feat(core): add async process pool, graceful signal handling, and safer config loading
- Added multiprocessing-based connection pooling for faster camera setup - Implemented robust signal handling (SIGINT/SIGTERM) for graceful shutdown - Upgraded MQTT client to v5 with improved logging and reconnect behavior - Added defensive WebRTC config validation to avoid runtime errors - Introduced unified config loader (`util.load_config`) with boolean coercion - Improved IP resolution and logging consistency across modulespull/106/head
Jeff Culverhouse
4 months ago
parent
a69ffc1667
commit
f025d60f75
@ -1,138 +1,61 @@
|
||||
# This software is licensed under the MIT License, which allows you to use,
|
||||
# copy, modify, merge, publish, distribute, and sell copies of the software,
|
||||
# with the requirement to include the original copyright notice and this
|
||||
# permission notice in all copies or substantial portions of the software.
|
||||
#
|
||||
# The software is provided 'as is', without any warranty.
|
||||
|
||||
#!/usr/bin/env python3
|
||||
import asyncio
|
||||
import argparse
|
||||
from amcrest_mqtt import AmcrestMqtt
|
||||
import logging
|
||||
import os
|
||||
import sys
|
||||
import time
|
||||
from util import *
|
||||
import yaml
|
||||
|
||||
# Let's go!
|
||||
version = read_version()
|
||||
|
||||
# Cmd-line args
|
||||
argparser = argparse.ArgumentParser()
|
||||
argparser.add_argument(
|
||||
'-c',
|
||||
'--config',
|
||||
required=False,
|
||||
help='Directory holding config.yaml or full path to config file',
|
||||
)
|
||||
args = argparser.parse_args()
|
||||
|
||||
# Setup config from yaml file or env
|
||||
configpath = args.config or '/config'
|
||||
try:
|
||||
if not configpath.endswith('.yaml'):
|
||||
if not configpath.endswith('/'):
|
||||
configpath += '/'
|
||||
configfile = configpath + 'config.yaml'
|
||||
with open(configfile) as file:
|
||||
config = yaml.safe_load(file)
|
||||
config['config_path'] = configpath
|
||||
config['config_from'] = 'file'
|
||||
except:
|
||||
config = {
|
||||
'mqtt': {
|
||||
'host': os.getenv('MQTT_HOST') or 'localhost',
|
||||
'qos': int(os.getenv('MQTT_QOS') or 0),
|
||||
'port': int(os.getenv('MQTT_PORT') or 1883),
|
||||
'username': os.getenv('MQTT_USERNAME'),
|
||||
'password': os.getenv('MQTT_PASSWORD'), # can be None
|
||||
'tls_enabled': os.getenv('MQTT_TLS_ENABLED') == 'true',
|
||||
'tls_ca_cert': os.getenv('MQTT_TLS_CA_CERT'),
|
||||
'tls_cert': os.getenv('MQTT_TLS_CERT'),
|
||||
'tls_key': os.getenv('MQTT_TLS_KEY'),
|
||||
'prefix': os.getenv('MQTT_PREFIX') or 'amcrest2mqtt',
|
||||
'homeassistant': os.getenv('MQTT_HOMEASSISTANT') == True,
|
||||
'discovery_prefix': os.getenv('MQTT_DISCOVERY_PREFIX') or 'homeassistant',
|
||||
},
|
||||
'amcrest': {
|
||||
'hosts': os.getenv("AMCREST_HOSTS"),
|
||||
'names': os.getenv("AMCREST_NAMES"),
|
||||
'port': int(os.getenv("AMCREST_PORT") or 80),
|
||||
'username': os.getenv("AMCREST_USERNAME") or "admin",
|
||||
'password': os.getenv("AMCREST_PASSWORD"),
|
||||
'storage_update_interval': int(os.getenv("STORAGE_UPDATE_INTERVAL") or 900),
|
||||
'snapshot_update_interval': int(os.getenv("SNAPSHOT_UPDATE_INTERVAL") or 300),
|
||||
'webrtc': {
|
||||
'host': os.getenv("AMCREST_WEBRTC_HOST"),
|
||||
'port': int(os.getenv("AMCREST_WEBRTC_PORT") or 1984),
|
||||
'link': os.getenv("AMCREST_WEBRTC_LINK") or 'stream.html',
|
||||
'sources': os.getenv("AMCREST_WEBRTC_SOURCES"),
|
||||
},
|
||||
},
|
||||
'debug': True if os.getenv('DEBUG') else False,
|
||||
'hide_ts': True if os.getenv('HIDE_TS') else False,
|
||||
'timezone': os.getenv('TZ'),
|
||||
'config_from': 'env',
|
||||
}
|
||||
config['version'] = version
|
||||
config['configpath'] = os.path.dirname(configpath)
|
||||
|
||||
# defaults
|
||||
if 'username' not in config['mqtt']: config['mqtt']['username'] = ''
|
||||
if 'password' not in config['mqtt']: config['mqtt']['password'] = ''
|
||||
if 'qos' not in config['mqtt']: config['mqtt']['qos'] = 0
|
||||
if 'timezone' not in config: config['timezone'] = 'UTC'
|
||||
if 'debug' not in config: config['debug'] = os.getenv('DEBUG') or False
|
||||
if 'hide_ts' not in config: config['hide_ts'] = os.getenv('HIDE_TS') or False
|
||||
|
||||
# init logging, based on config settings
|
||||
logging.basicConfig(
|
||||
format = '%(asctime)s.%(msecs)03d [%(levelname)s] %(name)s: %(message)s' if config['hide_ts'] == False else '[%(levelname)s] %(name)s: %(message)s',
|
||||
datefmt='%Y-%m-%d %H:%M:%S',
|
||||
level=logging.INFO if config['debug'] == False else logging.DEBUG
|
||||
)
|
||||
logger = logging.getLogger(__name__)
|
||||
logger.info(f'Starting: amcrest2mqtt {version}')
|
||||
logger.info(f'Config loaded from {config["config_from"]}')
|
||||
|
||||
# Check for required config properties
|
||||
if config['amcrest']['hosts'] is None:
|
||||
logger.error('Missing env var: AMCREST_HOSTS or amcrest.hosts in config')
|
||||
exit(1)
|
||||
config['amcrest']['host_count'] = len(config['amcrest']['hosts'])
|
||||
|
||||
if config['amcrest']['names'] is None:
|
||||
logger.error('Missing env var: AMCREST_NAMES or amcrest.names in config')
|
||||
exit(1)
|
||||
config['amcrest']['name_count'] = len(config['amcrest']['names'])
|
||||
|
||||
if config['amcrest']['host_count'] != config['amcrest']['name_count']:
|
||||
logger.error('The AMCREST_HOSTS and AMCREST_NAMES must have the same number of space-delimited hosts/names')
|
||||
exit(1)
|
||||
logger.info(f'Found {config["amcrest"]["host_count"]} host(s) defined to monitor')
|
||||
|
||||
if 'webrtc' in config['amcrest']:
|
||||
webrtc = config['amcrest']['webrtc']
|
||||
if 'host' not in webrtc:
|
||||
logger.error('Missing HOST in webrtc config')
|
||||
exit(1)
|
||||
if 'sources' not in webrtc:
|
||||
logger.error('Missing SOURCES in webrtc config')
|
||||
exit(1)
|
||||
config['amcrest']['webrtc_sources_count'] = len(config['amcrest']['webrtc']['sources'])
|
||||
if config['amcrest']['host_count'] != config['amcrest']['webrtc_sources_count']:
|
||||
logger.error('The AMCREST_HOSTS and AMCREST_WEBRTC_SOURCES must have the same number of space-delimited hosts/names')
|
||||
exit(1)
|
||||
if 'port' not in webrtc: webrtc['port'] = 1984
|
||||
if 'link' not in webrtc: webrtc['link'] = 'stream.html'
|
||||
|
||||
if config['amcrest']['password'] is None:
|
||||
logger.error('Please set the AMCREST_PASSWORD environment variable')
|
||||
exit(1)
|
||||
|
||||
logger.debug("DEBUG logging is ON")
|
||||
|
||||
# Go!
|
||||
with AmcrestMqtt(config) as mqtt:
|
||||
asyncio.run(mqtt.main_loop())
|
||||
from amcrest_mqtt import AmcrestMqtt
|
||||
from util import load_config
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Parse command-line arguments
|
||||
argparser = argparse.ArgumentParser()
|
||||
argparser.add_argument(
|
||||
"-c",
|
||||
"--config",
|
||||
required=False,
|
||||
help="Directory or file path for config.yaml (defaults to /config/config.yaml)",
|
||||
)
|
||||
args = argparser.parse_args()
|
||||
|
||||
# Load configuration
|
||||
config = load_config(args.config)
|
||||
|
||||
# Setup logging
|
||||
logging.basicConfig(
|
||||
format=(
|
||||
"%(asctime)s.%(msecs)03d [%(levelname)s] %(name)s: %(message)s"
|
||||
if not config["hide_ts"]
|
||||
else "[%(levelname)s] %(name)s: %(message)s"
|
||||
),
|
||||
datefmt="%Y-%m-%d %H:%M:%S",
|
||||
level=logging.DEBUG if config["debug"] else logging.INFO,
|
||||
)
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
logger.info(f"Starting amcrest2mqtt {config['version']}")
|
||||
logger.info(f"Config loaded from {config['config_from']} ({config['config_path']})")
|
||||
|
||||
# Run main loop safely
|
||||
try:
|
||||
with AmcrestMqtt(config) as mqtt:
|
||||
try:
|
||||
# Prefer a clean async run, but handle nested event loops
|
||||
asyncio.run(mqtt.main_loop())
|
||||
except RuntimeError as e:
|
||||
if "asyncio.run() cannot be called from a running event loop" in str(e):
|
||||
loop = asyncio.get_event_loop()
|
||||
loop.run_until_complete(mqtt.main_loop())
|
||||
else:
|
||||
raise
|
||||
except KeyboardInterrupt:
|
||||
logger.info("Shutdown requested (Ctrl+C). Exiting gracefully...")
|
||||
except asyncio.CancelledError:
|
||||
logger.warning("Main loop cancelled.")
|
||||
except Exception as e:
|
||||
logger.exception(f"Unhandled exception in main loop: {e}")
|
||||
finally:
|
||||
try:
|
||||
if "mqtt" in locals() and hasattr(mqtt, "api") and mqtt.api:
|
||||
mqtt.api.shutdown()
|
||||
except Exception as e:
|
||||
logger.debug(f"Error during shutdown: {e}")
|
||||
logger.info("amcrest2mqtt stopped.")
|
||||
@ -1,44 +1,121 @@
|
||||
# This software is licensed under the MIT License, which allows you to use,
|
||||
# copy, modify, merge, publish, distribute, and sell copies of the software,
|
||||
# with the requirement to include the original copyright notice and this
|
||||
# permission notice in all copies or substantial portions of the software.
|
||||
#
|
||||
# The software is provided 'as is', without any warranty.
|
||||
|
||||
import ipaddress
|
||||
import logging
|
||||
import os
|
||||
import socket
|
||||
import yaml
|
||||
|
||||
# Helper functions and callbacks
|
||||
def read_file(file_name):
|
||||
with open(file_name, 'r') as file:
|
||||
data = file.read().replace('\n', '')
|
||||
def get_ip_address(hostname: str) -> str:
|
||||
"""
|
||||
Resolve a hostname to an IP address (IPv4 or IPv6).
|
||||
|
||||
Returns:
|
||||
str: The resolved IP address, or the original hostname if resolution fails.
|
||||
"""
|
||||
if not hostname:
|
||||
return hostname
|
||||
|
||||
try:
|
||||
# Try both IPv4 and IPv6 (AF_UNSPEC)
|
||||
infos = socket.getaddrinfo(
|
||||
hostname, None, family=socket.AF_UNSPEC, type=socket.SOCK_STREAM
|
||||
)
|
||||
# Prefer IPv4 addresses if available
|
||||
for family, _, _, _, sockaddr in infos:
|
||||
if family == socket.AF_INET:
|
||||
return sockaddr[0]
|
||||
# Otherwise, fallback to first valid IPv6
|
||||
return infos[0][4][0] if infos else hostname
|
||||
except socket.gaierror as e:
|
||||
logging.debug(f"DNS lookup failed for {hostname}: {e}")
|
||||
except Exception as e:
|
||||
logging.debug(f"Unexpected error resolving {hostname}: {e}")
|
||||
|
||||
return hostname
|
||||
|
||||
|
||||
def to_gb(bytes_value):
|
||||
"""Convert bytes to a rounded string in gigabytes."""
|
||||
try:
|
||||
gb = float(bytes_value) / (1024**3)
|
||||
return f"{gb:.2f} GB"
|
||||
except Exception:
|
||||
return "0.00 GB"
|
||||
|
||||
|
||||
def read_file(file_name, strip_newlines=True, default=None, encoding="utf-8"):
|
||||
try:
|
||||
with open(file_name, "r", encoding=encoding) as f:
|
||||
data = f.read()
|
||||
return data.replace("\n", "") if strip_newlines else data
|
||||
except FileNotFoundError:
|
||||
if default is not None:
|
||||
return default
|
||||
raise
|
||||
|
||||
return data
|
||||
|
||||
def read_version():
|
||||
if os.path.isfile('./VERSION'):
|
||||
return read_file('./VERSION')
|
||||
base_dir = os.path.dirname(os.path.abspath(__file__))
|
||||
version_path = os.path.join(base_dir, "VERSION")
|
||||
try:
|
||||
with open(version_path, "r") as f:
|
||||
return f.read().strip() or "unknown"
|
||||
except FileNotFoundError:
|
||||
env_version = os.getenv("APP_VERSION")
|
||||
return env_version.strip() if env_version else "unknown"
|
||||
|
||||
return read_file('../VERSION')
|
||||
|
||||
def to_gb(total):
|
||||
return str(round(float(total[0]) / 1024 / 1024 / 1024, 2))
|
||||
def load_config(path=None):
|
||||
"""Load and normalize configuration from YAML file or directory."""
|
||||
|
||||
def is_ipv4(string):
|
||||
try:
|
||||
ipaddress.IPv4Network(string)
|
||||
return True
|
||||
except ValueError:
|
||||
logger = logging.getLogger(__name__)
|
||||
default_path = "/config/config.yaml"
|
||||
|
||||
# Resolve config path
|
||||
config_path = path or default_path
|
||||
if os.path.isdir(config_path):
|
||||
config_path = os.path.join(config_path, "config.yaml")
|
||||
|
||||
if not os.path.exists(config_path):
|
||||
raise FileNotFoundError(f"Config file not found: {config_path}")
|
||||
|
||||
with open(config_path, "r") as f:
|
||||
config = yaml.safe_load(f) or {}
|
||||
|
||||
# --- Normalization helpers ------------------------------------------------
|
||||
def to_bool(value):
|
||||
"""Coerce common truthy/falsey forms to proper bool."""
|
||||
if isinstance(value, bool):
|
||||
return value
|
||||
if isinstance(value, (int, float)):
|
||||
return bool(value)
|
||||
if value is None:
|
||||
return False
|
||||
return str(value).strip().lower() in ("true", "1", "yes", "on")
|
||||
|
||||
def get_ip_address(string):
|
||||
if is_ipv4(string):
|
||||
return string
|
||||
try:
|
||||
for i in socket.getaddrinfo(string, None):
|
||||
if i[0] == socket.AddressFamily.AF_INET:
|
||||
return i[4][0]
|
||||
except socket.gaierror as e:
|
||||
raise Exception(f"Failed to resolve {string}: {e}")
|
||||
raise Exception(f"Failed to find IP address for {string}")
|
||||
def normalize_section(section, bool_keys):
|
||||
"""Normalize booleans within a nested section."""
|
||||
if not isinstance(config.get(section), dict):
|
||||
return
|
||||
for key in bool_keys:
|
||||
if key in config[section]:
|
||||
config[section][key] = to_bool(config[section][key])
|
||||
|
||||
# --- Global defaults + normalization -------------------------------------
|
||||
config.setdefault("version", "1.0.0")
|
||||
config.setdefault("debug", False)
|
||||
config.setdefault("hide_ts", False)
|
||||
config.setdefault("timezone", "UTC")
|
||||
|
||||
# normalize top-level flags
|
||||
config["debug"] = to_bool(config.get("debug"))
|
||||
config["hide_ts"] = to_bool(config.get("hide_ts"))
|
||||
|
||||
# Example: normalize booleans within sections
|
||||
normalize_section("mqtt", ["tls", "retain", "clean_session"])
|
||||
normalize_section("amcrest", ["webrtc", "verify_ssl"])
|
||||
normalize_section("service", ["enabled", "auto_restart"])
|
||||
|
||||
# Add metadata for debugging/logging
|
||||
config["config_path"] = os.path.abspath(config_path)
|
||||
config["config_from"] = "file" if os.path.exists(config_path) else "defaults"
|
||||
|
||||
return config
|
||||
|
||||
Loading…
Reference in New Issue