mirror of
https://github.com/praktimarc/kst4contest.git
synced 2026-09-13 20:55:31 +02:00
Compare commits
18
Commits
53555cbe69
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
393c9c49ee | ||
|
|
f0508f51a2 | ||
|
|
923d76beb0 | ||
|
|
821535a24f | ||
|
|
914a06cb7f | ||
|
|
b23884bde1 | ||
|
|
4ad1cf71dd
|
||
|
|
ad212e3e71 | ||
|
|
08d65a0e23 | ||
|
|
edf71b4105
|
||
|
|
885bf83c2f
|
||
|
|
634b88238d
|
||
|
|
830e4020a2 | ||
|
|
7ee50267ec | ||
|
|
113e843111 | ||
|
|
79161d2afa | ||
|
|
3ed1cad5ab | ||
|
|
75fe45b50b |
@@ -551,6 +551,9 @@ jobs:
|
|||||||
name: Publish Flatpak OSTree Repo (nightly)
|
name: Publish Flatpak OSTree Repo (nightly)
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: build-flatpak
|
needs: build-flatpak
|
||||||
|
concurrency:
|
||||||
|
group: flatpak-repo-publish
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Install Flatpak tooling
|
- name: Install Flatpak tooling
|
||||||
|
|||||||
@@ -646,6 +646,9 @@ jobs:
|
|||||||
name: Publish Flatpak OSTree Repo (${{ github.ref_name }})
|
name: Publish Flatpak OSTree Repo (${{ github.ref_name }})
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: build-flatpak
|
needs: build-flatpak
|
||||||
|
concurrency:
|
||||||
|
group: flatpak-repo-publish
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Install Flatpak tooling
|
- name: Install Flatpak tooling
|
||||||
|
|||||||
@@ -0,0 +1,416 @@
|
|||||||
|
From afb77c6a8674ff5571a9c57cbe7108b9a5189407 Mon Sep 17 00:00:00 2001
|
||||||
|
From: Codex <codex@openai.com>
|
||||||
|
Date: Fri, 4 Sep 2026 00:17:15 +0300
|
||||||
|
Subject: [PATCH] Document v1.43 and fix release metadata
|
||||||
|
|
||||||
|
---
|
||||||
|
.github/workflows/tagged-release.yml | 84 +++++++++----------
|
||||||
|
docs/PROJECT_CONTEXT.md | 4 +
|
||||||
|
github_docs/de-Changelog.md | 80 +++++++++++++++---
|
||||||
|
github_docs/en-Changelog.md | 80 +++++++++++++++---
|
||||||
|
.../kst4contest/ApplicationConstants.java | 2 +-
|
||||||
|
website/src/news/2026-09-03-version-1-43.md | 29 +++++++
|
||||||
|
6 files changed, 212 insertions(+), 67 deletions(-)
|
||||||
|
create mode 100644 website/src/news/2026-09-03-version-1-43.md
|
||||||
|
|
||||||
|
diff --git a/.github/workflows/tagged-release.yml b/.github/workflows/tagged-release.yml
|
||||||
|
index d9133550..be7bf536 100644
|
||||||
|
--- a/.github/workflows/tagged-release.yml
|
||||||
|
+++ b/.github/workflows/tagged-release.yml
|
||||||
|
@@ -786,45 +786,45 @@ jobs:
|
||||||
|
release-assets/macos/KST4Contest-${{ github.ref_name }}-macos-*.dmg,
|
||||||
|
release-assets/docs/KST4Contest-${{ github.ref_name }}-manual-en.pdf,
|
||||||
|
release-assets/docs/KST4Contest-${{ github.ref_name }}-manual-de.pdf
|
||||||
|
-
|
||||||
|
- # The update feed is generated only after GitHub has published the
|
||||||
|
- # release. Otherwise the Releases API cannot return the release notes
|
||||||
|
- # belonging to the tag which triggered this workflow.
|
||||||
|
- - name: Set up Node.js for website build
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
- with:
|
||||||
|
- node-version: "24"
|
||||||
|
- cache: npm
|
||||||
|
- cache-dependency-path: website/package-lock.json
|
||||||
|
-
|
||||||
|
- - name: Build and validate website after release publication
|
||||||
|
- working-directory: website
|
||||||
|
- run: |
|
||||||
|
- npm ci
|
||||||
|
- npm test
|
||||||
|
- npm run build
|
||||||
|
- env:
|
||||||
|
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
-
|
||||||
|
- - name: Verify Stable release in update feed
|
||||||
|
- if: ${{ !startsWith(github.ref_name, 'beta-') }}
|
||||||
|
- working-directory: website
|
||||||
|
- run: npm run validate:version-info
|
||||||
|
- env:
|
||||||
|
- EXPECTED_STABLE_VERSION: ${{ github.ref_name }}
|
||||||
|
-
|
||||||
|
- - name: Attach verified version info to tagged release
|
||||||
|
- run: >-
|
||||||
|
- gh release upload "${GITHUB_REF_NAME}"
|
||||||
|
- website/_site/kst4ContestVersionInfo.xml
|
||||||
|
- --clobber
|
||||||
|
- env:
|
||||||
|
- GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
-
|
||||||
|
- - name: Upload verified website artifact
|
||||||
|
- uses: actions/upload-artifact@v4.3.4
|
||||||
|
- with:
|
||||||
|
- name: kst4contest-website-${{ github.ref_name }}
|
||||||
|
- path: website/_site/
|
||||||
|
- if-no-files-found: error
|
||||||
|
- retention-days: 14
|
||||||
|
\ No newline at end of file
|
||||||
|
+
|
||||||
|
+ # The update feed is generated only after GitHub has published the
|
||||||
|
+ # release. Otherwise the Releases API cannot return the release notes
|
||||||
|
+ # belonging to the tag which triggered this workflow.
|
||||||
|
+ - name: Set up Node.js for website build
|
||||||
|
+ uses: actions/setup-node@v4
|
||||||
|
+ with:
|
||||||
|
+ node-version: "24"
|
||||||
|
+ cache: npm
|
||||||
|
+ cache-dependency-path: website/package-lock.json
|
||||||
|
+
|
||||||
|
+ - name: Build and validate website after release publication
|
||||||
|
+ working-directory: website
|
||||||
|
+ run: |
|
||||||
|
+ npm ci
|
||||||
|
+ npm test
|
||||||
|
+ npm run build
|
||||||
|
+ env:
|
||||||
|
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
+
|
||||||
|
+ - name: Verify Stable release in update feed
|
||||||
|
+ if: ${{ !startsWith(github.ref_name, 'beta-') }}
|
||||||
|
+ working-directory: website
|
||||||
|
+ run: npm run validate:version-info
|
||||||
|
+ env:
|
||||||
|
+ EXPECTED_STABLE_VERSION: ${{ github.ref_name }}
|
||||||
|
+
|
||||||
|
+ - name: Attach verified version info to tagged release
|
||||||
|
+ run: >-
|
||||||
|
+ gh release upload "${GITHUB_REF_NAME}"
|
||||||
|
+ website/_site/kst4ContestVersionInfo.xml
|
||||||
|
+ --clobber
|
||||||
|
+ env:
|
||||||
|
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
+
|
||||||
|
+ - name: Upload verified website artifact
|
||||||
|
+ uses: actions/upload-artifact@v4.3.4
|
||||||
|
+ with:
|
||||||
|
+ name: kst4contest-website-${{ github.ref_name }}
|
||||||
|
+ path: website/_site/
|
||||||
|
+ if-no-files-found: error
|
||||||
|
+ retention-days: 14
|
||||||
|
diff --git a/docs/PROJECT_CONTEXT.md b/docs/PROJECT_CONTEXT.md
|
||||||
|
index b0ca4b63..c4d70f1f 100644
|
||||||
|
--- a/docs/PROJECT_CONTEXT.md
|
||||||
|
+++ b/docs/PROJECT_CONTEXT.md
|
||||||
|
@@ -162,6 +162,10 @@ The repository contains the KST4Contest website under `website/`, published sepa
|
||||||
|
|
||||||
|
Current website/deployment scripts and update-feed behaviour must be inspected before changes; do not rely on historical assumptions.
|
||||||
|
|
||||||
|
+- `APPLICATION_CURRENT_VERSION` is the user-visible semantic version and must use the dotted `major.minor.patch` form. `APPLICATION_CURRENTVERSIONNUMBER` is retained only for older feeds and encodes patch releases by appending the patch digit, for example `1.43.1` as `1.431`.
|
||||||
|
+- The tagged-release workflow creates the GitHub Release before building the website update feed. This ordering is required because `versionInfo.js` reads the published release body through the GitHub Releases API.
|
||||||
|
+- After publication, the workflow tests and builds the website, validates the expected Stable version, attaches `kst4ContestVersionInfo.xml` to the release and uploads the complete website build as a workflow artifact.
|
||||||
|
+
|
||||||
|
## Important Decisions and Workarounds
|
||||||
|
|
||||||
|
- Preserve full callsign/category identity while applying base-call normalisation only to specifically defined features.
|
||||||
|
diff --git a/github_docs/de-Changelog.md b/github_docs/de-Changelog.md
|
||||||
|
index 2022f904..622bb446 100644
|
||||||
|
--- a/github_docs/de-Changelog.md
|
||||||
|
+++ b/github_docs/de-Changelog.md
|
||||||
|
@@ -8,6 +8,72 @@ Die veröffentlichten Stable-Versionen und ihre Programmpakete stehen unter [Git
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
+## v1.43.1 (2026-09-03)
|
||||||
|
+
|
||||||
|
+**Korrigierte Versionsmetadaten**
|
||||||
|
+
|
||||||
|
+v1.43.1 enthält dieselben funktionalen Änderungen wie v1.43.0. Korrigiert wurden die Anwendungs- und Build-Metadaten für Anzeige, ON4KST-Kennung und Update-Vergleich. Ein Teil der Metadaten des ersten v1.43.0-Pakets wies den Build noch als Version 1.42 aus.
|
||||||
|
+
|
||||||
|
+### Behoben
|
||||||
|
+
|
||||||
|
+- **Einheitliche semantische Version:** Die sichtbare Anwendungsversion verwendet jetzt vollständig `1.43.1`. Der kompakte Wert `1.431` bleibt ausschließlich im veralteten numerischen Feld für die Kompatibilität mit älteren Update-Feeds erhalten.
|
||||||
|
+
|
||||||
|
+- **Update-Feed im Tagged-Release-Workflow:** Website-Build, Prüfung des Versionsfeeds und Upload der Artefakte laufen jetzt tatsächlich nach der Veröffentlichung des GitHub Releases. Diese Schritte waren zuvor versehentlich in die Artefaktliste der Release-Action eingerückt und wurden deshalb übersprungen.
|
||||||
|
+
|
||||||
|
+Wer v1.43.0 installiert hat, sollte v1.43.1 verwenden. Die Funktionen bleiben unverändert; korrigiert werden nur die Versionsmetadaten und der Release-Workflow.
|
||||||
|
+
|
||||||
|
+Die korrigierte Version ist als [Release v1.43.1](https://github.com/praktimarc/kst4contest/releases/tag/v1.43.1) verfügbar.
|
||||||
|
+
|
||||||
|
+---
|
||||||
|
+
|
||||||
|
+## v1.43.0 (2026-09-03)
|
||||||
|
+
|
||||||
|
+**Zuverlässigere Log-Synchronisation, gespeicherte Tabellenlayouts und bessere DX-Cluster-Kompatibilität**
|
||||||
|
+
|
||||||
|
+v1.43 konzentriert sich auf die zuverlässige Verarbeitung externer Logdaten und den stabilen Betrieb während längerer Conteste. Hinzu kommen praktische Einstellmöglichkeiten für Tabellenlayouts und die Stationsgruppierung auf der Karte.
|
||||||
|
+
|
||||||
|
+### Neu
|
||||||
|
+
|
||||||
|
+- **Optionale Kartencluster:** **Group nearby stations** schaltet die räumliche Gruppierung bei niedrigen Zoomstufen unmittelbar ein oder aus. Die gespeicherte Auswahl verändert weder Kartenausschnitt noch Stationsauswahl; die Zusammenfassung aktiver Varianten desselben Basisrufzeichens bleibt davon unabhängig. Damit ist [Issue #79](https://github.com/praktimarc/kst4contest/issues/79) umgesetzt.
|
||||||
|
+
|
||||||
|
+- **Tabellenlayout automatisch gesichert:** Tabellen erhalten beim ersten brauchbaren Inhalt sinnvolle Breiten. Manuell geänderte Spaltenbreiten, Fenstergrößen und relevante Divider werden nach kurzer Verzögerung in `preferences.xml` geschrieben. Haupt- und Monitorfenster behalten getrennte Layouts für DXCluster und QSO of the other.
|
||||||
|
+
|
||||||
|
+- **Tooltips für gekürzte Tabellenwerte:** Normale Tabellenzellen zeigen ihren vollständigen Inhalt, wenn die sichtbare Spalte zu schmal ist. Funktionale Tooltips und anklickbare Links bleiben davon unberührt.
|
||||||
|
+
|
||||||
|
+- **Hinweis bei neu angelegtem Simplelogfile:** Fehlt die ausgewählte Datei, legt KST4Contest sie an und zeigt einen Hinweis mit Dateipfad, konkretem Testablauf und Link zum passenden Abschnitt des Handbuchs.
|
||||||
|
+
|
||||||
|
+### Geändert
|
||||||
|
+
|
||||||
|
+- **Robuste Simplelogfile-Auswertung:** Die ausgewählte Datei wird einmal pro Minute ausgewertet und nach jedem Durchlauf geschlossen, damit das Logprogramm sie ersetzen oder rotieren kann. Erkannte Rufzeichen setzen den globalen Worked-Status für alle aktiven Suffixvarianten des Basisrufzeichens. Bei deaktivierter Funktion findet kein Dateizugriff statt; Lese- oder Erstellungsfehler beenden die periodische Aufgabe nicht mehr.
|
||||||
|
+
|
||||||
|
+- **Einheitliche Bandwerte externer Logger:** UCXLog-kompatible Pakete und Win-Test-Ereignisse verwenden eine gemeinsame Bandnormalisierung. Numerische Werte, Meter- und Zentimeterangaben sowie die vorhandenen Win-Test-IDs setzen damit dieselben Worked-Markierungen und Worked-Großfelder. Insbesondere `2320`, `5760` und `10368` werden zuverlässig verarbeitet; bei fehlendem oder unbekanntem Band wird nur der globale Worked-Status gesetzt.
|
||||||
|
+
|
||||||
|
+- **Kompakte vollständige Frequenzen erkannt:** Vollständige Frequenzangaben ohne Dezimaltrenner werden auf allen unterstützten Bändern akzeptiert; die letzten drei Ziffern bilden den kHz-Anteil. Nackte dreistellige Zahlen benötigen weiterhin einen erkennbaren Frequenzkontext, damit Signalrapporte und andere Zahlen nicht als QRG behandelt werden.
|
||||||
|
+
|
||||||
|
+- **DXSpider-kompatibles Spotformat:** Lokale DX-Cluster-Spots verwenden eine feste 75-Zeichen-Nutzzeile mit dem DX-Rufzeichen ab Spalte 27, einem 30 Zeichen breiten Kommentarfeld und der UTC-Zeit ab Spalte 71. Das Format bleibt bis 24 GHz stabil. Überlange DX-Rufzeichen werden verworfen und protokolliert, statt unbemerkt abgeschnitten zu werden. Damit ist [Issue #86](https://github.com/praktimarc/kst4contest/issues/86) behoben.
|
||||||
|
+
|
||||||
|
+- **Aktive ON4KST-Verbindungsprüfung:** Ein ruhiger Chatserver wird mit einer expliziten, sitzungsweiten Abfrage geprüft, bevor die Verbindung als unterbrochen gilt. Heartbeat und Prüftelegramme behalten das erforderliche CR/LF-Framing.
|
||||||
|
+
|
||||||
|
+- **Zuverlässige Altersmarkierung privater Nachrichten:** Eingehende Privatnachrichten verwenden bis zu fünf Minuten lang die definierten grünen Altersstufen. Eigene Nachrichten behalten ihre separate Darstellung; leere oder wiederverwendete Tabellenzeilen kehren zum normalen Design zurück und behalten keine veraltete Hervorhebung.
|
||||||
|
+
|
||||||
|
+### Behoben
|
||||||
|
+
|
||||||
|
+- **Worked-Status nach dem Login:** Persistierte SQLite-Informationen werden vor der Veröffentlichung jeder initialen ON4KST-Benutzerliste geladen und angewendet. Erneute Verbindungen, beide Kategorien und alle aktiven Varianten eines Basisrufzeichens starten dadurch mit dem richtigen Status. Damit ist [Issue #85](https://github.com/praktimarc/kst4contest/issues/85) behoben.
|
||||||
|
+
|
||||||
|
+- **Fehlerhafte Trennung bei ruhigem Server:** Eine gültige ON4KST-Verbindung wird nicht mehr beendet, nur weil der Server gerade keine Aktivitätszeilen überträgt.
|
||||||
|
+
|
||||||
|
+### Dokumentation und Auslieferung
|
||||||
|
+
|
||||||
|
+- Das deutsche und englische Handbuch wurden mit der Implementierung abgeglichen und überarbeitet. Ein neues Kapitel zum Contest-Workflow verbindet die einzelnen Funktionen zu einem praktischen Betriebsablauf; außerdem wurden die Abschnitte zu Dual Chat, Privatnachrichten, QRG-Synchronisation, Simplelogfile-Auswertung und Konfiguration präzisiert.
|
||||||
|
+
|
||||||
|
+- Die Website beschreibt Band- und Richtungsgelegenheiten, Stationskarte, QRG-Verarbeitung, Filter, globale Nachrichtenansichten, Privatnachrichten und Log-Synchronisation jetzt ausführlicher.
|
||||||
|
+
|
||||||
|
+- Die AUR-Paketdefinitionen wurden auf v1.43.0 aktualisiert.
|
||||||
|
+
|
||||||
|
+Die vollständige Funktionalität von v1.43.0 steht im [Release v1.43.0](https://github.com/praktimarc/kst4contest/releases/tag/v1.43.0) bereit. Wegen der inkonsistenten eingebetteten Versionsmetadaten ist v1.43.1 der empfohlene Paketstand.
|
||||||
|
+
|
||||||
|
+---
|
||||||
|
+
|
||||||
|
## v1.42.0 (2026-08-22)
|
||||||
|
|
||||||
|
**Gemeinsamer Bandkontext, sitzungsbasierte ON4KST-Verbindung und signierte macOS-Pakete**
|
||||||
|
@@ -38,21 +104,17 @@ v1.42 führt mehrere bisher getrennte Auswertungen zusammen. Bandinformationen,
|
||||||
|
|
||||||
|
- **Filter zurücksetzen:** Ein eigener Reset-Button entfernt die aktiven Filterprädikate der Benutzerliste zuverlässig.
|
||||||
|
|
||||||
|
-- **Optionale Kartencluster:** **Group nearby stations** schaltet die räumliche Gruppierung bei niedrigen Zoomstufen unmittelbar ein oder aus. Die automatisch gespeicherte Auswahl verändert weder Kartenausschnitt noch Stationsauswahl; die Zusammenfassung aktiver Varianten desselben Basisrufzeichens bleibt davon unabhängig. Damit ist [Issue #79](https://github.com/praktimarc/kst4contest/issues/79) umgesetzt.
|
||||||
|
+- **Kartencluster:** Räumlich dicht beieinanderliegende Stationen werden bei niedrigen Zoomstufen zusammengefasst. Die ausgewählte Station und relevante Richtungsgelegenheiten bleiben einzeln sichtbar.
|
||||||
|
|
||||||
|
- **Ausblendbare Streckenanalyse:** Geländeprofil und Analysebereich der Stationskarte können vollständig ausgeblendet werden. Die Auswahl wird gespeichert und beim nächsten Programmstart wiederhergestellt.
|
||||||
|
|
||||||
|
### Geändert
|
||||||
|
|
||||||
|
-- **Tabellenlayout automatisch gesichert:** Tabellen werden beim ersten brauchbaren Inhalt sinnvoll dimensioniert. Manuell geänderte Spaltenbreiten, Fenstergrößen und relevante Divider werden verzögert in `preferences.xml` gespeichert; Haupt- und Monitorfenster behalten für DXCluster und QSO of the other getrennte Layouts. Gekürzte normale Zellwerte zeigen ihren Volltext im Tooltip, ohne funktionale Tooltips oder anklickbare Links zu verdrängen.
|
||||||
|
-
|
||||||
|
-- **DX-Cluster-Zeilenformat vereinheitlicht:** Lokale Spots verwenden jetzt eine feste, DXSpider-kompatible 75-Zeichen-Nutzzeile mit dem DX-Rufzeichen ab Spalte 27, einem 30 Zeichen breiten Kommentarfeld und der UTC-Zeit ab Spalte 71. Das Format bleibt auch bei Mikrowellenfrequenzen bis 24 GHz stabil. Überlange DX-Rufzeichen werden verworfen und protokolliert, statt still abgeschnitten zu werden; AirScout- und Testkommentare sind entsprechend kompakter.
|
||||||
|
-
|
||||||
|
- **Sessionbezogene ON4KST-Verbindungssteuerung:** Socket, Reader, Writer, Messagebus und Warteschlangen gehören jetzt zu einer eindeutig identifizierten Verbindungssession. Veraltete Threads einer abgelösten Verbindung können dadurch keine Daten mehr verarbeiten oder die neue Verbindung schließen. `ONLINE` wird erst nach bestätigtem Login und vollständig empfangenen Benutzerlisten gemeldet. Verbindungsaufbau, Login und Synchronisation besitzen feste Zeitlimits; Heartbeats, ausbleibende Eingangsdaten, EOF sowie Lese- und Schreibfehler werden überwacht und lösen bei Bedarf einen kontrollierten Neuaufbau mit Backoff aus.
|
||||||
|
|
||||||
|
- **ON4KST-Protokollbefehle abgesichert:** Ausgehende Befehle werden zentral aufgebaut und auf gültige Kategorien, Locatoren und unerlaubte Frame-Trennzeichen geprüft. Da ON4KST pro TCP-Session nur einen Locator verwaltet, wird für beide Chat-Kategorien der Hauptlocator verwendet und eine abweichende zweite Konfiguration protokolliert, statt widersprüchliche Befehle an den Server zu senden.
|
||||||
|
|
||||||
|
-- **QRG-Erkennung präzisiert:** Vollständige Frequenzangaben werden auch ohne Dezimaltrenner erkannt; die letzten drei Ziffern bilden dabei den kHz-Anteil. Relative Frequenzen bleiben unverändert, und nackte dreistellige Zahlen gelten weiterhin nur bei erkennbarem Frequenzkontext als QRG. Signalrapporte, Bandangaben und andere Zahlen erzeugen dadurch seltener falsche Frequenzen.
|
||||||
|
+- **QRG-Erkennung präzisiert:** Vollständige und relative Frequenzangaben werden weiterhin erkannt. Nackte dreistellige Zahlen gelten nur noch bei erkennbarem Frequenzkontext als QRG. Signalrapporte, Bandangaben und andere Zahlen erzeugen dadurch seltener falsche Frequenzen.
|
||||||
|
|
||||||
|
- **Stationsbezogener Frequenzkontext:** Bei relativen QRGs verwendet KST4Contest zuerst einen höchstens 30 Minuten alten Bandkontext derselben Station. Erst wenn dieser fehlt, wird das global konfigurierte Fallback-Band verwendet.
|
||||||
|
|
||||||
|
@@ -86,10 +148,6 @@ v1.42 führt mehrere bisher getrennte Auswertungen zusammen. Bandinformationen,
|
||||||
|
|
||||||
|
- **DXLog-Gesamtlog übernommen:** Der UCXLog-kompatible UDP-Listener verarbeitet neben `contactinfo` auch `contactreplace`. Dadurch kann ein von DXLog.net als vollständiges Log ausgesendeter Datenbestand eingelesen werden.
|
||||||
|
|
||||||
|
-- **Logger-Bandwerte vereinheitlicht:** Numerische sowie Meter- und Zentimeterangaben aus UCXLog-kompatiblen QSO-Paketen und die Band-IDs von Win-Test werden einmal normalisiert und danach einheitlich für Worked-Markierungen und Worked-Großfelder verwendet. Dadurch setzen insbesondere `2320`, `5760` und `10368` zuverlässig ihre vorhandenen Bandmarkierungen. Bei einem fehlenden oder unbekannten Band bleibt es beim globalen Worked-Status.
|
||||||
|
-
|
||||||
|
-- **Simplelogfile-Verhalten präzisiert:** Die ausgewählte Textdatei wird einmal pro Minute mit einem festen Rufzeichenmuster ausgewertet. Treffer setzen den globalen Worked-Status aller aktiven Varianten des Basisrufzeichens, werden aber nicht in SQLite persistiert. Eine fehlende Datei wird angelegt; Lese- und Erstellungsfehler beenden die periodische Auswertung nicht. Ein Datenbank-Reset verändert die Datei nicht, sodass enthaltene Rufzeichen bei der nächsten Auswertung erneut als gearbeitet markiert werden.
|
||||||
|
-
|
||||||
|
- **Automatische QRG-Übernahme abgesichert:** `MYQRG` wird nur von einer aktivierten Schnittstelle aktualisiert, die tatsächlich gültige `RadioInfo`- beziehungsweise Win-Test-`STATUS`-Pakete liefert. Eine aktivierte, aber nicht liefernde Quelle ersetzt die notwendige Funktionsprüfung oder manuelle QRG-Pflege nicht.
|
||||||
|
|
||||||
|
- **Versionserkennung verbessert:** Versionsnummern werden semantisch verglichen, damit beispielsweise Patch-Versionen und Nightly-Stände nicht mehr durch eine einfache Fließkommazahl falsch eingeordnet werden.
|
||||||
|
@@ -98,8 +156,6 @@ v1.42 führt mehrere bisher getrennte Auswertungen zusammen. Bandinformationen,
|
||||||
|
|
||||||
|
- **Zuverlässige Benutzerliste beim Login:** Ungültige oder unvollständige `UA0`-Teilnehmerdatensätze werden einzeln verworfen und protokolliert, ohne die Verarbeitung der alphabetisch folgenden Teilnehmer abzubrechen. Die gültigen Einträge werden zunächst pro Kategorie gesammelt und erst mit dem ersten zugehörigen `UE`-Abschlussframe vollständig veröffentlicht.
|
||||||
|
|
||||||
|
-- **Persistierter Worked-Status beim Listenaufbau:** Beim Abschluss jeder initialen ON4KST-Benutzerliste wird der SQLite-Zustand einmal geladen und vor der Veröffentlichung auf die neuen Chatmember angewendet. Das gilt für beide Kategorien, erneute Verbindungen und alle aktiven Varianten eines Basisrufzeichens.
|
||||||
|
-
|
||||||
|
- **Benutzerliste verschwindet nach dem Login:** ON4KST kann nach Namens-, Status- oder anderen Live-Änderungen weitere `UE`-Frames für dieselbe Kategorie senden. Wiederholte Abschlussframes werden jetzt erkannt und ignoriert, damit eine bereits gefüllte Benutzerliste nicht durch eine leere Momentaufnahme ersetzt wird.
|
||||||
|
|
||||||
|
- **Fehlgeschlagener Erstaufbau und Verbindungsverlust:** Wenn beim Programmstart keine Verbindung zum Server hergestellt werden kann, läuft KST4Contest nicht mehr in eine Endlos- oder Busy-Wait-Schleife. Die Oberfläche bleibt bedienbar und weitere Versuche erfolgen mit begrenztem Backoff. Auch ein vom Server geschlossener oder über längere Zeit stummer Socket wird zuverlässig erkannt.
|
||||||
|
diff --git a/github_docs/en-Changelog.md b/github_docs/en-Changelog.md
|
||||||
|
index 1635ce44..af1cb47b 100644
|
||||||
|
--- a/github_docs/en-Changelog.md
|
||||||
|
+++ b/github_docs/en-Changelog.md
|
||||||
|
@@ -8,6 +8,72 @@ Published Stable versions and their application packages are available under [Gi
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
+## v1.43.1 (2026-09-03)
|
||||||
|
+
|
||||||
|
+**Corrected version metadata**
|
||||||
|
+
|
||||||
|
+v1.43.1 contains the same functional changes as v1.43.0. It corrects the application and build metadata used for display, ON4KST identification and update comparison. Some metadata in the first v1.43.0 package set still identified the build as version 1.42.
|
||||||
|
+
|
||||||
|
+### Fixed
|
||||||
|
+
|
||||||
|
+- **Consistent semantic version:** The user-visible application version now uses the complete `1.43.1` form. The compact value `1.431` remains only in the deprecated numeric field required for compatibility with older update feeds.
|
||||||
|
+
|
||||||
|
+- **Tagged-release update feed:** The website build, version-feed validation and artifact upload now run as actual workflow steps after the GitHub Release has been published. They were previously indented into the release action's artifact list and therefore skipped.
|
||||||
|
+
|
||||||
|
+Users of v1.43.0 should install v1.43.1. The functionality is unchanged; the update only corrects the version metadata and release workflow.
|
||||||
|
+
|
||||||
|
+The corrected version is available as [Release v1.43.1](https://github.com/praktimarc/kst4contest/releases/tag/v1.43.1).
|
||||||
|
+
|
||||||
|
+---
|
||||||
|
+
|
||||||
|
+## v1.43.0 (2026-09-03)
|
||||||
|
+
|
||||||
|
+**More reliable log synchronisation, persistent layouts and better DX Cluster compatibility**
|
||||||
|
+
|
||||||
|
+v1.43 concentrates on reliability around external log data and long-running contest operation. It also adds practical control over table layouts and station grouping on the map.
|
||||||
|
+
|
||||||
|
+### Added
|
||||||
|
+
|
||||||
|
+- **Optional map clustering:** **Group nearby stations** immediately enables or disables spatial grouping at lower zoom levels. The stored setting changes neither the viewport nor the selected station; aggregation of active variants sharing one base callsign remains independent. This implements [Issue #79](https://github.com/praktimarc/kst4contest/issues/79).
|
||||||
|
+
|
||||||
|
+- **Automatic table-layout persistence:** Tables receive useful widths when their first meaningful contents arrive. Manually changed column widths, window sizes and relevant dividers are written to `preferences.xml` after a short delay. The main and monitor windows keep separate DXCluster and QSO-of-the-other layouts.
|
||||||
|
+
|
||||||
|
+- **Tooltips for truncated table values:** Normal table cells expose their complete text when the visible column is too narrow, without replacing functional tooltips or clickable links.
|
||||||
|
+
|
||||||
|
+- **Simplelogfile creation notice:** When the selected file does not exist, KST4Contest creates it and displays a notice with the file path, a concrete test procedure and a link to the relevant manual section.
|
||||||
|
+
|
||||||
|
+### Changed
|
||||||
|
+
|
||||||
|
+- **Robust Simplelogfile evaluation:** The selected file is evaluated once per minute and closed after every pass so that the logging application can replace or rotate it. Detected callsigns apply the global Worked state to every active suffix variant of the base callsign. Disabling the function prevents any file access, while read or creation errors no longer terminate the periodic task.
|
||||||
|
+
|
||||||
|
+- **Consistent external logger bands:** UCXLog-compatible packets and Win-Test events use one shared band normalisation. Numeric values, metre and centimetre designators and the existing Win-Test IDs now set the same Worked flags and worked grid squares. Values including `2320`, `5760` and `10368` are handled reliably; a missing or unknown band sets only the global Worked state.
|
||||||
|
+
|
||||||
|
+- **Compact full-frequency recognition:** Complete frequencies without a decimal separator are accepted across the supported bands, with the final three digits interpreted as the kHz part. Bare three-digit numbers still require recognisable frequency context so that signal reports and unrelated numbers are not treated as QRGs.
|
||||||
|
+
|
||||||
|
+- **DXSpider-compatible spot format:** Local DX Cluster spots use a fixed 75-character payload line with the DX callsign in column 27, a 30-character comment field and UTC time in column 71. The format remains stable up to 24 GHz. Overlong DX callsigns are rejected and logged instead of being silently truncated. This resolves [Issue #86](https://github.com/praktimarc/kst4contest/issues/86).
|
||||||
|
+
|
||||||
|
+- **Active ON4KST connection probe:** A quiet chat server is checked with an explicit session-wide probe before the connection is treated as dead. Heartbeats and probe frames retain the required CR/LF framing.
|
||||||
|
+
|
||||||
|
+- **Reliable private-message age highlighting:** Incoming private messages use the defined green age levels for up to five minutes. Locally sent messages retain their separate style, and empty or reused table rows return to the normal design instead of keeping an obsolete highlight.
|
||||||
|
+
|
||||||
|
+### Fixed
|
||||||
|
+
|
||||||
|
+- **Worked state after login:** Persisted SQLite Worked information is loaded and applied before each initial ON4KST user list is published. Reconnects, both categories and all active variants of a base callsign therefore start with the correct state. This resolves [Issue #85](https://github.com/praktimarc/kst4contest/issues/85).
|
||||||
|
+
|
||||||
|
+- **False disconnect during quiet periods:** A valid ON4KST connection is no longer closed merely because the server currently has no activity lines to send.
|
||||||
|
+
|
||||||
|
+### Documentation and packaging
|
||||||
|
+
|
||||||
|
+- The German and English manuals were revised against the implementation. A new contest-workflow chapter connects the individual functions into a practical operating sequence, while the sections on dual chat, private-message handling, QRG synchronisation, Simplelogfile evaluation and configuration were clarified.
|
||||||
|
+
|
||||||
|
+- The website feature pages now describe band and direction opportunities, the station map, QRG handling, filters, global message views, private-message handling and logger synchronisation in more detail.
|
||||||
|
+
|
||||||
|
+- The AUR package definitions were updated for v1.43.0.
|
||||||
|
+
|
||||||
|
+The complete v1.43.0 functionality is available in [Release v1.43.0](https://github.com/praktimarc/kst4contest/releases/tag/v1.43.0). Because its embedded version metadata is inconsistent, v1.43.1 is the recommended package set.
|
||||||
|
+
|
||||||
|
+---
|
||||||
|
+
|
||||||
|
## v1.42.0 (2026-08-22)
|
||||||
|
|
||||||
|
**Shared band context, session-based ON4KST connection and signed macOS packages**
|
||||||
|
@@ -38,21 +104,17 @@ v1.42 brings several previously separate calculations together. Band information
|
||||||
|
|
||||||
|
- **Filter reset:** A dedicated reset button reliably removes the active user-list filter predicates.
|
||||||
|
|
||||||
|
-- **Optional map clustering:** **Group nearby stations** immediately enables or disables spatial grouping at lower zoom levels. The automatically stored setting changes neither the viewport nor the selected station; aggregation of active variants sharing one base callsign remains independent. This implements [Issue #79](https://github.com/praktimarc/kst4contest/issues/79).
|
||||||
|
+- **Map clustering:** Stations close to each other are grouped at lower zoom levels. The selected station and relevant direction opportunities remain individually visible.
|
||||||
|
|
||||||
|
- **Hideable path analysis:** The terrain profile and analysis section of the station map can be hidden completely. The selected state is stored and restored at the next application start.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
-- **Automatic table-layout persistence:** Tables receive useful widths when their first meaningful contents arrive. Manually changed column widths, window sizes and relevant dividers are written to `preferences.xml` after a short delay; the main and monitor windows keep separate DXCluster and QSO-of-the-other layouts. Truncated normal cell values expose their full text in a tooltip without replacing functional tooltips or clickable links.
|
||||||
|
-
|
||||||
|
-- **Unified DX Cluster line format:** Local spots now use a fixed, DXSpider-compatible 75-character payload line with the DX callsign in column 27, a 30-character comment field and UTC time in column 71. The layout remains stable for microwave frequencies up to 24 GHz. Overlong DX callsigns are rejected and logged instead of being silently truncated; AirScout and test comments are correspondingly more compact.
|
||||||
|
-
|
||||||
|
- **Session-based ON4KST connection lifecycle:** Each socket, reader, writer, message bus and queue now belongs to an explicitly identified connection session. Delayed threads from an obsolete connection can therefore no longer process data or close its replacement. `ONLINE` is reported only after the login has been accepted and all requested user lists have been received. Connection setup, login and synchronisation use bounded timeouts, while heartbeats, missing inbound traffic, EOF and read or write failures trigger controlled reconnect attempts with backoff where appropriate.
|
||||||
|
|
||||||
|
- **Validated ON4KST protocol commands:** Outgoing frames are built centrally and checked for valid categories, locators and prohibited frame delimiters. Because ON4KST maintains one locator per TCP session, the main locator is used for both chat categories and a conflicting secondary configuration is logged instead of sending contradictory commands to the server.
|
||||||
|
|
||||||
|
-- **More precise QRG recognition:** Complete frequencies are also recognised without a decimal separator, with the final three digits interpreted as the kHz part. Relative frequencies remain unchanged, and bare three-digit numbers still require recognisable frequency context. Signal reports, band designators and unrelated numbers therefore produce fewer false frequencies.
|
||||||
|
+- **More precise QRG recognition:** Complete and relative frequency references continue to be recognised. Bare three-digit numbers are treated as QRGs only when a frequency context is available. Signal reports, band designators and unrelated numbers therefore produce fewer false frequencies.
|
||||||
|
|
||||||
|
- **Station-specific frequency context:** For relative QRGs, KST4Contest first uses a band context for the same station which is no more than 30 minutes old. The globally configured fallback band is used only when this context is unavailable.
|
||||||
|
|
||||||
|
@@ -86,10 +148,6 @@ v1.42 brings several previously separate calculations together. Band information
|
||||||
|
|
||||||
|
- **DXLog full-log import:** In addition to `contactinfo`, the UCXLog-compatible UDP listener processes `contactreplace`. This allows a complete log broadcast by DXLog.net to be imported.
|
||||||
|
|
||||||
|
-- **Consistent logger band values:** Numeric, metre and centimetre values from UCXLog-compatible QSO packets and Win-Test band IDs are normalised once and then used consistently for Worked marks and worked grid squares. In particular, `2320`, `5760` and `10368` now reliably set their existing band marks. A missing or unknown band continues to set only the global Worked status.
|
||||||
|
-
|
||||||
|
-- **Defined Simplelogfile behaviour:** The selected text file is evaluated once per minute using a fixed callsign pattern. Matches set the global Worked status for all active variants of the base callsign but are not persisted in SQLite. A missing file is created, and read or creation errors do not terminate the periodic task. A database reset does not change the file, so callsigns contained in it are marked as worked again during the next evaluation.
|
||||||
|
-
|
||||||
|
- **Guarded automatic QRG updates:** `MYQRG` is updated only by an enabled interface which actually supplies valid `RadioInfo` or Win-Test `STATUS` packets. An enabled source which provides no data does not remove the need for a functional check or manual QRG maintenance.
|
||||||
|
|
||||||
|
- **Improved version comparison:** Versions are compared semantically so that patch releases and Nightly versions are not misclassified by conversion to a floating-point number.
|
||||||
|
@@ -98,8 +156,6 @@ v1.42 brings several previously separate calculations together. Band information
|
||||||
|
|
||||||
|
- **Reliable initial user list:** Invalid or incomplete `UA0` member records are rejected and logged individually without preventing alphabetically following members from being processed. Valid entries are staged per category and published as one complete snapshot when the first corresponding `UE` end marker is received.
|
||||||
|
|
||||||
|
-- **Persisted Worked state during initial-list setup:** At the end of each initial ON4KST user list, the SQLite state is loaded once and applied to the new chat members before publication. This covers both categories, reconnects and every active variant of a base callsign.
|
||||||
|
-
|
||||||
|
- **User list disappearing after login:** ON4KST may send additional `UE` frames for the same category after name, state or other live updates. Repeated end markers are now detected and ignored so that an already populated user list cannot be replaced by an empty snapshot.
|
||||||
|
|
||||||
|
- **Failed initial connection and lost sockets:** An unavailable server during startup no longer sends KST4Contest into an endless or busy-wait loop. The user interface remains responsive and further attempts use bounded reconnect backoff. Sockets closed by the server, or connections without inbound traffic for an excessive period, are also detected reliably.
|
||||||
|
diff --git a/src/main/java/kst4contest/ApplicationConstants.java b/src/main/java/kst4contest/ApplicationConstants.java
|
||||||
|
index 6da42ff4..71f64575 100644
|
||||||
|
--- a/src/main/java/kst4contest/ApplicationConstants.java
|
||||||
|
+++ b/src/main/java/kst4contest/ApplicationConstants.java
|
||||||
|
@@ -20,7 +20,7 @@ public class ApplicationConstants {
|
||||||
|
/**
|
||||||
|
* Version shown to the user and used for semantic version comparison.
|
||||||
|
*/
|
||||||
|
- public static final String APPLICATION_CURRENT_VERSION = "1.431";
|
||||||
|
+ public static final String APPLICATION_CURRENT_VERSION = "1.43.1";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Legacy numeric representation used only while older update feeds and
|
||||||
|
diff --git a/website/src/news/2026-09-03-version-1-43.md b/website/src/news/2026-09-03-version-1-43.md
|
||||||
|
new file mode 100644
|
||||||
|
index 00000000..30754c3d
|
||||||
|
--- /dev/null
|
||||||
|
+++ b/website/src/news/2026-09-03-version-1-43.md
|
||||||
|
@@ -0,0 +1,29 @@
|
||||||
|
+---
|
||||||
|
+title: Version 1.43.1 released
|
||||||
|
+summary: Reliable log synchronisation, persistent layouts and better DX Cluster compatibility
|
||||||
|
+date: 2026-09-03
|
||||||
|
+---
|
||||||
|
+
|
||||||
|
+## Version 1.43.1
|
||||||
|
+
|
||||||
|
+Version 1.43 focuses on the parts of KST4Contest that have to keep working during a long contest: ON4KST connection monitoring, log synchronisation, Worked information and the data sent to external logging software.
|
||||||
|
+
|
||||||
|
+The first v1.43.0 packages already contained all functional changes described below, but some embedded version metadata still identified the build as version 1.42. v1.43.1 corrects this. If you already downloaded v1.43.0, use v1.43.1 instead.
|
||||||
|
+
|
||||||
|
+### What changed
|
||||||
|
+
|
||||||
|
+- **More reliable log synchronisation:** The Simplelogfile parser now closes the selected file after every pass, handles suffix variants by their base callsign and reports when a missing file has been created. UCXLog-compatible packets and Win-Test events share the same band normalisation, including the existing microwave bands.
|
||||||
|
+- **Correct Worked state after login:** Persisted Worked information is applied before the initial ON4KST user list becomes visible. Reconnects and both chat categories therefore start with the correct state.
|
||||||
|
+- **No false disconnect on a quiet server:** KST4Contest actively checks a quiet ON4KST session before treating it as dead. A period without new activity lines no longer causes an unnecessary reconnect.
|
||||||
|
+- **DX Cluster compatibility:** Local spots now use a fixed, DXSpider-compatible 75-character line format that is also accepted reliably by DXLog. Frequencies up to 24 GHz keep the required column positions.
|
||||||
|
+- **Layouts that stay where you put them:** Table column widths, window sizes and relevant dividers are saved automatically. Truncated table values expose their full text in a tooltip.
|
||||||
|
+- **Controllable map grouping:** **Group nearby stations** switches map clustering on or off without changing the current viewport or selected station.
|
||||||
|
+- **Smaller corrections:** Complete QRGs without a decimal separator are recognised across the supported bands, and private-message age highlighting no longer remains attached to reused table rows.
|
||||||
|
+
|
||||||
|
+The complete technical list is available in the [changelog](/manual/en/changelog/) and the [GitHub release notes](https://github.com/praktimarc/kst4contest/releases/tag/v1.43.1).
|
||||||
|
+
|
||||||
|
+### Getting it
|
||||||
|
+
|
||||||
|
+Packages for Windows, Linux and macOS are available on the [download page](/download/) and in the [GitHub release](https://github.com/praktimarc/kst4contest/releases/tag/v1.43.1). The AUR packages are updated through their normal release workflow.
|
||||||
|
+
|
||||||
|
+The German and English manuals have also been revised. The new contest-workflow chapter connects the individual functions into a practical operating sequence instead of describing them only in isolation. 73
|
||||||
|
--
|
||||||
|
2.51.1
|
||||||
|
|
||||||
Binary file not shown.
Binary file not shown.
+58
-5
@@ -1,6 +1,6 @@
|
|||||||
# KST4Contest Project Context
|
# KST4Contest Project Context
|
||||||
|
|
||||||
Last reviewed: 2026-09-03
|
Last reviewed: 2026-09-13
|
||||||
|
|
||||||
This file is the durable technical project context for KST4Contest. It is not a user manual and not a replacement for the changelog. Current code, tests and authoritative external specifications remain the source of truth when this document is stale or ambiguous.
|
This file is the durable technical project context for KST4Contest. It is not a user manual and not a replacement for the changelog. Current code, tests and authoritative external specifications remain the source of truth when this document is stale or ambiguous.
|
||||||
|
|
||||||
@@ -101,6 +101,16 @@ CR/LF framing, XML framing, ports/transports, callsign normalization and frequen
|
|||||||
- External logger threads do not read or mutate the JavaFX user-list projection. `ChatController` applies global and per-band Worked state to every active variant of the base callsign on the JavaFX Application Thread before evaluating a band-upgrade notice.
|
- External logger threads do not read or mutate the JavaFX user-list projection. `ChatController` applies global and per-band Worked state to every active variant of the base callsign on the JavaFX Application Thread before evaluating a band-upgrade notice.
|
||||||
- The established Win-Test handling for 24, 47 and 76 GHz remains unchanged. Their Worked flags are retained, while only frequencies represented by the project `Band` model can create worked-grid state.
|
- The established Win-Test handling for 24, 47 and 76 GHz remains unchanged. Their Worked flags are retained, while only frequencies represented by the project `Band` model can create worked-grid state.
|
||||||
|
|
||||||
|
### Win-Test log recovery
|
||||||
|
|
||||||
|
- Win-Test only broadcasts new QSOs. A listener started later never sees the earlier ones, so KST4Contest pulls them with the Win-Test `IHAVE` / `NEEDQSO` protocol, ported from the wtKST `WtLogSync` implementation. The answers are ordinary `ADDQSO` packets and reuse the established Worked path; the recovery itself never touches database or UI.
|
||||||
|
- The recovery is not configurable. It is bound to the existing Win-Test network listener, runs automatically once a station is detected through `HELLO` or `STATUS`, and stays active so gaps caused by lost broadcasts are refetched.
|
||||||
|
- The station-name filter remains a QRG-sync setting. Log recovery covers every station in the network, because each band station of a multi-station setup keeps its own log and contributes per-band Worked state.
|
||||||
|
- A QSO is identified by `StationName@LogUniqueID` plus the Win-Test QSO number. That identity deduplicates the answers of overlapping requests, so a recovered log is written once instead of once per resend.
|
||||||
|
- Win-Test framing must be resolved on the raw datagram bytes: the checksum byte is not valid ASCII and would otherwise corrupt the trailing fields, which carry the log ID of `ADDQSO` and the run-length inventory of `IHAVE`. A broken checksum discards `IHAVE` only; the established handling of the other message types is unchanged and still does not verify checksums.
|
||||||
|
- Win-Test answers broadcasts only; an identical unicast request to the same station stays unanswered (verified against Win-Test). Outgoing Win-Test packets therefore derive their broadcast address from the source address of received Win-Test packets, with the configured address as fallback for a station behind a router. A configured address pointing at a non-existent network raises no send error, so it silently disabled both log recovery and SKED handover before. Only genuine Win-Test message types update that address; internal control packets such as the poison pill must not redirect outgoing traffic.
|
||||||
|
- `IHAVE` inventories are run-length encoded and may be split, so the announced first row is honoured instead of assuming that an inventory starts at QSO number one. A station that never sends a usable inventory is served by a blind block fallback starting at QSO number one.
|
||||||
|
|
||||||
### Terrain data providers
|
### Terrain data providers
|
||||||
|
|
||||||
- The active terrain profile provider is Open-Meteo using Copernicus GLO-90 data.
|
- The active terrain profile provider is Open-Meteo using Copernicus GLO-90 data.
|
||||||
@@ -116,11 +126,11 @@ CR/LF framing, XML framing, ports/transports, callsign normalization and frequen
|
|||||||
|
|
||||||
### ON4KST session liveness
|
### ON4KST session liveness
|
||||||
|
|
||||||
- After 90 seconds without inbound data, the application keeps the established empty CRLF heartbeat.
|
- Only after the session is fully authenticated and synchronized, more than 90 seconds without inbound server data trigger one client-side `CK|\r\n` liveness probe. The trailing pipe matches the framing used by the server for its own `CK|\r\n` probe. The probe state belongs to the TCP session, so a two-category session still sends only one probe per idle phase.
|
||||||
- At about 180 seconds of inbound idle time, the TCP session sends one `RDXQ|<main chat id>|` probe. The probe state belongs to the session, so a two-category session still sends only one probe per idle phase.
|
- The live ON4KST test returned `OK|\r\n` for `CK|\r\n`. KST4Contest treats both that confirmed frame and the originally specified `OK\r\n` form as internal responses: it records inbound activity, confirms the outstanding probe and does not publish the response as chat content. Any other inbound server frame also confirms reachability and starts a new idle phase.
|
||||||
- Any subsequent inbound server frame confirms the probe. `DXQ` is accepted as the expected internal response and is not published as chat content.
|
- A `CK` initiated by the server remains a separate protocol case and receives the established empty CRLF response. It must not be confused with the client-side probe.
|
||||||
- If no inbound frame arrives by about 210 seconds, the existing reconnect flow remains responsible for replacing the session.
|
- If no inbound frame arrives by about 210 seconds, the existing reconnect flow remains responsible for replacing the session.
|
||||||
- Probe diagnostics contain the session id, main category, opcode and timing only. They must not include credentials, complete server frames or normal chat messages.
|
- Liveness diagnostics contain the session id, opcode and timing only. They must not include credentials, complete server frames or normal chat messages.
|
||||||
|
|
||||||
## User Workflow / UI Invariants
|
## User Workflow / UI Invariants
|
||||||
|
|
||||||
@@ -160,8 +170,51 @@ After implementation use targeted documentation-impact checks. Do not run a comp
|
|||||||
|
|
||||||
The repository contains the KST4Contest website under `website/`, published separately from the desktop application build.
|
The repository contains the KST4Contest website under `website/`, published separately from the desktop application build.
|
||||||
|
|
||||||
|
- Historical GHz-Tagung papers are published as German and English PDF assets below `website/src/assets/papers/` and explained on `/background/`. Their editable ODT sources remain outside the public Eleventy input tree and must never be copied into the generated site.
|
||||||
|
- The home-page news teaser is derived from the date-sorted Eleventy `news` tag collection. It deliberately renders nothing when that collection is empty; it must not be pinned to a release version.
|
||||||
|
|
||||||
Current website/deployment scripts and update-feed behaviour must be inspected before changes; do not rely on historical assumptions.
|
Current website/deployment scripts and update-feed behaviour must be inspected before changes; do not rely on historical assumptions.
|
||||||
|
|
||||||
|
- `APPLICATION_CURRENT_VERSION` is the user-visible semantic version and must use the dotted `major.minor.patch` form. `APPLICATION_CURRENTVERSIONNUMBER` is retained only for older feeds and encodes patch releases by appending the patch digit, for example `1.43.1` as `1.431`.
|
||||||
|
- The tagged-release workflow creates the GitHub Release before building the website update feed. This ordering is required because `versionInfo.js` reads the published release body through the GitHub Releases API.
|
||||||
|
- After publication, the workflow tests and builds the website, validates the expected Stable version, attaches `kst4ContestVersionInfo.xml` to the release and uploads the complete website build as a workflow artifact.
|
||||||
|
|
||||||
|
### Server-side website statistics
|
||||||
|
|
||||||
|
The detailed operator runbook is
|
||||||
|
[`website/ops/analytics/README.md`](../website/ops/analytics/README.md). This
|
||||||
|
section records only the durable architecture and operational boundaries.
|
||||||
|
|
||||||
|
#### Architecture and data flow
|
||||||
|
|
||||||
|
- Production runs on Ubuntu Server 24.04 with Nginx 1.24, Node.js 18.19.1 and GoAccess 1.8.1. GoAccess has GeoIP2/MMDB and OpenSSL support but no Zlib support; missing Zlib is intentional for this operating model.
|
||||||
|
- Nginx writes eligible `GET` page requests to a reduced, tab-separated analytics log in addition to the normal operational log. It records server name, client IP, time, method, normalized path without query string, protocol, status, bytes and user agent; referrer and remote user are omitted.
|
||||||
|
- Nginx removes assets, downloads, status/monitoring paths, update feed, counter requests and known crawler clients before logging. GoAccess supplies the second crawler-classification layer, anonymises IP addresses at the configured level and performs Country lookup locally through GeoLite2-Country.
|
||||||
|
- The hourly systemd timer starts the Node.js generator. Each registered site is processed from its optional uncompressed `.1` rotation followed by the current log; older `.gz` files are not part of regular processing. Logrotate retains raw analytics logs for 14 days and requires `delaycompress` for this handover.
|
||||||
|
- GoAccess maintains one private report/database per registered site and one combined report/database. The generator then updates its separate daily counter state and publishes `visitor-count.json` for enabled sites. Private reports are served with Basic Auth from `stats.hamradioonline.de`; the public home page requests only its same-origin counter file.
|
||||||
|
|
||||||
|
#### Durable invariants and persistence
|
||||||
|
|
||||||
|
- GoAccess defines a visit by IP address, date and user agent. The public value is therefore an approximate visit total, not a count of unique people, and remains separate from page views.
|
||||||
|
- The public contract contains only `schemaVersion`, `visits`, `since` and `updatedAt`. The browser uses no analytics cookie, local storage or third-party request; failed or invalid responses leave the counter hidden.
|
||||||
|
- The site registry at `/etc/hamradioonline-analytics/sites.json` owns stable site IDs, hostnames, current uncompressed log paths, activation dates and output targets. `stats.hamradioonline.de` is never registered as an analytics site. Existing counter state cannot be continued with a changed hostname or `activatedOn` without an explicit migration or reset decision.
|
||||||
|
- GoAccess databases below `/var/lib/hamradioonline-analytics/db` retain rolling 395-day detail through `--persist` and `--restore`. `/var/lib/hamradioonline-analytics/public-counter-state.json` retains daily values from activation onward and is the durable business source for the lifetime public total. Reports and public JSON files are derived outputs.
|
||||||
|
- GoAccess 1.8.1 exposes Country data as `geolocation`; combined jobs explicitly enable `VIRTUAL_HOSTS` and require `vhosts`. Individual site jobs do not enable that panel. `geo_location` and `virtual_hosts` are invalid interface names.
|
||||||
|
- Generator inputs and staged GoAccess outputs are validated before publication. Files are replaced atomically, dry-runs use temporary state without the production lock, and productive runs use `/run/hamradioonline-analytics/generator.lock`. Exit codes are 1 for runtime/publication errors, 2 for configuration errors and 3 when the production lock cannot be acquired.
|
||||||
|
|
||||||
|
#### Components, roles and external services
|
||||||
|
|
||||||
|
- `hamradio-analytics` is the locked, non-login service account which reads configuration, Country MMDB and analytics logs and writes service state. Nginx runs as `www-data`, writes the analytics log and can read only reports and the public counter, not private databases or counter state. `stats-reader` is a local Nginx Basic Auth login whose password file remains outside Git.
|
||||||
|
- Root-managed program/configuration lives below `/opt/hamradioonline-analytics` and `/etc/hamradioonline-analytics`; service state lives below `/var/lib/hamradioonline-analytics`. Report/public directories are shared read-only with Nginx through group ownership; no ACL dependency exists.
|
||||||
|
- MaxMind is used only by `geoipupdate` to download GeoLite2-Country. Visitor lookups are local; Account ID and License Key remain in the protected server configuration. Let's Encrypt supplies TLS for the statistics vhost through the permanent ACME webroot and `/snap/bin/certbot`. GitHub supplies website source and deployment, not analytics processing.
|
||||||
|
- The website deploy checks out `origin/main`, builds the static site and publishes it to the Nginx document root. It does not install or overwrite analytics programs/configuration, systemd, Nginx, Logrotate, GeoIP, Basic Auth or Certbot state; those remain separate manual server operations.
|
||||||
|
- Passwords, hashes, deployment credentials, MaxMind credentials, ACME account data and private TLS keys must remain outside the repository and ordinary diagnostic output.
|
||||||
|
|
||||||
|
#### Open operational work
|
||||||
|
|
||||||
|
- The server has no comprehensive automated backup plan yet. A future server-wide plan must include the non-regenerable counter state, GoAccess databases and protected operational configuration without extending the published 14-day raw-log retention.
|
||||||
|
- The first real rotation of the dedicated analytics log still requires an explicit operational check of `.1`, ownership/readability, subsequent generator success and absence of duplicate counting. This is not a current service blocker.
|
||||||
|
|
||||||
## Important Decisions and Workarounds
|
## Important Decisions and Workarounds
|
||||||
|
|
||||||
- Preserve full callsign/category identity while applying base-call normalisation only to specifically defined features.
|
- Preserve full callsign/category identity while applying base-call normalisation only to specifically defined features.
|
||||||
|
|||||||
+68
-12
@@ -8,6 +8,72 @@ Die veröffentlichten Stable-Versionen und ihre Programmpakete stehen unter [Git
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## v1.43.1 (2026-09-03)
|
||||||
|
|
||||||
|
**Korrigierte Versionsmetadaten**
|
||||||
|
|
||||||
|
v1.43.1 enthält dieselben funktionalen Änderungen wie v1.43.0. Korrigiert wurden die Anwendungs- und Build-Metadaten für Anzeige, ON4KST-Kennung und Update-Vergleich. Ein Teil der Metadaten des ersten v1.43.0-Pakets wies den Build noch als Version 1.42 aus.
|
||||||
|
|
||||||
|
### Behoben
|
||||||
|
|
||||||
|
- **Einheitliche semantische Version:** Die sichtbare Anwendungsversion verwendet jetzt vollständig `1.43.1`. Der kompakte Wert `1.431` bleibt ausschließlich im veralteten numerischen Feld für die Kompatibilität mit älteren Update-Feeds erhalten.
|
||||||
|
|
||||||
|
- **Update-Feed im Tagged-Release-Workflow:** Website-Build, Prüfung des Versionsfeeds und Upload der Artefakte laufen jetzt tatsächlich nach der Veröffentlichung des GitHub Releases. Diese Schritte waren zuvor versehentlich in die Artefaktliste der Release-Action eingerückt und wurden deshalb übersprungen.
|
||||||
|
|
||||||
|
Wer v1.43.0 installiert hat, sollte v1.43.1 verwenden. Die Funktionen bleiben unverändert; korrigiert werden nur die Versionsmetadaten und der Release-Workflow.
|
||||||
|
|
||||||
|
Die korrigierte Version ist als [Release v1.43.1](https://github.com/praktimarc/kst4contest/releases/tag/v1.43.1) verfügbar.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## v1.43.0 (2026-09-03)
|
||||||
|
|
||||||
|
**Zuverlässigere Log-Synchronisation, gespeicherte Tabellenlayouts und bessere DX-Cluster-Kompatibilität**
|
||||||
|
|
||||||
|
v1.43 konzentriert sich auf die zuverlässige Verarbeitung externer Logdaten und den stabilen Betrieb während längerer Conteste. Hinzu kommen praktische Einstellmöglichkeiten für Tabellenlayouts und die Stationsgruppierung auf der Karte.
|
||||||
|
|
||||||
|
### Neu
|
||||||
|
|
||||||
|
- **Optionale Kartencluster:** **Group nearby stations** schaltet die räumliche Gruppierung bei niedrigen Zoomstufen unmittelbar ein oder aus. Die gespeicherte Auswahl verändert weder Kartenausschnitt noch Stationsauswahl; die Zusammenfassung aktiver Varianten desselben Basisrufzeichens bleibt davon unabhängig. Damit ist [Issue #79](https://github.com/praktimarc/kst4contest/issues/79) umgesetzt.
|
||||||
|
|
||||||
|
- **Tabellenlayout automatisch gesichert:** Tabellen erhalten beim ersten brauchbaren Inhalt sinnvolle Breiten. Manuell geänderte Spaltenbreiten, Fenstergrößen und relevante Divider werden nach kurzer Verzögerung in `preferences.xml` geschrieben. Haupt- und Monitorfenster behalten getrennte Layouts für DXCluster und QSO of the other.
|
||||||
|
|
||||||
|
- **Tooltips für gekürzte Tabellenwerte:** Normale Tabellenzellen zeigen ihren vollständigen Inhalt, wenn die sichtbare Spalte zu schmal ist. Funktionale Tooltips und anklickbare Links bleiben davon unberührt.
|
||||||
|
|
||||||
|
- **Hinweis bei neu angelegtem Simplelogfile:** Fehlt die ausgewählte Datei, legt KST4Contest sie an und zeigt einen Hinweis mit Dateipfad, konkretem Testablauf und Link zum passenden Abschnitt des Handbuchs.
|
||||||
|
|
||||||
|
### Geändert
|
||||||
|
|
||||||
|
- **Robuste Simplelogfile-Auswertung:** Die ausgewählte Datei wird einmal pro Minute ausgewertet und nach jedem Durchlauf geschlossen, damit das Logprogramm sie ersetzen oder rotieren kann. Erkannte Rufzeichen setzen den globalen Worked-Status für alle aktiven Suffixvarianten des Basisrufzeichens. Bei deaktivierter Funktion findet kein Dateizugriff statt; Lese- oder Erstellungsfehler beenden die periodische Aufgabe nicht mehr.
|
||||||
|
|
||||||
|
- **Einheitliche Bandwerte externer Logger:** UCXLog-kompatible Pakete und Win-Test-Ereignisse verwenden eine gemeinsame Bandnormalisierung. Numerische Werte, Meter- und Zentimeterangaben sowie die vorhandenen Win-Test-IDs setzen damit dieselben Worked-Markierungen und Worked-Großfelder. Insbesondere `2320`, `5760` und `10368` werden zuverlässig verarbeitet; bei fehlendem oder unbekanntem Band wird nur der globale Worked-Status gesetzt.
|
||||||
|
|
||||||
|
- **Kompakte vollständige Frequenzen erkannt:** Vollständige Frequenzangaben ohne Dezimaltrenner werden auf allen unterstützten Bändern akzeptiert; die letzten drei Ziffern bilden den kHz-Anteil. Nackte dreistellige Zahlen benötigen weiterhin einen erkennbaren Frequenzkontext, damit Signalrapporte und andere Zahlen nicht als QRG behandelt werden.
|
||||||
|
|
||||||
|
- **DXSpider-kompatibles Spotformat:** Lokale DX-Cluster-Spots verwenden eine feste 75-Zeichen-Nutzzeile mit dem DX-Rufzeichen ab Spalte 27, einem 30 Zeichen breiten Kommentarfeld und der UTC-Zeit ab Spalte 71. Das Format bleibt bis 24 GHz stabil. Überlange DX-Rufzeichen werden verworfen und protokolliert, statt unbemerkt abgeschnitten zu werden. Damit ist [Issue #86](https://github.com/praktimarc/kst4contest/issues/86) behoben.
|
||||||
|
|
||||||
|
- **Aktive ON4KST-Verbindungsprüfung:** Ein ruhiger Chatserver wird mit einer expliziten, sitzungsweiten Abfrage geprüft, bevor die Verbindung als unterbrochen gilt. Heartbeat und Prüftelegramme behalten das erforderliche CR/LF-Framing.
|
||||||
|
|
||||||
|
- **Zuverlässige Altersmarkierung privater Nachrichten:** Eingehende Privatnachrichten verwenden bis zu fünf Minuten lang die definierten grünen Altersstufen. Eigene Nachrichten behalten ihre separate Darstellung; leere oder wiederverwendete Tabellenzeilen kehren zum normalen Design zurück und behalten keine veraltete Hervorhebung.
|
||||||
|
|
||||||
|
### Behoben
|
||||||
|
|
||||||
|
- **Worked-Status nach dem Login:** Persistierte SQLite-Informationen werden vor der Veröffentlichung jeder initialen ON4KST-Benutzerliste geladen und angewendet. Erneute Verbindungen, beide Kategorien und alle aktiven Varianten eines Basisrufzeichens starten dadurch mit dem richtigen Status. Damit ist [Issue #85](https://github.com/praktimarc/kst4contest/issues/85) behoben.
|
||||||
|
|
||||||
|
- **Fehlerhafte Trennung bei ruhigem Server:** Eine gültige ON4KST-Verbindung wird nicht mehr beendet, nur weil der Server gerade keine Aktivitätszeilen überträgt.
|
||||||
|
|
||||||
|
### Dokumentation und Auslieferung
|
||||||
|
|
||||||
|
- Das deutsche und englische Handbuch wurden mit der Implementierung abgeglichen und überarbeitet. Ein neues Kapitel zum Contest-Workflow verbindet die einzelnen Funktionen zu einem praktischen Betriebsablauf; außerdem wurden die Abschnitte zu Dual Chat, Privatnachrichten, QRG-Synchronisation, Simplelogfile-Auswertung und Konfiguration präzisiert.
|
||||||
|
|
||||||
|
- Die Website beschreibt Band- und Richtungsgelegenheiten, Stationskarte, QRG-Verarbeitung, Filter, globale Nachrichtenansichten, Privatnachrichten und Log-Synchronisation jetzt ausführlicher.
|
||||||
|
|
||||||
|
- Die AUR-Paketdefinitionen wurden auf v1.43.0 aktualisiert.
|
||||||
|
|
||||||
|
Die vollständige Funktionalität von v1.43.0 steht im [Release v1.43.0](https://github.com/praktimarc/kst4contest/releases/tag/v1.43.0) bereit. Wegen der inkonsistenten eingebetteten Versionsmetadaten ist v1.43.1 der empfohlene Paketstand.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## v1.42.0 (2026-08-22)
|
## v1.42.0 (2026-08-22)
|
||||||
|
|
||||||
**Gemeinsamer Bandkontext, sitzungsbasierte ON4KST-Verbindung und signierte macOS-Pakete**
|
**Gemeinsamer Bandkontext, sitzungsbasierte ON4KST-Verbindung und signierte macOS-Pakete**
|
||||||
@@ -38,21 +104,17 @@ v1.42 führt mehrere bisher getrennte Auswertungen zusammen. Bandinformationen,
|
|||||||
|
|
||||||
- **Filter zurücksetzen:** Ein eigener Reset-Button entfernt die aktiven Filterprädikate der Benutzerliste zuverlässig.
|
- **Filter zurücksetzen:** Ein eigener Reset-Button entfernt die aktiven Filterprädikate der Benutzerliste zuverlässig.
|
||||||
|
|
||||||
- **Optionale Kartencluster:** **Group nearby stations** schaltet die räumliche Gruppierung bei niedrigen Zoomstufen unmittelbar ein oder aus. Die automatisch gespeicherte Auswahl verändert weder Kartenausschnitt noch Stationsauswahl; die Zusammenfassung aktiver Varianten desselben Basisrufzeichens bleibt davon unabhängig. Damit ist [Issue #79](https://github.com/praktimarc/kst4contest/issues/79) umgesetzt.
|
- **Kartencluster:** Räumlich dicht beieinanderliegende Stationen werden bei niedrigen Zoomstufen zusammengefasst. Die ausgewählte Station und relevante Richtungsgelegenheiten bleiben einzeln sichtbar.
|
||||||
|
|
||||||
- **Ausblendbare Streckenanalyse:** Geländeprofil und Analysebereich der Stationskarte können vollständig ausgeblendet werden. Die Auswahl wird gespeichert und beim nächsten Programmstart wiederhergestellt.
|
- **Ausblendbare Streckenanalyse:** Geländeprofil und Analysebereich der Stationskarte können vollständig ausgeblendet werden. Die Auswahl wird gespeichert und beim nächsten Programmstart wiederhergestellt.
|
||||||
|
|
||||||
### Geändert
|
### Geändert
|
||||||
|
|
||||||
- **Tabellenlayout automatisch gesichert:** Tabellen werden beim ersten brauchbaren Inhalt sinnvoll dimensioniert. Manuell geänderte Spaltenbreiten, Fenstergrößen und relevante Divider werden verzögert in `preferences.xml` gespeichert; Haupt- und Monitorfenster behalten für DXCluster und QSO of the other getrennte Layouts. Gekürzte normale Zellwerte zeigen ihren Volltext im Tooltip, ohne funktionale Tooltips oder anklickbare Links zu verdrängen.
|
|
||||||
|
|
||||||
- **DX-Cluster-Zeilenformat vereinheitlicht:** Lokale Spots verwenden jetzt eine feste, DXSpider-kompatible 75-Zeichen-Nutzzeile mit dem DX-Rufzeichen ab Spalte 27, einem 30 Zeichen breiten Kommentarfeld und der UTC-Zeit ab Spalte 71. Das Format bleibt auch bei Mikrowellenfrequenzen bis 24 GHz stabil. Überlange DX-Rufzeichen werden verworfen und protokolliert, statt still abgeschnitten zu werden; AirScout- und Testkommentare sind entsprechend kompakter.
|
|
||||||
|
|
||||||
- **Sessionbezogene ON4KST-Verbindungssteuerung:** Socket, Reader, Writer, Messagebus und Warteschlangen gehören jetzt zu einer eindeutig identifizierten Verbindungssession. Veraltete Threads einer abgelösten Verbindung können dadurch keine Daten mehr verarbeiten oder die neue Verbindung schließen. `ONLINE` wird erst nach bestätigtem Login und vollständig empfangenen Benutzerlisten gemeldet. Verbindungsaufbau, Login und Synchronisation besitzen feste Zeitlimits; Heartbeats, ausbleibende Eingangsdaten, EOF sowie Lese- und Schreibfehler werden überwacht und lösen bei Bedarf einen kontrollierten Neuaufbau mit Backoff aus.
|
- **Sessionbezogene ON4KST-Verbindungssteuerung:** Socket, Reader, Writer, Messagebus und Warteschlangen gehören jetzt zu einer eindeutig identifizierten Verbindungssession. Veraltete Threads einer abgelösten Verbindung können dadurch keine Daten mehr verarbeiten oder die neue Verbindung schließen. `ONLINE` wird erst nach bestätigtem Login und vollständig empfangenen Benutzerlisten gemeldet. Verbindungsaufbau, Login und Synchronisation besitzen feste Zeitlimits; Heartbeats, ausbleibende Eingangsdaten, EOF sowie Lese- und Schreibfehler werden überwacht und lösen bei Bedarf einen kontrollierten Neuaufbau mit Backoff aus.
|
||||||
|
|
||||||
- **ON4KST-Protokollbefehle abgesichert:** Ausgehende Befehle werden zentral aufgebaut und auf gültige Kategorien, Locatoren und unerlaubte Frame-Trennzeichen geprüft. Da ON4KST pro TCP-Session nur einen Locator verwaltet, wird für beide Chat-Kategorien der Hauptlocator verwendet und eine abweichende zweite Konfiguration protokolliert, statt widersprüchliche Befehle an den Server zu senden.
|
- **ON4KST-Protokollbefehle abgesichert:** Ausgehende Befehle werden zentral aufgebaut und auf gültige Kategorien, Locatoren und unerlaubte Frame-Trennzeichen geprüft. Da ON4KST pro TCP-Session nur einen Locator verwaltet, wird für beide Chat-Kategorien der Hauptlocator verwendet und eine abweichende zweite Konfiguration protokolliert, statt widersprüchliche Befehle an den Server zu senden.
|
||||||
|
|
||||||
- **QRG-Erkennung präzisiert:** Vollständige Frequenzangaben werden auch ohne Dezimaltrenner erkannt; die letzten drei Ziffern bilden dabei den kHz-Anteil. Relative Frequenzen bleiben unverändert, und nackte dreistellige Zahlen gelten weiterhin nur bei erkennbarem Frequenzkontext als QRG. Signalrapporte, Bandangaben und andere Zahlen erzeugen dadurch seltener falsche Frequenzen.
|
- **QRG-Erkennung präzisiert:** Vollständige und relative Frequenzangaben werden weiterhin erkannt. Nackte dreistellige Zahlen gelten nur noch bei erkennbarem Frequenzkontext als QRG. Signalrapporte, Bandangaben und andere Zahlen erzeugen dadurch seltener falsche Frequenzen.
|
||||||
|
|
||||||
- **Stationsbezogener Frequenzkontext:** Bei relativen QRGs verwendet KST4Contest zuerst einen höchstens 30 Minuten alten Bandkontext derselben Station. Erst wenn dieser fehlt, wird das global konfigurierte Fallback-Band verwendet.
|
- **Stationsbezogener Frequenzkontext:** Bei relativen QRGs verwendet KST4Contest zuerst einen höchstens 30 Minuten alten Bandkontext derselben Station. Erst wenn dieser fehlt, wird das global konfigurierte Fallback-Band verwendet.
|
||||||
|
|
||||||
@@ -86,10 +148,6 @@ v1.42 führt mehrere bisher getrennte Auswertungen zusammen. Bandinformationen,
|
|||||||
|
|
||||||
- **DXLog-Gesamtlog übernommen:** Der UCXLog-kompatible UDP-Listener verarbeitet neben `contactinfo` auch `contactreplace`. Dadurch kann ein von DXLog.net als vollständiges Log ausgesendeter Datenbestand eingelesen werden.
|
- **DXLog-Gesamtlog übernommen:** Der UCXLog-kompatible UDP-Listener verarbeitet neben `contactinfo` auch `contactreplace`. Dadurch kann ein von DXLog.net als vollständiges Log ausgesendeter Datenbestand eingelesen werden.
|
||||||
|
|
||||||
- **Logger-Bandwerte vereinheitlicht:** Numerische sowie Meter- und Zentimeterangaben aus UCXLog-kompatiblen QSO-Paketen und die Band-IDs von Win-Test werden einmal normalisiert und danach einheitlich für Worked-Markierungen und Worked-Großfelder verwendet. Dadurch setzen insbesondere `2320`, `5760` und `10368` zuverlässig ihre vorhandenen Bandmarkierungen. Bei einem fehlenden oder unbekannten Band bleibt es beim globalen Worked-Status.
|
|
||||||
|
|
||||||
- **Simplelogfile-Verhalten präzisiert:** Die ausgewählte Textdatei wird einmal pro Minute mit einem festen Rufzeichenmuster ausgewertet. Treffer setzen den globalen Worked-Status aller aktiven Varianten des Basisrufzeichens, werden aber nicht in SQLite persistiert. Eine fehlende Datei wird angelegt; Lese- und Erstellungsfehler beenden die periodische Auswertung nicht. Ein Datenbank-Reset verändert die Datei nicht, sodass enthaltene Rufzeichen bei der nächsten Auswertung erneut als gearbeitet markiert werden.
|
|
||||||
|
|
||||||
- **Automatische QRG-Übernahme abgesichert:** `MYQRG` wird nur von einer aktivierten Schnittstelle aktualisiert, die tatsächlich gültige `RadioInfo`- beziehungsweise Win-Test-`STATUS`-Pakete liefert. Eine aktivierte, aber nicht liefernde Quelle ersetzt die notwendige Funktionsprüfung oder manuelle QRG-Pflege nicht.
|
- **Automatische QRG-Übernahme abgesichert:** `MYQRG` wird nur von einer aktivierten Schnittstelle aktualisiert, die tatsächlich gültige `RadioInfo`- beziehungsweise Win-Test-`STATUS`-Pakete liefert. Eine aktivierte, aber nicht liefernde Quelle ersetzt die notwendige Funktionsprüfung oder manuelle QRG-Pflege nicht.
|
||||||
|
|
||||||
- **Versionserkennung verbessert:** Versionsnummern werden semantisch verglichen, damit beispielsweise Patch-Versionen und Nightly-Stände nicht mehr durch eine einfache Fließkommazahl falsch eingeordnet werden.
|
- **Versionserkennung verbessert:** Versionsnummern werden semantisch verglichen, damit beispielsweise Patch-Versionen und Nightly-Stände nicht mehr durch eine einfache Fließkommazahl falsch eingeordnet werden.
|
||||||
@@ -98,8 +156,6 @@ v1.42 führt mehrere bisher getrennte Auswertungen zusammen. Bandinformationen,
|
|||||||
|
|
||||||
- **Zuverlässige Benutzerliste beim Login:** Ungültige oder unvollständige `UA0`-Teilnehmerdatensätze werden einzeln verworfen und protokolliert, ohne die Verarbeitung der alphabetisch folgenden Teilnehmer abzubrechen. Die gültigen Einträge werden zunächst pro Kategorie gesammelt und erst mit dem ersten zugehörigen `UE`-Abschlussframe vollständig veröffentlicht.
|
- **Zuverlässige Benutzerliste beim Login:** Ungültige oder unvollständige `UA0`-Teilnehmerdatensätze werden einzeln verworfen und protokolliert, ohne die Verarbeitung der alphabetisch folgenden Teilnehmer abzubrechen. Die gültigen Einträge werden zunächst pro Kategorie gesammelt und erst mit dem ersten zugehörigen `UE`-Abschlussframe vollständig veröffentlicht.
|
||||||
|
|
||||||
- **Persistierter Worked-Status beim Listenaufbau:** Beim Abschluss jeder initialen ON4KST-Benutzerliste wird der SQLite-Zustand einmal geladen und vor der Veröffentlichung auf die neuen Chatmember angewendet. Das gilt für beide Kategorien, erneute Verbindungen und alle aktiven Varianten eines Basisrufzeichens.
|
|
||||||
|
|
||||||
- **Benutzerliste verschwindet nach dem Login:** ON4KST kann nach Namens-, Status- oder anderen Live-Änderungen weitere `UE`-Frames für dieselbe Kategorie senden. Wiederholte Abschlussframes werden jetzt erkannt und ignoriert, damit eine bereits gefüllte Benutzerliste nicht durch eine leere Momentaufnahme ersetzt wird.
|
- **Benutzerliste verschwindet nach dem Login:** ON4KST kann nach Namens-, Status- oder anderen Live-Änderungen weitere `UE`-Frames für dieselbe Kategorie senden. Wiederholte Abschlussframes werden jetzt erkannt und ignoriert, damit eine bereits gefüllte Benutzerliste nicht durch eine leere Momentaufnahme ersetzt wird.
|
||||||
|
|
||||||
- **Fehlgeschlagener Erstaufbau und Verbindungsverlust:** Wenn beim Programmstart keine Verbindung zum Server hergestellt werden kann, läuft KST4Contest nicht mehr in eine Endlos- oder Busy-Wait-Schleife. Die Oberfläche bleibt bedienbar und weitere Versuche erfolgen mit begrenztem Backoff. Auch ein vom Server geschlossener oder über längere Zeit stummer Socket wird zuverlässig erkannt.
|
- **Fehlgeschlagener Erstaufbau und Verbindungsverlust:** Wenn beim Programmstart keine Verbindung zum Server hergestellt werden kann, läuft KST4Contest nicht mehr in eine Endlos- oder Busy-Wait-Schleife. Die Oberfläche bleibt bedienbar und weitere Versuche erfolgen mit begrenztem Backoff. Auch ein vom Server geschlossener oder über längere Zeit stummer Socket wird zuverlässig erkannt.
|
||||||
|
|||||||
@@ -240,6 +240,24 @@ Prüfe zuerst, welche Frequenzen für die betreffende Station innerhalb der letz
|
|||||||
|
|
||||||
Ist kein aktueller Stationskontext vorhanden, prüfe die Auswahl unter **Fallback band for relative QRG detection**. Das Fallback wird nur benötigt, wenn sich das Band weder aus einer vollständigen Frequenz noch aus dem aktuellen Kontext des Absenders ergibt.
|
Ist kein aktueller Stationskontext vorhanden, prüfe die Auswahl unter **Fallback band for relative QRG detection**. Das Fallback wird nur benötigt, wenn sich das Band weder aus einer vollständigen Frequenz noch aus dem aktuellen Kontext des Absenders ergibt.
|
||||||
|
|
||||||
|
### Das Logprogramm läuft in einer eigenen Sandbox
|
||||||
|
|
||||||
|
Ein Logprogramm, das als Flatpak oder über eine Wine-Umgebung wie Bottles gestartet wird, benutzt die Netzwerkrechte dieser Sandbox. Teilt die Sandbox das Netzwerk des Rechners nicht, ist `127.0.0.1` darin nicht das `127.0.0.1`, auf dem KST4Contest lauscht. Die Verbindung wird dann abgewiesen, obwohl KST4Contest den Port korrekt meldet.
|
||||||
|
|
||||||
|
Bei einem Flatpak-Logprogramm lassen sich die Rechte so prüfen:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
flatpak info --show-permissions <Anwendungs-ID>
|
||||||
|
```
|
||||||
|
|
||||||
|
Im Abschnitt `[Context]` muss `shared=network` stehen. Nachträglich vergeben lässt es sich mit:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
flatpak override --user --share=network <Anwendungs-ID>
|
||||||
|
```
|
||||||
|
|
||||||
|
Das Gleiche gilt, wenn KST4Contest selbst als Flatpak läuft. Dessen veröffentlichtes Manifest enthält `--share=network` bereits, ein lauschender Port ist daher vom Rechner selbst und von anderen Anwendungen darauf erreichbar.
|
||||||
|
|
||||||
### Der Spot wird vom Logger ausgeblendet
|
### Der Spot wird vom Logger ausgeblendet
|
||||||
|
|
||||||
Verwende ein Spotter-Rufzeichen, das nicht mit dem eigenen Contest-Rufzeichen identisch ist. Abhängig vom Logger können eigene Spots gefiltert oder besonders behandelt werden.
|
Verwende ein Spotter-Rufzeichen, das nicht mit dem eigenen Contest-Rufzeichen identisch ist. Abhängig vom Logger können eigene Spots gefiltert oder besonders behandelt werden.
|
||||||
|
|||||||
@@ -102,6 +102,24 @@ Die Band-IDs für 50 und 70 MHz werden ebenso verarbeitet wie die VHF-, UHF- und
|
|||||||
|
|
||||||
Die Daten werden in derselben internen Datenbank abgelegt wie Worked-Informationen aus den übrigen QSO-UDP-Schnittstellen und nach einem Neustart wiederhergestellt.
|
Die Daten werden in derselben internen Datenbank abgelegt wie Worked-Informationen aus den übrigen QSO-UDP-Schnittstellen und nach einem Neustart wiederhergestellt.
|
||||||
|
|
||||||
|
#### Bereits geloggte QSOs nachladen
|
||||||
|
|
||||||
|
Win-Test sendet jedes neue QSO als Broadcast. QSOs, die vor dem Start von KST4Contest geloggt wurden, sind darin nicht enthalten. KST4Contest fordert diese QSOs deshalb selbst an, sobald der Win-Test-Netzwerk-Listener eine Win-Test-Station im Netzwerk erkennt.
|
||||||
|
|
||||||
|
Der Abgleich benötigt keine eigene Einstellung und keinen Bedienschritt:
|
||||||
|
|
||||||
|
- Win-Test meldet mit `IHAVE`, welche QSO-Nummern welches Logs es führt.
|
||||||
|
- KST4Contest fordert die fehlenden Bereiche mit `NEEDQSO` an, höchstens 50 QSOs pro Anfrage.
|
||||||
|
- Win-Test beantwortet die Anfrage mit gewöhnlichen `ADDQSO`-Paketen. Sie werden genauso ausgewertet wie ein live geloggtes QSO.
|
||||||
|
|
||||||
|
Bereits gearbeitete Stationen erscheinen dadurch auch dann als gearbeitet, wenn KST4Contest erst während des Contests gestartet wird. Der Abgleich bleibt anschließend aktiv und holt auch einzelne Pakete nach, die im laufenden Betrieb verloren gegangen sind. Bereits bekannte QSOs werden erkannt und nicht erneut gespeichert.
|
||||||
|
|
||||||
|
Sind mehrere Win-Test-Stationen im Netzwerk aktiv, wird jedes Log abgeglichen. Damit sind die bandbezogenen Worked-Markierungen aller Bandstationen vollständig. Der Stationsnamensfilter wirkt weiterhin nur auf die QRG-Synchronisation und schränkt den Logabgleich nicht ein.
|
||||||
|
|
||||||
|
Meldet eine erkannte Station kein auswertbares `IHAVE`, etwa bei einer älteren Win-Test-Version, fordert KST4Contest die QSOs blockweise ab QSO-Nummer 1 an, bis ein Block unbeantwortet bleibt.
|
||||||
|
|
||||||
|
Voraussetzung ist ein aktiviertes Win-Test-Netzwerk. Ist das Win-Test-Netzwerk oder der Listener in KST4Contest deaktiviert, findet kein Abgleich statt.
|
||||||
|
|
||||||
#### Skeds an Win-Test übergeben
|
#### Skeds an Win-Test übergeben
|
||||||
|
|
||||||
Mit **Create sked** wird zunächst ein interner KST4Contest-Sked angelegt. Ist der Win-Test-Netzwerk-Listener aktiviert, versucht KST4Contest anschließend automatisch, den Sked als `ADDSKED` an das Win-Test-Netzwerk zu übertragen.
|
Mit **Create sked** wird zunächst ein interner KST4Contest-Sked angelegt. Ist der Win-Test-Netzwerk-Listener aktiviert, versucht KST4Contest anschließend automatisch, den Sked als `ADDSKED` an das Win-Test-Netzwerk zu übertragen.
|
||||||
@@ -154,7 +172,11 @@ Im Reiter **TRX sync**:
|
|||||||
- `Use pass frequency from Win-Test STATUS`
|
- `Use pass frequency from Win-Test STATUS`
|
||||||
- `Win-Test station name filter`
|
- `Win-Test station name filter`
|
||||||
|
|
||||||
Das Win-Test-Netzwerk muss in Win-Test aktiviert sein. Bei mehreren Computern muss die Broadcast-Adresse das betreffende lokale Netzwerk erreichen. Der Stationsname sollte die sendende KST4Contest-Instanz innerhalb des Win-Test-Netzwerks eindeutig erkennen lassen.
|
Das Win-Test-Netzwerk muss in Win-Test aktiviert sein. Der Stationsname sollte die sendende KST4Contest-Instanz innerhalb des Win-Test-Netzwerks eindeutig erkennen lassen.
|
||||||
|
|
||||||
|
Die Broadcast-Adresse ermittelt KST4Contest selbst: Aus der Absenderadresse der empfangenen Win-Test-Pakete wird das passende lokale Netzwerk bestimmt und dessen Broadcast-Adresse verwendet. Die eingetragene Adresse dient als Rückfallebene, wenn kein lokales Netzwerk zur Win-Test-Station passt, etwa wenn Win-Test hinter einem Router liegt.
|
||||||
|
|
||||||
|
Das ist wichtig, weil Win-Test ausschließlich auf Broadcasts reagiert und eine Adresse in einem nicht vorhandenen Netzwerk keinen Fehler auslöst: Das Paket wird ohne Meldung weggeroutet. Eine veraltete Eintragung, etwa aus einem anderen Netzwerk, machte dadurch früher sowohl die Sked-Übergabe als auch den Logabgleich wirkungslos.
|
||||||
|
|
||||||
Ausführliche Beschreibung der Einstellungen: [Win-Test-Netzwerk-Listener](de-Konfiguration#win-test-netzwerk-listener-ab-v131)
|
Ausführliche Beschreibung der Einstellungen: [Win-Test-Netzwerk-Listener](de-Konfiguration#win-test-netzwerk-listener-ab-v131)
|
||||||
|
|
||||||
|
|||||||
+68
-12
@@ -8,6 +8,72 @@ Published Stable versions and their application packages are available under [Gi
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## v1.43.1 (2026-09-03)
|
||||||
|
|
||||||
|
**Corrected version metadata**
|
||||||
|
|
||||||
|
v1.43.1 contains the same functional changes as v1.43.0. It corrects the application and build metadata used for display, ON4KST identification and update comparison. Some metadata in the first v1.43.0 package set still identified the build as version 1.42.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **Consistent semantic version:** The user-visible application version now uses the complete `1.43.1` form. The compact value `1.431` remains only in the deprecated numeric field required for compatibility with older update feeds.
|
||||||
|
|
||||||
|
- **Tagged-release update feed:** The website build, version-feed validation and artifact upload now run as actual workflow steps after the GitHub Release has been published. They were previously indented into the release action's artifact list and therefore skipped.
|
||||||
|
|
||||||
|
Users of v1.43.0 should install v1.43.1. The functionality is unchanged; the update only corrects the version metadata and release workflow.
|
||||||
|
|
||||||
|
The corrected version is available as [Release v1.43.1](https://github.com/praktimarc/kst4contest/releases/tag/v1.43.1).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## v1.43.0 (2026-09-03)
|
||||||
|
|
||||||
|
**More reliable log synchronisation, persistent layouts and better DX Cluster compatibility**
|
||||||
|
|
||||||
|
v1.43 concentrates on reliability around external log data and long-running contest operation. It also adds practical control over table layouts and station grouping on the map.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **Optional map clustering:** **Group nearby stations** immediately enables or disables spatial grouping at lower zoom levels. The stored setting changes neither the viewport nor the selected station; aggregation of active variants sharing one base callsign remains independent. This implements [Issue #79](https://github.com/praktimarc/kst4contest/issues/79).
|
||||||
|
|
||||||
|
- **Automatic table-layout persistence:** Tables receive useful widths when their first meaningful contents arrive. Manually changed column widths, window sizes and relevant dividers are written to `preferences.xml` after a short delay. The main and monitor windows keep separate DXCluster and QSO-of-the-other layouts.
|
||||||
|
|
||||||
|
- **Tooltips for truncated table values:** Normal table cells expose their complete text when the visible column is too narrow, without replacing functional tooltips or clickable links.
|
||||||
|
|
||||||
|
- **Simplelogfile creation notice:** When the selected file does not exist, KST4Contest creates it and displays a notice with the file path, a concrete test procedure and a link to the relevant manual section.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- **Robust Simplelogfile evaluation:** The selected file is evaluated once per minute and closed after every pass so that the logging application can replace or rotate it. Detected callsigns apply the global Worked state to every active suffix variant of the base callsign. Disabling the function prevents any file access, while read or creation errors no longer terminate the periodic task.
|
||||||
|
|
||||||
|
- **Consistent external logger bands:** UCXLog-compatible packets and Win-Test events use one shared band normalisation. Numeric values, metre and centimetre designators and the existing Win-Test IDs now set the same Worked flags and worked grid squares. Values including `2320`, `5760` and `10368` are handled reliably; a missing or unknown band sets only the global Worked state.
|
||||||
|
|
||||||
|
- **Compact full-frequency recognition:** Complete frequencies without a decimal separator are accepted across the supported bands, with the final three digits interpreted as the kHz part. Bare three-digit numbers still require recognisable frequency context so that signal reports and unrelated numbers are not treated as QRGs.
|
||||||
|
|
||||||
|
- **DXSpider-compatible spot format:** Local DX Cluster spots use a fixed 75-character payload line with the DX callsign in column 27, a 30-character comment field and UTC time in column 71. The format remains stable up to 24 GHz. Overlong DX callsigns are rejected and logged instead of being silently truncated. This resolves [Issue #86](https://github.com/praktimarc/kst4contest/issues/86).
|
||||||
|
|
||||||
|
- **Active ON4KST connection probe:** A quiet chat server is checked with an explicit session-wide probe before the connection is treated as dead. Heartbeats and probe frames retain the required CR/LF framing.
|
||||||
|
|
||||||
|
- **Reliable private-message age highlighting:** Incoming private messages use the defined green age levels for up to five minutes. Locally sent messages retain their separate style, and empty or reused table rows return to the normal design instead of keeping an obsolete highlight.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **Worked state after login:** Persisted SQLite Worked information is loaded and applied before each initial ON4KST user list is published. Reconnects, both categories and all active variants of a base callsign therefore start with the correct state. This resolves [Issue #85](https://github.com/praktimarc/kst4contest/issues/85).
|
||||||
|
|
||||||
|
- **False disconnect during quiet periods:** A valid ON4KST connection is no longer closed merely because the server currently has no activity lines to send.
|
||||||
|
|
||||||
|
### Documentation and packaging
|
||||||
|
|
||||||
|
- The German and English manuals were revised against the implementation. A new contest-workflow chapter connects the individual functions into a practical operating sequence, while the sections on dual chat, private-message handling, QRG synchronisation, Simplelogfile evaluation and configuration were clarified.
|
||||||
|
|
||||||
|
- The website feature pages now describe band and direction opportunities, the station map, QRG handling, filters, global message views, private-message handling and logger synchronisation in more detail.
|
||||||
|
|
||||||
|
- The AUR package definitions were updated for v1.43.0.
|
||||||
|
|
||||||
|
The complete v1.43.0 functionality is available in [Release v1.43.0](https://github.com/praktimarc/kst4contest/releases/tag/v1.43.0). Because its embedded version metadata is inconsistent, v1.43.1 is the recommended package set.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## v1.42.0 (2026-08-22)
|
## v1.42.0 (2026-08-22)
|
||||||
|
|
||||||
**Shared band context, session-based ON4KST connection and signed macOS packages**
|
**Shared band context, session-based ON4KST connection and signed macOS packages**
|
||||||
@@ -38,21 +104,17 @@ v1.42 brings several previously separate calculations together. Band information
|
|||||||
|
|
||||||
- **Filter reset:** A dedicated reset button reliably removes the active user-list filter predicates.
|
- **Filter reset:** A dedicated reset button reliably removes the active user-list filter predicates.
|
||||||
|
|
||||||
- **Optional map clustering:** **Group nearby stations** immediately enables or disables spatial grouping at lower zoom levels. The automatically stored setting changes neither the viewport nor the selected station; aggregation of active variants sharing one base callsign remains independent. This implements [Issue #79](https://github.com/praktimarc/kst4contest/issues/79).
|
- **Map clustering:** Stations close to each other are grouped at lower zoom levels. The selected station and relevant direction opportunities remain individually visible.
|
||||||
|
|
||||||
- **Hideable path analysis:** The terrain profile and analysis section of the station map can be hidden completely. The selected state is stored and restored at the next application start.
|
- **Hideable path analysis:** The terrain profile and analysis section of the station map can be hidden completely. The selected state is stored and restored at the next application start.
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- **Automatic table-layout persistence:** Tables receive useful widths when their first meaningful contents arrive. Manually changed column widths, window sizes and relevant dividers are written to `preferences.xml` after a short delay; the main and monitor windows keep separate DXCluster and QSO-of-the-other layouts. Truncated normal cell values expose their full text in a tooltip without replacing functional tooltips or clickable links.
|
|
||||||
|
|
||||||
- **Unified DX Cluster line format:** Local spots now use a fixed, DXSpider-compatible 75-character payload line with the DX callsign in column 27, a 30-character comment field and UTC time in column 71. The layout remains stable for microwave frequencies up to 24 GHz. Overlong DX callsigns are rejected and logged instead of being silently truncated; AirScout and test comments are correspondingly more compact.
|
|
||||||
|
|
||||||
- **Session-based ON4KST connection lifecycle:** Each socket, reader, writer, message bus and queue now belongs to an explicitly identified connection session. Delayed threads from an obsolete connection can therefore no longer process data or close its replacement. `ONLINE` is reported only after the login has been accepted and all requested user lists have been received. Connection setup, login and synchronisation use bounded timeouts, while heartbeats, missing inbound traffic, EOF and read or write failures trigger controlled reconnect attempts with backoff where appropriate.
|
- **Session-based ON4KST connection lifecycle:** Each socket, reader, writer, message bus and queue now belongs to an explicitly identified connection session. Delayed threads from an obsolete connection can therefore no longer process data or close its replacement. `ONLINE` is reported only after the login has been accepted and all requested user lists have been received. Connection setup, login and synchronisation use bounded timeouts, while heartbeats, missing inbound traffic, EOF and read or write failures trigger controlled reconnect attempts with backoff where appropriate.
|
||||||
|
|
||||||
- **Validated ON4KST protocol commands:** Outgoing frames are built centrally and checked for valid categories, locators and prohibited frame delimiters. Because ON4KST maintains one locator per TCP session, the main locator is used for both chat categories and a conflicting secondary configuration is logged instead of sending contradictory commands to the server.
|
- **Validated ON4KST protocol commands:** Outgoing frames are built centrally and checked for valid categories, locators and prohibited frame delimiters. Because ON4KST maintains one locator per TCP session, the main locator is used for both chat categories and a conflicting secondary configuration is logged instead of sending contradictory commands to the server.
|
||||||
|
|
||||||
- **More precise QRG recognition:** Complete frequencies are also recognised without a decimal separator, with the final three digits interpreted as the kHz part. Relative frequencies remain unchanged, and bare three-digit numbers still require recognisable frequency context. Signal reports, band designators and unrelated numbers therefore produce fewer false frequencies.
|
- **More precise QRG recognition:** Complete and relative frequency references continue to be recognised. Bare three-digit numbers are treated as QRGs only when a frequency context is available. Signal reports, band designators and unrelated numbers therefore produce fewer false frequencies.
|
||||||
|
|
||||||
- **Station-specific frequency context:** For relative QRGs, KST4Contest first uses a band context for the same station which is no more than 30 minutes old. The globally configured fallback band is used only when this context is unavailable.
|
- **Station-specific frequency context:** For relative QRGs, KST4Contest first uses a band context for the same station which is no more than 30 minutes old. The globally configured fallback band is used only when this context is unavailable.
|
||||||
|
|
||||||
@@ -86,10 +148,6 @@ v1.42 brings several previously separate calculations together. Band information
|
|||||||
|
|
||||||
- **DXLog full-log import:** In addition to `contactinfo`, the UCXLog-compatible UDP listener processes `contactreplace`. This allows a complete log broadcast by DXLog.net to be imported.
|
- **DXLog full-log import:** In addition to `contactinfo`, the UCXLog-compatible UDP listener processes `contactreplace`. This allows a complete log broadcast by DXLog.net to be imported.
|
||||||
|
|
||||||
- **Consistent logger band values:** Numeric, metre and centimetre values from UCXLog-compatible QSO packets and Win-Test band IDs are normalised once and then used consistently for Worked marks and worked grid squares. In particular, `2320`, `5760` and `10368` now reliably set their existing band marks. A missing or unknown band continues to set only the global Worked status.
|
|
||||||
|
|
||||||
- **Defined Simplelogfile behaviour:** The selected text file is evaluated once per minute using a fixed callsign pattern. Matches set the global Worked status for all active variants of the base callsign but are not persisted in SQLite. A missing file is created, and read or creation errors do not terminate the periodic task. A database reset does not change the file, so callsigns contained in it are marked as worked again during the next evaluation.
|
|
||||||
|
|
||||||
- **Guarded automatic QRG updates:** `MYQRG` is updated only by an enabled interface which actually supplies valid `RadioInfo` or Win-Test `STATUS` packets. An enabled source which provides no data does not remove the need for a functional check or manual QRG maintenance.
|
- **Guarded automatic QRG updates:** `MYQRG` is updated only by an enabled interface which actually supplies valid `RadioInfo` or Win-Test `STATUS` packets. An enabled source which provides no data does not remove the need for a functional check or manual QRG maintenance.
|
||||||
|
|
||||||
- **Improved version comparison:** Versions are compared semantically so that patch releases and Nightly versions are not misclassified by conversion to a floating-point number.
|
- **Improved version comparison:** Versions are compared semantically so that patch releases and Nightly versions are not misclassified by conversion to a floating-point number.
|
||||||
@@ -98,8 +156,6 @@ v1.42 brings several previously separate calculations together. Band information
|
|||||||
|
|
||||||
- **Reliable initial user list:** Invalid or incomplete `UA0` member records are rejected and logged individually without preventing alphabetically following members from being processed. Valid entries are staged per category and published as one complete snapshot when the first corresponding `UE` end marker is received.
|
- **Reliable initial user list:** Invalid or incomplete `UA0` member records are rejected and logged individually without preventing alphabetically following members from being processed. Valid entries are staged per category and published as one complete snapshot when the first corresponding `UE` end marker is received.
|
||||||
|
|
||||||
- **Persisted Worked state during initial-list setup:** At the end of each initial ON4KST user list, the SQLite state is loaded once and applied to the new chat members before publication. This covers both categories, reconnects and every active variant of a base callsign.
|
|
||||||
|
|
||||||
- **User list disappearing after login:** ON4KST may send additional `UE` frames for the same category after name, state or other live updates. Repeated end markers are now detected and ignored so that an already populated user list cannot be replaced by an empty snapshot.
|
- **User list disappearing after login:** ON4KST may send additional `UE` frames for the same category after name, state or other live updates. Repeated end markers are now detected and ignored so that an already populated user list cannot be replaced by an empty snapshot.
|
||||||
|
|
||||||
- **Failed initial connection and lost sockets:** An unavailable server during startup no longer sends KST4Contest into an endless or busy-wait loop. The user interface remains responsive and further attempts use bounded reconnect backoff. Sockets closed by the server, or connections without inbound traffic for an excessive period, are also detected reliably.
|
- **Failed initial connection and lost sockets:** An unavailable server during startup no longer sends KST4Contest into an endless or busy-wait loop. The user interface remains responsive and further attempts use bounded reconnect backoff. Sockets closed by the server, or connections without inbound traffic for an excessive period, are also detected reliably.
|
||||||
|
|||||||
@@ -240,6 +240,24 @@ First check which frequencies were detected for the station during the previous
|
|||||||
|
|
||||||
If no current station context exists, check **Fallback band for relative QRG detection**. The fallback is used only when the band cannot be determined from a complete frequency or the sender's current context.
|
If no current station context exists, check **Fallback band for relative QRG detection**. The fallback is used only when the band cannot be determined from a complete frequency or the sender's current context.
|
||||||
|
|
||||||
|
### The Logger Runs in Its Own Sandbox
|
||||||
|
|
||||||
|
A logging programme started as a Flatpak, or through a Wine environment such as Bottles, uses the network permissions of that sandbox. If the sandbox does not share the host network, `127.0.0.1` inside it is not the `127.0.0.1` on which KST4Contest is listening, and the connection is refused even though KST4Contest reports the port correctly.
|
||||||
|
|
||||||
|
For a Flatpak logger, check its permission with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
flatpak info --show-permissions <application id>
|
||||||
|
```
|
||||||
|
|
||||||
|
The `[Context]` section has to contain `shared=network`. It can be granted with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
flatpak override --user --share=network <application id>
|
||||||
|
```
|
||||||
|
|
||||||
|
The same applies when KST4Contest itself runs as a Flatpak. Its published manifest already contains `--share=network`, so a listening port is reachable from the host and from other applications on the same computer.
|
||||||
|
|
||||||
### The Logger Hides the Spot
|
### The Logger Hides the Spot
|
||||||
|
|
||||||
Try a spotter callsign which differs from the contest callsign. Depending on the logger, spots from the local callsign may be filtered or handled specially. KST4Contest itself does not require the two callsigns to differ.
|
Try a spotter callsign which differs from the contest callsign. Depending on the logger, spots from the local callsign may be filtered or handled specially. KST4Contest itself does not require the two callsigns to differ.
|
||||||
|
|||||||
@@ -102,6 +102,24 @@ Band IDs for 50 and 70 MHz are processed in the same way as the VHF, UHF and SHF
|
|||||||
|
|
||||||
The information is written to the same internal database as Worked data received through the other QSO UDP interfaces and is restored after a restart.
|
The information is written to the same internal database as Worked data received through the other QSO UDP interfaces and is restored after a restart.
|
||||||
|
|
||||||
|
#### Recovering QSOs logged earlier
|
||||||
|
|
||||||
|
Win-Test broadcasts every new QSO. QSOs logged before KST4Contest was started are not part of those broadcasts. KST4Contest therefore requests them itself as soon as the Win-Test network listener detects a Win-Test station on the network.
|
||||||
|
|
||||||
|
The recovery needs no dedicated setting and no operating step:
|
||||||
|
|
||||||
|
- Win-Test announces with `IHAVE` which QSO numbers of which log it holds.
|
||||||
|
- KST4Contest requests the missing ranges with `NEEDQSO`, at most 50 QSOs per request.
|
||||||
|
- Win-Test answers with ordinary `ADDQSO` packets. They are processed exactly like a QSO logged live.
|
||||||
|
|
||||||
|
Stations already worked therefore appear as worked even when KST4Contest is started during the contest. The recovery stays active afterwards and also picks up individual packets lost during operation. Known QSOs are recognised and not stored again.
|
||||||
|
|
||||||
|
When several Win-Test stations are active on the network, every log is recovered. The per-band Worked marks of all band stations are then complete. The station name filter still applies to the QRG synchronisation only and does not restrict the log recovery.
|
||||||
|
|
||||||
|
If a detected station sends no usable `IHAVE`, for example an older Win-Test version, KST4Contest requests the QSOs in blocks starting at QSO number 1 until a block remains unanswered.
|
||||||
|
|
||||||
|
The Win-Test network must be enabled. No recovery takes place while the Win-Test network or the listener in KST4Contest is disabled.
|
||||||
|
|
||||||
#### Handing skeds over to Win-Test
|
#### Handing skeds over to Win-Test
|
||||||
|
|
||||||
Pressing **Create sked** first creates an internal KST4Contest sked. If the Win-Test network listener is enabled, KST4Contest then automatically attempts to send the sked to the Win-Test network as an `ADDSKED` packet.
|
Pressing **Create sked** first creates an internal KST4Contest sked. If the Win-Test network listener is enabled, KST4Contest then automatically attempts to send the sked to the Win-Test network as an `ADDSKED` packet.
|
||||||
@@ -154,7 +172,11 @@ In the **TRX sync** tab:
|
|||||||
- `Use pass frequency from Win-Test STATUS`
|
- `Use pass frequency from Win-Test STATUS`
|
||||||
- `Win-Test station name filter`
|
- `Win-Test station name filter`
|
||||||
|
|
||||||
The Win-Test network must be enabled in Win-Test. When several computers are used, the broadcast address must reach the relevant local network. The station name should identify the sending KST4Contest instance unambiguously within the Win-Test network.
|
The Win-Test network must be enabled in Win-Test. The station name should identify the sending KST4Contest instance unambiguously within the Win-Test network.
|
||||||
|
|
||||||
|
KST4Contest determines the broadcast address itself: the source address of the received Win-Test packets identifies the matching local network, and the broadcast address of that network is used. The configured address serves as the fallback when no local network matches the Win-Test station, for example when Win-Test is located behind a router.
|
||||||
|
|
||||||
|
This matters because Win-Test only reacts to broadcasts, and an address in a network that does not exist raises no error: the packet is routed away silently. An outdated entry, for instance from a different network, therefore used to disable both the sked handover and the log recovery.
|
||||||
|
|
||||||
Detailed settings: [Win-Test Network Listener](en-Configuration#win-test-network-listener-from-v131)
|
Detailed settings: [Win-Test Network Listener](en-Configuration#win-test-network-listener-from-v131)
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
pkgbase = kst4contest-bin
|
pkgbase = kst4contest-bin
|
||||||
pkgdesc = ON4KST Chat Client for VHF/UHF contest operation (pre-built)
|
pkgdesc = ON4KST Chat Client for VHF/UHF contest operation (pre-built)
|
||||||
pkgver = 1.42.0
|
pkgver = 1.44.0
|
||||||
pkgrel = 1
|
pkgrel = 1
|
||||||
url = https://github.com/praktimarc/kst4contest
|
url = https://github.com/praktimarc/kst4contest
|
||||||
arch = x86_64
|
arch = x86_64
|
||||||
@@ -10,7 +10,7 @@ pkgbase = kst4contest-bin
|
|||||||
provides = kst4contest
|
provides = kst4contest
|
||||||
conflicts = kst4contest
|
conflicts = kst4contest
|
||||||
conflicts = kst4contest-git
|
conflicts = kst4contest-git
|
||||||
source = KST4Contest-v1.42.0-archlinux-x86_64.pkg.tar.zst::https://github.com/praktimarc/kst4contest/releases/download/v1.42.0/KST4Contest-v1.42.0-archlinux-x86_64.pkg.tar.zst
|
source = KST4Contest-v1.44.0-archlinux-x86_64.pkg.tar.zst::https://github.com/praktimarc/kst4contest/releases/download/v1.44.0/KST4Contest-v1.44.0-archlinux-x86_64.pkg.tar.zst
|
||||||
sha256sums = 3d8ac19c9f9d3ab0bdaf0ea621de0aa18c64f442c8776d28bfad607522aaf02b
|
sha256sums = 62688fabc25be32ebe71588eb90f0334cfb7ddde14ba1be6df9956ff4415ddf0
|
||||||
|
|
||||||
pkgname = kst4contest-bin
|
pkgname = kst4contest-bin
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Maintainer: Philipp Wagner <philipp@wagnersnetz.de>
|
# Maintainer: Philipp Wagner <philipp@wagnersnetz.de>
|
||||||
pkgname=kst4contest-bin
|
pkgname=kst4contest-bin
|
||||||
pkgver=1.42.0
|
pkgver=1.44.0
|
||||||
pkgrel=1
|
pkgrel=1
|
||||||
pkgdesc="ON4KST Chat Client for VHF/UHF contest operation (pre-built)"
|
pkgdesc="ON4KST Chat Client for VHF/UHF contest operation (pre-built)"
|
||||||
arch=('x86_64')
|
arch=('x86_64')
|
||||||
@@ -10,7 +10,7 @@ depends=('gst-plugins-base' 'gst-plugins-good')
|
|||||||
provides=('kst4contest')
|
provides=('kst4contest')
|
||||||
conflicts=('kst4contest' 'kst4contest-git')
|
conflicts=('kst4contest' 'kst4contest-git')
|
||||||
source=("KST4Contest-v${pkgver}-archlinux-${CARCH}.pkg.tar.zst::https://github.com/praktimarc/kst4contest/releases/download/v${pkgver}/KST4Contest-v${pkgver}-archlinux-${CARCH}.pkg.tar.zst")
|
source=("KST4Contest-v${pkgver}-archlinux-${CARCH}.pkg.tar.zst::https://github.com/praktimarc/kst4contest/releases/download/v${pkgver}/KST4Contest-v${pkgver}-archlinux-${CARCH}.pkg.tar.zst")
|
||||||
sha256sums=('3d8ac19c9f9d3ab0bdaf0ea621de0aa18c64f442c8776d28bfad607522aaf02b')
|
sha256sums=('62688fabc25be32ebe71588eb90f0334cfb7ddde14ba1be6df9956ff4415ddf0')
|
||||||
|
|
||||||
package() {
|
package() {
|
||||||
cp -a "${srcdir}/usr" "${pkgdir}/"
|
cp -a "${srcdir}/usr" "${pkgdir}/"
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
pkgbase = kst4contest-git
|
pkgbase = kst4contest-git
|
||||||
pkgdesc = ON4KST Chat Client for VHF/UHF contest operation (git)
|
pkgdesc = ON4KST Chat Client for VHF/UHF contest operation (git)
|
||||||
pkgver = 1.42.0.r256.g8aadbb9
|
pkgver = 1.44.0.r299.g08d65a0e
|
||||||
pkgrel = 1
|
pkgrel = 1
|
||||||
url = https://github.com/praktimarc/kst4contest
|
url = https://github.com/praktimarc/kst4contest
|
||||||
arch = x86_64
|
arch = x86_64
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Maintainer: Philipp Wagner <philipp@wagnersnetz.de>
|
# Maintainer: Philipp Wagner <philipp@wagnersnetz.de>
|
||||||
pkgname=kst4contest-git
|
pkgname=kst4contest-git
|
||||||
pkgver=1.42.0.r256.g8aadbb9
|
pkgver=1.44.0.r299.g08d65a0e
|
||||||
pkgrel=1
|
pkgrel=1
|
||||||
pkgdesc="ON4KST Chat Client for VHF/UHF contest operation (git)"
|
pkgdesc="ON4KST Chat Client for VHF/UHF contest operation (git)"
|
||||||
arch=('x86_64')
|
arch=('x86_64')
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
pkgbase = kst4contest
|
pkgbase = kst4contest
|
||||||
pkgdesc = ON4KST Chat Client for VHF/UHF contest operation
|
pkgdesc = ON4KST Chat Client for VHF/UHF contest operation
|
||||||
pkgver = 1.42.0
|
pkgver = 1.44.0
|
||||||
pkgrel = 1
|
pkgrel = 1
|
||||||
url = https://github.com/praktimarc/kst4contest
|
url = https://github.com/praktimarc/kst4contest
|
||||||
arch = x86_64
|
arch = x86_64
|
||||||
@@ -12,7 +12,7 @@ pkgbase = kst4contest
|
|||||||
provides = kst4contest
|
provides = kst4contest
|
||||||
conflicts = kst4contest-bin
|
conflicts = kst4contest-bin
|
||||||
conflicts = kst4contest-git
|
conflicts = kst4contest-git
|
||||||
source = kst4contest-1.42.0.tar.gz::https://github.com/praktimarc/kst4contest/archive/refs/tags/v1.42.0.tar.gz
|
source = kst4contest-1.44.0.tar.gz::https://github.com/praktimarc/kst4contest/archive/refs/tags/v1.44.0.tar.gz
|
||||||
sha256sums = bd396387b8de41aac706458d5ebf64140ab3e83b8a7c710b66aa802bd48e804e
|
sha256sums = e702df24a29e6f914a43934df0095bc4adbd00a9f02df3a632816c832272e914
|
||||||
|
|
||||||
pkgname = kst4contest
|
pkgname = kst4contest
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Maintainer: Philipp Wagner <philipp@wagnersnetz.de>
|
# Maintainer: Philipp Wagner <philipp@wagnersnetz.de>
|
||||||
pkgname=kst4contest
|
pkgname=kst4contest
|
||||||
pkgver=1.42.0
|
pkgver=1.44.0
|
||||||
pkgrel=1
|
pkgrel=1
|
||||||
pkgdesc="ON4KST Chat Client for VHF/UHF contest operation"
|
pkgdesc="ON4KST Chat Client for VHF/UHF contest operation"
|
||||||
arch=('x86_64')
|
arch=('x86_64')
|
||||||
@@ -11,7 +11,7 @@ makedepends=('java-environment=21' 'maven')
|
|||||||
provides=('kst4contest')
|
provides=('kst4contest')
|
||||||
conflicts=('kst4contest-bin' 'kst4contest-git')
|
conflicts=('kst4contest-bin' 'kst4contest-git')
|
||||||
source=("${pkgname}-${pkgver}.tar.gz::https://github.com/praktimarc/kst4contest/archive/refs/tags/v${pkgver}.tar.gz")
|
source=("${pkgname}-${pkgver}.tar.gz::https://github.com/praktimarc/kst4contest/archive/refs/tags/v${pkgver}.tar.gz")
|
||||||
sha256sums=('bd396387b8de41aac706458d5ebf64140ab3e83b8a7c710b66aa802bd48e804e')
|
sha256sums=('e702df24a29e6f914a43934df0095bc4adbd00a9f02df3a632816c832272e914')
|
||||||
|
|
||||||
build() {
|
build() {
|
||||||
cd "${srcdir}/kst4contest-${pkgver}"
|
cd "${srcdir}/kst4contest-${pkgver}"
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
<groupId>de.x08</groupId>
|
<groupId>de.x08</groupId>
|
||||||
<artifactId>praktiKST</artifactId>
|
<artifactId>praktiKST</artifactId>
|
||||||
<version>1.42.0-nightly</version>
|
<version>1.44.0-nightly</version>
|
||||||
|
|
||||||
<name>praktiKST</name>
|
<name>praktiKST</name>
|
||||||
|
|
||||||
|
|||||||
@@ -20,14 +20,14 @@ public class ApplicationConstants {
|
|||||||
/**
|
/**
|
||||||
* Version shown to the user and used for semantic version comparison.
|
* Version shown to the user and used for semantic version comparison.
|
||||||
*/
|
*/
|
||||||
public static final String APPLICATION_CURRENT_VERSION = "1.42";
|
public static final String APPLICATION_CURRENT_VERSION = "1.44.0";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Legacy numeric representation used only while older update feeds and
|
* Legacy numeric representation used only while older update feeds and
|
||||||
* application versions still exist.
|
* application versions still exist.
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
public static final double APPLICATION_CURRENTVERSIONNUMBER = 1.42;
|
public static final double APPLICATION_CURRENTVERSIONNUMBER = 1.44;
|
||||||
|
|
||||||
public static final String VERSIONINFOURLFORUPDATES_KST4CONTEST = "https://kst4contest.hamradioonline.de/kst4ContestVersionInfo.xml";
|
public static final String VERSIONINFOURLFORUPDATES_KST4CONTEST = "https://kst4contest.hamradioonline.de/kst4ContestVersionInfo.xml";
|
||||||
public static final String VERSIONINFDOWNLOADEDLOCALFILE = "kst4ContestVersionInfo.xml";
|
public static final String VERSIONINFDOWNLOADEDLOCALFILE = "kst4ContestVersionInfo.xml";
|
||||||
|
|||||||
@@ -1204,7 +1204,8 @@ public class ChatController implements ThreadStatusCallback, PstRotatorEventList
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
InetAddress broadcastAddress = InetAddress.getByName(
|
InetAddress broadcastAddress =
|
||||||
|
winTestAddressResolver.resolveBroadcastAddress(
|
||||||
chatPreferences
|
chatPreferences
|
||||||
.getLogsynch_wintestNetworkBroadcastAddress()
|
.getLogsynch_wintestNetworkBroadcastAddress()
|
||||||
);
|
);
|
||||||
@@ -1642,11 +1643,26 @@ public class ChatController implements ThreadStatusCallback, PstRotatorEventList
|
|||||||
// private String hostname = "109.90.0.130";
|
// private String hostname = "109.90.0.130";
|
||||||
private String hostname;
|
private String hostname;
|
||||||
// private String praktiKSTVersion = "praktiKST 1.0";
|
// private String praktiKSTVersion = "praktiKST 1.0";
|
||||||
private String praktiKSTVersionInfo = "2022-10 - 2022-12\ndeveloped by DO5AMF, Marc\nContact: praktimarc@gmail.com\nDonations via paypal are welcome";
|
private String praktiKSTVersionInfo = "2022-10 - 2022-12\ndeveloped by DO5AMF, Marc and DN9APW, Philipp Wagner\nContact: praktimarc@gmail.com\nDonations via paypal are welcome";
|
||||||
|
|
||||||
private int port = 23001; // kst4contest.test 4 23001 //TODO: auslagern in Chatprefs
|
private int port = 23001; // kst4contest.test 4 23001 //TODO: auslagern in Chatprefs
|
||||||
private ReadUDPbyUCXMessageThread readUDPbyUCXThread;
|
private ReadUDPbyUCXMessageThread readUDPbyUCXThread;
|
||||||
private ReadUDPByWintestThread readUDPByWintestThread;
|
private ReadUDPByWintestThread readUDPByWintestThread;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shared resolver for the Win-Test broadcast address. Win-Test only reacts
|
||||||
|
* to broadcasts, so both the log synchronization and the SKED handover have
|
||||||
|
* to reach the network the station was actually heard on.
|
||||||
|
*/
|
||||||
|
private final WinTestNetworkAddressResolver winTestAddressResolver =
|
||||||
|
new WinTestNetworkAddressResolver();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return resolver for outgoing Win-Test packets
|
||||||
|
*/
|
||||||
|
public WinTestNetworkAddressResolver getWinTestAddressResolver() {
|
||||||
|
return winTestAddressResolver;
|
||||||
|
}
|
||||||
private WriteThread writeThread;
|
private WriteThread writeThread;
|
||||||
private ReadThread readThread;
|
private ReadThread readThread;
|
||||||
private InputReaderThread consoleReader;
|
private InputReaderThread consoleReader;
|
||||||
|
|||||||
@@ -877,10 +877,9 @@ public class MessageBusManagementThread extends Thread {
|
|||||||
|| messageToProcess.getMessageText().isEmpty()) {
|
|| messageToProcess.getMessageText().isEmpty()) {
|
||||||
// No processable data.
|
// No processable data.
|
||||||
} else {
|
} else {
|
||||||
if (On4KstProtocol.isConnectionProbeResponse(
|
if (On4KstProtocol.isInternalDxqResponse(
|
||||||
messageToProcess.getMessageText())) {
|
messageToProcess.getMessageText())) {
|
||||||
// DXQ is the internal response to the active connection probe.
|
// Preserve the established internal handling of DXQ server data.
|
||||||
// Liveness was already recorded by the session manager.
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2183,7 +2182,7 @@ public class MessageBusManagementThread extends Thread {
|
|||||||
// e.printStackTrace();
|
// e.printStackTrace();
|
||||||
// }
|
// }
|
||||||
|
|
||||||
if (!On4KstProtocol.isConnectionProbeResponse(
|
if (!On4KstProtocol.isInternalDxqResponse(
|
||||||
messageTextRaw.getMessageText())) {
|
messageTextRaw.getMessageText())) {
|
||||||
System.out.println(messageTextRaw.getMessageText() + " <- RXed"); // Stdout at
|
System.out.println(messageTextRaw.getMessageText() + " <- RXed"); // Stdout at
|
||||||
// Console#######################################################TODO:Wichtig
|
// Console#######################################################TODO:Wichtig
|
||||||
|
|||||||
@@ -47,9 +47,7 @@ final class On4KstConnectionManager {
|
|||||||
static final int CONNECT_TIMEOUT_MILLIS = 10_000; //TCP-Connect-Timeout
|
static final int CONNECT_TIMEOUT_MILLIS = 10_000; //TCP-Connect-Timeout
|
||||||
static final long LOGIN_FALLBACK_MILLIS = 2_000L; //Login-Fallback
|
static final long LOGIN_FALLBACK_MILLIS = 2_000L; //Login-Fallback
|
||||||
static final long HANDSHAKE_TIMEOUT_MILLIS = 45_000L; //Handshake-Timeout
|
static final long HANDSHAKE_TIMEOUT_MILLIS = 45_000L; //Handshake-Timeout
|
||||||
static final long APPLICATION_HEARTBEAT_AFTER_MILLIS = 90_000L; //Application-Heartbeat
|
static final long CLIENT_LIVENESS_PROBE_AFTER_MILLIS = 90_000L;
|
||||||
/** Idle duration after which the server is asked for current DX data. */
|
|
||||||
static final long CONNECTION_PROBE_AFTER_MILLIS = 180_000L; //Active connection probe
|
|
||||||
static final long INBOUND_STALE_AFTER_MILLIS = 210_000L; //Stale-Timeout - time without rxed data
|
static final long INBOUND_STALE_AFTER_MILLIS = 210_000L; //Stale-Timeout - time without rxed data
|
||||||
static final List<Long> RECONNECT_DELAYS_MILLIS =
|
static final List<Long> RECONNECT_DELAYS_MILLIS =
|
||||||
List.of(2_000L, 5_000L, 10_000L, 20_000L, 30_000L); //Reconnect-Backoff if no connection possible
|
List.of(2_000L, 5_000L, 10_000L, 20_000L, 30_000L); //Reconnect-Backoff if no connection possible
|
||||||
@@ -181,10 +179,10 @@ final class On4KstConnectionManager {
|
|||||||
session.lastProgressMillis.set(now);
|
session.lastProgressMillis.set(now);
|
||||||
|
|
||||||
String opcode = On4KstProtocol.opcode(line);
|
String opcode = On4KstProtocol.opcode(line);
|
||||||
long probeResponseMillis = session.connectionProbe.acknowledge(now);
|
long probeResponseMillis = session.clientLivenessProbe.acknowledge(now);
|
||||||
if (probeResponseMillis >= 0L) {
|
if (probeResponseMillis >= 0L) {
|
||||||
LOGGER.log(Level.INFO,
|
LOGGER.log(Level.INFO,
|
||||||
"ON4KST connection probe confirmed: session {0}, "
|
"ON4KST client liveness probe confirmed: session {0}, "
|
||||||
+ "received opcode {1}, response time {2} ms",
|
+ "received opcode {1}, response time {2} ms",
|
||||||
new Object[] {
|
new Object[] {
|
||||||
sessionId,
|
sessionId,
|
||||||
@@ -193,8 +191,8 @@ final class On4KstConnectionManager {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
if ("CK".equals(opcode)) {
|
if (On4KstProtocol.isServerLivenessProbe(line)) {
|
||||||
sendHeartbeat(session);
|
sendServerLivenessProbeResponse(session);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!session.loginSent
|
if (!session.loginSent
|
||||||
@@ -265,8 +263,7 @@ final class On4KstConnectionManager {
|
|||||||
token,
|
token,
|
||||||
socket,
|
socket,
|
||||||
receiveQueue,
|
receiveQueue,
|
||||||
transmitQueue,
|
transmitQueue);
|
||||||
mainCategory);
|
|
||||||
|
|
||||||
ReadThread readThread = new ReadThread(
|
ReadThread readThread = new ReadThread(
|
||||||
token, socket, receiveQueue, this::isActiveSession,
|
token, socket, receiveQueue, this::isActiveSession,
|
||||||
@@ -541,42 +538,35 @@ final class On4KstConnectionManager {
|
|||||||
session.transmitQueue.offer(message);
|
session.transmitQueue.offer(message);
|
||||||
}
|
}
|
||||||
|
|
||||||
private void sendHeartbeat(Session session) {
|
private void sendServerLivenessProbeResponse(Session session) {
|
||||||
if (session == null || !isActiveSession(session.id)) {
|
if (session == null || !isActiveSession(session.id)) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
long now = System.currentTimeMillis();
|
|
||||||
session.lastHeartbeatMillis.set(now);
|
|
||||||
LOGGER.log(Level.FINE,
|
LOGGER.log(Level.FINE,
|
||||||
"Sending application heartbeat for ON4KST session {0}",
|
"Responding to ON4KST server liveness probe: session {0}, "
|
||||||
|
+ "opcode CK",
|
||||||
session.id);
|
session.id);
|
||||||
ChatMessage heartbeat = new ChatMessage();
|
sendControl(session, On4KstProtocol.serverLivenessProbeResponse());
|
||||||
heartbeat.setMessageDirectedToServer(true);
|
|
||||||
heartbeat.setMessageText("");
|
|
||||||
session.transmitQueue.offer(heartbeat);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private void sendConnectionProbe(
|
private void sendClientLivenessProbe(
|
||||||
Session session,
|
Session session,
|
||||||
long now,
|
long now,
|
||||||
long inboundIdle
|
long inboundIdle
|
||||||
) {
|
) {
|
||||||
if (session == null || !isActiveSession(session.id)
|
if (session == null || !isActiveSession(session.id)
|
||||||
|| !session.connectionProbe.tryStart(now)) {
|
|| !session.clientLivenessProbe.tryStart(now)) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
LOGGER.log(Level.INFO,
|
LOGGER.log(Level.INFO,
|
||||||
"Sending ON4KST connection probe: session {0}, main category "
|
"Sending ON4KST client liveness probe: session {0}, "
|
||||||
+ "{1}, inbound idle {2} seconds",
|
+ "opcode CK, inbound idle {1} seconds",
|
||||||
new Object[] {
|
new Object[] {
|
||||||
session.id,
|
session.id,
|
||||||
session.mainCategory,
|
|
||||||
inboundIdle / 1_000L
|
inboundIdle / 1_000L
|
||||||
});
|
});
|
||||||
sendControl(
|
sendControl(session, On4KstProtocol.clientLivenessProbe());
|
||||||
session,
|
|
||||||
On4KstProtocol.connectionProbe(session.mainCategory));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private void onConnectionFailure(long sessionId, Throwable failure) {
|
private void onConnectionFailure(long sessionId, Throwable failure) {
|
||||||
@@ -682,8 +672,8 @@ final class On4KstConnectionManager {
|
|||||||
long inboundIdle = now - lastInboundMillis;
|
long inboundIdle = now - lastInboundMillis;
|
||||||
IdleAction idleAction = determineIdleAction(
|
IdleAction idleAction = determineIdleAction(
|
||||||
inboundIdle,
|
inboundIdle,
|
||||||
session.lastHeartbeatMillis.get() >= lastInboundMillis,
|
session.online,
|
||||||
session.connectionProbe.isOutstanding());
|
session.clientLivenessProbe.isOutstanding());
|
||||||
|
|
||||||
if (session.lastInboundMillis.get() != lastInboundMillis) {
|
if (session.lastInboundMillis.get() != lastInboundMillis) {
|
||||||
return;
|
return;
|
||||||
@@ -695,16 +685,15 @@ final class On4KstConnectionManager {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
long probeWaitMillis =
|
long probeWaitMillis =
|
||||||
session.connectionProbe.responseWaitMillis(now);
|
session.clientLivenessProbe.responseWaitMillis(now);
|
||||||
if (probeWaitMillis >= 0L) {
|
if (probeWaitMillis >= 0L) {
|
||||||
LOGGER.log(Level.WARNING,
|
LOGGER.log(Level.WARNING,
|
||||||
"ON4KST connection probe timed out: session "
|
"ON4KST client liveness probe timed out: "
|
||||||
+ "{0}, main category {1}, no response "
|
+ "session {0}, opcode CK, no response "
|
||||||
+ "for {2} ms, inbound idle {3} seconds; "
|
+ "for {1} ms, inbound idle {2} seconds; "
|
||||||
+ "reconnecting",
|
+ "reconnecting",
|
||||||
new Object[] {
|
new Object[] {
|
||||||
session.id,
|
session.id,
|
||||||
session.mainCategory,
|
|
||||||
probeWaitMillis,
|
probeWaitMillis,
|
||||||
inboundIdle / 1_000L
|
inboundIdle / 1_000L
|
||||||
});
|
});
|
||||||
@@ -713,9 +702,8 @@ final class On4KstConnectionManager {
|
|||||||
new SocketException("No ON4KST data received for "
|
new SocketException("No ON4KST data received for "
|
||||||
+ inboundIdle / 1_000L + " seconds"));
|
+ inboundIdle / 1_000L + " seconds"));
|
||||||
}
|
}
|
||||||
case CONNECTION_PROBE ->
|
case CLIENT_LIVENESS_PROBE ->
|
||||||
sendConnectionProbe(session, now, inboundIdle);
|
sendClientLivenessProbe(session, now, inboundIdle);
|
||||||
case HEARTBEAT -> sendHeartbeat(session);
|
|
||||||
case NONE -> {
|
case NONE -> {
|
||||||
// The session is active or already has the required idle action.
|
// The session is active or already has the required idle action.
|
||||||
}
|
}
|
||||||
@@ -731,19 +719,18 @@ final class On4KstConnectionManager {
|
|||||||
*/
|
*/
|
||||||
static IdleAction determineIdleAction(
|
static IdleAction determineIdleAction(
|
||||||
long inboundIdleMillis,
|
long inboundIdleMillis,
|
||||||
boolean heartbeatSentForIdlePhase,
|
boolean online,
|
||||||
boolean probeOutstanding
|
boolean probeOutstanding
|
||||||
) {
|
) {
|
||||||
|
if (!online) {
|
||||||
|
return IdleAction.NONE;
|
||||||
|
}
|
||||||
if (inboundIdleMillis > INBOUND_STALE_AFTER_MILLIS) {
|
if (inboundIdleMillis > INBOUND_STALE_AFTER_MILLIS) {
|
||||||
return IdleAction.TIMEOUT;
|
return IdleAction.TIMEOUT;
|
||||||
}
|
}
|
||||||
if (inboundIdleMillis >= CONNECTION_PROBE_AFTER_MILLIS
|
if (inboundIdleMillis > CLIENT_LIVENESS_PROBE_AFTER_MILLIS
|
||||||
&& !probeOutstanding) {
|
&& !probeOutstanding) {
|
||||||
return IdleAction.CONNECTION_PROBE;
|
return IdleAction.CLIENT_LIVENESS_PROBE;
|
||||||
}
|
|
||||||
if (inboundIdleMillis > APPLICATION_HEARTBEAT_AFTER_MILLIS
|
|
||||||
&& !heartbeatSentForIdlePhase) {
|
|
||||||
return IdleAction.HEARTBEAT;
|
|
||||||
}
|
}
|
||||||
return IdleAction.NONE;
|
return IdleAction.NONE;
|
||||||
}
|
}
|
||||||
@@ -894,15 +881,13 @@ final class On4KstConnectionManager {
|
|||||||
private final Socket socket;
|
private final Socket socket;
|
||||||
private final LinkedBlockingQueue<ChatMessage> receiveQueue;
|
private final LinkedBlockingQueue<ChatMessage> receiveQueue;
|
||||||
private final LinkedBlockingQueue<ChatMessage> transmitQueue;
|
private final LinkedBlockingQueue<ChatMessage> transmitQueue;
|
||||||
private final int mainCategory;
|
|
||||||
private final long connectedMillis = System.currentTimeMillis();
|
private final long connectedMillis = System.currentTimeMillis();
|
||||||
private final AtomicLong lastInboundMillis =
|
private final AtomicLong lastInboundMillis =
|
||||||
new AtomicLong(connectedMillis);
|
new AtomicLong(connectedMillis);
|
||||||
private final AtomicLong lastProgressMillis =
|
private final AtomicLong lastProgressMillis =
|
||||||
new AtomicLong(connectedMillis);
|
new AtomicLong(connectedMillis);
|
||||||
private final AtomicLong lastHeartbeatMillis = new AtomicLong();
|
private final ClientLivenessProbeState clientLivenessProbe =
|
||||||
private final ConnectionProbeState connectionProbe =
|
new ClientLivenessProbeState();
|
||||||
new ConnectionProbeState();
|
|
||||||
private final Map<Integer, Map<String, ChatMember>> initialMembers =
|
private final Map<Integer, Map<String, ChatMember>> initialMembers =
|
||||||
new ConcurrentHashMap<>();
|
new ConcurrentHashMap<>();
|
||||||
|
|
||||||
@@ -920,27 +905,24 @@ final class On4KstConnectionManager {
|
|||||||
long id,
|
long id,
|
||||||
Socket socket,
|
Socket socket,
|
||||||
LinkedBlockingQueue<ChatMessage> receiveQueue,
|
LinkedBlockingQueue<ChatMessage> receiveQueue,
|
||||||
LinkedBlockingQueue<ChatMessage> transmitQueue,
|
LinkedBlockingQueue<ChatMessage> transmitQueue
|
||||||
int mainCategory
|
|
||||||
) {
|
) {
|
||||||
this.id = id;
|
this.id = id;
|
||||||
this.socket = socket;
|
this.socket = socket;
|
||||||
this.receiveQueue = receiveQueue;
|
this.receiveQueue = receiveQueue;
|
||||||
this.transmitQueue = transmitQueue;
|
this.transmitQueue = transmitQueue;
|
||||||
this.mainCategory = mainCategory;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Maintenance action selected by the session monitor. */
|
/** Maintenance action selected by the session monitor. */
|
||||||
enum IdleAction {
|
enum IdleAction {
|
||||||
NONE,
|
NONE,
|
||||||
HEARTBEAT,
|
CLIENT_LIVENESS_PROBE,
|
||||||
CONNECTION_PROBE,
|
|
||||||
TIMEOUT
|
TIMEOUT
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Tracks one outstanding liveness probe for the complete TCP session. */
|
/** Tracks one client-initiated liveness probe for the complete TCP session. */
|
||||||
static final class ConnectionProbeState {
|
static final class ClientLivenessProbeState {
|
||||||
private final AtomicLong sentMillis = new AtomicLong();
|
private final AtomicLong sentMillis = new AtomicLong();
|
||||||
|
|
||||||
boolean tryStart(long now) {
|
boolean tryStart(long now) {
|
||||||
|
|||||||
@@ -54,13 +54,32 @@ final class On4KstProtocol {
|
|||||||
+ "|0|";
|
+ "|0|";
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Builds the active liveness probe for the session's main chat. */
|
/** Builds the session-wide liveness probe initiated by this client. */
|
||||||
static String connectionProbe(int category) {
|
static String clientLivenessProbe() {
|
||||||
return "RDXQ|" + category(category) + "|";
|
return "CK|";
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Returns whether a server frame is the expected liveness-probe response. */
|
/** Returns whether a server frame acknowledges a client-initiated probe. */
|
||||||
static boolean isConnectionProbeResponse(String frame) {
|
static boolean isClientLivenessProbeResponse(String frame) {
|
||||||
|
if (frame == null) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
String normalized = frame.trim().toUpperCase(Locale.ROOT);
|
||||||
|
return "OK".equals(normalized) || "OK|".equals(normalized);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Returns whether ON4KST initiated its own liveness check. */
|
||||||
|
static boolean isServerLivenessProbe(String frame) {
|
||||||
|
return "CK".equals(opcode(frame));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Builds the established empty response to a server-initiated {@code CK}. */
|
||||||
|
static String serverLivenessProbeResponse() {
|
||||||
|
return "";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Preserves the existing internal handling of DXQ server data. */
|
||||||
|
static boolean isInternalDxqResponse(String frame) {
|
||||||
return "DXQ".equals(opcode(frame));
|
return "DXQ".equals(opcode(frame));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -86,11 +86,20 @@ public class ReadThread extends Thread {
|
|||||||
throw new EOFException("ON4KST closed the TCP connection");
|
throw new EOFException("ON4KST closed the TCP connection");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (!sessionIsActive.test(sessionId)) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
inboundActivity.accept(response);
|
inboundActivity.accept(response);
|
||||||
if (!sessionIsActive.test(sessionId)) {
|
if (!sessionIsActive.test(sessionId)) {
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (On4KstProtocol.isClientLivenessProbeResponse(response)) {
|
||||||
|
// OK and OK| acknowledge the client-side CK| probe.
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
ChatMessage message = new ChatMessage();
|
ChatMessage message = new ChatMessage();
|
||||||
message.setMessageText(response);
|
message.setMessageText(response);
|
||||||
receiveQueue.put(message);
|
receiveQueue.put(message);
|
||||||
|
|||||||
@@ -13,8 +13,9 @@ import java.net.*;
|
|||||||
import java.nio.charset.StandardCharsets;
|
import java.nio.charset.StandardCharsets;
|
||||||
import java.util.ArrayList;
|
import java.util.ArrayList;
|
||||||
import java.util.Arrays;
|
import java.util.Arrays;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.List;
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
import java.util.concurrent.ConcurrentHashMap;
|
|
||||||
import java.util.regex.Matcher;
|
import java.util.regex.Matcher;
|
||||||
import java.util.regex.Pattern;
|
import java.util.regex.Pattern;
|
||||||
|
|
||||||
@@ -31,18 +32,40 @@ public class ReadUDPByWintestThread extends Thread {
|
|||||||
|
|
||||||
private static final int BUFFER_SIZE = 4096;
|
private static final int BUFFER_SIZE = 4096;
|
||||||
|
|
||||||
private final Map<Integer, String> receivedQsos = new ConcurrentHashMap<>();
|
|
||||||
private long lastPacketTime = 0;
|
private long lastPacketTime = 0;
|
||||||
|
|
||||||
private String myStation = "DO5AMF";
|
private String myStation = "DO5AMF";
|
||||||
|
|
||||||
private String targetStation = "";
|
private String targetStation = "";
|
||||||
private String stationID = "";
|
private String stationID = "";
|
||||||
private int lastKnownQso = 0;
|
|
||||||
|
|
||||||
private ThreadStatusCallback callBackToController;
|
private ThreadStatusCallback callBackToController;
|
||||||
private String ThreadNickName = "Wintest-msg";
|
private String ThreadNickName = "Wintest-msg";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of fields of a complete ADDQSO packet, including message type,
|
||||||
|
* source and destination.
|
||||||
|
*/
|
||||||
|
private static final int ADDQSO_FIELD_COUNT = 24;
|
||||||
|
|
||||||
|
/** Field position of the Win-Test QSO number inside an ADDQSO packet. */
|
||||||
|
private static final int ADDQSO_QSO_NUMBER_INDEX = 11;
|
||||||
|
|
||||||
|
/** Field position of the logging station name inside an ADDQSO packet. */
|
||||||
|
private static final int ADDQSO_STATION_NAME_INDEX = 3;
|
||||||
|
|
||||||
|
private final WinTestLogSyncService logSyncService;
|
||||||
|
|
||||||
|
private WinTestLogSyncService.SyncState lastReportedSyncState;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Last IHAVE payload seen per station. Win-Test repeats the inventory
|
||||||
|
* periodically, so tracing only the changes keeps the output readable.
|
||||||
|
*/
|
||||||
|
private final Map<String, String> lastTracedIhaveByStation = new HashMap<>();
|
||||||
|
|
||||||
|
private final WinTestNetworkAddressResolver addressResolver;
|
||||||
|
|
||||||
|
|
||||||
public ReadUDPByWintestThread(ChatController client, ThreadStatusCallback callback) {
|
public ReadUDPByWintestThread(ChatController client, ThreadStatusCallback callback) {
|
||||||
|
|
||||||
@@ -51,6 +74,21 @@ public class ReadUDPByWintestThread extends Thread {
|
|||||||
this.myStation = client.getChatPreferences().getStn_loginCallSignRaw(); //callsign of the logging stn
|
this.myStation = client.getChatPreferences().getStn_loginCallSignRaw(); //callsign of the logging stn
|
||||||
this.PORT = client.getChatPreferences().getLogsynch_wintestNetworkPort();
|
this.PORT = client.getChatPreferences().getLogsynch_wintestNetworkPort();
|
||||||
|
|
||||||
|
WinTestNetworkAddressResolver sharedAddressResolver =
|
||||||
|
client.getWinTestAddressResolver();
|
||||||
|
this.addressResolver = sharedAddressResolver != null
|
||||||
|
? sharedAddressResolver
|
||||||
|
: new WinTestNetworkAddressResolver();
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Preferences are read late on purpose: station name, port and broadcast
|
||||||
|
* address can be changed while the listener is running.
|
||||||
|
*/
|
||||||
|
this.logSyncService = new WinTestLogSyncService(
|
||||||
|
this::sendNeedQso,
|
||||||
|
this::resolveOwnWinTestStationName
|
||||||
|
);
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
@@ -85,35 +123,113 @@ public class ReadUDPByWintestThread extends Thread {
|
|||||||
|
|
||||||
while (running) {
|
while (running) {
|
||||||
try {
|
try {
|
||||||
|
/*
|
||||||
|
* DatagramPacket keeps the length of the previous datagram, so
|
||||||
|
* without resetting it a long packet would be truncated after a
|
||||||
|
* short one. A truncated packet loses its trailing fields and
|
||||||
|
* its checksum.
|
||||||
|
*/
|
||||||
|
packet.setLength(buffer.length);
|
||||||
socket.receive(packet);
|
socket.receive(packet);
|
||||||
String msg = new String(packet.getData(), 0, packet.getLength(), StandardCharsets.US_ASCII).trim();
|
processWinTestDatagram(
|
||||||
processWinTestMessage(msg);
|
packet.getData(), packet.getLength(), packet.getAddress());
|
||||||
} catch (SocketTimeoutException e) {
|
} catch (SocketTimeoutException e) {
|
||||||
// checkForMissingQsos();
|
logSyncService.tick();
|
||||||
|
reportSyncStateIfChanged();
|
||||||
} catch (IOException e) {
|
} catch (IOException e) {
|
||||||
//TODO: here is something to catch
|
//TODO: here is something to catch
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolves the Win-Test framing of a received datagram and processes it.
|
||||||
|
*
|
||||||
|
* <p>The checksum byte and the NUL terminator are removed on the raw bytes
|
||||||
|
* before any text parsing, so the trailing fields of the packet stay
|
||||||
|
* readable. Afterwards the log synchronization gets its chance to request
|
||||||
|
* QSOs that were logged before this listener was started.</p>
|
||||||
|
*
|
||||||
|
* @param datagram raw datagram buffer
|
||||||
|
* @param length number of valid bytes in the buffer
|
||||||
|
*/
|
||||||
|
void processWinTestDatagram(byte[] datagram, int length, InetAddress source) {
|
||||||
|
if (datagram == null || length <= 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
WinTestPacket packet = WinTestPacket.fromDatagram(datagram, length);
|
||||||
|
|
||||||
|
if (packet != null && isWinTestStationMessage(packet.getMessageType())) {
|
||||||
|
/*
|
||||||
|
* Win-Test only answers broadcasts. Remembering where its packets
|
||||||
|
* come from keeps outgoing requests on the network the station
|
||||||
|
* actually lives in, even when the configured broadcast address
|
||||||
|
* belongs to a different or no longer existing network.
|
||||||
|
*/
|
||||||
|
addressResolver.rememberStationAddress(source);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (packet == null) {
|
||||||
|
/*
|
||||||
|
* The datagram does not follow the Win-Test framing. It still
|
||||||
|
* reaches the established text handling, which also recognizes the
|
||||||
|
* poison pill that stops this listener.
|
||||||
|
*/
|
||||||
|
processWinTestPacket(
|
||||||
|
null,
|
||||||
|
new String(datagram, 0, length, StandardCharsets.US_ASCII).trim()
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
processWinTestPacket(packet, packet.getMessageText());
|
||||||
|
|
||||||
|
logSyncService.tick();
|
||||||
|
reportSyncStateIfChanged();
|
||||||
|
}
|
||||||
|
|
||||||
void processWinTestMessage(String msg) {
|
void processWinTestMessage(String msg) {
|
||||||
|
processWinTestPacket(WinTestPacket.fromMessageText(msg), msg);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Processes one Win-Test message.
|
||||||
|
*
|
||||||
|
* @param packet parsed packet, or {@code null} when the message does not
|
||||||
|
* follow the Win-Test framing
|
||||||
|
* @param msg complete message text
|
||||||
|
*/
|
||||||
|
private void processWinTestPacket(WinTestPacket packet, String msg) {
|
||||||
// System.out.println("Wintest-Message received: " + msg);
|
// System.out.println("Wintest-Message received: " + msg);
|
||||||
|
|
||||||
|
if (msg == null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
lastPacketTime = System.currentTimeMillis();
|
lastPacketTime = System.currentTimeMillis();
|
||||||
|
|
||||||
if (msg.startsWith("HELLO:")) { //Client Signon of wintest
|
if (msg.startsWith("HELLO:")) { //Client Signon of wintest
|
||||||
parseHello(msg);
|
parseHello(msg);
|
||||||
try {
|
|
||||||
// send_needqso();
|
|
||||||
}catch (Exception e) {
|
|
||||||
System.out.println("Error: ");
|
|
||||||
e.printStackTrace();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
if (packet != null) {
|
||||||
|
System.out.println("[WinTest RX] HELLO from " + packet.getSource());
|
||||||
|
logSyncService.onStationSeen(packet.getSource());
|
||||||
|
}
|
||||||
|
|
||||||
} else if (msg.startsWith("ADDQSO:")) { //adding qso to wintest log
|
} else if (msg.startsWith("ADDQSO:")) { //adding qso to wintest log
|
||||||
try {
|
try {
|
||||||
|
|
||||||
|
if (packet != null && !packet.getDestination().isEmpty()) {
|
||||||
|
/*
|
||||||
|
* A directed ADDQSO is the answer to one of our NEEDQSO
|
||||||
|
* requests. Tracing it separates a missing answer from a
|
||||||
|
* failing evaluation of the answer.
|
||||||
|
*/
|
||||||
|
System.out.println("[WinTest RX] ADDQSO answer from "
|
||||||
|
+ packet.getSource() + " to " + packet.getDestination());
|
||||||
|
}
|
||||||
|
|
||||||
parseAddQso(msg);
|
parseAddQso(msg);
|
||||||
} catch (Exception e) {
|
} catch (Exception e) {
|
||||||
ThreadStateMessage threadStateMessage = new ThreadStateMessage(this.ThreadNickName, true, "Parsing ERROR: " + Arrays.toString(e.getStackTrace()), true);
|
ThreadStateMessage threadStateMessage = new ThreadStateMessage(this.ThreadNickName, true, "Parsing ERROR: " + Arrays.toString(e.getStackTrace()), true);
|
||||||
@@ -123,8 +239,19 @@ public class ReadUDPByWintestThread extends Thread {
|
|||||||
} else if (msg.startsWith("STATUS")) {
|
} else if (msg.startsWith("STATUS")) {
|
||||||
parseStatus(msg);
|
parseStatus(msg);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* HELLO is only sent when a log is opened, so a listener that was
|
||||||
|
* started later learns about a station from its periodic STATUS.
|
||||||
|
* The configured station-name filter stays a QRG-sync setting: in a
|
||||||
|
* multi-station setup every band station keeps its own log, and all
|
||||||
|
* of them contribute Worked state.
|
||||||
|
*/
|
||||||
|
if (packet != null) {
|
||||||
|
logSyncService.onStationSeen(packet.getSource());
|
||||||
|
}
|
||||||
|
|
||||||
} else if (msg.startsWith("IHAVE:")) { //periodical message of wintest, which qsos are in the log
|
} else if (msg.startsWith("IHAVE:")) { //periodical message of wintest, which qsos are in the log
|
||||||
// parseIHave(msg); //TODO
|
parseIHave(packet);
|
||||||
}
|
}
|
||||||
|
|
||||||
else if (msg.contains(ApplicationConstants.DISCONNECT_RDR_POISONPILL)) {
|
else if (msg.contains(ApplicationConstants.DISCONNECT_RDR_POISONPILL)) {
|
||||||
@@ -138,6 +265,130 @@ public class ReadUDPByWintestThread extends Thread {
|
|||||||
callBackToController.onThreadStatus(ThreadNickName,threadStateMessage);
|
callBackToController.onThreadStatus(ThreadNickName,threadStateMessage);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hands the periodic Win-Test log inventory to the log synchronization.
|
||||||
|
*
|
||||||
|
* <p>A packet with a broken checksum is discarded here. The run-length
|
||||||
|
* inventory is the last field of an IHAVE packet, so a corrupted packet
|
||||||
|
* would announce QSO ranges that do not exist. The established handling of
|
||||||
|
* the other message types is deliberately left unchanged, because it never
|
||||||
|
* verified the checksum.</p>
|
||||||
|
*
|
||||||
|
* @param packet received IHAVE packet
|
||||||
|
*/
|
||||||
|
private void parseIHave(WinTestPacket packet) {
|
||||||
|
if (packet == null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (packet.isChecksumPresent() && !packet.isChecksumValid()) {
|
||||||
|
System.out.println("[WinTest] IHAVE with invalid checksum ignored");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
String tracedPayload = String.join(" ", packet.getDataTokens());
|
||||||
|
if (!tracedPayload.equals(lastTracedIhaveByStation.put(packet.getSource(), tracedPayload))) {
|
||||||
|
System.out.println("[WinTest RX] IHAVE from " + packet.getSource()
|
||||||
|
+ " to '" + packet.getDestination() + "': " + tracedPayload
|
||||||
|
+ (WinTestIhaveInventory.fromPacket(packet).isEmpty()
|
||||||
|
? " <-- not usable as inventory" : ""));
|
||||||
|
}
|
||||||
|
|
||||||
|
logSyncService.onIhaveReceived(packet);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reports a change of the log-synchronization progress to the controller.
|
||||||
|
*/
|
||||||
|
private void reportSyncStateIfChanged() {
|
||||||
|
WinTestLogSyncService.SyncState currentSyncState = logSyncService.getState();
|
||||||
|
|
||||||
|
if (currentSyncState == lastReportedSyncState) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
lastReportedSyncState = currentSyncState;
|
||||||
|
|
||||||
|
ThreadStateMessage threadStateMessage = new ThreadStateMessage(
|
||||||
|
this.ThreadNickName, true, "log sync: " + currentSyncState, false);
|
||||||
|
callBackToController.onThreadStatus(ThreadNickName, threadStateMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sends a NEEDQSO request as a UDP broadcast.
|
||||||
|
*
|
||||||
|
* <p>The framing follows the wtKST implementation exactly, including the
|
||||||
|
* leading blank of the data part:</p>
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* NEEDQSO: "KST4Contest" "STN1" "STN1@44510" 1 50{checksum}\0
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* @param targetStation Win-Test station the request is addressed to
|
||||||
|
* @param logId log identity in the form {@code StationName@LogUniqueID}
|
||||||
|
* @param countFrom first requested QSO number
|
||||||
|
* @param countTo last requested QSO number
|
||||||
|
*/
|
||||||
|
private void sendNeedQso(String targetStation, String logId, long countFrom, long countTo) {
|
||||||
|
String data = " \"" + logId + "\" " + countFrom + " " + countTo;
|
||||||
|
|
||||||
|
WinTestMessage needQsoMessage = new WinTestMessage(
|
||||||
|
WinTestMessage.MessageType.NEEDQSO,
|
||||||
|
resolveOwnWinTestStationName(),
|
||||||
|
targetStation,
|
||||||
|
data
|
||||||
|
);
|
||||||
|
|
||||||
|
try (DatagramSocket sendSocket = new DatagramSocket()) {
|
||||||
|
sendSocket.setBroadcast(true);
|
||||||
|
sendSocket.setReuseAddress(true);
|
||||||
|
|
||||||
|
byte[] messageBytes = needQsoMessage.toBytes();
|
||||||
|
InetAddress broadcastAddress = addressResolver.resolveBroadcastAddress(
|
||||||
|
client.getChatPreferences().getLogsynch_wintestNetworkBroadcastAddress());
|
||||||
|
int targetPort = client.getChatPreferences().getLogsynch_wintestNetworkPort();
|
||||||
|
|
||||||
|
sendSocket.send(new DatagramPacket(
|
||||||
|
messageBytes, messageBytes.length, broadcastAddress, targetPort));
|
||||||
|
|
||||||
|
System.out.println("[WinTest LogSync] NEEDQSO to " + targetStation
|
||||||
|
+ " for " + logId + " " + countFrom + "-" + countTo);
|
||||||
|
} catch (IOException | RuntimeException exception) {
|
||||||
|
System.out.println("[WinTest LogSync] NEEDQSO could not be sent: "
|
||||||
|
+ exception.getMessage());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return own station name in the Win-Test network, never blank
|
||||||
|
*/
|
||||||
|
private String resolveOwnWinTestStationName() {
|
||||||
|
String configuredStationName =
|
||||||
|
client.getChatPreferences().getLogsynch_wintestNetworkStationNameOfKST();
|
||||||
|
|
||||||
|
if (configuredStationName == null || configuredStationName.isBlank()) {
|
||||||
|
return "KST4Contest";
|
||||||
|
}
|
||||||
|
|
||||||
|
return configuredStationName.trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether a message type identifies a genuine Win-Test station.
|
||||||
|
*
|
||||||
|
* <p>Internal control messages such as the poison pill must not influence
|
||||||
|
* the address of outgoing Win-Test packets.</p>
|
||||||
|
*
|
||||||
|
* @param messageType message type of a received packet
|
||||||
|
* @return {@code true} for a Win-Test station message
|
||||||
|
*/
|
||||||
|
private static boolean isWinTestStationMessage(String messageType) {
|
||||||
|
return "HELLO".equals(messageType)
|
||||||
|
|| "STATUS".equals(messageType)
|
||||||
|
|| "IHAVE".equals(messageType)
|
||||||
|
|| "ADDQSO".equals(messageType);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* parsing of the hello message of wintest:
|
* parsing of the hello message of wintest:
|
||||||
* "HELLO: "STN1" "" 6667 130 "SLAVE" 1 0 1762201985"
|
* "HELLO: "STN1" "" 6667 130 "SLAVE" 1 0 1762201985"
|
||||||
@@ -346,15 +597,6 @@ public class ReadUDPByWintestThread extends Thread {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// private void send_needqso() throws IOException {
|
|
||||||
// String payload = String.format("NEEDQSO:\"%s\" \"%s\" \"%s\" %d %d?\0",
|
|
||||||
// "DO5AMF", "STN1", stationID, 1, 9999);
|
|
||||||
// InetAddress broadcast = InetAddress.getByName("255.255.255.255");
|
|
||||||
// byte[] bytes = payload.getBytes(StandardCharsets.US_ASCII);
|
|
||||||
// bytes[bytes.length - 2] = util_calculateChecksum((bytes));
|
|
||||||
// socket.send(new DatagramPacket(bytes, bytes.length, broadcast, 9871));
|
|
||||||
// }
|
|
||||||
|
|
||||||
// private void send_hello() throws IOException {
|
// private void send_hello() throws IOException {
|
||||||
// String payload = String.format("HELLO:\"%s\" \"%s\" \"%s\" %d %d?\0",
|
// String payload = String.format("HELLO:\"%s\" \"%s\" \"%s\" %d %d?\0",
|
||||||
// "DO5AMF", "", stationID, "SLAVE", 1, 14);
|
// "DO5AMF", "", stationID, "SLAVE", 1, 14);
|
||||||
@@ -390,6 +632,61 @@ public class ReadUDPByWintestThread extends Thread {
|
|||||||
return packetFields.length > 3 ? packetFields[3] : "";
|
return packetFields.length > 3 ? packetFields[3] : "";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds the log identity of an ADDQSO packet.
|
||||||
|
*
|
||||||
|
* <p>Win-Test numbers the QSOs of every log continuously, so a QSO is only
|
||||||
|
* identified by the combination of the logging station, the unique log ID
|
||||||
|
* and the QSO number. The log ID is the last field of the packet.</p>
|
||||||
|
*
|
||||||
|
* @param packetFields fields of the ADDQSO packet
|
||||||
|
* @return identity in the form {@code StationName@LogUniqueID}, or
|
||||||
|
* {@code null} when the packet does not carry both values
|
||||||
|
*/
|
||||||
|
static String extractLogIdFromWinTestAddQso(List<String> packetFields) {
|
||||||
|
if (packetFields == null || packetFields.size() < ADDQSO_FIELD_COUNT) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
String stationName = packetFields.get(ADDQSO_STATION_NAME_INDEX);
|
||||||
|
String logUniqueId = packetFields.get(packetFields.size() - 1);
|
||||||
|
|
||||||
|
if (stationName == null || stationName.isBlank()
|
||||||
|
|| logUniqueId == null || logUniqueId.isBlank()) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return stationName.trim() + "@" + logUniqueId.trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extracts the Win-Test QSO number of an ADDQSO packet.
|
||||||
|
*
|
||||||
|
* <p>Win-Test sends {@code 0} instead of {@code 1} for the first QSO of a
|
||||||
|
* log in some situations. wtKST corrects that the same way.</p>
|
||||||
|
*
|
||||||
|
* @param packetFields fields of the ADDQSO packet
|
||||||
|
* @return QSO number, or {@code 0} when the packet carries no usable value
|
||||||
|
*/
|
||||||
|
static long extractQsoNumberFromWinTestAddQso(List<String> packetFields) {
|
||||||
|
if (packetFields == null || packetFields.size() < ADDQSO_FIELD_COUNT) {
|
||||||
|
return 0L;
|
||||||
|
}
|
||||||
|
|
||||||
|
String rawQsoNumber = packetFields.get(ADDQSO_QSO_NUMBER_INDEX);
|
||||||
|
|
||||||
|
if (rawQsoNumber == null) {
|
||||||
|
return 0L;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
long qsoNumber = Long.parseLong(rawQsoNumber.trim());
|
||||||
|
return qsoNumber <= 0L ? 1L : qsoNumber;
|
||||||
|
} catch (NumberFormatException exception) {
|
||||||
|
return 0L;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Extracts the locator from a Win-Test ADDQSO packet.
|
* Extracts the locator from a Win-Test ADDQSO packet.
|
||||||
*
|
*
|
||||||
@@ -443,6 +740,17 @@ public class ReadUDPByWintestThread extends Thread {
|
|||||||
*/
|
*/
|
||||||
private void parseAddQso(String msg) {
|
private void parseAddQso(String msg) {
|
||||||
try {
|
try {
|
||||||
|
List<String> packetFields = WinTestPacket.tokenize(msg);
|
||||||
|
String logId = extractLogIdFromWinTestAddQso(packetFields);
|
||||||
|
long qsoNumber = extractQsoNumberFromWinTestAddQso(packetFields);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* The QSO number is registered before any validation. Otherwise the
|
||||||
|
* log synchronization would request a QSO with unusable content
|
||||||
|
* over and over again.
|
||||||
|
*/
|
||||||
|
boolean isUnknownQso = logSyncService.registerReceivedQso(logId, qsoNumber);
|
||||||
|
|
||||||
String[] quotedParts = msg == null ? new String[0] : msg.split("\"");
|
String[] quotedParts = msg == null ? new String[0] : msg.split("\"");
|
||||||
String callSign = quotedParts.length > 7 ? quotedParts[7] : "";
|
String callSign = quotedParts.length > 7 ? quotedParts[7] : "";
|
||||||
String rawBandId = extractBandIdFromWinTestAddQso(msg);
|
String rawBandId = extractBandIdFromWinTestAddQso(msg);
|
||||||
@@ -455,6 +763,16 @@ public class ReadUDPByWintestThread extends Thread {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (!isUnknownQso) {
|
||||||
|
/*
|
||||||
|
* Win-Test resends known QSOs when a NEEDQSO request overlaps
|
||||||
|
* with QSOs that already arrived as a broadcast. Worked state
|
||||||
|
* and database entry exist in that case, so repeating the write
|
||||||
|
* would only cost time during the initial log recovery.
|
||||||
|
*/
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
if (loggedBand == null && !rawBandId.isEmpty()) {
|
if (loggedBand == null && !rawBandId.isEmpty()) {
|
||||||
System.out.println("[WinTestUDPRcvr: warning] Unknown band ID: " + rawBandId);
|
System.out.println("[WinTestUDPRcvr: warning] Unknown band ID: " + rawBandId);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,217 @@
|
|||||||
|
package kst4contest.controller;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Inventory of one Win-Test log, transported in an {@code IHAVE} packet.
|
||||||
|
*
|
||||||
|
* <p>Win-Test announces which QSO numbers of a log a station currently holds.
|
||||||
|
* To keep the packet short the inventory is run-length encoded:</p>
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* IHAVE: "Shack" "" "Shack@9" E 1 1 911-1-117
|
||||||
|
* ^logId ^ ^ ^ ^run lengths
|
||||||
|
* origin | initial state
|
||||||
|
* first row
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* <p>The run lengths alternate between present and missing QSOs, starting with
|
||||||
|
* the state given by {@code InitialState} at QSO number {@code FirstRow}. The
|
||||||
|
* example above therefore means: QSOs 1 to 911 are present, QSO 912 is missing
|
||||||
|
* and QSOs 913 to 1029 are present again.</p>
|
||||||
|
*
|
||||||
|
* <p>Unlike the wtKST implementation this parser honours {@code FirstRow}
|
||||||
|
* instead of assuming that every inventory starts at QSO number one. Win-Test
|
||||||
|
* splits long inventories into several packets, and a split inventory starts at
|
||||||
|
* a higher first row.</p>
|
||||||
|
*/
|
||||||
|
public final class WinTestIhaveInventory {
|
||||||
|
|
||||||
|
/** Where the sending station got the log from. */
|
||||||
|
public enum Origin {
|
||||||
|
/** The station owns the log or the operator is logged on there. */
|
||||||
|
OWNER,
|
||||||
|
/** The station only mirrors a log owned by somebody else. */
|
||||||
|
LOGGED_ELSE
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Protects against endless loops caused by a corrupted run-length chain. */
|
||||||
|
private static final int MAX_SEGMENTS = 512;
|
||||||
|
|
||||||
|
private static final int EXPECTED_FIELD_COUNT = 5;
|
||||||
|
|
||||||
|
private final String logId;
|
||||||
|
private final Origin origin;
|
||||||
|
private final List<WinTestLogSegment> segments;
|
||||||
|
|
||||||
|
private WinTestIhaveInventory(String logId, Origin origin, List<WinTestLogSegment> segments) {
|
||||||
|
this.logId = logId;
|
||||||
|
this.origin = origin;
|
||||||
|
this.segments = segments;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses an {@code IHAVE} packet.
|
||||||
|
*
|
||||||
|
* @param packet received packet
|
||||||
|
* @return inventory, or an empty value when the packet is not a usable
|
||||||
|
* {@code IHAVE} announcement
|
||||||
|
*/
|
||||||
|
public static Optional<WinTestIhaveInventory> fromPacket(WinTestPacket packet) {
|
||||||
|
if (packet == null || !"IHAVE".equals(packet.getMessageType())) {
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
List<String> fields = packet.getDataTokens();
|
||||||
|
if (fields.size() != EXPECTED_FIELD_COUNT) {
|
||||||
|
/*
|
||||||
|
* Win-Test versions before 1.29 use a shorter IHAVE format without
|
||||||
|
* run-length encoding. It carries no usable range information, so
|
||||||
|
* the blind fallback of the sync service has to take over.
|
||||||
|
*/
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
String parsedLogId = fields.get(0) == null ? "" : fields.get(0).trim();
|
||||||
|
if (parsedLogId.isEmpty()) {
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
Origin parsedOrigin = parseOrigin(fields.get(1));
|
||||||
|
|
||||||
|
long firstRow = parseUnsignedValue(fields.get(2));
|
||||||
|
long initialState = parseUnsignedValue(fields.get(3));
|
||||||
|
|
||||||
|
if (firstRow < 1L || initialState < 0L || initialState > 1L) {
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
List<WinTestLogSegment> parsedSegments =
|
||||||
|
parseRunLengths(fields.get(4), firstRow, initialState == 1L);
|
||||||
|
|
||||||
|
if (parsedSegments == null) {
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
return Optional.of(new WinTestIhaveInventory(parsedLogId, parsedOrigin, parsedSegments));
|
||||||
|
}
|
||||||
|
|
||||||
|
private static Origin parseOrigin(String rawOrigin) {
|
||||||
|
if (rawOrigin == null) {
|
||||||
|
return Origin.OWNER;
|
||||||
|
}
|
||||||
|
|
||||||
|
String normalizedOrigin = rawOrigin.trim().toUpperCase(java.util.Locale.ROOT);
|
||||||
|
if ("E".equals(normalizedOrigin) || "LOGGEDELSE".equals(normalizedOrigin)) {
|
||||||
|
return Origin.LOGGED_ELSE;
|
||||||
|
}
|
||||||
|
return Origin.OWNER;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Expands the hyphen-separated run lengths into ranges.
|
||||||
|
*
|
||||||
|
* @param rawRunLengths run-length chain such as {@code 911-1-117}
|
||||||
|
* @param firstRow QSO number the first run starts at
|
||||||
|
* @param startsPresent {@code true} when the first run describes present QSOs
|
||||||
|
* @return ranges of present QSOs, or {@code null} for an unusable chain
|
||||||
|
*/
|
||||||
|
private static List<WinTestLogSegment> parseRunLengths(
|
||||||
|
String rawRunLengths,
|
||||||
|
long firstRow,
|
||||||
|
boolean startsPresent
|
||||||
|
) {
|
||||||
|
if (rawRunLengths == null || rawRunLengths.isBlank()) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
String[] runLengths = rawRunLengths.trim().split("-");
|
||||||
|
|
||||||
|
/*
|
||||||
|
* A chain that starts with present QSOs has to end with a present run,
|
||||||
|
* so its length is odd. A chain that starts with missing QSOs needs an
|
||||||
|
* even length for the same reason.
|
||||||
|
*/
|
||||||
|
if (startsPresent) {
|
||||||
|
if (runLengths.length % 2 == 0) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
} else if (runLengths.length % 2 == 1 || runLengths.length < 2) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
List<WinTestLogSegment> parsedSegments = new ArrayList<>();
|
||||||
|
long cursor = firstRow;
|
||||||
|
boolean present = startsPresent;
|
||||||
|
|
||||||
|
for (String runLength : runLengths) {
|
||||||
|
long count = parseUnsignedValue(runLength);
|
||||||
|
if (count < 0L) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (present && count > 0L) {
|
||||||
|
if (parsedSegments.size() >= MAX_SEGMENTS) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
parsedSegments.add(new WinTestLogSegment(cursor, cursor + count - 1L));
|
||||||
|
}
|
||||||
|
|
||||||
|
cursor += count;
|
||||||
|
present = !present;
|
||||||
|
}
|
||||||
|
|
||||||
|
return parsedSegments;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static long parseUnsignedValue(String rawValue) {
|
||||||
|
if (rawValue == null) {
|
||||||
|
return -1L;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return Long.parseLong(rawValue.trim());
|
||||||
|
} catch (NumberFormatException exception) {
|
||||||
|
return -1L;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return log identity in the form {@code StationName@LogUniqueID}
|
||||||
|
*/
|
||||||
|
public String getLogId() {
|
||||||
|
return logId;
|
||||||
|
}
|
||||||
|
|
||||||
|
public Origin getOrigin() {
|
||||||
|
return origin;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return ranges of QSO numbers the announcing station holds
|
||||||
|
*/
|
||||||
|
public List<WinTestLogSegment> getSegments() {
|
||||||
|
return Collections.unmodifiableList(segments);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return highest announced QSO number, or {@code 0} for an empty inventory
|
||||||
|
*/
|
||||||
|
public long getHighestQsoNumber() {
|
||||||
|
long highestQsoNumber = 0L;
|
||||||
|
for (WinTestLogSegment segment : segments) {
|
||||||
|
if (segment.getCountTo() > highestQsoNumber) {
|
||||||
|
highestQsoNumber = segment.getCountTo();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return highestQsoNumber;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return logId + " " + origin + " " + segments;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
package kst4contest.controller;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Consecutive range of Win-Test QSO numbers inside one log.
|
||||||
|
*
|
||||||
|
* <p>Win-Test numbers the QSOs of every log continuously. The {@code IHAVE}
|
||||||
|
* inventory of a log is therefore expressed as a list of ranges that are
|
||||||
|
* present in that log. A range is inclusive on both ends.</p>
|
||||||
|
*/
|
||||||
|
public final class WinTestLogSegment {
|
||||||
|
|
||||||
|
private final long countFrom;
|
||||||
|
private final long countTo;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param countFrom first QSO number of the range
|
||||||
|
* @param countTo last QSO number of the range
|
||||||
|
*/
|
||||||
|
public WinTestLogSegment(long countFrom, long countTo) {
|
||||||
|
this.countFrom = countFrom;
|
||||||
|
this.countTo = countTo;
|
||||||
|
}
|
||||||
|
|
||||||
|
public long getCountFrom() {
|
||||||
|
return countFrom;
|
||||||
|
}
|
||||||
|
|
||||||
|
public long getCountTo() {
|
||||||
|
return countTo;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return number of QSOs covered by this range, never negative
|
||||||
|
*/
|
||||||
|
public long getCount() {
|
||||||
|
return countTo < countFrom ? 0L : countTo - countFrom + 1L;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean equals(Object other) {
|
||||||
|
if (this == other) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
if (!(other instanceof WinTestLogSegment)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
WinTestLogSegment otherSegment = (WinTestLogSegment) other;
|
||||||
|
return countFrom == otherSegment.countFrom && countTo == otherSegment.countTo;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int hashCode() {
|
||||||
|
return Long.hashCode(countFrom) * 31 + Long.hashCode(countTo);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return countFrom + "-" + countTo;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,611 @@
|
|||||||
|
package kst4contest.controller;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.LinkedHashMap;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.NavigableSet;
|
||||||
|
import java.util.Optional;
|
||||||
|
import java.util.TreeSet;
|
||||||
|
import java.util.function.LongSupplier;
|
||||||
|
import java.util.function.Supplier;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Recovers the part of a Win-Test log that was written before KST4Contest was
|
||||||
|
* started.
|
||||||
|
*
|
||||||
|
* <p>Win-Test broadcasts every new QSO as an {@code ADDQSO} packet. A client
|
||||||
|
* that joins the network later never sees the QSOs logged before it started, so
|
||||||
|
* stations already worked would still be shown as not worked. Win-Test also
|
||||||
|
* offers a pull mechanism for exactly this situation, and this service is the
|
||||||
|
* port of the wtKST {@code WtLogSync} implementation of it:</p>
|
||||||
|
*
|
||||||
|
* <ol>
|
||||||
|
* <li>a Win-Test station announces itself with {@code HELLO} or, if its log
|
||||||
|
* was opened before we started listening, with its periodic
|
||||||
|
* {@code STATUS};</li>
|
||||||
|
* <li>its periodic {@code IHAVE} packets announce which QSO numbers of
|
||||||
|
* which log it holds;</li>
|
||||||
|
* <li>missing ranges are requested with {@code NEEDQSO}, at most
|
||||||
|
* {@value #MAX_QSOS_PER_REQUEST} QSOs per request;</li>
|
||||||
|
* <li>Win-Test answers with ordinary {@code ADDQSO} packets that are
|
||||||
|
* addressed to us instead of being broadcast.</li>
|
||||||
|
* </ol>
|
||||||
|
*
|
||||||
|
* <p>Because the answers are ordinary {@code ADDQSO} packets, the recovered
|
||||||
|
* QSOs run through the same Worked handling as live QSOs. This service only
|
||||||
|
* decides what still has to be requested; it neither touches the database nor
|
||||||
|
* the user interface.</p>
|
||||||
|
*
|
||||||
|
* <p>If a station is known but no usable {@code IHAVE} inventory arrives within
|
||||||
|
* {@value #INVENTORY_GRACE_PERIOD_MS} ms, a blind fallback requests fixed
|
||||||
|
* blocks starting at QSO number one until a block stays unanswered. That covers
|
||||||
|
* Win-Test versions whose {@code IHAVE} format carries no run lengths.</p>
|
||||||
|
*
|
||||||
|
* <p>Deviation from wtKST: wtKST discards its whole QSO table whenever a
|
||||||
|
* {@code HELLO} arrives, because it displays that table. KST4Contest only
|
||||||
|
* accumulates Worked state, where a stale entry is harmless while a discarded
|
||||||
|
* one would cause the complete log to be requested and written again. The log
|
||||||
|
* identity {@code StationName@LogUniqueID} already changes when Win-Test opens
|
||||||
|
* a different log, so nothing is cleared here.</p>
|
||||||
|
*/
|
||||||
|
public class WinTestLogSyncService {
|
||||||
|
|
||||||
|
/** Win-Test answers at most this many QSOs for one NEEDQSO request. */
|
||||||
|
static final int MAX_QSOS_PER_REQUEST = 50;
|
||||||
|
|
||||||
|
/** Time after which an unanswered request is retried elsewhere. */
|
||||||
|
static final long REQUEST_TIMEOUT_MS = 5000L;
|
||||||
|
|
||||||
|
/** Shortest distance between two evaluations without a pending trigger. */
|
||||||
|
static final long TICK_INTERVAL_MS = 2000L;
|
||||||
|
|
||||||
|
/** Waiting time for a usable IHAVE before the blind fallback starts. */
|
||||||
|
static final long INVENTORY_GRACE_PERIOD_MS = 15000L;
|
||||||
|
|
||||||
|
/** Upper bound for the blind fallback, equals 10000 QSOs. */
|
||||||
|
static final int MAX_BLIND_BLOCKS = 200;
|
||||||
|
|
||||||
|
/** Guards the gap search against a corrupted inventory. */
|
||||||
|
private static final long MAX_SCANNED_QSO_NUMBERS = 200000L;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sends a NEEDQSO request to a Win-Test station.
|
||||||
|
*/
|
||||||
|
@FunctionalInterface
|
||||||
|
public interface NeedQsoSender {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param targetStation Win-Test station name the request is sent to
|
||||||
|
* @param logId log identity in the form {@code StationName@LogUniqueID}
|
||||||
|
* @param countFrom first requested QSO number
|
||||||
|
* @param countTo last requested QSO number
|
||||||
|
*/
|
||||||
|
void sendNeedQso(String targetStation, String logId, long countFrom, long countTo);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Progress of the log recovery, used for status reporting. */
|
||||||
|
public enum SyncState {
|
||||||
|
/** No Win-Test station seen yet. */
|
||||||
|
IDLE,
|
||||||
|
/** A station is known, but nothing has been requested yet. */
|
||||||
|
STATION_DETECTED,
|
||||||
|
/** QSOs are being requested. */
|
||||||
|
SYNCING,
|
||||||
|
/** Everything announced by the known stations has been received. */
|
||||||
|
IN_SYNC
|
||||||
|
}
|
||||||
|
|
||||||
|
private final NeedQsoSender needQsoSender;
|
||||||
|
private final Supplier<String> ownStationNameSupplier;
|
||||||
|
private final LongSupplier clock;
|
||||||
|
|
||||||
|
/** Inventories per Win-Test station, keyed by log identity. */
|
||||||
|
private final Map<String, Map<String, WinTestIhaveInventory>> inventoriesByStation =
|
||||||
|
new LinkedHashMap<>();
|
||||||
|
|
||||||
|
/** QSO numbers already received, keyed by log identity. */
|
||||||
|
private final Map<String, NavigableSet<Long>> receivedQsoNumbersByLogId = new HashMap<>();
|
||||||
|
|
||||||
|
/** State of the blind fallback, keyed by log identity. */
|
||||||
|
private final Map<String, BlindScan> blindScansByLogId = new LinkedHashMap<>();
|
||||||
|
|
||||||
|
private PendingRequest pendingRequest;
|
||||||
|
private long firstStationSeenAtMs;
|
||||||
|
private boolean usableInventorySeen;
|
||||||
|
private long lastTickMs;
|
||||||
|
private boolean tickDueImmediately;
|
||||||
|
private SyncState state = SyncState.IDLE;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param needQsoSender transport used for NEEDQSO requests
|
||||||
|
* @param ownStationNameSupplier own Win-Test station name, read late because
|
||||||
|
* it can be changed in the settings at runtime
|
||||||
|
*/
|
||||||
|
public WinTestLogSyncService(
|
||||||
|
NeedQsoSender needQsoSender,
|
||||||
|
Supplier<String> ownStationNameSupplier
|
||||||
|
) {
|
||||||
|
this(needQsoSender, ownStationNameSupplier, System::currentTimeMillis);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param needQsoSender transport used for NEEDQSO requests
|
||||||
|
* @param ownStationNameSupplier own Win-Test station name
|
||||||
|
* @param clock time source in milliseconds
|
||||||
|
*/
|
||||||
|
WinTestLogSyncService(
|
||||||
|
NeedQsoSender needQsoSender,
|
||||||
|
Supplier<String> ownStationNameSupplier,
|
||||||
|
LongSupplier clock
|
||||||
|
) {
|
||||||
|
this.needQsoSender = needQsoSender;
|
||||||
|
this.ownStationNameSupplier = ownStationNameSupplier;
|
||||||
|
this.clock = clock;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a Win-Test station seen in a HELLO or STATUS packet.
|
||||||
|
*
|
||||||
|
* @param stationName Win-Test station name
|
||||||
|
*/
|
||||||
|
public synchronized void onStationSeen(String stationName) {
|
||||||
|
if (stationName == null || stationName.isBlank()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
String normalizedStationName = stationName.trim();
|
||||||
|
if (normalizedStationName.equalsIgnoreCase(resolveOwnStationName())) {
|
||||||
|
// our own packets, nothing to synchronize from
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (inventoriesByStation.putIfAbsent(normalizedStationName, new LinkedHashMap<>()) == null) {
|
||||||
|
tickDueImmediately = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (firstStationSeenAtMs == 0L) {
|
||||||
|
firstStationSeenAtMs = clock.getAsLong();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (state == SyncState.IDLE) {
|
||||||
|
state = SyncState.STATION_DETECTED;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Takes over the inventory of an IHAVE packet.
|
||||||
|
*
|
||||||
|
* @param packet received IHAVE packet
|
||||||
|
*/
|
||||||
|
public synchronized void onIhaveReceived(WinTestPacket packet) {
|
||||||
|
if (packet == null || !packet.isAddressedTo(resolveOwnStationName())) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
Optional<WinTestIhaveInventory> parsedInventory = WinTestIhaveInventory.fromPacket(packet);
|
||||||
|
if (parsedInventory.isEmpty()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
WinTestIhaveInventory inventory = parsedInventory.get();
|
||||||
|
onStationSeen(packet.getSource());
|
||||||
|
|
||||||
|
Map<String, WinTestIhaveInventory> stationInventories =
|
||||||
|
inventoriesByStation.get(packet.getSource() == null ? "" : packet.getSource().trim());
|
||||||
|
|
||||||
|
if (stationInventories == null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
WinTestIhaveInventory previousInventory =
|
||||||
|
stationInventories.put(inventory.getLogId(), inventory);
|
||||||
|
|
||||||
|
if (previousInventory == null
|
||||||
|
|| !previousInventory.getSegments().equals(inventory.getSegments())) {
|
||||||
|
System.out.println("[WinTest LogSync] inventory of " + inventory.getLogId()
|
||||||
|
+ " from " + packet.getSource()
|
||||||
|
+ " (" + inventory.getOrigin() + "): " + inventory.getSegments());
|
||||||
|
}
|
||||||
|
|
||||||
|
usableInventorySeen = true;
|
||||||
|
blindScansByLogId.remove(inventory.getLogId());
|
||||||
|
tickDueImmediately = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a QSO received in an ADDQSO packet.
|
||||||
|
*
|
||||||
|
* @param logId log identity in the form {@code StationName@LogUniqueID}
|
||||||
|
* @param qsoNumber Win-Test QSO number inside that log
|
||||||
|
* @return {@code true} when this QSO was not known before, and therefore
|
||||||
|
* still has to be applied to Worked state and database
|
||||||
|
*/
|
||||||
|
public synchronized boolean registerReceivedQso(String logId, long qsoNumber) {
|
||||||
|
if (logId == null || logId.isBlank() || qsoNumber <= 0L) {
|
||||||
|
// without a usable identity the QSO cannot be deduplicated
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
NavigableSet<Long> receivedQsoNumbers =
|
||||||
|
receivedQsoNumbersByLogId.computeIfAbsent(logId.trim(), key -> new TreeSet<>());
|
||||||
|
boolean isNewQso = receivedQsoNumbers.add(qsoNumber);
|
||||||
|
|
||||||
|
if (pendingRequest != null
|
||||||
|
&& pendingRequest.logId.equals(logId.trim())
|
||||||
|
&& qsoNumber >= pendingRequest.countFrom
|
||||||
|
&& qsoNumber <= pendingRequest.countTo) {
|
||||||
|
|
||||||
|
pendingRequest.answeredQsoCount++;
|
||||||
|
|
||||||
|
if (qsoNumber == pendingRequest.countTo
|
||||||
|
|| pendingRequest.answeredQsoCount >= pendingRequest.getRequestedQsoCount()) {
|
||||||
|
PendingRequest completedRequest = pendingRequest;
|
||||||
|
pendingRequest = null;
|
||||||
|
if (completedRequest.blind) {
|
||||||
|
finishBlindBlock(completedRequest);
|
||||||
|
}
|
||||||
|
tickDueImmediately = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return isNewQso;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Advances the recovery. Called after every received packet and on every
|
||||||
|
* receive timeout of the listener; an internal interval keeps the actual
|
||||||
|
* work rare while a satisfied request triggers the next one immediately.
|
||||||
|
*/
|
||||||
|
public synchronized void tick() {
|
||||||
|
long now = clock.getAsLong();
|
||||||
|
|
||||||
|
if (!tickDueImmediately && now - lastTickMs < TICK_INTERVAL_MS) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
lastTickMs = now;
|
||||||
|
tickDueImmediately = false;
|
||||||
|
|
||||||
|
if (pendingRequest != null) {
|
||||||
|
if (now - pendingRequest.sentAtMs < REQUEST_TIMEOUT_MS) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
handlePendingTimeout();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (requestNextMissingRange(now)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (requestNextBlindBlock(now)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (state == SyncState.SYNCING) {
|
||||||
|
state = SyncState.IN_SYNC;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return current progress of the recovery
|
||||||
|
*/
|
||||||
|
public synchronized SyncState getState() {
|
||||||
|
return state;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return number of QSO numbers known for the given log
|
||||||
|
*/
|
||||||
|
synchronized int getKnownQsoCount(String logId) {
|
||||||
|
NavigableSet<Long> receivedQsoNumbers = receivedQsoNumbersByLogId.get(logId);
|
||||||
|
return receivedQsoNumbers == null ? 0 : receivedQsoNumbers.size();
|
||||||
|
}
|
||||||
|
|
||||||
|
private void handlePendingTimeout() {
|
||||||
|
PendingRequest timedOutRequest = pendingRequest;
|
||||||
|
pendingRequest = null;
|
||||||
|
|
||||||
|
if (timedOutRequest.blind) {
|
||||||
|
finishBlindBlock(timedOutRequest);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
String alternativeStation =
|
||||||
|
findAlternativeStation(timedOutRequest.logId, timedOutRequest.targetStation);
|
||||||
|
|
||||||
|
System.out.println("[WinTest LogSync] no answer from " + timedOutRequest.targetStation
|
||||||
|
+ " for " + timedOutRequest.logId + " "
|
||||||
|
+ timedOutRequest.countFrom + "-" + timedOutRequest.countTo);
|
||||||
|
|
||||||
|
if (alternativeStation != null) {
|
||||||
|
sendRequest(
|
||||||
|
alternativeStation,
|
||||||
|
timedOutRequest.logId,
|
||||||
|
timedOutRequest.countFrom,
|
||||||
|
timedOutRequest.countTo,
|
||||||
|
false,
|
||||||
|
clock.getAsLong()
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Nobody else holds this log. The silent station is dropped and returns
|
||||||
|
* with its next STATUS or IHAVE packet.
|
||||||
|
*/
|
||||||
|
System.out.println("[WinTest LogSync] dropping silent station "
|
||||||
|
+ timedOutRequest.targetStation + ", waiting for its next STATUS or IHAVE");
|
||||||
|
inventoriesByStation.remove(timedOutRequest.targetStation);
|
||||||
|
tickDueImmediately = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
private String findAlternativeStation(String logId, String excludedStation) {
|
||||||
|
for (Map.Entry<String, Map<String, WinTestIhaveInventory>> station
|
||||||
|
: inventoriesByStation.entrySet()) {
|
||||||
|
|
||||||
|
if (station.getKey().equals(excludedStation)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (station.getValue().containsKey(logId)) {
|
||||||
|
return station.getKey();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Looks for the first announced QSO range that is still missing and
|
||||||
|
* requests it. Stations that own a log are preferred over stations that
|
||||||
|
* only mirror it.
|
||||||
|
*
|
||||||
|
* @param now current time in milliseconds
|
||||||
|
* @return {@code true} when a request was sent
|
||||||
|
*/
|
||||||
|
private boolean requestNextMissingRange(long now) {
|
||||||
|
for (int pass = 0; pass < 2; pass++) {
|
||||||
|
boolean preferOwner = pass == 0;
|
||||||
|
|
||||||
|
for (Map.Entry<String, Map<String, WinTestIhaveInventory>> station
|
||||||
|
: new ArrayList<>(inventoriesByStation.entrySet())) {
|
||||||
|
|
||||||
|
for (WinTestIhaveInventory inventory : new ArrayList<>(station.getValue().values())) {
|
||||||
|
boolean isOwner = inventory.getOrigin() == WinTestIhaveInventory.Origin.OWNER;
|
||||||
|
if (preferOwner != isOwner) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
long[] missingRange = findMissingRange(
|
||||||
|
inventory.getSegments(),
|
||||||
|
receivedQsoNumbersByLogId.get(inventory.getLogId())
|
||||||
|
);
|
||||||
|
|
||||||
|
if (missingRange == null) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
sendRequest(
|
||||||
|
station.getKey(),
|
||||||
|
inventory.getLogId(),
|
||||||
|
missingRange[0],
|
||||||
|
missingRange[1],
|
||||||
|
false,
|
||||||
|
now
|
||||||
|
);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determines the next missing QSO range of one log.
|
||||||
|
*
|
||||||
|
* <p>wtKST compares its own segment list against the announced one and
|
||||||
|
* derives the request bounds from the segment indices. Searching the gap
|
||||||
|
* directly produces the same ranges for the ordinary cases, cannot run past
|
||||||
|
* the end of either list, and never asks for QSO numbers that are already
|
||||||
|
* known.</p>
|
||||||
|
*
|
||||||
|
* @param segments ranges announced by the station
|
||||||
|
* @param receivedQsoNumbers QSO numbers already received for this log
|
||||||
|
* @return first missing range as {@code {countFrom, countTo}}, or
|
||||||
|
* {@code null} when nothing is missing
|
||||||
|
*/
|
||||||
|
static long[] findMissingRange(
|
||||||
|
List<WinTestLogSegment> segments,
|
||||||
|
NavigableSet<Long> receivedQsoNumbers
|
||||||
|
) {
|
||||||
|
if (segments == null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
long remainingScanBudget = MAX_SCANNED_QSO_NUMBERS;
|
||||||
|
|
||||||
|
for (WinTestLogSegment segment : segments) {
|
||||||
|
for (long qsoNumber = segment.getCountFrom();
|
||||||
|
qsoNumber <= segment.getCountTo();
|
||||||
|
qsoNumber++) {
|
||||||
|
|
||||||
|
remainingScanBudget--;
|
||||||
|
if (remainingScanBudget < 0L) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (receivedQsoNumbers != null && receivedQsoNumbers.contains(qsoNumber)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
long countFrom = qsoNumber;
|
||||||
|
long countTo = countFrom;
|
||||||
|
|
||||||
|
while (countTo < segment.getCountTo()
|
||||||
|
&& countTo - countFrom + 1L < MAX_QSOS_PER_REQUEST
|
||||||
|
&& (receivedQsoNumbers == null || !receivedQsoNumbers.contains(countTo + 1L))) {
|
||||||
|
countTo++;
|
||||||
|
}
|
||||||
|
|
||||||
|
return new long[] { countFrom, countTo };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Requests the next fixed block of a log whose station never sent a usable
|
||||||
|
* inventory.
|
||||||
|
*
|
||||||
|
* @param now current time in milliseconds
|
||||||
|
* @return {@code true} when a request was sent
|
||||||
|
*/
|
||||||
|
private boolean requestNextBlindBlock(long now) {
|
||||||
|
if (usableInventorySeen || firstStationSeenAtMs == 0L) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (now - firstStationSeenAtMs < INVENTORY_GRACE_PERIOD_MS) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
for (String logId : new ArrayList<>(receivedQsoNumbersByLogId.keySet())) {
|
||||||
|
BlindScan blindScan = blindScansByLogId.computeIfAbsent(logId, key -> new BlindScan());
|
||||||
|
|
||||||
|
if (blindScan.completed || blindScan.requestedBlockCount >= MAX_BLIND_BLOCKS) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
String targetStation = resolveStationForLogId(logId);
|
||||||
|
if (targetStation == null) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
blindScan.requestedBlockCount++;
|
||||||
|
sendRequest(
|
||||||
|
targetStation,
|
||||||
|
logId,
|
||||||
|
blindScan.nextCountFrom,
|
||||||
|
blindScan.nextCountFrom + MAX_QSOS_PER_REQUEST - 1L,
|
||||||
|
true,
|
||||||
|
now
|
||||||
|
);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
private void finishBlindBlock(PendingRequest finishedRequest) {
|
||||||
|
BlindScan blindScan = blindScansByLogId.get(finishedRequest.logId);
|
||||||
|
if (blindScan == null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
System.out.println("[WinTest LogSync] blind block " + finishedRequest.countFrom
|
||||||
|
+ "-" + finishedRequest.countTo + " of " + finishedRequest.logId
|
||||||
|
+ " answered with " + finishedRequest.answeredQsoCount + " QSOs");
|
||||||
|
|
||||||
|
if (finishedRequest.answeredQsoCount == 0) {
|
||||||
|
// the log ends before this block, nothing left to fetch
|
||||||
|
blindScan.completed = true;
|
||||||
|
} else {
|
||||||
|
blindScan.nextCountFrom = finishedRequest.countTo + 1L;
|
||||||
|
}
|
||||||
|
|
||||||
|
tickDueImmediately = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolves the Win-Test station a log belongs to. The log identity carries
|
||||||
|
* the owning station name in front of the {@code @} separator.
|
||||||
|
*
|
||||||
|
* @param logId log identity
|
||||||
|
* @return station name to ask, or {@code null} when none is known
|
||||||
|
*/
|
||||||
|
private String resolveStationForLogId(String logId) {
|
||||||
|
int separatorIndex = logId.indexOf('@');
|
||||||
|
String ownerStationName = separatorIndex > 0 ? logId.substring(0, separatorIndex) : logId;
|
||||||
|
|
||||||
|
for (String stationName : inventoriesByStation.keySet()) {
|
||||||
|
if (stationName.equalsIgnoreCase(ownerStationName)) {
|
||||||
|
return stationName;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return ownerStationName.isBlank() ? null : ownerStationName;
|
||||||
|
}
|
||||||
|
|
||||||
|
private void sendRequest(
|
||||||
|
String targetStation,
|
||||||
|
String logId,
|
||||||
|
long countFrom,
|
||||||
|
long countTo,
|
||||||
|
boolean blind,
|
||||||
|
long now
|
||||||
|
) {
|
||||||
|
pendingRequest = new PendingRequest(targetStation, logId, countFrom, countTo, blind, now);
|
||||||
|
state = SyncState.SYNCING;
|
||||||
|
|
||||||
|
try {
|
||||||
|
needQsoSender.sendNeedQso(targetStation, logId, countFrom, countTo);
|
||||||
|
} catch (RuntimeException exception) {
|
||||||
|
/*
|
||||||
|
* A failed transmission must not stop the receive loop. The pending
|
||||||
|
* request runs into its timeout and is retried from there.
|
||||||
|
*/
|
||||||
|
System.out.println(
|
||||||
|
"[WinTest LogSync] NEEDQSO could not be sent: " + exception.getMessage()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private String resolveOwnStationName() {
|
||||||
|
if (ownStationNameSupplier == null) {
|
||||||
|
return "";
|
||||||
|
}
|
||||||
|
|
||||||
|
String ownStationName = ownStationNameSupplier.get();
|
||||||
|
return ownStationName == null ? "" : ownStationName.trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Request that is waiting for its answer. */
|
||||||
|
private static final class PendingRequest {
|
||||||
|
|
||||||
|
private final String targetStation;
|
||||||
|
private final String logId;
|
||||||
|
private final long countFrom;
|
||||||
|
private final long countTo;
|
||||||
|
private final boolean blind;
|
||||||
|
private final long sentAtMs;
|
||||||
|
private int answeredQsoCount;
|
||||||
|
|
||||||
|
private PendingRequest(
|
||||||
|
String targetStation,
|
||||||
|
String logId,
|
||||||
|
long countFrom,
|
||||||
|
long countTo,
|
||||||
|
boolean blind,
|
||||||
|
long sentAtMs
|
||||||
|
) {
|
||||||
|
this.targetStation = targetStation;
|
||||||
|
this.logId = logId;
|
||||||
|
this.countFrom = countFrom;
|
||||||
|
this.countTo = countTo;
|
||||||
|
this.blind = blind;
|
||||||
|
this.sentAtMs = sentAtMs;
|
||||||
|
}
|
||||||
|
|
||||||
|
private long getRequestedQsoCount() {
|
||||||
|
return countTo - countFrom + 1L;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Progress of the blind fallback for one log. */
|
||||||
|
private static final class BlindScan {
|
||||||
|
private long nextCountFrom = 1L;
|
||||||
|
private int requestedBlockCount;
|
||||||
|
private boolean completed;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -17,8 +17,10 @@ import java.nio.charset.StandardCharsets;
|
|||||||
*/
|
*/
|
||||||
public class WinTestMessage {
|
public class WinTestMessage {
|
||||||
|
|
||||||
/** Win-Test message types relevant for SKED management. */
|
/** Win-Test message types sent by KST4Contest. */
|
||||||
public enum MessageType {
|
public enum MessageType {
|
||||||
|
/** Requests a range of QSOs of one Win-Test log for log synchronization. */
|
||||||
|
NEEDQSO,
|
||||||
LOCKSKED,
|
LOCKSKED,
|
||||||
UNLOCKSKED,
|
UNLOCKSKED,
|
||||||
ADDSKED,
|
ADDSKED,
|
||||||
|
|||||||
@@ -0,0 +1,227 @@
|
|||||||
|
package kst4contest.controller;
|
||||||
|
|
||||||
|
import java.net.Inet4Address;
|
||||||
|
import java.net.InetAddress;
|
||||||
|
import java.net.InterfaceAddress;
|
||||||
|
import java.net.NetworkInterface;
|
||||||
|
import java.net.SocketException;
|
||||||
|
import java.net.UnknownHostException;
|
||||||
|
import java.util.Enumeration;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determines the broadcast address used to talk to the Win-Test network.
|
||||||
|
*
|
||||||
|
* <p>Win-Test only reacts to broadcast packets; a unicast request to the same
|
||||||
|
* station stays unanswered. The configured broadcast address is therefore the
|
||||||
|
* one setting that silently disables every outgoing Win-Test feature when it is
|
||||||
|
* wrong: sending to an address outside the local networks succeeds without an
|
||||||
|
* error and the packet is routed away.</p>
|
||||||
|
*
|
||||||
|
* <p>Incoming Win-Test packets carry the information that is actually needed.
|
||||||
|
* The source address of a received packet identifies the network the station
|
||||||
|
* lives in, so the broadcast address of the matching local interface reaches it
|
||||||
|
* reliably. The configured address remains the fallback and keeps working for a
|
||||||
|
* station behind a router, where no local interface matches.</p>
|
||||||
|
*/
|
||||||
|
public class WinTestNetworkAddressResolver {
|
||||||
|
|
||||||
|
/** Last resort when neither a station nor a usable setting is available. */
|
||||||
|
private static final String LIMITED_BROADCAST_ADDRESS = "255.255.255.255";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolves the local broadcast address for a remote address.
|
||||||
|
*/
|
||||||
|
@FunctionalInterface
|
||||||
|
public interface LocalBroadcastLookup {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param remoteAddress address a Win-Test packet was received from
|
||||||
|
* @return broadcast address of the matching local interface, or
|
||||||
|
* {@code null} when no local interface serves that network
|
||||||
|
*/
|
||||||
|
InetAddress findBroadcastFor(InetAddress remoteAddress);
|
||||||
|
}
|
||||||
|
|
||||||
|
private final LocalBroadcastLookup localBroadcastLookup;
|
||||||
|
|
||||||
|
private volatile InetAddress lastStationAddress;
|
||||||
|
|
||||||
|
private volatile String lastReportedBroadcastAddress;
|
||||||
|
|
||||||
|
public WinTestNetworkAddressResolver() {
|
||||||
|
this(WinTestNetworkAddressResolver::findLocalBroadcastAddress);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param localBroadcastLookup interface lookup, replaceable for tests
|
||||||
|
*/
|
||||||
|
WinTestNetworkAddressResolver(LocalBroadcastLookup localBroadcastLookup) {
|
||||||
|
this.localBroadcastLookup = localBroadcastLookup;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remembers where Win-Test packets come from.
|
||||||
|
*
|
||||||
|
* <p>Only addresses of real Win-Test stations may be passed in. Loopback and
|
||||||
|
* wildcard addresses are ignored, so an internal control packet cannot
|
||||||
|
* redirect outgoing Win-Test traffic.</p>
|
||||||
|
*
|
||||||
|
* @param stationAddress source address of a received Win-Test packet
|
||||||
|
*/
|
||||||
|
public void rememberStationAddress(InetAddress stationAddress) {
|
||||||
|
if (stationAddress == null
|
||||||
|
|| stationAddress.isLoopbackAddress()
|
||||||
|
|| stationAddress.isAnyLocalAddress()
|
||||||
|
|| !(stationAddress instanceof Inet4Address)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.lastStationAddress = stationAddress;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determines the broadcast address for outgoing Win-Test packets.
|
||||||
|
*
|
||||||
|
* <p>Order of preference: the broadcast address of the local interface that
|
||||||
|
* serves the last seen Win-Test station, then the configured address, then
|
||||||
|
* the limited broadcast address.</p>
|
||||||
|
*
|
||||||
|
* @param configuredBroadcastAddress address from the settings, may be blank
|
||||||
|
* @return address to send Win-Test packets to
|
||||||
|
* @throws UnknownHostException if the configured address cannot be resolved
|
||||||
|
* and the limited broadcast address fails too
|
||||||
|
*/
|
||||||
|
public InetAddress resolveBroadcastAddress(String configuredBroadcastAddress)
|
||||||
|
throws UnknownHostException {
|
||||||
|
|
||||||
|
InetAddress stationAddress = this.lastStationAddress;
|
||||||
|
|
||||||
|
if (stationAddress != null) {
|
||||||
|
InetAddress derivedBroadcastAddress =
|
||||||
|
localBroadcastLookup.findBroadcastFor(stationAddress);
|
||||||
|
|
||||||
|
if (derivedBroadcastAddress != null) {
|
||||||
|
reportDerivedAddress(derivedBroadcastAddress, configuredBroadcastAddress);
|
||||||
|
return derivedBroadcastAddress;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (configuredBroadcastAddress != null && !configuredBroadcastAddress.isBlank()) {
|
||||||
|
return InetAddress.getByName(configuredBroadcastAddress.trim());
|
||||||
|
}
|
||||||
|
|
||||||
|
return InetAddress.getByName(LIMITED_BROADCAST_ADDRESS);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Logs a derived address once as long as it stays the same, and points out
|
||||||
|
* a configured address that does not match the Win-Test network.
|
||||||
|
*/
|
||||||
|
private void reportDerivedAddress(
|
||||||
|
InetAddress derivedBroadcastAddress,
|
||||||
|
String configuredBroadcastAddress
|
||||||
|
) {
|
||||||
|
String derivedHostAddress = derivedBroadcastAddress.getHostAddress();
|
||||||
|
|
||||||
|
if (derivedHostAddress.equals(lastReportedBroadcastAddress)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
lastReportedBroadcastAddress = derivedHostAddress;
|
||||||
|
|
||||||
|
String configuredHostAddress = configuredBroadcastAddress == null
|
||||||
|
? "" : configuredBroadcastAddress.trim();
|
||||||
|
|
||||||
|
if (derivedHostAddress.equals(configuredHostAddress)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
System.out.println("[WinTest] using broadcast address " + derivedHostAddress
|
||||||
|
+ " of the network Win-Test was heard on, configured is '"
|
||||||
|
+ configuredHostAddress + "'");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Searches the local interfaces for the network a remote address belongs to.
|
||||||
|
*
|
||||||
|
* @param remoteAddress address of a Win-Test station
|
||||||
|
* @return broadcast address of the matching interface, or {@code null}
|
||||||
|
*/
|
||||||
|
static InetAddress findLocalBroadcastAddress(InetAddress remoteAddress) {
|
||||||
|
if (!(remoteAddress instanceof Inet4Address)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
Enumeration<NetworkInterface> networkInterfaces =
|
||||||
|
NetworkInterface.getNetworkInterfaces();
|
||||||
|
|
||||||
|
while (networkInterfaces != null && networkInterfaces.hasMoreElements()) {
|
||||||
|
NetworkInterface networkInterface = networkInterfaces.nextElement();
|
||||||
|
|
||||||
|
for (InterfaceAddress interfaceAddress : networkInterface.getInterfaceAddresses()) {
|
||||||
|
InetAddress broadcastAddress = interfaceAddress.getBroadcast();
|
||||||
|
|
||||||
|
if (broadcastAddress == null
|
||||||
|
|| !(interfaceAddress.getAddress() instanceof Inet4Address)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isInSameSubnet(
|
||||||
|
interfaceAddress.getAddress(),
|
||||||
|
remoteAddress,
|
||||||
|
interfaceAddress.getNetworkPrefixLength())) {
|
||||||
|
return broadcastAddress;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (SocketException exception) {
|
||||||
|
System.out.println("[WinTest] could not inspect local interfaces: "
|
||||||
|
+ exception.getMessage());
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Compares two IPv4 addresses up to the given network prefix length.
|
||||||
|
*
|
||||||
|
* @param localAddress address of a local interface
|
||||||
|
* @param remoteAddress address of the Win-Test station
|
||||||
|
* @param networkPrefixLength prefix length of the local interface
|
||||||
|
* @return {@code true} when both addresses share the same network
|
||||||
|
*/
|
||||||
|
static boolean isInSameSubnet(
|
||||||
|
InetAddress localAddress,
|
||||||
|
InetAddress remoteAddress,
|
||||||
|
int networkPrefixLength
|
||||||
|
) {
|
||||||
|
if (localAddress == null || remoteAddress == null) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
byte[] localBytes = localAddress.getAddress();
|
||||||
|
byte[] remoteBytes = remoteAddress.getAddress();
|
||||||
|
|
||||||
|
if (localBytes.length != remoteBytes.length
|
||||||
|
|| networkPrefixLength < 0
|
||||||
|
|| networkPrefixLength > localBytes.length * 8) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
int remainingPrefixBits = networkPrefixLength;
|
||||||
|
|
||||||
|
for (int byteIndex = 0; byteIndex < localBytes.length && remainingPrefixBits > 0; byteIndex++) {
|
||||||
|
int comparedBits = Math.min(8, remainingPrefixBits);
|
||||||
|
int mask = (0xFF << (8 - comparedBits)) & 0xFF;
|
||||||
|
|
||||||
|
if ((localBytes[byteIndex] & mask) != (remoteBytes[byteIndex] & mask)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
remainingPrefixBits -= comparedBits;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,238 @@
|
|||||||
|
package kst4contest.controller;
|
||||||
|
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.regex.Matcher;
|
||||||
|
import java.util.regex.Pattern;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Win-Test network packet received over UDP.
|
||||||
|
*
|
||||||
|
* <p>This is the receiving counterpart of {@link WinTestMessage} and follows the
|
||||||
|
* same framing:</p>
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
|
* MESSAGETYPE: "src" "dst" data{checksum}\0
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* <p>The checksum byte always has bit 7 set and is therefore not valid ASCII.
|
||||||
|
* Decoding the datagram as text before removing it turns the byte into a
|
||||||
|
* replacement character that sticks to the last data field. That is harmless
|
||||||
|
* for fields KST4Contest never reads, but the log synchronization needs exactly
|
||||||
|
* those trailing fields: the log ID of an {@code ADDQSO} packet and the
|
||||||
|
* run-length inventory of an {@code IHAVE} packet. The framing is therefore
|
||||||
|
* resolved on the raw bytes here, once, before any text parsing.</p>
|
||||||
|
*/
|
||||||
|
public final class WinTestPacket {
|
||||||
|
|
||||||
|
/** Quoted values stay one token, unquoted values are split at whitespace. */
|
||||||
|
private static final Pattern TOKEN_PATTERN = Pattern.compile("\"([^\"]*)\"|(\\S+)");
|
||||||
|
|
||||||
|
private final String messageType;
|
||||||
|
private final String source;
|
||||||
|
private final String destination;
|
||||||
|
private final String messageText;
|
||||||
|
private final List<String> dataTokens;
|
||||||
|
private final boolean checksumPresent;
|
||||||
|
private final boolean checksumValid;
|
||||||
|
|
||||||
|
private WinTestPacket(
|
||||||
|
String messageType,
|
||||||
|
String source,
|
||||||
|
String destination,
|
||||||
|
String messageText,
|
||||||
|
List<String> dataTokens,
|
||||||
|
boolean checksumPresent,
|
||||||
|
boolean checksumValid
|
||||||
|
) {
|
||||||
|
this.messageType = messageType;
|
||||||
|
this.source = source;
|
||||||
|
this.destination = destination;
|
||||||
|
this.messageText = messageText;
|
||||||
|
this.dataTokens = dataTokens;
|
||||||
|
this.checksumPresent = checksumPresent;
|
||||||
|
this.checksumValid = checksumValid;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds a packet from a received datagram.
|
||||||
|
*
|
||||||
|
* <p>Trailing NUL bytes are removed first. If the resulting last byte has
|
||||||
|
* bit 7 set it is the Win-Test checksum: it is verified against the sum of
|
||||||
|
* all preceding bytes and removed before the message text is decoded.</p>
|
||||||
|
*
|
||||||
|
* @param datagram raw datagram buffer
|
||||||
|
* @param length number of valid bytes in the buffer
|
||||||
|
* @return parsed packet, or {@code null} when the datagram carries no message
|
||||||
|
*/
|
||||||
|
public static WinTestPacket fromDatagram(byte[] datagram, int length) {
|
||||||
|
if (datagram == null || length <= 0 || length > datagram.length) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
int endIndex = length;
|
||||||
|
while (endIndex > 0 && datagram[endIndex - 1] == 0) {
|
||||||
|
endIndex--;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (endIndex == 0) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
boolean hasChecksum = (datagram[endIndex - 1] & 0x80) != 0;
|
||||||
|
boolean isChecksumValid = false;
|
||||||
|
int textEndIndex = endIndex;
|
||||||
|
|
||||||
|
if (hasChecksum) {
|
||||||
|
int sum = 0;
|
||||||
|
for (int index = 0; index < endIndex - 1; index++) {
|
||||||
|
sum += datagram[index] & 0xFF;
|
||||||
|
}
|
||||||
|
byte expectedChecksum = (byte) ((sum | 0x80) & 0xFF);
|
||||||
|
isChecksumValid = expectedChecksum == datagram[endIndex - 1];
|
||||||
|
textEndIndex = endIndex - 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
String text = new String(datagram, 0, textEndIndex, StandardCharsets.US_ASCII);
|
||||||
|
return fromMessageText(text, hasChecksum, isChecksumValid);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds a packet from an already decoded message text without checksum
|
||||||
|
* information. Used for messages that reach the listener as text.
|
||||||
|
*
|
||||||
|
* @param messageText complete message text
|
||||||
|
* @return parsed packet, or {@code null} for an unusable message
|
||||||
|
*/
|
||||||
|
public static WinTestPacket fromMessageText(String messageText) {
|
||||||
|
return fromMessageText(messageText, false, false);
|
||||||
|
}
|
||||||
|
|
||||||
|
private static WinTestPacket fromMessageText(
|
||||||
|
String rawMessageText,
|
||||||
|
boolean checksumPresent,
|
||||||
|
boolean checksumValid
|
||||||
|
) {
|
||||||
|
if (rawMessageText == null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
String text = rawMessageText.trim();
|
||||||
|
int typeEndIndex = text.indexOf(": ");
|
||||||
|
if (typeEndIndex <= 0) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
String type = text.substring(0, typeEndIndex);
|
||||||
|
List<String> tokens = tokenize(text.substring(typeEndIndex + 2));
|
||||||
|
|
||||||
|
String packetSource = tokens.isEmpty() ? "" : tokens.get(0);
|
||||||
|
String packetDestination = tokens.size() > 1 ? tokens.get(1) : "";
|
||||||
|
List<String> data = tokens.size() > 2
|
||||||
|
? new ArrayList<>(tokens.subList(2, tokens.size()))
|
||||||
|
: new ArrayList<>();
|
||||||
|
|
||||||
|
return new WinTestPacket(
|
||||||
|
type,
|
||||||
|
packetSource,
|
||||||
|
packetDestination,
|
||||||
|
text,
|
||||||
|
data,
|
||||||
|
checksumPresent,
|
||||||
|
checksumValid
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Splits Win-Test payload text into fields. Quoted values are kept together
|
||||||
|
* and empty quoted values are preserved, so field positions stay stable.
|
||||||
|
*
|
||||||
|
* @param text payload text
|
||||||
|
* @return field values without their surrounding quotes
|
||||||
|
*/
|
||||||
|
static List<String> tokenize(String text) {
|
||||||
|
List<String> tokens = new ArrayList<>();
|
||||||
|
if (text == null) {
|
||||||
|
return tokens;
|
||||||
|
}
|
||||||
|
|
||||||
|
Matcher matcher = TOKEN_PATTERN.matcher(text);
|
||||||
|
while (matcher.find()) {
|
||||||
|
tokens.add(matcher.group(1) != null ? matcher.group(1) : matcher.group(2));
|
||||||
|
}
|
||||||
|
return tokens;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return message type such as {@code ADDQSO}, never {@code null}
|
||||||
|
*/
|
||||||
|
public String getMessageType() {
|
||||||
|
return messageType;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return Win-Test station that sent the packet
|
||||||
|
*/
|
||||||
|
public String getSource() {
|
||||||
|
return source;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return addressed Win-Test station, empty for a broadcast
|
||||||
|
*/
|
||||||
|
public String getDestination() {
|
||||||
|
return destination;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return complete message text without checksum byte and NUL terminator
|
||||||
|
*/
|
||||||
|
public String getMessageText() {
|
||||||
|
return messageText;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return payload fields following source and destination
|
||||||
|
*/
|
||||||
|
public List<String> getDataTokens() {
|
||||||
|
return Collections.unmodifiableList(dataTokens);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param index payload field position
|
||||||
|
* @return field value, or {@code null} when the field is missing
|
||||||
|
*/
|
||||||
|
public String getDataToken(int index) {
|
||||||
|
return index >= 0 && index < dataTokens.size() ? dataTokens.get(index) : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
public boolean isChecksumPresent() {
|
||||||
|
return checksumPresent;
|
||||||
|
}
|
||||||
|
|
||||||
|
public boolean isChecksumValid() {
|
||||||
|
return checksumValid;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether this packet is meant for us.
|
||||||
|
*
|
||||||
|
* @param ownStationName own Win-Test station name
|
||||||
|
* @return {@code true} for a broadcast or for a packet addressed to us
|
||||||
|
*/
|
||||||
|
public boolean isAddressedTo(String ownStationName) {
|
||||||
|
if (destination == null || destination.isEmpty()) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return ownStationName != null && destination.equalsIgnoreCase(ownStationName.trim());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return messageType + ": src=" + source + " dst=" + destination
|
||||||
|
+ " fields=" + dataTokens.size()
|
||||||
|
+ (checksumPresent ? (checksumValid ? " checksum=ok" : " checksum=bad") : " checksum=none");
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -148,7 +148,7 @@ public class ChatPreferences {
|
|||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
String programVersion = "Chat is powered by ON4KST \n\nUsage is free. You are welcome to support: \n\n- my project (donations, bugreports, good ideas are welcome), \n- ON4KST Servers, \n- AirScout developers and \n- OV3T (best AS-data provider of the world). \n\n73 de DO5AMF, Marc (DM5M / DARC X08)";
|
String programVersion = "Chat is powered by ON4KST \n\nUsage is free. You are welcome to support: \n\n- my project (donations, bugreports, good ideas are welcome), \n- ON4KST Servers, \n- AirScout developers and \n- OV3T (best AS-data provider of the world). \n\n73 de DO5AMF, Marc (DM5M / DARC X08)\nand DN9APW, Philipp Wagner";
|
||||||
String logsynch_storeWorkedCallSignsFileNameUDPMessageBackup = "udpReaderBackup.txt";
|
String logsynch_storeWorkedCallSignsFileNameUDPMessageBackup = "udpReaderBackup.txt";
|
||||||
String storeAndRestorePreferencesFileName = ApplicationFileUtils.getFilePath(ApplicationConstants.APPLICATION_NAME, PREFERENCES_FILE);
|
String storeAndRestorePreferencesFileName = ApplicationFileUtils.getFilePath(ApplicationConstants.APPLICATION_NAME, PREFERENCES_FILE);
|
||||||
String chatState; // working variable only for use by primarystage (title bar)
|
String chatState; // working variable only for use by primarystage (title bar)
|
||||||
|
|||||||
@@ -5753,7 +5753,8 @@ public class Kst4ContestApplication extends Application implements StatusUpdateL
|
|||||||
Alert a = new Alert(AlertType.INFORMATION);
|
Alert a = new Alert(AlertType.INFORMATION);
|
||||||
|
|
||||||
a.setTitle("About kst4contest");
|
a.setTitle("About kst4contest");
|
||||||
a.setHeaderText("kst4Contest " + ApplicationConstants.APPLICATION_CURRENT_VERSION + ": ON4KST Chatclient by DO5AMF");
|
a.setHeaderText("kst4Contest " + ApplicationConstants.APPLICATION_CURRENT_VERSION
|
||||||
|
+ ": ON4KST Chatclient by DO5AMF and DN9APW");
|
||||||
a.setContentText(chatcontroller.getChatPreferences().getProgramVersion());
|
a.setContentText(chatcontroller.getChatPreferences().getProgramVersion());
|
||||||
a.show();
|
a.show();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,46 +3,63 @@ package kst4contest.controller;
|
|||||||
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
|
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
|
||||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertNull;
|
||||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||||
|
|
||||||
|
import java.io.OutputStreamWriter;
|
||||||
|
import java.lang.reflect.Field;
|
||||||
import java.net.ServerSocket;
|
import java.net.ServerSocket;
|
||||||
import java.net.Socket;
|
import java.net.Socket;
|
||||||
import java.nio.charset.StandardCharsets;
|
import java.nio.charset.StandardCharsets;
|
||||||
import java.time.Duration;
|
import java.time.Duration;
|
||||||
import java.util.concurrent.CompletableFuture;
|
import java.util.concurrent.CompletableFuture;
|
||||||
|
import java.util.concurrent.CountDownLatch;
|
||||||
import java.util.concurrent.LinkedBlockingQueue;
|
import java.util.concurrent.LinkedBlockingQueue;
|
||||||
import java.util.concurrent.TimeUnit;
|
import java.util.concurrent.TimeUnit;
|
||||||
import java.util.concurrent.atomic.AtomicBoolean;
|
import java.util.concurrent.atomic.AtomicBoolean;
|
||||||
|
import java.util.concurrent.atomic.AtomicLong;
|
||||||
|
|
||||||
import org.junit.jupiter.api.Test;
|
import org.junit.jupiter.api.Test;
|
||||||
import org.junit.jupiter.api.Timeout;
|
import org.junit.jupiter.api.Timeout;
|
||||||
|
|
||||||
|
import kst4contest.model.ChatCategory;
|
||||||
import kst4contest.model.ChatMessage;
|
import kst4contest.model.ChatMessage;
|
||||||
|
import kst4contest.model.ChatPreferences;
|
||||||
|
|
||||||
class On4KstConnectionProbeTest {
|
class On4KstConnectionProbeTest {
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
void buildsMainChatProbeAndAcceptsExpectedResponse() {
|
void separatesClientProbeServerProbeAndInternalResponses() {
|
||||||
assertEquals("RDXQ|2|", On4KstProtocol.connectionProbe(2));
|
assertEquals("CK|", On4KstProtocol.clientLivenessProbe());
|
||||||
assertTrue(On4KstProtocol.isConnectionProbeResponse("DXQ|2|data|"));
|
assertTrue(On4KstProtocol.isClientLivenessProbeResponse("OK"));
|
||||||
assertFalse(On4KstProtocol.isConnectionProbeResponse(
|
assertTrue(On4KstProtocol.isClientLivenessProbeResponse("OK|"));
|
||||||
"CH|2|123|DL1ABC|Name|0|text|0|"));
|
assertFalse(On4KstProtocol.isClientLivenessProbeResponse(
|
||||||
|
"OK|unexpected|"));
|
||||||
|
assertTrue(On4KstProtocol.isServerLivenessProbe("CK|"));
|
||||||
|
assertEquals("", On4KstProtocol.serverLivenessProbeResponse());
|
||||||
|
assertTrue(On4KstProtocol.isInternalDxqResponse("DXQ|2|data|"));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
void selectsHeartbeatProbeAndTimeoutAtIdleBoundaries() {
|
void selectsOneClientProbeAndTimeoutAtIdleBoundaries() {
|
||||||
assertEquals(
|
assertEquals(
|
||||||
On4KstConnectionManager.IdleAction.NONE,
|
On4KstConnectionManager.IdleAction.NONE,
|
||||||
idleAction(90_000L, false, false));
|
idleAction(90_000L, true, false));
|
||||||
assertEquals(
|
|
||||||
On4KstConnectionManager.IdleAction.HEARTBEAT,
|
|
||||||
idleAction(90_001L, false, false));
|
|
||||||
assertEquals(
|
assertEquals(
|
||||||
On4KstConnectionManager.IdleAction.NONE,
|
On4KstConnectionManager.IdleAction.NONE,
|
||||||
idleAction(179_999L, true, false));
|
idleAction(90_001L, false, false),
|
||||||
|
"No client probe may be sent before the session is online");
|
||||||
assertEquals(
|
assertEquals(
|
||||||
On4KstConnectionManager.IdleAction.CONNECTION_PROBE,
|
On4KstConnectionManager.IdleAction.CLIENT_LIVENESS_PROBE,
|
||||||
idleAction(180_000L, true, false));
|
idleAction(90_001L, true, false));
|
||||||
|
assertEquals(
|
||||||
|
On4KstConnectionManager.IdleAction.NONE,
|
||||||
|
idleAction(180_000L, true, true),
|
||||||
|
"The 90-second CK remains the only probe in this idle phase");
|
||||||
|
assertEquals(
|
||||||
|
On4KstConnectionManager.IdleAction.CLIENT_LIVENESS_PROBE,
|
||||||
|
idleAction(180_000L, true, false),
|
||||||
|
"Even without probe state, the only 180-second action is CK");
|
||||||
assertEquals(
|
assertEquals(
|
||||||
On4KstConnectionManager.IdleAction.NONE,
|
On4KstConnectionManager.IdleAction.NONE,
|
||||||
idleAction(210_000L, true, true));
|
idleAction(210_000L, true, true));
|
||||||
@@ -52,9 +69,9 @@ class On4KstConnectionProbeTest {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
void oneSessionProbeIsAcknowledgedByAnyInboundTraffic() {
|
void sessionProbeCoversTwoCategoriesAndRepeatedIdlePhases() {
|
||||||
On4KstConnectionManager.ConnectionProbeState probe =
|
On4KstConnectionManager.ClientLivenessProbeState probe =
|
||||||
new On4KstConnectionManager.ConnectionProbeState();
|
new On4KstConnectionManager.ClientLivenessProbeState();
|
||||||
|
|
||||||
assertTrue(probe.tryStart(1_000L));
|
assertTrue(probe.tryStart(1_000L));
|
||||||
assertFalse(probe.tryStart(1_001L),
|
assertFalse(probe.tryStart(1_001L),
|
||||||
@@ -71,8 +88,8 @@ class On4KstConnectionProbeTest {
|
|||||||
|
|
||||||
@Test
|
@Test
|
||||||
@Timeout(5)
|
@Timeout(5)
|
||||||
void writerUsesExactCrLfForHeartbeatAndConnectionProbe() throws Exception {
|
void writerUsesExactBytesForClientAndServerLivenessFrames() throws Exception {
|
||||||
byte[] expected = "\r\nRDXQ|2|\r\n".getBytes(StandardCharsets.UTF_8);
|
byte[] expected = "CK|\r\n\r\n".getBytes(StandardCharsets.UTF_8);
|
||||||
|
|
||||||
try (ServerSocket server = new ServerSocket(0)) {
|
try (ServerSocket server = new ServerSocket(0)) {
|
||||||
CompletableFuture<byte[]> received = CompletableFuture.supplyAsync(() -> {
|
CompletableFuture<byte[]> received = CompletableFuture.supplyAsync(() -> {
|
||||||
@@ -98,8 +115,9 @@ class On4KstConnectionProbeTest {
|
|||||||
ignored -> { });
|
ignored -> { });
|
||||||
writer.start();
|
writer.start();
|
||||||
|
|
||||||
queue.add(serverFrame(""));
|
queue.add(serverFrame(On4KstProtocol.clientLivenessProbe()));
|
||||||
queue.add(serverFrame(On4KstProtocol.connectionProbe(2)));
|
queue.add(serverFrame(
|
||||||
|
On4KstProtocol.serverLivenessProbeResponse()));
|
||||||
|
|
||||||
assertArrayEquals(
|
assertArrayEquals(
|
||||||
expected,
|
expected,
|
||||||
@@ -112,14 +130,153 @@ class On4KstConnectionProbeTest {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
@Timeout(5)
|
||||||
|
void readerRecordsOkAsActivityWithoutPublishingIt() throws Exception {
|
||||||
|
CountDownLatch releaseChatFrame = new CountDownLatch(1);
|
||||||
|
String chatFrame = "CH|2|123|DL1ABC|Name|0|text|0|";
|
||||||
|
|
||||||
|
try (ServerSocket server = new ServerSocket(0)) {
|
||||||
|
CompletableFuture<Void> serverDone = CompletableFuture.runAsync(() -> {
|
||||||
|
try (Socket accepted = server.accept();
|
||||||
|
OutputStreamWriter out = new OutputStreamWriter(
|
||||||
|
accepted.getOutputStream(), StandardCharsets.UTF_8)) {
|
||||||
|
out.write("OK|\r\n");
|
||||||
|
out.flush();
|
||||||
|
releaseChatFrame.await(2, TimeUnit.SECONDS);
|
||||||
|
out.write(chatFrame + "\r\n");
|
||||||
|
out.flush();
|
||||||
|
} catch (Exception exception) {
|
||||||
|
throw new RuntimeException(exception);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
try (Socket client = new Socket("127.0.0.1", server.getLocalPort())) {
|
||||||
|
LinkedBlockingQueue<ChatMessage> messages =
|
||||||
|
new LinkedBlockingQueue<>();
|
||||||
|
LinkedBlockingQueue<String> activity =
|
||||||
|
new LinkedBlockingQueue<>();
|
||||||
|
AtomicBoolean active = new AtomicBoolean(true);
|
||||||
|
ReadThread reader = new ReadThread(
|
||||||
|
21L,
|
||||||
|
client,
|
||||||
|
messages,
|
||||||
|
ignored -> active.get(),
|
||||||
|
activity::offer,
|
||||||
|
ignored -> { });
|
||||||
|
reader.start();
|
||||||
|
|
||||||
|
assertEquals("OK|", activity.poll(2, TimeUnit.SECONDS));
|
||||||
|
assertNull(messages.poll(200, TimeUnit.MILLISECONDS));
|
||||||
|
|
||||||
|
releaseChatFrame.countDown();
|
||||||
|
assertEquals(chatFrame,
|
||||||
|
messages.poll(2, TimeUnit.SECONDS).getMessageText());
|
||||||
|
|
||||||
|
active.set(false);
|
||||||
|
reader.join(Duration.ofSeconds(2).toMillis());
|
||||||
|
}
|
||||||
|
serverDone.get(2, TimeUnit.SECONDS);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
@Timeout(5)
|
||||||
|
void readerIgnoresDelayedResponseFromReplacedSession() throws Exception {
|
||||||
|
CountDownLatch releaseOldResponse = new CountDownLatch(1);
|
||||||
|
AtomicBoolean inboundCallbackUsed = new AtomicBoolean();
|
||||||
|
|
||||||
|
try (ServerSocket server = new ServerSocket(0)) {
|
||||||
|
CompletableFuture<Void> serverDone = CompletableFuture.runAsync(() -> {
|
||||||
|
try (Socket accepted = server.accept();
|
||||||
|
OutputStreamWriter out = new OutputStreamWriter(
|
||||||
|
accepted.getOutputStream(), StandardCharsets.UTF_8)) {
|
||||||
|
releaseOldResponse.await(2, TimeUnit.SECONDS);
|
||||||
|
out.write("OK\r\n");
|
||||||
|
out.flush();
|
||||||
|
} catch (Exception exception) {
|
||||||
|
throw new RuntimeException(exception);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
try (Socket client = new Socket("127.0.0.1", server.getLocalPort())) {
|
||||||
|
LinkedBlockingQueue<ChatMessage> messages =
|
||||||
|
new LinkedBlockingQueue<>();
|
||||||
|
AtomicBoolean active = new AtomicBoolean(true);
|
||||||
|
ReadThread reader = new ReadThread(
|
||||||
|
22L,
|
||||||
|
client,
|
||||||
|
messages,
|
||||||
|
ignored -> active.get(),
|
||||||
|
ignored -> inboundCallbackUsed.set(true),
|
||||||
|
ignored -> { });
|
||||||
|
reader.start();
|
||||||
|
|
||||||
|
active.set(false);
|
||||||
|
releaseOldResponse.countDown();
|
||||||
|
reader.join(Duration.ofSeconds(2).toMillis());
|
||||||
|
|
||||||
|
assertFalse(inboundCallbackUsed.get());
|
||||||
|
assertNull(messages.poll());
|
||||||
|
}
|
||||||
|
serverDone.get(2, TimeUnit.SECONDS);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
@Timeout(15)
|
||||||
|
void unansweredProbeUsesExistingReconnectFlow() throws Exception {
|
||||||
|
ChatPreferences preferences = localPreferences();
|
||||||
|
ChatController controller = org.mockito.Mockito.mock(
|
||||||
|
ChatController.class);
|
||||||
|
org.mockito.Mockito.when(controller.getChatPreferences())
|
||||||
|
.thenReturn(preferences);
|
||||||
|
org.mockito.Mockito.when(controller.getChatCategoryMain())
|
||||||
|
.thenReturn(preferences.getLoginChatCategoryMain());
|
||||||
|
org.mockito.Mockito.when(controller.getChatCategorySecondChat())
|
||||||
|
.thenReturn(preferences.getLoginChatCategorySecond());
|
||||||
|
|
||||||
|
try (ServerSocket server = new ServerSocket(0)) {
|
||||||
|
preferences.setStn_on4kstServersPort(server.getLocalPort());
|
||||||
|
CompletableFuture<Integer> acceptedConnections =
|
||||||
|
CompletableFuture.supplyAsync(() -> {
|
||||||
|
try (Socket first = server.accept();
|
||||||
|
Socket second = server.accept()) {
|
||||||
|
return 2;
|
||||||
|
} catch (Exception exception) {
|
||||||
|
throw new RuntimeException(exception);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
On4KstConnectionManager manager =
|
||||||
|
new On4KstConnectionManager(controller);
|
||||||
|
try {
|
||||||
|
manager.start();
|
||||||
|
awaitState(manager, On4KstConnectionState.AUTHENTICATING);
|
||||||
|
manager.onLogstat(1L, new String[] {"LOGSTAT", "100"});
|
||||||
|
awaitState(manager, On4KstConnectionState.SYNCING_MAIN_CHAT);
|
||||||
|
manager.onInitialUserListCompleted(1L,
|
||||||
|
preferences.getLoginChatCategoryMain());
|
||||||
|
awaitState(manager, On4KstConnectionState.ONLINE);
|
||||||
|
|
||||||
|
setTimedOutProbe(manager, System.currentTimeMillis());
|
||||||
|
|
||||||
|
awaitState(manager, On4KstConnectionState.RECONNECT_WAIT);
|
||||||
|
assertEquals(2, acceptedConnections.get(7, TimeUnit.SECONDS));
|
||||||
|
} finally {
|
||||||
|
manager.stopByUser();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
private On4KstConnectionManager.IdleAction idleAction(
|
private On4KstConnectionManager.IdleAction idleAction(
|
||||||
long inboundIdleMillis,
|
long inboundIdleMillis,
|
||||||
boolean heartbeatSent,
|
boolean online,
|
||||||
boolean probeOutstanding
|
boolean probeOutstanding
|
||||||
) {
|
) {
|
||||||
return On4KstConnectionManager.determineIdleAction(
|
return On4KstConnectionManager.determineIdleAction(
|
||||||
inboundIdleMillis,
|
inboundIdleMillis,
|
||||||
heartbeatSent,
|
online,
|
||||||
probeOutstanding);
|
probeOutstanding);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -129,4 +286,55 @@ class On4KstConnectionProbeTest {
|
|||||||
message.setMessageText(text);
|
message.setMessageText(text);
|
||||||
return message;
|
return message;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private ChatPreferences localPreferences() {
|
||||||
|
ChatPreferences preferences = new ChatPreferences();
|
||||||
|
preferences.setStn_on4kstServersDns("127.0.0.1");
|
||||||
|
preferences.setStn_loginCallSign("DL1ABC");
|
||||||
|
preferences.setStn_loginPassword("test-password");
|
||||||
|
preferences.setStn_loginNameMainCat("");
|
||||||
|
preferences.setStn_loginLocatorMainCat("JO50AA");
|
||||||
|
preferences.setLoginChatCategoryMain(new ChatCategory(2));
|
||||||
|
preferences.setLoginChatCategorySecond(new ChatCategory(3));
|
||||||
|
preferences.setLoginToSecondChatEnabled(false);
|
||||||
|
return preferences;
|
||||||
|
}
|
||||||
|
|
||||||
|
private void awaitState(
|
||||||
|
On4KstConnectionManager manager,
|
||||||
|
On4KstConnectionState expected
|
||||||
|
) throws InterruptedException {
|
||||||
|
long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(7L);
|
||||||
|
while (System.nanoTime() < deadline) {
|
||||||
|
if (manager.getState() == expected) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
TimeUnit.MILLISECONDS.sleep(25L);
|
||||||
|
}
|
||||||
|
assertEquals(expected, manager.getState());
|
||||||
|
}
|
||||||
|
|
||||||
|
private void setTimedOutProbe(
|
||||||
|
On4KstConnectionManager manager,
|
||||||
|
long now
|
||||||
|
) throws ReflectiveOperationException {
|
||||||
|
Field activeSession = On4KstConnectionManager.class
|
||||||
|
.getDeclaredField("activeSession");
|
||||||
|
activeSession.setAccessible(true);
|
||||||
|
Object session = activeSession.get(manager);
|
||||||
|
|
||||||
|
Field lastInboundMillis = session.getClass()
|
||||||
|
.getDeclaredField("lastInboundMillis");
|
||||||
|
lastInboundMillis.setAccessible(true);
|
||||||
|
((AtomicLong) lastInboundMillis.get(session)).set(
|
||||||
|
now - On4KstConnectionManager.INBOUND_STALE_AFTER_MILLIS - 1L);
|
||||||
|
|
||||||
|
Field clientLivenessProbe = session.getClass()
|
||||||
|
.getDeclaredField("clientLivenessProbe");
|
||||||
|
clientLivenessProbe.setAccessible(true);
|
||||||
|
((On4KstConnectionManager.ClientLivenessProbeState)
|
||||||
|
clientLivenessProbe.get(session)).tryStart(
|
||||||
|
now - On4KstConnectionManager
|
||||||
|
.CLIENT_LIVENESS_PROBE_AFTER_MILLIS);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,296 @@
|
|||||||
|
package kst4contest.controller;
|
||||||
|
|
||||||
|
import static org.junit.jupiter.api.Assertions.fail;
|
||||||
|
import static org.junit.jupiter.api.Assumptions.assumeTrue;
|
||||||
|
import static org.mockito.ArgumentMatchers.any;
|
||||||
|
import static org.mockito.ArgumentMatchers.anyBoolean;
|
||||||
|
import static org.mockito.ArgumentMatchers.anyLong;
|
||||||
|
import static org.mockito.ArgumentMatchers.anyString;
|
||||||
|
import static org.mockito.Mockito.doAnswer;
|
||||||
|
import static org.mockito.Mockito.doNothing;
|
||||||
|
import static org.mockito.Mockito.mock;
|
||||||
|
import static org.mockito.Mockito.when;
|
||||||
|
|
||||||
|
import java.time.Duration;
|
||||||
|
import java.time.ZonedDateTime;
|
||||||
|
import java.time.format.DateTimeFormatter;
|
||||||
|
import java.util.concurrent.LinkedBlockingQueue;
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
import java.util.concurrent.atomic.AtomicBoolean;
|
||||||
|
import java.util.concurrent.atomic.AtomicReference;
|
||||||
|
import java.util.logging.Handler;
|
||||||
|
import java.util.logging.Level;
|
||||||
|
import java.util.logging.LogRecord;
|
||||||
|
import java.util.logging.Logger;
|
||||||
|
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
import org.junit.jupiter.api.Timeout;
|
||||||
|
|
||||||
|
import kst4contest.model.ChatCategory;
|
||||||
|
import kst4contest.model.ChatMember;
|
||||||
|
import kst4contest.model.ChatPreferences;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opt-in practice test against the configured ON4KST server.
|
||||||
|
*
|
||||||
|
* <p>The normal test suite skips this class. Run it explicitly with
|
||||||
|
* {@code -Don4kst.live=true -Dtest=On4KstIdlePracticeTest} from the IDE or
|
||||||
|
* Maven when the locally stored test credentials may be used. The practice
|
||||||
|
* connection uses only the usually quiet category 9.</p>
|
||||||
|
*/
|
||||||
|
class On4KstIdlePracticeTest {
|
||||||
|
private static final int LIVE_CATEGORY = ChatCategory.VUHFR3;
|
||||||
|
private static final Duration ONLINE_TIMEOUT = Duration.ofSeconds(90);
|
||||||
|
private static final Duration QUIET_PHASE_TIMEOUT = Duration.ofMinutes(45);
|
||||||
|
private static final Duration POST_RESPONSE_OBSERVATION = Duration.ofSeconds(135);
|
||||||
|
|
||||||
|
@Test
|
||||||
|
@Timeout(value = 50, unit = TimeUnit.MINUTES)
|
||||||
|
void observesCkOkWithoutQuietReconnect() throws Exception {
|
||||||
|
assumeTrue(Boolean.getBoolean("on4kst.live"),
|
||||||
|
"Live ON4KST test requires -Don4kst.live=true");
|
||||||
|
|
||||||
|
ChatPreferences preferences = new ChatPreferences();
|
||||||
|
assumeTrue(preferences.readPreferencesFromXmlFile(),
|
||||||
|
"No readable local ON4KST test configuration");
|
||||||
|
assumeTrue(hasText(preferences.getStn_loginCallSign())
|
||||||
|
&& hasText(preferences.getStn_loginPassword()),
|
||||||
|
"Local ON4KST test credentials are incomplete");
|
||||||
|
preferences.setLoginChatCategoryMain(
|
||||||
|
new ChatCategory(LIVE_CATEGORY));
|
||||||
|
preferences.setLoginToSecondChatEnabled(false);
|
||||||
|
|
||||||
|
LinkedBlockingQueue<StateEvent> stateEvents =
|
||||||
|
new LinkedBlockingQueue<>();
|
||||||
|
LinkedBlockingQueue<ProbeEvent> probeEvents =
|
||||||
|
new LinkedBlockingQueue<>();
|
||||||
|
AtomicBoolean reconnectObserved = new AtomicBoolean();
|
||||||
|
AtomicReference<On4KstConnectionManager> managerReference =
|
||||||
|
new AtomicReference<>();
|
||||||
|
|
||||||
|
ChatController controller = mock(ChatController.class);
|
||||||
|
when(controller.getChatPreferences()).thenReturn(preferences);
|
||||||
|
ChatCategory mainCategory = preferences.getLoginChatCategoryMain();
|
||||||
|
ChatCategory secondCategory = preferences.getLoginChatCategorySecond();
|
||||||
|
if (secondCategory == null) {
|
||||||
|
secondCategory = new ChatCategory(
|
||||||
|
mainCategory.getCategoryNumber() == 2 ? 3 : 2);
|
||||||
|
}
|
||||||
|
when(controller.getChatCategoryMain()).thenReturn(mainCategory);
|
||||||
|
when(controller.getChatCategorySecondChat()).thenReturn(secondCategory);
|
||||||
|
|
||||||
|
DBController database = mock(DBController.class);
|
||||||
|
when(database.fetchChatMemberWkdDataForOnlyOneCallsignFromDB(
|
||||||
|
any(ChatMember.class)))
|
||||||
|
.thenAnswer(invocation -> invocation.getArgument(0));
|
||||||
|
doNothing().when(database).storeChatMember(any(ChatMember.class));
|
||||||
|
when(controller.getDbHandler()).thenReturn(database);
|
||||||
|
doAnswer(invocation -> {
|
||||||
|
On4KstConnectionState state = invocation.getArgument(0);
|
||||||
|
stateEvents.offer(new StateEvent(state, ZonedDateTime.now()));
|
||||||
|
if (state == On4KstConnectionState.RECONNECT_WAIT) {
|
||||||
|
reconnectObserved.set(true);
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}).when(controller).updateOn4KstConnectionState(
|
||||||
|
any(On4KstConnectionState.class), anyString(), anyBoolean());
|
||||||
|
doAnswer(invocation -> {
|
||||||
|
managerReference.get().onLogstat(
|
||||||
|
invocation.getArgument(0), invocation.getArgument(1));
|
||||||
|
return null;
|
||||||
|
}).when(controller).onOn4KstLogstat(anyLong(), any(String[].class));
|
||||||
|
doAnswer(invocation -> {
|
||||||
|
managerReference.get().stageInitialChatMember(
|
||||||
|
invocation.getArgument(0), invocation.getArgument(1));
|
||||||
|
return null;
|
||||||
|
}).when(controller).stageInitialOn4KstChatMember(
|
||||||
|
anyLong(), any(ChatMember.class));
|
||||||
|
doAnswer(invocation -> {
|
||||||
|
managerReference.get().onInitialUserListCompleted(
|
||||||
|
invocation.getArgument(0), invocation.getArgument(1));
|
||||||
|
return null;
|
||||||
|
}).when(controller).onOn4KstInitialUserListCompleted(
|
||||||
|
anyLong(), any(ChatCategory.class));
|
||||||
|
|
||||||
|
On4KstConnectionManager manager =
|
||||||
|
new On4KstConnectionManager(controller);
|
||||||
|
managerReference.set(manager);
|
||||||
|
|
||||||
|
Logger logger = Logger.getLogger(
|
||||||
|
On4KstConnectionManager.class.getName());
|
||||||
|
Level previousLevel = logger.getLevel();
|
||||||
|
Handler probeHandler = probeHandler(probeEvents);
|
||||||
|
logger.setLevel(Level.INFO);
|
||||||
|
logger.addHandler(probeHandler);
|
||||||
|
|
||||||
|
try {
|
||||||
|
manager.start();
|
||||||
|
StateEvent online = awaitOnline(stateEvents);
|
||||||
|
System.out.println("[ON4KST live] Category " + LIVE_CATEGORY
|
||||||
|
+ " ONLINE at "
|
||||||
|
+ timestamp(online.at()));
|
||||||
|
reconnectObserved.set(false);
|
||||||
|
|
||||||
|
ProbeCycle successfulCycle = awaitCkOkCycle(
|
||||||
|
probeEvents, reconnectObserved);
|
||||||
|
System.out.println("[ON4KST live] CK sent at "
|
||||||
|
+ timestamp(successfulCycle.sentAt())
|
||||||
|
+ ", OK received at "
|
||||||
|
+ timestamp(successfulCycle.confirmedAt())
|
||||||
|
+ ", response time "
|
||||||
|
+ successfulCycle.responseMillis() + " ms");
|
||||||
|
|
||||||
|
reconnectObserved.set(false);
|
||||||
|
long observationDeadline = System.nanoTime()
|
||||||
|
+ POST_RESPONSE_OBSERVATION.toNanos();
|
||||||
|
while (System.nanoTime() < observationDeadline) {
|
||||||
|
if (reconnectObserved.get()) {
|
||||||
|
fail("ON4KST entered reconnect after the confirmed CK/OK cycle");
|
||||||
|
}
|
||||||
|
TimeUnit.SECONDS.sleep(1L);
|
||||||
|
}
|
||||||
|
|
||||||
|
System.out.println("[ON4KST live] Observation completed at "
|
||||||
|
+ timestamp(ZonedDateTime.now())
|
||||||
|
+ "; no reconnect followed the quiet CK/OK cycle");
|
||||||
|
} finally {
|
||||||
|
manager.stopByUser();
|
||||||
|
logger.removeHandler(probeHandler);
|
||||||
|
logger.setLevel(previousLevel);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private StateEvent awaitOnline(
|
||||||
|
LinkedBlockingQueue<StateEvent> stateEvents
|
||||||
|
) throws InterruptedException {
|
||||||
|
long deadline = System.nanoTime() + ONLINE_TIMEOUT.toNanos();
|
||||||
|
while (System.nanoTime() < deadline) {
|
||||||
|
StateEvent event = stateEvents.poll(1L, TimeUnit.SECONDS);
|
||||||
|
if (event == null) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (event.state() == On4KstConnectionState.ONLINE) {
|
||||||
|
return event;
|
||||||
|
}
|
||||||
|
if (event.state() == On4KstConnectionState.DISCONNECTED) {
|
||||||
|
fail("ON4KST live test disconnected before reaching ONLINE");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fail("ON4KST live test did not reach ONLINE within "
|
||||||
|
+ ONLINE_TIMEOUT.toSeconds() + " seconds");
|
||||||
|
throw new IllegalStateException("unreachable");
|
||||||
|
}
|
||||||
|
|
||||||
|
private ProbeCycle awaitCkOkCycle(
|
||||||
|
LinkedBlockingQueue<ProbeEvent> probeEvents,
|
||||||
|
AtomicBoolean reconnectObserved
|
||||||
|
) throws InterruptedException {
|
||||||
|
long deadline = System.nanoTime() + QUIET_PHASE_TIMEOUT.toNanos();
|
||||||
|
ProbeEvent sent = null;
|
||||||
|
|
||||||
|
while (System.nanoTime() < deadline) {
|
||||||
|
if (reconnectObserved.get()) {
|
||||||
|
fail("ON4KST reconnected before a CK/OK idle cycle was observed");
|
||||||
|
}
|
||||||
|
|
||||||
|
ProbeEvent event = probeEvents.poll(1L, TimeUnit.SECONDS);
|
||||||
|
if (event == null) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (event.type() == ProbeEventType.SENT) {
|
||||||
|
sent = event;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (sent != null && event.sessionId() == sent.sessionId()) {
|
||||||
|
if ("OK".equals(event.opcode())) {
|
||||||
|
return new ProbeCycle(
|
||||||
|
sent.at(), event.at(), event.responseMillis());
|
||||||
|
}
|
||||||
|
// Normal server data ended this idle phase before OK arrived.
|
||||||
|
sent = null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fail("No uninterrupted CK/OK idle cycle was observed within "
|
||||||
|
+ QUIET_PHASE_TIMEOUT.toMinutes() + " minutes");
|
||||||
|
throw new IllegalStateException("unreachable");
|
||||||
|
}
|
||||||
|
|
||||||
|
private Handler probeHandler(
|
||||||
|
LinkedBlockingQueue<ProbeEvent> probeEvents
|
||||||
|
) {
|
||||||
|
return new Handler() {
|
||||||
|
@Override
|
||||||
|
public void publish(LogRecord record) {
|
||||||
|
if (record == null || record.getParameters() == null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
Object[] parameters = record.getParameters();
|
||||||
|
if (record.getMessage().startsWith(
|
||||||
|
"Sending ON4KST client liveness probe")
|
||||||
|
&& parameters.length >= 1) {
|
||||||
|
probeEvents.offer(new ProbeEvent(
|
||||||
|
ProbeEventType.SENT,
|
||||||
|
((Number) parameters[0]).longValue(),
|
||||||
|
"CK",
|
||||||
|
-1L,
|
||||||
|
ZonedDateTime.now()));
|
||||||
|
} else if (record.getMessage().startsWith(
|
||||||
|
"ON4KST client liveness probe confirmed")
|
||||||
|
&& parameters.length >= 3) {
|
||||||
|
probeEvents.offer(new ProbeEvent(
|
||||||
|
ProbeEventType.CONFIRMED,
|
||||||
|
((Number) parameters[0]).longValue(),
|
||||||
|
String.valueOf(parameters[1]),
|
||||||
|
((Number) parameters[2]).longValue(),
|
||||||
|
ZonedDateTime.now()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void flush() {
|
||||||
|
// Nothing is buffered.
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void close() {
|
||||||
|
// The handler owns no external resource.
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private boolean hasText(String value) {
|
||||||
|
return value != null && !value.isBlank();
|
||||||
|
}
|
||||||
|
|
||||||
|
private String timestamp(ZonedDateTime value) {
|
||||||
|
return DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
private record StateEvent(
|
||||||
|
On4KstConnectionState state,
|
||||||
|
ZonedDateTime at
|
||||||
|
) {
|
||||||
|
}
|
||||||
|
|
||||||
|
private enum ProbeEventType {
|
||||||
|
SENT,
|
||||||
|
CONFIRMED
|
||||||
|
}
|
||||||
|
|
||||||
|
private record ProbeEvent(
|
||||||
|
ProbeEventType type,
|
||||||
|
long sessionId,
|
||||||
|
String opcode,
|
||||||
|
long responseMillis,
|
||||||
|
ZonedDateTime at
|
||||||
|
) {
|
||||||
|
}
|
||||||
|
|
||||||
|
private record ProbeCycle(
|
||||||
|
ZonedDateTime sentAt,
|
||||||
|
ZonedDateTime confirmedAt,
|
||||||
|
long responseMillis
|
||||||
|
) {
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,425 @@
|
|||||||
|
package kst4contest.controller;
|
||||||
|
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||||
|
import static org.junit.jupiter.api.Assumptions.assumeTrue;
|
||||||
|
|
||||||
|
import java.io.ByteArrayOutputStream;
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.io.OutputStream;
|
||||||
|
import java.io.Writer;
|
||||||
|
import java.net.InetSocketAddress;
|
||||||
|
import java.net.Socket;
|
||||||
|
import java.net.SocketTimeoutException;
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
import java.nio.file.Files;
|
||||||
|
import java.nio.file.Path;
|
||||||
|
import java.nio.file.StandardOpenOption;
|
||||||
|
import java.time.Duration;
|
||||||
|
import java.time.ZonedDateTime;
|
||||||
|
import java.time.format.DateTimeFormatter;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.HexFormat;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
import org.junit.jupiter.api.Timeout;
|
||||||
|
|
||||||
|
import kst4contest.ApplicationConstants;
|
||||||
|
import kst4contest.model.ChatCategory;
|
||||||
|
import kst4contest.model.ChatPreferences;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opt-in raw-wire probe matrix against ON4KST category 9.
|
||||||
|
*
|
||||||
|
* <p>Login traffic is deliberately excluded from the evidence file so that no
|
||||||
|
* credentials or login tokens are persisted. Capture begins after the initial
|
||||||
|
* category-9 user list has completed.</p>
|
||||||
|
*/
|
||||||
|
class On4KstProbeVariantPracticeTest {
|
||||||
|
private static final int CATEGORY = ChatCategory.VUHFR3;
|
||||||
|
private static final Duration CONNECT_TIMEOUT = Duration.ofSeconds(10);
|
||||||
|
private static final Duration HANDSHAKE_TIMEOUT = Duration.ofSeconds(45);
|
||||||
|
private static final Duration QUIET_PERIOD = Duration.ofSeconds(90);
|
||||||
|
private static final Duration RESPONSE_TIMEOUT = Duration.ofSeconds(125);
|
||||||
|
private static final Duration VARIANT_TIMEOUT = Duration.ofMinutes(8);
|
||||||
|
private static final Duration TOTAL_TIMEOUT = Duration.ofMinutes(45);
|
||||||
|
|
||||||
|
private static final List<ProbeVariant> VARIANTS = List.of(
|
||||||
|
variant("CK_CRLF", "CK\r\n"),
|
||||||
|
variant("CK_PIPE_CRLF", "CK|\r\n"),
|
||||||
|
variant("CK_CR_NUL", "CK\r\0"),
|
||||||
|
variant("CK_PIPE_CR_NUL", "CK|\r\0"),
|
||||||
|
variant("PIPE_CK_PIPE_CRLF", "|CK|\r\n")
|
||||||
|
);
|
||||||
|
|
||||||
|
@Test
|
||||||
|
@Timeout(value = 47, unit = TimeUnit.MINUTES)
|
||||||
|
void recordsProbeVariantResponsesWithoutLoginData() throws Exception {
|
||||||
|
assumeTrue(Boolean.getBoolean("on4kst.live.variants"),
|
||||||
|
"Live probe matrix requires -Don4kst.live.variants=true");
|
||||||
|
|
||||||
|
ChatPreferences preferences = new ChatPreferences();
|
||||||
|
assumeTrue(preferences.readPreferencesFromXmlFile(),
|
||||||
|
"No readable local ON4KST test configuration");
|
||||||
|
assumeTrue(hasText(preferences.getStn_loginCallSign())
|
||||||
|
&& hasText(preferences.getStn_loginPassword()),
|
||||||
|
"Local ON4KST test credentials are incomplete");
|
||||||
|
|
||||||
|
Path evidenceDirectory = Path.of(
|
||||||
|
"target", "on4kst-live-evidence");
|
||||||
|
Files.createDirectories(evidenceDirectory);
|
||||||
|
String timestamp = DateTimeFormatter.ofPattern("yyyyMMdd-HHmmss")
|
||||||
|
.format(ZonedDateTime.now());
|
||||||
|
Path evidenceFile = evidenceDirectory.resolve(
|
||||||
|
timestamp + "-category-9-probe-matrix.log");
|
||||||
|
List<ProbeResult> results = new ArrayList<>();
|
||||||
|
long totalDeadline = System.nanoTime() + TOTAL_TIMEOUT.toNanos();
|
||||||
|
|
||||||
|
try (Writer evidence = Files.newBufferedWriter(
|
||||||
|
evidenceFile,
|
||||||
|
StandardCharsets.UTF_8,
|
||||||
|
StandardOpenOption.CREATE_NEW,
|
||||||
|
StandardOpenOption.WRITE)) {
|
||||||
|
writeHeader(evidence);
|
||||||
|
|
||||||
|
for (ProbeVariant variant : VARIANTS) {
|
||||||
|
if (System.nanoTime() >= totalDeadline) {
|
||||||
|
ProbeResult result = new ProbeResult(
|
||||||
|
variant.name(), "TOTAL_BUDGET_EXHAUSTED", "");
|
||||||
|
results.add(result);
|
||||||
|
writeResult(evidence, result);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
ProbeResult result;
|
||||||
|
try {
|
||||||
|
result = runVariant(
|
||||||
|
preferences, variant, totalDeadline, evidence);
|
||||||
|
} catch (Exception exception) {
|
||||||
|
result = new ProbeResult(
|
||||||
|
variant.name(),
|
||||||
|
"ERROR",
|
||||||
|
exception.getClass().getSimpleName()
|
||||||
|
+ ": " + safeMessage(exception));
|
||||||
|
writeResult(evidence, result);
|
||||||
|
}
|
||||||
|
results.add(result);
|
||||||
|
evidence.flush();
|
||||||
|
}
|
||||||
|
|
||||||
|
evidence.write("\nSUMMARY\n");
|
||||||
|
for (ProbeResult result : results) {
|
||||||
|
writeResult(evidence, result);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
System.out.println("[ON4KST variant test] Evidence: "
|
||||||
|
+ evidenceFile.toAbsolutePath());
|
||||||
|
assertTrue(
|
||||||
|
results.stream().anyMatch(result ->
|
||||||
|
"OK_DIRECT".equals(result.status())),
|
||||||
|
"No probe variant received a direct OK response. Evidence: "
|
||||||
|
+ evidenceFile.toAbsolutePath());
|
||||||
|
}
|
||||||
|
|
||||||
|
private ProbeResult runVariant(
|
||||||
|
ChatPreferences preferences,
|
||||||
|
ProbeVariant variant,
|
||||||
|
long totalDeadline,
|
||||||
|
Writer evidence
|
||||||
|
) throws Exception {
|
||||||
|
long variantDeadline = Math.min(
|
||||||
|
totalDeadline,
|
||||||
|
System.nanoTime() + VARIANT_TIMEOUT.toNanos());
|
||||||
|
evidence.write("\nVARIANT " + variant.name() + "\n");
|
||||||
|
evidence.write("probe hex=" + HexFormat.ofDelimiter(" ")
|
||||||
|
.withUpperCase().formatHex(variant.bytes())
|
||||||
|
+ " ascii=" + escapedAscii(variant.bytes()) + "\n");
|
||||||
|
|
||||||
|
try (Socket socket = new Socket()) {
|
||||||
|
socket.connect(
|
||||||
|
new InetSocketAddress(
|
||||||
|
preferences.getStn_on4kstServersDns(),
|
||||||
|
preferences.getStn_on4kstServersPort()),
|
||||||
|
Math.toIntExact(CONNECT_TIMEOUT.toMillis()));
|
||||||
|
socket.setSoTimeout(1_000);
|
||||||
|
|
||||||
|
InputStream input = socket.getInputStream();
|
||||||
|
OutputStream output = socket.getOutputStream();
|
||||||
|
WireReader reader = new WireReader(input);
|
||||||
|
completeHandshake(preferences, reader, output, variantDeadline);
|
||||||
|
|
||||||
|
writeEvent(evidence, "STATE", new byte[0],
|
||||||
|
"category 9 synchronized; login capture suppressed");
|
||||||
|
|
||||||
|
long lastInbound = System.nanoTime();
|
||||||
|
while (System.nanoTime() < variantDeadline) {
|
||||||
|
long quietDeadline = Math.min(
|
||||||
|
variantDeadline,
|
||||||
|
lastInbound + QUIET_PERIOD.toNanos());
|
||||||
|
byte[] inbound = reader.readFrame(quietDeadline);
|
||||||
|
if (inbound == null) {
|
||||||
|
if (System.nanoTime() >= variantDeadline) {
|
||||||
|
ProbeResult result = new ProbeResult(
|
||||||
|
variant.name(), "NO_QUIET_PHASE", "");
|
||||||
|
writeResult(evidence, result);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
writeEvent(evidence, "RX", inbound, "pre-probe");
|
||||||
|
lastInbound = System.nanoTime();
|
||||||
|
if ("CK".equals(On4KstProtocol.opcode(frameText(inbound)))) {
|
||||||
|
byte[] response = "\r\n".getBytes(StandardCharsets.US_ASCII);
|
||||||
|
output.write(response);
|
||||||
|
output.flush();
|
||||||
|
writeEvent(evidence, "TX", response,
|
||||||
|
"response to server-initiated CK");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
output.write(variant.bytes());
|
||||||
|
output.flush();
|
||||||
|
writeEvent(evidence, "TX", variant.bytes(), "client probe");
|
||||||
|
|
||||||
|
long responseDeadline = Math.min(
|
||||||
|
variantDeadline,
|
||||||
|
System.nanoTime() + RESPONSE_TIMEOUT.toNanos());
|
||||||
|
boolean receivedOtherFrame = false;
|
||||||
|
while (System.nanoTime() < responseDeadline) {
|
||||||
|
byte[] inbound = reader.readFrame(responseDeadline);
|
||||||
|
if (inbound == null) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
writeEvent(evidence, "RX", inbound, "post-probe");
|
||||||
|
String text = frameText(inbound);
|
||||||
|
if (On4KstProtocol.isClientLivenessProbeResponse(text)) {
|
||||||
|
String status = receivedOtherFrame
|
||||||
|
? "OK_AFTER_OTHER_DATA"
|
||||||
|
: "OK_DIRECT";
|
||||||
|
ProbeResult result = new ProbeResult(
|
||||||
|
variant.name(), status, escapedAscii(inbound));
|
||||||
|
writeResult(evidence, result);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
receivedOtherFrame = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
ProbeResult result = new ProbeResult(
|
||||||
|
variant.name(),
|
||||||
|
receivedOtherFrame ? "OTHER_DATA_ONLY" : "NO_RESPONSE",
|
||||||
|
"");
|
||||||
|
writeResult(evidence, result);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private void completeHandshake(
|
||||||
|
ChatPreferences preferences,
|
||||||
|
WireReader reader,
|
||||||
|
OutputStream output,
|
||||||
|
long variantDeadline
|
||||||
|
) throws Exception {
|
||||||
|
long handshakeDeadline = Math.min(
|
||||||
|
variantDeadline,
|
||||||
|
System.nanoTime() + HANDSHAKE_TIMEOUT.toNanos());
|
||||||
|
|
||||||
|
byte[] prompt = requireFrame(reader, handshakeDeadline,
|
||||||
|
"ON4KST login prompt");
|
||||||
|
if (!frameText(prompt).toLowerCase().contains("login")) {
|
||||||
|
throw new IOException("Unexpected ON4KST login prompt opcode: "
|
||||||
|
+ On4KstProtocol.opcode(frameText(prompt)));
|
||||||
|
}
|
||||||
|
|
||||||
|
String login = On4KstProtocol.login(
|
||||||
|
preferences.getStn_loginCallSign(),
|
||||||
|
preferences.getStn_loginPassword(),
|
||||||
|
CATEGORY,
|
||||||
|
"KST4Contest v"
|
||||||
|
+ ApplicationConstants.APPLICATION_CURRENT_VERSION,
|
||||||
|
0L);
|
||||||
|
writeCrLfFrame(output, login);
|
||||||
|
|
||||||
|
boolean loginAccepted = false;
|
||||||
|
while (!loginAccepted) {
|
||||||
|
byte[] inbound = requireFrame(reader, handshakeDeadline,
|
||||||
|
"ON4KST LOGSTAT");
|
||||||
|
String text = frameText(inbound);
|
||||||
|
if (!"LOGSTAT".equals(On4KstProtocol.opcode(text))) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
String[] fields = text.split("\\|", -1);
|
||||||
|
if (fields.length < 2 || !"100".equals(fields[1])) {
|
||||||
|
throw new IOException("ON4KST login rejected with code "
|
||||||
|
+ (fields.length < 2 ? "missing" : fields[1]));
|
||||||
|
}
|
||||||
|
loginAccepted = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
writeCrLfFrame(output, On4KstProtocol.settingsDone(CATEGORY));
|
||||||
|
while (true) {
|
||||||
|
byte[] inbound = requireFrame(reader, handshakeDeadline,
|
||||||
|
"category-9 user-list completion");
|
||||||
|
String text = frameText(inbound);
|
||||||
|
if (text.startsWith("UE|" + CATEGORY + "|")) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private byte[] requireFrame(
|
||||||
|
WireReader reader,
|
||||||
|
long deadline,
|
||||||
|
String description
|
||||||
|
) throws IOException {
|
||||||
|
byte[] frame = reader.readFrame(deadline);
|
||||||
|
if (frame == null) {
|
||||||
|
throw new SocketTimeoutException(
|
||||||
|
"Timed out waiting for " + description);
|
||||||
|
}
|
||||||
|
return frame;
|
||||||
|
}
|
||||||
|
|
||||||
|
private void writeCrLfFrame(OutputStream output, String frame)
|
||||||
|
throws IOException {
|
||||||
|
output.write(frame.getBytes(StandardCharsets.US_ASCII));
|
||||||
|
output.write('\r');
|
||||||
|
output.write('\n');
|
||||||
|
output.flush();
|
||||||
|
}
|
||||||
|
|
||||||
|
private void writeHeader(Writer evidence) throws IOException {
|
||||||
|
evidence.write("ON4KST client-probe wire evidence\n");
|
||||||
|
evidence.write("started=" + DateTimeFormatter.ISO_OFFSET_DATE_TIME
|
||||||
|
.format(ZonedDateTime.now()) + "\n");
|
||||||
|
evidence.write("category=9\n");
|
||||||
|
evidence.write("login and initial synchronization frames are suppressed"
|
||||||
|
+ " to exclude credentials and login tokens\n");
|
||||||
|
evidence.write("wtKST reference: server CK frame="
|
||||||
|
+ "43 4B 7C 0D 0A (CK|<CR><LF>)\n");
|
||||||
|
evidence.write("wtKST reference: no client CK and no server OK occur"
|
||||||
|
+ " in wtkstcomm.c\n");
|
||||||
|
evidence.write("wtKST reference: repeated client idle payload="
|
||||||
|
+ "0D 00 0D 0A (<CR><NUL><CR><LF>)\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
private void writeEvent(
|
||||||
|
Writer evidence,
|
||||||
|
String direction,
|
||||||
|
byte[] bytes,
|
||||||
|
String note
|
||||||
|
) throws IOException {
|
||||||
|
evidence.write(DateTimeFormatter.ISO_OFFSET_DATE_TIME
|
||||||
|
.format(ZonedDateTime.now()));
|
||||||
|
evidence.write(" " + direction);
|
||||||
|
if (bytes.length > 0) {
|
||||||
|
evidence.write(" hex=" + HexFormat.ofDelimiter(" ")
|
||||||
|
.withUpperCase().formatHex(bytes));
|
||||||
|
evidence.write(" ascii=" + escapedAscii(bytes));
|
||||||
|
}
|
||||||
|
if (hasText(note)) {
|
||||||
|
evidence.write(" note=" + note);
|
||||||
|
}
|
||||||
|
evidence.write("\n");
|
||||||
|
evidence.flush();
|
||||||
|
}
|
||||||
|
|
||||||
|
private void writeResult(Writer evidence, ProbeResult result)
|
||||||
|
throws IOException {
|
||||||
|
evidence.write("RESULT variant=" + result.variant()
|
||||||
|
+ " status=" + result.status());
|
||||||
|
if (hasText(result.detail())) {
|
||||||
|
evidence.write(" detail=" + result.detail());
|
||||||
|
}
|
||||||
|
evidence.write("\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
private static ProbeVariant variant(String name, String wireText) {
|
||||||
|
return new ProbeVariant(
|
||||||
|
name, wireText.getBytes(StandardCharsets.US_ASCII));
|
||||||
|
}
|
||||||
|
|
||||||
|
private String frameText(byte[] frame) {
|
||||||
|
int length = frame.length;
|
||||||
|
while (length > 0 && (frame[length - 1] == '\r'
|
||||||
|
|| frame[length - 1] == '\n'
|
||||||
|
|| frame[length - 1] == 0)) {
|
||||||
|
length--;
|
||||||
|
}
|
||||||
|
return new String(frame, 0, length, StandardCharsets.US_ASCII);
|
||||||
|
}
|
||||||
|
|
||||||
|
private String escapedAscii(byte[] bytes) {
|
||||||
|
StringBuilder escaped = new StringBuilder();
|
||||||
|
for (byte value : bytes) {
|
||||||
|
int unsigned = Byte.toUnsignedInt(value);
|
||||||
|
switch (unsigned) {
|
||||||
|
case 0 -> escaped.append("<NUL>");
|
||||||
|
case '\r' -> escaped.append("<CR>");
|
||||||
|
case '\n' -> escaped.append("<LF>");
|
||||||
|
default -> {
|
||||||
|
if (unsigned >= 0x20 && unsigned <= 0x7e) {
|
||||||
|
escaped.append((char) unsigned);
|
||||||
|
} else {
|
||||||
|
escaped.append(String.format("<%02X>", unsigned));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return escaped.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
private String safeMessage(Exception exception) {
|
||||||
|
String message = exception.getMessage();
|
||||||
|
return message == null || message.isBlank()
|
||||||
|
? "no detail" : message.replaceAll("[\\r\\n]+", " ");
|
||||||
|
}
|
||||||
|
|
||||||
|
private boolean hasText(String value) {
|
||||||
|
return value != null && !value.isBlank();
|
||||||
|
}
|
||||||
|
|
||||||
|
private record ProbeVariant(String name, byte[] bytes) {
|
||||||
|
private ProbeVariant {
|
||||||
|
bytes = bytes.clone();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public byte[] bytes() {
|
||||||
|
return bytes.clone();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private record ProbeResult(String variant, String status, String detail) {
|
||||||
|
}
|
||||||
|
|
||||||
|
private static final class WireReader {
|
||||||
|
private final InputStream input;
|
||||||
|
|
||||||
|
private WireReader(InputStream input) {
|
||||||
|
this.input = input;
|
||||||
|
}
|
||||||
|
|
||||||
|
private byte[] readFrame(long deadlineNanos) throws IOException {
|
||||||
|
ByteArrayOutputStream frame = new ByteArrayOutputStream();
|
||||||
|
while (System.nanoTime() < deadlineNanos) {
|
||||||
|
try {
|
||||||
|
int value = input.read();
|
||||||
|
if (value < 0) {
|
||||||
|
throw new IOException("ON4KST closed the TCP session");
|
||||||
|
}
|
||||||
|
frame.write(value);
|
||||||
|
if (value == '\n' || value == 0) {
|
||||||
|
return frame.toByteArray();
|
||||||
|
}
|
||||||
|
} catch (SocketTimeoutException timeout) {
|
||||||
|
// Continue until the caller's monotonic deadline expires.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return frame.size() == 0 ? null : frame.toByteArray();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
package kst4contest.controller;
|
||||||
|
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
|
||||||
|
class WinTestIhaveInventoryTest {
|
||||||
|
|
||||||
|
private static Optional<WinTestIhaveInventory> parse(String messageText) {
|
||||||
|
return WinTestIhaveInventory.fromPacket(WinTestPacket.fromMessageText(messageText));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void inventoryStartingWithPresentQsosIsExpanded() {
|
||||||
|
Optional<WinTestIhaveInventory> inventory =
|
||||||
|
parse("IHAVE: \"STN1\" \"\" \"STN1@9\" E 1 1 911-1-117");
|
||||||
|
|
||||||
|
assertTrue(inventory.isPresent());
|
||||||
|
assertEquals("STN1@9", inventory.get().getLogId());
|
||||||
|
assertEquals(WinTestIhaveInventory.Origin.LOGGED_ELSE, inventory.get().getOrigin());
|
||||||
|
assertEquals(
|
||||||
|
List.of(new WinTestLogSegment(1L, 911L), new WinTestLogSegment(913L, 1029L)),
|
||||||
|
inventory.get().getSegments());
|
||||||
|
assertEquals(1029L, inventory.get().getHighestQsoNumber());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void inventoryStartingWithMissingQsosIsExpanded() {
|
||||||
|
Optional<WinTestIhaveInventory> inventory =
|
||||||
|
parse("IHAVE: \"STN1\" \"\" \"STN1@9\" O 1 0 30-5");
|
||||||
|
|
||||||
|
assertTrue(inventory.isPresent());
|
||||||
|
assertEquals(WinTestIhaveInventory.Origin.OWNER, inventory.get().getOrigin());
|
||||||
|
assertEquals(List.of(new WinTestLogSegment(31L, 35L)), inventory.get().getSegments());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void splitInventoryStartsAtItsFirstRow() {
|
||||||
|
/*
|
||||||
|
* Win-Test splits long inventories. The documented example "100 1 10-5-5"
|
||||||
|
* means: ten QSOs from 100, five missing, five present again.
|
||||||
|
*/
|
||||||
|
Optional<WinTestIhaveInventory> inventory =
|
||||||
|
parse("IHAVE: \"STN1\" \"\" \"STN1@9\" O 100 1 10-5-5");
|
||||||
|
|
||||||
|
assertTrue(inventory.isPresent());
|
||||||
|
assertEquals(
|
||||||
|
List.of(new WinTestLogSegment(100L, 109L), new WinTestLogSegment(115L, 119L)),
|
||||||
|
inventory.get().getSegments());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void runLengthChainWithWrongParityIsRejected() {
|
||||||
|
assertTrue(parse("IHAVE: \"STN1\" \"\" \"STN1@9\" O 1 1 10-5").isEmpty());
|
||||||
|
assertTrue(parse("IHAVE: \"STN1\" \"\" \"STN1@9\" O 1 0 10-5-5").isEmpty());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void legacyInventoryWithoutRunLengthsIsRejected() {
|
||||||
|
assertTrue(parse("IHAVE: \"STN1\" \"\" \"STN1@169\" \"OWNER\" 2").isEmpty());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void otherMessageTypesAreRejected() {
|
||||||
|
assertTrue(parse("STATUS: \"STN1\" \"\" 0 12 0 0 0 1443210 0").isEmpty());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,171 @@
|
|||||||
|
package kst4contest.controller;
|
||||||
|
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
import org.junit.jupiter.api.BeforeEach;
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
|
||||||
|
class WinTestLogSyncServiceTest {
|
||||||
|
|
||||||
|
private static final String LOG_ID = "STN1@44510";
|
||||||
|
|
||||||
|
private final List<String> sentRequests = new ArrayList<>();
|
||||||
|
|
||||||
|
private long currentTimeMs = 1_000_000L;
|
||||||
|
|
||||||
|
private WinTestLogSyncService service;
|
||||||
|
|
||||||
|
@BeforeEach
|
||||||
|
void createService() {
|
||||||
|
sentRequests.clear();
|
||||||
|
service = new WinTestLogSyncService(
|
||||||
|
(targetStation, logId, countFrom, countTo) ->
|
||||||
|
sentRequests.add(targetStation + " " + logId + " " + countFrom + "-" + countTo),
|
||||||
|
() -> "KST4Contest",
|
||||||
|
() -> currentTimeMs
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
private void receiveIhave(String messageText) {
|
||||||
|
service.onIhaveReceived(WinTestPacket.fromMessageText(messageText));
|
||||||
|
}
|
||||||
|
|
||||||
|
private void receiveQsos(long countFrom, long countTo) {
|
||||||
|
for (long qsoNumber = countFrom; qsoNumber <= countTo; qsoNumber++) {
|
||||||
|
service.registerReceivedQso(LOG_ID, qsoNumber);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void firstBlockOfAnAnnouncedLogIsRequested() {
|
||||||
|
receiveIhave("IHAVE: \"STN1\" \"\" \"" + LOG_ID + "\" O 1 1 120");
|
||||||
|
|
||||||
|
service.tick();
|
||||||
|
|
||||||
|
assertEquals(List.of("STN1 " + LOG_ID + " 1-50"), sentRequests);
|
||||||
|
assertEquals(WinTestLogSyncService.SyncState.SYNCING, service.getState());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void answeredBlockTriggersTheNextBlockUntilTheLogIsComplete() {
|
||||||
|
receiveIhave("IHAVE: \"STN1\" \"\" \"" + LOG_ID + "\" O 1 1 120");
|
||||||
|
|
||||||
|
service.tick();
|
||||||
|
receiveQsos(1L, 50L);
|
||||||
|
service.tick();
|
||||||
|
receiveQsos(51L, 100L);
|
||||||
|
service.tick();
|
||||||
|
receiveQsos(101L, 120L);
|
||||||
|
service.tick();
|
||||||
|
|
||||||
|
assertEquals(
|
||||||
|
List.of(
|
||||||
|
"STN1 " + LOG_ID + " 1-50",
|
||||||
|
"STN1 " + LOG_ID + " 51-100",
|
||||||
|
"STN1 " + LOG_ID + " 101-120"
|
||||||
|
),
|
||||||
|
sentRequests);
|
||||||
|
assertEquals(WinTestLogSyncService.SyncState.IN_SYNC, service.getState());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void onlyMissingQsoNumbersAreRequested() {
|
||||||
|
receiveQsos(1L, 10L);
|
||||||
|
receiveQsos(21L, 30L);
|
||||||
|
receiveIhave("IHAVE: \"STN1\" \"\" \"" + LOG_ID + "\" O 1 1 30");
|
||||||
|
|
||||||
|
service.tick();
|
||||||
|
|
||||||
|
assertEquals(List.of("STN1 " + LOG_ID + " 11-20"), sentRequests);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void alreadyKnownQsoIsReportedAsKnown() {
|
||||||
|
assertTrue(service.registerReceivedQso(LOG_ID, 5L));
|
||||||
|
assertFalse(service.registerReceivedQso(LOG_ID, 5L));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void qsoWithoutUsableIdentityIsAlwaysTreatedAsNew() {
|
||||||
|
assertTrue(service.registerReceivedQso(null, 5L));
|
||||||
|
assertTrue(service.registerReceivedQso("", 5L));
|
||||||
|
assertTrue(service.registerReceivedQso(LOG_ID, 0L));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void unansweredRequestIsRepeatedAtAnotherStationHoldingTheSameLog() {
|
||||||
|
receiveIhave("IHAVE: \"STN1\" \"\" \"" + LOG_ID + "\" O 1 1 120");
|
||||||
|
receiveIhave("IHAVE: \"STN2\" \"\" \"" + LOG_ID + "\" E 1 1 120");
|
||||||
|
|
||||||
|
service.tick();
|
||||||
|
currentTimeMs += WinTestLogSyncService.REQUEST_TIMEOUT_MS;
|
||||||
|
service.tick();
|
||||||
|
|
||||||
|
assertEquals(
|
||||||
|
List.of("STN1 " + LOG_ID + " 1-50", "STN2 " + LOG_ID + " 1-50"),
|
||||||
|
sentRequests);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void silentStationIsDroppedWhenNobodyElseHoldsTheLog() {
|
||||||
|
receiveIhave("IHAVE: \"STN1\" \"\" \"" + LOG_ID + "\" O 1 1 120");
|
||||||
|
|
||||||
|
service.tick();
|
||||||
|
currentTimeMs += WinTestLogSyncService.REQUEST_TIMEOUT_MS;
|
||||||
|
service.tick();
|
||||||
|
currentTimeMs += WinTestLogSyncService.REQUEST_TIMEOUT_MS;
|
||||||
|
service.tick();
|
||||||
|
|
||||||
|
assertEquals(List.of("STN1 " + LOG_ID + " 1-50"), sentRequests);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void blindFallbackRequestsFixedBlocksWithoutInventory() {
|
||||||
|
service.onStationSeen("STN1");
|
||||||
|
service.registerReceivedQso(LOG_ID, 7L);
|
||||||
|
|
||||||
|
service.tick();
|
||||||
|
assertEquals(List.of(), sentRequests);
|
||||||
|
|
||||||
|
currentTimeMs += WinTestLogSyncService.INVENTORY_GRACE_PERIOD_MS;
|
||||||
|
service.tick();
|
||||||
|
receiveQsos(1L, 50L);
|
||||||
|
service.tick();
|
||||||
|
|
||||||
|
currentTimeMs += WinTestLogSyncService.REQUEST_TIMEOUT_MS;
|
||||||
|
service.tick();
|
||||||
|
currentTimeMs += WinTestLogSyncService.REQUEST_TIMEOUT_MS;
|
||||||
|
service.tick();
|
||||||
|
|
||||||
|
assertEquals(
|
||||||
|
List.of("STN1 " + LOG_ID + " 1-50", "STN1 " + LOG_ID + " 51-100"),
|
||||||
|
sentRequests);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void inventoryStopsTheBlindFallback() {
|
||||||
|
service.onStationSeen("STN1");
|
||||||
|
service.registerReceivedQso(LOG_ID, 7L);
|
||||||
|
currentTimeMs += WinTestLogSyncService.INVENTORY_GRACE_PERIOD_MS;
|
||||||
|
|
||||||
|
receiveIhave("IHAVE: \"STN1\" \"\" \"" + LOG_ID + "\" O 1 1 10");
|
||||||
|
service.tick();
|
||||||
|
|
||||||
|
assertEquals(List.of("STN1 " + LOG_ID + " 1-6"), sentRequests);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void ownPacketsDoNotStartASynchronization() {
|
||||||
|
service.onStationSeen("KST4Contest");
|
||||||
|
|
||||||
|
service.tick();
|
||||||
|
|
||||||
|
assertEquals(List.of(), sentRequests);
|
||||||
|
assertEquals(WinTestLogSyncService.SyncState.IDLE, service.getState());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
package kst4contest.controller;
|
||||||
|
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||||
|
|
||||||
|
import java.net.InetAddress;
|
||||||
|
import java.net.UnknownHostException;
|
||||||
|
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
|
||||||
|
class WinTestNetworkAddressResolverTest {
|
||||||
|
|
||||||
|
private static InetAddress address(String hostAddress) throws UnknownHostException {
|
||||||
|
return InetAddress.getByName(hostAddress);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void stationNetworkWinsOverConfiguredAddress() throws UnknownHostException {
|
||||||
|
WinTestNetworkAddressResolver resolver = new WinTestNetworkAddressResolver(
|
||||||
|
remoteAddress -> {
|
||||||
|
try {
|
||||||
|
return address("192.168.122.255");
|
||||||
|
} catch (UnknownHostException exception) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
resolver.rememberStationAddress(address("192.168.122.1"));
|
||||||
|
|
||||||
|
assertEquals(address("192.168.122.255"),
|
||||||
|
resolver.resolveBroadcastAddress("192.168.101.255"));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void configuredAddressIsUsedWhenNoLocalInterfaceServesTheStation()
|
||||||
|
throws UnknownHostException {
|
||||||
|
WinTestNetworkAddressResolver resolver =
|
||||||
|
new WinTestNetworkAddressResolver(remoteAddress -> null);
|
||||||
|
|
||||||
|
resolver.rememberStationAddress(address("10.9.8.7"));
|
||||||
|
|
||||||
|
assertEquals(address("192.168.101.255"),
|
||||||
|
resolver.resolveBroadcastAddress("192.168.101.255"));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void limitedBroadcastIsUsedWithoutStationAndWithoutSetting()
|
||||||
|
throws UnknownHostException {
|
||||||
|
WinTestNetworkAddressResolver resolver =
|
||||||
|
new WinTestNetworkAddressResolver(remoteAddress -> null);
|
||||||
|
|
||||||
|
assertEquals(address("255.255.255.255"), resolver.resolveBroadcastAddress(" "));
|
||||||
|
assertEquals(address("255.255.255.255"), resolver.resolveBroadcastAddress(null));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void loopbackAndWildcardSourcesAreIgnored() throws UnknownHostException {
|
||||||
|
WinTestNetworkAddressResolver resolver = new WinTestNetworkAddressResolver(
|
||||||
|
remoteAddress -> {
|
||||||
|
throw new IllegalStateException("must not be asked for " + remoteAddress);
|
||||||
|
});
|
||||||
|
|
||||||
|
resolver.rememberStationAddress(address("127.0.0.1"));
|
||||||
|
resolver.rememberStationAddress(address("0.0.0.0"));
|
||||||
|
resolver.rememberStationAddress(null);
|
||||||
|
|
||||||
|
assertEquals(address("192.168.101.255"),
|
||||||
|
resolver.resolveBroadcastAddress("192.168.101.255"));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void subnetComparisonHonoursThePrefixLength() throws UnknownHostException {
|
||||||
|
assertTrue(WinTestNetworkAddressResolver.isInSameSubnet(
|
||||||
|
address("192.168.122.1"), address("192.168.122.203"), 24));
|
||||||
|
assertFalse(WinTestNetworkAddressResolver.isInSameSubnet(
|
||||||
|
address("192.168.101.5"), address("192.168.122.1"), 24));
|
||||||
|
assertTrue(WinTestNetworkAddressResolver.isInSameSubnet(
|
||||||
|
address("172.19.0.1"), address("172.19.240.9"), 16));
|
||||||
|
assertFalse(WinTestNetworkAddressResolver.isInSameSubnet(
|
||||||
|
address("10.244.22.73"), address("10.244.23.1"), 24));
|
||||||
|
assertTrue(WinTestNetworkAddressResolver.isInSameSubnet(
|
||||||
|
address("10.244.22.73"), address("10.244.23.1"), 16));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,111 @@
|
|||||||
|
package kst4contest.controller;
|
||||||
|
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertNull;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||||
|
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
|
||||||
|
class WinTestPacketTest {
|
||||||
|
|
||||||
|
private static final String ADDQSO_MESSAGE =
|
||||||
|
"ADDQSO: \"STN1\" \"\" \"STN1\" 1762202297 1440000 0 12 0 0 0 2 2 "
|
||||||
|
+ "\"DM2RN\" \"599\" \"599001\" \"JO51UM\" \"\" \"\" 0 \"\" \"\" \"\" 44510";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds a datagram exactly like Win-Test does: message text, checksum byte
|
||||||
|
* replacing the placeholder, NUL terminator.
|
||||||
|
*/
|
||||||
|
private static byte[] toDatagram(String messageText) {
|
||||||
|
byte[] datagram = (messageText + "?\0").getBytes(StandardCharsets.US_ASCII);
|
||||||
|
|
||||||
|
int sum = 0;
|
||||||
|
for (int index = 0; index < datagram.length - 2; index++) {
|
||||||
|
sum += datagram[index] & 0xFF;
|
||||||
|
}
|
||||||
|
|
||||||
|
datagram[datagram.length - 2] = (byte) ((sum | 0x80) & 0xFF);
|
||||||
|
return datagram;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void checksumByteAndTerminatorAreRemovedFromMessageText() {
|
||||||
|
byte[] datagram = toDatagram(ADDQSO_MESSAGE);
|
||||||
|
|
||||||
|
WinTestPacket packet = WinTestPacket.fromDatagram(datagram, datagram.length);
|
||||||
|
|
||||||
|
assertEquals(ADDQSO_MESSAGE, packet.getMessageText());
|
||||||
|
assertTrue(packet.isChecksumPresent());
|
||||||
|
assertTrue(packet.isChecksumValid());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void trailingLogIdStaysReadableAfterFramingIsResolved() {
|
||||||
|
byte[] datagram = toDatagram(ADDQSO_MESSAGE);
|
||||||
|
|
||||||
|
WinTestPacket packet = WinTestPacket.fromDatagram(datagram, datagram.length);
|
||||||
|
List<String> packetFields = WinTestPacket.tokenize(packet.getMessageText());
|
||||||
|
|
||||||
|
assertEquals("STN1@44510",
|
||||||
|
ReadUDPByWintestThread.extractLogIdFromWinTestAddQso(packetFields));
|
||||||
|
assertEquals(2L,
|
||||||
|
ReadUDPByWintestThread.extractQsoNumberFromWinTestAddQso(packetFields));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void manipulatedChecksumIsDetected() {
|
||||||
|
byte[] datagram = toDatagram(ADDQSO_MESSAGE);
|
||||||
|
datagram[datagram.length - 2] = (byte) 0xFF;
|
||||||
|
|
||||||
|
WinTestPacket packet = WinTestPacket.fromDatagram(datagram, datagram.length);
|
||||||
|
|
||||||
|
assertTrue(packet.isChecksumPresent());
|
||||||
|
assertFalse(packet.isChecksumValid());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void sourceAndDestinationAreSeparatedFromPayload() {
|
||||||
|
byte[] datagram = toDatagram(
|
||||||
|
"IHAVE: \"STN1\" \"KST4Contest\" \"STN1@44510\" O 1 1 120");
|
||||||
|
|
||||||
|
WinTestPacket packet = WinTestPacket.fromDatagram(datagram, datagram.length);
|
||||||
|
|
||||||
|
assertEquals("IHAVE", packet.getMessageType());
|
||||||
|
assertEquals("STN1", packet.getSource());
|
||||||
|
assertEquals("KST4Contest", packet.getDestination());
|
||||||
|
assertEquals(List.of("STN1@44510", "O", "1", "1", "120"), packet.getDataTokens());
|
||||||
|
assertTrue(packet.isAddressedTo("KST4Contest"));
|
||||||
|
assertFalse(packet.isAddressedTo("STN2"));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void emptyQuotedFieldsKeepFieldPositions() {
|
||||||
|
List<String> packetFields = WinTestPacket.tokenize(ADDQSO_MESSAGE);
|
||||||
|
|
||||||
|
assertEquals("ADDQSO:", packetFields.get(0));
|
||||||
|
assertEquals("STN1", packetFields.get(1));
|
||||||
|
assertEquals("", packetFields.get(2));
|
||||||
|
assertEquals("12", packetFields.get(7));
|
||||||
|
assertEquals("DM2RN", packetFields.get(13));
|
||||||
|
assertEquals(24, packetFields.size());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void messageWithoutWinTestFramingIsRejected() {
|
||||||
|
assertNull(WinTestPacket.fromMessageText("no win-test message"));
|
||||||
|
assertNull(WinTestPacket.fromDatagram(new byte[] { 0 }, 1));
|
||||||
|
assertNull(WinTestPacket.fromDatagram(null, 0));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void broadcastPacketIsAcceptedForEveryStationName() {
|
||||||
|
WinTestPacket packet = WinTestPacket.fromMessageText(ADDQSO_MESSAGE);
|
||||||
|
|
||||||
|
assertTrue(packet.isAddressedTo("KST4Contest"));
|
||||||
|
assertFalse(packet.isChecksumPresent());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2392,3 +2392,14 @@ SM6VTZ;Chris .135;JO58UJ;StringProperty [value: 432.135]; wkd true; wkd144 true;
|
|||||||
LA0BY;Stefan @ hilltop;JO59IX;StringProperty [value: 144.062]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; 2: 144/432 MHz
|
LA0BY;Stefan @ hilltop;JO59IX;StringProperty [value: 144.062]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; 2: 144/432 MHz
|
||||||
LA0BY;null;JO49ML;StringProperty [value: null]; wkd true; wkd144 false; wkd432true; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
LA0BY;null;JO49ML;StringProperty [value: null]; wkd true; wkd144 false; wkd432true; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
OV3T;null;JO46CM;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
OV3T;null;JO46CM;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
|
DK0TR;null;JO40QL;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
|
DD0VF;null;JO61TB;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
|
F5DYD;null;JN03KG;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
|
F6DRO;null;JN03TJ;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
|
F4VRB;null;IN98PT;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
|
DK0TR;null;JO40QL;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
|
DD0VF;null;JO61TB;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
|
F5DYD;null;JN03KG;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
|
F6DRO;null;JN03TJ;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
|
F4VRB;null;IN98PT;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
|
DK5KMA;null;JO50IK;StringProperty [value: null]; wkd true; wkd144 true; wkd432false; wkd1240false; wkd2300false; wkd3400false; wkd5600false; wkd10Gfalse ; null
|
||||||
@@ -73,6 +73,12 @@ function getManualPageOrder(lang, slug) {
|
|||||||
return index >= 0 ? index : 999;
|
return index >= 0 ? index : 999;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function selectLatestNews(newsItems) {
|
||||||
|
return [...(newsItems || [])]
|
||||||
|
.sort((first, second) => second.date - first.date)
|
||||||
|
.slice(0, 1);
|
||||||
|
}
|
||||||
|
|
||||||
function githubCompatibleSlug(value) {
|
function githubCompatibleSlug(value) {
|
||||||
return (value || "")
|
return (value || "")
|
||||||
.trim()
|
.trim()
|
||||||
@@ -152,6 +158,12 @@ module.exports = function (eleventyConfig) {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
eleventyConfig.addCollection("latestNews", function (collectionApi) {
|
||||||
|
return selectLatestNews(
|
||||||
|
collectionApi.getFilteredByTag("news")
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
eleventyConfig.addFilter("whereTag", function(collection, tag) {
|
eleventyConfig.addFilter("whereTag", function(collection, tag) {
|
||||||
return collection.filter(item => item.data.tags && item.data.tags.includes(tag));
|
return collection.filter(item => item.data.tags && item.data.tags.includes(tag));
|
||||||
});
|
});
|
||||||
@@ -231,3 +243,5 @@ module.exports = function (eleventyConfig) {
|
|||||||
htmlTemplateEngine: "njk"
|
htmlTemplateEngine: "njk"
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
module.exports.selectLatestNews = selectLatestNews;
|
||||||
|
|||||||
+10
-1
@@ -48,4 +48,13 @@ Nginx serves this directory.
|
|||||||
|
|
||||||
## Build Strategy
|
## Build Strategy
|
||||||
|
|
||||||
GitHub Actions will later build the 11ty website and deploy the generated output to the server.
|
The production server keeps a checkout at `/srv/git/kst4contest`. A root cron
|
||||||
|
job runs `/srv/scripts/deploy-kst4contest-website.sh` every five minutes. The
|
||||||
|
script resets the checkout to `origin/main`, installs the locked npm
|
||||||
|
dependencies, builds and validates the Eleventy site, and synchronises the
|
||||||
|
result to `/srv/www/kst4contest/current` with the ownership required by Nginx.
|
||||||
|
|
||||||
|
This deploy path updates only the static website. Server-side analytics,
|
||||||
|
Nginx, systemd, Logrotate, GeoIP, Basic Auth and Certbot configuration are
|
||||||
|
installed and maintained separately as described in
|
||||||
|
[`ops/analytics/README.md`](ops/analytics/README.md).
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,879 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const fs = require("node:fs");
|
||||||
|
const os = require("node:os");
|
||||||
|
const path = require("node:path");
|
||||||
|
const { spawnSync } = require("node:child_process");
|
||||||
|
|
||||||
|
const STATE_SCHEMA_VERSION = 1;
|
||||||
|
const PUBLIC_SCHEMA_VERSION = 1;
|
||||||
|
const MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER;
|
||||||
|
const RESERVED_STATS_HOST = "stats.hamradioonline.de";
|
||||||
|
|
||||||
|
class ConfigurationError extends Error {
|
||||||
|
constructor(message) {
|
||||||
|
super(message);
|
||||||
|
this.name = "ConfigurationError";
|
||||||
|
this.exitCode = 2;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class LockError extends Error {
|
||||||
|
constructor(message) {
|
||||||
|
super(message);
|
||||||
|
this.name = "LockError";
|
||||||
|
this.exitCode = 3;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function readJson(filePath, label) {
|
||||||
|
let parsed;
|
||||||
|
|
||||||
|
try {
|
||||||
|
parsed = JSON.parse(fs.readFileSync(filePath, "utf8"));
|
||||||
|
} catch (error) {
|
||||||
|
throw new ConfigurationError(`${label} is not valid JSON: ${error.message}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return parsed;
|
||||||
|
}
|
||||||
|
|
||||||
|
function parseIsoDate(value) {
|
||||||
|
const match = /^(\d{4})-(\d{2})-(\d{2})$/.exec(value);
|
||||||
|
|
||||||
|
if (!match) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const year = Number(match[1]);
|
||||||
|
const month = Number(match[2]);
|
||||||
|
const day = Number(match[3]);
|
||||||
|
const date = new Date(Date.UTC(year, month - 1, day));
|
||||||
|
|
||||||
|
if (date.getUTCFullYear() !== year
|
||||||
|
|| date.getUTCMonth() !== month - 1
|
||||||
|
|| date.getUTCDate() !== day) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return `${match[1]}-${match[2]}-${match[3]}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function requireAbsolutePath(value, label) {
|
||||||
|
if (typeof value !== "string" || /[\r\n\0]/.test(value) || !path.isAbsolute(value)) {
|
||||||
|
throw new ConfigurationError(`${label} must be an absolute path`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return path.normalize(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
function isWithin(parent, candidate) {
|
||||||
|
const relative = path.relative(parent, candidate);
|
||||||
|
return relative !== ""
|
||||||
|
&& relative !== ".."
|
||||||
|
&& !relative.startsWith(`..${path.sep}`)
|
||||||
|
&& !path.isAbsolute(relative);
|
||||||
|
}
|
||||||
|
|
||||||
|
function validateRegistry(registry) {
|
||||||
|
if (!registry || typeof registry !== "object" || Array.isArray(registry)) {
|
||||||
|
throw new ConfigurationError("registry must be an object");
|
||||||
|
}
|
||||||
|
if (registry.schemaVersion !== 1) {
|
||||||
|
throw new ConfigurationError("registry schemaVersion must be 1");
|
||||||
|
}
|
||||||
|
if (!Array.isArray(registry.sites) || registry.sites.length === 0) {
|
||||||
|
throw new ConfigurationError("registry.sites must contain at least one site");
|
||||||
|
}
|
||||||
|
|
||||||
|
const stateDirectory = requireAbsolutePath(
|
||||||
|
registry.stateDirectory,
|
||||||
|
"registry.stateDirectory"
|
||||||
|
);
|
||||||
|
const counterStatePath = requireAbsolutePath(
|
||||||
|
registry.counterStatePath,
|
||||||
|
"registry.counterStatePath"
|
||||||
|
);
|
||||||
|
if (!isWithin(stateDirectory, counterStatePath)) {
|
||||||
|
throw new ConfigurationError("counterStatePath must be below stateDirectory");
|
||||||
|
}
|
||||||
|
|
||||||
|
const ids = new Set();
|
||||||
|
const hostnames = new Set();
|
||||||
|
const analyticsLogPaths = new Set();
|
||||||
|
const outputDirectories = new Set();
|
||||||
|
const publicJsonPaths = new Set();
|
||||||
|
const sites = registry.sites.map((site, index) => {
|
||||||
|
const label = `registry.sites[${index}]`;
|
||||||
|
|
||||||
|
if (!site || typeof site !== "object" || Array.isArray(site)) {
|
||||||
|
throw new ConfigurationError(`${label} must be an object`);
|
||||||
|
}
|
||||||
|
if (typeof site.id !== "string" || !/^[a-z0-9][a-z0-9-]{0,62}$/.test(site.id)) {
|
||||||
|
throw new ConfigurationError(`${label}.id is invalid`);
|
||||||
|
}
|
||||||
|
if (site.id === "combined") {
|
||||||
|
throw new ConfigurationError(`${label}.id is reserved`);
|
||||||
|
}
|
||||||
|
if (ids.has(site.id)) {
|
||||||
|
throw new ConfigurationError(`duplicate site id: ${site.id}`);
|
||||||
|
}
|
||||||
|
ids.add(site.id);
|
||||||
|
|
||||||
|
if (typeof site.hostname !== "string"
|
||||||
|
|| !/^[a-z0-9.-]+$/.test(site.hostname)
|
||||||
|
|| site.hostname.includes("..")) {
|
||||||
|
throw new ConfigurationError(`${label}.hostname is invalid`);
|
||||||
|
}
|
||||||
|
const hostname = site.hostname.toLowerCase();
|
||||||
|
if (hostname === RESERVED_STATS_HOST) {
|
||||||
|
throw new ConfigurationError(`${RESERVED_STATS_HOST} must not be registered`);
|
||||||
|
}
|
||||||
|
if (hostnames.has(hostname)) {
|
||||||
|
throw new ConfigurationError(`duplicate hostname: ${hostname}`);
|
||||||
|
}
|
||||||
|
hostnames.add(hostname);
|
||||||
|
|
||||||
|
const activatedOn = parseIsoDate(site.activatedOn);
|
||||||
|
if (!activatedOn) {
|
||||||
|
throw new ConfigurationError(`${label}.activatedOn must be a valid ISO date`);
|
||||||
|
}
|
||||||
|
if (typeof site.publicCounter !== "boolean") {
|
||||||
|
throw new ConfigurationError(`${label}.publicCounter must be boolean`);
|
||||||
|
}
|
||||||
|
const analyticsLog = requireAbsolutePath(
|
||||||
|
site.analyticsLog,
|
||||||
|
`${label}.analyticsLog`
|
||||||
|
);
|
||||||
|
if (/\.(?:\d+|gz)$/i.test(path.basename(analyticsLog))) {
|
||||||
|
throw new ConfigurationError(
|
||||||
|
`${label}.analyticsLog must identify the current uncompressed log`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (analyticsLogPaths.has(analyticsLog)) {
|
||||||
|
throw new ConfigurationError(`analytics log is registered more than once: ${analyticsLog}`);
|
||||||
|
}
|
||||||
|
analyticsLogPaths.add(analyticsLog);
|
||||||
|
|
||||||
|
const reportOutputDirectory = requireAbsolutePath(
|
||||||
|
site.reportOutputDirectory,
|
||||||
|
`${label}.reportOutputDirectory`
|
||||||
|
);
|
||||||
|
if (!isWithin(stateDirectory, reportOutputDirectory)) {
|
||||||
|
throw new ConfigurationError(`${label}.reportOutputDirectory must be below stateDirectory`);
|
||||||
|
}
|
||||||
|
if (outputDirectories.has(reportOutputDirectory)) {
|
||||||
|
throw new ConfigurationError(`duplicate report output directory: ${reportOutputDirectory}`);
|
||||||
|
}
|
||||||
|
outputDirectories.add(reportOutputDirectory);
|
||||||
|
|
||||||
|
const publicJsonPath = site.publicCounter
|
||||||
|
? requireAbsolutePath(site.publicJsonPath, `${label}.publicJsonPath`)
|
||||||
|
: null;
|
||||||
|
if (publicJsonPath && !isWithin(stateDirectory, publicJsonPath)) {
|
||||||
|
throw new ConfigurationError(`${label}.publicJsonPath must be below stateDirectory`);
|
||||||
|
}
|
||||||
|
if (publicJsonPath === counterStatePath) {
|
||||||
|
throw new ConfigurationError(`${label}.publicJsonPath conflicts with counterStatePath`);
|
||||||
|
}
|
||||||
|
if (publicJsonPath && publicJsonPaths.has(publicJsonPath)) {
|
||||||
|
throw new ConfigurationError(`duplicate public JSON path: ${publicJsonPath}`);
|
||||||
|
}
|
||||||
|
if (publicJsonPath) {
|
||||||
|
publicJsonPaths.add(publicJsonPath);
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
id: site.id,
|
||||||
|
hostname,
|
||||||
|
activatedOn,
|
||||||
|
publicCounter: site.publicCounter,
|
||||||
|
analyticsLog,
|
||||||
|
reportOutputDirectory,
|
||||||
|
publicJsonPath
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!registry.combined || typeof registry.combined !== "object") {
|
||||||
|
throw new ConfigurationError("registry.combined must be an object");
|
||||||
|
}
|
||||||
|
|
||||||
|
const combinedReportOutputDirectory = requireAbsolutePath(
|
||||||
|
registry.combined.reportOutputDirectory,
|
||||||
|
"registry.combined.reportOutputDirectory"
|
||||||
|
);
|
||||||
|
if (!isWithin(stateDirectory, combinedReportOutputDirectory)) {
|
||||||
|
throw new ConfigurationError(
|
||||||
|
"registry.combined.reportOutputDirectory must be below stateDirectory"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (outputDirectories.has(combinedReportOutputDirectory)) {
|
||||||
|
throw new ConfigurationError(
|
||||||
|
`duplicate report output directory: ${combinedReportOutputDirectory}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
schemaVersion: 1,
|
||||||
|
stateDirectory,
|
||||||
|
counterStatePath,
|
||||||
|
lockFile: requireAbsolutePath(registry.lockFile, "registry.lockFile"),
|
||||||
|
geoIpCountryDatabase: requireAbsolutePath(
|
||||||
|
registry.geoIpCountryDatabase,
|
||||||
|
"registry.geoIpCountryDatabase"
|
||||||
|
),
|
||||||
|
combined: {
|
||||||
|
reportOutputDirectory: combinedReportOutputDirectory
|
||||||
|
},
|
||||||
|
sites
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function resolveAnalyticsLogs(site) {
|
||||||
|
const logs = [];
|
||||||
|
const candidates = [
|
||||||
|
{ path: `${site.analyticsLog}.1`, required: false },
|
||||||
|
{ path: site.analyticsLog, required: true }
|
||||||
|
];
|
||||||
|
|
||||||
|
for (const candidate of candidates) {
|
||||||
|
let stats;
|
||||||
|
try {
|
||||||
|
stats = fs.statSync(candidate.path);
|
||||||
|
} catch (error) {
|
||||||
|
if (!candidate.required && error.code === "ENOENT") {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
throw new ConfigurationError(`analytics log is not readable: ${candidate.path}`);
|
||||||
|
}
|
||||||
|
if (!stats.isFile()) {
|
||||||
|
throw new ConfigurationError(`analytics log is not a file: ${candidate.path}`);
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
fs.accessSync(candidate.path, fs.constants.R_OK);
|
||||||
|
} catch (error) {
|
||||||
|
throw new ConfigurationError(
|
||||||
|
`analytics log is not readable by the current user: ${candidate.path}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
logs.push(candidate.path);
|
||||||
|
}
|
||||||
|
|
||||||
|
return logs;
|
||||||
|
}
|
||||||
|
|
||||||
|
function requireWritableDirectory(directory, label) {
|
||||||
|
let stats;
|
||||||
|
try {
|
||||||
|
stats = fs.statSync(directory);
|
||||||
|
} catch (error) {
|
||||||
|
throw new ConfigurationError(`${label} does not exist: ${directory}`);
|
||||||
|
}
|
||||||
|
if (!stats.isDirectory()) {
|
||||||
|
throw new ConfigurationError(`${label} is not a directory: ${directory}`);
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
fs.accessSync(directory, fs.constants.W_OK | fs.constants.X_OK);
|
||||||
|
} catch (error) {
|
||||||
|
throw new ConfigurationError(
|
||||||
|
`${label} is not writable by the current user: ${directory}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function validateInputs(registry, configTemplate) {
|
||||||
|
const requiredConfigParts = [
|
||||||
|
"{{DB_PATH}}",
|
||||||
|
"{{RESTORE_DIRECTIVE}}",
|
||||||
|
"{{GEOIP_COUNTRY_DATABASE}}",
|
||||||
|
"persist true",
|
||||||
|
"anonymize-ip true",
|
||||||
|
"ignore-crawlers true",
|
||||||
|
"unknowns-as-crawlers true",
|
||||||
|
"keep-last 395"
|
||||||
|
];
|
||||||
|
|
||||||
|
for (const required of requiredConfigParts) {
|
||||||
|
if (!configTemplate.includes(required)) {
|
||||||
|
throw new ConfigurationError(`GoAccess template is missing: ${required}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const analyticsLogsBySite = new Map(registry.sites.map(site => [
|
||||||
|
site.id,
|
||||||
|
resolveAnalyticsLogs(site)
|
||||||
|
]));
|
||||||
|
|
||||||
|
let geoStats;
|
||||||
|
try {
|
||||||
|
geoStats = fs.statSync(registry.geoIpCountryDatabase);
|
||||||
|
} catch (error) {
|
||||||
|
throw new ConfigurationError(
|
||||||
|
`GeoIP Country database is not readable: ${registry.geoIpCountryDatabase}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (!geoStats.isFile() || /city/i.test(path.basename(registry.geoIpCountryDatabase))) {
|
||||||
|
throw new ConfigurationError("geoIpCountryDatabase must be a Country database file");
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
fs.accessSync(registry.geoIpCountryDatabase, fs.constants.R_OK);
|
||||||
|
} catch (error) {
|
||||||
|
throw new ConfigurationError(
|
||||||
|
`GeoIP Country database is not readable by the current user: `
|
||||||
|
+ registry.geoIpCountryDatabase
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
requireWritableDirectory(registry.stateDirectory, "stateDirectory");
|
||||||
|
requireWritableDirectory(
|
||||||
|
registry.combined.reportOutputDirectory,
|
||||||
|
"combined report output directory"
|
||||||
|
);
|
||||||
|
for (const site of registry.sites) {
|
||||||
|
requireWritableDirectory(
|
||||||
|
site.reportOutputDirectory,
|
||||||
|
`report output directory for ${site.id}`
|
||||||
|
);
|
||||||
|
if (site.publicCounter) {
|
||||||
|
requireWritableDirectory(
|
||||||
|
path.dirname(site.publicJsonPath),
|
||||||
|
`public output directory for ${site.id}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return analyticsLogsBySite;
|
||||||
|
}
|
||||||
|
|
||||||
|
function renderGoAccessConfig(template, dbPath, restore, geoIpCountryDatabase) {
|
||||||
|
const rendered = template
|
||||||
|
.replaceAll("{{DB_PATH}}", dbPath)
|
||||||
|
.replaceAll(
|
||||||
|
"{{RESTORE_DIRECTIVE}}",
|
||||||
|
restore ? "restore true" : "# restore is disabled until a database exists"
|
||||||
|
)
|
||||||
|
.replaceAll("{{GEOIP_COUNTRY_DATABASE}}", geoIpCountryDatabase);
|
||||||
|
|
||||||
|
if (/{{[A-Z_]+}}/.test(rendered)) {
|
||||||
|
throw new ConfigurationError("GoAccess template contains an unknown placeholder");
|
||||||
|
}
|
||||||
|
|
||||||
|
return rendered;
|
||||||
|
}
|
||||||
|
|
||||||
|
function defaultRunGoAccess({ binary, args }) {
|
||||||
|
const result = spawnSync(binary, args, {
|
||||||
|
encoding: "utf8",
|
||||||
|
maxBuffer: 1024 * 1024,
|
||||||
|
timeout: 30 * 60 * 1000,
|
||||||
|
windowsHide: true
|
||||||
|
});
|
||||||
|
|
||||||
|
if (result.error) {
|
||||||
|
throw new Error(`could not start GoAccess: ${result.error.message}`);
|
||||||
|
}
|
||||||
|
if (result.status !== 0) {
|
||||||
|
const detail = (result.stderr || result.stdout || "no diagnostic output").trim();
|
||||||
|
throw new Error(`GoAccess failed with exit code ${result.status}: ${detail}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function defaultCheckGoAccess(binary) {
|
||||||
|
const result = spawnSync(binary, ["--version"], {
|
||||||
|
encoding: "utf8",
|
||||||
|
timeout: 10000,
|
||||||
|
windowsHide: true
|
||||||
|
});
|
||||||
|
|
||||||
|
if (result.error || result.status !== 0) {
|
||||||
|
const detail = result.error
|
||||||
|
? result.error.message
|
||||||
|
: (result.stderr || result.stdout || "no diagnostic output").trim();
|
||||||
|
throw new ConfigurationError(`GoAccess is not available: ${detail}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return parseGoAccessVersion(`${result.stdout || ""}\n${result.stderr || ""}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
function parseGoAccessVersion(output) {
|
||||||
|
const versionMatch = /GoAccess\s+-\s+([0-9]+(?:\.[0-9]+)+)/i.exec(output);
|
||||||
|
|
||||||
|
return {
|
||||||
|
version: versionMatch ? versionMatch[1] : "unknown",
|
||||||
|
geoIpMmdb: /--enable-geoip=mmdb\b/i.test(output),
|
||||||
|
openSsl: /--with-openssl\b/i.test(output),
|
||||||
|
zlib: /--with-zlib\b/i.test(output)
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatGoAccessCheck(capabilities) {
|
||||||
|
const detected = [
|
||||||
|
`GeoIP2/MMDB ${capabilities.geoIpMmdb ? "enabled" : "not detected"}`,
|
||||||
|
`OpenSSL ${capabilities.openSsl ? "enabled" : "not detected"}`,
|
||||||
|
`Zlib ${capabilities.zlib ? "enabled" : "not detected"}`
|
||||||
|
].join(", ");
|
||||||
|
const summary = `GoAccess ${capabilities.version}: ${detected}.`;
|
||||||
|
|
||||||
|
if (capabilities.zlib) {
|
||||||
|
return summary;
|
||||||
|
}
|
||||||
|
|
||||||
|
return `${summary} This build has no Zlib support. That is valid for regular mode: `
|
||||||
|
+ "the current analytics log and its optional uncompressed .1 rotation are read "
|
||||||
|
+ "directly; older .gz logs are not imported.";
|
||||||
|
}
|
||||||
|
|
||||||
|
function parseGoAccessDate(value) {
|
||||||
|
if (typeof value !== "string") {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
if (parseIsoDate(value)) {
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
if (/^\d{8}$/.test(value)) {
|
||||||
|
return parseIsoDate(`${value.slice(0, 4)}-${value.slice(4, 6)}-${value.slice(6, 8)}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const match = /^(\d{2})\/([A-Za-z]{3})\/(\d{4})$/.exec(value);
|
||||||
|
const months = {
|
||||||
|
Jan: "01", Feb: "02", Mar: "03", Apr: "04", May: "05", Jun: "06",
|
||||||
|
Jul: "07", Aug: "08", Sep: "09", Oct: "10", Nov: "11", Dec: "12"
|
||||||
|
};
|
||||||
|
|
||||||
|
return match && months[match[2]]
|
||||||
|
? parseIsoDate(`${match[3]}-${months[match[2]]}-${match[1]}`)
|
||||||
|
: null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function validateReport(report, combined) {
|
||||||
|
if (!report || typeof report !== "object" || Array.isArray(report)) {
|
||||||
|
throw new Error("GoAccess JSON report must be an object");
|
||||||
|
}
|
||||||
|
const requiredPanels = ["visitors", "requests", "status_codes", "geolocation"];
|
||||||
|
if (combined) {
|
||||||
|
requiredPanels.push("vhosts");
|
||||||
|
}
|
||||||
|
if (!report.general || typeof report.general !== "object") {
|
||||||
|
throw new Error("GoAccess JSON report has no general summary");
|
||||||
|
}
|
||||||
|
for (const panel of requiredPanels) {
|
||||||
|
if (!report[panel] || !Array.isArray(report[panel].data)) {
|
||||||
|
throw new Error(`GoAccess JSON report has no ${panel} panel`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
extractDailyVisits(report);
|
||||||
|
return report;
|
||||||
|
}
|
||||||
|
|
||||||
|
function readAndValidateReport(jsonPath, htmlPath, combined) {
|
||||||
|
let report;
|
||||||
|
try {
|
||||||
|
report = JSON.parse(fs.readFileSync(jsonPath, "utf8"));
|
||||||
|
} catch (error) {
|
||||||
|
throw new Error(`GoAccess JSON output is invalid: ${error.message}`);
|
||||||
|
}
|
||||||
|
validateReport(report, combined);
|
||||||
|
|
||||||
|
const html = fs.readFileSync(htmlPath, "utf8");
|
||||||
|
if (html.length < 100 || !/<html(?:\s|>)/i.test(html)) {
|
||||||
|
throw new Error("GoAccess HTML output is missing or implausibly small");
|
||||||
|
}
|
||||||
|
|
||||||
|
return report;
|
||||||
|
}
|
||||||
|
|
||||||
|
function extractDailyVisits(report) {
|
||||||
|
const daily = {};
|
||||||
|
|
||||||
|
for (const row of report.visitors.data) {
|
||||||
|
const date = parseGoAccessDate(row && row.data);
|
||||||
|
const visits = row && row.visitors && row.visitors.count;
|
||||||
|
|
||||||
|
if (!date || !Number.isSafeInteger(visits) || visits < 0) {
|
||||||
|
throw new Error("GoAccess visitors panel contains invalid daily data");
|
||||||
|
}
|
||||||
|
if (Object.hasOwn(daily, date)) {
|
||||||
|
throw new Error(`GoAccess visitors panel contains duplicate date ${date}`);
|
||||||
|
}
|
||||||
|
daily[date] = visits;
|
||||||
|
}
|
||||||
|
|
||||||
|
return daily;
|
||||||
|
}
|
||||||
|
|
||||||
|
function loadCounterState(statePath) {
|
||||||
|
if (!fs.existsSync(statePath)) {
|
||||||
|
return { schemaVersion: STATE_SCHEMA_VERSION, sites: {} };
|
||||||
|
}
|
||||||
|
|
||||||
|
const state = readJson(statePath, "counter state");
|
||||||
|
if (state.schemaVersion !== STATE_SCHEMA_VERSION
|
||||||
|
|| !state.sites || typeof state.sites !== "object" || Array.isArray(state.sites)) {
|
||||||
|
throw new ConfigurationError("counter state has an unsupported structure");
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const [siteId, site] of Object.entries(state.sites)) {
|
||||||
|
if (!site || typeof site !== "object" || !parseIsoDate(site.since)
|
||||||
|
|| !site.dailyVisits || typeof site.dailyVisits !== "object"
|
||||||
|
|| Array.isArray(site.dailyVisits)) {
|
||||||
|
throw new ConfigurationError(`counter state for ${siteId} is invalid`);
|
||||||
|
}
|
||||||
|
for (const [date, visits] of Object.entries(site.dailyVisits)) {
|
||||||
|
if (!parseIsoDate(date) || !Number.isSafeInteger(visits) || visits < 0) {
|
||||||
|
throw new ConfigurationError(`counter state value for ${siteId}/${date} is invalid`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return state;
|
||||||
|
}
|
||||||
|
|
||||||
|
function updateCounterState(state, site, report) {
|
||||||
|
const current = state.sites[site.id];
|
||||||
|
if (current && current.since !== site.activatedOn) {
|
||||||
|
throw new ConfigurationError(
|
||||||
|
`activation date for ${site.id} differs from the existing counter state`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (current && current.hostname !== site.hostname) {
|
||||||
|
throw new ConfigurationError(
|
||||||
|
`hostname for ${site.id} differs from the existing counter state`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const dailyVisits = current ? { ...current.dailyVisits } : {};
|
||||||
|
for (const [date, visits] of Object.entries(extractDailyVisits(report))) {
|
||||||
|
if (date >= site.activatedOn) {
|
||||||
|
dailyVisits[date] = visits;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
state.sites[site.id] = {
|
||||||
|
hostname: site.hostname,
|
||||||
|
since: site.activatedOn,
|
||||||
|
dailyVisits
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function publicPayload(state, site, now) {
|
||||||
|
const siteState = state.sites[site.id];
|
||||||
|
let visits = 0;
|
||||||
|
|
||||||
|
for (const [date, value] of Object.entries(siteState.dailyVisits)) {
|
||||||
|
if (date >= site.activatedOn) {
|
||||||
|
visits += value;
|
||||||
|
if (!Number.isSafeInteger(visits) || visits > MAX_SAFE_INTEGER) {
|
||||||
|
throw new Error(`public visit total for ${site.id} exceeds the safe integer range`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
schemaVersion: PUBLIC_SCHEMA_VERSION,
|
||||||
|
visits,
|
||||||
|
since: site.activatedOn,
|
||||||
|
updatedAt: now.toISOString().replace(/\.\d{3}Z$/, "Z")
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function atomicWriteFile(destination, content, mode = 0o640) {
|
||||||
|
const directory = path.dirname(destination);
|
||||||
|
const temporary = path.join(
|
||||||
|
directory,
|
||||||
|
`.${path.basename(destination)}.${process.pid}.${Date.now()}.tmp`
|
||||||
|
);
|
||||||
|
const handle = fs.openSync(temporary, "wx", mode);
|
||||||
|
|
||||||
|
try {
|
||||||
|
fs.writeFileSync(handle, content);
|
||||||
|
fs.fchmodSync(handle, mode);
|
||||||
|
fs.fsyncSync(handle);
|
||||||
|
} finally {
|
||||||
|
fs.closeSync(handle);
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
fs.renameSync(temporary, destination);
|
||||||
|
} catch (error) {
|
||||||
|
fs.rmSync(temporary, { force: true });
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function atomicCopyFile(source, destination) {
|
||||||
|
atomicWriteFile(destination, fs.readFileSync(source));
|
||||||
|
}
|
||||||
|
|
||||||
|
function replaceDirectory(source, destination) {
|
||||||
|
fs.mkdirSync(path.dirname(destination), { recursive: true });
|
||||||
|
const backup = `${destination}.previous-${process.pid}`;
|
||||||
|
const hadDestination = fs.existsSync(destination);
|
||||||
|
|
||||||
|
if (fs.existsSync(backup)) {
|
||||||
|
throw new Error(`stale database backup blocks replacement: ${backup}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (hadDestination) {
|
||||||
|
fs.renameSync(destination, backup);
|
||||||
|
}
|
||||||
|
fs.renameSync(source, destination);
|
||||||
|
if (hadDestination) {
|
||||||
|
fs.rmSync(backup, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
if (!fs.existsSync(destination) && fs.existsSync(backup)) {
|
||||||
|
fs.renameSync(backup, destination);
|
||||||
|
}
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function acquireLock(lockPath) {
|
||||||
|
fs.mkdirSync(path.dirname(lockPath), { recursive: true });
|
||||||
|
let descriptor;
|
||||||
|
|
||||||
|
try {
|
||||||
|
descriptor = fs.openSync(lockPath, "wx", 0o640);
|
||||||
|
fs.writeFileSync(descriptor, `${process.pid}\n`);
|
||||||
|
} catch (error) {
|
||||||
|
throw new LockError(`another analytics run is active (${lockPath})`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
fs.closeSync(descriptor);
|
||||||
|
fs.rmSync(lockPath, { force: true });
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function createReportJob(id, logs, outputDirectory, combined) {
|
||||||
|
return { id, logs, outputDirectory, combined };
|
||||||
|
}
|
||||||
|
|
||||||
|
function prepareReport(job, context) {
|
||||||
|
const jobDirectory = path.join(context.runDirectory, job.id);
|
||||||
|
const stagedDb = path.join(jobDirectory, "db");
|
||||||
|
const currentDb = path.join(context.registry.stateDirectory, "db", job.id);
|
||||||
|
const outputJson = path.join(jobDirectory, "report.json");
|
||||||
|
const outputHtml = path.join(jobDirectory, "report.html");
|
||||||
|
const runConfig = path.join(jobDirectory, "goaccess.conf");
|
||||||
|
let hasDatabase = false;
|
||||||
|
|
||||||
|
if (fs.existsSync(currentDb)) {
|
||||||
|
if (!fs.statSync(currentDb).isDirectory()) {
|
||||||
|
throw new Error(`GoAccess database path is not a directory: ${currentDb}`);
|
||||||
|
}
|
||||||
|
hasDatabase = fs.readdirSync(currentDb).length > 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
fs.mkdirSync(jobDirectory, { recursive: true });
|
||||||
|
if (hasDatabase) {
|
||||||
|
fs.cpSync(currentDb, stagedDb, { recursive: true, errorOnExist: true });
|
||||||
|
} else {
|
||||||
|
fs.mkdirSync(stagedDb);
|
||||||
|
}
|
||||||
|
fs.writeFileSync(runConfig, renderGoAccessConfig(
|
||||||
|
context.configTemplate,
|
||||||
|
stagedDb,
|
||||||
|
hasDatabase,
|
||||||
|
context.registry.geoIpCountryDatabase
|
||||||
|
));
|
||||||
|
|
||||||
|
const args = [
|
||||||
|
...job.logs,
|
||||||
|
"--no-global-config",
|
||||||
|
"--config-file", runConfig
|
||||||
|
];
|
||||||
|
if (job.combined) {
|
||||||
|
args.push("--enable-panel=VIRTUAL_HOSTS");
|
||||||
|
}
|
||||||
|
args.push(
|
||||||
|
"--output", outputJson,
|
||||||
|
"--output", outputHtml
|
||||||
|
);
|
||||||
|
context.runGoAccess({
|
||||||
|
binary: context.goaccessBinary,
|
||||||
|
args,
|
||||||
|
id: job.id,
|
||||||
|
combined: job.combined,
|
||||||
|
outputJson,
|
||||||
|
outputHtml,
|
||||||
|
dbPath: stagedDb
|
||||||
|
});
|
||||||
|
|
||||||
|
return {
|
||||||
|
...job,
|
||||||
|
report: readAndValidateReport(outputJson, outputHtml, job.combined),
|
||||||
|
outputJson,
|
||||||
|
outputHtml,
|
||||||
|
stagedDb,
|
||||||
|
currentDb
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function generateReports(options, dependencies = {}) {
|
||||||
|
const registryPath = path.resolve(options.registryPath);
|
||||||
|
const configTemplatePath = path.resolve(options.configTemplatePath);
|
||||||
|
const registry = validateRegistry(readJson(registryPath, "site registry"));
|
||||||
|
const configTemplate = fs.readFileSync(configTemplatePath, "utf8");
|
||||||
|
const runGoAccess = dependencies.runGoAccess || defaultRunGoAccess;
|
||||||
|
const checkGoAccess = dependencies.checkGoAccess || defaultCheckGoAccess;
|
||||||
|
const now = dependencies.now ? dependencies.now() : new Date();
|
||||||
|
|
||||||
|
const analyticsLogsBySite = validateInputs(registry, configTemplate);
|
||||||
|
const goAccess = checkGoAccess(options.goaccessBinary || "goaccess");
|
||||||
|
if (!goAccess || !goAccess.geoIpMmdb) {
|
||||||
|
throw new ConfigurationError(
|
||||||
|
"GoAccess must be built with GeoIP2/MMDB support (--enable-geoip=mmdb)"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (options.check) {
|
||||||
|
return { checked: true, sites: registry.sites.length, goAccess };
|
||||||
|
}
|
||||||
|
|
||||||
|
const releaseLock = options.dryRun || dependencies.skipLock
|
||||||
|
? () => {}
|
||||||
|
: acquireLock(registry.lockFile);
|
||||||
|
let runDirectory;
|
||||||
|
|
||||||
|
try {
|
||||||
|
runDirectory = fs.mkdtempSync(path.join(
|
||||||
|
options.dryRun ? os.tmpdir() : registry.stateDirectory,
|
||||||
|
".analytics-run-"
|
||||||
|
));
|
||||||
|
|
||||||
|
const jobs = registry.sites.map(site => createReportJob(
|
||||||
|
site.id,
|
||||||
|
analyticsLogsBySite.get(site.id),
|
||||||
|
site.reportOutputDirectory,
|
||||||
|
false
|
||||||
|
));
|
||||||
|
jobs.push(createReportJob(
|
||||||
|
"combined",
|
||||||
|
registry.sites.flatMap(site => analyticsLogsBySite.get(site.id)),
|
||||||
|
registry.combined.reportOutputDirectory,
|
||||||
|
true
|
||||||
|
));
|
||||||
|
|
||||||
|
const context = {
|
||||||
|
registry,
|
||||||
|
configTemplate,
|
||||||
|
goaccessBinary: options.goaccessBinary || "goaccess",
|
||||||
|
runGoAccess,
|
||||||
|
runDirectory
|
||||||
|
};
|
||||||
|
const prepared = jobs.map(job => prepareReport(job, context));
|
||||||
|
const state = loadCounterState(registry.counterStatePath);
|
||||||
|
|
||||||
|
for (const site of registry.sites.filter(entry => entry.publicCounter)) {
|
||||||
|
const generated = prepared.find(entry => entry.id === site.id);
|
||||||
|
updateCounterState(state, site, generated.report);
|
||||||
|
}
|
||||||
|
|
||||||
|
const publicFiles = registry.sites
|
||||||
|
.filter(site => site.publicCounter)
|
||||||
|
.map(site => ({
|
||||||
|
destination: site.publicJsonPath,
|
||||||
|
content: `${JSON.stringify(publicPayload(state, site, now), null, 2)}\n`
|
||||||
|
}));
|
||||||
|
|
||||||
|
if (!options.dryRun) {
|
||||||
|
for (const report of prepared) {
|
||||||
|
atomicCopyFile(
|
||||||
|
report.outputJson,
|
||||||
|
path.join(report.outputDirectory, "report.json")
|
||||||
|
);
|
||||||
|
atomicCopyFile(
|
||||||
|
report.outputHtml,
|
||||||
|
path.join(report.outputDirectory, "report.html")
|
||||||
|
);
|
||||||
|
}
|
||||||
|
for (const report of prepared) {
|
||||||
|
replaceDirectory(report.stagedDb, report.currentDb);
|
||||||
|
}
|
||||||
|
atomicWriteFile(
|
||||||
|
registry.counterStatePath,
|
||||||
|
`${JSON.stringify(state, null, 2)}\n`
|
||||||
|
);
|
||||||
|
for (const publicFile of publicFiles) {
|
||||||
|
atomicWriteFile(publicFile.destination, publicFile.content, 0o644);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
checked: false,
|
||||||
|
dryRun: Boolean(options.dryRun),
|
||||||
|
sites: registry.sites.length,
|
||||||
|
reports: prepared.length,
|
||||||
|
publicCounters: publicFiles.length
|
||||||
|
};
|
||||||
|
} finally {
|
||||||
|
if (runDirectory && fs.existsSync(runDirectory)) {
|
||||||
|
fs.rmSync(runDirectory, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
releaseLock();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function parseArguments(argv) {
|
||||||
|
const options = { check: false, dryRun: false, goaccessBinary: "goaccess" };
|
||||||
|
|
||||||
|
for (let index = 0; index < argv.length; index += 1) {
|
||||||
|
const argument = argv[index];
|
||||||
|
if (argument === "--check") {
|
||||||
|
options.check = true;
|
||||||
|
} else if (argument === "--dry-run") {
|
||||||
|
options.dryRun = true;
|
||||||
|
} else if (["--registry", "--config-template", "--goaccess"].includes(argument)) {
|
||||||
|
const value = argv[index + 1];
|
||||||
|
if (!value) {
|
||||||
|
throw new ConfigurationError(`${argument} requires a value`);
|
||||||
|
}
|
||||||
|
index += 1;
|
||||||
|
if (argument === "--registry") options.registryPath = value;
|
||||||
|
if (argument === "--config-template") options.configTemplatePath = value;
|
||||||
|
if (argument === "--goaccess") options.goaccessBinary = value;
|
||||||
|
} else {
|
||||||
|
throw new ConfigurationError(`unknown argument: ${argument}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!options.registryPath || !options.configTemplatePath) {
|
||||||
|
throw new ConfigurationError(
|
||||||
|
"usage: generate-reports.js --registry FILE --config-template FILE "
|
||||||
|
+ "[--goaccess FILE] [--check|--dry-run]"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (options.check && options.dryRun) {
|
||||||
|
throw new ConfigurationError("--check and --dry-run are mutually exclusive");
|
||||||
|
}
|
||||||
|
|
||||||
|
return options;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (require.main === module) {
|
||||||
|
try {
|
||||||
|
const result = generateReports(parseArguments(process.argv.slice(2)));
|
||||||
|
const action = result.checked ? "Configuration check" : "Analytics generation";
|
||||||
|
if (result.checked) {
|
||||||
|
process.stdout.write(`${formatGoAccessCheck(result.goAccess)}\n`);
|
||||||
|
}
|
||||||
|
process.stdout.write(`${action} completed: ${JSON.stringify(result)}\n`);
|
||||||
|
} catch (error) {
|
||||||
|
process.stderr.write(`analytics: ${error.message}\n`);
|
||||||
|
process.exitCode = error.exitCode || 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
ConfigurationError,
|
||||||
|
extractDailyVisits,
|
||||||
|
formatGoAccessCheck,
|
||||||
|
generateReports,
|
||||||
|
parseGoAccessVersion,
|
||||||
|
parseArguments,
|
||||||
|
publicPayload,
|
||||||
|
updateCounterState,
|
||||||
|
validateRegistry,
|
||||||
|
validateReport
|
||||||
|
};
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
# Rendered by generate-reports.js. Do not use this file without replacing
|
||||||
|
# all {{...}} placeholders.
|
||||||
|
|
||||||
|
datetime-format %Y-%m-%dT%H:%M:%S%z
|
||||||
|
log-format %v\t%h\t%x\t%m\t%U\t%H\t%s\t%b\t"%u"
|
||||||
|
|
||||||
|
anonymize-ip true
|
||||||
|
anonymize-level 2
|
||||||
|
ignore-crawlers true
|
||||||
|
unknowns-as-crawlers true
|
||||||
|
keep-last 395
|
||||||
|
|
||||||
|
persist true
|
||||||
|
{{RESTORE_DIRECTIVE}}
|
||||||
|
db-path {{DB_PATH}}
|
||||||
|
|
||||||
|
geoip-database {{GEOIP_COUNTRY_DATABASE}}
|
||||||
|
|
||||||
|
json-pretty-print true
|
||||||
|
no-progress true
|
||||||
|
no-parsing-spinner true
|
||||||
|
no-color true
|
||||||
|
agent-list false
|
||||||
|
http-method true
|
||||||
|
http-protocol true
|
||||||
|
max-items 500
|
||||||
|
|
||||||
|
# The Nginx analytics log contains $uri rather than $request_uri, so query
|
||||||
|
# strings never reach GoAccess. These panels are deliberately unavailable.
|
||||||
|
ignore-panel HOSTS
|
||||||
|
ignore-panel OS
|
||||||
|
ignore-panel BROWSERS
|
||||||
|
ignore-panel REFERRERS
|
||||||
|
ignore-panel REFERRING_SITES
|
||||||
|
ignore-panel KEYPHRASES
|
||||||
|
ignore-panel REMOTE_USER
|
||||||
|
ignore-panel REQUESTS_STATIC
|
||||||
|
ignore-panel VISIT_TIMES
|
||||||
|
ignore-panel NOT_FOUND
|
||||||
|
ignore-panel ASN
|
||||||
|
ignore-panel MIME_TYPE
|
||||||
|
ignore-panel TLS_TYPE
|
||||||
|
ignore-panel CACHE_STATUS
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
/var/log/nginx/*-analytics.log {
|
||||||
|
daily
|
||||||
|
rotate 14
|
||||||
|
missingok
|
||||||
|
notifempty
|
||||||
|
compress
|
||||||
|
# Keep .1 uncompressed because the regular generator reads it directly.
|
||||||
|
delaycompress
|
||||||
|
create 0640 www-data hamradio-analytics
|
||||||
|
sharedscripts
|
||||||
|
postrotate
|
||||||
|
invoke-rc.d nginx rotate >/dev/null 2>&1
|
||||||
|
endscript
|
||||||
|
}
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
# Only page GET requests which are candidates for the reach statistics enter
|
||||||
|
# the dedicated analytics log. GoAccess performs the second bot-classification
|
||||||
|
# layer, including unknown browsers and operating systems.
|
||||||
|
map $request_method $hamradioonline_analytics_method {
|
||||||
|
default 0;
|
||||||
|
GET 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
map $uri $hamradioonline_analytics_path {
|
||||||
|
default 1;
|
||||||
|
|
||||||
|
/visitor-count.json 0;
|
||||||
|
/kst4ContestVersionInfo.xml 0;
|
||||||
|
/sitemap.xml 0;
|
||||||
|
/robots.txt 0;
|
||||||
|
/favicon.ico 0;
|
||||||
|
/assets/favicon.svg 0;
|
||||||
|
/health 0;
|
||||||
|
/healthz 0;
|
||||||
|
/ping 0;
|
||||||
|
/status 0;
|
||||||
|
|
||||||
|
~*^/(?:assets|manual/assets)/ 0;
|
||||||
|
~*\.(?:css|js|mjs|map|json|png|jpe?g|gif|svg|webp|avif|ico|woff2?|ttf|otf|eot|xml|txt|pdf|zip|gz|wasm|mp4|webm)$ 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
map $http_user_agent $hamradioonline_analytics_known_bot {
|
||||||
|
default 0;
|
||||||
|
~*(?:bot|crawler|spider|slurp|headless|monitor|healthcheck|uptime|wget|curl) 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
map "$hamradioonline_analytics_method:$hamradioonline_analytics_path:$hamradioonline_analytics_known_bot"
|
||||||
|
$hamradioonline_analytics_loggable {
|
||||||
|
default 0;
|
||||||
|
"1:1:0" 1;
|
||||||
|
}
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
# Include in the Nginx http context. $uri is the normalized path and excludes
|
||||||
|
# the query string. The format intentionally omits referrer and remote user.
|
||||||
|
log_format hamradioonline_analytics
|
||||||
|
'$server_name\t$remote_addr\t$time_iso8601\t$request_method\t$uri\t'
|
||||||
|
'$server_protocol\t$status\t$body_bytes_sent\t"$http_user_agent"';
|
||||||
|
|
||||||
|
# Include the maps below in the Nginx http context as well.
|
||||||
|
include /etc/nginx/snippets/hamradioonline-analytics-filters.conf;
|
||||||
|
|
||||||
|
# Add this extra log to each registered project server block. Keep the
|
||||||
|
# existing operational access_log directive; do not replace it implicitly.
|
||||||
|
#
|
||||||
|
# access_log /var/log/nginx/kst4contest-analytics.log
|
||||||
|
# hamradioonline_analytics if=$hamradioonline_analytics_loggable;
|
||||||
|
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# Include inside the kst4contest.hamradioonline.de HTTPS server block. Grant
|
||||||
|
# the Nginx worker read access to the file and directory, but no write access.
|
||||||
|
location = /visitor-count.json {
|
||||||
|
alias /var/lib/hamradioonline-analytics/public/kst4contest/visitor-count.json;
|
||||||
|
default_type application/json;
|
||||||
|
access_log off;
|
||||||
|
add_header Cache-Control "public, max-age=3600" always;
|
||||||
|
add_header X-Content-Type-Options "nosniff" always;
|
||||||
|
}
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# Temporary HTTP-only virtual host for initial certificate provisioning.
|
||||||
|
# Replace it with stats-vhost.conf.example after Certbot has succeeded.
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
server_name stats.hamradioonline.de;
|
||||||
|
|
||||||
|
access_log off;
|
||||||
|
|
||||||
|
location ^~ /.well-known/acme-challenge/ {
|
||||||
|
root /var/lib/letsencrypt;
|
||||||
|
default_type text/plain;
|
||||||
|
}
|
||||||
|
|
||||||
|
location / {
|
||||||
|
return 404;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
# Keep this HTTP server active so Certbot can renew the webroot certificate.
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
server_name stats.hamradioonline.de;
|
||||||
|
|
||||||
|
access_log off;
|
||||||
|
|
||||||
|
location ^~ /.well-known/acme-challenge/ {
|
||||||
|
root /var/lib/letsencrypt;
|
||||||
|
default_type text/plain;
|
||||||
|
}
|
||||||
|
|
||||||
|
location / {
|
||||||
|
return 301 https://$host$request_uri;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# This server exposes static reports only. Provision the certificate and the
|
||||||
|
# htpasswd file outside the repository. Do not add this host to sites.json.
|
||||||
|
server {
|
||||||
|
listen 443 ssl http2;
|
||||||
|
server_name stats.hamradioonline.de;
|
||||||
|
|
||||||
|
ssl_certificate /etc/letsencrypt/live/stats.hamradioonline.de/fullchain.pem;
|
||||||
|
ssl_certificate_key /etc/letsencrypt/live/stats.hamradioonline.de/privkey.pem;
|
||||||
|
include /etc/letsencrypt/options-ssl-nginx.conf;
|
||||||
|
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;
|
||||||
|
|
||||||
|
root /var/lib/hamradioonline-analytics/reports;
|
||||||
|
index report.html;
|
||||||
|
|
||||||
|
auth_basic "Private project statistics";
|
||||||
|
auth_basic_user_file /etc/nginx/htpasswd/hamradioonline-analytics;
|
||||||
|
|
||||||
|
access_log off;
|
||||||
|
add_header Cache-Control "private, no-store" always;
|
||||||
|
add_header X-Content-Type-Options "nosniff" always;
|
||||||
|
add_header X-Frame-Options "DENY" always;
|
||||||
|
|
||||||
|
location = / {
|
||||||
|
try_files /__no_report_at_root__ @combined_reports;
|
||||||
|
}
|
||||||
|
|
||||||
|
location @combined_reports {
|
||||||
|
return 302 /combined/;
|
||||||
|
}
|
||||||
|
|
||||||
|
location / {
|
||||||
|
try_files $uri $uri/ =404;
|
||||||
|
}
|
||||||
|
|
||||||
|
location ~ /\. {
|
||||||
|
deny all;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# IPv6 is deliberately omitted until the DNS AAAA record has been confirmed.
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
{
|
||||||
|
"schemaVersion": 1,
|
||||||
|
"stateDirectory": "/var/lib/hamradioonline-analytics",
|
||||||
|
"counterStatePath": "/var/lib/hamradioonline-analytics/public-counter-state.json",
|
||||||
|
"lockFile": "/run/hamradioonline-analytics/generator.lock",
|
||||||
|
"geoIpCountryDatabase": "/var/lib/GeoIP/GeoLite2-Country.mmdb",
|
||||||
|
"combined": {
|
||||||
|
"reportOutputDirectory": "/var/lib/hamradioonline-analytics/reports/combined"
|
||||||
|
},
|
||||||
|
"sites": [
|
||||||
|
{
|
||||||
|
"id": "kst4contest",
|
||||||
|
"hostname": "kst4contest.hamradioonline.de",
|
||||||
|
"analyticsLog": "/var/log/nginx/kst4contest-analytics.log",
|
||||||
|
"activatedOn": "2026-09-11",
|
||||||
|
"publicCounter": true,
|
||||||
|
"reportOutputDirectory": "/var/lib/hamradioonline-analytics/reports/kst4contest",
|
||||||
|
"publicJsonPath": "/var/lib/hamradioonline-analytics/public/kst4contest/visitor-count.json"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Generate private GoAccess reports and public project counters
|
||||||
|
After=nginx.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=hamradio-analytics
|
||||||
|
Group=hamradio-analytics
|
||||||
|
UMask=0027
|
||||||
|
Environment=LC_TIME=C
|
||||||
|
ExecStart=/usr/bin/node /opt/hamradioonline-analytics/generate-reports.js --registry /etc/hamradioonline-analytics/sites.json --config-template /etc/hamradioonline-analytics/goaccess.conf.template
|
||||||
|
|
||||||
|
NoNewPrivileges=true
|
||||||
|
PrivateDevices=true
|
||||||
|
PrivateNetwork=true
|
||||||
|
ProtectClock=true
|
||||||
|
ProtectControlGroups=true
|
||||||
|
ProtectHome=true
|
||||||
|
ProtectKernelLogs=true
|
||||||
|
ProtectKernelModules=true
|
||||||
|
ProtectKernelTunables=true
|
||||||
|
ProtectSystem=strict
|
||||||
|
PrivateTmp=true
|
||||||
|
ProtectProc=invisible
|
||||||
|
ProcSubset=pid
|
||||||
|
RestrictAddressFamilies=AF_UNIX
|
||||||
|
ReadOnlyPaths=/etc/hamradioonline-analytics /opt/hamradioonline-analytics /var/log/nginx /var/lib/GeoIP/GeoLite2-Country.mmdb
|
||||||
|
ReadWritePaths=/var/lib/hamradioonline-analytics
|
||||||
|
StateDirectory=hamradioonline-analytics
|
||||||
|
StateDirectoryMode=0711
|
||||||
|
RuntimeDirectory=hamradioonline-analytics
|
||||||
|
RuntimeDirectoryMode=0750
|
||||||
|
RestrictSUIDSGID=true
|
||||||
|
LockPersonality=true
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Run hamradioonline analytics once per hour
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=hourly
|
||||||
|
Persistent=true
|
||||||
|
RandomizedDelaySec=4m
|
||||||
|
AccuracySec=1m
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
Generated
+3
@@ -7,6 +7,9 @@
|
|||||||
"": {
|
"": {
|
||||||
"name": "kst4contest-website",
|
"name": "kst4contest-website",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18.19.1"
|
||||||
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"markdown-it": "^14.3.0",
|
"markdown-it": "^14.3.0",
|
||||||
"markdown-it-anchor": "^9.2.0"
|
"markdown-it-anchor": "^9.2.0"
|
||||||
|
|||||||
@@ -2,6 +2,9 @@
|
|||||||
"name": "kst4contest-website",
|
"name": "kst4contest-website",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18.19.1"
|
||||||
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "eleventy --serve",
|
"start": "eleventy --serve",
|
||||||
"build": "eleventy && npm run validate:version-info",
|
"build": "eleventy && npm run validate:version-info",
|
||||||
|
|||||||
@@ -1,23 +1,32 @@
|
|||||||
module.exports = [
|
module.exports = [
|
||||||
{
|
{
|
||||||
id: "main-window",
|
id: "main-window-light",
|
||||||
title: "Main Window",
|
title: "Main window · Light theme",
|
||||||
image: "/assets/screenshots/main-window.png",
|
image: "/assets/completeViewLight.png",
|
||||||
alt: "KST4Contest ON4KST contest chat client main window",
|
alt: "KST4Contest main window in the light theme with ON4KST chat, station filters, priority candidates and sked controls",
|
||||||
caption: "Contest-oriented ON4KST chat workflow with candidate awareness."
|
caption: "The complete contest view brings chat messages, active bands, filters and priority candidates together."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
id: "priority-candidates",
|
id: "main-window-dark",
|
||||||
title: "Priority Candidates",
|
title: "Main window · Dark theme",
|
||||||
image: "/assets/screenshots/priority-candidates.png",
|
image: "/assets/completeViewDark.png",
|
||||||
alt: "Priority candidate list in KST4Contest",
|
alt: "KST4Contest main window in the dark theme with ON4KST chat, station filters, priority candidates and sked controls",
|
||||||
caption: "Score-based candidate ranking for faster operator decisions."
|
caption: "The same operating view in the dark theme, including worked status, candidate priorities and message preparation."
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
id: "timeline",
|
id: "timeline",
|
||||||
title: "Timeline View",
|
title: "AP and sked timeline",
|
||||||
image: "/assets/screenshots/timeline.png",
|
image: "/assets/timeline.png",
|
||||||
alt: "KST4Contest AP timeline view",
|
alt: "KST4Contest timeline showing scheduled contacts and Aircraft Scatter crossing windows",
|
||||||
caption: "Timeline support for AP windows and candidate timing."
|
caption: "Skeds and Aircraft Scatter opportunities share one time axis, making upcoming operating windows easier to coordinate.",
|
||||||
|
wide: true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "airscout",
|
||||||
|
title: "KST4Contest with AirScout",
|
||||||
|
image: "/assets/complete_incl_AS.png",
|
||||||
|
alt: "KST4Contest main window alongside AirScout path and aircraft information",
|
||||||
|
caption: "AirScout adds path and aircraft information while KST4Contest keeps the related chat and station context visible.",
|
||||||
|
wide: true
|
||||||
}
|
}
|
||||||
];
|
];
|
||||||
@@ -61,6 +61,7 @@
|
|||||||
<p><a href="/features/">Features</a></p>
|
<p><a href="/features/">Features</a></p>
|
||||||
<p><a href="/download/">Download</a></p>
|
<p><a href="/download/">Download</a></p>
|
||||||
<p><a href="/manual/">Manual</a></p>
|
<p><a href="/manual/">Manual</a></p>
|
||||||
|
<p><a href="/background/">Background</a></p>
|
||||||
<p><a href="/roadmap/">Roadmap</a></p>
|
<p><a href="/roadmap/">Roadmap</a></p>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
@@ -81,5 +82,8 @@
|
|||||||
{% if heroFx %}
|
{% if heroFx %}
|
||||||
<script src="/assets/js/hero-radio-fx.js?v={{ build.version }}" defer></script>
|
<script src="/assets/js/hero-radio-fx.js?v={{ build.version }}" defer></script>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
{% if visitorCount %}
|
||||||
|
<script src="/assets/js/visitor-count.js?v={{ build.version }}" defer></script>
|
||||||
|
{% endif %}
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -25,6 +25,8 @@ description: About KST4Contest and its contest-oriented ON4KST workflow.
|
|||||||
<p>
|
<p>
|
||||||
The project is open source and focused on practical contest station workflows.
|
The project is open source and focused on practical contest station workflows.
|
||||||
Features are designed around real operating pressure, not theoretical UI concepts.
|
Features are designed around real operating pressure, not theoretical UI concepts.
|
||||||
|
The <a href="/background/">background and conference papers</a> explain how
|
||||||
|
work at DM5M and later analysis of archived ON4KST chat data influenced the client.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h2>Community supported</h2>
|
<h2>Community supported</h2>
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 382 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 385 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.1 MiB |
@@ -641,24 +641,43 @@ a:hover {
|
|||||||
margin-top: 30px;
|
margin-top: 30px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.screenshot-placeholder {
|
.screenshot-grid {
|
||||||
display: grid;
|
grid-template-columns: repeat(2, minmax(0, 1fr));
|
||||||
place-items: center;
|
}
|
||||||
min-height: 180px;
|
|
||||||
|
.screenshot-card--wide {
|
||||||
|
grid-column: 1 / -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.screenshot-link {
|
||||||
|
display: block;
|
||||||
margin-bottom: 16px;
|
margin-bottom: 16px;
|
||||||
border-radius: 18px;
|
border-radius: 18px;
|
||||||
background:
|
overflow: hidden;
|
||||||
linear-gradient(135deg, rgba(56, 189, 248, 0.20), rgba(168, 85, 247, 0.20)),
|
|
||||||
rgba(2, 6, 23, 0.7);
|
|
||||||
border: 1px solid var(--border);
|
border: 1px solid var(--border);
|
||||||
color: white;
|
background: rgba(2, 6, 23, 0.7);
|
||||||
font-weight: 800;
|
}
|
||||||
|
|
||||||
|
.screenshot-image {
|
||||||
|
display: block;
|
||||||
|
width: 100%;
|
||||||
|
height: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.screenshot-card h3 {
|
||||||
|
margin-bottom: 8px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.cta-panel {
|
.cta-panel {
|
||||||
padding: clamp(28px, 5vw, 60px);
|
padding: clamp(28px, 5vw, 60px);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.visitor-count {
|
||||||
|
margin: 24px 0 0;
|
||||||
|
color: var(--soft);
|
||||||
|
font-size: 0.9rem;
|
||||||
|
}
|
||||||
|
|
||||||
.manual-content {
|
.manual-content {
|
||||||
max-width: 980px;
|
max-width: 980px;
|
||||||
}
|
}
|
||||||
@@ -712,6 +731,14 @@ code {
|
|||||||
align-items: flex-start;
|
align-items: flex-start;
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.screenshot-grid {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
}
|
||||||
|
|
||||||
|
.screenshot-card--wide {
|
||||||
|
grid-column: auto;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@media (prefers-reduced-motion: no-preference) {
|
@media (prefers-reduced-motion: no-preference) {
|
||||||
|
|||||||
@@ -0,0 +1,147 @@
|
|||||||
|
"use strict";
|
||||||
|
|
||||||
|
const VISITOR_COUNT_ENDPOINT = "/visitor-count.json";
|
||||||
|
const VISITOR_COUNT_TIMEOUT_MS = 2500;
|
||||||
|
|
||||||
|
function parseIsoDate(value) {
|
||||||
|
const match = /^(\d{4})-(\d{2})-(\d{2})$/.exec(value);
|
||||||
|
|
||||||
|
if (!match) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const year = Number(match[1]);
|
||||||
|
const month = Number(match[2]);
|
||||||
|
const day = Number(match[3]);
|
||||||
|
const date = new Date(Date.UTC(year, month - 1, day));
|
||||||
|
|
||||||
|
if (date.getUTCFullYear() !== year
|
||||||
|
|| date.getUTCMonth() !== month - 1
|
||||||
|
|| date.getUTCDate() !== day) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return date;
|
||||||
|
}
|
||||||
|
|
||||||
|
function isIsoTimestamp(value) {
|
||||||
|
if (typeof value !== "string") {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
const match = /^(\d{4}-\d{2}-\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.\d+)?(Z|[+-](\d{2}):(\d{2}))$/.exec(value);
|
||||||
|
|
||||||
|
if (!match || !parseIsoDate(match[1])) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
const hour = Number(match[2]);
|
||||||
|
const minute = Number(match[3]);
|
||||||
|
const second = Number(match[4]);
|
||||||
|
const offsetHour = match[6] === undefined ? 0 : Number(match[6]);
|
||||||
|
const offsetMinute = match[7] === undefined ? 0 : Number(match[7]);
|
||||||
|
|
||||||
|
return hour <= 23
|
||||||
|
&& minute <= 59
|
||||||
|
&& second <= 59
|
||||||
|
&& offsetHour <= 23
|
||||||
|
&& offsetMinute <= 59
|
||||||
|
&& Number.isFinite(Date.parse(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
function validateVisitorCount(data) {
|
||||||
|
if (!data || typeof data !== "object" || Array.isArray(data)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (data.schemaVersion !== 1
|
||||||
|
|| !Number.isSafeInteger(data.visits)
|
||||||
|
|| data.visits < 0
|
||||||
|
|| !isIsoTimestamp(data.updatedAt)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const since = typeof data.since === "string"
|
||||||
|
? parseIsoDate(data.since)
|
||||||
|
: null;
|
||||||
|
|
||||||
|
return since ? { visits: data.visits, since } : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatVisitorCount(data) {
|
||||||
|
const valid = validateVisitorCount(data);
|
||||||
|
|
||||||
|
if (!valid) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const date = new Intl.DateTimeFormat("en-GB", {
|
||||||
|
day: "numeric",
|
||||||
|
month: "long",
|
||||||
|
year: "numeric",
|
||||||
|
timeZone: "UTC"
|
||||||
|
}).format(valid.since);
|
||||||
|
const visits = new Intl.NumberFormat("en-GB").format(valid.visits);
|
||||||
|
|
||||||
|
return `Visits since ${date}: ${visits}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function loadVisitorCount({
|
||||||
|
element,
|
||||||
|
fetchImpl = globalThis.fetch,
|
||||||
|
AbortControllerImpl = globalThis.AbortController,
|
||||||
|
timeoutMs = VISITOR_COUNT_TIMEOUT_MS
|
||||||
|
}) {
|
||||||
|
if (!element || typeof fetchImpl !== "function"
|
||||||
|
|| typeof AbortControllerImpl !== "function") {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
element.hidden = true;
|
||||||
|
element.textContent = "";
|
||||||
|
|
||||||
|
const controller = new AbortControllerImpl();
|
||||||
|
const timeout = setTimeout(() => controller.abort(), timeoutMs);
|
||||||
|
|
||||||
|
try {
|
||||||
|
const response = await fetchImpl(VISITOR_COUNT_ENDPOINT, {
|
||||||
|
credentials: "omit",
|
||||||
|
signal: controller.signal
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!response.ok) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
const text = formatVisitorCount(await response.json());
|
||||||
|
|
||||||
|
if (!text) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
element.textContent = text;
|
||||||
|
element.hidden = false;
|
||||||
|
return true;
|
||||||
|
} catch {
|
||||||
|
return false;
|
||||||
|
} finally {
|
||||||
|
clearTimeout(timeout);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof document !== "undefined") {
|
||||||
|
const element = document.querySelector("[data-visitor-count]");
|
||||||
|
|
||||||
|
if (element) {
|
||||||
|
loadVisitorCount({ element });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof module !== "undefined" && module.exports) {
|
||||||
|
module.exports = {
|
||||||
|
formatVisitorCount,
|
||||||
|
loadVisitorCount,
|
||||||
|
parseIsoDate,
|
||||||
|
validateVisitorCount
|
||||||
|
};
|
||||||
|
}
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
@@ -0,0 +1,98 @@
|
|||||||
|
---
|
||||||
|
layout: base.njk
|
||||||
|
lang: en
|
||||||
|
title: Background and conference papers
|
||||||
|
description: The operating background of KST4Contest and the German and English papers presented at GHz-Tagung Dorsten in 2025 and 2026.
|
||||||
|
---
|
||||||
|
|
||||||
|
<section class="hero">
|
||||||
|
<p class="badge">Project background</p>
|
||||||
|
<h1>Background and conference papers</h1>
|
||||||
|
<p class="lead">
|
||||||
|
KST4Contest grew out of practical contest operation at DM5M. Individual
|
||||||
|
functions started with concrete problems encountered while using the ON4KST
|
||||||
|
chat; later development was also influenced by analysis of archived chat data.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="section narrow">
|
||||||
|
<div class="section-heading">
|
||||||
|
<p class="eyebrow">Two points in the project history</p>
|
||||||
|
<h2>What the papers document</h2>
|
||||||
|
<p>
|
||||||
|
These papers preserve the implementation and knowledge available at the
|
||||||
|
respective GHz-Tagung. Their historical version references and plans have
|
||||||
|
deliberately not been rewritten to match the current application.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="grid">
|
||||||
|
<article class="card" id="paper-2025">
|
||||||
|
<p class="eyebrow">GHz-Tagung Dorsten · 2025</p>
|
||||||
|
<h3>Softwaregestützte Optimierung der Betriebstechnik von Conteststationen am Beispiel von KST4Contest</h3>
|
||||||
|
<p><strong>English title:</strong> Software-assisted optimisation of contest station operating practice using KST4Contest</p>
|
||||||
|
<p>
|
||||||
|
The paper covers the development of KST4Contest, practical contest
|
||||||
|
operating technique, the limits of conventional chat clients, Worked
|
||||||
|
information, Genius frequency and message analysis, AirScout, logger,
|
||||||
|
rotator and DX Cluster integration, and the operating and UI concept.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Marc Fröhlich, “Softwaregestützte Optimierung der Betriebstechnik von
|
||||||
|
Conteststationen am Beispiel von KST4Contest”, paper for the presentation
|
||||||
|
at <a href="https://ghztagung.darc.de/">GHz-Tagung Dorsten 2025</a>.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The English edition is a translation of the German original, not a
|
||||||
|
separate publication.
|
||||||
|
</p>
|
||||||
|
<div class="actions">
|
||||||
|
<a class="button" href="/assets/papers/kst4contest-ghz-tagung-2025-de.pdf">Download German PDF</a>
|
||||||
|
<a class="button secondary" href="/assets/papers/kst4contest-ghz-tagung-2025-en.pdf">Download English PDF</a>
|
||||||
|
</div>
|
||||||
|
<p><small>German PDF · 3.4 MB · English PDF · 3.4 MB</small></p>
|
||||||
|
</article>
|
||||||
|
|
||||||
|
<article class="card" id="paper-2026">
|
||||||
|
<p class="eyebrow">GHz-Tagung Dorsten · 2026</p>
|
||||||
|
<h3>Chat-Mining: Jagdinstinkte wecken mit KST4Contest</h3>
|
||||||
|
<p><strong>English title:</strong> Chat mining: awakening hunting instincts with KST4Contest</p>
|
||||||
|
<p>
|
||||||
|
The paper examines archived ON4KST chats, presence in both categories,
|
||||||
|
activity periods, sked requests and reply behaviour, the relationship
|
||||||
|
between useful information and reply rate, and the functions derived
|
||||||
|
from those observations.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Marc Fröhlich, “Chat-Mining: Jagdinstinkte wecken mit KST4Contest”, paper
|
||||||
|
for the presentation at <a href="https://ghztagung.darc.de/">GHz-Tagung
|
||||||
|
Dorsten 2026</a>, including section “Erfolgsrezept”.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The English edition is a translation of the German original, not a
|
||||||
|
separate study.
|
||||||
|
</p>
|
||||||
|
<div class="actions">
|
||||||
|
<a class="button" href="/assets/papers/kst4contest-ghz-tagung-2026-de.pdf">Download German PDF</a>
|
||||||
|
<a class="button secondary" href="/assets/papers/kst4contest-ghz-tagung-2026-en.pdf">Download English PDF</a>
|
||||||
|
</div>
|
||||||
|
<p><small>German PDF · 1.8 MB · English PDF · 1.7 MB</small></p>
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="section narrow">
|
||||||
|
<div class="cta-panel">
|
||||||
|
<p class="eyebrow">Current software</p>
|
||||||
|
<h2>The papers explain the background, not today's complete feature set</h2>
|
||||||
|
<p>
|
||||||
|
For current behaviour and configuration, use the complete function
|
||||||
|
overview and the manual. The conference papers remain historical sources.
|
||||||
|
</p>
|
||||||
|
<div class="actions">
|
||||||
|
<a class="button" href="/features/">Open all functions</a>
|
||||||
|
<a class="button secondary" href="/manual/">Read the current manual</a>
|
||||||
|
<a class="button ghost" href="/">Return to the home page</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
@@ -212,6 +212,45 @@ description: Download the latest stable KST4Contest packages for Windows, Linux
|
|||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
<section class="section">
|
||||||
|
<div class="section-heading">
|
||||||
|
<p class="eyebrow">Conference papers</p>
|
||||||
|
<h2>Background from GHz-Tagung Dorsten</h2>
|
||||||
|
<p>
|
||||||
|
These historical conference papers document KST4Contest at the time of the 2025 and 2026 talks.
|
||||||
|
They provide project background, not a complete description of the current feature set.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="grid">
|
||||||
|
<article class="card content-card">
|
||||||
|
<h3>GHz-Tagung 2025</h3>
|
||||||
|
<p>
|
||||||
|
How KST4Contest grew from practical contest operation and addressed limitations of conventional
|
||||||
|
chat clients.
|
||||||
|
</p>
|
||||||
|
<div class="actions">
|
||||||
|
<a class="button secondary" href="/assets/papers/kst4contest-ghz-tagung-2025-de.pdf">Download German PDF</a>
|
||||||
|
<a class="button secondary" href="/assets/papers/kst4contest-ghz-tagung-2025-en.pdf">Download English PDF</a>
|
||||||
|
</div>
|
||||||
|
<p><a href="/background/#paper-2025">Background and source details →</a></p>
|
||||||
|
</article>
|
||||||
|
|
||||||
|
<article class="card content-card">
|
||||||
|
<h3>GHz-Tagung 2026</h3>
|
||||||
|
<p>
|
||||||
|
How archived ON4KST chat data was evaluated and how the findings influenced later KST4Contest
|
||||||
|
functions.
|
||||||
|
</p>
|
||||||
|
<div class="actions">
|
||||||
|
<a class="button secondary" href="/assets/papers/kst4contest-ghz-tagung-2026-de.pdf">Download German PDF</a>
|
||||||
|
<a class="button secondary" href="/assets/papers/kst4contest-ghz-tagung-2026-en.pdf">Download English PDF</a>
|
||||||
|
</div>
|
||||||
|
<p><a href="/background/#paper-2026">Background and source details →</a></p>
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
<section class="section">
|
<section class="section">
|
||||||
<div class="cta-panel">
|
<div class="cta-panel">
|
||||||
<p class="eyebrow">Choosing a package</p>
|
<p class="eyebrow">Choosing a package</p>
|
||||||
|
|||||||
@@ -49,6 +49,8 @@ The general UDP listener processes packets from UCXLog, N1MM+, QARTest and DXLog
|
|||||||
|
|
||||||
Win-Test uses a separate listener for its native network protocol. KST4Contest resolves the Win-Test band ID, including 50 and 70 MHz, and stores the resulting Worked information in the same internal database.
|
Win-Test uses a separate listener for its native network protocol. KST4Contest resolves the Win-Test band ID, including 50 and 70 MHz, and stores the resulting Worked information in the same internal database.
|
||||||
|
|
||||||
|
QSOs logged before KST4Contest was started are recovered from Win-Test as well. As soon as a Win-Test station is detected, the missing part of its log is requested over the native protocol, so stations already worked are marked as worked even when the client joins the contest late. The recovery needs no setting, keeps running to close gaps caused by lost packets, and covers every log in a multi-station network.
|
||||||
|
|
||||||
STATUS packets can also update the local QRG when QRG synchronisation is enabled and valid packets actually arrive. Enabling the source alone does not supply a frequency. In multi-operator networks, a station-name filter prevents STATUS packets from another operating position from replacing the frequency of the intended radio.
|
STATUS packets can also update the local QRG when QRG synchronisation is enabled and valid packets actually arrive. Enabling the source alone does not supply a frequency. In multi-operator networks, a station-name filter prevents STATUS packets from another operating position from replacing the frequency of the intended radio.
|
||||||
|
|
||||||
Win-Test can additionally receive skeds created in KST4Contest. The handover only takes place when a QRG matching the selected band can be determined. No fixed fallback frequency is inserted merely to make the packet technically valid.
|
Win-Test can additionally receive skeds created in KST4Contest. The handover only takes place when a QRG matching the selected band can be determined. No fixed fallback frequency is inserted merely to make the packet technically valid.
|
||||||
|
|||||||
+118
-52
@@ -3,6 +3,7 @@ layout: base.njk
|
|||||||
title: KST4Contest – ON4KST Contest Client for VHF, UHF and SHF
|
title: KST4Contest – ON4KST Contest Client for VHF, UHF and SHF
|
||||||
description: KST4Contest combines ON4KST chat, candidate prioritisation, sked planning, AirScout data and logger integration in one desktop client.
|
description: KST4Contest combines ON4KST chat, candidate prioritisation, sked planning, AirScout data and logger integration in one desktop client.
|
||||||
heroFx: true
|
heroFx: true
|
||||||
|
visitorCount: true
|
||||||
---
|
---
|
||||||
|
|
||||||
<section class="hero hero-split">
|
<section class="hero hero-split">
|
||||||
@@ -14,15 +15,15 @@ heroFx: true
|
|||||||
<h1>KST4Contest</h1>
|
<h1>KST4Contest</h1>
|
||||||
|
|
||||||
<p class="lead">
|
<p class="lead">
|
||||||
ON4KST shows you the traffic. KST4Contest helps turn it into an operating
|
KST4Contest is an ON4KST client for VHF, UHF and SHF contest operation
|
||||||
decision by combining chat, candidate prioritisation, sked planning,
|
on 144 MHz and above. It keeps active stations, frequencies, skeds and
|
||||||
AirScout data and logger integration in one desktop client.
|
aircraft-scatter opportunities in view while connecting chat information
|
||||||
|
with logger and station interfaces.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
The available information is filtered, related to active stations and
|
The client helps the operator choose the next useful station and prepare
|
||||||
presented in a contest-oriented workflow. The final decision still
|
the next operating step. It does not automate the radio contact itself.
|
||||||
belongs to the operator.
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<div class="actions">
|
<div class="actions">
|
||||||
@@ -35,57 +36,71 @@ heroFx: true
|
|||||||
<div class="hero-panel">
|
<div class="hero-panel">
|
||||||
<div class="terminal-bar">
|
<div class="terminal-bar">
|
||||||
<span></span><span></span><span></span>
|
<span></span><span></span><span></span>
|
||||||
<strong>Functions sharing the same station context</strong>
|
<strong>Contest information ready for the next decision</strong>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="mock-grid">
|
<div class="mock-grid">
|
||||||
{% for feature in collections.sortedFeatures %}
|
|
||||||
{% if loop.index <= 6 %}
|
|
||||||
<div class="mini-card">
|
<div class="mini-card">
|
||||||
<strong>{{ feature.data.icon }} {{ feature.data.title }}</strong>
|
<strong>Active stations and QRGs</strong>
|
||||||
<small>{{ feature.data.summary }}</small>
|
<small>Chat messages, recognised frequencies and known bands stay connected to the station.</small>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="mini-card">
|
||||||
|
<strong>Skeds and AP windows</strong>
|
||||||
|
<small>Scheduled contacts and AirScout timing remain visible while the contest continues.</small>
|
||||||
|
</div>
|
||||||
|
<div class="mini-card">
|
||||||
|
<strong>Logger and station status</strong>
|
||||||
|
<small>Worked information, the current TRX QRG and rotor direction inform the same workflow.</small>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
{% if collections.latestNews.length %}
|
||||||
|
{% set latestPost = collections.latestNews[0] %}
|
||||||
|
<section class="section narrow" aria-labelledby="latest-news-heading">
|
||||||
|
<article class="card">
|
||||||
|
<p class="eyebrow">Latest news · {{ latestPost.date | readableDate }}</p>
|
||||||
|
<h2 id="latest-news-heading"><a href="{{ latestPost.url }}">{{ latestPost.data.title }}</a></h2>
|
||||||
|
<p>{{ latestPost.data.summary }}</p>
|
||||||
|
<a href="{{ latestPost.url }}">Open this update →</a>
|
||||||
|
</article>
|
||||||
|
</section>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% endfor %}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section class="section">
|
<section class="section">
|
||||||
<div class="section-heading">
|
<div class="section-heading">
|
||||||
<p class="eyebrow">The operating problem</p>
|
<p class="eyebrow">Practical tasks</p>
|
||||||
<h2>The useful station is rarely the only station in the chat</h2>
|
<h2>From chat traffic to the next operating step</h2>
|
||||||
<p>
|
<p>
|
||||||
During an active contest, messages, sked requests, frequency information
|
Messages, station activity and station interfaces provide different
|
||||||
and band changes arrive continuously. The task is to identify which part
|
pieces of the same operating situation. KST4Contest brings them together
|
||||||
of that traffic matters now, which candidate should be monitored and
|
where they are needed.
|
||||||
which contact is better scheduled for later.
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="grid">
|
<div class="grid">
|
||||||
<article class="card">
|
<article class="card">
|
||||||
<h3>Observe</h3>
|
<h3>Keep track of chat and active stations</h3>
|
||||||
<p>
|
<p>
|
||||||
Messages, locators, detected frequencies and known band activity are
|
Follow messages across two ON4KST categories, see active bands and keep
|
||||||
assigned to stations across as many as two ON4KST chat categories.
|
recognised frequencies attached to the callsign that sent them.
|
||||||
</p>
|
</p>
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<article class="card">
|
<article class="card">
|
||||||
<h3>Evaluate</h3>
|
<h3>Select and plan contacts</h3>
|
||||||
<p>
|
<p>
|
||||||
Direction, distance, worked status, NOT-QRV information, chat activity,
|
Use filters and priorities to find candidates, schedule skeds and keep
|
||||||
sked context and aircraft scatter data feed filters and candidate scores.
|
their timing visible in the timeline together with AirScout data.
|
||||||
</p>
|
</p>
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<article class="card">
|
<article class="card">
|
||||||
<h3>Act</h3>
|
<h3>Connect logger and station components</h3>
|
||||||
<p>
|
<p>
|
||||||
Candidates can be contacted, scheduled or monitored. Skeds remain
|
Synchronise Worked status with supported loggers and pass useful context
|
||||||
visible, while supported loggers and station interfaces receive the
|
to the TRX, rotator and local DX Cluster interfaces.
|
||||||
information required for the next operating step.
|
|
||||||
</p>
|
</p>
|
||||||
</article>
|
</article>
|
||||||
</div>
|
</div>
|
||||||
@@ -93,25 +108,77 @@ heroFx: true
|
|||||||
|
|
||||||
<section class="section">
|
<section class="section">
|
||||||
<div class="section-heading">
|
<div class="section-heading">
|
||||||
<p class="eyebrow">Functions</p>
|
<p class="eyebrow">What the chat data showed</p>
|
||||||
<h2>One workflow, shared context</h2>
|
<h2>Useful detail makes a reply easier</h2>
|
||||||
<p>
|
<p>
|
||||||
The individual functions are not isolated tools. They use the same
|
Archived ON4KST chat logs from several IARU contests in the preceding two
|
||||||
station, message, band and timing information, so that a change in one
|
years were analysed. The concrete example comes from the July 2025 contest
|
||||||
part of the workflow can also affect filters, priorities and reminders.
|
and combines the 144/432 MHz and Microwave categories. It compares sked
|
||||||
|
requests with the replies and sked windows they produced.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The text analysis considered action and sked words, frequency, timing,
|
||||||
|
beam direction, aircraft-scatter information, locator, mode and courtesy
|
||||||
|
or anchor words. Within this sample, requests containing AP and beam
|
||||||
|
information were associated with an almost 30% higher chat reply rate
|
||||||
|
than short, unspecific requests such as “Hi noname, try 2m?”.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
This measures chat replies, not completed QSOs. It is a correlation within
|
||||||
|
the investigated sample, not general proof of causation and not a promise
|
||||||
|
that an individual sked will succeed. The practical point is modest:
|
||||||
|
information that can be used immediately saves the other operator from
|
||||||
|
having to ask for it first. KST4Contest supplies part of that context when
|
||||||
|
preparing messages and skeds.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Source: Marc Fröhlich, “Chat-Mining: Jagdinstinkte wecken mit KST4Contest”,
|
||||||
|
conference paper for GHz-Tagung Dorsten 2026, section “Erfolgsrezept”.
|
||||||
|
<a href="/background/#paper-2026">Read the background and download the paper</a>.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="section">
|
||||||
|
<div class="section-heading">
|
||||||
|
<p class="eyebrow">Selected functions</p>
|
||||||
|
<h2>The parts most often used during a contest</h2>
|
||||||
|
<p>
|
||||||
|
These examples show how station, band, message and timing information is
|
||||||
|
used in practice. The complete function overview remains available for
|
||||||
|
configuration details and less frequently used tools.
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="grid">
|
<div class="grid">
|
||||||
{% for feature in collections.sortedFeatures %}
|
|
||||||
<article class="card feature-card">
|
<article class="card feature-card">
|
||||||
<div class="feature-icon">{{ feature.data.icon }}</div>
|
<h3><a href="/features/global-message-views/">Chat overview and station filters</a></h3>
|
||||||
<p class="eyebrow">{{ feature.data.category }}</p>
|
<p>Separate global and private views keep the traffic readable, while station filters narrow the candidate list without hiding the underlying chat context.</p>
|
||||||
<h3><a href="{{ feature.url }}">{{ feature.data.title }}</a></h3>
|
|
||||||
<p>{{ feature.data.summary }}</p>
|
|
||||||
<a href="{{ feature.url }}">Read how it works →</a>
|
|
||||||
</article>
|
</article>
|
||||||
{% endfor %}
|
<article class="card feature-card">
|
||||||
|
<h3><a href="/features/priority-score/">Priority and band opportunities</a></h3>
|
||||||
|
<p>Candidate scores combine available station information with Worked and band state so that a useful next call is easier to find.</p>
|
||||||
|
</article>
|
||||||
|
<article class="card feature-card">
|
||||||
|
<h3><a href="/features/timeline/">Skeds and AP timeline</a></h3>
|
||||||
|
<p>Manual skeds, reminders and aircraft-scatter windows remain visible instead of disappearing in the continuing chat stream.</p>
|
||||||
|
</article>
|
||||||
|
<article class="card feature-card">
|
||||||
|
<h3><a href="/features/airscout/">AirScout and path information</a></h3>
|
||||||
|
<p>AirScout data adds timing and path context to a selected station without turning that assessment into a propagation promise.</p>
|
||||||
|
</article>
|
||||||
|
<article class="card feature-card">
|
||||||
|
<h3><a href="/features/log-sync/">Logger and Worked synchronisation</a></h3>
|
||||||
|
<p>Supported logger data updates global and per-band Worked information across the active callsign variants.</p>
|
||||||
|
</article>
|
||||||
|
<article class="card feature-card">
|
||||||
|
<h3><a href="/features/trx-qrg-synchronisation/">TRX, rotator and DX Cluster integration</a></h3>
|
||||||
|
<p>The current QRG, rotor direction and local spots carry selected station information into the next manual operating step.</p>
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="actions">
|
||||||
|
<a class="button secondary" href="/features/">Open the complete function overview</a>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
@@ -120,10 +187,9 @@ heroFx: true
|
|||||||
<p class="eyebrow">Limits</p>
|
<p class="eyebrow">Limits</p>
|
||||||
<h2>A priority score is not a propagation forecast</h2>
|
<h2>A priority score is not a propagation forecast</h2>
|
||||||
<p>
|
<p>
|
||||||
KST4Contest can only evaluate the information it knows. Scores, AP
|
Priorities are not a propagation forecast. Scores, filters and AP windows
|
||||||
windows, filters and path profiles support the operator's decision; they
|
depend on the data available to the client. They help with sorting and
|
||||||
do not guarantee a contact. If the input data is incomplete or outdated,
|
timing, but they do not guarantee a QSO.
|
||||||
the result can be incomplete or outdated as well.
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<div class="actions">
|
<div class="actions">
|
||||||
@@ -138,11 +204,9 @@ heroFx: true
|
|||||||
<p class="eyebrow">Project status</p>
|
<p class="eyebrow">Project status</p>
|
||||||
<h2>Stable for operation, Nightly for testing</h2>
|
<h2>Stable for operation, Nightly for testing</h2>
|
||||||
<p>
|
<p>
|
||||||
KST4Contest is open-source software. The current stable release is the
|
Stable is the normal choice for contest operation. Nightly contains the
|
||||||
normal choice for contest operation. Nightly builds follow ongoing
|
latest development state and is intended for testing. Changing versions
|
||||||
development and are useful when a particular fix or feature needs
|
immediately before a contest is still not recommended.
|
||||||
testing. A few minutes before a contest is not the ideal time to discover
|
|
||||||
what changed.
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<div class="actions">
|
<div class="actions">
|
||||||
@@ -150,6 +214,8 @@ heroFx: true
|
|||||||
<a class="button secondary" href="/roadmap/">Development status</a>
|
<a class="button secondary" href="/roadmap/">Development status</a>
|
||||||
<a class="button ghost" href="/support/">Support development</a>
|
<a class="button ghost" href="/support/">Support development</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<p class="visitor-count" data-visitor-count hidden aria-live="polite"></p>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,29 @@
|
|||||||
|
---
|
||||||
|
title: Version 1.43.1 released
|
||||||
|
summary: Reliable log synchronisation, persistent layouts and better DX Cluster compatibility
|
||||||
|
date: 2026-09-03
|
||||||
|
---
|
||||||
|
|
||||||
|
## Version 1.43.1
|
||||||
|
|
||||||
|
Version 1.43 focuses on the parts of KST4Contest that have to keep working during a long contest: ON4KST connection monitoring, log synchronisation, Worked information and the data sent to external logging software.
|
||||||
|
|
||||||
|
The first v1.43.0 packages already contained all functional changes described below, but some embedded version metadata still identified the build as version 1.42. v1.43.1 corrects this. If you already downloaded v1.43.0, use v1.43.1 instead.
|
||||||
|
|
||||||
|
### What changed
|
||||||
|
|
||||||
|
- **More reliable log synchronisation:** The Simplelogfile parser now closes the selected file after every pass, handles suffix variants by their base callsign and reports when a missing file has been created. UCXLog-compatible packets and Win-Test events share the same band normalisation, including the existing microwave bands.
|
||||||
|
- **Correct Worked state after login:** Persisted Worked information is applied before the initial ON4KST user list becomes visible. Reconnects and both chat categories therefore start with the correct state.
|
||||||
|
- **No false disconnect on a quiet server:** KST4Contest actively checks a quiet ON4KST session before treating it as dead. A period without new activity lines no longer causes an unnecessary reconnect.
|
||||||
|
- **DX Cluster compatibility:** Local spots now use a fixed, DXSpider-compatible 75-character line format that is also accepted reliably by DXLog. Frequencies up to 24 GHz keep the required column positions.
|
||||||
|
- **Layouts that stay where you put them:** Table column widths, window sizes and relevant dividers are saved automatically. Truncated table values expose their full text in a tooltip.
|
||||||
|
- **Controllable map grouping:** **Group nearby stations** switches map clustering on or off without changing the current viewport or selected station.
|
||||||
|
- **Smaller corrections:** Complete QRGs without a decimal separator are recognised across the supported bands, and private-message age highlighting no longer remains attached to reused table rows.
|
||||||
|
|
||||||
|
The complete technical list is available in the [changelog](/manual/en/changelog/) and the [GitHub release notes](https://github.com/praktimarc/kst4contest/releases/tag/v1.43.1).
|
||||||
|
|
||||||
|
### Getting it
|
||||||
|
|
||||||
|
Packages for Windows, Linux and macOS are available on the [download page](/download/) and in the [GitHub release](https://github.com/praktimarc/kst4contest/releases/tag/v1.43.1). The AUR packages are updated through their normal release workflow.
|
||||||
|
|
||||||
|
The German and English manuals have also been revised. The new contest-workflow chapter connects the individual functions into a practical operating sequence instead of describing them only in isolation. 73
|
||||||
@@ -7,7 +7,7 @@ description: Privacy policy for the KST4Contest website.
|
|||||||
<section class="hero">
|
<section class="hero">
|
||||||
<p class="badge">Privacy</p>
|
<p class="badge">Privacy</p>
|
||||||
<h1>Privacy Policy</h1>
|
<h1>Privacy Policy</h1>
|
||||||
<p class="lead">Information about data processing on this static website.</p>
|
<p class="lead">Information about data processing on this website.</p>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section class="section narrow">
|
<section class="section narrow">
|
||||||
@@ -30,12 +30,46 @@ description: Privacy policy for the KST4Contest website.
|
|||||||
<h2>Legal basis</h2>
|
<h2>Legal basis</h2>
|
||||||
<p>
|
<p>
|
||||||
The legal basis is Art. 6(1)(f) GDPR: legitimate interest in secure and reliable operation
|
The legal basis is Art. 6(1)(f) GDPR: legitimate interest in secure and reliable operation
|
||||||
of the website.
|
of the website and in understanding the approximate use of its project pages.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h2>Cookies and tracking</h2>
|
<h2>Server-side reach statistics</h2>
|
||||||
<p>
|
<p>
|
||||||
This website currently does not use cookies, analytics tracking, advertising pixels or user profiling.
|
The website uses server-side reach statistics to understand approximate demand and which
|
||||||
|
project pages are used. Measurement is based on a dedicated, reduced server access log. It
|
||||||
|
does not use cookies, an analytics or tracking script, advertising pixels, local storage,
|
||||||
|
third-party requests or user profiles.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The analytics log contains the server name, IP address, time, HTTP method, normalised path
|
||||||
|
without a query string, protocol, response status, transferred size and user agent. It does
|
||||||
|
not contain a referrer or authenticated user name. Known crawlers are filtered, and unknown
|
||||||
|
browsers or operating systems are treated as crawlers.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
IP addresses are anonymised before data is stored in the statistics aggregates. The dedicated
|
||||||
|
analytics raw logs are retained for 14 days. Anonymised detailed aggregates are retained on a
|
||||||
|
rolling basis for 395 days. They include countries, but no city or host statistics. Countries
|
||||||
|
are derived with a Country database only.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
A visit is an approximate daily value based on the combination of IP address, date and user
|
||||||
|
agent used by GoAccess. It must not be read as a number of unique people. Page views and visits
|
||||||
|
remain separate measures. Bots, monitoring requests, software update checks and static assets
|
||||||
|
are excluded as far as they can be identified.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<h2>Public visitor count</h2>
|
||||||
|
<p>
|
||||||
|
The home page displays an element containing the total number of these approximate daily visits
|
||||||
|
since the stated activation date. The display loads a same-origin JSON file and remains hidden
|
||||||
|
if that file is unavailable or invalid. This request is not included in the statistic.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The public file contains only the counter value, activation date, schema version and update time.
|
||||||
|
It contains no personal data or daily breakdown. The non-personal daily counter values are kept
|
||||||
|
permanently so that the total does not decrease when detailed aggregates reach the end of their
|
||||||
|
395-day retention period.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h2>External links</h2>
|
<h2>External links</h2>
|
||||||
|
|||||||
@@ -14,14 +14,25 @@ description: Screenshots of KST4Contest, the contest-optimized ON4KST chat clien
|
|||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section class="section">
|
<section class="section">
|
||||||
<div class="grid">
|
<div class="section-heading">
|
||||||
{% for shot in screenshots %}
|
<p class="eyebrow">Four working views</p>
|
||||||
<article class="card screenshot-card">
|
<h2>From chat overview to Aircraft Scatter timing</h2>
|
||||||
<div class="screenshot-placeholder">
|
<p>
|
||||||
<span>{{ shot.title }}</span>
|
These screenshots were captured in a test environment. Version-like text inside chat messages is
|
||||||
|
test data, not an announcement of a published KST4Contest version.
|
||||||
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="grid screenshot-grid">
|
||||||
|
{% for shot in screenshots %}
|
||||||
|
<article class="card screenshot-card{% if shot.wide %} screenshot-card--wide{% endif %}">
|
||||||
|
<a class="screenshot-link" href="{{ shot.image }}" target="_blank" rel="noopener"
|
||||||
|
aria-label="Open {{ shot.title }} in full size">
|
||||||
|
<img class="screenshot-image" src="{{ shot.image }}" alt="{{ shot.alt }}" loading="lazy" decoding="async">
|
||||||
|
</a>
|
||||||
<h3>{{ shot.title }}</h3>
|
<h3>{{ shot.title }}</h3>
|
||||||
<p>{{ shot.caption }}</p>
|
<p>{{ shot.caption }}</p>
|
||||||
|
<p><a href="{{ shot.image }}" target="_blank" rel="noopener">Open full-size image →</a></p>
|
||||||
</article>
|
</article>
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -0,0 +1,547 @@
|
|||||||
|
const assert = require("node:assert/strict");
|
||||||
|
const fs = require("node:fs");
|
||||||
|
const os = require("node:os");
|
||||||
|
const path = require("node:path");
|
||||||
|
const test = require("node:test");
|
||||||
|
|
||||||
|
const {
|
||||||
|
formatGoAccessCheck,
|
||||||
|
generateReports,
|
||||||
|
parseGoAccessVersion,
|
||||||
|
validateReport
|
||||||
|
} = require("../ops/analytics/generate-reports");
|
||||||
|
|
||||||
|
const GOACCESS_WITHOUT_ZLIB = {
|
||||||
|
version: "1.8.1",
|
||||||
|
geoIpMmdb: true,
|
||||||
|
openSsl: true,
|
||||||
|
zlib: false
|
||||||
|
};
|
||||||
|
|
||||||
|
function goAccessReport(dailyVisits, combined = false) {
|
||||||
|
const report = {
|
||||||
|
general: { total_requests: 1 },
|
||||||
|
visitors: {
|
||||||
|
data: Object.entries(dailyVisits).map(([date, count]) => ({
|
||||||
|
data: date.replaceAll("-", ""),
|
||||||
|
visitors: { count }
|
||||||
|
}))
|
||||||
|
},
|
||||||
|
requests: { data: [] },
|
||||||
|
status_codes: { data: [] },
|
||||||
|
geolocation: { data: [] }
|
||||||
|
};
|
||||||
|
if (combined) {
|
||||||
|
report.vhosts = { data: [] };
|
||||||
|
}
|
||||||
|
return report;
|
||||||
|
}
|
||||||
|
|
||||||
|
function fixture(siteDefinitions) {
|
||||||
|
const root = fs.mkdtempSync(path.join(os.tmpdir(), "kst4-analytics-test-"));
|
||||||
|
const stateDirectory = path.join(root, "state");
|
||||||
|
const geoIpCountryDatabase = path.join(root, "GeoLite2-Country.mmdb");
|
||||||
|
const configTemplatePath = path.join(root, "goaccess.conf.template");
|
||||||
|
const registryPath = path.join(root, "sites.json");
|
||||||
|
fs.writeFileSync(geoIpCountryDatabase, "test database placeholder");
|
||||||
|
fs.copyFileSync(
|
||||||
|
path.join(__dirname, "../ops/analytics/goaccess.conf.template"),
|
||||||
|
configTemplatePath
|
||||||
|
);
|
||||||
|
|
||||||
|
const sites = siteDefinitions.map((definition, index) => {
|
||||||
|
const id = definition.id || `site-${index}`;
|
||||||
|
const log = path.join(root, `${id}.log`);
|
||||||
|
fs.writeFileSync(log, "example log line\n");
|
||||||
|
if (definition.rotated !== false) {
|
||||||
|
fs.writeFileSync(`${log}.1`, "rotated example log line\n");
|
||||||
|
}
|
||||||
|
if (definition.compressed) {
|
||||||
|
fs.writeFileSync(`${log}.2.gz`, "compressed placeholder\n");
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
id,
|
||||||
|
hostname: definition.hostname || `${id}.example.test`,
|
||||||
|
analyticsLog: log,
|
||||||
|
activatedOn: definition.activatedOn || "2026-01-01",
|
||||||
|
publicCounter: definition.publicCounter,
|
||||||
|
reportOutputDirectory: path.join(stateDirectory, "reports", id),
|
||||||
|
...(definition.publicCounter
|
||||||
|
? { publicJsonPath: path.join(stateDirectory, "public", `${id}.json`) }
|
||||||
|
: {})
|
||||||
|
};
|
||||||
|
});
|
||||||
|
const registry = {
|
||||||
|
schemaVersion: 1,
|
||||||
|
stateDirectory,
|
||||||
|
counterStatePath: path.join(stateDirectory, "counter-state.json"),
|
||||||
|
lockFile: path.join(root, "run", "generator.lock"),
|
||||||
|
geoIpCountryDatabase,
|
||||||
|
combined: {
|
||||||
|
reportOutputDirectory: path.join(stateDirectory, "reports", "combined")
|
||||||
|
},
|
||||||
|
sites
|
||||||
|
};
|
||||||
|
fs.mkdirSync(stateDirectory, { recursive: true });
|
||||||
|
fs.mkdirSync(registry.combined.reportOutputDirectory, { recursive: true });
|
||||||
|
for (const site of sites) {
|
||||||
|
fs.mkdirSync(site.reportOutputDirectory, { recursive: true });
|
||||||
|
if (site.publicCounter) {
|
||||||
|
fs.mkdirSync(path.dirname(site.publicJsonPath), { recursive: true });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fs.writeFileSync(registryPath, JSON.stringify(registry));
|
||||||
|
|
||||||
|
return {
|
||||||
|
root,
|
||||||
|
registry,
|
||||||
|
registryPath,
|
||||||
|
configTemplatePath,
|
||||||
|
cleanup: () => fs.rmSync(root, { recursive: true, force: true })
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function fakeGoAccess(reports, calls, failureId) {
|
||||||
|
return invocation => {
|
||||||
|
calls.push(invocation);
|
||||||
|
if (invocation.id === failureId) {
|
||||||
|
throw new Error("simulated GoAccess failure");
|
||||||
|
}
|
||||||
|
fs.writeFileSync(
|
||||||
|
invocation.outputJson,
|
||||||
|
JSON.stringify(reports[invocation.id])
|
||||||
|
);
|
||||||
|
fs.writeFileSync(
|
||||||
|
invocation.outputHtml,
|
||||||
|
`<!doctype html><html><body>${"report".repeat(30)}</body></html>`
|
||||||
|
);
|
||||||
|
fs.writeFileSync(path.join(invocation.dbPath, "persisted.db"), invocation.id);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function run(testFixture, reports, calls = [], failureId) {
|
||||||
|
return generateReports({
|
||||||
|
registryPath: testFixture.registryPath,
|
||||||
|
configTemplatePath: testFixture.configTemplatePath,
|
||||||
|
goaccessBinary: "fake-goaccess"
|
||||||
|
}, {
|
||||||
|
checkGoAccess: () => GOACCESS_WITHOUT_ZLIB,
|
||||||
|
runGoAccess: fakeGoAccess(reports, calls, failureId),
|
||||||
|
now: () => new Date("2026-09-11T07:00:00Z"),
|
||||||
|
skipLock: true
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
test("replaces repeated daily values and retains older public days", () => {
|
||||||
|
const testFixture = fixture([{ id: "alpha", publicCounter: true }]);
|
||||||
|
try {
|
||||||
|
fs.mkdirSync(path.dirname(testFixture.registry.counterStatePath), { recursive: true });
|
||||||
|
fs.writeFileSync(testFixture.registry.counterStatePath, JSON.stringify({
|
||||||
|
schemaVersion: 1,
|
||||||
|
sites: {
|
||||||
|
alpha: {
|
||||||
|
hostname: "alpha.example.test",
|
||||||
|
since: "2026-01-01",
|
||||||
|
dailyVisits: { "2026-01-01": 7 }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
|
||||||
|
run(testFixture, {
|
||||||
|
alpha: goAccessReport({ "2026-09-11": 3 }),
|
||||||
|
combined: goAccessReport({ "2026-09-11": 3 }, true)
|
||||||
|
});
|
||||||
|
run(testFixture, {
|
||||||
|
alpha: goAccessReport({ "2026-09-11": 5 }),
|
||||||
|
combined: goAccessReport({ "2026-09-11": 5 }, true)
|
||||||
|
});
|
||||||
|
|
||||||
|
const state = JSON.parse(fs.readFileSync(
|
||||||
|
testFixture.registry.counterStatePath,
|
||||||
|
"utf8"
|
||||||
|
));
|
||||||
|
const published = JSON.parse(fs.readFileSync(
|
||||||
|
testFixture.registry.sites[0].publicJsonPath,
|
||||||
|
"utf8"
|
||||||
|
));
|
||||||
|
assert.deepEqual(state.sites.alpha.dailyVisits, {
|
||||||
|
"2026-01-01": 7,
|
||||||
|
"2026-09-11": 5
|
||||||
|
});
|
||||||
|
assert.deepEqual(published, {
|
||||||
|
schemaVersion: 1,
|
||||||
|
visits: 12,
|
||||||
|
since: "2026-01-01",
|
||||||
|
updatedAt: "2026-09-11T07:00:00Z"
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
testFixture.cleanup();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("keeps valid outputs unchanged when a GoAccess job fails", () => {
|
||||||
|
const testFixture = fixture([{ id: "alpha", publicCounter: true }]);
|
||||||
|
try {
|
||||||
|
const reportDirectory = testFixture.registry.sites[0].reportOutputDirectory;
|
||||||
|
fs.mkdirSync(reportDirectory, { recursive: true });
|
||||||
|
fs.mkdirSync(path.dirname(testFixture.registry.counterStatePath), { recursive: true });
|
||||||
|
fs.mkdirSync(path.dirname(testFixture.registry.sites[0].publicJsonPath), { recursive: true });
|
||||||
|
fs.writeFileSync(path.join(reportDirectory, "report.json"), "old-json");
|
||||||
|
fs.writeFileSync(path.join(reportDirectory, "report.html"), "old-html");
|
||||||
|
fs.writeFileSync(testFixture.registry.counterStatePath, "old-state");
|
||||||
|
fs.writeFileSync(testFixture.registry.sites[0].publicJsonPath, "old-public");
|
||||||
|
|
||||||
|
assert.throws(() => run(testFixture, {
|
||||||
|
alpha: goAccessReport({ "2026-09-11": 3 }),
|
||||||
|
combined: goAccessReport({ "2026-09-11": 3 }, true)
|
||||||
|
}, [], "combined"), /simulated GoAccess failure/);
|
||||||
|
|
||||||
|
assert.equal(fs.readFileSync(path.join(reportDirectory, "report.json"), "utf8"), "old-json");
|
||||||
|
assert.equal(fs.readFileSync(path.join(reportDirectory, "report.html"), "utf8"), "old-html");
|
||||||
|
assert.equal(fs.readFileSync(testFixture.registry.counterStatePath, "utf8"), "old-state");
|
||||||
|
assert.equal(fs.readFileSync(testFixture.registry.sites[0].publicJsonPath, "utf8"), "old-public");
|
||||||
|
} finally {
|
||||||
|
testFixture.cleanup();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("processes subdomains separately and together without publishing disabled counters", () => {
|
||||||
|
const testFixture = fixture([
|
||||||
|
{ id: "alpha", publicCounter: true, compressed: true },
|
||||||
|
{ id: "bravo", publicCounter: false, rotated: false, compressed: true }
|
||||||
|
]);
|
||||||
|
const calls = [];
|
||||||
|
try {
|
||||||
|
const result = run(testFixture, {
|
||||||
|
alpha: goAccessReport({ "2026-09-11": 3 }),
|
||||||
|
bravo: goAccessReport({ "2026-09-11": 4 }),
|
||||||
|
combined: goAccessReport({ "2026-09-11": 6 }, true)
|
||||||
|
}, calls);
|
||||||
|
|
||||||
|
assert.equal(result.reports, 3);
|
||||||
|
assert.deepEqual(calls.map(call => call.id), ["alpha", "bravo", "combined"]);
|
||||||
|
const alphaLogs = [
|
||||||
|
`${testFixture.registry.sites[0].analyticsLog}.1`,
|
||||||
|
testFixture.registry.sites[0].analyticsLog
|
||||||
|
];
|
||||||
|
const bravoLogs = [testFixture.registry.sites[1].analyticsLog];
|
||||||
|
assert.deepEqual(calls[0].args.slice(0, 2), alphaLogs);
|
||||||
|
assert.deepEqual(calls[1].args.slice(0, 1), bravoLogs);
|
||||||
|
assert.deepEqual(
|
||||||
|
calls[2].args.slice(0, 3),
|
||||||
|
[...alphaLogs, ...bravoLogs]
|
||||||
|
);
|
||||||
|
assert.equal(calls[0].args.includes("--enable-panel=VIRTUAL_HOSTS"), false);
|
||||||
|
assert.equal(calls[1].args.includes("--enable-panel=VIRTUAL_HOSTS"), false);
|
||||||
|
assert.equal(calls[2].args.includes("--enable-panel=VIRTUAL_HOSTS"), true);
|
||||||
|
assert.equal(calls.some(call => call.args.some(argument => argument.endsWith(".gz"))), false);
|
||||||
|
assert.equal(fs.existsSync(path.join(
|
||||||
|
testFixture.registry.stateDirectory,
|
||||||
|
"public",
|
||||||
|
"bravo.json"
|
||||||
|
)), false);
|
||||||
|
assert.equal(fs.existsSync(path.join(
|
||||||
|
testFixture.registry.combined.reportOutputDirectory,
|
||||||
|
"report.html"
|
||||||
|
)), true);
|
||||||
|
} finally {
|
||||||
|
testFixture.cleanup();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("validates GoAccess 1.8.1 panel names strictly", () => {
|
||||||
|
const siteReport = goAccessReport({ "2026-09-11": 3 });
|
||||||
|
const combinedReport = goAccessReport({ "2026-09-11": 3 }, true);
|
||||||
|
|
||||||
|
assert.doesNotThrow(() => validateReport(siteReport, false));
|
||||||
|
assert.doesNotThrow(() => validateReport(combinedReport, true));
|
||||||
|
|
||||||
|
const missingGeolocation = goAccessReport({ "2026-09-11": 3 });
|
||||||
|
delete missingGeolocation.geolocation;
|
||||||
|
missingGeolocation.geo_location = { data: [] };
|
||||||
|
assert.throws(
|
||||||
|
() => validateReport(missingGeolocation, false),
|
||||||
|
/GoAccess JSON report has no geolocation panel/
|
||||||
|
);
|
||||||
|
|
||||||
|
const missingVhosts = goAccessReport({ "2026-09-11": 3 }, true);
|
||||||
|
delete missingVhosts.vhosts;
|
||||||
|
missingVhosts.virtual_hosts = { data: [] };
|
||||||
|
assert.throws(
|
||||||
|
() => validateReport(missingVhosts, true),
|
||||||
|
/GoAccess JSON report has no vhosts panel/
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("dry-run validates generated data without changing production paths", () => {
|
||||||
|
const testFixture = fixture([{ id: "alpha", publicCounter: true }]);
|
||||||
|
try {
|
||||||
|
const blockedLockParent = path.join(testFixture.root, "blocked-lock-parent");
|
||||||
|
fs.writeFileSync(blockedLockParent, "not a directory");
|
||||||
|
testFixture.registry.lockFile = path.join(blockedLockParent, "generator.lock");
|
||||||
|
fs.writeFileSync(testFixture.registryPath, JSON.stringify(testFixture.registry));
|
||||||
|
|
||||||
|
const result = generateReports({
|
||||||
|
registryPath: testFixture.registryPath,
|
||||||
|
configTemplatePath: testFixture.configTemplatePath,
|
||||||
|
goaccessBinary: "fake-goaccess",
|
||||||
|
dryRun: true
|
||||||
|
}, {
|
||||||
|
checkGoAccess: () => GOACCESS_WITHOUT_ZLIB,
|
||||||
|
runGoAccess: fakeGoAccess({
|
||||||
|
alpha: goAccessReport({ "2026-09-11": 3 }),
|
||||||
|
combined: goAccessReport({ "2026-09-11": 3 }, true)
|
||||||
|
}, []),
|
||||||
|
now: () => new Date("2026-09-11T07:00:00Z")
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(result.dryRun, true);
|
||||||
|
assert.equal(fs.statSync(blockedLockParent).isFile(), true);
|
||||||
|
assert.equal(fs.readdirSync(
|
||||||
|
testFixture.registry.sites[0].reportOutputDirectory
|
||||||
|
).length, 0);
|
||||||
|
assert.equal(fs.existsSync(testFixture.registry.sites[0].publicJsonPath), false);
|
||||||
|
assert.equal(fs.existsSync(testFixture.registry.counterStatePath), false);
|
||||||
|
} finally {
|
||||||
|
testFixture.cleanup();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("configuration check accepts and explains a GoAccess build without Zlib", () => {
|
||||||
|
const testFixture = fixture([{ id: "alpha", publicCounter: true, rotated: false }]);
|
||||||
|
try {
|
||||||
|
const versionOutput = [
|
||||||
|
"GoAccess - 1.8.1.",
|
||||||
|
"Build configure arguments:",
|
||||||
|
" --enable-geoip=mmdb",
|
||||||
|
" --with-openssl"
|
||||||
|
].join("\n");
|
||||||
|
const capabilities = parseGoAccessVersion(versionOutput);
|
||||||
|
const result = generateReports({
|
||||||
|
registryPath: testFixture.registryPath,
|
||||||
|
configTemplatePath: testFixture.configTemplatePath,
|
||||||
|
goaccessBinary: "fake-goaccess",
|
||||||
|
check: true
|
||||||
|
}, {
|
||||||
|
checkGoAccess: () => capabilities,
|
||||||
|
runGoAccess: () => {
|
||||||
|
throw new Error("configuration check must not generate reports");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
const message = formatGoAccessCheck(result.goAccess);
|
||||||
|
|
||||||
|
assert.deepEqual(capabilities, GOACCESS_WITHOUT_ZLIB);
|
||||||
|
assert.equal(result.checked, true);
|
||||||
|
assert.match(message, /Zlib not detected/);
|
||||||
|
assert.match(message, /no Zlib support/);
|
||||||
|
assert.match(message, /valid for regular mode/);
|
||||||
|
assert.match(message, /optional uncompressed \.1 rotation/);
|
||||||
|
assert.match(message, /older \.gz logs are not imported/);
|
||||||
|
} finally {
|
||||||
|
testFixture.cleanup();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("detects Zlib support when it is present", () => {
|
||||||
|
const capabilities = parseGoAccessVersion([
|
||||||
|
"GoAccess - 1.8.1.",
|
||||||
|
"Build configure arguments:",
|
||||||
|
" --enable-geoip=mmdb --with-openssl --with-zlib"
|
||||||
|
].join("\n"));
|
||||||
|
|
||||||
|
assert.equal(capabilities.zlib, true);
|
||||||
|
assert.match(formatGoAccessCheck(capabilities), /Zlib enabled/);
|
||||||
|
assert.doesNotMatch(formatGoAccessCheck(capabilities), /older \.gz logs/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("configuration check rejects GoAccess without GeoIP2 MMDB support", () => {
|
||||||
|
const testFixture = fixture([{ id: "alpha", publicCounter: true }]);
|
||||||
|
try {
|
||||||
|
assert.throws(() => generateReports({
|
||||||
|
registryPath: testFixture.registryPath,
|
||||||
|
configTemplatePath: testFixture.configTemplatePath,
|
||||||
|
check: true
|
||||||
|
}, {
|
||||||
|
checkGoAccess: () => ({
|
||||||
|
version: "1.8.1",
|
||||||
|
geoIpMmdb: false,
|
||||||
|
openSsl: true,
|
||||||
|
zlib: false
|
||||||
|
})
|
||||||
|
}), error => error.exitCode === 2
|
||||||
|
&& /must be built with GeoIP2\/MMDB support/.test(error.message));
|
||||||
|
} finally {
|
||||||
|
testFixture.cleanup();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("configuration check verifies analytics-log readability", () => {
|
||||||
|
const testFixture = fixture([{ id: "alpha", publicCounter: true, rotated: false }]);
|
||||||
|
const originalAccessSync = fs.accessSync;
|
||||||
|
try {
|
||||||
|
fs.accessSync = (filePath, mode) => {
|
||||||
|
if (filePath === testFixture.registry.sites[0].analyticsLog
|
||||||
|
&& mode === fs.constants.R_OK) {
|
||||||
|
const error = new Error("permission denied");
|
||||||
|
error.code = "EACCES";
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
return originalAccessSync(filePath, mode);
|
||||||
|
};
|
||||||
|
|
||||||
|
assert.throws(() => generateReports({
|
||||||
|
registryPath: testFixture.registryPath,
|
||||||
|
configTemplatePath: testFixture.configTemplatePath,
|
||||||
|
check: true
|
||||||
|
}, {
|
||||||
|
checkGoAccess: () => GOACCESS_WITHOUT_ZLIB
|
||||||
|
}), /analytics log is not readable by the current user/);
|
||||||
|
} finally {
|
||||||
|
fs.accessSync = originalAccessSync;
|
||||||
|
testFixture.cleanup();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("configuration check reports missing output directories", () => {
|
||||||
|
const testFixture = fixture([{ id: "alpha", publicCounter: true }]);
|
||||||
|
try {
|
||||||
|
fs.rmSync(testFixture.registry.sites[0].reportOutputDirectory, {
|
||||||
|
recursive: true,
|
||||||
|
force: true
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.throws(() => generateReports({
|
||||||
|
registryPath: testFixture.registryPath,
|
||||||
|
configTemplatePath: testFixture.configTemplatePath,
|
||||||
|
check: true
|
||||||
|
}, {
|
||||||
|
checkGoAccess: () => GOACCESS_WITHOUT_ZLIB
|
||||||
|
}), /report output directory for alpha does not exist/);
|
||||||
|
} finally {
|
||||||
|
testFixture.cleanup();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("rejects a compressed log as the regular analytics input", () => {
|
||||||
|
const testFixture = fixture([{ id: "alpha", publicCounter: true }]);
|
||||||
|
try {
|
||||||
|
testFixture.registry.sites[0].analyticsLog += ".2.gz";
|
||||||
|
fs.writeFileSync(testFixture.registryPath, JSON.stringify(testFixture.registry));
|
||||||
|
|
||||||
|
assert.throws(() => generateReports({
|
||||||
|
registryPath: testFixture.registryPath,
|
||||||
|
configTemplatePath: testFixture.configTemplatePath,
|
||||||
|
check: true
|
||||||
|
}, {
|
||||||
|
checkGoAccess: () => GOACCESS_WITHOUT_ZLIB
|
||||||
|
}), /must identify the current uncompressed log/);
|
||||||
|
} finally {
|
||||||
|
testFixture.cleanup();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("Nginx filters exclude non-page traffic before analytics logging", () => {
|
||||||
|
const source = fs.readFileSync(path.join(
|
||||||
|
__dirname,
|
||||||
|
"../ops/analytics/nginx/analytics-filters.conf.example"
|
||||||
|
), "utf8");
|
||||||
|
|
||||||
|
for (const excluded of [
|
||||||
|
"/visitor-count.json",
|
||||||
|
"/kst4ContestVersionInfo.xml",
|
||||||
|
"/sitemap.xml",
|
||||||
|
"/robots.txt",
|
||||||
|
"manual/assets",
|
||||||
|
"healthz"
|
||||||
|
]) {
|
||||||
|
assert.match(source, new RegExp(excluded.replaceAll("/", "\\/"), "i"));
|
||||||
|
}
|
||||||
|
assert.doesNotMatch(source, /^\s*=\//m);
|
||||||
|
assert.match(source, /^\s*\/visitor-count\.json\s+0;/m);
|
||||||
|
assert.match(source, /^\s*\/health\s+0;/m);
|
||||||
|
assert.match(source, /\|map\|/);
|
||||||
|
assert.match(source, /\$uri/);
|
||||||
|
assert.match(source, /known_bot/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("server templates use the production GeoIP path and permission model", () => {
|
||||||
|
const registry = JSON.parse(fs.readFileSync(path.join(
|
||||||
|
__dirname,
|
||||||
|
"../ops/analytics/sites.example.json"
|
||||||
|
), "utf8"));
|
||||||
|
const service = fs.readFileSync(path.join(
|
||||||
|
__dirname,
|
||||||
|
"../ops/analytics/systemd/hamradioonline-analytics.service.example"
|
||||||
|
), "utf8");
|
||||||
|
const generator = fs.readFileSync(path.join(
|
||||||
|
__dirname,
|
||||||
|
"../ops/analytics/generate-reports.js"
|
||||||
|
), "utf8");
|
||||||
|
|
||||||
|
assert.equal(registry.geoIpCountryDatabase, "/var/lib/GeoIP/GeoLite2-Country.mmdb");
|
||||||
|
assert.match(service, /\/var\/lib\/GeoIP\/GeoLite2-Country\.mmdb/);
|
||||||
|
assert.match(service, /^StateDirectoryMode=0711$/m);
|
||||||
|
assert.match(generator, /fs\.fchmodSync\(handle, mode\)/);
|
||||||
|
assert.match(generator, /publicFile\.destination, publicFile\.content, 0o644/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("public counter template disables logging and sets cache and type headers", () => {
|
||||||
|
const source = fs.readFileSync(path.join(
|
||||||
|
__dirname,
|
||||||
|
"../ops/analytics/nginx/public-counter.conf.example"
|
||||||
|
), "utf8");
|
||||||
|
|
||||||
|
assert.match(source, /^\s*access_log off;$/m);
|
||||||
|
assert.match(source, /Cache-Control "public, max-age=3600" always/);
|
||||||
|
assert.match(source, /X-Content-Type-Options "nosniff" always/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("statistics vhost preserves ACME renewal and protects HTTPS reports", () => {
|
||||||
|
const source = fs.readFileSync(path.join(
|
||||||
|
__dirname,
|
||||||
|
"../ops/analytics/nginx/stats-vhost.conf.example"
|
||||||
|
), "utf8");
|
||||||
|
const bootstrap = fs.readFileSync(path.join(
|
||||||
|
__dirname,
|
||||||
|
"../ops/analytics/nginx/stats-vhost-http-bootstrap.conf.example"
|
||||||
|
), "utf8");
|
||||||
|
const httpsOffset = source.search(/server\s*\{\s*listen 443 ssl http2;/);
|
||||||
|
assert.notEqual(httpsOffset, -1);
|
||||||
|
const httpSource = source.slice(0, httpsOffset);
|
||||||
|
const httpsSource = source.slice(httpsOffset);
|
||||||
|
|
||||||
|
assert.match(httpSource, /^\s*listen 80;$/m);
|
||||||
|
assert.match(httpSource, /^\s*access_log off;$/m);
|
||||||
|
assert.match(httpSource, /location \^~ \/\.well-known\/acme-challenge\//);
|
||||||
|
assert.match(httpSource, /root \/var\/lib\/letsencrypt;/);
|
||||||
|
assert.match(httpSource, /return 301 https:\/\/\$host\$request_uri;/);
|
||||||
|
assert.match(httpsSource, /^\s*listen 443 ssl http2;$/m);
|
||||||
|
assert.match(httpsSource, /^\s*auth_basic "Private project statistics";$/m);
|
||||||
|
assert.match(httpsSource, /^\s*access_log off;$/m);
|
||||||
|
assert.match(httpsSource, /location = \/[\s\S]*return 302 \/combined\/;/);
|
||||||
|
assert.match(httpsSource, /include \/etc\/letsencrypt\/options-ssl-nginx\.conf;/);
|
||||||
|
assert.match(httpsSource, /ssl_dhparam \/etc\/letsencrypt\/ssl-dhparams\.pem;/);
|
||||||
|
assert.doesNotMatch(source, /listen \[::\]/);
|
||||||
|
assert.match(bootstrap, /^\s*listen 80;$/m);
|
||||||
|
assert.doesNotMatch(bootstrap, /ssl_certificate/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("logrotate uses the Ubuntu Nginx rotation action", () => {
|
||||||
|
const source = fs.readFileSync(path.join(
|
||||||
|
__dirname,
|
||||||
|
"../ops/analytics/logrotate/hamradioonline-analytics.example"
|
||||||
|
), "utf8");
|
||||||
|
|
||||||
|
assert.match(source, /invoke-rc\.d nginx rotate >\/dev\/null 2>&1/);
|
||||||
|
assert.match(source, /^\s*delaycompress$/m);
|
||||||
|
assert.match(source, /^\s*rotate 14$/m);
|
||||||
|
assert.match(source, /^\s*create 0640 www-data hamradio-analytics$/m);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("website package records the Node.js 18.19.1 baseline", () => {
|
||||||
|
const packageJson = JSON.parse(fs.readFileSync(path.join(__dirname, "../package.json")));
|
||||||
|
const packageLock = JSON.parse(fs.readFileSync(path.join(__dirname, "../package-lock.json")));
|
||||||
|
|
||||||
|
assert.equal(packageJson.engines.node, ">=18.19.1");
|
||||||
|
assert.equal(packageLock.packages[""].engines.node, ">=18.19.1");
|
||||||
|
});
|
||||||
@@ -0,0 +1,120 @@
|
|||||||
|
const assert = require("node:assert/strict");
|
||||||
|
const fs = require("node:fs");
|
||||||
|
const path = require("node:path");
|
||||||
|
const test = require("node:test");
|
||||||
|
|
||||||
|
const eleventyConfig = require("../.eleventy.js");
|
||||||
|
|
||||||
|
test("selects the newest news article without relying on a version", () => {
|
||||||
|
const older = { date: new Date("2026-08-22"), data: { title: "Older" } };
|
||||||
|
const newest = { date: new Date("2026-09-03"), data: { title: "Newest" } };
|
||||||
|
|
||||||
|
assert.deepEqual(
|
||||||
|
eleventyConfig.selectLatestNews([older, newest]),
|
||||||
|
[newest]
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an empty news collection omits the latest-news item safely", () => {
|
||||||
|
assert.deepEqual(eleventyConfig.selectLatestNews([]), []);
|
||||||
|
assert.deepEqual(eleventyConfig.selectLatestNews(), []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("homepage keeps the statistical result tied to its limits", () => {
|
||||||
|
const source = fs.readFileSync(
|
||||||
|
path.join(__dirname, "../src/index.njk"),
|
||||||
|
"utf8"
|
||||||
|
);
|
||||||
|
|
||||||
|
assert.match(source, /almost 30% higher chat reply rate/);
|
||||||
|
assert.match(source, /chat replies, not completed QSOs/);
|
||||||
|
assert.match(source, /correlation within[\s\S]*not general proof of causation/);
|
||||||
|
assert.match(source, /July 2025 contest/);
|
||||||
|
assert.match(source, /144\/432 MHz and Microwave categories/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("background page links all public papers and no ODT source", () => {
|
||||||
|
const source = fs.readFileSync(
|
||||||
|
path.join(__dirname, "../src/background/index.njk"),
|
||||||
|
"utf8"
|
||||||
|
);
|
||||||
|
|
||||||
|
for (const name of [
|
||||||
|
"kst4contest-ghz-tagung-2025-de.pdf",
|
||||||
|
"kst4contest-ghz-tagung-2025-en.pdf",
|
||||||
|
"kst4contest-ghz-tagung-2026-de.pdf",
|
||||||
|
"kst4contest-ghz-tagung-2026-en.pdf"
|
||||||
|
]) {
|
||||||
|
assert.match(source, new RegExp(name.replaceAll(".", "\\.")));
|
||||||
|
}
|
||||||
|
assert.doesNotMatch(source, /\.odt\b/i);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("homepage contains one selected function grid and a complete-overview link", () => {
|
||||||
|
const source = fs.readFileSync(
|
||||||
|
path.join(__dirname, "../src/index.njk"),
|
||||||
|
"utf8"
|
||||||
|
);
|
||||||
|
|
||||||
|
assert.equal((source.match(/<h2>The parts most often used during a contest<\/h2>/g) || []).length, 1);
|
||||||
|
assert.match(source, /href="\/features\/"[^>]*>Open the complete function overview/);
|
||||||
|
assert.doesNotMatch(source, /Observe|Evaluate|>Act<|One workflow, shared context/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("screenshot page uses the four approved originals as full-size links", () => {
|
||||||
|
const page = fs.readFileSync(
|
||||||
|
path.join(__dirname, "../src/screenshots/index.njk"),
|
||||||
|
"utf8"
|
||||||
|
);
|
||||||
|
const css = fs.readFileSync(
|
||||||
|
path.join(__dirname, "../src/assets/css/main.css"),
|
||||||
|
"utf8"
|
||||||
|
);
|
||||||
|
const screenshots = require("../src/_data/screenshots.js");
|
||||||
|
|
||||||
|
assert.equal(screenshots.length, 4);
|
||||||
|
assert.deepEqual(
|
||||||
|
screenshots.map(({ image }) => image),
|
||||||
|
[
|
||||||
|
"/assets/completeViewLight.png",
|
||||||
|
"/assets/completeViewDark.png",
|
||||||
|
"/assets/timeline.png",
|
||||||
|
"/assets/complete_incl_AS.png"
|
||||||
|
]
|
||||||
|
);
|
||||||
|
assert.ok(screenshots.every(({ alt, caption }) => alt && caption));
|
||||||
|
assert.equal(screenshots.find(({ id }) => id === "timeline").wide, true);
|
||||||
|
assert.doesNotMatch(JSON.stringify(screenshots), /Priority Candidates/);
|
||||||
|
assert.match(page, /href="{{ shot\.image }}"[\s\S]*<img[^>]*src="{{ shot\.image }}"/);
|
||||||
|
assert.match(page, /Version-like text inside chat messages is[\s\S]*not an announcement/);
|
||||||
|
assert.match(css, /\.screenshot-image\s*\{[\s\S]*?width:\s*100%;[\s\S]*?height:\s*auto;/);
|
||||||
|
assert.match(css, /\.screenshot-card--wide\s*\{\s*grid-column:\s*1\s*\/\s*-1;/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("footer and download page expose background and conference papers", () => {
|
||||||
|
const layout = fs.readFileSync(
|
||||||
|
path.join(__dirname, "../src/_layouts/base.njk"),
|
||||||
|
"utf8"
|
||||||
|
);
|
||||||
|
const download = fs.readFileSync(
|
||||||
|
path.join(__dirname, "../src/download/index.njk"),
|
||||||
|
"utf8"
|
||||||
|
);
|
||||||
|
|
||||||
|
assert.match(layout, /<p><a href="\/background\/">Background<\/a><\/p>/);
|
||||||
|
for (const name of [
|
||||||
|
"kst4contest-ghz-tagung-2025-de.pdf",
|
||||||
|
"kst4contest-ghz-tagung-2025-en.pdf",
|
||||||
|
"kst4contest-ghz-tagung-2026-de.pdf",
|
||||||
|
"kst4contest-ghz-tagung-2026-en.pdf"
|
||||||
|
]) {
|
||||||
|
assert.match(download, new RegExp(`/assets/papers/${name.replaceAll(".", "\\.")}`));
|
||||||
|
}
|
||||||
|
assert.match(download, /href="\/background\/#paper-2025"/);
|
||||||
|
assert.match(download, /href="\/background\/#paper-2026"/);
|
||||||
|
assert.match(download, /historical conference papers[\s\S]*not a complete description of the current feature set/);
|
||||||
|
assert.ok(
|
||||||
|
download.indexOf("Background from GHz-Tagung Dorsten") >
|
||||||
|
download.indexOf('<div class="channel-panel" data-channel="nightly">')
|
||||||
|
);
|
||||||
|
});
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
const assert = require("node:assert/strict");
|
||||||
|
const fs = require("node:fs");
|
||||||
|
const path = require("node:path");
|
||||||
|
const test = require("node:test");
|
||||||
|
|
||||||
|
const {
|
||||||
|
formatVisitorCount,
|
||||||
|
loadVisitorCount,
|
||||||
|
validateVisitorCount
|
||||||
|
} = require("../src/assets/js/visitor-count");
|
||||||
|
|
||||||
|
const VALID_DATA = {
|
||||||
|
schemaVersion: 1,
|
||||||
|
visits: 1234,
|
||||||
|
since: "2026-09-11",
|
||||||
|
updatedAt: "2026-09-11T07:00:00Z"
|
||||||
|
};
|
||||||
|
|
||||||
|
function element() {
|
||||||
|
return { hidden: true, textContent: "" };
|
||||||
|
}
|
||||||
|
|
||||||
|
test("formats valid data for the English website", async () => {
|
||||||
|
const target = element();
|
||||||
|
let request;
|
||||||
|
const shown = await loadVisitorCount({
|
||||||
|
element: target,
|
||||||
|
fetchImpl: async (url, options) => {
|
||||||
|
request = { url, options };
|
||||||
|
return { ok: true, json: async () => VALID_DATA };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(shown, true);
|
||||||
|
assert.equal(target.hidden, false);
|
||||||
|
assert.equal(target.textContent, "Visits since 11 September 2026: 1,234");
|
||||||
|
assert.equal(request.url, "/visitor-count.json");
|
||||||
|
assert.equal(request.options.credentials, "omit");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("rejects unsupported schemas and invalid visit counts", () => {
|
||||||
|
for (const changes of [
|
||||||
|
{ schemaVersion: 2 },
|
||||||
|
{ visits: -1 },
|
||||||
|
{ visits: 1.5 },
|
||||||
|
{ visits: Number.MAX_SAFE_INTEGER + 1 }
|
||||||
|
]) {
|
||||||
|
assert.equal(validateVisitorCount({ ...VALID_DATA, ...changes }), null);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("rejects invalid dates and timestamps without timezone shifts", () => {
|
||||||
|
for (const changes of [
|
||||||
|
{ since: "2026-02-30" },
|
||||||
|
{ since: "11-09-2026" },
|
||||||
|
{ updatedAt: "2026-09-11" },
|
||||||
|
{ updatedAt: "2026-02-30T07:00:00Z" },
|
||||||
|
{ updatedAt: "2026-09-11T25:00:00Z" },
|
||||||
|
{ updatedAt: "not-a-timestamp" }
|
||||||
|
]) {
|
||||||
|
assert.equal(formatVisitorCount({ ...VALID_DATA, ...changes }), null);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("keeps the element hidden for HTTP and fetch failures", async () => {
|
||||||
|
for (const fetchImpl of [
|
||||||
|
async () => ({ ok: false }),
|
||||||
|
async () => { throw new Error("network failure"); }
|
||||||
|
]) {
|
||||||
|
const target = element();
|
||||||
|
assert.equal(await loadVisitorCount({ element: target, fetchImpl }), false);
|
||||||
|
assert.equal(target.hidden, true);
|
||||||
|
assert.equal(target.textContent, "");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("aborts a slow request and keeps the element hidden", async () => {
|
||||||
|
const target = element();
|
||||||
|
let aborted = false;
|
||||||
|
const fetchImpl = (url, options) => new Promise((resolve, reject) => {
|
||||||
|
options.signal.addEventListener("abort", () => {
|
||||||
|
aborted = true;
|
||||||
|
reject(new Error("aborted"));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(await loadVisitorCount({
|
||||||
|
element: target,
|
||||||
|
fetchImpl,
|
||||||
|
timeoutMs: 5
|
||||||
|
}), false);
|
||||||
|
assert.equal(aborted, true);
|
||||||
|
assert.equal(target.hidden, true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("uses textContent and loads the script only for the home page", () => {
|
||||||
|
const script = fs.readFileSync(path.join(
|
||||||
|
__dirname,
|
||||||
|
"../src/assets/js/visitor-count.js"
|
||||||
|
), "utf8");
|
||||||
|
const home = fs.readFileSync(path.join(__dirname, "../src/index.njk"), "utf8");
|
||||||
|
const layout = fs.readFileSync(path.join(
|
||||||
|
__dirname,
|
||||||
|
"../src/_layouts/base.njk"
|
||||||
|
), "utf8");
|
||||||
|
const sourceRoot = path.join(__dirname, "../src");
|
||||||
|
const otherPages = fs.readdirSync(sourceRoot, { recursive: true })
|
||||||
|
.filter(entry => entry.endsWith(".njk") && entry !== "index.njk");
|
||||||
|
|
||||||
|
assert.doesNotMatch(script, /innerHTML/);
|
||||||
|
assert.match(script, /textContent/);
|
||||||
|
assert.match(home, /^visitorCount: true$/m);
|
||||||
|
assert.match(layout, /\{% if visitorCount %\}/);
|
||||||
|
assert.equal(
|
||||||
|
otherPages.some(entry => fs.readFileSync(path.join(sourceRoot, entry), "utf8")
|
||||||
|
.includes("visitorCount: true")),
|
||||||
|
false
|
||||||
|
);
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user