sippy 2.2.1__tar.gz → 2.2.3__tar.gz

sippy-2.2.3/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include requirements.txt
+include sippy/dictionary
+recursive-include sippy/UI/static *

{sippy-2.2.1/sippy.egg-info → sippy-2.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sippy
-Version: 2.2.1
+Version: 2.2.3
 Summary: RFC3261 SIP Stack and Back-to-Back User Agent (B2BUA)
 Home-page: http://www.b2bua.org/
 Author: Sippy Software, Inc.

{sippy-2.2.1 → sippy-2.2.3}/setup.py

@@ -8,13 +8,11 @@ with open("README.md", "r") as fh:
 
 setup(
     name = "sippy",
-    version = "2.2.1",
+    version = "2.2.3",
     packages = find_packages(),
 
     install_requires = requirements,
-    package_data = {
-        '': ['dictionary', '*.md']
-        },
+    include_package_data=True,
     test_suite = 'tests',
 
     entry_points = {

sippy-2.2.1/sippy/B2BRoute.py → sippy-2.2.3/sippy/B2B/Route.py

@@ -26,7 +26,7 @@
 
 from sippy.SipHeader import SipHeader
 from sippy.SipConf import SipConf
-from sippy.B2BTransforms import getTransProc
+from sippy.B2B.Transforms import getTransProc
 
 try:
     from urllib import unquote

sippy-2.2.3/sippy/B2B/SimpleAPI.py

@@ -0,0 +1,142 @@
+# Copyright (c) 2003-2005 Maxim Sobolev. All rights reserved.
+# Copyright (c) 2006-2025 Sippy Software, Inc. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation and/or
+# other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from ..CLIManager import CLIConnectionManager, CLIManager
+from ..Time.MonoTime import MonoTime
+from .States import CCStateConnected, CCStateARComplete
+
+class B2BSimpleAPI(CLIConnectionManager):
+    global_config = None
+
+    def __init__(self, global_config):
+        cmdfile = global_config['b2bua_socket']
+        self.global_config = global_config
+        if cmdfile.startswith('tcp:'):
+            parts = cmdfile[4:].split(':', 1)
+            if len(parts) == 1:
+                address = (parts[0], 12345)
+            else:
+                address = (parts[0], int(parts[1]))
+            super().__init__(self.recvCommand, address, tcp = True)
+        else:
+            if cmdfile.startswith('unix:'):
+                cmdfile = cmdfile[5:]
+            super().__init__(self.recvCommand, cmdfile)
+
+    def recvCommand(self, clim, cmd):
+        ccm = self.global_config['_cmap']
+        args = cmd.split()
+        cmd = args.pop(0).lower()
+        if cmd == 'q':
+            clim.close()
+            return False
+        if cmd == 'l':
+            res = 'In-memory calls:\n'
+            total = 0
+            for (cid, sname), uaast, uaost in ccm.listActiveCalls():
+                res += f'{cid}: {sname} ('
+                if uaast is not None:
+                    _s, _t, _h, _p, _cld, _cli = uaast
+                    res += f'{_s} {_t}:{_h}:{_p} {_cld} {_cli} -> '
+                else:
+                    res += 'N/A -> '
+                if uaost is not None:
+                    _s, _t, _h, _p, _cld, _cli = uaost
+                    res += f'{_s} {_t}:{_h}:{_p} {_cld} {_cli})\n'
+                else:
+                    res += 'N/A)\n'
+                total += 1
+            res += 'Total: %d\n' % total
+            clim.send(res)
+            return False
+        if cmd == 'lt':
+            res = 'In-memory server transactions:\n'
+            for tid, t in self.global_config['_sip_tm'].tserver.iteritems():
+                res += '%s %s %s\n' % (tid, t.method, t.state)
+            res += 'In-memory client transactions:\n'
+            for tid, t in self.global_config['_sip_tm'].tclient.iteritems():
+                res += '%s %s %s\n' % (tid, t.method, t.state)
+            clim.send(res)
+            return False
+        if cmd in ('lt', 'llt'):
+            if cmd == 'llt':
+                mindur = 60.0
+            else:
+                mindur = 0.0
+            ctime = MonoTime()
+            res = 'In-memory server transactions:\n'
+            for tid, t in self.global_config['_sip_tm'].tserver.iteritems():
+                duration = ctime - t.rtime
+                if duration < mindur:
+                    continue
+                res += '%s %s %s %s\n' % (tid, t.method, t.state, duration)
+            res += 'In-memory client transactions:\n'
+            for tid, t in self.global_config['_sip_tm'].tclient.iteritems():
+                duration = ctime - t.rtime
+                if duration < mindur:
+                    continue
+                res += '%s %s %s %s\n' % (tid, t.method, t.state, duration)
+            clim.send(res)
+            return False
+        if cmd == 'd':
+            if len(args) != 1:
+                clim.send('ERROR: syntax error: d <call-id>\n')
+                return False
+            if args[0] == '*':
+                self.discAll()
+                clim.send('OK\n')
+                return False
+            dlist = [x for x in ccm.ccmap if str(x.cId) == args[0]]
+            if len(dlist) == 0:
+                clim.send('ERROR: no call with id of %s has been found\n' % args[0])
+                return False
+            for cc in dlist:
+                cc.disconnect()
+            clim.send('OK\n')
+            return False
+        if cmd == 'r':
+            if len(args) != 1:
+                clim.send('ERROR: syntax error: r [<id>]\n')
+                return False
+            idx = int(args[0])
+            dlist = [x for x in ccm.ccmap if x.id == idx]
+            if len(dlist) == 0:
+                clim.send('ERROR: no call with id of %d has been found\n' % idx)
+                return False
+            for cc in dlist:
+                if not cc.proxied:
+                    continue
+                if cc.state == CCStateConnected:
+                    cc.disconnect(MonoTime().getOffsetCopy(-60), origin = 'media_timeout')
+                    continue
+                if cc.state == CCStateARComplete:
+                    cc.uaO.disconnect(MonoTime().getOffsetCopy(-60), origin = 'media_timeout')
+                    continue
+            clim.send('OK\n')
+            return False
+        clim.send('ERROR: unknown command\n')
+        return False
+
+    def set_rtp_io_socket(self, rtpp_nsock, rtpp_nsock_spec):
+        CLIManager(rtpp_nsock, self.recvCommand)

sippy-2.2.3/sippy/B2B/States.py

@@ -0,0 +1,36 @@
+# Copyright (c) 2003-2005 Maxim Sobolev. All rights reserved.
+# Copyright (c) 2006-2025 Sippy Software, Inc. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation and/or
+# other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+class CCStateIdle(object):
+    sname = 'Idle'
+class CCStateWaitRoute(object):
+    sname = 'WaitRoute'
+class CCStateARComplete(object):
+    sname = 'ARComplete'
+class CCStateConnected(object):
+    sname = 'Connected'
+class CCStateDead(object):
+    sname = 'Dead'
+class CCStateDisconnecting(object):
+    sname = 'Disconnecting'

{sippy-2.2.1 → sippy-2.2.3}/sippy/CLIManager.py

@@ -27,7 +27,7 @@
 
 from __future__ import print_function
 
-from os import remove, chown, chmod
+from os import remove, chown, chmod, pipe, read, write, close
 import socket
 from errno import EPIPE, ENOTCONN, EBADF, ECONNABORTED
 from select import poll, POLLIN, POLLNVAL
@@ -48,19 +48,30 @@ class _Acceptor(Thread):
     pollobj = None
     fileno = None
 
-    def __init__(self, clicm):
+    def __init__(self, clicm, wakeup_r):
         Thread.__init__(self)
         self.clicm = clicm
         self.pollobj = poll()
         self.fileno = self.clicm.serversock.fileno()
+        self.wakeup_r = wakeup_r
         self.pollobj.register(self.fileno, POLLIN)
+        self.pollobj.register(self.wakeup_r, POLLIN)
         self.start()
 
     def run(self):
         #print(self.run, 'enter')
         while True:
             #print(self.run, 'cycle')
-            pollret = dict(self.pollobj.poll()).get(self.fileno, 0)
+            revents = dict(self.pollobj.poll())
+            if self.wakeup_r in revents and (revents[self.wakeup_r] & POLLIN):
+                try:
+                    # drain the pipe (best-effort)
+                    read(self.wakeup_r, 1024)
+                except OSError:
+                    dump_exception('CLIConnectionManager: unhandled exception draining wakeup socket')
+                    pass
+                break
+            pollret = revents.get(self.fileno, 0)
             if pollret & POLLNVAL != 0:
                 break
             if pollret & POLLIN == 0:
@@ -74,16 +85,18 @@ class _Acceptor(Thread):
                     break
                 else:
                     raise
-            except Exception as e:
-                dump_exception('CLIConnectionManager: unhandled exception when accepting incoming connection')
+            except Exception:
+                dump_exception('CLIConnectionManager: unhandled exception accepting incoming connection')
                 break
             #print(self.run, 'handle_accept')
             ED2.callFromThread(self.clicm.handle_accept, clientsock, addr)
         self.clicm = None
+        close(self.wakeup_r)
         #print(self.run, 'exit')
 
 class CLIConnectionManager(object):
     command_cb = None
+    address = None
     tcp = False
     accept_list: list = None
     serversock = None
@@ -116,7 +129,9 @@ class CLIConnectionManager(object):
             if sock_mode != None:
                 chmod(address, sock_mode)
         self.serversock.listen(backlog)
-        self.atr = _Acceptor(self)
+        wakeup_r, self._wakeup_w = pipe()
+        self.atr = _Acceptor(self, wakeup_r)
+        self.address = address
 
     def handle_accept(self, conn, address):
         #print(self.handle_accept)
@@ -125,16 +140,24 @@ class CLIConnectionManager(object):
                 conn.close()
                 return
         try:
-            cm = CLIManager(conn, self.command_cb, address)
-        except Exception as e:
-            dump_exception('CLIConnectionManager: unhandled exception when setting up incoming connection handler')
+            cm = CLIManager(conn, self.command_cb)
+        except Exception:
+            dump_exception('CLIConnectionManager: unhandled exception setting up incoming connection handler')
             conn.close()
             return
 
     def shutdown(self):
+        try:
+            write(self._wakeup_w, b'\x01')
+        except OSError:
+            dump_exception('CLIConnectionManager: unhandled exception waking up acceptor')
+            pass
+        close(self._wakeup_w)
         self.serversock.close()
         self.command_cb = None
         self.atr.join()
+        if not self.tcp:
+            remove(self.address)
 
 class _CLIManager_w(Thread):
     daemon = True
@@ -174,6 +197,11 @@ class _CLIManager_w(Thread):
                 except BrokenPipeError:
                     self.clim = None
                     return
+                except socket.error as why:
+                    if why.errno != EBADF:
+                        raise
+                    self.clim = None
+                    return
                 if res == len(wbuffer):
                     break
                 if res > 0:
@@ -239,14 +267,12 @@ class CLIManager(object):
     clientsock = None
     command_cb = None
     close_pendind = False
-    raddr = None
     wthr = None
     rthr = None
 
-    def __init__(self, clientsock, command_cb, raddr):
+    def __init__(self, clientsock, command_cb):
         self.clientsock = clientsock
         self.command_cb = command_cb
-        self.raddr = raddr
         self.wthr = _CLIManager_w(clientsock, self)
         self.rthr = _CLIManager_r(clientsock, self)
 
@@ -254,7 +280,7 @@ class CLIManager(object):
         try:
             self.command_cb(self, cmd)
         except:
-            dump_exception('CLIManager: unhandled exception when processing incoming data')
+            dump_exception('CLIManager: unhandled exception processing incoming data')
             self.close()
 
     def send(self, data):

{sippy-2.2.1 → sippy-2.2.3}/sippy/Core/EventDispatcher.py

@@ -29,12 +29,13 @@ from __future__ import print_function
 from functools import partial
 from datetime import datetime
 from heapq import heappush, heappop, heapify
-from threading import Lock
+from threading import Lock, local as t_local
 from random import random
 import sys, traceback, signal
 from _thread import get_ident
 from sippy.Time.MonoTime import MonoTime
 from sippy.Core.Exceptions import dump_exception, StdException
+from queue import Queue
 
 from elperiodic.ElPeriodic import ElPeriodic
 
@@ -123,6 +124,8 @@ class EventDispatcher2(Singleton):
     ed_inum = 0
     elp = None
     bands = None
+    _exception = None
+    tloc_data = None
 
     def __init__(self, freq = 100.0):
         EventDispatcher2.state_lock.acquire()
@@ -140,6 +143,7 @@ class EventDispatcher2(Singleton):
         self.elp = ElPeriodic(freq)
         self.elp.CFT_enable(signal.SIGURG)
         self.bands = [(freq, 0),]
+        self.tloc_data = t_local()
 
     def signal(self, signum, frame):
         self.signals_pending.append(signum)
@@ -233,16 +237,35 @@ class EventDispatcher2(Singleton):
     def dispatchThreadCallback(self, thread_cb, cb_params):
         try:
             thread_cb(*cb_params)
-        except Exception as ex:
-            if isinstance(ex, SystemExit):
-                raise
+        except BaseException as ex:
+            if isinstance(ex, (SystemExit, KeyboardInterrupt)):
+                self._exception = ex
+                return
             dump_exception('EventDispatcher2: unhandled exception when processing from-thread-call')
-        #print('dispatchThreadCallback dispatched', thread_cb, cb_params)
+
+    def dispatchThreadCallbackSync(self, res_cb_q, thread_cb, cb_params):
+        try:
+            res = thread_cb(*cb_params)
+        except BaseException as ex:
+            rval = (None, ex)
+        else:
+            rval = (res, None)
+        res_cb_q.put(rval)
 
     def callFromThread(self, thread_cb, *cb_params):
         self.elp.call_from_thread(self.dispatchThreadCallback, thread_cb, cb_params)
         #print('EventDispatcher2.callFromThread completed', str(self), thread_cb, cb_params)
 
+    def callFromThreadSync(self, thread_cb, *cb_params):
+        if not hasattr(self.tloc_data, 'res_cb_q'):
+            self.tloc_data.res_cb_q = Queue()
+        res_cb_q = self.tloc_data.res_cb_q
+        self.elp.call_from_thread(self.dispatchThreadCallbackSync, res_cb_q, thread_cb, cb_params)
+        res, ex = res_cb_q.get()
+        if ex is not None:
+            raise ex
+        return res
+
     def loop(self, timeout = None, freq = None):
         if freq != None and self.bands[0][0] != freq:
             for fb in self.bands:
@@ -274,6 +297,10 @@ class EventDispatcher2(Singleton):
                 break
             self.elp.procrastinate()
             self.last_ts = MonoTime()
+            if self._exception is not None:
+                ex = self._exception
+                self._exception = None
+                raise ex
         return self.el_rval
 
     def breakLoop(self, rval=0):

{sippy-2.2.1 → sippy-2.2.3}/sippy/MsgBody.py

@@ -47,6 +47,7 @@ class MsgBody(object):
         if content != None:
             self.mtype = mtype
             self.content = content
+            self.parsed = type(content) not in str_types
             return
         if cself is not None:
             if type(cself.content) in str_types:

{sippy-2.2.1 → sippy-2.2.3}/sippy/MultipartMixBody.py

@@ -23,14 +23,22 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+from secrets import token_hex
+
 from sippy.SipHeader import SipHeader
+from sippy.SipContentType import SipContentType
 
 class MultipartMixBody():
     parts = None
     boundary = None
+    mtype = SipContentType('multipart/mixed')
+    mtype.parse()
 
     def __init__(self, body = None, ctype = None):
+        self.parts = []
+        self.part_headers = []
         if body is None:
+            self.setBoundary(token_hex(16))
             return
         sep = f'--{ctype.params["boundary"]}'
         bparts = body.split(sep)
@@ -38,8 +46,6 @@ class MultipartMixBody():
         assert len(bparts[0]) == 0
         assert bparts[-1].strip() == '--'
         parts = [p.lstrip() for p in bparts[1:-1]]
-        self.parts = []
-        self.part_headers = []
         for sect in parts:
             headers = []
             ct = None
@@ -55,18 +61,24 @@ class MultipartMixBody():
             sect = MsgBody(sect, ct)
             self.parts.append(sect)
             self.part_headers.append(headers)
-        self.boundary = ctype.params["boundary"]
+        self.setBoundary(ctype.params["boundary"])
+
+    def setBoundary(self, bnd):
+        self.boundary = bnd
+        mtype = self.mtype.getCopy()
+        mtype.params["boundary"] = bnd
+        self.mtype = mtype
 
     def __str__(self):
         bnd = f'--{self.boundary}\r\n'
-        parts = [f'{bnd}Content-Type: {p.mtype}\r\n{p}' for p in self.parts]
+        parts = [f'{bnd}Content-Type: {p.mtype}\r\n\r\n{p}' for p in self.parts]
         s = ''.join(parts)
         s += f'{bnd[:-2]}--\r\n'
         return s
 
     def localStr(self, local_addr = None):
         bnd = f'--{self.boundary}\r\n'
-        parts = [f'{bnd}Content-Type: {p.mtype}\r\n{p.localStr(local_addr)}'
+        parts = [f'{bnd}Content-Type: {p.mtype}\r\n\r\n{p.localStr(local_addr)}'
                  for p in self.parts]
         s = ''.join(parts)
         s += f'{bnd[:-2]}--\r\n'
@@ -78,5 +90,8 @@ class MultipartMixBody():
         cself.boundary = self.boundary
         return cself
 
+    def getContentType(self):
+        return self.mtype.getCopy()
+
 if 'MsgBody' not in globals():
     from sippy.MsgBody import MsgBody

{sippy-2.2.1 → sippy-2.2.3}/sippy/MyConfigParser.py

@@ -33,7 +33,7 @@ except ImportError:
     from configparser import RawConfigParser
     _boolean_states = RawConfigParser.BOOLEAN_STATES
 from sippy.SipConf import SipConf
-from sippy.B2BTransforms import getTransProc
+from sippy.B2B.Transforms import getTransProc
 
 SUPPORTED_OPTIONS = { \
  'acct_enable':       ('B', 'enable or disable Radius accounting'), \