prim-ctrl 0.3.0__py3-none-any.whl

prim_ctrl/__main__.py

@@ -0,0 +1,870 @@
+
+import argparse
+import asyncio
+import logging
+import os
+import platform
+import socket
+import subprocess
+import sys
+import time
+from abc import abstractmethod
+from contextlib import nullcontext, suppress
+from datetime import datetime, timezone
+from pathlib import Path
+from typing import Dict
+
+import aiohttp
+from aiohttp import ClientTimeout, web
+from platformdirs import user_cache_dir
+from zeroconf import Zeroconf, ServiceInfo, ServiceListener as ZeroconfServiceListener
+from zeroconf.asyncio import AsyncZeroconf
+
+########
+
+class LevelFormatter(logging.Formatter):
+    logging.Formatter.default_msec_format = logging.Formatter.default_msec_format.replace(',', '.') if logging.Formatter.default_msec_format else None
+
+    def __init__(self, fmts: Dict[int, str], fmt: str, **kwargs):
+        super().__init__()
+        self.formatters = dict({level: logging.Formatter(fmt, **kwargs) for level, fmt in fmts.items()})
+        self.default_formatter = logging.Formatter(fmt, **kwargs)
+
+    def format(self, record: logging.LogRecord) -> str:
+        return self.formatters.get(record.levelno, self.default_formatter).format(record)
+
+class Logger(logging.Logger):
+    def __init__(self, name, level=logging.NOTSET):
+        super().__init__(name, level)
+        self.exitcode = 0
+
+    def prepare(self, timestamp: bool, silent: bool):
+        handler = logging.StreamHandler(sys.stderr)
+        handler.setFormatter(
+            LevelFormatter(
+                {
+                    logging.WARNING: '%(asctime)s %(message)s',
+                    logging.INFO: '%(asctime)s %(message)s',
+                    logging.DEBUG: '%(asctime)s %(levelname)s %(message)s',
+                },
+                '%(asctime)s %(name)s: %(levelname)s: %(message)s')
+            if timestamp else
+            LevelFormatter(
+                {
+                    logging.WARNING: '%(message)s',
+                    logging.INFO: '%(message)s',
+                    logging.DEBUG: '%(levelname)s %(message)s',
+                },
+                '%(name)s: %(levelname)s: %(message)s')
+        )
+        self.addHandler(handler)
+        if self.level == logging.NOTSET:
+            self.setLevel(logging.WARNING if silent else logging.INFO)
+
+    def error(self, msg, *args, **kwargs):
+        self.exitcode = 1
+        super().error(msg, *args, **kwargs)
+
+    def critical(self, msg, *args, **kwargs):
+        self.exitcode = 1
+        super().critical(msg, *args, **kwargs)
+
+    def log(self, level, msg, *args, **kwargs):
+        if level >= logging.ERROR:
+            self.exitcode = 1
+        super().log(level, msg, *args, **kwargs)
+
+class LazyStr:
+    def __init__(self, func, *args, **kwargs):
+        self.func = func
+        self.args = args
+        self.kwargs = kwargs
+        self.result = None
+    def __str__(self):
+        if self.result is None:
+            self.result = str(self.func(*self.args, **self.kwargs))
+        return self.result
+
+logger = Logger(Path(sys.argv[0]).name)
+
+########
+
+# based on https://stackoverflow.com/a/55656177/2755656
+def sync_ping(host, packets: int = 1, timeout: float = 1):
+    if platform.system().lower() == 'windows':
+        command = ['ping', '-n', str(packets), '-w', str(int(timeout*1000)), host]
+        # don't use text=True, the async version will raise ValueError("text must be False"), who knows why
+        result = subprocess.run(command, stdin=subprocess.DEVNULL, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, creationflags=subprocess.CREATE_NO_WINDOW)
+        return result.returncode == 0 and b'TTL=' in result.stdout
+    else:
+        command = ['ping', '-c', str(packets), '-W', str(int(timeout)), host]
+        result = subprocess.run(command, stdin=subprocess.DEVNULL, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+        return result.returncode == 0
+
+async def async_ping(host, packets: int = 1, timeout: float = 1):
+    if platform.system().lower() == 'windows':
+        command = ['ping', '-n', str(packets), '-w', str(int(timeout*1000)), host]
+        # don't use text=True, the async version will raise ValueError("text must be False"), who knows why
+        proc = await asyncio.create_subprocess_exec(*command, stdin=subprocess.DEVNULL, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, creationflags=subprocess.CREATE_NO_WINDOW)
+        stdout, _stderr = await proc.communicate()
+        return proc.returncode == 0 and b'TTL=' in stdout
+    else:
+        command = ['ping', '-c', str(packets), '-W', str(int(timeout)), host]
+        proc = await asyncio.create_subprocess_exec(*command, stdin=subprocess.DEVNULL, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+        _stdout, _stderr = await proc.communicate()
+        return proc.returncode == 0
+
+########
+
+class Secrets:
+    DIR_NAME = '.secrets'
+
+    def __init__(self):
+        self.secrets_path = Path.home() / Secrets.DIR_NAME
+
+    def get(self, tokenfile: str):
+        with open(str(self.secrets_path / tokenfile), 'rt') as file:
+            return file.readline().rstrip()
+
+    def set(self, tokenfile: str, token: str):
+        self.secrets_path.mkdir(parents=True, exist_ok=True)
+        with open(str(self.secrets_path / tokenfile), 'wt') as file:
+            file.write(token)
+
+    def get_age(self, tokenfile: str):
+        return (datetime.now(timezone.utc) - datetime.fromtimestamp(os.stat(str(self.secrets_path / tokenfile)).st_mtime, timezone.utc)).total_seconds()
+
+class Pingable:
+    @abstractmethod
+    async def ping(self, availability_hint: bool | None = None) -> bool:
+        pass
+
+    def get_class_name(self):
+        return self.__qualname__ if hasattr(self, '__qualname__') else self.__class__.__qualname__.rsplit('.', maxsplit=1)[0]
+
+    @staticmethod
+    def get_state_name(available: bool):
+        return 'up' if available else 'down'
+
+    async def wait_for(self, available: bool, timeout: float):
+        logger.debug("Waiting for %s to be %s (timeout is %ds)", LazyStr(self.get_class_name), LazyStr(Pingable.get_state_name, available), int(timeout))
+        async with asyncio.timeout(timeout):
+            while await self.ping(available) != available:
+                if not available:
+                    await asyncio.sleep(1)
+
+class Manager:
+    @abstractmethod
+    async def start(self):
+        pass
+
+    @abstractmethod
+    async def stop(self):
+        pass
+
+class Manageable(Pingable):
+    def __init__(self, manager: Manager):
+        super().__init__()
+        self.manager = manager
+
+    async def _set_state(self, available: bool, repeat: float, timeout: float):
+        action_name = LazyStr(lambda: 'Starting' if available else 'Stopping')
+        class_name = LazyStr(self.get_class_name)
+        available_name = LazyStr(Pingable.get_state_name, available)
+        logger.info("%s %s...", action_name, class_name)
+        logger.debug("%s %s (repeat after %ds, timeout is %ds)", action_name, class_name, int(repeat), int(timeout))
+        try:
+            async with asyncio.timeout(timeout):
+                while True:
+                    try:
+                        if available:
+                            await self.manager.start()
+                        else:
+                            await self.manager.stop()
+                        await self.wait_for(available, min(repeat, timeout))
+                        break
+                    except TimeoutError:
+                        pass
+        except TimeoutError as e:
+            e.add_note(f"Can't get {class_name} {available_name} for {timeout} seconds")
+            raise
+        logger.info("  %s is %s", class_name, available_name)
+        return available
+
+    async def test(self):
+        available = await self.ping()
+        logger.info("%s is %s", LazyStr(self.get_class_name), LazyStr(Pingable.get_state_name, available))
+        return available
+
+    async def start(self, repeat: float, timeout: float):
+        return await self._set_state(True, repeat, timeout)
+
+    async def stop(self, repeat: float, timeout: float):
+        return await self._set_state(False, repeat, timeout)
+
+class Service(Manageable):
+    def __init__(self, host: str, port: int, manager: Manager):
+        super().__init__(manager)
+        self.host = host
+        self.port = port
+
+    async def ping(self, _availability_hint: bool | None = None):
+        async def _connect(connect_timeout: float):
+            logger.debug(" Connecting to %s on port %d (timeout is %ds)", self.host, self.port, connect_timeout)
+            async with asyncio.timeout(connect_timeout):
+                return await asyncio.open_connection(self.host, self.port)
+        logger.debug("Pinging %s (%s:%d)", LazyStr(self.get_class_name), self.host, self.port)
+        try:
+            _reader, writer = await _connect(2)
+            writer.close()
+            await writer.wait_closed()
+            return True
+        except (TimeoutError, socket.gaierror, ConnectionRefusedError):
+            return False
+        except Exception as e:
+            logger.debug("  Unexpected ping exception: %s", e.__str__())
+            raise
+
+class Device(Manageable):
+    def __init__(self, host: str, manager: Manager):
+        super().__init__(manager)
+        self.host = host
+
+    async def ping(self, availability_hint: bool | None = None):
+        logger.debug("Pinging %s (%s)", LazyStr(self.get_class_name), self.host)
+        return await async_ping(self.host, timeout=2)
+
+class StateSerializer:
+    BOOL = {False: Pingable.get_state_name(False), True: Pingable.get_state_name(True)}
+    INV_BOOL = {v: k for k, v in BOOL.items()}
+
+    @staticmethod
+    def dump_value(v):
+        return v if not isinstance(v, bool) else StateSerializer.BOOL[v]
+
+    @staticmethod
+    def load_value(v):
+        return v if v not in StateSerializer.INV_BOOL else StateSerializer.INV_BOOL[v]
+
+    @staticmethod
+    def dumps(d: dict):
+        return ','.join(f"{k}={StateSerializer.dump_value(v)}" for k, v in d.items())
+
+    @staticmethod
+    def loads(s: str):
+        try:
+            return dict({k: StateSerializer.load_value(v) for k, v in [s.split('=') for s in s.split(',')]})
+        except ValueError as e:
+            e.add_note("Missing '=' in state")
+            raise
+
+class State:
+    WIFI = 'wifi'
+    PFTPD = 'pftpd'
+    NAMES = { WIFI: "Wi-Fi", PFTPD: "pFTPd"}
+
+    @abstractmethod
+    async def get(self, repeat: float, timeout: float) -> dict:
+        pass
+
+########
+
+class Webhooks:
+    PING_PATH = 'ping'
+    VARIABLE_PATH = 'variable'
+
+    def __init__(self, host: str, port: int):
+        self.host = host
+        self.port = port
+        self.variables = dict[str, asyncio.Queue[str]]()
+
+    @staticmethod
+    def get_ping_path():
+        return f'/{Webhooks.PING_PATH}'
+
+    @staticmethod
+    def get_variable_path(variable: str):
+        return f'/{Webhooks.VARIABLE_PATH}/{variable}'
+
+    async def _start(self):
+        async def _ping(request: web.Request):
+            return web.Response(text='pong')
+        async def _receive_variable(request: web.Request):
+            queue = self.variables.get(request.match_info['name'])
+            if queue:
+                with suppress(asyncio.QueueFull):
+                    queue.put_nowait(await request.text())
+            return web.Response(text='OK')
+        app = web.Application()
+        app.add_routes([
+            web.get(f'/{Webhooks.PING_PATH}', _ping),
+            web.post(f'/{Webhooks.VARIABLE_PATH}' + r'/{name}', _receive_variable)])
+        self.runner = web.AppRunner(app)
+        await self.runner.setup()
+        self.site = web.TCPSite(self.runner, host=self.host, port=self.port)
+        await self.site.start()
+
+    async def _stop(self):
+        await self.runner.cleanup()
+
+    def subscribe_variable(self, variable: str):
+        if variable not in self.variables:
+            self.variables[variable] = asyncio.Queue[str](maxsize=16)
+
+    def unsubscribe_variable(self, variable: str):
+        self.variables.pop(variable)
+
+    async def get_variable(self, variable: str, timeout: float):
+        queue = self.variables.get(variable)
+        if not queue:
+            raise ValueError(f"The {variable} is unknown")
+        try:
+            async with asyncio.timeout(timeout):
+                return await queue.get()
+        except TimeoutError as e:
+            e.add_note(f"Can't get value of {variable} for {timeout} seconds")
+            raise
+
+    def __enter__(self):
+        raise TypeError("Use async with instead")
+    def __exit__(self, exc_type, exc_value, exc_tb):
+        pass
+    async def __aenter__(self):
+        await self._start()
+        return self
+    async def __aexit__(self, exc_type, exc_value, exc_tb):
+        await self._stop()
+
+class Automate:
+    def __init__(self, secrets: Secrets, session: aiohttp.ClientSession, account: str, device: str, tokenfile: str):
+        self.session = session
+        self.account = account
+        self.device = device
+        self.secret = secrets.get(tokenfile)
+
+    async def send_message(self, message: str):
+        data = {
+            "secret": self.secret,
+            "to": self.account,
+            "device": self.device,
+            "priority": "high",
+            "payload": f"prim-ctrl;{time.time()};" + message
+        }
+        logger.debug("Messaging Automate with: %s", message)
+        async with self.session.post(f'https://llamalab.com/automate/cloud/message', json=data) as response:
+            await response.text()
+
+class AutomatepFTPdManager(Manager):
+    def __init__(self, automate: Automate):
+        self.automate = automate
+
+    async def start(self):
+        await self.automate.send_message('start-pftpd')
+
+    async def stop(self):
+        await self.automate.send_message('stop-pftpd')
+
+class AutomateTailscaleManager(Manager):
+    def __init__(self, automate: Automate):
+        self.automate = automate
+
+    async def start(self):
+        await self.automate.send_message('start-tailscale')
+
+    async def stop(self):
+        await self.automate.send_message('stop-tailscale')
+
+class AutomateState(State):
+    VARIABLE_STATE = 'state'
+
+    def __init__(self, session: aiohttp.ClientSession, webhooks: Webhooks, automate: Automate, external_url: str):
+        self.session = session
+        self.webhooks = webhooks
+        self.automate = automate
+        self.external_url = external_url
+
+    async def get(self, repeat: float, timeout: float):
+        logger.info("Getting state...")
+        # first test funnel + webhooks availability, to not wait for a reply if local tailscale or funnel is down
+        # though it will be routed locally, it will not go out to Tailscale's TCP forwarder servers, so the route is different from what Automate will see
+        logger.debug("Testing funnel with pinging local webhook (timeout is %ds)", int(timeout))
+        try:
+            async with self.session.get(f'{self.external_url}{Webhooks.get_ping_path()}', timeout=ClientTimeout(total=timeout)) as response:
+                if await response.text() != 'pong':
+                    raise Exception()
+        except:
+            raise RuntimeError(f"Local Tailscale is down or local Funnel is not configured properly for {self.external_url}")
+        # get state
+        logger.debug("Getting state (repeat after %ds, timeout is %ds)", int(repeat), int(timeout))
+        self.webhooks.subscribe_variable(AutomateState.VARIABLE_STATE)
+        try:
+            async with asyncio.timeout(timeout):
+                while True:
+                    try:
+                        await self.automate.send_message(f'get-state;{self.external_url}{Webhooks.get_variable_path(AutomateState.VARIABLE_STATE)}')
+                        state = await self.webhooks.get_variable(AutomateState.VARIABLE_STATE, min(repeat, timeout))
+                        break
+                    except TimeoutError:
+                        pass
+        except TimeoutError as e:
+            e.add_note(f"Can't get value of {AutomateState.VARIABLE_STATE} for {timeout} seconds")
+            raise
+        finally:
+            self.webhooks.unsubscribe_variable(AutomateState.VARIABLE_STATE)
+        logger.info("  state is %s", state)
+        return StateSerializer.loads(state)
+
+########
+
+class Cache:
+    PRIM_SYNC_APP_NAME = 'prim-sync'
+
+    def __init__(self):
+        self.cache_path = Path(user_cache_dir(Cache.PRIM_SYNC_APP_NAME, False))
+
+    def set(self, key: str, value: str):
+        self.cache_path.mkdir(parents=True, exist_ok=True)
+        cache_filename = str(self.cache_path / key)
+        with open(cache_filename, 'wt') as file:
+            file.write(value)
+
+    def get(self, key: str):
+        self.cache_path.mkdir(parents=True, exist_ok=True)
+        cache_filename = str(self.cache_path / key)
+        if os.path.exists(cache_filename) and os.path.isfile(cache_filename):
+            with open(cache_filename, 'rt') as file:
+                return file.readline().rstrip()
+        else:
+            return None
+
+class ServiceCache:
+    def __init__(self, cache: Cache):
+        self.cache = cache
+
+    def set(self, service_name: str, host: str, port: int):
+        self.cache.set(service_name, '|'.join([host, str(port)]))
+
+    def get(self, service_name: str):
+        if cached_value := self.cache.get(service_name):
+            cached_value = cached_value.split('|')
+            return (cached_value[0], int(cached_value[1]))
+        else:
+            return (None, None)
+
+class ServiceResolver:
+    def __init__(self, zeroconf: AsyncZeroconf, service_type: str):
+        self.zeroconf = zeroconf
+        self.service_type = service_type
+
+    async def get(self, service_name: str, timeout: float = 3):
+        service_info = await self.zeroconf.async_get_service_info(self.service_type, f"{service_name}.{self.service_type}", timeout=int(timeout*1000))
+        if not service_info or not service_info.port:
+            raise TimeoutError("Unable to resolve zeroconf (DNS-SD) service information")
+        return (service_info.parsed_addresses()[0], int(service_info.port))
+
+class ServiceListener:
+    @abstractmethod
+    def set_service(self, service_name: str, service_info: ServiceInfo):
+        pass
+
+    @abstractmethod
+    def del_service(self, service_name: str):
+        pass
+
+class ServiceBrowser:
+    def __init__(self, zeroconf: AsyncZeroconf, service_type: str):
+        self.zeroconf = zeroconf
+        self.service_type = service_type
+
+    class ServiceListenerWrapper(ZeroconfServiceListener):
+        def __init__(self, listener: ServiceListener):
+            self.listener = listener
+
+        @staticmethod
+        def get_service_name(name: str):
+            return name.split('.', maxsplit=1)[0]
+
+        def set_service(self, zc: Zeroconf, type_: str, name: str):
+            service_info = ServiceInfo(type_, name)
+            if service_info.load_from_cache(zc):
+                self.listener.set_service(ServiceBrowser.ServiceListenerWrapper.get_service_name(name), service_info)
+
+        def del_service(self, zc: Zeroconf, type_: str, name: str):
+            self.listener.del_service(ServiceBrowser.ServiceListenerWrapper.get_service_name(name))
+
+        def add_service(self, zc: Zeroconf, type_: str, name: str):
+            self.set_service(zc, type_, name)
+
+        def remove_service(self, zc: Zeroconf, type_: str, name: str):
+            self.del_service(zc, type_, name)
+
+        def update_service(self, zc: Zeroconf, type_: str, name: str):
+            self.set_service(zc, type_, name)
+
+    async def add_service_listener(self, listener: ServiceListener):
+        await self.zeroconf.async_add_service_listener(self.service_type, ServiceBrowser.ServiceListenerWrapper(listener))
+
+SFTP_SERVICE_TYPE = '_sftp-ssh._tcp.local.'
+
+class SftpServiceResolver(ServiceResolver):
+    def __init__(self, zeroconf: AsyncZeroconf):
+        super().__init__(zeroconf, SFTP_SERVICE_TYPE)
+
+class SftpServiceBrowser(ServiceBrowser):
+    def __init__(self, zeroconf: AsyncZeroconf):
+        super().__init__(zeroconf, SFTP_SERVICE_TYPE)
+
+class ZeroconfService(Manageable):
+    def __init__(self, service_name: str, service_cache: ServiceCache, service_resolver: ServiceResolver, manager: Manager):
+        super().__init__(manager)
+        self.service_name = service_name
+        self.host = None
+        self.port = None
+        self.service_cache = service_cache
+        self.service_resolver = service_resolver
+
+    async def ping(self, availability_hint: bool | None = None):
+        async def _connect(connect_timeout: float, resolve_timeout: float):
+            async def asyncio_open_connection(host: str, port: int, timeout: float):
+                logger.debug(" Connecting to %s on port %d (timeout is %ds)", host, port, timeout)
+                async with asyncio.timeout(timeout):
+                    return await asyncio.open_connection(host, port)
+            async def service_resolver_get(service_name: str, timeout: float):
+                logger.debug(" Resolving %s (timeout is %ds)", service_name, timeout)
+                return await self.service_resolver.get(service_name, timeout)
+            if self.host and self.port:
+                return await asyncio_open_connection(self.host, self.port, connect_timeout)
+            host, port = self.service_cache.get(self.service_name)
+            if host and port:
+                try:
+                    reader_writer = await asyncio_open_connection(host, port, connect_timeout)
+                    self.host = host
+                    self.port = port
+                    return reader_writer
+                except (TimeoutError, socket.gaierror, ConnectionRefusedError):
+                    if availability_hint is None or availability_hint:
+                        pass
+                    else:
+                        raise
+            host, port = await service_resolver_get(self.service_name, resolve_timeout)
+            reader_writer = await asyncio_open_connection(host, port, connect_timeout)
+            self.service_cache.set(self.service_name, host, port)
+            self.host = host
+            self.port = port
+            return reader_writer
+        logger.debug("Pinging %s (%s - %s:%s)", LazyStr(self.get_class_name), self.service_name, str(self.host), str(self.port))
+        try:
+            _reader, writer = await _connect(2, 6)
+            writer.close()
+            await writer.wait_closed()
+            return True
+        except (TimeoutError, socket.gaierror, ConnectionRefusedError):
+            return False
+        except Exception as e:
+            logger.debug("  Unexpected ping exception: %s", e.__str__())
+            raise
+
+########
+
+class Phone:
+    def __init__(self, local_sftp: ZeroconfService, vpn: Device | None, remote_sftp: Service | None, state: State | None):
+        self.local_sftp = local_sftp
+        self.vpn = vpn
+        self.remote_sftp = remote_sftp
+        self.state = state
+
+class pFTPdServiceListener(ServiceListener):
+    def __init__(self, server_name: str, cache: ServiceCache):
+        self.server_name = server_name
+        self.cache = cache
+
+    def set_service(self, service_name: str, service_info: ServiceInfo):
+        if service_name == self.server_name and service_info.port:
+            host = service_info.parsed_addresses()[0]
+            port = int(service_info.port)
+            self.cache.set(service_name, host, port)
+            logger.debug(" (ServiceListener) Resolved %s to %s:%d", service_name, host, port)
+
+    def del_service(self, service_name: str):
+        pass
+
+class pFTPd(Service):
+    pass
+
+class pFTPdZeroconf(ZeroconfService):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.__qualname__ = pFTPd.__qualname__
+
+class Tailscale(Device):
+    def __init__(self, tailnet: str, machine_name: str, manager: Manager):
+        super().__init__(f'{machine_name}.{tailnet}', manager)
+        self.tailnet = tailnet
+
+class Funnel:
+    LOCAL_HOST = '127.0.0.1'
+
+    def __init__(self, tailscale: Tailscale, machine_name: str, local_port: int, local_path: str, external_port: int):
+        self.local_port = local_port
+        self.external_url = f'https://{machine_name}.{tailscale.tailnet}:{external_port}{local_path}'
+
+########
+
+class WideHelpFormatter(argparse.RawTextHelpFormatter):
+    def __init__(self, prog: str, indent_increment: int = 2, max_help_position: int = 35, width: int | None = None) -> None:
+        super().__init__(prog, indent_increment, max_help_position, width)
+
+async def gather_with_taskgroup(*coros):
+    try:
+        async with asyncio.TaskGroup() as tg:
+            tasks = [tg.create_task(coro) for coro in coros]
+        return tuple([task.result() for task in tasks])
+    except ExceptionGroup as eg:
+        raise eg.exceptions[0] from (None if len(eg.exceptions) == 1 else eg)
+
+class Control:
+    WIFI = 'wifi'
+    VPN = 'vpn'
+    SFTP = 'sftp'
+    CONNECTED = 'connected'
+    LOCAL = 'local'
+    REMOTE = 'remote'
+
+    @staticmethod
+    def setup_parser_arguments(parser):
+        parser.add_argument('server_name', metavar='server-name', help="the Servername configuration option from Primitive FTPd app")
+        parser.add_argument('-i', '--intent', choices=["test", "start", "stop"], help="what to do with the apps, default: test", default="test")
+
+    @staticmethod
+    def setup_parser_options(parser):
+        pass
+
+    @staticmethod
+    def setup_parser_groups(parser):
+        logging_group = parser.add_argument_group('logging')
+        logging_group.add_argument('-t', '--timestamp', help="prefix each message with an UTC timestamp", default=False, action='store_true')
+        logging_group.add_argument('-s', '--silent', help="only errors printed", default=False, action='store_true')
+        logging_group.add_argument('--debug', help="use debug level logging and add stack trace for exceptions, disables the --silent and enables the --timestamp options", default=False, action='store_true')
+
+    @staticmethod
+    def setup_parser_vpngroup(vpn_group):
+        vpn_group.add_argument('-ac', '--accept-cellular', help="in case of start, if WiFi is not connected, don't return error, but start VPN up", default=False, action='store_true')
+        vpn_group.add_argument('-b', '--backup-state', help="in case of start, backup current state to stdout as single string (in case of an error, it will try to restore the original state but will not write it to stdout)", default=False, action='store_true')
+        vpn_group.add_argument('-r', '--restore-state', metavar="STATE", help="in case of stop, restore previous state from STATE (use -b to get a valid STATE string)", action='store')
+
+    @abstractmethod
+    async def run(self, args):
+        pass
+
+    def prepare(self, args):
+        if args.debug:
+            logger.setLevel(logging.DEBUG)
+        logger.prepare(args.timestamp or args.debug, args.silent)
+
+        if args.accept_cellular and args.intent != 'start':
+            raise ValueError("The --accept-cellular options can be enabled only for the start intent")
+        if args.backup_state and args.intent != 'start':
+            raise ValueError("The --backup-state option can be enabled only for the start intent")
+        if args.restore_state and args.intent != 'stop':
+            raise ValueError("The --restore-state option can be enabled only for the stop intent")
+
+    async def execute(self, args, phone: Phone):
+        async def _stop(restore_state: dict | None):
+            if phone.vpn and phone.remote_sftp and await phone.vpn.test():
+                if (restore_state is None or not restore_state.get(Control.SFTP, False)) and await phone.remote_sftp.test():
+                    await phone.remote_sftp.stop(10, 30)
+                if restore_state is None or not restore_state.get(Control.VPN, False):
+                    await phone.vpn.stop(10, 60)
+            else:
+                if (restore_state is None or not restore_state.get(Control.SFTP, False)):
+                    await phone.local_sftp.stop(10, 30)
+        match args.intent:
+            case 'test':
+                if phone.vpn and phone.remote_sftp and phone.state:
+                    phone_state, _vpn_state = await gather_with_taskgroup(phone.state.get(10, 30), phone.vpn.test())
+                    for k, v in phone_state.items():
+                        logger.info("%s is %s", LazyStr(lambda: State.NAMES[k]), LazyStr(StateSerializer.dump_value, v))
+                elif phone.vpn and phone.remote_sftp and await phone.vpn.test():
+                    await phone.remote_sftp.test()
+                else:
+                    await phone.local_sftp.test()
+            case 'start':
+                if phone.vpn and phone.remote_sftp:
+                    state = dict()
+                    local_accessible = False
+                    remote_accessible = False
+                    # gather state info
+                    if phone.state:
+                        phone_state, vpn_state = await gather_with_taskgroup(phone.state.get(10, 30), phone.vpn.test())
+                        state[Control.WIFI] = phone_state[State.WIFI]
+                        state[Control.VPN] = vpn_state
+                        state[Control.SFTP] = phone_state[State.PFTPD]
+                        if not state[Control.WIFI] and not args.accept_cellular:
+                            raise RuntimeError(f"Phone is not on Wi-Fi network")
+                    else:
+                        state[Control.VPN] = await phone.vpn.test()
+                        if state[Control.VPN]:
+                            state[Control.SFTP] = remote_accessible = await phone.remote_sftp.test()
+                    # start changing state
+                    try:
+                        if phone.state:
+                            if not state[Control.SFTP]:
+                                if not state[Control.VPN]:
+                                    if state[Control.WIFI]:
+                                        try:
+                                            local_accessible = await phone.local_sftp.start(10, 30)
+                                        except TimeoutError:
+                                            await phone.vpn.start(10, 60)
+                                            remote_accessible = await phone.remote_sftp.test()
+                                    else:
+                                        await phone.vpn.start(10, 60)
+                                        remote_accessible = await phone.remote_sftp.start(10, 30)
+                                else:
+                                    remote_accessible = await phone.remote_sftp.start(10, 30)
+                                    if state[Control.WIFI]:
+                                        local_accessible = await phone.local_sftp.test()
+                            else:
+                                if not state[Control.VPN]:
+                                    if not state[Control.WIFI] or not (local_accessible := await phone.local_sftp.test()):
+                                        await phone.vpn.start(10, 60)
+                                        remote_accessible = await phone.remote_sftp.test()
+                                else:
+                                    local_accessible, remote_accessible = await gather_with_taskgroup(phone.local_sftp.test(), phone.remote_sftp.test())
+                        else:
+                            if not state[Control.VPN]:
+                                if not (local_accessible := await phone.local_sftp.test()):
+                                    try:
+                                        local_accessible = await phone.local_sftp.start(10, 30)
+                                    except TimeoutError:
+                                        await phone.vpn.start(10, 60)
+                                        remote_accessible = await phone.remote_sftp.test()
+                            else:
+                                if not state[Control.SFTP]:
+                                    remote_accessible = await phone.remote_sftp.start(10, 30)
+                                local_accessible = await phone.local_sftp.test()
+                        if not local_accessible and not remote_accessible:
+                            raise RuntimeError(f"Even when {phone.vpn.get_class_name()} and {phone.remote_sftp.get_class_name()} is started, {phone.remote_sftp.get_class_name()} is still not accessible")
+                    except:
+                        await _stop(state)
+                        raise
+                    if not args.backup_state:
+                        state = dict()
+                    state[Control.CONNECTED] = Control.LOCAL if local_accessible else Control.REMOTE
+                    print(StateSerializer.dumps(state))
+                else:
+                    if not await phone.local_sftp.test():
+                        try:
+                            await phone.local_sftp.start(10, 30)
+                        except:
+                            await _stop(None)
+                            raise
+            case 'stop':
+                await _stop(StateSerializer.loads(args.restore_state) if args.restore_state else None)
+
+class AutomateControl(Control):
+    @staticmethod
+    def setup_subparser(subparsers):
+        parser = subparsers.add_parser('Automate', aliases=['a'],
+            description="Remote control of your phone's Primitive FTPd and optionally Tailscale app statuses via the Automate app, for more details see https://github.com/lmagyar/prim-ctrl\n\n"
+                "Note: you must install Automate app on your phone, download prim-ctrl flow into it, and configure your Google account in the flow to receive messages (see the project's GitHub page for more details)\n"
+                "Note: optionally if your phone is not accessible on local network but your laptop is part of the Tailscale VPN then Tailscale VPN can be started on the phone\n"
+                "Note: optionally if your laptop is accessible through Tailscale Funnel then VPN on cellular can be refused and app statuses on the phone can be backed up and restored\n\n"
+                "Output: even when -b option is not used, the script will output 'connected=(local|remote)', what you can use to determine whether to use -a option for the prim-sync script",
+            formatter_class=WideHelpFormatter)
+
+        parser.add_argument('automate_account', metavar='automate-account', help="your Google account email you set up in the Automate flow's first Set variable block's Value field")
+        parser.add_argument('automate_device', metavar='automate-device', help="the device name you can see at the Automate flow's Cloud receive block's This device field")
+        parser.add_argument('automate_tokenfile', metavar='automate-tokenfile', help="filename containing Automates's Secret that located under your .secrets folder\n"
+                            "(generated on https://llamalab.com/automate/cloud, use the same Google account you set up on the Cloud receive block)")
+
+        Control.setup_parser_arguments(parser)
+
+        Control.setup_parser_options(parser)
+
+        Control.setup_parser_groups(parser)
+
+        vpn_group = parser.add_argument_group('VPN',
+            description="To use --tailscale option you must install Tailscale and configure Tailscale VPN on your phone and your laptop\n"
+                "To use --funnel option you must configure Tailscale Funnel on your laptop for prim-ctrl's local webhook to accept responses from the Automate app\n"
+                "   (eg.: tailscale funnel --bg --https=8443 --set-path=/prim-ctrl \"http://127.0.0.1:12345\")\n"
+                "Note: --funnel, --backup-state and --restore-state options can be used only when --tailscale is used\n"
+                "Note: --backup-state is accurate only, when --funnel is used\n"
+                "Note: --accept-cellular option can be used only when --funnel is used")
+        vpn_group.add_argument('--tailscale', nargs=3, metavar=('tailnet', 'remote-machine-name', 'sftp-port'), help=
+                            "tailnet:             your Tailscale tailnet name (eg. tailxxxx.ts.net)\n"
+                            "remote-machine-name: your phone's name within your tailnet (just the name, without the tailnet)\n"
+                            "sftp-port:           Primitive FTPd's sftp port")
+        vpn_group.add_argument('--funnel', nargs=4, metavar=('local-machine-name', 'local-port', 'local-path', 'external-port'), help=
+                            "local-machine-name:  your laptop's name within your tailnet (just the name, without the tailnet)\n"
+                            "local-port:          12345 - if you used the example tailscale funnel command above (the local webhook will be started on this port)\n"
+                            "local-path:          /prim-ctrl - if you used the example tailscale funnel command above\n"
+                            "external-port:       8443 - if you used the example tailscale funnel command above")
+        Control.setup_parser_vpngroup(vpn_group)
+
+        parser.set_defaults(ctor=AutomateControl)
+
+    def prepare(self, args):
+        super().prepare(args)
+        if args.funnel and not args.tailscale:
+            raise ValueError("--funnel option can be used only when --tailscale is used")
+        if args.backup_state and not args.tailscale:
+            raise ValueError("--backup-state option can be used only when --tailscale is used")
+        if args.restore_state and not args.tailscale:
+            raise ValueError("--restore-state option can be used only when --tailscale is used")
+        if args.accept_cellular and not args.funnel:
+            raise ValueError("--accept-cellular option can be used only when --funnel is used")
+
+    async def run(self, args):
+        self.prepare(args)
+
+        async with (
+            aiohttp.ClientSession(
+                # Automate messaging server prefers closing connections
+                connector=aiohttp.TCPConnector(force_close=True)) as session,
+            AsyncZeroconf() as zeroconf
+        ):
+            service_cache = ServiceCache(Cache())
+            service_resolver = SftpServiceResolver(zeroconf)
+            service_listener = pFTPdServiceListener(args.server_name, service_cache)
+            service_browser = SftpServiceBrowser(zeroconf)
+            await service_browser.add_service_listener(service_listener)
+
+            automate = Automate(Secrets(), session, args.automate_account, args.automate_device, args.automate_tokenfile)
+            local_pftpd = pFTPdZeroconf(args.server_name, service_cache, service_resolver, AutomatepFTPdManager(automate))
+            tailscale = Tailscale(args.tailscale[0], args.tailscale[1], AutomateTailscaleManager(automate)) if args.tailscale else None
+            remote_pftpd = pFTPd(tailscale.host, int(args.tailscale[2]), local_pftpd.manager) if tailscale else None
+            funnel = Funnel(tailscale, args.funnel[0], int(args.funnel[1]), args.funnel[2], int(args.funnel[3])) if tailscale and args.funnel else None
+
+            async with Webhooks(Funnel.LOCAL_HOST, funnel.local_port) if funnel else nullcontext() as webhooks:
+                state = AutomateState(session, webhooks, automate, funnel.external_url) if funnel and webhooks else None
+                phone = Phone(local_pftpd, tailscale, remote_pftpd, state)
+                await self.execute(args, phone)
+
+async def main():
+    args = None
+    try:
+        parser = argparse.ArgumentParser(
+            description="Remote control of your phone's Primitive FTPd and optionally Tailscale app statuses via the Automate app, for more details see https://github.com/lmagyar/prim-ctrl",
+            formatter_class=WideHelpFormatter)
+        subparsers = parser.add_subparsers(required=True,
+            title="Phone app to use for control")
+
+        AutomateControl.setup_subparser(subparsers)
+
+        args = parser.parse_args()
+        await args.ctor().run(args)
+
+    except Exception as e:
+        if not args or args.debug:
+            logger.exception(e)
+        else:
+            if hasattr(e, '__notes__'):
+                logger.error("%s: %s", LazyStr(repr, e), LazyStr(", ".join, e.__notes__))
+            else:
+                logger.error(LazyStr(repr, e))
+
+    return logger.exitcode
+
+def run():
+    with suppress(KeyboardInterrupt):
+        exit(asyncio.run(main()))

prim_ctrl-0.3.0.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

prim_ctrl-0.3.0.dist-info/METADATA

@@ -0,0 +1,215 @@
+Metadata-Version: 2.1
+Name: prim-ctrl
+Version: 0.3.0
+Summary: Primitive Ctrl - Remote control of your phone's Primitive FTPd Android SFTP server and optionally Tailscale VPN.
+Home-page: https://github.com/lmagyar/prim-ctrl
+License: Apache-2.0
+Author: Laszlo Magyar
+Author-email: lmagyar1973@gmail.com
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: aiohttp (==3.10.5)
+Requires-Dist: platformdirs (==4.3.2)
+Requires-Dist: zeroconf (==0.134.0)
+Project-URL: Change Log, https://github.com/lmagyar/prim-ctrl/blob/main/CHANGELOG.md
+Project-URL: Repository, https://github.com/lmagyar/prim-ctrl
+Description-Content-Type: text/markdown
+
+
+> [!WARNING]
+> ***This repository works with both the original and the forked version of the Primitive FTPd Android SFTP server!***
+> - ***install my fork from https://github.com/lmagyar/prim-ftpd - and use the prim-ctrl-lmagyar Automate flow below***
+> - ***install the original version from https://github.com/wolpi/prim-ftpd - and use the prim-ctrl Automate flow below***
+
+# Primitive Ctrl
+
+Remote control of your phone's [Primitive FTPd Android SFTP server](https://github.com/wolpi/prim-ftpd) and optionally [Tailscale VPN](https://tailscale.com/).
+
+Though Primitive FTPd consumes minimal power when it is not used, remote start/stop can be usefull for zeroconf (DNS-SD). Android doesn't reply DSN-SD queries when the screen is off, but Android announces the new service when the Primitive FTPd server starts up. So SFTP clients can/should capture and cache the announcement at Primitive FTPd server startup to connect to a phone through zeroconf even when the screen is off.
+
+But in case of Tailscale, it is a real battery and mobile network data drain when not used, remote start/stop is de facto very useful.
+
+With the help of this script you can sync your phone with eg. your home NAS server whereever your phone is on a WiFi network - or even on cellular. Your phone doesn't have to be on the same LAN to make zeroconf working when you have alternative access through VPN.
+
+See my other project, https://github.com/lmagyar/prim-sync, for bidirectional and unidirectional sync over SFTP (multiplatform Python script optimized for the Primitive FTPd SFTP server).
+
+See my other project, https://github.com/lmagyar/prim-batch, for batch execution of prim-ctrl and prim-sync commands.
+
+**Note:** These are my first ever Python projects, any comments on how to make them better are appreciated.
+
+## Features
+
+- Remote start/stop of Primitive FTPd Android SFTP server and optionally Tailscale VPN
+- Using VPN on cellular can be refused
+- Backup states before starting them, restore when stopping (ie. they won't be stopped if they were running before the script were asked to start them)
+
+## Installation
+
+You need to install:
+- Automate on your phone - see: https://llamalab.com/automate/
+
+- Python 3.12+, pip and venv on your laptop - see: https://www.python.org/downloads/ or
+  <details><summary>Unix</summary>
+
+  ```
+  sudo apt update
+  sudo apt upgrade
+  sudo apt install python3 python3-pip python3-venv
+  ```
+  </details>
+  <details><summary>Windows</summary>
+
+  - Install from Microsoft Store the latest [Python 3](https://apps.microsoft.com/search?query=python+3&department=Apps) (search), [Python 3.12](https://www.microsoft.com/store/productId/9NCVDN91XZQP) (App)
+  - Install from Chocolatey: `choco install python3 -y`
+  </details>
+
+- pipx - see: https://pipx.pypa.io/stable/installation/#installing-pipx or
+  <details><summary>Unix</summary>
+
+  ```
+  sudo apt install pipx
+  pipx ensurepath
+  ```
+  </details>
+  <details><summary>Windows</summary>
+
+  ```
+  py -m pip install --user pipx
+  py -m pipx ensurepath
+  ```
+  </details>
+
+- This repo
+  ```
+  pipx install prim-ctrl
+  ```
+
+Optionally you can install:
+- Tailscale on your phone and laptop - see: https://tailscale.com/download
+
+Optionally, if you want to edit or even contribute to the source, you also need to install:
+- poetry - see: https://python-poetry.org/
+  ```
+  pipx install poetry
+  ```
+
+## Configuration
+
+### Automate
+
+- Depending on whether you installed the [forked](https://github.com/lmagyar/prim-ftpd) or the [original](https://github.com/wolpi/prim-ftpd) version of Primitive FTPd, download the appropriate Automate flow to your phone:
+  - Flow for the **forked** Primitive FTPd: https://raw.githubusercontent.com/lmagyar/prim-ctrl/main/res/prim-ctrl-lmagyar.flo (see [image](https://raw.githubusercontent.com/lmagyar/prim-ctrl/main/res/prim-ctrl-lmagyar.png) of the flow)
+  - Flow for the **original** Primitive FTPd: https://raw.githubusercontent.com/lmagyar/prim-ctrl/main/res/prim-ctrl.flo (see [image](https://raw.githubusercontent.com/lmagyar/prim-ctrl/main/res/prim-ctrl.png) of the flow)
+- Import it with the ... menu / Import command
+- Enable all privileges
+- Click on the flow, edit the 2. block ("Set variable google_account to...), enter your Google account and press Save
+- Start the flow
+- Settings
+  - Run on system startup: enable
+
+### Primitive FTPd
+
+- Configuration tab
+  - UI
+    - Show notification to start/stop server(s): disable - this is necessary to determine whether Primitive FTPd is running on the phone or not, because the Automate flow determines whether the server is started with checking the existence of it's notification, and if the notification is always shown, that would make it false positive; please use another way, eg. a Quick Settings Tile to start/stop the server manually
+
+### Tailscale VPN (optional)
+
+Follow Tailscale's instructions on how to configure Tailscale VPN on your phone and laptop.
+
+For more details see: https://login.tailscale.com/start
+
+### Tailscale Funnel (optional)
+
+You can configure Tailscale Funnel on your laptop (for incoming connections to this script's webhooks from the internet). Until the Tailscale VPN is up on the phone, the phone can't send information directly to your laptop, to this script's webhooks. But Tailscale Funnel makes it possible to access a Tailscale VPN connected device's services from the wider internet.
+
+For more details see: https://tailscale.com/kb/1223/funnel
+
+An example Tailscale Funnel config command for this script is: `tailscale funnel --bg --https=8443 --set-path=/prim-ctrl "http://127.0.0.1:12345"`
+
+## Usage
+
+If you decide to use this script, I suggest to configure Tailscale VPN and Tailscale Funnel, this will provide the most functionality.
+
+Without any VPN, the script will start and stop the Primitive FTPd app on your phone making a best effort and assumes the phone is on the same LAN (ie. zeroconf works). This is fine if you start the script manually and your phone is with you.
+
+But if the script runs scheduled, we can't be sure whether the phone is on WiFi, is on the same WiFi as your laptop: it is better to configure the VPN and Funnel. And I suggest to use the backup and restore functionality also, in this case a scheduled script will not interfere with a manually started Primitive FTPd or VPN, you won't notice the synchronization is running while you are doing something else on the phone with the Primitive FTPd or the VPN.
+
+Notes:
+- Even when -b option is **not** used, the script will output 'connected=(local|remote)', what you can use to determine whether to use -a option for the prim-sync script
+
+### Some example
+
+<details><summary>Unix</summary>
+
+```
+prim-ctrl Automate youraccount@gmail.com "SOME MANUFACTURER XXX" automate your-phone-pftpd --tailscale tailxxxx.ts.net your-phone 2222 --funnel your-laptop 12345 /prim-ctrl 8443 -t -i start -b
+prim-ctrl Automate youraccount@gmail.com "SOME MANUFACTURER XXX" automate your-phone-pftpd --tailscale tailxxxx.ts.net your-phone 2222 --funnel your-laptop 12345 /prim-ctrl 8443 -t -i stop -r ${PREV_STATE}
+```
+</details>
+<details><summary>Windows</summary>
+
+```
+prim-ctrl Automate youraccount@gmail.com "SOME MANUFACTURER XXXX" automate your-phone-pftpd --tailscale tailxxxx.ts.net your-phone 2222 --funnel your-laptop 12345 /prim-ctrl 8443 -t -i start -b
+prim-ctrl Automate youraccount@gmail.com "SOME MANUFACTURER XXXX" automate your-phone-pftpd --tailscale tailxxxx.ts.net your-phone 2222 --funnel your-laptop 12345 /prim-ctrl 8443 -t -i stop -r !PREV_STATE!
+```
+</details>
+
+### Options
+
+```
+usage: prim-ctrl Automate [-h] [-i {test,start,stop}] [-t] [-s] [--debug] [--tailscale tailnet remote-machine-name sftp-port] [--funnel local-machine-name local-port local-path external-port] [-ac] [-b] [-r STATE]
+                          automate-account automate-device automate-tokenfile server-name
+
+Remote control of your phone's Primitive FTPd and optionally Tailscale app statuses via the Automate app, for more details see https://github.com/lmagyar/prim-ctrl
+
+Note: you must install Automate app on your phone, download prim-ctrl flow into it, and configure your Google account in the flow to receive messages (see the project's GitHub page for more details)
+Note: optionally if your phone is not accessible on local network but your laptop is part of the Tailscale VPN then Tailscale VPN can be started on the phone
+Note: optionally if your laptop is accessible through Tailscale Funnel then VPN on cellular can be refused and app statuses on the phone can be backed up and restored
+
+Output: even when -b option is not used, the script will output 'connected=(local|remote)', what you can use to determine whether to use -a option for the prim-sync script
+
+positional arguments:
+  automate-account                 your Google account email you set up in the Automate flow's first Set variable block's Value field
+  automate-device                  the device name you can see at the Automate flow's Cloud receive block's This device field
+  automate-tokenfile               filename containing Automates's Secret that located under your .secrets folder
+                                   (generated on https://llamalab.com/automate/cloud, use the same Google account you set up on the Cloud receive block)
+  server-name                      the Servername configuration option from Primitive FTPd app
+
+options:
+  -h, --help                       show this help message and exit
+  -i {test,start,stop}, --intent {test,start,stop}
+                                   what to do with the apps, default: test
+
+logging:
+  -t, --timestamp                  prefix each message with an UTC timestamp
+  -s, --silent                     only errors printed
+  --debug                          use debug level logging and add stack trace for exceptions, disables the --silent and enables the --timestamp options
+
+VPN:
+  To use --tailscale option you must install Tailscale and configure Tailscale VPN on your phone and your laptop
+  To use --funnel option you must configure Tailscale Funnel on your laptop for prim-ctrl's local webhook to accept responses from the Automate app
+     (eg.: tailscale funnel --bg --https=8443 --set-path=/prim-ctrl "http://127.0.0.1:12345")
+  Note: --funnel, --backup-state and --restore-state options can be used only when --tailscale is used
+  Note: --backup-state is accurate only, when --funnel is used
+  Note: --accept-cellular option can be used only when --funnel is used
+
+  --tailscale tailnet remote-machine-name sftp-port
+                                   tailnet:             your Tailscale tailnet name (eg. tailxxxx.ts.net)
+                                   remote-machine-name: your phone's name within your tailnet (just the name, without the tailnet)
+                                   sftp-port:           Primitive FTPd's sftp port
+  --funnel local-machine-name local-port local-path external-port
+                                   local-machine-name:  your laptop's name within your tailnet (just the name, without the tailnet)
+                                   local-port:          12345 - if you used the example tailscale funnel command above (the local webhook will be started on this port)
+                                   local-path:          /prim-ctrl - if you used the example tailscale funnel command above
+                                   external-port:       8443 - if you used the example tailscale funnel command above
+  -ac, --accept-cellular           in case of start, if WiFi is not connected, don't return error, but start VPN up
+  -b, --backup-state               in case of start, backup current state to stdout as single string (in case of an error, it will try to restore the original state but will not write it to stdout)
+  -r STATE, --restore-state STATE  in case of stop, restore previous state from STATE (use -b to get a valid STATE string)
+```
+

prim_ctrl-0.3.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+prim_ctrl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+prim_ctrl/__main__.py,sha256=SXH7tNGYvOAVSl8blNjC56ncvlvK0QDNbyJqUbZYorA,41180
+prim_ctrl-0.3.0.dist-info/entry_points.txt,sha256=00c0ccpamWF4op6U9_KJYBSUfSmUgcFOAj3IWI2J1Gk,52
+prim_ctrl-0.3.0.dist-info/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+prim_ctrl-0.3.0.dist-info/METADATA,sha256=hvwDmHA9A87o1f-bihl7OPX5291yYVTI-B4VHWlmJpc,12816
+prim_ctrl-0.3.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+prim_ctrl-0.3.0.dist-info/RECORD,,

prim_ctrl-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any

prim_ctrl-0.3.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+prim-ctrl=prim_ctrl.__main__:run
+