Coding guidelines cleanup
[asterisk/asterisk.git] / res / res_config_ldap.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Copyright (C) 2005, Oxymium sarl
5  * Manuel Guesdon <mguesdon@oxymium.net> - LDAP RealTime Driver Author/Adaptor
6  *
7  * Copyright (C) 2007, Digium, Inc.
8  * Russell Bryant <russell@digium.com>
9  *
10  * See http://www.asterisk.org for more information about
11  * the Asterisk project. Please do not directly contact
12  * any of the maintainers of this project for assistance;
13  * the project provides a web site, mailing lists and IRC
14  * channels for your use.
15  *
16  * This program is free software, distributed under the terms of
17  * the GNU General Public License Version 2. See the LICENSE file
18  * at the top of the source tree.
19  *
20  */
21
22 /*! \file
23  *
24  * \brief ldap plugin for portable configuration engine (ARA)
25  *
26  * \author Mark Spencer <markster@digium.com>
27  * \author Manuel Guesdon
28  * \author Carl-Einar Thorner <cthorner@voicerd.com>
29  * \author Russell Bryant <russell@digium.com>
30  *
31  * \arg http://www.openldap.org
32  */
33
34 /*** MODULEINFO
35         <depend>ldap</depend>
36  ***/
37
38 #include "asterisk.h"
39
40 #include <stdlib.h>
41 #include <string.h>
42 #include <ctype.h>
43 #include <stdio.h>
44 #include <ldap.h>
45
46 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
47
48 #include "asterisk/channel.h"
49 #include "asterisk/logger.h"
50 #include "asterisk/config.h"
51 #include "asterisk/module.h"
52 #include "asterisk/lock.h"
53 #include "asterisk/options.h"
54 #include "asterisk/cli.h"
55 #include "asterisk/utils.h"
56 #include "asterisk/strings.h"
57 #include "asterisk/pbx.h"
58 #include "asterisk/linkedlists.h"
59
60 #define RES_CONFIG_LDAP_CONF "res_ldap.conf"
61
62 AST_MUTEX_DEFINE_STATIC(ldap_lock);
63
64 static LDAP *ldapConn;
65 static char host[512];
66 static char user[512];
67 static char pass[50];
68 static char basedn[512];
69 static int port = 389;
70 static time_t connect_time;
71
72 static int parse_config(void);
73 static int ldap_reconnect(void);
74 static char *realtime_ldap_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
75
76 struct category_and_metric {
77         const char *name;
78         int metric;
79         const char *variable_name;
80         const char *variable_value;
81         int var_metric; /*!< For organizing variables (particularly includes and switch statments) within a context */
82 };
83
84 /*! \brief Table configuration */
85 struct ldap_table_config {
86         char *table_name;                 /*!< table name */
87         char *additional_filter;          /*!< additional filter        */
88         struct ast_variable *attributes;  /*!< attribute names conversion */
89         struct ast_variable *delimiters;  /*!< the current delimiter is semicolon, so we are not using this variable */
90         AST_LIST_ENTRY(ldap_table_config) entry;
91 };
92
93 /*! \brief Should be locked before using it */
94 static AST_LIST_HEAD_NOLOCK_STATIC(table_configs, ldap_table_config);
95 static struct ldap_table_config *base_table_config;
96 static struct ldap_table_config *static_table_config;
97
98 static struct ast_cli_entry ldap_cli[] = {
99         AST_CLI_DEFINE(realtime_ldap_status, "Shows connection information for the LDAP RealTime driver"),
100 };
101
102 /*! \brief Create a new table_config */
103 static struct ldap_table_config *table_config_new(const char *table_name)
104 {
105         struct ldap_table_config *p;
106
107         if (!(p = ast_calloc(1, sizeof(*p))))
108                 return NULL;
109
110         if (table_name) {
111                 if (!(p->table_name = ast_strdup(table_name))) {
112                         free(p);
113                         return NULL;
114                 }
115         }
116
117         return p;
118 }
119
120 /*! \brief Find a table_config - Should be locked before using it 
121  *  \note This function assumes ldap_lock to be locked. */
122 static struct ldap_table_config *table_config_for_table_name(const char *table_name)
123 {
124         struct ldap_table_config *c = NULL;
125
126         AST_LIST_TRAVERSE(&table_configs, c, entry) {
127                 if (!strcmp(c->table_name, table_name))
128                         break;
129         }
130
131         return c;
132 }
133
134 /*! \brief Find variable by name */
135 static struct ast_variable *variable_named(struct ast_variable *var, const char *name)
136 {
137         for (; var; var = var->next) {
138                 if (!strcasecmp(name, var->name))
139                         break;
140         }
141
142         return var;
143 }
144
145 /*! \brief for the semicolon delimiter
146         \param somestr - pointer to a string
147
148         \return number of occurances of the delimiter(semicolon)
149  */
150 static int semicolon_count_str(const char *somestr)
151 {
152         int count = 0;
153
154         for (; *somestr; somestr++) {
155                 if (*somestr == ';')
156                         count++;
157         }
158
159         return count;
160
161
162 /* takes a linked list of \a ast_variable variables, finds the one with the name variable_value
163  * and returns the number of semicolons in the value for that \a ast_variable
164  */
165 static int semicolon_count_var(struct ast_variable *var)
166 {
167         struct ast_variable *var_value = variable_named(var, "variable_value");
168
169         if (!var_value)
170                 return 0;
171
172         ast_debug(1, "LINE(%d) semicolon_count_var: %s\n", __LINE__, var_value->value);
173
174         return semicolon_count_str(var_value->value);
175 }
176
177 /*! \brief add attribute to table config - Should be locked before using it */
178 static void ldap_table_config_add_attribute(struct ldap_table_config *table_config,
179         const char *attribute_name, const char *attribute_value)
180 {
181         struct ast_variable *var;
182
183         if (ast_strlen_zero(attribute_name) || ast_strlen_zero(attribute_value))
184                 return;
185
186         if (!(var = ast_variable_new(attribute_name, attribute_value, table_config->table_name)))
187                 return;
188
189         if (table_config->attributes)
190                 var->next = table_config->attributes;
191         table_config->attributes = var;
192 }
193
194 /*! \brief Free table_config 
195  *  \note assumes ldap_lock to be locked */
196 static void table_configs_free(void)
197 {
198         struct ldap_table_config *c;
199
200         while ((c = AST_LIST_REMOVE_HEAD(&table_configs, entry))) {
201                 if (c->table_name)
202                         free(c->table_name);
203                 if (c->additional_filter)
204                         free(c->additional_filter);
205                 if (c->attributes)
206                         ast_variables_destroy(c->attributes);
207                 free(c);
208         }
209
210         base_table_config = NULL;
211         static_table_config = NULL;
212 }
213
214 /*! \brief Convert variable name to ldap attribute name - Should be locked before using it */
215 static const char *convert_attribute_name_to_ldap(struct ldap_table_config *table_config,
216         const char *attribute_name)
217 {
218         int i = 0;
219         struct ldap_table_config *configs[] = { table_config, base_table_config };
220
221         for (i = 0; i < ARRAY_LEN(configs); i++) {
222                 struct ast_variable *attribute;
223
224                 if (!configs[i])
225                         continue;
226
227                 attribute = configs[i]->attributes;
228                 for (; attribute; attribute = attribute->next) {
229                         if (!strcasecmp(attribute_name, attribute->name))
230                                 return attribute->value;
231                 }
232         }
233
234         return attribute_name;
235 }
236
237 /*! \brief Convert ldap attribute name to variable name - Should be locked before using it */
238 static const char *convert_attribute_name_from_ldap(struct ldap_table_config *table_config,
239                                                     const char *attribute_name)
240 {
241         int i = 0;
242         struct ldap_table_config *configs[] = { table_config, base_table_config };
243
244         for (i = 0; i < ARRAY_LEN(configs); i++) {
245                 struct ast_variable *attribute;
246
247                 if (!configs[i])
248                         continue;
249
250                 attribute = configs[i]->attributes;
251                 for (; attribute; attribute = attribute->next) {
252                         if (strcasecmp(attribute_name, attribute->value) == 0)
253                                 return attribute->name;
254                 }
255         }
256
257         return attribute_name;
258 }
259
260 /*! \brief Get variables from ldap entry attributes - Should be locked before using it
261  * \return a linked list of ast_variable variables.
262  **/
263 static struct ast_variable *realtime_ldap_entry_to_var(struct ldap_table_config *table_config,
264         LDAPMessage *ldap_entry)
265 {
266         BerElement *ber = NULL;
267         struct ast_variable *var = NULL;
268         struct ast_variable *prev = NULL;
269         int is_delimited = 0;
270         int i = 0;
271         char *ldap_attribute_name;
272         struct berval *value;
273         int pos = 0;
274
275         ldap_attribute_name = ldap_first_attribute(ldapConn, ldap_entry, &ber);
276
277         while (ldap_attribute_name) {
278                 struct berval **values = NULL;
279                 const char *attribute_name = convert_attribute_name_from_ldap(table_config, ldap_attribute_name);
280                 int is_realmed_password_attribute = strcasecmp(attribute_name, "md5secret") == 0;
281
282                 values = ldap_get_values_len(ldapConn, ldap_entry, ldap_attribute_name); /* these are freed at the end */
283                 if (values) {
284                         struct berval **v = values;
285
286                         while (*v) {
287                                 value = *v;
288                                 ast_debug(2, "LINE(%d) attribute_name: %s LDAP value: %s\n", __LINE__, attribute_name, value->bv_val);
289                                 if (is_realmed_password_attribute) {
290                                         if (!strncasecmp(value->bv_val, "{md5}", 5))
291                                                 value->bv_val += 5;
292                                         else
293                                                 value->bv_val = NULL;
294                                         ast_debug(2, "md5: %s\n", value->bv_val);
295                                 }
296                                 if (value->bv_val) {
297                                         /* ok, so looping through all delimited values except the last one (not, last character is not delimited...) */
298                                         if (is_delimited) {
299                                                 i = 0;
300                                                 pos = 0;
301                                                 while (!ast_strlen_zero(value->bv_val + i)) {
302                                                         if (value->bv_val[i] == ';'){
303                                                                 value->bv_val[i] = '\0';
304                                                                 if (prev) {
305                                                                         prev->next = ast_variable_new(attribute_name, &value->bv_val[pos], table_config->table_name);
306                                                                         if (prev->next) {
307                                                                                 prev = prev->next;
308                                                                         }
309                                                                 } else {
310                                                                         prev = var = ast_variable_new(attribute_name, &value->bv_val[pos], table_config->table_name);
311                                                                 }
312                                                                 pos = i + 1;
313                                                         }
314                                                         i++;
315                                                 }
316                                         }
317                                         /* for the last delimited value or if the value is not delimited: */
318                                         if (prev) {
319                                                 prev->next = ast_variable_new(attribute_name, &value->bv_val[pos], table_config->table_name);
320                                                 if (prev->next) {
321                                                         prev = prev->next;
322                                                 }
323                                         } else {
324                                                 prev = var = ast_variable_new(attribute_name, &value->bv_val[pos], table_config->table_name);
325                                         }
326                                 }
327                                 v++;
328                         }
329                         ber_bvecfree(values);
330                 }
331                 ldap_attribute_name = ldap_next_attribute(ldapConn, ldap_entry, ber);
332         }
333         ber_free(ber, 0);
334
335         return var;
336 }
337
338 /*! \brief Get variables from ldap entry attributes - Should be locked before using it
339  *
340  * The results are freed outside this function so is the \a vars array.
341  *      
342  * \return \a vars - an array of ast_variable variables terminated with a null.
343  **/
344 static struct ast_variable **realtime_ldap_result_to_vars(struct ldap_table_config *table_config,
345         LDAPMessage *ldap_result, unsigned int *entries_count_ptr)
346 {
347         struct ast_variable **vars;
348         int i = 0;
349         int tot_count = 0;
350         int entry_index = 0;
351         LDAPMessage *ldap_entry = NULL;
352         BerElement *ber = NULL;
353         struct ast_variable *var = NULL;
354         struct ast_variable *prev = NULL;
355         int is_delimited = 0;
356         char *delim_value = NULL;
357         int delim_tot_count = 0;
358         int delim_count = 0;
359
360         /* First find the total count */
361         ldap_entry = ldap_first_entry(ldapConn, ldap_result);
362
363         for (tot_count = 0; ldap_entry; tot_count++){ 
364                 tot_count += semicolon_count_var(realtime_ldap_entry_to_var(table_config, ldap_entry));
365                 ldap_entry = ldap_next_entry(ldapConn, ldap_entry);
366         }
367
368         if (entries_count_ptr)
369                 *entries_count_ptr = tot_count;
370         /* Now that we have the total count we allocate space and create the variables
371          * Remember that each element in vars is a linked list that points to realtime variable.
372          * If the we are dealing with a static realtime variable we create a new element in the \a vars array for each delimited
373          * value in \a variable_value; otherwise, we keep \a vars static and increase the length of the linked list of variables in the array element.
374          * This memory must be freed outside of this function. */
375         vars = ast_calloc(sizeof(struct ast_variable *), tot_count + 1);
376
377         ldap_entry = ldap_first_entry(ldapConn, ldap_result);
378
379         i = 0;
380
381         /* For each static realtime variable we may create several entries in the \a vars array if it's delimited */
382         for (entry_index = 0; ldap_entry; ) { 
383                 int pos = 0;
384                 delim_value = NULL;
385                 delim_tot_count = 0;
386                 delim_count = 0;
387                 
388                 do { /* while delim_count */
389
390                         /* Starting new static var */
391                         char *ldap_attribute_name = ldap_first_attribute(ldapConn, ldap_entry, &ber);
392                         struct berval *value;
393                         while (ldap_attribute_name) {
394                         
395                                 const char *attribute_name =
396                                         convert_attribute_name_from_ldap(table_config, ldap_attribute_name);
397                                 int is_realmed_password_attribute = strcasecmp(attribute_name, "md5secret") == 0;
398                                 struct berval **values = NULL;
399
400                                 values = ldap_get_values_len(ldapConn, ldap_entry, ldap_attribute_name);
401                                 if (values) {
402                                         struct berval **v = values;
403
404                                         while (*v) {
405                                                 value = *v;
406                                                 if (is_realmed_password_attribute) {
407                                                         if (strncasecmp(value->bv_val, "{md5}", 5) == 0)
408                                                                 value->bv_val += 5;
409                                                         else
410                                                                 value->bv_val = NULL;
411                                                         ast_debug(2, "md5: %s\n", value->bv_val);
412                                                 }
413                                                 if (value->bv_val) {
414                                                         if (delim_value == NULL 
415                                                                 && !is_realmed_password_attribute 
416                                                                 && (static_table_config != table_config || strcmp(attribute_name, "variable_value") == 0)) {
417
418                                                                 delim_value = ast_strdup(value->bv_val);
419
420                                                                 if ((delim_tot_count = semicolon_count_str(delim_value)) > 0) {
421                                                                         ast_debug(4, "LINE(%d) is delimited %d times: %s\n", __LINE__, delim_tot_count, delim_value);
422                                                                         is_delimited = 1;
423                                                                 }
424                                                         }
425
426                                                         if (is_delimited != 0 
427                                                                 && !is_realmed_password_attribute 
428                                                                 && (static_table_config != table_config || strcmp(attribute_name, "variable_value") == 0) ){
429                                                                 /* for non-Static RealTime, first */
430
431                                                                 i = pos;
432                                                                 while (!ast_strlen_zero(value->bv_val + i)) {
433                                                                         ast_debug(4, "LINE(%d) DELIM pos: %d i: %d\n", __LINE__, pos, i);
434                                                                         if (delim_value[i] == ';') {
435                                                                                 delim_value[i] = '\0';
436
437                                                                                 ast_debug(2, "LINE(%d) DELIM - attribute_name: %s value: %s pos: %d\n", __LINE__, attribute_name, &delim_value[pos], pos);
438                                                         
439                                                                                 if (prev) {
440                                                                                         prev->next = ast_variable_new(attribute_name, &delim_value[pos], table_config->table_name);
441                                                                                         if (prev->next) {
442                                                                                                 prev = prev->next;
443                                                                                         }
444                                                                                 } else {
445                                                                                         prev = var = ast_variable_new(attribute_name, &delim_value[pos], table_config->table_name);
446                                                                                 }
447                                                                                 pos = i + 1;
448
449                                                                                 if (static_table_config == table_config) {
450                                                                                         break;
451                                                                                 }
452                                                                         }
453                                                                         i++;
454                                                                 }
455                                                                 if (ast_strlen_zero(value->bv_val + i)) {
456                                                                         ast_debug(4, "LINE(%d) DELIM pos: %d i: %d delim_count: %d\n", __LINE__, pos, i, delim_count);
457                                                                         /* Last delimited value */
458                                                                         ast_debug(4, "LINE(%d) DELIM - attribute_name: %s value: %s pos: %d\n", __LINE__, attribute_name, &delim_value[pos], pos);
459                                                                         if (prev) {
460                                                                                 prev->next = ast_variable_new(attribute_name, &delim_value[pos], table_config->table_name);
461                                                                                 if (prev->next) {
462                                                                                         prev = prev->next;
463                                                                                 }
464                                                                         } else {
465                                                                                 prev = var = ast_variable_new(attribute_name, &delim_value[pos], table_config->table_name);
466                                                                         }
467                                                                         /* Remembering to free memory */
468                                                                         is_delimited = 0;
469                                                                         pos = 0;
470                                                                         free(delim_value);
471                                                                         delim_value = NULL;
472                                                                 }
473                                                                 
474                                                                 ast_debug(4, "LINE(%d) DELIM pos: %d i: %d\n", __LINE__, pos, i);
475                                                         } else {
476                                                                 /* not delimited */
477                                                                 if (delim_value) {
478                                                                         free(delim_value);
479                                                                         delim_value = NULL;
480                                                                 }
481                                                                 ast_debug(2, "LINE(%d) attribute_name: %s value: %s\n", __LINE__, attribute_name, value->bv_val);
482
483                                                                 if (prev) {
484                                                                         prev->next = ast_variable_new(attribute_name, value->bv_val, table_config->table_name);
485                                                                         if (prev->next) {
486                                                                                 prev = prev->next;
487                                                                         }
488                                                                 } else {
489                                                                         prev = var = ast_variable_new(attribute_name, value->bv_val, table_config->table_name);
490                                                                 }
491                                                         }
492                                                 }
493                                                 v++;
494                                         } /*!< while(*v) */
495                                         ber_bvecfree(values);
496                                 }/*!< if (values) */
497                                 ldap_attribute_name = ldap_next_attribute(ldapConn, ldap_entry, ber);
498                         } /*!< while (ldap_attribute_name) */
499                         ber_free(ber, 0);
500                         if (static_table_config == table_config) {
501                                 if (option_debug > 2) {
502                                         const struct ast_variable *tmpdebug = variable_named(var, "variable_name");
503                                         const struct ast_variable *tmpdebug2 = variable_named(var, "variable_value");
504                                         if (tmpdebug && tmpdebug2) {
505                                                 ast_debug(3, "LINE(%d) Added to vars - %s = %s\n", __LINE__, tmpdebug->value, tmpdebug2->value);
506                                         }
507                                 }
508                                 vars[entry_index++] = var;
509                                 prev = NULL;
510                         }
511
512                         delim_count++;
513                 } while (delim_count <= delim_tot_count && static_table_config == table_config);
514
515                 if (static_table_config != table_config) {
516                         ast_debug(3, "LINE(%d) Added to vars - non static\n", __LINE__);
517                                 
518                         vars[entry_index++] = var;
519                         prev = NULL;
520                 }
521                 ldap_entry = ldap_next_entry(ldapConn, ldap_entry);
522         } /*!< end for loop over ldap_entry */
523
524         return vars;
525 }
526
527
528 static int is_ldap_connect_error(int err)
529 {
530         return (err == LDAP_SERVER_DOWN
531                         || err == LDAP_TIMEOUT || err == LDAP_CONNECT_ERROR);
532 }
533
534 /*! \brief Get LDAP entry by dn and return attributes as variables  - Should be locked before using it 
535         This is used for setting the default values of an object(i.e., with accountBaseDN)
536 */
537 static struct ast_variable *ldap_loadentry(struct ldap_table_config *table_config,
538                                            const char *dn)
539 {
540         if (!table_config) {
541                 ast_log(LOG_ERROR, "No table config\n");
542                 return NULL;
543         } else {
544                 struct ast_variable **vars = NULL;
545                 struct ast_variable *var = NULL;
546                 int result = -1;
547                 LDAPMessage *ldap_result = NULL;
548                 int tries = 0;
549
550                 ast_debug(2, "ldap_loadentry dn=%s\n", dn);
551
552                 do {
553                         result = ldap_search_ext_s(ldapConn, dn, LDAP_SCOPE_BASE,
554                                            "(objectclass=*)", NULL, 0, NULL, NULL, NULL, LDAP_NO_LIMIT, &ldap_result);
555                         if (result < 0 && is_ldap_connect_error(result)) {
556                                 ast_log(LOG_WARNING,
557                                         "Failed to query database. Try %d/3\n",
558                                         tries + 1);
559                                 tries++;
560                                 if (tries < 3) {
561                                         usleep(500000L * tries);
562                                         if (ldapConn) {
563                                                 ldap_unbind_ext_s(ldapConn, NULL, NULL);
564                                                 ldapConn = NULL;
565                                         }
566                                         if (!ldap_reconnect())
567                                                 break;
568                                 }
569                         }
570                 } while (result < 0 && tries < 3 && is_ldap_connect_error(result));
571
572                 if (result < 0) {
573                         ast_log(LOG_WARNING,
574                                         "Failed to query database. Check debug for more info.\n");
575                         ast_debug(2, "dn=%s\n", dn);
576                         ast_debug(2, "Query Failed because: %s\n",
577                                 ldap_err2string(result));
578                         ast_mutex_unlock(&ldap_lock);
579                         return NULL;
580                 } else {
581                         int num_entry = 0;
582                         unsigned int *entries_count_ptr = NULL; /*!< not using this */
583                         if ((num_entry = ldap_count_entries(ldapConn, ldap_result)) > 0) {
584                                 ast_debug(3, "num_entry: %d\n", num_entry);
585
586                                 vars = realtime_ldap_result_to_vars(table_config, ldap_result, entries_count_ptr);
587                                 if (num_entry > 1)
588                                         ast_log(LOG_WARNING, "More than one entry for dn=%s. Take only 1st one\n", dn);
589                         } else {
590                                 ast_log(LOG_WARNING, "Could not find any entry dn=%s.\n", dn);
591                         }
592                 }
593                 ldap_msgfree(ldap_result);
594
595                 /* Chopping \a vars down to one variable */
596                 if (vars != NULL) {
597                         struct ast_variable **p = vars;
598                         p++;
599                         var = *p;
600                         while (var) {
601                                 ast_variables_destroy(var);
602                                 p++;
603                         }
604                         vars = ast_realloc(vars, sizeof(struct ast_variable *));
605                 }
606
607                 var = *vars;
608
609                 return var;
610         }
611 }
612
613 /*! \brief caller should free returned pointer */
614 static char *substituted(struct ast_channel *channel, const char *string)
615 {
616 #define MAXRESULT       2048
617         char *ret_string = NULL;
618
619         if (!ast_strlen_zero(string)) {
620                 ret_string = ast_calloc(1, MAXRESULT);
621                 pbx_substitute_variables_helper(channel, string, ret_string, MAXRESULT - 1);
622         }
623         ast_debug(2, "substituted: string: '%s' => '%s' \n",
624                 string, ret_string);
625         return ret_string;
626 }
627
628 /*! \brief caller should free returned pointer */
629 static char *cleaned_basedn(struct ast_channel *channel, const char *basedn)
630 {
631         char *cbasedn = NULL;
632         if (basedn) {
633                 char *p = NULL;
634                 cbasedn = substituted(channel, basedn);
635                 if (*cbasedn == '"') {
636                         cbasedn++;
637                         if (!ast_strlen_zero(cbasedn)) {
638                                 int len = strlen(cbasedn);
639                                 if (cbasedn[len - 1] == '"')
640                                         cbasedn[len - 1] = '\0';
641
642                         }
643                 }
644                 p = cbasedn;
645                 while (*p) {
646                         if (*p == '|')
647                                 *p = ',';
648                         p++;
649                 }
650         }
651         ast_debug(2, "basedn: '%s' => '%s' \n", basedn, cbasedn);
652         return cbasedn;
653 }
654
655 /*! \brief Replace <search> by <by> in string. No check is done on string allocated size ! */
656 static int replace_string_in_string(char *string, const char *search, const char *by)
657 {
658         int search_len = strlen(search);
659         int by_len = strlen(by);
660         int replaced = 0;
661         char *p = strstr(string, search);
662         if (p) {
663                 replaced = 1;
664                 while (p) {
665                         if (by_len == search_len)
666                                 memcpy(p, by, by_len);
667                         else {
668                                 memmove(p + by_len, p + search_len,
669                                                 strlen(p + search_len) + 1);
670                                 memcpy(p, by, by_len);
671                         }
672                         p = strstr(p + by_len, search);
673                 }
674         }
675         return replaced;
676 }
677
678 /*! \brief Append a name=value filter string. The filter string can grow. */
679 static void append_var_and_value_to_filter(struct ast_str **filter,
680         struct ldap_table_config *table_config,
681         const char *name, const char *value)
682 {
683         char *new_name = NULL;
684         char *new_value = NULL;
685         char *like_pos = strstr(name, " LIKE");
686
687         ast_debug(2, "name='%s' value='%s'\n", name, value);
688
689         if (like_pos) {
690                 name = new_name = ast_strdupa(like_pos + strlen(" LIKE"));
691                 value = new_value = ast_strdupa(value);
692                 replace_string_in_string(new_value, "\\_", "_");
693                 replace_string_in_string(new_value, "%", "*");
694         }
695
696         name = convert_attribute_name_to_ldap(table_config, name);
697
698         ast_str_append(filter, 0, "(%s=%s)", name, value);
699 }
700
701 /*! \brief LDAP base function 
702  * \return a null terminated array of ast_variable (one per entry) or NULL if no entry is found or if an error occured
703  * caller should free the returned array and ast_variables
704  * \param entries_count_ptr is a pointer to found entries count (can be NULL)
705  * \param basedn is the base DN
706  * \param table_name is the table_name (used dor attribute convertion and additional filter)
707  * \param ap contains null terminated list of pairs name/value
708 */
709 static struct ast_variable **realtime_ldap_base_ap(unsigned int *entries_count_ptr,
710         const char *basedn, const char *table_name, va_list ap)
711 {
712         struct ast_variable **vars = NULL;
713         const char *newparam = NULL;
714         const char *newval = NULL;
715         struct ldap_table_config *table_config = NULL;
716         char *clean_basedn = cleaned_basedn(NULL, basedn);
717         struct ast_str *filter = NULL;
718         int tries = 0;
719         int result = 0;
720         LDAPMessage *ldap_result = NULL;
721
722         if (!table_name) {
723                 ast_log(LOG_WARNING, "No table_name specified.\n");
724                 ast_free(clean_basedn);
725                 return NULL;
726         } 
727
728         if (!(filter = ast_str_create(80)))
729                 ast_free(clean_basedn);
730                 return NULL;
731
732         /* Get the first parameter and first value in our list of passed paramater/value pairs  */
733         newparam = va_arg(ap, const char *);
734         newval = va_arg(ap, const char *);
735
736         if (!newparam || !newval) {
737                 ast_log(LOG_WARNING, "Realtime retrieval requires at least 1 parameter"
738                         " and 1 value to search on.\n");
739                 ast_free(filter);
740                 ast_free(clean_basedn);
741                 return NULL;
742         }
743
744         ast_mutex_lock(&ldap_lock);
745
746         /* We now have our complete statement; Lets connect to the server and execute it.  */
747         if (!ldap_reconnect()) {
748                 ast_mutex_unlock(&ldap_lock);
749                 ast_free(filter);
750                 ast_free(clean_basedn);
751                 return NULL;
752         }
753
754         table_config = table_config_for_table_name(table_name);
755         if (!table_config) {
756                 ast_log(LOG_WARNING, "No table named '%s'.\n", table_name);
757                 ast_mutex_unlock(&ldap_lock);
758                 ast_free(filter);
759                 ast_free(clean_basedn);
760                 return NULL;
761         }
762
763         ast_str_append(&filter, 0, "(&");
764
765         if (table_config && table_config->additional_filter)
766                 ast_str_append(&filter, 0, table_config->additional_filter);
767         if (table_config != base_table_config && base_table_config && 
768                 base_table_config->additional_filter) {
769                 ast_str_append(&filter, 0, base_table_config->additional_filter);
770         }
771
772         /* Create the first part of the query using the first parameter/value pairs we just extracted */
773         /*   If there is only 1 set, then we have our query. Otherwise, loop thru the list and concat */
774
775         append_var_and_value_to_filter(&filter, table_config, newparam, newval);
776         while ((newparam = va_arg(ap, const char *))) {
777                 newval = va_arg(ap, const char *);
778                 append_var_and_value_to_filter(&filter, table_config, newparam, newval);
779         }
780         ast_str_append(&filter, 0, ")");
781
782         do {
783                 /* freeing ldap_result further down */
784                 result = ldap_search_ext_s(ldapConn, clean_basedn,
785                                   LDAP_SCOPE_SUBTREE, filter->str, NULL, 0, NULL, NULL, NULL, LDAP_NO_LIMIT,
786                                   &ldap_result);
787                 if (result < 0 && is_ldap_connect_error(result)) {
788                         ast_log(LOG_DEBUG, "Failed to query database. Try %d/10\n",
789                                 tries + 1);
790                         if (++tries < 10) {
791                                 usleep(1);
792                                 if (ldapConn) {
793                                         ldap_unbind_ext_s(ldapConn, NULL, NULL);
794                                         ldapConn = NULL;
795                                 }
796                                 if (!ldap_reconnect())
797                                         break;
798                         }
799                 }
800         } while (result < 0 && tries < 10 && is_ldap_connect_error(result));
801
802         if (result < 0) {
803                 ast_log(LOG_WARNING, "Failed to query database. Check debug for more info.\n");
804                 ast_log(LOG_WARNING, "Query: %s\n", filter->str);
805                 ast_log(LOG_WARNING, "Query Failed because: %s\n", ldap_err2string(result));
806         } else {
807                 /* this is where we create the variables from the search result 
808                  * freeing this \a vars outside this function */
809                 if (ldap_count_entries(ldapConn, ldap_result) > 0) {
810                         /* is this a static var or some other? they are handled different for delimited values */
811                         vars = realtime_ldap_result_to_vars(table_config, ldap_result, entries_count_ptr);
812                 } else {
813                         ast_log(LOG_WARNING, "Could not find any entry matching %s in base dn %s.\n",
814                                 filter->str, clean_basedn);
815                 }
816
817                 ldap_msgfree(ldap_result);
818
819                 /* TODO: get the default variables from the accountBaseDN, not implemented with delimited values */
820                 if (vars) {
821                         struct ast_variable **p = vars;
822                         while (*p) {
823                                 struct ast_variable *append_var = NULL;
824                                 struct ast_variable *tmp = *p;
825                                 while (tmp) {
826                                         if (strcasecmp(tmp->name, "accountBaseDN") == 0) {
827                                                 /* Get the variable to compare with for the defaults */
828                                                 struct ast_variable *base_var = ldap_loadentry(table_config, tmp->value);
829                                                 
830                                                 while (base_var) {
831                                                         struct ast_variable *next = base_var->next;
832                                                         struct ast_variable *test_var = *p;
833                                                         int base_var_found = 0;
834
835                                                         /* run throught the default values and fill it inn if it is missing */
836                                                         while (test_var) {
837                                                                 if (strcasecmp(test_var->name, base_var->name) == 0) {
838                                                                         base_var_found = 1;
839                                                                         break;
840                                                                 } else
841                                                                         test_var = test_var->next;
842                                                         }
843                                                         if (base_var_found) {
844                                                                 base_var->next = NULL;
845                                                                 ast_variables_destroy(base_var);
846                                                                 base_var = next;
847                                                         } else {
848                                                                 if (append_var)
849                                                                         base_var->next = append_var;
850                                                                 else
851                                                                         base_var->next = NULL;
852                                                                 append_var = base_var;
853                                                                 base_var = next;
854                                                         }
855                                                 }
856                                         }
857                                         if (!tmp->next && append_var) {
858                                                 tmp->next = append_var;
859                                                 tmp = NULL;
860                                         } else
861                                                 tmp = tmp->next;
862                                 }
863                                 p++;
864                         }
865                 }
866         }
867
868         if (filter)
869                 ast_free(filter);
870
871         if (clean_basedn)
872                 ast_free(clean_basedn);
873
874         ast_mutex_unlock(&ldap_lock);
875
876         return vars;
877 }
878
879 /*! \brief same as realtime_ldap_base_ap but take variable arguments count list */
880 static struct ast_variable **realtime_ldap_base(unsigned int *entries_count_ptr,
881         const char *basedn, const char *table_name, ...)
882 {
883         struct ast_variable **vars = NULL;
884         va_list ap;
885
886         va_start(ap, table_name);
887         vars = realtime_ldap_base_ap(entries_count_ptr, basedn, table_name, ap);
888         va_end(ap);
889
890         return vars;
891 }
892
893 /*! \brief See Asterisk doc
894 *
895 * For Realtime Dynamic(i.e., switch, queues, and directory) -- I think
896 */
897 static struct ast_variable *realtime_ldap(const char *basedn,
898                                           const char *table_name, va_list ap)
899 {
900         struct ast_variable **vars = realtime_ldap_base_ap(NULL, basedn, table_name, ap);
901         struct ast_variable *var = NULL;
902
903         if (vars) {
904                 struct ast_variable *last_var = NULL;
905                 struct ast_variable **p = vars;
906                 while (*p) {
907                         if (last_var) {
908                                 while (last_var->next)
909                                         last_var = last_var->next;
910                                 last_var->next = *p;
911                         } else {
912                                 var = *p;
913                                 last_var = var;
914                         }
915                         p++;
916                 }
917                 free(vars);
918         }
919         return var;
920 }
921
922 /*! \brief See Asterisk doc
923 *
924 * this function will be called for the switch statment if no match is found with the realtime_ldap function(i.e. it is a failover);
925 * however, the ast_load_realtime wil match on wildcharacters also depending on what the mode is set to
926 * this is an area of asterisk that could do with a lot of modification
927 * I think this function returns Realtime dynamic objects
928 */
929 static struct ast_config *realtime_multi_ldap(const char *basedn,
930       const char *table_name, va_list ap)
931 {
932         struct ast_variable **vars =
933                 realtime_ldap_base_ap(NULL, basedn, table_name, ap);
934         struct ast_config *cfg = NULL;
935
936         if (vars) {
937                 cfg = ast_config_new();
938                 if (!cfg) {
939                         ast_log(LOG_WARNING, "Out of memory!\n");
940                 } else {
941                         struct ast_variable **p = vars;
942
943                         while (*p) {
944                                 struct ast_category *cat = NULL;
945                                 cat = ast_category_new("", table_name, -1);
946                                 if (!cat) {
947                                         ast_log(LOG_WARNING, "Out of memory!\n");
948                                         break;
949                                 } else {
950                                         struct ast_variable *var = *p;
951                                         while (var) {
952                                                 struct ast_variable *next = var->next;
953                                                 var->next = NULL;
954                                                 ast_variable_append(cat, var);
955                                                 var = next;
956                                         }
957                                 }
958                                 ast_category_append(cfg, cat);
959                                 p++;
960                         }
961                 }
962                 free(vars);
963         }
964         return cfg;
965
966 }
967
968 /*! 
969  * \brief Sorting alogrithm for qsort to find the order of the variables \a a and \a b
970  * \param \a a pointer to category_and_metric struct
971  * \param \a b pointer to category_and_metric struct
972  *
973  * \return the -1,0,1 (zero for equal, -1 for if b is greater, and 1 if a is greater)
974  */
975 static int compare_categories(const void *a, const void *b)
976 {
977         const struct category_and_metric *as = a;
978         const struct category_and_metric *bs = b;
979
980         if (as->metric < bs->metric)
981                 return -1;
982         else if (as->metric > bs->metric)
983                 return 1;
984         else if (as->metric == bs->metric && strcmp(as->name, bs->name) != 0)
985                 return strcmp(as->name, bs->name);
986
987         /* if the metric and the category name is the same, we check the variable metric */
988         if (as->var_metric < bs->var_metric)
989                 return -1;
990         else if (as->var_metric > bs->var_metric)
991                 return 1;
992
993         return 0;
994 }
995
996 /*! \brief See Asterisk doc
997  *
998 *       This is for Static Realtime (again: I think...)
999 *       
1000 *       load the configuration stuff for the .conf files
1001 *       called on a reload
1002 */
1003 static struct ast_config *config_ldap(const char *basedn, const char *table_name,
1004         const char *file, struct ast_config *cfg, struct ast_flags config_flags, const char *sugg_incl)
1005 {
1006         unsigned int vars_count = 0;
1007         struct ast_variable **vars;
1008         int i = 0;
1009         struct ast_variable *new_v = NULL;
1010         struct ast_category *cur_cat = NULL;
1011         const char *last_category = NULL;
1012         int last_category_metric = 0;
1013         struct category_and_metric *categories;
1014         struct ast_variable **p;
1015
1016         if (ast_strlen_zero(file) || !strcasecmp(file, RES_CONFIG_LDAP_CONF)) {
1017                 ast_log(LOG_WARNING, "Cannot configure myself.\n");
1018                 return NULL;
1019         }
1020
1021         vars = realtime_ldap_base(&vars_count, basedn, table_name, "filename",
1022                                 file, "commented", "FALSE", NULL);
1023
1024         if (!vars) {
1025                 ast_log(LOG_WARNING, "Could not find config '%s' in database.\n", file);
1026                 return NULL;
1027         }
1028
1029         /*!\note Since the items come back in random order, they need to be sorted
1030          * first, and since the data could easily exceed stack size, this is
1031          * allocated from the heap.
1032          */
1033         if (!(categories = ast_calloc(sizeof(*categories), vars_count)))
1034                 return NULL;
1035
1036         for (vars_count = 0, p = vars; *p; p++) {
1037                 struct ast_variable *category = variable_named(*p, "category");
1038                 struct ast_variable *cat_metric = variable_named(*p, "cat_metric");
1039                 struct ast_variable *var_name = variable_named(*p, "variable_name");
1040                 struct ast_variable *var_val = variable_named(*p, "variable_value");
1041                 struct ast_variable *var_metric = variable_named(*p, "var_metric");
1042                 struct ast_variable *dn = variable_named(*p, "dn");
1043                         
1044                 ast_debug(1, "category: %s\n", category->value);
1045                 ast_debug(1, "var_name: %s\n", var_name->value);
1046                 ast_debug(1, "var_val: %s\n", var_val->value);
1047                 ast_debug(1, "cat_metric: %s\n", cat_metric->value);
1048
1049                 if (!category) {
1050                         ast_log(LOG_ERROR,
1051                                         "No category name in entry '%s'  for file '%s'.\n",
1052                                         (dn ? dn->value : "?"), file);
1053                 } else if (!cat_metric) {
1054                         ast_log(LOG_ERROR,
1055                                         "No category metric in entry '%s'(category: %s) for file '%s'.\n",
1056                                         (dn ? dn->value : "?"), category->value, file);
1057                 } else if (!var_metric) {
1058                         ast_log(LOG_ERROR,
1059                                         "No variable metric in entry '%s'(category: %s) for file '%s'.\n",
1060                                         (dn ? dn->value : "?"), category->value, file);
1061                 } else if (!var_name) {
1062                         ast_log(LOG_ERROR,
1063                                         "No variable name in entry '%s' (category: %s metric: %s) for file '%s'.\n",
1064                                         (dn ? dn->value : "?"), category->value,
1065                                         cat_metric->value, file);
1066                 } else if (!var_val) {
1067                         ast_log(LOG_ERROR,
1068                                         "No variable value in entry '%s' (category: %s metric: %s variable: %s) for file '%s'.\n",
1069                                         (dn ? dn->value : "?"), category->value,
1070                                         cat_metric->value, var_name->value, file);
1071                 } else {
1072                         categories[vars_count].name = category->value;
1073                         categories[vars_count].metric = atoi(cat_metric->value);
1074                         categories[vars_count].variable_name = var_name->value;
1075                         categories[vars_count].variable_value = var_val->value;
1076                         categories[vars_count].var_metric = atoi(var_metric->value);
1077                         vars_count++;
1078                 }
1079         }
1080
1081         qsort(categories, vars_count, sizeof(*categories), compare_categories);
1082
1083         for (i = 0; i < vars_count; i++) {
1084                 if (!strcmp(categories[i].variable_name, "#include")) {
1085                         struct ast_flags config_flags = { 0 };
1086                         if (!ast_config_internal_load(categories[i].variable_value, cfg, config_flags, ""))
1087                                 break;
1088                         continue;
1089                 }
1090
1091                 if (!last_category || strcmp(last_category, categories[i].name) ||
1092                         last_category_metric != categories[i].metric) {
1093                         cur_cat = ast_category_new(categories[i].name, table_name, -1);
1094                         if (!cur_cat)
1095                                 break;
1096                         last_category = categories[i].name;
1097                         last_category_metric = categories[i].metric;
1098                         ast_category_append(cfg, cur_cat);
1099                 }
1100
1101                 if (!(new_v = ast_variable_new(categories[i].variable_name, categories[i].variable_value, table_name)))
1102                         break;
1103
1104                 ast_variable_append(cur_cat, new_v);
1105         }
1106
1107         free(vars);
1108         free(categories);
1109
1110         return cfg;
1111 }
1112
1113 /* \brief Function to update a set of values in ldap
1114 static
1115 */
1116 static int update_ldap(const char *basedn, const char *table_name, const char *attribute,
1117         const char *lookup, va_list ap)
1118 {
1119         int error = 0;
1120         LDAPMessage *ldap_entry = NULL;
1121         LDAPMod **ldap_mods;
1122         const char *newparam = NULL;
1123         const char *newval = NULL;
1124         char *dn;
1125         int num_entries = 0;
1126         int i = 0;
1127         int mods_size = 0;
1128         int mod_exists = 0;
1129         struct ldap_table_config *table_config = NULL;
1130         char *clean_basedn = NULL;
1131         struct ast_str *filter = NULL;
1132         int tries = 0;
1133         int result = 0;
1134         LDAPMessage *ldap_result = NULL;
1135
1136         if (!table_name) {
1137                 ast_log(LOG_WARNING, "No table_name specified.\n");
1138                 return -1;
1139         } 
1140
1141         if (!(filter = ast_str_create(80)))
1142                 return -1;
1143
1144         if (!attribute || !lookup) {
1145                 ast_log(LOG_WARNING,
1146                                 "LINE(%d): search parameters are empty.\n", __LINE__);
1147                 return -1;
1148         }
1149         ast_mutex_lock(&ldap_lock);
1150
1151         /* We now have our complete statement; Lets connect to the server and execute it.  */
1152         if (!ldap_reconnect()) {
1153                 ast_mutex_unlock(&ldap_lock);
1154                 return -1;
1155         }
1156
1157         table_config = table_config_for_table_name(table_name);
1158         if (!table_config) {
1159                 ast_log(LOG_WARNING, "No table named '%s'.\n", table_name);
1160                 ast_mutex_unlock(&ldap_lock);
1161                 return -1;
1162         }
1163
1164         clean_basedn = cleaned_basedn(NULL, basedn);
1165
1166         /* Create the filter with the table additional filter and the parameter/value pairs we were given */
1167         ast_str_append(&filter, 0, "(&");
1168         if (table_config && table_config->additional_filter) {
1169                 ast_str_append(&filter, 0, table_config->additional_filter);
1170         }
1171         if (table_config != base_table_config && base_table_config
1172                 && base_table_config->additional_filter) {
1173                 ast_str_append(&filter, 0, base_table_config->additional_filter);
1174         }
1175         append_var_and_value_to_filter(&filter, table_config, attribute, lookup);
1176         ast_str_append(&filter, 0, ")");
1177
1178         /* Create the modification array with the parameter/value pairs we were given, 
1179          * if there are several parameters with the same name, we collect them into 
1180          * one parameter/value pair and delimit them with a semicolon */
1181         newparam = va_arg(ap, const char *);
1182         newparam = convert_attribute_name_to_ldap(table_config, newparam);
1183         newval = va_arg(ap, const char *);
1184         if (!newparam || !newval) {
1185                 ast_log(LOG_WARNING,
1186                                 "LINE(%d): need at least one paramter to modify.\n", __LINE__);
1187                 return -1;
1188         }
1189
1190         mods_size = 2; /* one for the first param/value pair and one for the the terminating NULL */
1191         ldap_mods = ast_calloc(sizeof(LDAPMod *), mods_size);
1192         ldap_mods[0] = ast_calloc(1, sizeof(LDAPMod));
1193
1194         ldap_mods[0]->mod_op = LDAP_MOD_REPLACE;
1195         ldap_mods[0]->mod_type = ast_calloc(sizeof(char), strlen(newparam) + 1);
1196         strcpy(ldap_mods[0]->mod_type, newparam);
1197
1198         ldap_mods[0]->mod_values = ast_calloc(sizeof(char), 2);
1199         ldap_mods[0]->mod_values[0] = ast_calloc(sizeof(char), strlen(newval) + 1);
1200         strcpy(ldap_mods[0]->mod_values[0], newval);
1201
1202         while ((newparam = va_arg(ap, const char *))) {
1203                 newparam = convert_attribute_name_to_ldap(table_config, newparam);
1204                 newval = va_arg(ap, const char *);
1205                 mod_exists = 0;
1206
1207                 for (i = 0; i < mods_size - 1; i++) {
1208                         if (ldap_mods[i]&& !strcmp(ldap_mods[i]->mod_type, newparam)) {
1209                                 /* We have the parameter allready, adding the value as a semicolon delimited value */
1210                                 ldap_mods[i]->mod_values[0] = ast_realloc(ldap_mods[i]->mod_values[0], sizeof(char) * (strlen(ldap_mods[i]->mod_values[0]) + strlen(newval) + 2));
1211                                 strcat(ldap_mods[i]->mod_values[0], ";");
1212                                 strcat(ldap_mods[i]->mod_values[0], newval);
1213                                 mod_exists = 1; 
1214                                 break;
1215                         }
1216                 }
1217
1218                 /* create new mod */
1219                 if (!mod_exists) {
1220                         mods_size++;
1221                         ldap_mods = ast_realloc(ldap_mods, sizeof(LDAPMod *) * mods_size);
1222                         ldap_mods[mods_size - 1] = NULL;
1223                         ldap_mods[mods_size - 2] = ast_calloc(1, sizeof(LDAPMod));
1224
1225                         ldap_mods[mods_size - 2]->mod_op = LDAP_MOD_REPLACE;
1226
1227                         ldap_mods[mods_size - 2]->mod_type = ast_calloc(sizeof(char), strlen(newparam) + 1);
1228                         strcpy(ldap_mods[mods_size - 2]->mod_type, newparam);
1229
1230                         ldap_mods[mods_size - 2]->mod_values = ast_calloc(sizeof(char *), 2);
1231                         ldap_mods[mods_size - 2]->mod_values[0] = ast_calloc(sizeof(char), strlen(newval) + 1);
1232                         strcpy(ldap_mods[mods_size - 2]->mod_values[0], newval);
1233                 }
1234         }
1235         /* freeing ldap_mods further down */
1236
1237         do {
1238                 /* freeing ldap_result further down */
1239                 result = ldap_search_ext_s(ldapConn, clean_basedn,
1240                                   LDAP_SCOPE_SUBTREE, filter->str, NULL, 0, NULL, NULL, NULL, LDAP_NO_LIMIT,
1241                                   &ldap_result);
1242                 if (result < 0 && is_ldap_connect_error(result)) {
1243                         ast_log(LOG_WARNING, "Failed to query database. Try %d/3\n",
1244                                 tries + 1);
1245                         tries++;
1246                         if (tries < 3) {
1247                                 usleep(500000L * tries);
1248                                 if (ldapConn) {
1249                                         ldap_unbind_ext_s(ldapConn, NULL, NULL);
1250                                         ldapConn = NULL;
1251                                 }
1252                                 if (!ldap_reconnect())
1253                                         break;
1254                         }
1255                 }
1256         } while (result < 0 && tries < 3 && is_ldap_connect_error(result));
1257
1258         if (result < 0) {
1259                 ast_log(LOG_WARNING, "Failed to query directory. Check debug for more info.\n");
1260                 ast_log(LOG_WARNING, "Query: %s\n", filter->str);
1261                 ast_log(LOG_WARNING, "Query Failed because: %s\n",
1262                         ldap_err2string(result));
1263
1264                 ast_mutex_unlock(&ldap_lock);
1265                 if (filter)
1266                         free(filter);
1267                 if (clean_basedn)
1268                         free(clean_basedn);
1269                 ldap_msgfree(ldap_result);
1270                 ldap_mods_free(ldap_mods, 0);
1271                 return -1;
1272         }
1273         /* Ready to update */
1274         if ((num_entries = ldap_count_entries(ldapConn, ldap_result)) > 0) {
1275                 ast_debug(3, "LINE(%d) Modifying %s=%s hits: %d\n", __LINE__, attribute, lookup, num_entries);
1276                 for (i = 0; option_debug > 2 && i < mods_size - 1; i++)
1277                         ast_debug(3, "LINE(%d) %s=%s \n", __LINE__, ldap_mods[i]->mod_type, ldap_mods[i]->mod_values[0]);
1278
1279                 ldap_entry = ldap_first_entry(ldapConn, ldap_result);
1280
1281                 for (i = 0; ldap_entry; i++) { 
1282                         dn = ldap_get_dn(ldapConn, ldap_entry);
1283                         if (!(error = ldap_modify_ext_s(ldapConn, dn, ldap_mods, NULL, NULL))) 
1284                                 ast_log(LOG_ERROR, "Couldn't modify dn:%s because %s", dn, ldap_err2string(error));
1285
1286                         ldap_entry = ldap_next_entry(ldapConn, ldap_entry);
1287                 }
1288         }
1289
1290         ast_mutex_unlock(&ldap_lock);
1291         if (filter)
1292                 free(filter);
1293         if (clean_basedn)
1294                 free(clean_basedn);
1295         ldap_msgfree(ldap_result);
1296         ldap_mods_free(ldap_mods, 0);
1297         return num_entries;
1298 }
1299
1300 static struct ast_config_engine ldap_engine = {
1301         .name = "ldap",
1302         .load_func = config_ldap,
1303         .realtime_func = realtime_ldap,
1304         .realtime_multi_func = realtime_multi_ldap,
1305         .update_func = update_ldap
1306 };
1307
1308 static int load_module(void)
1309 {
1310         if (parse_config() < 0) {
1311                 ast_log(LOG_NOTICE, "Cannot load LDAP RealTime driver.\n");
1312                 return 0;
1313         }
1314
1315         ast_mutex_lock(&ldap_lock);
1316
1317         if (!ldap_reconnect()) 
1318                 ast_log(LOG_WARNING, "Couldn't establish connection. Check debug.\n");
1319
1320         ast_config_engine_register(&ldap_engine);
1321         ast_verb(1, "LDAP RealTime driver loaded.\n");
1322         ast_cli_register_multiple(ldap_cli, sizeof(ldap_cli) / sizeof(struct ast_cli_entry));
1323
1324         ast_mutex_unlock(&ldap_lock);
1325
1326         return 0;
1327 }
1328
1329 static int unload_module(void)
1330 {
1331         /* Aquire control before doing anything to the module itself. */
1332         ast_mutex_lock(&ldap_lock);
1333
1334         table_configs_free();
1335
1336         if (ldapConn) {
1337                 ldap_unbind_ext_s(ldapConn, NULL, NULL);
1338                 ldapConn = NULL;
1339         }
1340         ast_cli_unregister_multiple(ldap_cli, sizeof(ldap_cli) / sizeof(struct ast_cli_entry));
1341         ast_config_engine_deregister(&ldap_engine);
1342         ast_verb(1, "LDAP RealTime unloaded.\n");
1343
1344         /* Unlock so something else can destroy the lock. */
1345         ast_mutex_unlock(&ldap_lock);
1346
1347         return 0;
1348 }
1349
1350 static int reload(void)
1351 {
1352         /* Aquire control before doing anything to the module itself. */
1353         ast_mutex_lock(&ldap_lock);
1354
1355         if (ldapConn) {
1356                 ldap_unbind_ext_s(ldapConn, NULL, NULL);
1357                 ldapConn = NULL;
1358         }
1359
1360         if (parse_config() < 0) {
1361                 ast_log(LOG_NOTICE, "Cannot reload LDAP RealTime driver.\n");
1362                 return 0;
1363         }               
1364
1365         if (!ldap_reconnect()) 
1366                 ast_log(LOG_WARNING, "Couldn't establish connection. Check debug.\n");
1367
1368         ast_verb(2, "LDAP RealTime reloaded.\n");
1369
1370         /* Done reloading. Release lock so others can now use driver. */
1371         ast_mutex_unlock(&ldap_lock);
1372
1373         return 0;
1374 }
1375
1376 int parse_config(void)
1377 {
1378         struct ast_config *config;
1379         struct ast_flags config_flags = {0};
1380         const char *s;
1381         char *category_name = NULL;
1382
1383         config = ast_config_load(RES_CONFIG_LDAP_CONF, config_flags);
1384
1385         if (!config) {
1386                 ast_log(LOG_WARNING, "Cannot load configuration %s\n", RES_CONFIG_LDAP_CONF);
1387                 return -1;
1388         }
1389
1390         if (!(s = ast_variable_retrieve(config, "_general", "user"))) {
1391                 ast_log(LOG_WARNING, "No directory user found, anonymous binding as default.\n");
1392                 user[0] = '\0';
1393         } else 
1394                 ast_copy_string(user, s, sizeof(user));
1395
1396         if (!(s = ast_variable_retrieve(config, "_general", "pass"))) {
1397                 ast_log(LOG_WARNING, "No directory password found, using 'asterisk' as default.\n");
1398                 ast_copy_string(pass, "asterisk", sizeof(pass) - 1);
1399         } else
1400                 ast_copy_string(pass, s, sizeof(pass));
1401
1402         if (!(s = ast_variable_retrieve(config, "_general", "host"))) {
1403                 ast_log(LOG_ERROR, "No directory host found.\n");
1404                 host[0] = '\0';
1405         } else {
1406                 ast_copy_string(host, "ldap://", 8 );
1407                 ast_copy_string(host + 7, s, sizeof(host));
1408         }
1409
1410         if (!(s = ast_variable_retrieve(config, "_general", "basedn"))) {
1411                 ast_log(LOG_ERROR, "No LDAP base dn found, using 'asterisk' as default.\n");
1412                 basedn[0] = '\0';
1413         } else 
1414                 ast_copy_string(basedn, s, sizeof(basedn));
1415
1416         if (!(s = ast_variable_retrieve(config, "_general", "port"))) {
1417                 ast_log(LOG_WARNING, "No directory port found, using 389 as default.\n");
1418                 port = 389;
1419                 ast_copy_string(host + strlen(host), ":389", sizeof(host));
1420         } else { 
1421                 ast_copy_string(host + 1, ":", sizeof(s));
1422                 ast_copy_string(host + strlen(host), s, sizeof(s));
1423                 port = atoi(s);
1424         }
1425
1426         table_configs_free();
1427
1428         while ((category_name = ast_category_browse(config, category_name))) {
1429                 int is_general = (strcasecmp(category_name, "_general") == 0);
1430                 int is_config = (strcasecmp(category_name, "config") == 0); /*!< using the [config] context for Static RealTime */
1431                 struct ast_variable *var = ast_variable_browse(config, category_name);
1432                 
1433                 if (var) {
1434                         struct ldap_table_config *table_config =
1435                                 table_config_for_table_name(category_name);
1436                         if (!table_config) {
1437                                 table_config = table_config_new(category_name);
1438                                 AST_LIST_INSERT_HEAD(&table_configs, table_config, entry);
1439                                 if (is_general)
1440                                         base_table_config = table_config;
1441                                 if (is_config)
1442                                         static_table_config = table_config;
1443                         }
1444                         for (; var; var = var->next) {
1445                                 if (!strcasecmp(var->name, "additionalFilter"))
1446                                         table_config->additional_filter = strdup(var->value);
1447                                 else
1448                                         ldap_table_config_add_attribute(table_config, var->name, var->value);
1449                         }
1450                 }
1451         }
1452
1453         ast_config_destroy(config);
1454
1455         return 1;
1456 }
1457
1458 /*! \note ldap_lock should have been locked before calling this function. */
1459 static int ldap_reconnect(void)
1460 {
1461         int bind_result = 0;
1462         struct berval cred;
1463
1464         if (ldapConn) {
1465                 ast_debug(2, "Everything seems fine.\n");
1466                 return 1;
1467         }
1468
1469         if (ast_strlen_zero(host)) {
1470                 ast_log(LOG_ERROR, "Not enough parameters to connect to ldap database\n");
1471                 return 0;
1472         }
1473
1474         if (LDAP_SUCCESS != ldap_initialize(&ldapConn, host)) {
1475                 ast_log(LOG_ERROR, "Failed to init ldap connection to %s. Check debug for more info.\n", host);
1476                 return 0;
1477         } 
1478
1479         if (!ast_strlen_zero(user)) {
1480                 ast_debug(2, "bind to %s as %s\n", host, user);
1481                 cred.bv_val = (char *) pass;
1482                 cred.bv_len = strlen(pass);
1483                 bind_result = ldap_sasl_bind_s(ldapConn, user, LDAP_SASL_SIMPLE, &cred, NULL, NULL, NULL);
1484         } else {
1485                 ast_debug(2, "bind anonymously %s anonymously\n", host);
1486                 bind_result = ldap_sasl_bind_s(ldapConn, NULL, LDAP_SASL_SIMPLE, NULL, NULL, NULL, NULL);
1487         }
1488         if (bind_result == LDAP_SUCCESS) {
1489                 ast_debug(2, "Successfully connected to database.\n");
1490                 connect_time = time(NULL);
1491                 return 1;
1492         } else {
1493                 ast_log(LOG_WARNING, "bind failed: %s\n", ldap_err2string(bind_result));
1494                 ldap_unbind_ext_s(ldapConn, NULL, NULL);
1495                 ldapConn = NULL;
1496                 return 0;
1497         }
1498 }
1499
1500 static char *realtime_ldap_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1501 {
1502         char status[256], status2[100] = "";
1503         int ctime = time(NULL) - connect_time;
1504
1505         switch (cmd) {
1506         case CLI_INIT:
1507                 e->command = "realtime ldap status";
1508                 e->usage =
1509                         "Usage: realtime ldap status\n"
1510                         "               Shows connection information for the LDAP RealTime driver\n";
1511                 return NULL;
1512         case CLI_GENERATE:
1513                 return NULL;
1514         }
1515
1516         if (!ldapConn)
1517                 return CLI_FAILURE;
1518
1519         if (!ast_strlen_zero(host)) 
1520                 snprintf(status, sizeof(status), "Connected to %s, port %d baseDN %s", host, port, basedn);
1521
1522         if (!ast_strlen_zero(user))
1523                 snprintf(status2, sizeof(status2), " with username %s", user);
1524
1525         if (ctime > 31536000) {
1526                 ast_cli(a->fd, "%s%s for %d years, %d days, %d hours, %d minutes, %d seconds.\n",
1527                                 status, status2, ctime / 31536000,
1528                                 (ctime % 31536000) / 86400, (ctime % 86400) / 3600,
1529                                 (ctime % 3600) / 60, ctime % 60);
1530         } else if (ctime > 86400) {
1531                 ast_cli(a->fd, "%s%s for %d days, %d hours, %d minutes, %d seconds.\n",
1532                                 status, status2, ctime / 86400, (ctime % 86400) / 3600,
1533                                 (ctime % 3600) / 60, ctime % 60);
1534         } else if (ctime > 3600) {
1535                 ast_cli(a->fd, "%s%s for %d hours, %d minutes, %d seconds.\n",
1536                                 status, status2, ctime / 3600, (ctime % 3600) / 60,
1537                                 ctime % 60);
1538         } else if (ctime > 60) {
1539                 ast_cli(a->fd, "%s%s for %d minutes, %d seconds.\n", status, status2,
1540                                         ctime / 60, ctime % 60);
1541         } else {
1542                 ast_cli(a->fd, "%s%s for %d seconds.\n", status, status2, ctime);
1543         }
1544
1545         return CLI_SUCCESS;
1546 }
1547
1548 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "LDAP realtime interface",
1549         .load = load_module,
1550         .unload = unload_module,
1551         .reload = reload,
1552 );