ldapsaisie/src/includes/class/class.LSattr_html_select_object.php

423 lines
16 KiB
PHP
Raw Normal View History

<?php
/*******************************************************************************
* Copyright (C) 2007 Easter-eggs
* https://ldapsaisie.org
*
* Author: See AUTHORS file in top-level directory.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License version 2
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
******************************************************************************/
/**
* Type d'attribut HTML select_object
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*/
class LSattr_html_select_object extends LSattr_html{
var $LSformElement_type = 'select_object';
/**
* Array of unrecognized values
* @see LSattr_html_select_object::getFormValues()
* @var array<int,string>
*/
var $unrecognizedValues = array();
/**
* Ajoute l'attribut au formualaire passer en paramètre
*
* @param LSform &$form Le formulaire
* @param string $idForm L'identifiant du formulaire
* @param array|string|null $data Valeur du champs du formulaire
*
* @return LSformElement|false L'element du formulaire ajouté, ou false
*/
public function addToForm (&$form,$idForm,$data=NULL) {
$this -> config['attrObject'] = $this;
$element=$form -> addElement($this -> LSformElement_type, $this -> name, $this -> getLabel(), $this -> config, $this);
if(!$element) {
LSerror :: addErrorCode('LSform_06',$this -> name);
return false;
}
if ($data) {
$values = $this -> getFormValues(ensureIsArray($data));
if ($values) {
$element -> setValue($values);
}
}
return $element;
}
/**
* Effectue les tâches nécéssaires au moment du rafraichissement du formulaire
2020-04-29 15:54:21 +02:00
*
* Récupère un array du type array('DNs' => 'displayName') à partir d'une
* liste de DNs.
2020-04-29 15:54:21 +02:00
*
* @param mixed $data The attribute value (liste de DNs)
2020-04-29 15:54:21 +02:00
*
* @return array La valeur formatée de l'attribut (array('DNs' => 'displayName'))
**/
public function refreshForm($data,$fromDNs=false) {
return $this -> getFormValues($data,$fromDNs);
}
/**
* Check and return selectable objects configuration and eventually instanciate
* it if &instanciate
*
* @param boolean &$instanciated_objects reference If this reference point to an array, each valid
* selectable object type will be instanciated in this
* array with object type name as key.
2020-04-29 15:54:21 +02:00
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @return array|false Selectable objects configuration or False on error.
2020-04-29 15:54:21 +02:00
*/
public function getSelectableObjectsConfig(&$instanciated_objects) {
$confs = $this -> getConfig('html_options.selectable_object');
if (!is_array($confs)) {
self :: log_debug('getSelectableObjectsConfig(): html_options.selectable_object not properly configured');
return false;
}
// Make sure we have an array or configured selectable objects
if (isset($confs['object_type'])) {
$confs = array($confs);
}
// Return confs
$ret_confs = array();
// For each configured object types:
// - check we have the minimal configuration (object_type & value_attribute)
// - check we to not have multiple conf for the same object type
// - load object type
// - implement an object of this type (if is_array($instanciated_objects))
// - if value are from attributes, check this attribute exists
foreach ($confs as $conf) {
if (!isset($conf['object_type'])) {
LSerror :: addErrorCode(
'LSattr_html_select_object_01',
array(
'attr' => $this -> name,
'parameter' => 'object_type',
)
);
return false;
}
if (!isset($conf['value_attribute'])) {
LSerror :: addErrorCode(
'LSattr_html_select_object_01',
array(
'attr' => $this -> name,
'parameter' => 'value_attribute',
)
);
return false;
}
2020-04-29 15:54:21 +02:00
if (array_key_exists($conf['object_type'], $ret_confs)) {
LSerror :: addErrorCode('LSattr_html_select_object_04', array('type' => $conf['object_type'], 'attr' => $this -> name));
return false;
}
$object_type = $conf['object_type'];
if (!LSsession :: loadLSobject($object_type))
return false;
if (is_array($instanciated_objects))
$instanciated_objects[$object_type] = new $object_type();
if (!($conf['value_attribute']=='dn') && !($conf['value_attribute']=='%{dn}')) {
if (!$object_type :: hasAttr($conf['value_attribute'])) {
LSerror :: addErrorCode(
'LSattr_html_select_object_02',
array(
'attr' => $this -> name,
'object_type' => $conf['object_type'],
'value_attribute' => $conf['value_attribute'],
)
);
return false;
}
}
// Handle other parameters
$conf['display_name_format'] = LSconfig :: get('display_name_format', null, null, $conf);
$conf['onlyAccessible'] = LSconfig :: get('onlyAccessible', false, 'bool', $conf);
$conf['filter'] = LSconfig :: get('filter', null, null, $conf);
$ret_confs[$object_type] = $conf;
}
return $ret_confs;
}
/**
* Return an array of selected objects with DN as key and as value, an array with object name (key name)
* and type (key object_type).
*
* @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
* of selected objects info (default: false)
2020-04-29 15:54:21 +02:00
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @return array|false Array of selected objects with DN as key and object info as value or array
2021-08-25 18:02:37 +02:00
* of attribute values if $retrieveAttrValues==true or False on error.
2020-04-29 15:54:21 +02:00
*/
2021-08-25 18:02:37 +02:00
public function getFormValues($values=NULL, $fromDNs=false, $retrieveAttrValues=false) {
self :: log_debug("getFormValues(): input values=".varDump($values));
// Check parameters consistency
2021-08-25 18:02:37 +02:00
if ($retrieveAttrValues && !$fromDNs) {
self :: log_fatal('getFormValues(): $fromDNs must be true if $retrieveAttrValues==true');
return false;
}
if (!is_array($values)) {
self :: log_warning('getFormValues(): $values is not array');
return false;
}
2021-08-25 18:02:37 +02:00
// Retrieve/check selectable objects config
$objs = array();
$confs = $this -> getSelectableObjectsConfig($objs);
if (!is_array($confs) || empty($confs)) {
self :: log_warning('getFormValues(): invalid selectable objects config');
return false;
}
2020-04-29 15:54:21 +02:00
$selected_objects = array();
$unrecognizedValues = array();
$found_values = array();
foreach ($confs as $conf) {
foreach($values as $value) {
// If we already mark its value as unrecognized, pass
if (in_array($value, $unrecognizedValues))
continue;
// Ignore empty value
if (empty($value))
continue;
2020-04-29 15:54:21 +02:00
// Determine value attribute: DN/attribute valued (or force form DNs)
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");
// Check if it's the first this value match with an object
if (isset($found_values[$value])) {
// DN 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;
}
$found_values[$value] = $value;
2021-08-25 18:02:37 +02:00
if ($retrieveAttrValues) {
// Retrieve attribute value case: $selected_objects[dn] = attribute value
if(($conf['value_attribute']=='dn') || ($conf['value_attribute']=='%{dn}')) {
$selected_objects[$value] = $value;
}
else {
$val = $objs[$conf['object_type']] -> getValue($conf['value_attribute']);
if (!empty($val)) {
$selected_objects[$value] = $val[0];
}
else {
LSerror :: addErrorCode(
'LSattr_html_select_object_06',
array(
'name' => $objs[$conf['object_type']] -> getDisplayName($conf['display_name_format']),
'attr' => $this -> name
)
);
- LSsearch/LSsearchEntry : Added a new classes to doing and exploit ldap object search -> view/select => change to use it (php+template+js) -> LSattr_html_select_object/LSattr_html_select_list => change to use it -> LSldapObject : -> change listObjectsName() / searchObject() / getSelectArray() / listObjects() -> comment search() function -> Add triggers to clean cache -> LSpeople : Update search config -> LSsession : Change function to use it : - getSubDnLdapServer() - loadLSprofiles() - LSrelation : Deplace error codes declaration from LSsession in class file - LSldapObject : -> change getObjectFilter() / getLabel() / getSubDnValue() / getSubDnName() for can call then staticaly -> Add afterModify() function and trigger -> Change getObjectFilter() / listObjectsInRelation() to use Net_LDAP2_Filter -> Add __get() function -> Move one LSerror code for LSrelation function from LSsession class file -> Add a global variable to save cached data ($cache) -> Change subDn and subDnName access methods - LSauth : Move LSsession auth procedure in a dedicated class -> LSsession : Change startLSsession() to use it - LSsession : -> Add getRootDn() function -> Fix getTopDn() to return root DN if no topDn is currently defined -> Create dedicated functions to support recoveryPassword mecanism : - recoverPasswd() - recoverPasswdSendMail() - recoverPasswdFirstStep() - recoverPasswdSecondStep -> Customize LSdebug return and display (php+js) -> Clean unused error codes -> Move LSrelation error codes -> Comment ajax method
2009-10-30 01:03:17 +01:00
}
}
}
else {
// General case: $selected_objects[dn] = array(name + object_type)
$selected_objects[$value] = array(
'name' => $objs[$conf['object_type']] -> getDisplayName($conf['display_name_format']),
'object_type' => $conf['object_type'],
);
self :: log_debug("getFormValues(): ".$conf['object_type']."($value): ".varDump($selected_objects[$value]));
}
}
else {
// Construct resulting list from attributes values
$filter = Net_LDAP2_Filter::create($conf['value_attribute'], 'equals', $value);
if (isset($conf['filter']))
$filter = LSldap::combineFilters('and', array($filter, $conf['filter']));
$sparams = array();
$sparams['onlyAccessible'] = $conf['onlyAccessible'];
$listobj = $objs[$conf['object_type']] -> listObjectsName(
$filter,
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;
}
}
2021-08-25 18:02:37 +02:00
// 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 = $unrecognizedValues;
self :: log_debug("getFormValues(): final values=".varDump($selected_objects));
return $selected_objects;
}
/**
* Get LSselect ID for this attribute
*
* @return string The LSselect ID for this attribute
*/
public function getLSselectId() {
$id = "";
if ($this -> attribute -> ldapObject -> isNew())
$id .= $this -> attribute -> ldapObject -> getType();
else
$id .= $this -> attribute -> ldapObject -> getDn();
$id .= "|".$this -> name;
return $id;
}
/**
* Return array of atttribute values form array of form values
*
* @param mixed $values Array of form values
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @return array|false Array of attribute values or False on error.
*/
public function getValuesFromFormValues($values=NULL) {
if (is_array($values)) {
return $this -> getFormValues(array_keys($values), true, true);
}
return false;
}
/**
* Return an array of selected objects with DN as key and display name as value
* from LSselect
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @return array|false Tableau associatif des objects selectionnés avec en clé
* le DN et en valeur ce qui sera affiché. False en cas d'erreur.
*/
public function getValuesFromLSselect() {
$LSselect_id = $this -> getLSselectId();
if (LSsession :: loadLSclass('LSselect', null, true) && LSselect :: exists($LSselect_id)) {
$selected_objects = LSselect :: getSelectedObjects($LSselect_id);
2021-08-25 18:02:37 +02:00
self :: log_debug("getValuesFromLSselect(): selected objects retrieved from LSselect '$LSselect_id' = ".varDump($selected_objects));
if (is_array($selected_objects)) {
return $this -> getFormValues(
array_keys($selected_objects),
true
);
}
}
return false;
}
/**
* Return the values to be displayed in the LSform
*
* @param array $data The values of attribute
*
* @return array The values to be displayed in the LSform
**/
public function getFormVal($data) {
return $data;
}
}
- LdapSaisie : J'ai commencé à écrire la docummentation de LdapSaisie que j'espère pour voir bientôt ajouté au SVN. Cela me fait mettre le doit sur quelques problèmes de nommages, d'organisation que j'ai corrigé sur le fait : - Concepte de level était enfaite celui de subDn : seule le nom subDn doit rester. - Le concept de LSrights dans LSsession et config.inc.php était mal nommé. Il correspond plus à la définition de LSprofile en réalité. Je l'ai renommé ainsi. - Les paramètres authobject et authobject_pwdattr n'étaient pas très représentatif. Je les ai renommé en authObjectType et authObjectTypeAttrPwd. - Templates : -> Correction du template default dans le but de changer la couleur bleu dominante juger trop flashy :). Au passage j'ai dégagé l'image de fond de #main utilisé pour colorer le menu : cette méthode est moche et quitte a à faire du moche je préfère utiliser un vulgaire tableau que des bidouille de ce genre. -> Création d'un logo pour LdapSaisie qui vient remplacer le logo Easter-Eggs utilisé jusqu'alors. -> Ajout d'un favicon. - LSerror : -> J'ai déplacé les definitions de code d'erreur dans le contexte concerné (càd dans les fichiers de définition des classes) (Feature Request #1757) -> J'en ai profité pour renommer les codes d'erreur avec un prefixe pour eviter les doublons -> J'ai donc modifié une grande partie des fichiers pour changer les codes erreurs utilisés -> Ajout d'une méthode getError() utilisé par getErrors() -> Modification de la méthode stop() - LSformElement_password : - Correction d'un bug dans la génération des mots de passe dans un formulaire de création d'objet. - Ajout d'une possiblité de choisir le type de hashage du mot de passe stocké dans l'annuaire (Feature Request #1756) - Traduction des commentaires - LSattribute : Ajout des vérifications dans les méthodes de la classe lors de l'utilisation des objets html et ldap. - LSsession : -> Renforcement des méthodes faisant des inclusions d'autres fichiers php.
2009-01-02 17:00:25 +01:00
/*
* Error Codes
*/
LSerror :: defineError('LSattr_html_select_object_01',
___("LSattr_html_select_object : parameter '%{parameter}' is missing (attribute : %{attr}).")
- LdapSaisie : J'ai commencé à écrire la docummentation de LdapSaisie que j'espère pour voir bientôt ajouté au SVN. Cela me fait mettre le doit sur quelques problèmes de nommages, d'organisation que j'ai corrigé sur le fait : - Concepte de level était enfaite celui de subDn : seule le nom subDn doit rester. - Le concept de LSrights dans LSsession et config.inc.php était mal nommé. Il correspond plus à la définition de LSprofile en réalité. Je l'ai renommé ainsi. - Les paramètres authobject et authobject_pwdattr n'étaient pas très représentatif. Je les ai renommé en authObjectType et authObjectTypeAttrPwd. - Templates : -> Correction du template default dans le but de changer la couleur bleu dominante juger trop flashy :). Au passage j'ai dégagé l'image de fond de #main utilisé pour colorer le menu : cette méthode est moche et quitte a à faire du moche je préfère utiliser un vulgaire tableau que des bidouille de ce genre. -> Création d'un logo pour LdapSaisie qui vient remplacer le logo Easter-Eggs utilisé jusqu'alors. -> Ajout d'un favicon. - LSerror : -> J'ai déplacé les definitions de code d'erreur dans le contexte concerné (càd dans les fichiers de définition des classes) (Feature Request #1757) -> J'en ai profité pour renommer les codes d'erreur avec un prefixe pour eviter les doublons -> J'ai donc modifié une grande partie des fichiers pour changer les codes erreurs utilisés -> Ajout d'une méthode getError() utilisé par getErrors() -> Modification de la méthode stop() - LSformElement_password : - Correction d'un bug dans la génération des mots de passe dans un formulaire de création d'objet. - Ajout d'une possiblité de choisir le type de hashage du mot de passe stocké dans l'annuaire (Feature Request #1756) - Traduction des commentaires - LSattribute : Ajout des vérifications dans les méthodes de la classe lors de l'utilisation des objets html et ldap. - LSsession : -> Renforcement des méthodes faisant des inclusions d'autres fichiers php.
2009-01-02 17:00:25 +01:00
);
LSerror :: defineError('LSattr_html_select_object_02',
___("LSattr_html_select_object : the value of the parameter value_attribute in the configuration of the attribute %{attr} is incorrect. Object %{object_type} have no attribute %{value_attribute}.")
);
LSerror :: defineError('LSattr_html_select_object_03',
___("LSattr_html_select_object : more than one object returned corresponding to value %{val} of attribute %{attr}.")
);
LSerror :: defineError('LSattr_html_select_object_04',
___("LSattr_html_select_object : selection of object type %{type} is configured multiple time for attribute %{attr}.")
);
LSerror :: defineError('LSattr_html_select_object_05',
___("LSattr_html_select_object : the value '%{value}' seem to be duplicated in values of the attribute %{attr}.")
);
LSerror :: defineError('LSattr_html_select_object_06',
___("LSattr_html_select_object : selected object %{name} has no attribute %{attr} value, you can't select it.")
);