Compare commits
64 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
3438b271a5
|
|||
| d6228d6d63 | |||
|
ccf954681b
|
|||
|
4ec44900cf
|
|||
|
d4099fb9a2
|
|||
|
1571b315b2
|
|||
|
71bd49bd7d
|
|||
|
382413dc08
|
|||
|
0621facc7d
|
|||
|
50cbfed5fa
|
|||
|
36d9a3350b
|
|||
|
515a9d9dbf
|
|||
|
3c27b4f9b8
|
|||
|
851c8c05d4
|
|||
|
8002a75e26
|
|||
|
06e6b55ecc
|
|||
|
48e47bd0bd
|
|||
|
9c074a0333
|
|||
|
f2314f862c
|
|||
|
6e57536650
|
|||
|
5fd7551874
|
|||
|
62d592c4d0
|
|||
|
8af2a9abbb
|
|||
|
64ca8bd4d2
|
|||
|
f1d025bd0e
|
|||
|
087ff563a2
|
|||
|
882dacf2bb
|
|||
|
a2efdb136a
|
|||
|
001613b4fa
|
|||
|
74564d0ef2
|
|||
|
81142ad194
|
|||
|
fee1d2e2d6
|
|||
|
7c93fdb71d
|
|||
| 9e435eeebc | |||
| 5dfcc1f2ce | |||
| 2def60b457 | |||
| f708ad4ee1 | |||
| f7568d81aa | |||
| 251f9bacef | |||
| 07892dbfee | |||
| 54e6849968 | |||
| ea27c380cb | |||
|
|
a338be85e1 | ||
|
|
e31cb3418b | ||
|
|
798725dca6 | ||
|
|
6f393497f0 | ||
|
|
14b5aabf2b | ||
| fb36907447 | |||
| 62fde2617b | |||
| 9f5ea23eb7 | |||
| 19fad61706 | |||
| c900cf38c9 | |||
| 014ebc25c6 | |||
|
|
d5e9308fb5 | ||
|
|
7d5e891261 | ||
|
|
c382ed790f | ||
| cb72e57da9 | |||
|
|
aaf5ad23e2 | ||
|
|
ce1b1dad7d | ||
|
|
67ebc7e556 | ||
|
|
b31fb748b8 | ||
|
|
eb27326763 | ||
|
|
f40d5a51ae | ||
|
|
4aa83a2dfb |
8
.github/workflows/docker-test.yml
vendored
8
.github/workflows/docker-test.yml
vendored
@@ -15,13 +15,13 @@ jobs:
|
|||||||
contents: read
|
contents: read
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
python-version: ["3.10", "3.11", "3.12", "3.13"]
|
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||||
- name: Set up Python ${{ matrix.python-version }}
|
- name: Set up Python ${{ matrix.python-version }}
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
|
||||||
with:
|
with:
|
||||||
python-version: ${{ matrix.python-version }}
|
python-version: ${{ matrix.python-version }}
|
||||||
- name: Build Docker Image
|
- name: Build Docker Image
|
||||||
run: docker build . --file Dockerfile --build-arg PYTHON_VERSION=${{ matrix.python-version }} --tag lxmfy-test:${{ matrix.python-version }}
|
run: docker build . --file docker/Dockerfile --build-arg PYTHON_VERSION=${{ matrix.python-version }} --tag lxmfy-test:${{ matrix.python-version }}
|
||||||
|
|||||||
19
.github/workflows/docker.yml
vendored
19
.github/workflows/docker.yml
vendored
@@ -20,18 +20,18 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||||
|
|
||||||
- name: Set up QEMU
|
- name: Set up QEMU
|
||||||
uses: docker/setup-qemu-action@v3
|
uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392
|
||||||
with:
|
with:
|
||||||
platforms: amd64,arm64
|
platforms: amd64,arm64
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@v3
|
uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435
|
||||||
|
|
||||||
- name: Log in to the Container registry
|
- name: Log in to the Container registry
|
||||||
uses: docker/login-action@v3
|
uses: docker/login-action@184bdaa0721073962dff0199f1fb9940f07167d1
|
||||||
with:
|
with:
|
||||||
registry: ${{ env.REGISTRY }}
|
registry: ${{ env.REGISTRY }}
|
||||||
username: ${{ github.actor }}
|
username: ${{ github.actor }}
|
||||||
@@ -39,7 +39,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Extract metadata (tags, labels) for Docker
|
- name: Extract metadata (tags, labels) for Docker
|
||||||
id: meta
|
id: meta
|
||||||
uses: docker/metadata-action@v5
|
uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f
|
||||||
with:
|
with:
|
||||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||||
tags: |
|
tags: |
|
||||||
@@ -51,9 +51,10 @@ jobs:
|
|||||||
type=sha,format=short
|
type=sha,format=short
|
||||||
|
|
||||||
- name: Build and push Docker image
|
- name: Build and push Docker image
|
||||||
uses: docker/build-push-action@v5
|
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
|
||||||
with:
|
with:
|
||||||
context: .
|
context: .
|
||||||
|
file: ./docker/Dockerfile
|
||||||
platforms: linux/amd64,linux/arm64
|
platforms: linux/amd64,linux/arm64
|
||||||
push: ${{ github.event_name != 'pull_request' }}
|
push: ${{ github.event_name != 'pull_request' }}
|
||||||
tags: ${{ steps.meta.outputs.tags }}
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
@@ -63,7 +64,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Extract metadata (tags, labels) for Docker (rootless)
|
- name: Extract metadata (tags, labels) for Docker (rootless)
|
||||||
id: meta_rootless
|
id: meta_rootless
|
||||||
uses: docker/metadata-action@v5
|
uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f
|
||||||
with:
|
with:
|
||||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}-rootless
|
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}-rootless
|
||||||
tags: |
|
tags: |
|
||||||
@@ -74,10 +75,10 @@ jobs:
|
|||||||
type=sha,format=short,suffix=-rootless
|
type=sha,format=short,suffix=-rootless
|
||||||
|
|
||||||
- name: Build and push rootless Docker image
|
- name: Build and push rootless Docker image
|
||||||
uses: docker/build-push-action@v5
|
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
|
||||||
with:
|
with:
|
||||||
context: .
|
context: .
|
||||||
file: ./Dockerfile.rootless
|
file: ./docker/Dockerfile.rootless
|
||||||
platforms: linux/amd64,linux/arm64
|
platforms: linux/amd64,linux/arm64
|
||||||
push: ${{ github.event_name != 'pull_request' }}
|
push: ${{ github.event_name != 'pull_request' }}
|
||||||
tags: ${{ steps.meta_rootless.outputs.tags }}
|
tags: ${{ steps.meta_rootless.outputs.tags }}
|
||||||
|
|||||||
50
.github/workflows/publish.yml
vendored
50
.github/workflows/publish.yml
vendored
@@ -1,5 +1,14 @@
|
|||||||
name: Publish Python 🐍 distribution 📦 to PyPI
|
name: Publish Python 🐍 distribution 📦 to PyPI
|
||||||
|
|
||||||
|
# This workflow creates immutable releases:
|
||||||
|
# 1. Build packages
|
||||||
|
# 2. Publish to PyPI (only on tag push)
|
||||||
|
# 3. After successful PyPI publish:
|
||||||
|
# - Sign artifacts
|
||||||
|
# - Check if GitHub release exists (idempotent)
|
||||||
|
# - Create release with all artifacts atomically
|
||||||
|
# This ensures releases cannot be modified once published.
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
tags:
|
tags:
|
||||||
@@ -23,11 +32,11 @@ jobs:
|
|||||||
contents: read
|
contents: read
|
||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4.2.2
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
||||||
with:
|
with:
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v5.3.0
|
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
|
||||||
with:
|
with:
|
||||||
python-version: "3.13"
|
python-version: "3.13"
|
||||||
- name: Install pypa/build
|
- name: Install pypa/build
|
||||||
@@ -35,7 +44,7 @@ jobs:
|
|||||||
- name: Build a binary wheel and a source tarball
|
- name: Build a binary wheel and a source tarball
|
||||||
run: python3 -m build
|
run: python3 -m build
|
||||||
- name: Store the distribution packages
|
- name: Store the distribution packages
|
||||||
uses: actions/upload-artifact@v4.5.0
|
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
|
||||||
with:
|
with:
|
||||||
name: python-package-distributions
|
name: python-package-distributions
|
||||||
path: dist/
|
path: dist/
|
||||||
@@ -55,12 +64,12 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Download all the dists
|
- name: Download all the dists
|
||||||
uses: actions/download-artifact@v4.1.8
|
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
|
||||||
with:
|
with:
|
||||||
name: python-package-distributions
|
name: python-package-distributions
|
||||||
path: dist/
|
path: dist/
|
||||||
- name: Publish distribution 📦 to PyPI
|
- name: Publish distribution 📦 to PyPI
|
||||||
uses: pypa/gh-action-pypi-publish@v1.12.3
|
uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e
|
||||||
|
|
||||||
github-release:
|
github-release:
|
||||||
name: Sign the Python 🐍 distribution 📦 and create GitHub Release
|
name: Sign the Python 🐍 distribution 📦 and create GitHub Release
|
||||||
@@ -73,28 +82,37 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Download all the dists
|
- name: Download all the dists
|
||||||
uses: actions/download-artifact@v4.1.8
|
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
|
||||||
with:
|
with:
|
||||||
name: python-package-distributions
|
name: python-package-distributions
|
||||||
path: dist/
|
path: dist/
|
||||||
- name: Sign the dists with Sigstore
|
- name: Sign the dists with Sigstore
|
||||||
uses: sigstore/gh-action-sigstore-python@v3.0.0
|
uses: sigstore/gh-action-sigstore-python@f7ad0af51a5648d09a20d00370f0a91c3bdf8f84 # v3.0.1
|
||||||
with:
|
with:
|
||||||
inputs: >-
|
inputs: >-
|
||||||
./dist/*.tar.gz
|
./dist/*.tar.gz
|
||||||
./dist/*.whl
|
./dist/*.whl
|
||||||
- name: Create GitHub Release
|
- name: Check if release exists
|
||||||
|
id: check_release
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ github.token }}
|
||||||
|
run: |
|
||||||
|
if gh release view "$GITHUB_REF_NAME" --repo "$GITHUB_REPOSITORY" >/dev/null 2>&1; then
|
||||||
|
echo "exists=true" >> $GITHUB_OUTPUT
|
||||||
|
echo "Release $GITHUB_REF_NAME already exists, skipping creation"
|
||||||
|
else
|
||||||
|
echo "exists=false" >> $GITHUB_OUTPUT
|
||||||
|
echo "Release $GITHUB_REF_NAME does not exist, will create"
|
||||||
|
fi
|
||||||
|
continue-on-error: true
|
||||||
|
- name: Create GitHub Release with artifacts
|
||||||
|
if: steps.check_release.outputs.exists != 'true'
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ github.token }}
|
GITHUB_TOKEN: ${{ github.token }}
|
||||||
run: >-
|
run: >-
|
||||||
gh release create
|
gh release create
|
||||||
"$GITHUB_REF_NAME"
|
"$GITHUB_REF_NAME"
|
||||||
--repo "$GITHUB_REPOSITORY"
|
--repo "$GITHUB_REPOSITORY"
|
||||||
--notes ""
|
--title "Release $GITHUB_REF_NAME"
|
||||||
- name: Upload artifact signatures to GitHub Release
|
--notes "PyPI: https://pypi.org/project/rns-page-node/$GITHUB_REF_NAME/"
|
||||||
env:
|
dist/*
|
||||||
GITHUB_TOKEN: ${{ github.token }}
|
|
||||||
run: >-
|
|
||||||
gh release upload
|
|
||||||
"$GITHUB_REF_NAME" dist/**
|
|
||||||
--repo "$GITHUB_REPOSITORY"
|
|
||||||
17
.github/workflows/safety.yml
vendored
Normal file
17
.github/workflows/safety.yml
vendored
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
name: Safety
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [ main ]
|
||||||
|
schedule:
|
||||||
|
- cron: '0 0 * * 0' # weekly
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@main
|
||||||
|
- name: Run Safety CLI to check for vulnerabilities
|
||||||
|
uses: pyupio/safety-action@7baf6605473beffc874c1313ddf2db085c0cacf2 # v1
|
||||||
|
with:
|
||||||
|
api-key: ${{ secrets.SAFETY_API_KEY }}
|
||||||
49
.github/workflows/tests.yml
vendored
Normal file
49
.github/workflows/tests.yml
vendored
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
name: Run Tests
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
shell: bash
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
os: ["ubuntu-latest", "windows-latest"]
|
||||||
|
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||||
|
|
||||||
|
- name: Set up Python ${{ matrix.python-version }}
|
||||||
|
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
|
||||||
|
with:
|
||||||
|
python-version: ${{ matrix.python-version }}
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
pip install -e .
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: |
|
||||||
|
cd tests
|
||||||
|
chmod +x run_tests.sh
|
||||||
|
timeout 120 ./run_tests.sh
|
||||||
|
|
||||||
|
- name: Upload test logs on failure
|
||||||
|
if: failure()
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: test-logs-${{ matrix.os }}-${{ matrix.python-version }}
|
||||||
|
path: tests/node.log
|
||||||
9
.gitignore
vendored
9
.gitignore
vendored
@@ -3,3 +3,12 @@ node-config/
|
|||||||
files/
|
files/
|
||||||
.ruff_cache/
|
.ruff_cache/
|
||||||
__pycache__/
|
__pycache__/
|
||||||
|
dist/
|
||||||
|
*.egg-info/
|
||||||
|
.ruff_cache/
|
||||||
|
.venv/
|
||||||
|
.env
|
||||||
|
.env.local
|
||||||
|
.env.development.local
|
||||||
|
.env.test.local
|
||||||
|
.env.production.local
|
||||||
15
Makefile
15
Makefile
@@ -2,19 +2,20 @@
|
|||||||
|
|
||||||
# Detect if docker buildx is available
|
# Detect if docker buildx is available
|
||||||
DOCKER_BUILD := $(shell docker buildx version >/dev/null 2>&1 && echo "docker buildx build" || echo "docker build")
|
DOCKER_BUILD := $(shell docker buildx version >/dev/null 2>&1 && echo "docker buildx build" || echo "docker build")
|
||||||
|
DOCKER_BUILD_LOAD := $(shell docker buildx version >/dev/null 2>&1 && echo "docker buildx build --load" || echo "docker build")
|
||||||
|
|
||||||
.PHONY: all build sdist wheel clean install lint format docker-wheels docker-build docker-run docker-build-rootless docker-run-rootless help test docker-test
|
.PHONY: all build sdist wheel clean install lint format docker-wheels docker-build docker-run docker-build-rootless docker-run-rootless help test docker-test
|
||||||
|
|
||||||
all: build
|
all: build
|
||||||
|
|
||||||
build: clean
|
build: clean
|
||||||
python3 setup.py sdist bdist_wheel
|
python3 -m build
|
||||||
|
|
||||||
sdist:
|
sdist:
|
||||||
python3 setup.py sdist
|
python3 -m build --sdist
|
||||||
|
|
||||||
wheel:
|
wheel:
|
||||||
python3 setup.py bdist_wheel
|
python3 -m build --wheel
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -rf build dist *.egg-info
|
rm -rf build dist *.egg-info
|
||||||
@@ -29,13 +30,13 @@ format:
|
|||||||
ruff check --fix .
|
ruff check --fix .
|
||||||
|
|
||||||
docker-wheels:
|
docker-wheels:
|
||||||
$(DOCKER_BUILD) --target builder -f Dockerfile.build -t rns-page-node-builder .
|
$(DOCKER_BUILD) --target builder -f docker/Dockerfile.build -t rns-page-node-builder .
|
||||||
docker create --name builder-container rns-page-node-builder true
|
docker create --name builder-container rns-page-node-builder true
|
||||||
docker cp builder-container:/src/dist ./dist
|
docker cp builder-container:/src/dist ./dist
|
||||||
docker rm builder-container
|
docker rm builder-container
|
||||||
|
|
||||||
docker-build:
|
docker-build:
|
||||||
$(DOCKER_BUILD) $(BUILD_ARGS) -f Dockerfile -t rns-page-node:latest .
|
$(DOCKER_BUILD_LOAD) $(BUILD_ARGS) -f docker/Dockerfile -t rns-page-node:latest .
|
||||||
|
|
||||||
docker-run:
|
docker-run:
|
||||||
docker run --rm -it \
|
docker run --rm -it \
|
||||||
@@ -50,7 +51,7 @@ docker-run:
|
|||||||
--announce-interval 360
|
--announce-interval 360
|
||||||
|
|
||||||
docker-build-rootless:
|
docker-build-rootless:
|
||||||
$(DOCKER_BUILD) $(BUILD_ARGS) -f Dockerfile.rootless -t rns-page-node-rootless:latest .
|
$(DOCKER_BUILD_LOAD) $(BUILD_ARGS) -f docker/Dockerfile.rootless -t rns-page-node-rootless:latest .
|
||||||
|
|
||||||
docker-run-rootless:
|
docker-run-rootless:
|
||||||
docker run --rm -it \
|
docker run --rm -it \
|
||||||
@@ -68,7 +69,7 @@ test:
|
|||||||
bash tests/run_tests.sh
|
bash tests/run_tests.sh
|
||||||
|
|
||||||
docker-test:
|
docker-test:
|
||||||
$(DOCKER_BUILD) -f tests/Dockerfile.tests -t rns-page-node-tests .
|
$(DOCKER_BUILD_LOAD) -f docker/Dockerfile.tests -t rns-page-node-tests .
|
||||||
docker run --rm rns-page-node-tests
|
docker run --rm rns-page-node-tests
|
||||||
|
|
||||||
help:
|
help:
|
||||||
|
|||||||
127
README.md
127
README.md
@@ -1,27 +1,82 @@
|
|||||||
# RNS Page Node
|
# RNS Page Node
|
||||||
|
|
||||||
|
[Русская](README.ru.md)
|
||||||
|
|
||||||
|
[](https://github.com/Sudo-Ivan/rns-page-node/actions/workflows/docker.yml)
|
||||||
|
[](https://github.com/Sudo-Ivan/rns-page-node/actions/workflows/docker-test.yml)
|
||||||
|
[](https://app.deepsource.com/gh/Sudo-Ivan/rns-page-node/)
|
||||||
|
|
||||||
A simple way to serve pages and files over the [Reticulum network](https://reticulum.network/). Drop-in replacement for [NomadNet](https://github.com/markqvist/NomadNet) nodes that primarily serve pages and files.
|
A simple way to serve pages and files over the [Reticulum network](https://reticulum.network/). Drop-in replacement for [NomadNet](https://github.com/markqvist/NomadNet) nodes that primarily serve pages and files.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Serves pages and files over RNS
|
||||||
|
- Dynamic page support with environment variables
|
||||||
|
- Form data and request parameter parsing
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# Pip
|
||||||
|
# May require --break-system-packages
|
||||||
|
|
||||||
pip install rns-page-node
|
pip install rns-page-node
|
||||||
|
|
||||||
|
# Pipx
|
||||||
|
|
||||||
|
pipx install rns-page-node
|
||||||
|
|
||||||
|
# uv
|
||||||
|
|
||||||
|
uv venv
|
||||||
|
source .venv/bin/activate
|
||||||
|
uv pip install rns-page-node
|
||||||
|
|
||||||
|
# Pipx via Git
|
||||||
|
|
||||||
|
pipx install git+https://github.com/Sudo-Ivan/rns-page-node.git
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# will use current directory for pages and files
|
||||||
rns-page-node
|
rns-page-node
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
or with command-line options:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
rns-page-node --node-name "Page Node" --pages-dir ./pages --files-dir ./files --identity-dir ./node-config --announce-interval 360
|
rns-page-node --node-name "Page Node" --pages-dir ./pages --files-dir ./files --identity-dir ./node-config --announce-interval 360
|
||||||
```
|
```
|
||||||
|
|
||||||
|
or with a config file:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
rns-page-node /path/to/config.conf
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configuration File
|
||||||
|
|
||||||
|
You can use a configuration file to persist settings. See `config.example` for an example.
|
||||||
|
|
||||||
|
Config file format is simple `key=value` pairs:
|
||||||
|
|
||||||
|
```
|
||||||
|
# Comment lines start with #
|
||||||
|
node-name=My Page Node
|
||||||
|
pages-dir=./pages
|
||||||
|
files-dir=./files
|
||||||
|
identity-dir=./node-config
|
||||||
|
announce-interval=360
|
||||||
|
```
|
||||||
|
|
||||||
|
Priority order: Command-line arguments > Config file > Defaults
|
||||||
|
|
||||||
### Docker/Podman
|
### Docker/Podman
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run -it --rm -v ./pages:/app/pages -v ./files:/app/files -v ./node-config:/app/node-config -v ./config:/app/config ghcr.io/sudo-ivan/rns-page-node:latest
|
docker run -it --rm -v ./pages:/app/pages -v ./files:/app/files -v ./node-config:/app/node-config -v ./config:/root/.reticulum ghcr.io/sudo-ivan/rns-page-node:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
### Docker/Podman Rootless
|
### Docker/Podman Rootless
|
||||||
@@ -54,60 +109,30 @@ make docker-wheels
|
|||||||
|
|
||||||
## Pages
|
## Pages
|
||||||
|
|
||||||
Supports Micron `.mu` and dynamic pages with `#!` in the micron files.
|
Supports dynamic executable pages with full request data parsing. Pages can receive:
|
||||||
|
- Form fields via `field_*` environment variables
|
||||||
|
- Link variables via `var_*` environment variables
|
||||||
|
- Remote identity via `remote_identity` environment variable
|
||||||
|
- Link ID via `link_id` environment variable
|
||||||
|
|
||||||
## Statistics Tracking
|
This enables forums, chats, and other interactive applications compatible with NomadNet clients.
|
||||||
|
|
||||||
The node now includes comprehensive statistics tracking for monitoring peer connections and page/file requests:
|
|
||||||
|
|
||||||
### Command Line Options for Stats
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Print stats every 60 seconds
|
|
||||||
rns-page-node --stats-interval 60
|
|
||||||
|
|
||||||
# Save stats to JSON file on shutdown
|
|
||||||
rns-page-node --save-stats node_stats.json
|
|
||||||
|
|
||||||
# Actively write stats to file (live updates)
|
|
||||||
rns-page-node --stats-file stats.json
|
|
||||||
|
|
||||||
# Combined: live stats file + periodic display + final save
|
|
||||||
rns-page-node --stats-file stats.json --stats-interval 300 --save-stats final_stats.json
|
|
||||||
```
|
|
||||||
|
|
||||||
### Docker Stats Usage
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# With periodic stats display
|
|
||||||
docker run -it --rm -v ./pages:/app/pages -v ./files:/app/files -v ./node-config:/app/node-config -v ./config:/app/config ghcr.io/sudo-ivan/rns-page-node:latest --stats-interval 60
|
|
||||||
|
|
||||||
# Save stats to mounted volume
|
|
||||||
docker run -it --rm -v ./pages:/app/pages -v ./files:/app/files -v ./node-config:/app/node-config -v ./config:/app/config -v ./stats:/app/stats ghcr.io/sudo-ivan/rns-page-node:latest --save-stats /app/stats/node_stats.json
|
|
||||||
```
|
|
||||||
|
|
||||||
### Tracked Metrics
|
|
||||||
|
|
||||||
- **Connection Statistics**: Total connections, active connections, peer tracking
|
|
||||||
- **Request Statistics**: Page requests, file requests, requests by path and peer
|
|
||||||
- **Performance Metrics**: Requests per hour, uptime, response patterns
|
|
||||||
- **Historical Data**: Recent request history, hourly/daily aggregations
|
|
||||||
- **Top Content**: Most requested pages and files, most active peers
|
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
```
|
```
|
||||||
-c, --config: The path to the Reticulum config file.
|
Positional arguments:
|
||||||
-n, --node-name: The name of the node.
|
node_config Path to rns-page-node config file
|
||||||
-p, --pages-dir: The directory to serve pages from.
|
|
||||||
-f, --files-dir: The directory to serve files from.
|
Optional arguments:
|
||||||
-i, --identity-dir: The directory to persist the node's identity.
|
-c, --config Path to the Reticulum config file
|
||||||
-a, --announce-interval: The interval to announce the node's presence.
|
-n, --node-name Name of the node
|
||||||
--page-refresh-interval: The interval to refresh pages (seconds, 0 disables).
|
-p, --pages-dir Directory to serve pages from
|
||||||
--file-refresh-interval: The interval to refresh files (seconds, 0 disables).
|
-f, --files-dir Directory to serve files from
|
||||||
-l, --log-level: The logging level.
|
-i, --identity-dir Directory to persist the node's identity
|
||||||
--stats-interval: Print stats every N seconds (0 disables).
|
-a, --announce-interval Interval to announce the node's presence (in minutes, default: 360 = 6 hours)
|
||||||
--save-stats: Save stats to JSON file on shutdown.
|
--page-refresh-interval Interval to refresh pages (in seconds, 0 = disabled)
|
||||||
|
--file-refresh-interval Interval to refresh files (in seconds, 0 = disabled)
|
||||||
|
-l, --log-level Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|||||||
124
README.ru.md
Normal file
124
README.ru.md
Normal file
@@ -0,0 +1,124 @@
|
|||||||
|
# RNS Page Node
|
||||||
|
|
||||||
|
[English](README.md)
|
||||||
|
|
||||||
|
Простой способ для раздачи страниц и файлов через сеть [Reticulum](https://reticulum.network/). Прямая замена для узлов [NomadNet](https://github.com/markqvist/NomadNet), которые в основном служат для раздачи страниц и файлов.
|
||||||
|
|
||||||
|
## Особенности
|
||||||
|
|
||||||
|
- Раздача страниц и файлов через RNS
|
||||||
|
- Поддержка динамических страниц с переменными окружения
|
||||||
|
- Разбор данных форм и параметров запросов
|
||||||
|
|
||||||
|
## Установка
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Pip
|
||||||
|
# Может потребоваться --break-system-packages
|
||||||
|
pip install rns-page-node
|
||||||
|
|
||||||
|
# Pipx
|
||||||
|
pipx install rns-page-node
|
||||||
|
|
||||||
|
# uv
|
||||||
|
uv venv
|
||||||
|
source .venv/bin/activate
|
||||||
|
uv pip install rns-page-node
|
||||||
|
|
||||||
|
# Pipx через Git
|
||||||
|
pipx install git+https://github.com/Sudo-Ivan/rns-page-node.git
|
||||||
|
|
||||||
|
```
|
||||||
|
## Использование
|
||||||
|
```bash
|
||||||
|
# будет использовать текущий каталог для страниц и файлов
|
||||||
|
rns-page-node
|
||||||
|
```
|
||||||
|
|
||||||
|
или с параметрами командной строки:
|
||||||
|
```bash
|
||||||
|
rns-page-node --node-name "Page Node" --pages-dir ./pages --files-dir ./files --identity-dir ./node-config --announce-interval 360
|
||||||
|
```
|
||||||
|
|
||||||
|
или с файлом конфигурации:
|
||||||
|
```bash
|
||||||
|
rns-page-node /путь/к/config.conf
|
||||||
|
```
|
||||||
|
|
||||||
|
### Файл Конфигурации
|
||||||
|
|
||||||
|
Вы можете использовать файл конфигурации для сохранения настроек. См. `config.example` для примера.
|
||||||
|
|
||||||
|
Формат файла конфигурации - простые пары `ключ=значение`:
|
||||||
|
|
||||||
|
```
|
||||||
|
# Строки комментариев начинаются с #
|
||||||
|
node-name=Мой Page Node
|
||||||
|
pages-dir=./pages
|
||||||
|
files-dir=./files
|
||||||
|
identity-dir=./node-config
|
||||||
|
announce-interval=360
|
||||||
|
```
|
||||||
|
|
||||||
|
Порядок приоритета: Аргументы командной строки > Файл конфигурации > Значения по умолчанию
|
||||||
|
|
||||||
|
### Docker/Podman
|
||||||
|
```bash
|
||||||
|
docker run -it --rm -v ./pages:/app/pages -v ./files:/app/files -v ./node-config:/app/node-config -v ./config:/root/.reticulum ghcr.io/sudo-ivan/rns-page-node:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
### Docker/Podman без root-доступа
|
||||||
|
```bash
|
||||||
|
mkdir -p ./pages ./files ./node-config ./config
|
||||||
|
chown -R 1000:1000 ./pages ./files ./node-config ./config
|
||||||
|
podman run -it --rm -v ./pages:/app/pages -v ./files:/app/files -v ./node-config:/app/node-config -v ./config:/app/config ghcr.io/sudo-ivan/rns-page-node:latest-rootless
|
||||||
|
```
|
||||||
|
|
||||||
|
Монтирование томов необязательно, вы также можете скопировать страницы и файлы в контейнер с помощью `podman cp` или `docker cp`.
|
||||||
|
|
||||||
|
## Сборка
|
||||||
|
```bash
|
||||||
|
make build
|
||||||
|
```
|
||||||
|
|
||||||
|
Сборка wheels:
|
||||||
|
```bash
|
||||||
|
make wheel
|
||||||
|
```
|
||||||
|
|
||||||
|
### Сборка Wheels в Docker
|
||||||
|
```bash
|
||||||
|
make docker-wheels
|
||||||
|
```
|
||||||
|
|
||||||
|
## Страницы
|
||||||
|
|
||||||
|
Поддержка динамических исполняемых страниц с полным разбором данных запросов. Страницы могут получать:
|
||||||
|
- Поля форм через переменные окружения `field_*`
|
||||||
|
- Переменные ссылок через переменные окружения `var_*`
|
||||||
|
- Удаленную идентификацию через переменную окружения `remote_identity`
|
||||||
|
- ID соединения через переменную окружения `link_id`
|
||||||
|
|
||||||
|
Это позволяет создавать форумы, чаты и другие интерактивные приложения, совместимые с клиентами NomadNet.
|
||||||
|
|
||||||
|
## Параметры
|
||||||
|
|
||||||
|
```
|
||||||
|
Позиционные аргументы:
|
||||||
|
node_config Путь к файлу конфигурации rns-page-node
|
||||||
|
|
||||||
|
Необязательные аргументы:
|
||||||
|
-c, --config Путь к файлу конфигурации Reticulum
|
||||||
|
-n, --node-name Имя узла
|
||||||
|
-p, --pages-dir Каталог для раздачи страниц
|
||||||
|
-f, --files-dir Каталог для раздачи файлов
|
||||||
|
-i, --identity-dir Каталог для сохранения идентификационных данных узла
|
||||||
|
-a, --announce-interval Интервал анонсирования присутствия узла (в минутах, по умолчанию: 360 = 6 часов)
|
||||||
|
--page-refresh-interval Интервал обновления страниц (в секундах, 0 = отключено)
|
||||||
|
--file-refresh-interval Интервал обновления файлов (в секундах, 0 = отключено)
|
||||||
|
-l, --log-level Уровень логирования (DEBUG, INFO, WARNING, ERROR, CRITICAL)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Лицензия
|
||||||
|
|
||||||
|
Этот проект включает части кодовой базы [NomadNet](https://github.com/markqvist/NomadNet), которая лицензирована под GNU General Public License v3.0 (GPL-3.0). Как производная работа, этот проект также распространяется на условиях GPL-3.0. Полный текст лицензии смотрите в файле [LICENSE](LICENSE).
|
||||||
31
config.example
Normal file
31
config.example
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# rns-page-node configuration file
|
||||||
|
# Lines starting with # are comments
|
||||||
|
# Format: key=value
|
||||||
|
|
||||||
|
# Reticulum config directory path
|
||||||
|
# reticulum-config=/path/to/reticulum/config
|
||||||
|
|
||||||
|
# Node display name
|
||||||
|
node-name=My Page Node
|
||||||
|
|
||||||
|
# Pages directory
|
||||||
|
pages-dir=./pages
|
||||||
|
|
||||||
|
# Files directory
|
||||||
|
files-dir=./files
|
||||||
|
|
||||||
|
# Node identity directory
|
||||||
|
identity-dir=./node-config
|
||||||
|
|
||||||
|
# Announce interval in minutes (default: 360 = 6 hours)
|
||||||
|
announce-interval=360
|
||||||
|
|
||||||
|
# Page refresh interval in seconds (0 = disabled)
|
||||||
|
page-refresh-interval=300
|
||||||
|
|
||||||
|
# File refresh interval in seconds (0 = disabled)
|
||||||
|
file-refresh-interval=300
|
||||||
|
|
||||||
|
# Log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
|
||||||
|
log-level=INFO
|
||||||
|
|
||||||
1543
poetry.lock
generated
1543
poetry.lock
generated
File diff suppressed because it is too large
Load Diff
@@ -1,16 +1,25 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "rns-page-node"
|
name = "rns-page-node"
|
||||||
version = "0.2.0"
|
version = "1.3.0"
|
||||||
license = "GPL-3.0-only"
|
license = "GPL-3.0-only"
|
||||||
description = "A simple way to serve pages and files over the Reticulum network."
|
description = "A simple way to serve pages and files over the Reticulum network."
|
||||||
authors = [
|
authors = [
|
||||||
{name = "Sudo-Ivan"}
|
{name = "Sudo-Ivan"}
|
||||||
]
|
]
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.10"
|
requires-python = ">3.9.0,<3.9.1 || >3.9.1"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"rns (>=1.0.0,<1.5.0)"
|
"rns (>=1.0.4,<1.5.0)",
|
||||||
|
"cryptography>=46.0.3"
|
||||||
]
|
]
|
||||||
|
classifiers = [
|
||||||
|
"Programming Language :: Python :: 3",
|
||||||
|
"Operating System :: OS Independent",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.urls]
|
||||||
|
Homepage = "https://github.com/Sudo-Ivan/rns-page-node"
|
||||||
|
Repository = "https://github.com/Sudo-Ivan/rns-page-node"
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
rns-page-node = "rns_page_node.main:main"
|
rns-page-node = "rns_page_node.main:main"
|
||||||
@@ -20,6 +29,4 @@ requires = ["poetry-core>=2.0.0,<3.0.0"]
|
|||||||
build-backend = "poetry.core.masonry.api"
|
build-backend = "poetry.core.masonry.api"
|
||||||
|
|
||||||
[tool.poetry.group.dev.dependencies]
|
[tool.poetry.group.dev.dependencies]
|
||||||
ruff = "^0.12.3"
|
ruff = "^0.13.3"
|
||||||
safety = "^3.6.0"
|
|
||||||
|
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
rns=1.0.0
|
rns=1.0.4
|
||||||
@@ -1,2 +1,6 @@
|
|||||||
# rns_page_node package
|
"""RNS Page Node package.
|
||||||
__all__ = ['main']
|
|
||||||
|
A minimal Reticulum page node that serves .mu pages and files over RNS.
|
||||||
|
"""
|
||||||
|
|
||||||
|
__all__ = ["main"]
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
31
setup.py
31
setup.py
@@ -1,31 +0,0 @@
|
|||||||
from setuptools import setup, find_packages
|
|
||||||
|
|
||||||
with open('README.md', 'r', encoding='utf-8') as fh:
|
|
||||||
long_description = fh.read()
|
|
||||||
|
|
||||||
setup(
|
|
||||||
name='rns-page-node',
|
|
||||||
version='0.2.0',
|
|
||||||
author='Sudo-Ivan',
|
|
||||||
author_email='',
|
|
||||||
description='A simple way to serve pages and files over the Reticulum network.',
|
|
||||||
long_description=long_description,
|
|
||||||
long_description_content_type='text/markdown',
|
|
||||||
url='https://github.com/Sudo-Ivan/rns-page-node',
|
|
||||||
packages=find_packages(),
|
|
||||||
license="GPL-3.0",
|
|
||||||
python_requires='>=3.10',
|
|
||||||
install_requires=[
|
|
||||||
'rns>=1.0.0,<1.5.0',
|
|
||||||
],
|
|
||||||
entry_points={
|
|
||||||
'console_scripts': [
|
|
||||||
'rns-page-node=rns_page_node.main:main',
|
|
||||||
],
|
|
||||||
},
|
|
||||||
classifiers=[
|
|
||||||
'Programming Language :: Python :: 3',
|
|
||||||
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
|
|
||||||
'Operating System :: OS Independent',
|
|
||||||
],
|
|
||||||
)
|
|
||||||
28
tests/run_tests.sh
Normal file → Executable file
28
tests/run_tests.sh
Normal file → Executable file
@@ -9,11 +9,33 @@ rm -rf config node-config pages files node.log
|
|||||||
mkdir -p config node-config pages files
|
mkdir -p config node-config pages files
|
||||||
|
|
||||||
# Create a sample page and a test file
|
# Create a sample page and a test file
|
||||||
cat > pages/index.mu << EOF
|
cat > pages/index.mu << 'EOF'
|
||||||
>Test Page
|
#!/usr/bin/env python3
|
||||||
This is a test page.
|
import os
|
||||||
|
|
||||||
|
print("`F0f0`_`Test Page`_")
|
||||||
|
print("This is a test page with environment variable support.")
|
||||||
|
print()
|
||||||
|
|
||||||
|
print("`F0f0`_`Environment Variables`_")
|
||||||
|
params = []
|
||||||
|
for key, value in os.environ.items():
|
||||||
|
if key.startswith(('field_', 'var_')):
|
||||||
|
params.append(f"- `Faaa`{key}`f: `F0f0`{value}`f")
|
||||||
|
|
||||||
|
if params:
|
||||||
|
print("\n".join(params))
|
||||||
|
else:
|
||||||
|
print("- No parameters received")
|
||||||
|
|
||||||
|
print()
|
||||||
|
print("`F0f0`_`Remote Identity`_")
|
||||||
|
remote_id = os.environ.get('remote_identity', '33aff86b736acd47dca07e84630fd192') # Mock for testing
|
||||||
|
print(f"`Faaa`{remote_id}`f")
|
||||||
EOF
|
EOF
|
||||||
|
|
||||||
|
chmod +x pages/index.mu
|
||||||
|
|
||||||
cat > files/text.txt << EOF
|
cat > files/text.txt << EOF
|
||||||
This is a test file.
|
This is a test file.
|
||||||
EOF
|
EOF
|
||||||
|
|||||||
@@ -1,20 +1,21 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
import time
|
|
||||||
import threading
|
import threading
|
||||||
|
import time
|
||||||
|
|
||||||
import RNS
|
import RNS
|
||||||
|
|
||||||
# Determine base directory for tests
|
# Determine base directory for tests
|
||||||
dir_path = os.path.abspath(os.path.dirname(__file__))
|
dir_path = os.path.abspath(os.path.dirname(__file__))
|
||||||
config_dir = os.path.join(dir_path, 'config')
|
config_dir = os.path.join(dir_path, "config")
|
||||||
identity_dir = os.path.join(dir_path, 'node-config')
|
identity_dir = os.path.join(dir_path, "node-config")
|
||||||
|
|
||||||
# Initialize Reticulum with shared config
|
# Initialize Reticulum with shared config
|
||||||
RNS.Reticulum(config_dir)
|
RNS.Reticulum(config_dir)
|
||||||
|
|
||||||
# Load server identity (created by the page node)
|
# Load server identity (created by the page node)
|
||||||
identity_file = os.path.join(identity_dir, 'identity')
|
identity_file = os.path.join(identity_dir, "identity")
|
||||||
server_identity = RNS.Identity.from_file(identity_file)
|
server_identity = RNS.Identity.from_file(identity_file)
|
||||||
|
|
||||||
# Create a destination to the server node
|
# Create a destination to the server node
|
||||||
@@ -22,8 +23,8 @@ destination = RNS.Destination(
|
|||||||
server_identity,
|
server_identity,
|
||||||
RNS.Destination.OUT,
|
RNS.Destination.OUT,
|
||||||
RNS.Destination.SINGLE,
|
RNS.Destination.SINGLE,
|
||||||
'nomadnetwork',
|
"nomadnetwork",
|
||||||
'node'
|
"node",
|
||||||
)
|
)
|
||||||
|
|
||||||
# Ensure we know a path to the destination
|
# Ensure we know a path to the destination
|
||||||
@@ -39,66 +40,190 @@ global_link = RNS.Link(destination)
|
|||||||
responses = {}
|
responses = {}
|
||||||
done_event = threading.Event()
|
done_event = threading.Event()
|
||||||
|
|
||||||
|
# Test data for environment variables
|
||||||
|
test_data_dict = {
|
||||||
|
"var_field_test": "dictionary_value",
|
||||||
|
"var_field_message": "hello_world",
|
||||||
|
"var_action": "test_action",
|
||||||
|
}
|
||||||
|
test_data_dict2 = {
|
||||||
|
"field_username": "testuser",
|
||||||
|
"field_message": "hello_from_form",
|
||||||
|
"var_action": "submit",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
# Callback for page response
|
# Callback for page response
|
||||||
def on_page(response):
|
def on_page(response):
|
||||||
data = response.response
|
data = response.response
|
||||||
if isinstance(data, bytes):
|
if isinstance(data, bytes):
|
||||||
text = data.decode('utf-8')
|
text = data.decode("utf-8")
|
||||||
else:
|
else:
|
||||||
text = str(data)
|
text = str(data)
|
||||||
print('Received page:')
|
print("Received page (no data):")
|
||||||
print(text)
|
print(text)
|
||||||
responses['page'] = text
|
responses["page"] = text
|
||||||
if 'file' in responses:
|
check_responses()
|
||||||
|
|
||||||
|
|
||||||
|
# Callback for page response with dictionary data
|
||||||
|
def on_page_dict(response):
|
||||||
|
data = response.response
|
||||||
|
if isinstance(data, bytes):
|
||||||
|
text = data.decode("utf-8")
|
||||||
|
else:
|
||||||
|
text = str(data)
|
||||||
|
print("Received page (dict data):")
|
||||||
|
print(text)
|
||||||
|
responses["page_dict"] = text
|
||||||
|
check_responses()
|
||||||
|
|
||||||
|
|
||||||
|
# Callback for page response with second dict data
|
||||||
|
def on_page_dict2(response):
|
||||||
|
data = response.response
|
||||||
|
if isinstance(data, bytes):
|
||||||
|
text = data.decode("utf-8")
|
||||||
|
else:
|
||||||
|
text = str(data)
|
||||||
|
print("Received page (dict2 data):")
|
||||||
|
print(text)
|
||||||
|
responses["page_dict2"] = text
|
||||||
|
check_responses()
|
||||||
|
|
||||||
|
|
||||||
|
def check_responses():
|
||||||
|
if (
|
||||||
|
"page" in responses
|
||||||
|
and "page_dict" in responses
|
||||||
|
and "page_dict2" in responses
|
||||||
|
and "file" in responses
|
||||||
|
):
|
||||||
done_event.set()
|
done_event.set()
|
||||||
|
|
||||||
|
|
||||||
# Callback for file response
|
# Callback for file response
|
||||||
def on_file(response):
|
def on_file(response):
|
||||||
data = response.response
|
data = response.response
|
||||||
# Handle response as [fileobj, headers]
|
# Handle response as [fileobj, headers]
|
||||||
if isinstance(data, list) and len(data) == 2 and hasattr(data[0], 'read'):
|
if isinstance(data, list) and len(data) == 2 and hasattr(data[0], "read"):
|
||||||
fileobj, headers = data
|
fileobj, headers = data
|
||||||
file_data = fileobj.read()
|
file_data = fileobj.read()
|
||||||
filename = headers.get(b'name', b'').decode('utf-8')
|
filename = headers.get(b"name", b"").decode("utf-8")
|
||||||
print(f'Received file ({filename}):')
|
print(f"Received file ({filename}):")
|
||||||
print(file_data.decode('utf-8'))
|
print(file_data.decode("utf-8"))
|
||||||
responses['file'] = file_data.decode('utf-8')
|
responses["file"] = file_data.decode("utf-8")
|
||||||
# Handle response as a raw file object
|
# Handle response as a raw file object
|
||||||
elif hasattr(data, 'read'):
|
elif hasattr(data, "read"):
|
||||||
file_data = data.read()
|
file_data = data.read()
|
||||||
filename = os.path.basename('text.txt')
|
filename = os.path.basename("text.txt")
|
||||||
print(f'Received file ({filename}):')
|
print(f"Received file ({filename}):")
|
||||||
print(file_data.decode('utf-8'))
|
print(file_data.decode("utf-8"))
|
||||||
responses['file'] = file_data.decode('utf-8')
|
responses["file"] = file_data.decode("utf-8")
|
||||||
# Handle response as raw bytes
|
# Handle response as raw bytes
|
||||||
elif isinstance(data, bytes):
|
elif isinstance(data, bytes):
|
||||||
text = data.decode('utf-8')
|
text = data.decode("utf-8")
|
||||||
print('Received file:')
|
print("Received file:")
|
||||||
print(text)
|
print(text)
|
||||||
responses['file'] = text
|
responses["file"] = text
|
||||||
else:
|
else:
|
||||||
print('Received file (unhandled format):', data)
|
print("Received file (unhandled format):", data)
|
||||||
responses['file'] = str(data)
|
responses["file"] = str(data)
|
||||||
if 'page' in responses:
|
check_responses()
|
||||||
done_event.set()
|
|
||||||
|
|
||||||
# Request the page and file once the link is established
|
|
||||||
|
# Request the pages and file once the link is established
|
||||||
def on_link_established(link):
|
def on_link_established(link):
|
||||||
link.request('/page/index.mu', None, response_callback=on_page)
|
# Test page without data
|
||||||
link.request('/file/text.txt', None, response_callback=on_file)
|
link.request("/page/index.mu", None, response_callback=on_page)
|
||||||
|
# Test page with dictionary data (simulates var_ prefixed data)
|
||||||
|
link.request("/page/index.mu", test_data_dict, response_callback=on_page_dict)
|
||||||
|
# Test page with form field data (simulates field_ prefixed data)
|
||||||
|
link.request("/page/index.mu", test_data_dict2, response_callback=on_page_dict2)
|
||||||
|
# Test file serving
|
||||||
|
link.request("/file/text.txt", None, response_callback=on_file)
|
||||||
|
|
||||||
|
|
||||||
# Register callbacks
|
# Register callbacks
|
||||||
global_link.set_link_established_callback(on_link_established)
|
global_link.set_link_established_callback(on_link_established)
|
||||||
global_link.set_link_closed_callback(lambda l: done_event.set())
|
global_link.set_link_closed_callback(lambda link: done_event.set())
|
||||||
|
|
||||||
# Wait for responses or timeout
|
# Wait for responses or timeout
|
||||||
if not done_event.wait(timeout=30):
|
if not done_event.wait(timeout=30):
|
||||||
print('Test timed out.', file=sys.stderr)
|
print("Test timed out.", file=sys.stderr)
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
if responses.get('page') and responses.get('file'):
|
|
||||||
print('Tests passed!')
|
# Validate test results
|
||||||
|
def validate_test_results():
|
||||||
|
"""Validate that all responses contain expected content"""
|
||||||
|
# Check basic page response (no data)
|
||||||
|
if "page" not in responses:
|
||||||
|
print("ERROR: No basic page response received", file=sys.stderr)
|
||||||
|
return False
|
||||||
|
|
||||||
|
page_content = responses["page"]
|
||||||
|
if "No parameters received" not in page_content:
|
||||||
|
print("ERROR: Basic page should show 'No parameters received'", file=sys.stderr)
|
||||||
|
return False
|
||||||
|
if "33aff86b736acd47dca07e84630fd192" not in page_content:
|
||||||
|
print("ERROR: Basic page should show mock remote identity", file=sys.stderr)
|
||||||
|
return False
|
||||||
|
|
||||||
|
# Check page with dictionary data
|
||||||
|
if "page_dict" not in responses:
|
||||||
|
print("ERROR: No dictionary data page response received", file=sys.stderr)
|
||||||
|
return False
|
||||||
|
|
||||||
|
dict_content = responses["page_dict"]
|
||||||
|
if "var_field_test" not in dict_content or "dictionary_value" not in dict_content:
|
||||||
|
print(
|
||||||
|
"ERROR: Dictionary data page should contain processed environment variables",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
if "33aff86b736acd47dca07e84630fd192" not in dict_content:
|
||||||
|
print(
|
||||||
|
"ERROR: Dictionary data page should show mock remote identity",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
|
||||||
|
# Check page with second dictionary data (form fields)
|
||||||
|
if "page_dict2" not in responses:
|
||||||
|
print("ERROR: No dict2 data page response received", file=sys.stderr)
|
||||||
|
return False
|
||||||
|
|
||||||
|
dict2_content = responses["page_dict2"]
|
||||||
|
if "field_username" not in dict2_content or "testuser" not in dict2_content:
|
||||||
|
print(
|
||||||
|
"ERROR: Dict2 data page should contain processed environment variables",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
if "33aff86b736acd47dca07e84630fd192" not in dict2_content:
|
||||||
|
print(
|
||||||
|
"ERROR: Dict2 data page should show mock remote identity",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
|
||||||
|
# Check file response
|
||||||
|
if "file" not in responses:
|
||||||
|
print("ERROR: No file response received", file=sys.stderr)
|
||||||
|
return False
|
||||||
|
|
||||||
|
file_content = responses["file"]
|
||||||
|
if "This is a test file" not in file_content:
|
||||||
|
print("ERROR: File content doesn't match expected content", file=sys.stderr)
|
||||||
|
return False
|
||||||
|
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
if validate_test_results():
|
||||||
|
print("All tests passed! Environment variable processing works correctly.")
|
||||||
sys.exit(0)
|
sys.exit(0)
|
||||||
else:
|
else:
|
||||||
print('Tests failed.', file=sys.stderr)
|
print("Tests failed.", file=sys.stderr)
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|||||||
@@ -1,20 +1,26 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
import time
|
|
||||||
import threading
|
import threading
|
||||||
|
import time
|
||||||
|
|
||||||
import RNS
|
import RNS
|
||||||
|
|
||||||
dir_path = os.path.abspath(os.path.dirname(__file__))
|
dir_path = os.path.abspath(os.path.dirname(__file__))
|
||||||
config_dir = os.path.join(dir_path, 'config')
|
config_dir = os.path.join(dir_path, "config")
|
||||||
|
|
||||||
RNS.Reticulum(config_dir)
|
RNS.Reticulum(config_dir)
|
||||||
|
|
||||||
DESTINATION_HEX = '49b2d959db8528347d0a38083aec1042' # Ivans Node that runs rns-page-node
|
DESTINATION_HEX = (
|
||||||
|
"49b2d959db8528347d0a38083aec1042" # Ivans Node that runs rns-page-node
|
||||||
|
)
|
||||||
|
|
||||||
dest_len = (RNS.Reticulum.TRUNCATED_HASHLENGTH // 8) * 2
|
dest_len = (RNS.Reticulum.TRUNCATED_HASHLENGTH // 8) * 2
|
||||||
if len(DESTINATION_HEX) != dest_len:
|
if len(DESTINATION_HEX) != dest_len:
|
||||||
print(f"Invalid destination length (got {len(DESTINATION_HEX)}, expected {dest_len})", file=sys.stderr)
|
print(
|
||||||
|
f"Invalid destination length (got {len(DESTINATION_HEX)}, expected {dest_len})",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
destination_hash = bytes.fromhex(DESTINATION_HEX)
|
destination_hash = bytes.fromhex(DESTINATION_HEX)
|
||||||
|
|
||||||
@@ -31,29 +37,33 @@ destination = RNS.Destination(
|
|||||||
server_identity,
|
server_identity,
|
||||||
RNS.Destination.OUT,
|
RNS.Destination.OUT,
|
||||||
RNS.Destination.SINGLE,
|
RNS.Destination.SINGLE,
|
||||||
'nomadnetwork',
|
"nomadnetwork",
|
||||||
'node'
|
"node",
|
||||||
)
|
)
|
||||||
link = RNS.Link(destination)
|
link = RNS.Link(destination)
|
||||||
|
|
||||||
done_event = threading.Event()
|
done_event = threading.Event()
|
||||||
|
|
||||||
|
|
||||||
def on_page(response):
|
def on_page(response):
|
||||||
data = response.response
|
data = response.response
|
||||||
if isinstance(data, bytes):
|
if isinstance(data, bytes):
|
||||||
text = data.decode('utf-8')
|
text = data.decode("utf-8")
|
||||||
else:
|
else:
|
||||||
text = str(data)
|
text = str(data)
|
||||||
print('Fetched page content:')
|
print("Fetched page content:")
|
||||||
print(text)
|
print(text)
|
||||||
done_event.set()
|
done_event.set()
|
||||||
|
|
||||||
link.set_link_established_callback(lambda l: l.request('/page/index.mu', None, response_callback=on_page))
|
|
||||||
link.set_link_closed_callback(lambda l: done_event.set())
|
link.set_link_established_callback(
|
||||||
|
lambda link: link.request("/page/index.mu", None, response_callback=on_page),
|
||||||
|
)
|
||||||
|
link.set_link_closed_callback(lambda link: done_event.set())
|
||||||
|
|
||||||
if not done_event.wait(timeout=30):
|
if not done_event.wait(timeout=30):
|
||||||
print('Timed out waiting for page', file=sys.stderr)
|
print("Timed out waiting for page", file=sys.stderr)
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
print('Done fetching page.')
|
print("Done fetching page.")
|
||||||
sys.exit(0)
|
sys.exit(0)
|
||||||
|
|||||||
Reference in New Issue
Block a user