/
textops_admin.xml
536 lines (509 loc) · 14.2 KB
/
textops_admin.xml
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
<!-- Module User's Guide -->
<chapter>
<title>&adminguide;</title>
<section id="overview" xreflabel="Overview">
<title>Overview</title>
<para>
The module implements text based operations over the SIP message
processed by OpenSIPS. SIP is a text based protocol and the module
provides a large set of very useful functions to manipulate the
message at text level, e.g., regular expression search and replace,
Perl-like substitutions, etc.
</para>
<para>
Note: all SIP-aware functions like <emphasis>insert_hf</emphasis>,
<emphasis>append_hf</emphasis> or <emphasis>codec</emphasis>
operations have been moved to the <emphasis>sipmsgops</emphasis>
module.
</para>
<section>
<title>Known Limitations</title>
<para>
search ignores folded lines. For example,
search(<quote>(From|f):.*@foo.bar</quote>)
doesn't match the following From header field:
</para>
<programlisting format="linespecific">
From: medabeda
<sip:medameda@foo.bar>;tag=1234
</programlisting>
</section>
</section>
<section id="dependencies" xreflabel="Dependencies">
<title>Dependencies</title>
<section>
<title>&osips; Modules</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para>
<emphasis>No dependencies on other &osips; modules</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>External Libraries or Applications</title>
<para>
The following libraries or applications must be installed before
running &osips; with this module loaded:
<itemizedlist>
<listitem>
<para>
<emphasis>None</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<section id="exported_functions" xreflabel="exported_functions">
<title>Exported Functions</title>
<section id="func_search" xreflabel="search()">
<title>
<function moreinfo="none">search(re)</function>
</title>
<para>
Searches for the re in the message.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>re</emphasis> - Regular expression.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>search</function> usage</title>
<programlisting format="linespecific">
...
if ( search("[Ss][Ii][Pp]") ) { /*....*/ };
...
</programlisting>
</example>
</section>
<section id="func_search_body" xreflabel="search_body()">
<title>
<function moreinfo="none">search_body(re)</function>
</title>
<para>
Searches for the re in the body of the message.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>re</emphasis> - Regular expression.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>search_body</function> usage</title>
<programlisting format="linespecific">
...
if ( search_body("[Ss][Ii][Pp]") ) { /*....*/ };
...
</programlisting>
</example>
</section>
<section id="func_search_append" xreflabel="search_append()">
<title>
<function moreinfo="none">search_append(re, txt)</function>
</title>
<para>
Searches for the first match of re and appends txt after it.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>re</emphasis> - Regular expression.
</para>
</listitem>
<listitem>
<para><emphasis>txt</emphasis> - String to be appended.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>search_append</function> usage</title>
<programlisting format="linespecific">
...
search_append("[Oo]pen[Ss]er", " SIP Proxy");
...
</programlisting>
</example>
</section>
<section id="func_search_append_body" xreflabel="search_append_body()">
<title>
<function moreinfo="none">search_append_body(re, txt)</function>
</title>
<para>
Searches for the first match of re in the body of the message
and appends txt after it.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>re</emphasis> - Regular expression.
</para>
</listitem>
<listitem>
<para><emphasis>txt</emphasis> - String to be appended.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>search_append_body</function> usage</title>
<programlisting format="linespecific">
...
search_append_body("[Oo]pen[Ss]er", " SIP Proxy");
...
</programlisting>
</example>
</section>
<section id="func_replace" xreflabel="replace()">
<title>
<function moreinfo="none">replace(re, txt)</function>
</title>
<para>
Replaces the first occurrence of re with txt.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>re</emphasis> - Regular expression.
</para>
</listitem>
<listitem>
<para><emphasis>txt</emphasis> - String.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>replace</function> usage</title>
<programlisting format="linespecific">
...
replace("opensips", "Open SIP Server");
...
</programlisting>
</example>
</section>
<section id="func_replace_body" xreflabel="replace_body()">
<title>
<function moreinfo="none">replace_body(re, txt)</function>
</title>
<para>
Replaces the first occurrence of re in the body of the message
with txt.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>re</emphasis> - Regular expression.
</para>
</listitem>
<listitem>
<para><emphasis>txt</emphasis> - String.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>replace_body</function> usage</title>
<programlisting format="linespecific">
...
replace_body("opensips", "Open SIP Server");
...
</programlisting>
</example>
</section>
<section id="func_replace_all" xreflabel="replace_all()">
<title>
<function moreinfo="none">replace_all(re, txt)</function>
</title>
<para>
Replaces all occurrence of re with txt.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>re</emphasis> - Regular expression.
</para>
</listitem>
<listitem>
<para><emphasis>txt</emphasis> - String.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>replace_all</function> usage</title>
<programlisting format="linespecific">
...
replace_all("opensips", "Open SIP Server");
...
</programlisting>
</example>
</section>
<section id="func_replace_body_all" xreflabel="replace_body_all()">
<title>
<function moreinfo="none">replace_body_all(re, txt)</function>
</title>
<para>
Replaces all occurrence of re in the body of the message
with txt. Matching is done on a per-line basis.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>re</emphasis> - Regular expression.
</para>
</listitem>
<listitem>
<para><emphasis>txt</emphasis> - String.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>replace_body_all</function> usage</title>
<programlisting format="linespecific">
...
replace_body_all("opensips", "Open SIP Server");
...
</programlisting>
</example>
</section>
<section id="func_replace_body_atonce" xreflabel="replace_body_atonce()">
<title>
<function moreinfo="none">replace_body_atonce(re, txt)</function>
</title>
<para>
Replaces all occurrence of re in the body of the message
with txt. Matching is done over the whole body.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>re</emphasis> - Regular expression.
</para>
</listitem>
<listitem>
<para><emphasis>txt</emphasis> - String.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>replace_body_atonce</function> usage</title>
<programlisting format="linespecific">
...
# strip the whole body from the message:
if(has_body() && replace_body_atonce("^.+$", ""))
remove_hf("Content-Type");
...
</programlisting>
</example>
</section>
<section id="func_subst" xreflabel="subst()">
<title>
<function moreinfo="none">subst('/re/repl/flags')</function>
</title>
<para>
Replaces re with repl (sed or perl like).
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>'/re/repl/flags'</emphasis> - sed like regular
expression. flags can be a combination of i (case insensitive),
g (global) or s (match newline don't treat it as end of line).
</para>
<para>
're' - is regular expression
</para>
<para>
'repl' - is replacement string - may contain pseudo-variables
</para>
<para>
'flags' - substitution flags (i - ignore case, g - global)
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>subst</function> usage</title>
<programlisting format="linespecific">
...
# replace the uri in to: with the message uri (just an example)
if ( subst('/^To:(.*)sip:[^@]*@[a-zA-Z0-9.]+(.*)$/t:\1\u\2/ig') ) {};
# replace the uri in to: with the value of avp sip_address (just an example)
if ( subst('/^To:(.*)sip:[^@]*@[a-zA-Z0-9.]+(.*)$/t:\1$avp(sip_address)\2/ig') ) {};
...
</programlisting>
</example>
</section>
<section id="func_subst_uri" xreflabel="subst_uri()">
<title>
<function moreinfo="none">subst_uri('/re/repl/flags')</function>
</title>
<para>
Runs the re substitution on the message uri (like subst but works
only on the uri)
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>'/re/repl/flags'</emphasis> - sed like regular
expression. flags can be a combination of i (case insensitive),
g (global) or s (match newline don't treat it as end of line).
</para>
<para>
're' - is regular expression
</para>
<para>
'repl' - is replacement string - may contain pseudo-variables
</para>
<para>
'flags' - substitution flags (i - ignore case, g - global)
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>subst_uri</function> usage</title>
<programlisting format="linespecific">
...
# adds 3463 prefix to numeric uris, and save the original uri (\0 match)
# as a parameter: orig_uri (just an example)
if (subst_uri('/^sip:([0-9]+)@(.*)$/sip:3463\1@\2;orig_uri=\0/i')){$
# adds the avp 'uri_prefix' as prefix to numeric uris, and save the original
# uri (\0 match) as a parameter: orig_uri (just an example)
if (subst_uri('/^sip:([0-9]+)@(.*)$/sip:$avp(uri_prefix)\1@\2;orig_uri=\0/i')){$
...
</programlisting>
</example>
</section>
<section id="func_subst_user" xreflabel="subst_user()">
<title>
<function moreinfo="none">subst_user('/re/repl/flags')</function>
</title>
<para>
Runs the re substitution on the message uri (like subst_uri but works
only on the user portion of the uri)
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>'/re/repl/flags'</emphasis> - sed like regular
expression. flags can be a combination of i (case insensitive),
g (global) or s (match newline don't treat it as end of line).
</para>
<para>
're' - is regular expression
</para>
<para>
'repl' - is replacement string - may contain pseudo-variables
</para>
<para>
'flags' - substitution flags (i - ignore case, g - global)
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>subst</function> usage</title>
<programlisting format="linespecific">
...
# adds 3463 prefix to uris ending with 3642 (just an example)
if (subst_user('/3642$/36423463/')){$
...
# adds avp 'user_prefix' as prefix to username in r-uri ending with 3642
if (subst_user('/(.*)3642$/$avp(user_prefix)\13642/')){$
...
</programlisting>
</example>
</section>
<section id="func_subst_body" xreflabel="subst_body()">
<title>
<function moreinfo="none">subst_body('/re/repl/flags')</function>
</title>
<para>
Replaces re with repl (sed or perl like) in the body of the message.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>'/re/repl/flags'</emphasis> - sed like regular
expression. flags can be a combination of i (case insensitive),
g (global) or s (match newline don't treat it as end of line).
</para>
<para>
're' - is regular expression
</para>
<para>
'repl' - is replacement string - may contain pseudo-variables
</para>
<para>
'flags' - substitution flags (i - ignore case, g - global)
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>subst_body</function> usage</title>
<programlisting format="linespecific">
...
if (subst_body("/^o=([^ ]*) /o=$fU /"))
xlog("successfully prepared an "o" line update!\n");
...
</programlisting>
</example>
</section>
</section>
</chapter>