forked from asterisk/asterisk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
func_strings.c
2032 lines (1763 loc) · 59.3 KB
/
func_strings.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) 2005-2006, Digium, Inc.
* Portions Copyright (C) 2005, Tilghman Lesher. All rights reserved.
* Portions Copyright (C) 2005, Anthony Minessale II
*
* 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 String manipulation dialplan functions
*
* \author Tilghman Lesher
* \author Anothony Minessale II
* \ingroup functions
*/
/*** MODULEINFO
<support_level>core</support_level>
***/
#include "asterisk.h"
#include <regex.h>
#include <ctype.h>
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/app.h"
#include "asterisk/localtime.h"
#include "asterisk/test.h"
AST_THREADSTORAGE(result_buf);
AST_THREADSTORAGE(tmp_buf);
/*** DOCUMENTATION
<function name="FIELDQTY" language="en_US">
<synopsis>
Count the fields with an arbitrary delimiter
</synopsis>
<syntax>
<parameter name="varname" required="true" />
<parameter name="delim" required="true" />
</syntax>
<description>
<para>The delimiter may be specified as a special or extended ASCII character, by encoding it. The characters
<literal>\n</literal>, <literal>\r</literal>, and <literal>\t</literal> are all recognized as the newline,
carriage return, and tab characters, respectively. Also, octal and hexadecimal specifications are recognized
by the patterns <literal>\0nnn</literal> and <literal>\xHH</literal>, respectively. For example, if you wanted
to encode a comma as the delimiter, you could use either <literal>\054</literal> or <literal>\x2C</literal>.</para>
<para>Example: If ${example} contains <literal>ex-amp-le</literal>, then ${FIELDQTY(example,-)} returns 3.</para>
</description>
</function>
<function name="FIELDNUM" language="en_US">
<synopsis>
Return the 1-based offset of a field in a list
</synopsis>
<syntax>
<parameter name="varname" required="true" />
<parameter name="delim" required="true" />
<parameter name="value" required="true" />
</syntax>
<description>
<para>Search the variable named <replaceable>varname</replaceable> for the string <replaceable>value</replaceable>
delimited by <replaceable>delim</replaceable> and return a 1-based offset as to its location. If not found
or an error occured, return <literal>0</literal>.</para>
<para>The delimiter may be specified as a special or extended ASCII character, by encoding it. The characters
<literal>\n</literal>, <literal>\r</literal>, and <literal>\t</literal> are all recognized as the newline,
carriage return, and tab characters, respectively. Also, octal and hexadecimal specifications are recognized
by the patterns <literal>\0nnn</literal> and <literal>\xHH</literal>, respectively. For example, if you wanted
to encode a comma as the delimiter, you could use either <literal>\054</literal> or <literal>\x2C</literal>.</para>
<para>Example: If ${example} contains <literal>ex-amp-le</literal>, then ${FIELDNUM(example,-,amp)} returns 2.</para>
</description>
</function>
<function name="LISTFILTER" language="en_US">
<synopsis>Remove an item from a list, by name.</synopsis>
<syntax>
<parameter name="varname" required="true" />
<parameter name="delim" required="true" default="," />
<parameter name="value" required="true" />
</syntax>
<description>
<para>Remove <replaceable>value</replaceable> from the list contained in the <replaceable>varname</replaceable>
variable, where the list delimiter is specified by the <replaceable>delim</replaceable> parameter. This is
very useful for removing a single channel name from a list of channels, for example.</para>
</description>
</function>
<function name="FILTER" language="en_US">
<synopsis>
Filter the string to include only the allowed characters
</synopsis>
<syntax>
<parameter name="allowed-chars" required="true" />
<parameter name="string" required="true" />
</syntax>
<description>
<para>Permits all characters listed in <replaceable>allowed-chars</replaceable>,
filtering all others outs. In addition to literally listing the characters,
you may also use ranges of characters (delimited by a <literal>-</literal></para>
<para>Hexadecimal characters started with a <literal>\x</literal>(i.e. \x20)</para>
<para>Octal characters started with a <literal>\0</literal> (i.e. \040)</para>
<para>Also <literal>\t</literal>,<literal>\n</literal> and <literal>\r</literal> are recognized.</para>
<note><para>If you want the <literal>-</literal> character it needs to be prefixed with a
<literal>\</literal></para></note>
</description>
</function>
<function name="REPLACE" language="en_US">
<synopsis>
Replace a set of characters in a given string with another character.
</synopsis>
<syntax>
<parameter name="varname" required="true" />
<parameter name="find-chars" required="true" />
<parameter name="replace-char" required="false" />
</syntax>
<description>
<para>Iterates through a string replacing all the <replaceable>find-chars</replaceable> with
<replaceable>replace-char</replaceable>. <replaceable>replace-char</replaceable> may be either
empty or contain one character. If empty, all <replaceable>find-chars</replaceable> will be
deleted from the output.</para>
<note><para>The replacement only occurs in the output. The original variable is not
altered.</para></note>
</description>
</function>
<function name="STRREPLACE" language="en_US">
<synopsis>
Replace instances of a substring within a string with another string.
</synopsis>
<syntax>
<parameter name="varname" required="true" />
<parameter name="find-string" required="true" />
<parameter name="replace-string" required="false" />
<parameter name="max-replacements" required="false" />
</syntax>
<description>
<para>Searches for all instances of the <replaceable>find-string</replaceable> in provided variable and
replaces them with <replaceable>replace-string</replaceable>. If <replaceable>replace-string</replaceable>
is an empty string, this will effecively delete that substring. If <replaceable>max-replacements</replaceable>
is specified, this function will stop after performing replacements <replaceable>max-replacements</replaceable> times.</para>
<note><para>The replacement only occurs in the output. The original variable is not altered.</para></note>
</description>
</function>
<function name="PASSTHRU" language="en_US">
<synopsis>
Pass the given argument back as a value.
</synopsis>
<syntax>
<parameter name="string" required="false" />
</syntax>
<description>
<para>Literally returns the given <replaceable>string</replaceable>. The intent is to permit
other dialplan functions which take a variable name as an argument to be able to take a literal
string, instead.</para>
<note><para>The functions which take a variable name need to be passed var and not
${var}. Similarly, use PASSTHRU() and not ${PASSTHRU()}.</para></note>
<para>Example: ${CHANNEL} contains SIP/321-1</para>
<para> ${CUT(PASSTHRU(${CUT(CHANNEL,-,1)}),/,2)}) will return 321</para>
</description>
</function>
<function name="REGEX" language="en_US">
<synopsis>
Check string against a regular expression.
</synopsis>
<syntax argsep=" ">
<parameter name=""regular expression"" required="true" />
<parameter name="string" required="true" />
</syntax>
<description>
<para>Return <literal>1</literal> on regular expression match or <literal>0</literal> otherwise</para>
<para>Please note that the space following the double quotes separating the
regex from the data is optional and if present, is skipped. If a space is
desired at the beginning of the data, then put two spaces there; the second
will not be skipped.</para>
</description>
</function>
<application name="ClearHash" language="en_US">
<synopsis>
Clear the keys from a specified hashname.
</synopsis>
<syntax>
<parameter name="hashname" required="true" />
</syntax>
<description>
<para>Clears all keys out of the specified <replaceable>hashname</replaceable>.</para>
</description>
</application>
<function name="HASH" language="en_US">
<synopsis>
Implementation of a dialplan associative array
</synopsis>
<syntax>
<parameter name="hashname" required="true" />
<parameter name="hashkey" />
</syntax>
<description>
<para>In two arguments mode, gets and sets values to corresponding keys within
a named associative array. The single-argument mode will only work when assigned
to from a function defined by func_odbc</para>
</description>
</function>
<function name="HASHKEYS" language="en_US">
<synopsis>
Retrieve the keys of the HASH() function.
</synopsis>
<syntax>
<parameter name="hashname" required="true" />
</syntax>
<description>
<para>Returns a comma-delimited list of the current keys of the associative array
defined by the HASH() function. Note that if you iterate over the keys of
the result, adding keys during iteration will cause the result of the HASHKEYS()
function to change.</para>
</description>
</function>
<function name="KEYPADHASH" language="en_US">
<synopsis>
Hash the letters in string into equivalent keypad numbers.
</synopsis>
<syntax>
<parameter name="string" required="true" />
</syntax>
<description>
<para>Example: ${KEYPADHASH(Les)} returns "537"</para>
</description>
</function>
<function name="ARRAY" language="en_US">
<synopsis>
Allows setting multiple variables at once.
</synopsis>
<syntax>
<parameter name="var1" required="true" />
<parameter name="var2" required="false" multiple="true" />
<parameter name="varN" required="false" />
</syntax>
<description>
<para>The comma-delimited list passed as a value to which the function is set will
be interpreted as a set of values to which the comma-delimited list of
variable names in the argument should be set.</para>
<para>Example: Set(ARRAY(var1,var2)=1,2) will set var1 to 1 and var2 to 2</para>
</description>
</function>
<function name="STRPTIME" language="en_US">
<synopsis>
Returns the epoch of the arbitrary date/time string structured as described by the format.
</synopsis>
<syntax>
<parameter name="datetime" required="true" />
<parameter name="timezone" required="true" />
<parameter name="format" required="true" />
</syntax>
<description>
<para>This is useful for converting a date into <literal>EPOCH</literal> time,
possibly to pass to an application like SayUnixTime or to calculate the difference
between the two date strings</para>
<para>Example: ${STRPTIME(2006-03-01 07:30:35,America/Chicago,%Y-%m-%d %H:%M:%S)} returns 1141219835</para>
</description>
</function>
<function name="STRFTIME" language="en_US">
<synopsis>
Returns the current date/time in the specified format.
</synopsis>
<syntax>
<parameter name="epoch" />
<parameter name="timezone" />
<parameter name="format" />
</syntax>
<description>
<para>STRFTIME supports all of the same formats as the underlying C function
<emphasis>strftime(3)</emphasis>.
It also supports the following format: <literal>%[n]q</literal> - fractions of a second,
with leading zeros.</para>
<para>Example: <literal>%3q</literal> will give milliseconds and <literal>%1q</literal>
will give tenths of a second. The default is set at milliseconds (n=3).
The common case is to use it in combination with %S, as in <literal>%S.%3q</literal>.</para>
</description>
<see-also>
<ref type="manpage">strftime(3)</ref>
</see-also>
</function>
<function name="EVAL" language="en_US">
<synopsis>
Evaluate stored variables
</synopsis>
<syntax>
<parameter name="variable" required="true" />
</syntax>
<description>
<para>Using EVAL basically causes a string to be evaluated twice.
When a variable or expression is in the dialplan, it will be
evaluated at runtime. However, if the results of the evaluation
is in fact another variable or expression, using EVAL will have it
evaluated a second time.</para>
<para>Example: If the <variable>MYVAR</variable> contains
<variable>OTHERVAR</variable>, then the result of ${EVAL(
<variable>MYVAR</variable>)} in the dialplan will be the
contents of <variable>OTHERVAR</variable>. Normally just
putting <variable>MYVAR</variable> in the dialplan the result
would be <variable>OTHERVAR</variable>.</para>
</description>
</function>
<function name="TOUPPER" language="en_US">
<synopsis>
Convert string to all uppercase letters.
</synopsis>
<syntax>
<parameter name="string" required="true" />
</syntax>
<description>
<para>Example: ${TOUPPER(Example)} returns "EXAMPLE"</para>
</description>
</function>
<function name="TOLOWER" language="en_US">
<synopsis>
Convert string to all lowercase letters.
</synopsis>
<syntax>
<parameter name="string" required="true" />
</syntax>
<description>
<para>Example: ${TOLOWER(Example)} returns "example"</para>
</description>
</function>
<function name="LEN" language="en_US">
<synopsis>
Return the length of the string given.
</synopsis>
<syntax>
<parameter name="string" required="true" />
</syntax>
<description>
<para>Example: ${LEN(example)} returns 7</para>
</description>
</function>
<function name="QUOTE" language="en_US">
<synopsis>
Quotes a given string, escaping embedded quotes as necessary
</synopsis>
<syntax>
<parameter name="string" required="true" />
</syntax>
<description>
<para>Example: ${QUOTE(ab"c"de)} will return ""ab\"c\"de""</para>
</description>
</function>
<function name="CSV_QUOTE" language="en_US">
<synopsis>
Quotes a given string for use in a CSV file, escaping embedded quotes as necessary
</synopsis>
<syntax>
<parameter name="string" required="true" />
</syntax>
<description>
<para>Example: ${CSV_QUOTE("a,b" 123)} will return """a,b"" 123"</para>
</description>
</function>
<function name="SHIFT" language="en_US">
<synopsis>
Removes and returns the first item off of a variable containing delimited text
</synopsis>
<syntax>
<parameter name="varname" required="true" />
<parameter name="delimiter" required="false" default="," />
</syntax>
<description>
<para>Example:</para>
<para>exten => s,1,Set(array=one,two,three)</para>
<para>exten => s,n,While($["${SET(var=${SHIFT(array)})}" != ""])</para>
<para>exten => s,n,NoOp(var is ${var})</para>
<para>exten => s,n,EndWhile</para>
<para>This would iterate over each value in array, left to right, and
would result in NoOp(var is one), NoOp(var is two), and
NoOp(var is three) being executed.
</para>
</description>
</function>
<function name="POP" language="en_US">
<synopsis>
Removes and returns the last item off of a variable containing delimited text
</synopsis>
<syntax>
<parameter name="varname" required="true" />
<parameter name="delimiter" required="false" default="," />
</syntax>
<description>
<para>Example:</para>
<para>exten => s,1,Set(array=one,two,three)</para>
<para>exten => s,n,While($["${SET(var=${POP(array)})}" != ""])</para>
<para>exten => s,n,NoOp(var is ${var})</para>
<para>exten => s,n,EndWhile</para>
<para>This would iterate over each value in array, right to left, and
would result in NoOp(var is three), NoOp(var is two), and
NoOp(var is one) being executed.
</para>
</description>
</function>
<function name="PUSH" language="en_US">
<synopsis>
Appends one or more values to the end of a variable containing delimited text
</synopsis>
<syntax>
<parameter name="varname" required="true" />
<parameter name="delimiter" required="false" default="," />
</syntax>
<description>
<para>Example: Set(PUSH(array)=one,two,three) would append one,
two, and three to the end of the values stored in the variable
"array".
</para>
</description>
</function>
<function name="UNSHIFT" language="en_US">
<synopsis>
Inserts one or more values to the beginning of a variable containing delimited text
</synopsis>
<syntax>
<parameter name="varname" required="true" />
<parameter name="delimiter" required="false" default="," />
</syntax>
<description>
<para>Example: Set(UNSHIFT(array)=one,two,three) would insert one,
two, and three before the values stored in the variable
"array".
</para>
</description>
</function>
***/
static int function_fieldqty_helper(struct ast_channel *chan, const char *cmd,
char *parse, char *buf, struct ast_str **sbuf, ssize_t len)
{
char *varsubst;
struct ast_str *str = ast_str_thread_get(&result_buf, 16);
int fieldcount = 0;
AST_DECLARE_APP_ARGS(args,
AST_APP_ARG(varname);
AST_APP_ARG(delim);
);
char delim[2] = "";
size_t delim_used;
if (!str) {
return -1;
}
AST_STANDARD_APP_ARGS(args, parse);
if (args.delim) {
ast_get_encoded_char(args.delim, delim, &delim_used);
varsubst = ast_alloca(strlen(args.varname) + 4);
sprintf(varsubst, "${%s}", args.varname);
ast_str_substitute_variables(&str, 0, chan, varsubst);
if (ast_str_strlen(str) == 0) {
fieldcount = 0;
} else {
char *varval = ast_str_buffer(str);
while (strsep(&varval, delim)) {
fieldcount++;
}
}
} else {
fieldcount = 1;
}
if (sbuf) {
ast_str_set(sbuf, len, "%d", fieldcount);
} else {
snprintf(buf, len, "%d", fieldcount);
}
return 0;
}
static int function_fieldqty(struct ast_channel *chan, const char *cmd,
char *parse, char *buf, size_t len)
{
return function_fieldqty_helper(chan, cmd, parse, buf, NULL, len);
}
static int function_fieldqty_str(struct ast_channel *chan, const char *cmd,
char *parse, struct ast_str **buf, ssize_t len)
{
return function_fieldqty_helper(chan, cmd, parse, NULL, buf, len);
}
static struct ast_custom_function fieldqty_function = {
.name = "FIELDQTY",
.read = function_fieldqty,
.read2 = function_fieldqty_str,
};
static int function_fieldnum_helper(struct ast_channel *chan, const char *cmd,
char *parse, char *buf, struct ast_str **sbuf, ssize_t len)
{
char *varsubst, *field;
struct ast_str *str = ast_str_thread_get(&result_buf, 16);
int fieldindex = 0, res = 0;
AST_DECLARE_APP_ARGS(args,
AST_APP_ARG(varname);
AST_APP_ARG(delim);
AST_APP_ARG(field);
);
char delim[2] = "";
size_t delim_used;
if (!str) {
return -1;
}
AST_STANDARD_APP_ARGS(args, parse);
if (args.argc < 3) {
ast_log(LOG_ERROR, "Usage: FIELDNUM(<listname>,<delimiter>,<fieldvalue>)\n");
res = -1;
} else {
varsubst = ast_alloca(strlen(args.varname) + 4);
sprintf(varsubst, "${%s}", args.varname);
ast_str_substitute_variables(&str, 0, chan, varsubst);
if (ast_str_strlen(str) == 0 || ast_strlen_zero(args.delim)) {
fieldindex = 0;
} else if (ast_get_encoded_char(args.delim, delim, &delim_used) == -1) {
res = -1;
} else {
char *varval = ast_str_buffer(str);
while ((field = strsep(&varval, delim)) != NULL) {
fieldindex++;
if (!strcasecmp(field, args.field)) {
break;
}
}
if (!field) {
fieldindex = 0;
}
res = 0;
}
}
if (sbuf) {
ast_str_set(sbuf, len, "%d", fieldindex);
} else {
snprintf(buf, len, "%d", fieldindex);
}
return res;
}
static int function_fieldnum(struct ast_channel *chan, const char *cmd,
char *parse, char *buf, size_t len)
{
return function_fieldnum_helper(chan, cmd, parse, buf, NULL, len);
}
static int function_fieldnum_str(struct ast_channel *chan, const char *cmd,
char *parse, struct ast_str **buf, ssize_t len)
{
return function_fieldnum_helper(chan, cmd, parse, NULL, buf, len);
}
static struct ast_custom_function fieldnum_function = {
.name = "FIELDNUM",
.read = function_fieldnum,
.read2 = function_fieldnum_str,
};
static int listfilter(struct ast_channel *chan, const char *cmd, char *parse, char *buf, struct ast_str **bufstr, ssize_t len)
{
AST_DECLARE_APP_ARGS(args,
AST_APP_ARG(listname);
AST_APP_ARG(delimiter);
AST_APP_ARG(fieldvalue);
);
struct ast_str *orig_list = ast_str_thread_get(&tmp_buf, 16);
const char *begin, *cur, *next;
int dlen, flen, first = 1;
struct ast_str *result, **result_ptr = &result;
char *delim, *varsubst;
AST_STANDARD_APP_ARGS(args, parse);
if (buf) {
if (!(result = ast_str_thread_get(&result_buf, 16))) {
return -1;
}
} else {
/* Place the result directly into the output buffer */
result_ptr = bufstr;
}
if (args.argc < 3) {
ast_log(LOG_ERROR, "Usage: LISTFILTER(<listname>,<delimiter>,<fieldvalue>)\n");
return -1;
}
varsubst = ast_alloca(strlen(args.listname) + 4);
sprintf(varsubst, "${%s}", args.listname);
/* If we don't lock the channel, the variable could disappear out from underneath us. */
if (chan) {
ast_channel_lock(chan);
}
ast_str_substitute_variables(&orig_list, 0, chan, varsubst);
if (!ast_str_strlen(orig_list)) {
if (chan) {
ast_channel_unlock(chan);
}
return -1;
}
/* If the string isn't there, just copy out the string and be done with it. */
if (!strstr(ast_str_buffer(orig_list), args.fieldvalue)) {
if (buf) {
ast_copy_string(buf, ast_str_buffer(orig_list), len);
} else {
ast_str_set(result_ptr, len, "%s", ast_str_buffer(orig_list));
}
if (chan) {
ast_channel_unlock(chan);
}
return 0;
}
dlen = strlen(args.delimiter);
delim = ast_alloca(dlen + 1);
ast_get_encoded_str(args.delimiter, delim, dlen + 1);
if ((dlen = strlen(delim)) == 0) {
delim = ",";
dlen = 1;
}
flen = strlen(args.fieldvalue);
ast_str_reset(*result_ptr);
/* Enough space for any result */
if (len > -1) {
ast_str_make_space(result_ptr, len ? len : ast_str_strlen(orig_list) + 1);
}
begin = ast_str_buffer(orig_list);
next = strstr(begin, delim);
do {
/* Find next boundary */
if (next) {
cur = next;
next = strstr(cur + dlen, delim);
} else {
cur = strchr(begin + dlen, '\0');
}
if (flen == cur - begin && !strncmp(begin, args.fieldvalue, flen)) {
/* Skip field */
begin += flen + dlen;
} else {
/* Copy field to output */
if (!first) {
ast_str_append(result_ptr, len, "%s", delim);
}
ast_str_append_substr(result_ptr, len, begin, cur - begin);
first = 0;
begin = cur + dlen;
}
} while (*cur != '\0');
if (chan) {
ast_channel_unlock(chan);
}
if (buf) {
ast_copy_string(buf, ast_str_buffer(result), len);
}
return 0;
}
static int listfilter_read(struct ast_channel *chan, const char *cmd, char *parse, char *buf, size_t len)
{
return listfilter(chan, cmd, parse, buf, NULL, len);
}
static int listfilter_read2(struct ast_channel *chan, const char *cmd, char *parse, struct ast_str **buf, ssize_t len)
{
return listfilter(chan, cmd, parse, NULL, buf, len);
}
static struct ast_custom_function listfilter_function = {
.name = "LISTFILTER",
.read = listfilter_read,
.read2 = listfilter_read2,
};
static int filter(struct ast_channel *chan, const char *cmd, char *parse, char *buf,
size_t len)
{
AST_DECLARE_APP_ARGS(args,
AST_APP_ARG(allowed);
AST_APP_ARG(string);
);
char *outbuf = buf;
unsigned char ac;
char allowed[256] = "";
size_t allowedlen = 0;
int32_t bitfield[8] = { 0, }; /* 256 bits */
AST_STANDARD_RAW_ARGS(args, parse);
if (!args.string) {
ast_log(LOG_ERROR, "Usage: FILTER(<allowed-chars>,<string>)\n");
return -1;
}
if (args.allowed[0] == '"' && !ast_opt_dont_warn) {
ast_log(LOG_WARNING, "FILTER allowed characters includes the quote (\") character. This may not be what you want.\n");
}
/* Expand ranges */
for (; *(args.allowed);) {
char c1 = 0, c2 = 0;
size_t consumed = 0;
if (ast_get_encoded_char(args.allowed, &c1, &consumed))
return -1;
args.allowed += consumed;
if (*(args.allowed) == '-') {
if (ast_get_encoded_char(args.allowed + 1, &c2, &consumed))
c2 = c1;
args.allowed += consumed + 1;
if ((unsigned char) c2 < (unsigned char) c1 && !ast_opt_dont_warn) {
ast_log(LOG_WARNING, "Range wrapping in FILTER(%s,%s). This may not be what you want.\n", parse, args.string);
}
/*!\note
* Looks a little strange, until you realize that we can overflow
* the size of a char.
*/
for (ac = (unsigned char) c1; ac != (unsigned char) c2; ac++) {
bitfield[ac / 32] |= 1 << (ac % 32);
}
bitfield[ac / 32] |= 1 << (ac % 32);
ast_debug(4, "c1=%d, c2=%d\n", c1, c2);
} else {
ac = (unsigned char) c1;
ast_debug(4, "c1=%d, consumed=%d, args.allowed=%s\n", c1, (int) consumed, args.allowed - consumed);
bitfield[ac / 32] |= 1 << (ac % 32);
}
}
for (ac = 1; ac != 0; ac++) {
if (bitfield[ac / 32] & (1 << (ac % 32))) {
allowed[allowedlen++] = ac;
}
}
ast_debug(1, "Allowed: %s\n", allowed);
for (; *(args.string) && (buf + len - 1 > outbuf); (args.string)++) {
if (strchr(allowed, *(args.string)))
*outbuf++ = *(args.string);
}
*outbuf = '\0';
return 0;
}
static struct ast_custom_function filter_function = {
.name = "FILTER",
.read = filter,
};
static int replace(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
{
AST_DECLARE_APP_ARGS(args,
AST_APP_ARG(varname);
AST_APP_ARG(find);
AST_APP_ARG(replace);
);
char *strptr, *varsubst;
RAII_VAR(struct ast_str *, str, ast_str_create(16), ast_free);
char find[256]; /* Only 256 characters possible */
char replace[2] = "";
size_t unused;
AST_STANDARD_APP_ARGS(args, data);
if (!str) {
return -1;
}
if (args.argc < 2) {
ast_log(LOG_ERROR, "Usage: %s(<varname>,<search-chars>[,<replace-char>])\n", cmd);
return -1;
}
/* Decode escapes */
ast_get_encoded_str(args.find, find, sizeof(find));
ast_get_encoded_char(args.replace, replace, &unused);
if (ast_strlen_zero(find) || ast_strlen_zero(args.varname)) {
ast_log(LOG_ERROR, "The characters to search for and the variable name must not be empty.\n");
return -1;
}
varsubst = ast_alloca(strlen(args.varname) + 4);
sprintf(varsubst, "${%s}", args.varname);
ast_str_substitute_variables(&str, 0, chan, varsubst);
if (!ast_str_strlen(str)) {
/* Blank, nothing to replace */
return -1;
}
ast_debug(3, "String to search: (%s)\n", ast_str_buffer(str));
ast_debug(3, "Characters to find: (%s)\n", find);
ast_debug(3, "Character to replace with: (%s)\n", replace);
for (strptr = ast_str_buffer(str); *strptr; strptr++) {
/* buf is already a mutable buffer, so we construct the result
* directly there */
if (strchr(find, *strptr)) {
if (ast_strlen_zero(replace)) {
memmove(strptr, strptr + 1, strlen(strptr + 1) + 1);
strptr--;
} else {
/* Replace character */
*strptr = *replace;
}
}
}
ast_str_set(buf, len, "%s", ast_str_buffer(str));
return 0;
}
static struct ast_custom_function replace_function = {
.name = "REPLACE",
.read2 = replace,
};
static int strreplace(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
{
char *varsubstr; /* substring for input var */
char *start; /* Starting pos of substring search. */
char *end; /* Ending pos of substring search. */
int find_size; /* length of given find-string */
unsigned max_matches; /* number of matches we find before terminating search */
unsigned count; /* loop counter */
struct ast_str *str = ast_str_thread_get(&result_buf, 16); /* Holds the data obtained from varname */
AST_DECLARE_APP_ARGS(args,
AST_APP_ARG(varname);
AST_APP_ARG(find_string);
AST_APP_ARG(replace_string);
AST_APP_ARG(max_replacements);
AST_APP_ARG(other); /* Any remining unused arguments */
);
/* Guarantee output string is empty to start with. */
ast_str_reset(*buf);
if (!str) {
/* We failed to allocate str, forget it. We failed. */
return -1;
}
/* Parse the arguments. */
AST_STANDARD_APP_ARGS(args, data);
if (args.argc < 2) {
/* Didn't receive enough arguments to do anything */
ast_log(LOG_ERROR,
"Usage: %s(<varname>,<find-string>[,<replace-string>,[<max-replacements>]])\n",
cmd);
return -1;
}
/* No var name specified. Return failure, string is already empty. */
if (ast_strlen_zero(args.varname)) {
return -1;
}
/* Zero length find strings are a no-no. Kill the function if we run into one. */
if (ast_strlen_zero(args.find_string)) {
ast_log(LOG_ERROR, "No <find-string> specified\n");
return -1;
}
find_size = strlen(args.find_string);
/* set varsubstr to the matching variable */
varsubstr = ast_alloca(strlen(args.varname) + 4);
sprintf(varsubstr, "${%s}", args.varname);
ast_str_substitute_variables(&str, 0, chan, varsubstr);
/* Determine how many replacements are allowed. */
if (!args.max_replacements
|| (max_matches = atoi(args.max_replacements)) <= 0) {
/* Unlimited replacements are allowed. */
max_matches = -1;
}
/* Generate the search and replaced string. */
start = ast_str_buffer(str);
for (count = 0; count < max_matches; ++count) {
end = strstr(start, args.find_string);
if (!end) {
/* Did not find a matching substring in the remainder. */
break;
}
/* Replace the found substring. */
*end = '\0';
ast_str_append(buf, len, "%s", start);
if (args.replace_string) {
/* Append the replacement string */
ast_str_append(buf, len, "%s", args.replace_string);
}
start = end + find_size;
}
ast_str_append(buf, len, "%s", start);
return 0;
}
static struct ast_custom_function strreplace_function = {
.name = "STRREPLACE",
.read2 = strreplace,
};
static int regex(struct ast_channel *chan, const char *cmd, char *parse, char *buf,
size_t len)
{
AST_DECLARE_APP_ARGS(args,
AST_APP_ARG(null);
AST_APP_ARG(reg);
AST_APP_ARG(str);
);
int errcode;
regex_t regexbuf;
buf[0] = '\0';
AST_NONSTANDARD_APP_ARGS(args, parse, '"');
if (args.argc != 3) {
ast_log(LOG_ERROR, "Unexpected arguments: should have been in the form '\"<regex>\" <string>'\n");
return -1;
}
if ((*args.str == ' ') || (*args.str == '\t'))
args.str++;
ast_debug(1, "FUNCTION REGEX (%s)(%s)\n", args.reg, args.str);
if ((errcode = regcomp(®exbuf, args.reg, REG_EXTENDED | REG_NOSUB))) {
regerror(errcode, ®exbuf, buf, len);
ast_log(LOG_WARNING, "Malformed input %s(%s): %s\n", cmd, parse, buf);
return -1;
}
strcpy(buf, regexec(®exbuf, args.str, 0, NULL, 0) ? "0" : "1");
regfree(®exbuf);
return 0;
}
static struct ast_custom_function regex_function = {
.name = "REGEX",
.read = regex,
};
#define HASH_PREFIX "~HASH~%s~"
#define HASH_FORMAT HASH_PREFIX "%s~"
static char *app_clearhash = "ClearHash";
/* This function probably should migrate to main/pbx.c, as pbx_builtin_clearvar_prefix() */
static void clearvar_prefix(struct ast_channel *chan, const char *prefix)
{
struct ast_var_t *var;
int len = strlen(prefix);
AST_LIST_TRAVERSE_SAFE_BEGIN(ast_channel_varshead(chan), var, entries) {