27ea1cb2858fb86f0a37db5b9660fe74f93f1405
[sip-router] / src / modules / avpops / README
1 AVPops Module
2
3 Ramona-Elena Modroiu
4
5    <ramona@rosdev.ro>
6
7 Edited by
8
9 Ramona-Elena Modroiu
10
11    <ramona@rosdev.ro>
12
13    Copyright © 2004, 2005 Voice Sistem SRL
14      __________________________________________________________________
15
16    Table of Contents
17
18    1. Admin Guide
19
20         1. Overview
21         2. Dependencies
22
23               2.1. Kamailio Modules
24               2.2. External Libraries or Applications
25
26         3. AVP naming format
27         4. Parameters
28
29               4.1. db_url (string)
30               4.2. avp_table (string)
31               4.3. use_domain (integer)
32               4.4. uuid_column (string)
33               4.5. username_column (string)
34               4.6. domain_column (string)
35               4.7. attribute_column (string)
36               4.8. value_column (string)
37               4.9. type_column (string)
38               4.10. db_scheme (string)
39
40         5. Functions
41
42               5.1. avp_db_load(source,name)
43               5.2. avp_db_store(source,name)
44               5.3. avp_db_delete(source,name)
45               5.4. avp_db_query(query[,dest])
46               5.5. avp_delete(name)
47               5.6. avp_pushto(destination,name)
48               5.7. avp_check(name,op_value)
49               5.8. avp_copy(old_name,new_name)
50               5.9. avp_printf(dest, format)
51               5.10. avp_subst(avps, subst)
52               5.11. avp_op(name,op_value)
53               5.12. is_avp_set(name)
54               5.13. avp_print()
55
56    List of Examples
57
58    1.1. AVP naming examples
59    1.2. Set db_url parameter
60    1.3. Set avp_table parameter
61    1.4. Set use_domain parameter
62    1.5. Set uuid_column parameter
63    1.6. Set username_column parameter
64    1.7. Set domain_column parameter
65    1.8. Set attribute_column parameter
66    1.9. Set value_column parameter
67    1.10. Set type_column parameter
68    1.11. Set db_scheme parameter
69    1.12. avp_db_load usage
70    1.13. avp_db_store usage
71    1.14. avp_db_delete usage
72    1.15. avp_db_query usage
73    1.16. avp_delete usage
74    1.17. avp_pushto usage
75    1.18. avp_check usage
76    1.19. avp_copy usage
77    1.20. avp_printf usage
78    1.21. avp_subst usage
79    1.22. avp_op usage
80    1.23. is_avp_set usage
81    1.24. avp_print usage
82
83 Chapter 1. Admin Guide
84
85    Table of Contents
86
87    1. Overview
88    2. Dependencies
89
90         2.1. Kamailio Modules
91         2.2. External Libraries or Applications
92
93    3. AVP naming format
94    4. Parameters
95
96         4.1. db_url (string)
97         4.2. avp_table (string)
98         4.3. use_domain (integer)
99         4.4. uuid_column (string)
100         4.5. username_column (string)
101         4.6. domain_column (string)
102         4.7. attribute_column (string)
103         4.8. value_column (string)
104         4.9. type_column (string)
105         4.10. db_scheme (string)
106
107    5. Functions
108
109         5.1. avp_db_load(source,name)
110         5.2. avp_db_store(source,name)
111         5.3. avp_db_delete(source,name)
112         5.4. avp_db_query(query[,dest])
113         5.5. avp_delete(name)
114         5.6. avp_pushto(destination,name)
115         5.7. avp_check(name,op_value)
116         5.8. avp_copy(old_name,new_name)
117         5.9. avp_printf(dest, format)
118         5.10. avp_subst(avps, subst)
119         5.11. avp_op(name,op_value)
120         5.12. is_avp_set(name)
121         5.13. avp_print()
122
123 1. Overview
124
125    The AVPops (AVP-operations) module implements a set of script functions
126    which allow access and manipulation of user attribute-value pairs
127    (AVPs, preferences) and pseudo-variables. AVPs are a powerful tool for
128    implementing services/preferences per user/domain. With this module,
129    they are usable directly from configuration script.
130
131    The module implement functions for interfacing DB resources
132    (loading/storing/removing), functions for swapping information between
133    AVPs and SIP messages and a function for testing/checking the value of
134    an AVP.
135
136    If you just need a way to execute SQL statements in a Kamailio
137    configuration script, please consider use the sqlops module instead.
138
139    AVPs are persistent per SIP transaction, being available in "route",
140    "branch_route" and "failure_route". A tutorial providing more
141    information (detailed explanations and commented examples) can be found
142    on the SIP-router web site.
143
144 2. Dependencies
145
146    2.1. Kamailio Modules
147    2.2. External Libraries or Applications
148
149 2.1. Kamailio Modules
150
151    The following modules must be loaded before this module:
152      * Optionally a database module
153
154 2.2. External Libraries or Applications
155
156    The following libraries or applications must be installed before
157    running Kamailio with this module loaded:
158      * None
159
160 3. AVP naming format
161
162    The format of the parameters specifying an AVP in functions exported by
163    this module is: $avp(avp_flags:avp_name) or $avp(avp_alias).
164      * avp_flags = type_flags [script_flags]; type_flags = 'I' | 'i' | 'S'
165        | 's'; script_flags = 0..255
166        'I' or 'i' means that the type of avp name is an integer (ID)
167        'S' or 's' means that the type of avp name is string
168        The type flag is mandatory. Please note that the type flag only
169        indicates type of name, not type of variable. An avp with name type
170        "i" may very well contain text strings.
171        script_flags must be an 8 bit unsigned number, therefore can be set
172        up to 8 flags. If no script flag is provided, the name will match
173        all AVPs, regardless they have or not a script flag set (preserves
174        the compatibility with the old naming schema).
175      * avp_name = string | integer
176        string - might be any alphanumeric string, wich contain following
177        characters: [a-z] [A-Z] [0-9] '_'
178        integer - might be an unsigned integer, greater than zero, up to
179        2^16-1
180      * avp_alias = string
181        string - might be any alphanumeric string, wich contain following
182        characters: [a-z] [A-Z] [0-9] '_'
183
184    Example 1.1. AVP naming examples
185 ...
186 $avp(i:11) - the AVP identified by integer 11
187 $avp(s:foo) - the AVP identified by the string 'foo'
188 $avp(bar) - the AVP identified by the AVP alias 'bar'
189 $avp(i3:123) - the AVP identified by the integer 123 which has script flags 1
190     and 2 set
191 ...
192
193 4. Parameters
194
195    4.1. db_url (string)
196    4.2. avp_table (string)
197    4.3. use_domain (integer)
198    4.4. uuid_column (string)
199    4.5. username_column (string)
200    4.6. domain_column (string)
201    4.7. attribute_column (string)
202    4.8. value_column (string)
203    4.9. type_column (string)
204    4.10. db_scheme (string)
205
206 4.1. db_url (string)
207
208    DB URL for database connection.
209
210    This parameter is optional, it's default value being NULL.
211
212    Example 1.2. Set db_url parameter
213 ...
214 modparam("avpops","db_url","mysql://user:passwd@host/database")
215 ...
216
217 4.2. avp_table (string)
218
219    DB table to be used.
220
221    This parameter is optional, it's default value being NULL. But if you
222    specify a db_url, you need also setup this parameter.
223
224    Example 1.3. Set avp_table parameter
225 ...
226 modparam("avpops","avp_table","avptable")
227 ...
228
229 4.3. use_domain (integer)
230
231    If the domain part of the URI should be used for identifying an AVP in
232    DB operations.
233
234    Default value is 0 (no).
235
236    Example 1.4. Set use_domain parameter
237 ...
238 modparam("avpops","use_domain",1)
239 ...
240
241 4.4. uuid_column (string)
242
243    Name of column containing the uuid (unique user id).
244
245    Default value is “uuid”.
246
247    Example 1.5. Set uuid_column parameter
248 ...
249 modparam("avpops","uuid_column","uuid")
250 ...
251
252 4.5. username_column (string)
253
254    Name of column containing the username.
255
256    Default value is “username”.
257
258    Example 1.6. Set username_column parameter
259 ...
260 modparam("avpops","username_column","username")
261 ...
262
263 4.6. domain_column (string)
264
265    Name of column containing the domain name.
266
267    Default value is “domain”.
268
269    Example 1.7. Set domain_column parameter
270 ...
271 modparam("avpops","domain_column","domain")
272 ...
273
274 4.7. attribute_column (string)
275
276    Name of column containing the attribute name (AVP name).
277
278    Default value is “attribute”.
279
280    Example 1.8. Set attribute_column parameter
281 ...
282 modparam("avpops","attribute_column","attribute")
283 ...
284
285 4.8. value_column (string)
286
287    Name of column containing the AVP value.
288
289    Default value is “value”.
290
291    Example 1.9. Set value_column parameter
292 ...
293 modparam("avpops","value_column","value")
294 ...
295
296 4.9. type_column (string)
297
298    Name of integer column containing the AVP type.
299
300    Default value is “type”.
301
302    Possible column values are
303      * 0 - AVP with string name and string value
304      * 1 - AVP with string name and integer value
305      * 2 - AVP with integer name and string value
306      * 3 - AVP with integer name and integer value
307
308    Example 1.10. Set type_column parameter
309 ...
310 modparam("avpops","type_column","type")
311 ...
312
313 4.10. db_scheme (string)
314
315    Definition of a DB scheme to be used for non-standard access to
316    Database information.
317
318    Definition of a DB scheme. Scheme syntax is:
319      * db_scheme = name':'element[';'element]*
320      * element =
321           + 'uuid_col='string
322           + 'username_col='string
323           + 'domain_col='string
324           + 'value_col='string
325           + 'value_type='('integer'|'string')
326           + 'table='string
327
328    Default value is “NULL”.
329
330    Example 1.11. Set db_scheme parameter
331 ...
332 modparam("avpops","db_scheme",
333 "scheme1:table=subscriber;uuid_col=uuid;value_col=first_name")
334 ...
335
336 5. Functions
337
338    5.1. avp_db_load(source,name)
339    5.2. avp_db_store(source,name)
340    5.3. avp_db_delete(source,name)
341    5.4. avp_db_query(query[,dest])
342    5.5. avp_delete(name)
343    5.6. avp_pushto(destination,name)
344    5.7. avp_check(name,op_value)
345    5.8. avp_copy(old_name,new_name)
346    5.9. avp_printf(dest, format)
347    5.10. avp_subst(avps, subst)
348    5.11. avp_op(name,op_value)
349    5.12. is_avp_set(name)
350    5.13. avp_print()
351
352 5.1.  avp_db_load(source,name)
353
354    Loads from DB into memory the AVPs corresponding to the given source.
355    If given, it sets the script flags for loaded AVPs. It returns true if
356    it loaded some values in AVPs, false otherwise (db error, no avp loaded
357    ...).
358
359    Meaning of the parameters is as follows:
360      * source - what info is used for identifying the AVPs. Parameter
361        syntax:
362           + source = (pvar|str_value)
363             ['/'('username'|'domain'|'uri'|'uuid')])
364           + pvar = any pseudo variable defined in Kamailio. If the pvar is
365             $ru (request uri), $fu (from uri), $tu (to uri) or $ou
366             (original uri), then the implicit flag is 'uri'. Otherwise,
367             the implicit flag is 'uuid'.
368      * name - which AVPs will be loaded from DB into memory. Parameter
369        syntax is:
370           + name = avp_spec['/'(table_name|'$'db_scheme)]
371           + avp_spec = matching_flags|$avp(avp_name)|$avp(avp_alias)
372           + matching_flags = 'a' | 'A' | 'i' | 'I' | 's' | 'S'
373             [script_flags]
374             'a' or 'A' means matching any of AVP name types ('i' and 's')
375             (NOTE: matching_flags cannot be used with $db_scheme because
376             the name of AVP to save in cannot be specified), the rest have
377             the meaning descriped in 'AVP naming format' chapter.
378
379    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
380    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
381
382    Example 1.12. avp_db_load usage
383 ...
384 avp_db_load("$fu","$(i:678)");
385 avp_db_load("$ru/domain","i:/domain_preferences");
386 avp_db_load("$uuid","$avp(s:404fwd)/fwd_table");
387 avp_db_load("$ru","$avp(i1:123)/$some_scheme");
388 ...
389
390 5.2.  avp_db_store(source,name)
391
392    Stores to DB the AVPs corresponding to the given source.
393
394    The meaning and usage of the parameters are identical as for
395    avp_db_load(source,name) function. Please refer to its description.
396
397    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
398    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
399
400    Example 1.13. avp_db_store usage
401 ...
402 avp_db_store("$tu","$avp(i:678)");
403 avp_db_store("$ru/username","$avp(email)");
404 ...
405
406 5.3.  avp_db_delete(source,name)
407
408    Deletes from DB the AVPs corresponding to the given source.
409
410    The meaning and usage of the parameters are identical as for
411    avp_db_load(source,name) function. Please refer to its description.
412
413    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
414    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
415
416    Example 1.14. avp_db_delete usage
417 ...
418 avp_db_delete("$tu","$avp(i:678)");
419 avp_db_delete("$ru/username","$avp(email)");
420 avp_db_delete("$uuid","$avp(s:404fwd)/fwd_table");
421 ...
422
423 5.4.  avp_db_query(query[,dest])
424
425    Make a database query and store the result in AVPs. This command is
426    deprecated, please use the more flexible and advanced sqlops module
427    instead.
428
429    The meaning and usage of the parameters:
430      * query - must be a valid SQL query. The parameter can contain
431        pseudo-variables.
432        You must escape any pseudo-variables manually to prevent SQL
433        injection attacks. You can use the existing transformations
434        escape.common and unescape.common to escape and unescape the
435        content of any pseudo-variable. Failing to escape the variables
436        used in the query makes you vulnerable to SQL injection, e.g. make
437        it possible for an outside attacker to alter your database content.
438      * dest - a list with AVP names where to store the result. The format
439        is “$avp(name1);$avp(name2);...”. If this parameter is ommited, the
440        result is stored in “$avp(i:1);$avp(i:2);...”. If the result gives
441        many rows, then multiple AVPs with corresponding name will be
442        added. The value type of the AVP (string or integer) will be
443        derived from the type of the columns. Please note that only this
444        two datatypes are supported, so its not possible for example to
445        return floating point or big integer values this way.
446
447    The function delivers the following return-codes:
448      * -1 - An error occurred while querying the database (e.g. wrong SQL
449        or database error)
450      * 1 - Query was successful
451      * -2 - Query was successful, but no rows where returned.
452
453    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
454    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
455
456    Example 1.15. avp_db_query usage
457 ...
458 avp_db_query("select password, ha1 from subscriber where username='$tu'",
459         "$avp(i:678);$avp(i:679)");
460 avp_db_query("delete from subscriber");
461 ...
462
463 5.5.  avp_delete(name)
464
465    Deletes from memory the AVPs with name or, if empty, all AVPs.
466
467    Meaning of the parameters is as follows:
468      * name - which AVPs will be deleted from memory. Parameter syntax is:
469           + name = (matching_flags|avp_name|avp_alias)['/'flag]
470           + matching_flags = please refer to avp_db_load() function
471           + flag = 'g'|'G' = deletes not only the last value but the
472             complete AVP.
473
474    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
475    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
476
477    Example 1.16. avp_delete usage
478 ...
479 avp_delete("$avp(i:678)/g");
480 avp_delete("$avp(email)");
481 avp_delete("i");
482 avp_delete("a3");
483 ...
484
485 5.6.  avp_pushto(destination,name)
486
487    Pushes the value of AVP(s) into the SIP message.
488
489    Meaning of the parameters is as follows:
490      * destination - as what will be the AVP value pushed into SIP
491        message. Parameter syntax:
492           + destination = '$ru' ['/'('username'|'domain')] | '$du' | '$br'
493           + $ru '['/'('username'|'domain')] - write the AVP in the request
494             URI or in username/domain part of it
495           + $du - write the AVP in 'dst_uri' field
496           + $br - write the AVP directly as a new branch (does not affect
497             RURI)
498      * name - which AVP(s)/pseudo-variable should be pushed into the SIP
499        message. Parameter syntax is:
500           + name = ( avp_name | avp_alias | pvar_name )['/'flags]
501           + flags = 'g' - effective only with AVPs
502
503    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
504    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
505
506    Example 1.17. avp_pushto usage
507 ...
508 avp_pushto("$ru/domain","$fd");
509 avp_pushto("$ru","$avp(i:678)");
510 avp_pushto("$ru/domain","$avp(s:backup_domains)/g");
511 avp_pushto("$du","$avp(i:679)");
512 avp_pushto("$br","$avp(i:680)");
513 ...
514
515 5.7.  avp_check(name,op_value)
516
517    Checks the value of the AVP(s) against an operator and value.
518
519    Meaning of the parameters is as follows:
520      * name - which AVP(s) should be checked. Parameter syntax is:
521           + name = ( pseudo-variable )
522      * op_value - define the operator, the value and flags for checking.
523        Parameter syntax is:
524           + op_value = operator '/' value ['/'flags]
525           + operator = 'eq' | 'ne' | 'lt' | 'le' | 'gt' | 'ge' | 're' |
526             'fm' | 'and' | 'or' | 'xor'
527           + value = pseudo-variable | fix_value
528           + fix_value = 'i:'integer | 's:'string | string
529           + flags = 'g' | 'G' | 'i' | 'I'
530        Operator meaning:
531           + eq - equal
532           + ne - not equal
533           + lt - less than
534           + le - less or equal
535           + gt - greater than
536           + ge - greater or equal
537           + re - regexp (regular exression match)
538           + fm - fast match (see: man fnmatch)
539           + and - bitwise 'and'
540           + or - bitwise 'or'
541           + xor - bitwise 'xor'
542        Integer values can be given in hexadecimal using notation:
543        'i:0xhex_number' (e.g.,: 'i:0xabcd');
544
545    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
546    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
547
548    Example 1.18. avp_check usage
549 ...
550 avp_check("$avp(i:678)", "lt/i:345/g");
551 avp_check("$fd","eq/$td/I");
552 avp_check("$avp(s:foo)","gt/$avp($var(bar))/g");
553 avp_check("$avp(s:foo)","re/sip:.*@bar.net/g");
554 avp_check("$avp(s:foo)","fm/$avp(fm_avp)/g");
555 ...
556
557    NOTE: you can use a xavp variable ($xavp(key1[indx1]=>key2[indx2])) as
558    first or second parameter. If you want to check all the values of the
559    key2 you should use [*] at indx2. The [*] index is not allowed at
560    indx1.
561 ...
562 avp_check("$xavp(op[0]=>lt[0])", "lt/i:345/g");
563 avp_check("$xavp(op=>fd","eq/$td/I");
564 avp_check("$xavp(op[1]=>foo[*])","gt/$avp($var(bar))/g");
565 avp_check("$avp(s:foo)","re/$xavp(op[0]=>re[*]/g");
566 $var(id)=2;
567 avp_check("$xavp(op=>foo[*])","fm/$xavp(op=>fm[$var(id)])/g");
568 ...
569
570 5.8.  avp_copy(old_name,new_name)
571
572    Copy / move an avp under a new name.
573
574    Meaning of the parameters is as follows:
575      * name1 - which AVP(s) should be copied/moved. Parameter syntax is:
576           + name = ( avp_name | avp_alias )
577      * name2 - the new name of the copied/moved AVP(s). Parameter syntax
578        is:
579           + name = ( avp_name | avp_alias ) ['/'flags]
580           + flags = 'g' | 'G' | 'd' | 'D' | 'n' | 'N' | 's' | 'S'
581
582    NOTE: if a list of AVPs is copied/moved (flag g|G), then the order of
583    the values is reversed. Copy/move twice in order to get the same order
584    as in original list.
585
586    This function can be used from ANY_ROUTE.
587
588    Example 1.19. avp_copy usage
589 ...
590 avp_copy("$avp(i:678)", "$avp(s:345)/g");
591 avp_copy("$avp(old)","$avp(new)/gd");
592 ...
593
594 5.9.  avp_printf(dest, format)
595
596    NOTE: since Kamailio 1.3.0 the function has been moved to core and it
597    is an alias to pv_printf().
598
599    Prints the formatted string 'format' in the AVP 'dest'. The 'format'
600    parameter can include any pseudo-variable defined in Kamailio. The list
601    with all pseudo-variables in Kamailio can be found at:
602    http://kamailio.org/dokuwiki/.
603
604    Meaning of the parameters is as follows:
605      * dest - in which AVP should be stored the result. Parameter syntax
606        is:
607           + name = ( avp_name | avp_alias )
608      * format - the formatted string to be printed in 'dest' AVP.
609
610    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
611    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
612
613    Example 1.20. avp_printf usage
614 ...
615 avp_printf("$avp(i:20)", "This is a $rm request with call-id $hdr(call-id)");
616 ...
617
618 5.10.  avp_subst(avps, subst)
619
620    Perl/sed-like subst applied to AVPs having string value.
621
622    Meaning of the parameters is as follows:
623      * avps - source AVP, destination AVP and flags. Parameter syntax is:
624           + avps = src_avp [ '/' dst_avp [ '/' flags ] ]
625           + src_avp = ( avp_name | avp_alias )
626           + dst_avp = ( avp_name | avp_alias ) - if dst_avp is missing
627             then the value of src_avp will be replaced
628           + flags = ( d | D | g | G ) -- (d, D - delete source avp; g, G -
629             apply to all avps matching src_avp name)
630      * subst - perl/sed-like reqular expression. Parameter syntax is:
631           + subst = "/regexp/replacement/flags"
632           + regexp - regular expression
633           + replacement - replacement string, can include pseudo-variables
634             and \1, ..., \9 for matching tokens, \0 for whole matching
635             text
636           + flags = 'g' | 'G' | 'i' | 'i' (g, G - replace all matching
637             tokens; i, I - match ignore case)
638
639    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
640    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
641
642    Example 1.21. avp_subst usage
643 ...
644 # if avp i:678 has a string value in e-mail format, replace the
645 # domain part with the value of domain part from R-URI
646 avp_subst("$avp(i:678)", "/(.*)@(.*)/\1@$rd/");
647
648 # if any avp i:678 has a string value in e-mail format, replace the
649 # domain part with the value of domain part from R-URI
650 # and place the result in avp i:679
651 avp_subst("$avp(i:678)/$avp(i:679)/g", "/(.*)@(.*)/\1@$rd/");
652 ...
653
654    IMPORTANT NOTE: if the replacement string includes src_avp or dst_avp
655    you will get something that you may not expect. In case you have many
656    src_avp and you make the substitution to be applied to all of them,
657    after the first src_avp is processed, it will be added in avp list and
658    next processing will use it.
659
660 5.11.  avp_op(name,op_value)
661
662    Different integer operations with avps.
663
664    Meaning of the parameters is as follows:
665      * name - 'source_avp/destination_avp' - which AVP(s) should be
666        processed and where to store the result. If 'destination_avp' is
667        missing, same name as 'source_avp' is used to store the result.
668        Parameter syntax is:
669           + name = ( source_avp[/destination_avp] )
670             source_avp = ( avp_name | avp_alias )
671             destination_avp = ( avp_name | avp_alias )
672      * op_value - define the operation, the value and flags. Parameter
673        syntax is:
674           + op_value = operator '/' value ['/'flags]
675           + operator = 'add' | 'sub' | 'mul' | 'div' | 'mod' | 'and' |
676             'or' | 'xor' | 'not'
677           + value = pseudo-variable | fix_value
678           + fix_value = 'i:'integer
679           + flags = 'g' | 'G' | 'd' | 'D'
680        Integer values can be given in hexadecimal using notation
681        'i:0xhex_number' (e.g.,: 'i:0xabcd');
682
683    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
684    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
685
686    Example 1.22. avp_op usage
687 ...
688 avp_op("$avp(i:678)", "add/i:345/g");
689 avp_op("$avp(number)","sub/$avp(number2)/d");
690 ...
691
692 5.12.  is_avp_set(name)
693
694    Check if any AVP with name is set.
695
696    Meaning of the parameters is as follows:
697      * name - name of AVP to look for. Parameter syntax is:
698           + name = avp_name|avp_alias [ '/' flags ])
699             flags = ('e'|'s'|'n') - e = empty value; s = value string; n =
700             value number (int)
701
702    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
703    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
704
705    Example 1.23. is_avp_set usage
706 ...
707 if(is_avp_set("$avp(i:678)"))
708     log("AVP with integer id 678 exists\n");
709 ...
710
711 5.13.  avp_print()
712
713    Prints the list with all the AVPs from memory. This is only a
714    helper/debug function.
715
716    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
717    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
718
719    Example 1.24. avp_print usage
720 ...
721 avp_print();
722 ...