Merge pull request #175 from ltb-project/169-configure-the-dn_list-editor

New configuration settings for dn_link component

Author: coudot

conf/config.inc.php

@@ -84,6 +84,9 @@
 
 $attributes_list = array();
 $dn_link_label_attributes = array("cn");
+#$dn_link_search_display_macro = "%fullname% (%mail%)";
+$dn_link_search_min_chars = 3;
+$dn_link_search_size_limit = 10;
 $group_dn_link_label_attributes = array("description","cn");
 $usergroup_dn_link_label_attributes = array("description","cn");
 

docs/attributes.rst

@@ -79,6 +79,27 @@ It is also possible to configure which attribute is displayed as value on ``dn_l
     $group_dn_link_label_attributes = array("description","cn");
     $usergroup_dn_link_label_attributes = array("description","cn");
 
+The component ``dn_link`` can be used when updating an entry. In this case it is an autocomplete field that will search for entries in the directory.
+Some configuration parameters can be used:
+
+* What to display as search result label: it can be useful to use more thanone attribute to display the entry found by the search. This is possible by configuring a macro. For example to display the full name with the email in parenthesis:
+
+.. code-block:: php
+
+    $dn_link_search_display_macro = "%fullname% (%mail%)";
+
+* Minimal characters needed to launch the search (default is 3):
+
+.. code-block:: php
+
+    $dn_link_search_min_chars = 2;
+
+* Maximal number of entries to return (default is 10):
+
+.. code-block:: php
+
+    $dn_link_search_size_limit = 5;
+
 .. tip:: 
 
     You can translate attribute label by defining the ``label_item`` messages in custom lang file, for example :

htdocs/api/search_dn.php

@@ -16,11 +16,32 @@
     # Search attributes
     $attributes = array('cn');
 
+    if (isset($_POST["search_type"]) and $_POST["search_type"] == "dn_link") {
+        $attributes = $dn_link_label_attributes;
+        if ($dn_link_search_display_macro) {
+            preg_match_all('/%(\w+)%/', $dn_link_search_display_macro, $matches);
+            foreach($matches[1] as $item) {
+                $attributes[] = $attributes_map[$item]['attribute'];
+            }
+        }
+        if (isset($dn_link_search_size_limit)) {
+            $ldapInstance->ldap_size_limit = $dn_link_search_size_limit;
+        }
+    }
+
     [$ldap,$result,$nb_entries,$entries,$size_limit_reached] = $ldapInstance->search($ldap_filter, $attributes, $attributes_map, $search_result_title, $search_result_sortby, $search_result_items, $ldap_scope);
 
     if ($nb_entries) {
         foreach($entries as $entry) {
-            $data["entries"][] = array( "dn" => $entry["dn"], "display" => $entry["cn"][0]);
+            $display = $entry["cn"][0];
+            if (isset($_POST["search_type"]) and $_POST["search_type"] == "dn_link" and $dn_link_search_display_macro) {
+                $display = preg_replace_callback('/%(\w+)%/',
+                    function ($matches) use ($entry, $attributes_map) {
+                        return $entry[ $attributes_map[$matches[1]]['attribute'] ][0];
+                    },
+                    $dn_link_search_display_macro);
+            }
+            $data["entries"][] = array( "dn" => $entry["dn"], "display" => $display);
         }
     }
 

htdocs/index.php

@@ -106,6 +106,7 @@
 $smarty->assign('logout_link',isset($logout_link) ? $logout_link : false);
 $smarty->assign('attributes_list',$attributes_list);
 $smarty->assign('dn_link_label_attributes',implode(",",$dn_link_label_attributes));
+$smarty->assign('dn_link_search_min_chars',$dn_link_search_min_chars);
 $smarty->assign('group_dn_link_label_attributes',implode(",",$group_dn_link_label_attributes));
 $smarty->assign('usergroup_dn_link_label_attributes',implode(",",$usergroup_dn_link_label_attributes));
 $smarty->assign('require_auth',$require_auth);

htdocs/js/update.js

@@ -2,20 +2,22 @@ $(document).ready(function(){
   let timer;
 
   $(".dn_link_container input[type=text]").on("keyup", function (event) {
+    var conf_search_min_chars = $(this).data("conf-searchminchars");
+    var search_min_chars = conf_search_min_chars ? conf_search_min_chars : 3;
     // Remove value if field is emptied or less than minimal characters
-    if ($(this).val().length <= 2) {
+    if ($(this).val().length < search_min_chars) {
         $(this).siblings('input[type=hidden]').val('') ;
         $(this).siblings('div.dn_link_suggestions').empty();
     }
     // Minimal search characters
-    if ($(this).val().length > 2) {
+    if ($(this).val().length >= search_min_chars) {
       if (timer) {
         clearTimeout(timer);
         $(this).siblings('div.dn_link_suggestions').empty();
       }
 
       timer = setTimeout(() => {
-        $.post("index.php", { 'apiendpoint': 'search_dn', 'search': $(this).val() }, (data) => {
+        $.post("index.php", { 'apiendpoint': 'search_dn', 'search': $(this).val(), 'search_type': 'dn_link' }, (data) => {
           // clear existing list
           $(this).siblings('div.dn_link_suggestions').empty();
           if (data.entries) {

templates/value_editor.tpl

@@ -25,7 +25,7 @@
     <input type="number" name="{$item}{$itemindex}" class="form-control" value="{$value}" data-role="value" />
 {else if $type eq 'dn_link'}
     <div class="dn_link_container">
-    <input type="text" class="form-control" value="{get_attribute dn="{$value}" attribute="cn" ldap_url="{$ldap_params.ldap_url}" ldap_starttls="{$ldap_params.ldap_starttls}" ldap_binddn="{$ldap_params.ldap_binddn}" ldap_bindpw="{$ldap_params.ldap_bindpw}" ldap_filter="{$ldap_params.ldap_user_filter}" ldap_network_timeout="{$ldap_params.ldap_network_timeout}"}" data-role="display"/>
+    <input type="text" class="form-control" value="{get_attribute dn="{$value}" attribute="cn" ldap_url="{$ldap_params.ldap_url}" ldap_starttls="{$ldap_params.ldap_starttls}" ldap_binddn="{$ldap_params.ldap_binddn}" ldap_bindpw="{$ldap_params.ldap_bindpw}" ldap_filter="{$ldap_params.ldap_user_filter}" ldap_network_timeout="{$ldap_params.ldap_network_timeout}"}" data-role="display" data-conf-searchminchars="{$dn_link_search_min_chars}"/>
     <input type="hidden" name="{$item}{$itemindex}" value="{$value}" data-role="value" />
     <div class="z-3 position-absolute list-group dn_link_suggestions"></div>
     </div>