mirror of
https://github.com/VallierDev/uu-remote-linux.git
synced 2026-11-16 16:50:41 +01:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
03d2311649 | ||
|
|
5949314e55 | ||
|
|
8389fc4eed | ||
|
|
b8de665593 | ||
|
|
554cbe806a | ||
|
|
a91f0024d3 | ||
|
|
68ad9759bd | ||
|
|
169edf2224 | ||
|
|
9994279b29 | ||
|
|
6733a117a2 | ||
|
|
e3cab32c75 |
No files matched your search
@@ -37,6 +37,7 @@ body:
|
|||||||
|
|
||||||
```sh
|
```sh
|
||||||
{
|
{
|
||||||
|
echo "== doctor (v0.2.17+)"; uuremote-server doctor
|
||||||
echo "== 系统"; grep PRETTY_NAME /etc/os-release; uname -rm
|
echo "== 系统"; grep PRETTY_NAME /etc/os-release; uname -rm
|
||||||
echo "== 桌面"; echo "session=$XDG_SESSION_TYPE desktop=$XDG_CURRENT_DESKTOP"
|
echo "== 桌面"; echo "session=$XDG_SESSION_TYPE desktop=$XDG_CURRENT_DESKTOP"
|
||||||
echo "== 显示器"; xrandr --listmonitors 2>/dev/null
|
echo "== 显示器"; xrandr --listmonitors 2>/dev/null
|
||||||
|
|||||||
@@ -35,6 +35,14 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
cargo build --locked --features wayland,portal,engine-plugins --bin uuremote-server
|
cargo build --locked --features wayland,portal,engine-plugins --bin uuremote-server
|
||||||
test -f target/debug/libuu-wayland.so
|
test -f target/debug/libuu-wayland.so
|
||||||
|
- name: Debian package installs
|
||||||
|
run: |
|
||||||
|
packaging/deb/build-deb.sh 0.0.0~ci target/debug /tmp/deb
|
||||||
|
dpkg-deb -I /tmp/deb/*.deb | grep -E 'Depends|Recommends'
|
||||||
|
sudo apt-get install -y /tmp/deb/*.deb
|
||||||
|
uuremote-server --help | head -1
|
||||||
|
test -f /usr/lib/uu-remote-linux/libuu-wayland.so
|
||||||
|
systemd-analyze verify /usr/lib/systemd/user/uuremote-native.service
|
||||||
|
|
||||||
test-viewer:
|
test-viewer:
|
||||||
runs-on: ubuntu-22.04
|
runs-on: ubuntu-22.04
|
||||||
@@ -95,3 +103,28 @@ jobs:
|
|||||||
- uses: dtolnay/rust-toolchain@stable
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
- run: cargo test --locked --features inproc-av
|
- run: cargo test --locked --features inproc-av
|
||||||
|
|
||||||
|
test-linux-arm64:
|
||||||
|
# aarch64 hosts (Ampere A1, arm64 VMs, Apple-silicon VMs) build from source, so keep that
|
||||||
|
# build honest on a native arm64 runner instead of letting it rot between releases.
|
||||||
|
runs-on: ubuntu-24.04-arm
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Install build dependencies
|
||||||
|
run: |
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y build-essential pkg-config \
|
||||||
|
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev \
|
||||||
|
libwayland-dev libwayland-bin libxkbcommon-dev libglib2.0-dev libpipewire-0.3-dev libei-dev
|
||||||
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
|
- uses: Swatinem/rust-cache@v2
|
||||||
|
- run: cargo test --locked
|
||||||
|
- name: Release binary
|
||||||
|
run: |
|
||||||
|
cargo build --locked --release --bin uuremote-server
|
||||||
|
file target/release/uuremote-server
|
||||||
|
# The aarch64 release package ships both engine plugins.
|
||||||
|
- name: Release feature set
|
||||||
|
run: |
|
||||||
|
cargo build --locked --features wayland,portal,engine-plugins --bin uuremote-server
|
||||||
|
for lib in libuu-wayland.so libuu-portal.so; do test -f "target/debug/$lib"; done
|
||||||
@@ -12,7 +12,12 @@ jobs:
|
|||||||
# GNOME/KDE Wayland engine: libei >= 1.1 first ships in Ubuntu 24.04, so this plugin needs
|
# GNOME/KDE Wayland engine: libei >= 1.1 first ships in Ubuntu 24.04, so this plugin needs
|
||||||
# glibc >= 2.39. It is only loaded on portal sessions; X11 and wlroots hosts never open it.
|
# glibc >= 2.39. It is only loaded on portal sessions; X11 and wlroots hosts never open it.
|
||||||
portal-plugin:
|
portal-plugin:
|
||||||
runs-on: ubuntu-24.04
|
strategy:
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- { arch: x86_64, runner: ubuntu-24.04 }
|
||||||
|
- { arch: aarch64, runner: ubuntu-24.04-arm }
|
||||||
|
runs-on: ${{ matrix.runner }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: Install build dependencies
|
- name: Install build dependencies
|
||||||
@@ -24,13 +29,18 @@ jobs:
|
|||||||
- run: UU_NO_GTK=1 cargo build --release --locked --features portal,engine-plugins --bin uuremote-server
|
- run: UU_NO_GTK=1 cargo build --release --locked --features portal,engine-plugins --bin uuremote-server
|
||||||
- uses: actions/upload-artifact@v4
|
- uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: libuu-portal
|
name: libuu-portal-${{ matrix.arch }}
|
||||||
path: target/release/libuu-portal.so
|
path: target/release/libuu-portal.so
|
||||||
|
|
||||||
release:
|
build:
|
||||||
needs: portal-plugin
|
needs: portal-plugin
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- { arch: x86_64, runner: ubuntu-22.04 }
|
||||||
|
- { arch: aarch64, runner: ubuntu-22.04-arm }
|
||||||
# Built on 22.04 so the binary also runs on Ubuntu 22.04/24.04 and newer Debian (glibc >= 2.35).
|
# Built on 22.04 so the binary also runs on Ubuntu 22.04/24.04 and newer Debian (glibc >= 2.35).
|
||||||
runs-on: ubuntu-22.04
|
runs-on: ${{ matrix.runner }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: Install build dependencies
|
- name: Install build dependencies
|
||||||
@@ -46,25 +56,52 @@ jobs:
|
|||||||
- run: cargo build --release --locked --features wayland,portal,engine-plugins
|
- run: cargo build --release --locked --features wayland,portal,engine-plugins
|
||||||
- uses: actions/download-artifact@v4
|
- uses: actions/download-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: libuu-portal
|
name: libuu-portal-${{ matrix.arch }}
|
||||||
path: target/release
|
path: target/release
|
||||||
# Experimental viewer; built after the host so uuremote-server keeps the release features.
|
# Experimental viewer; built after the host so uuremote-server keeps the release features.
|
||||||
- run: cargo build --release --locked --features native-viewer,viewer-sdl --bin uuremote-viewer
|
- run: cargo build --release --locked --features native-viewer,viewer-sdl --bin uuremote-viewer
|
||||||
- name: Package
|
- name: Package
|
||||||
run: |
|
run: |
|
||||||
name=uu-remote-linux-${GITHUB_REF_NAME}-x86_64-linux
|
name=uu-remote-linux-${GITHUB_REF_NAME}-${{ matrix.arch }}-linux
|
||||||
mkdir -p "$name"
|
mkdir -p "$name"
|
||||||
cp target/release/uuremote-server target/release/uuremote-viewer target/release/libuu-wayland.so target/release/libuu-portal.so \
|
cp target/release/uuremote-server target/release/uuremote-viewer target/release/libuu-wayland.so target/release/libuu-portal.so \
|
||||||
LICENSE README.md README.en.md config.example.json "$name/"
|
LICENSE README.md README.en.md config.example.json "$name/"
|
||||||
cp -r contrib "$name/"
|
cp -r contrib "$name/"
|
||||||
tar czf "$name.tar.gz" "$name"
|
tar czf "$name.tar.gz" "$name"
|
||||||
sha256sum "$name.tar.gz" > "$name.tar.gz.sha256"
|
sha256sum "$name.tar.gz" > "$name.tar.gz.sha256"
|
||||||
|
- name: Debian package
|
||||||
|
run: |
|
||||||
|
packaging/deb/build-deb.sh "${GITHUB_REF_NAME#v}" target/release .
|
||||||
|
deb=$(ls uu-remote-linux_*.deb)
|
||||||
|
sha256sum "$deb" > "$deb.sha256"
|
||||||
|
sudo apt-get install -y "./$deb"
|
||||||
|
uuremote-server --help | head -1
|
||||||
|
systemd-analyze verify /usr/lib/systemd/user/uuremote-native.service
|
||||||
|
- uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: package-${{ matrix.arch }}
|
||||||
|
path: |
|
||||||
|
uu-remote-linux-*.tar.gz*
|
||||||
|
uu-remote-linux_*.deb*
|
||||||
|
|
||||||
|
# One publisher, so the matrix legs never race to create the release.
|
||||||
|
release:
|
||||||
|
needs: build
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/download-artifact@v4
|
||||||
|
with:
|
||||||
|
pattern: package-*
|
||||||
|
merge-multiple: true
|
||||||
- uses: softprops/action-gh-release@v2
|
- uses: softprops/action-gh-release@v2
|
||||||
with:
|
with:
|
||||||
body_path: docs/release-notes/${{ github.ref_name }}.md
|
body_path: docs/release-notes/${{ github.ref_name }}.md
|
||||||
files: |
|
files: |
|
||||||
uu-remote-linux-*.tar.gz
|
uu-remote-linux-*.tar.gz
|
||||||
uu-remote-linux-*.tar.gz.sha256
|
uu-remote-linux-*.tar.gz.sha256
|
||||||
|
uu-remote-linux_*.deb
|
||||||
|
uu-remote-linux_*.deb.sha256
|
||||||
|
|
||||||
# Headless NAS image (docker/), built from the release tarball published by the job above.
|
# Headless NAS image (docker/), built from the release tarball published by the job above.
|
||||||
docker:
|
docker:
|
||||||
|
|||||||
@@ -117,6 +117,7 @@ viewer does not reconnect them automatically.
|
|||||||
| `UU_AUDIO=0`, `UU_AUDIO_SOURCE` | disable sound / choose the Pulse source (default `@DEFAULT_MONITOR@`) |
|
| `UU_AUDIO=0`, `UU_AUDIO_SOURCE` | disable sound / choose the Pulse source (default `@DEFAULT_MONITOR@`) |
|
||||||
| `UU_LOGIN_WINDOW=0` | don't auto-open the login window |
|
| `UU_LOGIN_WINDOW=0` | don't auto-open the login window |
|
||||||
| `UU_ENGINE_DIR` | directory holding `libuu-wayland.so` / `libuu-portal.so` (`--features engine-plugins`, used by release packages: engines are dlopen'ed only on Wayland sessions; also searched next to the binary, `../lib/uu-remote-linux`, `~/.local/lib/uu-remote-linux`, `/usr/lib/uu-remote-linux`) |
|
| `UU_ENGINE_DIR` | directory holding `libuu-wayland.so` / `libuu-portal.so` (`--features engine-plugins`, used by release packages: engines are dlopen'ed only on Wayland sessions; also searched next to the binary, `../lib/uu-remote-linux`, `~/.local/lib/uu-remote-linux`, `/usr/lib/uu-remote-linux`) |
|
||||||
|
| `UU_WOL_HELPER=1` | experimental: report LAN info (`api-ipv4…/api/v1/device/wake_on_lan/info` {mac, ip, subnet_mask}) after sign-in and answer `wake_on_lan` pushes (`target_device` {mac, ip, subnet_mask}) with a magic packet, like the official Windows host (field names from its log strings; not verified end to end). `wake_on_lan` push key names are always logged |
|
||||||
| `UU_USE_PROXY=1` | honor HTTP/SOCKS proxy env vars; cloud API clients bypass env proxies by default |
|
| `UU_USE_PROXY=1` | honor HTTP/SOCKS proxy env vars; cloud API clients bypass env proxies by default |
|
||||||
| `UU_REMOTE_ASSIST=0`, `UU_ASSIST_ALLOW=1`, `UU_ASSIST_UI=tty`, `UU_ASSIST_DEBUG=1` | disable assistance / allow at start / terminal UI for `assist` / include the server's short error message in assist errors |
|
| `UU_REMOTE_ASSIST=0`, `UU_ASSIST_ALLOW=1`, `UU_ASSIST_UI=tty`, `UU_ASSIST_DEBUG=1` | disable assistance / allow at start / terminal UI for `assist` / include the server's short error message in assist errors |
|
||||||
|
|
||||||
@@ -152,7 +153,8 @@ every 60 s.
|
|||||||
| `src/viewer_main.rs`, `src/viewer/` | experimental viewer (`--features native-viewer,viewer-sdl`): cloud join, WebRTC offer side, SDL desktop window (ffmpeg CLI decode), files/terminal/portmap/power/assist tools, device removal (`POST /api/v1/device/{id}/unbind`, verified live; shared devices use `/api/v1/device/share/{id}/unbind`, strings only), GTK launcher |
|
| `src/viewer_main.rs`, `src/viewer/` | experimental viewer (`--features native-viewer,viewer-sdl`): cloud join, WebRTC offer side, SDL desktop window (ffmpeg CLI decode), files/terminal/portmap/power/assist tools, device removal (`POST /api/v1/device/{id}/unbind`, verified live; shared devices use `/api/v1/device/share/{id}/unbind`, strings only), GTK launcher |
|
||||||
| `c_engine/viewer_window.c`, `c_engine/viewer_tools.c` | viewer GTK launcher and tool windows (files, port mapping, terminal list) |
|
| `c_engine/viewer_window.c`, `c_engine/viewer_tools.c` | viewer GTK launcher and tool windows (files, port mapping, terminal list) |
|
||||||
|
|
||||||
Diagnostic subcommands: `login [--no-gui]`, `unlock-check` (password on stdin, prints only accepted/rejected),
|
Diagnostic subcommands: `doctor` (paste-safe report: session, selected backend, engine plugins, uinput, encoders,
|
||||||
|
default codec, sign-in/service state; booleans and names only), `login [--no-gui]`, `unlock-check` (password on stdin, prints only accepted/rejected),
|
||||||
`desktop-probe [new.png]`, `desktop-video-probe` (`UU_PROBE_FPS`, `UU_PROBE_FRAMES`, `UU_PROBE_QUALITY` 1-5 = viewer bitrate preset, 5 auto; `UU_PROBE_INPUT` fixed video/image sequence, `UU_PROBE_LOOP=1` repeats), `wayland-input-probe`, `clipboard-acceptance`,
|
`desktop-probe [new.png]`, `desktop-video-probe` (`UU_PROBE_FPS`, `UU_PROBE_FRAMES`, `UU_PROBE_QUALITY` 1-5 = viewer bitrate preset, 5 auto; `UU_PROBE_INPUT` fixed video/image sequence, `UU_PROBE_LOOP=1` repeats), `wayland-input-probe`, `clipboard-acceptance`,
|
||||||
`portal-acceptance`, `help`. Unknown arguments exit with code 2. Builds up to v0.1.0 did **not** reject them and
|
`portal-acceptance`, `help`. Unknown arguments exit with code 2. Builds up to v0.1.0 did **not** reject them and
|
||||||
started a second full host server instead, so check that a subcommand exists in the binary you run.
|
started a second full host server instead, so check that a subcommand exists in the binary you run.
|
||||||
|
|||||||
Generated
+1
-1
@@ -2741,7 +2741,7 @@ checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "uu-remote-linux"
|
name = "uu-remote-linux"
|
||||||
version = "0.2.14"
|
version = "0.2.18"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"async-trait",
|
"async-trait",
|
||||||
"base64 0.22.1",
|
"base64 0.22.1",
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "uu-remote-linux"
|
name = "uu-remote-linux"
|
||||||
version = "0.2.14"
|
version = "0.2.18"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
default-run = "uuremote-server"
|
default-run = "uuremote-server"
|
||||||
authors = ["uu-remote-linux contributors"]
|
authors = ["uu-remote-linux contributors"]
|
||||||
|
|||||||
+21
-5
@@ -77,7 +77,8 @@ authorized session. Independent file/terminal tool peers do not reset input.
|
|||||||
| GNOME / KDE Plasma | Wayland (xdg-desktop-portal) | 🧪 Experimental; validation scope and limits below | `--features wayland,portal` |
|
| GNOME / KDE Plasma | Wayland (xdg-desktop-portal) | 🧪 Experimental; validation scope and limits below | `--features wayland,portal` |
|
||||||
|
|
||||||
The GNOME Wayland Portal/EIS path has been checked for video and mouse/keyboard input on Ubuntu 26.04, GNOME 50, with one 4K screen at 200% scale; auto unlock after a cold locked connection is verified with the official Mac and iPhone 4.42.0 viewers, while other lock recovery and reconnection still need hardware acceptance testing. Apart from that path and GNOME on X11, desktop testing has primarily used virtual machines. If something goes wrong on
|
The GNOME Wayland Portal/EIS path has been checked for video and mouse/keyboard input on Ubuntu 26.04, GNOME 50, with one 4K screen at 200% scale; auto unlock after a cold locked connection is verified with the official Mac and iPhone 4.42.0 viewers, while other lock recovery and reconnection still need hardware acceptance testing. Apart from that path and GNOME on X11, desktop testing has primarily used virtual machines. If something goes wrong on
|
||||||
real hardware, please [open an issue](../../issues) with your distribution, desktop, GPU and the relevant lines from
|
real hardware, please [open an issue](../../issues) with the output of `uuremote-server doctor` (v0.2.17+; session, backend,
|
||||||
|
plugins, permissions and encoders only, no account data, tokens or addresses) and the relevant lines from
|
||||||
`journalctl --user -u uuremote-native.service`.
|
`journalctl --user -u uuremote-native.service`.
|
||||||
|
|
||||||
Wayland limits: captures one screen by default; Hyprland can enable monitor switching as described below. Resolution is fixed. The native Hyprland backend now pipelines two shm screencopy buffers and passes the viewer's requested fps to both capture pacing and the encoder. Actual fps remains limited by the compositor, rendering and readback (the old serial path measured about 16–22 fps at 2560x1600; the pipeline is VM-measured only, not a hardware guarantee). The portal backend does not support dynamic resolution; see below for GNOME wake and lock recovery; the clipboard syncs while the viewer's remote window has focus. On the first connection the desktop asks for "Remote Desktop / Screen Sharing"
|
Wayland limits: captures one screen by default; Hyprland can enable monitor switching as described below. Resolution is fixed. The native Hyprland backend now pipelines two shm screencopy buffers and passes the viewer's requested fps to both capture pacing and the encoder. Actual fps remains limited by the compositor, rendering and readback (the old serial path measured about 16–22 fps at 2560x1600; the pipeline is VM-measured only, not a hardware guarantee). The portal backend does not support dynamic resolution; see below for GNOME wake and lock recovery; the clipboard syncs while the viewer's remote window has focus. On the first connection the desktop asks for "Remote Desktop / Screen Sharing"
|
||||||
@@ -128,9 +129,20 @@ Switching reuses one video track and pauses input until the new source sends a f
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### 0. Prebuilt release package (recommended, x86_64)
|
### 0. Prebuilt release package (recommended, x86_64 / aarch64)
|
||||||
|
|
||||||
Download `uu-remote-linux-<version>-x86_64-linux.tar.gz` from [Releases](../../releases/latest), extract it, then:
|
**Ubuntu / Debian (v0.2.18+)**: download `uu-remote-linux_<version>_amd64.deb` (ARM64: `arm64`), then:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo apt install ./uu-remote-linux_<version>_amd64.deb
|
||||||
|
uuremote-server login # scan the QR code with the UU Remote app
|
||||||
|
systemctl --user enable --now uuremote-native.service # start with the graphical session
|
||||||
|
```
|
||||||
|
|
||||||
|
The deb installs the binaries, plugins, a systemd user unit and menu entries; uinput access stays opt-in (step 5).
|
||||||
|
GNOME and KDE pass the display environment to the unit; on desktops that don't (e.g. Xfce) add `DISPLAY` as in step 4.
|
||||||
|
|
||||||
|
**Other distributions**: download `uu-remote-linux-<version>-x86_64-linux.tar.gz` (ARM64: `aarch64-linux`) from [Releases](../../releases/latest), extract it, then:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
install -Dm755 uuremote-server ~/.local/bin/uuremote-server
|
install -Dm755 uuremote-server ~/.local/bin/uuremote-server
|
||||||
@@ -148,7 +160,7 @@ running session at startup, and the matching `libuu-*.so` is loaded only on Wayl
|
|||||||
|
|
||||||
Plugins are found next to `uuremote-server`, in `../lib/uu-remote-linux/`, `~/.local/lib/uu-remote-linux/` or
|
Plugins are found next to `uuremote-server`, in `../lib/uu-remote-linux/`, `~/.local/lib/uu-remote-linux/` or
|
||||||
`/usr/lib/uu-remote-linux/` (`UU_ENGINE_DIR` overrides); a missing library or too old glibc is reported in the log.
|
`/usr/lib/uu-remote-linux/` (`UU_ENGINE_DIR` overrides); a missing library or too old glibc is reported in the log.
|
||||||
Continue with step 3 (login). Other architectures (ARM): build from source below.
|
Continue with step 3 (login). Other architectures: build from source below.
|
||||||
|
|
||||||
### 1. Dependencies (Ubuntu / Debian)
|
### 1. Dependencies (Ubuntu / Debian)
|
||||||
|
|
||||||
@@ -321,6 +333,7 @@ Common environment variables:
|
|||||||
| `UU_ASSIST_ALLOW=1` | Allow remote assistance at start (overrides the saved switch) |
|
| `UU_ASSIST_ALLOW=1` | Allow remote assistance at start (overrides the saved switch) |
|
||||||
| `UU_LOGIN_WINDOW=0` | Do not open the login window automatically when credentials are missing |
|
| `UU_LOGIN_WINDOW=0` | Do not open the login window automatically when credentials are missing |
|
||||||
| `UU_PORT_MAPPING=0` | Disable port mapping (the official host's controlled-side switch) |
|
| `UU_PORT_MAPPING=0` | Disable port mapping (the official host's controlled-side switch) |
|
||||||
|
| `UU_WOL_HELPER=1` | Experimental: act as a remote-boot helper like the official Windows host — report this host's LAN info after sign-in and send a magic packet to the LAN when the cloud asks to wake a PC (not verified end to end) |
|
||||||
| `UU_USE_PROXY=1` | Honor HTTP/SOCKS proxy environment variables; by default proxies are ignored and NetEase servers are reached directly |
|
| `UU_USE_PROXY=1` | Honor HTTP/SOCKS proxy environment variables; by default proxies are ignored and NetEase servers are reached directly |
|
||||||
|
|
||||||
Host settings such as "lock after remote session" and "mute host" are stored in
|
Host settings such as "lock after remote session" and "mute host" are stored in
|
||||||
@@ -383,7 +396,7 @@ Released under the [GPL-3.0](LICENSE): you may use, modify and redistribute it,
|
|||||||
|
|
||||||
### H.265 / HEVC
|
### H.265 / HEVC
|
||||||
|
|
||||||
When both sides support H.265 the host uses it (as the official host does: the host picks the codec from both
|
When both sides support H.265 and the host has a hardware encoder (NVENC / explicit VAAPI), the host uses it (as the official host does: the host picks the codec from both
|
||||||
capability lists; the official Mac viewer lists H265 first in its SDP). The first desktop connection probes a
|
capability lists; the official Mac viewer lists H265 first in its SDP). The first desktop connection probes a
|
||||||
synthetic frame and announces encoder support with CodecNegotiation. `hevc_nvenc`, `libx265` and explicit
|
synthetic frame and announces encoder support with CodecNegotiation. `hevc_nvenc`, `libx265` and explicit
|
||||||
`UU_VIDEO_ENCODER=vaapi` (`hevc_vaapi`); hardware failure falls back to software HEVC, then to H.264.
|
`UU_VIDEO_ENCODER=vaapi` (`hevc_vaapi`); hardware failure falls back to software HEVC, then to H.264.
|
||||||
@@ -391,6 +404,9 @@ synthetic frame and announces encoder support with CodecNegotiation. `hevc_nvenc
|
|||||||
Verified with the official Mac viewer on an RTX 3090 (hevc_nvenc, including 4:4:4) and with the official Android
|
Verified with the official Mac viewer on an RTX 3090 (hevc_nvenc, including 4:4:4) and with the official Android
|
||||||
viewer on Intel Alder Lake-P (iHD): 2560x1440 fully hardware-encoded, 58 fps decoded at about 10 ms. libx265 is
|
viewer on Intel Alder Lake-P (iHD): 2560x1440 fully hardware-encoded, 58 fps decoded at about 10 ms. libx265 is
|
||||||
still not verified against a real viewer.
|
still not verified against a real viewer.
|
||||||
|
With CPU-only encoding the default is H.264: libx265 is about ten times slower than libx264 (measured ~15 vs ~155 fps
|
||||||
|
at 1080p on a 4-core ARM host, #59); `UU_VIDEO_CODEC=h265` forces H.265. The applied frame rate comes from the viewer's
|
||||||
|
quality/fps menu; `UU_DISPLAY_FPS` only changes the reported display refresh rate.
|
||||||
|
|
||||||
HEVC access units are split on RFC 7798 picture boundaries instead of AUDs: `hevc_vaapi` with `-aud 1` writes an
|
HEVC access units are split on RFC 7798 picture boundaries instead of AUDs: `hevc_vaapi` with `-aud 1` writes an
|
||||||
AUD only at IRAPs and drops every other picture from the bitstream, so an AUD-based reader turns a whole GOP into
|
AUD only at IRAPs and drops every other picture from the bitstream, so an AUD-based reader turns a whole GOP into
|
||||||
|
|||||||
@@ -71,7 +71,7 @@ Portal 仅作用于本服务获授权的会话。文件传输、终端等独立
|
|||||||
最后一列是源码编译方式;Release 预编译包已包含全部后端,直接使用即可(见[安装](#0-直接用-release-预编译包推荐x86_64))。
|
最后一列是源码编译方式;Release 预编译包已包含全部后端,直接使用即可(见[安装](#0-直接用-release-预编译包推荐x86_64))。
|
||||||
|
|
||||||
GNOME Wayland 的 Portal/EIS 路径已在 Ubuntu 26.04、GNOME 50、单屏 4K/200% 缩放下验证画面和键鼠;锁屏冷连接自动解锁已用 Mac 和 iPhone 4.42.0 客户端实机验证,其余锁屏恢复及重连仍待验收。除 GNOME 的上述路径和 X11 外,其余桌面目前主要在虚拟机里测试。如果你在真机上遇到问题,欢迎[提交 issue](../../issues),
|
GNOME Wayland 的 Portal/EIS 路径已在 Ubuntu 26.04、GNOME 50、单屏 4K/200% 缩放下验证画面和键鼠;锁屏冷连接自动解锁已用 Mac 和 iPhone 4.42.0 客户端实机验证,其余锁屏恢复及重连仍待验收。除 GNOME 的上述路径和 X11 外,其余桌面目前主要在虚拟机里测试。如果你在真机上遇到问题,欢迎[提交 issue](../../issues),
|
||||||
请附上发行版、桌面环境、显卡型号和 `journalctl --user -u uuremote-native.service` 里的相关日志。
|
请附上 `uuremote-server doctor` 的输出(v0.2.17 起;只含会话、后端、插件、权限、编码器等状态,不含账号、令牌或地址,可直接粘贴)和 `journalctl --user -u uuremote-native.service` 里的相关日志。
|
||||||
|
|
||||||
Wayland 下的限制:默认采集单屏,Hyprland 可按上文启用切屏;分辨率固定;Hyprland 原生后端默认使用双缓冲流水线 shm screencopy,控制端帧率设置会同步到采集节拍和编码器,但实际帧率仍受合成器、渲染和读回速度限制(旧串行路径在 2560x1600 曾测得约 16~22 帧;流水线只在虚拟机里测量过,不代表实机保证);portal 后端暂不支持动态分辨率;GNOME 的屏幕唤醒与锁屏恢复见下;剪贴板只在控制端的远控窗口处于前台时同步。
|
Wayland 下的限制:默认采集单屏,Hyprland 可按上文启用切屏;分辨率固定;Hyprland 原生后端默认使用双缓冲流水线 shm screencopy,控制端帧率设置会同步到采集节拍和编码器,但实际帧率仍受合成器、渲染和读回速度限制(旧串行路径在 2560x1600 曾测得约 16~22 帧;流水线只在虚拟机里测量过,不代表实机保证);portal 后端暂不支持动态分辨率;GNOME 的屏幕唤醒与锁屏恢复见下;剪贴板只在控制端的远控窗口处于前台时同步。
|
||||||
|
|
||||||
@@ -115,9 +115,20 @@ GNOME Portal 的控制通道不再等待授权窗口或第一帧画面:先通
|
|||||||
|
|
||||||
## 安装
|
## 安装
|
||||||
|
|
||||||
### 0. 直接用 Release 预编译包(推荐,x86_64)
|
### 0. 直接用 Release 预编译包(推荐,x86_64 / aarch64)
|
||||||
|
|
||||||
从 [Releases](../../releases/latest) 下载 `uu-remote-linux-<版本>-x86_64-linux.tar.gz`,解压后:
|
**Ubuntu / Debian(v0.2.18 起)**:下载 `uu-remote-linux_<版本>_amd64.deb`(ARM64 选 `arm64`)后:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo apt install ./uu-remote-linux_<版本>_amd64.deb
|
||||||
|
uuremote-server login # 用 UU 远程 App 扫码
|
||||||
|
systemctl --user enable --now uuremote-native.service # 随图形会话启动
|
||||||
|
```
|
||||||
|
|
||||||
|
deb 会安装程序、插件、用户级 systemd 服务和应用菜单图标;uinput 权限不会自动开启(见第 5 步)。
|
||||||
|
GNOME / KDE 会把显示环境自动传给服务;Xfce 等不传的桌面需按第 4 步补 `DISPLAY`。
|
||||||
|
|
||||||
|
**其他发行版**:从 [Releases](../../releases/latest) 下载 `uu-remote-linux-<版本>-x86_64-linux.tar.gz`(ARM64 选 `aarch64-linux`),解压后:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
install -Dm755 uuremote-server ~/.local/bin/uuremote-server
|
install -Dm755 uuremote-server ~/.local/bin/uuremote-server
|
||||||
@@ -134,7 +145,7 @@ install -Dm644 libuu-wayland.so libuu-portal.so -t ~/.local/lib/uu-remote-linux/
|
|||||||
| GNOME / KDE Wayland | glibc ≥ 2.39(Ubuntu 24.04、Fedora 40、Debian 13 及更新),以及 libei ≥ 1.1、PipeWire |
|
| GNOME / KDE Wayland | glibc ≥ 2.39(Ubuntu 24.04、Fedora 40、Debian 13 及更新),以及 libei ≥ 1.1、PipeWire |
|
||||||
|
|
||||||
插件放在 `uuremote-server` 同目录、`../lib/uu-remote-linux/`、`~/.local/lib/uu-remote-linux/` 或 `/usr/lib/uu-remote-linux/` 都能找到
|
插件放在 `uuremote-server` 同目录、`../lib/uu-remote-linux/`、`~/.local/lib/uu-remote-linux/` 或 `/usr/lib/uu-remote-linux/` 都能找到
|
||||||
(`UU_ENGINE_DIR` 可指定)。缺库或版本太旧时日志会写明原因。之后从第 3 步「登录」继续;ARM 等其他架构请按下面源码编译。
|
(`UU_ENGINE_DIR` 可指定)。缺库或版本太旧时日志会写明原因。之后从第 3 步「登录」继续;其他架构请按下面源码编译。
|
||||||
|
|
||||||
### 1. 依赖(Ubuntu / Debian)
|
### 1. 依赖(Ubuntu / Debian)
|
||||||
|
|
||||||
@@ -292,6 +303,7 @@ systemctl --user restart uuremote-native.service
|
|||||||
| `UU_REMOTE_ASSIST=0` | 关闭远程协助(未登录时也不再以访客身份提供协助) |
|
| `UU_REMOTE_ASSIST=0` | 关闭远程协助(未登录时也不再以访客身份提供协助) |
|
||||||
| `UU_ASSIST_ALLOW=1` | 启动时就允许他人远程协助(覆盖窗口里保存的开关状态) |
|
| `UU_ASSIST_ALLOW=1` | 启动时就允许他人远程协助(覆盖窗口里保存的开关状态) |
|
||||||
| `UU_PORT_MAPPING=0` | 关闭端口映射(对应官方被控端的开关) |
|
| `UU_PORT_MAPPING=0` | 关闭端口映射(对应官方被控端的开关) |
|
||||||
|
| `UU_WOL_HELPER=1` | 实验性:让这台主机像官方 Windows 被控端一样充当「远程开机」辅助设备——登录后向网易上报本机局域网信息,收到云端唤醒请求时向同一局域网发送唤醒包(未经端到端验证) |
|
||||||
| `UU_USE_PROXY=1` | 使用环境变量里的 HTTP/SOCKS 代理;默认忽略代理、直连网易服务器 |
|
| `UU_USE_PROXY=1` | 使用环境变量里的 HTTP/SOCKS 代理;默认忽略代理、直连网易服务器 |
|
||||||
|
|
||||||
「远程结束后自动锁屏」「静音运行」等设置保存在 `~/.config/uuremote/host_settings.json`。
|
「远程结束后自动锁屏」「静音运行」等设置保存在 `~/.config/uuremote/host_settings.json`。
|
||||||
@@ -346,8 +358,9 @@ flowchart LR
|
|||||||
|
|
||||||
### H.265 / HEVC
|
### H.265 / HEVC
|
||||||
|
|
||||||
控制端和主机都支持 H.265 时,主机自动使用 H.265(与官方主机一致,由主机按双方能力选择;官方 Mac 客户端在 SDP
|
控制端和主机都支持 H.265、且主机使用硬件编码器(NVENC / 显式 VAAPI)时,主机自动使用 H.265(与官方主机一致,由主机按双方能力选择;官方 Mac 客户端在 SDP
|
||||||
中优先列出 H.265)。首次桌面连接会用合成帧探测实际编码能力,并通过 CodecNegotiation 告知客户端。支持 `hevc_nvenc`、
|
中优先列出 H.265)。**只有 CPU 编码时默认用 H.264**:libx265 比 libx264 慢约 10 倍(4 核 ARM 上 1080p 实测约 15 帧对 155 帧,#59),
|
||||||
|
可用 `UU_VIDEO_CODEC=h265` 强制 H.265。实际帧率由控制端的「画质/帧率」菜单决定;`UU_DISPLAY_FPS` 只改上报的显示器刷新率。首次桌面连接会用合成帧探测实际编码能力,并通过 CodecNegotiation 告知客户端。支持 `hevc_nvenc`、
|
||||||
`libx265`、显式 `UU_VIDEO_ENCODER=vaapi` 的 `hevc_vaapi`;硬件失败先回落软件 HEVC,再回落 H.264。
|
`libx265`、显式 `UU_VIDEO_ENCODER=vaapi` 的 `hevc_vaapi`;硬件失败先回落软件 HEVC,再回落 H.264。
|
||||||
`UU_VIDEO_CODEC=h264` 强制使用 H.264。8-bit;真彩 4:4:4 使用 hevc_nvenc `rext` / libx265 `main444-8`。
|
`UU_VIDEO_CODEC=h264` 强制使用 H.264。8-bit;真彩 4:4:4 使用 hevc_nvenc `rext` / libx265 `main444-8`。
|
||||||
已用官方 Mac 客户端在 RTX 3090(hevc_nvenc,含 4:4:4)实机验收;`hevc_vaapi` 配官方 Android 客户端也已实机验收
|
已用官方 Mac 客户端在 RTX 3090(hevc_nvenc,含 4:4:4)实机验收;`hevc_vaapi` 配官方 Android 客户端也已实机验收
|
||||||
|
|||||||
@@ -7,6 +7,8 @@
|
|||||||
#define SESSION_DEST "org.gnome.SessionManager"
|
#define SESSION_DEST "org.gnome.SessionManager"
|
||||||
#define SESSION_PATH "/org/gnome/SessionManager"
|
#define SESSION_PATH "/org/gnome/SessionManager"
|
||||||
#define SESSION_IFACE "org.gnome.SessionManager"
|
#define SESSION_IFACE "org.gnome.SessionManager"
|
||||||
|
#define SCREENSAVER_DEST "org.freedesktop.ScreenSaver"
|
||||||
|
#define SCREENSAVER_PATH "/org/freedesktop/ScreenSaver"
|
||||||
|
|
||||||
enum {
|
enum {
|
||||||
UU_POWER_OK = 0,
|
UU_POWER_OK = 0,
|
||||||
@@ -17,6 +19,7 @@ enum {
|
|||||||
struct uu_idle_inhibitor {
|
struct uu_idle_inhibitor {
|
||||||
GDBusConnection *connection;
|
GDBusConnection *connection;
|
||||||
guint32 cookie;
|
guint32 cookie;
|
||||||
|
int freedesktop; /* org.freedesktop.ScreenSaver (KDE) instead of org.gnome.SessionManager */
|
||||||
};
|
};
|
||||||
|
|
||||||
struct setup_timeout {
|
struct setup_timeout {
|
||||||
@@ -138,13 +141,45 @@ struct uu_idle_inhibitor *uu_desktop_idle_inhibitor_acquire(int *error_code) {
|
|||||||
return inhibitor;
|
return inhibitor;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* KDE (and other desktops implementing the freedesktop idle-inhibition spec): the inhibition is
|
||||||
|
also dropped by the screensaver when this private connection closes. */
|
||||||
|
struct uu_idle_inhibitor *uu_desktop_screensaver_inhibitor_acquire(int *error_code) {
|
||||||
|
if (!error_code) return NULL;
|
||||||
|
*error_code = UU_POWER_OK;
|
||||||
|
GDBusConnection *connection = private_session_bus(error_code);
|
||||||
|
if (!connection) return NULL;
|
||||||
|
GError *error = NULL;
|
||||||
|
GVariant *reply = g_dbus_connection_call_sync(
|
||||||
|
connection, SCREENSAVER_DEST, SCREENSAVER_PATH, SCREENSAVER_DEST, "Inhibit",
|
||||||
|
g_variant_new("(ss)", "uu-remote-linux", "Remote desktop session is active"),
|
||||||
|
G_VARIANT_TYPE("(u)"), G_DBUS_CALL_FLAGS_NONE, CALL_TIMEOUT_MS, NULL, &error);
|
||||||
|
g_clear_error(&error);
|
||||||
|
struct uu_idle_inhibitor *inhibitor = reply ? calloc(1, sizeof(*inhibitor)) : NULL;
|
||||||
|
if (!inhibitor) {
|
||||||
|
*error_code = UU_POWER_CALL_FAILED;
|
||||||
|
if (reply) g_variant_unref(reply);
|
||||||
|
close_private_bus(connection);
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
|
g_variant_get(reply, "(u)", &inhibitor->cookie);
|
||||||
|
g_variant_unref(reply);
|
||||||
|
inhibitor->connection = connection;
|
||||||
|
inhibitor->freedesktop = 1;
|
||||||
|
return inhibitor;
|
||||||
|
}
|
||||||
|
|
||||||
void uu_desktop_idle_inhibitor_release(struct uu_idle_inhibitor *inhibitor) {
|
void uu_desktop_idle_inhibitor_release(struct uu_idle_inhibitor *inhibitor) {
|
||||||
if (!inhibitor) return;
|
if (!inhibitor) return;
|
||||||
GError *error = NULL;
|
GError *error = NULL;
|
||||||
GVariant *reply = g_dbus_connection_call_sync(
|
GVariant *reply = inhibitor->freedesktop
|
||||||
inhibitor->connection, SESSION_DEST, SESSION_PATH, SESSION_IFACE, "Uninhibit",
|
? g_dbus_connection_call_sync(
|
||||||
g_variant_new("(u)", inhibitor->cookie), G_VARIANT_TYPE("()"),
|
inhibitor->connection, SCREENSAVER_DEST, SCREENSAVER_PATH, SCREENSAVER_DEST, "UnInhibit",
|
||||||
G_DBUS_CALL_FLAGS_NONE, CALL_TIMEOUT_MS, NULL, &error);
|
g_variant_new("(u)", inhibitor->cookie), G_VARIANT_TYPE("()"),
|
||||||
|
G_DBUS_CALL_FLAGS_NONE, CALL_TIMEOUT_MS, NULL, &error)
|
||||||
|
: g_dbus_connection_call_sync(
|
||||||
|
inhibitor->connection, SESSION_DEST, SESSION_PATH, SESSION_IFACE, "Uninhibit",
|
||||||
|
g_variant_new("(u)", inhibitor->cookie), G_VARIANT_TYPE("()"),
|
||||||
|
G_DBUS_CALL_FLAGS_NONE, CALL_TIMEOUT_MS, NULL, &error);
|
||||||
if (reply) g_variant_unref(reply);
|
if (reply) g_variant_unref(reply);
|
||||||
g_clear_error(&error);
|
g_clear_error(&error);
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -1,7 +1,7 @@
|
|||||||
# Unofficial UU Remote Linux host in a container, for NAS boxes (Synology DSM, etc.) without a desktop.
|
# Unofficial UU Remote Linux host in a container, for NAS boxes (Synology DSM, etc.) without a desktop.
|
||||||
# Headless mode: file transfer, terminal and port mapping; no remote desktop. Uses the published release binary.
|
# Headless mode: file transfer, terminal and port mapping; no remote desktop. Uses the published release binary.
|
||||||
FROM ubuntu:24.04
|
FROM ubuntu:24.04
|
||||||
ARG VERSION=v0.2.14
|
ARG VERSION=v0.2.18
|
||||||
LABEL org.opencontainers.image.source="https://github.com/VallierDev/uu-remote-linux" \
|
LABEL org.opencontainers.image.source="https://github.com/VallierDev/uu-remote-linux" \
|
||||||
org.opencontainers.image.description="Unofficial UU Remote Linux host, headless (file transfer, terminal, port mapping)" \
|
org.opencontainers.image.description="Unofficial UU Remote Linux host, headless (file transfer, terminal, port mapping)" \
|
||||||
org.opencontainers.image.licenses="GPL-3.0"
|
org.opencontainers.image.licenses="GPL-3.0"
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
ARM64 预编译包;无硬件编码器时默认 H.264。/ aarch64 release package; CPU-only hosts default to H.264.
|
||||||
|
|
||||||
|
### 新增 / Added
|
||||||
|
- **aarch64 预编译包**(#59,感谢 @DeliciousBuding):新增 `uu-remote-linux-v0.2.15-aarch64-linux.tar.gz`,与 x86_64 包相同,
|
||||||
|
含 `uuremote-server`、`uuremote-viewer` 和两个桌面引擎插件;ARM64 主机不再需要源码编译。CI 新增 ARM64 原生构建与测试(#58)。
|
||||||
|
aarch64 包由 GitHub ARM runner 构建,尚未在真实 ARM 主机上运行验收。
|
||||||
|
- New aarch64 release package (same contents as x86_64), built on GitHub ARM runners; not yet run on real ARM hardware.
|
||||||
|
|
||||||
|
### 变更 / Changed
|
||||||
|
- **只有 CPU 编码时默认使用 H.264**(#59):libx265 比 libx264 慢约 10 倍(4 核 Ampere A1 上 1080p 约 15 帧对 155 帧),
|
||||||
|
原先 CPU 主机默认 H.265 会掉到十几帧。现在只有使用硬件编码器(NVENC / 显式 VAAPI)时才自动选 H.265;
|
||||||
|
`UU_VIDEO_CODEC=h265` 仍可强制 H.265。NVENC / VAAPI 主机行为不变。
|
||||||
|
- Without NVENC/VAAPI the host now picks H.264 even when both sides offer H.265; `UU_VIDEO_CODEC=h265` forces H.265.
|
||||||
|
|
||||||
|
### 下载 / Download
|
||||||
|
`uu-remote-linux-v0.2.15-x86_64-linux.tar.gz` / `uu-remote-linux-v0.2.15-aarch64-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.15`(x86_64)。
|
||||||
|
|
||||||
|
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
KDE 远程期间不再自动锁屏;锁屏和黑屏原因写进日志。/ No idle lock on KDE during remote sessions; lock and black-screen hints.
|
||||||
|
|
||||||
|
### 修复 / Fixed
|
||||||
|
- **KDE Wayland 远程操作中途自动锁屏**(#61,感谢 @coolxll):桌面连接期间通过 `org.freedesktop.ScreenSaver.Inhibit` 阻止空闲锁屏,
|
||||||
|
断开后释放(GNOME 沿用 SessionManager 的空闲抑制)。尚未在 KDE 真机上验证。
|
||||||
|
- **`inproc-av` 奇数尺寸桌面**(#60,感谢 @ferstar):进程内编码路径同样补齐为偶数尺寸(#53 只修了默认 FFmpeg 管线)。
|
||||||
|
`inproc-av` 不在预编译包里;未在奇数尺寸真机上验证。
|
||||||
|
|
||||||
|
### 改进 / Improved
|
||||||
|
- 桌面锁屏时日志提示「控制端在解锁前只会看到黑屏」,并给出解锁方式(控制端「自动解锁被控端」或本机 `loginctl unlock-session`)。
|
||||||
|
- 检测到 Wayland 会话却选中了 X11 后端时给出警告(此时采集 XWayland 只会得到全黑画面且没有报错)。
|
||||||
|
- KDE sessions hold a freedesktop ScreenSaver inhibitor while connected (not yet tested on real KDE); the log now explains lock-screen
|
||||||
|
black frames and warns when X11 capture is used inside a Wayland session; `inproc-av` pads odd sizes too.
|
||||||
|
|
||||||
|
### 下载 / Download
|
||||||
|
`uu-remote-linux-v0.2.16-x86_64-linux.tar.gz` / `uu-remote-linux-v0.2.16-aarch64-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.16`(x86_64)。
|
||||||
|
|
||||||
|
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
新增 `uuremote-server doctor` 一键诊断。/ New `uuremote-server doctor` diagnostic report.
|
||||||
|
|
||||||
|
### 新增 / Added
|
||||||
|
- **`uuremote-server doctor`**:一次输出提 issue 需要的状态——会话类型与桌面、最终选中的后端(含「Wayland 会话里用了 X11 后端会黑屏」的提醒)、
|
||||||
|
Wayland / portal 插件能否加载及缺什么库、`/dev/uinput` 与显卡 render 节点权限、FFmpeg 可用编码器和版本、默认编码(H.264 / H.265)、
|
||||||
|
是否已登录、服务状态和重复进程。只输出布尔值、名称和版本,主目录和用户名会被替换,不含账号 ID、令牌、IP、MAC 或文件内容,
|
||||||
|
可以直接贴到 issue。issue 模板已改为先运行它。
|
||||||
|
- `uuremote-server doctor` prints a paste-safe report (session, backend, plugins, permissions, encoders, default codec, sign-in and
|
||||||
|
service state) with no ids, tokens, addresses or file contents.
|
||||||
|
|
||||||
|
### 下载 / Download
|
||||||
|
`uu-remote-linux-v0.2.17-x86_64-linux.tar.gz` / `uu-remote-linux-v0.2.17-aarch64-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.17`(x86_64)。
|
||||||
|
|
||||||
|
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
Ubuntu / Debian 安装包(.deb);实验性远程开机辅助。/ Debian packages; experimental Wake-on-LAN helper.
|
||||||
|
|
||||||
|
### 新增 / Added
|
||||||
|
- **`.deb` 安装包**(amd64 / arm64):`sudo apt install ./uu-remote-linux_0.2.18_amd64.deb` 一步装好程序、两个桌面插件、
|
||||||
|
用户级 systemd 服务和应用菜单图标,依赖由 apt 自动安装。之后以桌面用户运行:
|
||||||
|
```sh
|
||||||
|
uuremote-server login
|
||||||
|
systemctl --user enable --now uuremote-native.service
|
||||||
|
```
|
||||||
|
服务随图形会话启动(GNOME / KDE 会自动传入显示环境;Xfce 等需按 README 补 `DISPLAY`)。uinput 权限不会自动开启,规则文件放在
|
||||||
|
`/usr/share/doc/uu-remote-linux/`。安装流程在 CI 的 Ubuntu 22.04 上实测(apt 安装、`--help`、systemd 单元校验);尚未在真实桌面上完整验收。
|
||||||
|
- **远程开机辅助(实验性,默认关闭,`UU_WOL_HELPER=1`)**:仿照官方 Windows 被控端,登录后向网易上报本机局域网信息,
|
||||||
|
收到云端的唤醒请求时向同一局域网发送唤醒包,让这台常开的 Linux(例如 NAS)帮你唤醒同局域网的其他电脑。
|
||||||
|
字段名来自官方程序的日志字符串,**未经端到端验证**;不开启时不上报任何局域网信息,只记录唤醒推送的字段名(不含 MAC/IP)。
|
||||||
|
- Debian packages (amd64/arm64) with the binaries, plugins, a systemd user unit and menu entries; install-tested on Ubuntu 22.04 in CI.
|
||||||
|
Experimental, opt-in Wake-on-LAN helper (`UU_WOL_HELPER=1`) modelled on the official Windows host; not verified end to end.
|
||||||
|
|
||||||
|
### 修复 / Fixed
|
||||||
|
- `uuremote-server doctor` 不再输出带完整路径的插件加载日志(路径可能含用户名)。
|
||||||
|
|
||||||
|
### 下载 / Download
|
||||||
|
`uu-remote-linux_0.2.18_amd64.deb` / `uu-remote-linux_0.2.18_arm64.deb`,或 `uu-remote-linux-v0.2.18-<x86_64|aarch64>-linux.tar.gz`,
|
||||||
|
或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.18`(x86_64)。
|
||||||
|
|
||||||
|
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
|
||||||
Executable
+67
@@ -0,0 +1,67 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# Build uu-remote-linux_<version>_<arch>.deb from release binaries.
|
||||||
|
# usage: packaging/deb/build-deb.sh VERSION BIN_DIR OUT_DIR (VERSION without the leading v)
|
||||||
|
set -eu
|
||||||
|
version=$1 bin=$2 out=$3
|
||||||
|
here=$(cd "$(dirname "$0")" && pwd) root=$(cd "$here/../.." && pwd)
|
||||||
|
case $(uname -m) in x86_64) arch=amd64 ;; aarch64) arch=arm64 ;; *) echo "unsupported arch" >&2; exit 1 ;; esac
|
||||||
|
pkg=$(mktemp -d)
|
||||||
|
trap 'rm -rf "$pkg"' EXIT
|
||||||
|
install -Dm755 "$bin/uuremote-server" "$pkg/usr/bin/uuremote-server"
|
||||||
|
[ -f "$bin/uuremote-viewer" ] && install -Dm755 "$bin/uuremote-viewer" "$pkg/usr/bin/uuremote-viewer"
|
||||||
|
for lib in libuu-wayland.so libuu-portal.so; do
|
||||||
|
[ -f "$bin/$lib" ] && install -Dm644 "$bin/$lib" "$pkg/usr/lib/uu-remote-linux/$lib"
|
||||||
|
done
|
||||||
|
install -Dm644 "$here/uuremote-native.service" "$pkg/usr/lib/systemd/user/uuremote-native.service"
|
||||||
|
install -Dm644 "$root/contrib/desktop/uu-remote-linux.desktop" "$pkg/usr/share/applications/uu-remote-linux.desktop"
|
||||||
|
[ -f "$pkg/usr/bin/uuremote-viewer" ] && install -Dm644 "$root/contrib/desktop/uu-remote-linux-viewer.desktop" "$pkg/usr/share/applications/uu-remote-linux-viewer.desktop"
|
||||||
|
install -Dm644 "$root/contrib/desktop/uu-remote-linux.svg" "$pkg/usr/share/icons/hicolor/scalable/apps/uu-remote-linux.svg"
|
||||||
|
install -Dm644 "$root/LICENSE" "$pkg/usr/share/doc/uu-remote-linux/copyright"
|
||||||
|
# uinput access is opt-in: it lets the service inject input into the whole seat.
|
||||||
|
printf '%s\n' 'KERNEL=="uinput", SUBSYSTEM=="misc", OPTIONS+="static_node=uinput", TAG+="uaccess"' \
|
||||||
|
> "$pkg/usr/share/doc/uu-remote-linux/60-uu-remote-linux-uinput.rules"
|
||||||
|
size=$(du -sk "$pkg/usr" | cut -f1)
|
||||||
|
# Library dependencies from the binaries themselves (the server hard, the viewer recommended).
|
||||||
|
shlibdeps() {
|
||||||
|
work=$(mktemp -d); mkdir "$work/debian"
|
||||||
|
printf 'Source: uu-remote-linux\n\nPackage: uu-remote-linux\nArchitecture: any\n' > "$work/debian/control"
|
||||||
|
(cd "$work" && dpkg-shlibdeps -O --ignore-missing-info "$1" 2>/dev/null) | sed -n 's/^shlibs:Depends=//p'
|
||||||
|
rm -rf "$work"
|
||||||
|
}
|
||||||
|
depends=$(shlibdeps "$pkg/usr/bin/uuremote-server")
|
||||||
|
recommends=""
|
||||||
|
[ -f "$pkg/usr/bin/uuremote-viewer" ] && recommends=$(shlibdeps "$pkg/usr/bin/uuremote-viewer")
|
||||||
|
[ -n "$depends" ] || { echo "dpkg-shlibdeps produced no dependencies" >&2; exit 1; }
|
||||||
|
mkdir -p "$pkg/DEBIAN"
|
||||||
|
cat > "$pkg/DEBIAN/control" <<CONTROL
|
||||||
|
Package: uu-remote-linux
|
||||||
|
Version: $version
|
||||||
|
Architecture: $arch
|
||||||
|
Maintainer: VallierDev <[email protected]>
|
||||||
|
Installed-Size: $size
|
||||||
|
Depends: $depends, ffmpeg
|
||||||
|
Recommends: ${recommends:+$recommends, }libwayland-client0, libxkbcommon0
|
||||||
|
Suggests: libpipewire-0.3-0, libei1, wl-clipboard
|
||||||
|
Section: net
|
||||||
|
Priority: optional
|
||||||
|
Homepage: https://github.com/VallierDev/uu-remote-linux
|
||||||
|
Description: Unofficial native Linux host for NetEase UU Remote
|
||||||
|
Lets the official NetEase UU Remote clients control this Linux desktop
|
||||||
|
(X11, wlroots Wayland and GNOME/KDE Wayland through runtime plugins).
|
||||||
|
Includes the experimental uuremote-viewer. Not affiliated with NetEase.
|
||||||
|
CONTROL
|
||||||
|
cat > "$pkg/DEBIAN/postinst" <<'POSTINST'
|
||||||
|
#!/bin/sh
|
||||||
|
set -e
|
||||||
|
if [ "$1" = configure ]; then
|
||||||
|
cat <<'MSG'
|
||||||
|
uu-remote-linux installed. As your desktop user (not root):
|
||||||
|
uuremote-server login # scan the QR code with the UU Remote app
|
||||||
|
systemctl --user enable --now uuremote-native.service # start with the graphical session
|
||||||
|
Optional uinput keyboard/mouse (Wayland): see /usr/share/doc/uu-remote-linux/60-uu-remote-linux-uinput.rules
|
||||||
|
MSG
|
||||||
|
fi
|
||||||
|
POSTINST
|
||||||
|
chmod 755 "$pkg/DEBIAN/postinst"
|
||||||
|
mkdir -p "$out"
|
||||||
|
dpkg-deb --build --root-owner-group "$pkg" "$out/uu-remote-linux_${version}_${arch}.deb"
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# Installed by the uu-remote-linux .deb as a systemd *user* unit; enable it per user:
|
||||||
|
# systemctl --user enable --now uuremote-native.service
|
||||||
|
# GNOME and KDE import DISPLAY / WAYLAND_DISPLAY into the user manager when the graphical session
|
||||||
|
# starts. Desktops that do not (e.g. Xfce) can add a drop-in with Environment=DISPLAY=:0.
|
||||||
|
[Unit]
|
||||||
|
Description=UU Remote Linux host (unofficial)
|
||||||
|
After=graphical-session.target
|
||||||
|
PartOf=graphical-session.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Environment=RUST_LOG=info
|
||||||
|
ExecStart=/usr/bin/uuremote-server
|
||||||
|
Restart=always
|
||||||
|
RestartSec=5
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=graphical-session.target
|
||||||
+10
@@ -251,6 +251,16 @@ impl UUAuthClient {
|
|||||||
Ok((status, value))
|
Ok((status, value))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Signed JSON POST to another API host (the signature covers the path only).
|
||||||
|
pub async fn post_json_url(&self, base: &str, path: &str, body: &serde_json::Value) -> Result<(u16, serde_json::Value), String> {
|
||||||
|
let body_str = serde_json::to_string(body).map_err(|e| e.to_string())?;
|
||||||
|
let resp = self.http.post(format!("{base}{path}"))
|
||||||
|
.headers(self.build_headers("POST", path, &body_str)).body(body_str)
|
||||||
|
.send().await.map_err(|e| format!("HTTP post {path} failed: {}", transport_error(&e)))?;
|
||||||
|
let status = resp.status().as_u16();
|
||||||
|
Ok((status, resp.json().await.unwrap_or(serde_json::Value::Null)))
|
||||||
|
}
|
||||||
|
|
||||||
/// Guest APIs use requestPlain for empty requests; sign the actual empty body.
|
/// Guest APIs use requestPlain for empty requests; sign the actual empty body.
|
||||||
/// Errors intentionally exclude response text and URL (both can contain secrets).
|
/// Errors intentionally exclude response text and URL (both can contain secrets).
|
||||||
pub async fn assist_post(&self, path: &str, body: Option<&serde_json::Value>) -> Result<(u16, serde_json::Value), String> {
|
pub async fn assist_post(&self, path: &str, body: Option<&serde_json::Value>) -> Result<(u16, serde_json::Value), String> {
|
||||||
|
|||||||
+19
-3
@@ -117,10 +117,16 @@ pub fn handle_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, na
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Initial codec once the m-line is negotiated: H.265 when both sides support it (the Mac viewer
|
/// Initial codec once the m-line is negotiated: H.265 when both sides support it (the Mac viewer
|
||||||
/// lists H265 first in its offer), unless UU_VIDEO_CODEC=h264.
|
/// lists H265 first in its offer) and a hardware encoder is selected. Software libx265 is about ten
|
||||||
|
/// times slower than libx264 (measured 15 vs 155 fps at 1080p on a 4-core ARM host, #59), so CPU
|
||||||
|
/// hosts default to H.264. UU_VIDEO_CODEC=h264 / h265 overrides.
|
||||||
pub fn preferred_codec(h264: bool, h265: bool) -> VideoCodec {
|
pub fn preferred_codec(h264: bool, h265: bool) -> VideoCodec {
|
||||||
let forced_h264 = std::env::var("UU_VIDEO_CODEC").is_ok_and(|v| v.eq_ignore_ascii_case("h264"));
|
let forced = std::env::var("UU_VIDEO_CODEC").ok().map(|v| v.to_ascii_lowercase());
|
||||||
if h265 && !(forced_h264 && h264) { VideoCodec::H265 } else { VideoCodec::H264 }
|
pick_codec(h264, h265, forced.as_deref(), crate::video::Encoder::requested() != crate::video::Encoder::Cpu)
|
||||||
|
}
|
||||||
|
fn pick_codec(h264: bool, h265: bool, forced: Option<&str>, hardware: bool) -> VideoCodec {
|
||||||
|
let wants_h265 = match forced { Some("h264") => false, Some("h265" | "hevc") => true, _ => hardware };
|
||||||
|
if h265 && (wants_h265 || !h264) { VideoCodec::H265 } else { VideoCodec::H264 }
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn handle_rpc_with_codecs(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32), h264: bool, h265: bool) -> Option<Vec<u8>> {
|
pub fn handle_rpc_with_codecs(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32), h264: bool, h265: bool) -> Option<Vec<u8>> {
|
||||||
@@ -499,6 +505,16 @@ mod codec_tests {
|
|||||||
assert_eq!(rx.borrow().codec, VideoCodec::H265);
|
assert_eq!(rx.borrow().codec, VideoCodec::H265);
|
||||||
assert_eq!(preferred_codec(true, false), VideoCodec::H264);
|
assert_eq!(preferred_codec(true, false), VideoCodec::H264);
|
||||||
}
|
}
|
||||||
|
#[test]
|
||||||
|
fn software_hosts_default_to_h264_unless_forced() {
|
||||||
|
assert_eq!(pick_codec(true, true, None, true), VideoCodec::H265);
|
||||||
|
assert_eq!(pick_codec(true, true, None, false), VideoCodec::H264);
|
||||||
|
assert_eq!(pick_codec(true, true, Some("h265"), false), VideoCodec::H265);
|
||||||
|
assert_eq!(pick_codec(true, true, Some("h264"), true), VideoCodec::H264);
|
||||||
|
// Only one codec bound in the SDP: use it whatever the preference.
|
||||||
|
assert_eq!(pick_codec(false, true, None, false), VideoCodec::H265);
|
||||||
|
assert_eq!(pick_codec(true, false, Some("h265"), true), VideoCodec::H264);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
|
|||||||
@@ -6,6 +6,16 @@ pub enum DesktopBackend { X11, Wayland, Portal, Kms }
|
|||||||
/// port mapping stay available (servers without a monitor or logged-in session).
|
/// port mapping stay available (servers without a monitor or logged-in session).
|
||||||
pub fn headless() -> bool { std::env::var("UU_DESKTOP_BACKEND").is_ok_and(|v| v == "none") }
|
pub fn headless() -> bool { std::env::var("UU_DESKTOP_BACKEND").is_ok_and(|v| v == "none") }
|
||||||
|
|
||||||
|
/// A Wayland compositor socket exists for this user or the environment says so, even when this
|
||||||
|
/// process (e.g. a systemd unit with only DISPLAY set) would select X11.
|
||||||
|
pub fn wayland_session_running() -> bool {
|
||||||
|
std::env::var("XDG_SESSION_TYPE").is_ok_and(|v| v == "wayland")
|
||||||
|
|| std::env::var("WAYLAND_DISPLAY").is_ok_and(|v| !v.is_empty())
|
||||||
|
|| std::env::var_os("XDG_RUNTIME_DIR").and_then(|dir| std::fs::read_dir(dir).ok())
|
||||||
|
.is_some_and(|entries| entries.flatten().any(|e| e.file_name().to_str()
|
||||||
|
.is_some_and(|n| n.starts_with("wayland-") && !n.ends_with(".lock"))))
|
||||||
|
}
|
||||||
|
|
||||||
pub fn detect() -> Result<DesktopBackend, String> {
|
pub fn detect() -> Result<DesktopBackend, String> {
|
||||||
let backend=select(std::env::var("UU_DESKTOP_BACKEND").ok().as_deref(),
|
let backend=select(std::env::var("UU_DESKTOP_BACKEND").ok().as_deref(),
|
||||||
std::env::var("XDG_SESSION_TYPE").ok().as_deref(),
|
std::env::var("XDG_SESSION_TYPE").ok().as_deref(),
|
||||||
|
|||||||
+15
-9
@@ -8,6 +8,7 @@ mod native {
|
|||||||
fn uu_desktop_power_wake() -> i32;
|
fn uu_desktop_power_wake() -> i32;
|
||||||
fn uu_desktop_idle_inhibitor_acquire(error: *mut i32) -> *mut c_void;
|
fn uu_desktop_idle_inhibitor_acquire(error: *mut i32) -> *mut c_void;
|
||||||
fn uu_desktop_idle_inhibitor_release(inhibitor: *mut c_void);
|
fn uu_desktop_idle_inhibitor_release(inhibitor: *mut c_void);
|
||||||
|
fn uu_desktop_screensaver_inhibitor_acquire(error: *mut i32) -> *mut c_void;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub struct Handle(NonNull<c_void>);
|
pub struct Handle(NonNull<c_void>);
|
||||||
@@ -16,9 +17,9 @@ mod native {
|
|||||||
unsafe impl Send for Handle {}
|
unsafe impl Send for Handle {}
|
||||||
|
|
||||||
impl Handle {
|
impl Handle {
|
||||||
pub fn acquire() -> Result<Self, String> {
|
pub fn acquire(gnome: bool) -> Result<Self, String> {
|
||||||
let mut error = 0;
|
let mut error = 0;
|
||||||
let pointer = unsafe { uu_desktop_idle_inhibitor_acquire(&mut error) };
|
let pointer = unsafe { if gnome { uu_desktop_idle_inhibitor_acquire(&mut error) } else { uu_desktop_screensaver_inhibitor_acquire(&mut error) } };
|
||||||
NonNull::new(pointer).map(Self).ok_or_else(|| super::error("idle inhibition", error))
|
NonNull::new(pointer).map(Self).ok_or_else(|| super::error("idle inhibition", error))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -50,7 +51,9 @@ pub fn wake() -> Result<(), String> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Holds a GNOME SessionManager idle-only inhibitor until dropped.
|
/// Holds an idle-only inhibitor until dropped: GNOME SessionManager on GNOME, the freedesktop
|
||||||
|
/// ScreenSaver interface on KDE (remote input through the portal does not count as activity
|
||||||
|
/// there, so the session locked mid-session, #61).
|
||||||
///
|
///
|
||||||
/// Acquire and drop perform blocking D-Bus work. Session-bus setup and each method call are
|
/// Acquire and drop perform blocking D-Bus work. Session-bus setup and each method call are
|
||||||
/// bounded to three seconds. Callers on an async runtime should move both operations to a
|
/// bounded to three seconds. Callers on an async runtime should move both operations to a
|
||||||
@@ -62,7 +65,8 @@ pub struct IdleInhibitor {
|
|||||||
|
|
||||||
impl IdleInhibitor {
|
impl IdleInhibitor {
|
||||||
pub fn acquire() -> Result<Self, String> {
|
pub fn acquire() -> Result<Self, String> {
|
||||||
if !gnome_portal_active() {
|
let kde = portal_desktop_is("kde");
|
||||||
|
if !gnome_portal_active() && !kde {
|
||||||
return Ok(Self {
|
return Ok(Self {
|
||||||
#[cfg(all(target_os = "linux", feature = "portal"))]
|
#[cfg(all(target_os = "linux", feature = "portal"))]
|
||||||
_handle: None,
|
_handle: None,
|
||||||
@@ -70,7 +74,7 @@ impl IdleInhibitor {
|
|||||||
}
|
}
|
||||||
#[cfg(all(target_os = "linux", feature = "portal"))]
|
#[cfg(all(target_os = "linux", feature = "portal"))]
|
||||||
{
|
{
|
||||||
native::Handle::acquire().map(|handle| Self { _handle: Some(handle) })
|
native::Handle::acquire(!kde).map(|handle| Self { _handle: Some(handle) })
|
||||||
}
|
}
|
||||||
#[cfg(not(all(target_os = "linux", feature = "portal")))]
|
#[cfg(not(all(target_os = "linux", feature = "portal")))]
|
||||||
{
|
{
|
||||||
@@ -79,10 +83,12 @@ impl IdleInhibitor {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn gnome_portal_active() -> bool {
|
fn gnome_portal_active() -> bool { portal_desktop_is("gnome") }
|
||||||
let gnome = std::env::var("XDG_CURRENT_DESKTOP").unwrap_or_default().split(':')
|
|
||||||
.any(|desktop| desktop.eq_ignore_ascii_case("gnome"));
|
fn portal_desktop_is(name: &str) -> bool {
|
||||||
gnome && crate::desktop_backend::detect().is_ok_and(|backend| backend == crate::desktop_backend::DesktopBackend::Portal)
|
let matches = std::env::var("XDG_CURRENT_DESKTOP").unwrap_or_default().split(':')
|
||||||
|
.any(|desktop| desktop.eq_ignore_ascii_case(name));
|
||||||
|
matches && crate::desktop_backend::detect().is_ok_and(|backend| backend == crate::desktop_backend::DesktopBackend::Portal)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(all(target_os = "linux", feature = "portal"))]
|
#[cfg(all(target_os = "linux", feature = "portal"))]
|
||||||
|
|||||||
+136
@@ -0,0 +1,136 @@
|
|||||||
|
//! `uuremote-server doctor`: one report with what an issue needs (session, backend, plugins,
|
||||||
|
//! input permission, encoders, config and service state), safe to paste publicly. It prints only
|
||||||
|
//! booleans, names and versions: no account ids, tokens, addresses, MACs or file contents, and the
|
||||||
|
//! home directory is shown as `~`.
|
||||||
|
|
||||||
|
fn redact(text: &str) -> String {
|
||||||
|
let mut out = text.to_owned();
|
||||||
|
if let Some(home) = std::env::var_os("HOME").and_then(|h| h.into_string().ok()).filter(|h| h.len() > 1) { out = out.replace(&home, "~"); }
|
||||||
|
if let Ok(user) = std::env::var("USER") { if user.len() > 2 { out = out.replace(&user, "<user>"); } }
|
||||||
|
out
|
||||||
|
}
|
||||||
|
|
||||||
|
fn env_state(name: &str) -> String {
|
||||||
|
match std::env::var(name) { Ok(v) if v.is_empty() => "set (empty)".into(), Ok(_) => "set".into(), Err(_) => "unset".into() }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn line(key: &str, value: impl std::fmt::Display) { println!("{key:<22} {}", redact(&value.to_string())); }
|
||||||
|
|
||||||
|
fn glibc() -> String {
|
||||||
|
#[cfg(all(target_os = "linux", target_env = "gnu"))]
|
||||||
|
{
|
||||||
|
extern "C" { fn gnu_get_libc_version() -> *const libc::c_char; }
|
||||||
|
return unsafe { std::ffi::CStr::from_ptr(gnu_get_libc_version()) }.to_string_lossy().into_owned();
|
||||||
|
}
|
||||||
|
#[allow(unreachable_code)]
|
||||||
|
"n/a".into()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn writable(path: &str) -> &'static str {
|
||||||
|
let Ok(c_path) = std::ffi::CString::new(path) else { return "invalid" };
|
||||||
|
if !std::path::Path::new(path).exists() { "missing" }
|
||||||
|
else if unsafe { libc::access(c_path.as_ptr(), libc::W_OK) } == 0 { "writable" } else { "no permission" }
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn command_output(program: &str, args: &[&str]) -> Option<String> {
|
||||||
|
let output = tokio::time::timeout(std::time::Duration::from_secs(5),
|
||||||
|
tokio::process::Command::new(program).args(args).kill_on_drop(true).output()).await.ok()?.ok()?;
|
||||||
|
Some(String::from_utf8_lossy(&output.stdout).trim().to_owned())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub async fn run() -> Result<(), String> {
|
||||||
|
use crate::desktop_backend as backend;
|
||||||
|
use crate::engine_plugin::{load, Engine};
|
||||||
|
// Info logs (e.g. plugin paths under the home directory) would bypass the redaction below.
|
||||||
|
log::set_max_level(log::LevelFilter::Warn);
|
||||||
|
println!("uu-remote-linux doctor (safe to paste: no ids, tokens, addresses or file contents)");
|
||||||
|
line("version", format!("v{} {}", env!("CARGO_PKG_VERSION"), std::env::consts::ARCH));
|
||||||
|
line("glibc", glibc());
|
||||||
|
let os = std::fs::read_to_string("/etc/os-release").ok()
|
||||||
|
.and_then(|t| t.lines().find_map(|l| l.strip_prefix("PRETTY_NAME=").map(|v| v.trim_matches('"').to_owned())));
|
||||||
|
line("os", os.unwrap_or_else(|| "unknown".into()));
|
||||||
|
let features: Vec<&str> = [("wayland", cfg!(feature = "wayland")), ("portal", cfg!(feature = "portal")),
|
||||||
|
("engine-plugins", cfg!(feature = "engine-plugins")), ("inproc-av", cfg!(feature = "inproc-av"))]
|
||||||
|
.into_iter().filter(|(_, on)| *on).map(|(name, _)| name).collect();
|
||||||
|
line("build features", if features.is_empty() { "default (X11 only)".to_owned() } else { features.join(", ") });
|
||||||
|
|
||||||
|
println!("-- session");
|
||||||
|
line("XDG_SESSION_TYPE", std::env::var("XDG_SESSION_TYPE").unwrap_or_else(|_| "unset".into()));
|
||||||
|
line("XDG_CURRENT_DESKTOP", std::env::var("XDG_CURRENT_DESKTOP").unwrap_or_else(|_| "unset".into()));
|
||||||
|
line("DISPLAY", env_state("DISPLAY"));
|
||||||
|
line("WAYLAND_DISPLAY", env_state("WAYLAND_DISPLAY"));
|
||||||
|
line("wayland running", backend::wayland_session_running());
|
||||||
|
line("UU_DESKTOP_BACKEND", std::env::var("UU_DESKTOP_BACKEND").unwrap_or_else(|_| "auto".into()));
|
||||||
|
let selected = backend::detect();
|
||||||
|
line("selected backend", match &selected { Ok(b) if backend::headless() => format!("none (headless, {b:?} unused)"), Ok(b) => format!("{b:?}"), Err(e) => format!("error: {e}") });
|
||||||
|
if selected.as_ref().is_ok_and(|b| *b == backend::DesktopBackend::X11) && backend::wayland_session_running() && !backend::headless() {
|
||||||
|
println!(" ! X11 backend inside a Wayland session: the picture will be black");
|
||||||
|
}
|
||||||
|
if cfg!(feature = "engine-plugins") {
|
||||||
|
for engine in [Engine::Wayland, Engine::Portal] {
|
||||||
|
line(engine.file(), match load(engine) { Ok(()) => "loaded".to_owned(), Err(e) => e });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
println!("-- input");
|
||||||
|
line("/dev/uinput", writable("/dev/uinput"));
|
||||||
|
line("UU_INPUT_BACKEND", std::env::var("UU_INPUT_BACKEND").unwrap_or_else(|_| "auto".into()));
|
||||||
|
|
||||||
|
println!("-- video");
|
||||||
|
let encoder = crate::video::Encoder::requested();
|
||||||
|
line("encoder", format!("{encoder:?} (UU_VIDEO_ENCODER={})", std::env::var("UU_VIDEO_ENCODER").unwrap_or_else(|_| "auto".into())));
|
||||||
|
line("default codec", format!("{:?}", crate::capture_setting::preferred_codec(true, true)));
|
||||||
|
let mut ffmpeg = crate::video::ffmpeg_command();
|
||||||
|
ffmpeg.args(["-hide_banner", "-encoders"]).kill_on_drop(true);
|
||||||
|
match tokio::time::timeout(std::time::Duration::from_secs(5), ffmpeg.output()).await {
|
||||||
|
Ok(Ok(output)) => {
|
||||||
|
let text = String::from_utf8_lossy(&output.stdout);
|
||||||
|
let found: Vec<&str> = ["libx264", "libx265", "h264_nvenc", "hevc_nvenc", "h264_vaapi", "hevc_vaapi"].into_iter()
|
||||||
|
.filter(|name| text.split_whitespace().any(|word| word == *name)).collect();
|
||||||
|
line("ffmpeg encoders", if found.is_empty() { "none of libx264/libx265/nvenc/vaapi".to_owned() } else { found.join(", ") });
|
||||||
|
}
|
||||||
|
_ => line("ffmpeg encoders", "ffmpeg not runnable (install ffmpeg or set ffmpeg_root)"),
|
||||||
|
}
|
||||||
|
let mut version = crate::video::ffmpeg_command();
|
||||||
|
version.arg("-version").kill_on_drop(true);
|
||||||
|
if let Ok(Ok(output)) = tokio::time::timeout(std::time::Duration::from_secs(5), version.output()).await {
|
||||||
|
line("ffmpeg version", String::from_utf8_lossy(&output.stdout).lines().next().unwrap_or("").split_whitespace().nth(2).unwrap_or("unknown"));
|
||||||
|
}
|
||||||
|
line("nvidia driver", std::path::Path::new("/proc/driver/nvidia/version").exists());
|
||||||
|
line("render node", writable(&std::env::var("UU_VAAPI_DEVICE").unwrap_or_else(|_| "/dev/dri/renderD128".into())));
|
||||||
|
|
||||||
|
println!("-- audio");
|
||||||
|
for tool in ["pactl", "pw-cli"] {
|
||||||
|
line(tool, command_output("sh", &["-c", &format!("command -v {tool} >/dev/null && echo found || echo missing")]).await.unwrap_or_else(|| "unknown".into()));
|
||||||
|
}
|
||||||
|
|
||||||
|
println!("-- account and service");
|
||||||
|
let path = crate::config::path();
|
||||||
|
line("config", path.display());
|
||||||
|
match std::fs::metadata(&path) {
|
||||||
|
Ok(meta) => {
|
||||||
|
use std::os::unix::fs::PermissionsExt;
|
||||||
|
line("config mode", format!("{:o}", meta.permissions().mode() & 0o777));
|
||||||
|
// Presence only: never read values out of the file.
|
||||||
|
let fields: Option<serde_json::Value> = std::fs::read(&path).ok().and_then(|b| serde_json::from_slice(&b).ok());
|
||||||
|
let has = |key: &str| fields.as_ref().and_then(|v| v.get(key)).is_some_and(|v| !v.is_null() && v.as_str() != Some(""));
|
||||||
|
line("signed in", has("token") && has("user_id"));
|
||||||
|
line("device registered", has("device_id"));
|
||||||
|
}
|
||||||
|
Err(_) => line("config mode", "missing (run `uuremote-server login`)"),
|
||||||
|
}
|
||||||
|
line("service", command_output("systemctl", &["--user", "is-active", "uuremote-native.service"]).await.unwrap_or_else(|| "systemctl unavailable".into()));
|
||||||
|
let running = command_output("pgrep", &["-c", "-x", "uuremote-server"]).await.filter(|n| !n.is_empty()).unwrap_or_else(|| "unknown".into());
|
||||||
|
line("uuremote-server procs", format!("{running} (including this one; more than 2 means duplicates)"));
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
#[test]
|
||||||
|
fn redaction_hides_home_and_user() {
|
||||||
|
let home = std::env::var("HOME").unwrap_or_default();
|
||||||
|
if home.len() > 1 { assert_eq!(super::redact(&format!("{home}/.config/x")), "~/.config/x"); }
|
||||||
|
assert_eq!(super::env_state("UU_DOCTOR_TEST_SURELY_UNSET"), "unset");
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -101,7 +101,9 @@ fn drain(encoder: &mut encoder::Video, packet: &mut Packet, units: &mpsc::Sender
|
|||||||
|
|
||||||
/// Opens the selected video encoder for `config`. Returns the encoder, its input pixel format and output size.
|
/// Opens the selected video encoder for `config`. Returns the encoder, its input pixel format and output size.
|
||||||
fn open_encoder(config: &Config) -> Result<(encoder::Video, Pixel, u32, u32), String> {
|
fn open_encoder(config: &Config) -> Result<(encoder::Video, Pixel, u32, u32), String> {
|
||||||
|
// H.264/HEVC 4:2:0 and NVENC need even dimensions; an odd native capture is padded (see run_damage).
|
||||||
let (width, height) = config.output.unwrap_or(config.input);
|
let (width, height) = config.output.unwrap_or(config.input);
|
||||||
|
let (width, height) = (width + width % 2, height + height % 2);
|
||||||
let codec = encoder::find_by_name(config.encoder.name_for(config.codec))
|
let codec = encoder::find_by_name(config.encoder.name_for(config.codec))
|
||||||
.ok_or_else(|| format!("{} is not available in this FFmpeg build", config.encoder.name_for(config.codec)))?;
|
.ok_or_else(|| format!("{} is not available in this FFmpeg build", config.encoder.name_for(config.codec)))?;
|
||||||
// Allocate for this codec so FFmpeg fills its defaults; libx264 rejects a context allocated without one.
|
// Allocate for this codec so FFmpeg fills its defaults; libx264 rejects a context allocated without one.
|
||||||
@@ -278,7 +280,11 @@ pub fn run(config: Config, units: mpsc::Sender<EncodedUnit>, stop: Arc<AtomicBoo
|
|||||||
fn run_damage(config: Config, mut capture: DamageCapture, units: mpsc::Sender<EncodedUnit>, stop: Arc<AtomicBool>, idr: Arc<AtomicBool>, budget: Arc<Semaphore>) -> Result<(), String> {
|
fn run_damage(config: Config, mut capture: DamageCapture, units: mpsc::Sender<EncodedUnit>, stop: Arc<AtomicBool>, idr: Arc<AtomicBool>, budget: Arc<Semaphore>) -> Result<(), String> {
|
||||||
let (mut encoder, pixel, width, height) = open_encoder(&config)?;
|
let (mut encoder, pixel, width, height) = open_encoder(&config)?;
|
||||||
let (cap_width, cap_height) = capture.size();
|
let (cap_width, cap_height) = capture.size();
|
||||||
let mut captured = frame::Video::new(Pixel::BGRZ, cap_width, cap_height);
|
// Native size uses the even encoder size. The extra row/column is never overwritten, so it stays black.
|
||||||
|
let native = config.output.is_none();
|
||||||
|
let (frame_width, frame_height) = if native { (width, height) } else { (cap_width, cap_height) };
|
||||||
|
let mut captured = frame::Video::new(Pixel::BGRZ, frame_width, frame_height);
|
||||||
|
if native { captured.data_mut(0).fill(0); }
|
||||||
let mut converted = frame::Video::empty();
|
let mut converted = frame::Video::empty();
|
||||||
let mut scaler = None;
|
let mut scaler = None;
|
||||||
let mut packet = Packet::empty();
|
let mut packet = Packet::empty();
|
||||||
@@ -324,11 +330,11 @@ fn run_damage(config: Config, mut capture: DamageCapture, units: mpsc::Sender<En
|
|||||||
let slot = slot.max(last_slot + 1);
|
let slot = slot.max(last_slot + 1);
|
||||||
last_slot = slot;
|
last_slot = slot;
|
||||||
|
|
||||||
let frame = if pixel == Pixel::BGRZ && width == cap_width && height == cap_height {
|
let frame = if pixel == Pixel::BGRZ && width == captured.width() && height == captured.height() {
|
||||||
&mut captured
|
&mut captured
|
||||||
} else {
|
} else {
|
||||||
if scaler.is_none() {
|
if scaler.is_none() {
|
||||||
scaler = Some(scaling::Context::get(Pixel::BGRZ, cap_width, cap_height, pixel, width, height, scaling::Flags::BILINEAR).map_err(text)?);
|
scaler = Some(scaling::Context::get(Pixel::BGRZ, captured.width(), captured.height(), pixel, width, height, scaling::Flags::BILINEAR).map_err(text)?);
|
||||||
}
|
}
|
||||||
if dirty {
|
if dirty {
|
||||||
if let Some(context) = scaler.as_mut() { context.run(&captured, &mut converted).map_err(text)?; }
|
if let Some(context) = scaler.as_mut() { context.run(&captured, &mut converted).map_err(text)?; }
|
||||||
|
|||||||
+30
-1
@@ -2,6 +2,8 @@
|
|||||||
//! Zero-Wine, Zero-Python, Single-Binary, 5 Native Tools Integrated
|
//! Zero-Wine, Zero-Python, Single-Binary, 5 Native Tools Integrated
|
||||||
|
|
||||||
mod engine_plugin;
|
mod engine_plugin;
|
||||||
|
mod doctor;
|
||||||
|
mod wol;
|
||||||
mod desktop_backend;
|
mod desktop_backend;
|
||||||
mod desktop_session;
|
mod desktop_session;
|
||||||
mod desktop_power;
|
mod desktop_power;
|
||||||
@@ -191,7 +193,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|||||||
.filter_module("uuremote_server", log::LevelFilter::Info).init();
|
.filter_module("uuremote_server", log::LevelFilter::Info).init();
|
||||||
} else { env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init(); }
|
} else { env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init(); }
|
||||||
// An unknown argument must never fall through to starting a second full host server.
|
// An unknown argument must never fall through to starting a second full host server.
|
||||||
const SUBCOMMANDS: [&str; 14] = ["show", "assist", "desktop-input-probe", "virtual-audio-probe", "login", "unlock-check", "desktop-probe", "desktop-video-probe", "desktop-audio-probe", "wayland-capture",
|
const SUBCOMMANDS: [&str; 15] = ["doctor", "show", "assist", "desktop-input-probe", "virtual-audio-probe", "login", "unlock-check", "desktop-probe", "desktop-video-probe", "desktop-audio-probe", "wayland-capture",
|
||||||
"wayland-input-probe", "wayland-text-probe", "clipboard-acceptance", "portal-acceptance"];
|
"wayland-input-probe", "wayland-text-probe", "clipboard-acceptance", "portal-acceptance"];
|
||||||
if let Some(arg) = std::env::args().nth(1).filter(|a| !SUBCOMMANDS.contains(&a.as_str())) {
|
if let Some(arg) = std::env::args().nth(1).filter(|a| !SUBCOMMANDS.contains(&a.as_str())) {
|
||||||
let usage = format!("usage: uuremote-server [{}]\n (no argument: run the host)", SUBCOMMANDS.join(" | "));
|
let usage = format!("usage: uuremote-server [{}]\n (no argument: run the host)", SUBCOMMANDS.join(" | "));
|
||||||
@@ -357,6 +359,9 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|||||||
if std::env::args().nth(1).as_deref() == Some("wayland-text-probe") {
|
if std::env::args().nth(1).as_deref() == Some("wayland-text-probe") {
|
||||||
return wayland::text_probe().map_err(|e|e.into());
|
return wayland::text_probe().map_err(|e|e.into());
|
||||||
}
|
}
|
||||||
|
if std::env::args().nth(1).as_deref() == Some("doctor") {
|
||||||
|
return doctor::run().await.map_err(|e| e.into());
|
||||||
|
}
|
||||||
if std::env::args().nth(1).as_deref() == Some("wayland-capture") {
|
if std::env::args().nth(1).as_deref() == Some("wayland-capture") {
|
||||||
return wayland::capture_stdout().map_err(|e| e.into());
|
return wayland::capture_stdout().map_err(|e| e.into());
|
||||||
}
|
}
|
||||||
@@ -410,6 +415,10 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|||||||
let _audio_cleanup=virtual_audio::Cleanup;
|
let _audio_cleanup=virtual_audio::Cleanup;
|
||||||
log::info!("Starting uu-remote-linux host v{}...", env!("CARGO_PKG_VERSION"));
|
log::info!("Starting uu-remote-linux host v{}...", env!("CARGO_PKG_VERSION"));
|
||||||
|
|
||||||
|
if !desktop_backend::headless() && desktop_backend::detect()? == desktop_backend::DesktopBackend::X11 && desktop_backend::wayland_session_running() {
|
||||||
|
// X11 capture inside a Wayland session reads XWayland's root window: all black, no error (#61).
|
||||||
|
log::warn!("A Wayland session is running but the X11 backend is selected: the picture will be black. Run inside the Wayland session (WAYLAND_DISPLAY set, UU_DESKTOP_BACKEND=auto) or log in to the Xorg session");
|
||||||
|
}
|
||||||
let capture = Arc::new((if desktop_backend::headless() {
|
let capture = Arc::new((if desktop_backend::headless() {
|
||||||
Err("headless mode (UU_DESKTOP_BACKEND=none)".to_owned())
|
Err("headless mode (UU_DESKTOP_BACKEND=none)".to_owned())
|
||||||
} else if desktop_backend::detect()?==desktop_backend::DesktopBackend::Portal {
|
} else if desktop_backend::detect()?==desktop_backend::DesktopBackend::Portal {
|
||||||
@@ -641,6 +650,11 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
|
|||||||
}
|
}
|
||||||
SignalingEvent::Connected => {
|
SignalingEvent::Connected => {
|
||||||
log::info!("Signaling handshake established.");
|
log::info!("Signaling handshake established.");
|
||||||
|
static WOL_REPORTED: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(false);
|
||||||
|
if wol::enabled() && assist.as_ref().is_none_or(|s| s.is_account()) && !WOL_REPORTED.swap(true, std::sync::atomic::Ordering::AcqRel) {
|
||||||
|
let client = auth.clone();
|
||||||
|
tokio::spawn(async move { wol::report(&client).await; });
|
||||||
|
}
|
||||||
}
|
}
|
||||||
SignalingEvent::RoomInfoAck(_) => { log::info!("RoomInfo acknowledged by NetEase server"); }
|
SignalingEvent::RoomInfoAck(_) => { log::info!("RoomInfo acknowledged by NetEase server"); }
|
||||||
SignalingEvent::DeviceInfoChanged(val) => {
|
SignalingEvent::DeviceInfoChanged(val) => {
|
||||||
@@ -650,6 +664,21 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
|
|||||||
log::debug!("Assist bmsg_push shape: type={:?} keys={:?} data_keys={:?}",
|
log::debug!("Assist bmsg_push shape: type={:?} keys={:?} data_keys={:?}",
|
||||||
val.get("type").and_then(serde_json::Value::as_str), keys(Some(&val)), keys(val.get("data")));
|
val.get("type").and_then(serde_json::Value::as_str), keys(Some(&val)), keys(val.get("data")));
|
||||||
}
|
}
|
||||||
|
if val.get("type").and_then(serde_json::Value::as_str) == Some("wake_on_lan") {
|
||||||
|
// Key names only: the target carries a MAC and LAN address.
|
||||||
|
let data = val.get("data").unwrap_or(&val);
|
||||||
|
log::info!("wake_on_lan push received: keys={:?} target_keys={:?} helper_enabled={}",
|
||||||
|
data.as_object().map(|o| o.keys().cloned().collect::<Vec<_>>()).unwrap_or_default(),
|
||||||
|
data.get("target_device").and_then(|t| t.as_object()).map(|o| o.keys().cloned().collect::<Vec<_>>()).unwrap_or_default(),
|
||||||
|
wol::enabled());
|
||||||
|
if wol::enabled() {
|
||||||
|
match wol::handle_push(data) {
|
||||||
|
Ok(sent) => log::info!("WOL helper: magic packet sent ({sent} datagrams)"),
|
||||||
|
Err(error) => log::warn!("WOL helper: {error}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
continue;
|
||||||
|
}
|
||||||
if val.get("type").and_then(serde_json::Value::as_str) == Some("get_control_mode") {
|
if val.get("type").and_then(serde_json::Value::as_str) == Some("get_control_mode") {
|
||||||
if let Some(s) = assist.as_mut() {
|
if let Some(s) = assist.as_mut() {
|
||||||
match s.control_mode(val.get("data").unwrap_or(&serde_json::Value::Null)).await {
|
match s.control_mode(val.get("data").unwrap_or(&serde_json::Value::Null)).await {
|
||||||
|
|||||||
@@ -92,6 +92,8 @@ pub fn watch_locked() -> watch::Receiver<Option<bool>> {
|
|||||||
if locked.is_none() { session = None; } // session ended or changed: look it up again
|
if locked.is_none() { session = None; } // session ended or changed: look it up again
|
||||||
sender.send_if_modified(|current| if *current != locked {
|
sender.send_if_modified(|current| if *current != locked {
|
||||||
log::info!("Desktop lock state: {}", match locked { Some(true) => "locked", Some(false) => "unlocked", None => "unknown" });
|
log::info!("Desktop lock state: {}", match locked { Some(true) => "locked", Some(false) => "unlocked", None => "unknown" });
|
||||||
|
// The viewer only sees black frames while locked and gives no hint (#61).
|
||||||
|
if locked == Some(true) { log::info!("Desktop is locked: viewers see a black screen until it is unlocked (viewer 自动解锁被控端, or `loginctl unlock-session` on the host)"); }
|
||||||
*current = locked; true
|
*current = locked; true
|
||||||
} else { false });
|
} else { false });
|
||||||
std::thread::sleep(Duration::from_secs(1));
|
std::thread::sleep(Duration::from_secs(1));
|
||||||
|
|||||||
+123
@@ -0,0 +1,123 @@
|
|||||||
|
//! Experimental Wake-on-LAN helper (`UU_WOL_HELPER=1`, off by default).
|
||||||
|
//!
|
||||||
|
//! The official Windows host (GameViewerServer: LoginManager::reportLanInfo, PushMessageHandler::wakeOnLan,
|
||||||
|
//! wake_on_lan.cpp host::send_wol) reports its LAN address to `api-ipv4…/api/v1/device/wake_on_lan/info`
|
||||||
|
//! after sign-in (logged as "mac / ip / subnet_mask", response carries `turn_on_wol`), and on a
|
||||||
|
//! `wake_on_lan` cloud push with a `target_device` {mac, ip, subnet_mask} it sends a magic packet to that
|
||||||
|
//! subnet's broadcast address, waking another PC of the account on the same LAN. The exact request and
|
||||||
|
//! push field names come from the official log strings only; nothing here is verified end to end yet.
|
||||||
|
//! Addresses are sent to NetEase only when the helper is enabled and are never logged.
|
||||||
|
|
||||||
|
use std::net::{Ipv4Addr, SocketAddrV4, UdpSocket};
|
||||||
|
|
||||||
|
pub fn enabled() -> bool { std::env::var("UU_WOL_HELPER").is_ok_and(|v| v == "1") }
|
||||||
|
|
||||||
|
/// `aa:bb:cc:dd:ee:ff` / `aa-bb-…` / `aabbcc…` → 6 bytes.
|
||||||
|
pub fn parse_mac(text: &str) -> Option<[u8; 6]> {
|
||||||
|
let hex: String = text.chars().filter(|c| c.is_ascii_hexdigit()).collect();
|
||||||
|
if hex.len() != 12 || text.chars().any(|c| !(c.is_ascii_hexdigit() || matches!(c, ':' | '-' | '.'))) { return None; }
|
||||||
|
let mut mac = [0u8; 6];
|
||||||
|
for (i, byte) in mac.iter_mut().enumerate() { *byte = u8::from_str_radix(&hex[i * 2..i * 2 + 2], 16).ok()?; }
|
||||||
|
(mac != [0; 6] && mac != [0xff; 6]).then_some(mac)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Six 0xFF bytes followed by the MAC sixteen times.
|
||||||
|
pub fn magic_packet(mac: [u8; 6]) -> Vec<u8> {
|
||||||
|
let mut packet = vec![0xff; 6];
|
||||||
|
for _ in 0..16 { packet.extend_from_slice(&mac); }
|
||||||
|
packet
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Directed broadcast of `ip`/`mask`, or None when either is missing or invalid.
|
||||||
|
pub fn subnet_broadcast(ip: &str, mask: &str) -> Option<Ipv4Addr> {
|
||||||
|
let (ip, mask): (Ipv4Addr, Ipv4Addr) = (ip.parse().ok()?, mask.parse().ok()?);
|
||||||
|
let mask = u32::from(mask);
|
||||||
|
if mask == 0 || mask.leading_ones() + mask.trailing_zeros() != 32 { return None; }
|
||||||
|
Some(Ipv4Addr::from(u32::from(ip) | !mask))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Handles a `wake_on_lan` push payload; returns how many datagrams were sent.
|
||||||
|
pub fn handle_push(data: &serde_json::Value) -> Result<usize, String> {
|
||||||
|
let target = data.get("target_device").or_else(|| data.get("data").and_then(|d| d.get("target_device")))
|
||||||
|
.ok_or("wake_on_lan push without target_device")?;
|
||||||
|
let text = |key: &str| target.get(key).and_then(serde_json::Value::as_str).unwrap_or("");
|
||||||
|
let mac = parse_mac(text("mac")).ok_or("wake_on_lan target has no valid mac")?;
|
||||||
|
let packet = magic_packet(mac);
|
||||||
|
let socket = UdpSocket::bind("0.0.0.0:0").map_err(|e| format!("WOL socket: {}", e.kind()))?;
|
||||||
|
socket.set_broadcast(true).map_err(|e| format!("WOL broadcast: {}", e.kind()))?;
|
||||||
|
let mut targets = vec![Ipv4Addr::BROADCAST];
|
||||||
|
if let Some(directed) = subnet_broadcast(text("ip"), text("subnet_mask")) { targets.insert(0, directed); }
|
||||||
|
let mut sent = 0;
|
||||||
|
for address in targets { for port in [9, 7] {
|
||||||
|
if socket.send_to(&packet, SocketAddrV4::new(address, port)).is_ok() { sent += 1; }
|
||||||
|
} }
|
||||||
|
if sent == 0 { return Err("WOL packet could not be sent".into()); }
|
||||||
|
Ok(sent)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// This host's LAN identity on the default IPv4 route: (mac, ip, subnet mask).
|
||||||
|
#[cfg(target_os = "linux")]
|
||||||
|
pub fn lan_info() -> Option<(String, String, String)> {
|
||||||
|
let routes = std::fs::read_to_string("/proc/net/route").ok()?;
|
||||||
|
let iface = routes.lines().skip(1).map(|l| l.split_whitespace().collect::<Vec<_>>())
|
||||||
|
.find(|f| f.len() > 2 && f[1] == "00000000")?.first()?.to_string();
|
||||||
|
let mac = std::fs::read_to_string(format!("/sys/class/net/{iface}/address")).ok()?.trim().to_owned();
|
||||||
|
parse_mac(&mac)?;
|
||||||
|
let mut addrs: *mut libc::ifaddrs = std::ptr::null_mut();
|
||||||
|
if unsafe { libc::getifaddrs(&mut addrs) } != 0 { return None; }
|
||||||
|
let mut result = None;
|
||||||
|
let mut cursor = addrs;
|
||||||
|
while !cursor.is_null() {
|
||||||
|
let entry = unsafe { &*cursor };
|
||||||
|
cursor = entry.ifa_next;
|
||||||
|
if entry.ifa_addr.is_null() || entry.ifa_netmask.is_null() { continue; }
|
||||||
|
let name = unsafe { std::ffi::CStr::from_ptr(entry.ifa_name) }.to_string_lossy();
|
||||||
|
if name != iface.as_str() || i32::from(unsafe { (*entry.ifa_addr).sa_family }) != libc::AF_INET { continue; }
|
||||||
|
let v4 = |p: *mut libc::sockaddr| Ipv4Addr::from(u32::from_be(unsafe { (*(p as *const libc::sockaddr_in)).sin_addr.s_addr }));
|
||||||
|
result = Some((mac.clone(), v4(entry.ifa_addr).to_string(), v4(entry.ifa_netmask).to_string()));
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
unsafe { libc::freeifaddrs(addrs) };
|
||||||
|
result
|
||||||
|
}
|
||||||
|
#[cfg(not(target_os = "linux"))]
|
||||||
|
pub fn lan_info() -> Option<(String, String, String)> { None }
|
||||||
|
|
||||||
|
/// Report this host's LAN identity like the official host after sign-in.
|
||||||
|
pub async fn report(auth: &crate::auth::UUAuthClient) {
|
||||||
|
let Some((mac, ip, subnet_mask)) = lan_info() else { log::warn!("WOL helper: no IPv4 default-route interface"); return; };
|
||||||
|
let body = serde_json::json!({ "mac": mac, "ip": ip, "subnet_mask": subnet_mask });
|
||||||
|
match auth.post_json_url("https://api-ipv4.nrd.nie.163.com", "/api/v1/device/wake_on_lan/info", &body).await {
|
||||||
|
Ok((status, value)) => log::info!("WOL helper: LAN info reported: status={status} code={:?} turn_on_wol={:?}",
|
||||||
|
value.get("code").and_then(serde_json::Value::as_i64),
|
||||||
|
value.get("data").and_then(|d| d.get("turn_on_wol")).or_else(|| value.get("turn_on_wol"))),
|
||||||
|
Err(error) => log::warn!("WOL helper: LAN info report failed: {error}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
#[test]
|
||||||
|
fn mac_parsing_and_packet() {
|
||||||
|
assert_eq!(parse_mac("AA:bb:cc:dd:ee:01"), Some([0xaa, 0xbb, 0xcc, 0xdd, 0xee, 1]));
|
||||||
|
assert_eq!(parse_mac("aa-bb-cc-dd-ee-01"), parse_mac("aabbccddee01"));
|
||||||
|
assert!(parse_mac("aa:bb:cc").is_none() && parse_mac("zz:bb:cc:dd:ee:01").is_none() && parse_mac("00:00:00:00:00:00").is_none());
|
||||||
|
let packet = magic_packet([1, 2, 3, 4, 5, 6]);
|
||||||
|
assert_eq!(packet.len(), 102);
|
||||||
|
assert_eq!(&packet[..6], &[0xff; 6]);
|
||||||
|
assert_eq!(&packet[96..], &[1, 2, 3, 4, 5, 6]);
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn directed_broadcast() {
|
||||||
|
assert_eq!(subnet_broadcast("192.168.2.29", "255.255.255.0"), Some(Ipv4Addr::new(192, 168, 2, 255)));
|
||||||
|
assert_eq!(subnet_broadcast("10.1.2.3", "255.255.0.0"), Some(Ipv4Addr::new(10, 1, 255, 255)));
|
||||||
|
assert_eq!(subnet_broadcast("10.1.2.3", "255.0.255.0"), None);
|
||||||
|
assert_eq!(subnet_broadcast("", "255.255.255.0"), None);
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn push_without_target_is_rejected() {
|
||||||
|
assert!(handle_push(&serde_json::json!({})).is_err());
|
||||||
|
assert!(handle_push(&serde_json::json!({"target_device": {"mac": "nope"}})).is_err());
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in new issue
Block a user