Public Member Functions
def	__init__ (self, line, retry_interval, max_attempts, outbound_proxy)

def	parse (self, line)

def	parse_host_part (self, host_part)

def	parse_user_part (self, user_part)

def	write (self, pjsip, nmapped)

Data Fields
	authuser

	domain

	expiry

	extension

	max_attempts

	outbound_proxy

	peer

	port

	protocol

	retry_interval

	secret

Detailed Description

Class for parsing and storing information in a register line in sip.conf.

Definition at line 945 of file sip_to_pjsip.py.

Constructor & Destructor Documentation

◆ init()

def __init__	(	self,
		line,
		retry_interval,
		max_attempts,
		outbound_proxy
	)

Definition at line 949 of file sip_to_pjsip.py.

     def __init__(self, line, retry_interval, max_attempts, outbound_proxy):
         self.retry_interval = retry_interval
         self.max_attempts = max_attempts
         self.outbound_proxy = outbound_proxy
         self.parse(line)
 

Member Function Documentation

◆ parse()

def parse	(	self,
		line
	)

Initial parsing routine for register lines in sip.conf.

This splits the line into the part before the host, and the part
after the '@' symbol. These two parts are then passed to their
own parsing routines

Definition at line 955 of file sip_to_pjsip.py.

References Registration.parse_host_part(), and Registration.parse_user_part().

     def parse(self, line):
         """
         Initial parsing routine for register lines in sip.conf.
 
         This splits the line into the part before the host, and the part
         after the '@' symbol. These two parts are then passed to their
         own parsing routines
         """
 
         # register =>
         # [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry]
 
         prehost, at, host_part = line.rpartition('@')
         if not prehost:
             raise
 
         self.parse_host_part(host_part)
         self.parse_user_part(prehost)
 

◆ parse_host_part()

def parse_host_part	(	self,
		host_part
	)

Parsing routine for the part after the final '@' in a register line.
The strategy is to use partition calls to peel away the data starting
from the right and working to the left.

Definition at line 974 of file sip_to_pjsip.py.

Referenced by Registration.parse().

     def parse_host_part(self, host_part):
         """
         Parsing routine for the part after the final '@' in a register line.
         The strategy is to use partition calls to peel away the data starting
         from the right and working to the left.
         """
         pre_expiry, sep, expiry = host_part.partition('~')
         pre_extension, sep, self.extension = pre_expiry.partition('/')
         self.host, sep, self.port = pre_extension.partition(':')
 
         self.expiry = expiry if expiry else '120'
 

◆ parse_user_part()

def parse_user_part	(	self,
		user_part
	)

Parsing routine for the part before the final '@' in a register line.
The only mandatory part of this line is the user portion. The strategy
here is to start by using partition calls to remove everything to
the right of the user, then finish by using rpartition calls to remove
everything to the left of the user.

Definition at line 986 of file sip_to_pjsip.py.

Referenced by Registration.parse().

     def parse_user_part(self, user_part):
         """
         Parsing routine for the part before the final '@' in a register line.
         The only mandatory part of this line is the user portion. The strategy
         here is to start by using partition calls to remove everything to
         the right of the user, then finish by using rpartition calls to remove
         everything to the left of the user.
         """
         self.peer = ''
         self.protocol = 'udp'
         protocols = ['udp', 'tcp', 'tls']
         for protocol in protocols:
             position = user_part.find(protocol + '://')
             if -1 < position:
                 post_transport = user_part[position + 6:]
                 self.peer, sep, self.protocol = user_part[:position + 3].rpartition('?')
                 user_part = post_transport
                 break
 
         colons = user_part.count(':')
         if (colons == 3):
             # :domainport:secret:authuser
             pre_auth, sep, port_auth = user_part.partition(':')
             self.domainport, sep, auth = port_auth.partition(':')
             self.secret, sep, self.authuser = auth.partition(':')
         elif (colons == 2):
             # :secret:authuser
             pre_auth, sep, auth = user_part.partition(':')
             self.secret, sep, self.authuser = auth.partition(':')
         elif (colons == 1):
             # :secret
             pre_auth, sep, self.secret = user_part.partition(':')
         elif (colons == 0):
             # No port, secret, or authuser
             pre_auth = user_part
         else:
             # Invalid setting
             raise
 
         self.user, sep, self.domain = pre_auth.partition('@')
 

◆ write()

def write	(	self,
		pjsip,
		nmapped
	)

Write parsed registration data into a section in pjsip.conf

Most of the data in self will get written to a registration section.
However, there will also need to be an auth section created if a
secret or authuser is present.

General mapping of values:
A combination of self.host and self.port is server_uri
A combination of self.user, self.domain, and self.domainport is
  client_uri
self.expiry is expiration
self.extension is contact_user
self.protocol will map to one of the mapped transports
self.secret and self.authuser will result in a new auth section, and
  outbound_auth will point to that section.
XXX self.peer really doesn't map to anything :(

Definition at line 1027 of file sip_to_pjsip.py.

References Registration.authuser, sip_registry.authuser, sip_subscription_mwi.authuser, minivm_account.domain, domain.domain, Registration.domain, sip_pvt.domain, blind_transfer_cb_data.domain, iax2_peer.expiry, chan_iax2_pvt.expiry, Registration.expiry, iax2_dpcache.expiry, sip_pvt.expiry, sip_registry.expiry, gosub_stack_frame.extension, unistim_device.extension, Registration.extension, ast_uri.host, srv_record.host, srv_entry.host, ast_dns_srv_record.host, ast_sip_transport_state.host, acl.host, cops_cmts.host, ast_sip_transport.host, ooh323_pvt.host, chan_iax2_pvt.host, websocket_client.host, Registration.max_attempts, Registration.outbound_proxy, iax_template.port, misdn_stack.port, ooh323_pvt.port, ooh323_peer.port, hold_info.port, misdn_bchannel.port, open_receive_channel_ack_message_ip4.port, open_receive_channel_ack_message_ip6.port, robin_list.port, iax2_registry.port, sip_proxy.port, sip_via.port, Registration.port, parsed_dial_string.port, sms_s.protocol, sip_via.protocol, Registration.protocol, Registration.retry_interval, iax2_user.secret, iax2_peer.secret, iax2_registry.secret, chan_iax2_pvt.secret, sip_auth.secret, Registration.secret, sip_peer.secret, sip_registry.secret, sip_subscription_mwi.secret, create_addr_info.secret, sip_to_pjsip.set_value(), uriparams.user, contact.user, iax_template.user, icalendar_pvt.user, caldav_pvt.user, exchangecal_pvt.user, ast_calendar_tech.user, parking_limits_pvt.user, ewscal_pvt.user, ooh323_pvt.user, sip_outbound_publisher.user, http_route.user, ast_xmpp_client_config.user, confbridge_hook_data.user, and dtmf_menu_hook_pvt.user.

     def write(self, pjsip, nmapped):
         """
         Write parsed registration data into a section in pjsip.conf
 
         Most of the data in self will get written to a registration section.
         However, there will also need to be an auth section created if a
         secret or authuser is present.
 
         General mapping of values:
         A combination of self.host and self.port is server_uri
         A combination of self.user, self.domain, and self.domainport is
           client_uri
         self.expiry is expiration
         self.extension is contact_user
         self.protocol will map to one of the mapped transports
         self.secret and self.authuser will result in a new auth section, and
           outbound_auth will point to that section.
         XXX self.peer really doesn't map to anything :(
         """
 
         section = 'reg_' + self.host
 
         set_value('retry_interval', self.retry_interval, section, pjsip,
                   nmapped, 'registration')
         set_value('max_retries', self.max_attempts, section, pjsip, nmapped,
                   'registration')
         if self.extension:
             set_value('contact_user', self.extension, section, pjsip, nmapped,
                       'registration')
 
         set_value('expiration', self.expiry, section, pjsip, nmapped,
                   'registration')
 
         if self.protocol == 'udp':
             set_value('transport', 'transport-udp', section, pjsip, nmapped,
                       'registration')
         elif self.protocol == 'tcp':
             set_value('transport', 'transport-tcp', section, pjsip, nmapped,
                       'registration')
         elif self.protocol == 'tls':
             set_value('transport', 'transport-tls', section, pjsip, nmapped,
                       'registration')
 
         auth_section = 'auth_reg_' + self.host
 
         if hasattr(self, 'secret') and self.secret:
             set_value('password', self.secret, auth_section, pjsip, nmapped,
                       'auth')
             set_value('username', self.authuser if hasattr(self, 'authuser')
                       else self.user, auth_section, pjsip, nmapped, 'auth')
             set_value('outbound_auth', auth_section, section, pjsip, nmapped,
                       'registration')
 
         client_uri = "sip:%s@" % self.user
         if self.domain:
             client_uri += self.domain
         else:
             client_uri += self.host
 
         if hasattr(self, 'domainport') and self.domainport:
             client_uri += ":" + self.domainport
         elif self.port:
             client_uri += ":" + self.port
 
         set_value('client_uri', client_uri, section, pjsip, nmapped,
                   'registration')
 
         server_uri = "sip:%s" % self.host
         if self.port:
             server_uri += ":" + self.port
 
         set_value('server_uri', server_uri, section, pjsip, nmapped,
                   'registration')
 
         if self.outbound_proxy:
             set_value('outboundproxy', self.outbound_proxy, section, pjsip,
                       nmapped, 'registration')
 
 