Include sys/wait.h on FreeBSD to get the WEXITSTATUS() macro.
[asterisk/asterisk.git] / apps / app_voicemail.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file
21  * \author Mark Spencer <markster@digium.com>
22  * \brief Comedian Mail - Voicemail System
23  *
24  * \extref unixODBC (http://www.unixodbc.org/)
25  * \extref A source distribution of University of Washington's IMAP c-client
26  *         (http://www.washington.edu/imap/)
27  *
28  * \par See also
29  * \arg \ref Config_vm
30  * \note For information about voicemail IMAP storage, read doc/imapstorage.txt
31  * \ingroup applications
32  * \note This module requires res_adsi to load. This needs to be optional
33  * during compilation.
34  *
35  * \note This file is now almost impossible to work with, due to all \#ifdefs.
36  *       Feels like the database code before realtime. Someone - please come up
37  *       with a plan to clean this up.
38  */
39
40 /*** MODULEINFO
41         <depend>res_smdi</depend>
42  ***/
43
44 /*** MAKEOPTS
45 <category name="MENUSELECT_OPTS_app_voicemail" displayname="Voicemail Build Options" positive_output="yes" touch_on_change="apps/app_voicemail.c apps/app_directory.c">
46         <member name="FILE_STORAGE" displayname="Storage of Voicemail using filesystem">
47                 <conflict>ODBC_STORAGE</conflict>
48                 <conflict>IMAP_STORAGE</conflict>
49                 <defaultenabled>yes</defaultenabled>
50         </member>
51         <member name="ODBC_STORAGE" displayname="Storage of Voicemail using ODBC">
52                 <depend>generic_odbc</depend>
53                 <depend>ltdl</depend>
54                 <conflict>IMAP_STORAGE</conflict>
55                 <conflict>FILE_STORAGE</conflict>
56                 <defaultenabled>no</defaultenabled>
57         </member>
58         <member name="IMAP_STORAGE" displayname="Storage of Voicemail using IMAP4">
59                 <depend>imap_tk</depend>
60                 <conflict>ODBC_STORAGE</conflict>
61                 <conflict>FILE_STORAGE</conflict>
62                 <use>openssl</use>
63                 <defaultenabled>no</defaultenabled>
64         </member>
65 </category>
66 ***/
67
68 #include "asterisk.h"
69
70 #ifdef IMAP_STORAGE
71 #include <ctype.h>
72 #include <signal.h>
73 #include <pwd.h>
74 #ifdef USE_SYSTEM_IMAP
75 #include <imap/c-client.h>
76 #include <imap/imap4r1.h>
77 #include <imap/linkage.h>
78 #elif defined (USE_SYSTEM_CCLIENT)
79 #include <c-client/c-client.h>
80 #include <c-client/imap4r1.h>
81 #include <c-client/linkage.h>
82 #else
83 #include "c-client.h"
84 #include "imap4r1.h"
85 #include "linkage.h"
86 #endif
87 #endif
88
89 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
90
91 #include "asterisk/paths.h"     /* use ast_config_AST_SPOOL_DIR */
92 #include <sys/time.h>
93 #include <sys/stat.h>
94 #include <sys/mman.h>
95 #include <time.h>
96 #include <dirent.h>
97 #if defined(__FreeBSD__)
98 #include <sys/wait.h>
99 #endif
100
101 #include "asterisk/logger.h"
102 #include "asterisk/lock.h"
103 #include "asterisk/file.h"
104 #include "asterisk/channel.h"
105 #include "asterisk/pbx.h"
106 #include "asterisk/config.h"
107 #include "asterisk/say.h"
108 #include "asterisk/module.h"
109 #include "asterisk/adsi.h"
110 #include "asterisk/app.h"
111 #include "asterisk/manager.h"
112 #include "asterisk/dsp.h"
113 #include "asterisk/localtime.h"
114 #include "asterisk/cli.h"
115 #include "asterisk/utils.h"
116 #include "asterisk/stringfields.h"
117 #include "asterisk/smdi.h"
118 #include "asterisk/astobj2.h"
119 #include "asterisk/event.h"
120 #include "asterisk/taskprocessor.h"
121 #include "asterisk/test.h"
122
123 #ifdef ODBC_STORAGE
124 #include "asterisk/res_odbc.h"
125 #endif
126
127 #ifdef IMAP_STORAGE
128 #include "asterisk/threadstorage.h"
129 #endif
130
131 /*** DOCUMENTATION
132         <application name="VoiceMail" language="en_US">
133                 <synopsis>
134                         Leave a Voicemail message.
135                 </synopsis>
136                 <syntax>
137                         <parameter name="mailboxs" argsep="&amp;" required="true">
138                                 <argument name="mailbox1" argsep="@" required="true">
139                                         <argument name="mailbox" required="true" />
140                                         <argument name="context" />
141                                 </argument>
142                                 <argument name="mailbox2" argsep="@" multiple="true">
143                                         <argument name="mailbox" required="true" />
144                                         <argument name="context" />
145                                 </argument>
146                         </parameter>
147                         <parameter name="options">
148                                 <optionlist>
149                                         <option name="b">
150                                                 <para>Play the <literal>busy</literal> greeting to the calling party.</para>
151                                         </option>
152                                         <option name="d">
153                                                 <argument name="c" />
154                                                 <para>Accept digits for a new extension in context <replaceable>c</replaceable>,
155                                                 if played during the greeting. Context defaults to the current context.</para>
156                                         </option>
157                                         <option name="g">
158                                                 <argument name="#" required="true" />
159                                                 <para>Use the specified amount of gain when recording the voicemail
160                                                 message. The units are whole-number decibels (dB). Only works on supported
161                                                 technologies, which is DAHDI only.</para>
162                                         </option>
163                                         <option name="s">
164                                                 <para>Skip the playback of instructions for leaving a message to the
165                                                 calling party.</para>
166                                         </option>
167                                         <option name="u">
168                                                 <para>Play the <literal>unavailable</literal> greeting.</para>
169                                         </option>
170                                         <option name="U">
171                                                 <para>Mark message as <literal>URGENT</literal>.</para>
172                                         </option>
173                                         <option name="P">
174                                                 <para>Mark message as <literal>PRIORITY</literal>.</para>
175                                         </option>
176                                 </optionlist>
177                         </parameter>
178                 </syntax>
179                 <description>
180                         <para>This application allows the calling party to leave a message for the specified
181                         list of mailboxes. When multiple mailboxes are specified, the greeting will be taken from
182                         the first mailbox specified. Dialplan execution will stop if the specified mailbox does not
183                         exist.</para>
184                         <para>The Voicemail application will exit if any of the following DTMF digits are received:</para>
185                         <enumlist>
186                                 <enum name="0">
187                                         <para>Jump to the <literal>o</literal> extension in the current dialplan context.</para>
188                                 </enum>
189                                 <enum name="*">
190                                         <para>Jump to the <literal>a</literal> extension in the current dialplan context.</para>
191                                 </enum>
192                         </enumlist>
193                         <para>This application will set the following channel variable upon completion:</para>
194                         <variablelist>
195                                 <variable name="VMSTATUS">
196                                         <para>This indicates the status of the execution of the VoiceMail application.</para>
197                                         <value name="SUCCESS" />
198                                         <value name="USEREXIT" />
199                                         <value name="FAILED" />
200                                 </variable>
201                         </variablelist>
202                 </description>
203         </application>
204         <application name="VoiceMailMain" language="en_US">
205                 <synopsis>
206                         Check Voicemail messages.
207                 </synopsis>
208                 <syntax>
209                         <parameter name="mailbox" required="true" argsep="@">
210                                 <argument name="mailbox" />
211                                 <argument name="context" />
212                         </parameter>
213                         <parameter name="options">
214                                 <optionlist>
215                                         <option name="p">
216                                                 <para>Consider the <replaceable>mailbox</replaceable> parameter as a prefix to
217                                                 the mailbox that is entered by the caller.</para>
218                                         </option>
219                                         <option name="g">
220                                                 <argument name="#" required="true" />
221                                                 <para>Use the specified amount of gain when recording a voicemail message.
222                                                 The units are whole-number decibels (dB).</para>
223                                         </option>
224                                         <option name="s">
225                                                 <para>Skip checking the passcode for the mailbox.</para>
226                                         </option>
227                                         <option name="a">
228                                                 <argument name="folder" required="true" />
229                                                 <para>Skip folder prompt and go directly to <replaceable>folder</replaceable> specified.
230                                                 Defaults to <literal>INBOX</literal> (or <literal>0</literal>).</para>
231                                                 <enumlist>
232                                                         <enum name="0"><para>INBOX</para></enum>
233                                                         <enum name="1"><para>Old</para></enum>
234                                                         <enum name="2"><para>Work</para></enum>
235                                                         <enum name="3"><para>Family</para></enum>
236                                                         <enum name="4"><para>Friends</para></enum>
237                                                         <enum name="5"><para>Cust1</para></enum>
238                                                         <enum name="6"><para>Cust2</para></enum>
239                                                         <enum name="7"><para>Cust3</para></enum>
240                                                         <enum name="8"><para>Cust4</para></enum>
241                                                         <enum name="9"><para>Cust5</para></enum>
242                                                 </enumlist>
243                                         </option>
244                                 </optionlist>
245                         </parameter>
246                 </syntax>
247                 <description>
248                         <para>This application allows the calling party to check voicemail messages. A specific
249                         <replaceable>mailbox</replaceable>, and optional corresponding <replaceable>context</replaceable>,
250                         may be specified. If a <replaceable>mailbox</replaceable> is not provided, the calling party will
251                         be prompted to enter one. If a <replaceable>context</replaceable> is not specified, the
252                         <literal>default</literal> context will be used.</para>
253                 </description>
254         </application>
255         <application name="MailboxExists" language="en_US">
256                 <synopsis>
257                         Check to see if Voicemail mailbox exists.
258                 </synopsis>
259                 <syntax>
260                         <parameter name="mailbox" required="true" argsep="@">
261                                 <argument name="mailbox" required="true" />
262                                 <argument name="context" />
263                         </parameter>
264                         <parameter name="options">
265                                 <para>None options.</para>
266                         </parameter>
267                 </syntax>
268                 <description>
269                         <para>Check to see if the specified <replaceable>mailbox</replaceable> exists. If no voicemail
270                         <replaceable>context</replaceable> is specified, the <literal>default</literal> context
271                         will be used.</para>
272                         <para>This application will set the following channel variable upon completion:</para>
273                         <variablelist>
274                                 <variable name="VMBOXEXISTSSTATUS">
275                                         <para>This will contain the status of the execution of the MailboxExists application.
276                                         Possible values include:</para>
277                                         <value name="SUCCESS" />
278                                         <value name="FAILED" />
279                                 </variable>
280                         </variablelist>
281                 </description>
282         </application>
283         <application name="VMAuthenticate" language="en_US">
284                 <synopsis>
285                         Authenticate with Voicemail passwords.
286                 </synopsis>
287                 <syntax>
288                         <parameter name="mailbox" required="true" argsep="@">
289                                 <argument name="mailbox" />
290                                 <argument name="context" />
291                         </parameter>
292                         <parameter name="options">
293                                 <optionlist>
294                                         <option name="s">
295                                                 <para>Skip playing the initial prompts.</para>
296                                         </option>
297                                 </optionlist>
298                         </parameter>
299                 </syntax>
300                 <description>
301                         <para>This application behaves the same way as the Authenticate application, but the passwords
302                         are taken from <filename>voicemail.conf</filename>. If the <replaceable>mailbox</replaceable> is
303                         specified, only that mailbox's password will be considered valid. If the <replaceable>mailbox</replaceable>
304                         is not specified, the channel variable <variable>AUTH_MAILBOX</variable> will be set with the authenticated
305                         mailbox.</para>
306                 </description>
307         </application>
308         <application name="VMSayName" language="en_US">
309                 <synopsis>
310                         Play the name of a voicemail user
311                 </synopsis>
312                 <syntax>
313                         <parameter name="mailbox" required="true" argsep="@">
314                                 <argument name="mailbox" />
315                                 <argument name="context" />
316                         </parameter>
317                 </syntax>
318                 <description>
319                         <para>This application will say the recorded name of the voicemail user specified as the
320                         argument to this application. If no context is provided, <literal>default</literal> is assumed.</para>
321                 </description>
322         </application>
323         <function name="MAILBOX_EXISTS" language="en_US">
324                 <synopsis>
325                         Tell if a mailbox is configured.
326                 </synopsis>
327                 <syntax argsep="@">
328                         <parameter name="mailbox" required="true" />
329                         <parameter name="context" />
330                 </syntax>
331                 <description>
332                         <para>Returns a boolean of whether the corresponding <replaceable>mailbox</replaceable> exists.
333                         If <replaceable>context</replaceable> is not specified, defaults to the <literal>default</literal>
334                         context.</para>
335                 </description>
336         </function>
337         <manager name="VoicemailUsersList" language="en_US">
338                 <synopsis>
339                         List All Voicemail User Information.
340                 </synopsis>
341                 <syntax>
342                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
343                 </syntax>
344                 <description>
345                 </description>
346         </manager>
347  ***/
348
349 #ifdef IMAP_STORAGE
350 static char imapserver[48];
351 static char imapport[8];
352 static char imapflags[128];
353 static char imapfolder[64];
354 static char imapparentfolder[64] = "\0";
355 static char greetingfolder[64];
356 static char authuser[32];
357 static char authpassword[42];
358 static int imapversion = 1;
359
360 static int expungeonhangup = 1;
361 static int imapgreetings = 0;
362 static char delimiter = '\0';
363
364 struct vm_state;
365 struct ast_vm_user;
366
367 AST_THREADSTORAGE(ts_vmstate);
368
369 /* Forward declarations for IMAP */
370 static int init_mailstream(struct vm_state *vms, int box);
371 static void write_file(char *filename, char *buffer, unsigned long len);
372 static char *get_header_by_tag(char *header, char *tag, char *buf, size_t len);
373 static void vm_imap_delete(char *file, int msgnum, struct ast_vm_user *vmu);
374 static char *get_user_by_mailbox(char *mailbox, char *buf, size_t len);
375 static struct vm_state *get_vm_state_by_imapuser(const char *user, int interactive);
376 static struct vm_state *get_vm_state_by_mailbox(const char *mailbox, const char *context, int interactive);
377 static struct vm_state *create_vm_state_from_user(struct ast_vm_user *vmu);
378 static void vmstate_insert(struct vm_state *vms);
379 static void vmstate_delete(struct vm_state *vms);
380 static void set_update(MAILSTREAM * stream);
381 static void init_vm_state(struct vm_state *vms);
382 static int save_body(BODY *body, struct vm_state *vms, char *section, char *format, int is_intro);
383 static void get_mailbox_delimiter(MAILSTREAM *stream);
384 static void mm_parsequota (MAILSTREAM *stream, unsigned char *msg, QUOTALIST *pquota);
385 static void imap_mailbox_name(char *spec, size_t len, struct vm_state *vms, int box, int target);
386 static int imap_store_file(const char *dir, const char *mailboxuser, const char *mailboxcontext, int msgnum, struct ast_channel *chan, struct ast_vm_user *vmu, char *fmt, int duration, struct vm_state *vms, const char *flag);
387 static void update_messages_by_imapuser(const char *user, unsigned long number);
388 static int vm_delete(char *file);
389
390 static int imap_remove_file (char *dir, int msgnum);
391 static int imap_retrieve_file (const char *dir, const int msgnum, const char *mailbox, const char *context);
392 static int imap_delete_old_greeting (char *dir, struct vm_state *vms);
393 static void check_quota(struct vm_state *vms, char *mailbox);
394 static int open_mailbox(struct vm_state *vms, struct ast_vm_user *vmu, int box);
395 struct vmstate {
396         struct vm_state *vms;
397         AST_LIST_ENTRY(vmstate) list;
398 };
399
400 static AST_LIST_HEAD_STATIC(vmstates, vmstate);
401
402 #endif
403
404 #define SMDI_MWI_WAIT_TIMEOUT 1000 /* 1 second */
405
406 #define COMMAND_TIMEOUT 5000
407 /* Don't modify these here; set your umask at runtime instead */
408 #define VOICEMAIL_DIR_MODE      0777
409 #define VOICEMAIL_FILE_MODE     0666
410 #define CHUNKSIZE       65536
411
412 #define VOICEMAIL_CONFIG "voicemail.conf"
413 #define ASTERISK_USERNAME "asterisk"
414
415 /* Define fast-forward, pause, restart, and reverse keys
416    while listening to a voicemail message - these are
417    strings, not characters */
418 #define DEFAULT_LISTEN_CONTROL_FORWARD_KEY "#"
419 #define DEFAULT_LISTEN_CONTROL_REVERSE_KEY "*"
420 #define DEFAULT_LISTEN_CONTROL_PAUSE_KEY "0"
421 #define DEFAULT_LISTEN_CONTROL_RESTART_KEY "2"
422 #define DEFAULT_LISTEN_CONTROL_STOP_KEY "13456789"
423 #define VALID_DTMF "1234567890*#" /* Yes ABCD are valid dtmf but what phones have those? */
424
425 /* Default mail command to mail voicemail. Change it with the
426     mailcmd= command in voicemail.conf */
427 #define SENDMAIL "/usr/sbin/sendmail -t"
428
429 #define INTRO "vm-intro"
430
431 #define MAXMSG 100
432 #define MAXMSGLIMIT 9999
433
434 #define MINPASSWORD 0 /*!< Default minimum mailbox password length */
435
436 #define BASELINELEN 72
437 #define BASEMAXINLINE 256
438 #define eol "\r\n"
439
440 #define MAX_DATETIME_FORMAT     512
441 #define MAX_NUM_CID_CONTEXTS 10
442
443 #define VM_REVIEW        (1 << 0)   /*!< After recording, permit the caller to review the recording before saving */
444 #define VM_OPERATOR      (1 << 1)   /*!< Allow 0 to be pressed to go to 'o' extension */
445 #define VM_SAYCID        (1 << 2)   /*!< Repeat the CallerID info during envelope playback */
446 #define VM_SVMAIL        (1 << 3)   /*!< Allow the user to compose a new VM from within VoicemailMain */
447 #define VM_ENVELOPE      (1 << 4)   /*!< Play the envelope information (who-from, time received, etc.) */
448 #define VM_SAYDURATION   (1 << 5)   /*!< Play the length of the message during envelope playback */
449 #define VM_SKIPAFTERCMD  (1 << 6)   /*!< After deletion, assume caller wants to go to the next message */
450 #define VM_FORCENAME     (1 << 7)   /*!< Have new users record their name */
451 #define VM_FORCEGREET    (1 << 8)   /*!< Have new users record their greetings */
452 #define VM_PBXSKIP       (1 << 9)   /*!< Skip the [PBX] preamble in the Subject line of emails */
453 #define VM_DIRECFORWARD  (1 << 10)  /*!< Permit caller to use the Directory app for selecting to which mailbox to forward a VM */
454 #define VM_ATTACH        (1 << 11)  /*!< Attach message to voicemail notifications? */
455 #define VM_DELETE        (1 << 12)  /*!< Delete message after sending notification */
456 #define VM_ALLOCED       (1 << 13)  /*!< Structure was malloc'ed, instead of placed in a return (usually static) buffer */
457 #define VM_SEARCH        (1 << 14)  /*!< Search all contexts for a matching mailbox */
458 #define VM_TEMPGREETWARN (1 << 15)  /*!< Remind user tempgreeting is set */
459 #define VM_MOVEHEARD     (1 << 16)  /*!< Move a "heard" message to Old after listening to it */
460 #define VM_MESSAGEWRAP   (1 << 17)  /*!< Wrap around from the last message to the first, and vice-versa */
461 #define VM_FWDURGAUTO    (1 << 18)  /*!< Autoset of Urgent flag on forwarded Urgent messages set globally */
462 #define ERROR_LOCK_PATH  -100
463
464
465 enum vm_box {
466         NEW_FOLDER,
467         OLD_FOLDER,
468         WORK_FOLDER,
469         FAMILY_FOLDER,
470         FRIENDS_FOLDER,
471         GREETINGS_FOLDER
472 };
473
474 enum vm_option_flags {
475         OPT_SILENT =           (1 << 0),
476         OPT_BUSY_GREETING =    (1 << 1),
477         OPT_UNAVAIL_GREETING = (1 << 2),
478         OPT_RECORDGAIN =       (1 << 3),
479         OPT_PREPEND_MAILBOX =  (1 << 4),
480         OPT_AUTOPLAY =         (1 << 6),
481         OPT_DTMFEXIT =         (1 << 7),
482         OPT_MESSAGE_Urgent =   (1 << 8),
483         OPT_MESSAGE_PRIORITY = (1 << 9)
484 };
485
486 enum vm_option_args {
487         OPT_ARG_RECORDGAIN = 0,
488         OPT_ARG_PLAYFOLDER = 1,
489         OPT_ARG_DTMFEXIT   = 2,
490         /* This *must* be the last value in this enum! */
491         OPT_ARG_ARRAY_SIZE = 3,
492 };
493
494 enum vm_passwordlocation {
495         OPT_PWLOC_VOICEMAILCONF = 0,
496         OPT_PWLOC_SPOOLDIR      = 1,
497         OPT_PWLOC_USERSCONF     = 2,
498 };
499
500 AST_APP_OPTIONS(vm_app_options, {
501         AST_APP_OPTION('s', OPT_SILENT),
502         AST_APP_OPTION('b', OPT_BUSY_GREETING),
503         AST_APP_OPTION('u', OPT_UNAVAIL_GREETING),
504         AST_APP_OPTION_ARG('g', OPT_RECORDGAIN, OPT_ARG_RECORDGAIN),
505         AST_APP_OPTION_ARG('d', OPT_DTMFEXIT, OPT_ARG_DTMFEXIT),
506         AST_APP_OPTION('p', OPT_PREPEND_MAILBOX),
507         AST_APP_OPTION_ARG('a', OPT_AUTOPLAY, OPT_ARG_PLAYFOLDER),
508         AST_APP_OPTION('U', OPT_MESSAGE_Urgent),
509         AST_APP_OPTION('P', OPT_MESSAGE_PRIORITY)
510 });
511
512 static int load_config(int reload);
513
514 /*! \page vmlang Voicemail Language Syntaxes Supported
515
516         \par Syntaxes supported, not really language codes.
517         \arg \b en    - English
518         \arg \b de    - German
519         \arg \b es    - Spanish
520         \arg \b fr    - French
521         \arg \b it    - Italian
522         \arg \b nl    - Dutch
523         \arg \b pt    - Portuguese
524         \arg \b pt_BR - Portuguese (Brazil)
525         \arg \b gr    - Greek
526         \arg \b no    - Norwegian
527         \arg \b se    - Swedish
528         \arg \b tw    - Chinese (Taiwan)
529         \arg \b ua - Ukrainian
530
531 German requires the following additional soundfile:
532 \arg \b 1F      einE (feminine)
533
534 Spanish requires the following additional soundfile:
535 \arg \b 1M      un (masculine)
536
537 Dutch, Portuguese & Spanish require the following additional soundfiles:
538 \arg \b vm-INBOXs       singular of 'new'
539 \arg \b vm-Olds         singular of 'old/heard/read'
540
541 NB these are plural:
542 \arg \b vm-INBOX        nieuwe (nl)
543 \arg \b vm-Old          oude (nl)
544
545 Polish uses:
546 \arg \b vm-new-a        'new', feminine singular accusative
547 \arg \b vm-new-e        'new', feminine plural accusative
548 \arg \b vm-new-ych      'new', feminine plural genitive
549 \arg \b vm-old-a        'old', feminine singular accusative
550 \arg \b vm-old-e        'old', feminine plural accusative
551 \arg \b vm-old-ych      'old', feminine plural genitive
552 \arg \b digits/1-a      'one', not always same as 'digits/1'
553 \arg \b digits/2-ie     'two', not always same as 'digits/2'
554
555 Swedish uses:
556 \arg \b vm-nytt         singular of 'new'
557 \arg \b vm-nya          plural of 'new'
558 \arg \b vm-gammalt      singular of 'old'
559 \arg \b vm-gamla        plural of 'old'
560 \arg \b digits/ett      'one', not always same as 'digits/1'
561
562 Norwegian uses:
563 \arg \b vm-ny           singular of 'new'
564 \arg \b vm-nye          plural of 'new'
565 \arg \b vm-gammel       singular of 'old'
566 \arg \b vm-gamle        plural of 'old'
567
568 Dutch also uses:
569 \arg \b nl-om           'at'?
570
571 Spanish also uses:
572 \arg \b vm-youhaveno
573
574 Italian requires the following additional soundfile:
575
576 For vm_intro_it:
577 \arg \b vm-nuovo        new
578 \arg \b vm-nuovi        new plural
579 \arg \b vm-vecchio      old
580 \arg \b vm-vecchi       old plural
581
582 Chinese (Taiwan) requires the following additional soundfile:
583 \arg \b vm-tong         A class-word for call (tong1)
584 \arg \b vm-ri           A class-word for day (ri4)
585 \arg \b vm-you          You (ni3)
586 \arg \b vm-haveno   Have no (mei2 you3)
587 \arg \b vm-have     Have (you3)
588 \arg \b vm-listen   To listen (yao4 ting1)
589
590
591 \note Don't use vm-INBOX or vm-Old, because they are the name of the INBOX and Old folders,
592 spelled among others when you have to change folder. For the above reasons, vm-INBOX
593 and vm-Old are spelled plural, to make them sound more as folder name than an adjective.
594
595 */
596
597 struct baseio {
598         int iocp;
599         int iolen;
600         int linelength;
601         int ateof;
602         unsigned char iobuf[BASEMAXINLINE];
603 };
604
605 /*! Structure for linked list of users 
606  * Use ast_vm_user_destroy() to free one of these structures. */
607 struct ast_vm_user {
608         char context[AST_MAX_CONTEXT];   /*!< Voicemail context */
609         char mailbox[AST_MAX_EXTENSION]; /*!< Mailbox id, unique within vm context */
610         char password[80];               /*!< Secret pin code, numbers only */
611         char fullname[80];               /*!< Full name, for directory app */
612         char email[80];                  /*!< E-mail address */
613         char *emailsubject;              /*!< E-mail subject */
614         char *emailbody;                 /*!< E-mail body */
615         char pager[80];                  /*!< E-mail address to pager (no attachment) */
616         char serveremail[80];            /*!< From: Mail address */
617         char mailcmd[160];               /*!< Configurable mail command */
618         char language[MAX_LANGUAGE];     /*!< Config: Language setting */
619         char zonetag[80];                /*!< Time zone */
620         char callback[80];
621         char dialout[80];
622         char uniqueid[80];               /*!< Unique integer identifier */
623         char exit[80];
624         char attachfmt[20];              /*!< Attachment format */
625         unsigned int flags;              /*!< VM_ flags */      
626         int saydurationm;
627         int maxmsg;                      /*!< Maximum number of msgs per folder for this mailbox */
628         int maxdeletedmsg;               /*!< Maximum number of deleted msgs saved for this mailbox */
629         int maxsecs;                     /*!< Maximum number of seconds per message for this mailbox */
630         int passwordlocation;            /*!< Storage location of the password */
631 #ifdef IMAP_STORAGE
632         char imapuser[80];               /*!< IMAP server login */
633         char imappassword[80];           /*!< IMAP server password if authpassword not defined */
634         char imapfolder[64];             /*!< IMAP voicemail folder */
635         char imapvmshareid[80];          /*!< Shared mailbox ID to use rather than the dialed one */
636         int imapversion;                 /*!< If configuration changes, use the new values */
637 #endif
638         double volgain;                  /*!< Volume gain for voicemails sent via email */
639         AST_LIST_ENTRY(ast_vm_user) list;
640 };
641
642 /*! Voicemail time zones */
643 struct vm_zone {
644         AST_LIST_ENTRY(vm_zone) list;
645         char name[80];
646         char timezone[80];
647         char msg_format[512];
648 };
649
650 #define VMSTATE_MAX_MSG_ARRAY 256
651
652 /*! Voicemail mailbox state */
653 struct vm_state {
654         char curbox[80];
655         char username[80];
656         char context[80];
657         char curdir[PATH_MAX];
658         char vmbox[PATH_MAX];
659         char fn[PATH_MAX];
660         char intro[PATH_MAX];
661         int *deleted;
662         int *heard;
663         int curmsg;
664         int lastmsg;
665         int newmessages;
666         int oldmessages;
667         int urgentmessages;
668         int starting;
669         int repeats;
670 #ifdef IMAP_STORAGE
671         ast_mutex_t lock;
672         int updated;                         /*!< decremented on each mail check until 1 -allows delay */
673         long msgArray[VMSTATE_MAX_MSG_ARRAY];
674         MAILSTREAM *mailstream;
675         int vmArrayIndex;
676         char imapuser[80];                   /*!< IMAP server login */
677         char imapfolder[64];                 /*!< IMAP voicemail folder */
678         int imapversion;
679         int interactive;
680         char introfn[PATH_MAX];              /*!< Name of prepended file */
681         unsigned int quota_limit;
682         unsigned int quota_usage;
683         struct vm_state *persist_vms;
684 #endif
685 };
686
687 #ifdef ODBC_STORAGE
688 static char odbc_database[80];
689 static char odbc_table[80];
690 #define RETRIEVE(a,b,c,d) retrieve_file(a,b)
691 #define DISPOSE(a,b) remove_file(a,b)
692 #define STORE(a,b,c,d,e,f,g,h,i,j) store_file(a,b,c,d)
693 #define EXISTS(a,b,c,d) (message_exists(a,b))
694 #define RENAME(a,b,c,d,e,f,g,h) (rename_file(a,b,c,d,e,f))
695 #define COPY(a,b,c,d,e,f,g,h) (copy_file(a,b,c,d,e,f))
696 #define DELETE(a,b,c,d) (delete_file(a,b))
697 #else
698 #ifdef IMAP_STORAGE
699 #define DISPOSE(a,b) (imap_remove_file(a,b))
700 #define STORE(a,b,c,d,e,f,g,h,i,j) (imap_store_file(a,b,c,d,e,f,g,h,i,j))
701 #define RETRIEVE(a,b,c,d) imap_retrieve_file(a,b,c,d)
702 #define EXISTS(a,b,c,d) (ast_fileexists(c,NULL,d) > 0)
703 #define RENAME(a,b,c,d,e,f,g,h) (rename_file(g,h));
704 #define COPY(a,b,c,d,e,f,g,h) (copy_file(g,h));
705 #define DELETE(a,b,c,d) (vm_imap_delete(a,b,d))
706 #else
707 #define RETRIEVE(a,b,c,d)
708 #define DISPOSE(a,b)
709 #define STORE(a,b,c,d,e,f,g,h,i,j)
710 #define EXISTS(a,b,c,d) (ast_fileexists(c,NULL,d) > 0)
711 #define RENAME(a,b,c,d,e,f,g,h) (rename_file(g,h));
712 #define COPY(a,b,c,d,e,f,g,h) (copy_plain_file(g,h)); 
713 #define DELETE(a,b,c,d) (vm_delete(c))
714 #endif
715 #endif
716
717 static char VM_SPOOL_DIR[PATH_MAX];
718
719 static char ext_pass_cmd[128];
720 static char ext_pass_check_cmd[128];
721
722 static int my_umask;
723
724 #define PWDCHANGE_INTERNAL (1 << 1)
725 #define PWDCHANGE_EXTERNAL (1 << 2)
726 static int pwdchange = PWDCHANGE_INTERNAL;
727
728 #ifdef ODBC_STORAGE
729 #define tdesc "Comedian Mail (Voicemail System) with ODBC Storage"
730 #else
731 # ifdef IMAP_STORAGE
732 # define tdesc "Comedian Mail (Voicemail System) with IMAP Storage"
733 # else
734 # define tdesc "Comedian Mail (Voicemail System)"
735 # endif
736 #endif
737
738 static char userscontext[AST_MAX_EXTENSION] = "default";
739
740 static char *addesc = "Comedian Mail";
741
742 /* Leave a message */
743 static char *app = "VoiceMail";
744
745 /* Check mail, control, etc */
746 static char *app2 = "VoiceMailMain";
747
748 static char *app3 = "MailboxExists";
749 static char *app4 = "VMAuthenticate";
750
751 static char *sayname_app = "VMSayName";
752
753 static AST_LIST_HEAD_STATIC(users, ast_vm_user);
754 static AST_LIST_HEAD_STATIC(zones, vm_zone);
755 static char zonetag[80];
756 static int maxsilence;
757 static int maxmsg;
758 static int maxdeletedmsg;
759 static int silencethreshold = 128;
760 static char serveremail[80];
761 static char mailcmd[160];       /* Configurable mail cmd */
762 static char externnotify[160]; 
763 static struct ast_smdi_interface *smdi_iface = NULL;
764 static char vmfmts[80];
765 static double volgain;
766 static int vmminsecs;
767 static int vmmaxsecs;
768 static int maxgreet;
769 static int skipms;
770 static int maxlogins;
771 static int minpassword;
772 static int passwordlocation;
773
774 /*! Poll mailboxes for changes since there is something external to
775  *  app_voicemail that may change them. */
776 static unsigned int poll_mailboxes;
777
778 /*! Polling frequency */
779 static unsigned int poll_freq;
780 /*! By default, poll every 30 seconds */
781 #define DEFAULT_POLL_FREQ 30
782
783 AST_MUTEX_DEFINE_STATIC(poll_lock);
784 static ast_cond_t poll_cond = PTHREAD_COND_INITIALIZER;
785 static pthread_t poll_thread = AST_PTHREADT_NULL;
786 static unsigned char poll_thread_run;
787
788 /*! Subscription to ... MWI event subscriptions */
789 static struct ast_event_sub *mwi_sub_sub;
790 /*! Subscription to ... MWI event un-subscriptions */
791 static struct ast_event_sub *mwi_unsub_sub;
792
793 /*!
794  * \brief An MWI subscription
795  *
796  * This is so we can keep track of which mailboxes are subscribed to.
797  * This way, we know which mailboxes to poll when the pollmailboxes
798  * option is being used.
799  */
800 struct mwi_sub {
801         AST_RWLIST_ENTRY(mwi_sub) entry;
802         int old_urgent;
803         int old_new;
804         int old_old;
805         uint32_t uniqueid;
806         char mailbox[1];
807 };
808
809 struct mwi_sub_task {
810         const char *mailbox;
811         const char *context;
812         uint32_t uniqueid;
813 };
814
815 static struct ast_taskprocessor *mwi_subscription_tps;
816
817 static AST_RWLIST_HEAD_STATIC(mwi_subs, mwi_sub);
818
819 /* custom audio control prompts for voicemail playback */
820 static char listen_control_forward_key[12];
821 static char listen_control_reverse_key[12];
822 static char listen_control_pause_key[12];
823 static char listen_control_restart_key[12];
824 static char listen_control_stop_key[12];
825
826 /* custom password sounds */
827 static char vm_password[80] = "vm-password";
828 static char vm_newpassword[80] = "vm-newpassword";
829 static char vm_passchanged[80] = "vm-passchanged";
830 static char vm_reenterpassword[80] = "vm-reenterpassword";
831 static char vm_mismatch[80] = "vm-mismatch";
832 static char vm_invalid_password[80] = "vm-invalid-password";
833 static char vm_pls_try_again[80] = "vm-pls-try-again";
834
835 static struct ast_flags globalflags = {0};
836
837 static int saydurationminfo;
838
839 static char dialcontext[AST_MAX_CONTEXT] = "";
840 static char callcontext[AST_MAX_CONTEXT] = "";
841 static char exitcontext[AST_MAX_CONTEXT] = "";
842
843 static char cidinternalcontexts[MAX_NUM_CID_CONTEXTS][64];
844
845
846 static char *emailbody = NULL;
847 static char *emailsubject = NULL;
848 static char *pagerbody = NULL;
849 static char *pagersubject = NULL;
850 static char fromstring[100];
851 static char pagerfromstring[100];
852 static char charset[32] = "ISO-8859-1";
853
854 static unsigned char adsifdn[4] = "\x00\x00\x00\x0F";
855 static unsigned char adsisec[4] = "\x9B\xDB\xF7\xAC";
856 static int adsiver = 1;
857 static char emaildateformat[32] = "%A, %B %d, %Y at %r";
858 static char pagerdateformat[32] = "%A, %B %d, %Y at %r";
859
860 /* Forward declarations - generic */
861 static int open_mailbox(struct vm_state *vms, struct ast_vm_user *vmu, int box);
862 static int advanced_options(struct ast_channel *chan, struct ast_vm_user *vmu, struct vm_state *vms, int msg, int option, signed char record_gain);
863 static int dialout(struct ast_channel *chan, struct ast_vm_user *vmu, char *num, char *outgoing_context);
864 static int play_record_review(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime,
865                         char *fmt, int outsidecaller, struct ast_vm_user *vmu, int *duration, const char *unlockdir,
866                         signed char record_gain, struct vm_state *vms, char *flag);
867 static int vm_tempgreeting(struct ast_channel *chan, struct ast_vm_user *vmu, struct vm_state *vms, char *fmtc, signed char record_gain);
868 static int vm_play_folder_name(struct ast_channel *chan, char *mbox);
869 static int notify_new_message(struct ast_channel *chan, struct ast_vm_user *vmu, struct vm_state *vms, int msgnum, long duration, char *fmt, char *cidnum, char *cidname, const char *flag);
870 static void make_email_file(FILE *p, char *srcemail, struct ast_vm_user *vmu, int msgnum, char *context, char *mailbox, const char *fromfolder, char *cidnum, char *cidname, char *attach, char *attach2, char *format, int duration, int attach_user_voicemail, struct ast_channel *chan, const char *category, int imap, const char *flag);
871 static void apply_options(struct ast_vm_user *vmu, const char *options);
872 static int add_email_attachment(FILE *p, struct ast_vm_user *vmu, char *format, char *attach, char *greeting_attachment, char *mailbox, char *bound, char *filename, int last, int msgnum);
873 static int is_valid_dtmf(const char *key);
874 static void read_password_from_file(const char *secretfn, char *password, int passwordlen);
875 static int write_password_to_file(const char *secretfn, const char *password);
876
877 struct ao2_container *inprocess_container;
878
879 struct inprocess {
880         int count;
881         char *context;
882         char mailbox[0];
883 };
884
885 static int inprocess_hash_fn(const void *obj, const int flags)
886 {
887         const struct inprocess *i = obj;
888         return atoi(i->mailbox);
889 }
890
891 static int inprocess_cmp_fn(void *obj, void *arg, int flags)
892 {
893         struct inprocess *i = obj, *j = arg;
894         if (!strcmp(i->mailbox, j->mailbox)) {
895                 return 0;
896         }
897         return !strcmp(i->context, j->context) ? CMP_MATCH : 0;
898 }
899
900 static int inprocess_count(const char *context, const char *mailbox, int delta)
901 {
902         struct inprocess *i, *arg = alloca(sizeof(*arg) + strlen(context) + strlen(mailbox) + 2);
903         arg->context = arg->mailbox + strlen(mailbox) + 1;
904         strcpy(arg->mailbox, mailbox); /* SAFE */
905         strcpy(arg->context, context); /* SAFE */
906         ao2_lock(inprocess_container);
907         if ((i = ao2_find(inprocess_container, arg, 0))) {
908                 int ret = ast_atomic_fetchadd_int(&i->count, delta);
909                 ao2_unlock(inprocess_container);
910                 ao2_ref(i, -1);
911                 return ret;
912         }
913         if (!(i = ao2_alloc(sizeof(*i) + strlen(context) + strlen(mailbox) + 2, NULL))) {
914                 ao2_unlock(inprocess_container);
915                 return 0;
916         }
917         i->context = i->mailbox + strlen(mailbox) + 1;
918         strcpy(i->mailbox, mailbox); /* SAFE */
919         strcpy(i->context, context); /* SAFE */
920         i->count = delta;
921         ao2_link(inprocess_container, i);
922         ao2_unlock(inprocess_container);
923         ao2_ref(i, -1);
924         return 0;
925 }
926
927 #if !(defined(ODBC_STORAGE) || defined(IMAP_STORAGE))
928 static int __has_voicemail(const char *context, const char *mailbox, const char *folder, int shortcircuit);
929 #endif
930
931 /*!
932  * \brief Strips control and non 7-bit clean characters from input string.
933  *
934  * \note To map control and none 7-bit characters to a 7-bit clean characters
935  *  please use ast_str_encode_mine().
936  */
937 static char *strip_control_and_high(const char *input, char *buf, size_t buflen)
938 {
939         char *bufptr = buf;
940         for (; *input; input++) {
941                 if (*input < 32) {
942                         continue;
943                 }
944                 *bufptr++ = *input;
945                 if (bufptr == buf + buflen - 1) {
946                         break;
947                 }
948         }
949         *bufptr = '\0';
950         return buf;
951 }
952
953
954 /*!
955  * \brief Sets default voicemail system options to a voicemail user.
956  *
957  * This applies select global settings to a newly created (dynamic) instance of a voicemail user.
958  * - all the globalflags
959  * - the saydurationminfo
960  * - the callcontext
961  * - the dialcontext
962  * - the exitcontext
963  * - vmmaxsecs, vmmaxmsg, maxdeletedmsg
964  * - volume gain.
965  */
966 static void populate_defaults(struct ast_vm_user *vmu)
967 {
968         ast_copy_flags(vmu, (&globalflags), AST_FLAGS_ALL);     
969         vmu->passwordlocation = passwordlocation;
970         if (saydurationminfo)
971                 vmu->saydurationm = saydurationminfo;
972         ast_copy_string(vmu->callback, callcontext, sizeof(vmu->callback));
973         ast_copy_string(vmu->dialout, dialcontext, sizeof(vmu->dialout));
974         ast_copy_string(vmu->exit, exitcontext, sizeof(vmu->exit));
975         ast_copy_string(vmu->zonetag, zonetag, sizeof(vmu->zonetag));
976         if (vmmaxsecs)
977                 vmu->maxsecs = vmmaxsecs;
978         if (maxmsg)
979                 vmu->maxmsg = maxmsg;
980         if (maxdeletedmsg)
981                 vmu->maxdeletedmsg = maxdeletedmsg;
982         vmu->volgain = volgain;
983         vmu->emailsubject = NULL;
984         vmu->emailbody = NULL;
985 #ifdef IMAP_STORAGE
986         ast_copy_string(vmu->imapfolder, imapfolder, sizeof(vmu->imapfolder));
987 #endif
988 }
989
990 /*!
991  * \brief Sets a a specific property value.
992  * \param vmu The voicemail user object to work with.
993  * \param var The name of the property to be set.
994  * \param value The value to be set to the property.
995  * 
996  * The property name must be one of the understood properties. See the source for details.
997  */
998 static void apply_option(struct ast_vm_user *vmu, const char *var, const char *value)
999 {
1000         int x;
1001         if (!strcasecmp(var, "attach")) {
1002                 ast_set2_flag(vmu, ast_true(value), VM_ATTACH);
1003         } else if (!strcasecmp(var, "attachfmt")) {
1004                 ast_copy_string(vmu->attachfmt, value, sizeof(vmu->attachfmt));
1005         } else if (!strcasecmp(var, "serveremail")) {
1006                 ast_copy_string(vmu->serveremail, value, sizeof(vmu->serveremail));
1007         } else if (!strcasecmp(var, "language")) {
1008                 ast_copy_string(vmu->language, value, sizeof(vmu->language));
1009         } else if (!strcasecmp(var, "tz")) {
1010                 ast_copy_string(vmu->zonetag, value, sizeof(vmu->zonetag));
1011 #ifdef IMAP_STORAGE
1012         } else if (!strcasecmp(var, "imapuser")) {
1013                 ast_copy_string(vmu->imapuser, value, sizeof(vmu->imapuser));
1014                 vmu->imapversion = imapversion;
1015         } else if (!strcasecmp(var, "imappassword") || !strcasecmp(var, "imapsecret")) {
1016                 ast_copy_string(vmu->imappassword, value, sizeof(vmu->imappassword));
1017                 vmu->imapversion = imapversion;
1018         } else if (!strcasecmp(var, "imapfolder")) {
1019                 ast_copy_string(vmu->imapfolder, value, sizeof(vmu->imapfolder));
1020         } else if (!strcasecmp(var, "imapvmshareid")) {
1021                 ast_copy_string(vmu->imapvmshareid, value, sizeof(vmu->imapvmshareid));
1022                 vmu->imapversion = imapversion;
1023 #endif
1024         } else if (!strcasecmp(var, "delete") || !strcasecmp(var, "deletevoicemail")) {
1025                 ast_set2_flag(vmu, ast_true(value), VM_DELETE); 
1026         } else if (!strcasecmp(var, "saycid")){
1027                 ast_set2_flag(vmu, ast_true(value), VM_SAYCID); 
1028         } else if (!strcasecmp(var, "sendvoicemail")){
1029                 ast_set2_flag(vmu, ast_true(value), VM_SVMAIL); 
1030         } else if (!strcasecmp(var, "review")){
1031                 ast_set2_flag(vmu, ast_true(value), VM_REVIEW);
1032         } else if (!strcasecmp(var, "tempgreetwarn")){
1033                 ast_set2_flag(vmu, ast_true(value), VM_TEMPGREETWARN);  
1034         } else if (!strcasecmp(var, "messagewrap")){
1035                 ast_set2_flag(vmu, ast_true(value), VM_MESSAGEWRAP);    
1036         } else if (!strcasecmp(var, "operator")) {
1037                 ast_set2_flag(vmu, ast_true(value), VM_OPERATOR);       
1038         } else if (!strcasecmp(var, "envelope")){
1039                 ast_set2_flag(vmu, ast_true(value), VM_ENVELOPE);       
1040         } else if (!strcasecmp(var, "moveheard")){
1041                 ast_set2_flag(vmu, ast_true(value), VM_MOVEHEARD);
1042         } else if (!strcasecmp(var, "sayduration")){
1043                 ast_set2_flag(vmu, ast_true(value), VM_SAYDURATION);    
1044         } else if (!strcasecmp(var, "saydurationm")){
1045                 if (sscanf(value, "%30d", &x) == 1) {
1046                         vmu->saydurationm = x;
1047                 } else {
1048                         ast_log(AST_LOG_WARNING, "Invalid min duration for say duration\n");
1049                 }
1050         } else if (!strcasecmp(var, "forcename")){
1051                 ast_set2_flag(vmu, ast_true(value), VM_FORCENAME);      
1052         } else if (!strcasecmp(var, "forcegreetings")){
1053                 ast_set2_flag(vmu, ast_true(value), VM_FORCEGREET);     
1054         } else if (!strcasecmp(var, "callback")) {
1055                 ast_copy_string(vmu->callback, value, sizeof(vmu->callback));
1056         } else if (!strcasecmp(var, "dialout")) {
1057                 ast_copy_string(vmu->dialout, value, sizeof(vmu->dialout));
1058         } else if (!strcasecmp(var, "exitcontext")) {
1059                 ast_copy_string(vmu->exit, value, sizeof(vmu->exit));
1060         } else if (!strcasecmp(var, "maxmessage") || !strcasecmp(var, "maxsecs")) {
1061                 vmu->maxsecs = atoi(value);
1062                 if (vmu->maxsecs <= 0) {
1063                         ast_log(AST_LOG_WARNING, "Invalid max message length of %s. Using global value %d\n", value, vmmaxsecs);
1064                         vmu->maxsecs = vmmaxsecs;
1065                 } else {
1066                         vmu->maxsecs = atoi(value);
1067                 }
1068                 if (!strcasecmp(var, "maxmessage"))
1069                         ast_log(AST_LOG_WARNING, "Option 'maxmessage' has been deprecated in favor of 'maxsecs'.  Please make that change in your voicemail config.\n");
1070         } else if (!strcasecmp(var, "maxmsg")) {
1071                 vmu->maxmsg = atoi(value);
1072                 /* Accept maxmsg=0 (Greetings only voicemail) */
1073                 if (vmu->maxmsg < 0) {
1074                         ast_log(AST_LOG_WARNING, "Invalid number of messages per folder maxmsg=%s. Using default value %d\n", value, MAXMSG);
1075                         vmu->maxmsg = MAXMSG;
1076                 } else if (vmu->maxmsg > MAXMSGLIMIT) {
1077                         ast_log(AST_LOG_WARNING, "Maximum number of messages per folder is %d. Cannot accept value maxmsg=%s\n", MAXMSGLIMIT, value);
1078                         vmu->maxmsg = MAXMSGLIMIT;
1079                 }
1080         } else if (!strcasecmp(var, "backupdeleted")) {
1081                 if (sscanf(value, "%30d", &x) == 1)
1082                         vmu->maxdeletedmsg = x;
1083                 else if (ast_true(value))
1084                         vmu->maxdeletedmsg = MAXMSG;
1085                 else
1086                         vmu->maxdeletedmsg = 0;
1087
1088                 if (vmu->maxdeletedmsg < 0) {
1089                         ast_log(AST_LOG_WARNING, "Invalid number of deleted messages saved per mailbox backupdeleted=%s. Using default value %d\n", value, MAXMSG);
1090                         vmu->maxdeletedmsg = MAXMSG;
1091                 } else if (vmu->maxdeletedmsg > MAXMSGLIMIT) {
1092                         ast_log(AST_LOG_WARNING, "Maximum number of deleted messages saved per mailbox is %d. Cannot accept value backupdeleted=%s\n", MAXMSGLIMIT, value);
1093                         vmu->maxdeletedmsg = MAXMSGLIMIT;
1094                 }
1095         } else if (!strcasecmp(var, "volgain")) {
1096                 sscanf(value, "%30lf", &vmu->volgain);
1097         } else if (!strcasecmp(var, "passwordlocation")) {
1098                 if (!strcasecmp(value, "spooldir")) {
1099                         vmu->passwordlocation = OPT_PWLOC_SPOOLDIR;
1100                 } else {
1101                         vmu->passwordlocation = OPT_PWLOC_VOICEMAILCONF;
1102                 }
1103         } else if (!strcasecmp(var, "options")) {
1104                 apply_options(vmu, value);
1105         }
1106 }
1107
1108 static char *vm_check_password_shell(char *command, char *buf, size_t len) 
1109 {
1110         int fds[2], pid = 0;
1111
1112         memset(buf, 0, len);
1113
1114         if (pipe(fds)) {
1115                 snprintf(buf, len, "FAILURE: Pipe failed: %s", strerror(errno));
1116         } else {
1117                 /* good to go*/
1118                 pid = ast_safe_fork(0);
1119
1120                 if (pid < 0) {
1121                         /* ok maybe not */
1122                         close(fds[0]);
1123                         close(fds[1]);
1124                         snprintf(buf, len, "FAILURE: Fork failed");
1125                 } else if (pid) {
1126                         /* parent */
1127                         close(fds[1]);
1128                         if (read(fds[0], buf, len) < 0) {
1129                                 ast_log(LOG_WARNING, "read() failed: %s\n", strerror(errno));
1130                         }
1131                         close(fds[0]);
1132                 } else {
1133                         /*  child */
1134                         AST_DECLARE_APP_ARGS(arg,
1135                                 AST_APP_ARG(v)[20];
1136                         );
1137                         char *mycmd = ast_strdupa(command);
1138
1139                         close(fds[0]);
1140                         dup2(fds[1], STDOUT_FILENO);
1141                         close(fds[1]);
1142                         ast_close_fds_above_n(STDOUT_FILENO);
1143
1144                         AST_NONSTANDARD_APP_ARGS(arg, mycmd, ' ');
1145
1146                         execv(arg.v[0], arg.v); 
1147                         printf("FAILURE: %s", strerror(errno));
1148                         _exit(0);
1149                 }
1150         }
1151         return buf;
1152 }
1153
1154 /*!
1155  * \brief Check that password meets minimum required length
1156  * \param vmu The voicemail user to change the password for.
1157  * \param password The password string to check
1158  *
1159  * \return zero on ok, 1 on not ok.
1160  */
1161 static int check_password(struct ast_vm_user *vmu, char *password)
1162 {
1163         /* check minimum length */
1164         if (strlen(password) < minpassword)
1165                 return 1;
1166         if (!ast_strlen_zero(ext_pass_check_cmd)) {
1167                 char cmd[255], buf[255];
1168
1169                 ast_log(AST_LOG_DEBUG, "Verify password policies for %s\n", password);
1170
1171                 snprintf(cmd, sizeof(cmd), "%s %s %s %s %s", ext_pass_check_cmd, vmu->mailbox, vmu->context, vmu->password, password);
1172                 if (vm_check_password_shell(cmd, buf, sizeof(buf))) {
1173                         ast_debug(5, "Result: %s\n", buf);
1174                         if (!strncasecmp(buf, "VALID", 5)) {
1175                                 ast_debug(3, "Passed password check: '%s'\n", buf);
1176                                 return 0;
1177                         } else if (!strncasecmp(buf, "FAILURE", 7)) {
1178                                 ast_log(AST_LOG_WARNING, "Unable to execute password validation script: '%s'.\n", buf);
1179                                 return 0;
1180                         } else {
1181                                 ast_log(AST_LOG_NOTICE, "Password doesn't match policies for user %s %s\n", vmu->mailbox, password);
1182                                 return 1;
1183                         }
1184                 }
1185         }
1186         return 0;
1187 }
1188
1189 /*! 
1190  * \brief Performs a change of the voicemail passowrd in the realtime engine.
1191  * \param vmu The voicemail user to change the password for.
1192  * \param password The new value to be set to the password for this user.
1193  * 
1194  * This only works if there is a realtime engine configured.
1195  * This is called from the (top level) vm_change_password.
1196  *
1197  * \return zero on success, -1 on error.
1198  */
1199 static int change_password_realtime(struct ast_vm_user *vmu, const char *password)
1200 {
1201         int res = -1;
1202         if (!strcmp(vmu->password, password)) {
1203                 /* No change (but an update would return 0 rows updated, so we opt out here) */
1204                 return 0;
1205         }
1206
1207         if (strlen(password) > 10) {
1208                 ast_realtime_require_field("voicemail", "password", RQ_CHAR, strlen(password), SENTINEL);
1209         }
1210         if (ast_update2_realtime("voicemail", "context", vmu->context, "mailbox", vmu->mailbox, SENTINEL, "password", password, SENTINEL) > 0) {
1211                 ast_copy_string(vmu->password, password, sizeof(vmu->password));
1212                 res = 0;
1213         }
1214         return res;
1215 }
1216
1217 /*!
1218  * \brief Destructively Parse options and apply.
1219  */
1220 static void apply_options(struct ast_vm_user *vmu, const char *options)
1221 {       
1222         char *stringp;
1223         char *s;
1224         char *var, *value;
1225         stringp = ast_strdupa(options);
1226         while ((s = strsep(&stringp, "|"))) {
1227                 value = s;
1228                 if ((var = strsep(&value, "=")) && value) {
1229                         apply_option(vmu, var, value);
1230                 }
1231         }       
1232 }
1233
1234 /*!
1235  * \brief Loads the options specific to a voicemail user.
1236  * 
1237  * This is called when a vm_user structure is being set up, such as from load_options.
1238  */
1239 static void apply_options_full(struct ast_vm_user *retval, struct ast_variable *var)
1240 {
1241         for (; var; var = var->next) {
1242                 if (!strcasecmp(var->name, "vmsecret")) {
1243                         ast_copy_string(retval->password, var->value, sizeof(retval->password));
1244                 } else if (!strcasecmp(var->name, "secret") || !strcasecmp(var->name, "password")) { /* don't overwrite vmsecret if it exists */
1245                         if (ast_strlen_zero(retval->password))
1246                                 ast_copy_string(retval->password, var->value, sizeof(retval->password));
1247                 } else if (!strcasecmp(var->name, "uniqueid")) {
1248                         ast_copy_string(retval->uniqueid, var->value, sizeof(retval->uniqueid));
1249                 } else if (!strcasecmp(var->name, "pager")) {
1250                         ast_copy_string(retval->pager, var->value, sizeof(retval->pager));
1251                 } else if (!strcasecmp(var->name, "email")) {
1252                         ast_copy_string(retval->email, var->value, sizeof(retval->email));
1253                 } else if (!strcasecmp(var->name, "fullname")) {
1254                         ast_copy_string(retval->fullname, var->value, sizeof(retval->fullname));
1255                 } else if (!strcasecmp(var->name, "context")) {
1256                         ast_copy_string(retval->context, var->value, sizeof(retval->context));
1257                 } else if (!strcasecmp(var->name, "emailsubject")) {
1258                         retval->emailsubject = ast_strdup(var->value);
1259                 } else if (!strcasecmp(var->name, "emailbody")) {
1260                         retval->emailbody = ast_strdup(var->value);
1261 #ifdef IMAP_STORAGE
1262                 } else if (!strcasecmp(var->name, "imapuser")) {
1263                         ast_copy_string(retval->imapuser, var->value, sizeof(retval->imapuser));
1264                         retval->imapversion = imapversion;
1265                 } else if (!strcasecmp(var->name, "imappassword") || !strcasecmp(var->name, "imapsecret")) {
1266                         ast_copy_string(retval->imappassword, var->value, sizeof(retval->imappassword));
1267                         retval->imapversion = imapversion;
1268                 } else if (!strcasecmp(var->name, "imapfolder")) {
1269                         ast_copy_string(retval->imapfolder, var->value, sizeof(retval->imapfolder));
1270                 } else if (!strcasecmp(var->name, "imapvmshareid")) {
1271                         ast_copy_string(retval->imapvmshareid, var->value, sizeof(retval->imapvmshareid));
1272                         retval->imapversion = imapversion;
1273 #endif
1274                 } else
1275                         apply_option(retval, var->name, var->value);
1276         }
1277 }
1278
1279 /*!
1280  * \brief Determines if a DTMF key entered is valid.
1281  * \param key The character to be compared. expects a single character. Though is capable of handling a string, this is internally copies using ast_strdupa.
1282  *
1283  * Tests the character entered against the set of valid DTMF characters. 
1284  * \return 1 if the character entered is a valid DTMF digit, 0 if the character is invalid.
1285  */
1286 static int is_valid_dtmf(const char *key)
1287 {
1288         int i;
1289         char *local_key = ast_strdupa(key);
1290
1291         for (i = 0; i < strlen(key); ++i) {
1292                 if (!strchr(VALID_DTMF, *local_key)) {
1293                         ast_log(AST_LOG_WARNING, "Invalid DTMF key \"%c\" used in voicemail configuration file\n", *local_key);
1294                         return 0;
1295                 }
1296                 local_key++;
1297         }
1298         return 1;
1299 }
1300
1301 /*!
1302  * \brief Finds a voicemail user from the realtime engine.
1303  * \param ivm
1304  * \param context
1305  * \param mailbox
1306  *
1307  * This is called as a fall through case when the normal find_user() was not able to find a user. That is, the default it so look in the usual voicemail users file first.
1308  *
1309  * \return The ast_vm_user structure for the user that was found.
1310  */
1311 static struct ast_vm_user *find_user_realtime(struct ast_vm_user *ivm, const char *context, const char *mailbox)
1312 {
1313         struct ast_variable *var;
1314         struct ast_vm_user *retval;
1315
1316         if ((retval = (ivm ? ivm : ast_calloc(1, sizeof(*retval))))) {
1317                 if (!ivm)
1318                         ast_set_flag(retval, VM_ALLOCED);       
1319                 else
1320                         memset(retval, 0, sizeof(*retval));
1321                 if (mailbox) 
1322                         ast_copy_string(retval->mailbox, mailbox, sizeof(retval->mailbox));
1323                 populate_defaults(retval);
1324                 if (!context && ast_test_flag((&globalflags), VM_SEARCH))
1325                         var = ast_load_realtime("voicemail", "mailbox", mailbox, SENTINEL);
1326                 else
1327                         var = ast_load_realtime("voicemail", "mailbox", mailbox, "context", context, SENTINEL);
1328                 if (var) {
1329                         apply_options_full(retval, var);
1330                         ast_variables_destroy(var);
1331                 } else { 
1332                         if (!ivm) 
1333                                 ast_free(retval);
1334                         retval = NULL;
1335                 }       
1336         } 
1337         return retval;
1338 }
1339
1340 /*!
1341  * \brief Finds a voicemail user from the users file or the realtime engine.
1342  * \param ivm
1343  * \param context
1344  * \param mailbox
1345  * 
1346  * \return The ast_vm_user structure for the user that was found.
1347  */
1348 static struct ast_vm_user *find_user(struct ast_vm_user *ivm, const char *context, const char *mailbox)
1349 {
1350         /* This function could be made to generate one from a database, too */
1351         struct ast_vm_user *vmu = NULL, *cur;
1352         AST_LIST_LOCK(&users);
1353
1354         if (!context && !ast_test_flag((&globalflags), VM_SEARCH))
1355                 context = "default";
1356
1357         AST_LIST_TRAVERSE(&users, cur, list) {
1358 #ifdef IMAP_STORAGE
1359                 if (cur->imapversion != imapversion) {
1360                         continue;
1361                 }
1362 #endif
1363                 if (ast_test_flag((&globalflags), VM_SEARCH) && !strcasecmp(mailbox, cur->mailbox))
1364                         break;
1365                 if (context && (!strcasecmp(context, cur->context)) && (!strcasecmp(mailbox, cur->mailbox)))
1366                         break;
1367         }
1368         if (cur) {
1369                 /* Make a copy, so that on a reload, we have no race */
1370                 if ((vmu = (ivm ? ivm : ast_malloc(sizeof(*vmu))))) {
1371                         memcpy(vmu, cur, sizeof(*vmu));
1372                         ast_set2_flag(vmu, !ivm, VM_ALLOCED);
1373                         AST_LIST_NEXT(vmu, list) = NULL;
1374                 }
1375         } else
1376                 vmu = find_user_realtime(ivm, context, mailbox);
1377         AST_LIST_UNLOCK(&users);
1378         return vmu;
1379 }
1380
1381 /*!
1382  * \brief Resets a user password to a specified password.
1383  * \param context
1384  * \param mailbox
1385  * \param newpass
1386  *
1387  * This does the actual change password work, called by the vm_change_password() function.
1388  *
1389  * \return zero on success, -1 on error.
1390  */
1391 static int reset_user_pw(const char *context, const char *mailbox, const char *newpass)
1392 {
1393         /* This function could be made to generate one from a database, too */
1394         struct ast_vm_user *cur;
1395         int res = -1;
1396         AST_LIST_LOCK(&users);
1397         AST_LIST_TRAVERSE(&users, cur, list) {
1398                 if ((!context || !strcasecmp(context, cur->context)) &&
1399                         (!strcasecmp(mailbox, cur->mailbox)))
1400                                 break;
1401         }
1402         if (cur) {
1403                 ast_copy_string(cur->password, newpass, sizeof(cur->password));
1404                 res = 0;
1405         }
1406         AST_LIST_UNLOCK(&users);
1407         return res;
1408 }
1409
1410 /*! 
1411  * \brief The handler for the change password option.
1412  * \param vmu The voicemail user to work with.
1413  * \param newpassword The new password (that has been gathered from the appropriate prompting).
1414  * This is called when a new user logs in for the first time and the option to force them to change their password is set.
1415  * It is also called when the user wants to change their password from menu option '5' on the mailbox options menu.
1416  */
1417 static void vm_change_password(struct ast_vm_user *vmu, const char *newpassword)
1418 {
1419         struct ast_config   *cfg = NULL;
1420         struct ast_variable *var = NULL;
1421         struct ast_category *cat = NULL;
1422         char *category = NULL, *value = NULL, *new = NULL;
1423         const char *tmp = NULL;
1424         struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS };
1425         char secretfn[PATH_MAX] = "";
1426         int found = 0;
1427
1428         if (!change_password_realtime(vmu, newpassword))
1429                 return;
1430
1431         /* check if we should store the secret in the spool directory next to the messages */
1432         switch (vmu->passwordlocation) {
1433         case OPT_PWLOC_SPOOLDIR:
1434                 snprintf(secretfn, sizeof(secretfn), "%s%s/%s/secret.conf", VM_SPOOL_DIR, vmu->context, vmu->mailbox);
1435                 if (write_password_to_file(secretfn, newpassword) == 0) {
1436                         ast_verb(4, "Writing voicemail password to file %s succeeded\n", secretfn);
1437                         reset_user_pw(vmu->context, vmu->mailbox, newpassword);
1438                         ast_copy_string(vmu->password, newpassword, sizeof(vmu->password));
1439                         break;
1440                 } else {
1441                         ast_verb(4, "Writing voicemail password to file %s failed, falling back to config file\n", secretfn);
1442                 }
1443                 /* Fall-through */
1444         case OPT_PWLOC_VOICEMAILCONF:
1445                 if ((cfg = ast_config_load(VOICEMAIL_CONFIG, config_flags)) && cfg != CONFIG_STATUS_FILEINVALID) {
1446                         while ((category = ast_category_browse(cfg, category))) {
1447                                 if (!strcasecmp(category, vmu->context)) {
1448                                         if (!(tmp = ast_variable_retrieve(cfg, category, vmu->mailbox))) {
1449                                                 ast_log(AST_LOG_WARNING, "We could not find the mailbox.\n");
1450                                                 break;
1451                                         }
1452                                         value = strstr(tmp, ",");
1453                                         if (!value) {
1454                                                 ast_log(AST_LOG_WARNING, "variable has bad format.\n");
1455                                                 break;
1456                                         }
1457                                         new = alloca((strlen(value) + strlen(newpassword) + 1));
1458                                         sprintf(new, "%s%s", newpassword, value);
1459                                         if (!(cat = ast_category_get(cfg, category))) {
1460                                                 ast_log(AST_LOG_WARNING, "Failed to get category structure.\n");
1461                                                 break;
1462                                         }
1463                                         ast_variable_update(cat, vmu->mailbox, new, NULL, 0);
1464                                         found = 1;
1465                                 }
1466                         }
1467                         /* save the results */
1468                         if (found) {
1469                                 reset_user_pw(vmu->context, vmu->mailbox, newpassword);
1470                                 ast_copy_string(vmu->password, newpassword, sizeof(vmu->password));
1471                                 ast_config_text_file_save(VOICEMAIL_CONFIG, cfg, "AppVoicemail");
1472                                 break;
1473                         }
1474                 }
1475                 /* Fall-through */
1476         case OPT_PWLOC_USERSCONF:
1477                 /* check users.conf and update the password stored for the mailbox */
1478                 /* if no vmsecret entry exists create one. */
1479                 if ((cfg = ast_config_load("users.conf", config_flags)) && cfg != CONFIG_STATUS_FILEINVALID) {
1480                         ast_debug(4, "we are looking for %s\n", vmu->mailbox);
1481                         for (category = ast_category_browse(cfg, NULL); category; category = ast_category_browse(cfg, category)) {
1482                                 ast_debug(4, "users.conf: %s\n", category);
1483                                 if (!strcasecmp(category, vmu->mailbox)) {
1484                                         if (!(tmp = ast_variable_retrieve(cfg, category, "vmsecret"))) {
1485                                                 ast_debug(3, "looks like we need to make vmsecret!\n");
1486                                                 var = ast_variable_new("vmsecret", newpassword, "");
1487                                         } else {
1488                                                 var = NULL;
1489                                         }
1490                                         new = alloca(strlen(newpassword) + 1);
1491                                         sprintf(new, "%s", newpassword);
1492                                         if (!(cat = ast_category_get(cfg, category))) {
1493                                                 ast_debug(4, "failed to get category!\n");
1494                                                 ast_free(var);
1495                                                 break;
1496                                         }
1497                                         if (!var) {
1498                                                 ast_variable_update(cat, "vmsecret", new, NULL, 0);
1499                                         } else {
1500                                                 ast_variable_append(cat, var);
1501                                         }
1502                                         found = 1;
1503                                         break;
1504                                 }
1505                         }
1506                         /* save the results and clean things up */
1507                         if (found) {
1508                                 reset_user_pw(vmu->context, vmu->mailbox, newpassword);
1509                                 ast_copy_string(vmu->password, newpassword, sizeof(vmu->password));
1510                                 ast_config_text_file_save("users.conf", cfg, "AppVoicemail");
1511                         }
1512                 }
1513         }
1514 }
1515
1516 static void vm_change_password_shell(struct ast_vm_user *vmu, char *newpassword)
1517 {
1518         char buf[255];
1519         snprintf(buf, sizeof(buf), "%s %s %s %s", ext_pass_cmd, vmu->context, vmu->mailbox, newpassword);
1520         if (!ast_safe_system(buf)) {
1521                 ast_copy_string(vmu->password, newpassword, sizeof(vmu->password));
1522                 /* Reset the password in memory, too */
1523                 reset_user_pw(vmu->context, vmu->mailbox, newpassword);
1524         }
1525 }
1526
1527 /*! 
1528  * \brief Creates a file system path expression for a folder within the voicemail data folder and the appropriate context.
1529  * \param dest The variable to hold the output generated path expression. This buffer should be of size PATH_MAX.
1530  * \param len The length of the path string that was written out.
1531  * 
1532  * The path is constructed as 
1533  *      VM_SPOOL_DIRcontext/ext/folder
1534  *
1535  * \return zero on success, -1 on error.
1536  */
1537 static int make_dir(char *dest, int len, const char *context, const char *ext, const char *folder)
1538 {
1539         return snprintf(dest, len, "%s%s/%s/%s", VM_SPOOL_DIR, context, ext, folder);
1540 }
1541
1542 /*! 
1543  * \brief Creates a file system path expression for a folder within the voicemail data folder and the appropriate context.
1544  * \param dest The variable to hold the output generated path expression. This buffer should be of size PATH_MAX.
1545  * \param len The length of the path string that was written out.
1546  * 
1547  * The path is constructed as 
1548  *      VM_SPOOL_DIRcontext/ext/folder
1549  *
1550  * \return zero on success, -1 on error.
1551  */
1552 static int make_file(char *dest, const int len, const char *dir, const int num)
1553 {
1554         return snprintf(dest, len, "%s/msg%04d", dir, num);
1555 }
1556
1557 /* same as mkstemp, but return a FILE * */
1558 static FILE *vm_mkftemp(char *template)
1559 {
1560         FILE *p = NULL;
1561         int pfd = mkstemp(template);
1562         chmod(template, VOICEMAIL_FILE_MODE & ~my_umask);
1563         if (pfd > -1) {
1564                 p = fdopen(pfd, "w+");
1565                 if (!p) {
1566                         close(pfd);
1567                         pfd = -1;
1568                 }
1569         }
1570         return p;
1571 }
1572
1573 /*! \brief basically mkdir -p $dest/$context/$ext/$folder
1574  * \param dest    String. base directory.
1575  * \param len     Length of dest.
1576  * \param context String. Ignored if is null or empty string.
1577  * \param ext     String. Ignored if is null or empty string.
1578  * \param folder  String. Ignored if is null or empty string. 
1579  * \return -1 on failure, 0 on success.
1580  */
1581 static int create_dirpath(char *dest, int len, const char *context, const char *ext, const char *folder)
1582 {
1583         mode_t  mode = VOICEMAIL_DIR_MODE;
1584         int res;
1585
1586         make_dir(dest, len, context, ext, folder);
1587         if ((res = ast_mkdir(dest, mode))) {
1588                 ast_log(AST_LOG_WARNING, "ast_mkdir '%s' failed: %s\n", dest, strerror(res));
1589                 return -1;
1590         }
1591         return 0;
1592 }
1593
1594 static const char * const mailbox_folders[] = {
1595 #ifdef IMAP_STORAGE
1596         imapfolder,
1597 #else
1598         "INBOX",
1599 #endif
1600         "Old",
1601         "Work",
1602         "Family",
1603         "Friends",
1604         "Cust1",
1605         "Cust2",
1606         "Cust3",
1607         "Cust4",
1608         "Cust5",
1609         "Deleted",
1610         "Urgent",
1611 };
1612
1613 static const char *mbox(struct ast_vm_user *vmu, int id)
1614 {
1615 #ifdef IMAP_STORAGE
1616         if (vmu && id == 0) {
1617                 return vmu->imapfolder;
1618         }
1619 #endif
1620         return (id >= 0 && id < ARRAY_LEN(mailbox_folders)) ? mailbox_folders[id] : "Unknown";
1621 }
1622
1623 static int get_folder_by_name(const char *name)
1624 {
1625         size_t i;
1626
1627         for (i = 0; i < ARRAY_LEN(mailbox_folders); i++) {
1628                 if (strcasecmp(name, mailbox_folders[i]) == 0) {
1629                         return i;
1630                 }
1631         }
1632
1633         return -1;
1634 }
1635
1636 static void free_user(struct ast_vm_user *vmu)
1637 {
1638         if (ast_test_flag(vmu, VM_ALLOCED)) {
1639                 if (vmu->emailbody != NULL) {
1640                         ast_free(vmu->emailbody);
1641                         vmu->emailbody = NULL;
1642                 }
1643                 if (vmu->emailsubject != NULL) {
1644                         ast_free(vmu->emailsubject);
1645                         vmu->emailsubject = NULL;
1646                 }
1647                 ast_free(vmu);
1648         }
1649 }
1650
1651 /* All IMAP-specific functions should go in this block. This
1652  * keeps them from being spread out all over the code */
1653 #ifdef IMAP_STORAGE
1654 static void vm_imap_delete(char *file, int msgnum, struct ast_vm_user *vmu)
1655 {
1656         char arg[10];
1657         struct vm_state *vms;
1658         unsigned long messageNum;
1659
1660         /* If greetings aren't stored in IMAP, just delete the file */
1661         if (msgnum < 0 && !imapgreetings) {
1662                 ast_filedelete(file, NULL);
1663                 return;
1664         }
1665
1666         if (!(vms = get_vm_state_by_mailbox(vmu->mailbox, vmu->context, 1)) && !(vms = get_vm_state_by_mailbox(vmu->mailbox, vmu->context, 0))) {
1667                 ast_log(LOG_WARNING, "Couldn't find a vm_state for mailbox %s. Unable to set \\DELETED flag for message %d\n", vmu->mailbox, msgnum);
1668                 return;
1669         }
1670
1671         /* find real message number based on msgnum */
1672         /* this may be an index into vms->msgArray based on the msgnum. */
1673         messageNum = vms->msgArray[msgnum];
1674         if (messageNum == 0) {
1675                 ast_log(LOG_WARNING, "msgnum %d, mailbox message %lu is zero.\n", msgnum, messageNum);
1676                 return;
1677         }
1678         if (option_debug > 2)
1679                 ast_log(LOG_DEBUG, "deleting msgnum %d, which is mailbox message %lu\n", msgnum, messageNum);
1680         /* delete message */
1681         snprintf (arg, sizeof(arg), "%lu", messageNum);
1682         ast_mutex_lock(&vms->lock);
1683         mail_setflag (vms->mailstream, arg, "\\DELETED");
1684         mail_expunge(vms->mailstream);
1685         ast_mutex_unlock(&vms->lock);
1686 }
1687
1688 static int imap_retrieve_greeting(const char *dir, const int msgnum, struct ast_vm_user *vmu)
1689 {
1690         struct vm_state *vms_p;
1691         char *file, *filename;
1692         char *attachment;
1693         int ret = 0, i;
1694         BODY *body;
1695
1696         /* This function is only used for retrieval of IMAP greetings
1697          * regular messages are not retrieved this way, nor are greetings
1698          * if they are stored locally*/
1699         if (msgnum > -1 || !imapgreetings) {
1700                 return 0;
1701         } else {
1702                 file = strrchr(ast_strdupa(dir), '/');
1703                 if (file)
1704                         *file++ = '\0';
1705                 else {
1706                         ast_debug (1, "Failed to procure file name from directory passed.\n");
1707                         return -1;
1708                 }
1709         }
1710
1711         /* check if someone is accessing this box right now... */
1712         if (!(vms_p = get_vm_state_by_mailbox(vmu->mailbox, vmu->context, 1)) && 
1713                 !(vms_p = get_vm_state_by_mailbox(vmu->mailbox, vmu->context, 0))) {
1714                 /* Unlike when retrieving a message, it is reasonable not to be able to find a 
1715                 * vm_state for a mailbox when trying to retrieve a greeting. Just create one,
1716                 * that's all we need to do.
1717                 */
1718                 if (!(vms_p = create_vm_state_from_user(vmu))) {
1719                         ast_log(LOG_NOTICE, "Unable to create vm_state object!\n");
1720                         return -1;
1721                 }
1722         }
1723         
1724         /* Greetings will never have a prepended message */
1725         *vms_p->introfn = '\0';
1726
1727         ast_mutex_lock(&vms_p->lock);
1728         ret = init_mailstream(vms_p, GREETINGS_FOLDER);
1729         if (!vms_p->mailstream) {
1730                 ast_log(AST_LOG_ERROR, "IMAP mailstream is NULL\n");
1731                 ast_mutex_unlock(&vms_p->lock);
1732                 return -1;
1733         }
1734
1735         /*XXX Yuck, this could probably be done a lot better */
1736         for (i = 0; i < vms_p->mailstream->nmsgs; i++) {
1737                 mail_fetchstructure(vms_p->mailstream, i + 1, &body);
1738                 /* We have the body, now we extract the file name of the first attachment. */
1739                 if (body->nested.part && body->nested.part->next && body->nested.part->next->body.parameter->value) {
1740                         attachment = ast_strdupa(body->nested.part->next->body.parameter->value);
1741                 } else {
1742                         ast_log(AST_LOG_ERROR, "There is no file attached to this IMAP message.\n");
1743                         ast_mutex_unlock(&vms_p->lock);
1744                         return -1;
1745                 }
1746                 filename = strsep(&attachment, ".");
1747                 if (!strcmp(filename, file)) {
1748                         ast_copy_string(vms_p->fn, dir, sizeof(vms_p->fn));
1749                         vms_p->msgArray[vms_p->curmsg] = i + 1;
1750                         save_body(body, vms_p, "2", attachment, 0);
1751                         ast_mutex_unlock(&vms_p->lock);
1752                         return 0;
1753                 }
1754         }
1755         ast_mutex_unlock(&vms_p->lock);
1756
1757         return -1;
1758 }
1759
1760 static int imap_retrieve_file(const char *dir, const int msgnum, const char *mailbox, const char *context)
1761 {
1762         BODY *body;
1763         char *header_content;
1764         char *attachedfilefmt;
1765         char buf[80];
1766         struct vm_state *vms;
1767         char text_file[PATH_MAX];
1768         FILE *text_file_ptr;
1769         int res = 0;
1770         struct ast_vm_user *vmu;
1771
1772         if (!(vmu = find_user(NULL, context, mailbox))) {
1773                 ast_log(LOG_WARNING, "Couldn't find user with mailbox %s@%s\n", mailbox, context);
1774                 return -1;
1775         }
1776         
1777         if (msgnum < 0) {
1778                 if (imapgreetings) {
1779                         res = imap_retrieve_greeting(dir, msgnum, vmu);
1780                         goto exit;
1781                 } else {
1782                         res = 0;
1783                         goto exit;
1784                 }
1785         }
1786
1787         /* Before anything can happen, we need a vm_state so that we can
1788          * actually access the imap server through the vms->mailstream
1789          */
1790         if (!(vms = get_vm_state_by_mailbox(vmu->mailbox, vmu->context, 1)) && !(vms = get_vm_state_by_mailbox(vmu->mailbox, vmu->context, 0))) {
1791                 /* This should not happen. If it does, then I guess we'd
1792                  * need to create the vm_state, extract which mailbox to
1793                  * open, and then set up the msgArray so that the correct
1794                  * IMAP message could be accessed. If I have seen correctly
1795                  * though, the vms should be obtainable from the vmstates list
1796                  * and should have its msgArray properly set up.
1797                  */
1798                 ast_log(LOG_ERROR, "Couldn't find a vm_state for mailbox %s!!! Oh no!\n", vmu->mailbox);
1799                 res = -1;
1800                 goto exit;
1801         }
1802         
1803         make_file(vms->fn, sizeof(vms->fn), dir, msgnum);
1804         snprintf(vms->introfn, sizeof(vms->introfn), "%sintro", vms->fn);
1805
1806         /* Don't try to retrieve a message from IMAP if it already is on the file system */
1807         if (ast_fileexists(vms->fn, NULL, NULL) > 0) {
1808                 res = 0;
1809                 goto exit;
1810         }
1811
1812         if (option_debug > 2)
1813                 ast_log(LOG_DEBUG, "Before mail_fetchheaders, curmsg is: %d, imap messages is %lu\n", msgnum, vms->msgArray[msgnum]);
1814         if (vms->msgArray[msgnum] == 0) {
1815                 ast_log(LOG_WARNING, "Trying to access unknown message\n");
1816                 res = -1;
1817                 goto exit;
1818         }
1819
1820         /* This will only work for new messages... */
1821         ast_mutex_lock(&vms->lock);
1822         header_content = mail_fetchheader (vms->mailstream, vms->msgArray[msgnum]);
1823         ast_mutex_unlock(&vms->lock);
1824         /* empty string means no valid header */
1825         if (ast_strlen_zero(header_content)) {
1826                 ast_log(LOG_ERROR, "Could not fetch header for message number %ld\n", vms->msgArray[msgnum]);
1827                 res = -1;
1828                 goto exit;
1829         }
1830
1831         ast_mutex_lock(&vms->lock);
1832         mail_fetchstructure(vms->mailstream, vms->msgArray[msgnum], &body);
1833         ast_mutex_unlock(&vms->lock);
1834
1835         /* We have the body, now we extract the file name of the first attachment. */
1836         if (body->nested.part && body->nested.part->next && body->nested.part->next->body.parameter->value) {
1837                 attachedfilefmt = ast_strdupa(body->nested.part->next->body.parameter->value);
1838         } else {
1839                 ast_log(LOG_ERROR, "There is no file attached to this IMAP message.\n");
1840                 res = -1;
1841                 goto exit;
1842         }
1843         
1844         /* Find the format of the attached file */
1845
1846         strsep(&attachedfilefmt, ".");
1847         if (!attachedfilefmt) {
1848                 ast_log(LOG_ERROR, "File format could not be obtained from IMAP message attachment\n");
1849                 res = -1;
1850                 goto exit;
1851         }
1852         
1853         save_body(body, vms, "2", attachedfilefmt, 0);
1854         if (save_body(body, vms, "3", attachedfilefmt, 1)) {
1855                 *vms->introfn = '\0';
1856         }
1857
1858         /* Get info from headers!! */
1859         snprintf(text_file, sizeof(text_file), "%s.%s", vms->fn, "txt");
1860
1861         if (!(text_file_ptr = fopen(text_file, "w"))) {
1862                 ast_log(LOG_WARNING, "Unable to open/create file %s: %s\n", text_file, strerror(errno));
1863         }
1864
1865         fprintf(text_file_ptr, "%s\n", "[message]");
1866
1867         get_header_by_tag(header_content, "X-Asterisk-VM-Caller-ID-Name:", buf, sizeof(buf));
1868         fprintf(text_file_ptr, "callerid=\"%s\" ", S_OR(buf, ""));
1869         get_header_by_tag(header_content, "X-Asterisk-VM-Caller-ID-Num:", buf, sizeof(buf));
1870         fprintf(text_file_ptr, "<%s>\n", S_OR(buf, ""));
1871         get_header_by_tag(header_content, "X-Asterisk-VM-Context:", buf, sizeof(buf));
1872         fprintf(text_file_ptr, "context=%s\n", S_OR(buf, ""));
1873         get_header_by_tag(header_content, "X-Asterisk-VM-Orig-time:", buf, sizeof(buf));
1874         fprintf(text_file_ptr, "origtime=%s\n", S_OR(buf, ""));
1875         get_header_by_tag(header_content, "X-Asterisk-VM-Duration:", buf, sizeof(buf));
1876         fprintf(text_file_ptr, "duration=%s\n", S_OR(buf, ""));
1877         get_header_by_tag(header_content, "X-Asterisk-VM-Category:", buf, sizeof(buf));
1878         fprintf(text_file_ptr, "category=%s\n", S_OR(buf, ""));
1879         get_header_by_tag(header_content, "X-Asterisk-VM-Flag:", buf, sizeof(buf));
1880         fprintf(text_file_ptr, "flag=%s\n", S_OR(buf, ""));
1881         fclose(text_file_ptr);
1882
1883 exit:
1884         free_user(vmu);
1885         return res;
1886 }
1887
1888 static int folder_int(const char *folder)
1889 {
1890         /*assume a NULL folder means INBOX*/
1891         if (!folder)
1892                 return 0;
1893         if (!strcasecmp(folder, imapfolder))
1894                 return 0;
1895         else if (!strcasecmp(folder, "Old"))
1896                 return 1;
1897         else if (!strcasecmp(folder, "Work"))
1898                 return 2;
1899         else if (!strcasecmp(folder, "Family"))
1900                 return 3;
1901         else if (!strcasecmp(folder, "Friends"))
1902                 return 4;
1903         else if (!strcasecmp(folder, "Cust1"))
1904                 return 5;
1905         else if (!strcasecmp(folder, "Cust2"))
1906                 return 6;
1907         else if (!strcasecmp(folder, "Cust3"))
1908                 return 7;
1909         else if (!strcasecmp(folder, "Cust4"))
1910                 return 8;
1911         else if (!strcasecmp(folder, "Cust5"))
1912                 return 9;
1913         else /*assume they meant INBOX if folder is not found otherwise*/
1914                 return 0;
1915 }
1916
1917 static int __messagecount(const char *context, const char *mailbox, const char *folder)
1918 {
1919         SEARCHPGM *pgm;
1920         SEARCHHEADER *hdr;
1921
1922         struct ast_vm_user *vmu, vmus;
1923         struct vm_state *vms_p;
1924         int ret = 0;
1925         int fold = folder_int(folder);
1926         int urgent = 0;
1927         
1928         /* If URGENT, then look at INBOX */
1929         if (fold == 11) {
1930                 fold = NEW_FOLDER;
1931                 urgent = 1;
1932         }
1933
1934         if (ast_strlen_zero(mailbox))
1935                 return 0;
1936
1937         /* We have to get the user before we can open the stream! */
1938         vmu = find_user(&vmus, context, mailbox);
1939         if (!vmu) {
1940                 ast_log(AST_LOG_ERROR, "Couldn't find mailbox %s in context %s\n", mailbox, context);
1941                 return -1;
1942         } else {
1943                 /* No IMAP account available */
1944                 if (vmu->imapuser[0] == '\0') {
1945                         ast_log(AST_LOG_WARNING, "IMAP user not set for mailbox %s\n", vmu->mailbox);
1946                         return -1;
1947                 }
1948         }
1949         
1950         /* No IMAP account available */
1951         if (vmu->imapuser[0] == '\0') {
1952                 ast_log(AST_LOG_WARNING, "IMAP user not set for mailbox %s\n", vmu->mailbox);
1953                 free_user(vmu);
1954                 return -1;
1955         }
1956
1957         /* check if someone is accessing this box right now... */
1958         vms_p = get_vm_state_by_imapuser(vmu->imapuser, 1);
1959         if (!vms_p) {
1960                 vms_p = get_vm_state_by_mailbox(mailbox, context, 1);
1961         }
1962         if (vms_p) {
1963                 ast_debug(3, "Returning before search - user is logged in\n");
1964                 if (fold == 0) { /* INBOX */
1965                         return vms_p->newmessages;
1966                 }
1967                 if (fold == 1) { /* Old messages */
1968                         return vms_p->oldmessages;
1969                 }
1970                 if (fold == 11) {/*Urgent messages*/
1971                         return vms_p->urgentmessages;
1972                 }
1973         }
1974
1975         /* add one if not there... */
1976         vms_p = get_vm_state_by_imapuser(vmu->imapuser, 0);
1977         if (!vms_p) {
1978                 vms_p = get_vm_state_by_mailbox(mailbox, context, 0);
1979         }
1980
1981         if (!vms_p) {
1982                 vms_p = create_vm_state_from_user(vmu);
1983         }
1984         ret = init_mailstream(vms_p, fold);
1985         if (!vms_p->mailstream) {
1986                 ast_log(AST_LOG_ERROR, "Houston we have a problem - IMAP mailstream is NULL\n");
1987                 return -1;
1988         }
1989         if (ret == 0) {
1990                 ast_mutex_lock(&vms_p->lock);
1991                 pgm = mail_newsearchpgm ();
1992                 hdr = mail_newsearchheader ("X-Asterisk-VM-Extension", (char *)(!ast_strlen_zero(vmu->imapvmshareid) ? vmu->imapvmshareid : mailbox));
1993                 hdr->next = mail_newsearchheader("X-Asterisk-VM-Context", (char *) S_OR(context, "default"));
1994                 pgm->header = hdr;
1995                 if (fold != 1) {
1996                         pgm->unseen = 1;
1997                         pgm->seen = 0;
1998                 }
1999                 /* In the special case where fold is 1 (old messages) we have to do things a bit
2000                  * differently. Old messages are stored in the INBOX but are marked as "seen"
2001                  */
2002                 else {
2003                         pgm->unseen = 0;
2004                         pgm->seen = 1;
2005                 }
2006                 /* look for urgent messages */
2007                 if (urgent) {
2008                         pgm->flagged = 1;
2009                         pgm->unflagged = 0;
2010                 }
2011                 pgm->undeleted = 1;
2012                 pgm->deleted = 0;
2013
2014                 vms_p->vmArrayIndex = 0;
2015                 mail_search_full (vms_p->mailstream, NULL, pgm, NIL);
2016                 if (fold == 0 && urgent == 0)
2017                         vms_p->newmessages = vms_p->vmArrayIndex;
2018                 if (fold == 1)
2019                         vms_p->oldmessages = vms_p->vmArrayIndex;
2020                 if (fold == 0 && urgent == 1)
2021                         vms_p->urgentmessages = vms_p->vmArrayIndex;
2022                 /*Freeing the searchpgm also frees the searchhdr*/
2023                 mail_free_searchpgm(&pgm);
2024                 ast_mutex_unlock(&vms_p->lock);
2025                 vms_p->updated = 0;
2026                 return vms_p->vmArrayIndex;
2027         } else {
2028                 ast_mutex_lock(&vms_p->lock);
2029                 mail_ping(vms_p->mailstream);
2030                 ast_mutex_unlock(&vms_p->lock);
2031         }
2032         return 0;
2033 }
2034
2035 /*!
2036  * \brief Gets the number of messages that exist in a mailbox folder.
2037  * \param context
2038  * \param mailbox
2039  * \param folder
2040  * 
2041  * This method is used when IMAP backend is used.
2042  * \return The number of messages in this mailbox folder (zero or more).
2043  */
2044 static int messagecount(const char *context, const char *mailbox, const char *folder)
2045 {
2046         if (ast_strlen_zero(folder) || !strcmp(folder, "INBOX")) {
2047                 return __messagecount(context, mailbox, "INBOX") + __messagecount(context, mailbox, "Urgent");
2048         } else {
2049                 return __messagecount(context, mailbox, folder);
2050         }
2051 }
2052
2053 static int imap_store_file(const char *dir, const char *mailboxuser, const char *mailboxcontext, int msgnum, struct ast_channel *chan, struct ast_vm_user *vmu, char *fmt, int duration, struct vm_state *vms, const char *flag)
2054 {
2055         char *myserveremail = serveremail;
2056         char fn[PATH_MAX];
2057         char introfn[PATH_MAX];
2058         char mailbox[256];
2059         char *stringp;
2060         FILE *p = NULL;
2061         char tmp[80] = "/tmp/astmail-XXXXXX";
2062         long len;
2063         void *buf;
2064         int tempcopy = 0;
2065         STRING str;
2066         int ret; /* for better error checking */
2067         char *imap_flags = NIL;
2068
2069     /* Back out early if this is a greeting and we don't want to store greetings in IMAP */
2070     if (msgnum < 0 && !imapgreetings) {
2071         return 0;
2072     }
2073
2074         /* Set urgent flag for IMAP message */
2075         if (!ast_strlen_zero(flag) && !strcmp(flag, "Urgent")) {
2076                 ast_debug(3, "Setting message flag \\\\FLAGGED.\n");
2077                 imap_flags = "\\FLAGGED";
2078         }
2079         
2080         /* Attach only the first format */
2081         fmt = ast_strdupa(fmt);
2082         stringp = fmt;
2083         strsep(&stringp, "|");
2084
2085         if (!ast_strlen_zero(vmu->serveremail))
2086                 myserveremail = vmu->serveremail;
2087
2088         if (msgnum > -1)
2089                 make_file(fn, sizeof(fn), dir, msgnum);
2090         else
2091                 ast_copy_string (fn, dir, sizeof(fn));
2092
2093         snprintf(introfn, sizeof(introfn), "%sintro", fn);
2094         if (ast_fileexists(introfn, NULL, NULL) <= 0) {
2095                 *introfn = '\0';
2096         }
2097         
2098         if (ast_strlen_zero(vmu->email)) {
2099                 /* We need the vmu->email to be set when we call make_email_file, but
2100                  * if we keep it set, a duplicate e-mail will be created. So at the end
2101                  * of this function, we will revert back to an empty string if tempcopy
2102                  * is 1.
2103                  */
2104                 ast_copy_string(vmu->email, vmu->imapuser, sizeof(vmu->email));
2105                 tempcopy = 1;
2106         }
2107
2108         if (!strcmp(fmt, "wav49"))
2109                 fmt = "WAV";
2110         ast_debug(3, "Storing file '%s', format '%s'\n", fn, fmt);
2111
2112         /* Make a temporary file instead of piping directly to sendmail, in case the mail
2113            command hangs. */
2114         if (!(p = vm_mkftemp(tmp))) {
2115                 ast_log(AST_LOG_WARNING, "Unable to store '%s' (can't create temporary file)\n", fn);
2116                 if (tempcopy)
2117                         *(vmu->email) = '\0';
2118                 return -1;
2119         }
2120
2121         if (msgnum < 0 && imapgreetings) {
2122                 if ((ret = init_mailstream(vms, GREETINGS_FOLDER))) {
2123                         ast_log(AST_LOG_WARNING, "Unable to open mailstream.\n");
2124                         return -1;
2125                 }
2126                 imap_delete_old_greeting(fn, vms);
2127         }
2128
2129         make_email_file(p, myserveremail, vmu, msgnum, vmu->context, vmu->mailbox, "INBOX", S_OR(chan->cid.cid_num, NULL), S_OR(chan->cid.cid_name, NULL), fn, introfn, fmt, duration, 1, chan, NULL, 1, flag);
2130         /* read mail file to memory */
2131         len = ftell(p);
2132         rewind(p);
2133         if (!(buf = ast_malloc(len + 1))) {
2134                 ast_log(AST_LOG_ERROR, "Can't allocate %ld bytes to read message\n", len + 1);
2135                 fclose(p);
2136                 if (tempcopy)
2137                         *(vmu->email) = '\0';
2138                 return -1;
2139         }
2140         if (fread(buf, len, 1, p) < len) {
2141                 if (ferror(p)) {
2142                         ast_log(LOG_ERROR, "Short read while reading in mail file.\n");
2143                         return -1;
2144                 }
2145         }
2146         ((char *) buf)[len] = '\0';
2147         INIT(&str, mail_string, buf, len);
2148         ret = init_mailstream(vms, NEW_FOLDER);
2149         if (ret == 0) {
2150                 imap_mailbox_name(mailbox, sizeof(mailbox), vms, NEW_FOLDER, 1);
2151                 ast_mutex_lock(&vms->lock);
2152                 if(!mail_append_full(vms->mailstream, mailbox, imap_flags, NIL, &str))
2153                         ast_log(LOG_ERROR, "Error while sending the message to %s\n", mailbox);
2154                 ast_mutex_unlock(&vms->lock);
2155                 fclose(p);
2156                 unlink(tmp);
2157                 ast_free(buf);
2158         } else {
2159                 ast_log(LOG_ERROR, "Could not initialize mailstream for %s\n", mailbox);
2160                 fclose(p);
2161                 unlink(tmp);
2162                 ast_free(buf);
2163                 return -1;
2164         }
2165         ast_debug(3, "%s stored\n", fn);
2166         
2167         if (tempcopy)
2168                 *(vmu->email) = '\0';
2169         
2170         return 0;
2171
2172 }
2173
2174 /*!
2175  * \brief Gets the number of messages that exist in the inbox folder.
2176  * \param mailbox_context
2177  * \param newmsgs The variable that is updated with the count of new messages within this inbox.
2178  * \param oldmsgs The variable that is updated with the count of old messages within this inbox.
2179  * \param urgentmsgs The variable that is updated with the count of urgent messages within this inbox.
2180  * 
2181  * This method is used when IMAP backend is used.
2182  * Simultaneously determines the count of new,old, and urgent messages. The total messages would then be the sum of these three.
2183  *
2184  * \return zero on success, -1 on error.
2185  */
2186
2187 static int inboxcount2(const char *mailbox_context, int *urgentmsgs, int *newmsgs, int *oldmsgs)
2188 {
2189         char tmp[PATH_MAX] = "";
2190         char *mailboxnc;
2191         char *context;
2192         char *mb;
2193         char *cur;
2194         if (newmsgs)
2195                 *newmsgs = 0;
2196         if (oldmsgs)
2197                 *oldmsgs = 0;
2198         if (urgentmsgs)
2199                 *urgentmsgs = 0;
2200
2201         ast_debug(3, "Mailbox is set to %s\n", mailbox_context);
2202         /* If no mailbox, return immediately */
2203         if (ast_strlen_zero(mailbox_context))
2204                 return 0;
2205         
2206         ast_copy_string(tmp, mailbox_context, sizeof(tmp));
2207         context = strchr(tmp, '@');
2208         if (strchr(mailbox_context, ',')) {
2209                 int tmpnew, tmpold, tmpurgent;
2210                 ast_copy_string(tmp, mailbox_context, sizeof(tmp));
2211                 mb = tmp;
2212                 while ((cur = strsep(&mb, ", "))) {
2213                         if (!ast_strlen_zero(cur)) {
2214                                 if (inboxcount2(cur, urgentmsgs ? &tmpurgent : NULL, newmsgs ? &tmpnew : NULL, oldmsgs ? &tmpold : NULL))
2215                                         return -1;
2216                                 else {
2217                                         if (newmsgs)
2218                                                 *newmsgs += tmpnew; 
2219                                         if (oldmsgs)
2220                                                 *oldmsgs += tmpold;
2221                                         if (urgentmsgs)
2222                                                 *urgentmsgs += tmpurgent;
2223                                 }
2224                         }
2225                 }
2226                 return 0;
2227         }
2228         if (context) {
2229                 *context = '\0';
2230                 mailboxnc = tmp;
2231                 context++;
2232         } else {
2233                 context = "default";
2234                 mailboxnc = (char *) mailbox_context;
2235         }
2236
2237         if (newmsgs) {
2238                 struct ast_vm_user *vmu = find_user(NULL, context, mailboxnc);
2239                 if (!vmu) {
2240                         ast_log(AST_LOG_ERROR, "Couldn't find mailbox %s in context %s\n", mailboxnc, context);
2241                         return -1;
2242                 }
2243                 if ((*newmsgs = __messagecount(context, mailboxnc, vmu->imapfolder)) < 0) {
2244                         return -1;
2245                 }
2246         }
2247         if (oldmsgs) {
2248                 if ((*oldmsgs = __messagecount(context, mailboxnc, "Old")) < 0) {
2249                         return -1;
2250                 }
2251         }
2252         if (urgentmsgs) {
2253                 if ((*urgentmsgs = __messagecount(context, mailboxnc, "Urgent")) < 0) {
2254                         return -1;
2255                 }
2256         }
2257         return 0;
2258 }
2259
2260 /** 
2261  * \brief Determines if the given folder has messages.
2262  * \param mailbox The @ delimited string for user@context. If no context is found, uses 'default' for the context.
2263  * \param folder the folder to look in
2264  *
2265  * This function is used when the mailbox is stored in an IMAP back end.
2266  * This invokes the messagecount(). Here we are interested in the presence of messages (> 0) only, not the actual count.
2267  * \return 1 if the folder has one or more messages. zero otherwise.
2268  */
2269
2270 static int has_voicemail(const char *mailbox, const char *folder)
2271 {
2272         char tmp[256], *tmp2, *box, *context;
2273         ast_copy_string(tmp, mailbox, sizeof(tmp));
2274         tmp2 = tmp;
2275         if (strchr(tmp2, ',') || strchr(tmp2, '&')) {
2276                 while ((box = strsep(&tmp2, ",&"))) {
2277                         if (!ast_strlen_zero(box)) {
2278                                 if (has_voicemail(box, folder)) {
2279                                         return 1;
2280                                 }
2281                         }
2282                 }
2283         }
2284         if ((context = strchr(tmp, '@'))) {
2285                 *context++ = '\0';
2286         } else {
2287                 context = "default";
2288         }
2289         return __messagecount(context, tmp, folder) ? 1 : 0;
2290 }
2291
2292 /*!
2293  * \brief Copies a message from one mailbox to another.
2294  * \param chan
2295  * \param vmu
2296  * \param imbox
2297  * \param msgnum
2298  * \param duration
2299  * \param recip
2300  * \param fmt
2301  * \param dir
2302  *
2303  * This works with IMAP storage based mailboxes.
2304  *
2305  * \return zero on success, -1 on error.
2306  */
2307 static int copy_message(struct ast_channel *chan, struct ast_vm_user *vmu, int imbox, int msgnum, long duration, struct ast_vm_user *recip, char *fmt, char *dir, char *flag)
2308 {
2309         struct vm_state *sendvms = NULL, *destvms = NULL;
2310         char messagestring[10]; /*I guess this could be a problem if someone has more than 999999999 messages...*/
2311         if (msgnum >= recip->maxmsg) {
2312                 ast_log(LOG_WARNING, "Unable to copy mail, mailbox %s is full\n", recip->mailbox);
2313                 return -1;
2314         }
2315         if (!(sendvms = get_vm_state_by_imapuser(vmu->imapuser, 0))) {
2316                 ast_log(LOG_ERROR, "Couldn't get vm_state for originator's mailbox!!\n");
2317                 return -1;
2318         }
2319         if (!(destvms = get_vm_state_by_imapuser(recip->imapuser, 0))) {
2320                 ast_log(LOG_ERROR, "Couldn't get vm_state for destination mailbox!\n");
2321                 return -1;
2322         }
2323         snprintf(messagestring, sizeof(messagestring), "%ld", sendvms->msgArray[msgnum]);
2324         ast_mutex_lock(&sendvms->lock);
2325         if ((mail_copy(sendvms->mailstream, messagestring, (char *) mbox(vmu, imbox)) == T)) {
2326                 ast_mutex_unlock(&sendvms->lock);
2327                 return 0;
2328         }
2329         ast_mutex_unlock(&sendvms->lock);
2330         ast_log(LOG_WARNING, "Unable to copy message from mailbox %s to mailbox %s\n", vmu->mailbox, recip->mailbox);
2331         return -1;
2332 }
2333
2334 static void imap_mailbox_name(char *spec, size_t len, struct vm_state *vms, int box, int use_folder)
2335 {
2336         char tmp[256], *t = tmp;
2337         size_t left = sizeof(tmp);
2338         
2339         if (box == OLD_FOLDER) {
2340                 ast_copy_string(vms->curbox, mbox(NULL, NEW_FOLDER), sizeof(vms->curbox));
2341         } else {
2342                 ast_copy_string(vms->curbox, mbox(NULL, box), sizeof(vms->curbox));
2343         }
2344
2345         if (box == NEW_FOLDER) {
2346                 ast_copy_string(vms->vmbox, "vm-INBOX", sizeof(vms->vmbox));
2347         } else {
2348                 snprintf(vms->vmbox, sizeof(vms->vmbox), "vm-%s", mbox(NULL, box));
2349         }
2350
2351         /* Build up server information */
2352         ast_build_string(&t, &left, "{%s:%s/imap", imapserver, imapport);
2353
2354         /* Add authentication user if present */
2355         if (!ast_strlen_zero(authuser))
2356                 ast_build_string(&t, &left, "/authuser=%s", authuser);
2357
2358         /* Add flags if present */
2359         if (!ast_strlen_zero(imapflags))
2360                 ast_build_string(&t, &left, "/%s", imapflags);
2361
2362         /* End with username */
2363 #if 1
2364         ast_build_string(&t, &left, "/user=%s}", vms->imapuser);
2365 #else
2366         ast_build_string(&t, &left, "/user=%s/novalidate-cert}", vms->imapuser);
2367 #endif
2368         if (box == NEW_FOLDER || box == OLD_FOLDER)
2369                 snprintf(spec, len, "%s%s", tmp, use_folder? vms->imapfolder: "INBOX");
2370         else if (box == GREETINGS_FOLDER)
2371                 snprintf(spec, len, "%s%s", tmp, greetingfolder);
2372         else {  /* Other folders such as Friends, Family, etc... */
2373                 if (!ast_strlen_zero(imapparentfolder)) {
2374                         /* imapparentfolder would typically be set to INBOX */
2375                         snprintf(spec, len, "%s%s%c%s", tmp, imapparentfolder, delimiter, mbox(NULL, box));
2376                 } else {
2377                         snprintf(spec, len, "%s%s", tmp, mbox(NULL, box));
2378                 }
2379         }
2380 }
2381
2382 static int init_mailstream(struct vm_state *vms, int box)
2383 {
2384         MAILSTREAM *stream = NIL;
2385         long debug;
2386         char tmp[256];
2387         
2388         if (!vms) {
2389                 ast_log(LOG_ERROR, "vm_state is NULL!\n");
2390                 return -1;
2391         }
2392         if (option_debug > 2)
2393                 ast_log(LOG_DEBUG, "vm_state user is:%s\n", vms->imapuser);
2394         if (vms->mailstream == NIL || !vms->mailstream) {
2395                 if (option_debug)
2396                         ast_log(LOG_DEBUG, "mailstream not set.\n");
2397         } else {
2398                 stream = vms->mailstream;
2399         }
2400         /* debug = T;  user wants protocol telemetry? */
2401         debug = NIL;  /* NO protocol telemetry? */
2402
2403         if (delimiter == '\0') {                /* did not probe the server yet */
2404                 char *cp;
2405 #ifdef USE_SYSTEM_IMAP
2406 #include <imap/linkage.c>
2407 #elif defined(USE_SYSTEM_CCLIENT)
2408 #include <c-client/linkage.c>
2409 #else
2410 #include "linkage.c"
2411 #endif
2412                 /* Connect to INBOX first to get folders delimiter */
2413                 imap_mailbox_name(tmp, sizeof(tmp), vms, 0, 1);
2414                 ast_mutex_lock(&vms->lock);
2415                 stream = mail_open (stream, tmp, debug ? OP_DEBUG : NIL);
2416                 ast_mutex_unlock(&vms->lock);
2417                 if (stream == NIL) {
2418                         ast_log(LOG_ERROR, "Can't connect to imap server %s\n", tmp);
2419                         return -1;
2420                 }
2421                 get_mailbox_delimiter(stream);
2422                 /* update delimiter in imapfolder */
2423                 for (cp = vms->imapfolder; *cp; cp++)
2424                         if (*cp == '/')
2425                                 *cp = delimiter;
2426         }
2427         /* Now connect to the target folder */
2428         imap_mailbox_name(tmp, sizeof(tmp), vms, box, 1);
2429         if (option_debug > 2)
2430                 ast_log(LOG_DEBUG, "Before mail_open, server: %s, box:%d\n", tmp, box);
2431         ast_mutex_lock(&vms->lock);
2432         vms->mailstream = mail_open (stream, tmp, debug ? OP_DEBUG : NIL);
2433         ast_mutex_unlock(&vms->lock);
2434         if (vms->mailstream == NIL) {
2435                 return -1;
2436         } else {
2437                 return 0;
2438         }
2439 }
2440
2441 static int open_mailbox(struct vm_state *vms, struct ast_vm_user *vmu, int box)
2442 {
2443         SEARCHPGM *pgm;
2444         SEARCHHEADER *hdr;
2445         int ret, urgent = 0;
2446
2447         /* If Urgent, then look at INBOX */
2448         if (box == 11) {
2449                 box = NEW_FOLDER;
2450                 urgent = 1;
2451         }
2452
2453         ast_copy_string(vms->imapuser, vmu->imapuser, sizeof(vms->imapuser));
2454         ast_copy_string(vms->imapfolder, vmu->imapfolder, sizeof(vms->imapfolder));
2455         vms->imapversion = vmu->imapversion;
2456         ast_debug(3, "Before init_mailstream, user is %s\n", vmu->imapuser);
2457
2458         if ((ret = init_mailstream(vms, box)) || !vms->mailstream) {
2459                 ast_log(AST_LOG_ERROR, "Could not initialize mailstream\n");
2460                 return -1;
2461         }
2462         
2463         create_dirpath(vms->curdir, sizeof(vms->curdir), vmu->context, vms->username, vms->curbox);
2464         
2465         /* Check Quota */
2466         if  (box == 0)  {
2467                 ast_debug(3, "Mailbox name set to: %s, about to check quotas\n", mbox(vmu, box));
2468                 check_quota(vms, (char *) mbox(vmu, box));
2469         }
2470
2471         ast_mutex_lock(&vms->lock);
2472         pgm = mail_newsearchpgm();
2473
2474         /* Check IMAP folder for Asterisk messages only... */
2475         hdr = mail_newsearchheader("X-Asterisk-VM-Extension", (!ast_strlen_zero(vmu->imapvmshareid) ? vmu->imapvmshareid : vmu->mailbox));
2476         hdr->next = mail_newsearchheader("X-Asterisk-VM-Context", vmu->context);
2477         pgm->header = hdr;
2478         pgm->deleted = 0;
2479         pgm->undeleted = 1;
2480
2481         /* if box = NEW_FOLDER, check for new, if box = OLD_FOLDER, check for read */
2482         if (box == NEW_FOLDER && urgent == 1) {
2483                 pgm->unseen = 1;
2484                 pgm->seen = 0;
2485                 pgm->flagged = 1;
2486                 pgm->unflagged = 0;
2487         } else if (box == NEW_FOLDER && urgent == 0) {
2488                 pgm->unseen = 1;
2489                 pgm->seen = 0;
2490                 pgm->flagged = 0;
2491                 pgm->unflagged = 1;
2492         } else if (box == OLD_FOLDER) {
2493                 pgm->seen = 1;
2494                 pgm->unseen = 0;
2495         }
2496
2497         ast_debug(3, "Before mail_search_full, user is %s\n", vmu->imapuser);
2498
2499         vms->vmArrayIndex = 0;
2500         mail_search_full (vms->mailstream, NULL, pgm, NIL);
2501         vms->lastmsg = vms->vmArrayIndex - 1;
2502         mail_free_searchpgm(&pgm);
2503
2504         ast_mutex_unlock(&vms->lock);
2505         return 0;
2506 }
2507
2508 static void write_file(char *filename, char *buffer, unsigned long len)
2509 {
2510         FILE *output;
2511
2512         output = fopen (filename, "w");
2513         if (fwrite(buffer, len, 1, output) != 1) {
2514                 if (ferror(output)) {
2515                         ast_log(LOG_ERROR, "Short write while writing e-mail body: %s.\n", strerror(errno));
2516                 }
2517         }
2518         fclose (output);
2519 }
2520
2521 static void update_messages_by_imapuser(const char *user, unsigned long number)
2522 {
2523         struct vm_state *vms = get_vm_state_by_imapuser(user, 1);
2524
2525         if (!vms && !(vms = get_vm_state_by_imapuser(user, 0))) {
2526                 return;
2527         }
2528
2529         ast_debug(3, "saving mailbox message number %lu as message %d. Interactive set to %d\n", number, vms->vmArrayIndex, vms->interactive);
2530         vms->msgArray[vms->vmArrayIndex++] = number;
2531 }
2532
2533 void mm_searched(MAILSTREAM *stream, unsigned long number)
2534 {
2535         char *mailbox = stream->mailbox, buf[1024] = "", *user;
2536
2537         if (!(user = get_user_by_mailbox(mailbox, buf, sizeof(buf))))
2538                 return;
2539
2540         update_messages_by_imapuser(user, number);
2541 }
2542
2543 static struct ast_vm_user *find_user_realtime_imapuser(const char *imapuser)
2544 {
2545         struct ast_variable *var;
2546         struct ast_vm_user *vmu;
2547
2548         vmu = ast_calloc(1, sizeof *vmu);
2549         if (!vmu)
2550                 return NULL;
2551         ast_set_flag(vmu, VM_ALLOCED);
2552         populate_defaults(vmu);
2553
2554         var = ast_load_realtime("voicemail", "imapuser", imapuser, NULL);
2555         if (var) {
2556                 apply_options_full(vmu, var);
2557                 ast_variables_destroy(var);
2558                 return vmu;
2559         } else {
2560                 ast_free(vmu);
2561                 return NULL;
2562         }
2563 }
2564
2565 /* Interfaces to C-client */
2566
2567 void mm_exists(MAILSTREAM * stream, unsigned long number)
2568 {
2569         /* mail_ping will callback here if new mail! */
2570         ast_debug(4, "Entering EXISTS callback for message %ld\n", number);
2571         if (number == 0) return;
2572         set_update(stream);
2573 }
2574
2575
2576 void mm_expunged(MAILSTREAM * stream, unsigned long number)
2577 {
2578         /* mail_ping will callback here if expunged mail! */
2579         ast_debug(4, "Entering EXPUNGE callback for message %ld\n", number);
2580         if (number == 0) return;
2581         set_update(stream);
2582 }
2583
2584
2585 void mm_flags(MAILSTREAM * stream, unsigned long number)
2586 {
2587         /* mail_ping will callback here if read mail! */
2588         ast_debug(4, "Entering FLAGS callback for message %ld\n", number);
2589         if (number == 0) return;
2590         set_update(stream);
2591 }
2592
2593
2594 void mm_notify(MAILSTREAM * stream, char *string, long errflg)
2595 {
2596         ast_debug(5, "Entering NOTIFY callback, errflag is %ld, string is %s\n", errflg, string);
2597         mm_log (string, errflg);
2598 }
2599
2600
2601 void mm_list(MAILSTREAM * stream, int delim, char *mailbox, long attributes)
2602 {
2603         if (delimiter == '\0') {
2604                 delimiter = delim;
2605         }
2606
2607         ast_debug(5, "Delimiter set to %c and mailbox %s\n", delim, mailbox);
2608         if (attributes & LATT_NOINFERIORS)
2609                 ast_debug(5, "no inferiors\n");
2610         if (attributes & LATT_NOSELECT)
2611                 ast_debug(5, "no select\n");
2612         if (attributes & LATT_MARKED)
2613                 ast_debug(5, "marked\n");
2614         if (attributes & LATT_UNMARKED)
2615                 ast_debug(5, "unmarked\n");
2616 }
2617
2618
2619 void mm_lsub(MAILSTREAM * stream, int delim, char *mailbox, long attributes)
2620 {
2621         ast_debug(5, "Delimiter set to %c and mailbox %s\n", delim, mailbox);
2622         if (attributes & LATT_NOINFERIORS)
2623                 ast_debug(5, "no inferiors\n");
2624         if (attributes & LATT_NOSELECT)
2625                 ast_debug(5, "no select\n");
2626         if (attributes & LATT_MARKED)
2627                 ast_debug(5, "marked\n");
2628         if (attributes & LATT_UNMARKED)
2629                 ast_debug(5, "unmarked\n");
2630 }
2631
2632
2633 void mm_status(MAILSTREAM * stream, char *mailbox, MAILSTATUS * status)
2634 {
2635         ast_log(AST_LOG_NOTICE, " Mailbox %s", mailbox);
2636         if (status->flags & SA_MESSAGES)
2637                 ast_log(AST_LOG_NOTICE, ", %lu messages", status->messages);
2638         if (status->flags & SA_RECENT)
2639                 ast_log(AST_LOG_NOTICE, ", %lu recent", status->recent);
2640         if (status->flags & SA_UNSEEN)
2641                 ast_log(AST_LOG_NOTICE, ", %lu unseen", status->unseen);
2642         if (status->flags & SA_UIDVALIDITY)
2643                 ast_log(AST_LOG_NOTICE, ", %lu UID validity", status->uidvalidity);
2644         if (status->flags & SA_UIDNEXT)
2645                 ast_log(AST_LOG_NOTICE, ", %lu next UID", status->uidnext);
2646         ast_log(AST_LOG_NOTICE, "\n");
2647 }
2648
2649
2650 void mm_log(char *string, long errflg)
2651 {
2652         switch ((short) errflg) {
2653                 case NIL:
2654                         ast_debug(1, "IMAP Info: %s\n", string);
2655                         break;
2656                 case PARSE:
2657                 case WARN:
2658                         ast_log(AST_LOG_WARNING, "IMAP Warning: %s\n", string);
2659                         break;
2660                 case ERROR:
2661                         ast_log(AST_LOG_ERROR, "IMAP Error: %s\n", string);
2662                         break;
2663         }
2664 }
2665
2666
2667 void mm_dlog(char *string)
2668 {
2669         ast_log(AST_LOG_NOTICE, "%s\n", string);
2670 }
2671
2672
2673 void mm_login(NETMBX * mb, char *user, char *pwd, long trial)
2674 {
2675         struct ast_vm_user *vmu;
2676
2677         ast_debug(4, "Entering callback mm_login\n");
2678
2679         ast_copy_string(user, mb->user, MAILTMPLEN);
2680
2681         /* We should only do this when necessary */
2682         if (!ast_strlen_zero(authpassword)) {
2683                 ast_copy_string(pwd, authpassword, MAILTMPLEN);
2684         } else {
2685                 AST_LIST_TRAVERSE(&users, vmu, list) {
2686                         if (!strcasecmp(mb->user, vmu->imapuser)) {
2687                                 ast_copy_string(pwd, vmu->imappassword, MAILTMPLEN);
2688                                 break;
2689                         }
2690                 }
2691                 if (!vmu) {
2692                         if ((vmu = find_user_realtime_imapuser(mb->user))) {
2693                                 ast_copy_string(pwd, vmu->imappassword, MAILTMPLEN);
2694                                 free_user(vmu);
2695                         }
2696                 }
2697         }
2698 }
2699
2700
2701 void mm_critical(MAILSTREAM * stream)
2702 {
2703 }
2704
2705
2706 void mm_nocritical(MAILSTREAM * stream)
2707 {
2708 }
2709
2710
2711 long mm_diskerror(MAILSTREAM * stream, long errcode, long serious)
2712 {
2713         kill (getpid (), SIGSTOP);
2714         return NIL;
2715 }
2716
2717
2718 void mm_fatal(char *string)
2719 {
2720         ast_log(AST_LOG_ERROR, "IMAP access FATAL error: %s\n", string);
2721 }
2722
2723 /* C-client callback to handle quota */
2724 static void mm_parsequota(MAILSTREAM *stream, unsigned char *msg, QUOTALIST *pquota)
2725 {
2726         struct vm_state *vms;
2727         char *mailbox = stream->mailbox, *user;
2728         char buf[1024] = "";
2729         unsigned long usage = 0, limit = 0;
2730         
2731         while (pquota) {
2732                 usage = pquota->usage;
2733                 limit = pquota->limit;
2734                 pquota = pquota->next;
2735         }
2736         
2737         if (!(user = get_user_by_mailbox(mailbox, buf, sizeof(buf))) || (!(vms = get_vm_state_by_imapuser(user, 2)) && !(vms = get_vm_state_by_imapuser(user, 0)))) {
2738                 ast_log(AST_LOG_ERROR, "No state found.\n");
2739                 return;
2740         }
2741
2742         ast_debug(3, "User %s usage is %lu, limit is %lu\n", user, usage, limit);
2743
2744         vms->quota_usage = usage;
2745         vms->quota_limit = limit;
2746 }
2747
2748 static char *get_header_by_tag(char *header, char *tag, char *buf, size_t len)
2749 {
2750         char *start, *eol_pnt;
2751         int taglen;
2752
2753         if (ast_strlen_zero(header) || ast_strlen_zero(tag))
2754                 return NULL;
2755
2756         taglen = strlen(tag) + 1;
2757         if (taglen < 1)
2758                 return NULL;
2759
2760         if (!(start = strstr(header, tag)))
2761                 return NULL;
2762
2763         /* Since we can be called multiple times we should clear our buffer */
2764         memset(buf, 0, len);
2765
2766         ast_copy_string(buf, start+taglen, len);
2767         if ((eol_pnt = strchr(buf,'\r')) || (eol_pnt = strchr(buf,'\n')))
2768                 *eol_pnt = '\0';
2769         return buf;
2770 }
2771
2772 static char *get_user_by_mailbox(char *mailbox, char *buf, size_t len)
2773 {
2774         char *start, *quote, *eol_pnt;
2775
2776         if (ast_strlen_zero(mailbox))
2777                 return NULL;
2778
2779         if (!(start = strstr(mailbox, "/user=")))
2780                 return NULL;
2781
2782         ast_copy_string(buf, start+6, len);
2783
2784         if (!(quote = strchr(buf, '\"'))) {
2785                 if (!(eol_pnt = strchr(buf, '/')))
2786                         eol_pnt = strchr(buf,'}');
2787                 *eol_pnt = '\0';
2788                 return buf;
2789         } else {
2790                 eol_pnt = strchr(buf+1,'\"');
2791                 *eol_pnt = '\0';
2792                 return buf+1;
2793         }
2794 }
2795
2796 static struct vm_state *create_vm_state_from_user(struct ast_vm_user *vmu)
2797 {
2798         struct vm_state *vms_p;
2799
2800         pthread_once(&ts_vmstate.once, ts_vmstate.key_init);
2801         if ((vms_p = pthread_getspecific(ts_vmstate.key)) && !strcmp(vms_p->imapuser, vmu->imapuser) && !strcmp(vms_p->username, vmu->mailbox)) {
2802                 return vms_p;
2803         }
2804         if (option_debug > 4)
2805                 ast_log(AST_LOG_DEBUG, "Adding new vmstate for %s\n", vmu->imapuser);
2806         if (!(vms_p = ast_calloc(1, sizeof(*vms_p))))
2807                 return NULL;
2808         ast_copy_string(vms_p->imapuser, vmu->imapuser, sizeof(vms_p->imapuser));
2809         ast_copy_string(vms_p->imapfolder, vmu->imapfolder, sizeof(vms_p->imapfolder));
2810         ast_copy_string(vms_p->username, vmu->mailbox, sizeof(vms_p->username)); /* save for access from interactive entry point */
2811         ast_copy_string(vms_p->context, vmu->context, sizeof(vms_p->context));
2812         vms_p->mailstream = NIL; /* save for access from interactive entry point */
2813         vms_p->imapversion = vmu->imapversion;
2814         if (option_debug > 4)
2815                 ast_log(AST_LOG_DEBUG, "Copied %s to %s\n", vmu->imapuser, vms_p->imapuser);
2816         vms_p->updated = 1;
2817         /* set mailbox to INBOX! */
2818         ast_copy_string(vms_p->curbox, mbox(vmu, 0), sizeof(vms_p->curbox));
2819         init_vm_state(vms_p);
2820         vmstate_insert(vms_p);
2821         return vms_p;
2822 }
2823
2824 static struct vm_state *get_vm_state_by_imapuser(const char *user, int interactive)
2825 {
2826         struct vmstate *vlist = NULL;
2827
2828         if (interactive) {
2829                 struct vm_state *vms;
2830                 pthread_once(&ts_vmstate.once, ts_vmstate.key_init);
2831                 vms = pthread_getspecific(ts_vmstate.key);
2832                 return vms;
2833         }
2834
2835         AST_LIST_LOCK(&vmstates);
2836         AST_LIST_TRAVERSE(&vmstates, vlist, list) {
2837                 if (!vlist->vms) {
2838                         ast_debug(3, "error: vms is NULL for %s\n", user);
2839                         continue;
2840                 }
2841                 if (vlist->vms->imapversion != imapversion) {
2842                         continue;
2843                 }
2844                 if (!vlist->vms->imapuser) {
2845                         ast_debug(3, "error: imapuser is NULL for %s\n", user);
2846                         continue;
2847                 }
2848
2849                 if (!strcmp(vlist->vms->imapuser, user) && (interactive == 2 || vlist->vms->interactive == interactive)) {
2850                         AST_LIST_UNLOCK(&vmstates);
2851                         return vlist->vms;
2852                 }
2853         }
2854         AST_LIST_UNLOCK(&vmstates);
2855
2856         ast_debug(3, "%s not found in vmstates\n", user);
2857
2858         return NULL;
2859 }
2860
2861 static struct vm_state *get_vm_state_by_mailbox(const char *mailbox, const char *context, int interactive)
2862 {
2863
2864         struct vmstate *vlist = NULL;
2865         const char *local_context = S_OR(context, "default");
2866
2867         if (interactive) {
2868                 struct vm_state *vms;
2869                 pthread_once(&ts_vmstate.once, ts_vmstate.key_init);
2870                 vms = pthread_getspecific(ts_vmstate.key);
2871                 return vms;
2872         }
2873
2874         AST_LIST_LOCK(&vmstates);
2875         AST_LIST_TRAVERSE(&vmstates, vlist, list) {
2876                 if (!vlist->vms) {
2877                         ast_debug(3, "error: vms is NULL for %s\n", mailbox);
2878                         continue;
2879                 }
2880                 if (vlist->vms->imapversion != imapversion) {
2881                         continue;
2882                 }
2883                 if (!vlist->vms->username || !vlist->vms->context) {
2884                         ast_debug(3, "error: username is NULL for %s\n", mailbox);
2885                         continue;
2886                 }
2887
2888                 ast_debug(3, "comparing mailbox %s@%s (i=%d) to vmstate mailbox %s@%s (i=%d)\n", mailbox, local_context, interactive, vlist->vms->username, vlist->vms->context, vlist->vms->interactive);
2889                 
2890                 if (!strcmp(vlist->vms->username, mailbox) && !strcmp(vlist->vms->context, local_context) && vlist->vms->interactive == interactive) {
2891                         ast_debug(3, "Found it!\n");
2892                         AST_LIST_UNLOCK(&vmstates);
2893                         return vlist->vms;
2894                 }
2895         }
2896         AST_LIST_UNLOCK(&vmstates);
2897
2898         ast_debug(3, "%s not found in vmstates\n", mailbox);
2899
2900         return NULL;
2901 }
2902
2903 static void vmstate_insert(struct vm_state *vms) 
2904 {
2905         struct vmstate *v;
2906         struct vm_state *altvms;
2907
2908         /* If interactive, it probably already exists, and we should
2909            use the one we already have since it is more up to date.
2910            We can compare the username to find the duplicate */
2911         if (vms->interactive == 1) {
2912                 altvms = get_vm_state_by_mailbox(vms->username, vms->context, 0);
2913                 if (altvms) {   
2914                         ast_debug(3, "Duplicate mailbox %s, copying message info...\n", vms->username);
2915                         vms->newmessages = altvms->newmessages;
2916                         vms->oldmessages = altvms->oldmessages;
2917                         vms->vmArrayIndex = altvms->vmArrayIndex;
2918                         vms->lastmsg = altvms->lastmsg;
2919                         vms->curmsg = altvms->curmsg;
2920                         /* get a pointer to the persistent store */
2921                         vms->persist_vms = altvms;
2922                         /* Reuse the mailstream? */
2923 #ifdef REALLY_FAST_EVEN_IF_IT_MEANS_RESOURCE_LEAKS
2924                         vms->mailstream = altvms->mailstream;
2925 #else
2926                         vms->mailstream = NIL;
2927 #endif
2928                 }
2929                 return;
2930         }
2931
2932         if (!(v = ast_calloc(1, sizeof(*v))))
2933                 return;
2934         
2935         v->vms = vms;
2936
2937         ast_debug(3, "Inserting vm_state for user:%s, mailbox %s\n", vms->imapuser, vms->username);
2938
2939         AST_LIST_LOCK(&vmstates);
2940         AST_LIST_INSERT_TAIL(&vmstates, v, list);
2941         AST_LIST_UNLOCK(&vmstates);
2942 }
2943
2944 static void vmstate_delete(struct vm_state *vms) 
2945 {
2946         struct vmstate *vc = NULL;
2947         struct vm_state *altvms = NULL;
2948
2949         /* If interactive, we should copy pertinent info
2950            back to the persistent state (to make update immediate) */
2951         if (vms->interactive == 1 && (altvms = vms->persist_vms)) {
2952                 ast_debug(3, "Duplicate mailbox %s, copying message info...\n", vms->username);
2953                 altvms->newmessages = vms->newmessages;
2954                 altvms->oldmessages = vms->oldmessages;
2955                 altvms->updated = 1;
2956                 vms->mailstream = mail_close(vms->mailstream);
2957
2958                 /* Interactive states are not stored within the persistent list */
2959                 return;
2960         }
2961         
2962         ast_debug(3, "Removing vm_state for user:%s, mailbox %s\n", vms->imapuser, vms->username);
2963         
2964         AST_LIST_LOCK(&vmstates);
2965         AST_LIST_TRAVERSE_SAFE_BEGIN(&vmstates, vc, list) {
2966                 if (vc->vms == vms) {
2967                         AST_LIST_REMOVE_CURRENT(list);
2968                         break;
2969                 }
2970         }
2971         AST_LIST_TRAVERSE_SAFE_END
2972         AST_LIST_UNLOCK(&vmstates);
2973         
2974         if (vc) {
2975                 ast_mutex_destroy(&vc->vms->lock);
2976                 ast_free(vc);
2977         }
2978         else
2979                 ast_log(AST_LOG_ERROR, "No vmstate found for user:%s, mailbox %s\n", vms->imapuser, vms->username);
2980 }
2981
2982 static void set_update(MAILSTREAM * stream) 
2983 {
2984         struct vm_state *vms;
2985         char *mailbox = stream->mailbox, *user;
2986         char buf[1024] = "";
2987
2988         if (!(user = get_user_by_mailbox(mailbox, buf, sizeof(buf))) || !(vms = get_vm_state_by_imapuser(user, 0))) {
2989                 if (user && option_debug > 2)
2990                         ast_log(AST_LOG_WARNING, "User %s mailbox not found for update.\n", user);
2991                 return;
2992         }
2993
2994         ast_debug(3, "User %s mailbox set for update.\n", user);
2995
2996         vms->updated = 1; /* Set updated flag since mailbox changed */
2997 }
2998
2999 static void init_vm_state(struct vm_state *vms) 
3000 {
3001         int x;
3002         vms->vmArrayIndex = 0;
3003         for (x = 0; x < VMSTATE_MAX_MSG_ARRAY; x++) {
3004                 vms->msgArray[x] = 0;
3005         }
3006         ast_mutex_init(&vms->lock);
3007 }
3008
3009 static int save_body(BODY *body, struct vm_state *vms, char *section, char *format, int is_intro) 
3010 {
3011         char *body_content;
3012         char *body_decoded;
3013         char *fn = is_intro ? vms->introfn : vms->fn;
3014         unsigned long len;
3015         unsigned long newlen;
3016         char filename[256];
3017         
3018         if (!body || body == NIL)
3019                 return -1;
3020
3021         ast_mutex_lock(&vms->lock);
3022         body_content = mail_fetchbody(vms->mailstream, vms->msgArray[vms->curmsg], section, &len);
3023         ast_mutex_unlock(&vms->lock);
3024         if (body_content != NIL) {
3025                 snprintf(filename, sizeof(filename), "%s.%s", fn, format);
3026                 /* ast_debug(1,body_content); */
3027                 body_decoded = rfc822_base64((unsigned char *) body_content, len, &newlen);
3028                 /* If the body of the file is empty, return an error */
3029                 if (!newlen) {
3030                         return -1;
3031                 }
3032                 write_file(filename, (char *) body_decoded, newlen);
3033         } else {
3034                 ast_debug(5, "Body of message is NULL.\n");
3035                 return -1;
3036         }
3037         return 0;
3038 }
3039
3040 /*! 
3041  * \brief Get delimiter via mm_list callback 
3042  * \param stream
3043  *
3044  * Determines the delimiter character that is used by the underlying IMAP based mail store.
3045  */
3046 /* MUTEX should already be held */
3047 static void get_mailbox_delimiter(MAILSTREAM *stream) {
3048         char tmp[50];
3049         snprintf(tmp, sizeof(tmp), "{%s}", imapserver);
3050         mail_list(stream, tmp, "*");
3051 }
3052
3053 /*! 
3054  * \brief Check Quota for user 
3055  * \param vms a pointer to a vm_state struct, will use the mailstream property of this.
3056  * \param mailbox the mailbox to check the quota for.
3057  *
3058  * Calls imap_getquotaroot, which will populate its results into the vm_state vms input structure.
3059  */
3060 static void check_quota(struct vm_state *vms, char *mailbox) {
3061         ast_mutex_lock(&vms->lock);
3062         mail_parameters(NULL, SET_QUOTA, (void *) mm_parsequota);
3063         ast_debug(3, "Mailbox name set to: %s, about to check quotas\n", mailbox);
3064         if (vms && vms->mailstream != NULL) {
3065                 imap_getquotaroot(vms->mailstream, mailbox);
3066         } else {
3067                 ast_log(AST_LOG_WARNING, "Mailstream not available for mailbox: %s\n", mailbox);
3068         }
3069         ast_mutex_unlock(&vms->lock);
3070 }
3071
3072 #endif /* IMAP_STORAGE */
3073
3074 /*! \brief Lock file path
3075     only return failure if ast_lock_path returns 'timeout',
3076    not if the path does not exist or any other reason
3077 */
3078 static int vm_lock_path(const char *path)
3079 {
3080         switch (ast_lock_path(path)) {
3081         case AST_LOCK_TIMEOUT:
3082                 return -1;
3083         default:
3084                 return 0;
3085         }
3086 }
3087
3088
3089 #ifdef ODBC_STORAGE
3090 struct generic_prepare_struct {
3091         char *sql;
3092         int argc;
3093         char **argv;
3094 };
3095
3096 static SQLHSTMT generic_prepare(struct odbc_obj *obj, void *data)
3097 {
3098         struct generic_prepare_struct *gps = data;
3099         int res, i;
3100         SQLHSTMT stmt;
3101
3102         res = SQLAllocHandle(SQL_HANDLE_STMT, obj->con, &stmt);
3103         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
3104                 ast_log(AST_LOG_WARNING, "SQL Alloc Handle failed!\n");
3105                 return NULL;
3106         }
3107         res = SQLPrepare(stmt, (unsigned char *) gps->sql, SQL_NTS);
3108         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
3109                 ast_log(AST_LOG_WARNING, "SQL Prepare failed![%s]\n", gps->sql);
3110                 SQLFreeHandle(SQL_HANDLE_STMT, stmt);
3111                 return NULL;
3112         }
3113         for (i = 0; i < gps->argc; i++)
3114                 SQLBindParameter(stmt, i + 1, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, strlen(gps->argv[i]), 0, gps->argv[i], 0, NULL);
3115
3116         return stmt;
3117 }
3118
3119 /*!
3120  * \brief Retrieves a file from an ODBC data store.
3121  * \param dir the path to the file to be retreived.
3122  * \param msgnum the message number, such as within a mailbox folder.
3123  * 
3124  * This method is used by the RETRIEVE macro when mailboxes are stored in an ODBC back end.
3125  * The purpose is to get the message from the database store to the local file system, so that the message may be played, or the information file may be read.
3126  *
3127  * The file is looked up by invoking a SQL on the odbc_table (default 'voicemessages') using the dir and msgnum input parameters.
3128  * The output is the message information file with the name msgnum and the extension .txt
3129  * and the message file with the extension of its format, in the directory with base file name of the msgnum.
3130  * 
3131  * \return 0 on success, -1 on error.
3132  */
3133 static int retrieve_file(char *dir, int msgnum)
3134 {
3135         int x = 0;
3136         int res;
3137         int fd = -1;
3138         size_t fdlen = 0;
3139         void *fdm = MAP_FAILED;
3140         SQLSMALLINT colcount = 0;
3141         SQLHSTMT stmt;
3142         char sql[PATH_MAX];
3143         char fmt[80]="";
3144         char *c;
3145         char coltitle[256];
3146         SQLSMALL