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