$Revision: 1.7 $
$Date: 2004/08/24 09:00:40 $
User's Guide
Overview
This is mostly an example module. It implements text based operation (search, replace,
append a.s.o).
Known Limitations
search ignores folded lines. For example, search((From|f):.*@foo.bar
)
doesn't match the following From header field:
From: medabeda
<sip:medameda@foo.bar>;tag=1234
Dependencies
&ser; Modules
The following modules must be loaded before this module:
No dependencies on other &ser; modules.
External Libraries or Applications
The following libraries or applications must be installed before running
&ser; with this module loaded:
None.
Exported Functions
<function moreinfo="none">search(re)</function>
Searches for the re in the message.
Meaning of the parameters is as follows:
re - Regular expression.
<function>search</function> usage
...
if ( search("[Ss][Ee][Rr]" ) { /*....*/ };
...
<function moreinfo="none">search_append(re, txt)</function>
Searches for the first match of re and appends txt after it.
Meaning of the parameters is as follows:
re - Regular expression.
txt - String to be appended.
<function>search_append</function> usage
...
search_append("[Ss]er", " blabla");
...
<function moreinfo="none">replace(re, txt)</function>
Replaces the first occurrence of re with txt.
Meaning of the parameters is as follows:
re - Regular expression.
txt - String.
<function>replace</function> usage
...
replace("ser", "Sip Express Router");
...
<function moreinfo="none">subst('/re/repl/flags')</function>
Replaces re with repl (sed or perl like).
Meaning of the parameters is as follows:
'/re/repl/flags' - 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).
<function>subst</function> usage
...
# 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') ) {};
...
<function moreinfo="none">subst_uri('/re/repl/flags')</function>
Runs the re substitution on the message uri (like subst but works
only on the uri)
Meaning of the parameters is as follows:
'/re/repl/flags' - 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).
<function>subst</function> usage
...
# 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')){$
...
<function moreinfo="none">subst_user('/re/repl/flags')</function>
Runs the re substitution on the message uri (like subst_uri but works
only on the user portion of the uri)
Meaning of the parameters is as follows:
'/re/repl/flags' - 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).
<function>subst</function> usage
...
# adds 3463 prefix to uris ending with 3642 (just an example)
if (subst_user('/3642$/36423463/')){$
...
<function moreinfo="none">append_to_reply(txt)</function>
Append txt to the reply.
Meaning of the parameters is as follows:
txt - String.
<function>append_to_reply</function> usage
...
append_to_reply("Foo: bar\r\n");
...
<function moreinfo="none">append_hf(hf)</function>
Appends txt after the last header field.
Meaning of the parameters is as follows:
hf - Header field to be appended.
<function>append_hf</function> usage
...
append_hf("P-hint: VOICEMAIL\r\n");
...
<function moreinfo="none">append_urihf(prefix, suffix)</function>
Append header field name with original Request-URI in middle.
Meaning of the parameters is as follows:
prefix - string (usually at least header field name).
suffix - string (usually at least line terminator).
<function>append_urihf</function> usage
...
append_urihf("CC-Diversion: ", "\r\n");
...
<function moreinfo="none">is_present_hf(hf_name)</function>
Return true if a header field is present in message.
Takes header field names as is
and doesn't distinguish compact
names.
Meaning of the parameters is as follows:
hf_name - Header field name.
<function>is_present_hf</function> usage
...
if (is_present_hf("From")) log(1, "From HF Present");
...
Known Limitations
Search functions are applied to the original request,
i.e., they ignore all changes resulting from message
processing in SER script.