Base working for damage

This commit is contained in:
2026-10-09 23:10:40 -06:00
parent 2895be91c4
commit 3e0ad62cf2
31 changed files with 9758 additions and 67 deletions
+1
View File
@@ -0,0 +1 @@
3.10
+2
View File
@@ -1,2 +1,4 @@
include README.md
include src/assets/*.png
include src/static/*
include src/scripts/*
+72 -6
View File
@@ -7,6 +7,10 @@
**Powered by** <a href="https://github.com/mazurwiktor/aoaddons-python"> **pyaoaddons** </a> & <a href="https://github.com/mazurwiktor/albion-online-addons"> **albion online addons** </a>
> On Linux the app no longer depends on `pyaoaddons`: it ships a pure-Python
> Protocol18 decoder and captures packets directly through `AF_PACKET`
> (no libpcap needed). `pyaoaddons` is still used on Windows and macOS.
[![Discord](https://discordapp.com/api/guilds/639922572368150552/widget.png?style=banner2)](https://discord.gg/3U2rpyV)
@@ -30,15 +34,65 @@ Albion online stats is an extension to MMORPG game - Albion Online. It tracks ne
## Installation
1. On windows make sure that WinPcap is installed in your system. [Npcap 0.9983 installer for Windows Vista/2008, 7/2008R2, 8/2012, 8.1/2012R2, 10/2016 (x86 and x64)](https://nmap.org/npcap/dist/npcap-0.9983.exe) **Make sure to install with the "Install Npcap in WinPcap API-compatible Mode"**
### Windows
1. Make sure that WinPcap is installed in your system. [Npcap 0.9983 installer for Windows Vista/2008, 7/2008R2, 8/2012, 8.1/2012R2, 10/2016 (x86 and x64)](https://nmap.org/npcap/dist/npcap-0.9983.exe) **Make sure to install with the "Install Npcap in WinPcap API-compatible Mode"**
2. Install python [all platforms installation instructions](https://docs.python.org/3/using/) or via [Microsoft Store](https://www.microsoft.com/en-us/p/python-39/9p7qfqmjrfp7).
3. Download latest launcher from https://github.com/mazurwiktor/albion-online-stats/releases/latest (albion-online-stats.bat for windows albion-online-stats.sh for linux and mac)
3. Enjoy :)
3. Download the latest launcher from https://github.com/mazurwiktor/albion-online-stats/releases/latest (`albion-online-stats.bat`).
4. Enjoy :)
### Linux / macOS
1. Install python 3 and the `venv` module with your package manager. On macOS also install libpcap:
```shell
# Debian / Ubuntu
sudo apt install python3 python3-venv python3-pip
# Fedora
sudo dnf install python3 python3-pip
# Arch
sudo pacman -S python
# macOS
brew install libpcap
```
2. Capturing network traffic requires elevated privileges. Either run the app with `sudo`, or grant the Python interpreter the capabilities it needs:
```shell
sudo setcap cap_net_raw,cap_net_admin=eip "$(readlink -f "$(command -v python3)")"
```
The app can do this for you from the **Fix capture permissions** button in its error dialog.
3. Download the latest launcher from https://github.com/mazurwiktor/albion-online-stats/releases/latest (`albion-online-stats.sh`), make it executable and run it:
```shell
chmod +x albion-online-stats.sh
./albion-online-stats.sh
```
4. Enjoy :)
> **Note:** on macOS (and Windows) the packet capture backend (`pyaoaddons`) only ships prebuilt wheels for CPython 3.6-3.10. If you use a newer Python, `pyaoaddons` is not installed automatically and the app will report that the backend is missing. Either use Python 3.10 (or older) or build `pyaoaddons` from source (requires a Rust toolchain). This does not affect Linux, where the built-in decoder is used.
## Configuration
After first execution the app is going to create default configuration file named `albion-online-stats.cfg`. Feel free to edit it according to your needs.
## Debugging
Start the app with `--verbose` (or set `AOSTATS_VERBOSE=1`) to enable detailed logging of the app and the packet capture backend:
```shell
aostats --verbose
```
This prints the backend initialization result, the capture-permission probe, and every received game event to the terminal. On Windows/macOS the capture backend also writes its own log to `aoaddons.log` in the current working directory.
On Linux the app uses its own `AF_PACKET` capture and Protocol18 decoder; every interface it listens on and every decoded event is logged with `--verbose`.
On Linux, when the app has no permission to capture packets the backend still reports successful initialization; the app detects this and shows a "Fix capture permissions" button regardless.
## Is This Allowed
<p align="center">
<img src="assets/sbistatement.png">
@@ -60,8 +114,9 @@ After first execution the app is going to create default configuration file name
## Prerequisites
- Python installed (python3.6+)
- Python installed (python3.6+). On Linux the built-in decoder requires no extra runtime. On Windows/macOS use CPython 3.6-3.10 to get the `pyaoaddons` capture backend as a prebuilt wheel; newer versions require building it from source.
- *Windows only prerequisites* https://github.com/libpnet/libpnet#windows
- *macOS only prerequisites* libpcap (`brew install libpcap`)
## All platforms
@@ -79,10 +134,21 @@ After first execution the app is going to create default configuration file name
```
3. Install package
3. Install the package with pip (this also installs the dependencies).
On Linux this is all you need. On Windows/macOS, use Python 3.6-3.10 to get the `pyaoaddons` capture backend automatically.
```shell
python setup.py install
python -m pip install .
```
On Windows/macOS with Python 3.11+ the capture backend is not installed
automatically. Either use a Python 3.6-3.10 interpreter, or build
`pyaoaddons` from source first:
```shell
pip install setuptools-rust
pip install --no-build-isolation git+https://github.com/mazurwiktor/aoaddons-python.git
python -m pip install ".[capture]"
```
4. Run the application
Regular → Executable
+37 -13
View File
@@ -1,26 +1,50 @@
#!/bin/bash
#!/usr/bin/env bash
#
# Albion Online Stats launcher for Linux and macOS.
set -eu
FOUND_PYTHON="none"
FOUND_PYTHON=""
for app in python3 python
do
if [ -x "$(command -v $app)" ]; then
FOUND_PYTHON=$app
for app in python3 python; do
if command -v "$app" >/dev/null 2>&1; then
if "$app" -c 'import sys; sys.exit(0 if sys.version_info[0] == 3 else 1)' >/dev/null 2>&1; then
FOUND_PYTHON="$app"
break
fi
fi
done
echo "Found python: $FOUND_PYTHON"
if [ -z "$FOUND_PYTHON" ]; then
echo "Error: python 3 was not found in the system." >&2
echo "Install it with your package manager, e.g.:" >&2
echo " Debian/Ubuntu: sudo apt install python3 python3-venv python3-pip" >&2
echo " Fedora: sudo dnf install python3 python3-pip" >&2
echo " Arch: sudo pacman -S python" >&2
exit 1
fi
echo "Creating python virtual environment"
python -m venv python_env
echo "Found python: $FOUND_PYTHON ($("$FOUND_PYTHON" --version 2>&1))"
source python_env/bin/activate
if ! "$FOUND_PYTHON" -m venv --help >/dev/null 2>&1; then
echo "Error: the python 'venv' module is not available." >&2
echo "On Debian/Ubuntu install it with: sudo apt install python3-venv" >&2
exit 1
fi
echo "Installing albion online stats"
# The pyaoaddons capture backend is only used on macOS now (Linux uses the
# built-in AF_PACKET decoder and has no pyaoaddons wheel requirement).
echo "Creating python virtual environment..."
"$FOUND_PYTHON" -m venv python_env
# shellcheck disable=SC1091
. ./python_env/bin/activate
echo "Installing albion online stats..."
python -m pip install --upgrade pip
python -m pip install aostats
python -m pip install --upgrade aostats
aostats
echo "Starting Albion Online Stats..."
aostats "$@"
+17 -5
View File
@@ -3,13 +3,24 @@ from setuptools import setup, find_packages
from src.version import version
install_requires = [
"requests==2.26.0",
"PySide6==6.2.0",
"toml==0.10.2",
"pillow==8.4.0",
"pyaoaddons==0.2.8"
"requests>=2.26",
"PySide6>=6.2",
"toml>=0.10.2",
"pillow>=8.4",
# On Linux the app ships a pure-Python Protocol18 decoder and captures with
# AF_PACKET directly, so no native backend is needed. On Windows/macOS the
# pyaoaddons packet capture backend is still used; only 0.2.8 is released
# and it ships prebuilt wheels for CPython 3.6-3.10 only. On newer Python
# versions it must be built from source (see the 'capture' extra).
"pyaoaddons==0.2.8; python_version < '3.11' and sys_platform != 'linux'",
]
extras_require = {
# Force installation of the packet capture backend, e.g. when building
# pyaoaddons from source or using an unsupported Python version.
'capture': ['pyaoaddons==0.2.8'],
}
this_directory = path.abspath(path.dirname(__file__))
with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
long_description = f.read()
@@ -25,6 +36,7 @@ with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
packages=find_packages('.', include=('src*')),
include_package_data=True,
install_requires=install_requires,
extras_require=extras_require,
entry_points={
'console_scripts': [
'aostats = src.__main__:run'
+65 -13
View File
@@ -1,6 +1,27 @@
import logging
from .environment import TEST_ENV_ENABLED
from . import environment
from .utils import platform_utils
logger = logging.getLogger(__name__)
class InitializationResult:
Ok = 0
UnknownFailure = 1
NetworkInterfaceListMissing = 2
BackendNotInstalled = 3
try:
import pyaoaddons # type: ignore
except:
BACKEND_AVAILABLE = True
except ImportError:
BACKEND_AVAILABLE = False
class pyaoaddons: # type: ignore
@staticmethod
def initialize():
@@ -10,15 +31,6 @@ except:
def subscribe(_):
pass
from .environment import TEST_ENV_ENABLED
from . import environment
class InitializationResult:
Ok = 0
UnknownFailure = 1
NetworkInterfaceListMissing = 2
INITIALIZATION_RESULT = {
0: InitializationResult.Ok,
@@ -26,24 +38,64 @@ INITIALIZATION_RESULT = {
2: InitializationResult.NetworkInterfaceListMissing
}
# On Linux we ship a pure-Python Protocol18 decoder and use AF_PACKET directly,
# so pyaoaddons is not required.
NATIVE_BACKEND_AVAILABLE = platform_utils.is_linux()
_capture = None
def initialize():
if TEST_ENV_ENABLED:
return InitializationResult.Ok
if NATIVE_BACKEND_AVAILABLE:
return InitializationResult.Ok
if not BACKEND_AVAILABLE:
return InitializationResult.BackendNotInstalled
try:
result = pyaoaddons.initialize()
return INITIALIZATION_RESULT[result]
except:
pass
except Exception:
return InitializationResult.UnknownFailure
def subscribe(callback):
if TEST_ENV_ENABLED:
return _testing_call_sequence(callback)
_testing_call_sequence(callback)
return True
if NATIVE_BACKEND_AVAILABLE:
return _start_native_backend(callback)
if BACKEND_AVAILABLE:
pyaoaddons.subscribe(callback)
return True
return False
def _start_native_backend(callback):
global _capture
if _capture is not None:
return True
from .decode.pipeline import Pipeline
from .net.capture import CaptureEngine
pipeline = Pipeline(callback)
capture = CaptureEngine(pipeline.on_udp)
if not capture.start():
logger.error(
"native capture backend could not start; "
"check packet capture permissions")
return False
_capture = capture
return True
def _testing_call_sequence(callback):
+2
View File
@@ -0,0 +1,2 @@
from .photon import PhotonDecoder, PhotonMessage
from .world import World
+50
View File
@@ -0,0 +1,50 @@
import os
from typing import Dict, Optional
_ITEM_DB: Optional[Dict[int, str]] = None
_ITEM_DB_PATH = os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))), 'static', 'item_ids.txt')
def _load() -> Dict[int, str]:
db = {}
with open(_ITEM_DB_PATH, encoding='utf-8') as f:
for line in f:
parts = line.strip().split(',', 1)
if len(parts) != 2:
continue
try:
_id = int(parts[0])
except ValueError:
continue
name = parts[1].strip()
if name:
db[_id] = name
return db
def get_db() -> Dict[int, str]:
global _ITEM_DB
if _ITEM_DB is None:
_ITEM_DB = _load()
return _ITEM_DB
ITEMS_SLOTS = ('weapon', 'offhand', 'helmet', 'armor', 'boots', 'bag', 'cape', 'mount', 'potion', 'food')
def decode_items(item_array) -> Dict[str, Optional[str]]:
"""Maps an equipment number array to slot -> item unique name.
Always returns all slots (aoaddons' ``Items`` struct keeps every field,
using ``None`` for empty/missing equipment) so downstream consumers can
index ``items['weapon']`` unconditionally.
"""
db = get_db()
items: Dict[str, Optional[str]] = {slot: None for slot in ITEMS_SLOTS}
for slot, _id in enumerate(ITEMS_SLOTS):
if item_array is None or slot >= len(item_array):
break
code = item_array[slot]
if code and code in db:
items[_id] = db[code]
return items
+380
View File
@@ -0,0 +1,380 @@
import struct
import logging
from collections import namedtuple
from typing import Dict, List, Optional
logger = logging.getLogger(__name__)
PROTOCOL18_SIGNAL = 0xF3
# Photon command types inside an eNet envelope
CMD_SEND_RELIABLE = 0x06
CMD_SEND_UNRELIABLE = 0x07
CMD_SEND_FRAGMENT = 0x08
CMD_SEND_UNRELIABLE_FRAGMENT = 0x0B
CMD_ACKNOWLEDGE = 0x03
CMD_PING = 0x05
CMD_LOGOUT = 0x04
# Photon message types
MSG_OPERATION_REQUEST = 0x02
MSG_OPERATION_RESPONSE = 0x03
MSG_EVENT_DATA = 0x04
MSG_INTERNAL_REQUEST = 0x06
MSG_INTERNAL_RESPONSE = 0x07
P18 = {
'Boolean': 2, 'Byte': 3, 'Short': 4, 'Float': 5, 'Double': 6, 'String': 7,
'Null': 8, 'CompressedInt': 9, 'CompressedLong': 10, 'Int1': 11, 'Int1Neg': 12,
'Int2': 13, 'Int2Neg': 14, 'Long1': 15, 'Long1Neg': 16, 'Long2': 17, 'Long2Neg': 18,
'Custom': 19, 'Dictionary': 20, 'Hashtable': 21, 'ObjectArray': 23,
'OperationRequest': 24, 'OperationResponse': 25, 'EventData': 26,
'BooleanFalse': 27, 'BooleanTrue': 28, 'ShortZero': 29, 'IntZero': 30,
'LongZero': 31, 'FloatZero': 32, 'DoubleZero': 33, 'ByteZero': 34,
'Array': 64, 'BooleanArray': 66, 'ByteArray': 67, 'ShortArray': 68,
'FloatArray': 69, 'DoubleArray': 70, 'StringArray': 71, 'CompressedIntArray': 73,
'CompressedLongArray': 74, 'CustomTypeArray': 83, 'DictionaryArray': 84,
'HashtableArray': 85, 'CustomTypeSlim': 128,
}
PhotonMessage = namedtuple(
'PhotonMessage', ('kind', 'code', 'params', 'return_code', 'debug_message'))
GAME_PORT = 5056
FRAG_HEADER_LEN = 20 # 5 x u32
class DecodeError(Exception):
pass
def _need(buf: bytes, pos: int, n: int, what: str):
if pos + n > len(buf):
raise DecodeError(f"not enough bytes for {what} at {pos}")
def rd_u8(buf: bytes, pos: int):
_need(buf, pos, 1, "u8")
return buf[pos], pos + 1
def rd_i16le(buf: bytes, pos: int):
_need(buf, pos, 2, "i16le")
return struct.unpack("<h", buf[pos:pos + 2])[0], pos + 2
def rd_u16le(buf: bytes, pos: int):
_need(buf, pos, 2, "u16le")
return struct.unpack("<H", buf[pos:pos + 2])[0], pos + 2
def rd_u16be(buf: bytes, pos: int):
_need(buf, pos, 2, "u16be")
return struct.unpack(">H", buf[pos:pos + 2])[0], pos + 2
def rd_u32be(buf: bytes, pos: int):
_need(buf, pos, 4, "u32be")
return struct.unpack(">I", buf[pos:pos + 4])[0], pos + 4
def rd_u32le(buf: bytes, pos: int):
_need(buf, pos, 4, "u32le")
return struct.unpack("<I", buf[pos:pos + 4])[0], pos + 4
def rd_f32le(buf: bytes, pos: int):
_need(buf, pos, 4, "f32le")
return struct.unpack("<f", buf[pos:pos + 4])[0], pos + 4
def rd_f64le(buf: bytes, pos: int):
_need(buf, pos, 8, "f64le")
return struct.unpack("<d", buf[pos:pos + 8])[0], pos + 8
def rd_varint(buf: bytes, pos: int):
value = 0
for shift in range(0, 64, 7):
b, pos = rd_u8(buf, pos)
if b & 0x80 == 0:
return value | (b << shift), pos
value |= (b & 0x7F) << shift
raise DecodeError("varint overflow")
def zigzag(v):
return (v >> 1) ^ (-(v & 1))
def read_string18(buf: bytes, pos: int):
slen, pos = rd_varint(buf, pos)
if slen == 0:
return "", pos
_need(buf, pos, slen, "string")
return buf[pos:pos + slen].decode('utf-8', 'replace'), pos + slen
def deserialize18(buf: bytes, pos: int, tc: int):
if tc >= P18['CustomTypeSlim']:
return ('custom', tc - P18['CustomTypeSlim']), pos
if tc == P18['Boolean']:
v, p = rd_u8(buf, pos)
return bool(v), p
if tc in (P18['Byte'], P18['ByteZero']):
if tc == P18['ByteZero']:
return 0, pos
return rd_u8(buf, pos)
if tc == P18['Short']:
return rd_i16le(buf, pos)
if tc == P18['Float']:
return rd_f32le(buf, pos)
if tc == P18['Double']:
return rd_f64le(buf, pos)
if tc == P18['String']:
return read_string18(buf, pos)
if tc in (P18['Null'], P18['BooleanFalse'], P18['BooleanTrue'],
P18['ShortZero'], P18['IntZero'], P18['LongZero'],
P18['FloatZero'], P18['DoubleZero']):
return None, pos
if tc == P18['CompressedInt']:
v, p = rd_varint(buf, pos)
return zigzag(v), p
if tc == P18['CompressedLong']:
v, p = rd_varint(buf, pos)
return zigzag(v), p
if tc in (P18['Int1'], P18['Long1']):
return rd_u8(buf, pos)
if tc == P18['Int1Neg'] or tc == P18['Long1Neg']:
v, p = rd_u8(buf, pos)
return -v, p
if tc in (P18['Int2'], P18['Long2']):
return rd_u16le(buf, pos)
if tc == P18['Int2Neg'] or tc == P18['Long2Neg']:
v, p = rd_u16le(buf, pos)
return -v, p
if tc == P18['ByteArray']:
n, p = rd_varint(buf, pos)
_need(buf, p, n, "byte array")
return bytes(buf[p:p + n]), p + n
if tc == P18['ShortArray']:
return _read_number_array(buf, pos, lambda b, p: rd_i16le(b, p), "short array")
if tc == P18['FloatArray']:
return _read_number_array(buf, pos, rd_f32le, "float array")
if tc == P18['DoubleArray']:
return _read_number_array(buf, pos, rd_f64le, "double array")
if tc == P18['StringArray']:
n, p = rd_varint(buf, pos)
out = []
for _ in range(n):
s, p = read_string18(buf, p)
out.append(s)
return out, p
if tc == P18['CompressedIntArray']:
n, p = rd_varint(buf, pos)
out = []
for _ in range(n):
v, p = rd_varint(buf, p)
out.append(zigzag(v))
return out, p
if tc == P18['CompressedLongArray']:
n, p = rd_varint(buf, pos)
out = []
for _ in range(n):
v, p = rd_varint(buf, p)
out.append(zigzag(v))
return out, p
if tc == P18['BooleanArray']:
n, p = rd_varint(buf, pos)
out = []
for _ in range(n):
v, p = rd_u8(buf, p)
out.append(bool(v))
return out, p
if tc in (P18['Array'], P18['ObjectArray'], P18['CustomTypeArray']):
n, p = rd_varint(buf, pos)
out = []
for _ in range(n):
et, p = rd_u8(buf, p)
v, p = deserialize18(buf, p, et)
out.append(v)
return out, p
if tc in (P18['Dictionary'], P18['Hashtable'], P18['DictionaryArray'], P18['HashtableArray']):
return _decode_map18(buf, pos, tc)
if tc == P18['Custom']:
t, p = rd_u8(buf, pos)
n, p = rd_varint(buf, p)
_need(buf, p, n, "custom")
return ('custom', t, bytes(buf[p:p + n])), p + n
raise DecodeError(f"unhandled P18 type 0x{tc:02X} at {pos}")
def _read_number_array(buf: bytes, pos: int, reader, what: str):
n, p = rd_varint(buf, pos)
out = []
for _ in range(n):
v, p = reader(buf, p)
out.append(v)
return out, p
def _decode_map18(buf: bytes, pos: int, tc: int):
if tc in (P18['Dictionary'], P18['DictionaryArray']):
kt, pos0 = rd_u8(buf, pos)
vt, p = rd_u8(buf, pos0)
n, p = rd_varint(buf, p)
out = {}
for _ in range(n):
if kt == 0:
kt2, p = rd_u8(buf, p)
k, p = deserialize18(buf, p, kt2)
else:
k, p = deserialize18(buf, p, kt)
if vt == 0:
vt2, p = rd_u8(buf, p)
v, p = deserialize18(buf, p, vt2)
else:
v, p = deserialize18(buf, p, vt)
out[k] = v
return out, p
n, p = rd_varint(buf, pos)
out = {}
for _ in range(n):
kt, p = rd_u8(buf, p)
k, p = deserialize18(buf, p, kt)
vt, p = rd_u8(buf, p)
v, p = deserialize18(buf, p, vt)
out[k] = v
return out, p
def decode_params18(buf: bytes, pos: int):
size, pos = rd_u8(buf, pos)
out = {}
for _ in range(size):
key, pos = rd_u8(buf, pos)
tc, pos = rd_u8(buf, pos)
val, pos = deserialize18(buf, pos, tc)
out[key] = val
return out, pos
def decode_message18(buf: bytes, pos: int):
_, pos = rd_u8(buf, pos) # signal byte 0xF3
msg_type, pos = rd_u8(buf, pos)
msg_type &= 0x7F
if msg_type in (MSG_OPERATION_REQUEST, MSG_INTERNAL_REQUEST):
code, pos = rd_u8(buf, pos)
params, pos = decode_params18(buf, pos)
return PhotonMessage('Request', code, params, None, None), pos
if msg_type in (MSG_OPERATION_RESPONSE, MSG_INTERNAL_RESPONSE):
code, pos = rd_u8(buf, pos)
ret, pos = rd_i16le(buf, pos)
dv_type, pos = rd_u8(buf, pos)
dv, pos = deserialize18(buf, pos, dv_type)
params, pos = decode_params18(buf, pos)
return PhotonMessage('Response', code, params, ret, dv), pos
if msg_type == MSG_EVENT_DATA:
code, pos = rd_u8(buf, pos)
params, pos = decode_params18(buf, pos)
return PhotonMessage('Event', code, params, None, None), pos
raise DecodeError(f"unknown message type 0x{msg_type:02X}")
class FragmentAssembler:
"""Reassembles eNet SendFragment sequences into whole Photon messages."""
def __init__(self):
self._fragments: Dict[tuple, dict] = {}
def add(self, peer: int, start_seq: int, fragment_count: int,
fragment_number: int, total_length: int, data: bytes):
key = (peer, start_seq)
group = self._fragments.setdefault(
key, {'count': fragment_count, 'parts': {}, 'total': total_length})
if group['count'] != fragment_count:
self._fragments.pop(key, None)
return None
group['parts'][fragment_number] = data
if len(group['parts']) < group['count']:
return None
payload = b''.join(group['parts'][i] for i in range(group['count']))
self._fragments.pop(key, None)
return payload
class PhotonDecoder:
def __init__(self):
self.assembler = FragmentAssembler()
def decode_packet(self, payload: bytes, peer: int = 0) -> List[PhotonMessage]:
messages: List[PhotonMessage] = []
try:
return self._decode_packet(payload, peer, messages)
except DecodeError as e:
logger.debug("dropping undecodable UDP payload: %s", e)
return messages
def _decode_packet(self, payload: bytes, peer: int,
messages: List[PhotonMessage]) -> List[PhotonMessage]:
pos = 0
_peer, pos = rd_u16be(payload, pos)
crc, pos = rd_u8(payload, pos)
count, pos = rd_u8(payload, pos)
_ts, pos = rd_u32be(payload, pos)
_ch, pos = rd_u32be(payload, pos)
for _ in range(count):
cmd_type, pos = rd_u8(payload, pos)
_channel, pos = rd_u8(payload, pos)
_flags, pos = rd_u8(payload, pos)
_reserved, pos = rd_u8(payload, pos)
length, pos = rd_u32be(payload, pos)
_seq, pos = rd_u32be(payload, pos)
data_len = length - 12
if cmd_type == CMD_SEND_FRAGMENT:
start_seq, pos = rd_u32be(payload, pos)
fragment_count, pos = rd_u32be(payload, pos)
fragment_number, pos = rd_u32be(payload, pos)
total_length, pos = rd_u32be(payload, pos)
_offset, pos = rd_u32be(payload, pos)
data = payload[pos:pos + data_len - FRAG_HEADER_LEN]
pos += data_len - FRAG_HEADER_LEN
reassembled = self.assembler.add(
peer, start_seq, fragment_count, fragment_number, total_length, data)
if reassembled is not None:
messages.extend(self._decode_message(reassembled, peer))
continue
if cmd_type in (CMD_ACKNOWLEDGE, CMD_PING):
pos += data_len
continue
if cmd_type == CMD_LOGOUT:
continue
if cmd_type in (CMD_SEND_RELIABLE, CMD_SEND_UNRELIABLE,
CMD_SEND_UNRELIABLE_FRAGMENT):
if cmd_type in (CMD_SEND_UNRELIABLE,
CMD_SEND_UNRELIABLE_FRAGMENT):
pos += 4 # unknown/unreliable sequence trailers
data_len -= 4
msg_bytes = payload[pos:pos + data_len]
pos += data_len
messages.extend(self._decode_message(msg_bytes, peer))
continue
pos += data_len
return messages
def _decode_message(self, msg_bytes: bytes, peer: int) -> List[PhotonMessage]:
if not msg_bytes:
return []
signal = msg_bytes[0]
if signal != PROTOCOL18_SIGNAL:
logger.debug("dropping message with unknown signal 0x%02X", signal)
return []
try:
msg, _ = decode_message18(msg_bytes, 0)
except DecodeError as e:
logger.debug("dropping undecodable Photon message: %s", e)
return []
logger.debug("decoded Photon message: %s", msg)
return [msg]
+40
View File
@@ -0,0 +1,40 @@
import threading
import logging
from typing import Callable, List
from .photon import PhotonDecoder, PhotonMessage
from .translate import into_game_message
from .world import World
logger = logging.getLogger(__name__)
class Pipeline:
"""Decodes captured UDP payloads into app events (aoaddons lib.rs flow)."""
def __init__(self, emit: Callable[[dict], None]):
self.emit = emit
self.decoder = PhotonDecoder()
self.world = World()
self._lock = threading.RLock()
def on_udp(self, payload: bytes):
logger.debug("received UDP payload: %d bytes", len(payload))
messages = self.decoder.decode_packet(payload)
if not messages:
return
with self._lock:
for message in messages:
for event in self._events_from_message(message):
self.emit(event)
def _events_from_message(self, message: PhotonMessage) -> List[dict]:
game_message = into_game_message(message)
if game_message is None:
return []
logger.debug("translated game message: %s", game_message)
events = self.world.transform(game_message)
for event in events:
logger.debug("emitting app event: %s", event)
return events
+198
View File
@@ -0,0 +1,198 @@
from dataclasses import dataclass, field
from typing import Optional, List
from .photon import PhotonMessage
# Photon message code used for game traffic (aoaddons pipeline guard)
PHOTON_GAME_CODE = 1
# Current opcodes (albion-lens numbering, verified against captured traffic)
EVENT_LEAVE = 1
EVENT_HEALTH_UPDATE = 6
EVENT_NEW_CHARACTER = 29
EVENT_UPDATE_FAME = 82
EVENT_CHARACTER_EQUIPMENT_CHANGED = 90
EVENT_REGENERATION_HEALTH_CHANGED = 91
EVENT_KNOCKED_DOWN = 166
EVENT_PARTY_INVITATION = 229
EVENT_PARTY_JOIN_REQUEST = 230
EVENT_PARTY_JOINED = 231
EVENT_PARTY_DISBANDED = 232
EVENT_PARTY_PLAYER_JOINED = 233
EVENT_PARTY_CHANGED_ORDER = 234
EVENT_PARTY_PLAYER_LEFT = 235
# Operation codes (response parameter 253)
OPERATION_JOIN = 2
OPERATION_CHANGE_CLUSTER = 41
def _int(value) -> Optional[int]:
if isinstance(value, bool):
return int(value)
if isinstance(value, (int, float)):
return int(value)
return None
def _float(value) -> Optional[float]:
if isinstance(value, bool):
return float(value)
if isinstance(value, (int, float)):
return float(value)
return None
def _string(value) -> Optional[str]:
if isinstance(value, str):
return value
return None
def _as_int_list(value) -> List[int]:
if isinstance(value, bytes):
return list(value)
if isinstance(value, list):
out = []
for v in value:
i = _int(v)
if i is not None:
out.append(i)
return out
return []
@dataclass
class GameMessage:
name: str
code: int
params: dict = field(default_factory=dict)
def param(self, key: int):
return self.params.get(key)
def into_game_message(message: PhotonMessage) -> Optional[GameMessage]:
if message.code != PHOTON_GAME_CODE:
return None
if message.kind == 'Event':
code = _int(message.params.get(252))
if code is None:
return None
name = EVENT_NAMES.get(code)
if name is None:
return None
return GameMessage(name, code, message.params)
if message.kind in ('Request', 'Response'):
code = _int(message.params.get(253))
if code is None:
return None
name = OPERATION_NAMES.get(code)
if name is None:
return None
return GameMessage(name, code, message.params)
return None
EVENT_NAMES = {
EVENT_LEAVE: 'Leave',
EVENT_HEALTH_UPDATE: 'HealthUpdate',
EVENT_NEW_CHARACTER: 'NewCharacter',
EVENT_UPDATE_FAME: 'UpdateFame',
EVENT_CHARACTER_EQUIPMENT_CHANGED: 'CharacterEquipmentChanged',
EVENT_REGENERATION_HEALTH_CHANGED: 'RegenerationHealthChanged',
EVENT_KNOCKED_DOWN: 'KnockedDown',
EVENT_PARTY_INVITATION: 'PartyInvitation',
EVENT_PARTY_JOIN_REQUEST: 'PartyJoinRequest',
EVENT_PARTY_JOINED: 'PartyJoined',
EVENT_PARTY_DISBANDED: 'PartyDisbanded',
EVENT_PARTY_PLAYER_JOINED: 'PartyPlayerJoined',
EVENT_PARTY_CHANGED_ORDER: 'PartyChangedOrder',
EVENT_PARTY_PLAYER_LEFT: 'PartyPlayerLeft',
}
OPERATION_NAMES = {
OPERATION_JOIN: 'Join',
OPERATION_CHANGE_CLUSTER: 'ChangeCluster',
}
# Parameter accessors used by the world state machine. Field names follow
# aoaddons' messages.json layouts, with the current opcode space from albion-lens.
def msg_source(msg: GameMessage) -> int:
v = _int(msg.params.get(0))
return v if v is not None else 0
def msg_character_name(msg: GameMessage) -> str:
v = _string(msg.params.get(2))
return v if v is not None else ''
def msg_new_character_name(msg: GameMessage) -> str:
v = _string(msg.params.get(1))
return v if v is not None else ''
def msg_map_index(msg: GameMessage) -> Optional[str]:
return _string(msg.params.get(8))
def msg_target(msg: GameMessage) -> int:
v = _int(msg.params.get(6))
return v if v is not None else 0
def msg_value(msg: GameMessage) -> float:
v = _float(msg.params.get(2))
return v if v is not None else 0.0
def msg_items(msg: GameMessage) -> List[int]:
return _as_int_list(msg.params.get(2))
def msg_new_character_items(msg: GameMessage) -> List[int]:
return _as_int_list(msg.params.get(33))
def msg_regeneration_rate(msg: GameMessage) -> Optional[float]:
if 4 not in msg.params:
return None
return _float(msg.params.get(4))
def msg_total_fame(msg: GameMessage) -> int:
v = _int(msg.params.get(1))
return v if v is not None else 0
def msg_fame_gained(msg: GameMessage) -> Optional[int]:
if 2 not in msg.params:
return None
return _int(msg.params.get(2))
def msg_party_structures(msg: GameMessage) -> List[List[int]]:
out = []
for item in msg.params.get(4, []) or []:
out.append(_as_int_list(item))
return out
def msg_party_names(msg: GameMessage) -> List[str]:
out = []
for item in msg.params.get(5, []) or []:
s = _string(item)
if s is not None:
out.append(s)
return out
def msg_party_structure(msg: GameMessage) -> List[int]:
return _as_int_list(msg.params.get(1))
def msg_party_name(msg: GameMessage) -> str:
v = _string(msg.params.get(2))
return v if v is not None else ''
+302
View File
@@ -0,0 +1,302 @@
from typing import Dict, List, Optional
from . import items as itemdb
from . import translate
from .translate import GameMessage
FIX_POINT = 10000.0
FAME_MIN_TOTAL = 1000000 # albion-lens sanity filter for UpdateFame events
class IdCache:
"""Maps dynamic (per-session) ids to stable ids and names.
Mirrors aoaddons src/game/id_cache.rs: ids are assigned sequentially by
player name, so reconnecting to a zone keeps the same id for a player.
"""
def __init__(self):
self.dyn_to_static: Dict[int, int] = {}
self.static_to_name: Dict[int, str] = {}
self.static_to_dyn: Dict[int, int] = {}
self.last_id = 0
def save(self, dynamic_id: int, name: str):
if not name:
return
static_id = self._find_static_id(name)
if static_id is not None:
old_dyn = self.static_to_dyn.get(static_id)
if old_dyn is not None:
self.dyn_to_static.pop(old_dyn, None)
self.dyn_to_static[dynamic_id] = static_id
self.static_to_dyn[static_id] = dynamic_id
return
static_id = self.last_id
self.last_id += 1
self.dyn_to_static[dynamic_id] = static_id
self.static_to_dyn[static_id] = dynamic_id
self.static_to_name[static_id] = name
def _find_static_id(self, name: str) -> Optional[int]:
for sid, sid_name in self.static_to_name.items():
if sid_name == name:
return sid
return None
def get_static_id(self, dynamic_id: int) -> Optional[int]:
return self.dyn_to_static.get(dynamic_id)
def get_name(self, static_id: int) -> Optional[str]:
return self.static_to_name.get(static_id)
class Party:
"""Tracks party membership from party events (aoaddons src/game/party.rs)."""
def __init__(self):
self.main_player_name: Optional[str] = None
self.items: List[dict] = [] # {'name', 'id'}
def set_main_player_name(self, name: str):
self.main_player_name = name
def _game_event(self) -> dict:
return {'name': 'UpdateParty', 'value': {
'player_names': [item['name'] for item in self.items]}}
def joined(self, msg: GameMessage) -> Optional[dict]:
structures = translate.msg_party_structures(msg)
names = translate.msg_party_names(msg)
self.items = []
for structure, name in zip(structures, names):
self.items.append({'name': name, 'id': _party_id(structure)})
return self._game_event()
def disbanded(self) -> Optional[dict]:
self.items = []
return self._game_event()
def player_left(self, msg: GameMessage) -> Optional[dict]:
if self.main_player_name is None:
return None
structure_id = _party_id(translate.msg_party_structure(msg))
party_item = next((i for i in self.items if i['id'] == structure_id), None)
if party_item is None:
return None
if party_item['name'] == self.main_player_name:
return self.disbanded()
self.items = [i for i in self.items if i['id'] != structure_id]
return self._game_event()
def single_player_joined(self, msg: GameMessage) -> Optional[dict]:
self.items.append({
'name': translate.msg_party_name(msg),
'id': _party_id(translate.msg_party_structure(msg)),
})
return self._game_event()
class UnconsumedMessages:
"""Buffers messages tagged with a dynamic id whose static id is unknown.
Replayed once the id is resolved (aoaddons src/game/unconsumed_messages.rs).
"""
def __init__(self):
self._messages: Dict[int, List[GameMessage]] = {}
def add(self, dynamic_id: int, msg: GameMessage):
self._messages.setdefault(dynamic_id, []).append(msg)
def get_for_id(self, dynamic_id: int) -> List[GameMessage]:
return self._messages.get(dynamic_id, [])
class World:
"""Transforms translated game messages into app events (aoaddons world.rs)."""
def __init__(self):
self.cache = IdCache()
self.party = Party()
self.unconsumed_messages = UnconsumedMessages()
self.main_player_id: Optional[int] = None
self._fame_totals: Dict[int, int] = {}
def transform(self, message: GameMessage) -> List[dict]:
if message.name == 'NewCharacter':
return self._on_new_character(message)
if message.name == 'Join':
return self._on_join(message)
if message.name == 'ChangeCluster':
return self._on_change_cluster(message)
if message.name == 'Leave':
return self._on_leave(message)
if message.name == 'HealthUpdate':
return self._on_health_update(message)
if message.name == 'RegenerationHealthChanged':
return self._on_regeneration(message)
if message.name == 'KnockedDown':
return self._on_knocked_down(message)
if message.name == 'UpdateFame':
return self._on_update_fame(message)
if message.name == 'CharacterEquipmentChanged':
return self._on_character_equipment_changed(message)
if message.name == 'PartyJoined':
return self._party_event(self.party.joined(message))
if message.name == 'PartyDisbanded':
return self._party_event(self.party.disbanded())
if message.name == 'PartyPlayerJoined':
return self._party_event(self.party.single_player_joined(message))
if message.name == 'PartyPlayerLeft':
return self._party_event(self.party.player_left(message))
return []
def _party_event(self, event: Optional[dict]) -> List[dict]:
return [event] if event is not None else []
def _on_new_character(self, msg: GameMessage) -> List[dict]:
name = translate.msg_new_character_name(msg)
dynamic_id = _dyn(translate.msg_source(msg))
if not name:
return []
self.cache.save(dynamic_id, name)
static_id = self.cache.get_static_id(dynamic_id)
if static_id is None:
return []
result = [{
'name': 'PlayerAppeared',
'value': {'id': static_id, 'name': name},
}]
items = itemdb.decode_items(translate.msg_new_character_items(msg))
if items:
result.append({
'name': 'UpdateItems',
'value': {'source': static_id, 'value': items},
})
result.extend(self._replay(dynamic_id))
if self.main_player_id is None:
self.main_player_id = static_id
return result
def _on_join(self, msg: GameMessage) -> List[dict]:
name = translate.msg_character_name(msg)
dynamic_id = _dyn(translate.msg_source(msg))
if not name:
return []
self.cache.save(dynamic_id, name)
static_id = self.cache.get_static_id(dynamic_id)
if static_id is None:
return []
self.party.set_main_player_name(name)
result = []
if self.main_player_id is None:
result.append({'name': 'ZoneChange'})
self.main_player_id = static_id
result.append({
'name': 'MainPlayerAppeared',
'value': {'id': static_id, 'name': name},
})
result.extend(self._replay(dynamic_id))
return result
def _on_change_cluster(self, msg: GameMessage) -> List[dict]:
if self.main_player_id is None:
return []
return [{'name': 'ZoneChange'}]
def _on_leave(self, msg: GameMessage) -> List[dict]:
dynamic_id = _dyn(translate.msg_source(msg))
static_id = self.cache.get_static_id(dynamic_id)
if static_id is None:
return []
if self.main_player_id == static_id:
self.main_player_id = None
return [{'name': 'ZoneChange'}]
return []
def _on_health_update(self, msg: GameMessage) -> List[dict]:
# params: [0]=target (entity whose health changed), [2]=signed delta,
# [6]=source (attacker/healer). aoaddons emits Damage{source: params[6],
# target: params[0]} which the app attributes to the dealer/healer.
value = translate.msg_value(msg)
if value == 0.0:
return []
actor_id = _dyn(translate.msg_target(msg)) # param 6
victim_id = _dyn(translate.msg_source(msg)) # param 0
actor_static = self.cache.get_static_id(actor_id)
if actor_static is None:
return []
event_name = 'DamageDone' if value < 0.0 else 'HealthReceived'
return [{
'name': event_name,
'value': {'source': actor_static,
'target': self.cache.get_static_id(victim_id),
'value': float(abs(value))},
}]
def _on_regeneration(self, msg: GameMessage) -> List[dict]:
dynamic_id = _dyn(translate.msg_source(msg))
static_id = self.cache.get_static_id(dynamic_id)
if static_id is None:
return []
name = self.cache.get_name(static_id) or ''
if not name:
return []
event_name = ('LeaveCombat' if translate.msg_regeneration_rate(msg) is not None
else 'EnterCombat')
return [{'name': event_name, 'value': {'id': static_id, 'name': name}}]
def _on_knocked_down(self, msg: GameMessage) -> List[dict]:
dynamic_id = _dyn(translate.msg_source(msg))
static_id = self.cache.get_static_id(dynamic_id)
if static_id is None:
return []
name = self.cache.get_name(static_id) or ''
if not name:
return []
return [{'name': 'LeaveCombat', 'value': {'id': static_id, 'name': name}}]
def _on_update_fame(self, msg: GameMessage) -> List[dict]:
dynamic_id = _dyn(translate.msg_source(msg))
static_id = self.cache.get_static_id(dynamic_id)
if static_id is None:
return []
total = translate.msg_total_fame(msg)
if total < FAME_MIN_TOTAL:
return []
prev = self._fame_totals.get(static_id)
if prev == total:
return []
gained = translate.msg_fame_gained(msg)
self._fame_totals[static_id] = total
if gained is None:
if prev is None or total < prev:
return []
gained = total - prev
if gained <= 0:
return []
return [{'name': 'UpdateFame', 'value': {'value': float(gained / FIX_POINT)}}]
def _on_character_equipment_changed(self, msg: GameMessage) -> List[dict]:
dynamic_id = _dyn(translate.msg_source(msg))
static_id = self.cache.get_static_id(dynamic_id)
if static_id is None:
self.unconsumed_messages.add(dynamic_id, msg)
return []
items = itemdb.decode_items(translate.msg_items(msg))
return [{'name': 'UpdateItems', 'value': {'source': static_id, 'value': items}}]
def _replay(self, dynamic_id: int) -> List[dict]:
result: List[dict] = []
for msg in self.unconsumed_messages.get_for_id(dynamic_id):
result.extend(self.transform(msg))
return result
def _dyn(value) -> int:
return int(value) & 0xFFFFFFFF
def _party_id(party_structure: List[int]) -> int:
return sum(party_structure)
+9 -1
View File
@@ -1,3 +1,4 @@
import logging
from typing import Iterable
from dataclasses import dataclass
from queue import Queue
@@ -14,6 +15,9 @@ from .event_receiver import VisibilityEventReceiver
from .stats.visibility import Visibility
logger = logging.getLogger(__name__)
@dataclass(frozen=True)
class VisibilityType:
LastFight: str = 'last_fight'
@@ -187,6 +191,7 @@ def get_stats(stat_type: str, combat_stat_type: str):
def queue_an_event(event):
event_queue.put(event)
logger.debug("event received: %s", event.get(ev_consts.EvKeyName))
def reset_zone_stats():
@@ -207,5 +212,8 @@ def is_ready():
def initialize():
initialization_result = backend_proxy.initialize()
backend_proxy.subscribe(queue_an_event)
if not backend_proxy.subscribe(queue_an_event):
logger.error("packet capture backend subscription failed")
if initialization_result == InitializationResult.Ok:
return InitializationResult.UnknownFailure
return initialization_result
+30
View File
@@ -1,7 +1,37 @@
import logging
import os
import sys
TEST_ENV_ENABLED = bool(os.getenv('TESTING'))
# Verbose debugging flag, e.g. ``aostats --verbose``.
VERBOSE = bool(
os.getenv('AOSTATS_VERBOSE') or
'--verbose' in sys.argv or
'-v' in sys.argv
)
def is_verbose():
return VERBOSE
def setup_logging():
"""Enable verbose logging for the app and the packet capture backend.
The Rust backend reads the ``BACKEND_LOG_LEVEL`` environment variable when
it initializes, so it must be set before ``initialize()`` is called.
"""
if not VERBOSE:
return
os.environ['BACKEND_LOG_LEVEL'] = 'debug'
logging.basicConfig(
level=logging.DEBUG,
format='%(asctime)s %(levelname)-8s %(name)s: %(message)s',
datefmt='%H:%M:%S')
class TestType:
Simple = 'simple'
+77 -10
View File
@@ -1,5 +1,6 @@
import logging
import os
import platform
import subprocess
import sys
import requests
@@ -13,6 +14,7 @@ from PySide6.QtWidgets import QPushButton # type: ignore
from ..engine import InitializationResult
from ..engine import initialize
from ..utils.config import config
from ..environment import setup_logging
from .modules.main import MainWidget
from .styling import style
@@ -20,17 +22,40 @@ from ..utils.version import current_version as get_current_version
from ..utils.version import latest_version as get_latest_version
from ..utils.assets import path
from ..utils.assets import scripts
from ..utils import platform_utils
from ..utils.platform_utils import capture_permissions_ok
sys.path.append(os.path.dirname(os.path.abspath('__file__')))
logger = logging.getLogger(__name__)
def fix_network():
script_name = platform_utils.repair_script()
if not script_name:
sys.exit(0)
script_path = scripts(script_name)
if platform_utils.is_windows():
os.system(script_path)
else:
subprocess.call(['sh', script_path, sys.executable])
def fix_npcap():
os.system(scripts('fixnpcap.bat'))
sys.exit(0)
def run():
setup_logging()
app_argv = [a for a in sys.argv if a not in ('--verbose', '-v')]
logger.info("Albion Online Stats v%s starting", get_current_version())
logger.debug("python: %s (%s)", sys.executable, sys.version)
logger.debug("platform: %s", platform_utils.system())
initialization_result = initialize()
logger.debug("backend initialization result: %s", initialization_result)
conf = config()
window_config = conf['window']
@@ -38,7 +63,12 @@ def run():
WIDTH = window_config['width']
HEIGHT = window_config['height']
app = QApplication(sys.argv)
perms_ok = True
if platform_utils.is_linux():
perms_ok = capture_permissions_ok()
logger.debug("capture permissions probe: %s", perms_ok)
app = QApplication(app_argv)
app.setStyleSheet(style)
@@ -73,20 +103,57 @@ def run():
msg.setStandardButtons(QMessageBox.Ok)
msg.show()
if initialization_result == InitializationResult.NetworkInterfaceListMissing:
need_capture_fix = (
initialization_result != InitializationResult.Ok
or (platform_utils.is_linux() and not perms_ok)
)
if need_capture_fix:
msg = QMessageBox()
msg.setIcon(QMessageBox.Critical)
msg.setWindowTitle("Unable to track network traffic data!")
if initialization_result == InitializationResult.BackendNotInstalled:
msg.setText(
"On windows make sure that WinPcap is installed in your system.")
msg.setInformativeText("WinPcap can be installed from <a href='{}'>here</a> <br>\
<b>Make sure to install with the \"Install Npcap in WinPcap API-compatible Mode\"<b> option<br><br>\
"The packet capture backend (pyaoaddons) is not installed.")
msg.setInformativeText(
"pyaoaddons 0.2.8 ships prebuilt wheels only for CPython 3.6-3.10.<br>\
Use one of those Python versions and reinstall the app \
(<code>python -m pip install .</code>), or build pyaoaddons from source.<br><br>\
See the README for details.")
msg.setStandardButtons(QMessageBox.Ok)
elif platform_utils.is_windows():
msg.setText(
"On Windows make sure that Npcap is installed in your system.")
msg.setInformativeText("Npcap can be installed from <a href='{}'>here</a> <br>\
<b>Make sure to install with the \"Install Npcap in WinPcap API-compatible Mode\"</b> option<br><br>\
In case where npcap is installed try to fix npcap and restart the app"
.format('https://nmap.org/npcap/dist/npcap-0.9990.exe'))
msg.setStandardButtons(QMessageBox.Ok)
button = QPushButton("Fix npcap")
button.clicked.connect(fix_npcap)
button.clicked.connect(fix_network)
msg.addButton(button, QMessageBox.NoRole)
else:
permissions_missing = platform_utils.is_linux() and not perms_ok
if permissions_missing:
msg.setText(
"The app does not have permission to capture network packets.")
msg.setInformativeText(
"Capturing packets requires elevated privileges. Use the button below \
to grant the Python interpreter the needed capabilities \
(or run the app with <code>sudo</code>).")
else:
msg.setText(
"Make sure that libpcap is installed and network interfaces are available.")
msg.setInformativeText(
"Install libpcap:<br>\
<b>Debian/Ubuntu:</b> <code>sudo apt install libpcap0.8</code><br>\
<b>Fedora:</b> <code>sudo dnf install libpcap</code><br>\
<b>Arch:</b> <code>sudo pacman -S libpcap</code>")
msg.setStandardButtons(QMessageBox.Ok)
if platform_utils.repair_script():
button = QPushButton("Fix capture permissions")
button.clicked.connect(fix_network)
msg.addButton(button, QMessageBox.NoRole)
msg.show()
View File
+155
View File
@@ -0,0 +1,155 @@
import logging
import socket
import struct
import threading
from typing import Callable, List, Optional
logger = logging.getLogger(__name__)
GAME_PORT = 5056
PROTO_IPV4 = 0x0800
PROTO_IPV6 = 0x86DD
PROTO_VLAN = 0x8100
PROTO_QINQ = 0x88A8
IPPROTO_UDP = 17
ETH_P_ALL = 0x0003
MAX_FRAME = 65535
def _extract_udp_payload(frame: bytes) -> Optional[bytes]:
"""Returns the UDP payload if the ethernet frame carries UDP on port 5056.
Handles Ethernet, VLAN tags, IPv4 and IPv6 with basic extension handling.
"""
pos = 0
if len(frame) < 14:
return None
ethertype = struct.unpack(">H", frame[12:14])[0]
pos = 14
while ethertype in (PROTO_VLAN, PROTO_QINQ):
if len(frame) < pos + 4:
return None
ethertype = struct.unpack(">H", frame[pos + 2:pos + 4])[0]
pos += 4
if ethertype == PROTO_IPV4:
if len(frame) < pos + 20:
return None
version_ihl = frame[pos]
header_len = (version_ihl & 0x0F) * 4
protocol = frame[pos + 9]
payload = frame[pos + header_len:]
elif ethertype == PROTO_IPV6:
if len(frame) < pos + 40:
return None
next_header = frame[pos + 6]
header_len = 40
while next_header in (0, 43, 44, 60):
if len(frame) < pos + header_len + 8:
return None
hdr_ext_len = (frame[pos + header_len + 1] + 1) * 8
if next_header == 44:
next_header = frame[pos + header_len]
header_len += 8
continue
next_header = frame[pos + header_len]
header_len += hdr_ext_len
protocol = next_header
payload = frame[pos + header_len:]
else:
return None
if protocol != IPPROTO_UDP:
return None
if len(payload) < 8:
return None
src_port, dst_port, length = struct.unpack(">HHH", payload[0:6])
if src_port != GAME_PORT and dst_port != GAME_PORT:
return None
udp_len = length
if udp_len < 8 or udp_len > len(payload):
return None
return bytes(payload[8:udp_len])
class CaptureEngine:
"""Listens for Albion Online traffic on all non-loopback interfaces.
Mirrors the aoaddons packet sniffer: one AF_PACKET socket per interface,
forwarding only UDP packets on port 5056 to a shared decode pipeline.
"""
def __init__(self, on_udp: Callable[[bytes], None]):
self._on_udp = on_udp
self._sockets: List[socket.socket] = []
self._threads: List[threading.Thread] = []
self._stop = threading.Event()
@staticmethod
def interface_names() -> List[str]:
names = []
try:
for _index, name in socket.if_nameindex():
if name and name != 'lo':
names.append(name)
except OSError:
logger.warning("unable to enumerate network interfaces")
return names
def start(self) -> bool:
names = self.interface_names()
if not names:
logger.warning("no network interfaces available for capture")
return False
for name in names:
try:
sock = socket.socket(
socket.AF_PACKET, socket.SOCK_RAW, socket.htons(ETH_P_ALL))
sock.bind((name, ETH_P_ALL))
sock.settimeout(1.0)
except OSError as e:
logger.warning("unable to bind %s: %s", name, e)
continue
self._sockets.append(sock)
thread = threading.Thread(
target=self._run_interface, args=(sock, name), daemon=True)
thread.start()
self._threads.append(thread)
logger.info("capturing on interface %s", name)
if not self._sockets:
logger.error("no interfaces could be captured (permissions?)")
return False
return True
def stop(self):
self._stop.set()
for sock in self._sockets:
try:
sock.close()
except OSError:
pass
for thread in self._threads:
thread.join(timeout=2.0)
self._sockets = []
self._threads = []
def _run_interface(self, sock: socket.socket, interface_name: str):
logger.debug("capture thread started for %s", interface_name)
try:
while not self._stop.is_set():
try:
frame = sock.recv(MAX_FRAME)
except socket.timeout:
continue
except OSError:
break
payload = _extract_udp_payload(frame)
if payload is None:
continue
try:
self._on_udp(payload)
except Exception:
logger.exception("error handling UDP payload")
finally:
logger.debug("capture thread stopped for %s", interface_name)
+55
View File
@@ -0,0 +1,55 @@
#!/bin/sh
# Grant the Python interpreter the capabilities required to capture network
# traffic, so that Albion Online Stats does not have to run as root.
#
# Usage: fixlibpcap.sh [path-to-python-interpreter]
PYTHON="${1:-$(command -v python3)}"
if [ -z "$PYTHON" ]; then
echo "Could not determine the python interpreter path." >&2
exit 1
fi
if [ ! -x "$PYTHON" ]; then
echo "Python interpreter '$PYTHON' is not executable." >&2
exit 1
fi
# Resolve symlinks (e.g. venv/bin/python -> /usr/bin/python3). setcap has to be
# applied to the real binary, not to a symlink.
if readlink -f "$PYTHON" >/dev/null 2>&1; then
PYTHON="$(readlink -f "$PYTHON")"
elif command -v python3 >/dev/null 2>&1; then
PYTHON="$(python3 -c 'import os, sys; print(os.path.realpath(sys.executable))' 2>/dev/null || echo "$PYTHON")"
fi
if ! command -v setcap >/dev/null 2>&1; then
echo "The 'setcap' tool was not found." >&2
echo "Install libcap before retrying:" >&2
echo " Debian/Ubuntu: sudo apt install libcap2-bin" >&2
echo " Fedora: sudo dnf install libcap" >&2
echo " Arch: sudo pacman -S libcap" >&2
exit 1
fi
echo "Granting packet capture capabilities to: $PYTHON"
echo "You may be asked for a password."
# pkexec shows a graphical authentication dialog, which works even when the app
# was not started from a terminal. Fall back to sudo otherwise.
if command -v pkexec >/dev/null 2>&1; then
pkexec setcap cap_net_raw,cap_net_admin=eip "$PYTHON"
status=$?
else
sudo setcap cap_net_raw,cap_net_admin=eip "$PYTHON"
status=$?
fi
if [ "$status" -ne 0 ]; then
echo "Failed to set capture capabilities. Try running the app with sudo:" >&2
echo " sudo $(command -v aostats 2>/dev/null || echo 'python -m aostats')" >&2
exit "$status"
fi
echo "Done. Please restart Albion Online Stats."
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large Load Diff
File diff suppressed because one or more lines are too long
+12 -6
View File
@@ -1,8 +1,9 @@
import os
import platform
import sys
import toml
from . import platform_utils
CFG_VERSION = '0.7'
default = """
@@ -33,11 +34,12 @@ _config = None
def get_config_path():
cfg_file_name = 'albion-online-stats.cfg'
script_dir = os.path.dirname(_script_path)
if platform.system() == 'Windows':
return os.path.join(os.getenv('APPDATA', script_dir), cfg_file_name)
else:
return os.path.join(script_dir, cfg_file_name)
cfg_dir = platform_utils.config_dir()
if not cfg_dir:
cfg_dir = os.path.dirname(os.path.abspath(_script_path))
return os.path.join(cfg_dir, cfg_file_name)
def config():
@@ -48,6 +50,10 @@ def config():
conf_file = get_config_path()
conf_dir = os.path.dirname(conf_file)
if conf_dir:
os.makedirs(conf_dir, exist_ok=True)
try:
with open(conf_file, "r") as cfg_file:
cfg = toml.load(cfg_file)
+9 -1
View File
@@ -1,8 +1,16 @@
import json
import os
try:
from pyaoaddons import localization_mapping
except:
except Exception:
_PATH = os.path.join(
os.path.dirname(os.path.dirname(os.path.abspath(__file__))),
'static', 'localization_mapping.json')
try:
with open(_PATH, encoding='utf-8') as _f:
localization_mapping = json.load(_f)
except (OSError, ValueError):
localization_mapping = {}
+89
View File
@@ -0,0 +1,89 @@
import os
import platform
import socket
from typing import Optional
WINDOWS = 'Windows'
LINUX = 'Linux'
MACOS = 'Darwin'
APP_DIR_NAME = 'albion-online-stats'
# Name of the platform specific script used to repair packet capture
# permissions. ``None`` means that no automatic repair is available.
_REPAIR_SCRIPTS = {
WINDOWS: 'fixnpcap.bat',
LINUX: 'fixlibpcap.sh',
MACOS: 'fixlibpcap.sh',
}
def system() -> str:
return platform.system()
def is_windows() -> bool:
return system() == WINDOWS
def is_linux() -> bool:
return system() == LINUX
def is_macos() -> bool:
return system() == MACOS
def repair_script() -> Optional[str]:
return _REPAIR_SCRIPTS.get(system())
def capture_permissions_ok() -> bool:
"""Return True when the current process may capture network packets.
The packet capture backend starts background sniffing threads and reports
initialization as successful even when it later fails to open a socket, so
on Linux this explicitly probes for ``CAP_NET_RAW`` (required to open
``AF_PACKET`` raw sockets). On other platforms there is no easy probe, so
``True`` is returned.
"""
if not is_linux():
return True
euid = getattr(os, 'geteuid', lambda: -1)()
if euid == 0:
return True
try:
sock = socket.socket(socket.AF_PACKET, socket.SOCK_RAW)
sock.close()
return True
except (PermissionError, OSError):
return False
def config_dir() -> Optional[str]:
"""Return the platform specific directory used to store the config.
Returns ``None`` when no standard per-user directory can be determined.
"""
if is_windows():
base = os.getenv('APPDATA')
return os.path.join(base, APP_DIR_NAME) if base else None
if is_macos():
home = os.path.expanduser('~')
if not home or home == '~':
return None
return os.path.join(home, 'Library', 'Application Support', APP_DIR_NAME)
if is_linux():
base = os.getenv('XDG_CONFIG_HOME')
if not base:
home = os.path.expanduser('~')
if not home or home == '~':
return None
base = os.path.join(home, '.config')
return os.path.join(base, APP_DIR_NAME)
return None
+11 -1
View File
@@ -1,6 +1,16 @@
import json
import os
try:
from pyaoaddons import item_category_mapping
except:
except Exception:
_PATH = os.path.join(
os.path.dirname(os.path.dirname(os.path.abspath(__file__))),
'static', 'item_category_mapping.json')
try:
with open(_PATH, encoding='utf-8') as _f:
item_category_mapping = json.load(_f)
except (OSError, ValueError):
item_category_mapping = {}
+104
View File
@@ -0,0 +1,104 @@
import pytest
from src import backend_proxy
from src import engine
def test_native_backend_available_on_linux():
import src.utils.platform_utils as pu
assert backend_proxy.NATIVE_BACKEND_AVAILABLE == pu.is_linux()
def test_initialize_ok_with_native_backend(monkeypatch):
monkeypatch.setattr(backend_proxy, 'NATIVE_BACKEND_AVAILABLE', True)
assert backend_proxy.initialize() == backend_proxy.InitializationResult.Ok
def test_initialize_without_backend_returns_not_installed(monkeypatch):
if backend_proxy.BACKEND_AVAILABLE:
pytest.skip('pyaoaddons is installed')
monkeypatch.setattr(backend_proxy, 'NATIVE_BACKEND_AVAILABLE', False)
assert backend_proxy.initialize() == \
backend_proxy.InitializationResult.BackendNotInstalled
def test_subscribe_starts_native_backend(monkeypatch):
started = []
monkeypatch.setattr(backend_proxy, 'NATIVE_BACKEND_AVAILABLE', True)
monkeypatch.setattr(
backend_proxy, '_start_native_backend',
lambda callback: started.append(callback) or True)
callback = lambda event: event
result = backend_proxy.subscribe(callback)
assert started == [callback]
assert result is True
def test_subscribe_is_noop_without_backend(monkeypatch):
if backend_proxy.BACKEND_AVAILABLE:
pytest.skip('pyaoaddons is installed')
monkeypatch.setattr(backend_proxy, 'NATIVE_BACKEND_AVAILABLE', False)
assert backend_proxy.subscribe(lambda event: event) is False
def test_start_native_backend_uses_pipeline(monkeypatch):
import src.net.capture as capture_mod
monkeypatch.setattr(backend_proxy, '_capture', None)
created = {}
class FakeCapture:
def __init__(self, on_udp):
created['on_udp'] = on_udp
def start(self):
created['started'] = True
return True
monkeypatch.setattr(capture_mod, 'CaptureEngine', FakeCapture)
events = []
assert backend_proxy._start_native_backend(events.append) is True
assert created['started'] is True
assert callable(created['on_udp'])
assert backend_proxy._capture is not None
backend_proxy._capture = None
def test_start_native_backend_reports_start_failure(monkeypatch):
import src.net.capture as capture_mod
monkeypatch.setattr(backend_proxy, '_capture', None)
class FakeCapture:
def __init__(self, on_udp):
self.on_udp = on_udp
def start(self):
return False
monkeypatch.setattr(capture_mod, 'CaptureEngine', FakeCapture)
assert backend_proxy._start_native_backend(lambda event: event) is False
assert backend_proxy._capture is None
def test_engine_initialize_reports_subscribe_failure(monkeypatch):
monkeypatch.setattr(
engine.backend_proxy, 'initialize',
lambda: backend_proxy.InitializationResult.Ok)
monkeypatch.setattr(
engine.backend_proxy, 'subscribe',
lambda callback: False)
assert engine.initialize() == backend_proxy.InitializationResult.UnknownFailure
+56
View File
@@ -0,0 +1,56 @@
import os
from src.utils import config
from src.utils import platform_utils
def _set_os(monkeypatch, system):
monkeypatch.setattr(platform_utils, 'system', lambda: system)
def test_config_path_linux_uses_xdg_config_home(monkeypatch, tmp_path):
_set_os(monkeypatch, platform_utils.LINUX)
monkeypatch.setenv('XDG_CONFIG_HOME', str(tmp_path))
assert config.get_config_path() == os.path.join(
str(tmp_path), platform_utils.APP_DIR_NAME, 'albion-online-stats.cfg')
def test_config_path_linux_falls_back_to_home(monkeypatch, tmp_path):
_set_os(monkeypatch, platform_utils.LINUX)
monkeypatch.delenv('XDG_CONFIG_HOME', raising=False)
monkeypatch.setenv('HOME', str(tmp_path))
assert config.get_config_path() == os.path.join(
str(tmp_path), '.config', platform_utils.APP_DIR_NAME,
'albion-online-stats.cfg')
def test_config_path_windows_uses_appdata(monkeypatch, tmp_path):
_set_os(monkeypatch, platform_utils.WINDOWS)
monkeypatch.setenv('APPDATA', str(tmp_path))
assert config.get_config_path() == os.path.join(
str(tmp_path), platform_utils.APP_DIR_NAME, 'albion-online-stats.cfg')
def test_config_path_falls_back_to_script_dir(monkeypatch):
_set_os(monkeypatch, 'SomethingElse')
assert os.path.basename(config.get_config_path()) == 'albion-online-stats.cfg'
def test_config_creates_missing_directory(monkeypatch, tmp_path):
_set_os(monkeypatch, platform_utils.LINUX)
monkeypatch.setenv('XDG_CONFIG_HOME', str(tmp_path))
monkeypatch.setattr(config, '_config', None)
expected = os.path.join(
str(tmp_path), platform_utils.APP_DIR_NAME, 'albion-online-stats.cfg')
cfg = config.config()
assert os.path.isfile(expected)
assert cfg['window']['width'] == 300
config._config = None
+378
View File
@@ -0,0 +1,378 @@
import struct
import pytest
from src.decode import photon
from src.decode import translate
from src.decode.photon import PhotonDecoder, decode_message18
from src.decode.translate import into_game_message
from src.decode.world import IdCache, World
from src.net.capture import _extract_udp_payload
# --- Protocol18 value builders -------------------------------------------------
def p18_short(value):
return bytes([photon.P18['Short']]) + struct.pack('<h', value)
def p18_string(value):
data = value.encode('utf-8')
return bytes([photon.P18['String']]) + bytes([len(data)]) + data
def p18_compressed_int(value):
zz = (value << 1) if value >= 0 else ((-value << 1) - 1)
out = bytes([photon.P18['CompressedInt']])
while True:
b = zz & 0x7F
zz >>= 7
if zz:
out += bytes([b | 0x80])
else:
return out + bytes([b])
def params_table(entries):
out = bytes([len(entries)])
for key, encoded in entries:
out += bytes([key]) + encoded
return out
def event_payload(opcode, entries):
table = params_table([(252, p18_short(opcode))] + list(entries))
return bytes([0xF3, 0x04, 0x01]) + table
def flagged_event_payload(opcode, entries):
table = params_table([(252, p18_short(opcode))] + list(entries))
return bytes([0xF3, 0x84, 0x01]) + table
def response_payload(opcode, entries):
table = params_table([(253, p18_short(opcode))] + list(entries))
debug = bytes([photon.P18['Null']])
return bytes([0xF3, 0x03, 0x01]) + struct.pack('<h', 0) + debug + table
def enet_packet(command, msg_bytes):
length = 12 + len(msg_bytes)
header = struct.pack('>HBBI', 0, 0, 1, 0) + struct.pack('>I', 0)
command_header = struct.pack('>BBBB', command, 0, 0, 0)
command_header += struct.pack('>I', length) + struct.pack('>I', 0)
return header + command_header + msg_bytes
def enet_unreliable_packet(command, msg_bytes):
unreliable_seq = struct.pack('>I', 17)
length = 12 + len(unreliable_seq) + len(msg_bytes)
header = struct.pack('>HBBI', 0, 0, 1, 0) + struct.pack('>I', 0)
command_header = struct.pack('>BBBB', command, 0, 0, 0)
command_header += struct.pack('>I', length) + struct.pack('>I', 0)
return header + command_header + unreliable_seq + msg_bytes
# --- Protocol18 primitives ------------------------------------------------------
def test_varint_roundtrip():
assert photon.rd_varint(bytes([0x00]), 0) == (0, 1)
assert photon.rd_varint(bytes([0x80, 0x01]), 0) == (128, 2)
assert photon.rd_varint(bytes([0xAC, 0x02]), 0) == (300, 2)
def test_zigzag():
assert photon.zigzag(0) == 0
assert photon.zigzag(1) == -1
assert photon.zigzag(2) == 1
assert photon.zigzag(3) == -2
def test_decode_params_and_compressed_int():
table = params_table([(0, p18_compressed_int(280962)),
(2, p18_string('bionicKatana')),
(3, p18_compressed_int(4))])
params, pos = photon.decode_params18(table, 0)
assert params[0] == 280962
assert params[2] == 'bionicKatana'
assert params[3] == 4
assert pos == len(table)
def test_decode_message18_event():
payload = event_payload(1, [(0, p18_compressed_int(277536))])
message, pos = decode_message18(payload, 0)
assert message.kind == 'Event'
assert message.code == 1
assert message.params[252] == 1
assert message.params[0] == 277536
assert pos == len(payload)
def test_decode_message18_flagged_event():
payload = flagged_event_payload(1, [(0, p18_compressed_int(277536))])
message, pos = decode_message18(payload, 0)
assert message.kind == 'Event'
assert message.params[252] == 1
assert message.params[0] == 277536
assert pos == len(payload)
# --- eNet envelope + fragments --------------------------------------------------
def test_decode_packet_reliable():
decoder = PhotonDecoder()
packet = enet_packet(
photon.CMD_SEND_RELIABLE, event_payload(90, [(0, p18_short(7))]))
messages = decoder.decode_packet(packet)
assert len(messages) == 1
assert messages[0].params[252] == 90
def test_decode_packet_observed_unreliable_fragment_command():
decoder = PhotonDecoder()
packet = enet_unreliable_packet(
photon.CMD_SEND_UNRELIABLE_FRAGMENT,
flagged_event_payload(1, [(0, p18_short(7))]))
messages = decoder.decode_packet(packet)
assert len(messages) == 1
assert messages[0].params[252] == 1
assert messages[0].params[0] == 7
def test_fragment_reassembly():
decoder = PhotonDecoder()
full = event_payload(29, [(0, p18_short(1234))])
split = 5
parts = [full[i:i + split] for i in range(0, len(full), split)]
messages = []
for i, part in enumerate(parts):
start_seq, count = 5, len(parts)
length = 12 + photon.FRAG_HEADER_LEN + len(part)
header = struct.pack('>HBBI', 0, 0, 1, 0) + struct.pack('>I', 0)
cmd = struct.pack('>BBBB', photon.CMD_SEND_FRAGMENT, 0, 0, 0)
cmd += struct.pack('>I', length) + struct.pack('>I', 0)
cmd += struct.pack('>IIIII', start_seq, count, i, len(full), i * split)
messages.extend(decoder.decode_packet(header + cmd + part))
assert len(messages) == 1
assert messages[0].params[252] == 29
assert messages[0].params[0] == 1234
# --- translate ------------------------------------------------------------------
@pytest.mark.parametrize('opcode,name', [
(1, 'Leave'),
(6, 'HealthUpdate'),
(29, 'NewCharacter'),
(82, 'UpdateFame'),
(90, 'CharacterEquipmentChanged'),
(91, 'RegenerationHealthChanged'),
(166, 'KnockedDown'),
(231, 'PartyJoined'),
(233, 'PartyPlayerJoined'),
(235, 'PartyPlayerLeft'),
])
def test_event_opcode_translation(opcode, name):
message, _ = decode_message18(event_payload(opcode, []), 0)
game = into_game_message(message)
assert game is not None
assert game.name == name
def test_operation_translation():
message, _ = decode_message18(response_payload(2, [(0, p18_short(63))]), 0)
game = into_game_message(message)
assert game is not None
assert game.name == 'Join'
def test_unknown_opcode_ignored():
message, _ = decode_message18(event_payload(9999, []), 0)
assert into_game_message(message) is None
# --- world ----------------------------------------------------------------------
def game(name, params=None):
return translate.GameMessage(name, 0, params or {})
def test_id_cache_reuses_id_for_name():
cache = IdCache()
cache.save(100, 'Alice')
assert cache.get_static_id(100) == 0
cache.save(200, 'Alice')
assert cache.get_static_id(200) == 0
assert cache.get_static_id(100) is None
assert cache.get_static_id(300) is None
def test_world_new_character_player_appeared():
world = World()
events = world.transform(game('NewCharacter', {0: 1234, 1: 'Alice'}))
names = [e['name'] for e in events]
assert 'PlayerAppeared' in names
appeared = next(e for e in events if e['name'] == 'PlayerAppeared')
assert appeared['value'] == {'id': 0, 'name': 'Alice'}
def test_world_join_emits_zone_change_and_main_player():
world = World()
events = world.transform(game('Join', {0: 63, 2: 'Alice'}))
assert events[0] == {'name': 'ZoneChange'}
assert events[1]['name'] == 'MainPlayerAppeared'
assert world.main_player_id == 0
second = world.transform(game('Join', {0: 77, 2: 'Alice'}))
assert {'name': 'ZoneChange'} not in second
def test_world_main_player_leave_emits_zone_change():
world = World()
world.transform(game('Join', {0: 63, 2: 'Alice'}))
events = world.transform(game('Leave', {0: 63}))
assert events == [{'name': 'ZoneChange'}]
def test_world_health_update_damage_and_heal():
world = World()
world.transform(game('NewCharacter', {0: 10, 1: 'Victim'}))
world.transform(game('NewCharacter', {0: 20, 1: 'Attacker'}))
damage = world.transform(game('HealthUpdate', {0: 10, 6: 20, 2: -80.0}))
assert damage[0]['name'] == 'DamageDone'
assert damage[0]['value']['source'] == 1 # attacker
assert damage[0]['value']['target'] == 0 # victim
assert damage[0]['value']['value'] == 80.0
heal = world.transform(game('HealthUpdate', {0: 10, 6: 20, 2: 40.0}))
assert heal[0]['name'] == 'HealthReceived'
assert heal[0]['value']['source'] == 1
assert heal[0]['value']['value'] == 40.0
def test_world_health_update_unknown_actor_dropped():
world = World()
world.transform(game('NewCharacter', {0: 10, 1: 'Victim'}))
assert world.transform(game('HealthUpdate', {0: 10, 6: 999, 2: -50.0})) == []
def test_world_regeneration_combat_states():
world = World()
world.transform(game('NewCharacter', {0: 10, 1: 'Alice'}))
enter = world.transform(game('RegenerationHealthChanged', {0: 10}))
assert enter[0]['name'] == 'EnterCombat'
leave = world.transform(game('RegenerationHealthChanged', {0: 10, 4: 5.0}))
assert leave[0]['name'] == 'LeaveCombat'
def test_world_knocked_down_leaves_combat():
world = World()
world.transform(game('NewCharacter', {0: 10, 1: 'Alice'}))
events = world.transform(game('KnockedDown', {0: 10}))
assert events[0]['name'] == 'LeaveCombat'
def test_world_update_fame_uses_gained():
world = World()
world.transform(game('NewCharacter', {0: 10, 1: 'Alice'}))
events = world.transform(game('UpdateFame', {0: 10, 1: 5000000, 2: 30000}))
assert events[0]['name'] == 'UpdateFame'
assert events[0]['value']['value'] == pytest.approx(3.0)
def test_world_update_fame_delta_from_total():
world = World()
world.transform(game('NewCharacter', {0: 10, 1: 'Alice'}))
assert world.transform(game('UpdateFame', {0: 10, 1: 2000000})) == []
events = world.transform(game('UpdateFame', {0: 10, 1: 2001000}))
assert events[0]['value']['value'] == pytest.approx(0.1)
def test_world_unconsumed_equipment_replayed_on_new_character():
world = World()
# equipment arrives before the player is named -> buffered
assert world.transform(
game('CharacterEquipmentChanged', {0: 55, 2: [0, 1]})) == []
events = world.transform(game('NewCharacter', {0: 55, 1: 'Alice'}))
names = [e['name'] for e in events]
assert 'PlayerAppeared' in names
assert 'UpdateItems' in names
def test_party_events_from_structures():
world = World()
world.party.set_main_player_name('Alice')
world.cache.save(1, 'Alice')
joined = world.transform(
game('PartyJoined', {4: [[1, 0], [2, 0]], 5: ['Alice', 'Bob']}))
assert joined[0]['name'] == 'UpdateParty'
assert joined[0]['value']['player_names'] == ['Alice', 'Bob']
left = world.transform(game('PartyPlayerLeft', {1: [2, 0]}))
assert left[0]['value']['player_names'] == ['Alice']
def test_party_main_player_left_disbands():
world = World()
world.party.set_main_player_name('Alice')
world.transform(game('PartyJoined', {4: [[1, 0], [2, 0]],
5: ['Alice', 'Bob']}))
events = world.transform(game('PartyPlayerLeft', {1: [1, 0]}))
assert events[0]['value']['player_names'] == []
# --- capture frame extraction ---------------------------------------------------
def build_ethernet_ipv4_udp(src_port, dst_port, payload):
udp = struct.pack('>HHHH', src_port, dst_port, 8 + len(payload), 0) + payload
ip = bytearray(20)
ip[0] = 0x45
ip[2:4] = struct.pack('>H', 20 + len(udp))
ip[9] = 17
ip[12:16] = bytes([10, 0, 0, 1])
ip[16:20] = bytes([10, 0, 0, 2])
ethernet = bytes(12) + struct.pack('>H', 0x0800)
return ethernet + bytes(ip) + udp
def test_extract_udp_payload_game_port():
frame = build_ethernet_ipv4_udp(12345, 5056, b'hello')
assert _extract_udp_payload(frame) == b'hello'
def test_extract_udp_payload_other_port_ignored():
frame = build_ethernet_ipv4_udp(12345, 1234, b'hello')
assert _extract_udp_payload(frame) is None
def test_extract_udp_payload_with_vlan():
inner = build_ethernet_ipv4_udp(5056, 12345, b'world')
header = inner[:12]
tagged = header + struct.pack('>H', 0x8100) + struct.pack('>H', 42) + inner[12:]
assert _extract_udp_payload(tagged) == b'world'
def build_ethernet_ipv6_udp(src_port, dst_port, payload):
udp = struct.pack('>HHHH', src_port, dst_port, 8 + len(payload), 0) + payload
ip = bytearray(40)
ip[0] = 0x60
ip[6] = 17
ip[8:24] = bytes.fromhex('fe800000000000000000000000000001')
ip[24:40] = bytes.fromhex('fe800000000000000000000000000002')
ethernet = bytes(12) + struct.pack('>H', 0x86DD)
return ethernet + bytes(ip) + udp
def test_extract_udp_payload_ipv6():
frame = build_ethernet_ipv6_udp(5056, 12345, b'v6')
assert _extract_udp_payload(frame) == b'v6'
def test_interface_names_excludes_loopback():
from src.net.capture import CaptureEngine
names = CaptureEngine.interface_names()
assert isinstance(names, list)
assert 'lo' not in names
+57
View File
@@ -0,0 +1,57 @@
import os
import re
from collections import Counter
import pytest
from src.decode.pipeline import Pipeline
LOG_PATH = os.path.join(
os.path.dirname(os.path.dirname(os.path.abspath(__file__))), 'aoaddons.log')
pytestmark = pytest.mark.skipif(
not os.path.exists(LOG_PATH),
reason='aoaddons.log capture fixture is not available')
def _raw_payloads():
payloads = []
pattern = re.compile(r'Raw payload: \[([0-9, ]+)\]')
with open(LOG_PATH, encoding='utf-8', errors='replace') as log:
for line in log:
match = pattern.search(line)
if match:
payloads.append(
bytes(int(part) for part in match.group(1).split(',')))
return payloads
def test_offline_capture_produces_expected_events():
payloads = _raw_payloads()
assert payloads, 'no raw payloads found in aoaddons.log'
events = []
pipeline = Pipeline(events.append)
for payload in payloads:
pipeline.on_udp(payload)
counts = Counter(event['name'] for event in events)
assert counts['MainPlayerAppeared'] >= 1
assert counts['PlayerAppeared'] == 2
assert counts['ZoneChange'] == 3
assert counts['UpdateItems'] >= 4
def test_offline_capture_main_player_stream_is_consistent():
events = []
pipeline = Pipeline(events.append)
for payload in _raw_payloads():
pipeline.on_udp(payload)
assert any(e['name'] == 'ZoneChange' for e in events)
main = next(e for e in events if e['name'] == 'MainPlayerAppeared')
assert main['value']['name']
appeared = [e['value']['id'] for e in events
if e['name'] == 'PlayerAppeared']
assert appeared == [0, 1]
+43
View File
@@ -0,0 +1,43 @@
from src.utils import platform_utils
def test_capture_permissions_ok_when_root(monkeypatch):
monkeypatch.setattr(platform_utils, 'is_linux', lambda: True)
monkeypatch.setattr(platform_utils.os, 'geteuid', lambda: 0)
assert platform_utils.capture_permissions_ok() is True
def test_capture_permissions_ok_when_socket_opens(monkeypatch):
monkeypatch.setattr(platform_utils, 'is_linux', lambda: True)
monkeypatch.setattr(platform_utils.os, 'geteuid', lambda: 1000)
monkeypatch.setattr(
platform_utils.socket,
'socket',
lambda *a, **k: _StubSocket(raise_error=False),
)
assert platform_utils.capture_permissions_ok() is True
def test_capture_permissions_ok_when_permission_denied(monkeypatch):
monkeypatch.setattr(platform_utils, 'is_linux', lambda: True)
monkeypatch.setattr(platform_utils.os, 'geteuid', lambda: 1000)
monkeypatch.setattr(
platform_utils.socket,
'socket',
lambda *a, **k: _StubSocket(raise_error=True),
)
assert platform_utils.capture_permissions_ok() is False
def test_capture_permissions_ok_skips_probe_on_other_platforms(monkeypatch):
monkeypatch.setattr(platform_utils, 'is_linux', lambda: False)
assert platform_utils.capture_permissions_ok() is True
class _StubSocket:
def __init__(self, raise_error=False):
self._raise_error = raise_error
def close(self):
if self._raise_error:
raise PermissionError('Operation not permitted')
+1
View File
@@ -17,5 +17,6 @@ commands =
[testenv:ut]
deps =
pytest
toml
commands =
python -m pytest tests