>From 37a9106649fd4a051d0ec06ca473fcf1be18c2e1 Mon Sep 17 00:00:00 2001 From: Scott Lawrence Date: Mon, 27 Oct 2008 16:28:48 -0400 Subject: [PATCH] specialize schema for fallbackrules, replace permissions with caller locations --- sipXcommserverLib/meta/urlmap.xsd | 11 +- sipXregistry/doc/fallbackrules.xml | 93 ++++++---- sipXregistry/meta/Makefile.am | 1 + sipXregistry/meta/fallbackrules.xsd.in | 340 ++++++++++++++++++++++++++++++++ sipXregistry/sipxregistry.spec.in | 1 + 5 files changed, 407 insertions(+), 39 deletions(-) create mode 100644 sipXregistry/meta/fallbackrules.xsd.in diff --git a/sipXcommserverLib/meta/urlmap.xsd b/sipXcommserverLib/meta/urlmap.xsd index da488a4..495f5c7 100644 --- a/sipXcommserverLib/meta/urlmap.xsd +++ b/sipXcommserverLib/meta/urlmap.xsd @@ -133,9 +133,14 @@ - Contains a set of match specifiers for the user part of a SIP address - and then other rules to be applied to any address that matches at least - one of the specified user patterns. + Contains a set of match specifiers for the permission tokens that apply to + the destination address as determined by matches in the permissions database. + If there are no permission child elements, then no lookup is performed, and + any transforms within this permissionMatch element are returned. + If there are permission child elements, then any transforms within this + permissionMatch element are returned. + NOTE: if there are permission elements present, but none match, then no + further searches in the urlmap are done. diff --git a/sipXregistry/doc/fallbackrules.xml b/sipXregistry/doc/fallbackrules.xml index a4c0443..12971ed 100644 --- a/sipXregistry/doc/fallbackrules.xml +++ b/sipXregistry/doc/fallbackrules.xml @@ -2,7 +2,7 @@ - + example.edu sipx.example.edu @@ -12,24 +12,28 @@ sos 911 - 9911 - + 9911 + + + boston 911 - pstn-gw.example.edu + pstn-boston-tw.example.edu - - - - - - operator - 100 - + + + + seattle - <sip:{digits}@{mediaserver};voicexml={voicemail}%2Fcgi-bin%2Fvoicemail%2Fmediaserver.cgi%3Faction%3Dautoattendant> + 911 + pstn-seattle-tw.example.edu - + + + + 911 + pstn-gw.example.edu + @@ -37,12 +41,10 @@ 91800xxxxxxx. 1800xxxxxxx. 800xxxxxxx. - - - 800{vdigits} - pstn-gw.example.edu - - + + 800{vdigits} + pstn-gw.example.edu + @@ -51,14 +53,38 @@ 91[2-9]xxxxxxxxx. 1[2-9]xxxxxxxxx. [2-9]xxxxxxxxx. - - Administration - Faculty + + + boston + + {vdigits} + pstn-boston-tw.example.edu + 0.9 + {vdigits} pstn-gw.example.edu + 0.8 - + + + + seattle + + {vdigits} + pstn-seattle-tw.example.edu + 0.9 + + + {vdigits} + pstn-gw.example.edu + 0.8 + + + + {vdigits} + pstn-gw.example.edu + @@ -66,13 +92,10 @@ Do not allow dialing intl numbers with a "9" prefix as this would conflict with the long distance pattern "[2-9]xxxxxxxxx." --> 011x. - - Administration - - 011{vdigits} - pstn-gw.example.edu - - + + 011{vdigits} + pstn-gw.example.edu + @@ -82,11 +105,9 @@ example.org . - - - sbc.example.edu - - + + sbc.example.edu + diff --git a/sipXregistry/meta/Makefile.am b/sipXregistry/meta/Makefile.am index 48fa6ca..cd0a0e9 100644 --- a/sipXregistry/meta/Makefile.am +++ b/sipXregistry/meta/Makefile.am @@ -3,6 +3,7 @@ include $(top_srcdir)/config/subdir.am schemas = \ alias.xsd \ caller-alias.xsd \ + fallbackrules.xsd \ huntgroup.xsd EXTRA_DATA = $(foreach xsd,$(schemas),$(xsd).in) diff --git a/sipXregistry/meta/fallbackrules.xsd.in b/sipXregistry/meta/fallbackrules.xsd.in new file mode 100644 index 0000000..fced201 --- /dev/null +++ b/sipXregistry/meta/fallbackrules.xsd.in @@ -0,0 +1,340 @@ + + + + + + Rules for mapping SIP addresses in fallbackrules.xml + + + + + + + + + + A container for a set of rules + + + + + + + + + + + + + Contains a set of match specifiers for the host part of a SIP address + and then other rules to be applied to any address that matches at least + one of the specified hostPattern elements. + + + + + + + + + + + + + + + The header format names valid in a format attribute. + + + + + + + + + + + + + One of three types of patterns: + + format='url' (default) + A 'hostport' (RFC 3261, sec. 25.1: 'hostport = host [ ":" port ]') + where the host and port must match exactly (except in case) + and the port 5060 matches an unspecified value. + + format='DnsWildcard' + A "wildcard" DNS Domain whose leftmost label is '*'. + The asterisk ('*') in the pattern matches any sequence of DNS + name tokens and dots. The pattern must match the full domain + value from the request URI. No port may be specified, and port + is not considered in the match. + + Examples: + *.example.com (matches any subdomain in example.com INCLUDING + example.com itself) + * (matches all domains) + + format='IPv4subnet' + An IPv4 subnet, specified as a series of IPv4 address decimal + octet values separated by dots (.), followed by a forward slash + (/) and a decimal number of bits to be used as a subnet mask value. + In order to match, the request URI "host" must be a valid IPv4 + dotted quad address whose value is within the subnet specified. + No port may be specified, and port is not considered in the match. + + Examples: + 10.0.0.0/8 Matches any IP address with first 8 bits = '10' + 192.168/16 + + + + + + + + + + + + + + + Contains a set of match specifiers for the user part of a SIP address + and then other rules to be applied to any address that matches at least + one of the specified userPattern specifiers. + If there are any callerLocationMatch specifiers, and the callerLocation + for any of those specifiers matches, then only any transform elements + within the first matching callerLocationMatch are returned. + If there are no callerLocationMatch specifiers, or none that are present + contain matching callerLocation elements, then any transform elements that + are the immediate children of the userMatch element are returned. + + + + + + + + + + + + + + + + A pattern expression used to match the user part of a SIP URL. + The pattern is implicitly anchored at both ends. + + + + + + + + Contains a set of match specifiers for the callerLocation of the + caller, which is passed indepent of the message to the fallbackrules + redirector. If any callerLocation matches, then only the transforms within + this callerLocationMatch element are applied. + + + + + + + + + + + + + + + A token string compared against that passed to the fallbackrules redirector for the call. + + + + + + + + Contains the rules for the output address. + + + + + + + + This specifies the complete Contact address. + + + + + + + These elements allow substitution of or addition to the existing address. + Any parts not explicitly specified are copied from the input address. + + + + + + + + + + + + + + + + The complete output SIP URL. + The value is subject to symbol token substitution; certain tokens in + the value are replaced with either configuration values or values from + the request URI being transformed. + + Configuration tokens - the values for these are taken from system + configuration variables (see sipXregistry/registrar-config): + {localhost} + + Request Uri tokens - values are taken from the request URI being transformed: + {user} or {digits} - the userinfo + {user-escaped} - the userinfo, with HTTP escaping + {digits-escaped} - the userinfo, with HTTP escaping + {host} - the host (and port, if any) + {headerparams} - all headerparams + {urlparams} - all urlparams + {uri} - the entire uri value + + {vdigits} - the part of the userinfo that matched a variable + portion of a pattern rule. + {vdigits-escaped} - vdigits, with HTTP escaping + + + + + + + + The user portion of the output SIP URL. + The value is subject to symbol token substitution (see the 'url' element). + + + + + + + + The host portion of the output SIP URL. + The value is subject to symbol token substitution (see the 'url' element). + + + + + + + + Provides a name and value for a URL attribute modifier (a urlparams, + fieldparams, or headerparams element). (In RFC 3261 section 25.1 + terminology, 'uri-parameter', 'header', or 'contact-params'[='generic-param'].) + + There are two syntaxes supported; they are distinguished by whether + or not there is a 'name' attribute on the modifier element (see below). + + In either form, the name and value are given in XML content as + their underlying character strings, not using SIP escaping as they would + appear in the URI -- escaping is the responsibility of the URL mapping + processor. (Of course, XML's escaping applies, as it is un-done before + the URL mapping processor sees the content.) + + The value may contain URL mapping substitutions of the format '{keyword}' + for specific keywords. These are substituted before the value is escaped + for insertion into the URI. (There is no escape mechanism for inserting + what appears to be a URL mapping substitution literally into the value.) + + In the preferred syntax, a 'name' attribute specifies the modifier name + and the element content is the value. For example: + value + ]]> + specifies the parameter "bar=value". + + For backward compatibility, an older form is also allowed in which the + modifier name and value are both provided in the element content, separated + by an equals sign: + bar=value + ]]> + The parameter name is separated from the parameter value by the + first '=' in the string. Note that the parameter name may not + contain '=', although the parameter value may. RFC 3261 allows URI + parameter names and header parameter names to contain '=' (which would + have to be escaped). There is no reason to believe that that will ever + be used in practice (since it would probably break many parsers), but + the preferred syntax handles it more smoothly anyway. + + In either form, the parameter value part may be empty. + + The value is subject to symbol token substitution (see the 'url' element). + + + + + + + + + + + + + A field parameter to be set on the output SIP URL. + See documentation of attributeModifier. + + The value is subject to symbol token substitution (see the 'url' element). + + + + + + + + A header parameter to be set on the output SIP URL. + See documentation of attributeModifier. + + The value is subject to symbol token substitution (see the 'url' element). + + + + + + + + A URL parameter to be set on the output SIP URL. + See documentation of attributeModifier. + + The value is subject to symbol token substitution (see the 'url' element). + + + + + + + + Used to describe the rule in the user interface. + + + + + + diff --git a/sipXregistry/sipxregistry.spec.in b/sipXregistry/sipxregistry.spec.in index c2f11e7..fbdcf4c 100644 --- a/sipXregistry/sipxregistry.spec.in +++ b/sipXregistry/sipxregistry.spec.in @@ -96,6 +96,7 @@ rm -rf $RPM_BUILD_ROOT %attr(755,root,root) %{_libdir}/libRedirectorTimeOfDay.so* %attr(755,root,root) %{_datadir}/sipxecs/schema/alias.xsd %attr(755,root,root) %{_datadir}/sipxecs/schema/caller-alias.xsd +%attr(755,root,root) %{_datadir}/sipxecs/schema/fallbackrules.xsd %attr(755,root,root) %{_datadir}/sipxecs/schema/huntgroup.xsd %files devel -- 1.5.4.3