Make phoneprov case-insensitive to remove the func_strings dependency of the default...
[asterisk/asterisk.git] / res / res_phoneprov.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2008, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * Matthew Brooks <mbrooks@digium.com>
8  * Terry Wilson <twilson@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 /*! \file
22  *
23  * \brief Phone provisioning application for the asterisk internal http server
24  *
25  * \author Matthew Brooks <mbrooks@digium.com>
26  * \author Terry Wilson <twilson@digium.com>
27  */
28
29 #include "asterisk.h"
30
31 #include <ctype.h>
32 #include <sys/ioctl.h>
33 #include <sys/socket.h>
34 #include <net/if.h>
35 #ifdef SOLARIS
36 #include <sys/sockio.h>
37 #endif
38 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 96773 $")
39
40 #include "asterisk/channel.h"
41 #include "asterisk/file.h"
42 #include "asterisk/paths.h"
43 #include "asterisk/pbx.h"
44 #include "asterisk/cli.h"
45 #include "asterisk/module.h"
46 #include "asterisk/http.h"
47 #include "asterisk/utils.h"
48 #include "asterisk/app.h"
49 #include "asterisk/strings.h"
50 #include "asterisk/stringfields.h"
51 #include "asterisk/options.h"
52 #include "asterisk/config.h"
53 #include "asterisk/acl.h"
54 #include "asterisk/astobj2.h"
55 #include "asterisk/ast_version.h"
56
57 #ifdef LOW_MEMORY
58 #define MAX_PROFILE_BUCKETS 1
59 #define MAX_ROUTE_BUCKETS 1
60 #define MAX_USER_BUCKETS 1
61 #else
62 #define MAX_PROFILE_BUCKETS 17
63 #define MAX_ROUTE_BUCKETS 563
64 #define MAX_USER_BUCKETS 563
65 #endif /* LOW_MEMORY */
66
67 #define VAR_BUF_SIZE 4096
68
69 /*! \brief for use in lookup_iface */
70 static struct in_addr __ourip = { .s_addr = 0x00000000, };
71
72 /* \note This enum and the pp_variable_list must be in the same order or
73  * bad things happen! */
74 enum pp_variables {
75         PP_MACADDRESS,
76         PP_USERNAME,
77         PP_FULLNAME,
78         PP_SECRET,
79         PP_LABEL,
80         PP_CALLERID,
81         PP_TIMEZONE,
82         PP_LINENUMBER,
83         PP_VAR_LIST_LENGTH,     /* This entry must always be the last in the list */
84 };
85
86 /*! \brief Lookup table to translate between users.conf property names and
87  * variables for use in phoneprov templates */
88 static const struct pp_variable_lookup {
89         enum pp_variables id;
90         const char * const user_var;
91         const char * const template_var;
92 } pp_variable_list[] = {
93         { PP_MACADDRESS, "macaddress", "MAC" },
94         { PP_USERNAME, "username", "USERNAME" },
95         { PP_FULLNAME, "fullname", "DISPLAY_NAME" },
96         { PP_SECRET, "secret", "SECRET" },
97         { PP_LABEL, "label", "LABEL" },
98         { PP_CALLERID, "cid_number", "CALLERID" },
99         { PP_TIMEZONE, "timezone", "TIMEZONE" },
100         { PP_LINENUMBER, "linenumber", "LINE" },
101 };
102
103 /*! \brief structure to hold file data */
104 struct phoneprov_file {
105         AST_DECLARE_STRING_FIELDS(
106                 AST_STRING_FIELD(format);       /*!< After variable substitution, becomes route->uri */
107                 AST_STRING_FIELD(template); /*!< Template/physical file location */
108                 AST_STRING_FIELD(mime_type);/*!< Mime-type of the file */
109         );
110         AST_LIST_ENTRY(phoneprov_file) entry;
111 };
112
113 /*! \brief structure to hold phone profiles read from phoneprov.conf */
114 struct phone_profile {
115         AST_DECLARE_STRING_FIELDS(
116                 AST_STRING_FIELD(name); /*!< Name of phone profile */
117                 AST_STRING_FIELD(default_mime_type);    /*!< Default mime type if it isn't provided */
118                 AST_STRING_FIELD(staticdir);    /*!< Subdirectory that static files are stored in */
119         );
120         struct varshead *headp; /*!< List of variables set with 'setvar' in phoneprov.conf */
121         AST_LIST_HEAD_NOLOCK(, phoneprov_file) static_files;    /*!< List of static files */
122         AST_LIST_HEAD_NOLOCK(, phoneprov_file) dynamic_files;   /*!< List of dynamic files */
123 };
124
125 struct extension {
126         AST_DECLARE_STRING_FIELDS(
127                 AST_STRING_FIELD(name);
128         );
129         int index;
130         struct varshead *headp; /*!< List of variables to substitute into templates */
131         AST_LIST_ENTRY(extension) entry;
132 };
133
134 /*! \brief structure to hold users read from users.conf */
135 struct user {
136         AST_DECLARE_STRING_FIELDS(
137                 AST_STRING_FIELD(macaddress);   /*!< Mac address of user's phone */
138         );
139         struct phone_profile *profile;  /*!< Profile the phone belongs to */
140         AST_LIST_HEAD_NOLOCK(, extension) extensions;
141 };
142
143 /*! \brief structure to hold http routes (valid URIs, and the files they link to) */
144 struct http_route {
145         AST_DECLARE_STRING_FIELDS(
146                 AST_STRING_FIELD(uri);  /*!< The URI requested */
147         );
148         struct phoneprov_file *file;    /*!< The file that links to the URI */
149         struct user *user;      /*!< The user that has variables to substitute into the file
150                                                  * NULL in the case of a static route */
151 };
152
153 static struct ao2_container *profiles;
154 static struct ao2_container *http_routes;
155 static struct ao2_container *users;
156
157 /*! \brief Extensions whose mime types we think we know */
158 static struct {
159         char *ext;
160         char *mtype;
161 } mimetypes[] = {
162         { "png", "image/png" },
163         { "xml", "text/xml" },
164         { "jpg", "image/jpeg" },
165         { "js", "application/x-javascript" },
166         { "wav", "audio/x-wav" },
167         { "mp3", "audio/mpeg" },
168 };
169
170 static char global_server[80] = "";     /*!< Server to substitute into templates */
171 static char global_serverport[6] = "";  /*!< Server port to substitute into templates */
172 static char global_default_profile[80] = "";    /*!< Default profile to use if one isn't specified */   
173
174 /*! \brief List of global variables currently available: VOICEMAIL_EXTEN, EXTENSION_LENGTH */
175 static struct varshead global_variables;
176 static ast_mutex_t globals_lock;
177
178 /*! \brief Return mime type based on extension */
179 static char *ftype2mtype(const char *ftype)
180 {
181         int x;
182
183         if (ast_strlen_zero(ftype))
184                 return NULL;
185
186         for (x = 0;x < ARRAY_LEN(mimetypes);x++) {
187                 if (!strcasecmp(ftype, mimetypes[x].ext))
188                         return mimetypes[x].mtype;
189         }
190         
191         return NULL;
192 }
193
194 /* iface is the interface (e.g. eth0); address is the return value */
195 static int lookup_iface(const char *iface, struct in_addr *address)
196 {
197         int mysock, res = 0;
198         struct ifreq ifr;
199         struct sockaddr_in *sin;
200
201         memset(&ifr, 0, sizeof(ifr));
202         ast_copy_string(ifr.ifr_name, iface, sizeof(ifr.ifr_name));
203
204         mysock = socket(PF_INET, SOCK_DGRAM, IPPROTO_IP);
205         if (mysock < 0) {
206                 ast_log(LOG_ERROR, "Failed to create socket: %s\n", strerror(errno));
207                 return -1;
208         }
209
210         res = ioctl(mysock, SIOCGIFADDR, &ifr);
211
212         close(mysock);
213
214         if (res < 0) {
215                 ast_log(LOG_WARNING, "Unable to get IP of %s: %s\n", iface, strerror(errno));
216                 memcpy(address, &__ourip, sizeof(__ourip));
217                 return -1;
218         } else {
219                 sin = (struct sockaddr_in *)&ifr.ifr_addr;
220                 memcpy(address, &sin->sin_addr, sizeof(*address));
221                 return 0;
222         }
223 }
224
225 static struct phone_profile *unref_profile(struct phone_profile *prof)
226 {
227         ao2_ref(prof, -1);
228
229         return NULL;
230 }
231
232 /*! \brief Return a phone profile looked up by name */
233 static struct phone_profile *find_profile(const char *name)
234 {
235         struct phone_profile tmp = {
236                 .name = name,
237         };
238
239         return ao2_find(profiles, &tmp, OBJ_POINTER);
240 }
241
242 static int profile_hash_fn(const void *obj, const int flags)
243 {
244         const struct phone_profile *profile = obj;
245         
246         return ast_str_hash(profile->name);
247 }
248
249 static int profile_cmp_fn(void *obj, void *arg, int flags)
250 {
251         const struct phone_profile *profile1 = obj, *profile2 = arg;
252
253         return !strcasecmp(profile1->name, profile2->name) ? CMP_MATCH | CMP_STOP : 0;
254 }
255
256 static void delete_file(struct phoneprov_file *file)
257 {
258         ast_string_field_free_memory(file);
259         free(file);
260 }
261
262 static void profile_destructor(void *obj)
263 {
264         struct phone_profile *profile = obj;
265         struct phoneprov_file *file;
266         struct ast_var_t *var;
267
268         while ((file = AST_LIST_REMOVE_HEAD(&profile->static_files, entry)))
269                 delete_file(file);
270
271         while ((file = AST_LIST_REMOVE_HEAD(&profile->dynamic_files, entry)))
272                 delete_file(file);
273
274         while ((var = AST_LIST_REMOVE_HEAD(profile->headp, entries)))
275                 ast_var_delete(var);
276
277         ast_free(profile->headp);
278         ast_string_field_free_memory(profile);
279 }
280
281 static struct http_route *unref_route(struct http_route *route)
282 {
283         ao2_ref(route, -1);
284
285         return NULL;
286 }
287
288 static int routes_hash_fn(const void *obj, const int flags)
289 {
290         const struct http_route *route = obj;
291         char *tmp,  *uri;
292    
293         uri = tmp = ast_strdupa(route->uri);
294
295         while (*tmp++) {
296                 *tmp = tolower(*tmp);
297         }
298
299         return ast_str_hash(uri);
300 }
301
302 static int routes_cmp_fn(void *obj, void *arg, int flags)
303 {
304         const struct http_route *route1 = obj, *route2 = arg;
305
306         return !strcasecmp(route1->uri, route2->uri) ? CMP_MATCH | CMP_STOP : 0;
307 }
308
309 static void route_destructor(void *obj)
310 {
311         struct http_route *route = obj;
312
313         ast_string_field_free_memory(route);
314 }
315
316 /*! \brief Read a TEXT file into a string and return the length */
317 static int load_file(const char *filename, char **ret)
318 {
319         int len = 0;
320         FILE *f;
321         
322         if (!(f = fopen(filename, "r"))) {
323                 *ret = NULL;
324                 return -1;
325         }
326
327         fseek(f, 0, SEEK_END);
328         len = ftell(f);
329         fseek(f, 0, SEEK_SET);
330         if (!(*ret = ast_malloc(len + 1)))
331                 return -2;
332
333         if (len != fread(*ret, sizeof(char), len, f)) {
334                 free(*ret);
335                 *ret = NULL;
336                 return -3;
337         }
338
339         fclose(f);
340
341         (*ret)[len] = '\0';
342
343         return len;
344 }
345
346 /*! \brief Set all timezone-related variables based on a zone (i.e. America/New_York)
347         \param headp pointer to list of user variables
348         \param zone A time zone. NULL sets variables based on timezone of the machine
349 */
350 static void set_timezone_variables(struct varshead *headp, const char *zone)
351 {
352         time_t utc_time;
353         int dstenable;
354         time_t dststart;
355         time_t dstend;
356         struct ast_tm tm_info;
357         int tzoffset;
358         char buffer[21];
359         struct ast_var_t *var;
360         struct timeval when;
361
362         time(&utc_time);
363         ast_get_dst_info(&utc_time, &dstenable, &dststart, &dstend, &tzoffset, zone);
364         snprintf(buffer, sizeof(buffer), "%d", tzoffset);
365         var = ast_var_assign("TZOFFSET", buffer);
366         if (var)
367                 AST_LIST_INSERT_TAIL(headp, var, entries); 
368
369         if (!dstenable)
370                 return;
371
372         if ((var = ast_var_assign("DST_ENABLE", "1")))
373                 AST_LIST_INSERT_TAIL(headp, var, entries);
374
375         when.tv_sec = dststart; 
376         ast_localtime(&when, &tm_info, zone);
377
378         snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_mon+1);
379         if ((var = ast_var_assign("DST_START_MONTH", buffer)))
380                 AST_LIST_INSERT_TAIL(headp, var, entries);
381
382         snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_mday);
383         if ((var = ast_var_assign("DST_START_MDAY", buffer)))
384                 AST_LIST_INSERT_TAIL(headp, var, entries);
385
386         snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_hour);
387         if ((var = ast_var_assign("DST_START_HOUR", buffer)))
388                 AST_LIST_INSERT_TAIL(headp, var, entries);
389
390         when.tv_sec = dstend;
391         ast_localtime(&when, &tm_info, zone);
392
393         snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_mon + 1);
394         if ((var = ast_var_assign("DST_END_MONTH", buffer)))
395                 AST_LIST_INSERT_TAIL(headp, var, entries);
396
397         snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_mday);
398         if ((var = ast_var_assign("DST_END_MDAY", buffer)))
399                 AST_LIST_INSERT_TAIL(headp, var, entries);
400
401         snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_hour);
402         if ((var = ast_var_assign("DST_END_HOUR", buffer)))
403                 AST_LIST_INSERT_TAIL(headp, var, entries);
404 }
405
406 /*! \brief Callback that is executed everytime an http request is received by this module */
407 static struct ast_str *phoneprov_callback(struct ast_tcptls_session_instance *ser, const struct ast_http_uri *urih, const char *uri, enum ast_http_method method, struct ast_variable *vars, struct ast_variable *headers, int *status, char **title, int *contentlength)
408 {
409         struct http_route *route;
410         struct http_route search_route = {
411                 .uri = uri,
412         };
413         struct ast_str *result = ast_str_create(512);
414         char path[PATH_MAX];
415         char *file = NULL;
416         int len;
417         int fd;
418         char buf[256];
419         struct timeval now = ast_tvnow();
420         struct ast_tm tm;
421
422         if (!(route = ao2_find(http_routes, &search_route, OBJ_POINTER))) {
423                 goto out404;
424         }
425
426         snprintf(path, sizeof(path), "%s/phoneprov/%s", ast_config_AST_DATA_DIR, route->file->template);
427
428         if (!route->user) { /* Static file */
429
430                 fd = open(path, O_RDONLY);
431                 if (fd < 0) {
432                         goto out500;
433                 }
434
435                 len = lseek(fd, 0, SEEK_END);
436                 lseek(fd, 0, SEEK_SET);
437                 if (len < 0) {
438                         ast_log(LOG_WARNING, "Could not load file: %s (%d)\n", path, len);
439                         close(fd);
440                         goto out500;
441                 }
442
443                 ast_strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S %Z", ast_localtime(&now, &tm, "GMT"));
444                 fprintf(ser->f, "HTTP/1.1 200 OK\r\n"
445                         "Server: Asterisk/%s\r\n"
446                         "Date: %s\r\n"
447                         "Connection: close\r\n"
448                         "Cache-Control: no-cache, no-store\r\n"
449                         "Content-Length: %d\r\n"
450                         "Content-Type: %s\r\n\r\n",
451                         ast_get_version(), buf, len, route->file->mime_type);
452                 
453                 while ((len = read(fd, buf, sizeof(buf))) > 0) {
454                         fwrite(buf, 1, len, ser->f);
455                 }
456
457                 close(fd);
458                 route = unref_route(route);
459                 return NULL;
460         } else { /* Dynamic file */
461                 int bufsize;
462                 char *tmp;
463
464                 len = load_file(path, &file);
465                 if (len < 0) {
466                         ast_log(LOG_WARNING, "Could not load file: %s (%d)\n", path, len);
467                         if (file) {
468                                 ast_free(file);
469                         }
470
471                         goto out500;
472                 }
473
474                 if (!file) {
475                         goto out500;
476                 }
477
478                 /* XXX This is a hack -- maybe sum length of all variables in route->user->headp and add that? */
479                 bufsize = len + VAR_BUF_SIZE;
480                 
481                 /* malloc() instead of alloca() here, just in case the file is bigger than
482                  * we have enough stack space for. */
483                 if (!(tmp = ast_calloc(1, bufsize))) {
484                         if (file) {
485                                 ast_free(file);
486                         }
487
488                         goto out500;
489                 }
490
491                 /* Unless we are overridden by serveriface or serveraddr, we set the SERVER variable to
492                  * the IP address we are listening on that the phone contacted for this config file */
493                 if (ast_strlen_zero(global_server)) {
494                         struct sockaddr name;
495                         socklen_t namelen = sizeof(name);
496                         int res;
497
498                         if ((res = getsockname(ser->fd, &name, &namelen))) {
499                                 ast_log(LOG_WARNING, "Could not get server IP, breakage likely.\n");
500                         } else {
501                                 struct ast_var_t *var;
502                                 struct extension *exten_iter;
503
504                                 if ((var = ast_var_assign("SERVER", ast_inet_ntoa(((struct sockaddr_in *)&name)->sin_addr)))) {
505                                         AST_LIST_TRAVERSE(&route->user->extensions, exten_iter, entry) {
506                                                 AST_LIST_INSERT_TAIL(exten_iter->headp, var, entries);
507                                         }
508                                 }
509                         }
510                 }
511
512                 pbx_substitute_variables_varshead(AST_LIST_FIRST(&route->user->extensions)->headp, file, tmp, bufsize);
513         
514                 if (file) {
515                         ast_free(file);
516                 }
517
518                 ast_str_append(&result, 0,
519                         "Content-Type: %s\r\n"
520                         "Content-length: %d\r\n"
521                         "\r\n"
522                         "%s", route->file->mime_type, (int) strlen(tmp), tmp);
523
524                 if (tmp) {
525                         ast_free(tmp);
526                 }
527
528                 route = unref_route(route);
529
530                 return result;
531         }
532
533 out404:
534         *status = 404;
535         *title = strdup("Not Found");
536         *contentlength = 0;
537         return ast_http_error(404, "Not Found", NULL, "The requested URL was not found on this server.");
538
539 out500:
540         route = unref_route(route);
541         *status = 500;
542         *title = strdup("Internal Server Error");
543         *contentlength = 0;
544         return ast_http_error(500, "Internal Error", NULL, "An internal error has occured.");
545 }
546
547 /*! \brief Build a route structure and add it to the list of available http routes
548         \param pp_file File to link to the route
549         \param user User to link to the route (NULL means static route)
550         \param uri URI of the route
551 */
552 static void build_route(struct phoneprov_file *pp_file, struct user *user, char *uri)
553 {
554         struct http_route *route;
555         
556         if (!(route = ao2_alloc(sizeof(*route), route_destructor))) {
557                 return;
558         }
559
560         if (ast_string_field_init(route, 32)) {
561                 ast_log(LOG_ERROR, "Couldn't create string fields for %s\n", pp_file->format);
562                 route = unref_route(route);
563                 return;
564         }
565
566         ast_string_field_set(route, uri, S_OR(uri, pp_file->format));
567         route->user = user;
568         route->file = pp_file;
569
570         ao2_link(http_routes, route);
571
572         route = unref_route(route);
573 }
574
575 /*! \brief Build a phone profile and add it to the list of phone profiles
576         \param name the name of the profile
577         \param v ast_variable from parsing phoneprov.conf
578 */
579 static void build_profile(const char *name, struct ast_variable *v)
580 {
581         struct phone_profile *profile;
582         struct ast_var_t *var;
583
584         if (!(profile = ao2_alloc(sizeof(*profile), profile_destructor))) {
585                 return;
586         }
587
588         if (ast_string_field_init(profile, 32)) {
589                 profile = unref_profile(profile);
590                 return;
591         }
592         
593         if (!(profile->headp = ast_calloc(1, sizeof(*profile->headp)))) {
594                 profile = unref_profile(profile);
595                 return;
596         }
597
598         AST_LIST_HEAD_INIT_NOLOCK(&profile->static_files);
599         AST_LIST_HEAD_INIT_NOLOCK(&profile->dynamic_files);
600
601         ast_string_field_set(profile, name, name);
602         for (; v; v = v->next) {
603                 if (!strcasecmp(v->name, "mime_type")) {
604                         ast_string_field_set(profile, default_mime_type, v->value);
605                 } else if (!strcasecmp(v->name, "setvar")) {
606                         struct ast_var_t *variable;
607                         char *value_copy = ast_strdupa(v->value);
608
609                         AST_DECLARE_APP_ARGS(args,
610                                 AST_APP_ARG(varname);
611                                 AST_APP_ARG(varval);
612                         );
613                         
614                         AST_NONSTANDARD_APP_ARGS(args, value_copy, '=');
615                         do {
616                                 if (ast_strlen_zero(args.varname) || ast_strlen_zero(args.varval))
617                                         break;
618                                 args.varname = ast_strip(args.varname);
619                                 args.varval = ast_strip(args.varval);
620                                 if (ast_strlen_zero(args.varname) || ast_strlen_zero(args.varval))
621                                         break;
622                                 if ((variable = ast_var_assign(args.varname, args.varval)))
623                                         AST_LIST_INSERT_TAIL(profile->headp, variable, entries);
624                         } while (0);
625                 } else if (!strcasecmp(v->name, "staticdir")) {
626                         ast_string_field_set(profile, staticdir, v->value);
627                 } else {
628                         struct phoneprov_file *pp_file;
629                         char *file_extension;
630                         char *value_copy = ast_strdupa(v->value); 
631
632                         AST_DECLARE_APP_ARGS(args,
633                                 AST_APP_ARG(filename);
634                                 AST_APP_ARG(mimetype);
635                         );
636
637                         if (!(pp_file = ast_calloc(1, sizeof(*pp_file)))) {
638                                 profile = unref_profile(profile);
639                                 return;
640                         }
641                         if (ast_string_field_init(pp_file, 32)) {
642                                 ast_free(pp_file);
643                                 profile = unref_profile(profile);
644                                 return;
645                         }
646
647                         if ((file_extension = strrchr(pp_file->format, '.')))
648                                 file_extension++;
649
650                         AST_STANDARD_APP_ARGS(args, value_copy);
651
652                         /* Mime type order of preference
653                          * 1) Specific mime-type defined for file in profile
654                          * 2) Mime determined by extension
655                          * 3) Default mime type specified in profile
656                          * 4) text/plain
657                          */
658                         ast_string_field_set(pp_file, mime_type, S_OR(args.mimetype, (S_OR(S_OR(ftype2mtype(file_extension), profile->default_mime_type), "text/plain"))));
659
660                         if (!strcasecmp(v->name, "static_file")) {
661                                 ast_string_field_set(pp_file, format, args.filename);
662                                 ast_string_field_build(pp_file, template, "%s%s", profile->staticdir, args.filename);
663                                 AST_LIST_INSERT_TAIL(&profile->static_files, pp_file, entry);
664                                 /* Add a route for the static files, as their filenames won't change per-user */
665                                 build_route(pp_file, NULL, NULL);
666                         } else {
667                                 ast_string_field_set(pp_file, format, v->name);
668                                 ast_string_field_set(pp_file, template, args.filename);
669                                 AST_LIST_INSERT_TAIL(&profile->dynamic_files, pp_file, entry);
670                         }
671                 }
672         }
673
674         /* Append the global variables to the variables list for this profile.
675          * This is for convenience later, when we need to provide a single
676          * variable list for use in substitution. */
677         ast_mutex_lock(&globals_lock);
678         AST_LIST_TRAVERSE(&global_variables, var, entries) {
679                 struct ast_var_t *new_var;
680                 if ((new_var = ast_var_assign(var->name, var->value))) {
681                         AST_LIST_INSERT_TAIL(profile->headp, new_var, entries);
682                 }
683         }
684         ast_mutex_unlock(&globals_lock);
685
686         ao2_link(profiles, profile);
687
688         profile = unref_profile(profile);
689 }
690
691 static struct extension *delete_extension(struct extension *exten)
692 {
693         struct ast_var_t *var;
694         while ((var = AST_LIST_REMOVE_HEAD(exten->headp, entries))) {
695                 ast_var_delete(var);
696         }
697         ast_free(exten->headp);
698         ast_string_field_free_memory(exten);
699
700         ast_free(exten);
701
702         return NULL;
703 }
704
705 static struct extension *build_extension(struct ast_config *cfg, const char *name)
706 {
707         struct extension *exten;
708         struct ast_var_t *var;
709         const char *tmp;
710         int i;
711
712         if (!(exten = ast_calloc(1, sizeof(*exten)))) {
713                 return NULL;
714         }
715         
716         if (ast_string_field_init(exten, 32)) {
717                 ast_free(exten);
718                 exten = NULL;
719                 return NULL;
720         }
721         
722         ast_string_field_set(exten, name, name);
723         
724         if (!(exten->headp = ast_calloc(1, sizeof(*exten->headp)))) {
725                 ast_free(exten);
726                 exten = NULL;
727                 return NULL;
728         }
729
730         for (i = 0; i < PP_VAR_LIST_LENGTH; i++) {
731                 tmp = ast_variable_retrieve(cfg, name, pp_variable_list[i].user_var);
732
733                 /* If we didn't get a USERNAME variable, set it to the user->name */
734                 if (i == PP_USERNAME && !tmp) {
735                         if ((var = ast_var_assign(pp_variable_list[PP_USERNAME].template_var, exten->name))) {
736                                 AST_LIST_INSERT_TAIL(exten->headp, var, entries);
737                         }
738                         continue;
739                 } else if (i == PP_TIMEZONE) {
740                         /* perfectly ok if tmp is NULL, will set variables based on server's time zone */
741                         set_timezone_variables(exten->headp, tmp);
742                 } else if (i == PP_LINENUMBER) {
743                         if (!tmp) {
744                                 tmp = "1";
745                         }
746                         exten->index = atoi(tmp);
747                 }
748
749                 if (tmp && (var = ast_var_assign(pp_variable_list[i].template_var, tmp))) {
750                         AST_LIST_INSERT_TAIL(exten->headp, var, entries);
751                 }
752         }
753
754         if (!ast_strlen_zero(global_server)) {
755                 if ((var = ast_var_assign("SERVER", global_server)))
756                         AST_LIST_INSERT_TAIL(exten->headp, var, entries);
757         }
758
759         if (!ast_strlen_zero(global_serverport)) {
760                 if ((var = ast_var_assign("SERVER_PORT", global_serverport)))
761                         AST_LIST_INSERT_TAIL(exten->headp, var, entries);
762         }
763
764         return exten;
765 }
766
767 static struct user *unref_user(struct user *user)
768 {
769         ao2_ref(user, -1);
770
771         return NULL;
772 }
773
774 /*! \brief Return a user looked up by name */
775 static struct user *find_user(const char *macaddress)
776 {
777         struct user tmp = {
778                 .macaddress = macaddress,
779         };
780
781         return ao2_find(users, &tmp, OBJ_POINTER);
782 }
783
784 static int users_hash_fn(const void *obj, const int flags)
785 {
786         const struct user *user = obj;
787         char *tmp, *mac;
788
789         mac = tmp = ast_strdupa(user->macaddress);
790
791         while (*tmp++) {
792                 *tmp = tolower(*tmp);
793         }
794         
795         return ast_str_hash(mac);
796 }
797
798 static int users_cmp_fn(void *obj, void *arg, int flags)
799 {
800         const struct user *user1 = obj, *user2 = arg;
801
802         return !strcasecmp(user1->macaddress, user2->macaddress) ? CMP_MATCH | CMP_STOP : 0;
803 }
804
805 /*! \brief Free all memory associated with a user */
806 static void user_destructor(void *obj)
807 {
808         struct user *user = obj;
809         struct extension *exten;
810
811         while ((exten = AST_LIST_REMOVE_HEAD(&user->extensions, entry))) {
812                 exten = delete_extension(exten);
813         }
814
815         if (user->profile) {
816                 user->profile = unref_profile(user->profile);
817         }
818         
819         ast_string_field_free_memory(user);
820 }
821
822 /*! \brief Delete all users */
823 static void delete_users(void)
824 {
825         struct ao2_iterator i;
826         struct user *user;
827
828         i = ao2_iterator_init(users, 0);
829         while ((user = ao2_iterator_next(&i))) {
830                 ao2_unlink(users, user);
831                 user = unref_user(user);
832         }
833 }
834
835 /*! \brief Build and return a user structure based on gathered config data */
836 static struct user *build_user(const char *mac, struct phone_profile *profile)
837 {
838         struct user *user;
839                 
840         if (!(user = ao2_alloc(sizeof(*user), user_destructor))) {
841                 profile = unref_profile(profile);
842                 return NULL;
843         }
844         
845         if (ast_string_field_init(user, 32)) {
846                 profile = unref_profile(profile);
847                 user = unref_user(user);
848                 return NULL;
849         }
850
851         ast_string_field_set(user, macaddress, mac);
852         user->profile = profile; /* already ref counted by find_profile */
853
854         return user;
855 }
856
857 /*! \brief Add an extension to a user ordered by index/linenumber */
858 static int add_user_extension(struct user *user, struct extension *exten)
859 {
860         struct ast_var_t *var;
861
862         /* Append profile variables here, and substitute variables on profile
863          * setvars, so that we can use user specific variables in them */
864         AST_LIST_TRAVERSE(user->profile->headp, var, entries) {
865                 char expand_buf[VAR_BUF_SIZE] = {0,};
866                 struct ast_var_t *var2;
867
868                 pbx_substitute_variables_varshead(exten->headp, var->value, expand_buf, sizeof(expand_buf));
869                 if ((var2 = ast_var_assign(var->name, expand_buf)))
870                         AST_LIST_INSERT_TAIL(exten->headp, var2, entries);
871         }
872
873         if (AST_LIST_EMPTY(&user->extensions)) {
874                 AST_LIST_INSERT_HEAD(&user->extensions, exten, entry);
875         } else {
876                 struct extension *exten_iter;
877
878                 AST_LIST_TRAVERSE_SAFE_BEGIN(&user->extensions, exten_iter, entry) {
879                         if (exten->index < exten_iter->index) {
880                                 AST_LIST_INSERT_BEFORE_CURRENT(exten, entry);
881                         } else if (exten->index == exten_iter->index) {
882                                 ast_log(LOG_WARNING, "Duplicate linenumber=%d for %s\n", exten->index, user->macaddress);
883                                 return -1;
884                         } else if (!AST_LIST_NEXT(exten_iter, entry)) {
885                                 AST_LIST_INSERT_TAIL(&user->extensions, exten, entry);
886                         }
887                 }
888                 AST_LIST_TRAVERSE_SAFE_END;
889         }
890
891         return 0;
892 }
893
894 /*! \brief Add an http route for dynamic files attached to the profile of the user */
895 static int build_user_routes(struct user *user)
896 {
897         struct phoneprov_file *pp_file;
898
899         AST_LIST_TRAVERSE(&user->profile->dynamic_files, pp_file, entry) {
900                 char expand_buf[VAR_BUF_SIZE] = { 0, };
901
902                 pbx_substitute_variables_varshead(AST_LIST_FIRST(&user->extensions)->headp, pp_file->format, expand_buf, sizeof(expand_buf));
903                 build_route(pp_file, user, expand_buf);
904         }
905
906         return 0;
907 }
908
909 /* \brief Parse config files and create appropriate structures */
910 static int set_config(void)
911 {
912         struct ast_config *cfg, *phoneprov_cfg;
913         char *cat;
914         struct ast_variable *v;
915         struct ast_flags config_flags = { 0 };
916         struct ast_var_t *var;
917
918         /* Try to grab the port from sip.conf.  If we don't get it here, we'll set it
919          * to whatever is set in phoneprov.conf or default to 5060 */
920         if ((cfg = ast_config_load("sip.conf", config_flags)) && cfg != CONFIG_STATUS_FILEINVALID) {
921                 ast_copy_string(global_serverport, S_OR(ast_variable_retrieve(cfg, "general", "bindport"), "5060"), sizeof(global_serverport));
922                 ast_config_destroy(cfg);
923         }
924
925         if (!(cfg = ast_config_load("users.conf", config_flags)) || cfg == CONFIG_STATUS_FILEINVALID) {
926                 ast_log(LOG_WARNING, "Unable to load users.cfg\n");
927                 return 0;
928         }
929
930         /* Go ahead and load global variables from users.conf so we can append to profiles */
931         for (v = ast_variable_browse(cfg, "general"); v; v = v->next) {
932                 if (!strcasecmp(v->name, "vmexten")) {
933                         if ((var = ast_var_assign("VOICEMAIL_EXTEN", v->value))) {
934                                 ast_mutex_lock(&globals_lock);
935                                 AST_LIST_INSERT_TAIL(&global_variables, var, entries);
936                                 ast_mutex_unlock(&globals_lock);
937                         }
938                 }
939                 if (!strcasecmp(v->name, "localextenlength")) {
940                         if ((var = ast_var_assign("EXTENSION_LENGTH", v->value)))
941                                 ast_mutex_lock(&globals_lock);
942                                 AST_LIST_INSERT_TAIL(&global_variables, var, entries);
943                                 ast_mutex_unlock(&globals_lock);
944                 }
945         }
946
947         if (!(phoneprov_cfg = ast_config_load("phoneprov.conf", config_flags)) || phoneprov_cfg == CONFIG_STATUS_FILEINVALID) {
948                 ast_log(LOG_ERROR, "Unable to load config phoneprov.conf\n");
949                 return -1;
950         }
951
952         cat = NULL;
953         while ((cat = ast_category_browse(phoneprov_cfg, cat))) {
954                 if (!strcasecmp(cat, "general")) {
955                         for (v = ast_variable_browse(phoneprov_cfg, cat); v; v = v->next) {
956                                 if (!strcasecmp(v->name, "serveraddr"))
957                                         ast_copy_string(global_server, v->value, sizeof(global_server));
958                                 else if (!strcasecmp(v->name, "serveriface")) {
959                                         struct in_addr addr;
960                                         lookup_iface(v->value, &addr);
961                                         ast_copy_string(global_server, ast_inet_ntoa(addr), sizeof(global_server));
962                                 } else if (!strcasecmp(v->name, "serverport"))
963                                         ast_copy_string(global_serverport, v->value, sizeof(global_serverport));
964                                 else if (!strcasecmp(v->name, "default_profile"))
965                                         ast_copy_string(global_default_profile, v->value, sizeof(global_default_profile));
966                         }
967                 } else 
968                         build_profile(cat, ast_variable_browse(phoneprov_cfg, cat));
969         }
970
971         ast_config_destroy(phoneprov_cfg);
972
973         cat = NULL;
974         while ((cat = ast_category_browse(cfg, cat))) {
975                 const char *tmp, *mac;
976                 struct user *user;
977                 struct phone_profile *profile;
978                 struct extension *exten;
979
980                 if (!strcasecmp(cat, "general")) {
981                         continue;
982                 }
983                           
984                 if (!strcasecmp(cat, "authentication"))
985                         continue;
986
987                 if (!((tmp = ast_variable_retrieve(cfg, cat, "autoprov")) && ast_true(tmp)))    
988                         continue;
989
990                 if (!(mac = ast_variable_retrieve(cfg, cat, "macaddress"))) {
991                         ast_log(LOG_WARNING, "autoprov set for %s, but no mac address - skipping.\n", cat);
992                         continue;
993                 }
994
995                 tmp = S_OR(ast_variable_retrieve(cfg, cat, "profile"), global_default_profile);
996                 if (ast_strlen_zero(tmp)) {
997                         ast_log(LOG_WARNING, "No profile for user [%s] with mac '%s' - skipping\n", cat, mac);
998                         continue;
999                 }
1000
1001                 if (!(user = find_user(mac))) {
1002                         if (!(profile = find_profile(tmp))) {
1003                                 ast_log(LOG_WARNING, "Could not look up profile '%s' - skipping.\n", tmp);
1004                                 continue;
1005                         }
1006
1007                         if (!(user = build_user(mac, profile))) {
1008                                 ast_log(LOG_WARNING, "Could not create user for '%s' - skipping\n", user->macaddress);
1009                                 continue;
1010                         }
1011
1012                         if (!(exten = build_extension(cfg, cat))) {
1013                                 ast_log(LOG_WARNING, "Could not create extension for %s - skipping\n", user->macaddress);
1014                                 user = unref_user(user);
1015                                 continue;
1016                         }
1017
1018                         if (add_user_extension(user, exten)) {
1019                                 ast_log(LOG_WARNING, "Could not add extension '%s' to user '%s'\n", exten->name, user->macaddress);
1020                                 user = unref_user(user);
1021                                 exten = delete_extension(exten);
1022                                 continue;
1023                         }
1024
1025                         if (build_user_routes(user)) {
1026                                 ast_log(LOG_WARNING, "Could not create http routes for %s - skipping\n", user->macaddress);
1027                                 user = unref_user(user);
1028                                 continue;
1029                         }
1030
1031                         ao2_link(users, user);
1032                         user = unref_user(user);
1033                 } else {
1034                         if (!(exten = build_extension(cfg, cat))) {
1035                                 ast_log(LOG_WARNING, "Could not create extension for %s - skipping\n", user->macaddress);
1036                                 user = unref_user(user);
1037                                 continue;
1038                         }
1039
1040                         if (add_user_extension(user, exten)) {
1041                                 ast_log(LOG_WARNING, "Could not add extension '%s' to user '%s'\n", exten->name, user->macaddress);
1042                                 user = unref_user(user);
1043                                 exten = delete_extension(exten);
1044                                 continue;
1045                         }
1046
1047                         user = unref_user(user);
1048                 }
1049         }
1050
1051         ast_config_destroy(cfg);
1052
1053         return 0;
1054 }
1055
1056 /*! \brief Delete all http routes, freeing their memory */
1057 static void delete_routes(void)
1058 {
1059         struct ao2_iterator i;
1060         struct http_route *route;
1061         
1062         i = ao2_iterator_init(http_routes, 0);
1063         while ((route = ao2_iterator_next(&i))) {
1064                 ao2_unlink(http_routes, route);
1065                 route = unref_route(route);
1066         }
1067 }
1068
1069 /*! \brief Delete all phone profiles, freeing their memory */
1070 static void delete_profiles(void)
1071 {
1072         struct ao2_iterator i;
1073         struct phone_profile *profile;
1074
1075         i = ao2_iterator_init(profiles, 0);
1076         while ((profile = ao2_iterator_next(&i))) {
1077                 ao2_unlink(profiles, profile);
1078                 profile = unref_profile(profile);
1079         }
1080 }
1081
1082 /*! \brief A dialplan function that can be used to print a string for each phoneprov user */
1083 static int pp_each_user_exec(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
1084 {
1085         char *tmp, expand_buf[VAR_BUF_SIZE] = {0,};
1086         struct ao2_iterator i;
1087         struct user *user;
1088         AST_DECLARE_APP_ARGS(args,
1089                 AST_APP_ARG(string);
1090                 AST_APP_ARG(exclude_mac);
1091         );
1092         AST_STANDARD_APP_ARGS(args, data);
1093
1094         /* Fix data by turning %{ into ${ */
1095         while ((tmp = strstr(args.string, "%{")))
1096                 *tmp = '$';
1097
1098         i = ao2_iterator_init(users, 0);
1099         while ((user = ao2_iterator_next(&i))) {
1100                 if (!ast_strlen_zero(args.exclude_mac) && !strcasecmp(user->macaddress, args.exclude_mac)) {
1101                         continue;
1102                 }
1103                 pbx_substitute_variables_varshead(AST_LIST_FIRST(&user->extensions)->headp, args.string, expand_buf, sizeof(expand_buf));
1104                 ast_build_string(&buf, &len, "%s", expand_buf);
1105                 user = unref_user(user);
1106         }
1107
1108         return 0;
1109 }
1110
1111 static struct ast_custom_function pp_each_user_function = {
1112         .name = "PP_EACH_USER",
1113         .synopsis = "Generate a string for each phoneprov user",
1114         .syntax = "PP_EACH_USER(<string>|<exclude_mac>)",
1115         .desc =
1116                 "Pass in a string, with phoneprov variables you want substituted in the format of\n"
1117                 "%{VARNAME}, and you will get the string rendered for each user in phoneprov\n"
1118                 "excluding ones with MAC address <exclude_mac>. Probably not useful outside of\n"
1119                 "res_phoneprov.\n"
1120                 "\nExample: ${PP_EACH_USER(<item><fn>%{DISPLAY_NAME}</fn></item>|${MAC})",
1121         .read = pp_each_user_exec,
1122 };
1123
1124 /*! \brief A dialplan function that can be used to output a template for each extension attached to a user */
1125 static int pp_each_extension_exec(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
1126 {
1127         struct user *user;
1128         struct extension *exten;
1129         char path[PATH_MAX];
1130         char *file;
1131         int filelen;
1132         AST_DECLARE_APP_ARGS(args, 
1133                 AST_APP_ARG(mac);
1134                 AST_APP_ARG(template);
1135         );
1136         
1137         AST_STANDARD_APP_ARGS(args, data);
1138
1139         if (ast_strlen_zero(args.mac) || ast_strlen_zero(args.template)) {
1140                 ast_log(LOG_WARNING, "PP_EACH_EXTENSION requries both a macaddress and template filename.\n");
1141                 return 0;
1142         }
1143
1144         if (!(user = find_user(args.mac))) {
1145                 ast_log(LOG_WARNING, "Could not find user with mac = '%s'\n", args.mac);
1146                 return 0;
1147         }
1148
1149         snprintf(path, sizeof(path), "%s/phoneprov/%s", ast_config_AST_DATA_DIR, args.template);
1150         filelen = load_file(path, &file);
1151         if (filelen < 0) {
1152                 ast_log(LOG_WARNING, "Could not load file: %s (%d)\n", path, filelen);
1153                 if (file) {
1154                         ast_free(file);
1155                 }
1156                 return 0;
1157         }
1158
1159         if (!file) {
1160                 return 0;
1161         }
1162
1163         AST_LIST_TRAVERSE(&user->extensions, exten, entry) {
1164                 char expand_buf[VAR_BUF_SIZE] = {0,};
1165                 pbx_substitute_variables_varshead(exten->headp, file, expand_buf, sizeof(expand_buf));
1166                 ast_build_string(&buf, &len, "%s", expand_buf);
1167         }
1168
1169         ast_free(file);
1170
1171         user = unref_user(user);
1172
1173         return 0;
1174 }
1175
1176 static struct ast_custom_function pp_each_extension_function = {
1177         .name = "PP_EACH_EXTENSION",
1178         .synopsis = "Execute specified template for each extension",
1179         .syntax = "PP_EACH_EXTENSION(<mac>|<template>)",
1180         .desc =
1181                 "Output the specified template for each extension associated with the specified\n"
1182                 "MAC address.",
1183         .read = pp_each_extension_exec,
1184 };
1185
1186 /*! \brief CLI command to list static and dynamic routes */
1187 static char *handle_show_routes(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1188 {
1189 #define FORMAT "%-40.40s  %-30.30s\n"
1190         struct ao2_iterator i;
1191         struct http_route *route;
1192         
1193         switch(cmd) {
1194         case CLI_INIT:
1195                 e->command = "phoneprov show routes";
1196                 e->usage =
1197                         "Usage: phoneprov show routes\n"
1198                         "       Lists all registered phoneprov http routes.\n";
1199                 return NULL;
1200         case CLI_GENERATE:
1201                 return NULL;
1202         }
1203
1204         /* This currently iterates over routes twice, but it is the only place I've needed
1205          * to really separate static an dynamic routes, so I've just left it this way. */
1206         ast_cli(a->fd, "Static routes\n\n");
1207         ast_cli(a->fd, FORMAT, "Relative URI", "Physical location");
1208         i = ao2_iterator_init(http_routes, 0);
1209         while ((route = ao2_iterator_next(&i))) {
1210                 if (!route->user)
1211                         ast_cli(a->fd, FORMAT, route->uri, route->file->template);
1212                 route = unref_route(route);
1213         }
1214
1215         ast_cli(a->fd, "\nDynamic routes\n\n");
1216         ast_cli(a->fd, FORMAT, "Relative URI", "Template");
1217
1218         i = ao2_iterator_init(http_routes, 0);
1219         while ((route = ao2_iterator_next(&i))) {
1220                 if (route->user)
1221                         ast_cli(a->fd, FORMAT, route->uri, route->file->template);
1222                 route = unref_route(route);
1223         }
1224
1225         return CLI_SUCCESS;
1226 }
1227
1228 static struct ast_cli_entry pp_cli[] = {
1229         AST_CLI_DEFINE(handle_show_routes, "Show registered phoneprov http routes"),
1230 };
1231
1232 static struct ast_http_uri phoneprovuri = {
1233         .callback = phoneprov_callback,
1234         .description = "Asterisk HTTP Phone Provisioning Tool",
1235         .uri = "phoneprov",
1236         .has_subtree = 1,
1237         .supports_get = 1,
1238         .data = NULL,
1239         .key = __FILE__,
1240 };
1241
1242 static int load_module(void)
1243 {
1244         profiles = ao2_container_alloc(MAX_PROFILE_BUCKETS, profile_hash_fn, profile_cmp_fn);
1245
1246         http_routes = ao2_container_alloc(MAX_ROUTE_BUCKETS, routes_hash_fn, routes_cmp_fn);
1247
1248         users = ao2_container_alloc(MAX_USER_BUCKETS, users_hash_fn, users_cmp_fn);
1249
1250         AST_LIST_HEAD_INIT_NOLOCK(&global_variables);
1251         ast_mutex_init(&globals_lock);
1252         
1253         ast_custom_function_register(&pp_each_user_function);
1254         ast_custom_function_register(&pp_each_extension_function);
1255         ast_cli_register_multiple(pp_cli, ARRAY_LEN(pp_cli));
1256
1257         set_config();
1258         ast_http_uri_link(&phoneprovuri); 
1259
1260         return 0;
1261 }
1262
1263 static int unload_module(void)
1264 {
1265         struct ast_var_t *var;
1266
1267         ast_http_uri_unlink(&phoneprovuri);
1268         ast_custom_function_unregister(&pp_each_user_function);
1269         ast_custom_function_unregister(&pp_each_extension_function);
1270         ast_cli_unregister_multiple(pp_cli, ARRAY_LEN(pp_cli));
1271
1272         delete_routes();
1273         delete_users();
1274         delete_profiles();
1275         ao2_ref(profiles, -1);
1276         ao2_ref(http_routes, -1);
1277         ao2_ref(users, -1);
1278
1279         ast_mutex_lock(&globals_lock);
1280         while ((var = AST_LIST_REMOVE_HEAD(&global_variables, entries))) {
1281                 ast_var_delete(var);
1282         }
1283         ast_mutex_unlock(&globals_lock);
1284
1285         ast_mutex_destroy(&globals_lock);
1286
1287         return 0;
1288 }
1289
1290 static int reload(void) 
1291 {
1292         struct ast_var_t *var;
1293
1294         delete_routes();
1295         delete_users();
1296         delete_profiles();
1297
1298         ast_mutex_lock(&globals_lock);
1299         while ((var = AST_LIST_REMOVE_HEAD(&global_variables, entries))) {
1300                 ast_var_delete(var);
1301         }
1302         ast_mutex_unlock(&globals_lock);
1303
1304         set_config();
1305
1306         return 0;
1307 }
1308
1309 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "HTTP Phone Provisioning",
1310                 .load = load_module,
1311                 .unload = unload_module,
1312                 .reload = reload,
1313         );