opensipscli 0.4.0__tar.gz → 0.4.1__tar.gz

opensipscli-0.4.1/.github/workflows/docker-push-image.yml

@@ -0,0 +1,38 @@
+name: Push OpenSIPS CLI Images in Docker Hub
+
+on:
+  push:
+  repository_dispatch:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v4
+
+    - name: Log in to Docker Hub
+      uses: docker/login-action@v4
+      with:
+        username: ${{ secrets.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_TOKEN }}
+
+    - name: Log in to GitHub Container Registry
+      uses: docker/login-action@v4
+      with:
+        registry: ghcr.io
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Build and push Docker image
+      uses: docker/build-push-action@v7
+      with:
+        context: ./docker/
+        push: true
+        tags: |
+          opensips/opensips-cli:latest
+          ghcr.io/opensips/opensips-cli:latest

{opensipscli-0.4.0 → opensipscli-0.4.1}/.github/workflows/docker-readme.yml

@@ -12,11 +12,11 @@ jobs:
   dockerHubDescription:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
 
 
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v4
+      uses: peter-evans/dockerhub-description@v5
       with:
         username: ${{ secrets.DOCKER_USERNAME }}
         password: ${{ secrets.DOCKER_TOKEN }}

{opensipscli-0.4.0 → opensipscli-0.4.1}/.github/workflows/pypi.yml

@@ -9,9 +9,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: "3.x"
     - name: Install pypa/build
@@ -23,7 +23,7 @@ jobs:
     - name: Build a binary wheel and a source tarball
       run: python3 -m build
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v7
       with:
         name: python-package-distributions
         path: dist/
@@ -43,7 +43,7 @@ jobs:
 
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v8
       with:
         name: python-package-distributions
         path: dist/
@@ -64,7 +64,7 @@ jobs:
 
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v8
       with:
         name: python-package-distributions
         path: dist/

{opensipscli-0.4.0 → opensipscli-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: opensipscli
-Version: 0.4.0
+Version: 0.4.1
 Summary: OpenSIPS Command Line Interface
 Project-URL: Homepage, https://github.com/OpenSIPS/opensips-cli
 Project-URL: Source, https://github.com/OpenSIPS/opensips-cli
@@ -16,7 +16,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
 Requires-Dist: opensips
 Requires-Dist: pymysql
-Requires-Dist: sqlalchemy>=1.3.16
+Requires-Dist: sqlalchemy>=1.3.2
 Description-Content-Type: text/markdown
 
 # OpenSIPS CLI (Command Line Interface)

{opensipscli-0.4.0 → opensipscli-0.4.1}/docs/INSTALLATION.md

@@ -17,8 +17,8 @@ to your system using the instructions provided, then install the
 
 Supported Operating Systems (at the time of writing):
 
-* Debian 8-10
-* Ubuntu 14.04, 16.04, 18.04, 19.04
+* Debian 10-12
+* Ubuntu 18.04, 20.04, 22.04, 24.04
 
 ### RPM packages (.rpm)
 

{opensipscli-0.4.0 → opensipscli-0.4.1}/docs/modules/database.md

@@ -14,7 +14,10 @@ which database to delete.
 parameter the name of the module, as specified in the OpenSIPS scripts
 hierarchy.
 * `migrate` - copy and convert an OpenSIPS database into its next OpenSIPS
-release equivalent
+  release equivalent
+* `pi` - creates a `pi_http` framework from the framework shipped with
+  OpenSIPS, using the configured database URL and modules. An optional output
+  path may be provided.
 
 ## Configuration
 
@@ -90,6 +93,17 @@ opensips-cli -x database add rtpproxy
 ```
 The command above will create the `rtpproxy_sockets` table.
 
+To create a provisioning framework for the configured modules, run:
+
+```
+opensips-cli -x database pi /etc/opensips/pi_framework.xml
+```
+
+The command reuses the framework shipped in the OpenSIPS `pi_http` scripts,
+including its module-specific columns, validations, and commands. When
+`database_modules` is not `ALL`, entries for other modules are removed from
+the generated file.
+
 A drop command will prompt the user whether they really want to drop the
 database or not:
 

{opensipscli-0.4.0 → opensipscli-0.4.1}/opensipscli/db.py

@@ -210,7 +210,16 @@ class osdb(object):
 
 	    # TODO: do this only for SQLAlchemy
         try:
-            self.__engine = sqlalchemy.create_engine(db_url, isolation_level='AUTOCOMMIT')
+            if self.dialect == "sqlite":
+                # SQLite only got the AUTOCOMMIT isolation level in SA 1.3.16;
+                # older versions (EL8 ships 1.3.2) reject it with ArgumentError.
+                # Setting the pysqlite isolation_level to None gives the same
+                # autocommit behaviour on every supported SA version.
+                self.__engine = sqlalchemy.create_engine(
+                        db_url, connect_args={'isolation_level': None})
+            else:
+                self.__engine = sqlalchemy.create_engine(
+                        db_url, isolation_level='AUTOCOMMIT')
 
             logger.debug("connecting to %s", db_url)
             self.__conn = self.__engine.connect()
@@ -477,10 +486,10 @@ class osdb(object):
         if not self.__conn:
             raise osdbError("connection not available")
 
-        where_str = self.get_where(filter_keys)
+        where_str, params = self.get_where(filter_keys)
         statement = "DELETE FROM {}{}".format(table, where_str)
         try:
-            self.__conn.execute(text(statement))
+            self.__conn.execute(text(statement), params)
         except sqlalchemy.exc.SQLAlchemyError as ex:
             logger.error("cannot execute query: {}".format(statement))
             logger.error(ex)
@@ -658,13 +667,13 @@ class osdb(object):
         elif type(fields) != list:
             fields = [ fields ]
 
-        where_str = self.get_where(filter_keys)
+        where_str, params = self.get_where(filter_keys)
         statement = "SELECT {} FROM {}{}".format(
                 ", ".join(fields),
                 table,
                 where_str)
         try:
-            result = self.__conn.execute(text(statement))
+            result = self.__conn.execute(text(statement), params)
         except sqlalchemy.exc.SQLAlchemyError as ex:
             logger.error("cannot execute query: {}".format(statement))
             logger.error(ex)
@@ -679,22 +688,18 @@ class osdb(object):
 
     def get_where(self, filter_keys):
         """
-        construct a sql 'where clause' from given filter keys
-        """
-        if filter_keys:
-            where_str = ""
-            for k, v in filter_keys.items():
-                where_str += " AND {} = ".format(k)
-                if type(v) == int:
-                    where_str += str(v)
-                else:
-                    where_str += "'{}'".format(
-                            v.translate(str.maketrans({'\'': '\\\''})))
-            if where_str != "":
-                where_str = " WHERE " + where_str[5:]
-        else:
-            where_str = ""
-        return where_str
+        construct a sql 'where clause' from given filter keys, along with
+        the parameters to bind to it
+        """
+        if not filter_keys:
+            return "", {}
+
+        where_str = ""
+        params = {}
+        for i, (k, v) in enumerate(filter_keys.items()):
+            where_str += " AND {} = :w{}".format(k, i)
+            params["w{}".format(i)] = v
+        return " WHERE " + where_str[5:], params
 
     def get_role(self, role_name="opensips"):
         """
@@ -781,18 +786,13 @@ class osdb(object):
         if not self.__conn:
             raise osdbError("connection not available")
 
-        values = ""
-        for v in keys.values():
-            values += ", "
-            if type(v) == int:
-                values += str(v)
-            else:
-                values += "'{}'".format(
-                        v.translate(str.maketrans({'\'': '\\\''})))
+        cols = list(keys.keys())
+        params = {"v{}".format(i): keys[k] for i, k in enumerate(cols)}
         statement = "INSERT INTO {} ({}) VALUES ({})".format(
-                table, ", ".join(keys.keys()), values[2:])
+                table, ", ".join(cols),
+                ", ".join(":v{}".format(i) for i in range(len(cols))))
         try:
-            result = self.__conn.execute(text(statement))
+            result = self.__conn.execute(text(statement), params)
         except sqlalchemy.exc.SQLAlchemyError as ex:
             logger.error("cannot execute query: {}".format(statement))
             logger.error(ex)
@@ -874,18 +874,16 @@ class osdb(object):
             raise osdbError("connection not available")
 
         update_str = ""
-        for k, v in update_keys.items():
-            update_str += ", {} = ".format(k)
-            if type(v) == int:
-                update_str += str(v)
-            else:
-                update_str += "'{}'".format(
-                        v.translate(str.maketrans({'\'': '\\\''})))
-        where_str = self.get_where(filter_keys)
+        params = {}
+        for i, (k, v) in enumerate(update_keys.items()):
+            update_str += ", {} = :s{}".format(k, i)
+            params["s{}".format(i)] = v
+        where_str, where_params = self.get_where(filter_keys)
+        params.update(where_params)
         statement = "UPDATE {} SET {}{}".format(table,
                 update_str[2:], where_str)
         try:
-            result = self.__conn.execute(text(statement))
+            result = self.__conn.execute(text(statement), params)
         except sqlalchemy.exc.SQLAlchemyError as ex:
             logger.error("cannot execute query: {}".format(statement))
             logger.error(ex)

{opensipscli-0.4.0 → opensipscli-0.4.1}/opensipscli/modules/database.py

@@ -28,6 +28,7 @@ from opensipscli.db import (
 )
 
 import os, re
+import xml.etree.ElementTree as ET
 from getpass import getpass, getuser
 from collections import OrderedDict
 
@@ -590,7 +591,6 @@ class database(Module):
                 if not text:
                     return mig_flavours
                 ret = [t for t in mig_flavours if t.startswith(text)]
-
             elif arg == 3 or (arg == 4 and line[-1] != ' '):
                 db_source = ['opensips ']
                 if not text:
@@ -602,6 +602,8 @@ class database(Module):
                 if not text:
                     return db_dest
                 ret = [t for t in db_dest if t.startswith(text)]
+        elif command == 'pi':
+            ret = ['pi_framework.xml ']
 
         return ret or ['']
 
@@ -624,6 +626,7 @@ class database(Module):
             'drop',
             'add',
             'migrate',
+            'pi',
             ]
 
     def get_db_url(self, db_name=cfg.get('database_name')):
@@ -722,6 +725,72 @@ class database(Module):
         db.destroy()
         return ret
 
+    def do_pi(self, params=None, modifiers=None):
+        """Generate a pi_http framework from the installed OpenSIPS template."""
+        output = params[0] if params else 'pi_framework.xml'
+        if os.path.isdir(output):
+            output = os.path.join(output, 'pi_framework.xml')
+
+        if not cfg.exists('database_url'):
+            logger.error("database_url must be configured to create a PI framework")
+            return -1
+        schema_path = self.get_schema_path(osdb.get_url_driver(cfg.get('database_url')))
+        if not schema_path:
+            return -1
+
+        template = None
+        for candidate in (
+                os.path.join(schema_path, 'pi_http', 'pi_framework.xml'),
+                os.path.join(schema_path, 'pi', 'pi_framework.xml'),
+                os.path.join(schema_path, 'pi_framework.xml'),
+                os.path.join(os.path.dirname(schema_path), 'pi_http',
+                             'pi_framework.xml')):
+            if os.path.isfile(candidate):
+                template = candidate
+                break
+        if not template:
+            logger.error("cannot find the installed pi_http framework template")
+            return -1
+
+        try:
+            tree = ET.parse(template)
+        except ET.ParseError as ex:
+            logger.error("invalid PI framework template '{}': {}".format(template, ex))
+            return -1
+        root = tree.getroot()
+        db_url = self.get_db_url()
+        if not db_url:
+            logger.error("cannot determine the configured database URL")
+            return -1
+        for node in root.findall('db_url'):
+            node.text = db_url
+
+        configured = cfg.get('database_modules').strip().lower() \
+            if cfg.exists('database_modules') else ' '.join(STANDARD_DB_MODULES)
+        modules = None if configured == 'all' else set(configured.split())
+        if modules is not None:
+            retained = []
+            referenced_tables = set()
+            for mod in list(root.findall('mod')):
+                name = mod.findtext('mod_name', '').strip().lower()
+                if name in modules:
+                    retained.append(mod)
+                    referenced_tables.update(
+                        c.text.strip() for c in mod.findall('.//db_table_id')
+                        if c.text)
+                else:
+                    root.remove(mod)
+            for table in list(root.findall('db_table')):
+                if (table.get('id') not in modules and
+                        table.get('id') not in referenced_tables):
+                    root.remove(table)
+
+        os.makedirs(os.path.dirname(os.path.abspath(output)), exist_ok=True)
+        ET.indent(root, space='\t')
+        tree.write(output, encoding='utf-8', xml_declaration=True)
+        logger.info("PI framework written to '{}' using '{}'".format(output, template))
+        return 0
+
 
     def do_create(self, params=None, modifiers=None):
         """

{opensipscli-0.4.0 → opensipscli-0.4.1}/opensipscli/version.py

@@ -17,6 +17,6 @@
 ## along with this program. If not, see <http://www.gnu.org/licenses/>.
 ##
 
-__version__ = '0.4.0'
+__version__ = '0.4.1'
 
 # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4

{opensipscli-0.4.0 → opensipscli-0.4.1}/packaging/debian/changelog

@@ -1,3 +1,9 @@
+opensips-cli (0.4.1-1) stable; urgency=low
+
+  * New public release.
+
+ -- Stefan Darius <darius.stefan@opensips.org>  Thu, 03 Sep 2026 00:00:00 +0000
+
 opensips-cli (0.4.0-1) stable; urgency=low
 
   * New public release.

{opensipscli-0.4.0 → opensipscli-0.4.1}/packaging/debian/control

@@ -9,7 +9,7 @@ Homepage: https://github.com/OpenSIPS/opensips-cli
 Package: opensips-cli
 Architecture: all
 Multi-Arch: foreign
-Depends: python3, ${misc:Depends}, ${python3:Depends}, python3-sqlalchemy (>= 1.3.16), python3-openssl, python3-pymysql, python3-opensips
+Depends: python3, ${misc:Depends}, ${python3:Depends}, python3-sqlalchemy (>= 1.3.2), python3-openssl, python3-pymysql, python3-opensips
 Description: Interactive command-line tool for OpenSIPS 3.0+
  This package contains the OpenSIPS CLI tool, an interactive command line tool
  that can be used to control and monitor OpenSIPS 3.0+ servers.

{opensipscli-0.4.0 → opensipscli-0.4.1}/packaging/redhat_fedora/opensips-cli.spec

@@ -1,6 +1,6 @@
 Summary:  Interactive command-line tool for OpenSIPS 3.0+
 Name:     opensips-cli
-Version:  0.4.0
+Version:  0.4.1
 Release:  0%{?dist}
 License:  GPL-3+
 Group:    System Environment/Daemons
@@ -18,11 +18,11 @@ AutoReqProv: no
 
 Requires: python3
 %if 0%{?rhel} == 7
-Requires: python36-sqlalchemy >= 1.3.16
+Requires: python36-sqlalchemy >= 1.3.2
 Requires: python36-PyMySQL
 Requires: python36-pyOpenSSL
 %else
-Requires: python3-sqlalchemy >= 1.3.16
+Requires: python3-sqlalchemy >= 1.3.2
 Requires: python3-PyMySQL
 Requires: python3-pyOpenSSL
 %endif
@@ -68,6 +68,8 @@ rm -rf $RPM_BUILD_ROOT
 %license LICENSE
 
 %changelog
+* Thu Sep 3 2026 Stefan Darius <darius.stefan@opensips.org> - 0.4.1-0
+- Bump package version to 0.4.1.
 * Fri May 8 2026 Razvan Crainea <razvan@opensips.org> - 0.4.0-0
 - Bump package version to 0.4.0.
 * Thu Aug 27 2020 Liviu Chircu <liviu@opensips.org> - 0.1-2

{opensipscli-0.4.0 → opensipscli-0.4.1}/pyproject.toml

@@ -18,7 +18,7 @@ maintainers = [
 dependencies = [
     "opensips",
     "PyMySQL",
-    "sqlalchemy>=1.3.16",
+    "sqlalchemy>=1.3.2",
 ]
 classifiers = [
     "Programming Language :: Python :: 3",

{opensipscli-0.4.0 → opensipscli-0.4.1}/setup.py

@@ -47,7 +47,7 @@ setup(
     install_requires=[
         "opensips",
         "PyMySQL",
-        "sqlalchemy>=1.3.16",
+        "sqlalchemy>=1.3.2",
     ],
     classifiers=[
         "Programming Language :: Python :: 3",

opensipscli-0.4.0/.github/workflows/docker-push-image.yml

@@ -1,26 +0,0 @@
-name: Push OpenSIPS CLI Images in Docker Hub
-
-on:
-  push:
-  repository_dispatch:
-  workflow_dispatch:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v3
-
-    - name: Log in to Docker Hub
-      uses: docker/login-action@v2.1.0
-      with:
-        username: ${{ secrets.DOCKER_USERNAME }}
-        password: ${{ secrets.DOCKER_TOKEN }}
-
-    - name: Build and push Docker image
-      uses: docker/build-push-action@v4
-      with:
-        context: ./docker/
-        push: true
-        tags: opensips/opensips-cli:latest