-
Notifications
You must be signed in to change notification settings - Fork 0
/
pbx.c
6560 lines (5848 loc) · 176 KB
/
pbx.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 1999 - 2005, Digium, Inc.
*
* Mark Spencer <markster@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*! \file
*
* \brief Core PBX routines.
*
*/
#include <sys/types.h>
#include <string.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
#include <ctype.h>
#include <errno.h>
#include <time.h>
#include <sys/time.h>
#include "asterisk.h"
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/lock.h"
#include "asterisk/cli.h"
#include "asterisk/pbx.h"
#include "asterisk/channel.h"
#include "asterisk/options.h"
#include "asterisk/logger.h"
#include "asterisk/file.h"
#include "asterisk/callerid.h"
#include "asterisk/cdr.h"
#include "asterisk/config.h"
#include "asterisk/term.h"
#include "asterisk/manager.h"
#include "asterisk/ast_expr.h"
#include "asterisk/linkedlists.h"
#include "asterisk/say.h"
#include "asterisk/utils.h"
#include "asterisk/causes.h"
#include "asterisk/musiconhold.h"
#include "asterisk/app.h"
#include "asterisk/devicestate.h"
#include "asterisk/compat.h"
/*!
* \note I M P O R T A N T :
*
* The speed of extension handling will likely be among the most important
* aspects of this PBX. The switching scheme as it exists right now isn't
* terribly bad (it's O(N+M), where N is the # of extensions and M is the avg #
* of priorities, but a constant search time here would be great ;-)
*
*/
#ifdef LOW_MEMORY
#define EXT_DATA_SIZE 256
#else
#define EXT_DATA_SIZE 8192
#endif
#define SWITCH_DATA_LENGTH 256
#define VAR_BUF_SIZE 4096
#define VAR_NORMAL 1
#define VAR_SOFTTRAN 2
#define VAR_HARDTRAN 3
#define BACKGROUND_SKIP (1 << 0)
#define BACKGROUND_NOANSWER (1 << 1)
#define BACKGROUND_MATCHEXTEN (1 << 2)
#define BACKGROUND_PLAYBACK (1 << 3)
AST_APP_OPTIONS(background_opts, {
AST_APP_OPTION('s', BACKGROUND_SKIP),
AST_APP_OPTION('n', BACKGROUND_NOANSWER),
AST_APP_OPTION('m', BACKGROUND_MATCHEXTEN),
AST_APP_OPTION('p', BACKGROUND_PLAYBACK),
});
#define WAITEXTEN_MOH (1 << 0)
AST_APP_OPTIONS(waitexten_opts, {
AST_APP_OPTION_ARG('m', WAITEXTEN_MOH, 1),
});
struct ast_context;
/*!\brief ast_exten: An extension
The dialplan is saved as a linked list with each context
having it's own linked list of extensions - one item per
priority.
*/
struct ast_exten {
char *exten; /* Extension name */
int matchcid; /* Match caller id ? */
char *cidmatch; /* Caller id to match for this extension */
int priority; /* Priority */
char *label; /* Label */
struct ast_context *parent; /* The context this extension belongs to */
char *app; /* Application to execute */
void *data; /* Data to use (arguments) */
void (*datad)(void *); /* Data destructor */
struct ast_exten *peer; /* Next higher priority with our extension */
const char *registrar; /* Registrar */
struct ast_exten *next; /* Extension with a greater ID */
char stuff[0];
};
/*! \brief ast_include: include= support in extensions.conf */
struct ast_include {
char *name;
char *rname; /* Context to include */
const char *registrar; /* Registrar */
int hastime; /* If time construct exists */
struct ast_timing timing; /* time construct */
struct ast_include *next; /* Link them together */
char stuff[0];
};
/*! \brief ast_sw: Switch statement in extensions.conf */
struct ast_sw {
char *name;
const char *registrar; /* Registrar */
char *data; /* Data load */
int eval;
struct ast_sw *next; /* Link them together */
char *tmpdata;
char stuff[0];
};
/*! \brief ast_ignorepat: Ignore patterns in dial plan */
struct ast_ignorepat {
const char *registrar;
struct ast_ignorepat *next;
char pattern[0];
};
/*! \brief ast_context: An extension context */
struct ast_context {
ast_mutex_t lock; /*!< A lock to prevent multiple threads from clobbering the context */
struct ast_exten *root; /*!< The root of the list of extensions */
struct ast_context *next; /*!< Link them together */
struct ast_include *includes; /*!< Include other contexts */
struct ast_ignorepat *ignorepats; /*!< Patterns for which to continue playing dialtone */
const char *registrar; /*!< Registrar */
struct ast_sw *alts; /*!< Alternative switches */
char name[0]; /*!< Name of the context */
};
/*! \brief ast_app: A registered application */
struct ast_app {
int (*execute)(struct ast_channel *chan, void *data);
const char *synopsis; /* Synopsis text for 'show applications' */
const char *description; /* Description (help text) for 'show application <name>' */
struct ast_app *next; /* Next app in list */
char name[0]; /* Name of the application */
};
/*! \brief ast_state_cb: An extension state notify register item */
struct ast_state_cb {
int id;
void *data;
ast_state_cb_type callback;
struct ast_state_cb *next;
};
/*! \brief Structure for dial plan hints
Hints are pointers from an extension in the dialplan to one or
more devices (tech/name) */
struct ast_hint {
struct ast_exten *exten; /*!< Extension */
int laststate; /*!< Last known state */
struct ast_state_cb *callbacks; /*!< Callback list for this extension */
struct ast_hint *next; /*!< Pointer to next hint in list */
};
int ast_pbx_outgoing_cdr_failed(void);
static int pbx_builtin_answer(struct ast_channel *, void *);
static int pbx_builtin_goto(struct ast_channel *, void *);
static int pbx_builtin_hangup(struct ast_channel *, void *);
static int pbx_builtin_background(struct ast_channel *, void *);
static int pbx_builtin_dtimeout(struct ast_channel *, void *);
static int pbx_builtin_rtimeout(struct ast_channel *, void *);
static int pbx_builtin_atimeout(struct ast_channel *, void *);
static int pbx_builtin_wait(struct ast_channel *, void *);
static int pbx_builtin_waitexten(struct ast_channel *, void *);
static int pbx_builtin_setlanguage(struct ast_channel *, void *);
static int pbx_builtin_resetcdr(struct ast_channel *, void *);
static int pbx_builtin_setaccount(struct ast_channel *, void *);
static int pbx_builtin_setamaflags(struct ast_channel *, void *);
static int pbx_builtin_ringing(struct ast_channel *, void *);
static int pbx_builtin_progress(struct ast_channel *, void *);
static int pbx_builtin_congestion(struct ast_channel *, void *);
static int pbx_builtin_busy(struct ast_channel *, void *);
static int pbx_builtin_setglobalvar(struct ast_channel *, void *);
static int pbx_builtin_noop(struct ast_channel *, void *);
static int pbx_builtin_gotoif(struct ast_channel *, void *);
static int pbx_builtin_gotoiftime(struct ast_channel *, void *);
static int pbx_builtin_execiftime(struct ast_channel *, void *);
static int pbx_builtin_saynumber(struct ast_channel *, void *);
static int pbx_builtin_saydigits(struct ast_channel *, void *);
static int pbx_builtin_saycharacters(struct ast_channel *, void *);
static int pbx_builtin_sayphonetic(struct ast_channel *, void *);
static int pbx_builtin_setvar_old(struct ast_channel *, void *);
int pbx_builtin_setvar(struct ast_channel *, void *);
static int pbx_builtin_importvar(struct ast_channel *, void *);
AST_MUTEX_DEFINE_STATIC(globalslock);
static struct varshead globals;
static int autofallthrough = 0;
AST_MUTEX_DEFINE_STATIC(maxcalllock);
static int countcalls = 0;
AST_MUTEX_DEFINE_STATIC(acflock); /*!< Lock for the custom function list */
static struct ast_custom_function *acf_root = NULL;
/*! \brief Declaration of builtin applications */
static struct pbx_builtin {
char name[AST_MAX_APP];
int (*execute)(struct ast_channel *chan, void *data);
char *synopsis;
char *description;
} builtins[] =
{
/* These applications are built into the PBX core and do not
need separate modules */
{ "AbsoluteTimeout", pbx_builtin_atimeout,
"Set absolute maximum time of call",
" AbsoluteTimeout(seconds): This application will set the absolute maximum\n"
"amount of time permitted for a call. A setting of 0 disables the timeout.\n"
" AbsoluteTimeout has been deprecated in favor of Set(TIMEOUT(absolute)=timeout)\n"
},
{ "Answer", pbx_builtin_answer,
"Answer a channel if ringing",
" Answer([delay]): If the call has not been answered, this application will\n"
"answer it. Otherwise, it has no effect on the call. If a delay is specified,\n"
"Asterisk will wait this number of milliseconds before returning to\n"
"the dialplan after answering the call.\n"
},
{ "BackGround", pbx_builtin_background,
"Play a file while awaiting extension",
" Background(filename1[&filename2...][|options[|langoverride][|context]]):\n"
"This application will play the given list of files while waiting for an\n"
"extension to be dialed by the calling channel. To continue waiting for digits\n"
"after this application has finished playing files, the WaitExten application\n"
"should be used. The 'langoverride' option explicity specifies which language\n"
"to attempt to use for the requested sound files. If a 'context' is specified,\n"
"this is the dialplan context that this application will use when exiting to a\n"
"dialed extension."
" If one of the requested sound files does not exist, call processing will be\n"
"terminated.\n"
" Options:\n"
" s - causes the playback of the message to be skipped\n"
" if the channel is not in the 'up' state (i.e. it\n"
" hasn't been answered yet.) If this happens, the\n"
" application will return immediately.\n"
" n - don't answer the channel before playing the files\n"
" m - only break if a digit hit matches a one digit\n"
" extension in the destination context\n"
},
{ "Busy", pbx_builtin_busy,
"Indicate the Busy condition",
" Busy([timeout]): This application will indicate the busy condition to\n"
"the calling channel. If the optional timeout is specified, the calling channel\n"
"will be hung up after the specified number of seconds. Otherwise, this\n"
"application will wait until the calling channel hangs up.\n"
},
{ "Congestion", pbx_builtin_congestion,
"Indicate the Congestion condition",
" Congestion([timeout]): This application will indicate the congenstion\n"
"condition to the calling channel. If the optional timeout is specified, the\n"
"calling channel will be hung up after the specified number of seconds.\n"
"Otherwise, this application will wait until the calling channel hangs up.\n"
},
{ "DigitTimeout", pbx_builtin_dtimeout,
"Set maximum timeout between digits",
" DigitTimeout(seconds): Set the maximum amount of time permitted between\n"
"digits when the user is typing in an extension. When this timeout expires,\n"
"after the user has started to type in an extension, the extension will be\n"
"considered complete, and will be interpreted. Note that if an extension\n"
"typed in is valid, it will not have to timeout to be tested, so typically\n"
"at the expiry of this timeout, the extension will be considered invalid\n"
"(and thus control would be passed to the 'i' extension, or if it doesn't\n"
"exist the call would be terminated). The default timeout is 5 seconds.\n"
" DigitTimeout has been deprecated in favor of Set(TIMEOUT(digit)=timeout)\n"
},
{ "Goto", pbx_builtin_goto,
"Jump to a particular priority, extension, or context",
" Goto([[context|]extension|]priority): This application will set the current\n"
"context, extension, and priority in the channel structure. After it completes, the\n"
"pbx engine will continue dialplan execution at the specified location.\n"
"If no specific extension, or extension and context, are specified, then this\n"
"application will just set the specified priority of the current extension.\n"
" At least a priority is required as an argument, or the goto will return a -1,\n"
"and the channel and call will be terminated.\n"
" If the location that is put into the channel information is bogus, and asterisk cannot\n"
"find that location in the dialplan,\n"
"then the execution engine will try to find and execute the code in the 'i' (invalid)\n"
"extension in the current context. If that does not exist, it will try to execute the\n"
"'h' extension. If either or neither the 'h' or 'i' extensions have been defined, the\n"
"channel is hung up, and the execution of instructions on the channel is terminated.\n"
"What this means is that, for example, you specify a context that does not exist, then\n"
"it will not be possible to find the 'h' or 'i' extensions, and the call will terminate!\n"
},
{ "GotoIf", pbx_builtin_gotoif,
"Conditional goto",
" GotoIf(condition?[labeliftrue]:[labeliffalse]): This application will set the current\n"
"context, extension, and priority in the channel structure based on the evaluation of\n"
"the given condition. After this application completes, the\n"
"pbx engine will continue dialplan execution at the specified location in the dialplan.\n"
"The channel will continue at\n"
"'labeliftrue' if the condition is true, or 'labeliffalse' if the condition is\n"
"false. The labels are specified with the same syntax as used within the Goto\n"
"application. If the label chosen by the condition is omitted, no jump is\n"
"performed, and the execution passes to the next instruction.\n"
"If the target location is bogus, and does not exist, the execution engine will try \n"
"to find and execute the code in the 'i' (invalid)\n"
"extension in the current context. If that does not exist, it will try to execute the\n"
"'h' extension. If either or neither the 'h' or 'i' extensions have been defined, the\n"
"channel is hung up, and the execution of instructions on the channel is terminated.\n"
"Remember that this command can set the current context, and if the context specified\n"
"does not exist, then it will not be able to find any 'h' or 'i' extensions there,\n"
"and the channel and call will both be terminated!\n"
},
{ "GotoIfTime", pbx_builtin_gotoiftime,
"Conditional Goto based on the current time",
" GotoIfTime(<times>|<weekdays>|<mdays>|<months>?[[context|]exten|]priority):\n"
"This application will set the context, extension, and priority in the channel structure\n"
"if the current time matches the given time specification. Otherwise, nothing is done.\n"
"Further information on the time specification can be found in examples\n"
"illustrating how to do time-based context includes in the dialplan.\n"
"If the target jump location is bogus, Asterisk will respond as outlined in Goto.\n"
},
{ "ExecIfTime", pbx_builtin_execiftime,
"Conditional application execution based on the current time",
" ExecIfTime(<times>|<weekdays>|<mdays>|<months>?appname[|appargs]):\n"
"This application will execute the specified dialplan application, with optional\n"
"arguments, if the current time matches the given time specification. Further\n"
"information on the time speicification can be found in examples illustrating\n"
"how to do time-based context includes in the dialplan.\n"
},
{ "Hangup", pbx_builtin_hangup,
"Hang up the calling channel",
" Hangup(): This application will hang up the calling channel.\n"
},
{ "NoOp", pbx_builtin_noop,
"Do Nothing",
" NoOp(): This applicatiion does nothing. However, it is useful for debugging\n"
"purposes. Any text that is provided as arguments to this application can be\n"
"viewed at the Asterisk CLI. This method can be used to see the evaluations of\n"
"variables or functions without having any effect."
},
{ "Progress", pbx_builtin_progress,
"Indicate progress",
" Progress(): This application will request that in-band progress information\n"
"be provided to the calling channel.\n"
},
{ "ResetCDR", pbx_builtin_resetcdr,
"Resets the Call Data Record",
" ResetCDR([options]): This application causes the Call Data Record to be\n"
"reset.\n"
" Options:\n"
" w -- Store the current CDR record before resetting it.\n"
" a -- Store any stacked records.\n"
" v -- Save CDR variables.\n"
},
{ "ResponseTimeout", pbx_builtin_rtimeout,
"Set maximum timeout awaiting response",
" ResponseTimeout(seconds): This will set the maximum amount of time permitted\n"
"to wait for an extension to dialed (see the WaitExten application), before the\n"
"timeout occurs. If this timeout is reached, dialplan execution will continue at\n"
"the 't' extension, if it exists.\n"
" ResponseTimeout has been deprecated in favor of Set(TIMEOUT(response)=timeout)\n"
},
{ "Ringing", pbx_builtin_ringing,
"Indicate ringing tone",
" Ringing(): This application will request that the channel indicate a ringing\n"
"tone to the user.\n"
},
{ "SayNumber", pbx_builtin_saynumber,
"Say Number",
" SayNumber(digits[,gender]): This application will play the sounds that\n"
"correspond to the given number. Optionally, a gender may be specified.\n"
"This will use the language that is currently set for the channel. See the\n"
"LANGUAGE function for more information on setting the language for the channel.\n"
},
{ "SayDigits", pbx_builtin_saydigits,
"Say Digits",
" SayDigits(digits): This application will play the sounds that correspond\n"
"to the digits of the given number. This will use the language that is currently\n"
"set for the channel. See the LANGUAGE function for more information on setting\n"
"the language for the channel.\n"
},
{ "SayAlpha", pbx_builtin_saycharacters,
"Say Alpha",
" SayAlpha(string): This application will play the sounds that correspond to\n"
"the letters of the given string.\n"
},
{ "SayPhonetic", pbx_builtin_sayphonetic,
"Say Phonetic",
" SayPhonetic(string): This application will play the sounds from the phonetic\n"
"alphabet that correspond to the letters in the given string.\n"
},
{ "SetAccount", pbx_builtin_setaccount,
"Set the CDR Account Code",
" SetAccount([account]): This application will set the channel account code for\n"
"billing purposes.\n"
" SetAccount has been deprecated in favor of the Set(CDR(accountcode)=account).\n"
},
{ "SetAMAFlags", pbx_builtin_setamaflags,
"Set the AMA Flags",
" SetAMAFlags([flag]): This channel will set the channel's AMA Flags for billing\n"
"purposes.\n"
},
{ "SetGlobalVar", pbx_builtin_setglobalvar,
"Set a global variable to a given value",
" SetGlobalVar(variable=value): This application sets a given global variable to\n"
"the specified value.\n"
},
{ "SetLanguage", pbx_builtin_setlanguage,
"Set the channel's preferred language",
" SetLanguage(language): This will set the channel language to the given value.\n"
"This information is used for the syntax in generation of numbers, and to choose\n"
"a sound file in the given language, when it is available.\n"
" For example, if language is set to 'fr' and the file 'demo-congrats' is \n"
"requested to be played, if the file 'fr/demo-congrats' exists, then\n"
"it will play that file. If not, it will play the normal 'demo-congrats'.\n"
"For some language codes, SetLanguage also changes the syntax of some\n"
"Asterisk functions, like SayNumber.\n"
" SetLanguage has been deprecated in favor of Set(LANGUAGE()=language)\n"
},
{ "Set", pbx_builtin_setvar,
"Set channel variable(s) or function value(s)",
" Set(name1=value1|name2=value2|..[|options])\n"
"This function can be used to set the value of channel variables or dialplan\n"
"functions. It will accept up to 24 name/value pairs. When setting variables,\n"
"if the variable name is prefixed with _, the variable will be inherited into\n"
"channels created from the current channel. If the variable name is prefixed\n"
"with __, the variable will be inherited into channels created from the current\n"
"channel and all children channels.\n"
" Options:\n"
" g - Set variable globally instead of on the channel\n"
" (applies only to variables, not functions)\n"
},
{ "SetVar", pbx_builtin_setvar_old,
"Set channel variable(s)",
" SetVar(name1=value1|name2=value2|..[|options]): This application has been\n"
"deprecated in favor of using the Set application.\n"
},
{ "ImportVar", pbx_builtin_importvar,
"Import a variable from a channel into a new variable",
" ImportVar(newvar=channelname|variable): This application imports a variable\n"
"from the specified channel (as opposed to the current one) and stores it as\n"
"a variable in the current channel (the channel that is calling this\n"
"application). Variables created by this application have the same inheritance\n"
"properties as those created with the Set application. See the documentation for\n"
"Set for more information.\n"
},
{ "Wait", pbx_builtin_wait,
"Waits for some time",
" Wait(seconds): This application waits for a specified number of seconds.\n"
"Then, dialplan execution will continue at the next priority.\n"
" Note that the seconds can be passed with fractions of a second. For example,\n"
"'1.5' will ask the application to wait for 1.5 seconds.\n"
},
{ "WaitExten", pbx_builtin_waitexten,
"Waits for an extension to be entered",
" WaitExten([seconds][|options]): This application waits for the user to enter\n"
"a new extension for a specified number of seconds.\n"
" Note that the seconds can be passed with fractions of a second. For example,\n"
"'1.5' will ask the application to wait for 1.5 seconds.\n"
" Options:\n"
" m[(x)] - Provide music on hold to the caller while waiting for an extension.\n"
" Optionally, specify the class for music on hold within parenthesis.\n"
},
};
static struct ast_context *contexts = NULL;
AST_MUTEX_DEFINE_STATIC(conlock); /* Lock for the ast_context list */
static struct ast_app *apps = NULL;
AST_MUTEX_DEFINE_STATIC(applock); /* Lock for the application list */
struct ast_switch *switches = NULL;
AST_MUTEX_DEFINE_STATIC(switchlock); /* Lock for switches */
/* WARNING:
When holding this lock, do _not_ do anything that will cause conlock
to be taken, unless you _already_ hold it. The ast_merge_contexts_and_delete
function will take the locks in conlock/hintlock order, so any other
paths that require both locks must also take them in that order.
*/
AST_MUTEX_DEFINE_STATIC(hintlock); /* Lock for extension state notifys */
static int stateid = 1;
struct ast_hint *hints = NULL;
struct ast_state_cb *statecbs = NULL;
/*
\note This function is special. It saves the stack so that no matter
how many times it is called, it returns to the same place */
int pbx_exec(struct ast_channel *c, /*!< Channel */
struct ast_app *app, /*!< Application */
void *data, /*!< Data for execution */
int newstack) /*!< Force stack increment */
{
int res;
char *saved_c_appl;
char *saved_c_data;
int (*execute)(struct ast_channel *chan, void *data) = app->execute;
if (newstack) {
if (c->cdr && !ast_check_hangup(c))
ast_cdr_setapp(c->cdr, app->name, data);
/* save channel values */
saved_c_appl= c->appl;
saved_c_data= c->data;
c->appl = app->name;
c->data = data;
res = execute(c, data);
/* restore channel values */
c->appl= saved_c_appl;
c->data= saved_c_data;
return res;
} else
ast_log(LOG_WARNING, "You really didn't want to call this function with newstack set to 0\n");
return -1;
}
/*! Go no deeper than this through includes (not counting loops) */
#define AST_PBX_MAX_STACK 128
#define HELPER_EXISTS 0
#define HELPER_SPAWN 1
#define HELPER_EXEC 2
#define HELPER_CANMATCH 3
#define HELPER_MATCHMORE 4
#define HELPER_FINDLABEL 5
/*! \brief Find application handle in linked list
*/
struct ast_app *pbx_findapp(const char *app)
{
struct ast_app *tmp;
if (ast_mutex_lock(&applock)) {
ast_log(LOG_WARNING, "Unable to obtain application lock\n");
return NULL;
}
tmp = apps;
while(tmp) {
if (!strcasecmp(tmp->name, app))
break;
tmp = tmp->next;
}
ast_mutex_unlock(&applock);
return tmp;
}
static struct ast_switch *pbx_findswitch(const char *sw)
{
struct ast_switch *asw;
if (ast_mutex_lock(&switchlock)) {
ast_log(LOG_WARNING, "Unable to obtain application lock\n");
return NULL;
}
asw = switches;
while(asw) {
if (!strcasecmp(asw->name, sw))
break;
asw = asw->next;
}
ast_mutex_unlock(&switchlock);
return asw;
}
static inline int include_valid(struct ast_include *i)
{
if (!i->hastime)
return 1;
return ast_check_timing(&(i->timing));
}
static void pbx_destroy(struct ast_pbx *p)
{
free(p);
}
#define EXTENSION_MATCH_CORE(data,pattern,match) {\
/* All patterns begin with _ */\
if (pattern[0] != '_') \
return 0;\
/* Start optimistic */\
match=1;\
pattern++;\
while(match && *data && *pattern && (*pattern != '/')) {\
while (*data == '-' && (*(data+1) != '\0')) data++;\
switch(toupper(*pattern)) {\
case '[': \
{\
int i,border=0;\
char *where;\
match=0;\
pattern++;\
where=strchr(pattern,']');\
if (where)\
border=(int)(where-pattern);\
if (!where || border > strlen(pattern)) {\
ast_log(LOG_WARNING, "Wrong usage of [] in the extension\n");\
return match;\
}\
for (i=0; i<border; i++) {\
int res=0;\
if (i+2<border)\
if (pattern[i+1]=='-') {\
if (*data >= pattern[i] && *data <= pattern[i+2]) {\
res=1;\
} else {\
i+=2;\
continue;\
}\
}\
if (res==1 || *data==pattern[i]) {\
match = 1;\
break;\
}\
}\
pattern+=border;\
break;\
}\
case 'N':\
if ((*data < '2') || (*data > '9'))\
match=0;\
break;\
case 'X':\
if ((*data < '0') || (*data > '9'))\
match = 0;\
break;\
case 'Z':\
if ((*data < '1') || (*data > '9'))\
match = 0;\
break;\
case '.':\
/* Must match */\
return 1;\
case '!':\
/* Early match */\
return 2;\
case ' ':\
case '-':\
/* Ignore these characters */\
data--;\
break;\
default:\
if (*data != *pattern)\
match =0;\
}\
data++;\
pattern++;\
}\
/* If we ran off the end of the data and the pattern ends in '!', match */\
if (match && !*data && (*pattern == '!'))\
return 2;\
}
int ast_extension_match(const char *pattern, const char *data)
{
int match;
/* If they're the same return */
if (!strcmp(pattern, data))
return 1;
EXTENSION_MATCH_CORE(data,pattern,match);
/* Must be at the end of both */
if (*data || (*pattern && (*pattern != '/')))
match = 0;
return match;
}
int ast_extension_close(const char *pattern, const char *data, int needmore)
{
int match;
/* If "data" is longer, it can'be a subset of pattern unless
pattern is a pattern match */
if ((strlen(pattern) < strlen(data)) && (pattern[0] != '_'))
return 0;
if ((ast_strlen_zero((char *)data) || !strncasecmp(pattern, data, strlen(data))) &&
(!needmore || (strlen(pattern) > strlen(data)))) {
return 1;
}
EXTENSION_MATCH_CORE(data,pattern,match);
/* If there's more or we don't care about more, or if it's a possible early match,
return non-zero; otherwise it's a miss */
if (!needmore || *pattern || match == 2) {
return match;
} else
return 0;
}
struct ast_context *ast_context_find(const char *name)
{
struct ast_context *tmp;
ast_mutex_lock(&conlock);
if (name) {
tmp = contexts;
while(tmp) {
if (!strcasecmp(name, tmp->name))
break;
tmp = tmp->next;
}
} else
tmp = contexts;
ast_mutex_unlock(&conlock);
return tmp;
}
#define STATUS_NO_CONTEXT 1
#define STATUS_NO_EXTENSION 2
#define STATUS_NO_PRIORITY 3
#define STATUS_NO_LABEL 4
#define STATUS_SUCCESS 5
static int matchcid(const char *cidpattern, const char *callerid)
{
int failresult;
/* If the Caller*ID pattern is empty, then we're matching NO Caller*ID, so
failing to get a number should count as a match, otherwise not */
if (!ast_strlen_zero(cidpattern))
failresult = 0;
else
failresult = 1;
if (!callerid)
return failresult;
return ast_extension_match(cidpattern, callerid);
}
static struct ast_exten *pbx_find_extension(struct ast_channel *chan, struct ast_context *bypass, const char *context, const char *exten, int priority, const char *label, const char *callerid, int action, char *incstack[], int *stacklen, int *status, struct ast_switch **swo, char **data, const char **foundcontext)
{
int x, res;
struct ast_context *tmp;
struct ast_exten *e, *eroot;
struct ast_include *i;
struct ast_sw *sw;
struct ast_switch *asw;
/* Initialize status if appropriate */
if (!*stacklen) {
*status = STATUS_NO_CONTEXT;
*swo = NULL;
*data = NULL;
}
/* Check for stack overflow */
if (*stacklen >= AST_PBX_MAX_STACK) {
ast_log(LOG_WARNING, "Maximum PBX stack exceeded\n");
return NULL;
}
/* Check first to see if we've already been checked */
for (x=0; x<*stacklen; x++) {
if (!strcasecmp(incstack[x], context))
return NULL;
}
if (bypass)
tmp = bypass;
else
tmp = contexts;
while(tmp) {
/* Match context */
if (bypass || !strcmp(tmp->name, context)) {
struct ast_exten *earlymatch = NULL;
if (*status < STATUS_NO_EXTENSION)
*status = STATUS_NO_EXTENSION;
for (eroot = tmp->root; eroot; eroot=eroot->next) {
int match = 0;
/* Match extension */
if ((((action != HELPER_MATCHMORE) && ast_extension_match(eroot->exten, exten)) ||
((action == HELPER_CANMATCH) && (ast_extension_close(eroot->exten, exten, 0))) ||
((action == HELPER_MATCHMORE) && (match = ast_extension_close(eroot->exten, exten, 1)))) &&
(!eroot->matchcid || matchcid(eroot->cidmatch, callerid))) {
if (action == HELPER_MATCHMORE && match == 2 && !earlymatch) {
/* It matched an extension ending in a '!' wildcard
So ignore it for now, unless there's a better match */
earlymatch = eroot;
} else {
e = eroot;
if (*status < STATUS_NO_PRIORITY)
*status = STATUS_NO_PRIORITY;
while(e) {
/* Match priority */
if (action == HELPER_FINDLABEL) {
if (*status < STATUS_NO_LABEL)
*status = STATUS_NO_LABEL;
if (label && e->label && !strcmp(label, e->label)) {
*status = STATUS_SUCCESS;
*foundcontext = context;
return e;
}
} else if (e->priority == priority) {
*status = STATUS_SUCCESS;
*foundcontext = context;
return e;
}
e = e->peer;
}
}
}
}
if (earlymatch) {
/* Bizarre logic for HELPER_MATCHMORE. We return zero to break out
of the loop waiting for more digits, and _then_ match (normally)
the extension we ended up with. We got an early-matching wildcard
pattern, so return NULL to break out of the loop. */
return NULL;
}
/* Check alternative switches */
sw = tmp->alts;
while(sw) {
if ((asw = pbx_findswitch(sw->name))) {
/* Substitute variables now */
if (sw->eval)
pbx_substitute_variables_helper(chan, sw->data, sw->tmpdata, SWITCH_DATA_LENGTH - 1);
if (action == HELPER_CANMATCH)
res = asw->canmatch ? asw->canmatch(chan, context, exten, priority, callerid, sw->eval ? sw->tmpdata : sw->data) : 0;
else if (action == HELPER_MATCHMORE)
res = asw->matchmore ? asw->matchmore(chan, context, exten, priority, callerid, sw->eval ? sw->tmpdata : sw->data) : 0;
else
res = asw->exists ? asw->exists(chan, context, exten, priority, callerid, sw->eval ? sw->tmpdata : sw->data) : 0;
if (res) {
/* Got a match */
*swo = asw;
*data = sw->eval ? sw->tmpdata : sw->data;
*foundcontext = context;
return NULL;
}
} else {
ast_log(LOG_WARNING, "No such switch '%s'\n", sw->name);
}
sw = sw->next;
}
/* Setup the stack */
incstack[*stacklen] = tmp->name;
(*stacklen)++;
/* Now try any includes we have in this context */
i = tmp->includes;
while(i) {
if (include_valid(i)) {
if ((e = pbx_find_extension(chan, bypass, i->rname, exten, priority, label, callerid, action, incstack, stacklen, status, swo, data, foundcontext)))
return e;
if (*swo)
return NULL;
}
i = i->next;
}
break;
}
tmp = tmp->next;
}
return NULL;
}
/* Note that it's negative -- that's important later. */
#define DONT_HAVE_LENGTH 0x80000000
static int parse_variable_name(char *var, int *offset, int *length, int *isfunc)
{
char *varchar, *offsetchar = NULL;
int parens=0;
*offset = 0;
*length = DONT_HAVE_LENGTH;
*isfunc = 0;
for (varchar=var; *varchar; varchar++) {
switch (*varchar) {
case '(':
(*isfunc)++;
parens++;
break;
case ')':
parens--;
break;
case ':':
if (parens == 0) {
offsetchar = varchar + 1;
*varchar = '\0';
goto pvn_endfor;
}
}
}
pvn_endfor:
if (offsetchar) {
sscanf(offsetchar, "%d:%d", offset, length);
return 1;
} else {
return 0;
}
}
/*! \brief takes a substring. It is ok to call with value == workspace.
*
* offset < 0 means start from the end of the string and set the beginning
* to be that many characters back.
* length is the length of the substring, -1 means unlimited
* (we take any negative value).
* Always return a copy in workspace.
*/
static char *substring(const char *value, int offset, int length, char *workspace, size_t workspace_len)
{
char *ret = workspace;
int lr; /* length of the input string after the copy */
ast_copy_string(workspace, value, workspace_len); /* always make a copy */
if (offset == 0 && length < 0) /* take the whole string */
return ret;
lr = strlen(ret); /* compute length after copy, so we never go out of the workspace */
if (offset < 0) { /* translate negative offset into positive ones */
offset = lr + offset;
if (offset < 0) /* If the negative offset was greater than the length of the string, just start at the beginning */
offset = 0;
}
/* too large offset result in empty string so we know what to return */
if (offset >= lr)
return ret + lr; /* the final '\0' */
ret += offset; /* move to the start position */
if (length >= 0 && length < lr - offset) /* truncate if necessary */
ret[length] = '\0';
return ret;
}
/*! \brief pbx_retrieve_variable: Support for Asterisk built-in variables
---*/
void pbx_retrieve_variable(struct ast_channel *c, const char *var, char **ret, char *workspace, int workspacelen, struct varshead *headp)
{