refactor: make backends extensible (#2)

* refactor: add black for formatting and some half-way refactorings, not functional yet. * refactor: use hatch * fix: some fixes to get stuff working * fix: get some xray functionality working * fix: get user addition/removal/update working * fix: xray logs * fix: xray core restart * fix: user usages * feat: log user modifications
marzneshin · May 17, 2024 · c962d16 · c962d16
1 parent 4450445
commit c962d16
Show file tree

Hide file tree

Showing 240 changed files with 1,067 additions and 750 deletions.
diff --git a/.gitignore b/.gitignore
@@ -169,3 +169,5 @@ xray-core
 *config.json
 bin/
 pyvenv.cfg
+_version.py
+
diff --git a/marznode.py b/marznode.py
@@ -4,6 +4,6 @@
 
 from marznode.marznode import main
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     loop = asyncio.new_event_loop()
     loop.run_until_complete(main())
diff --git a/marznode/__init__.py b/marznode/__init__.py
@@ -1,4 +1,5 @@
 """Initiate logger for marznode"""
+
 import logging
 
 from marznode import config

diff --git a/marznode/backends/__init__.py b/marznode/backends/__init__.py
diff --git a/marznode/backends/base.py b/marznode/backends/base.py
@@ -0,0 +1,37 @@
+"""What a vpn server should do"""
+
+from abc import ABC, abstractmethod
+from collections.abc import AsyncIterator
+from typing import Any
+
+from marznode.models import User, Inbound
+
+
+class VPNBackend(ABC):
+    @abstractmethod
+    def contains_tag(self, tag: str) -> bool:
+        raise NotImplementedError
+
+    @abstractmethod
+    async def start(self) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    async def restart(self, backend_config: Any) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    async def add_user(self, user: User, inbound: Inbound) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    async def remove_user(self, user: User, inbound: Inbound) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_logs(self, include_buffer: bool) -> AsyncIterator:
+        raise NotImplementedError
+
+    @abstractmethod
+    async def get_usages(self):
+        raise NotImplementedError
diff --git a/marznode/xray/__init__.py → marznode/backends/xray/__init__.py b/marznode/xray/__init__.py → marznode/backends/xray/__init__.py