socketmap-sql 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

{socketmap_sql-0.1.0.dist-info → socketmap_sql-0.2.1.dist-info}/METADATA

@@ -1,36 +1,41 @@
-Metadata-Version: 2.0
+Metadata-Version: 2.4
 Name: socketmap-sql
-Version: 0.1.0
-Summary: A socketmap script for SQL databases
-Home-page: https://github.com/kgaughan/socketmap-sql/
-Author: Keith Gaughan
-Author-email: k@stereochro.me
-License: MIT
-Platform: UNKNOWN
+Version: 0.2.1
+Summary: An implementation of the sendmail socketmap protocol to allow an SQL database
+Author-email: Keith Gaughan <k@stereochro.me>
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+License-Expression: MIT
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: POSIX
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Communications :: Email :: Mail Transport Agents
 Classifier: Topic :: Database
+License-File: LICENSE
+Project-URL: Source, https://github.com/kgaughan/socketmap-sql
 
 =============
 socketmap-sql
 =============
 
-A socketmap script for interfacing with an SQL database.
+A socketmap_ script for interfacing with an SQL database.
+
+.. _socketmap: http://www.postfix.org/socketmap_table.5.html
 
 Why?
 ====
 
-I have a number of FreeBSD servers, with one intended to act as my primary
+I have a number of FreeBSD_ servers, with one intended to act as my primary
 mailserver (the current one and remaining one becoming secondary mailservers).
-The problem is that I'm using postfix, and trying very hard to stick to
-precompiled packages rather than using ports, and postfix on FreeBSD lacks
+The problem is that I'm using Postfix_, and trying very hard to stick to
+precompiled packages rather than using ports, and Postfix on FreeBSD lacks
 bindings to databases. In my case, I wanted to be able to use an SQL database.
 
+.. _FreeBSD: https://www.freebsd.org/
+.. _Postfix: http://www.postfix.org/
+
 Configuration format
 ====================
 
@@ -47,7 +52,7 @@ function.
     driver = sqlite3
     database = /path/to/sqlite.db
 
-Other sections start wth ``table:``, and denote virtual tables to be queried.
+Other sections start with ``table:``, and denote virtual tables to be queried.
 There are two fields: *transform* (optional) and *query* (required).
 
 The *transform* field gives the name of a transformation to apply to the query
@@ -88,9 +93,7 @@ following to ``master.cf``::
 Compatibility
 =============
 
-The script only works on Python 3.3+, though it can be made to work on Python
-2.7 with some moderate patching.
+The script only works on Python 3.8+.
 
 .. vim:set ft=rst:
 
-

socketmap_sql-0.2.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+socketmapsql.py,sha256=ZcApgWGIGUZ1a81uCyhMUm-evcmrzxyHAlwjs_tpNB0,7316
+socketmap_sql-0.2.1.dist-info/entry_points.txt,sha256=1N1u8xbsj9ryvD0v-HWBMxNfiCarn1Dq7pXXwjn7-8E,51
+socketmap_sql-0.2.1.dist-info/licenses/LICENSE,sha256=Du-PK9kF9TBcjQfRGArxGPH9HVDUxifjzF5yFex2NKE,1070
+socketmap_sql-0.2.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+socketmap_sql-0.2.1.dist-info/METADATA,sha256=iN1lE_1ACmwCwW3i1xaoczFdFsLa7lXNtVcZlvlKKOs,3229
+socketmap_sql-0.2.1.dist-info/RECORD,,

{socketmap_sql-0.1.0.dist-info → socketmap_sql-0.2.1.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.29.0)
+Generator: flit 3.12.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

socketmap_sql-0.2.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+socketmap-sql=socketmapsql:main
+

socketmap_sql-0.2.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Keith Gaughan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

socketmapsql.py

@@ -0,0 +1,278 @@
+#!/usr/bin/env python3
+"""
+An implementation of the sendmail socketmap protocol to allow an SQL database
+to be queried out of process.
+"""
+
+import argparse
+import configparser
+import contextlib
+import dataclasses
+import importlib
+import os.path
+import re
+import select
+import subprocess
+import sys
+import typing as t
+
+__version__: str = "0.2.1"
+
+
+Transform = t.Callable[[str, t.Mapping[str, str]], list[str]]
+
+
+@dataclasses.dataclass
+class TableCfg:
+    query: str
+    transform: Transform
+
+
+class Cfg(t.TypedDict):
+    database: dict[str, str]
+    misc: dict[str, str]
+    tables: dict[str, TableCfg]
+
+
+FUNC_REF_PATTERN = re.compile(
+    r"""
+    ^
+    (?P<module>[a-z_][a-z0-9_]*(?:\.[a-z_][a-z0-9_]*)*)
+    :
+    (?P<object>[a-z_][a-z0-9_]*(?:\.[a-z_][a-z0-9_]*)*)
+    $
+    """,
+    re.IGNORECASE | re.VERBOSE,
+)
+
+
+def match(name: str) -> tuple[str, str]:
+    matches = FUNC_REF_PATTERN.match(name)
+    if not matches:
+        raise ValueError(f"Malformed callable '{name}'")
+    return matches.group("module"), matches.group("object")
+
+
+def resolve(module_name: str, obj_name: str) -> t.Callable:
+    """
+    Resolve a named object in a module.
+    """
+    return getattr(importlib.import_module(module_name), obj_name)
+
+
+class MalformedNetstringError(Exception):
+    pass
+
+
+def read_netstring(fp: t.IO[str]) -> str | None:
+    """Reads a single netstring."""
+    ns = ""
+    while True:
+        c = fp.read(1)
+        if c == "":
+            return None
+        if c == ":":
+            break
+        if len(ns) > 10:  # noqa: PLR2004
+            raise MalformedNetstringError
+        if c == "0" and ns == "":
+            # We can't allow leading zeros.
+            if fp.read(1) != ":":
+                raise MalformedNetstringError
+            ns = c
+            break
+        ns += c
+    n = int(ns, 10)
+    result = ""
+    while n > 0:
+        segment = fp.read(n)
+        if segment == "":
+            raise MalformedNetstringError
+        n -= len(segment)
+        result += segment
+    if fp.read(1) != ",":
+        raise MalformedNetstringError
+    return result
+
+
+def write_netstring(fp: t.IO[str], response: str) -> None:
+    fp.write(f"{len(response)}:{response},")
+    fp.flush()
+
+
+def process_local(local_part: str, cfg: t.Mapping[str, str]) -> str:
+    delimiter = cfg.get("recipient_delimiter", "").strip()
+    if delimiter != "":
+        local_part = local_part.split(delimiter, 1)[0]
+    return local_part.lower()
+
+
+def split(arg: str, cfg: t.Mapping[str, str]) -> list[str]:
+    parts = arg.split("@", 1)
+    parts[0] = process_local(parts[0], cfg)
+    parts[1] = parts[1].lower()
+    return parts
+
+
+def parse_config(fp: t.IO[str]) -> Cfg:
+    transforms = {
+        "all": lambda arg, _: [arg],
+        "lowercase": lambda arg, _: [arg.lower()],
+        "local": lambda arg, cfg: [process_local(arg.split("@", 1)[0], cfg)],
+        "domain": lambda arg, _: [arg.split("@", 1)[1].lower()],
+        "split": split,
+    }
+
+    cp = configparser.ConfigParser(interpolation=None)
+    cp.read_file(fp)
+
+    tables = {}
+    for section in cp.sections():
+        if section.startswith("table:"):
+            _, table_name = section.split(":", 1)
+            if not cp.has_option(section, "query"):
+                continue
+
+            try:
+                transform_name = cp.get(section, "transform")
+            except configparser.NoOptionError:
+                transform_name = "all"
+            transform = transforms.get(transform_name)
+            if transform is None:
+                transform = resolve(*match(transform_name))
+
+            tables[table_name] = TableCfg(
+                query=cp.get(section, "query"),
+                transform=transform,
+            )
+
+    return Cfg(
+        database=dict(cp.items("database")),
+        tables=tables,
+        misc=dict(cp.items("misc")),
+    )
+
+
+def get_int(cfg: t.Mapping[str, str], key: str) -> int | None:
+    return int(cfg[key]) if key in cfg else None
+
+
+def serve_client(
+    fh_in: t.IO[str],
+    fh_out: t.IO[str],
+    conn,
+    timeout: int,
+    tables: t.Mapping[str, TableCfg],
+    cfg: t.Mapping[str, str],
+) -> None:
+    max_requests = get_int(cfg, "max_requests")
+    try:
+        while True:
+            if max_requests is not None:
+                max_requests -= 1
+                if max_requests < 1:
+                    break
+
+            # Wait a short period before exiting.
+            iready, _, _ = select.select([fh_in], (), (), timeout)
+            if len(iready) == 0:
+                break
+
+            request = read_netstring(fh_in)
+            if request is None:
+                break
+
+            table_name, arg = request.split(" ", 1)
+
+            table = tables.get(table_name)
+            if table is None:
+                write_netstring(fh_out, f"PERM no such table: {table_name}")
+                break
+
+            cur = conn.cursor()
+            try:
+                cur.execute(table.query, table.transform(arg, cfg))
+                result = cur.fetchone()
+            finally:
+                cur.close()
+
+            if result is None:
+                write_netstring(fh_out, "NOTFOUND ")
+            else:
+                write_netstring(fh_out, f"OK {result[0]!s}")
+    except MalformedNetstringError:
+        write_netstring(fh_out, "PERM malformed netstring")
+    except Exception as exc:
+        write_netstring(fh_out, f"PERM {exc!s}")
+
+
+def connect(settings: dict[str, str]):
+    """Connect to a database."""
+    driver = importlib.import_module(settings.pop("driver", "sqlite3"))
+    return driver.connect(**settings)
+
+
+def make_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(description="Database socketmap daemon.")
+    parser.add_argument(
+        "--config",
+        help="Path to config file",
+        type=argparse.FileType(),
+        default="/etc/socketmap-sql.ini",
+    )
+    parser.add_argument(
+        "--timeout",
+        help="Number of seconds to wait before exiting",
+        type=int,
+        default=5,
+    )
+    parser.add_argument(
+        "--client",
+        action="store_true",
+        help="Start with a debug client",
+    )
+    return parser
+
+
+def main() -> int:
+    args = make_parser().parse_args()
+
+    with contextlib.closing(args.config):
+        cfg = parse_config(args.config)
+
+    if args.client:
+        svr_args = [arg for arg in sys.argv if arg != "--client"]
+        svr_args[0] = os.path.abspath(svr_args[0])
+        proc = subprocess.Popen(
+            svr_args,
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            encoding="utf-8",
+        )
+        print("Type '.exit' to exit.")
+        while proc.poll() is None:
+            req = input("socketmap> ")
+            if req == ".exit":
+                proc.terminate()
+                break
+            if proc.stdin is not None and proc.stdout is not None:
+                write_netstring(proc.stdin, req)
+                print(read_netstring(proc.stdout))
+    else:
+        with contextlib.closing(connect(cfg["database"])) as conn:
+            serve_client(
+                sys.stdin,
+                sys.stdout,
+                conn,
+                args.timeout,
+                cfg["tables"],
+                cfg["misc"],
+            )
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())
+
+# vim:set ft=python et:

socketmap_sql-0.1.0.data/scripts/socketmap-sql

@@ -1,231 +0,0 @@
-#!python
-#
-# socketmap-sql
-# by Keith Gaughan (https://github.com/kgaughan/)
-#
-# This implements the sendmail socketmap protocol to allow an SQL database to
-# be queried out of process.
-#
-# Copyright (c) Keith Gaughan, 2017. See 'LICENSE' for license details.
-#
-
-from __future__ import print_function
-
-import argparse
-import contextlib
-try:
-    import configparser
-except ImportError:
-    import ConfigParser as configparser
-import importlib
-import os.path
-import re
-import select
-import subprocess
-import sys
-
-
-FUNC_REF_PATTERN = re.compile(r"""
-    ^
-    (?P<module>
-        [a-z_][a-z0-9_]*(?:\.[a-z_][a-z0-9_]*)*
-    )
-    :
-    (?P<object>
-        [a-z_][a-z0-9_]*(?:\.[a-z_][a-z0-9_]*)*
-    )
-    $
-    """, re.I | re.X)
-
-
-def match(name):
-    matches = FUNC_REF_PATTERN.match(name)
-    if not matches:
-        raise ValueError("Malformed callable '{}'".format(name))
-    return matches.group('module'), matches.group('object')
-
-
-def resolve(module_name, obj_name):
-    """
-    Resolve a named object in a module.
-    """
-    return getattr(importlib.import_module(module_name), obj_name)
-
-
-class MalformedNetstringError(Exception):
-    pass
-
-
-def read_netstring(fp):
-    """
-    Reads a single netstring.
-    """
-    n = ""
-    while True:
-        c = fp.read(1)
-        if c == '':
-            return None
-        if c == ':':
-            break
-        if len(n) > 10:
-            raise MalformedNetstringError
-        if c == '0' and n == '':
-            # We can't allow leading zeros.
-            if fp.read(1) != ':':
-                raise MalformedNetstringError
-            n = c
-            break
-        n += c
-    n = int(n, 10)
-    result = ""
-    while n > 0:
-        segment = fp.read(n)
-        n -= len(segment)
-        result += segment
-    if fp.read(1) != ',':
-        raise MalformedNetstringError
-    return result
-
-
-def write_netstring(fp, response):
-    fp.write('{}:{},'.format(len(response), response))
-    fp.flush()
-
-
-def parse_config(fp):
-    def passthrough(arg):
-        return [arg]
-
-    def local_part(arg):
-        return [arg.split('@', 1)[0]]
-
-    def domain_part(arg):
-        return [arg.split('@', 1)[1]]
-
-    def split(arg):
-        return arg.split('@', 1)
-
-    cp = configparser.RawConfigParser()
-    cp.readfp(fp)
-
-    result = {
-        'db': dict(cp.items('database')),
-        'tables': {},
-    }
-
-    for section in cp.sections():
-        if section.startswith('table:'):
-            _, table_name = section.split(':', 1)
-            if not cp.has_option(section, 'query'):
-                continue
-
-            try:
-                transform_name = cp.get(section, 'transform')
-            except configparser.NoOptionError:
-                transform_name = 'all'
-            if transform_name == 'all':
-                transform = passthrough
-            elif transform_name == 'local':
-                transform = local_part
-            elif transform_name == 'domain':
-                transform = domain_part
-            elif transform_name == 'split':
-                transform = split
-            else:
-                transform = resolve(*match(transform_name))
-
-            result['tables'][table_name] = {
-                'transform': transform,
-                'query': cp.get(section, 'query'),
-            }
-
-    return result
-
-
-def serve_client(fh_in, fh_out, conn, timeout, tables):
-    try:
-        while True:
-            # Wait a short period before exiting.
-            iready, _, _ = select.select([fh_in], (), (), timeout)
-            if len(iready) == 0:
-                break
-
-            request = read_netstring(fh_in)
-
-            table_name, arg = request.split(' ', 1)
-
-            table = tables.get(table_name)
-            if table is None:
-                write_netstring(fh_out,
-                                'PERM no such table: ' + table_name)
-                continue
-
-            cur = conn.cursor()
-            try:
-                cur.execute(table['query'], table['transform'](arg))
-                result = cur.fetchone()
-            finally:
-                cur.close()
-
-            if result is None:
-                write_netstring(fh_out, 'NOTFOUND ')
-            else:
-                write_netstring(fh_out, 'OK ' + str(result[0]))
-    except MalformedNetstringError:
-        write_netstring(fh_out, 'PERM malformed netstring')
-    except Exception as exc:
-        write_netstring(fh_out, 'PERM ' + str(exc))
-
-
-def connect(settings):
-    """
-    Connect to a database.
-    """
-    driver = importlib.import_module(settings.pop('driver', 'sqlite3'))
-    return driver.connect(**settings)
-
-
-def main():
-    parser = argparse.ArgumentParser(description='Database socketmap daemon.')
-    parser.add_argument('--config',
-                        help='Path to config file',
-                        type=argparse.FileType(),
-                        default='/etc/socketmap-sql.ini')
-    parser.add_argument('--timeout',
-                        help='Number of seconds to wait before exiting',
-                        type=int,
-                        default=2)
-    parser.add_argument('--client', action='store_true',
-                        help='Start with a debug client')
-    args = parser.parse_args()
-
-    with contextlib.closing(args.config):
-        cfg = parse_config(args.config)
-
-    if args.client:
-        svr_args = [arg for arg in sys.argv if arg != '--client']
-        svr_args[0] = os.path.abspath(svr_args[0])
-        proc = subprocess.Popen(svr_args,
-                                stdin=subprocess.PIPE,
-                                stdout=subprocess.PIPE,
-                                encoding='utf-8')
-        print("Type '.exit' to exit.")
-        while proc.poll() is None:
-            req = input('socketmap> ')
-            if req == '.exit':
-                proc.terminate()
-                break
-            write_netstring(proc.stdin, req)
-            print(read_netstring(proc.stdout))
-    else:
-        with contextlib.closing(connect(cfg['db'])) as conn:
-            serve_client(sys.stdin, sys.stdout,
-                         conn, args.timeout, cfg['tables'])
-
-    return 0
-
-
-if __name__ == '__main__':
-    sys.exit(main())
-
-# vim:set ft=python et:

socketmap_sql-0.1.0.dist-info/DESCRIPTION.rst

@@ -1,78 +0,0 @@
-=============
-socketmap-sql
-=============
-
-A socketmap script for interfacing with an SQL database.
-
-Why?
-====
-
-I have a number of FreeBSD servers, with one intended to act as my primary
-mailserver (the current one and remaining one becoming secondary mailservers).
-The problem is that I'm using postfix, and trying very hard to stick to
-precompiled packages rather than using ports, and postfix on FreeBSD lacks
-bindings to databases. In my case, I wanted to be able to use an SQL database.
-
-Configuration format
-====================
-
-Configuration files are INI files containing two types of section.
-
-First is the ``[database]`` section, which gives database connection details.
-The *driver* field specifies the driver to use; if omitted, its value defaults
-to *sqlite3*. The remaining fields are passed to the driver's ``connect()``
-function.
-
-::
-
-    [database]
-    driver = sqlite3
-    database = /path/to/sqlite.db
-
-Other sections start wth ``table:``, and denote virtual tables to be queried.
-There are two fields: *transform* (optional) and *query* (required).
-
-The *transform* field gives the name of a transformation to apply to the query
-parameter before its use in the query the query. The default is to accept the
-parameter as-is (*all*). Other values can be a reference to a Python function
-in the form 'module:function', *local* for just the local part, *domain* for
-the domain part of the address, and *split* breaks an email address in two.
-It must return a list or tuple giving the postitional arguments to use in the
-query.
-
-The *query* field give an SQL query to be used to generate the synthetic table.
-Use placeholders as specified by the database driver's documentation.
-
-Usage
-=====
-
-Run with::
-
-    socketmap-sql --config /path/to/config.ini
-
-If you don't provide the *--config* flag, it defaults to
-``/etc/socketmap-sql.ini``.
-
-Postfix
-=======
-
-This script is intended to be executed by Postfix's spawn_ mechanism, meaning
-it reads its input and writes its output to stdin and stdout respectively.
-
-.. _spawn: http://www.postfix.org/spawn.8.html
-
-Assuming you've installed the script in ``/usr/local/libexec``, add the
-following to ``master.cf``::
-
-    sockmapd  unix  -      -       n       -       1       spawn
-      user=nobody argv=/usr/local/libexec/socketmap-sql
-
-Compatibility
-=============
-
-The script only works on Python 3.3+, though it can be made to work on Python
-2.7 with some moderate patching.
-
-.. vim:set ft=rst:
-
-

socketmap_sql-0.1.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-socketmap_sql-0.1.0.data/scripts/socketmap-sql,sha256=0npExfWKFA2eWUb4inEd4LrKYuP9JMUYHd08MvO3Lx8,6183
-socketmap_sql-0.1.0.dist-info/DESCRIPTION.rst,sha256=VjUam2HBajWb0iIyW8Mrx4u7ZAKrCULlqOXLH1OtQXQ,2460
-socketmap_sql-0.1.0.dist-info/METADATA,sha256=MVvI2F3PVEhFchI6lvFRnvJbjxt6V15wplIIcGmlFdA,3092
-socketmap_sql-0.1.0.dist-info/RECORD,,
-socketmap_sql-0.1.0.dist-info/WHEEL,sha256=rNo05PbNqwnXiIHFsYm0m22u4Zm6YJtugFG2THx4w3g,92
-socketmap_sql-0.1.0.dist-info/metadata.json,sha256=7Sk8EoCX0x_S0O6-TQ--YguY4x8gBwrMk9tYR119P8g,763
-socketmap_sql-0.1.0.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1

socketmap_sql-0.1.0.dist-info/metadata.json

@@ -1 +0,0 @@
-{"classifiers": ["Development Status :: 4 - Beta", "Intended Audience :: System Administrators", "License :: OSI Approved :: MIT License", "Operating System :: POSIX", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3 :: Only", "Topic :: Communications :: Email :: Mail Transport Agents", "Topic :: Database"], "extensions": {"python.details": {"contacts": [{"email": "k@stereochro.me", "name": "Keith Gaughan", "role": "author"}], "document_names": {"description": "DESCRIPTION.rst"}, "project_urls": {"Home": "https://github.com/kgaughan/socketmap-sql/"}}}, "generator": "bdist_wheel (0.29.0)", "license": "MIT", "metadata_version": "2.0", "name": "socketmap-sql", "summary": "A socketmap script for SQL databases", "version": "0.1.0"}

socketmap_sql-0.1.0.dist-info/top_level.txt

@@ -1 +0,0 @@
-