Compare commits
1 Commits
dane/sqlit
...
feature/me
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dafbbab2ed |
4
.github/FUNDING.yml
vendored
4
.github/FUNDING.yml
vendored
@@ -1,2 +1,2 @@
|
|||||||
github: [ DaneEveritt ]
|
github: [DaneEveritt]
|
||||||
custom: [ "https://paypal.me/PterodactylSoftware" ]
|
custom: ["https://paypal.me/PterodactylSoftware"]
|
||||||
|
|||||||
42
.github/workflows/build-test.yml
vendored
42
.github/workflows/build-test.yml
vendored
@@ -2,17 +2,17 @@ name: Run Tests
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- develop
|
- 'develop'
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- develop
|
- 'develop'
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
os: [ ubuntu-20.04 ]
|
os: [ ubuntu-20.04 ]
|
||||||
go: [ '^1.17' ]
|
go: [ '^1.15', '^1.16' ]
|
||||||
goos: [ linux ]
|
goos: [ linux ]
|
||||||
goarch: [ amd64, arm64 ]
|
goarch: [ amd64, arm64 ]
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
@@ -32,20 +32,17 @@ jobs:
|
|||||||
go env
|
go env
|
||||||
printf "\n\nSystem Environment:\n\n"
|
printf "\n\nSystem Environment:\n\n"
|
||||||
env
|
env
|
||||||
printf "Git Version: $(git version)\n\n"
|
|
||||||
echo "::set-output name=version_tag::${GITHUB_REF/refs\/tags\//}"
|
echo "::set-output name=version_tag::${GITHUB_REF/refs\/tags\//}"
|
||||||
echo "::set-output name=short_sha::$(git rev-parse --short HEAD)"
|
echo "::set-output name=short_sha::$(git rev-parse --short HEAD)"
|
||||||
echo "::set-output name=go_cache::$(go env GOCACHE)"
|
echo "::set-output name=go_cache::$(go env GOCACHE)"
|
||||||
echo "::set-output name=go_mod_cache::$(go env GOMODCACHE)"
|
|
||||||
- name: Build Cache
|
- name: Build Cache
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v2
|
||||||
with:
|
with:
|
||||||
key: ${{ runner.os }}-go${{ matrix.go }}-${{ hashFiles('**/go.sum') }}
|
path: ${{ steps.env.outputs.go_cache }}
|
||||||
|
key: ${{ runner.os }}-${{ matrix.go }}-go-${{ hashFiles('**/go.sum') }}
|
||||||
restore-keys: |
|
restore-keys: |
|
||||||
${{ runner.os }}-go${{ matrix.go }}-
|
${{ runner.os }}-${{ matrix.go }}-go
|
||||||
path: |
|
|
||||||
${{ steps.env.outputs.go_cache }}
|
|
||||||
${{ steps.env.outputs.go_mod_cache }}
|
|
||||||
- name: Get Dependencies
|
- name: Get Dependencies
|
||||||
run: |
|
run: |
|
||||||
go get -v -t -d ./...
|
go get -v -t -d ./...
|
||||||
@@ -56,21 +53,14 @@ jobs:
|
|||||||
CGO_ENABLED: 0
|
CGO_ENABLED: 0
|
||||||
SRC_PATH: github.com/pterodactyl/wings
|
SRC_PATH: github.com/pterodactyl/wings
|
||||||
run: |
|
run: |
|
||||||
go build -v -trimpath -ldflags="-s -w -X ${SRC_PATH}/system.Version=dev-${GIT_COMMIT:0:7}" -o build/wings_${GOOS}_${GOARCH} wings.go
|
go build -v -trimpath -ldflags="-s -w -X ${SRC_PATH}/system.Version=dev-${GIT_COMMIT:0:7}" -o build/wings_${{ matrix.goos }}_${{ matrix.goarch }} wings.go
|
||||||
go build -v -trimpath -ldflags="-X ${SRC_PATH}/system.Version=dev-${GIT_COMMIT:0:7}" -o build/wings_${GOOS}_${GOARCH}_debug wings.go
|
upx build/wings_${{ matrix.goos }}_${{ matrix.goarch }}
|
||||||
upx build/wings_${GOOS}_${{ matrix.goarch }}
|
chmod +x build/wings_${{ matrix.goos }}_${{ matrix.goarch }}
|
||||||
chmod +x build/*
|
- name: Test
|
||||||
- name: Tests
|
run: go test ./...
|
||||||
run: go test -race ./...
|
- name: Upload Artifact
|
||||||
- name: Upload Release Artifact
|
|
||||||
uses: actions/upload-artifact@v2
|
uses: actions/upload-artifact@v2
|
||||||
if: ${{ github.ref == 'refs/heads/develop' || github.event_name == 'pull_request' }}
|
if: ${{ matrix.go == '^1.15' && (github.ref == 'refs/heads/develop' || github.event_name == 'pull_request') }}
|
||||||
with:
|
with:
|
||||||
name: wings_linux_${{ matrix.goarch }}
|
name: wings_${{ matrix.goos }}_${{ matrix.goarch }}
|
||||||
path: build/wings_linux_${{ matrix.goarch }}
|
path: build/wings_${{ matrix.goos }}_${{ matrix.goarch }}
|
||||||
- name: Upload Debug Artifact
|
|
||||||
uses: actions/upload-artifact@v2
|
|
||||||
if: ${{ github.ref == 'refs/heads/develop' || github.event_name == 'pull_request' }}
|
|
||||||
with:
|
|
||||||
name: wings_linux_${{ matrix.goarch }}_debug
|
|
||||||
path: build/wings_linux_${{ matrix.goarch }}_debug
|
|
||||||
|
|||||||
23
.github/workflows/codeql-analysis.yml
vendored
23
.github/workflows/codeql-analysis.yml
vendored
@@ -2,29 +2,30 @@ name: CodeQL
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- develop
|
- 'develop'
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- develop
|
- 'develop'
|
||||||
schedule:
|
schedule:
|
||||||
- cron: '0 9 * * 4'
|
- cron: '0 9 * * 4'
|
||||||
jobs:
|
jobs:
|
||||||
analyze:
|
analyze:
|
||||||
name: Analyze
|
name: Analyze
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-20.04
|
||||||
permissions:
|
|
||||||
actions: read
|
|
||||||
contents: read
|
|
||||||
security-events: write
|
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
language: [ 'go' ]
|
language:
|
||||||
|
- go
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- name: Code Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
- name: Checkout Head
|
||||||
|
run: git checkout HEAD^2
|
||||||
|
if: ${{ github.event_name == 'pull_request' }}
|
||||||
- name: Initialize CodeQL
|
- name: Initialize CodeQL
|
||||||
uses: github/codeql-action/init@v1
|
uses: github/codeql-action/init@v1
|
||||||
with:
|
with:
|
||||||
languages: ${{ matrix.language }}
|
languages: ${{ matrix.language }}
|
||||||
- uses: github/codeql-action/autobuild@v1
|
- name: Perform CodeQL Analysis
|
||||||
- uses: github/codeql-action/analyze@v1
|
uses: github/codeql-action/analyze@v1
|
||||||
|
|||||||
7
.github/workflows/docker.yml
vendored
7
.github/workflows/docker.yml
vendored
@@ -2,7 +2,8 @@ name: Publish Docker Image
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- develop
|
- 'develop'
|
||||||
|
|
||||||
tags:
|
tags:
|
||||||
- 'v*'
|
- 'v*'
|
||||||
jobs:
|
jobs:
|
||||||
@@ -34,7 +35,7 @@ jobs:
|
|||||||
- name: Get Build Information
|
- name: Get Build Information
|
||||||
id: build_info
|
id: build_info
|
||||||
run: |
|
run: |
|
||||||
echo "::set-output name=version_tag::${GITHUB_REF/refs\/tags\/v/}"
|
echo "::set-output name=version_tag::${GITHUB_REF/refs\/tags\//}"
|
||||||
echo "::set-output name=short_sha::$(git rev-parse --short HEAD)"
|
echo "::set-output name=short_sha::$(git rev-parse --short HEAD)"
|
||||||
- name: Release Production Build
|
- name: Release Production Build
|
||||||
uses: docker/build-push-action@v2
|
uses: docker/build-push-action@v2
|
||||||
@@ -43,7 +44,6 @@ jobs:
|
|||||||
build-args: |
|
build-args: |
|
||||||
VERSION=${{ steps.build_info.outputs.version_tag }}
|
VERSION=${{ steps.build_info.outputs.version_tag }}
|
||||||
labels: ${{ steps.docker_meta.outputs.labels }}
|
labels: ${{ steps.docker_meta.outputs.labels }}
|
||||||
platforms: linux/amd64,linux/arm64
|
|
||||||
push: true
|
push: true
|
||||||
tags: ${{ steps.docker_meta.outputs.tags }}
|
tags: ${{ steps.docker_meta.outputs.tags }}
|
||||||
- name: Release Development Build
|
- name: Release Development Build
|
||||||
@@ -53,6 +53,5 @@ jobs:
|
|||||||
build-args: |
|
build-args: |
|
||||||
VERSION=dev-${{ steps.build_info.outputs.short_sha }}
|
VERSION=dev-${{ steps.build_info.outputs.short_sha }}
|
||||||
labels: ${{ steps.docker_meta.outputs.labels }}
|
labels: ${{ steps.docker_meta.outputs.labels }}
|
||||||
platforms: linux/amd64,linux/arm64
|
|
||||||
push: ${{ github.event_name != 'pull_request' }}
|
push: ${{ github.event_name != 'pull_request' }}
|
||||||
tags: ${{ steps.docker_meta.outputs.tags }}
|
tags: ${{ steps.docker_meta.outputs.tags }}
|
||||||
|
|||||||
4
.github/workflows/release.yml
vendored
4
.github/workflows/release.yml
vendored
@@ -11,7 +11,7 @@ jobs:
|
|||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
- uses: actions/setup-go@v2
|
- uses: actions/setup-go@v2
|
||||||
with:
|
with:
|
||||||
go-version: '^1.17'
|
go-version: '^1.15'
|
||||||
- name: Build
|
- name: Build
|
||||||
env:
|
env:
|
||||||
REF: ${{ github.ref }}
|
REF: ${{ github.ref }}
|
||||||
@@ -45,7 +45,7 @@ jobs:
|
|||||||
git config --local user.name "Pterodactyl CI"
|
git config --local user.name "Pterodactyl CI"
|
||||||
git checkout -b $BRANCH
|
git checkout -b $BRANCH
|
||||||
git push -u origin $BRANCH
|
git push -u origin $BRANCH
|
||||||
sed -i "s/var Version = \".*\"/var Version = \"${REF:11}\"/" system/const.go
|
sed -i "s/ Version = \".*\"/ Version = \"${REF:11}\"/" system/const.go
|
||||||
git add system/const.go
|
git add system/const.go
|
||||||
git commit -m "bump version for release"
|
git commit -m "bump version for release"
|
||||||
git push
|
git push
|
||||||
|
|||||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -49,4 +49,3 @@ debug
|
|||||||
.DS_Store
|
.DS_Store
|
||||||
*.pprof
|
*.pprof
|
||||||
*.pdf
|
*.pdf
|
||||||
pprof.*
|
|
||||||
140
CHANGELOG.md
140
CHANGELOG.md
@@ -1,145 +1,5 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## v1.6.4
|
|
||||||
### Fixed
|
|
||||||
* Fixes a bug causing CPU limiting to not be properly applied to servers.
|
|
||||||
* Fixes a bug causing zip archives to decompress without taking into account nested folder structures.
|
|
||||||
|
|
||||||
## v1.6.3
|
|
||||||
### Fixed
|
|
||||||
* Fixes SFTP authentication failing for administrative users due to a permissions adjustment on the Panel.
|
|
||||||
|
|
||||||
## v1.6.2
|
|
||||||
### Fixed
|
|
||||||
* Fixes file upload size not being properly enforced.
|
|
||||||
* Fixes a bug that prevented listing a directory when it contained a named pipe. Also added a check to prevent attempting to read a named pipe directly.
|
|
||||||
* Fixes a bug with the archiver logic that would include folders that had the same name prefix. (for example, requesting only `map` would also include `map2` and `map3`)
|
|
||||||
* Requests to the Panel that return a client error (4xx response code) no longer trigger an exponential backoff, they immediately stop the request.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
* CPU limit fields are only set on the Docker container if they have been specified for the server — otherwise they are left empty.
|
|
||||||
|
|
||||||
### Added
|
|
||||||
* Added the ability to define the location of the temporary folder used by Wings — defaults to `/tmp/pterodactyl`.
|
|
||||||
* Adds the ability to authenticate for SFTP using public keys (requires `Panel@1.8.0`).
|
|
||||||
|
|
||||||
## v1.6.1
|
|
||||||
### Fixed
|
|
||||||
* Fixes error that would sometimes occur when starting a server that would cause the temporary power action lock to never be released due to a blocked channel.
|
|
||||||
* Fixes a bug causing the CPU usage of Wings to get stuck at 100% when a server is deleted while the installation process is running.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
* Cleans up a lot of the logic for handling events between the server and environment process to make it easier to make modifications to down the road.
|
|
||||||
* Cleans up logic handling the `StopAndWait` logic for stopping a server gracefully before terminating the process if it does not respond.
|
|
||||||
|
|
||||||
## v1.6.0
|
|
||||||
### Fixed
|
|
||||||
* Internal logic for processing a server start event has been adjusted to attach to the Docker container before attempting to start the container. This should fix issues where a server would get stuck after pulling the container image.
|
|
||||||
* Fixes a bug in the console output that was dropping console lines when a large number of lines were sent at once.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
* Removed the console throttle logic that would terminate a server instance that was sending too much data. This logic has been replaced with simpler logic that only throttles the console, it does not try to terminate the server. In addition, this change has reduced the number of go-routines needed by the application and dramatically simplified internal logic.
|
|
||||||
* Removed the `--profiler` flag and replaced it with `--pprof` which will start an internal server listening on `localhost:6060` allowing you to use Go's standard `pprof` tooling.
|
|
||||||
* Replaced the `json` log driver for Docker containers with `local` to reduce the amount of overhead when it comes to streaming logs from instances.
|
|
||||||
|
|
||||||
## v1.5.6
|
|
||||||
### Fixed
|
|
||||||
* Rewrote handler logic for the power actions lock to hopefully address issues people have been having when a server crashes and they're unable to start it again until restarting Wings.
|
|
||||||
* Fixes files uploaded with SFTP not being owned by the Pterodactyl user.
|
|
||||||
* Fixes excessive memory usage when large lines are sent through the console event handler.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
* Replaced usage of `encoding/json` throughout the codebase with a more performant encoder (`goccy/go-json`) to hopefully improve overall performance for JSON operations.
|
|
||||||
* Added custom `ContainerInspect` function to handle direct calls to Docker's CLI and make use of the new JSON encoder logic. This should reduce the total number of memory allocations and be more performant overall in a hot pathway.
|
|
||||||
|
|
||||||
## v1.5.5
|
|
||||||
### Fixed
|
|
||||||
* Fixes sending to a closed channel when sending server logs over the websocket
|
|
||||||
* Fixes `wings diagnostics` uploading no content
|
|
||||||
* Fixes a panic caused by the event bus closing channels multiple times when a server is deleted
|
|
||||||
|
|
||||||
## v1.5.4
|
|
||||||
### Fixed
|
|
||||||
* Fixes SSL paths being improperly converted to lowercase in environments where the path is case-sensitive.
|
|
||||||
* Fixes a memory leak due to the implemention of server event processing.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
* Selecting to redact information now redacts URLs from the log output when running the diagnostic command.
|
|
||||||
|
|
||||||
### Added
|
|
||||||
* Adds support for modifying the default memory overhead percentages in environments where the shipped values are not adequate.
|
|
||||||
* Adds support for sending the `Access-Control-Request-Private-Network` header in environments where Wings will be accessed over a private network. This is defaulted to `off`.
|
|
||||||
|
|
||||||
## v1.5.3
|
|
||||||
### Fixed
|
|
||||||
* Fixes improper event registration and error handling during socket authentication that would cause the incorrect error message to be returned to the client, or no error in some scenarios. Event registration is now delayed until the socket is fully authenticated to ensure needless listeners are not registed.
|
|
||||||
* Fixes dollar signs always being evaluated as environment variables with no way to escape them. They can now be escaped as `$$` which will transform into a single dollar sign.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
* A websocket connection to a server will be closed by Wings if there is a send error encountered and the client will be left to handle reconnections, rather than simply logging the error and continuing to listen for new events.
|
|
||||||
|
|
||||||
## v1.5.2
|
|
||||||
### Fixed
|
|
||||||
* Fixes servers not properly re-syncing with the Panel if they are already running causing them to be hard-stopped when terminated, rather than stopped with the configured action.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
* Changes SFTP server implementation to use ED25519 server keys rather than deprecated SHA1 RSA keys.
|
|
||||||
|
|
||||||
### Added
|
|
||||||
* Adds server uptime output in the stats event emitted to the websocket.
|
|
||||||
|
|
||||||
## v1.5.1
|
|
||||||
### Added
|
|
||||||
* Global configuration option for toggling server crash detection (`system.crash_detection.enabled`)
|
|
||||||
* RPM specfile
|
|
||||||
|
|
||||||
## v1.5.0
|
|
||||||
### Fixed
|
|
||||||
* Fixes a race condition when setting the application name in the console output for a server.
|
|
||||||
* Fixes a server being reinstalled causing the `file_denylist` parameter for an Egg to be ignored until Wings is restarted.
|
|
||||||
* Fixes YAML file parser not correctly setting boolean values.
|
|
||||||
* Fixes potential issue where the underlying websocket connection is closed but the parent request context is not yet canceled causing a write over a closed connection.
|
|
||||||
* Fixes race condition when closing all active websocket connections when a server is deleted.
|
|
||||||
* Fixes logic to determine if a server's context is closed out and send a websocket close message to connected clients. Previously this fired off whenever the request itself was closed, and not when the server context was closed.
|
|
||||||
|
|
||||||
### Added
|
|
||||||
* Exposes `8080` in the default Docker setup to better support proxy tools.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
* Releases are now built using `Go 1.17` — the minimum version required to build Wings remains `Go 1.16`.
|
|
||||||
* Simplifed the logic powering server updates to only pull information from the Panel rather than trying to accept updated values. All parts of Wings needing the most up-to-date server details should call `Server#Sync()` to fetch the latest stored build information.
|
|
||||||
* `Installer#New()` no longer requires passing all of the server data as a byte slice, rather a new `Installer#ServerDetails` struct is exposed which can be passed and accepts a UUID and if the server should be started after the installer finishes.
|
|
||||||
|
|
||||||
### Removed
|
|
||||||
* Removes complicated (and unused) logic during the server installation process that was a hold-over from legacy Wings architectures.
|
|
||||||
* Removes the `PATCH /api/servers/:server` endpoint — if you were previously using this API call it should be replaced with `POST /api/servers/:server/sync`.
|
|
||||||
|
|
||||||
## v1.4.7
|
|
||||||
### Fixed
|
|
||||||
* SFTP access is now properly denied if a server is suspended.
|
|
||||||
* Correctly uses `start_on_completion` and `crash_detection_enabled` for servers.
|
|
||||||
|
|
||||||
## v1.4.6
|
|
||||||
### Fixed
|
|
||||||
* Environment variable starting with the same prefix no longer get merged into a single environment variable value (skipping all but the first).
|
|
||||||
* The `start_on_completion` flag for server installs will now properly start the server.
|
|
||||||
* Fixes socket files unintentionally causing backups to be aborted.
|
|
||||||
* Files extracted from a backup now have their preior mode properly set on the restored files, rather than defaulting to 0644.
|
|
||||||
* Fixes logrotate issues due to a bad user configuration on some systems.
|
|
||||||
|
|
||||||
### Updated
|
|
||||||
* The minimum Go version required to compile Wings is now `go1.16`.
|
|
||||||
|
|
||||||
### Deprecated
|
|
||||||
> Both of these deprecations will be removed in `Wings@2.0.0`.
|
|
||||||
|
|
||||||
* The `Server.Id()` method has been deprecated in favor of `Server.ID()`.
|
|
||||||
* The `directory` field on the `/api/servers/:server/files/pull` endpoint is deprecated and should be updated to use `root` instead for consistency with other endpoints.
|
|
||||||
|
|
||||||
## v1.4.5
|
|
||||||
### Changed
|
|
||||||
* Upped the process limit for a container from `256` to `512` in order to address edge-cases for some games that spawn a lot of processes.
|
|
||||||
|
|
||||||
## v1.4.4
|
## v1.4.4
|
||||||
### Added
|
### Added
|
||||||
* **[security]** Adds support for limiting the total number of pids any one container can have active at once to prevent malicious users from impacting other instances on the same node.
|
* **[security]** Adds support for limiting the total number of pids any one container can have active at once to prevent malicious users from impacting other instances on the same node.
|
||||||
|
|||||||
17
Dockerfile
17
Dockerfile
@@ -1,25 +1,22 @@
|
|||||||
# Stage 1 (Build)
|
# Stage 1 (Build)
|
||||||
FROM golang:1.17-alpine AS builder
|
FROM golang:1.15-alpine3.12 AS builder
|
||||||
|
|
||||||
ARG VERSION
|
ARG VERSION
|
||||||
RUN apk add --update --no-cache git make
|
RUN apk add --update --no-cache git make upx
|
||||||
WORKDIR /app/
|
WORKDIR /app/
|
||||||
COPY go.mod go.sum /app/
|
COPY go.mod go.sum /app/
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
COPY . /app/
|
COPY . /app/
|
||||||
RUN CGO_ENABLED=0 go build \
|
RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build \
|
||||||
-ldflags="-s -w -X github.com/pterodactyl/wings/system.Version=$VERSION" \
|
-ldflags="-s -w -X github.com/pterodactyl/wings/system.Version=$VERSION" \
|
||||||
-v \
|
-v \
|
||||||
-trimpath \
|
-trimpath \
|
||||||
-o wings \
|
-o wings \
|
||||||
wings.go
|
wings.go
|
||||||
RUN echo "ID=\"distroless\"" > /etc/os-release
|
RUN upx wings
|
||||||
|
|
||||||
# Stage 2 (Final)
|
# Stage 2 (Final)
|
||||||
FROM gcr.io/distroless/static:latest
|
FROM busybox:1.33.0
|
||||||
COPY --from=builder /etc/os-release /etc/os-release
|
RUN echo "ID=\"busybox\"" > /etc/os-release
|
||||||
|
|
||||||
COPY --from=builder /app/wings /usr/bin/
|
COPY --from=builder /app/wings /usr/bin/
|
||||||
CMD [ "/usr/bin/wings", "--config", "/etc/pterodactyl/config.yml" ]
|
CMD [ "wings", "--config", "/etc/pterodactyl/config.yml" ]
|
||||||
|
|
||||||
EXPOSE 8080
|
|
||||||
|
|||||||
4
Makefile
4
Makefile
@@ -5,8 +5,8 @@ build:
|
|||||||
GOOS=linux GOARCH=arm64 go build -ldflags="-s -w" -gcflags "all=-trimpath=$(pwd)" -o build/wings_linux_arm64 -v wings.go
|
GOOS=linux GOARCH=arm64 go build -ldflags="-s -w" -gcflags "all=-trimpath=$(pwd)" -o build/wings_linux_arm64 -v wings.go
|
||||||
|
|
||||||
debug:
|
debug:
|
||||||
go build -ldflags="-X github.com/pterodactyl/wings/system.Version=$(GIT_HEAD)"
|
go build -ldflags="-X github.com/pterodactyl/wings/system.Version=$(GIT_HEAD)" -race
|
||||||
sudo ./wings --debug --ignore-certificate-errors --config config.yml --pprof --pprof-block-rate 1
|
sudo ./wings --debug --ignore-certificate-errors --config config.yml
|
||||||
|
|
||||||
# Runs a remotly debuggable session for Wings allowing an IDE to connect and target
|
# Runs a remotly debuggable session for Wings allowing an IDE to connect and target
|
||||||
# different breakpoints.
|
# different breakpoints.
|
||||||
|
|||||||
16
README.md
16
README.md
@@ -19,17 +19,19 @@ I would like to extend my sincere thanks to the following sponsors for helping f
|
|||||||
| Company | About |
|
| Company | About |
|
||||||
| ------- | ----- |
|
| ------- | ----- |
|
||||||
| [**WISP**](https://wisp.gg) | Extra features. |
|
| [**WISP**](https://wisp.gg) | Extra features. |
|
||||||
|
| [**MixmlHosting**](https://mixmlhosting.com) | MixmlHosting provides high quality Virtual Private Servers along with game servers, all at a affordable price. |
|
||||||
| [**BisectHosting**](https://www.bisecthosting.com/) | BisectHosting provides Minecraft, Valheim and other server hosting services with the highest reliability and lightning fast support since 2012. |
|
| [**BisectHosting**](https://www.bisecthosting.com/) | BisectHosting provides Minecraft, Valheim and other server hosting services with the highest reliability and lightning fast support since 2012. |
|
||||||
| [**Fragnet**](https://fragnet.net) | Providing low latency, high-end game hosting solutions to gamers, game studios and eSports platforms. |
|
|
||||||
| [**Tempest**](https://tempest.net/) | Tempest Hosting is a subsidiary of Path Network, Inc. offering unmetered DDoS protected 10Gbps dedicated servers, starting at just $80/month. Full anycast, tons of filters. |
|
|
||||||
| [**Bloom.host**](https://bloom.host) | Bloom.host offers dedicated core VPS and Minecraft hosting with Ryzen 9 processors. With owned-hardware, we offer truly unbeatable prices on high-performance hosting. |
|
| [**Bloom.host**](https://bloom.host) | Bloom.host offers dedicated core VPS and Minecraft hosting with Ryzen 9 processors. With owned-hardware, we offer truly unbeatable prices on high-performance hosting. |
|
||||||
| [**MineStrator**](https://minestrator.com/) | Looking for the most highend French hosting company for your minecraft server? More than 24,000 members on our discord trust us. Give us a try! |
|
| [**MineStrator**](https://minestrator.com/) | Looking for a French highend hosting company for you minecraft server? More than 14,000 members on our discord, trust us. |
|
||||||
|
| [**DedicatedMC**](https://dedicatedmc.io/) | DedicatedMC provides Raw Power hosting at affordable pricing, making sure to never compromise on your performance and giving you the best performance money can buy. |
|
||||||
| [**Skynode**](https://www.skynode.pro/) | Skynode provides blazing fast game servers along with a top-notch user experience. Whatever our clients are looking for, we're able to provide it! |
|
| [**Skynode**](https://www.skynode.pro/) | Skynode provides blazing fast game servers along with a top-notch user experience. Whatever our clients are looking for, we're able to provide it! |
|
||||||
|
| [**XCORE**](https://xcore-server.de/) | XCORE offers High-End Servers for hosting and gaming since 2012. Fast, excellent and well-known for eSports Gaming. |
|
||||||
|
| [**RoyaleHosting**](https://royalehosting.net/) | Build your dreams and deploy them with RoyaleHosting’s reliable servers and network. Easy to use, provisioned in a couple of minutes. |
|
||||||
|
| [**Spill Hosting**](https://spillhosting.no/) | Spill Hosting is a Norwegian hosting service, which aims for inexpensive services on quality servers. Premium i9-9900K processors will run your game like a dream. |
|
||||||
| [**DeinServerHost**](https://deinserverhost.de/) | DeinServerHost offers Dedicated, vps and Gameservers for many popular Games like Minecraft and Rust in Germany since 2013. |
|
| [**DeinServerHost**](https://deinserverhost.de/) | DeinServerHost offers Dedicated, vps and Gameservers for many popular Games like Minecraft and Rust in Germany since 2013. |
|
||||||
| [**Aussie Server Hosts**](https://aussieserverhosts.com/) | No frills Australian Owned and operated High Performance Server hosting for some of the most demanding games serving Australia and New Zealand. |
|
| [**HostBend**](https://hostbend.com/) | HostBend offers a variety of solutions for developers, students, and others who have a tight budget but don't want to compromise quality and support. |
|
||||||
| [**HostEZ**](https://hostez.io) | Providing North America Valheim, Minecraft and other popular games with low latency, high uptime and maximum availability. EZ! |
|
| [**Capitol Hosting Solutions**](https://capitolsolutions.cloud/) | CHS is *the* budget friendly hosting company for Australian and American gamers, offering a variety of plans from Web Hosting to Game Servers; Custom Solutions too! |
|
||||||
| [**VibeGAMES**](https://vibegames.net/) | VibeGAMES is a game server provider that specializes in DDOS protection for the games we offer. We have multiple locations in the US, Brazil, France, Germany, Singapore, Australia and South Africa.|
|
| [**ByteAnia**](https://byteania.com/?utm_source=pterodactyl) | ByteAnia offers the best performing and most affordable **Ryzen 5000 Series hosting** on the market for *unbeatable prices*! |
|
||||||
| [**Gamenodes**](https://gamenodes.nl) | Gamenodes love quality. For Minecraft, Discord Bots and other services, among others. With our own programmers, we provide just that little bit of extra service! |
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
* [Panel Documentation](https://pterodactyl.io/panel/1.0/getting_started.html)
|
* [Panel Documentation](https://pterodactyl.io/panel/1.0/getting_started.html)
|
||||||
|
|||||||
@@ -2,8 +2,9 @@ package cmd
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"crypto/tls"
|
"crypto/tls"
|
||||||
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io/ioutil"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
"os"
|
"os"
|
||||||
@@ -13,20 +14,20 @@ import (
|
|||||||
|
|
||||||
"github.com/AlecAivazis/survey/v2"
|
"github.com/AlecAivazis/survey/v2"
|
||||||
"github.com/AlecAivazis/survey/v2/terminal"
|
"github.com/AlecAivazis/survey/v2/terminal"
|
||||||
"github.com/goccy/go-json"
|
|
||||||
"github.com/spf13/cobra"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
)
|
)
|
||||||
|
|
||||||
var configureArgs struct {
|
var (
|
||||||
|
configureArgs struct {
|
||||||
PanelURL string
|
PanelURL string
|
||||||
Token string
|
Token string
|
||||||
ConfigPath string
|
ConfigPath string
|
||||||
Node string
|
Node string
|
||||||
Override bool
|
Override bool
|
||||||
AllowInsecure bool
|
AllowInsecure bool
|
||||||
}
|
}
|
||||||
|
)
|
||||||
|
|
||||||
var nodeIdRegex = regexp.MustCompile(`^(\d+)$`)
|
var nodeIdRegex = regexp.MustCompile(`^(\d+)$`)
|
||||||
|
|
||||||
@@ -138,13 +139,13 @@ func configureCmdRun(cmd *cobra.Command, args []string) {
|
|||||||
fmt.Println("The authentication credentials provided were not valid.")
|
fmt.Println("The authentication credentials provided were not valid.")
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
} else if res.StatusCode != http.StatusOK {
|
} else if res.StatusCode != http.StatusOK {
|
||||||
b, _ := io.ReadAll(res.Body)
|
b, _ := ioutil.ReadAll(res.Body)
|
||||||
|
|
||||||
fmt.Println("An error occurred while processing this request.\n", string(b))
|
fmt.Println("An error occurred while processing this request.\n", string(b))
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
b, err := io.ReadAll(res.Body)
|
b, err := ioutil.ReadAll(res.Body)
|
||||||
|
|
||||||
cfg, err := config.NewAtPath(configPath)
|
cfg, err := config.NewAtPath(configPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -2,9 +2,11 @@ package cmd
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
"io/ioutil"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
@@ -19,27 +21,25 @@ import (
|
|||||||
"github.com/docker/docker/api/types"
|
"github.com/docker/docker/api/types"
|
||||||
"github.com/docker/docker/pkg/parsers/kernel"
|
"github.com/docker/docker/pkg/parsers/kernel"
|
||||||
"github.com/docker/docker/pkg/parsers/operatingsystem"
|
"github.com/docker/docker/pkg/parsers/operatingsystem"
|
||||||
"github.com/goccy/go-json"
|
|
||||||
"github.com/spf13/cobra"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
"github.com/pterodactyl/wings/loggers/cli"
|
"github.com/pterodactyl/wings/loggers/cli"
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const DefaultHastebinUrl = "https://ptero.co"
|
||||||
DefaultHastebinUrl = "https://ptero.co"
|
const DefaultLogLines = 200
|
||||||
DefaultLogLines = 200
|
|
||||||
)
|
|
||||||
|
|
||||||
var diagnosticsArgs struct {
|
var (
|
||||||
|
diagnosticsArgs struct {
|
||||||
IncludeEndpoints bool
|
IncludeEndpoints bool
|
||||||
IncludeLogs bool
|
IncludeLogs bool
|
||||||
ReviewBeforeUpload bool
|
ReviewBeforeUpload bool
|
||||||
HastebinURL string
|
HastebinURL string
|
||||||
LogLines int
|
LogLines int
|
||||||
}
|
}
|
||||||
|
)
|
||||||
|
|
||||||
func newDiagnosticsCommand() *cobra.Command {
|
func newDiagnosticsCommand() *cobra.Command {
|
||||||
command := &cobra.Command{
|
command := &cobra.Command{
|
||||||
@@ -78,7 +78,7 @@ func diagnosticsCmdRun(cmd *cobra.Command, args []string) {
|
|||||||
{
|
{
|
||||||
Name: "ReviewBeforeUpload",
|
Name: "ReviewBeforeUpload",
|
||||||
Prompt: &survey.Confirm{
|
Prompt: &survey.Confirm{
|
||||||
Message: "Do you want to review the collected data before uploading to " + diagnosticsArgs.HastebinURL + "?",
|
Message: "Do you want to review the collected data before uploading to hastebin.com?",
|
||||||
Help: "The data, especially the logs, might contain sensitive information, so you should review it. You will be asked again if you want to upload.",
|
Help: "The data, especially the logs, might contain sensitive information, so you should review it. You will be asked again if you want to upload.",
|
||||||
Default: true,
|
Default: true,
|
||||||
},
|
},
|
||||||
@@ -96,12 +96,12 @@ func diagnosticsCmdRun(cmd *cobra.Command, args []string) {
|
|||||||
output := &strings.Builder{}
|
output := &strings.Builder{}
|
||||||
fmt.Fprintln(output, "Pterodactyl Wings - Diagnostics Report")
|
fmt.Fprintln(output, "Pterodactyl Wings - Diagnostics Report")
|
||||||
printHeader(output, "Versions")
|
printHeader(output, "Versions")
|
||||||
fmt.Fprintln(output, " Wings:", system.Version)
|
fmt.Fprintln(output, " wings:", system.Version)
|
||||||
if dockerErr == nil {
|
if dockerErr == nil {
|
||||||
fmt.Fprintln(output, " Docker:", dockerVersion.Version)
|
fmt.Fprintln(output, "Docker:", dockerVersion.Version)
|
||||||
}
|
}
|
||||||
if v, err := kernel.GetKernelVersion(); err == nil {
|
if v, err := kernel.GetKernelVersion(); err == nil {
|
||||||
fmt.Fprintln(output, " Kernel:", v)
|
fmt.Fprintln(output, "Kernel:", v)
|
||||||
}
|
}
|
||||||
if os, err := operatingsystem.GetOperatingSystem(); err == nil {
|
if os, err := operatingsystem.GetOperatingSystem(); err == nil {
|
||||||
fmt.Fprintln(output, " OS:", os)
|
fmt.Fprintln(output, " OS:", os)
|
||||||
@@ -109,6 +109,7 @@ func diagnosticsCmdRun(cmd *cobra.Command, args []string) {
|
|||||||
|
|
||||||
printHeader(output, "Wings Configuration")
|
printHeader(output, "Wings Configuration")
|
||||||
if err := config.FromFile(config.DefaultLocation); err != nil {
|
if err := config.FromFile(config.DefaultLocation); err != nil {
|
||||||
|
|
||||||
}
|
}
|
||||||
cfg := config.Get()
|
cfg := config.Get()
|
||||||
fmt.Fprintln(output, " Panel Location:", redact(cfg.PanelLocation))
|
fmt.Fprintln(output, " Panel Location:", redact(cfg.PanelLocation))
|
||||||
@@ -179,17 +180,6 @@ func diagnosticsCmdRun(cmd *cobra.Command, args []string) {
|
|||||||
fmt.Fprintln(output, "Logs redacted.")
|
fmt.Fprintln(output, "Logs redacted.")
|
||||||
}
|
}
|
||||||
|
|
||||||
if !diagnosticsArgs.IncludeEndpoints {
|
|
||||||
s := output.String()
|
|
||||||
output.Reset()
|
|
||||||
s = strings.ReplaceAll(s, cfg.PanelLocation, "{redacted}")
|
|
||||||
s = strings.ReplaceAll(s, cfg.Api.Host, "{redacted}")
|
|
||||||
s = strings.ReplaceAll(s, cfg.Api.Ssl.CertificateFile, "{redacted}")
|
|
||||||
s = strings.ReplaceAll(s, cfg.Api.Ssl.KeyFile, "{redacted}")
|
|
||||||
s = strings.ReplaceAll(s, cfg.System.Sftp.Address, "{redacted}")
|
|
||||||
output.WriteString(s)
|
|
||||||
}
|
|
||||||
|
|
||||||
fmt.Println("\n--------------- generated report ---------------")
|
fmt.Println("\n--------------- generated report ---------------")
|
||||||
fmt.Println(output.String())
|
fmt.Println(output.String())
|
||||||
fmt.Print("--------------- end of report ---------------\n\n")
|
fmt.Print("--------------- end of report ---------------\n\n")
|
||||||
@@ -235,7 +225,7 @@ func uploadToHastebin(hbUrl, content string) (string, error) {
|
|||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
pres := make(map[string]interface{})
|
pres := make(map[string]interface{})
|
||||||
body, err := io.ReadAll(res.Body)
|
body, err := ioutil.ReadAll(res.Body)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Println("Failed to parse response.", err)
|
fmt.Println("Failed to parse response.", err)
|
||||||
return "", err
|
return "", err
|
||||||
|
|||||||
128
cmd/root.go
128
cmd/root.go
@@ -1,19 +1,15 @@
|
|||||||
package cmd
|
package cmd
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
|
||||||
"crypto/tls"
|
"crypto/tls"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"github.com/pterodactyl/wings/internal/cron"
|
"github.com/pterodactyl/wings/metrics"
|
||||||
"github.com/pterodactyl/wings/internal/database"
|
|
||||||
log2 "log"
|
log2 "log"
|
||||||
"net/http"
|
"net/http"
|
||||||
_ "net/http/pprof"
|
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"runtime"
|
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
@@ -24,10 +20,7 @@ import (
|
|||||||
"github.com/docker/docker/client"
|
"github.com/docker/docker/client"
|
||||||
"github.com/gammazero/workerpool"
|
"github.com/gammazero/workerpool"
|
||||||
"github.com/mitchellh/colorstring"
|
"github.com/mitchellh/colorstring"
|
||||||
"github.com/spf13/cobra"
|
"github.com/pkg/profile"
|
||||||
"golang.org/x/crypto/acme"
|
|
||||||
"golang.org/x/crypto/acme/autocert"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
"github.com/pterodactyl/wings/loggers/cli"
|
"github.com/pterodactyl/wings/loggers/cli"
|
||||||
@@ -36,6 +29,9 @@ import (
|
|||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
"github.com/pterodactyl/wings/sftp"
|
"github.com/pterodactyl/wings/sftp"
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
"golang.org/x/crypto/acme"
|
||||||
|
"golang.org/x/crypto/acme/autocert"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
@@ -45,7 +41,7 @@ var (
|
|||||||
|
|
||||||
var rootCommand = &cobra.Command{
|
var rootCommand = &cobra.Command{
|
||||||
Use: "wings",
|
Use: "wings",
|
||||||
Short: "Runs the API server allowing programmatic control of game servers for Pterodactyl Panel.",
|
Short: "Runs the API server allowing programatic control of game servers for Pterodactyl Panel.",
|
||||||
PreRun: func(cmd *cobra.Command, args []string) {
|
PreRun: func(cmd *cobra.Command, args []string) {
|
||||||
initConfig()
|
initConfig()
|
||||||
initLogging()
|
initLogging()
|
||||||
@@ -78,9 +74,7 @@ func init() {
|
|||||||
rootCommand.PersistentFlags().BoolVar(&debug, "debug", false, "pass in order to run wings in debug mode")
|
rootCommand.PersistentFlags().BoolVar(&debug, "debug", false, "pass in order to run wings in debug mode")
|
||||||
|
|
||||||
// Flags specifically used when running the API.
|
// Flags specifically used when running the API.
|
||||||
rootCommand.Flags().Bool("pprof", false, "if the pprof profiler should be enabled. The profiler will bind to localhost:6060 by default")
|
rootCommand.Flags().String("profiler", "", "the profiler to run for this instance")
|
||||||
rootCommand.Flags().Int("pprof-block-rate", 0, "enables block profile support, may have performance impacts")
|
|
||||||
rootCommand.Flags().Int("pprof-port", 6060, "If provided with --pprof, the port it will run on")
|
|
||||||
rootCommand.Flags().Bool("auto-tls", false, "pass in order to have wings generate and manage it's own SSL certificates using Let's Encrypt")
|
rootCommand.Flags().Bool("auto-tls", false, "pass in order to have wings generate and manage it's own SSL certificates using Let's Encrypt")
|
||||||
rootCommand.Flags().String("tls-hostname", "", "required with --auto-tls, the FQDN for the generated SSL certificate")
|
rootCommand.Flags().String("tls-hostname", "", "required with --auto-tls, the FQDN for the generated SSL certificate")
|
||||||
rootCommand.Flags().Bool("ignore-certificate-errors", false, "ignore certificate verification errors when executing API calls")
|
rootCommand.Flags().Bool("ignore-certificate-errors", false, "ignore certificate verification errors when executing API calls")
|
||||||
@@ -91,6 +85,25 @@ func init() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func rootCmdRun(cmd *cobra.Command, _ []string) {
|
func rootCmdRun(cmd *cobra.Command, _ []string) {
|
||||||
|
switch cmd.Flag("profiler").Value.String() {
|
||||||
|
case "cpu":
|
||||||
|
defer profile.Start(profile.CPUProfile).Stop()
|
||||||
|
case "mem":
|
||||||
|
defer profile.Start(profile.MemProfile).Stop()
|
||||||
|
case "alloc":
|
||||||
|
defer profile.Start(profile.MemProfile, profile.MemProfileAllocs()).Stop()
|
||||||
|
case "heap":
|
||||||
|
defer profile.Start(profile.MemProfile, profile.MemProfileHeap()).Stop()
|
||||||
|
case "routines":
|
||||||
|
defer profile.Start(profile.GoroutineProfile).Stop()
|
||||||
|
case "mutex":
|
||||||
|
defer profile.Start(profile.MutexProfile).Stop()
|
||||||
|
case "threads":
|
||||||
|
defer profile.Start(profile.ThreadcreationProfile).Stop()
|
||||||
|
case "block":
|
||||||
|
defer profile.Start(profile.BlockProfile).Stop()
|
||||||
|
}
|
||||||
|
|
||||||
printLogo()
|
printLogo()
|
||||||
log.Debug("running in debug mode")
|
log.Debug("running in debug mode")
|
||||||
log.WithField("config_file", configPath).Info("loading configuration from file")
|
log.WithField("config_file", configPath).Info("loading configuration from file")
|
||||||
@@ -110,6 +123,11 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
log.WithField("error", err).Fatal("failed to configure system directories for pterodactyl")
|
log.WithField("error", err).Fatal("failed to configure system directories for pterodactyl")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
if err := config.EnableLogRotation(); err != nil {
|
||||||
|
log.WithField("error", err).Fatal("failed to configure log rotation on the system")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
log.WithField("username", config.Get().System.User).Info("checking for pterodactyl system user")
|
log.WithField("username", config.Get().System.User).Info("checking for pterodactyl system user")
|
||||||
if err := config.EnsurePterodactylUser(); err != nil {
|
if err := config.EnsurePterodactylUser(); err != nil {
|
||||||
log.WithField("error", err).Fatal("failed to create pterodactyl system user")
|
log.WithField("error", err).Fatal("failed to create pterodactyl system user")
|
||||||
@@ -119,10 +137,9 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
"uid": config.Get().System.User.Uid,
|
"uid": config.Get().System.User.Uid,
|
||||||
"gid": config.Get().System.User.Gid,
|
"gid": config.Get().System.User.Gid,
|
||||||
}).Info("configured system user successfully")
|
}).Info("configured system user successfully")
|
||||||
if err := config.EnableLogRotation(); err != nil {
|
|
||||||
log.WithField("error", err).Fatal("failed to configure log rotation on the system")
|
done := make(chan bool)
|
||||||
return
|
go metrics.Initialize(done)
|
||||||
}
|
|
||||||
|
|
||||||
pclient := remote.New(
|
pclient := remote.New(
|
||||||
config.Get().PanelLocation,
|
config.Get().PanelLocation,
|
||||||
@@ -132,10 +149,6 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
}),
|
}),
|
||||||
)
|
)
|
||||||
|
|
||||||
if err := database.Initialize(); err != nil {
|
|
||||||
log.WithField("error", err).Fatal("failed to initialize database")
|
|
||||||
}
|
|
||||||
|
|
||||||
manager, err := server.NewManager(cmd.Context(), pclient)
|
manager, err := server.NewManager(cmd.Context(), pclient)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.WithField("error", err).Fatal("failed to load server configurations")
|
log.WithField("error", err).Fatal("failed to load server configurations")
|
||||||
@@ -151,7 +164,7 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
|
|
||||||
// Just for some nice log output.
|
// Just for some nice log output.
|
||||||
for _, s := range manager.All() {
|
for _, s := range manager.All() {
|
||||||
log.WithField("server", s.ID()).Info("finished loading configuration for server")
|
log.WithField("server", s.Id()).Info("finished loading configuration for server")
|
||||||
}
|
}
|
||||||
|
|
||||||
states, err := manager.ReadStates()
|
states, err := manager.ReadStates()
|
||||||
@@ -190,27 +203,23 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if states[s.Id()] == environment.ProcessRunningState {
|
||||||
|
metrics.ServerStatus.WithLabelValues(s.Id()).Set(1)
|
||||||
|
} else {
|
||||||
|
metrics.ServerStatus.WithLabelValues(s.Id()).Set(0)
|
||||||
|
}
|
||||||
|
|
||||||
pool.Submit(func() {
|
pool.Submit(func() {
|
||||||
s.Log().Info("configuring server environment and restoring to previous state")
|
s.Log().Info("configuring server environment and restoring to previous state")
|
||||||
var st string
|
var st string
|
||||||
if state, exists := states[s.ID()]; exists {
|
if state, exists := states[s.Id()]; exists {
|
||||||
st = state
|
st = state
|
||||||
}
|
}
|
||||||
|
|
||||||
// Use a timed context here to avoid booting issues where Docker hangs for a
|
r, err := s.Environment.IsRunning()
|
||||||
// specific container that would cause Wings to be un-bootable until the entire
|
|
||||||
// machine is rebooted. It is much better for us to just have a single failed
|
|
||||||
// server instance than an entire offline node.
|
|
||||||
//
|
|
||||||
// @see https://github.com/pterodactyl/panel/issues/2475
|
|
||||||
// @see https://github.com/pterodactyl/panel/issues/3358
|
|
||||||
ctx, cancel := context.WithTimeout(cmd.Context(), time.Second*30)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
r, err := s.Environment.IsRunning(ctx)
|
|
||||||
// We ignore missing containers because we don't want to actually block booting of wings at this
|
// We ignore missing containers because we don't want to actually block booting of wings at this
|
||||||
// point. If we didn't do this, and you pruned all the images and then started wings you could
|
// point. If we didn't do this and you pruned all of the images and then started wings you could
|
||||||
// end up waiting a long period of time for all the images to be re-pulled on Wings boot rather
|
// end up waiting a long period of time for all of the images to be re-pulled on Wings boot rather
|
||||||
// than when the server itself is started.
|
// than when the server itself is started.
|
||||||
if err != nil && !client.IsErrNotFound(err) {
|
if err != nil && !client.IsErrNotFound(err) {
|
||||||
s.Log().WithField("error", err).Error("error checking server environment status")
|
s.Log().WithField("error", err).Error("error checking server environment status")
|
||||||
@@ -236,7 +245,7 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
s.Log().Info("detected server is running, re-attaching to process...")
|
s.Log().Info("detected server is running, re-attaching to process...")
|
||||||
|
|
||||||
s.Environment.SetState(environment.ProcessRunningState)
|
s.Environment.SetState(environment.ProcessRunningState)
|
||||||
if err := s.Environment.Attach(ctx); err != nil {
|
if err := s.Environment.Attach(); err != nil {
|
||||||
s.Log().WithField("error", err).Warn("failed to attach to running server environment")
|
s.Log().WithField("error", err).Warn("failed to attach to running server environment")
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
@@ -245,33 +254,19 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
// state being tracked.
|
// state being tracked.
|
||||||
s.Environment.SetState(environment.ProcessOfflineState)
|
s.Environment.SetState(environment.ProcessOfflineState)
|
||||||
}
|
}
|
||||||
|
|
||||||
if state := s.Environment.State(); state == environment.ProcessStartingState || state == environment.ProcessRunningState {
|
|
||||||
s.Log().Debug("re-syncing server configuration for already running server")
|
|
||||||
if err := s.Sync(); err != nil {
|
|
||||||
s.Log().WithError(err).Error("failed to re-sync server configuration")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// Wait until all the servers are ready to go before we fire up the SFTP and HTTP servers.
|
// Wait until all of the servers are ready to go before we fire up the SFTP and HTTP servers.
|
||||||
pool.StopWait()
|
pool.StopWait()
|
||||||
defer func() {
|
defer func() {
|
||||||
// Cancel the context on all the running servers at this point, even though the
|
// Cancel the context on all of the running servers at this point, even though the
|
||||||
// program is just shutting down.
|
// program is just shutting down.
|
||||||
for _, s := range manager.All() {
|
for _, s := range manager.All() {
|
||||||
s.CtxCancel()
|
s.CtxCancel()
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
if s, err := cron.Scheduler(cmd.Context(), manager); err != nil {
|
|
||||||
log.WithField("error", err).Fatal("failed to initialize cron system")
|
|
||||||
} else {
|
|
||||||
log.WithField("subsystem", "cron").Info("starting cron processes")
|
|
||||||
s.StartAsync()
|
|
||||||
}
|
|
||||||
|
|
||||||
go func() {
|
go func() {
|
||||||
// Run the SFTP server.
|
// Run the SFTP server.
|
||||||
if err := sftp.New(manager).Run(); err != nil {
|
if err := sftp.New(manager).Run(); err != nil {
|
||||||
@@ -282,7 +277,7 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
|
|
||||||
go func() {
|
go func() {
|
||||||
log.Info("updating server states on Panel: marking installing/restoring servers as normal")
|
log.Info("updating server states on Panel: marking installing/restoring servers as normal")
|
||||||
// Update all the servers on the Panel to be in a valid state if they're
|
// Update all of the servers on the Panel to be in a valid state if they're
|
||||||
// currently marked as installing/restoring now that Wings is restarted.
|
// currently marked as installing/restoring now that Wings is restarted.
|
||||||
if err := pclient.ResetServersState(cmd.Context()); err != nil {
|
if err := pclient.ResetServersState(cmd.Context()); err != nil {
|
||||||
log.WithField("error", err).Error("failed to reset server states on Panel: some instances may be stuck in an installing/restoring state unexpectedly")
|
log.WithField("error", err).Error("failed to reset server states on Panel: some instances may be stuck in an installing/restoring state unexpectedly")
|
||||||
@@ -291,12 +286,12 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
|
|
||||||
sys := config.Get().System
|
sys := config.Get().System
|
||||||
// Ensure the archive directory exists.
|
// Ensure the archive directory exists.
|
||||||
if err := os.MkdirAll(sys.ArchiveDirectory, 0o755); err != nil {
|
if err := os.MkdirAll(sys.ArchiveDirectory, 0755); err != nil {
|
||||||
log.WithField("error", err).Error("failed to create archive directory")
|
log.WithField("error", err).Error("failed to create archive directory")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Ensure the backup directory exists.
|
// Ensure the backup directory exists.
|
||||||
if err := os.MkdirAll(sys.BackupDirectory, 0o755); err != nil {
|
if err := os.MkdirAll(sys.BackupDirectory, 0755); err != nil {
|
||||||
log.WithField("error", err).Error("failed to create backup directory")
|
log.WithField("error", err).Error("failed to create backup directory")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -322,20 +317,6 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
TLSConfig: config.DefaultTLSConfig,
|
TLSConfig: config.DefaultTLSConfig,
|
||||||
}
|
}
|
||||||
|
|
||||||
profile, _ := cmd.Flags().GetBool("pprof")
|
|
||||||
if profile {
|
|
||||||
if r, _ := cmd.Flags().GetInt("pprof-block-rate"); r > 0 {
|
|
||||||
runtime.SetBlockProfileRate(r)
|
|
||||||
}
|
|
||||||
// Catch at least 1% of mutex contention issues.
|
|
||||||
runtime.SetMutexProfileFraction(100)
|
|
||||||
|
|
||||||
profilePort, _ := cmd.Flags().GetInt("pprof-port")
|
|
||||||
go func() {
|
|
||||||
http.ListenAndServe(fmt.Sprintf("localhost:%d", profilePort), nil)
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check if the server should run with TLS but using autocert.
|
// Check if the server should run with TLS but using autocert.
|
||||||
if autotls {
|
if autotls {
|
||||||
m := autocert.Manager{
|
m := autocert.Manager{
|
||||||
@@ -366,7 +347,7 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
// Check if main http server should run with TLS. Otherwise reset the TLS
|
// Check if main http server should run with TLS. Otherwise reset the TLS
|
||||||
// config on the server and then serve it over normal HTTP.
|
// config on the server and then serve it over normal HTTP.
|
||||||
if api.Ssl.Enabled {
|
if api.Ssl.Enabled {
|
||||||
if err := s.ListenAndServeTLS(api.Ssl.CertificateFile, api.Ssl.KeyFile); err != nil {
|
if err := s.ListenAndServeTLS(strings.ToLower(api.Ssl.CertificateFile), strings.ToLower(api.Ssl.KeyFile)); err != nil {
|
||||||
log.WithFields(log.Fields{"auto_tls": false, "error": err}).Fatal("failed to configure HTTPS server")
|
log.WithFields(log.Fields{"auto_tls": false, "error": err}).Fatal("failed to configure HTTPS server")
|
||||||
}
|
}
|
||||||
return
|
return
|
||||||
@@ -375,10 +356,11 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
if err := s.ListenAndServe(); err != nil {
|
if err := s.ListenAndServe(); err != nil {
|
||||||
log.WithField("error", err).Fatal("failed to configure HTTP server")
|
log.WithField("error", err).Fatal("failed to configure HTTP server")
|
||||||
}
|
}
|
||||||
|
<-done
|
||||||
}
|
}
|
||||||
|
|
||||||
// Reads the configuration from the disk and then sets up the global singleton
|
// Reads the configuration from the disk and then sets up the global singleton
|
||||||
// with all the configuration values.
|
// with all of the configuration values.
|
||||||
func initConfig() {
|
func initConfig() {
|
||||||
if !strings.HasPrefix(configPath, "/") {
|
if !strings.HasPrefix(configPath, "/") {
|
||||||
d, err := os.Getwd()
|
d, err := os.Getwd()
|
||||||
@@ -403,7 +385,7 @@ func initConfig() {
|
|||||||
// in the code without having to pass around a logger instance.
|
// in the code without having to pass around a logger instance.
|
||||||
func initLogging() {
|
func initLogging() {
|
||||||
dir := config.Get().System.LogDirectory
|
dir := config.Get().System.LogDirectory
|
||||||
if err := os.MkdirAll(path.Join(dir, "/install"), 0o700); err != nil {
|
if err := os.MkdirAll(path.Join(dir, "/install"), 0700); err != nil {
|
||||||
log2.Fatalf("cmd/root: failed to create install directory path: %s", err)
|
log2.Fatalf("cmd/root: failed to create install directory path: %s", err)
|
||||||
}
|
}
|
||||||
p := filepath.Join(dir, "/wings.log")
|
p := filepath.Join(dir, "/wings.log")
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"crypto/tls"
|
"crypto/tls"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
"os"
|
"os"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
"os/user"
|
"os/user"
|
||||||
@@ -20,9 +21,8 @@ import (
|
|||||||
"github.com/cobaugh/osrelease"
|
"github.com/cobaugh/osrelease"
|
||||||
"github.com/creasty/defaults"
|
"github.com/creasty/defaults"
|
||||||
"github.com/gbrlsnchs/jwt/v3"
|
"github.com/gbrlsnchs/jwt/v3"
|
||||||
"gopkg.in/yaml.v2"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
|
"gopkg.in/yaml.v2"
|
||||||
)
|
)
|
||||||
|
|
||||||
const DefaultLocation = "/etc/pterodactyl/config.yml"
|
const DefaultLocation = "/etc/pterodactyl/config.yml"
|
||||||
@@ -47,15 +47,13 @@ var DefaultTLSConfig = &tls.Config{
|
|||||||
CurvePreferences: []tls.CurveID{tls.X25519, tls.CurveP256},
|
CurvePreferences: []tls.CurveID{tls.X25519, tls.CurveP256},
|
||||||
}
|
}
|
||||||
|
|
||||||
var (
|
var mu sync.RWMutex
|
||||||
mu sync.RWMutex
|
var _config *Configuration
|
||||||
_config *Configuration
|
var _jwtAlgo *jwt.HMACSHA
|
||||||
_jwtAlgo *jwt.HMACSHA
|
var _debugViaFlag bool
|
||||||
_debugViaFlag bool
|
|
||||||
)
|
|
||||||
|
|
||||||
// Locker specific to writing the configuration to the disk, this happens
|
// Locker specific to writing the configuration to the disk, this happens
|
||||||
// in areas that might already be locked, so we don't want to crash the process.
|
// in areas that might already be locked so we don't want to crash the process.
|
||||||
var _writeLock sync.Mutex
|
var _writeLock sync.Mutex
|
||||||
|
|
||||||
// SftpConfiguration defines the configuration of the internal SFTP server.
|
// SftpConfiguration defines the configuration of the internal SFTP server.
|
||||||
@@ -89,8 +87,14 @@ type ApiConfiguration struct {
|
|||||||
// servers.
|
// servers.
|
||||||
DisableRemoteDownload bool `json:"disable_remote_download" yaml:"disable_remote_download"`
|
DisableRemoteDownload bool `json:"disable_remote_download" yaml:"disable_remote_download"`
|
||||||
|
|
||||||
// The maximum size for files uploaded through the Panel in MB.
|
// The maximum size for files uploaded through the Panel in bytes.
|
||||||
UploadLimit int64 `default:"100" json:"upload_limit" yaml:"upload_limit"`
|
UploadLimit int `default:"100" json:"upload_limit" yaml:"upload_limit"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// MetricsConfiguration .
|
||||||
|
type MetricsConfiguration struct {
|
||||||
|
// Bind .
|
||||||
|
Bind string `default:":9000" yaml:"bind"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemoteQueryConfiguration defines the configuration settings for remote requests
|
// RemoteQueryConfiguration defines the configuration settings for remote requests
|
||||||
@@ -132,10 +136,6 @@ type SystemConfiguration struct {
|
|||||||
// Directory where local backups will be stored on the machine.
|
// Directory where local backups will be stored on the machine.
|
||||||
BackupDirectory string `default:"/var/lib/pterodactyl/backups" yaml:"backup_directory"`
|
BackupDirectory string `default:"/var/lib/pterodactyl/backups" yaml:"backup_directory"`
|
||||||
|
|
||||||
// TmpDirectory specifies where temporary files for Pterodactyl installation processes
|
|
||||||
// should be created. This supports environments running docker-in-docker.
|
|
||||||
TmpDirectory string `default:"/tmp/pterodactyl" yaml:"tmp_directory"`
|
|
||||||
|
|
||||||
// The user that should own all of the server files, and be used for containers.
|
// The user that should own all of the server files, and be used for containers.
|
||||||
Username string `default:"pterodactyl" yaml:"username"`
|
Username string `default:"pterodactyl" yaml:"username"`
|
||||||
|
|
||||||
@@ -163,15 +163,6 @@ type SystemConfiguration struct {
|
|||||||
// disk usage is not a concern.
|
// disk usage is not a concern.
|
||||||
DiskCheckInterval int64 `default:"150" yaml:"disk_check_interval"`
|
DiskCheckInterval int64 `default:"150" yaml:"disk_check_interval"`
|
||||||
|
|
||||||
// ActivitySendInterval is the amount of time that should ellapse between aggregated server activity
|
|
||||||
// being sent to the Panel. By default this will send activity collected over the last minute. Keep
|
|
||||||
// in mind that only a fixed number of activity log entries, defined by ActivitySendCount, will be sent
|
|
||||||
// in each run.
|
|
||||||
ActivitySendInterval int64 `default:"60" yaml:"activity_send_interval"`
|
|
||||||
|
|
||||||
// ActivitySendCount is the number of activity events to send per batch.
|
|
||||||
ActivitySendCount int64 `default:"100" yaml:"activity_send_count"`
|
|
||||||
|
|
||||||
// If set to true, file permissions for a server will be checked when the process is
|
// If set to true, file permissions for a server will be checked when the process is
|
||||||
// booted. This can cause boot delays if the server has a large amount of files. In most
|
// booted. This can cause boot delays if the server has a large amount of files. In most
|
||||||
// cases disabling this should not have any major impact unless external processes are
|
// cases disabling this should not have any major impact unless external processes are
|
||||||
@@ -195,9 +186,6 @@ type SystemConfiguration struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type CrashDetection struct {
|
type CrashDetection struct {
|
||||||
// CrashDetectionEnabled sets if crash detection is enabled globally for all servers on this node.
|
|
||||||
CrashDetectionEnabled bool `default:"true" yaml:"enabled"`
|
|
||||||
|
|
||||||
// Determines if Wings should detect a server that stops with a normal exit code of
|
// Determines if Wings should detect a server that stops with a normal exit code of
|
||||||
// "0" as being crashed if the process stopped without any Wings interaction. E.g.
|
// "0" as being crashed if the process stopped without any Wings interaction. E.g.
|
||||||
// the user did not press the stop button, but the process stopped cleanly.
|
// the user did not press the stop button, but the process stopped cleanly.
|
||||||
@@ -235,14 +223,26 @@ type ConsoleThrottles struct {
|
|||||||
// Whether or not the throttler is enabled for this instance.
|
// Whether or not the throttler is enabled for this instance.
|
||||||
Enabled bool `json:"enabled" yaml:"enabled" default:"true"`
|
Enabled bool `json:"enabled" yaml:"enabled" default:"true"`
|
||||||
|
|
||||||
// The total number of lines that can be output in a given Period period before
|
// The total number of lines that can be output in a given LineResetInterval period before
|
||||||
// a warning is triggered and counted against the server.
|
// a warning is triggered and counted against the server.
|
||||||
Lines uint64 `json:"lines" yaml:"lines" default:"2000"`
|
Lines uint64 `json:"lines" yaml:"lines" default:"2000"`
|
||||||
|
|
||||||
|
// The total number of throttle activations that can accumulate before a server is considered
|
||||||
|
// to be breaching and will be stopped. This value is decremented by one every DecayInterval.
|
||||||
|
MaximumTriggerCount uint64 `json:"maximum_trigger_count" yaml:"maximum_trigger_count" default:"5"`
|
||||||
|
|
||||||
// The amount of time after which the number of lines processed is reset to 0. This runs in
|
// The amount of time after which the number of lines processed is reset to 0. This runs in
|
||||||
// a constant loop and is not affected by the current console output volumes. By default, this
|
// a constant loop and is not affected by the current console output volumes. By default, this
|
||||||
// will reset the processed line count back to 0 every 100ms.
|
// will reset the processed line count back to 0 every 100ms.
|
||||||
Period uint64 `json:"line_reset_interval" yaml:"line_reset_interval" default:"100"`
|
LineResetInterval uint64 `json:"line_reset_interval" yaml:"line_reset_interval" default:"100"`
|
||||||
|
|
||||||
|
// The amount of time in milliseconds that must pass without an output warning being triggered
|
||||||
|
// before a throttle activation is decremented.
|
||||||
|
DecayInterval uint64 `json:"decay_interval" yaml:"decay_interval" default:"10000"`
|
||||||
|
|
||||||
|
// The amount of time that a server is allowed to be stopping for before it is terminated
|
||||||
|
// forcefully if it triggers output throttles.
|
||||||
|
StopGracePeriod uint `json:"stop_grace_period" yaml:"stop_grace_period" default:"15"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type Configuration struct {
|
type Configuration struct {
|
||||||
@@ -269,6 +269,7 @@ type Configuration struct {
|
|||||||
Api ApiConfiguration `json:"api" yaml:"api"`
|
Api ApiConfiguration `json:"api" yaml:"api"`
|
||||||
System SystemConfiguration `json:"system" yaml:"system"`
|
System SystemConfiguration `json:"system" yaml:"system"`
|
||||||
Docker DockerConfiguration `json:"docker" yaml:"docker"`
|
Docker DockerConfiguration `json:"docker" yaml:"docker"`
|
||||||
|
Metrics MetricsConfiguration `json:"metrics" yaml:"metrics"`
|
||||||
|
|
||||||
// Defines internal throttling configurations for server processes to prevent
|
// Defines internal throttling configurations for server processes to prevent
|
||||||
// someone from running an endless loop that spams data to logs.
|
// someone from running an endless loop that spams data to logs.
|
||||||
@@ -287,12 +288,6 @@ type Configuration struct {
|
|||||||
// The Panel URL is automatically allowed, this is only needed for adding
|
// The Panel URL is automatically allowed, this is only needed for adding
|
||||||
// additional origins.
|
// additional origins.
|
||||||
AllowedOrigins []string `json:"allowed_origins" yaml:"allowed_origins"`
|
AllowedOrigins []string `json:"allowed_origins" yaml:"allowed_origins"`
|
||||||
|
|
||||||
// AllowCORSPrivateNetwork sets the `Access-Control-Request-Private-Network` header which
|
|
||||||
// allows client browsers to make requests to internal IP addresses over HTTP. This setting
|
|
||||||
// is only required by users running Wings without SSL certificates and using internal IP
|
|
||||||
// addresses in order to connect. Most users should NOT enable this setting.
|
|
||||||
AllowCORSPrivateNetwork bool `json:"allow_cors_private_network" yaml:"allow_cors_private_network"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewAtPath creates a new struct and set the path where it should be stored.
|
// NewAtPath creates a new struct and set the path where it should be stored.
|
||||||
@@ -386,7 +381,7 @@ func WriteToDisk(c *Configuration) error {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if err := os.WriteFile(c.path, b, 0o600); err != nil {
|
if err := ioutil.WriteFile(c.path, b, 0600); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
@@ -406,7 +401,7 @@ func EnsurePterodactylUser() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Our way of detecting if wings is running inside of Docker.
|
// Our way of detecting if wings is running inside of Docker.
|
||||||
if sysName == "distroless" {
|
if sysName == "busybox" {
|
||||||
_config.System.Username = system.FirstNotEmpty(os.Getenv("WINGS_USERNAME"), "pterodactyl")
|
_config.System.Username = system.FirstNotEmpty(os.Getenv("WINGS_USERNAME"), "pterodactyl")
|
||||||
_config.System.User.Uid = system.MustInt(system.FirstNotEmpty(os.Getenv("WINGS_UID"), "988"))
|
_config.System.User.Uid = system.MustInt(system.FirstNotEmpty(os.Getenv("WINGS_UID"), "988"))
|
||||||
_config.System.User.Gid = system.MustInt(system.FirstNotEmpty(os.Getenv("WINGS_GID"), "988"))
|
_config.System.User.Gid = system.MustInt(system.FirstNotEmpty(os.Getenv("WINGS_GID"), "988"))
|
||||||
@@ -454,7 +449,7 @@ func EnsurePterodactylUser() error {
|
|||||||
// FromFile reads the configuration from the provided file and stores it in the
|
// FromFile reads the configuration from the provided file and stores it in the
|
||||||
// global singleton for this instance.
|
// global singleton for this instance.
|
||||||
func FromFile(path string) error {
|
func FromFile(path string) error {
|
||||||
b, err := os.ReadFile(path)
|
b, err := ioutil.ReadFile(path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -462,17 +457,18 @@ func FromFile(path string) error {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
// Replace environment variables within the configuration file with their
|
||||||
|
// values from the host system.
|
||||||
|
b = []byte(os.ExpandEnv(string(b)))
|
||||||
if err := yaml.Unmarshal(b, c); err != nil {
|
if err := yaml.Unmarshal(b, c); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Store this configuration in the global state.
|
// Store this configuration in the global state.
|
||||||
Set(c)
|
Set(c)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// ConfigureDirectories ensures that all the system directories exist on the
|
// ConfigureDirectories ensures that all of the system directories exist on the
|
||||||
// system. These directories are created so that only the owner can read the data,
|
// system. These directories are created so that only the owner can read the data,
|
||||||
// and no other users.
|
// and no other users.
|
||||||
//
|
//
|
||||||
@@ -480,7 +476,7 @@ func FromFile(path string) error {
|
|||||||
func ConfigureDirectories() error {
|
func ConfigureDirectories() error {
|
||||||
root := _config.System.RootDirectory
|
root := _config.System.RootDirectory
|
||||||
log.WithField("path", root).Debug("ensuring root data directory exists")
|
log.WithField("path", root).Debug("ensuring root data directory exists")
|
||||||
if err := os.MkdirAll(root, 0o700); err != nil {
|
if err := os.MkdirAll(root, 0700); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -501,17 +497,17 @@ func ConfigureDirectories() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
log.WithField("path", _config.System.Data).Debug("ensuring server data directory exists")
|
log.WithField("path", _config.System.Data).Debug("ensuring server data directory exists")
|
||||||
if err := os.MkdirAll(_config.System.Data, 0o700); err != nil {
|
if err := os.MkdirAll(_config.System.Data, 0700); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
log.WithField("path", _config.System.ArchiveDirectory).Debug("ensuring archive data directory exists")
|
log.WithField("path", _config.System.ArchiveDirectory).Debug("ensuring archive data directory exists")
|
||||||
if err := os.MkdirAll(_config.System.ArchiveDirectory, 0o700); err != nil {
|
if err := os.MkdirAll(_config.System.ArchiveDirectory, 0700); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
log.WithField("path", _config.System.BackupDirectory).Debug("ensuring backup data directory exists")
|
log.WithField("path", _config.System.BackupDirectory).Debug("ensuring backup data directory exists")
|
||||||
if err := os.MkdirAll(_config.System.BackupDirectory, 0o700); err != nil {
|
if err := os.MkdirAll(_config.System.BackupDirectory, 0700); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -549,7 +545,8 @@ func EnableLogRotation() error {
|
|||||||
}
|
}
|
||||||
defer f.Close()
|
defer f.Close()
|
||||||
|
|
||||||
t, err := template.New("logrotate").Parse(`{{.LogDirectory}}/wings.log {
|
t, err := template.New("logrotate").Parse(`
|
||||||
|
{{.LogDirectory}}/wings.log {
|
||||||
size 10M
|
size 10M
|
||||||
compress
|
compress
|
||||||
delaycompress
|
delaycompress
|
||||||
@@ -557,8 +554,9 @@ func EnableLogRotation() error {
|
|||||||
maxage 7
|
maxage 7
|
||||||
missingok
|
missingok
|
||||||
notifempty
|
notifempty
|
||||||
|
create 0640 {{.User.Uid}} {{.User.Gid}}
|
||||||
postrotate
|
postrotate
|
||||||
/usr/bin/systemctl kill -s HUP wings.service >/dev/null 2>&1 || true
|
killall -SIGHUP wings
|
||||||
endscript
|
endscript
|
||||||
}`)
|
}`)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -584,7 +582,7 @@ func ConfigureTimezone() error {
|
|||||||
_config.System.Timezone = tz
|
_config.System.Timezone = tz
|
||||||
}
|
}
|
||||||
if _config.System.Timezone == "" {
|
if _config.System.Timezone == "" {
|
||||||
b, err := os.ReadFile("/etc/timezone")
|
b, err := ioutil.ReadFile("/etc/timezone")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if !os.IsNotExist(err) {
|
if !os.IsNotExist(err) {
|
||||||
return errors.WithMessage(err, "config: failed to open timezone file")
|
return errors.WithMessage(err, "config: failed to open timezone file")
|
||||||
|
|||||||
@@ -2,10 +2,9 @@ package config
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/base64"
|
"encoding/base64"
|
||||||
"sort"
|
"encoding/json"
|
||||||
|
|
||||||
"github.com/docker/docker/api/types"
|
"github.com/docker/docker/api/types"
|
||||||
"github.com/goccy/go-json"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type dockerNetworkInterfaces struct {
|
type dockerNetworkInterfaces struct {
|
||||||
@@ -36,7 +35,6 @@ type DockerNetworkConfiguration struct {
|
|||||||
Mode string `default:"pterodactyl_nw" yaml:"network_mode"`
|
Mode string `default:"pterodactyl_nw" yaml:"network_mode"`
|
||||||
IsInternal bool `default:"false" yaml:"is_internal"`
|
IsInternal bool `default:"false" yaml:"is_internal"`
|
||||||
EnableICC bool `default:"true" yaml:"enable_icc"`
|
EnableICC bool `default:"true" yaml:"enable_icc"`
|
||||||
NetworkMTU int64 `default:"1500" yaml:"network_mtu"`
|
|
||||||
Interfaces dockerNetworkInterfaces `yaml:"interfaces"`
|
Interfaces dockerNetworkInterfaces `yaml:"interfaces"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -53,31 +51,25 @@ type DockerConfiguration struct {
|
|||||||
// Registries .
|
// Registries .
|
||||||
Registries map[string]RegistryConfiguration `json:"registries" yaml:"registries"`
|
Registries map[string]RegistryConfiguration `json:"registries" yaml:"registries"`
|
||||||
|
|
||||||
// TmpfsSize specifies the size for the /tmp directory mounted into containers. Please be
|
// The size of the /tmp directory when mounted into a container. Please be aware that Docker
|
||||||
// aware that Docker utilizes the host's system memory for this value, and that we do not
|
// utilizes host memory for this value, and that we do not keep track of the space used here
|
||||||
// keep track of the space used there, so avoid allocating too much to a server.
|
// so avoid allocating too much to a server.
|
||||||
TmpfsSize uint `default:"100" json:"tmpfs_size" yaml:"tmpfs_size"`
|
TmpfsSize uint `default:"100" json:"tmpfs_size" yaml:"tmpfs_size"`
|
||||||
|
|
||||||
// ContainerPidLimit sets the total number of processes that can be active in a container
|
// ContainerPidLimit sets the total number of processes that can be active in a container
|
||||||
// at any given moment. This is a security concern in shared-hosting environments where a
|
// at any given moment. This is a security concern in shared-hosting environments where a
|
||||||
// malicious process could create enough processes to cause the host node to run out of
|
// malicious process could create enough processes to cause the host node to run out of
|
||||||
// available pids and crash.
|
// available pids and crash.
|
||||||
ContainerPidLimit int64 `default:"512" json:"container_pid_limit" yaml:"container_pid_limit"`
|
ContainerPidLimit int64 `default:"256" json:"container_pid_limit" yaml:"container_pid_limit"`
|
||||||
|
|
||||||
// InstallerLimits defines the limits on the installer containers that prevents a server's
|
// InstallLimits defines the limits on the installer containers that prevents a server's
|
||||||
// installation process from unintentionally consuming more resources than expected. This
|
// installation process from unintentionally consuming more resources than expected. This
|
||||||
// is used in conjunction with the server's defined limits. Whichever value is higher will
|
// is used in conjunction with the server's defined limits. Whichever value is higher will
|
||||||
// take precedence in the installer containers.
|
// take precedence in the install containers.
|
||||||
InstallerLimits struct {
|
InstallerLimits struct {
|
||||||
Memory int64 `default:"1024" json:"memory" yaml:"memory"`
|
Memory int64 `default:"1024" json:"memory" yaml:"memory"`
|
||||||
Cpu int64 `default:"100" json:"cpu" yaml:"cpu"`
|
Cpu int64 `default:"100" json:"cpu" yaml:"cpu"`
|
||||||
} `json:"installer_limits" yaml:"installer_limits"`
|
} `json:"installer_limits" yaml:"installer_limits"`
|
||||||
|
|
||||||
// Overhead controls the memory overhead given to all containers to circumvent certain
|
|
||||||
// software such as the JVM not staying below the maximum memory limit.
|
|
||||||
Overhead Overhead `json:"overhead" yaml:"overhead"`
|
|
||||||
|
|
||||||
UsePerformantInspect bool `default:"true" json:"use_performant_inspect" yaml:"use_performant_inspect"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// RegistryConfiguration defines the authentication credentials for a given
|
// RegistryConfiguration defines the authentication credentials for a given
|
||||||
@@ -99,62 +91,3 @@ func (c RegistryConfiguration) Base64() (string, error) {
|
|||||||
}
|
}
|
||||||
return base64.URLEncoding.EncodeToString(b), nil
|
return base64.URLEncoding.EncodeToString(b), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Overhead controls the memory overhead given to all containers to circumvent certain
|
|
||||||
// software such as the JVM not staying below the maximum memory limit.
|
|
||||||
type Overhead struct {
|
|
||||||
// Override controls if the overhead limits should be overridden by the values in the config file.
|
|
||||||
Override bool `default:"false" json:"override" yaml:"override"`
|
|
||||||
|
|
||||||
// DefaultMultiplier sets the default multiplier for if no Multipliers are able to be applied.
|
|
||||||
DefaultMultiplier float64 `default:"1.05" json:"default_multiplier" yaml:"default_multiplier"`
|
|
||||||
|
|
||||||
// Multipliers allows overriding DefaultMultiplier depending on the amount of memory
|
|
||||||
// configured for a server.
|
|
||||||
//
|
|
||||||
// Default values (used if Override is `false`)
|
|
||||||
// - Less than 2048 MB of memory, multiplier of 1.15 (15%)
|
|
||||||
// - Less than 4096 MB of memory, multiplier of 1.10 (10%)
|
|
||||||
// - Otherwise, multiplier of 1.05 (5%) - specified in DefaultMultiplier
|
|
||||||
//
|
|
||||||
// If the defaults were specified in the config they would look like:
|
|
||||||
// ```yaml
|
|
||||||
// multipliers:
|
|
||||||
// 2048: 1.15
|
|
||||||
// 4096: 1.10
|
|
||||||
// ```
|
|
||||||
Multipliers map[int]float64 `json:"multipliers" yaml:"multipliers"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func (o Overhead) GetMultiplier(memoryLimit int64) float64 {
|
|
||||||
// Default multiplier values.
|
|
||||||
if !o.Override {
|
|
||||||
if memoryLimit <= 2048 {
|
|
||||||
return 1.15
|
|
||||||
} else if memoryLimit <= 4096 {
|
|
||||||
return 1.10
|
|
||||||
}
|
|
||||||
return 1.05
|
|
||||||
}
|
|
||||||
|
|
||||||
// This plucks the keys of the Multipliers map, so they can be sorted from
|
|
||||||
// smallest to largest in order to correctly apply the proper multiplier.
|
|
||||||
i := 0
|
|
||||||
multipliers := make([]int, len(o.Multipliers))
|
|
||||||
for k := range o.Multipliers {
|
|
||||||
multipliers[i] = k
|
|
||||||
i++
|
|
||||||
}
|
|
||||||
sort.Ints(multipliers)
|
|
||||||
|
|
||||||
// Loop through the memory values in order (smallest to largest)
|
|
||||||
for _, m := range multipliers {
|
|
||||||
// If the server's memory limit exceeds the modifier's limit, don't apply it.
|
|
||||||
if memoryLimit > int64(m) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
return o.Multipliers[m]
|
|
||||||
}
|
|
||||||
|
|
||||||
return o.DefaultMultiplier
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ import (
|
|||||||
"strconv"
|
"strconv"
|
||||||
|
|
||||||
"github.com/docker/go-connections/nat"
|
"github.com/docker/go-connections/nat"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -20,7 +19,7 @@ type Allocations struct {
|
|||||||
Port int `json:"port"`
|
Port int `json:"port"`
|
||||||
} `json:"default"`
|
} `json:"default"`
|
||||||
|
|
||||||
// Mappings contains all the ports that should be assigned to a given server
|
// Mappings contains all of the ports that should be assigned to a given server
|
||||||
// attached to the IP they correspond to.
|
// attached to the IP they correspond to.
|
||||||
Mappings map[string][]int `json:"mappings"`
|
Mappings map[string][]int `json:"mappings"`
|
||||||
}
|
}
|
||||||
@@ -31,7 +30,7 @@ type Allocations struct {
|
|||||||
//
|
//
|
||||||
// You'll want to use DockerBindings() if you need to re-map 127.0.0.1 to the Docker interface.
|
// You'll want to use DockerBindings() if you need to re-map 127.0.0.1 to the Docker interface.
|
||||||
func (a *Allocations) Bindings() nat.PortMap {
|
func (a *Allocations) Bindings() nat.PortMap {
|
||||||
out := nat.PortMap{}
|
var out = nat.PortMap{}
|
||||||
|
|
||||||
for ip, ports := range a.Mappings {
|
for ip, ports := range a.Mappings {
|
||||||
for _, port := range ports {
|
for _, port := range ports {
|
||||||
@@ -63,7 +62,7 @@ func (a *Allocations) DockerBindings() nat.PortMap {
|
|||||||
iface := config.Get().Docker.Network.Interface
|
iface := config.Get().Docker.Network.Interface
|
||||||
|
|
||||||
out := a.Bindings()
|
out := a.Bindings()
|
||||||
// Loop over all the bindings for this container, and convert any that reference 127.0.0.1
|
// Loop over all of the bindings for this container, and convert any that reference 127.0.0.1
|
||||||
// to use the pterodactyl0 network interface IP, as that is the true local for what people are
|
// to use the pterodactyl0 network interface IP, as that is the true local for what people are
|
||||||
// trying to do when creating servers.
|
// trying to do when creating servers.
|
||||||
for p, binds := range out {
|
for p, binds := range out {
|
||||||
@@ -94,7 +93,7 @@ func (a *Allocations) DockerBindings() nat.PortMap {
|
|||||||
// To accomplish this, we'll just get the values from "DockerBindings" and then set them
|
// To accomplish this, we'll just get the values from "DockerBindings" and then set them
|
||||||
// to empty structs. Because why not.
|
// to empty structs. Because why not.
|
||||||
func (a *Allocations) Exposed() nat.PortSet {
|
func (a *Allocations) Exposed() nat.PortSet {
|
||||||
out := nat.PortSet{}
|
var out = nat.PortSet{}
|
||||||
|
|
||||||
for port := range a.DockerBindings() {
|
for port := range a.DockerBindings() {
|
||||||
out[port] = struct{}{}
|
out[port] = struct{}{}
|
||||||
|
|||||||
@@ -10,14 +10,11 @@ import (
|
|||||||
"github.com/docker/docker/api/types"
|
"github.com/docker/docker/api/types"
|
||||||
"github.com/docker/docker/api/types/network"
|
"github.com/docker/docker/api/types/network"
|
||||||
"github.com/docker/docker/client"
|
"github.com/docker/docker/client"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var _conce sync.Once
|
||||||
_conce sync.Once
|
var _client *client.Client
|
||||||
_client *client.Client
|
|
||||||
)
|
|
||||||
|
|
||||||
// Docker returns a docker client to be used throughout the codebase. Once a
|
// Docker returns a docker client to be used throughout the codebase. Once a
|
||||||
// client has been created it will be returned for all subsequent calls to this
|
// client has been created it will be returned for all subsequent calls to this
|
||||||
@@ -92,7 +89,7 @@ func createDockerNetwork(ctx context.Context, cli *client.Client) error {
|
|||||||
"com.docker.network.bridge.enable_ip_masquerade": "true",
|
"com.docker.network.bridge.enable_ip_masquerade": "true",
|
||||||
"com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
|
"com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
|
||||||
"com.docker.network.bridge.name": "pterodactyl0",
|
"com.docker.network.bridge.name": "pterodactyl0",
|
||||||
"com.docker.network.driver.mtu": strconv.FormatInt(nw.NetworkMTU, 10),
|
"com.docker.network.driver.mtu": "1500",
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -1,119 +0,0 @@
|
|||||||
package docker
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"io"
|
|
||||||
"net/http"
|
|
||||||
"reflect"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/docker/docker/api/types"
|
|
||||||
"github.com/docker/docker/api/types/versions"
|
|
||||||
"github.com/docker/docker/client"
|
|
||||||
"github.com/docker/docker/errdefs"
|
|
||||||
"github.com/goccy/go-json"
|
|
||||||
"github.com/pterodactyl/wings/config"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
o sync.Once
|
|
||||||
cli cliSettings
|
|
||||||
fastEnabled bool
|
|
||||||
)
|
|
||||||
|
|
||||||
type cliSettings struct {
|
|
||||||
enabled bool
|
|
||||||
proto string
|
|
||||||
host string
|
|
||||||
scheme string
|
|
||||||
version string
|
|
||||||
}
|
|
||||||
|
|
||||||
func configure(c *client.Client) {
|
|
||||||
o.Do(func() {
|
|
||||||
fastEnabled = config.Get().Docker.UsePerformantInspect
|
|
||||||
|
|
||||||
r := reflect.ValueOf(c).Elem()
|
|
||||||
cli.proto = r.FieldByName("proto").String()
|
|
||||||
cli.host = r.FieldByName("addr").String()
|
|
||||||
cli.scheme = r.FieldByName("scheme").String()
|
|
||||||
cli.version = r.FieldByName("version").String()
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// ContainerInspect is a rough equivalent of Docker's client.ContainerInspect()
|
|
||||||
// but re-written to use a more performant JSON decoder. This is important since
|
|
||||||
// a large number of requests to this endpoint are spawned by Wings, and the
|
|
||||||
// standard "encoding/json" shows its performance woes badly even with single
|
|
||||||
// containers running.
|
|
||||||
func (e *Environment) ContainerInspect(ctx context.Context) (types.ContainerJSON, error) {
|
|
||||||
configure(e.client)
|
|
||||||
|
|
||||||
// Support feature flagging of this functionality so that if something goes
|
|
||||||
// wrong for now it is easy enough for people to switch back to the older method
|
|
||||||
// of fetching stats.
|
|
||||||
if !fastEnabled {
|
|
||||||
return e.client.ContainerInspect(ctx, e.Id)
|
|
||||||
}
|
|
||||||
|
|
||||||
var st types.ContainerJSON
|
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, "/containers/"+e.Id+"/json", nil)
|
|
||||||
if err != nil {
|
|
||||||
return st, errors.WithStack(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if cli.proto == "unix" || cli.proto == "npipe" {
|
|
||||||
req.Host = "docker"
|
|
||||||
}
|
|
||||||
|
|
||||||
req.URL.Host = cli.host
|
|
||||||
req.URL.Scheme = cli.scheme
|
|
||||||
|
|
||||||
res, err := e.client.HTTPClient().Do(req)
|
|
||||||
if err != nil {
|
|
||||||
if res == nil {
|
|
||||||
return st, errdefs.Unknown(err)
|
|
||||||
}
|
|
||||||
return st, errdefs.FromStatusCode(err, res.StatusCode)
|
|
||||||
}
|
|
||||||
|
|
||||||
body, err := io.ReadAll(res.Body)
|
|
||||||
if err != nil {
|
|
||||||
return st, errors.Wrap(err, "failed to read response body from Docker")
|
|
||||||
}
|
|
||||||
if err := parseErrorFromResponse(res, body); err != nil {
|
|
||||||
return st, errdefs.FromStatusCode(err, res.StatusCode)
|
|
||||||
}
|
|
||||||
if err := json.Unmarshal(body, &st); err != nil {
|
|
||||||
return st, errors.WithStack(err)
|
|
||||||
}
|
|
||||||
return st, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseErrorFromResponse is a re-implementation of Docker's
|
|
||||||
// client.checkResponseErr() function.
|
|
||||||
func parseErrorFromResponse(res *http.Response, body []byte) error {
|
|
||||||
if res.StatusCode >= 200 && res.StatusCode < 400 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
var ct string
|
|
||||||
if res.Header != nil {
|
|
||||||
ct = res.Header.Get("Content-Type")
|
|
||||||
}
|
|
||||||
|
|
||||||
var emsg string
|
|
||||||
if (cli.version == "" || versions.GreaterThan(cli.version, "1.23")) && ct == "application/json" {
|
|
||||||
var errResp types.ErrorResponse
|
|
||||||
if err := json.Unmarshal(body, &errResp); err != nil {
|
|
||||||
return errors.WithStack(err)
|
|
||||||
}
|
|
||||||
emsg = strings.TrimSpace(errResp.Message)
|
|
||||||
} else {
|
|
||||||
emsg = strings.TrimSpace(string(body))
|
|
||||||
}
|
|
||||||
|
|
||||||
return errors.Wrap(errors.New(emsg), "Error response from daemon")
|
|
||||||
}
|
|
||||||
@@ -3,6 +3,7 @@ package docker
|
|||||||
import (
|
import (
|
||||||
"bufio"
|
"bufio"
|
||||||
"context"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"strconv"
|
"strconv"
|
||||||
@@ -11,13 +12,11 @@ import (
|
|||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/buger/jsonparser"
|
|
||||||
"github.com/docker/docker/api/types"
|
"github.com/docker/docker/api/types"
|
||||||
"github.com/docker/docker/api/types/container"
|
"github.com/docker/docker/api/types/container"
|
||||||
"github.com/docker/docker/api/types/mount"
|
"github.com/docker/docker/api/types/mount"
|
||||||
"github.com/docker/docker/client"
|
"github.com/docker/docker/client"
|
||||||
"github.com/docker/docker/daemon/logger/local"
|
"github.com/docker/docker/daemon/logger/jsonfilelog"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
@@ -38,14 +37,14 @@ func (nw noopWriter) Write(b []byte) (int, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Attach attaches to the docker container itself and ensures that we can pipe
|
// Attach attaches to the docker container itself and ensures that we can pipe
|
||||||
// data in and out of the process stream. This should always be called before
|
// data in and out of the process stream. This should not be used for reading
|
||||||
// you have started the container, but after you've ensured it exists.
|
// console data as you *will* miss important output at the beginning because of
|
||||||
|
// the time delay with attaching to the output.
|
||||||
//
|
//
|
||||||
// Calling this function will poll resources for the container in the background
|
// Calling this function will poll resources for the container in the background
|
||||||
// until the container is stopped. The context provided to this function is used
|
// until the provided context is canceled by the caller. Failure to cancel said
|
||||||
// for the purposes of attaching to the container, a seecond context is created
|
// context will cause background memory leaks as the goroutine will not exit.
|
||||||
// within the function for managing polling.
|
func (e *Environment) Attach() error {
|
||||||
func (e *Environment) Attach(ctx context.Context) error {
|
|
||||||
if e.IsAttached() {
|
if e.IsAttached() {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -62,17 +61,14 @@ func (e *Environment) Attach(ctx context.Context) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Set the stream again with the container.
|
// Set the stream again with the container.
|
||||||
if st, err := e.client.ContainerAttach(ctx, e.Id, opts); err != nil {
|
if st, err := e.client.ContainerAttach(context.Background(), e.Id, opts); err != nil {
|
||||||
return err
|
return err
|
||||||
} else {
|
} else {
|
||||||
e.SetStream(&st)
|
e.SetStream(&st)
|
||||||
}
|
}
|
||||||
|
|
||||||
go func() {
|
go func() {
|
||||||
// Don't use the context provided to the function, that'll cause the polling to
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
// exit unexpectedly. We want a custom context for this, the one passed to the
|
|
||||||
// function is to avoid a hang situation when trying to attach to a container.
|
|
||||||
pollCtx, cancel := context.WithCancel(context.Background())
|
|
||||||
defer cancel()
|
defer cancel()
|
||||||
defer e.stream.Close()
|
defer e.stream.Close()
|
||||||
defer func() {
|
defer func() {
|
||||||
@@ -81,7 +77,7 @@ func (e *Environment) Attach(ctx context.Context) error {
|
|||||||
}()
|
}()
|
||||||
|
|
||||||
go func() {
|
go func() {
|
||||||
if err := e.pollResources(pollCtx); err != nil {
|
if err := e.pollResources(ctx); err != nil {
|
||||||
if !errors.Is(err, context.Canceled) {
|
if !errors.Is(err, context.Canceled) {
|
||||||
e.log().WithField("error", err).Error("error during environment resource polling")
|
e.log().WithField("error", err).Error("error during environment resource polling")
|
||||||
} else {
|
} else {
|
||||||
@@ -118,7 +114,7 @@ func (e *Environment) InSituUpdate() error {
|
|||||||
ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
|
ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
if _, err := e.ContainerInspect(ctx); err != nil {
|
if _, err := e.client.ContainerInspect(ctx, e.Id); err != nil {
|
||||||
// If the container doesn't exist for some reason there really isn't anything
|
// If the container doesn't exist for some reason there really isn't anything
|
||||||
// we can do to fix that in this process (it doesn't make sense at least). In those
|
// we can do to fix that in this process (it doesn't make sense at least). In those
|
||||||
// cases just return without doing anything since we still want to save the configuration
|
// cases just return without doing anything since we still want to save the configuration
|
||||||
@@ -143,14 +139,14 @@ func (e *Environment) InSituUpdate() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create creates a new container for the server using all the data that is
|
// Create creates a new container for the server using all of the data that is
|
||||||
// currently available for it. If the container already exists it will be
|
// currently available for it. If the container already exists it will be
|
||||||
// returned.
|
// returned.
|
||||||
func (e *Environment) Create() error {
|
func (e *Environment) Create() error {
|
||||||
// If the container already exists don't hit the user with an error, just return
|
// If the container already exists don't hit the user with an error, just return
|
||||||
// the current information about it which is what we would do when creating the
|
// the current information about it which is what we would do when creating the
|
||||||
// container anyways.
|
// container anyways.
|
||||||
if _, err := e.ContainerInspect(context.Background()); err == nil {
|
if _, err := e.client.ContainerInspect(context.Background(), e.Id); err == nil {
|
||||||
return nil
|
return nil
|
||||||
} else if !client.IsErrNotFound(err) {
|
} else if !client.IsErrNotFound(err) {
|
||||||
return errors.Wrap(err, "environment/docker: failed to inspect container")
|
return errors.Wrap(err, "environment/docker: failed to inspect container")
|
||||||
@@ -175,7 +171,7 @@ func (e *Environment) Create() error {
|
|||||||
conf := &container.Config{
|
conf := &container.Config{
|
||||||
Hostname: e.Id,
|
Hostname: e.Id,
|
||||||
Domainname: config.Get().Docker.Domainname,
|
Domainname: config.Get().Docker.Domainname,
|
||||||
User: strconv.Itoa(config.Get().System.User.Uid) + ":" + strconv.Itoa(config.Get().System.User.Gid),
|
User: strconv.Itoa(config.Get().System.User.Uid),
|
||||||
AttachStdin: true,
|
AttachStdin: true,
|
||||||
AttachStdout: true,
|
AttachStdout: true,
|
||||||
AttachStderr: true,
|
AttachStderr: true,
|
||||||
@@ -196,7 +192,7 @@ func (e *Environment) Create() error {
|
|||||||
PortBindings: a.DockerBindings(),
|
PortBindings: a.DockerBindings(),
|
||||||
|
|
||||||
// Configure the mounts for this container. First mount the server data directory
|
// Configure the mounts for this container. First mount the server data directory
|
||||||
// into the container as an r/w bind.
|
// into the container as a r/w bind.
|
||||||
Mounts: e.convertMounts(),
|
Mounts: e.convertMounts(),
|
||||||
|
|
||||||
// Configure the /tmp folder mapping in containers. This is necessary for some
|
// Configure the /tmp folder mapping in containers. This is necessary for some
|
||||||
@@ -216,12 +212,11 @@ func (e *Environment) Create() error {
|
|||||||
// since we only need it for the last few hundred lines of output and don't care
|
// since we only need it for the last few hundred lines of output and don't care
|
||||||
// about anything else in it.
|
// about anything else in it.
|
||||||
LogConfig: container.LogConfig{
|
LogConfig: container.LogConfig{
|
||||||
Type: local.Name,
|
Type: jsonfilelog.Name,
|
||||||
Config: map[string]string{
|
Config: map[string]string{
|
||||||
"max-size": "5m",
|
"max-size": "5m",
|
||||||
"max-file": "1",
|
"max-file": "1",
|
||||||
"compress": "false",
|
"compress": "false",
|
||||||
"mode": "non-blocking",
|
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -343,11 +338,13 @@ func (e *Environment) followOutput() error {
|
|||||||
func (e *Environment) scanOutput(reader io.ReadCloser) {
|
func (e *Environment) scanOutput(reader io.ReadCloser) {
|
||||||
defer reader.Close()
|
defer reader.Close()
|
||||||
|
|
||||||
if err := system.ScanReader(reader, func(v []byte) {
|
events := e.Events()
|
||||||
e.logCallbackMx.Lock()
|
|
||||||
defer e.logCallbackMx.Unlock()
|
err := system.ScanReader(reader, func(line string) {
|
||||||
e.logCallback(v)
|
events.Publish(environment.ConsoleOutputEvent, line)
|
||||||
}); err != nil && err != io.EOF {
|
})
|
||||||
|
|
||||||
|
if err != nil && err != io.EOF {
|
||||||
log.WithField("error", err).WithField("container_id", e.Id).Warn("error processing scanner line in console output")
|
log.WithField("error", err).WithField("container_id", e.Id).Warn("error processing scanner line in console output")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -357,7 +354,7 @@ func (e *Environment) scanOutput(reader io.ReadCloser) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Close the current reader before starting a new one, the defer will still run,
|
// Close the current reader before starting a new one, the defer will still run
|
||||||
// but it will do nothing if we already closed the stream.
|
// but it will do nothing if we already closed the stream.
|
||||||
_ = reader.Close()
|
_ = reader.Close()
|
||||||
|
|
||||||
@@ -365,12 +362,17 @@ func (e *Environment) scanOutput(reader io.ReadCloser) {
|
|||||||
go e.followOutput()
|
go e.followOutput()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type imagePullStatus struct {
|
||||||
|
Status string `json:"status"`
|
||||||
|
Progress string `json:"progress"`
|
||||||
|
}
|
||||||
|
|
||||||
// Pulls the image from Docker. If there is an error while pulling the image
|
// Pulls the image from Docker. If there is an error while pulling the image
|
||||||
// from the source but the image already exists locally, we will report that
|
// from the source but the image already exists locally, we will report that
|
||||||
// error to the logger but continue with the process.
|
// error to the logger but continue with the process.
|
||||||
//
|
//
|
||||||
// The reasoning behind this is that Quay has had some serious outages as of
|
// The reasoning behind this is that Quay has had some serious outages as of
|
||||||
// late, and we don't need to block all the servers from booting just because
|
// late, and we don't need to block all of the servers from booting just because
|
||||||
// of that. I'd imagine in a lot of cases an outage shouldn't affect users too
|
// of that. I'd imagine in a lot of cases an outage shouldn't affect users too
|
||||||
// badly. It'll at least keep existing servers working correctly if anything.
|
// badly. It'll at least keep existing servers working correctly if anything.
|
||||||
func (e *Environment) ensureImageExists(image string) error {
|
func (e *Environment) ensureImageExists(image string) error {
|
||||||
@@ -450,11 +452,12 @@ func (e *Environment) ensureImageExists(image string) error {
|
|||||||
scanner := bufio.NewScanner(out)
|
scanner := bufio.NewScanner(out)
|
||||||
|
|
||||||
for scanner.Scan() {
|
for scanner.Scan() {
|
||||||
b := scanner.Bytes()
|
s := imagePullStatus{}
|
||||||
status, _ := jsonparser.GetString(b, "status")
|
fmt.Println(scanner.Text())
|
||||||
progress, _ := jsonparser.GetString(b, "progress")
|
|
||||||
|
|
||||||
e.Events().Publish(environment.DockerImagePullStatus, status+" "+progress)
|
if err := json.Unmarshal(scanner.Bytes(), &s); err == nil {
|
||||||
|
e.Events().Publish(environment.DockerImagePullStatus, s.Status+" "+s.Progress)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := scanner.Err(); err != nil {
|
if err := scanner.Err(); err != nil {
|
||||||
@@ -480,3 +483,21 @@ func (e *Environment) convertMounts() []mount.Mount {
|
|||||||
|
|
||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (e *Environment) resources() container.Resources {
|
||||||
|
l := e.Configuration.Limits()
|
||||||
|
pids := l.ProcessLimit()
|
||||||
|
|
||||||
|
return container.Resources{
|
||||||
|
Memory: l.BoundedMemoryLimit(),
|
||||||
|
MemoryReservation: l.MemoryLimit * 1_000_000,
|
||||||
|
MemorySwap: l.ConvertedSwap(),
|
||||||
|
CPUQuota: l.ConvertedCpuLimit(),
|
||||||
|
CPUPeriod: 100_000,
|
||||||
|
CPUShares: 1024,
|
||||||
|
BlkioWeight: l.IoWeight,
|
||||||
|
OomKillDisable: &l.OOMDisabled,
|
||||||
|
CpusetCpus: l.Threads,
|
||||||
|
PidsLimit: &pids,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ package docker
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/pterodactyl/wings/metrics"
|
||||||
"io"
|
"io"
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
@@ -21,12 +22,13 @@ type Metadata struct {
|
|||||||
Stop remote.ProcessStopConfiguration
|
Stop remote.ProcessStopConfiguration
|
||||||
}
|
}
|
||||||
|
|
||||||
// Ensure that the Docker environment is always implementing all the methods
|
// Ensure that the Docker environment is always implementing all of the methods
|
||||||
// from the base environment interface.
|
// from the base environment interface.
|
||||||
var _ environment.ProcessEnvironment = (*Environment)(nil)
|
var _ environment.ProcessEnvironment = (*Environment)(nil)
|
||||||
|
|
||||||
type Environment struct {
|
type Environment struct {
|
||||||
mu sync.RWMutex
|
mu sync.RWMutex
|
||||||
|
eventMu sync.Once
|
||||||
|
|
||||||
// The public identifier for this environment. In this case it is the Docker container
|
// The public identifier for this environment. In this case it is the Docker container
|
||||||
// name that will be used for all instances created under it.
|
// name that will be used for all instances created under it.
|
||||||
@@ -47,10 +49,7 @@ type Environment struct {
|
|||||||
// Holds the stats stream used by the polling commands so that we can easily close it out.
|
// Holds the stats stream used by the polling commands so that we can easily close it out.
|
||||||
stats io.ReadCloser
|
stats io.ReadCloser
|
||||||
|
|
||||||
emitter *events.Bus
|
emitter *events.EventBus
|
||||||
|
|
||||||
logCallbackMx sync.Mutex
|
|
||||||
logCallback func([]byte)
|
|
||||||
|
|
||||||
// Tracks the environment state.
|
// Tracks the environment state.
|
||||||
st *system.AtomicString
|
st *system.AtomicString
|
||||||
@@ -72,7 +71,6 @@ func New(id string, m *Metadata, c *environment.Configuration) (*Environment, er
|
|||||||
meta: m,
|
meta: m,
|
||||||
client: cli,
|
client: cli,
|
||||||
st: system.NewAtomicString(environment.ProcessOfflineState),
|
st: system.NewAtomicString(environment.ProcessOfflineState),
|
||||||
emitter: events.NewBus(),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return e, nil
|
return e, nil
|
||||||
@@ -86,67 +84,71 @@ func (e *Environment) Type() string {
|
|||||||
return "docker"
|
return "docker"
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetStream sets the current stream value from the Docker client. If a nil
|
// Set if this process is currently attached to the process.
|
||||||
// value is provided we assume that the stream is no longer operational and the
|
|
||||||
// instance is effectively offline.
|
|
||||||
func (e *Environment) SetStream(s *types.HijackedResponse) {
|
func (e *Environment) SetStream(s *types.HijackedResponse) {
|
||||||
e.mu.Lock()
|
e.mu.Lock()
|
||||||
|
defer e.mu.Unlock()
|
||||||
|
|
||||||
e.stream = s
|
e.stream = s
|
||||||
e.mu.Unlock()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsAttached determine if the this process is currently attached to the
|
// Determine if the this process is currently attached to the container.
|
||||||
// container instance by checking if the stream is nil or not.
|
|
||||||
func (e *Environment) IsAttached() bool {
|
func (e *Environment) IsAttached() bool {
|
||||||
e.mu.RLock()
|
e.mu.RLock()
|
||||||
defer e.mu.RUnlock()
|
defer e.mu.RUnlock()
|
||||||
|
|
||||||
return e.stream != nil
|
return e.stream != nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Events returns an event bus for the environment.
|
func (e *Environment) Events() *events.EventBus {
|
||||||
func (e *Environment) Events() *events.Bus {
|
e.eventMu.Do(func() {
|
||||||
|
e.emitter = events.New()
|
||||||
|
})
|
||||||
|
|
||||||
return e.emitter
|
return e.emitter
|
||||||
}
|
}
|
||||||
|
|
||||||
// Exists determines if the container exists in this environment. The ID passed
|
// Determines if the container exists in this environment. The ID passed through should be the
|
||||||
// through should be the server UUID since containers are created utilizing the
|
// server UUID since containers are created utilizing the server UUID as the name and docker
|
||||||
// server UUID as the name and docker will work fine when using the container
|
// will work fine when using the container name as the lookup parameter in addition to the longer
|
||||||
// name as the lookup parameter in addition to the longer ID auto-assigned when
|
// ID auto-assigned when the container is created.
|
||||||
// the container is created.
|
|
||||||
func (e *Environment) Exists() (bool, error) {
|
func (e *Environment) Exists() (bool, error) {
|
||||||
_, err := e.ContainerInspect(context.Background())
|
_, err := e.client.ContainerInspect(context.Background(), e.Id)
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// If this error is because the container instance wasn't found via Docker we
|
// If this error is because the container instance wasn't found via Docker we
|
||||||
// can safely ignore the error and just return false.
|
// can safely ignore the error and just return false.
|
||||||
if client.IsErrNotFound(err) {
|
if client.IsErrNotFound(err) {
|
||||||
return false, nil
|
return false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
return false, err
|
return false, err
|
||||||
}
|
}
|
||||||
|
|
||||||
return true, nil
|
return true, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsRunning determines if the server's docker container is currently running.
|
// Determines if the server's docker container is currently running. If there is no container
|
||||||
// If there is no container present, an error will be raised (since this
|
// present, an error will be raised (since this shouldn't be a case that ever happens under
|
||||||
// shouldn't be a case that ever happens under correctly developed
|
// correctly developed circumstances).
|
||||||
// circumstances).
|
|
||||||
//
|
//
|
||||||
// You can confirm if the instance wasn't found by using client.IsErrNotFound
|
// You can confirm if the instance wasn't found by using client.IsErrNotFound from the Docker
|
||||||
// from the Docker API.
|
// API.
|
||||||
//
|
//
|
||||||
// @see docker/client/errors.go
|
// @see docker/client/errors.go
|
||||||
func (e *Environment) IsRunning(ctx context.Context) (bool, error) {
|
func (e *Environment) IsRunning() (bool, error) {
|
||||||
c, err := e.ContainerInspect(ctx)
|
c, err := e.client.ContainerInspect(context.Background(), e.Id)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return false, err
|
return false, err
|
||||||
}
|
}
|
||||||
|
|
||||||
return c.State.Running, nil
|
return c.State.Running, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExitState returns the container exit state, the exit code and whether or not
|
// Determine the container exit state and return the exit code and whether or not
|
||||||
// the container was killed by the OOM killer.
|
// the container was killed by the OOM killer.
|
||||||
func (e *Environment) ExitState() (uint32, bool, error) {
|
func (e *Environment) ExitState() (uint32, bool, error) {
|
||||||
c, err := e.ContainerInspect(context.Background())
|
c, err := e.client.ContainerInspect(context.Background(), e.Id)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// I'm not entirely sure how this can happen to be honest. I tried deleting a
|
// I'm not entirely sure how this can happen to be honest. I tried deleting a
|
||||||
// container _while_ a server was running and wings gracefully saw the crash and
|
// container _while_ a server was running and wings gracefully saw the crash and
|
||||||
@@ -160,13 +162,15 @@ func (e *Environment) ExitState() (uint32, bool, error) {
|
|||||||
if client.IsErrNotFound(err) {
|
if client.IsErrNotFound(err) {
|
||||||
return 1, false, nil
|
return 1, false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
return 0, false, err
|
return 0, false, err
|
||||||
}
|
}
|
||||||
|
|
||||||
return uint32(c.State.ExitCode), c.State.OOMKilled, nil
|
return uint32(c.State.ExitCode), c.State.OOMKilled, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Config returns the environment configuration allowing a process to make
|
// Returns the environment configuration allowing a process to make modifications of the
|
||||||
// modifications of the environment on the fly.
|
// environment on the fly.
|
||||||
func (e *Environment) Config() *environment.Configuration {
|
func (e *Environment) Config() *environment.Configuration {
|
||||||
e.mu.RLock()
|
e.mu.RLock()
|
||||||
defer e.mu.RUnlock()
|
defer e.mu.RUnlock()
|
||||||
@@ -174,11 +178,12 @@ func (e *Environment) Config() *environment.Configuration {
|
|||||||
return e.Configuration
|
return e.Configuration
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetStopConfiguration sets the stop configuration for the environment.
|
// Sets the stop configuration for the environment.
|
||||||
func (e *Environment) SetStopConfiguration(c remote.ProcessStopConfiguration) {
|
func (e *Environment) SetStopConfiguration(c remote.ProcessStopConfiguration) {
|
||||||
e.mu.Lock()
|
e.mu.Lock()
|
||||||
|
defer e.mu.Unlock()
|
||||||
|
|
||||||
e.meta.Stop = c
|
e.meta.Stop = c
|
||||||
e.mu.Unlock()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (e *Environment) SetImage(i string) {
|
func (e *Environment) SetImage(i string) {
|
||||||
@@ -208,12 +213,15 @@ func (e *Environment) SetState(state string) {
|
|||||||
// If the state changed make sure we update the internal tracking to note that.
|
// If the state changed make sure we update the internal tracking to note that.
|
||||||
e.st.Store(state)
|
e.st.Store(state)
|
||||||
e.Events().Publish(environment.StateChangeEvent, state)
|
e.Events().Publish(environment.StateChangeEvent, state)
|
||||||
|
|
||||||
|
if state == environment.ProcessRunningState || state == environment.ProcessOfflineState {
|
||||||
|
val := 0
|
||||||
|
if state == environment.ProcessRunningState {
|
||||||
|
val = 1
|
||||||
|
} else {
|
||||||
|
metrics.ResetServer(e.Id)
|
||||||
|
}
|
||||||
|
metrics.ServerStatus.WithLabelValues(e.Id).Set(float64(val))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (e *Environment) SetLogCallback(f func([]byte)) {
|
|
||||||
e.logCallbackMx.Lock()
|
|
||||||
defer e.logCallbackMx.Unlock()
|
|
||||||
|
|
||||||
e.logCallback = f
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -12,22 +12,20 @@ import (
|
|||||||
"github.com/docker/docker/api/types"
|
"github.com/docker/docker/api/types"
|
||||||
"github.com/docker/docker/api/types/container"
|
"github.com/docker/docker/api/types/container"
|
||||||
"github.com/docker/docker/client"
|
"github.com/docker/docker/client"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
)
|
)
|
||||||
|
|
||||||
// OnBeforeStart run before the container starts and get the process
|
// Run before the container starts and get the process configuration from the Panel.
|
||||||
// configuration from the Panel. This is important since we use this to check
|
// This is important since we use this to check configuration files as well as ensure
|
||||||
// configuration files as well as ensure we always have the latest version of
|
// we always have the latest version of an egg available for server processes.
|
||||||
// an egg available for server processes.
|
|
||||||
//
|
//
|
||||||
// This process will also confirm that the server environment exists and is in
|
// This process will also confirm that the server environment exists and is in a bootable
|
||||||
// a bootable state. This ensures that unexpected container deletion while Wings
|
// state. This ensures that unexpected container deletion while Wings is running does
|
||||||
// is running does not result in the server becoming un-bootable.
|
// not result in the server becoming un-bootable.
|
||||||
func (e *Environment) OnBeforeStart(ctx context.Context) error {
|
func (e *Environment) OnBeforeStart() error {
|
||||||
// Always destroy and re-create the server container to ensure that synced data from the Panel is used.
|
// Always destroy and re-create the server container to ensure that synced data from the Panel is used.
|
||||||
if err := e.client.ContainerRemove(ctx, e.Id, types.ContainerRemoveOptions{RemoveVolumes: true}); err != nil {
|
if err := e.client.ContainerRemove(context.Background(), e.Id, types.ContainerRemoveOptions{RemoveVolumes: true}); err != nil {
|
||||||
if !client.IsErrNotFound(err) {
|
if !client.IsErrNotFound(err) {
|
||||||
return errors.WrapIf(err, "environment/docker: failed to remove container during pre-boot")
|
return errors.WrapIf(err, "environment/docker: failed to remove container during pre-boot")
|
||||||
}
|
}
|
||||||
@@ -47,10 +45,10 @@ func (e *Environment) OnBeforeStart(ctx context.Context) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Start will start the server environment and begins piping output to the event
|
// Starts the server environment and begins piping output to the event listeners for the
|
||||||
// listeners for the console. If a container does not exist, or needs to be
|
// console. If a container does not exist, or needs to be rebuilt that will happen in the
|
||||||
// rebuilt that will happen in the call to OnBeforeStart().
|
// call to OnBeforeStart().
|
||||||
func (e *Environment) Start(ctx context.Context) error {
|
func (e *Environment) Start() error {
|
||||||
sawError := false
|
sawError := false
|
||||||
|
|
||||||
// If sawError is set to true there was an error somewhere in the pipeline that
|
// If sawError is set to true there was an error somewhere in the pipeline that
|
||||||
@@ -66,7 +64,7 @@ func (e *Environment) Start(ctx context.Context) error {
|
|||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
if c, err := e.ContainerInspect(ctx); err != nil {
|
if c, err := e.client.ContainerInspect(context.Background(), e.Id); err != nil {
|
||||||
// Do nothing if the container is not found, we just don't want to continue
|
// Do nothing if the container is not found, we just don't want to continue
|
||||||
// to the next block of code here. This check was inlined here to guard against
|
// to the next block of code here. This check was inlined here to guard against
|
||||||
// a nil-pointer when checking c.State below.
|
// a nil-pointer when checking c.State below.
|
||||||
@@ -80,10 +78,10 @@ func (e *Environment) Start(ctx context.Context) error {
|
|||||||
if c.State.Running {
|
if c.State.Running {
|
||||||
e.SetState(environment.ProcessRunningState)
|
e.SetState(environment.ProcessRunningState)
|
||||||
|
|
||||||
return e.Attach(ctx)
|
return e.Attach()
|
||||||
}
|
}
|
||||||
|
|
||||||
// Truncate the log file, so we don't end up outputting a bunch of useless log information
|
// Truncate the log file so we don't end up outputting a bunch of useless log information
|
||||||
// to the websocket and whatnot. Check first that the path and file exist before trying
|
// to the websocket and whatnot. Check first that the path and file exist before trying
|
||||||
// to truncate them.
|
// to truncate them.
|
||||||
if _, err := os.Stat(c.LogPath); err == nil {
|
if _, err := os.Stat(c.LogPath); err == nil {
|
||||||
@@ -102,33 +100,21 @@ func (e *Environment) Start(ctx context.Context) error {
|
|||||||
// Run the before start function and wait for it to finish. This will validate that the container
|
// Run the before start function and wait for it to finish. This will validate that the container
|
||||||
// exists on the system, and rebuild the container if that is required for server booting to
|
// exists on the system, and rebuild the container if that is required for server booting to
|
||||||
// occur.
|
// occur.
|
||||||
if err := e.OnBeforeStart(ctx); err != nil {
|
if err := e.OnBeforeStart(); err != nil {
|
||||||
return errors.WithStackIf(err)
|
return errors.WithStackIf(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// If we cannot start & attach to the container in 30 seconds something has gone
|
ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
|
||||||
// quite sideways and we should stop trying to avoid a hanging situation.
|
|
||||||
actx, cancel := context.WithTimeout(ctx, time.Second*30)
|
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
// You must attach to the instance _before_ you start the container. If you do this
|
if err := e.client.ContainerStart(ctx, e.Id, types.ContainerStartOptions{}); err != nil {
|
||||||
// in the opposite order you'll enter a deadlock condition where we're attached to
|
|
||||||
// the instance successfully, but the container has already stopped and you'll get
|
|
||||||
// the entire program into a very confusing state.
|
|
||||||
//
|
|
||||||
// By explicitly attaching to the instance before we start it, we can immediately
|
|
||||||
// react to errors/output stopping/etc. when starting.
|
|
||||||
if err := e.Attach(actx); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := e.client.ContainerStart(actx, e.Id, types.ContainerStartOptions{}); err != nil {
|
|
||||||
return errors.WrapIf(err, "environment/docker: failed to start container")
|
return errors.WrapIf(err, "environment/docker: failed to start container")
|
||||||
}
|
}
|
||||||
|
|
||||||
// No errors, good to continue through.
|
// No errors, good to continue through.
|
||||||
sawError = false
|
sawError = false
|
||||||
return nil
|
|
||||||
|
return e.Attach()
|
||||||
}
|
}
|
||||||
|
|
||||||
// Stop stops the container that the server is running in. This will allow up to
|
// Stop stops the container that the server is running in. This will allow up to
|
||||||
@@ -138,7 +124,9 @@ func (e *Environment) Start(ctx context.Context) error {
|
|||||||
// You most likely want to be using WaitForStop() rather than this function,
|
// You most likely want to be using WaitForStop() rather than this function,
|
||||||
// since this will return as soon as the command is sent, rather than waiting
|
// since this will return as soon as the command is sent, rather than waiting
|
||||||
// for the process to be completed stopped.
|
// for the process to be completed stopped.
|
||||||
func (e *Environment) Stop(ctx context.Context) error {
|
//
|
||||||
|
// TODO: pass context through from the server instance.
|
||||||
|
func (e *Environment) Stop() error {
|
||||||
e.mu.RLock()
|
e.mu.RLock()
|
||||||
s := e.meta.Stop
|
s := e.meta.Stop
|
||||||
e.mu.RUnlock()
|
e.mu.RUnlock()
|
||||||
@@ -162,7 +150,7 @@ func (e *Environment) Stop(ctx context.Context) error {
|
|||||||
case "SIGTERM":
|
case "SIGTERM":
|
||||||
signal = syscall.SIGTERM
|
signal = syscall.SIGTERM
|
||||||
}
|
}
|
||||||
return e.Terminate(ctx, signal)
|
return e.Terminate(signal)
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the process is already offline don't switch it back to stopping. Just leave it how
|
// If the process is already offline don't switch it back to stopping. Just leave it how
|
||||||
@@ -177,10 +165,8 @@ func (e *Environment) Stop(ctx context.Context) error {
|
|||||||
return e.SendCommand(s.Value)
|
return e.SendCommand(s.Value)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Allow the stop action to run for however long it takes, similar to executing a command
|
t := time.Second * 30
|
||||||
// and using a different logic pathway to wait for the container to stop successfully.
|
if err := e.client.ContainerStop(context.Background(), e.Id, &t); err != nil {
|
||||||
t := time.Duration(-1)
|
|
||||||
if err := e.client.ContainerStop(ctx, e.Id, &t); err != nil {
|
|
||||||
// If the container does not exist just mark the process as stopped and return without
|
// If the container does not exist just mark the process as stopped and return without
|
||||||
// an error.
|
// an error.
|
||||||
if client.IsErrNotFound(err) {
|
if client.IsErrNotFound(err) {
|
||||||
@@ -198,66 +184,45 @@ func (e *Environment) Stop(ctx context.Context) error {
|
|||||||
// command. If the server does not stop after seconds have passed, an error will
|
// command. If the server does not stop after seconds have passed, an error will
|
||||||
// be returned, or the instance will be terminated forcefully depending on the
|
// be returned, or the instance will be terminated forcefully depending on the
|
||||||
// value of the second argument.
|
// value of the second argument.
|
||||||
//
|
func (e *Environment) WaitForStop(seconds uint, terminate bool) error {
|
||||||
// Calls to Environment.Terminate() in this function use the context passed
|
if err := e.Stop(); err != nil {
|
||||||
// through since we don't want to prevent termination of the server instance
|
|
||||||
// just because the context.WithTimeout() has expired.
|
|
||||||
func (e *Environment) WaitForStop(ctx context.Context, duration time.Duration, terminate bool) error {
|
|
||||||
tctx, cancel := context.WithTimeout(context.Background(), duration)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
// If the parent context is canceled, abort the timed context for termination.
|
|
||||||
go func() {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
cancel()
|
|
||||||
case <-tctx.Done():
|
|
||||||
// When the timed context is canceled, terminate this routine since we no longer
|
|
||||||
// need to worry about the parent routine being canceled.
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
doTermination := func(s string) error {
|
|
||||||
e.log().WithField("step", s).WithField("duration", duration).Warn("container stop did not complete in time, terminating process...")
|
|
||||||
return e.Terminate(ctx, os.Kill)
|
|
||||||
}
|
|
||||||
|
|
||||||
// We pass through the timed context for this stop action so that if one of the
|
|
||||||
// internal docker calls fails to ever finish before we've exhausted the time limit
|
|
||||||
// the resources get cleaned up, and the exection is stopped.
|
|
||||||
if err := e.Stop(tctx); err != nil {
|
|
||||||
if terminate && errors.Is(err, context.DeadlineExceeded) {
|
|
||||||
return doTermination("stop")
|
|
||||||
}
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), time.Duration(seconds)*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
// Block the return of this function until the container as been marked as no
|
// Block the return of this function until the container as been marked as no
|
||||||
// longer running. If this wait does not end by the time seconds have passed,
|
// longer running. If this wait does not end by the time seconds have passed,
|
||||||
// attempt to terminate the container, or return an error.
|
// attempt to terminate the container, or return an error.
|
||||||
ok, errChan := e.client.ContainerWait(tctx, e.Id, container.WaitConditionNotRunning)
|
ok, errChan := e.client.ContainerWait(ctx, e.Id, container.WaitConditionNotRunning)
|
||||||
select {
|
select {
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
if err := ctx.Err(); err != nil {
|
if ctxErr := ctx.Err(); ctxErr != nil {
|
||||||
if terminate {
|
if terminate {
|
||||||
return doTermination("parent-context")
|
log.WithField("container_id", e.Id).Info("server did not stop in time, executing process termination")
|
||||||
|
|
||||||
|
return e.Terminate(os.Kill)
|
||||||
}
|
}
|
||||||
return err
|
|
||||||
|
return ctxErr
|
||||||
}
|
}
|
||||||
case err := <-errChan:
|
case err := <-errChan:
|
||||||
// If the error stems from the container not existing there is no point in wasting
|
// If the error stems from the container not existing there is no point in wasting
|
||||||
// CPU time to then try and terminate it.
|
// CPU time to then try and terminate it.
|
||||||
if err == nil || client.IsErrNotFound(err) {
|
if err != nil && !client.IsErrNotFound(err) {
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if terminate {
|
if terminate {
|
||||||
if !errors.Is(err, context.DeadlineExceeded) {
|
l := log.WithField("container_id", e.Id)
|
||||||
e.log().WithField("error", err).Warn("error while waiting for container stop; terminating process")
|
if errors.Is(err, context.DeadlineExceeded) {
|
||||||
|
l.Warn("deadline exceeded for container stop; terminating process")
|
||||||
|
} else {
|
||||||
|
l.WithField("error", err).Warn("error while waiting for container stop; terminating process")
|
||||||
}
|
}
|
||||||
return doTermination("wait")
|
|
||||||
|
return e.Terminate(os.Kill)
|
||||||
}
|
}
|
||||||
return errors.WrapIf(err, "environment/docker: error waiting on container to enter \"not-running\" state")
|
return errors.WrapIf(err, "environment/docker: error waiting on container to enter \"not-running\" state")
|
||||||
|
}
|
||||||
case <-ok:
|
case <-ok:
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -265,8 +230,8 @@ func (e *Environment) WaitForStop(ctx context.Context, duration time.Duration, t
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Terminate forcefully terminates the container using the signal provided.
|
// Terminate forcefully terminates the container using the signal provided.
|
||||||
func (e *Environment) Terminate(ctx context.Context, signal os.Signal) error {
|
func (e *Environment) Terminate(signal os.Signal) error {
|
||||||
c, err := e.ContainerInspect(ctx)
|
c, err := e.client.ContainerInspect(context.Background(), e.Id)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// Treat missing containers as an okay error state, means it is obviously
|
// Treat missing containers as an okay error state, means it is obviously
|
||||||
// already terminated at this point.
|
// already terminated at this point.
|
||||||
@@ -277,7 +242,7 @@ func (e *Environment) Terminate(ctx context.Context, signal os.Signal) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if !c.State.Running {
|
if !c.State.Running {
|
||||||
// If the container is not running, but we're not already in a stopped state go ahead
|
// If the container is not running but we're not already in a stopped state go ahead
|
||||||
// and update things to indicate we should be completely stopped now. Set to stopping
|
// and update things to indicate we should be completely stopped now. Set to stopping
|
||||||
// first so crash detection is not triggered.
|
// first so crash detection is not triggered.
|
||||||
if e.st.Load() != environment.ProcessOfflineState {
|
if e.st.Load() != environment.ProcessOfflineState {
|
||||||
@@ -291,7 +256,7 @@ func (e *Environment) Terminate(ctx context.Context, signal os.Signal) error {
|
|||||||
// We set it to stopping than offline to prevent crash detection from being triggered.
|
// We set it to stopping than offline to prevent crash detection from being triggered.
|
||||||
e.SetState(environment.ProcessStoppingState)
|
e.SetState(environment.ProcessStoppingState)
|
||||||
sig := strings.TrimSuffix(strings.TrimPrefix(signal.String(), "signal "), "ed")
|
sig := strings.TrimSuffix(strings.TrimPrefix(signal.String(), "signal "), "ed")
|
||||||
if err := e.client.ContainerKill(ctx, e.Id, sig); err != nil && !client.IsErrNotFound(err) {
|
if err := e.client.ContainerKill(context.Background(), e.Id, sig); err != nil && !client.IsErrNotFound(err) {
|
||||||
return errors.WithStack(err)
|
return errors.WithStack(err)
|
||||||
}
|
}
|
||||||
e.SetState(environment.ProcessOfflineState)
|
e.SetState(environment.ProcessOfflineState)
|
||||||
|
|||||||
@@ -2,34 +2,15 @@ package docker
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"emperror.dev/errors"
|
||||||
|
"encoding/json"
|
||||||
|
"github.com/docker/docker/api/types"
|
||||||
|
"github.com/pterodactyl/wings/environment"
|
||||||
|
"github.com/pterodactyl/wings/metrics"
|
||||||
"io"
|
"io"
|
||||||
"math"
|
"math"
|
||||||
"time"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/docker/docker/api/types"
|
|
||||||
"github.com/goccy/go-json"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/environment"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Uptime returns the current uptime of the container in milliseconds. If the
|
|
||||||
// container is not currently running this will return 0.
|
|
||||||
func (e *Environment) Uptime(ctx context.Context) (int64, error) {
|
|
||||||
ins, err := e.ContainerInspect(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return 0, errors.Wrap(err, "environment: could not inspect container")
|
|
||||||
}
|
|
||||||
if !ins.State.Running {
|
|
||||||
return 0, nil
|
|
||||||
}
|
|
||||||
started, err := time.Parse(time.RFC3339, ins.State.StartedAt)
|
|
||||||
if err != nil {
|
|
||||||
return 0, errors.Wrap(err, "environment: failed to parse container start time")
|
|
||||||
}
|
|
||||||
return time.Since(started).Milliseconds(), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Attach to the instance and then automatically emit an event whenever the resource usage for the
|
// Attach to the instance and then automatically emit an event whenever the resource usage for the
|
||||||
// server process changes.
|
// server process changes.
|
||||||
func (e *Environment) pollResources(ctx context.Context) error {
|
func (e *Environment) pollResources(ctx context.Context) error {
|
||||||
@@ -46,11 +27,6 @@ func (e *Environment) pollResources(ctx context.Context) error {
|
|||||||
}
|
}
|
||||||
defer stats.Body.Close()
|
defer stats.Body.Close()
|
||||||
|
|
||||||
uptime, err := e.Uptime(ctx)
|
|
||||||
if err != nil {
|
|
||||||
e.log().WithField("error", err).Warn("failed to calculate container uptime")
|
|
||||||
}
|
|
||||||
|
|
||||||
dec := json.NewDecoder(stats.Body)
|
dec := json.NewDecoder(stats.Body)
|
||||||
for {
|
for {
|
||||||
select {
|
select {
|
||||||
@@ -73,12 +49,7 @@ func (e *Environment) pollResources(ctx context.Context) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
if !v.PreRead.IsZero() {
|
|
||||||
uptime = uptime + v.Read.Sub(v.PreRead).Milliseconds()
|
|
||||||
}
|
|
||||||
|
|
||||||
st := environment.Stats{
|
st := environment.Stats{
|
||||||
Uptime: uptime,
|
|
||||||
Memory: calculateDockerMemory(v.MemoryStats),
|
Memory: calculateDockerMemory(v.MemoryStats),
|
||||||
MemoryLimit: v.MemoryStats.Limit,
|
MemoryLimit: v.MemoryStats.Limit,
|
||||||
CpuAbsolute: calculateDockerAbsoluteCpu(v.PreCPUStats, v.CPUStats),
|
CpuAbsolute: calculateDockerAbsoluteCpu(v.PreCPUStats, v.CPUStats),
|
||||||
@@ -90,7 +61,16 @@ func (e *Environment) pollResources(ctx context.Context) error {
|
|||||||
st.Network.TxBytes += nw.TxBytes
|
st.Network.TxBytes += nw.TxBytes
|
||||||
}
|
}
|
||||||
|
|
||||||
e.Events().Publish(environment.ResourceEvent, st)
|
metrics.ServerCPU.WithLabelValues(e.Id).Set(st.CpuAbsolute)
|
||||||
|
metrics.ServerMemory.WithLabelValues(e.Id).Set(float64(st.Memory))
|
||||||
|
metrics.ServerNetworkRx.WithLabelValues(e.Id).Set(float64(st.Network.RxBytes))
|
||||||
|
metrics.ServerNetworkTx.WithLabelValues(e.Id).Set(float64(st.Network.TxBytes))
|
||||||
|
|
||||||
|
if b, err := json.Marshal(st); err != nil {
|
||||||
|
e.log().WithField("error", err).Warn("error while marshaling stats object for environment")
|
||||||
|
} else {
|
||||||
|
e.Events().Publish(environment.ResourceEvent, string(b))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -99,8 +79,9 @@ func (e *Environment) pollResources(ctx context.Context) error {
|
|||||||
// value which can be rather confusing to people trying to compare panel usage to
|
// value which can be rather confusing to people trying to compare panel usage to
|
||||||
// their stats output.
|
// their stats output.
|
||||||
//
|
//
|
||||||
// This math is from their CLI repository in order to show the same values to avoid people
|
// This math is straight up lifted from their CLI repository in order to show the same
|
||||||
// bothering me about it. It should also reflect a slightly more correct memory value anyways.
|
// values to avoid people bothering me about it. It should also reflect a slightly more
|
||||||
|
// correct memory value anyways.
|
||||||
//
|
//
|
||||||
// @see https://github.com/docker/cli/blob/96e1d1d6/cli/command/container/stats_helpers.go#L227-L249
|
// @see https://github.com/docker/cli/blob/96e1d1d6/cli/command/container/stats_helpers.go#L227-L249
|
||||||
func calculateDockerMemory(stats types.MemoryStats) uint64 {
|
func calculateDockerMemory(stats types.MemoryStats) uint64 {
|
||||||
|
|||||||
@@ -1,14 +1,13 @@
|
|||||||
package environment
|
package environment
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
|
||||||
"os"
|
"os"
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/events"
|
"github.com/pterodactyl/wings/events"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
ConsoleOutputEvent = "console output"
|
||||||
StateChangeEvent = "state change"
|
StateChangeEvent = "state change"
|
||||||
ResourceEvent = "resources"
|
ResourceEvent = "resources"
|
||||||
DockerImagePullStarted = "docker image pull started"
|
DockerImagePullStarted = "docker image pull started"
|
||||||
@@ -35,16 +34,16 @@ type ProcessEnvironment interface {
|
|||||||
// Returns an event emitter instance that can be hooked into to listen for different
|
// Returns an event emitter instance that can be hooked into to listen for different
|
||||||
// events that are fired by the environment. This should not allow someone to publish
|
// events that are fired by the environment. This should not allow someone to publish
|
||||||
// events, only subscribe to them.
|
// events, only subscribe to them.
|
||||||
Events() *events.Bus
|
Events() *events.EventBus
|
||||||
|
|
||||||
// Determines if the server instance exists. For example, in a docker environment
|
// Determines if the server instance exists. For example, in a docker environment
|
||||||
// this should confirm that the container is created and in a bootable state. In
|
// this should confirm that the container is created and in a bootable state. In
|
||||||
// a basic CLI environment this can probably just return true right away.
|
// a basic CLI environment this can probably just return true right away.
|
||||||
Exists() (bool, error)
|
Exists() (bool, error)
|
||||||
|
|
||||||
// IsRunning determines if the environment is currently active and running
|
// Determines if the environment is currently active and running a server process
|
||||||
// a server process for this specific server instance.
|
// for this specific server instance.
|
||||||
IsRunning(ctx context.Context) (bool, error)
|
IsRunning() (bool, error)
|
||||||
|
|
||||||
// Performs an update of server resource limits without actually stopping the server
|
// Performs an update of server resource limits without actually stopping the server
|
||||||
// process. This only executes if the environment supports it, otherwise it is
|
// process. This only executes if the environment supports it, otherwise it is
|
||||||
@@ -53,26 +52,24 @@ type ProcessEnvironment interface {
|
|||||||
|
|
||||||
// Runs before the environment is started. If an error is returned starting will
|
// Runs before the environment is started. If an error is returned starting will
|
||||||
// not occur, otherwise proceeds as normal.
|
// not occur, otherwise proceeds as normal.
|
||||||
OnBeforeStart(ctx context.Context) error
|
OnBeforeStart() error
|
||||||
|
|
||||||
// Starts a server instance. If the server instance is not in a state where it
|
// Starts a server instance. If the server instance is not in a state where it
|
||||||
// can be started an error should be returned.
|
// can be started an error should be returned.
|
||||||
Start(ctx context.Context) error
|
Start() error
|
||||||
|
|
||||||
// Stop stops a server instance. If the server is already stopped an error will
|
// Stops a server instance. If the server is already stopped an error should
|
||||||
// not be returned, this function will act as a no-op.
|
// not be returned.
|
||||||
Stop(ctx context.Context) error
|
Stop() error
|
||||||
|
|
||||||
// WaitForStop waits for a server instance to stop gracefully. If the server is
|
// Waits for a server instance to stop gracefully. If the server is still detected
|
||||||
// still detected as running after "duration", an error will be returned, or the server
|
// as running after seconds, an error will be returned, or the server will be terminated
|
||||||
// will be terminated depending on the value of the second argument. If the context
|
// depending on the value of the second argument.
|
||||||
// provided is canceled the underlying wait conditions will be stopped and the
|
WaitForStop(seconds uint, terminate bool) error
|
||||||
// entire loop will be ended (potentially without stopping or terminating).
|
|
||||||
WaitForStop(ctx context.Context, duration time.Duration, terminate bool) error
|
|
||||||
|
|
||||||
// Terminate stops a running server instance using the provided signal. This function
|
// Terminates a running server instance using the provided signal. If the server
|
||||||
// is a no-op if the server is already stopped.
|
// is not running no error should be returned.
|
||||||
Terminate(ctx context.Context, signal os.Signal) error
|
Terminate(signal os.Signal) error
|
||||||
|
|
||||||
// Destroys the environment removing any containers that were created (in Docker
|
// Destroys the environment removing any containers that were created (in Docker
|
||||||
// environments at least).
|
// environments at least).
|
||||||
@@ -87,10 +84,10 @@ type ProcessEnvironment interface {
|
|||||||
// server.
|
// server.
|
||||||
Create() error
|
Create() error
|
||||||
|
|
||||||
// Attach attaches to the server console environment and allows piping the output
|
// Attaches to the server console environment and allows piping the output to a
|
||||||
// to a websocket or other internal tool to monitor output. Also allows you to later
|
// websocket or other internal tool to monitor output. Also allows you to later
|
||||||
// send data into the environment's stdin.
|
// send data into the environment's stdin.
|
||||||
Attach(ctx context.Context) error
|
Attach() error
|
||||||
|
|
||||||
// Sends the provided command to the running server instance.
|
// Sends the provided command to the running server instance.
|
||||||
SendCommand(string) error
|
SendCommand(string) error
|
||||||
@@ -106,11 +103,4 @@ type ProcessEnvironment interface {
|
|||||||
// handle this itself, but there are some scenarios where it is helpful for the server
|
// handle this itself, but there are some scenarios where it is helpful for the server
|
||||||
// to update the state externally (e.g. starting -> started).
|
// to update the state externally (e.g. starting -> started).
|
||||||
SetState(string)
|
SetState(string)
|
||||||
|
|
||||||
// Uptime returns the current environment uptime in milliseconds. This is
|
|
||||||
// the time that has passed since it was last started.
|
|
||||||
Uptime(ctx context.Context) (int64, error)
|
|
||||||
|
|
||||||
// SetLogCallback sets the callback that the container's log output will be passed to.
|
|
||||||
SetLogCallback(func([]byte))
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ import (
|
|||||||
|
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/docker/docker/api/types/container"
|
"github.com/docker/docker/api/types/container"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -26,7 +25,7 @@ type Mount struct {
|
|||||||
// that we're mounting into the container at the Target location.
|
// that we're mounting into the container at the Target location.
|
||||||
Source string `json:"source"`
|
Source string `json:"source"`
|
||||||
|
|
||||||
// Whether the directory is being mounted as read-only. It is up to the environment to
|
// Whether or not the directory is being mounted as read-only. It is up to the environment to
|
||||||
// handle this value correctly and ensure security expectations are met with its usage.
|
// handle this value correctly and ensure security expectations are met with its usage.
|
||||||
ReadOnly bool `json:"read_only"`
|
ReadOnly bool `json:"read_only"`
|
||||||
}
|
}
|
||||||
@@ -75,7 +74,13 @@ func (l Limits) ConvertedCpuLimit() int64 {
|
|||||||
// server is < 4G, use 10%, if less than 2G use 15%. This avoids unexpected
|
// server is < 4G, use 10%, if less than 2G use 15%. This avoids unexpected
|
||||||
// crashes from processes like Java which run over the limit.
|
// crashes from processes like Java which run over the limit.
|
||||||
func (l Limits) MemoryOverheadMultiplier() float64 {
|
func (l Limits) MemoryOverheadMultiplier() float64 {
|
||||||
return config.Get().Docker.Overhead.GetMultiplier(l.MemoryLimit)
|
if l.MemoryLimit <= 2048 {
|
||||||
|
return 1.15
|
||||||
|
} else if l.MemoryLimit <= 4096 {
|
||||||
|
return 1.10
|
||||||
|
}
|
||||||
|
|
||||||
|
return 1.05
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l Limits) BoundedMemoryLimit() int64 {
|
func (l Limits) BoundedMemoryLimit() int64 {
|
||||||
@@ -99,36 +104,21 @@ func (l Limits) ProcessLimit() int64 {
|
|||||||
return config.Get().Docker.ContainerPidLimit
|
return config.Get().Docker.ContainerPidLimit
|
||||||
}
|
}
|
||||||
|
|
||||||
// AsContainerResources returns the available resources for a container in a format
|
|
||||||
// that Docker understands.
|
|
||||||
func (l Limits) AsContainerResources() container.Resources {
|
func (l Limits) AsContainerResources() container.Resources {
|
||||||
pids := l.ProcessLimit()
|
pids := l.ProcessLimit()
|
||||||
resources := container.Resources{
|
|
||||||
|
return container.Resources{
|
||||||
Memory: l.BoundedMemoryLimit(),
|
Memory: l.BoundedMemoryLimit(),
|
||||||
MemoryReservation: l.MemoryLimit * 1_000_000,
|
MemoryReservation: l.MemoryLimit * 1_000_000,
|
||||||
MemorySwap: l.ConvertedSwap(),
|
MemorySwap: l.ConvertedSwap(),
|
||||||
|
CPUQuota: l.ConvertedCpuLimit(),
|
||||||
|
CPUPeriod: 100_000,
|
||||||
|
CPUShares: 1024,
|
||||||
BlkioWeight: l.IoWeight,
|
BlkioWeight: l.IoWeight,
|
||||||
OomKillDisable: &l.OOMDisabled,
|
OomKillDisable: &l.OOMDisabled,
|
||||||
|
CpusetCpus: l.Threads,
|
||||||
PidsLimit: &pids,
|
PidsLimit: &pids,
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the CPU Limit is not set, don't send any of these fields through. Providing
|
|
||||||
// them seems to break some Java services that try to read the available processors.
|
|
||||||
//
|
|
||||||
// @see https://github.com/pterodactyl/panel/issues/3988
|
|
||||||
if l.CpuLimit > 0 {
|
|
||||||
resources.CPUQuota = l.CpuLimit * 1_000
|
|
||||||
resources.CPUPeriod = 100_000
|
|
||||||
resources.CPUShares = 1024
|
|
||||||
}
|
|
||||||
|
|
||||||
// Similar to above, don't set the specific assigned CPUs if we didn't actually limit
|
|
||||||
// the server to any of them.
|
|
||||||
if l.Threads != "" {
|
|
||||||
resources.CpusetCpus = l.Threads
|
|
||||||
}
|
|
||||||
|
|
||||||
return resources
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type Variables map[string]interface{}
|
type Variables map[string]interface{}
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
package environment
|
package environment
|
||||||
|
|
||||||
// Stats defines the current resource usage for a given server instance.
|
// Defines the current resource usage for a given server instance. If a server is offline you
|
||||||
|
// should obviously expect memory and CPU usage to be 0. However, disk will always be returned
|
||||||
|
// since that is not dependent on the server being running to collect that data.
|
||||||
type Stats struct {
|
type Stats struct {
|
||||||
// The total amount of memory, in bytes, that this server instance is consuming. This is
|
// The total amount of memory, in bytes, that this server instance is consuming. This is
|
||||||
// calculated slightly differently than just using the raw Memory field that the stats
|
// calculated slightly differently than just using the raw Memory field that the stats
|
||||||
@@ -10,18 +12,19 @@ type Stats struct {
|
|||||||
|
|
||||||
// The total amount of memory this container or resource can use. Inside Docker this is
|
// The total amount of memory this container or resource can use. Inside Docker this is
|
||||||
// going to be higher than you'd expect because we're automatically allocating overhead
|
// going to be higher than you'd expect because we're automatically allocating overhead
|
||||||
// abilities for the container, so it's not going to be a perfect match.
|
// abilities for the container, so its not going to be a perfect match.
|
||||||
MemoryLimit uint64 `json:"memory_limit_bytes"`
|
MemoryLimit uint64 `json:"memory_limit_bytes"`
|
||||||
|
|
||||||
// The absolute CPU usage is the amount of CPU used in relation to the entire system and
|
// The absolute CPU usage is the amount of CPU used in relation to the entire system and
|
||||||
// does not take into account any limits on the server process itself.
|
// does not take into account any limits on the server process itself.
|
||||||
CpuAbsolute float64 `json:"cpu_absolute"`
|
CpuAbsolute float64 `json:"cpu_absolute"`
|
||||||
|
|
||||||
|
// The current disk space being used by the server. This is cached to prevent slow lookup
|
||||||
|
// issues on frequent refreshes.
|
||||||
|
// Disk int64 `json:"disk_bytes"`
|
||||||
|
|
||||||
// Current network transmit in & out for a container.
|
// Current network transmit in & out for a container.
|
||||||
Network NetworkStats `json:"network"`
|
Network NetworkStats `json:"network"`
|
||||||
|
|
||||||
// The current uptime of the container, in milliseconds.
|
|
||||||
Uptime int64 `json:"uptime"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type NetworkStats struct {
|
type NetworkStats struct {
|
||||||
|
|||||||
130
events/events.go
130
events/events.go
@@ -1,70 +1,122 @@
|
|||||||
package events
|
package events
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"encoding/json"
|
||||||
"strings"
|
"strings"
|
||||||
|
"sync"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"github.com/gammazero/workerpool"
|
||||||
"github.com/goccy/go-json"
|
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Event represents an Event sent over a Bus.
|
|
||||||
type Event struct {
|
type Event struct {
|
||||||
|
Data string
|
||||||
Topic string
|
Topic string
|
||||||
Data interface{}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Bus represents an Event Bus.
|
type EventBus struct {
|
||||||
type Bus struct {
|
mu sync.RWMutex
|
||||||
*system.SinkPool
|
pools map[string]*CallbackPool
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewBus returns a new empty Bus. This is simply a nicer wrapper around the
|
func New() *EventBus {
|
||||||
// system.SinkPool implementation that allows for more simplistic usage within
|
return &EventBus{
|
||||||
// the codebase.
|
pools: make(map[string]*CallbackPool),
|
||||||
//
|
|
||||||
// All of the events emitted out of this bus are byte slices that can be decoded
|
|
||||||
// back into an events.Event interface.
|
|
||||||
func NewBus() *Bus {
|
|
||||||
return &Bus{
|
|
||||||
system.NewSinkPool(),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Publish publishes a message to the Bus.
|
// Publish data to a given topic.
|
||||||
func (b *Bus) Publish(topic string, data interface{}) {
|
func (e *EventBus) Publish(topic string, data string) {
|
||||||
// Some of our actions for the socket support passing a more specific namespace,
|
t := topic
|
||||||
|
// Some of our topics for the socket support passing a more specific namespace,
|
||||||
// such as "backup completed:1234" to indicate which specific backup was completed.
|
// such as "backup completed:1234" to indicate which specific backup was completed.
|
||||||
//
|
//
|
||||||
// In these cases, we still need to send the event using the standard listener
|
// In these cases, we still need to the send the event using the standard listener
|
||||||
// name of "backup completed".
|
// name of "backup completed".
|
||||||
if strings.Contains(topic, ":") {
|
if strings.Contains(topic, ":") {
|
||||||
parts := strings.SplitN(topic, ":", 2)
|
parts := strings.SplitN(topic, ":", 2)
|
||||||
|
|
||||||
if len(parts) == 2 {
|
if len(parts) == 2 {
|
||||||
topic = parts[0]
|
t = parts[0]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
enc, err := json.Marshal(Event{Topic: topic, Data: data})
|
e.mu.RLock()
|
||||||
|
defer e.mu.RUnlock()
|
||||||
|
|
||||||
|
// Acquire a read lock and loop over all of the channels registered for the topic. This
|
||||||
|
// avoids a panic crash if the process tries to unregister the channel while this routine
|
||||||
|
// is running.
|
||||||
|
if cp, ok := e.pools[t]; ok {
|
||||||
|
for _, callback := range cp.callbacks {
|
||||||
|
c := *callback
|
||||||
|
evt := Event{Data: data, Topic: topic}
|
||||||
|
// Using the workerpool with one worker allows us to execute events in a FIFO manner. Running
|
||||||
|
// this using goroutines would cause things such as console output to just output in random order
|
||||||
|
// if more than one event is fired at the same time.
|
||||||
|
//
|
||||||
|
// However, the pool submission does not block the execution of this function itself, allowing
|
||||||
|
// us to call publish without blocking any of the other pathways.
|
||||||
|
//
|
||||||
|
// @see https://github.com/pterodactyl/panel/issues/2303
|
||||||
|
cp.pool.Submit(func() {
|
||||||
|
c(evt)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Publishes a JSON message to a given topic.
|
||||||
|
func (e *EventBus) PublishJson(topic string, data interface{}) error {
|
||||||
|
b, err := json.Marshal(data)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
panic(errors.WithStack(err))
|
return err
|
||||||
}
|
}
|
||||||
b.Push(enc)
|
|
||||||
}
|
|
||||||
|
|
||||||
// MustDecode decodes the event byte slice back into an events.Event struct or
|
e.Publish(topic, string(b))
|
||||||
// panics if an error is encountered during this process.
|
|
||||||
func MustDecode(data []byte) (e Event) {
|
|
||||||
if err := DecodeTo(data, &e); err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// DecodeTo decodes a byte slice of event data into the given interface.
|
|
||||||
func DecodeTo(data []byte, v interface{}) error {
|
|
||||||
if err := json.Unmarshal(data, &v); err != nil {
|
|
||||||
return errors.Wrap(err, "events: failed to decode byte slice")
|
|
||||||
}
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Register a callback function that will be executed each time one of the events using the topic
|
||||||
|
// name is called.
|
||||||
|
func (e *EventBus) On(topic string, callback *func(Event)) {
|
||||||
|
e.mu.Lock()
|
||||||
|
defer e.mu.Unlock()
|
||||||
|
|
||||||
|
// Check if this topic has been registered at least once for the event listener, and if
|
||||||
|
// not create an empty struct for the topic.
|
||||||
|
if _, exists := e.pools[topic]; !exists {
|
||||||
|
e.pools[topic] = &CallbackPool{
|
||||||
|
callbacks: make([]*func(Event), 0),
|
||||||
|
pool: workerpool.New(1),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// If this callback is not already registered as an event listener, go ahead and append
|
||||||
|
// it to the array of callbacks for this topic.
|
||||||
|
e.pools[topic].Add(callback)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Removes an event listener from the bus.
|
||||||
|
func (e *EventBus) Off(topic string, callback *func(Event)) {
|
||||||
|
e.mu.Lock()
|
||||||
|
defer e.mu.Unlock()
|
||||||
|
|
||||||
|
if cp, ok := e.pools[topic]; ok {
|
||||||
|
cp.Remove(callback)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Removes all of the event listeners that have been registered for any topic. Also stops the worker
|
||||||
|
// pool to close that routine.
|
||||||
|
func (e *EventBus) Destroy() {
|
||||||
|
e.mu.Lock()
|
||||||
|
defer e.mu.Unlock()
|
||||||
|
|
||||||
|
// Stop every pool that exists for a given callback topic.
|
||||||
|
for _, cp := range e.pools {
|
||||||
|
cp.pool.Stop()
|
||||||
|
}
|
||||||
|
|
||||||
|
e.pools = make(map[string]*CallbackPool)
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,98 +0,0 @@
|
|||||||
package events
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
. "github.com/franela/goblin"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestNewBus(t *testing.T) {
|
|
||||||
g := Goblin(t)
|
|
||||||
|
|
||||||
g.Describe("Events", func() {
|
|
||||||
var bus *Bus
|
|
||||||
g.BeforeEach(func() {
|
|
||||||
bus = NewBus()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.Describe("NewBus", func() {
|
|
||||||
g.It("is not nil", func() {
|
|
||||||
g.Assert(bus).IsNotNil("Bus expected to not be nil")
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
g.Describe("Publish", func() {
|
|
||||||
const topic = "test"
|
|
||||||
const message = "this is a test message!"
|
|
||||||
|
|
||||||
g.It("publishes message", func() {
|
|
||||||
bus := NewBus()
|
|
||||||
|
|
||||||
listener := make(chan []byte)
|
|
||||||
bus.On(listener)
|
|
||||||
|
|
||||||
done := make(chan struct{}, 1)
|
|
||||||
go func() {
|
|
||||||
select {
|
|
||||||
case v := <-listener:
|
|
||||||
m := MustDecode(v)
|
|
||||||
g.Assert(m.Topic).Equal(topic)
|
|
||||||
g.Assert(m.Data).Equal(message)
|
|
||||||
case <-time.After(1 * time.Second):
|
|
||||||
g.Fail("listener did not receive message in time")
|
|
||||||
}
|
|
||||||
done <- struct{}{}
|
|
||||||
}()
|
|
||||||
bus.Publish(topic, message)
|
|
||||||
<-done
|
|
||||||
|
|
||||||
// Cleanup
|
|
||||||
bus.Off(listener)
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("publishes message to all listeners", func() {
|
|
||||||
bus := NewBus()
|
|
||||||
|
|
||||||
listener := make(chan []byte)
|
|
||||||
listener2 := make(chan []byte)
|
|
||||||
listener3 := make(chan []byte)
|
|
||||||
bus.On(listener)
|
|
||||||
bus.On(listener2)
|
|
||||||
bus.On(listener3)
|
|
||||||
|
|
||||||
done := make(chan struct{}, 1)
|
|
||||||
go func() {
|
|
||||||
for i := 0; i < 3; i++ {
|
|
||||||
select {
|
|
||||||
case v := <-listener:
|
|
||||||
m := MustDecode(v)
|
|
||||||
g.Assert(m.Topic).Equal(topic)
|
|
||||||
g.Assert(m.Data).Equal(message)
|
|
||||||
case v := <-listener2:
|
|
||||||
m := MustDecode(v)
|
|
||||||
g.Assert(m.Topic).Equal(topic)
|
|
||||||
g.Assert(m.Data).Equal(message)
|
|
||||||
case v := <-listener3:
|
|
||||||
m := MustDecode(v)
|
|
||||||
g.Assert(m.Topic).Equal(topic)
|
|
||||||
g.Assert(m.Data).Equal(message)
|
|
||||||
case <-time.After(1 * time.Second):
|
|
||||||
g.Fail("all listeners did not receive the message in time")
|
|
||||||
i = 3
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
done <- struct{}{}
|
|
||||||
}()
|
|
||||||
bus.Publish(topic, message)
|
|
||||||
<-done
|
|
||||||
|
|
||||||
// Cleanup
|
|
||||||
bus.Off(listener)
|
|
||||||
bus.Off(listener2)
|
|
||||||
bus.Off(listener3)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
50
events/pool.go
Normal file
50
events/pool.go
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
package events
|
||||||
|
|
||||||
|
import (
|
||||||
|
"reflect"
|
||||||
|
|
||||||
|
"github.com/gammazero/workerpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
type CallbackPool struct {
|
||||||
|
callbacks []*func(Event)
|
||||||
|
pool *workerpool.WorkerPool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pushes a new callback into the array of listeners for the pool.
|
||||||
|
func (cp *CallbackPool) Add(callback *func(Event)) {
|
||||||
|
if cp.index(reflect.ValueOf(callback)) < 0 {
|
||||||
|
cp.callbacks = append(cp.callbacks, callback)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Removes a callback from the array of registered callbacks if it exists.
|
||||||
|
func (cp *CallbackPool) Remove(callback *func(Event)) {
|
||||||
|
i := cp.index(reflect.ValueOf(callback))
|
||||||
|
|
||||||
|
// If i < 0 it means there was no index found for the given callback, meaning it was
|
||||||
|
// never registered or was already unregistered from the listeners. Also double check
|
||||||
|
// that we didn't somehow escape the length of the topic callback (not sure how that
|
||||||
|
// would happen, but lets avoid a panic condition).
|
||||||
|
if i < 0 || i >= len(cp.callbacks) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// We can assume that the topic still exists at this point since we acquire an exclusive
|
||||||
|
// lock on the process, and the "e.index" function cannot return a value >= 0 if there is
|
||||||
|
// no topic already existing.
|
||||||
|
cp.callbacks = append(cp.callbacks[:i], cp.callbacks[i+1:]...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Finds the index of a given callback in the topic by comparing all of the registered callback
|
||||||
|
// pointers to the passed function. This function does not aquire a lock as it should only be called
|
||||||
|
// within the confines of a function that has already acquired a lock for the duration of the lookup.
|
||||||
|
func (cp *CallbackPool) index(v reflect.Value) int {
|
||||||
|
for i, handler := range cp.callbacks {
|
||||||
|
if reflect.ValueOf(handler).Pointer() == v.Pointer() {
|
||||||
|
return i
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return -1
|
||||||
|
}
|
||||||
178
go.mod
178
go.mod
@@ -1,129 +1,83 @@
|
|||||||
module github.com/pterodactyl/wings
|
module github.com/pterodactyl/wings
|
||||||
|
|
||||||
go 1.17
|
go 1.14
|
||||||
|
|
||||||
require (
|
require (
|
||||||
emperror.dev/errors v0.8.1
|
emperror.dev/errors v0.8.0
|
||||||
github.com/AlecAivazis/survey/v2 v2.3.4
|
github.com/AlecAivazis/survey/v2 v2.2.7
|
||||||
github.com/Jeffail/gabs/v2 v2.6.1
|
github.com/Jeffail/gabs/v2 v2.6.0
|
||||||
|
github.com/Microsoft/go-winio v0.4.16 // indirect
|
||||||
|
github.com/Microsoft/hcsshim v0.8.14 // indirect
|
||||||
github.com/NYTimes/logrotate v1.0.0
|
github.com/NYTimes/logrotate v1.0.0
|
||||||
|
github.com/andybalholm/brotli v1.0.1 // indirect
|
||||||
github.com/apex/log v1.9.0
|
github.com/apex/log v1.9.0
|
||||||
github.com/asaskevich/govalidator v0.0.0-20210307081110-f21760c49a8d
|
github.com/asaskevich/govalidator v0.0.0-20200907205600-7a23bdc65eef
|
||||||
github.com/beevik/etree v1.1.0
|
github.com/beevik/etree v1.1.0
|
||||||
github.com/buger/jsonparser v1.1.1
|
github.com/buger/jsonparser v1.1.0
|
||||||
github.com/cenkalti/backoff/v4 v4.1.2
|
github.com/cenkalti/backoff/v4 v4.1.0
|
||||||
github.com/cobaugh/osrelease v0.0.0-20181218015638-a93a0a55a249
|
github.com/cobaugh/osrelease v0.0.0-20181218015638-a93a0a55a249
|
||||||
github.com/creasty/defaults v1.5.2
|
github.com/containerd/containerd v1.4.3 // indirect
|
||||||
github.com/docker/docker v20.10.14+incompatible
|
github.com/containerd/fifo v0.0.0-20201026212402-0724c46b320c // indirect
|
||||||
|
github.com/creasty/defaults v1.5.1
|
||||||
|
github.com/docker/distribution v2.7.1+incompatible // indirect
|
||||||
|
github.com/docker/docker v20.10.1+incompatible
|
||||||
github.com/docker/go-connections v0.4.0
|
github.com/docker/go-connections v0.4.0
|
||||||
github.com/fatih/color v1.13.0
|
github.com/docker/go-metrics v0.0.1 // indirect
|
||||||
|
github.com/fatih/color v1.10.0
|
||||||
github.com/franela/goblin v0.0.0-20200825194134-80c0062ed6cd
|
github.com/franela/goblin v0.0.0-20200825194134-80c0062ed6cd
|
||||||
github.com/gabriel-vasile/mimetype v1.4.0
|
github.com/fsnotify/fsnotify v1.4.9 // indirect
|
||||||
github.com/gammazero/workerpool v1.1.2
|
github.com/gabriel-vasile/mimetype v1.1.2
|
||||||
github.com/gbrlsnchs/jwt/v3 v3.0.1
|
github.com/gammazero/deque v0.0.0-20201010052221-3932da5530cc // indirect
|
||||||
github.com/gin-gonic/gin v1.7.7
|
github.com/gammazero/workerpool v1.1.1
|
||||||
github.com/google/uuid v1.3.0
|
github.com/gbrlsnchs/jwt/v3 v3.0.0
|
||||||
github.com/gorilla/websocket v1.5.0
|
github.com/gin-gonic/gin v1.6.3
|
||||||
github.com/iancoleman/strcase v0.2.0
|
github.com/go-playground/validator/v10 v10.4.1 // indirect
|
||||||
github.com/icza/dyno v0.0.0-20210726202311-f1bafe5d9996
|
github.com/golang/snappy v0.0.2 // indirect
|
||||||
|
github.com/google/go-cmp v0.5.2 // indirect
|
||||||
|
github.com/google/uuid v1.1.2
|
||||||
|
github.com/gorilla/mux v1.7.4 // indirect
|
||||||
|
github.com/gorilla/websocket v1.4.2
|
||||||
|
github.com/iancoleman/strcase v0.1.2
|
||||||
|
github.com/icza/dyno v0.0.0-20200205103839-49cb13720835
|
||||||
|
github.com/imdario/mergo v0.3.9
|
||||||
github.com/juju/ratelimit v1.0.1
|
github.com/juju/ratelimit v1.0.1
|
||||||
github.com/karrick/godirwalk v1.16.1
|
github.com/karrick/godirwalk v1.16.1
|
||||||
|
github.com/klauspost/compress v1.11.4 // indirect
|
||||||
github.com/klauspost/pgzip v1.2.5
|
github.com/klauspost/pgzip v1.2.5
|
||||||
github.com/magiconair/properties v1.8.6
|
github.com/leodido/go-urn v1.2.1 // indirect
|
||||||
github.com/mattn/go-colorable v0.1.12
|
github.com/magefile/mage v1.10.0 // indirect
|
||||||
github.com/mholt/archiver/v3 v3.5.1
|
github.com/magiconair/properties v1.8.4
|
||||||
|
github.com/mattn/go-colorable v0.1.8
|
||||||
|
github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
|
||||||
|
github.com/mholt/archiver/v3 v3.5.0
|
||||||
github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db
|
github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db
|
||||||
|
github.com/moby/term v0.0.0-20201216013528-df9cb8a40635 // indirect
|
||||||
|
github.com/morikuni/aec v1.0.0 // indirect
|
||||||
|
github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
|
||||||
|
github.com/opencontainers/go-digest v1.0.0 // indirect
|
||||||
|
github.com/opencontainers/image-spec v1.0.1 // indirect
|
||||||
github.com/patrickmn/go-cache v2.1.0+incompatible
|
github.com/patrickmn/go-cache v2.1.0+incompatible
|
||||||
github.com/pkg/sftp v1.13.4
|
github.com/pierrec/lz4/v4 v4.1.2 // indirect
|
||||||
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06
|
github.com/pkg/profile v1.5.0
|
||||||
github.com/spf13/cobra v1.4.0
|
github.com/pkg/sftp v1.12.0
|
||||||
github.com/stretchr/testify v1.7.5
|
github.com/prometheus/client_golang v1.9.0 // indirect
|
||||||
golang.org/x/crypto v0.0.0-20220321153916-2c7772ba3064
|
github.com/sabhiram/go-gitignore v0.0.0-20201211210132-54b8a0bf510f
|
||||||
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
|
github.com/sirupsen/logrus v1.7.0 // indirect
|
||||||
gopkg.in/ini.v1 v1.66.4
|
github.com/spf13/cobra v1.1.1
|
||||||
|
github.com/stretchr/testify v1.6.1
|
||||||
|
github.com/ugorji/go v1.2.2 // indirect
|
||||||
|
github.com/ulikunitz/xz v0.5.9 // indirect
|
||||||
|
golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad
|
||||||
|
golang.org/x/net v0.0.0-20201224014010-6772e930b67b // indirect
|
||||||
|
golang.org/x/sync v0.0.0-20201207232520-09787c993a3a
|
||||||
|
golang.org/x/sys v0.0.0-20201223074533-0d417f636930 // indirect
|
||||||
|
golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf // indirect
|
||||||
|
golang.org/x/text v0.3.4 // indirect
|
||||||
|
golang.org/x/time v0.0.0-20201208040808-7e3f01d25324 // indirect
|
||||||
|
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
|
||||||
|
google.golang.org/genproto v0.0.0-20201214200347-8c77b98c765d // indirect
|
||||||
|
google.golang.org/grpc v1.34.0 // indirect
|
||||||
|
gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
|
||||||
|
gopkg.in/ini.v1 v1.62.0
|
||||||
gopkg.in/yaml.v2 v2.4.0
|
gopkg.in/yaml.v2 v2.4.0
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
|
||||||
github.com/glebarez/sqlite v1.4.6
|
|
||||||
github.com/go-co-op/gocron v1.15.0
|
|
||||||
github.com/goccy/go-json v0.9.6
|
|
||||||
github.com/klauspost/compress v1.15.1
|
|
||||||
gorm.io/gorm v1.23.8
|
|
||||||
)
|
|
||||||
|
|
||||||
require golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f // indirect
|
|
||||||
|
|
||||||
require (
|
|
||||||
github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
|
|
||||||
github.com/Microsoft/go-winio v0.5.2 // indirect
|
|
||||||
github.com/Microsoft/hcsshim v0.9.2 // indirect
|
|
||||||
github.com/andybalholm/brotli v1.0.4 // indirect
|
|
||||||
github.com/beorn7/perks v1.0.1 // indirect
|
|
||||||
github.com/cespare/xxhash/v2 v2.1.2 // indirect
|
|
||||||
github.com/containerd/containerd v1.6.2 // indirect
|
|
||||||
github.com/containerd/fifo v1.0.0 // indirect
|
|
||||||
github.com/davecgh/go-spew v1.1.1 // indirect
|
|
||||||
github.com/docker/distribution v2.8.1+incompatible // indirect
|
|
||||||
github.com/docker/go-metrics v0.0.1 // indirect
|
|
||||||
github.com/docker/go-units v0.4.0 // indirect
|
|
||||||
github.com/dsnet/compress v0.0.2-0.20210315054119-f66993602bf5 // indirect
|
|
||||||
github.com/fsnotify/fsnotify v1.5.1 // indirect
|
|
||||||
github.com/gammazero/deque v0.1.1 // indirect
|
|
||||||
github.com/gin-contrib/sse v0.1.0 // indirect
|
|
||||||
github.com/glebarez/go-sqlite v1.17.3 // indirect
|
|
||||||
github.com/go-playground/locales v0.14.0 // indirect
|
|
||||||
github.com/go-playground/universal-translator v0.18.0 // indirect
|
|
||||||
github.com/go-playground/validator/v10 v10.10.1 // indirect
|
|
||||||
github.com/gogo/protobuf v1.3.2 // indirect
|
|
||||||
github.com/golang/protobuf v1.5.2 // indirect
|
|
||||||
github.com/golang/snappy v0.0.4 // indirect
|
|
||||||
github.com/gorilla/mux v1.7.4 // indirect
|
|
||||||
github.com/inconshreveable/mousetrap v1.0.0 // indirect
|
|
||||||
github.com/jinzhu/inflection v1.0.0 // indirect
|
|
||||||
github.com/jinzhu/now v1.1.5 // indirect
|
|
||||||
github.com/json-iterator/go v1.1.12 // indirect
|
|
||||||
github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
|
|
||||||
github.com/kr/fs v0.1.0 // indirect
|
|
||||||
github.com/leodido/go-urn v1.2.1 // indirect
|
|
||||||
github.com/magefile/mage v1.13.0 // indirect
|
|
||||||
github.com/mattn/go-isatty v0.0.14 // indirect
|
|
||||||
github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369 // indirect
|
|
||||||
github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
|
|
||||||
github.com/moby/term v0.0.0-20210619224110-3f7ff695adc6 // indirect
|
|
||||||
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
|
|
||||||
github.com/modern-go/reflect2 v1.0.2 // indirect
|
|
||||||
github.com/morikuni/aec v1.0.0 // indirect
|
|
||||||
github.com/nwaples/rardecode v1.1.3 // indirect
|
|
||||||
github.com/opencontainers/go-digest v1.0.0 // indirect
|
|
||||||
github.com/opencontainers/image-spec v1.0.2 // indirect
|
|
||||||
github.com/pierrec/lz4/v4 v4.1.14 // indirect
|
|
||||||
github.com/pkg/errors v0.9.1 // indirect
|
|
||||||
github.com/pmezard/go-difflib v1.0.0 // indirect
|
|
||||||
github.com/prometheus/client_golang v1.12.1 // indirect
|
|
||||||
github.com/prometheus/client_model v0.2.0 // indirect
|
|
||||||
github.com/prometheus/common v0.32.1 // indirect
|
|
||||||
github.com/prometheus/procfs v0.7.3 // indirect
|
|
||||||
github.com/remyoudompheng/bigfft v0.0.0-20200410134404-eec4a21b6bb0 // indirect
|
|
||||||
github.com/robfig/cron/v3 v3.0.1 // indirect
|
|
||||||
github.com/sirupsen/logrus v1.8.1 // indirect
|
|
||||||
github.com/spf13/pflag v1.0.5 // indirect
|
|
||||||
github.com/ugorji/go/codec v1.2.7 // indirect
|
|
||||||
github.com/ulikunitz/xz v0.5.10 // indirect
|
|
||||||
github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 // indirect
|
|
||||||
go.uber.org/atomic v1.9.0 // indirect
|
|
||||||
go.uber.org/multierr v1.8.0 // indirect
|
|
||||||
golang.org/x/net v0.0.0-20220225172249-27dd8689420f // indirect
|
|
||||||
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 // indirect
|
|
||||||
golang.org/x/text v0.3.7 // indirect
|
|
||||||
golang.org/x/time v0.0.0-20220224211638-0e9765cccd65 // indirect
|
|
||||||
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
|
|
||||||
google.golang.org/genproto v0.0.0-20220324131243-acbaeb5b85eb // indirect
|
|
||||||
google.golang.org/grpc v1.45.0 // indirect
|
|
||||||
google.golang.org/protobuf v1.28.0 // indirect
|
|
||||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
|
||||||
modernc.org/libc v1.16.17 // indirect
|
|
||||||
modernc.org/mathutil v1.4.1 // indirect
|
|
||||||
modernc.org/memory v1.1.1 // indirect
|
|
||||||
modernc.org/sqlite v1.17.3 // indirect
|
|
||||||
)
|
|
||||||
|
|||||||
@@ -2,32 +2,70 @@ package installer
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/asaskevich/govalidator"
|
"github.com/asaskevich/govalidator"
|
||||||
|
"github.com/buger/jsonparser"
|
||||||
|
"github.com/pterodactyl/wings/environment"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
)
|
)
|
||||||
|
|
||||||
type Installer struct {
|
type Installer struct {
|
||||||
server *server.Server
|
server *server.Server
|
||||||
StartOnCompletion bool
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type ServerDetails struct {
|
// New validates the received data to ensure that all of the required fields
|
||||||
UUID string `json:"uuid"`
|
|
||||||
StartOnCompletion bool `json:"start_on_completion"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// New validates the received data to ensure that all the required fields
|
|
||||||
// have been passed along in the request. This should be manually run before
|
// have been passed along in the request. This should be manually run before
|
||||||
// calling Execute().
|
// calling Execute().
|
||||||
func New(ctx context.Context, manager *server.Manager, details ServerDetails) (*Installer, error) {
|
func New(ctx context.Context, manager *server.Manager, data []byte) (*Installer, error) {
|
||||||
if !govalidator.IsUUIDv4(details.UUID) {
|
if !govalidator.IsUUIDv4(getString(data, "uuid")) {
|
||||||
return nil, NewValidationError("uuid provided was not in a valid format")
|
return nil, NewValidationError("uuid provided was not in a valid format")
|
||||||
}
|
}
|
||||||
|
|
||||||
c, err := manager.Client().GetServerConfiguration(ctx, details.UUID)
|
cfg := &server.Configuration{
|
||||||
|
Uuid: getString(data, "uuid"),
|
||||||
|
Suspended: false,
|
||||||
|
Invocation: getString(data, "invocation"),
|
||||||
|
SkipEggScripts: getBoolean(data, "skip_egg_scripts"),
|
||||||
|
Build: environment.Limits{
|
||||||
|
MemoryLimit: getInt(data, "build", "memory"),
|
||||||
|
Swap: getInt(data, "build", "swap"),
|
||||||
|
IoWeight: uint16(getInt(data, "build", "io")),
|
||||||
|
CpuLimit: getInt(data, "build", "cpu"),
|
||||||
|
DiskSpace: getInt(data, "build", "disk"),
|
||||||
|
Threads: getString(data, "build", "threads"),
|
||||||
|
},
|
||||||
|
CrashDetectionEnabled: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg.Allocations.DefaultMapping.Ip = getString(data, "allocations", "default", "ip")
|
||||||
|
cfg.Allocations.DefaultMapping.Port = int(getInt(data, "allocations", "default", "port"))
|
||||||
|
|
||||||
|
// Unmarshal the environment variables from the request into the server struct.
|
||||||
|
if b, _, _, err := jsonparser.Get(data, "environment"); err != nil {
|
||||||
|
return nil, errors.WithStackIf(err)
|
||||||
|
} else {
|
||||||
|
cfg.EnvVars = make(environment.Variables)
|
||||||
|
if err := json.Unmarshal(b, &cfg.EnvVars); err != nil {
|
||||||
|
return nil, errors.WrapIf(err, "installer: could not unmarshal environment variables for server")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unmarshal the allocation mappings from the request into the server struct.
|
||||||
|
if b, _, _, err := jsonparser.Get(data, "allocations", "mappings"); err != nil {
|
||||||
|
return nil, errors.WithStackIf(err)
|
||||||
|
} else {
|
||||||
|
cfg.Allocations.Mappings = make(map[string][]int)
|
||||||
|
if err := json.Unmarshal(b, &cfg.Allocations.Mappings); err != nil {
|
||||||
|
return nil, errors.Wrap(err, "installer: could not unmarshal allocation mappings")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg.Container.Image = getString(data, "container", "image")
|
||||||
|
|
||||||
|
c, err := manager.Client().GetServerConfiguration(ctx, cfg.Uuid)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if !remote.IsRequestError(err) {
|
if !remote.IsRequestError(err) {
|
||||||
return nil, errors.WithStackIf(err)
|
return nil, errors.WithStackIf(err)
|
||||||
@@ -41,11 +79,35 @@ func New(ctx context.Context, manager *server.Manager, details ServerDetails) (*
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, errors.WrapIf(err, "installer: could not init server instance")
|
return nil, errors.WrapIf(err, "installer: could not init server instance")
|
||||||
}
|
}
|
||||||
i := Installer{server: s, StartOnCompletion: details.StartOnCompletion}
|
return &Installer{server: s}, nil
|
||||||
return &i, nil
|
}
|
||||||
|
|
||||||
|
// Uuid returns the UUID associated with this installer instance.
|
||||||
|
func (i *Installer) Uuid() string {
|
||||||
|
return i.server.Id()
|
||||||
}
|
}
|
||||||
|
|
||||||
// Server returns the server instance.
|
// Server returns the server instance.
|
||||||
func (i *Installer) Server() *server.Server {
|
func (i *Installer) Server() *server.Server {
|
||||||
return i.server
|
return i.server
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Returns a string value from the JSON data provided.
|
||||||
|
func getString(data []byte, key ...string) string {
|
||||||
|
value, _ := jsonparser.GetString(data, key...)
|
||||||
|
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns an int value from the JSON data provided.
|
||||||
|
func getInt(data []byte, key ...string) int64 {
|
||||||
|
value, _ := jsonparser.GetInt(data, key...)
|
||||||
|
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
|
||||||
|
func getBoolean(data []byte, key ...string) bool {
|
||||||
|
value, _ := jsonparser.GetBoolean(data, key...)
|
||||||
|
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,57 +0,0 @@
|
|||||||
package cron
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/pterodactyl/wings/internal/database"
|
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
|
||||||
"github.com/pterodactyl/wings/server"
|
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
)
|
|
||||||
|
|
||||||
type activityCron struct {
|
|
||||||
mu *system.AtomicBool
|
|
||||||
manager *server.Manager
|
|
||||||
max int64
|
|
||||||
}
|
|
||||||
|
|
||||||
// Run executes the cronjob and ensures we fetch and send all of the stored activity to the
|
|
||||||
// Panel instance. Once activity is sent it is deleted from the local database instance. Any
|
|
||||||
// SFTP specific events are not handled in this cron, they're handled seperately to account
|
|
||||||
// for de-duplication and event merging.
|
|
||||||
func (ac *activityCron) Run(ctx context.Context) error {
|
|
||||||
// Don't execute this cron if there is currently one running. Once this task is completed
|
|
||||||
// go ahead and mark it as no longer running.
|
|
||||||
if !ac.mu.SwapIf(true) {
|
|
||||||
return errors.WithStack(ErrCronRunning)
|
|
||||||
}
|
|
||||||
defer ac.mu.Store(false)
|
|
||||||
|
|
||||||
var activity []models.Activity
|
|
||||||
tx := database.Instance().WithContext(ctx).
|
|
||||||
Where("event NOT LIKE ?", "server:sftp.%").
|
|
||||||
Limit(int(ac.max)).
|
|
||||||
Find(&activity)
|
|
||||||
|
|
||||||
if tx.Error != nil {
|
|
||||||
return errors.WithStack(tx.Error)
|
|
||||||
}
|
|
||||||
if len(activity) == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := ac.manager.Client().SendActivityLogs(ctx, activity); err != nil {
|
|
||||||
return errors.WrapIf(err, "cron: failed to send activity events to Panel")
|
|
||||||
}
|
|
||||||
|
|
||||||
var ids []int
|
|
||||||
for _, v := range activity {
|
|
||||||
ids = append(ids, v.ID)
|
|
||||||
}
|
|
||||||
|
|
||||||
tx = database.Instance().WithContext(ctx).Where("id IN ?", ids).Delete(&models.Activity{})
|
|
||||||
if tx.Error != nil {
|
|
||||||
return errors.WithStack(tx.Error)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
package cron
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/apex/log"
|
|
||||||
"github.com/go-co-op/gocron"
|
|
||||||
"github.com/pterodactyl/wings/config"
|
|
||||||
"github.com/pterodactyl/wings/server"
|
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
const ErrCronRunning = errors.Sentinel("cron: job already running")
|
|
||||||
|
|
||||||
var o system.AtomicBool
|
|
||||||
|
|
||||||
// Scheduler configures the internal cronjob system for Wings and returns the scheduler
|
|
||||||
// instance to the caller. This should only be called once per application lifecycle, additional
|
|
||||||
// calls will result in an error being returned.
|
|
||||||
func Scheduler(ctx context.Context, m *server.Manager) (*gocron.Scheduler, error) {
|
|
||||||
if !o.SwapIf(true) {
|
|
||||||
return nil, errors.New("cron: cannot call scheduler more than once in application lifecycle")
|
|
||||||
}
|
|
||||||
l, err := time.LoadLocation(config.Get().System.Timezone)
|
|
||||||
if err != nil {
|
|
||||||
return nil, errors.Wrap(err, "cron: failed to parse configured system timezone")
|
|
||||||
}
|
|
||||||
|
|
||||||
activity := activityCron{
|
|
||||||
mu: system.NewAtomicBool(false),
|
|
||||||
manager: m,
|
|
||||||
max: config.Get().System.ActivitySendCount,
|
|
||||||
}
|
|
||||||
|
|
||||||
sftp := sftpCron{
|
|
||||||
mu: system.NewAtomicBool(false),
|
|
||||||
manager: m,
|
|
||||||
max: config.Get().System.ActivitySendCount,
|
|
||||||
}
|
|
||||||
|
|
||||||
s := gocron.NewScheduler(l)
|
|
||||||
_, _ = s.Tag("activity").Every(config.Get().System.ActivitySendInterval).Seconds().Do(func() {
|
|
||||||
if err := activity.Run(ctx); err != nil {
|
|
||||||
if errors.Is(err, ErrCronRunning) {
|
|
||||||
log.WithField("cron", "activity").Warn("activity process is already running, skipping...")
|
|
||||||
} else {
|
|
||||||
log.WithField("cron", "activity").WithField("error", err).Error("activity process failed to execute")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
_, _ = s.Tag("sftp").Every(config.Get().System.ActivitySendInterval).Seconds().Do(func() {
|
|
||||||
if err := sftp.Run(ctx); err != nil {
|
|
||||||
if errors.Is(err, ErrCronRunning) {
|
|
||||||
log.WithField("cron", "sftp").Warn("sftp events process already running, skipping...")
|
|
||||||
} else {
|
|
||||||
log.WithField("cron", "sftp").WithField("error", err).Error("sftp events process failed to execute")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
return s, nil
|
|
||||||
}
|
|
||||||
@@ -1,180 +0,0 @@
|
|||||||
package cron
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/pterodactyl/wings/internal/database"
|
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
|
||||||
"github.com/pterodactyl/wings/server"
|
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
"gorm.io/gorm"
|
|
||||||
"reflect"
|
|
||||||
)
|
|
||||||
|
|
||||||
type sftpCron struct {
|
|
||||||
mu *system.AtomicBool
|
|
||||||
manager *server.Manager
|
|
||||||
max int64
|
|
||||||
}
|
|
||||||
|
|
||||||
type mapKey struct {
|
|
||||||
User string
|
|
||||||
Server string
|
|
||||||
IP string
|
|
||||||
Event models.Event
|
|
||||||
Timestamp string
|
|
||||||
}
|
|
||||||
|
|
||||||
type eventMap struct {
|
|
||||||
max int
|
|
||||||
ids []int
|
|
||||||
m map[mapKey]*models.Activity
|
|
||||||
}
|
|
||||||
|
|
||||||
// Run executes the SFTP reconciliation cron. This job will pull all of the SFTP specific events
|
|
||||||
// and merge them together across user, server, ip, and event. This allows a SFTP event that deletes
|
|
||||||
// tens or hundreds of files to be tracked as a single "deletion" event so long as they all occur
|
|
||||||
// within the same one minute period of time (starting at the first timestamp for the group). Without
|
|
||||||
// this we'd end up flooding the Panel event log with excessive data that is of no use to end users.
|
|
||||||
func (sc *sftpCron) Run(ctx context.Context) error {
|
|
||||||
if !sc.mu.SwapIf(true) {
|
|
||||||
return errors.WithStack(ErrCronRunning)
|
|
||||||
}
|
|
||||||
defer sc.mu.Store(false)
|
|
||||||
|
|
||||||
var o int
|
|
||||||
activity, err := sc.fetchRecords(ctx, o)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
o += len(activity)
|
|
||||||
|
|
||||||
events := &eventMap{
|
|
||||||
m: map[mapKey]*models.Activity{},
|
|
||||||
ids: []int{},
|
|
||||||
max: int(sc.max),
|
|
||||||
}
|
|
||||||
|
|
||||||
for {
|
|
||||||
if len(activity) == 0 {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
slen := len(events.ids)
|
|
||||||
for _, a := range activity {
|
|
||||||
events.Push(a)
|
|
||||||
}
|
|
||||||
if len(events.ids) > slen {
|
|
||||||
// Execute the query again, we found some events so we want to continue
|
|
||||||
// with this. Start at the next offset.
|
|
||||||
activity, err = sc.fetchRecords(ctx, o)
|
|
||||||
if err != nil {
|
|
||||||
return errors.WithStack(err)
|
|
||||||
}
|
|
||||||
o += len(activity)
|
|
||||||
} else {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(events.m) == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
err = database.Instance().Transaction(func(tx *gorm.DB) error {
|
|
||||||
tx.Where("id IN ?", events.ids).Delete(&models.Activity{})
|
|
||||||
if tx.Error != nil {
|
|
||||||
return tx.Error
|
|
||||||
}
|
|
||||||
|
|
||||||
return sc.manager.Client().SendActivityLogs(ctx, events.Elements())
|
|
||||||
})
|
|
||||||
|
|
||||||
return errors.WithStack(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// fetchRecords returns a group of activity events starting at the given offset. This is used
|
|
||||||
// since we might need to make multiple database queries to select enough events to properly
|
|
||||||
// fill up our request to the given maximum. This is due to the fact that this cron merges any
|
|
||||||
// activity that line up across user, server, ip, and event into a single activity record when
|
|
||||||
// sending the data to the Panel.
|
|
||||||
func (sc *sftpCron) fetchRecords(ctx context.Context, offset int) (activity []models.Activity, err error) {
|
|
||||||
tx := database.Instance().WithContext(ctx).
|
|
||||||
Where("event LIKE ?", "server:sftp.%").
|
|
||||||
Order("event DESC").
|
|
||||||
Offset(offset).
|
|
||||||
Limit(int(sc.max)).
|
|
||||||
Find(&activity)
|
|
||||||
if tx.Error != nil {
|
|
||||||
err = errors.WithStack(tx.Error)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Push adds an activity to the event mapping, or de-duplicates it and merges the files metadata
|
|
||||||
// into the existing entity that exists.
|
|
||||||
func (em *eventMap) Push(a models.Activity) {
|
|
||||||
m := em.forActivity(a)
|
|
||||||
// If no activity entity is returned we've hit the cap for the number of events to
|
|
||||||
// send along to the Panel. Just skip over this record and we'll account for it in
|
|
||||||
// the next iteration.
|
|
||||||
if m == nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
em.ids = append(em.ids, a.ID)
|
|
||||||
// Always reduce this to the first timestamp that was recorded for the set
|
|
||||||
// of events, and not
|
|
||||||
if a.Timestamp.Before(m.Timestamp) {
|
|
||||||
m.Timestamp = a.Timestamp
|
|
||||||
}
|
|
||||||
list := m.Metadata["files"].([]interface{})
|
|
||||||
if s, ok := a.Metadata["files"]; ok {
|
|
||||||
v := reflect.ValueOf(s)
|
|
||||||
if v.Kind() != reflect.Slice || v.IsNil() {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
for i := 0; i < v.Len(); i++ {
|
|
||||||
list = append(list, v.Index(i).Interface())
|
|
||||||
}
|
|
||||||
// You must set it again at the end of the process, otherwise you've only updated the file
|
|
||||||
// slice in this one loop since it isn't passed by reference. This is just shorter than having
|
|
||||||
// to explicitly keep casting it to the slice.
|
|
||||||
m.Metadata["files"] = list
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Elements returns the finalized activity models.
|
|
||||||
func (em *eventMap) Elements() (out []models.Activity) {
|
|
||||||
for _, v := range em.m {
|
|
||||||
out = append(out, *v)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// forActivity returns an event entity from our map which allows existing matches to be
|
|
||||||
// updated with additional files.
|
|
||||||
func (em *eventMap) forActivity(a models.Activity) *models.Activity {
|
|
||||||
key := mapKey{
|
|
||||||
User: a.User.String,
|
|
||||||
Server: a.Server,
|
|
||||||
IP: a.IP,
|
|
||||||
Event: a.Event,
|
|
||||||
// We group by the minute, don't care about the seconds for this logic.
|
|
||||||
Timestamp: a.Timestamp.Format("2006-01-02_15:04"),
|
|
||||||
}
|
|
||||||
if v, ok := em.m[key]; ok {
|
|
||||||
return v
|
|
||||||
}
|
|
||||||
// Cap the size of the events map at the defined maximum events to send to the Panel. Just
|
|
||||||
// return nil and let the caller handle it.
|
|
||||||
if len(em.m) >= em.max {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
// Doesn't exist in our map yet, create a copy of the activity passed into this
|
|
||||||
// function and then assign it into the map with an empty metadata value.
|
|
||||||
v := a
|
|
||||||
v.Metadata = models.ActivityMeta{
|
|
||||||
"files": make([]interface{}, 0),
|
|
||||||
}
|
|
||||||
em.m[key] = &v
|
|
||||||
return &v
|
|
||||||
}
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
package database
|
|
||||||
|
|
||||||
import (
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/glebarez/sqlite"
|
|
||||||
"github.com/pterodactyl/wings/config"
|
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
"gorm.io/gorm"
|
|
||||||
"path/filepath"
|
|
||||||
)
|
|
||||||
|
|
||||||
var o system.AtomicBool
|
|
||||||
var db *gorm.DB
|
|
||||||
|
|
||||||
// Initialize configures the local SQLite database for Wings and ensures that the models have
|
|
||||||
// been fully migrated.
|
|
||||||
func Initialize() error {
|
|
||||||
if !o.SwapIf(true) {
|
|
||||||
panic("database: attempt to initialize more than once during application lifecycle")
|
|
||||||
}
|
|
||||||
p := filepath.Join(config.Get().System.RootDirectory, "wings.db")
|
|
||||||
instance, err := gorm.Open(sqlite.Open(p), &gorm.Config{})
|
|
||||||
if err != nil {
|
|
||||||
return errors.Wrap(err, "database: could not open database file")
|
|
||||||
}
|
|
||||||
db = instance
|
|
||||||
if err := db.AutoMigrate(&models.Activity{}); err != nil {
|
|
||||||
return errors.WithStack(err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Instance returns the gorm database instance that was configured when the application was
|
|
||||||
// booted.
|
|
||||||
func Instance() *gorm.DB {
|
|
||||||
if db == nil {
|
|
||||||
panic("database: attempt to access instance before initialized")
|
|
||||||
}
|
|
||||||
return db
|
|
||||||
}
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
package models
|
|
||||||
|
|
||||||
import (
|
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
"gorm.io/gorm"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
type Event string
|
|
||||||
|
|
||||||
type ActivityMeta map[string]interface{}
|
|
||||||
|
|
||||||
// Activity defines an activity log event for a server entity performed by a user. This is
|
|
||||||
// used for tracking commands, power actions, and SFTP events so that they can be reconciled
|
|
||||||
// and sent back to the Panel instance to be displayed to the user.
|
|
||||||
type Activity struct {
|
|
||||||
ID int `gorm:"primaryKey;not null" json:"-"`
|
|
||||||
// User is UUID of the user that triggered this event, or an empty string if the event
|
|
||||||
// cannot be tied to a specific user, in which case we will assume it was the system
|
|
||||||
// user.
|
|
||||||
User JsonNullString `gorm:"type:uuid" json:"user"`
|
|
||||||
// Server is the UUID of the server this event is associated with.
|
|
||||||
Server string `gorm:"type:uuid;not null" json:"server"`
|
|
||||||
// Event is a string that describes what occurred, and is used by the Panel instance to
|
|
||||||
// properly associate this event in the activity logs.
|
|
||||||
Event Event `gorm:"index;not null" json:"event"`
|
|
||||||
// Metadata is either a null value, string, or a JSON blob with additional event specific
|
|
||||||
// metadata that can be provided.
|
|
||||||
Metadata ActivityMeta `gorm:"serializer:json" json:"metadata"`
|
|
||||||
// IP is the IP address that triggered this event, or an empty string if it cannot be
|
|
||||||
// determined properly. This should be the connecting user's IP address, and not the
|
|
||||||
// internal system IP.
|
|
||||||
IP string `gorm:"not null" json:"ip"`
|
|
||||||
Timestamp time.Time `gorm:"not null" json:"timestamp"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetUser sets the current user that performed the action. If an empty string is provided
|
|
||||||
// it is cast into a null value when stored.
|
|
||||||
func (a Activity) SetUser(u string) *Activity {
|
|
||||||
var ns JsonNullString
|
|
||||||
if u == "" {
|
|
||||||
if err := ns.Scan(nil); err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if err := ns.Scan(u); err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
a.User = ns
|
|
||||||
return &a
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeforeCreate executes before we create any activity entry to ensure the IP address
|
|
||||||
// is trimmed down to remove any extraneous data, and the timestamp is set to the current
|
|
||||||
// system time and then stored as UTC.
|
|
||||||
func (a *Activity) BeforeCreate(_ *gorm.DB) error {
|
|
||||||
a.IP = system.TrimIPSuffix(a.IP)
|
|
||||||
if a.Timestamp.IsZero() {
|
|
||||||
a.Timestamp = time.Now()
|
|
||||||
}
|
|
||||||
a.Timestamp = a.Timestamp.UTC()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
package models
|
|
||||||
|
|
||||||
import (
|
|
||||||
"database/sql"
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/goccy/go-json"
|
|
||||||
)
|
|
||||||
|
|
||||||
type JsonNullString struct {
|
|
||||||
sql.NullString
|
|
||||||
}
|
|
||||||
|
|
||||||
func (v JsonNullString) MarshalJSON() ([]byte, error) {
|
|
||||||
if v.Valid {
|
|
||||||
return json.Marshal(v.String)
|
|
||||||
} else {
|
|
||||||
return json.Marshal(nil)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (v *JsonNullString) UnmarshalJSON(data []byte) error {
|
|
||||||
var s *string
|
|
||||||
if err := json.Unmarshal(data, &s); err != nil {
|
|
||||||
return errors.WithStack(err)
|
|
||||||
}
|
|
||||||
if s != nil {
|
|
||||||
v.String = *s
|
|
||||||
}
|
|
||||||
v.Valid = s != nil
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
@@ -1,25 +1,22 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"emperror.dev/errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/apex/log"
|
||||||
|
"github.com/apex/log/handlers/cli"
|
||||||
|
color2 "github.com/fatih/color"
|
||||||
|
"github.com/mattn/go-colorable"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/apex/log"
|
|
||||||
"github.com/apex/log/handlers/cli"
|
|
||||||
color2 "github.com/fatih/color"
|
|
||||||
"github.com/mattn/go-colorable"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var Default = New(os.Stderr, true)
|
||||||
Default = New(os.Stderr, true)
|
var bold = color2.New(color2.Bold)
|
||||||
bold = color2.New(color2.Bold)
|
var boldred = color2.New(color2.Bold, color2.FgRed)
|
||||||
boldred = color2.New(color2.Bold, color2.FgRed)
|
|
||||||
)
|
|
||||||
|
|
||||||
var Strings = [...]string{
|
var Strings = [...]string{
|
||||||
log.DebugLevel: "DEBUG",
|
log.DebugLevel: "DEBUG",
|
||||||
|
|||||||
107
metrics/metrics.go
Normal file
107
metrics/metrics.go
Normal file
@@ -0,0 +1,107 @@
|
|||||||
|
package metrics
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/apex/log"
|
||||||
|
"github.com/prometheus/client_golang/prometheus"
|
||||||
|
"github.com/prometheus/client_golang/prometheus/promauto"
|
||||||
|
"github.com/prometheus/client_golang/prometheus/promhttp"
|
||||||
|
"github.com/pterodactyl/wings/config"
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Metrics struct {
|
||||||
|
handler http.Handler
|
||||||
|
}
|
||||||
|
|
||||||
|
const (
|
||||||
|
namespace = "pterodactyl"
|
||||||
|
subsystem = "wings"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
bootTimeSeconds = promauto.NewGauge(prometheus.GaugeOpts{
|
||||||
|
Namespace: namespace,
|
||||||
|
Subsystem: subsystem,
|
||||||
|
Name: "boot_time_seconds",
|
||||||
|
Help: "Boot time of this instance since epoch (1970)",
|
||||||
|
})
|
||||||
|
timeSeconds = promauto.NewGauge(prometheus.GaugeOpts{
|
||||||
|
Namespace: namespace,
|
||||||
|
Subsystem: subsystem,
|
||||||
|
Name: "time_seconds",
|
||||||
|
Help: "System time in seconds since epoch (1970)",
|
||||||
|
})
|
||||||
|
|
||||||
|
ServerStatus = promauto.NewGaugeVec(prometheus.GaugeOpts{
|
||||||
|
Namespace: namespace,
|
||||||
|
Subsystem: subsystem,
|
||||||
|
Name: "server_status",
|
||||||
|
}, []string{"server_id"})
|
||||||
|
ServerCPU = promauto.NewGaugeVec(prometheus.GaugeOpts{
|
||||||
|
Namespace: namespace,
|
||||||
|
Subsystem: subsystem,
|
||||||
|
Name: "server_cpu",
|
||||||
|
}, []string{"server_id"})
|
||||||
|
ServerMemory = promauto.NewGaugeVec(prometheus.GaugeOpts{
|
||||||
|
Namespace: namespace,
|
||||||
|
Subsystem: subsystem,
|
||||||
|
Name: "server_memory",
|
||||||
|
}, []string{"server_id"})
|
||||||
|
ServerNetworkRx = promauto.NewGaugeVec(prometheus.GaugeOpts{
|
||||||
|
Namespace: namespace,
|
||||||
|
Subsystem: subsystem,
|
||||||
|
Name: "server_network_rx",
|
||||||
|
}, []string{"server_id"})
|
||||||
|
ServerNetworkTx = promauto.NewGaugeVec(prometheus.GaugeOpts{
|
||||||
|
Namespace: namespace,
|
||||||
|
Subsystem: subsystem,
|
||||||
|
Name: "server_network_tx",
|
||||||
|
}, []string{"server_id"})
|
||||||
|
|
||||||
|
HTTPRequestsTotal = promauto.NewCounterVec(prometheus.CounterOpts{
|
||||||
|
Namespace: namespace,
|
||||||
|
Subsystem: subsystem,
|
||||||
|
Name: "http_requests_total",
|
||||||
|
}, []string{"method", "route_path", "raw_path", "raw_query", "code"})
|
||||||
|
)
|
||||||
|
|
||||||
|
func Initialize(done chan bool) {
|
||||||
|
bootTimeSeconds.Set(float64(time.Now().UnixNano()) / 1e9)
|
||||||
|
ticker := time.NewTicker(time.Second)
|
||||||
|
go func() {
|
||||||
|
defer ticker.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
// Received a "signal" on the done channel.
|
||||||
|
log.Debug("metrics: done")
|
||||||
|
return
|
||||||
|
case t := <-ticker.C:
|
||||||
|
// Update the current time.
|
||||||
|
timeSeconds.Set(float64(t.UnixNano()) / 1e9)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
if err := http.ListenAndServe(config.Get().Metrics.Bind, promhttp.Handler()); err != nil && err != http.ErrServerClosed {
|
||||||
|
log.WithField("error", err).Error("failed to start metrics server")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteServer will remove any existing labels from being scraped by Prometheus.
|
||||||
|
// Any previously scraped data will still be persisted by Prometheus.
|
||||||
|
func DeleteServer(sID string) {
|
||||||
|
ServerStatus.DeleteLabelValues(sID)
|
||||||
|
ServerCPU.DeleteLabelValues(sID)
|
||||||
|
ServerMemory.DeleteLabelValues(sID)
|
||||||
|
ServerNetworkRx.DeleteLabelValues(sID)
|
||||||
|
ServerNetworkTx.DeleteLabelValues(sID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ResetServer will reset a server's metrics to their default values except the status.
|
||||||
|
func ResetServer(sID string) {
|
||||||
|
ServerCPU.WithLabelValues(sID).Set(0)
|
||||||
|
ServerMemory.WithLabelValues(sID).Set(0)
|
||||||
|
ServerNetworkRx.WithLabelValues(sID).Set(0)
|
||||||
|
ServerNetworkTx.WithLabelValues(sID).Set(0)
|
||||||
|
}
|
||||||
@@ -2,7 +2,7 @@ package parser
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"io"
|
"io/ioutil"
|
||||||
"os"
|
"os"
|
||||||
"regexp"
|
"regexp"
|
||||||
"strconv"
|
"strconv"
|
||||||
@@ -38,29 +38,29 @@ var xmlValueMatchRegex = regexp.MustCompile(`^\[([\w]+)='(.*)'\]$`)
|
|||||||
// Gets the []byte representation of a configuration file to be passed through to other
|
// Gets the []byte representation of a configuration file to be passed through to other
|
||||||
// handler functions. If the file does not currently exist, it will be created.
|
// handler functions. If the file does not currently exist, it will be created.
|
||||||
func readFileBytes(path string) ([]byte, error) {
|
func readFileBytes(path string) ([]byte, error) {
|
||||||
file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0o644)
|
file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0644)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
defer file.Close()
|
defer file.Close()
|
||||||
|
|
||||||
return io.ReadAll(file)
|
return ioutil.ReadAll(file)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Gets the value of a key based on the value type defined.
|
// Gets the value of a key based on the value type defined.
|
||||||
func (cfr *ConfigurationFileReplacement) getKeyValue(value string) interface{} {
|
func (cfr *ConfigurationFileReplacement) getKeyValue(value []byte) interface{} {
|
||||||
if cfr.ReplaceWith.Type() == jsonparser.Boolean {
|
if cfr.ReplaceWith.Type() == jsonparser.Boolean {
|
||||||
v, _ := strconv.ParseBool(value)
|
v, _ := strconv.ParseBool(string(value))
|
||||||
return v
|
return v
|
||||||
}
|
}
|
||||||
|
|
||||||
// Try to parse into an int, if this fails just ignore the error and continue
|
// Try to parse into an int, if this fails just ignore the error and continue
|
||||||
// through, returning the string.
|
// through, returning the string.
|
||||||
if v, err := strconv.Atoi(value); err == nil {
|
if v, err := strconv.Atoi(string(value)); err == nil {
|
||||||
return v
|
return v
|
||||||
}
|
}
|
||||||
|
|
||||||
return value
|
return string(value)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Iterate over an unstructured JSON/YAML/etc. interface and set all of the required
|
// Iterate over an unstructured JSON/YAML/etc. interface and set all of the required
|
||||||
@@ -97,23 +97,24 @@ func (f *ConfigurationFile) IterateOverJson(data []byte) (*gabs.Container, error
|
|||||||
// If the child is a null value, nothing will happen. Seems reasonable as of the
|
// If the child is a null value, nothing will happen. Seems reasonable as of the
|
||||||
// time this code is being written.
|
// time this code is being written.
|
||||||
for _, child := range parsed.Path(strings.Trim(parts[0], ".")).Children() {
|
for _, child := range parsed.Path(strings.Trim(parts[0], ".")).Children() {
|
||||||
if err := v.SetAtPathway(child, strings.Trim(parts[1], "."), value); err != nil {
|
if err := v.SetAtPathway(child, strings.Trim(parts[1], "."), []byte(value)); err != nil {
|
||||||
if errors.Is(err, gabs.ErrNotFound) {
|
if errors.Is(err, gabs.ErrNotFound) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
return nil, errors.WithMessage(err, "failed to set config value of array child")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := v.SetAtPathway(parsed, v.Match, value); err != nil {
|
return nil, errors.WithMessage(err, "failed to set config value of array child")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if err = v.SetAtPathway(parsed, v.Match, []byte(value)); err != nil {
|
||||||
if errors.Is(err, gabs.ErrNotFound) {
|
if errors.Is(err, gabs.ErrNotFound) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil, errors.WithMessage(err, "unable to set config value at pathway: "+v.Match)
|
return nil, errors.WithMessage(err, "unable to set config value at pathway: "+v.Match)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return parsed, nil
|
return parsed, nil
|
||||||
}
|
}
|
||||||
@@ -131,10 +132,13 @@ func setValueAtPath(c *gabs.Container, path string, value interface{}) error {
|
|||||||
var err error
|
var err error
|
||||||
|
|
||||||
matches := checkForArrayElement.FindStringSubmatch(path)
|
matches := checkForArrayElement.FindStringSubmatch(path)
|
||||||
|
|
||||||
// Check if we are **NOT** updating an array element.
|
|
||||||
if len(matches) < 3 {
|
if len(matches) < 3 {
|
||||||
|
// Only update the value if the pathway actually exists in the configuration, otherwise
|
||||||
|
// do nothing.
|
||||||
|
if c.ExistsP(path) {
|
||||||
_, err = c.SetP(value, path)
|
_, err = c.SetP(value, path)
|
||||||
|
}
|
||||||
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -192,34 +196,32 @@ func setValueAtPath(c *gabs.Container, path string, value interface{}) error {
|
|||||||
|
|
||||||
// Sets the value at a specific pathway, but checks if we were looking for a specific
|
// Sets the value at a specific pathway, but checks if we were looking for a specific
|
||||||
// value or not before doing it.
|
// value or not before doing it.
|
||||||
func (cfr *ConfigurationFileReplacement) SetAtPathway(c *gabs.Container, path string, value string) error {
|
func (cfr *ConfigurationFileReplacement) SetAtPathway(c *gabs.Container, path string, value []byte) error {
|
||||||
if cfr.IfValue == "" {
|
if cfr.IfValue == "" {
|
||||||
return setValueAtPath(c, path, cfr.getKeyValue(value))
|
return setValueAtPath(c, path, cfr.getKeyValue(value))
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check if we are replacing instead of overwriting.
|
// If this is a regex based matching, we need to get a little more creative since
|
||||||
if strings.HasPrefix(cfr.IfValue, "regex:") {
|
// we're only going to replacing part of the string, and not the whole thing.
|
||||||
// Doing a regex replacement requires an existing value.
|
if c.ExistsP(path) && strings.HasPrefix(cfr.IfValue, "regex:") {
|
||||||
// TODO: Do we try passing an empty string to the regex?
|
// We're doing some regex here.
|
||||||
if c.ExistsP(path) {
|
|
||||||
return gabs.ErrNotFound
|
|
||||||
}
|
|
||||||
|
|
||||||
r, err := regexp.Compile(strings.TrimPrefix(cfr.IfValue, "regex:"))
|
r, err := regexp.Compile(strings.TrimPrefix(cfr.IfValue, "regex:"))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.WithFields(log.Fields{"if_value": strings.TrimPrefix(cfr.IfValue, "regex:"), "error": err}).
|
log.WithFields(log.Fields{"if_value": strings.TrimPrefix(cfr.IfValue, "regex:"), "error": err}).
|
||||||
Warn("configuration if_value using invalid regexp, cannot perform replacement")
|
Warn("configuration if_value using invalid regexp, cannot perform replacement")
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
v := strings.Trim(c.Path(path).String(), "\"")
|
// If the path exists and there is a regex match, go ahead and attempt the replacement
|
||||||
|
// using the value we got from the key. This will only replace the one match.
|
||||||
|
v := strings.Trim(string(c.Path(path).Bytes()), "\"")
|
||||||
if r.Match([]byte(v)) {
|
if r.Match([]byte(v)) {
|
||||||
return setValueAtPath(c, path, r.ReplaceAllString(v, value))
|
return setValueAtPath(c, path, r.ReplaceAllString(v, string(value)))
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if c.ExistsP(path) && !bytes.Equal(c.Bytes(), []byte(cfr.IfValue)) {
|
return nil
|
||||||
|
} else if !c.ExistsP(path) || (c.ExistsP(path) && !bytes.Equal(c.Bytes(), []byte(cfr.IfValue))) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,8 @@ package parser
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bufio"
|
"bufio"
|
||||||
|
"encoding/json"
|
||||||
|
"io/ioutil"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strconv"
|
"strconv"
|
||||||
@@ -11,13 +13,11 @@ import (
|
|||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/beevik/etree"
|
"github.com/beevik/etree"
|
||||||
"github.com/buger/jsonparser"
|
"github.com/buger/jsonparser"
|
||||||
"github.com/goccy/go-json"
|
|
||||||
"github.com/icza/dyno"
|
"github.com/icza/dyno"
|
||||||
"github.com/magiconair/properties"
|
"github.com/magiconair/properties"
|
||||||
|
"github.com/pterodactyl/wings/config"
|
||||||
"gopkg.in/ini.v1"
|
"gopkg.in/ini.v1"
|
||||||
"gopkg.in/yaml.v2"
|
"gopkg.in/yaml.v2"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// The file parsing options that are available for a server configuration file.
|
// The file parsing options that are available for a server configuration file.
|
||||||
@@ -56,22 +56,17 @@ func (cv *ReplaceValue) Type() jsonparser.ValueType {
|
|||||||
// handle casting the UTF-8 sequence into the expected value, switching something
|
// handle casting the UTF-8 sequence into the expected value, switching something
|
||||||
// like "\u00a7Foo" into "§Foo".
|
// like "\u00a7Foo" into "§Foo".
|
||||||
func (cv *ReplaceValue) String() string {
|
func (cv *ReplaceValue) String() string {
|
||||||
switch cv.Type() {
|
if cv.Type() != jsonparser.String {
|
||||||
case jsonparser.String:
|
if cv.Type() == jsonparser.Null {
|
||||||
|
return "<nil>"
|
||||||
|
}
|
||||||
|
return "<invalid>"
|
||||||
|
}
|
||||||
str, err := jsonparser.ParseString(cv.value)
|
str, err := jsonparser.ParseString(cv.value)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
panic(errors.Wrap(err, "parser: could not parse value"))
|
panic(errors.Wrap(err, "parser: could not parse value"))
|
||||||
}
|
}
|
||||||
return str
|
return str
|
||||||
case jsonparser.Null:
|
|
||||||
return "<nil>"
|
|
||||||
case jsonparser.Boolean:
|
|
||||||
return string(cv.value)
|
|
||||||
case jsonparser.Number:
|
|
||||||
return string(cv.value)
|
|
||||||
default:
|
|
||||||
return "<invalid>"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type ConfigurationParser string
|
type ConfigurationParser string
|
||||||
@@ -80,8 +75,8 @@ func (cp ConfigurationParser) String() string {
|
|||||||
return string(cp)
|
return string(cp)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ConfigurationFile defines a configuration file for the server startup. These
|
// Defines a configuration file for the server startup. These will be looped over
|
||||||
// will be looped over and modified before the server finishes booting.
|
// and modified before the server finishes booting.
|
||||||
type ConfigurationFile struct {
|
type ConfigurationFile struct {
|
||||||
FileName string `json:"file"`
|
FileName string `json:"file"`
|
||||||
Parser ConfigurationParser `json:"parser"`
|
Parser ConfigurationParser `json:"parser"`
|
||||||
@@ -92,10 +87,12 @@ type ConfigurationFile struct {
|
|||||||
configuration []byte
|
configuration []byte
|
||||||
}
|
}
|
||||||
|
|
||||||
// UnmarshalJSON is a custom unmarshaler for configuration files. If there is an
|
// Custom unmarshaler for configuration files. If there is an error while parsing out the
|
||||||
// error while parsing out the replacements, don't fail the entire operation,
|
// replacements, don't fail the entire operation, just log a global warning so someone can
|
||||||
// just log a global warning so someone can find the issue, and return an empty
|
// find the issue, and return an empty array of replacements.
|
||||||
// array of replacements.
|
//
|
||||||
|
// I imagine people will notice configuration replacement isn't working correctly and then
|
||||||
|
// the logs should help better expose that issue.
|
||||||
func (f *ConfigurationFile) UnmarshalJSON(data []byte) error {
|
func (f *ConfigurationFile) UnmarshalJSON(data []byte) error {
|
||||||
var m map[string]*json.RawMessage
|
var m map[string]*json.RawMessage
|
||||||
if err := json.Unmarshal(data, &m); err != nil {
|
if err := json.Unmarshal(data, &m); err != nil {
|
||||||
@@ -209,7 +206,7 @@ func (f *ConfigurationFile) Parse(path string, internal bool) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
b := strings.TrimSuffix(path, filepath.Base(path))
|
b := strings.TrimSuffix(path, filepath.Base(path))
|
||||||
if err := os.MkdirAll(b, 0o755); err != nil {
|
if err := os.MkdirAll(b, 0755); err != nil {
|
||||||
return errors.WithMessage(err, "failed to create base directory for missing configuration file")
|
return errors.WithMessage(err, "failed to create base directory for missing configuration file")
|
||||||
} else {
|
} else {
|
||||||
if _, err := os.Create(path); err != nil {
|
if _, err := os.Create(path); err != nil {
|
||||||
@@ -226,7 +223,7 @@ func (f *ConfigurationFile) Parse(path string, internal bool) error {
|
|||||||
// Parses an xml file.
|
// Parses an xml file.
|
||||||
func (f *ConfigurationFile) parseXmlFile(path string) error {
|
func (f *ConfigurationFile) parseXmlFile(path string) error {
|
||||||
doc := etree.NewDocument()
|
doc := etree.NewDocument()
|
||||||
file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0o644)
|
file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0644)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -319,7 +316,7 @@ func (f *ConfigurationFile) parseIniFile(path string) error {
|
|||||||
// Ini package can't handle a non-existent file, so handle that automatically here
|
// Ini package can't handle a non-existent file, so handle that automatically here
|
||||||
// by creating it if not exists. Then, immediately close the file since we will use
|
// by creating it if not exists. Then, immediately close the file since we will use
|
||||||
// other methods to write the new contents.
|
// other methods to write the new contents.
|
||||||
file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0o644)
|
file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0644)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -331,29 +328,7 @@ func (f *ConfigurationFile) parseIniFile(path string) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
for _, replacement := range f.Replace {
|
for _, replacement := range f.Replace {
|
||||||
var (
|
path := strings.SplitN(replacement.Match, ".", 2)
|
||||||
path []string
|
|
||||||
bracketDepth int
|
|
||||||
v []int32
|
|
||||||
)
|
|
||||||
for _, c := range replacement.Match {
|
|
||||||
switch c {
|
|
||||||
case '[':
|
|
||||||
bracketDepth++
|
|
||||||
case ']':
|
|
||||||
bracketDepth--
|
|
||||||
case '.':
|
|
||||||
if bracketDepth > 0 || len(path) == 1 {
|
|
||||||
v = append(v, c)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
path = append(path, string(v))
|
|
||||||
v = v[:0]
|
|
||||||
default:
|
|
||||||
v = append(v, c)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
path = append(path, string(v))
|
|
||||||
|
|
||||||
value, err := f.LookupConfigurationValue(replacement)
|
value, err := f.LookupConfigurationValue(replacement)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -406,7 +381,7 @@ func (f *ConfigurationFile) parseJsonFile(path string) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
output := []byte(data.StringIndent("", " "))
|
output := []byte(data.StringIndent("", " "))
|
||||||
return os.WriteFile(path, output, 0o644)
|
return ioutil.WriteFile(path, output, 0644)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Parses a yaml file and updates any matching key/value pairs before persisting
|
// Parses a yaml file and updates any matching key/value pairs before persisting
|
||||||
@@ -443,14 +418,14 @@ func (f *ConfigurationFile) parseYamlFile(path string) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
return os.WriteFile(path, marshaled, 0o644)
|
return ioutil.WriteFile(path, marshaled, 0644)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Parses a text file using basic find and replace. This is a highly inefficient method of
|
// Parses a text file using basic find and replace. This is a highly inefficient method of
|
||||||
// scanning a file and performing a replacement. You should attempt to use anything other
|
// scanning a file and performing a replacement. You should attempt to use anything other
|
||||||
// than this function where possible.
|
// than this function where possible.
|
||||||
func (f *ConfigurationFile) parseTextFile(path string) error {
|
func (f *ConfigurationFile) parseTextFile(path string) error {
|
||||||
input, err := os.ReadFile(path)
|
input, err := ioutil.ReadFile(path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -468,7 +443,7 @@ func (f *ConfigurationFile) parseTextFile(path string) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := os.WriteFile(path, []byte(strings.Join(lines, "\n")), 0o644); err != nil {
|
if err := ioutil.WriteFile(path, []byte(strings.Join(lines, "\n")), 0644); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -564,7 +539,7 @@ func (f *ConfigurationFile) parsePropertiesFile(path string) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Open the file for writing.
|
// Open the file for writing.
|
||||||
w, err := os.OpenFile(path, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0o644)
|
w, err := os.OpenFile(path, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -57,7 +57,8 @@ func (re *RequestError) StatusCode() int {
|
|||||||
return re.response.StatusCode
|
return re.response.StatusCode
|
||||||
}
|
}
|
||||||
|
|
||||||
type SftpInvalidCredentialsError struct{}
|
type SftpInvalidCredentialsError struct {
|
||||||
|
}
|
||||||
|
|
||||||
func (ice SftpInvalidCredentialsError) Error() string {
|
func (ice SftpInvalidCredentialsError) Error() string {
|
||||||
return "the credentials provided were invalid"
|
return "the credentials provided were invalid"
|
||||||
|
|||||||
@@ -3,9 +3,10 @@ package remote
|
|||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
|
||||||
"io"
|
"io"
|
||||||
|
"io/ioutil"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -14,8 +15,6 @@ import (
|
|||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/cenkalti/backoff/v4"
|
"github.com/cenkalti/backoff/v4"
|
||||||
"github.com/goccy/go-json"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -31,7 +30,6 @@ type Client interface {
|
|||||||
SetInstallationStatus(ctx context.Context, uuid string, successful bool) error
|
SetInstallationStatus(ctx context.Context, uuid string, successful bool) error
|
||||||
SetTransferStatus(ctx context.Context, uuid string, successful bool) error
|
SetTransferStatus(ctx context.Context, uuid string, successful bool) error
|
||||||
ValidateSftpCredentials(ctx context.Context, request SftpAuthRequest) (SftpAuthResponse, error)
|
ValidateSftpCredentials(ctx context.Context, request SftpAuthRequest) (SftpAuthResponse, error)
|
||||||
SendActivityLogs(ctx context.Context, activity []models.Activity) error
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type client struct {
|
type client struct {
|
||||||
@@ -120,7 +118,7 @@ func (c *client) requestOnce(ctx context.Context, method, path string, body io.R
|
|||||||
return &Response{res}, err
|
return &Response{res}, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// request executes an HTTP request against the Panel API. If there is an error
|
// request executes a HTTP request against the Panel API. If there is an error
|
||||||
// encountered with the request it will be retried using an exponential backoff.
|
// encountered with the request it will be retried using an exponential backoff.
|
||||||
// If the error returned from the Panel is due to API throttling or because there
|
// If the error returned from the Panel is due to API throttling or because there
|
||||||
// are invalid authentication credentials provided the request will _not_ be
|
// are invalid authentication credentials provided the request will _not_ be
|
||||||
@@ -130,19 +128,10 @@ func (c *client) requestOnce(ctx context.Context, method, path string, body io.R
|
|||||||
// and adds the required authentication headers to the request that is being
|
// and adds the required authentication headers to the request that is being
|
||||||
// created. Errors returned will be of the RequestError type if there was some
|
// created. Errors returned will be of the RequestError type if there was some
|
||||||
// type of response from the API that can be parsed.
|
// type of response from the API that can be parsed.
|
||||||
func (c *client) request(ctx context.Context, method, path string, body *bytes.Buffer, opts ...func(r *http.Request)) (*Response, error) {
|
func (c *client) request(ctx context.Context, method, path string, body io.Reader, opts ...func(r *http.Request)) (*Response, error) {
|
||||||
var res *Response
|
var res *Response
|
||||||
err := backoff.Retry(func() error {
|
err := backoff.Retry(func() error {
|
||||||
var b bytes.Buffer
|
r, err := c.requestOnce(ctx, method, path, body, opts...)
|
||||||
if body != nil {
|
|
||||||
// We have to create a copy of the body, otherwise attempting this request again will
|
|
||||||
// send no data if there was initially a body since the "requestOnce" method will read
|
|
||||||
// the whole buffer, thus leaving it empty at the end.
|
|
||||||
if _, err := b.Write(body.Bytes()); err != nil {
|
|
||||||
return backoff.Permanent(errors.Wrap(err, "http: failed to copy body buffer"))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
r, err := c.requestOnce(ctx, method, path, &b, opts...)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
|
if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
|
||||||
return backoff.Permanent(err)
|
return backoff.Permanent(err)
|
||||||
@@ -153,10 +142,12 @@ func (c *client) request(ctx context.Context, method, path string, body *bytes.B
|
|||||||
if r.HasError() {
|
if r.HasError() {
|
||||||
// Close the request body after returning the error to free up resources.
|
// Close the request body after returning the error to free up resources.
|
||||||
defer r.Body.Close()
|
defer r.Body.Close()
|
||||||
// Don't keep attempting to access this endpoint if the response is a 4XX
|
// Don't keep spamming the endpoint if we've already made too many requests or
|
||||||
// level error which indicates a client mistake. Only retry when the error
|
// if we're not even authenticated correctly. Retrying generally won't fix either
|
||||||
// is due to a server issue (5XX error).
|
// of these issues.
|
||||||
if r.StatusCode >= 400 && r.StatusCode < 500 {
|
if r.StatusCode == http.StatusForbidden ||
|
||||||
|
r.StatusCode == http.StatusTooManyRequests ||
|
||||||
|
r.StatusCode == http.StatusUnauthorized {
|
||||||
return backoff.Permanent(r.Error())
|
return backoff.Permanent(r.Error())
|
||||||
}
|
}
|
||||||
return r.Error()
|
return r.Error()
|
||||||
@@ -179,7 +170,7 @@ func (c *client) request(ctx context.Context, method, path string, body *bytes.B
|
|||||||
// This allows for issues with DNS resolution, or rare race conditions due to
|
// This allows for issues with DNS resolution, or rare race conditions due to
|
||||||
// slower SQL queries on the Panel to potentially self-resolve without just
|
// slower SQL queries on the Panel to potentially self-resolve without just
|
||||||
// immediately failing the first request. The example below shows the amount of
|
// immediately failing the first request. The example below shows the amount of
|
||||||
// time that has elapsed between each call to the handler when an error is
|
// time that has ellapsed between each call to the handler when an error is
|
||||||
// returned. You can tweak these values as needed to get the effect you desire.
|
// returned. You can tweak these values as needed to get the effect you desire.
|
||||||
//
|
//
|
||||||
// If maxAttempts is a value greater than 0 the backoff will be capped at a total
|
// If maxAttempts is a value greater than 0 the backoff will be capped at a total
|
||||||
@@ -232,9 +223,9 @@ func (r *Response) Read() ([]byte, error) {
|
|||||||
return nil, errors.New("remote: attempting to read missing response")
|
return nil, errors.New("remote: attempting to read missing response")
|
||||||
}
|
}
|
||||||
if r.Response.Body != nil {
|
if r.Response.Body != nil {
|
||||||
b, _ = io.ReadAll(r.Response.Body)
|
b, _ = ioutil.ReadAll(r.Response.Body)
|
||||||
}
|
}
|
||||||
r.Response.Body = io.NopCloser(bytes.NewBuffer(b))
|
r.Response.Body = ioutil.NopCloser(bytes.NewBuffer(b))
|
||||||
return b, nil
|
return b, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -87,6 +87,7 @@ func TestPost(t *testing.T) {
|
|||||||
}
|
}
|
||||||
c, _ := createTestClient(func(rw http.ResponseWriter, r *http.Request) {
|
c, _ := createTestClient(func(rw http.ResponseWriter, r *http.Request) {
|
||||||
assert.Equal(t, http.MethodPost, r.Method)
|
assert.Equal(t, http.MethodPost, r.Method)
|
||||||
|
|
||||||
})
|
})
|
||||||
r, err := c.Post(context.Background(), "/test", test)
|
r, err := c.Post(context.Background(), "/test", test)
|
||||||
assert.NoError(t, err)
|
assert.NoError(t, err)
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ package remote
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
|
||||||
"strconv"
|
"strconv"
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
@@ -179,16 +178,6 @@ func (c *client) SendRestorationStatus(ctx context.Context, backup string, succe
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// SendActivityLogs sends activity logs back to the Panel for processing.
|
|
||||||
func (c *client) SendActivityLogs(ctx context.Context, activity []models.Activity) error {
|
|
||||||
resp, err := c.Post(ctx, "/activity", d{"data": activity})
|
|
||||||
if err != nil {
|
|
||||||
return errors.WithStackIf(err)
|
|
||||||
}
|
|
||||||
_ = resp.Body.Close()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// getServersPaged returns a subset of servers from the Panel API using the
|
// getServersPaged returns a subset of servers from the Panel API using the
|
||||||
// pagination query parameters.
|
// pagination query parameters.
|
||||||
func (c *client) getServersPaged(ctx context.Context, page, limit int) ([]RawServerData, Pagination, error) {
|
func (c *client) getServersPaged(ctx context.Context, page, limit int) ([]RawServerData, Pagination, error) {
|
||||||
|
|||||||
@@ -1,20 +1,14 @@
|
|||||||
package remote
|
package remote
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"encoding/json"
|
||||||
"github.com/apex/log"
|
|
||||||
"github.com/goccy/go-json"
|
|
||||||
"regexp"
|
"regexp"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"github.com/apex/log"
|
||||||
"github.com/pterodactyl/wings/parser"
|
"github.com/pterodactyl/wings/parser"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
|
||||||
SftpAuthPassword = SftpAuthRequestType("password")
|
|
||||||
SftpAuthPublicKey = SftpAuthRequestType("public_key")
|
|
||||||
)
|
|
||||||
|
|
||||||
// A generic type allowing for easy binding use when making requests to API
|
// A generic type allowing for easy binding use when making requests to API
|
||||||
// endpoints that only expect a singular argument or something that would not
|
// endpoints that only expect a singular argument or something that would not
|
||||||
// benefit from being a typed struct.
|
// benefit from being a typed struct.
|
||||||
@@ -38,7 +32,7 @@ type Pagination struct {
|
|||||||
|
|
||||||
// ServerConfigurationResponse holds the server configuration data returned from
|
// ServerConfigurationResponse holds the server configuration data returned from
|
||||||
// the Panel. When a server process is started, Wings communicates with the
|
// the Panel. When a server process is started, Wings communicates with the
|
||||||
// Panel to fetch the latest build information as well as get all the details
|
// Panel to fetch the latest build information as well as get all of the details
|
||||||
// needed to parse the given Egg.
|
// needed to parse the given Egg.
|
||||||
//
|
//
|
||||||
// This means we do not need to hit Wings each time part of the server is
|
// This means we do not need to hit Wings each time part of the server is
|
||||||
@@ -67,12 +61,9 @@ type RawServerData struct {
|
|||||||
ProcessConfiguration json.RawMessage `json:"process_configuration"`
|
ProcessConfiguration json.RawMessage `json:"process_configuration"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type SftpAuthRequestType string
|
|
||||||
|
|
||||||
// SftpAuthRequest defines the request details that are passed along to the Panel
|
// SftpAuthRequest defines the request details that are passed along to the Panel
|
||||||
// when determining if the credentials provided to Wings are valid.
|
// when determining if the credentials provided to Wings are valid.
|
||||||
type SftpAuthRequest struct {
|
type SftpAuthRequest struct {
|
||||||
Type SftpAuthRequestType `json:"type"`
|
|
||||||
User string `json:"username"`
|
User string `json:"username"`
|
||||||
Pass string `json:"password"`
|
Pass string `json:"password"`
|
||||||
IP string `json:"ip"`
|
IP string `json:"ip"`
|
||||||
@@ -86,45 +77,44 @@ type SftpAuthRequest struct {
|
|||||||
// user for the SFTP subsystem.
|
// user for the SFTP subsystem.
|
||||||
type SftpAuthResponse struct {
|
type SftpAuthResponse struct {
|
||||||
Server string `json:"server"`
|
Server string `json:"server"`
|
||||||
User string `json:"user"`
|
Token string `json:"token"`
|
||||||
Permissions []string `json:"permissions"`
|
Permissions []string `json:"permissions"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type OutputLineMatcher struct {
|
type OutputLineMatcher struct {
|
||||||
// The raw string to match against. This may or may not be prefixed with
|
// The raw string to match against. This may or may not be prefixed with
|
||||||
// regex: which indicates we want to match against the regex expression.
|
// regex: which indicates we want to match against the regex expression.
|
||||||
raw []byte
|
raw string
|
||||||
reg *regexp.Regexp
|
reg *regexp.Regexp
|
||||||
}
|
}
|
||||||
|
|
||||||
// Matches determines if the provided byte string matches the given regex or
|
// Matches determines if a given string "s" matches the given line.
|
||||||
// raw string provided to the matcher.
|
func (olm *OutputLineMatcher) Matches(s string) bool {
|
||||||
func (olm *OutputLineMatcher) Matches(s []byte) bool {
|
|
||||||
if olm.reg == nil {
|
if olm.reg == nil {
|
||||||
return bytes.Contains(s, olm.raw)
|
return strings.Contains(s, olm.raw)
|
||||||
}
|
}
|
||||||
return olm.reg.Match(s)
|
|
||||||
|
return olm.reg.MatchString(s)
|
||||||
}
|
}
|
||||||
|
|
||||||
// String returns the matcher's raw comparison string.
|
// String returns the matcher's raw comparison string.
|
||||||
func (olm *OutputLineMatcher) String() string {
|
func (olm *OutputLineMatcher) String() string {
|
||||||
return string(olm.raw)
|
return olm.raw
|
||||||
}
|
}
|
||||||
|
|
||||||
// UnmarshalJSON unmarshals the startup lines into individual structs for easier
|
// UnmarshalJSON unmarshals the startup lines into individual structs for easier
|
||||||
// matching abilities.
|
// matching abilities.
|
||||||
func (olm *OutputLineMatcher) UnmarshalJSON(data []byte) error {
|
func (olm *OutputLineMatcher) UnmarshalJSON(data []byte) error {
|
||||||
var r string
|
if err := json.Unmarshal(data, &olm.raw); err != nil {
|
||||||
if err := json.Unmarshal(data, &r); err != nil {
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
olm.raw = []byte(r)
|
if strings.HasPrefix(olm.raw, "regex:") && len(olm.raw) > 6 {
|
||||||
if bytes.HasPrefix(olm.raw, []byte("regex:")) && len(olm.raw) > 6 {
|
r, err := regexp.Compile(strings.TrimPrefix(olm.raw, "regex:"))
|
||||||
r, err := regexp.Compile(strings.TrimPrefix(string(olm.raw), "regex:"))
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.WithField("error", err).WithField("raw", string(olm.raw)).Warn("failed to compile output line marked as being regex")
|
log.WithField("error", err).WithField("raw", olm.raw).Warn("failed to compile output line marked as being regex")
|
||||||
}
|
}
|
||||||
|
|
||||||
olm.reg = r
|
olm.reg = r
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,27 +2,26 @@ package downloader
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"emperror.dev/errors"
|
||||||
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"github.com/pterodactyl/wings/server"
|
||||||
"io"
|
"io"
|
||||||
"mime"
|
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"regexp"
|
||||||
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/goccy/go-json"
|
|
||||||
"github.com/google/uuid"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/server"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
var client = &http.Client{
|
var client = &http.Client{
|
||||||
Timeout: time.Hour * 12,
|
Timeout: time.Hour * 12,
|
||||||
// Disallow any redirect on an HTTP call. This is a security requirement: do not modify
|
// Disallow any redirect on a HTTP call. This is a security requirement: do not modify
|
||||||
// this logic without first ensuring that the new target location IS NOT within the current
|
// this logic without first ensuring that the new target location IS NOT within the current
|
||||||
// instance's local network.
|
// instance's local network.
|
||||||
//
|
//
|
||||||
@@ -37,14 +36,18 @@ var client = &http.Client{
|
|||||||
}
|
}
|
||||||
|
|
||||||
var instance = &Downloader{
|
var instance = &Downloader{
|
||||||
// Tracks all the active downloads.
|
// Tracks all of the active downloads.
|
||||||
downloadCache: make(map[string]*Download),
|
downloadCache: make(map[string]*Download),
|
||||||
// Tracks all the downloads active for a given server instance. This is
|
// Tracks all of the downloads active for a given server instance. This is
|
||||||
// primarily used to make things quicker and keep the code a little more
|
// primarily used to make things quicker and keep the code a little more
|
||||||
// legible throughout here.
|
// legible throughout here.
|
||||||
serverCache: make(map[string][]string),
|
serverCache: make(map[string][]string),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Regex to match the end of an IPv4/IPv6 address. This allows the port to be removed
|
||||||
|
// so that we are just working with the raw IP address in question.
|
||||||
|
var ipMatchRegex = regexp.MustCompile(`(:\d+)$`)
|
||||||
|
|
||||||
// Internal IP ranges that should be blocked if the resource requested resolves within.
|
// Internal IP ranges that should be blocked if the resource requested resolves within.
|
||||||
var internalRanges = []*net.IPNet{
|
var internalRanges = []*net.IPNet{
|
||||||
mustParseCIDR("127.0.0.1/8"),
|
mustParseCIDR("127.0.0.1/8"),
|
||||||
@@ -57,11 +60,9 @@ var internalRanges = []*net.IPNet{
|
|||||||
mustParseCIDR("fc00::/7"),
|
mustParseCIDR("fc00::/7"),
|
||||||
}
|
}
|
||||||
|
|
||||||
const (
|
const ErrInternalResolution = errors.Sentinel("downloader: destination resolves to internal network location")
|
||||||
ErrInternalResolution = errors.Sentinel("downloader: destination resolves to internal network location")
|
const ErrInvalidIPAddress = errors.Sentinel("downloader: invalid IP address")
|
||||||
ErrInvalidIPAddress = errors.Sentinel("downloader: invalid IP address")
|
const ErrDownloadFailed = errors.Sentinel("downloader: download request failed")
|
||||||
ErrDownloadFailed = errors.Sentinel("downloader: download request failed")
|
|
||||||
)
|
|
||||||
|
|
||||||
type Counter struct {
|
type Counter struct {
|
||||||
total int
|
total int
|
||||||
@@ -76,15 +77,12 @@ func (c *Counter) Write(p []byte) (int, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type DownloadRequest struct {
|
type DownloadRequest struct {
|
||||||
Directory string
|
|
||||||
URL *url.URL
|
URL *url.URL
|
||||||
FileName string
|
Directory string
|
||||||
UseHeader bool
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type Download struct {
|
type Download struct {
|
||||||
Identifier string
|
Identifier string
|
||||||
path string
|
|
||||||
mu sync.RWMutex
|
mu sync.RWMutex
|
||||||
req DownloadRequest
|
req DownloadRequest
|
||||||
server *server.Server
|
server *server.Server
|
||||||
@@ -92,7 +90,7 @@ type Download struct {
|
|||||||
cancelFunc *context.CancelFunc
|
cancelFunc *context.CancelFunc
|
||||||
}
|
}
|
||||||
|
|
||||||
// New starts a new tracked download which allows for cancellation later on by calling
|
// Starts a new tracked download which allows for cancellation later on by calling
|
||||||
// the Downloader.Cancel function.
|
// the Downloader.Cancel function.
|
||||||
func New(s *server.Server, r DownloadRequest) *Download {
|
func New(s *server.Server, r DownloadRequest) *Download {
|
||||||
dl := Download{
|
dl := Download{
|
||||||
@@ -104,14 +102,14 @@ func New(s *server.Server, r DownloadRequest) *Download {
|
|||||||
return &dl
|
return &dl
|
||||||
}
|
}
|
||||||
|
|
||||||
// ByServer returns all the tracked downloads for a given server instance.
|
// Returns all of the tracked downloads for a given server instance.
|
||||||
func ByServer(sid string) []*Download {
|
func ByServer(sid string) []*Download {
|
||||||
instance.mu.Lock()
|
instance.mu.Lock()
|
||||||
defer instance.mu.Unlock()
|
defer instance.mu.Unlock()
|
||||||
var downloads []*Download
|
var downloads []*Download
|
||||||
if v, ok := instance.serverCache[sid]; ok {
|
if v, ok := instance.serverCache[sid]; ok {
|
||||||
for _, id := range v {
|
for _, id := range v {
|
||||||
if dl, ok := instance.downloadCache[id]; ok {
|
if dl, dlok := instance.downloadCache[id]; dlok {
|
||||||
downloads = append(downloads, dl)
|
downloads = append(downloads, dl)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -119,7 +117,7 @@ func ByServer(sid string) []*Download {
|
|||||||
return downloads
|
return downloads
|
||||||
}
|
}
|
||||||
|
|
||||||
// ByID returns a single Download matching a given identifier. If no download is found
|
// Returns a single Download matching a given identifier. If no download is found
|
||||||
// the second argument in the response will be false.
|
// the second argument in the response will be false.
|
||||||
func ByID(dlid string) *Download {
|
func ByID(dlid string) *Download {
|
||||||
return instance.find(dlid)
|
return instance.find(dlid)
|
||||||
@@ -136,7 +134,7 @@ func (dl Download) MarshalJSON() ([]byte, error) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// Execute executes a given download for the server and begins writing the file to the disk. Once
|
// Executes a given download for the server and begins writing the file to the disk. Once
|
||||||
// completed the download will be removed from the cache.
|
// completed the download will be removed from the cache.
|
||||||
func (dl *Download) Execute() error {
|
func (dl *Download) Execute() error {
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), time.Hour*12)
|
ctx, cancel := context.WithTimeout(context.Background(), time.Hour*12)
|
||||||
@@ -176,28 +174,8 @@ func (dl *Download) Execute() error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if dl.req.UseHeader {
|
fnameparts := strings.Split(dl.req.URL.Path, "/")
|
||||||
if contentDisposition := res.Header.Get("Content-Disposition"); contentDisposition != "" {
|
p := filepath.Join(dl.req.Directory, fnameparts[len(fnameparts)-1])
|
||||||
_, params, err := mime.ParseMediaType(contentDisposition)
|
|
||||||
if err != nil {
|
|
||||||
return errors.WrapIf(err, "downloader: invalid \"Content-Disposition\" header")
|
|
||||||
}
|
|
||||||
|
|
||||||
if v, ok := params["filename"]; ok {
|
|
||||||
dl.path = v
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if dl.path == "" {
|
|
||||||
if dl.req.FileName != "" {
|
|
||||||
dl.path = dl.req.FileName
|
|
||||||
} else {
|
|
||||||
parts := strings.Split(dl.req.URL.Path, "/")
|
|
||||||
dl.path = parts[len(parts)-1]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
p := dl.Path()
|
|
||||||
dl.server.Log().WithField("path", p).Debug("writing remote file to disk")
|
dl.server.Log().WithField("path", p).Debug("writing remote file to disk")
|
||||||
|
|
||||||
r := io.TeeReader(res.Body, dl.counter(res.ContentLength))
|
r := io.TeeReader(res.Body, dl.counter(res.ContentLength))
|
||||||
@@ -207,7 +185,7 @@ func (dl *Download) Execute() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Cancel cancels a running download and frees up the associated resources. If a file is being
|
// Cancels a running download and frees up the associated resources. If a file is being
|
||||||
// written a partial file will remain present on the disk.
|
// written a partial file will remain present on the disk.
|
||||||
func (dl *Download) Cancel() {
|
func (dl *Download) Cancel() {
|
||||||
if dl.cancelFunc != nil {
|
if dl.cancelFunc != nil {
|
||||||
@@ -216,12 +194,12 @@ func (dl *Download) Cancel() {
|
|||||||
instance.remove(dl.Identifier)
|
instance.remove(dl.Identifier)
|
||||||
}
|
}
|
||||||
|
|
||||||
// BelongsTo checks if the given download belongs to the provided server.
|
// Checks if the given download belongs to the provided server.
|
||||||
func (dl *Download) BelongsTo(s *server.Server) bool {
|
func (dl *Download) BelongsTo(s *server.Server) bool {
|
||||||
return dl.server.ID() == s.ID()
|
return dl.server.Id() == s.Id()
|
||||||
}
|
}
|
||||||
|
|
||||||
// Progress returns the current progress of the download as a float value between 0 and 1 where
|
// Returns the current progress of the download as a float value between 0 and 1 where
|
||||||
// 1 indicates that the download is completed.
|
// 1 indicates that the download is completed.
|
||||||
func (dl *Download) Progress() float64 {
|
func (dl *Download) Progress() float64 {
|
||||||
dl.mu.RLock()
|
dl.mu.RLock()
|
||||||
@@ -229,10 +207,6 @@ func (dl *Download) Progress() float64 {
|
|||||||
return dl.progress
|
return dl.progress
|
||||||
}
|
}
|
||||||
|
|
||||||
func (dl *Download) Path() string {
|
|
||||||
return filepath.Join(dl.req.Directory, dl.path)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handles a write event by updating the progress completed percentage and firing off
|
// Handles a write event by updating the progress completed percentage and firing off
|
||||||
// events to the server websocket as needed.
|
// events to the server websocket as needed.
|
||||||
func (dl *Download) counter(contentLength int64) *Counter {
|
func (dl *Download) counter(contentLength int64) *Counter {
|
||||||
@@ -258,19 +232,15 @@ func (dl *Download) isExternalNetwork(ctx context.Context) error {
|
|||||||
|
|
||||||
// This cluster-fuck of math and integer shit converts an integer IP into a proper IPv4.
|
// This cluster-fuck of math and integer shit converts an integer IP into a proper IPv4.
|
||||||
// For example: 16843009 would become 1.1.1.1
|
// For example: 16843009 would become 1.1.1.1
|
||||||
//if i, err := strconv.ParseInt(host, 10, 64); err == nil {
|
if i, err := strconv.ParseInt(host, 10, 64); err == nil {
|
||||||
// host = strconv.FormatInt((i>>24)&0xFF, 10) + "." + strconv.FormatInt((i>>16)&0xFF, 10) + "." + strconv.FormatInt((i>>8)&0xFF, 10) + "." + strconv.FormatInt(i&0xFF, 10)
|
host = strconv.FormatInt((i>>24)&0xFF, 10) + "." + strconv.FormatInt((i>>16)&0xFF, 10) + "." + strconv.FormatInt((i>>8)&0xFF, 10) + "." + strconv.FormatInt(i&0xFF, 10)
|
||||||
//}
|
|
||||||
|
|
||||||
if _, _, err := net.SplitHostPort(host); err != nil {
|
|
||||||
if !strings.Contains(err.Error(), "missing port in address") {
|
|
||||||
return errors.WithStack(err)
|
|
||||||
}
|
}
|
||||||
switch dl.req.URL.Scheme {
|
|
||||||
case "http":
|
if !ipMatchRegex.MatchString(host) {
|
||||||
host += ":80"
|
if dl.req.URL.Scheme == "https" {
|
||||||
case "https":
|
host = host + ":443"
|
||||||
host += ":443"
|
} else {
|
||||||
|
host = host + ":80"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -280,11 +250,7 @@ func (dl *Download) isExternalNetwork(ctx context.Context) error {
|
|||||||
}
|
}
|
||||||
_ = c.Close()
|
_ = c.Close()
|
||||||
|
|
||||||
ipStr, _, err := net.SplitHostPort(c.RemoteAddr().String())
|
ip := net.ParseIP(ipMatchRegex.ReplaceAllString(c.RemoteAddr().String(), ""))
|
||||||
if err != nil {
|
|
||||||
return errors.WithStack(err)
|
|
||||||
}
|
|
||||||
ip := net.ParseIP(ipStr)
|
|
||||||
if ip == nil {
|
if ip == nil {
|
||||||
return errors.WithStack(ErrInvalidIPAddress)
|
return errors.WithStack(ErrInvalidIPAddress)
|
||||||
}
|
}
|
||||||
@@ -299,7 +265,7 @@ func (dl *Download) isExternalNetwork(ctx context.Context) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Downloader represents a global downloader that keeps track of all currently processing downloads
|
// Defines a global downloader struct that keeps track of all currently processing downloads
|
||||||
// for the machine.
|
// for the machine.
|
||||||
type Downloader struct {
|
type Downloader struct {
|
||||||
mu sync.RWMutex
|
mu sync.RWMutex
|
||||||
@@ -307,11 +273,11 @@ type Downloader struct {
|
|||||||
serverCache map[string][]string
|
serverCache map[string][]string
|
||||||
}
|
}
|
||||||
|
|
||||||
// track tracks a download in the internal cache for this instance.
|
// Tracks a download in the internal cache for this instance.
|
||||||
func (d *Downloader) track(dl *Download) {
|
func (d *Downloader) track(dl *Download) {
|
||||||
d.mu.Lock()
|
d.mu.Lock()
|
||||||
defer d.mu.Unlock()
|
defer d.mu.Unlock()
|
||||||
sid := dl.server.ID()
|
sid := dl.server.Id()
|
||||||
if _, ok := d.downloadCache[dl.Identifier]; !ok {
|
if _, ok := d.downloadCache[dl.Identifier]; !ok {
|
||||||
d.downloadCache[dl.Identifier] = dl
|
d.downloadCache[dl.Identifier] = dl
|
||||||
if _, ok := d.serverCache[sid]; !ok {
|
if _, ok := d.serverCache[sid]; !ok {
|
||||||
@@ -321,7 +287,7 @@ func (d *Downloader) track(dl *Download) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// find finds a given download entry using the provided ID and returns it.
|
// Finds a given download entry using the provided ID and returns it.
|
||||||
func (d *Downloader) find(dlid string) *Download {
|
func (d *Downloader) find(dlid string) *Download {
|
||||||
d.mu.RLock()
|
d.mu.RLock()
|
||||||
defer d.mu.RUnlock()
|
defer d.mu.RUnlock()
|
||||||
@@ -331,24 +297,24 @@ func (d *Downloader) find(dlid string) *Download {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// remove removes the given download reference from the cache storing them. This also updates
|
// Remove the given download reference from the cache storing them. This also updates
|
||||||
// the slice of active downloads for a given server to not include this download.
|
// the slice of active downloads for a given server to not include this download.
|
||||||
func (d *Downloader) remove(dlID string) {
|
func (d *Downloader) remove(dlid string) {
|
||||||
d.mu.Lock()
|
d.mu.Lock()
|
||||||
defer d.mu.Unlock()
|
defer d.mu.Unlock()
|
||||||
if _, ok := d.downloadCache[dlID]; !ok {
|
if _, ok := d.downloadCache[dlid]; !ok {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
sID := d.downloadCache[dlID].server.ID()
|
sid := d.downloadCache[dlid].server.Id()
|
||||||
delete(d.downloadCache, dlID)
|
delete(d.downloadCache, dlid)
|
||||||
if tracked, ok := d.serverCache[sID]; ok {
|
if tracked, ok := d.serverCache[sid]; ok {
|
||||||
var out []string
|
var out []string
|
||||||
for _, k := range tracked {
|
for _, k := range tracked {
|
||||||
if k != dlID {
|
if k != dlid {
|
||||||
out = append(out, k)
|
out = append(out, k)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
d.serverCache[sID] = out
|
d.serverCache[sid] = out
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ import (
|
|||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
"github.com/google/uuid"
|
"github.com/google/uuid"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
"github.com/pterodactyl/wings/server/filesystem"
|
"github.com/pterodactyl/wings/server/filesystem"
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ package router
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
"github.com/pterodactyl/wings/router/middleware"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -3,16 +3,17 @@ package middleware
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"crypto/subtle"
|
"crypto/subtle"
|
||||||
|
"github.com/pterodactyl/wings/metrics"
|
||||||
"io"
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
"github.com/google/uuid"
|
"github.com/google/uuid"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
@@ -63,7 +64,7 @@ func (re *RequestError) Abort(c *gin.Context, status int) {
|
|||||||
// server triggered this error.
|
// server triggered this error.
|
||||||
if s, ok := c.Get("server"); ok {
|
if s, ok := c.Get("server"); ok {
|
||||||
if s, ok := s.(*server.Server); ok {
|
if s, ok := s.(*server.Server); ok {
|
||||||
event = event.WithField("server_id", s.ID())
|
event = event.WithField("server_id", s.Id())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -218,29 +219,19 @@ func CaptureErrors() gin.HandlerFunc {
|
|||||||
// SetAccessControlHeaders sets the access request control headers on all of
|
// SetAccessControlHeaders sets the access request control headers on all of
|
||||||
// the requests.
|
// the requests.
|
||||||
func SetAccessControlHeaders() gin.HandlerFunc {
|
func SetAccessControlHeaders() gin.HandlerFunc {
|
||||||
cfg := config.Get()
|
origins := config.Get().AllowedOrigins
|
||||||
origins := cfg.AllowedOrigins
|
location := config.Get().PanelLocation
|
||||||
location := cfg.PanelLocation
|
|
||||||
allowPrivateNetwork := cfg.AllowCORSPrivateNetwork
|
|
||||||
|
|
||||||
return func(c *gin.Context) {
|
return func(c *gin.Context) {
|
||||||
c.Header("Access-Control-Allow-Origin", location)
|
|
||||||
c.Header("Access-Control-Allow-Credentials", "true")
|
c.Header("Access-Control-Allow-Credentials", "true")
|
||||||
c.Header("Access-Control-Allow-Methods", "GET, POST, PATCH, PUT, DELETE, OPTIONS")
|
c.Header("Access-Control-Allow-Methods", "GET, POST, PATCH, PUT, DELETE, OPTIONS")
|
||||||
c.Header("Access-Control-Allow-Headers", "Accept, Accept-Encoding, Authorization, Cache-Control, Content-Type, Content-Length, Origin, X-Real-IP, X-CSRF-Token")
|
|
||||||
|
|
||||||
// CORS for Private Networks (RFC1918)
|
|
||||||
// @see https://developer.chrome.com/blog/private-network-access-update/?utm_source=devtools
|
|
||||||
if allowPrivateNetwork {
|
|
||||||
c.Header("Access-Control-Request-Private-Network", "true")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Maximum age allowable under Chromium v76 is 2 hours, so just use that since
|
// Maximum age allowable under Chromium v76 is 2 hours, so just use that since
|
||||||
// anything higher will be ignored (even if other browsers do allow higher values).
|
// anything higher will be ignored (even if other browsers do allow higher values).
|
||||||
//
|
//
|
||||||
// @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age#Directives
|
// @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age#Directives
|
||||||
c.Header("Access-Control-Max-Age", "7200")
|
c.Header("Access-Control-Max-Age", "7200")
|
||||||
|
c.Header("Access-Control-Allow-Origin", location)
|
||||||
|
c.Header("Access-Control-Allow-Headers", "Accept, Accept-Encoding, Authorization, Cache-Control, Content-Type, Content-Length, Origin, X-Real-IP, X-CSRF-Token")
|
||||||
// Validate that the request origin is coming from an allowed origin. Because you
|
// Validate that the request origin is coming from an allowed origin. Because you
|
||||||
// cannot set multiple values here we need to see if the origin is one of the ones
|
// cannot set multiple values here we need to see if the origin is one of the ones
|
||||||
// that we allow, and if so return it explicitly. Otherwise, just return the default
|
// that we allow, and if so return it explicitly. Otherwise, just return the default
|
||||||
@@ -273,14 +264,14 @@ func ServerExists() gin.HandlerFunc {
|
|||||||
if c.Param("server") != "" {
|
if c.Param("server") != "" {
|
||||||
manager := ExtractManager(c)
|
manager := ExtractManager(c)
|
||||||
s = manager.Find(func(s *server.Server) bool {
|
s = manager.Find(func(s *server.Server) bool {
|
||||||
return c.Param("server") == s.ID()
|
return c.Param("server") == s.Id()
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
if s == nil {
|
if s == nil {
|
||||||
c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"error": "The requested resource does not exist on this instance."})
|
c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"error": "The requested resource does not exist on this instance."})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
c.Set("logger", ExtractLogger(c).WithField("server_id", s.ID()))
|
c.Set("logger", ExtractLogger(c).WithField("server_id", s.Id()))
|
||||||
c.Set("server", s)
|
c.Set("server", s)
|
||||||
c.Next()
|
c.Next()
|
||||||
}
|
}
|
||||||
@@ -363,3 +354,19 @@ func ExtractManager(c *gin.Context) *server.Manager {
|
|||||||
}
|
}
|
||||||
panic("middleware/middleware: cannot extract server manager: not present in context")
|
panic("middleware/middleware: cannot extract server manager: not present in context")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func Metrics() gin.HandlerFunc {
|
||||||
|
return func(c *gin.Context) {
|
||||||
|
path := c.Request.URL.Path
|
||||||
|
rawQuery := c.Request.URL.RawQuery
|
||||||
|
|
||||||
|
c.Next()
|
||||||
|
|
||||||
|
// Skip over the server websocket endpoint.
|
||||||
|
if strings.HasSuffix(c.FullPath(), "/ws") {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
metrics.HTTPRequestsTotal.WithLabelValues(c.Request.Method, c.FullPath(), path, rawQuery, strconv.Itoa(c.Writer.Status())).Inc()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -3,18 +3,18 @@ package router
|
|||||||
import (
|
import (
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
"github.com/pterodactyl/wings/router/middleware"
|
||||||
wserver "github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Configure configures the routing infrastructure for this daemon instance.
|
// Configure configures the routing infrastructure for this daemon instance.
|
||||||
func Configure(m *wserver.Manager, client remote.Client) *gin.Engine {
|
func Configure(m *server.Manager, client remote.Client) *gin.Engine {
|
||||||
gin.SetMode("release")
|
gin.SetMode("release")
|
||||||
|
|
||||||
router := gin.New()
|
router := gin.New()
|
||||||
router.Use(gin.Recovery())
|
router.Use(gin.Recovery())
|
||||||
|
router.Use(middleware.Metrics())
|
||||||
router.Use(middleware.AttachRequestID(), middleware.CaptureErrors(), middleware.SetAccessControlHeaders())
|
router.Use(middleware.AttachRequestID(), middleware.CaptureErrors(), middleware.SetAccessControlHeaders())
|
||||||
router.Use(middleware.AttachServerManager(m), middleware.AttachApiClient(client))
|
router.Use(middleware.AttachServerManager(m), middleware.AttachApiClient(client))
|
||||||
// @todo log this into a different file so you can setup IP blocking for abusive requests and such.
|
// @todo log this into a different file so you can setup IP blocking for abusive requests and such.
|
||||||
@@ -63,6 +63,7 @@ func Configure(m *wserver.Manager, client remote.Client) *gin.Engine {
|
|||||||
server.Use(middleware.RequireAuthorization(), middleware.ServerExists())
|
server.Use(middleware.RequireAuthorization(), middleware.ServerExists())
|
||||||
{
|
{
|
||||||
server.GET("", getServer)
|
server.GET("", getServer)
|
||||||
|
server.PATCH("", patchServer)
|
||||||
server.DELETE("", deleteServer)
|
server.DELETE("", deleteServer)
|
||||||
|
|
||||||
server.GET("/logs", getServerLogs)
|
server.GET("/logs", getServerLogs)
|
||||||
@@ -70,7 +71,6 @@ func Configure(m *wserver.Manager, client remote.Client) *gin.Engine {
|
|||||||
server.POST("/commands", postServerCommands)
|
server.POST("/commands", postServerCommands)
|
||||||
server.POST("/install", postServerInstall)
|
server.POST("/install", postServerInstall)
|
||||||
server.POST("/reinstall", postServerReinstall)
|
server.POST("/reinstall", postServerReinstall)
|
||||||
server.POST("/sync", postServerSync)
|
|
||||||
server.POST("/ws/deny", postServerDenyWSTokens)
|
server.POST("/ws/deny", postServerDenyWSTokens)
|
||||||
|
|
||||||
// This archive request causes the archive to start being created
|
// This archive request causes the archive to start being created
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import (
|
|||||||
"strconv"
|
"strconv"
|
||||||
|
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
"github.com/pterodactyl/wings/router/middleware"
|
||||||
"github.com/pterodactyl/wings/router/tokens"
|
"github.com/pterodactyl/wings/router/tokens"
|
||||||
"github.com/pterodactyl/wings/server/backup"
|
"github.com/pterodactyl/wings/server/backup"
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
package router
|
package router
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"net/http"
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
@@ -53,7 +54,6 @@ func postServerPower(c *gin.Context) {
|
|||||||
|
|
||||||
var data struct {
|
var data struct {
|
||||||
Action server.PowerAction `json:"action"`
|
Action server.PowerAction `json:"action"`
|
||||||
WaitSeconds int `json:"wait_seconds"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := c.BindJSON(&data); err != nil {
|
if err := c.BindJSON(&data); err != nil {
|
||||||
@@ -84,16 +84,12 @@ func postServerPower(c *gin.Context) {
|
|||||||
// we can immediately return a response from the server. Some of these actions
|
// we can immediately return a response from the server. Some of these actions
|
||||||
// can take quite some time, especially stopping or restarting.
|
// can take quite some time, especially stopping or restarting.
|
||||||
go func(s *server.Server) {
|
go func(s *server.Server) {
|
||||||
if data.WaitSeconds < 0 || data.WaitSeconds > 300 {
|
if err := s.HandlePowerAction(data.Action, 30); err != nil {
|
||||||
data.WaitSeconds = 30
|
|
||||||
}
|
|
||||||
if err := s.HandlePowerAction(data.Action, data.WaitSeconds); err != nil {
|
|
||||||
if errors.Is(err, context.DeadlineExceeded) {
|
if errors.Is(err, context.DeadlineExceeded) {
|
||||||
s.Log().WithField("action", data.Action).WithField("error", err).Warn("could not process server power action")
|
s.Log().WithField("action", data.Action).
|
||||||
} else if errors.Is(err, server.ErrIsRunning) {
|
Warn("could not acquire a lock while attempting to perform a power action")
|
||||||
// Do nothing, this isn't something we care about for logging,
|
|
||||||
} else {
|
} else {
|
||||||
s.Log().WithFields(log.Fields{"action": data.Action, "wait_seconds": data.WaitSeconds, "error": err}).
|
s.Log().WithFields(log.Fields{"action": data, "error": err}).
|
||||||
Error("encountered error processing a server power action in the background")
|
Error("encountered error processing a server power action in the background")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -106,7 +102,7 @@ func postServerPower(c *gin.Context) {
|
|||||||
func postServerCommands(c *gin.Context) {
|
func postServerCommands(c *gin.Context) {
|
||||||
s := ExtractServer(c)
|
s := ExtractServer(c)
|
||||||
|
|
||||||
if running, err := s.Environment.IsRunning(c.Request.Context()); err != nil {
|
if running, err := s.Environment.IsRunning(); err != nil {
|
||||||
NewServerError(err, s).Abort(c)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
} else if !running {
|
} else if !running {
|
||||||
@@ -133,18 +129,21 @@ func postServerCommands(c *gin.Context) {
|
|||||||
c.Status(http.StatusNoContent)
|
c.Status(http.StatusNoContent)
|
||||||
}
|
}
|
||||||
|
|
||||||
// postServerSync will accept a POST request and trigger a re-sync of the given
|
// Updates information about a server internally.
|
||||||
// server against the Panel. This can be manually triggered when needed by an
|
func patchServer(c *gin.Context) {
|
||||||
// external system, or triggered by the Panel itself when modifications are made
|
|
||||||
// to the build of a server internally.
|
|
||||||
func postServerSync(c *gin.Context) {
|
|
||||||
s := ExtractServer(c)
|
s := ExtractServer(c)
|
||||||
|
|
||||||
if err := s.Sync(); err != nil {
|
buf := bytes.Buffer{}
|
||||||
WithError(c, err)
|
buf.ReadFrom(c.Request.Body)
|
||||||
} else {
|
|
||||||
c.Status(http.StatusNoContent)
|
if err := s.UpdateDataStructure(buf.Bytes()); err != nil {
|
||||||
|
NewServerError(err, s).Abort(c)
|
||||||
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
s.SyncWithEnvironment()
|
||||||
|
|
||||||
|
c.Status(http.StatusNoContent)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Performs a server installation in a background thread.
|
// Performs a server installation in a background thread.
|
||||||
@@ -187,10 +186,16 @@ func deleteServer(c *gin.Context) {
|
|||||||
// Immediately suspend the server to prevent a user from attempting
|
// Immediately suspend the server to prevent a user from attempting
|
||||||
// to start it while this process is running.
|
// to start it while this process is running.
|
||||||
s.Config().SetSuspended(true)
|
s.Config().SetSuspended(true)
|
||||||
s.CleanupForDestroy()
|
|
||||||
|
// Stop all running background tasks for this server that are using the context on
|
||||||
|
// the server struct. This will cancel any running install processes for the server
|
||||||
|
// as well.
|
||||||
|
s.CtxCancel()
|
||||||
|
s.Events().Destroy()
|
||||||
|
s.Websockets().CancelAll()
|
||||||
|
|
||||||
// Remove any pending remote file downloads for the server.
|
// Remove any pending remote file downloads for the server.
|
||||||
for _, dl := range downloader.ByServer(s.ID()) {
|
for _, dl := range downloader.ByServer(s.Id()) {
|
||||||
dl.Cancel()
|
dl.Cancel()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -215,7 +220,7 @@ func deleteServer(c *gin.Context) {
|
|||||||
}(s.Filesystem().Path())
|
}(s.Filesystem().Path())
|
||||||
|
|
||||||
middleware.ExtractManager(c).Remove(func(server *server.Server) bool {
|
middleware.ExtractManager(c).Remove(func(server *server.Server) bool {
|
||||||
return server.ID() == s.ID()
|
return server.Id() == s.Id()
|
||||||
})
|
})
|
||||||
|
|
||||||
// Deallocate the reference to this server.
|
// Deallocate the reference to this server.
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import (
|
|||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
"github.com/pterodactyl/wings/router/middleware"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
"github.com/pterodactyl/wings/server/backup"
|
"github.com/pterodactyl/wings/server/backup"
|
||||||
@@ -43,7 +42,7 @@ func postServerBackup(c *gin.Context) {
|
|||||||
// Attach the server ID and the request ID to the adapter log context for easier
|
// Attach the server ID and the request ID to the adapter log context for easier
|
||||||
// parsing in the logs.
|
// parsing in the logs.
|
||||||
adapter.WithLogContext(map[string]interface{}{
|
adapter.WithLogContext(map[string]interface{}{
|
||||||
"server": s.ID(),
|
"server": s.Id(),
|
||||||
"request_id": c.GetString("request_id"),
|
"request_id": c.GetString("request_id"),
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
@@ -13,18 +13,15 @@ import (
|
|||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
"golang.org/x/sync/errgroup"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/router/downloader"
|
"github.com/pterodactyl/wings/router/downloader"
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
"github.com/pterodactyl/wings/router/middleware"
|
||||||
"github.com/pterodactyl/wings/router/tokens"
|
"github.com/pterodactyl/wings/router/tokens"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
"github.com/pterodactyl/wings/server/filesystem"
|
"github.com/pterodactyl/wings/server/filesystem"
|
||||||
|
"golang.org/x/sync/errgroup"
|
||||||
)
|
)
|
||||||
|
|
||||||
// getServerFileContents returns the contents of a file on the server.
|
// getServerFileContents returns the contents of a file on the server.
|
||||||
@@ -37,15 +34,6 @@ func getServerFileContents(c *gin.Context) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
defer f.Close()
|
defer f.Close()
|
||||||
// Don't allow a named pipe to be opened.
|
|
||||||
//
|
|
||||||
// @see https://github.com/pterodactyl/panel/issues/4059
|
|
||||||
if st.Mode()&os.ModeNamedPipe != 0 {
|
|
||||||
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{
|
|
||||||
"error": "Cannot open files of this type.",
|
|
||||||
})
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
c.Header("X-Mime-Type", st.Mimetype)
|
c.Header("X-Mime-Type", st.Mimetype)
|
||||||
c.Header("Content-Length", strconv.Itoa(int(st.Size())))
|
c.Header("Content-Length", strconv.Itoa(int(st.Size())))
|
||||||
@@ -131,10 +119,6 @@ func putServerRenameFiles(c *gin.Context) {
|
|||||||
// Return nil if the error is an is not exists.
|
// Return nil if the error is an is not exists.
|
||||||
// NOTE: os.IsNotExist() does not work if the error is wrapped.
|
// NOTE: os.IsNotExist() does not work if the error is wrapped.
|
||||||
if errors.Is(err, os.ErrNotExist) {
|
if errors.Is(err, os.ErrNotExist) {
|
||||||
s.Log().WithField("error", err).
|
|
||||||
WithField("from_path", pf).
|
|
||||||
WithField("to_path", pt).
|
|
||||||
Warn("failed to rename: source or target does not exist")
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
return err
|
return err
|
||||||
@@ -261,7 +245,7 @@ func postServerWriteFile(c *gin.Context) {
|
|||||||
func getServerPullingFiles(c *gin.Context) {
|
func getServerPullingFiles(c *gin.Context) {
|
||||||
s := ExtractServer(c)
|
s := ExtractServer(c)
|
||||||
c.JSON(http.StatusOK, gin.H{
|
c.JSON(http.StatusOK, gin.H{
|
||||||
"downloads": downloader.ByServer(s.ID()),
|
"downloads": downloader.ByServer(s.Id()),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -269,23 +253,13 @@ func getServerPullingFiles(c *gin.Context) {
|
|||||||
func postServerPullRemoteFile(c *gin.Context) {
|
func postServerPullRemoteFile(c *gin.Context) {
|
||||||
s := ExtractServer(c)
|
s := ExtractServer(c)
|
||||||
var data struct {
|
var data struct {
|
||||||
// Deprecated
|
|
||||||
Directory string `binding:"required_without=RootPath,omitempty" json:"directory"`
|
|
||||||
RootPath string `binding:"required_without=Directory,omitempty" json:"root"`
|
|
||||||
URL string `binding:"required" json:"url"`
|
URL string `binding:"required" json:"url"`
|
||||||
FileName string `json:"file_name"`
|
Directory string `binding:"required,omitempty" json:"directory"`
|
||||||
UseHeader bool `json:"use_header"`
|
|
||||||
Foreground bool `json:"foreground"`
|
|
||||||
}
|
}
|
||||||
if err := c.BindJSON(&data); err != nil {
|
if err := c.BindJSON(&data); err != nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Handle the deprecated Directory field in the struct until it is removed.
|
|
||||||
if data.Directory != "" && data.RootPath == "" {
|
|
||||||
data.RootPath = data.Directory
|
|
||||||
}
|
|
||||||
|
|
||||||
u, err := url.Parse(data.URL)
|
u, err := url.Parse(data.URL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if e, ok := err.(*url.Error); ok {
|
if e, ok := err.(*url.Error); ok {
|
||||||
@@ -303,7 +277,7 @@ func postServerPullRemoteFile(c *gin.Context) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
// Do not allow more than three simultaneous remote file downloads at one time.
|
// Do not allow more than three simultaneous remote file downloads at one time.
|
||||||
if len(downloader.ByServer(s.ID())) >= 3 {
|
if len(downloader.ByServer(s.Id())) >= 3 {
|
||||||
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{
|
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{
|
||||||
"error": "This server has reached its limit of 3 simultaneous remote file downloads at once. Please wait for one to complete before trying again.",
|
"error": "This server has reached its limit of 3 simultaneous remote file downloads at once. Please wait for one to complete before trying again.",
|
||||||
})
|
})
|
||||||
@@ -311,43 +285,23 @@ func postServerPullRemoteFile(c *gin.Context) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
dl := downloader.New(s, downloader.DownloadRequest{
|
dl := downloader.New(s, downloader.DownloadRequest{
|
||||||
Directory: data.RootPath,
|
|
||||||
URL: u,
|
URL: u,
|
||||||
FileName: data.FileName,
|
Directory: data.Directory,
|
||||||
UseHeader: data.UseHeader,
|
|
||||||
})
|
})
|
||||||
|
|
||||||
download := func() error {
|
// Execute this pull in a seperate thread since it may take a long time to complete.
|
||||||
|
go func() {
|
||||||
s.Log().WithField("download_id", dl.Identifier).WithField("url", u.String()).Info("starting pull of remote file to disk")
|
s.Log().WithField("download_id", dl.Identifier).WithField("url", u.String()).Info("starting pull of remote file to disk")
|
||||||
if err := dl.Execute(); err != nil {
|
if err := dl.Execute(); err != nil {
|
||||||
s.Log().WithField("download_id", dl.Identifier).WithField("error", err).Error("failed to pull remote file")
|
s.Log().WithField("download_id", dl.Identifier).WithField("error", err).Error("failed to pull remote file")
|
||||||
return err
|
|
||||||
} else {
|
} else {
|
||||||
s.Log().WithField("download_id", dl.Identifier).Info("completed pull of remote file")
|
s.Log().WithField("download_id", dl.Identifier).Info("completed pull of remote file")
|
||||||
}
|
}
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if !data.Foreground {
|
|
||||||
go func() {
|
|
||||||
_ = download()
|
|
||||||
}()
|
}()
|
||||||
|
|
||||||
c.JSON(http.StatusAccepted, gin.H{
|
c.JSON(http.StatusAccepted, gin.H{
|
||||||
"identifier": dl.Identifier,
|
"identifier": dl.Identifier,
|
||||||
})
|
})
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := download(); err != nil {
|
|
||||||
NewServerError(err, s).Abort(c)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
st, err := s.Filesystem().Stat(dl.Path())
|
|
||||||
if err != nil {
|
|
||||||
NewServerError(err, s).AbortFilesystemError(c)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
c.JSON(http.StatusOK, &st)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Stops a remote file download if it exists and belongs to this server.
|
// Stops a remote file download if it exists and belongs to this server.
|
||||||
@@ -575,16 +529,8 @@ func postServerUploadFiles(c *gin.Context) {
|
|||||||
|
|
||||||
directory := c.Query("directory")
|
directory := c.Query("directory")
|
||||||
|
|
||||||
maxFileSize := config.Get().Api.UploadLimit
|
|
||||||
maxFileSizeBytes := maxFileSize * 1024 * 1024
|
|
||||||
var totalSize int64
|
var totalSize int64
|
||||||
for _, header := range headers {
|
for _, header := range headers {
|
||||||
if header.Size > maxFileSizeBytes {
|
|
||||||
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{
|
|
||||||
"error": "File " + header.Filename + " is larger than the maximum file upload size of " + strconv.FormatInt(maxFileSize, 10) + " MB.",
|
|
||||||
})
|
|
||||||
return
|
|
||||||
}
|
|
||||||
totalSize += header.Size
|
totalSize += header.Size
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,36 +2,19 @@ package router
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
"github.com/goccy/go-json"
|
|
||||||
ws "github.com/gorilla/websocket"
|
ws "github.com/gorilla/websocket"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
"github.com/pterodactyl/wings/router/middleware"
|
||||||
"github.com/pterodactyl/wings/router/websocket"
|
"github.com/pterodactyl/wings/router/websocket"
|
||||||
)
|
)
|
||||||
|
|
||||||
var expectedCloseCodes = []int{
|
|
||||||
ws.CloseGoingAway,
|
|
||||||
ws.CloseAbnormalClosure,
|
|
||||||
ws.CloseNormalClosure,
|
|
||||||
ws.CloseNoStatusReceived,
|
|
||||||
ws.CloseServiceRestart,
|
|
||||||
}
|
|
||||||
|
|
||||||
// Upgrades a connection to a websocket and passes events along between.
|
// Upgrades a connection to a websocket and passes events along between.
|
||||||
func getServerWebsocket(c *gin.Context) {
|
func getServerWebsocket(c *gin.Context) {
|
||||||
manager := middleware.ExtractManager(c)
|
manager := middleware.ExtractManager(c)
|
||||||
s, _ := manager.Get(c.Param("server"))
|
s, _ := manager.Get(c.Param("server"))
|
||||||
|
|
||||||
// Create a context that can be canceled when the user disconnects from this
|
|
||||||
// socket that will also cancel listeners running in separate threads. If the
|
|
||||||
// connection itself is terminated listeners using this context will also be
|
|
||||||
// closed.
|
|
||||||
ctx, cancel := context.WithCancel(c.Request.Context())
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
handler, err := websocket.GetHandler(s, c.Writer, c.Request)
|
handler, err := websocket.GetHandler(s, c.Writer, c.Request)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
NewServerError(err, s).Abort(c)
|
NewServerError(err, s).Abort(c)
|
||||||
@@ -39,37 +22,50 @@ func getServerWebsocket(c *gin.Context) {
|
|||||||
}
|
}
|
||||||
defer handler.Connection.Close()
|
defer handler.Connection.Close()
|
||||||
|
|
||||||
|
// Create a context that can be canceled when the user disconnects from this
|
||||||
|
// socket that will also cancel listeners running in separate threads.
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
// Track this open connection on the server so that we can close them all programmatically
|
// Track this open connection on the server so that we can close them all programmatically
|
||||||
// if the server is deleted.
|
// if the server is deleted.
|
||||||
s.Websockets().Push(handler.Uuid(), &cancel)
|
s.Websockets().Push(handler.Uuid(), &cancel)
|
||||||
handler.Logger().Debug("opening connection to server websocket")
|
defer s.Websockets().Remove(handler.Uuid())
|
||||||
|
|
||||||
defer func() {
|
// Listen for the context being canceled and then close the websocket connection. This normally
|
||||||
s.Websockets().Remove(handler.Uuid())
|
// just happens because you're disconnecting from the socket in the browser, however in some
|
||||||
handler.Logger().Debug("closing connection to server websocket")
|
// cases we close the connections programmatically (e.g. deleting the server) and need to send
|
||||||
}()
|
// a close message to the websocket so it disconnects.
|
||||||
|
go func(ctx context.Context, c *ws.Conn) {
|
||||||
// If the server is deleted we need to send a close message to the connected client
|
ListenerLoop:
|
||||||
// so that they disconnect since there will be no more events sent along. Listen for
|
for {
|
||||||
// the request context being closed to break this loop, otherwise this routine will
|
|
||||||
// be left hanging in the background.
|
|
||||||
go func() {
|
|
||||||
select {
|
select {
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
break
|
|
||||||
case <-s.Context().Done():
|
|
||||||
handler.Connection.WriteControl(ws.CloseMessage, ws.FormatCloseMessage(ws.CloseGoingAway, "server deleted"), time.Now().Add(time.Second*5))
|
handler.Connection.WriteControl(ws.CloseMessage, ws.FormatCloseMessage(ws.CloseGoingAway, "server deleted"), time.Now().Add(time.Second*5))
|
||||||
break
|
// A break right here without defining the specific loop would only break the select
|
||||||
|
// and not actually break the for loop, thus causing this routine to stick around forever.
|
||||||
|
break ListenerLoop
|
||||||
}
|
}
|
||||||
}()
|
}
|
||||||
|
}(ctx, handler.Connection)
|
||||||
|
|
||||||
|
go handler.ListenForServerEvents(ctx)
|
||||||
|
go handler.ListenForExpiration(ctx)
|
||||||
|
|
||||||
for {
|
for {
|
||||||
j := websocket.Message{}
|
j := websocket.Message{}
|
||||||
|
|
||||||
_, p, err := handler.Connection.ReadMessage()
|
_, p, err := handler.Connection.ReadMessage()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if ws.IsUnexpectedCloseError(err, expectedCloseCodes...) {
|
if !ws.IsCloseError(
|
||||||
handler.Logger().WithField("error", err).Warn("error handling websocket message for server")
|
err,
|
||||||
|
ws.CloseNormalClosure,
|
||||||
|
ws.CloseGoingAway,
|
||||||
|
ws.CloseNoStatusReceived,
|
||||||
|
ws.CloseServiceRestart,
|
||||||
|
ws.CloseAbnormalClosure,
|
||||||
|
) {
|
||||||
|
s.Log().WithField("error", err).Warn("error handling websocket message for server")
|
||||||
}
|
}
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
@@ -82,7 +78,7 @@ func getServerWebsocket(c *gin.Context) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
go func(msg websocket.Message) {
|
go func(msg websocket.Message) {
|
||||||
if err := handler.HandleInbound(ctx, msg); err != nil {
|
if err := handler.HandleInbound(msg); err != nil {
|
||||||
handler.SendErrorJson(msg, err)
|
handler.SendErrorJson(msg, err)
|
||||||
}
|
}
|
||||||
}(j)
|
}(j)
|
||||||
|
|||||||
@@ -1,14 +1,12 @@
|
|||||||
package router
|
package router
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"bytes"
|
||||||
"errors"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/installer"
|
"github.com/pterodactyl/wings/installer"
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
"github.com/pterodactyl/wings/router/middleware"
|
||||||
@@ -43,13 +41,10 @@ func getAllServers(c *gin.Context) {
|
|||||||
// for it.
|
// for it.
|
||||||
func postCreateServer(c *gin.Context) {
|
func postCreateServer(c *gin.Context) {
|
||||||
manager := middleware.ExtractManager(c)
|
manager := middleware.ExtractManager(c)
|
||||||
|
buf := bytes.Buffer{}
|
||||||
|
buf.ReadFrom(c.Request.Body)
|
||||||
|
|
||||||
details := installer.ServerDetails{}
|
install, err := installer.New(c.Request.Context(), manager, buf.Bytes())
|
||||||
if err := c.BindJSON(&details); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
install, err := installer.New(c.Request.Context(), manager, details)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if installer.IsValidationError(err) {
|
if installer.IsValidationError(err) {
|
||||||
c.AbortWithStatusJSON(http.StatusUnprocessableEntity, gin.H{
|
c.AbortWithStatusJSON(http.StatusUnprocessableEntity, gin.H{
|
||||||
@@ -70,27 +65,14 @@ func postCreateServer(c *gin.Context) {
|
|||||||
// cycle. If there are any errors they will be logged and communicated back
|
// cycle. If there are any errors they will be logged and communicated back
|
||||||
// to the Panel where a reinstall may take place.
|
// to the Panel where a reinstall may take place.
|
||||||
go func(i *installer.Installer) {
|
go func(i *installer.Installer) {
|
||||||
if err := i.Server().CreateEnvironment(); err != nil {
|
err := i.Server().CreateEnvironment()
|
||||||
|
if err != nil {
|
||||||
i.Server().Log().WithField("error", err).Error("failed to create server environment during install process")
|
i.Server().Log().WithField("error", err).Error("failed to create server environment during install process")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := i.Server().Install(false); err != nil {
|
if err := i.Server().Install(false); err != nil {
|
||||||
log.WithFields(log.Fields{"server": i.Server().ID(), "error": err}).Error("failed to run install process for server")
|
log.WithFields(log.Fields{"server": i.Uuid(), "error": err}).Error("failed to run install process for server")
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if i.StartOnCompletion {
|
|
||||||
log.WithField("server_id", i.Server().ID()).Debug("starting server after successful installation")
|
|
||||||
if err := i.Server().HandlePowerAction(server.PowerActionStart, 30); err != nil {
|
|
||||||
if errors.Is(err, context.DeadlineExceeded) {
|
|
||||||
log.WithFields(log.Fields{"server_id": i.Server().ID(), "action": "start"}).Warn("could not acquire a lock while attempting to perform a power action")
|
|
||||||
} else {
|
|
||||||
log.WithFields(log.Fields{"server_id": i.Server().ID(), "action": "start", "error": err}).Error("encountered error processing a server power action in the background")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
log.WithField("server_id", i.Server().ID()).Debug("skipping automatic start after successful server installation")
|
|
||||||
}
|
}
|
||||||
}(install)
|
}(install)
|
||||||
|
|
||||||
@@ -103,17 +85,15 @@ func postUpdateConfiguration(c *gin.Context) {
|
|||||||
if err := c.BindJSON(&cfg); err != nil {
|
if err := c.BindJSON(&cfg); err != nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Keep the SSL certificates the same since the Panel will send through Lets Encrypt
|
// Keep the SSL certificates the same since the Panel will send through Lets Encrypt
|
||||||
// default locations. However, if we picked a different location manually we don't
|
// default locations. However, if we picked a different location manually we don't
|
||||||
// want to override that.
|
// want to override that.
|
||||||
//
|
//
|
||||||
// If you pass through manual locations in the API call this logic will be skipped.
|
// If you pass through manual locations in the API call this logic will be skipped.
|
||||||
if strings.HasPrefix(cfg.Api.Ssl.KeyFile, "/etc/letsencrypt/live/") {
|
if strings.HasPrefix(cfg.Api.Ssl.KeyFile, "/etc/letsencrypt/live/") {
|
||||||
cfg.Api.Ssl.KeyFile = config.Get().Api.Ssl.KeyFile
|
cfg.Api.Ssl.KeyFile = strings.ToLower(config.Get().Api.Ssl.KeyFile)
|
||||||
cfg.Api.Ssl.CertificateFile = config.Get().Api.Ssl.CertificateFile
|
cfg.Api.Ssl.CertificateFile = strings.ToLower(config.Get().Api.Ssl.CertificateFile)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Try to write this new configuration to the disk before updating our global
|
// Try to write this new configuration to the disk before updating our global
|
||||||
// state with it.
|
// state with it.
|
||||||
if err := config.WriteToDisk(cfg); err != nil {
|
if err := config.WriteToDisk(cfg); err != nil {
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"crypto/sha256"
|
"crypto/sha256"
|
||||||
"encoding/hex"
|
"encoding/hex"
|
||||||
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
@@ -22,7 +23,6 @@ import (
|
|||||||
"github.com/juju/ratelimit"
|
"github.com/juju/ratelimit"
|
||||||
"github.com/mholt/archiver/v3"
|
"github.com/mholt/archiver/v3"
|
||||||
"github.com/mitchellh/colorstring"
|
"github.com/mitchellh/colorstring"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/installer"
|
"github.com/pterodactyl/wings/installer"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
@@ -49,7 +49,7 @@ type serverTransferRequest struct {
|
|||||||
ServerID string `binding:"required" json:"server_id"`
|
ServerID string `binding:"required" json:"server_id"`
|
||||||
URL string `binding:"required" json:"url"`
|
URL string `binding:"required" json:"url"`
|
||||||
Token string `binding:"required" json:"token"`
|
Token string `binding:"required" json:"token"`
|
||||||
Server installer.ServerDetails `json:"server"`
|
Server json.RawMessage `json:"server"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func getArchivePath(sID string) string {
|
func getArchivePath(sID string) string {
|
||||||
@@ -75,14 +75,14 @@ func getServerArchive(c *gin.Context) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
s := ExtractServer(c)
|
s := ExtractServer(c)
|
||||||
if token.Subject != s.ID() {
|
if token.Subject != s.Id() {
|
||||||
c.AbortWithStatusJSON(http.StatusForbidden, gin.H{
|
c.AbortWithStatusJSON(http.StatusForbidden, gin.H{
|
||||||
"error": "Missing required token subject, or subject is not valid for the requested server.",
|
"error": "Missing required token subject, or subject is not valid for the requested server.",
|
||||||
})
|
})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
archivePath := getArchivePath(s.ID())
|
archivePath := getArchivePath(s.Id())
|
||||||
|
|
||||||
// Stat the archive file.
|
// Stat the archive file.
|
||||||
st, err := os.Lstat(archivePath)
|
st, err := os.Lstat(archivePath)
|
||||||
@@ -123,7 +123,7 @@ func getServerArchive(c *gin.Context) {
|
|||||||
c.Header("X-Checksum", checksum)
|
c.Header("X-Checksum", checksum)
|
||||||
c.Header("X-Mime-Type", "application/tar+gzip")
|
c.Header("X-Mime-Type", "application/tar+gzip")
|
||||||
c.Header("Content-Length", strconv.Itoa(int(st.Size())))
|
c.Header("Content-Length", strconv.Itoa(int(st.Size())))
|
||||||
c.Header("Content-Disposition", "attachment; filename="+strconv.Quote(s.ID()+".tar.gz"))
|
c.Header("Content-Disposition", "attachment; filename="+strconv.Quote(s.Id()+".tar.gz"))
|
||||||
c.Header("Content-Type", "application/octet-stream")
|
c.Header("Content-Type", "application/octet-stream")
|
||||||
|
|
||||||
_, _ = bufio.NewReader(f).WriteTo(c.Writer)
|
_, _ = bufio.NewReader(f).WriteTo(c.Writer)
|
||||||
@@ -134,7 +134,7 @@ func postServerArchive(c *gin.Context) {
|
|||||||
manager := middleware.ExtractManager(c)
|
manager := middleware.ExtractManager(c)
|
||||||
|
|
||||||
go func(s *server.Server) {
|
go func(s *server.Server) {
|
||||||
l := log.WithField("server", s.ID())
|
l := log.WithField("server", s.Id())
|
||||||
|
|
||||||
// This function automatically adds the Source Node prefix and Timestamp to the log
|
// This function automatically adds the Source Node prefix and Timestamp to the log
|
||||||
// output before sending it over the websocket.
|
// output before sending it over the websocket.
|
||||||
@@ -157,7 +157,7 @@ func postServerArchive(c *gin.Context) {
|
|||||||
s.Events().Publish(server.TransferStatusEvent, "failure")
|
s.Events().Publish(server.TransferStatusEvent, "failure")
|
||||||
|
|
||||||
sendTransferLog("Attempting to notify panel of archive failure..")
|
sendTransferLog("Attempting to notify panel of archive failure..")
|
||||||
if err := manager.Client().SetArchiveStatus(s.Context(), s.ID(), false); err != nil {
|
if err := manager.Client().SetArchiveStatus(s.Context(), s.Id(), false); err != nil {
|
||||||
if !remote.IsRequestError(err) {
|
if !remote.IsRequestError(err) {
|
||||||
sendTransferLog("Failed to notify panel of archive failure: " + err.Error())
|
sendTransferLog("Failed to notify panel of archive failure: " + err.Error())
|
||||||
l.WithField("error", err).Error("failed to notify panel of failed archive status")
|
l.WithField("error", err).Error("failed to notify panel of failed archive status")
|
||||||
@@ -178,7 +178,7 @@ func postServerArchive(c *gin.Context) {
|
|||||||
|
|
||||||
// Ensure the server is offline. Sometimes a "No such container" error gets through
|
// Ensure the server is offline. Sometimes a "No such container" error gets through
|
||||||
// which means the server is already stopped. We can ignore that.
|
// which means the server is already stopped. We can ignore that.
|
||||||
if err := s.Environment.WaitForStop(s.Context(), time.Minute, false); err != nil && !strings.Contains(strings.ToLower(err.Error()), "no such container") {
|
if err := s.Environment.WaitForStop(60, false); err != nil && !strings.Contains(strings.ToLower(err.Error()), "no such container") {
|
||||||
sendTransferLog("Failed to stop server, aborting transfer..")
|
sendTransferLog("Failed to stop server, aborting transfer..")
|
||||||
l.WithField("error", err).Error("failed to stop server")
|
l.WithField("error", err).Error("failed to stop server")
|
||||||
return
|
return
|
||||||
@@ -190,7 +190,7 @@ func postServerArchive(c *gin.Context) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Attempt to get an archive of the server.
|
// Attempt to get an archive of the server.
|
||||||
if err := a.Create(getArchivePath(s.ID())); err != nil {
|
if err := a.Create(getArchivePath(s.Id())); err != nil {
|
||||||
sendTransferLog("An error occurred while archiving the server: " + err.Error())
|
sendTransferLog("An error occurred while archiving the server: " + err.Error())
|
||||||
l.WithField("error", err).Error("failed to get transfer archive for server")
|
l.WithField("error", err).Error("failed to get transfer archive for server")
|
||||||
return
|
return
|
||||||
@@ -199,7 +199,7 @@ func postServerArchive(c *gin.Context) {
|
|||||||
sendTransferLog("Successfully created archive, attempting to notify panel..")
|
sendTransferLog("Successfully created archive, attempting to notify panel..")
|
||||||
l.Info("successfully created server transfer archive, notifying panel..")
|
l.Info("successfully created server transfer archive, notifying panel..")
|
||||||
|
|
||||||
if err := manager.Client().SetArchiveStatus(s.Context(), s.ID(), true); err != nil {
|
if err := manager.Client().SetArchiveStatus(s.Context(), s.Id(), true); err != nil {
|
||||||
if !remote.IsRequestError(err) {
|
if !remote.IsRequestError(err) {
|
||||||
sendTransferLog("Failed to notify panel of archive success: " + err.Error())
|
sendTransferLog("Failed to notify panel of archive success: " + err.Error())
|
||||||
l.WithField("error", err).Error("failed to notify panel of successful archive status")
|
l.WithField("error", err).Error("failed to notify panel of successful archive status")
|
||||||
@@ -360,7 +360,7 @@ func postTransfer(c *gin.Context) {
|
|||||||
sendTransferLog("Server transfer failed, check Wings logs for additional information.")
|
sendTransferLog("Server transfer failed, check Wings logs for additional information.")
|
||||||
s.Events().Publish(server.TransferStatusEvent, "failure")
|
s.Events().Publish(server.TransferStatusEvent, "failure")
|
||||||
manager.Remove(func(match *server.Server) bool {
|
manager.Remove(func(match *server.Server) bool {
|
||||||
return match.ID() == s.ID()
|
return match.Id() == s.Id()
|
||||||
})
|
})
|
||||||
|
|
||||||
// If the transfer status was successful but the request failed, act like the transfer failed.
|
// If the transfer status was successful but the request failed, act like the transfer failed.
|
||||||
|
|||||||
@@ -1,11 +1,9 @@
|
|||||||
package tokens
|
package tokens
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/gbrlsnchs/jwt/v3"
|
"github.com/gbrlsnchs/jwt/v3"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
type TokenData interface {
|
type TokenData interface {
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
package tokens
|
package tokens
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"github.com/patrickmn/go-cache"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/patrickmn/go-cache"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type TokenStore struct {
|
type TokenStore struct {
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
package tokens
|
package tokens
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"github.com/apex/log"
|
||||||
|
"github.com/gbrlsnchs/jwt/v3"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/apex/log"
|
|
||||||
"github.com/gbrlsnchs/jwt/v3"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// The time at which Wings was booted. No JWT's created before this time are allowed to
|
// The time at which Wings was booted. No JWT's created before this time are allowed to
|
||||||
@@ -34,13 +34,13 @@ func DenyJTI(jti string) {
|
|||||||
denylist.Store(jti, time.Now())
|
denylist.Store(jti, time.Now())
|
||||||
}
|
}
|
||||||
|
|
||||||
// WebsocketPayload defines the JWT payload for a websocket connection. This JWT is passed along to
|
// A JWT payload for Websocket connections. This JWT is passed along to the Websocket after
|
||||||
// the websocket after it has been connected to by sending an "auth" event.
|
// it has been connected to by sending an "auth" event.
|
||||||
type WebsocketPayload struct {
|
type WebsocketPayload struct {
|
||||||
jwt.Payload
|
jwt.Payload
|
||||||
sync.RWMutex
|
sync.RWMutex
|
||||||
|
|
||||||
UserUUID string `json:"user_uuid"`
|
UserID json.Number `json:"user_id"`
|
||||||
ServerUUID string `json:"server_uuid"`
|
ServerUUID string `json:"server_uuid"`
|
||||||
Permissions []string `json:"permissions"`
|
Permissions []string `json:"permissions"`
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,50 +2,21 @@ package websocket
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/goccy/go-json"
|
|
||||||
"github.com/pterodactyl/wings/events"
|
"github.com/pterodactyl/wings/events"
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
// RegisterListenerEvents will setup the server event listeners and expiration
|
// Checks the time to expiration on the JWT every 30 seconds until the token has
|
||||||
// timers. This is only triggered on first authentication with the websocket,
|
// expired. If we are within 3 minutes of the token expiring, send a notice over
|
||||||
// reconnections will not call it.
|
// the socket that it is expiring soon. If it has expired, send that notice as well.
|
||||||
//
|
func (h *Handler) ListenForExpiration(ctx context.Context) {
|
||||||
// This needs to be called once the socket is properly authenticated otherwise
|
|
||||||
// you'll get a flood of error spam in the output that doesn't make sense because
|
|
||||||
// Docker events being output to the socket will fail when it hasn't been
|
|
||||||
// properly initialized yet.
|
|
||||||
//
|
|
||||||
// @see https://github.com/pterodactyl/panel/issues/3295
|
|
||||||
func (h *Handler) registerListenerEvents(ctx context.Context) {
|
|
||||||
h.Logger().Debug("registering event listeners for connection")
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
if err := h.listenForServerEvents(ctx); err != nil {
|
|
||||||
h.Logger().Warn("error while processing server event; closing websocket connection")
|
|
||||||
if err := h.Connection.Close(); err != nil {
|
|
||||||
h.Logger().WithField("error", errors.WithStack(err)).Error("error closing websocket connection")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
go h.listenForExpiration(ctx)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListenForExpiration checks the time to expiration on the JWT every 30 seconds
|
|
||||||
// until the token has expired. If we are within 3 minutes of the token expiring,
|
|
||||||
// send a notice over the socket that it is expiring soon. If it has expired,
|
|
||||||
// send that notice as well.
|
|
||||||
func (h *Handler) listenForExpiration(ctx context.Context) {
|
|
||||||
// Make a ticker and completion channel that is used to continuously poll the
|
// Make a ticker and completion channel that is used to continuously poll the
|
||||||
// JWT stored in the session to send events to the socket when it is expiring.
|
// JWT stored in the session to send events to the socket when it is expiring.
|
||||||
ticker := time.NewTicker(time.Second * 30)
|
ticker := time.NewTicker(time.Second * 30)
|
||||||
|
|
||||||
|
// Whenever this function is complete, end the ticker, close out the channel,
|
||||||
|
// and then close the websocket connection.
|
||||||
defer ticker.Stop()
|
defer ticker.Stop()
|
||||||
|
|
||||||
for {
|
for {
|
||||||
@@ -56,9 +27,9 @@ func (h *Handler) listenForExpiration(ctx context.Context) {
|
|||||||
jwt := h.GetJwt()
|
jwt := h.GetJwt()
|
||||||
if jwt != nil {
|
if jwt != nil {
|
||||||
if jwt.ExpirationTime.Unix()-time.Now().Unix() <= 0 {
|
if jwt.ExpirationTime.Unix()-time.Now().Unix() <= 0 {
|
||||||
_ = h.SendJson(Message{Event: TokenExpiredEvent})
|
_ = h.SendJson(&Message{Event: TokenExpiredEvent})
|
||||||
} else if jwt.ExpirationTime.Unix()-time.Now().Unix() <= 60 {
|
} else if jwt.ExpirationTime.Unix()-time.Now().Unix() <= 60 {
|
||||||
_ = h.SendJson(Message{Event: TokenExpiringEvent})
|
_ = h.SendJson(&Message{Event: TokenExpiringEvent})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -79,91 +50,29 @@ var e = []string{
|
|||||||
server.TransferStatusEvent,
|
server.TransferStatusEvent,
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListenForServerEvents will listen for different events happening on a server
|
// Listens for different events happening on a server and sends them along
|
||||||
// and send them along to the connected websocket client. This function will
|
// to the connected websocket.
|
||||||
// block until the context provided to it is canceled.
|
func (h *Handler) ListenForServerEvents(ctx context.Context) {
|
||||||
func (h *Handler) listenForServerEvents(ctx context.Context) error {
|
h.server.Log().Debug("listening for server events over websocket")
|
||||||
var o sync.Once
|
callback := func(e events.Event) {
|
||||||
var err error
|
if err := h.SendJson(&Message{Event: e.Topic, Args: []string{e.Data}}); err != nil {
|
||||||
|
h.server.Log().WithField("error", err).Warn("error while sending server data over websocket")
|
||||||
ctx, cancel := context.WithCancel(ctx)
|
}
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
eventChan := make(chan []byte)
|
|
||||||
logOutput := make(chan []byte, 8)
|
|
||||||
installOutput := make(chan []byte, 4)
|
|
||||||
|
|
||||||
h.server.Events().On(eventChan) // TODO: make a sinky
|
|
||||||
h.server.Sink(system.LogSink).On(logOutput)
|
|
||||||
h.server.Sink(system.InstallSink).On(installOutput)
|
|
||||||
|
|
||||||
onError := func(evt string, err2 error) {
|
|
||||||
h.Logger().WithField("event", evt).WithField("error", err2).Error("failed to send event over server websocket")
|
|
||||||
// Avoid race conditions by only setting the error once and then canceling
|
|
||||||
// the context. This way if additional processing errors come through due
|
|
||||||
// to a massive flood of things you still only report and stop at the first.
|
|
||||||
o.Do(func() {
|
|
||||||
err = err2
|
|
||||||
})
|
|
||||||
cancel()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
for {
|
// Subscribe to all of the events with the same callback that will push the data out over the
|
||||||
|
// websocket for the server.
|
||||||
|
for _, evt := range e {
|
||||||
|
h.server.Events().On(evt, &callback)
|
||||||
|
}
|
||||||
|
|
||||||
|
go func(ctx context.Context) {
|
||||||
select {
|
select {
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
break
|
// Once this context is stopped, de-register all of the listeners that have been registered.
|
||||||
case b := <-logOutput:
|
for _, evt := range e {
|
||||||
sendErr := h.SendJson(Message{Event: server.ConsoleOutputEvent, Args: []string{string(b)}})
|
h.server.Events().Off(evt, &callback)
|
||||||
if sendErr == nil {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
onError(server.ConsoleOutputEvent, sendErr)
|
|
||||||
case b := <-installOutput:
|
|
||||||
sendErr := h.SendJson(Message{Event: server.InstallOutputEvent, Args: []string{string(b)}})
|
|
||||||
if sendErr == nil {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
onError(server.InstallOutputEvent, sendErr)
|
|
||||||
case b := <-eventChan:
|
|
||||||
var e events.Event
|
|
||||||
if err := events.DecodeTo(b, &e); err != nil {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
var sendErr error
|
|
||||||
message := Message{Event: e.Topic}
|
|
||||||
if str, ok := e.Data.(string); ok {
|
|
||||||
message.Args = []string{str}
|
|
||||||
} else if b, ok := e.Data.([]byte); ok {
|
|
||||||
message.Args = []string{string(b)}
|
|
||||||
} else {
|
|
||||||
b, sendErr = json.Marshal(e.Data)
|
|
||||||
if sendErr == nil {
|
|
||||||
message.Args = []string{string(b)}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}(ctx)
|
||||||
if sendErr == nil {
|
|
||||||
sendErr = h.SendJson(message)
|
|
||||||
if sendErr == nil {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
}
|
|
||||||
onError(message.Event, sendErr)
|
|
||||||
}
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
// These functions will automatically close the channel if it hasn't been already.
|
|
||||||
h.server.Events().Off(eventChan)
|
|
||||||
h.server.Sink(system.LogSink).Off(logOutput)
|
|
||||||
h.server.Sink(system.InstallSink).Off(installOutput)
|
|
||||||
|
|
||||||
// If the internal context is stopped it is either because the parent context
|
|
||||||
// got canceled or because we ran into an error. If the "err" variable is nil
|
|
||||||
// we can assume the parent was canceled and need not perform any actions.
|
|
||||||
if err != nil {
|
|
||||||
return errors.WithStack(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,26 +2,22 @@ package websocket
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
|
||||||
"net/http"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gbrlsnchs/jwt/v3"
|
"github.com/gbrlsnchs/jwt/v3"
|
||||||
"github.com/goccy/go-json"
|
|
||||||
"github.com/google/uuid"
|
"github.com/google/uuid"
|
||||||
"github.com/gorilla/websocket"
|
"github.com/gorilla/websocket"
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
"github.com/pterodactyl/wings/environment/docker"
|
"github.com/pterodactyl/wings/environment/docker"
|
||||||
"github.com/pterodactyl/wings/router/tokens"
|
"github.com/pterodactyl/wings/router/tokens"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -41,7 +37,6 @@ type Handler struct {
|
|||||||
Connection *websocket.Conn `json:"-"`
|
Connection *websocket.Conn `json:"-"`
|
||||||
jwt *tokens.WebsocketPayload
|
jwt *tokens.WebsocketPayload
|
||||||
server *server.Server
|
server *server.Server
|
||||||
ra server.RequestActivity
|
|
||||||
uuid uuid.UUID
|
uuid uuid.UUID
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -60,10 +55,11 @@ func IsJwtError(err error) bool {
|
|||||||
errors.Is(err, jwt.ErrExpValidation)
|
errors.Is(err, jwt.ErrExpValidation)
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewTokenPayload parses a JWT into a websocket token payload.
|
// Parses a JWT into a websocket token payload.
|
||||||
func NewTokenPayload(token []byte) (*tokens.WebsocketPayload, error) {
|
func NewTokenPayload(token []byte) (*tokens.WebsocketPayload, error) {
|
||||||
var payload tokens.WebsocketPayload
|
payload := tokens.WebsocketPayload{}
|
||||||
if err := tokens.ParseToken(token, &payload); err != nil {
|
err := tokens.ParseToken(token, &payload)
|
||||||
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -78,7 +74,7 @@ func NewTokenPayload(token []byte) (*tokens.WebsocketPayload, error) {
|
|||||||
return &payload, nil
|
return &payload, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetHandler returns a new websocket handler using the context provided.
|
// Returns a new websocket handler using the context provided.
|
||||||
func GetHandler(s *server.Server, w http.ResponseWriter, r *http.Request) (*Handler, error) {
|
func GetHandler(s *server.Server, w http.ResponseWriter, r *http.Request) (*Handler, error) {
|
||||||
upgrader := websocket.Upgrader{
|
upgrader := websocket.Upgrader{
|
||||||
// Ensure that the websocket request is originating from the Panel itself,
|
// Ensure that the websocket request is originating from the Panel itself,
|
||||||
@@ -111,7 +107,6 @@ func GetHandler(s *server.Server, w http.ResponseWriter, r *http.Request) (*Hand
|
|||||||
Connection: conn,
|
Connection: conn,
|
||||||
jwt: nil,
|
jwt: nil,
|
||||||
server: s,
|
server: s,
|
||||||
ra: s.NewRequestActivity("", r.RemoteAddr),
|
|
||||||
uuid: u,
|
uuid: u,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
@@ -120,23 +115,18 @@ func (h *Handler) Uuid() uuid.UUID {
|
|||||||
return h.uuid
|
return h.uuid
|
||||||
}
|
}
|
||||||
|
|
||||||
func (h *Handler) Logger() *log.Entry {
|
func (h *Handler) SendJson(v *Message) error {
|
||||||
return log.WithField("subsystem", "websocket").
|
|
||||||
WithField("connection", h.Uuid().String()).
|
|
||||||
WithField("server", h.server.ID())
|
|
||||||
}
|
|
||||||
|
|
||||||
func (h *Handler) SendJson(v Message) error {
|
|
||||||
// Do not send JSON down the line if the JWT on the connection is not valid!
|
// Do not send JSON down the line if the JWT on the connection is not valid!
|
||||||
if err := h.TokenValid(); err != nil {
|
if err := h.TokenValid(); err != nil {
|
||||||
_ = h.unsafeSendJson(Message{
|
h.unsafeSendJson(Message{
|
||||||
Event: JwtErrorEvent,
|
Event: JwtErrorEvent,
|
||||||
Args: []string{err.Error()},
|
Args: []string{err.Error()},
|
||||||
})
|
})
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
if j := h.GetJwt(); j != nil {
|
j := h.GetJwt()
|
||||||
|
if j != nil {
|
||||||
// If we're sending installation output but the user does not have the required
|
// If we're sending installation output but the user does not have the required
|
||||||
// permissions to see the output, don't send it down the line.
|
// permissions to see the output, don't send it down the line.
|
||||||
if v.Event == server.InstallOutputEvent {
|
if v.Event == server.InstallOutputEvent {
|
||||||
@@ -190,7 +180,7 @@ func (h *Handler) unsafeSendJson(v interface{}) error {
|
|||||||
return h.Connection.WriteJSON(v)
|
return h.Connection.WriteJSON(v)
|
||||||
}
|
}
|
||||||
|
|
||||||
// TokenValid checks if the JWT is still valid.
|
// Checks if the JWT is still valid.
|
||||||
func (h *Handler) TokenValid() error {
|
func (h *Handler) TokenValid() error {
|
||||||
j := h.GetJwt()
|
j := h.GetJwt()
|
||||||
if j == nil {
|
if j == nil {
|
||||||
@@ -209,14 +199,14 @@ func (h *Handler) TokenValid() error {
|
|||||||
return ErrJwtNoConnectPerm
|
return ErrJwtNoConnectPerm
|
||||||
}
|
}
|
||||||
|
|
||||||
if h.server.ID() != j.GetServerUuid() {
|
if h.server.Id() != j.GetServerUuid() {
|
||||||
return ErrJwtUuidMismatch
|
return ErrJwtUuidMismatch
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// SendErrorJson sends an error back to the connected websocket instance by checking the permissions
|
// Sends an error back to the connected websocket instance by checking the permissions
|
||||||
// of the token. If the user has the "receive-errors" grant we will send back the actual
|
// of the token. If the user has the "receive-errors" grant we will send back the actual
|
||||||
// error message, otherwise we just send back a standard error message.
|
// error message, otherwise we just send back a standard error message.
|
||||||
func (h *Handler) SendErrorJson(msg Message, err error, shouldLog ...bool) error {
|
func (h *Handler) SendErrorJson(msg Message, err error, shouldLog ...bool) error {
|
||||||
@@ -246,7 +236,7 @@ func (h *Handler) SendErrorJson(msg Message, err error, shouldLog ...bool) error
|
|||||||
return h.unsafeSendJson(wsm)
|
return h.unsafeSendJson(wsm)
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetErrorMessage converts an error message into a more readable representation and returns a UUID
|
// Converts an error message into a more readable representation and returns a UUID
|
||||||
// that can be cross-referenced to find the specific error that triggered.
|
// that can be cross-referenced to find the specific error that triggered.
|
||||||
func (h *Handler) GetErrorMessage(msg string) (string, uuid.UUID) {
|
func (h *Handler) GetErrorMessage(msg string) (string, uuid.UUID) {
|
||||||
u := uuid.Must(uuid.NewRandom())
|
u := uuid.Must(uuid.NewRandom())
|
||||||
@@ -256,7 +246,13 @@ func (h *Handler) GetErrorMessage(msg string) (string, uuid.UUID) {
|
|||||||
return m, u
|
return m, u
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetJwt returns the JWT for the websocket in a race-safe manner.
|
// Sets the JWT for the websocket in a race-safe manner.
|
||||||
|
func (h *Handler) setJwt(token *tokens.WebsocketPayload) {
|
||||||
|
h.Lock()
|
||||||
|
h.jwt = token
|
||||||
|
h.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
func (h *Handler) GetJwt() *tokens.WebsocketPayload {
|
func (h *Handler) GetJwt() *tokens.WebsocketPayload {
|
||||||
h.RLock()
|
h.RLock()
|
||||||
defer h.RUnlock()
|
defer h.RUnlock()
|
||||||
@@ -264,16 +260,8 @@ func (h *Handler) GetJwt() *tokens.WebsocketPayload {
|
|||||||
return h.jwt
|
return h.jwt
|
||||||
}
|
}
|
||||||
|
|
||||||
// setJwt sets the JWT for the websocket in a race-safe manner.
|
// Handle the inbound socket request and route it to the proper server action.
|
||||||
func (h *Handler) setJwt(token *tokens.WebsocketPayload) {
|
func (h *Handler) HandleInbound(m Message) error {
|
||||||
h.Lock()
|
|
||||||
h.ra = h.ra.SetUser(token.UserUUID)
|
|
||||||
h.jwt = token
|
|
||||||
h.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
// HandleInbound handles an inbound socket request and route it to the proper action.
|
|
||||||
func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
|
|
||||||
if m.Event != AuthenticationEvent {
|
if m.Event != AuthenticationEvent {
|
||||||
if err := h.TokenValid(); err != nil {
|
if err := h.TokenValid(); err != nil {
|
||||||
h.unsafeSendJson(Message{
|
h.unsafeSendJson(Message{
|
||||||
@@ -289,6 +277,13 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
|
|||||||
{
|
{
|
||||||
token, err := NewTokenPayload([]byte(strings.Join(m.Args, "")))
|
token, err := NewTokenPayload([]byte(strings.Join(m.Args, "")))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
// If the error says the JWT expired, send a token expired
|
||||||
|
// event and hopefully the client renews the token.
|
||||||
|
if err == jwt.ErrExpValidation {
|
||||||
|
h.SendJson(&Message{Event: TokenExpiredEvent})
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -301,7 +296,10 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
|
|||||||
h.setJwt(token)
|
h.setJwt(token)
|
||||||
|
|
||||||
// Tell the client they authenticated successfully.
|
// Tell the client they authenticated successfully.
|
||||||
_ = h.unsafeSendJson(Message{Event: AuthenticationSuccessEvent})
|
h.unsafeSendJson(Message{
|
||||||
|
Event: AuthenticationSuccessEvent,
|
||||||
|
Args: []string{},
|
||||||
|
})
|
||||||
|
|
||||||
// Check if the client was refreshing their authentication token
|
// Check if the client was refreshing their authentication token
|
||||||
// instead of authenticating for the first time.
|
// instead of authenticating for the first time.
|
||||||
@@ -311,15 +309,10 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Now that we've authenticated with the token and confirmed that we're not
|
|
||||||
// reconnecting to the socket, register the event listeners for the server and
|
|
||||||
// the token expiration.
|
|
||||||
h.registerListenerEvents(ctx)
|
|
||||||
|
|
||||||
// On every authentication event, send the current server status back
|
// On every authentication event, send the current server status back
|
||||||
// to the client. :)
|
// to the client. :)
|
||||||
state := h.server.Environment.State()
|
state := h.server.Environment.State()
|
||||||
_ = h.SendJson(Message{
|
h.SendJson(&Message{
|
||||||
Event: server.StatusEvent,
|
Event: server.StatusEvent,
|
||||||
Args: []string{state},
|
Args: []string{state},
|
||||||
})
|
})
|
||||||
@@ -331,7 +324,7 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
|
|||||||
_ = h.server.Filesystem().HasSpaceAvailable(false)
|
_ = h.server.Filesystem().HasSpaceAvailable(false)
|
||||||
|
|
||||||
b, _ := json.Marshal(h.server.Proc())
|
b, _ := json.Marshal(h.server.Proc())
|
||||||
_ = h.SendJson(Message{
|
h.SendJson(&Message{
|
||||||
Event: server.StatsEvent,
|
Event: server.StatsEvent,
|
||||||
Args: []string{string(b)},
|
Args: []string{string(b)},
|
||||||
})
|
})
|
||||||
@@ -358,10 +351,10 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
err := h.server.HandlePowerAction(action)
|
err := h.server.HandlePowerAction(action)
|
||||||
if errors.Is(err, system.ErrLockerLocked) {
|
if errors.Is(err, context.DeadlineExceeded) {
|
||||||
m, _ := h.GetErrorMessage("another power action is currently being processed for this server, please try again later")
|
m, _ := h.GetErrorMessage("another power action is currently being processed for this server, please try again later")
|
||||||
|
|
||||||
_ = h.SendJson(Message{
|
h.SendJson(&Message{
|
||||||
Event: ErrorEvent,
|
Event: ErrorEvent,
|
||||||
Args: []string{m},
|
Args: []string{m},
|
||||||
})
|
})
|
||||||
@@ -369,17 +362,11 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
if err == nil {
|
|
||||||
_ = h.ra.Save(h.server, models.Event(server.ActivityPowerPrefix+action), nil)
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
case SendServerLogsEvent:
|
case SendServerLogsEvent:
|
||||||
{
|
{
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
|
if running, _ := h.server.Environment.IsRunning(); !running {
|
||||||
defer cancel()
|
|
||||||
if running, _ := h.server.Environment.IsRunning(ctx); !running {
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -389,7 +376,7 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
for _, line := range logs {
|
for _, line := range logs {
|
||||||
_ = h.SendJson(Message{
|
h.SendJson(&Message{
|
||||||
Event: server.ConsoleOutputEvent,
|
Event: server.ConsoleOutputEvent,
|
||||||
Args: []string{line},
|
Args: []string{line},
|
||||||
})
|
})
|
||||||
@@ -400,7 +387,7 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
|
|||||||
case SendStatsEvent:
|
case SendStatsEvent:
|
||||||
{
|
{
|
||||||
b, _ := json.Marshal(h.server.Proc())
|
b, _ := json.Marshal(h.server.Proc())
|
||||||
_ = h.SendJson(Message{
|
h.SendJson(&Message{
|
||||||
Event: server.StatsEvent,
|
Event: server.StatsEvent,
|
||||||
Args: []string{string(b)},
|
Args: []string{string(b)},
|
||||||
})
|
})
|
||||||
@@ -429,10 +416,6 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
_ = h.ra.Save(h.server, server.ActivityConsoleCommand, models.ActivityMeta{
|
|
||||||
"command": strings.Join(m.Args, ""),
|
|
||||||
})
|
|
||||||
|
|
||||||
return h.server.Environment.SendCommand(strings.Join(m.Args, ""))
|
return h.server.Environment.SendCommand(strings.Join(m.Args, ""))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,121 +0,0 @@
|
|||||||
Name: ptero-wings
|
|
||||||
Version: 1.5.3
|
|
||||||
Release: 1%{?dist}
|
|
||||||
Summary: The server control plane for Pterodactyl Panel. Written from the ground-up with security, speed, and stability in mind.
|
|
||||||
BuildArch: x86_64
|
|
||||||
License: MIT
|
|
||||||
URL: https://github.com/pterodactyl/wings
|
|
||||||
Source0: https://github.com/pterodactyl/wings/releases/download/v%{version}/wings_linux_amd64
|
|
||||||
|
|
||||||
%if 0%{?rhel} && 0%{?rhel} <= 8
|
|
||||||
BuildRequires: systemd
|
|
||||||
%else
|
|
||||||
BuildRequires: systemd-rpm-macros
|
|
||||||
%endif
|
|
||||||
|
|
||||||
|
|
||||||
%description
|
|
||||||
Wings is Pterodactyl's server control plane, built for the rapidly
|
|
||||||
changing gaming industry and designed to be highly performant and
|
|
||||||
secure. Wings provides an HTTP API allowing you to interface directly
|
|
||||||
with running server instances, fetch server logs, generate backups,
|
|
||||||
and control all aspects of the server lifecycle.
|
|
||||||
|
|
||||||
In addition, Wings ships with a built-in SFTP server allowing your
|
|
||||||
system to remain free of Pterodactyl specific dependencies, and
|
|
||||||
allowing users to authenticate with the same credentials they would
|
|
||||||
normally use to access the Panel.
|
|
||||||
|
|
||||||
%prep
|
|
||||||
|
|
||||||
%build
|
|
||||||
#nothing required
|
|
||||||
|
|
||||||
%install
|
|
||||||
mkdir -p %{buildroot}%{_bindir}
|
|
||||||
mkdir -p %{buildroot}%{_unitdir}
|
|
||||||
cp %{_sourcedir}/wings_linux_amd64 %{buildroot}%{_bindir}/wings
|
|
||||||
|
|
||||||
cat > %{buildroot}%{_unitdir}/wings.service << EOF
|
|
||||||
[Unit]
|
|
||||||
Description=Pterodactyl Wings Daemon
|
|
||||||
After=docker.service
|
|
||||||
Requires=docker.service
|
|
||||||
PartOf=docker.service
|
|
||||||
StartLimitIntervalSec=600
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
WorkingDirectory=/etc/pterodactyl
|
|
||||||
ExecStart=/usr/bin/wings
|
|
||||||
ExecReload=/bin/kill -HUP $MAINPID
|
|
||||||
Restart=on-failure
|
|
||||||
StartLimitInterval=180
|
|
||||||
StartLimitBurst=30
|
|
||||||
RestartSec=5s
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
EOF
|
|
||||||
|
|
||||||
%files
|
|
||||||
%attr(0755, root, root) %{_prefix}/bin/wings
|
|
||||||
%attr(0644, root, root) %{_unitdir}/wings.service
|
|
||||||
|
|
||||||
%post
|
|
||||||
|
|
||||||
# Reload systemd
|
|
||||||
systemctl daemon-reload
|
|
||||||
|
|
||||||
# Create the required directory structure
|
|
||||||
mkdir -p /etc/pterodactyl
|
|
||||||
mkdir -p /var/lib/pterodactyl/{archives,backups,volumes}
|
|
||||||
mkdir -p /var/log/pterodactyl/install
|
|
||||||
|
|
||||||
%preun
|
|
||||||
|
|
||||||
systemctl is-active %{name} >/dev/null 2>&1
|
|
||||||
if [ $? -eq 0 ]; then
|
|
||||||
systemctl stop %{name}
|
|
||||||
fi
|
|
||||||
|
|
||||||
systemctl is-enabled %{name} >/dev/null 2>&1
|
|
||||||
if [ $? -eq 0 ]; then
|
|
||||||
systemctl disable %{name}
|
|
||||||
fi
|
|
||||||
|
|
||||||
%postun
|
|
||||||
rm -rf /var/log/pterodactyl
|
|
||||||
|
|
||||||
%verifyscript
|
|
||||||
|
|
||||||
wings --version
|
|
||||||
|
|
||||||
%changelog
|
|
||||||
* Wed Oct 27 2021 Capitol Hosting Solutions Systems Engineering <syseng@chs.gg> - 1.5.3-1
|
|
||||||
- specfile by Capitol Hosting Solutions, Upstream by Pterodactyl
|
|
||||||
- Rebased for https://github.com/pterodactyl/wings/releases/tag/v1.5.3
|
|
||||||
- Fixes improper event registration and error handling during socket authentication that would cause the incorrect error message to be returned to the client, or no error in some scenarios. Event registration is now delayed until the socket is fully authenticated to ensure needless listeners are not registed.
|
|
||||||
- Fixes dollar signs always being evaluated as environment variables with no way to escape them. They can now be escaped as $$ which will transform into a single dollar sign.
|
|
||||||
- A websocket connection to a server will be closed by Wings if there is a send error encountered and the client will be left to handle reconnections, rather than simply logging the error and continuing to listen for new events.
|
|
||||||
|
|
||||||
* Sun Sep 12 2021 Capitol Hosting Solutions Systems Engineering <syseng@chs.gg> - 1.5.0-1
|
|
||||||
- specfile by Capitol Hosting Solutions, Upstream by Pterodactyl
|
|
||||||
- Rebased for https://github.com/pterodactyl/wings/releases/tag/v1.5.0
|
|
||||||
- Fixes a race condition when setting the application name in the console output for a server.
|
|
||||||
- Fixes a server being reinstalled causing the file_denylist parameter for an Egg to be ignored until Wings is restarted.
|
|
||||||
- Fixes YAML file parser not correctly setting boolean values.
|
|
||||||
- Fixes potential issue where the underlying websocket connection is closed but the parent request context is not yet canceled causing a write over a closed connection.
|
|
||||||
- Fixes race condition when closing all active websocket connections when a server is deleted.
|
|
||||||
- Fixes logic to determine if a server's context is closed out and send a websocket close message to connected clients. Previously this fired off whenever the request itself was closed, and not when the server context was closed.
|
|
||||||
- Exposes 8080 in the wings Dockerfile to better support reverse proxy tools.
|
|
||||||
- Releases are now built using Go 1.17 — the minimum version required to build Wings remains Go 1.16.
|
|
||||||
- Simplifed the logic powering server updates to only pull information from the Panel rather than trying to accept updated values. All parts of Wings needing the most up-to-date server details should call Server#Sync() to fetch the latest stored build information.
|
|
||||||
- Installer#New() no longer requires passing all of the server data as a byte slice, rather a new Installer#ServerDetails struct is exposed which can be passed and accepts a UUID and if the server should be started after the installer finishes.
|
|
||||||
- Removes complicated (and unused) logic during the server installation process that was a hold-over from legacy Wings architectures.
|
|
||||||
- Removes the PATCH /api/servers/:server endpoint — if you were previously using this API call it should be replaced with POST /api/servers/:server/sync.
|
|
||||||
|
|
||||||
* Wed Aug 25 2021 Capitol Hosting Solutions Systems Engineering <syseng@chs.gg> - 1.4.7-1
|
|
||||||
- specfile by Capitol Hosting Solutions, Upstream by Pterodactyl
|
|
||||||
- Rebased for https://github.com/pterodactyl/wings/releases/tag/v1.4.7
|
|
||||||
- SFTP access is now properly denied if a server is suspended.
|
|
||||||
- Correctly uses start_on_completion and crash_detection_enabled for servers.
|
|
||||||
@@ -1,70 +0,0 @@
|
|||||||
package server
|
|
||||||
|
|
||||||
import (
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/pterodactyl/wings/internal/database"
|
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
|
||||||
)
|
|
||||||
|
|
||||||
const ActivityPowerPrefix = "server:power."
|
|
||||||
|
|
||||||
const (
|
|
||||||
ActivityConsoleCommand = models.Event("server:console.command")
|
|
||||||
ActivitySftpWrite = models.Event("server:sftp.write")
|
|
||||||
ActivitySftpCreate = models.Event("server:sftp.create")
|
|
||||||
ActivitySftpCreateDirectory = models.Event("server:sftp.create-directory")
|
|
||||||
ActivitySftpRename = models.Event("server:sftp.rename")
|
|
||||||
ActivitySftpDelete = models.Event("server:sftp.delete")
|
|
||||||
)
|
|
||||||
|
|
||||||
// RequestActivity is a wrapper around a LoggedEvent that is able to track additional request
|
|
||||||
// specific metadata including the specific user and IP address associated with all subsequent
|
|
||||||
// events. The internal logged event structure can be extracted by calling RequestEvent.Event().
|
|
||||||
type RequestActivity struct {
|
|
||||||
server string
|
|
||||||
user string
|
|
||||||
ip string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Event returns the underlying logged event from the RequestEvent instance and sets the
|
|
||||||
// specific event and metadata on it.
|
|
||||||
func (ra RequestActivity) Event(event models.Event, metadata models.ActivityMeta) *models.Activity {
|
|
||||||
a := models.Activity{Server: ra.server, IP: ra.ip, Event: event, Metadata: metadata}
|
|
||||||
|
|
||||||
return a.SetUser(ra.user)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Save creates a new event instance and saves it. If an error is encountered it is automatically
|
|
||||||
// logged to the provided server's error logging output. The error is also returned to the caller
|
|
||||||
// but can be ignored.
|
|
||||||
func (ra RequestActivity) Save(s *Server, event models.Event, metadata models.ActivityMeta) error {
|
|
||||||
if tx := database.Instance().Create(ra.Event(event, metadata)); tx.Error != nil {
|
|
||||||
err := errors.WithStackIf(tx.Error)
|
|
||||||
|
|
||||||
s.Log().WithField("error", err).WithField("event", event).Error("activity: failed to save event")
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// IP returns the IP address associated with this entry.
|
|
||||||
func (ra RequestActivity) IP() string {
|
|
||||||
return ra.ip
|
|
||||||
}
|
|
||||||
|
|
||||||
func (ra *RequestActivity) User() string {
|
|
||||||
return ra.user
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetUser clones the RequestActivity struct and sets a new user value on the copy
|
|
||||||
// before returning it.
|
|
||||||
func (ra RequestActivity) SetUser(u string) RequestActivity {
|
|
||||||
c := ra
|
|
||||||
c.user = u
|
|
||||||
return c
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Server) NewRequestActivity(user string, ip string) RequestActivity {
|
|
||||||
return RequestActivity{server: s.ID(), user: user, ip: ip}
|
|
||||||
}
|
|
||||||
@@ -2,14 +2,12 @@ package server
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"io"
|
"io"
|
||||||
"io/fs"
|
"io/ioutil"
|
||||||
"os"
|
"os"
|
||||||
"time"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/docker/docker/client"
|
"github.com/docker/docker/client"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/server/backup"
|
"github.com/pterodactyl/wings/server/backup"
|
||||||
@@ -48,7 +46,7 @@ func (s *Server) getServerwideIgnoredFiles() (string, error) {
|
|||||||
// Don't read a symlinked ignore file, or a file larger than 32KiB in size.
|
// Don't read a symlinked ignore file, or a file larger than 32KiB in size.
|
||||||
return "", nil
|
return "", nil
|
||||||
}
|
}
|
||||||
b, err := io.ReadAll(f)
|
b, err := ioutil.ReadAll(f)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
@@ -62,7 +60,7 @@ func (s *Server) Backup(b backup.BackupInterface) error {
|
|||||||
ignored := b.Ignored()
|
ignored := b.Ignored()
|
||||||
if b.Ignored() == "" {
|
if b.Ignored() == "" {
|
||||||
if i, err := s.getServerwideIgnoredFiles(); err != nil {
|
if i, err := s.getServerwideIgnoredFiles(); err != nil {
|
||||||
log.WithField("server", s.ID()).WithField("error", err).Warn("failed to get server-wide ignored files")
|
log.WithField("server", s.Id()).WithField("error", err).Warn("failed to get server-wide ignored files")
|
||||||
} else {
|
} else {
|
||||||
ignored = i
|
ignored = i
|
||||||
}
|
}
|
||||||
@@ -79,7 +77,7 @@ func (s *Server) Backup(b backup.BackupInterface) error {
|
|||||||
s.Log().WithField("backup", b.Identifier()).Info("notified panel of failed backup state")
|
s.Log().WithField("backup", b.Identifier()).Info("notified panel of failed backup state")
|
||||||
}
|
}
|
||||||
|
|
||||||
s.Events().Publish(BackupCompletedEvent+":"+b.Identifier(), map[string]interface{}{
|
_ = s.Events().PublishJson(BackupCompletedEvent+":"+b.Identifier(), map[string]interface{}{
|
||||||
"uuid": b.Identifier(),
|
"uuid": b.Identifier(),
|
||||||
"is_successful": false,
|
"is_successful": false,
|
||||||
"checksum": "",
|
"checksum": "",
|
||||||
@@ -103,7 +101,7 @@ func (s *Server) Backup(b backup.BackupInterface) error {
|
|||||||
|
|
||||||
// Emit an event over the socket so we can update the backup in realtime on
|
// Emit an event over the socket so we can update the backup in realtime on
|
||||||
// the frontend for the server.
|
// the frontend for the server.
|
||||||
s.Events().Publish(BackupCompletedEvent+":"+b.Identifier(), map[string]interface{}{
|
_ = s.Events().PublishJson(BackupCompletedEvent+":"+b.Identifier(), map[string]interface{}{
|
||||||
"uuid": b.Identifier(),
|
"uuid": b.Identifier(),
|
||||||
"is_successful": true,
|
"is_successful": true,
|
||||||
"checksum": ad.Checksum,
|
"checksum": ad.Checksum,
|
||||||
@@ -142,7 +140,7 @@ func (s *Server) RestoreBackup(b backup.BackupInterface, reader io.ReadCloser) (
|
|||||||
// instance, otherwise you'll likely hit all types of write errors due to the
|
// instance, otherwise you'll likely hit all types of write errors due to the
|
||||||
// server being suspended.
|
// server being suspended.
|
||||||
if s.Environment.State() != environment.ProcessOfflineState {
|
if s.Environment.State() != environment.ProcessOfflineState {
|
||||||
if err = s.Environment.WaitForStop(s.Context(), time.Minute*2, false); err != nil {
|
if err = s.Environment.WaitForStop(120, false); err != nil {
|
||||||
if !client.IsErrNotFound(err) {
|
if !client.IsErrNotFound(err) {
|
||||||
return errors.WrapIf(err, "server/backup: restore: failed to wait for container stop")
|
return errors.WrapIf(err, "server/backup: restore: failed to wait for container stop")
|
||||||
}
|
}
|
||||||
@@ -152,15 +150,9 @@ func (s *Server) RestoreBackup(b backup.BackupInterface, reader io.ReadCloser) (
|
|||||||
// Attempt to restore the backup to the server by running through each entry
|
// Attempt to restore the backup to the server by running through each entry
|
||||||
// in the file one at a time and writing them to the disk.
|
// in the file one at a time and writing them to the disk.
|
||||||
s.Log().Debug("starting file writing process for backup restoration")
|
s.Log().Debug("starting file writing process for backup restoration")
|
||||||
err = b.Restore(s.Context(), reader, func(file string, r io.Reader, mode fs.FileMode, atime, mtime time.Time) error {
|
err = b.Restore(s.Context(), reader, func(file string, r io.Reader) error {
|
||||||
s.Events().Publish(DaemonMessageEvent, "(restoring): "+file)
|
s.Events().Publish(DaemonMessageEvent, "(restoring): "+file)
|
||||||
if err := s.Filesystem().Writefile(file, r); err != nil {
|
return s.Filesystem().Writefile(file, r)
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err := s.Filesystem().Chmod(file, mode); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return s.Filesystem().Chtimes(file, atime, mtime)
|
|
||||||
})
|
})
|
||||||
|
|
||||||
return errors.WithStackIf(err)
|
return errors.WithStackIf(err)
|
||||||
|
|||||||
@@ -5,17 +5,14 @@ import (
|
|||||||
"crypto/sha1"
|
"crypto/sha1"
|
||||||
"encoding/hex"
|
"encoding/hex"
|
||||||
"io"
|
"io"
|
||||||
"io/fs"
|
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
"time"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"golang.org/x/sync/errgroup"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
|
"golang.org/x/sync/errgroup"
|
||||||
)
|
)
|
||||||
|
|
||||||
type AdapterType string
|
type AdapterType string
|
||||||
@@ -27,7 +24,7 @@ const (
|
|||||||
|
|
||||||
// RestoreCallback is a generic restoration callback that exists for both local
|
// RestoreCallback is a generic restoration callback that exists for both local
|
||||||
// and remote backups allowing the files to be restored.
|
// and remote backups allowing the files to be restored.
|
||||||
type RestoreCallback func(file string, r io.Reader, mode fs.FileMode, atime, mtime time.Time) error
|
type RestoreCallback func(file string, r io.Reader) error
|
||||||
|
|
||||||
// noinspection GoNameStartsWithPackageName
|
// noinspection GoNameStartsWithPackageName
|
||||||
type BackupInterface interface {
|
type BackupInterface interface {
|
||||||
|
|||||||
@@ -6,10 +6,10 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/mholt/archiver/v3"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/remote"
|
|
||||||
"github.com/pterodactyl/wings/server/filesystem"
|
"github.com/pterodactyl/wings/server/filesystem"
|
||||||
|
|
||||||
|
"github.com/mholt/archiver/v3"
|
||||||
|
"github.com/pterodactyl/wings/remote"
|
||||||
)
|
)
|
||||||
|
|
||||||
type LocalBackup struct {
|
type LocalBackup struct {
|
||||||
@@ -85,10 +85,12 @@ func (b *LocalBackup) Restore(ctx context.Context, _ io.Reader, callback Restore
|
|||||||
// Stop walking if the context is canceled.
|
// Stop walking if the context is canceled.
|
||||||
return archiver.ErrStopWalk
|
return archiver.ErrStopWalk
|
||||||
default:
|
default:
|
||||||
|
{
|
||||||
if f.IsDir() {
|
if f.IsDir() {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
return callback(filesystem.ExtractNameFromArchive(f), f, f.Mode(), f.ModTime(), f.ModTime())
|
return callback(filesystem.ExtractNameFromArchive(f), f)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,11 +13,9 @@ import (
|
|||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/cenkalti/backoff/v4"
|
"github.com/cenkalti/backoff/v4"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/server/filesystem"
|
"github.com/pterodactyl/wings/server/filesystem"
|
||||||
|
|
||||||
"github.com/juju/ratelimit"
|
"github.com/juju/ratelimit"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
)
|
)
|
||||||
@@ -116,7 +114,7 @@ func (s *S3Backup) Restore(ctx context.Context, r io.Reader, callback RestoreCal
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if header.Typeflag == tar.TypeReg {
|
if header.Typeflag == tar.TypeReg {
|
||||||
if err := callback(header.Name, tr, header.FileInfo().Mode(), header.AccessTime, header.ModTime); err != nil {
|
if err := callback(header.Name, tr); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,14 +6,12 @@ import (
|
|||||||
"github.com/gammazero/workerpool"
|
"github.com/gammazero/workerpool"
|
||||||
)
|
)
|
||||||
|
|
||||||
// UpdateConfigurationFiles updates all of the defined configuration files for
|
// Parent function that will update all of the defined configuration files for a server
|
||||||
// a server automatically to ensure that they always use the specified values.
|
// automatically to ensure that they always use the specified values.
|
||||||
func (s *Server) UpdateConfigurationFiles() {
|
func (s *Server) UpdateConfigurationFiles() {
|
||||||
pool := workerpool.New(runtime.NumCPU())
|
pool := workerpool.New(runtime.NumCPU())
|
||||||
|
|
||||||
s.Log().Debug("acquiring process configuration files...")
|
|
||||||
files := s.ProcessConfiguration().ConfigurationFiles
|
files := s.ProcessConfiguration().ConfigurationFiles
|
||||||
s.Log().Debug("acquired process configuration files")
|
|
||||||
for _, cf := range files {
|
for _, cf := range files {
|
||||||
f := cf
|
f := cf
|
||||||
|
|
||||||
@@ -28,8 +26,6 @@ func (s *Server) UpdateConfigurationFiles() {
|
|||||||
if err := f.Parse(p, false); err != nil {
|
if err := f.Parse(p, false); err != nil {
|
||||||
s.Log().WithField("error", err).Error("failed to parse and update server configuration file")
|
s.Log().WithField("error", err).Error("failed to parse and update server configuration file")
|
||||||
}
|
}
|
||||||
|
|
||||||
s.Log().WithField("path", f.FileName).Debug("finished processing server configuration file")
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ type Configuration struct {
|
|||||||
|
|
||||||
// By default this is false, however if selected within the Panel while installing or re-installing a
|
// By default this is false, however if selected within the Panel while installing or re-installing a
|
||||||
// server, specific installation scripts will be skipped for the server process.
|
// server, specific installation scripts will be skipped for the server process.
|
||||||
SkipEggScripts bool `json:"skip_egg_scripts"`
|
SkipEggScripts bool `default:"false" json:"skip_egg_scripts"`
|
||||||
|
|
||||||
// An array of environment variables that should be passed along to the running
|
// An array of environment variables that should be passed along to the running
|
||||||
// server process.
|
// server process.
|
||||||
@@ -41,7 +41,7 @@ type Configuration struct {
|
|||||||
|
|
||||||
Allocations environment.Allocations `json:"allocations"`
|
Allocations environment.Allocations `json:"allocations"`
|
||||||
Build environment.Limits `json:"build"`
|
Build environment.Limits `json:"build"`
|
||||||
CrashDetectionEnabled bool `json:"crash_detection_enabled"`
|
CrashDetectionEnabled bool `default:"true" json:"enabled" yaml:"enabled"`
|
||||||
Mounts []Mount `json:"mounts"`
|
Mounts []Mount `json:"mounts"`
|
||||||
Egg EggConfiguration `json:"egg,omitempty"`
|
Egg EggConfiguration `json:"egg,omitempty"`
|
||||||
|
|
||||||
@@ -54,30 +54,34 @@ type Configuration struct {
|
|||||||
func (s *Server) Config() *Configuration {
|
func (s *Server) Config() *Configuration {
|
||||||
s.cfg.mu.RLock()
|
s.cfg.mu.RLock()
|
||||||
defer s.cfg.mu.RUnlock()
|
defer s.cfg.mu.RUnlock()
|
||||||
|
|
||||||
return &s.cfg
|
return &s.cfg
|
||||||
}
|
}
|
||||||
|
|
||||||
// DiskSpace returns the amount of disk space available to a server in bytes.
|
// Returns the amount of disk space available to a server in bytes.
|
||||||
func (s *Server) DiskSpace() int64 {
|
func (s *Server) DiskSpace() int64 {
|
||||||
s.cfg.mu.RLock()
|
s.cfg.mu.RLock()
|
||||||
defer s.cfg.mu.RUnlock()
|
defer s.cfg.mu.RUnlock()
|
||||||
|
|
||||||
return s.cfg.Build.DiskSpace * 1024.0 * 1024.0
|
return s.cfg.Build.DiskSpace * 1024.0 * 1024.0
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) MemoryLimit() int64 {
|
func (s *Server) MemoryLimit() int64 {
|
||||||
s.cfg.mu.RLock()
|
s.cfg.mu.RLock()
|
||||||
defer s.cfg.mu.RUnlock()
|
defer s.cfg.mu.RUnlock()
|
||||||
|
|
||||||
return s.cfg.Build.MemoryLimit
|
return s.cfg.Build.MemoryLimit
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Configuration) GetUuid() string {
|
func (c *Configuration) GetUuid() string {
|
||||||
c.mu.RLock()
|
c.mu.RLock()
|
||||||
defer c.mu.RUnlock()
|
defer c.mu.RUnlock()
|
||||||
|
|
||||||
return c.Uuid
|
return c.Uuid
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Configuration) SetSuspended(s bool) {
|
func (c *Configuration) SetSuspended(s bool) {
|
||||||
c.mu.Lock()
|
c.mu.Lock()
|
||||||
defer c.mu.Unlock()
|
|
||||||
c.Suspended = s
|
c.Suspended = s
|
||||||
|
c.mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,13 @@
|
|||||||
package server
|
package server
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"sync"
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"emperror.dev/errors"
|
||||||
"github.com/mitchellh/colorstring"
|
"github.com/mitchellh/colorstring"
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
@@ -14,68 +17,124 @@ import (
|
|||||||
// the configuration every time we need to send output along to the websocket for
|
// the configuration every time we need to send output along to the websocket for
|
||||||
// a server.
|
// a server.
|
||||||
var appName string
|
var appName string
|
||||||
var appNameSync sync.Once
|
|
||||||
|
|
||||||
// PublishConsoleOutputFromDaemon sends output to the server console formatted
|
var ErrTooMuchConsoleData = errors.New("console is outputting too much data")
|
||||||
// to appear correctly as being sent from Wings.
|
|
||||||
func (s *Server) PublishConsoleOutputFromDaemon(data string) {
|
type ConsoleThrottler struct {
|
||||||
appNameSync.Do(func() {
|
mu sync.Mutex
|
||||||
appName = config.Get().AppName
|
config.ConsoleThrottles
|
||||||
})
|
|
||||||
s.Events().Publish(
|
// The total number of activations that have occurred thus far.
|
||||||
ConsoleOutputEvent,
|
activations uint64
|
||||||
colorstring.Color(fmt.Sprintf("[yellow][bold][%s Daemon]:[default] %s", appName, data)),
|
|
||||||
)
|
// The total number of lines that have been sent since the last reset timer period.
|
||||||
|
count uint64
|
||||||
|
|
||||||
|
// Wether or not the console output is being throttled. It is up to calling code to
|
||||||
|
// determine what to do if it is.
|
||||||
|
isThrottled *system.AtomicBool
|
||||||
|
|
||||||
|
// The total number of lines processed so far during the given time period.
|
||||||
|
timerCancel *context.CancelFunc
|
||||||
}
|
}
|
||||||
|
|
||||||
// Throttler returns the throttler instance for the server or creates a new one.
|
// Resets the state of the throttler.
|
||||||
func (s *Server) Throttler() *ConsoleThrottle {
|
func (ct *ConsoleThrottler) Reset() {
|
||||||
s.throttleOnce.Do(func() {
|
atomic.StoreUint64(&ct.count, 0)
|
||||||
throttles := config.Get().Throttles
|
atomic.StoreUint64(&ct.activations, 0)
|
||||||
period := time.Duration(throttles.Period) * time.Millisecond
|
ct.isThrottled.Store(false)
|
||||||
|
}
|
||||||
|
|
||||||
s.throttler = newConsoleThrottle(throttles.Lines, period)
|
// Triggers an activation for a server. You can also decrement the number of activations
|
||||||
s.throttler.strike = func() {
|
// by passing a negative number.
|
||||||
s.PublishConsoleOutputFromDaemon(fmt.Sprintf("Server is outputting console data too quickly -- throttling..."))
|
func (ct *ConsoleThrottler) markActivation(increment bool) uint64 {
|
||||||
|
if !increment {
|
||||||
|
if atomic.LoadUint64(&ct.activations) == 0 {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// This weird dohicky subtracts 1 from the activation count.
|
||||||
|
return atomic.AddUint64(&ct.activations, ^uint64(0))
|
||||||
|
}
|
||||||
|
|
||||||
|
return atomic.AddUint64(&ct.activations, 1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Determines if the console is currently being throttled. Calls to this function can be used to
|
||||||
|
// determine if output should be funneled along to the websocket processes.
|
||||||
|
func (ct *ConsoleThrottler) Throttled() bool {
|
||||||
|
return ct.isThrottled.Load()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Starts a timer that runs in a seperate thread and will continually decrement the lines processed
|
||||||
|
// and number of activations, regardless of the current console message volume. All of the timers
|
||||||
|
// are canceled if the context passed through is canceled.
|
||||||
|
func (ct *ConsoleThrottler) StartTimer(ctx context.Context) {
|
||||||
|
system.Every(ctx, time.Duration(int64(ct.LineResetInterval))*time.Millisecond, func(_ time.Time) {
|
||||||
|
ct.isThrottled.Store(false)
|
||||||
|
atomic.StoreUint64(&ct.count, 0)
|
||||||
|
})
|
||||||
|
|
||||||
|
system.Every(ctx, time.Duration(int64(ct.DecayInterval))*time.Millisecond, func(_ time.Time) {
|
||||||
|
ct.markActivation(false)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handles output from a server's console. This code ensures that a server is not outputting
|
||||||
|
// an excessive amount of data to the console that could indicate a malicious or run-away process
|
||||||
|
// and lead to performance issues for other users.
|
||||||
|
//
|
||||||
|
// This was much more of a problem for the NodeJS version of the daemon which struggled to handle
|
||||||
|
// large volumes of output. However, this code is much more performant so I generally feel a lot
|
||||||
|
// better about it's abilities.
|
||||||
|
//
|
||||||
|
// However, extreme output is still somewhat of a DoS attack vector against this software since we
|
||||||
|
// are still logging it to the disk temporarily and will want to avoid dumping a huge amount of
|
||||||
|
// data all at once. These values are all configurable via the wings configuration file, however the
|
||||||
|
// defaults have been in the wild for almost two years at the time of this writing, so I feel quite
|
||||||
|
// confident in them.
|
||||||
|
//
|
||||||
|
// This function returns an error if the server should be stopped due to violating throttle constraints
|
||||||
|
// and a boolean value indicating if a throttle is being violated when it is checked.
|
||||||
|
func (ct *ConsoleThrottler) Increment(onTrigger func()) error {
|
||||||
|
if !ct.Enabled {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Increment the line count and if we have now output more lines than are allowed, trigger a throttle
|
||||||
|
// activation. Once the throttle is triggered and has passed the kill at value we will trigger a server
|
||||||
|
// stop automatically.
|
||||||
|
if atomic.AddUint64(&ct.count, 1) >= ct.Lines && !ct.Throttled() {
|
||||||
|
ct.isThrottled.Store(true)
|
||||||
|
if ct.markActivation(true) >= ct.MaximumTriggerCount {
|
||||||
|
return ErrTooMuchConsoleData
|
||||||
|
}
|
||||||
|
|
||||||
|
onTrigger()
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns the throttler instance for the server or creates a new one.
|
||||||
|
func (s *Server) Throttler() *ConsoleThrottler {
|
||||||
|
s.throttleOnce.Do(func() {
|
||||||
|
s.throttler = &ConsoleThrottler{
|
||||||
|
isThrottled: system.NewAtomicBool(false),
|
||||||
|
ConsoleThrottles: config.Get().Throttles,
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
return s.throttler
|
return s.throttler
|
||||||
}
|
}
|
||||||
|
|
||||||
type ConsoleThrottle struct {
|
// PublishConsoleOutputFromDaemon sends output to the server console formatted
|
||||||
limit *system.Rate
|
// to appear correctly as being sent from Wings.
|
||||||
lock *system.Locker
|
func (s *Server) PublishConsoleOutputFromDaemon(data string) {
|
||||||
strike func()
|
if appName == "" {
|
||||||
}
|
appName = config.Get().AppName
|
||||||
|
|
||||||
func newConsoleThrottle(lines uint64, period time.Duration) *ConsoleThrottle {
|
|
||||||
return &ConsoleThrottle{
|
|
||||||
limit: system.NewRate(lines, period),
|
|
||||||
lock: system.NewLocker(),
|
|
||||||
}
|
}
|
||||||
}
|
s.Events().Publish(
|
||||||
|
ConsoleOutputEvent,
|
||||||
// Allow checks if the console is allowed to process more output data, or if too
|
colorstring.Color(fmt.Sprintf("[yellow][bold][%s Daemon]:[default] %s", appName, data)),
|
||||||
// much has already been sent over the line. If there is too much output the
|
)
|
||||||
// strike callback function is triggered, but only if it has not already been
|
|
||||||
// triggered at this point in the process.
|
|
||||||
//
|
|
||||||
// If output is allowed, the lock on the throttler is released and the next time
|
|
||||||
// it is triggered the strike function will be re-executed.
|
|
||||||
func (ct *ConsoleThrottle) Allow() bool {
|
|
||||||
if !ct.limit.Try() {
|
|
||||||
if err := ct.lock.Acquire(); err == nil {
|
|
||||||
if ct.strike != nil {
|
|
||||||
ct.strike()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
ct.lock.Release()
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reset resets the console throttler internal rate limiter and overage counter.
|
|
||||||
func (ct *ConsoleThrottle) Reset() {
|
|
||||||
ct.limit.Reset()
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,62 +0,0 @@
|
|||||||
package server
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/franela/goblin"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestName(t *testing.T) {
|
|
||||||
g := goblin.Goblin(t)
|
|
||||||
|
|
||||||
g.Describe("ConsoleThrottler", func() {
|
|
||||||
g.It("keeps count of the number of overages in a time period", func() {
|
|
||||||
t := newConsoleThrottle(1, time.Second)
|
|
||||||
g.Assert(t.Allow()).IsTrue()
|
|
||||||
g.Assert(t.Allow()).IsFalse()
|
|
||||||
g.Assert(t.Allow()).IsFalse()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("calls strike once per time period", func() {
|
|
||||||
t := newConsoleThrottle(1, time.Millisecond*20)
|
|
||||||
|
|
||||||
var times int
|
|
||||||
t.strike = func() {
|
|
||||||
times = times + 1
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Allow()
|
|
||||||
t.Allow()
|
|
||||||
t.Allow()
|
|
||||||
time.Sleep(time.Millisecond * 100)
|
|
||||||
t.Allow()
|
|
||||||
t.Reset()
|
|
||||||
t.Allow()
|
|
||||||
t.Allow()
|
|
||||||
t.Allow()
|
|
||||||
|
|
||||||
g.Assert(times).Equal(2)
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("is properly reset", func() {
|
|
||||||
t := newConsoleThrottle(10, time.Second)
|
|
||||||
|
|
||||||
for i := 0; i < 10; i++ {
|
|
||||||
g.Assert(t.Allow()).IsTrue()
|
|
||||||
}
|
|
||||||
g.Assert(t.Allow()).IsFalse()
|
|
||||||
t.Reset()
|
|
||||||
g.Assert(t.Allow()).IsTrue()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkConsoleThrottle(b *testing.B) {
|
|
||||||
t := newConsoleThrottle(10, time.Millisecond*10)
|
|
||||||
|
|
||||||
b.ReportAllocs()
|
|
||||||
for i := 0; i < b.N; i++ {
|
|
||||||
t.Allow()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -12,7 +12,8 @@ var (
|
|||||||
ErrServerIsRestoring = errors.New("server is currently being restored")
|
ErrServerIsRestoring = errors.New("server is currently being restored")
|
||||||
)
|
)
|
||||||
|
|
||||||
type crashTooFrequent struct{}
|
type crashTooFrequent struct {
|
||||||
|
}
|
||||||
|
|
||||||
func (e *crashTooFrequent) Error() string {
|
func (e *crashTooFrequent) Error() string {
|
||||||
return "server has crashed too soon after the last detected crash"
|
return "server has crashed too soon after the last detected crash"
|
||||||
@@ -24,7 +25,8 @@ func IsTooFrequentCrashError(err error) bool {
|
|||||||
return ok
|
return ok
|
||||||
}
|
}
|
||||||
|
|
||||||
type serverDoesNotExist struct{}
|
type serverDoesNotExist struct {
|
||||||
|
}
|
||||||
|
|
||||||
func (e *serverDoesNotExist) Error() string {
|
func (e *serverDoesNotExist) Error() string {
|
||||||
return "server does not exist on remote system"
|
return "server does not exist on remote system"
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ package server
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"github.com/pterodactyl/wings/events"
|
"github.com/pterodactyl/wings/events"
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Defines all of the possible output events for a server.
|
// Defines all of the possible output events for a server.
|
||||||
@@ -21,35 +20,14 @@ const (
|
|||||||
TransferStatusEvent = "transfer status"
|
TransferStatusEvent = "transfer status"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Events returns the server's emitter instance.
|
// Returns the server's emitter instance.
|
||||||
func (s *Server) Events() *events.Bus {
|
func (s *Server) Events() *events.EventBus {
|
||||||
s.emitterLock.Lock()
|
s.emitterLock.Lock()
|
||||||
defer s.emitterLock.Unlock()
|
defer s.emitterLock.Unlock()
|
||||||
|
|
||||||
if s.emitter == nil {
|
if s.emitter == nil {
|
||||||
s.emitter = events.NewBus()
|
s.emitter = events.New()
|
||||||
}
|
}
|
||||||
|
|
||||||
return s.emitter
|
return s.emitter
|
||||||
}
|
}
|
||||||
|
|
||||||
// Sink returns the instantiated and named sink for a server. If the sink has
|
|
||||||
// not been configured yet this function will cause a panic condition.
|
|
||||||
func (s *Server) Sink(name system.SinkName) *system.SinkPool {
|
|
||||||
sink, ok := s.sinks[name]
|
|
||||||
if !ok {
|
|
||||||
s.Log().Fatalf("attempt to access nil sink: %s", name)
|
|
||||||
}
|
|
||||||
return sink
|
|
||||||
}
|
|
||||||
|
|
||||||
// DestroyAllSinks iterates over all of the sinks configured for the server and
|
|
||||||
// destroys their instances. Note that this will cause a panic if you attempt
|
|
||||||
// to call Server.Sink() again after. This function is only used when a server
|
|
||||||
// is being deleted from the system.
|
|
||||||
func (s *Server) DestroyAllSinks() {
|
|
||||||
s.Log().Info("destroying all registered sinks for server instance")
|
|
||||||
for _, sink := range s.sinks {
|
|
||||||
sink.Destroy()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ package filesystem
|
|||||||
import (
|
import (
|
||||||
"archive/tar"
|
"archive/tar"
|
||||||
"io"
|
"io"
|
||||||
"io/fs"
|
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -14,9 +13,8 @@ import (
|
|||||||
"github.com/juju/ratelimit"
|
"github.com/juju/ratelimit"
|
||||||
"github.com/karrick/godirwalk"
|
"github.com/karrick/godirwalk"
|
||||||
"github.com/klauspost/pgzip"
|
"github.com/klauspost/pgzip"
|
||||||
ignore "github.com/sabhiram/go-gitignore"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
|
"github.com/sabhiram/go-gitignore"
|
||||||
)
|
)
|
||||||
|
|
||||||
const memory = 4 * 1024
|
const memory = 4 * 1024
|
||||||
@@ -45,7 +43,7 @@ type Archive struct {
|
|||||||
// Create creates an archive at dst with all of the files defined in the
|
// Create creates an archive at dst with all of the files defined in the
|
||||||
// included files struct.
|
// included files struct.
|
||||||
func (a *Archive) Create(dst string) error {
|
func (a *Archive) Create(dst string) error {
|
||||||
f, err := os.OpenFile(dst, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o600)
|
f, err := os.OpenFile(dst, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -130,7 +128,7 @@ func (a *Archive) withFilesCallback(tw *tar.Writer) func(path string, de *godirw
|
|||||||
for _, f := range a.Files {
|
for _, f := range a.Files {
|
||||||
// If the given doesn't match, or doesn't have the same prefix continue
|
// If the given doesn't match, or doesn't have the same prefix continue
|
||||||
// to the next item in the loop.
|
// to the next item in the loop.
|
||||||
if p != f && !strings.HasPrefix(strings.TrimSuffix(p, "/")+"/", f) {
|
if p != f && !strings.HasPrefix(p, f) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -158,15 +156,9 @@ func (a *Archive) addToArchive(p string, rp string, w *tar.Writer) error {
|
|||||||
return errors.WrapIff(err, "failed executing os.Lstat on '%s'", rp)
|
return errors.WrapIff(err, "failed executing os.Lstat on '%s'", rp)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Skip socket files as they are unsupported by archive/tar.
|
|
||||||
// Error will come from tar#FileInfoHeader: "archive/tar: sockets not supported"
|
|
||||||
if s.Mode()&fs.ModeSocket != 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resolve the symlink target if the file is a symlink.
|
// Resolve the symlink target if the file is a symlink.
|
||||||
var target string
|
var target string
|
||||||
if s.Mode()&fs.ModeSymlink != 0 {
|
if s.Mode()&os.ModeSymlink != 0 {
|
||||||
// Read the target of the symlink. If there are any errors we will dump them out to
|
// Read the target of the symlink. If there are any errors we will dump them out to
|
||||||
// the logs, but we're not going to stop the backup. There are far too many cases of
|
// the logs, but we're not going to stop the backup. There are far too many cases of
|
||||||
// symlinks causing all sorts of unnecessary pain in this process. Sucks to suck if
|
// symlinks causing all sorts of unnecessary pain in this process. Sucks to suck if
|
||||||
@@ -188,7 +180,7 @@ func (a *Archive) addToArchive(p string, rp string, w *tar.Writer) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Fix the header name if the file is not a symlink.
|
// Fix the header name if the file is not a symlink.
|
||||||
if s.Mode()&fs.ModeSymlink == 0 {
|
if s.Mode()&os.ModeSymlink == 0 {
|
||||||
header.Name = rp
|
header.Name = rp
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -5,12 +5,9 @@ import (
|
|||||||
"archive/zip"
|
"archive/zip"
|
||||||
"compress/gzip"
|
"compress/gzip"
|
||||||
"fmt"
|
"fmt"
|
||||||
gzip2 "github.com/klauspost/compress/gzip"
|
|
||||||
zip2 "github.com/klauspost/compress/zip"
|
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"reflect"
|
|
||||||
"strings"
|
"strings"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
@@ -135,14 +132,6 @@ func (fs *Filesystem) DecompressFile(dir string, file string) error {
|
|||||||
if err := fs.Writefile(p, f); err != nil {
|
if err := fs.Writefile(p, f); err != nil {
|
||||||
return wrapError(err, source)
|
return wrapError(err, source)
|
||||||
}
|
}
|
||||||
// Update the file permissions to the one set in the archive.
|
|
||||||
if err := fs.Chmod(p, f.Mode()); err != nil {
|
|
||||||
return wrapError(err, source)
|
|
||||||
}
|
|
||||||
// Update the file modification time to the one set in the archive.
|
|
||||||
if err := fs.Chtimes(p, f.ModTime(), f.ModTime()); err != nil {
|
|
||||||
return wrapError(err, source)
|
|
||||||
}
|
|
||||||
return nil
|
return nil
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -175,26 +164,13 @@ func ExtractNameFromArchive(f archiver.File) string {
|
|||||||
return f.Name()
|
return f.Name()
|
||||||
}
|
}
|
||||||
switch s := sys.(type) {
|
switch s := sys.(type) {
|
||||||
case *zip.FileHeader:
|
|
||||||
return s.Name
|
|
||||||
case *zip2.FileHeader:
|
|
||||||
return s.Name
|
|
||||||
case *tar.Header:
|
case *tar.Header:
|
||||||
return s.Name
|
return s.Name
|
||||||
case *gzip.Header:
|
case *gzip.Header:
|
||||||
return s.Name
|
return s.Name
|
||||||
case *gzip2.Header:
|
case *zip.FileHeader:
|
||||||
return s.Name
|
return s.Name
|
||||||
default:
|
default:
|
||||||
// At this point we cannot figure out what type of archive this might be so
|
|
||||||
// just try to find the name field in the struct. If it is found return it.
|
|
||||||
field := reflect.Indirect(reflect.ValueOf(sys)).FieldByName("Name")
|
|
||||||
if field.IsValid() {
|
|
||||||
return field.String()
|
|
||||||
}
|
|
||||||
// Fallback to the basename of the file at this point. There is nothing we can really
|
|
||||||
// do to try and figure out what the underlying directory of the file is supposed to
|
|
||||||
// be since it didn't implement a name field.
|
|
||||||
return f.Name()
|
return f.Name()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
package filesystem
|
package filesystem
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"os"
|
"io/ioutil"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
@@ -19,10 +19,11 @@ func TestFilesystem_DecompressFile(t *testing.T) {
|
|||||||
fs, rfs := NewFs()
|
fs, rfs := NewFs()
|
||||||
|
|
||||||
g.Describe("Decompress", func() {
|
g.Describe("Decompress", func() {
|
||||||
|
|
||||||
for _, ext := range []string{"zip", "rar", "tar", "tar.gz"} {
|
for _, ext := range []string{"zip", "rar", "tar", "tar.gz"} {
|
||||||
g.It("can decompress a "+ext, func() {
|
g.It("can decompress a "+ext, func() {
|
||||||
// copy the file to the new FS
|
// copy the file to the new FS
|
||||||
c, err := os.ReadFile("./testdata/test." + ext)
|
c, err := ioutil.ReadFile("./testdata/test." + ext)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
err = rfs.CreateServerFile("./test."+ext, c)
|
err = rfs.CreateServerFile("./test."+ext, c)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
|
|||||||
@@ -17,10 +17,9 @@ import (
|
|||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/gabriel-vasile/mimetype"
|
"github.com/gabriel-vasile/mimetype"
|
||||||
"github.com/karrick/godirwalk"
|
"github.com/karrick/godirwalk"
|
||||||
ignore "github.com/sabhiram/go-gitignore"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
|
ignore "github.com/sabhiram/go-gitignore"
|
||||||
)
|
)
|
||||||
|
|
||||||
type Filesystem struct {
|
type Filesystem struct {
|
||||||
@@ -85,7 +84,7 @@ func (fs *Filesystem) Touch(p string, flag int) (*os.File, error) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
f, err := os.OpenFile(cleaned, flag, 0o644)
|
f, err := os.OpenFile(cleaned, flag, 0644)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
return f, nil
|
return f, nil
|
||||||
}
|
}
|
||||||
@@ -97,7 +96,7 @@ func (fs *Filesystem) Touch(p string, flag int) (*os.File, error) {
|
|||||||
if _, err := os.Stat(filepath.Dir(cleaned)); errors.Is(err, os.ErrNotExist) {
|
if _, err := os.Stat(filepath.Dir(cleaned)); errors.Is(err, os.ErrNotExist) {
|
||||||
// Create the path leading up to the file we're trying to create, setting the final perms
|
// Create the path leading up to the file we're trying to create, setting the final perms
|
||||||
// on it as we go.
|
// on it as we go.
|
||||||
if err := os.MkdirAll(filepath.Dir(cleaned), 0o755); err != nil {
|
if err := os.MkdirAll(filepath.Dir(cleaned), 0755); err != nil {
|
||||||
return nil, errors.Wrap(err, "server/filesystem: touch: failed to create directory tree")
|
return nil, errors.Wrap(err, "server/filesystem: touch: failed to create directory tree")
|
||||||
}
|
}
|
||||||
if err := fs.Chown(filepath.Dir(cleaned)); err != nil {
|
if err := fs.Chown(filepath.Dir(cleaned)); err != nil {
|
||||||
@@ -107,7 +106,7 @@ func (fs *Filesystem) Touch(p string, flag int) (*os.File, error) {
|
|||||||
o := &fileOpener{}
|
o := &fileOpener{}
|
||||||
// Try to open the file now that we have created the pathing necessary for it, and then
|
// Try to open the file now that we have created the pathing necessary for it, and then
|
||||||
// Chown that file so that the permissions don't mess with things.
|
// Chown that file so that the permissions don't mess with things.
|
||||||
f, err = o.open(cleaned, flag, 0o644)
|
f, err = o.open(cleaned, flag, 0644)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, errors.Wrap(err, "server/filesystem: touch: failed to open file with wait")
|
return nil, errors.Wrap(err, "server/filesystem: touch: failed to open file with wait")
|
||||||
}
|
}
|
||||||
@@ -115,6 +114,19 @@ func (fs *Filesystem) Touch(p string, flag int) (*os.File, error) {
|
|||||||
return f, nil
|
return f, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Reads a file on the system and returns it as a byte representation in a file
|
||||||
|
// reader. This is not the most memory efficient usage since it will be reading the
|
||||||
|
// entirety of the file into memory.
|
||||||
|
func (fs *Filesystem) Readfile(p string, w io.Writer) error {
|
||||||
|
file, _, err := fs.File(p)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer file.Close()
|
||||||
|
_, err = bufio.NewReader(file).WriteTo(w)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
// Writefile writes a file to the system. If the file does not already exist one
|
// Writefile writes a file to the system. If the file does not already exist one
|
||||||
// will be created. This will also properly recalculate the disk space used by
|
// will be created. This will also properly recalculate the disk space used by
|
||||||
// the server when writing new files or modifying existing ones.
|
// the server when writing new files or modifying existing ones.
|
||||||
@@ -168,19 +180,19 @@ func (fs *Filesystem) CreateDirectory(name string, p string) error {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return os.MkdirAll(cleaned, 0o755)
|
return os.MkdirAll(cleaned, 0755)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Rename moves (or renames) a file or directory.
|
// Moves (or renames) a file or directory.
|
||||||
func (fs *Filesystem) Rename(from string, to string) error {
|
func (fs *Filesystem) Rename(from string, to string) error {
|
||||||
cleanedFrom, err := fs.SafePath(from)
|
cleanedFrom, err := fs.SafePath(from)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.WithStack(err)
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
cleanedTo, err := fs.SafePath(to)
|
cleanedTo, err := fs.SafePath(to)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.WithStack(err)
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the target file or directory already exists the rename function will fail, so just
|
// If the target file or directory already exists the rename function will fail, so just
|
||||||
@@ -197,15 +209,12 @@ func (fs *Filesystem) Rename(from string, to string) error {
|
|||||||
// Ensure that the directory we're moving into exists correctly on the system. Only do this if
|
// Ensure that the directory we're moving into exists correctly on the system. Only do this if
|
||||||
// we're not at the root directory level.
|
// we're not at the root directory level.
|
||||||
if d != fs.Path() {
|
if d != fs.Path() {
|
||||||
if mkerr := os.MkdirAll(d, 0o755); mkerr != nil {
|
if mkerr := os.MkdirAll(d, 0755); mkerr != nil {
|
||||||
return errors.WithMessage(mkerr, "failed to create directory structure for file rename")
|
return errors.WithMessage(mkerr, "failed to create directory structure for file rename")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := os.Rename(cleanedFrom, cleanedTo); err != nil {
|
return os.Rename(cleanedFrom, cleanedTo)
|
||||||
return errors.WithStack(err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Recursively iterates over a file or directory and sets the permissions on all of the
|
// Recursively iterates over a file or directory and sets the permissions on all of the
|
||||||
@@ -367,7 +376,7 @@ func (fs *Filesystem) TruncateRootDirectory() error {
|
|||||||
if err := os.RemoveAll(fs.Path()); err != nil {
|
if err := os.RemoveAll(fs.Path()); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if err := os.Mkdir(fs.Path(), 0o755); err != nil {
|
if err := os.Mkdir(fs.Path(), 0755); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
atomic.StoreInt64(&fs.diskUsed, 0)
|
atomic.StoreInt64(&fs.diskUsed, 0)
|
||||||
@@ -475,18 +484,14 @@ func (fs *Filesystem) ListDirectory(p string) ([]Stat, error) {
|
|||||||
defer wg.Done()
|
defer wg.Done()
|
||||||
|
|
||||||
var m *mimetype.MIME
|
var m *mimetype.MIME
|
||||||
d := "inode/directory"
|
var d = "inode/directory"
|
||||||
if !f.IsDir() {
|
if !f.IsDir() {
|
||||||
cleanedp := filepath.Join(cleaned, f.Name())
|
cleanedp := filepath.Join(cleaned, f.Name())
|
||||||
if f.Mode()&os.ModeSymlink != 0 {
|
if f.Mode()&os.ModeSymlink != 0 {
|
||||||
cleanedp, _ = fs.SafePath(filepath.Join(cleaned, f.Name()))
|
cleanedp, _ = fs.SafePath(filepath.Join(cleaned, f.Name()))
|
||||||
}
|
}
|
||||||
|
|
||||||
// Don't try to detect the type on a pipe — this will just hang the application and
|
if cleanedp != "" {
|
||||||
// you'll never get a response back.
|
|
||||||
//
|
|
||||||
// @see https://github.com/pterodactyl/panel/issues/4059
|
|
||||||
if cleanedp != "" && f.Mode()&os.ModeNamedPipe == 0 {
|
|
||||||
m, _ = mimetype.DetectFile(filepath.Join(cleaned, f.Name()))
|
m, _ = mimetype.DetectFile(filepath.Join(cleaned, f.Name()))
|
||||||
} else {
|
} else {
|
||||||
// Just pass this for an unknown type because the file could not safely be resolved within
|
// Just pass this for an unknown type because the file could not safely be resolved within
|
||||||
@@ -522,20 +527,3 @@ func (fs *Filesystem) ListDirectory(p string) ([]Stat, error) {
|
|||||||
|
|
||||||
return out, nil
|
return out, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (fs *Filesystem) Chtimes(path string, atime, mtime time.Time) error {
|
|
||||||
cleaned, err := fs.SafePath(path)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if fs.isTest {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := os.Chtimes(cleaned, atime, mtime); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
package filesystem
|
package filesystem
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bufio"
|
|
||||||
"bytes"
|
"bytes"
|
||||||
"errors"
|
"errors"
|
||||||
|
"io/ioutil"
|
||||||
"math/rand"
|
"math/rand"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
@@ -12,7 +12,6 @@ import (
|
|||||||
"unicode/utf8"
|
"unicode/utf8"
|
||||||
|
|
||||||
. "github.com/franela/goblin"
|
. "github.com/franela/goblin"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -25,7 +24,7 @@ func NewFs() (*Filesystem, *rootFs) {
|
|||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|
||||||
tmpDir, err := os.MkdirTemp(os.TempDir(), "pterodactyl")
|
tmpDir, err := ioutil.TempDir(os.TempDir(), "pterodactyl")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
@@ -45,14 +44,6 @@ type rootFs struct {
|
|||||||
root string
|
root string
|
||||||
}
|
}
|
||||||
|
|
||||||
func getFileContent(file *os.File) string {
|
|
||||||
var w bytes.Buffer
|
|
||||||
if _, err := bufio.NewReader(file).WriteTo(&w); err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
return w.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rfs *rootFs) CreateServerFile(p string, c []byte) error {
|
func (rfs *rootFs) CreateServerFile(p string, c []byte) error {
|
||||||
f, err := os.Create(filepath.Join(rfs.root, "/server", p))
|
f, err := os.Create(filepath.Join(rfs.root, "/server", p))
|
||||||
|
|
||||||
@@ -79,11 +70,59 @@ func (rfs *rootFs) reset() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := os.Mkdir(filepath.Join(rfs.root, "/server"), 0o755); err != nil {
|
if err := os.Mkdir(filepath.Join(rfs.root, "/server"), 0755); err != nil {
|
||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestFilesystem_Readfile(t *testing.T) {
|
||||||
|
g := Goblin(t)
|
||||||
|
fs, rfs := NewFs()
|
||||||
|
|
||||||
|
g.Describe("Readfile", func() {
|
||||||
|
buf := &bytes.Buffer{}
|
||||||
|
|
||||||
|
g.It("opens a file if it exists on the system", func() {
|
||||||
|
err := rfs.CreateServerFileFromString("test.txt", "testing")
|
||||||
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
|
err = fs.Readfile("test.txt", buf)
|
||||||
|
g.Assert(err).IsNil()
|
||||||
|
g.Assert(buf.String()).Equal("testing")
|
||||||
|
})
|
||||||
|
|
||||||
|
g.It("returns an error if the file does not exist", func() {
|
||||||
|
err := fs.Readfile("test.txt", buf)
|
||||||
|
g.Assert(err).IsNotNil()
|
||||||
|
g.Assert(errors.Is(err, os.ErrNotExist)).IsTrue()
|
||||||
|
})
|
||||||
|
|
||||||
|
g.It("returns an error if the \"file\" is a directory", func() {
|
||||||
|
err := os.Mkdir(filepath.Join(rfs.root, "/server/test.txt"), 0755)
|
||||||
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
|
err = fs.Readfile("test.txt", buf)
|
||||||
|
g.Assert(err).IsNotNil()
|
||||||
|
g.Assert(IsErrorCode(err, ErrCodeIsDirectory)).IsTrue()
|
||||||
|
})
|
||||||
|
|
||||||
|
g.It("cannot open a file outside the root directory", func() {
|
||||||
|
err := rfs.CreateServerFileFromString("/../test.txt", "testing")
|
||||||
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
|
err = fs.Readfile("/../test.txt", buf)
|
||||||
|
g.Assert(err).IsNotNil()
|
||||||
|
g.Assert(IsErrorCode(err, ErrCodePathResolution)).IsTrue()
|
||||||
|
})
|
||||||
|
|
||||||
|
g.AfterEach(func() {
|
||||||
|
buf.Truncate(0)
|
||||||
|
atomic.StoreInt64(&fs.diskUsed, 0)
|
||||||
|
rfs.reset()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
func TestFilesystem_Writefile(t *testing.T) {
|
func TestFilesystem_Writefile(t *testing.T) {
|
||||||
g := Goblin(t)
|
g := Goblin(t)
|
||||||
fs, rfs := NewFs()
|
fs, rfs := NewFs()
|
||||||
@@ -101,10 +140,9 @@ func TestFilesystem_Writefile(t *testing.T) {
|
|||||||
err := fs.Writefile("test.txt", r)
|
err := fs.Writefile("test.txt", r)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
f, _, err := fs.File("test.txt")
|
err = fs.Readfile("test.txt", buf)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
defer f.Close()
|
g.Assert(buf.String()).Equal("test file content")
|
||||||
g.Assert(getFileContent(f)).Equal("test file content")
|
|
||||||
g.Assert(atomic.LoadInt64(&fs.diskUsed)).Equal(r.Size())
|
g.Assert(atomic.LoadInt64(&fs.diskUsed)).Equal(r.Size())
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -114,10 +152,9 @@ func TestFilesystem_Writefile(t *testing.T) {
|
|||||||
err := fs.Writefile("/some/nested/test.txt", r)
|
err := fs.Writefile("/some/nested/test.txt", r)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
f, _, err := fs.File("/some/nested/test.txt")
|
err = fs.Readfile("/some/nested/test.txt", buf)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
defer f.Close()
|
g.Assert(buf.String()).Equal("test file content")
|
||||||
g.Assert(getFileContent(f)).Equal("test file content")
|
|
||||||
})
|
})
|
||||||
|
|
||||||
g.It("can create a new file inside a nested directory without a trailing slash", func() {
|
g.It("can create a new file inside a nested directory without a trailing slash", func() {
|
||||||
@@ -126,10 +163,9 @@ func TestFilesystem_Writefile(t *testing.T) {
|
|||||||
err := fs.Writefile("some/../foo/bar/test.txt", r)
|
err := fs.Writefile("some/../foo/bar/test.txt", r)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
f, _, err := fs.File("foo/bar/test.txt")
|
err = fs.Readfile("foo/bar/test.txt", buf)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
defer f.Close()
|
g.Assert(buf.String()).Equal("test file content")
|
||||||
g.Assert(getFileContent(f)).Equal("test file content")
|
|
||||||
})
|
})
|
||||||
|
|
||||||
g.It("cannot create a file outside the root directory", func() {
|
g.It("cannot create a file outside the root directory", func() {
|
||||||
@@ -154,6 +190,28 @@ func TestFilesystem_Writefile(t *testing.T) {
|
|||||||
g.Assert(IsErrorCode(err, ErrCodeDiskSpace)).IsTrue()
|
g.Assert(IsErrorCode(err, ErrCodeDiskSpace)).IsTrue()
|
||||||
})
|
})
|
||||||
|
|
||||||
|
/*g.It("updates the total space used when a file is appended to", func() {
|
||||||
|
atomic.StoreInt64(&fs.diskUsed, 100)
|
||||||
|
|
||||||
|
b := make([]byte, 100)
|
||||||
|
_, _ = rand.Read(b)
|
||||||
|
|
||||||
|
r := bytes.NewReader(b)
|
||||||
|
err := fs.Writefile("test.txt", r)
|
||||||
|
g.Assert(err).IsNil()
|
||||||
|
g.Assert(atomic.LoadInt64(&fs.diskUsed)).Equal(int64(200))
|
||||||
|
|
||||||
|
// If we write less data than already exists, we should expect the total
|
||||||
|
// disk used to be decremented.
|
||||||
|
b = make([]byte, 50)
|
||||||
|
_, _ = rand.Read(b)
|
||||||
|
|
||||||
|
r = bytes.NewReader(b)
|
||||||
|
err = fs.Writefile("test.txt", r)
|
||||||
|
g.Assert(err).IsNil()
|
||||||
|
g.Assert(atomic.LoadInt64(&fs.diskUsed)).Equal(int64(150))
|
||||||
|
})*/
|
||||||
|
|
||||||
g.It("truncates the file when writing new contents", func() {
|
g.It("truncates the file when writing new contents", func() {
|
||||||
r := bytes.NewReader([]byte("original data"))
|
r := bytes.NewReader([]byte("original data"))
|
||||||
err := fs.Writefile("test.txt", r)
|
err := fs.Writefile("test.txt", r)
|
||||||
@@ -163,10 +221,9 @@ func TestFilesystem_Writefile(t *testing.T) {
|
|||||||
err = fs.Writefile("test.txt", r)
|
err = fs.Writefile("test.txt", r)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
f, _, err := fs.File("test.txt")
|
err = fs.Readfile("test.txt", buf)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
defer f.Close()
|
g.Assert(buf.String()).Equal("new data")
|
||||||
g.Assert(getFileContent(f)).Equal("new data")
|
|
||||||
})
|
})
|
||||||
|
|
||||||
g.AfterEach(func() {
|
g.AfterEach(func() {
|
||||||
@@ -283,7 +340,7 @@ func TestFilesystem_Rename(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
g.It("allows a folder to be renamed", func() {
|
g.It("allows a folder to be renamed", func() {
|
||||||
err := os.Mkdir(filepath.Join(rfs.root, "/server/source_dir"), 0o755)
|
err := os.Mkdir(filepath.Join(rfs.root, "/server/source_dir"), 0755)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
err = fs.Rename("source_dir", "target_dir")
|
err = fs.Rename("source_dir", "target_dir")
|
||||||
@@ -347,7 +404,7 @@ func TestFilesystem_Copy(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
g.It("should return an error if the source directory is outside the root", func() {
|
g.It("should return an error if the source directory is outside the root", func() {
|
||||||
err := os.MkdirAll(filepath.Join(rfs.root, "/nested/in/dir"), 0o755)
|
err := os.MkdirAll(filepath.Join(rfs.root, "/nested/in/dir"), 0755)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
err = rfs.CreateServerFileFromString("/../nested/in/dir/ext-source.txt", "external content")
|
err = rfs.CreateServerFileFromString("/../nested/in/dir/ext-source.txt", "external content")
|
||||||
@@ -363,7 +420,7 @@ func TestFilesystem_Copy(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
g.It("should return an error if the source is a directory", func() {
|
g.It("should return an error if the source is a directory", func() {
|
||||||
err := os.Mkdir(filepath.Join(rfs.root, "/server/dir"), 0o755)
|
err := os.Mkdir(filepath.Join(rfs.root, "/server/dir"), 0755)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
err = fs.Copy("dir")
|
err = fs.Copy("dir")
|
||||||
@@ -408,7 +465,7 @@ func TestFilesystem_Copy(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
g.It("should create a copy inside of a directory", func() {
|
g.It("should create a copy inside of a directory", func() {
|
||||||
err := os.MkdirAll(filepath.Join(rfs.root, "/server/nested/in/dir"), 0o755)
|
err := os.MkdirAll(filepath.Join(rfs.root, "/server/nested/in/dir"), 0755)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
err = rfs.CreateServerFileFromString("nested/in/dir/source.txt", "test content")
|
err = rfs.CreateServerFileFromString("nested/in/dir/source.txt", "test content")
|
||||||
@@ -487,7 +544,7 @@ func TestFilesystem_Delete(t *testing.T) {
|
|||||||
"foo/bar/baz/source.txt",
|
"foo/bar/baz/source.txt",
|
||||||
}
|
}
|
||||||
|
|
||||||
err := os.MkdirAll(filepath.Join(rfs.root, "/server/foo/bar/baz"), 0o755)
|
err := os.MkdirAll(filepath.Join(rfs.root, "/server/foo/bar/baz"), 0755)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
for _, s := range sources {
|
for _, s := range sources {
|
||||||
|
|||||||
@@ -115,8 +115,8 @@ func (fs *Filesystem) ParallelSafePath(paths []string) ([]string, error) {
|
|||||||
var cleaned []string
|
var cleaned []string
|
||||||
|
|
||||||
// Simple locker function to avoid racy appends to the array of cleaned paths.
|
// Simple locker function to avoid racy appends to the array of cleaned paths.
|
||||||
m := new(sync.Mutex)
|
var m = new(sync.Mutex)
|
||||||
push := func(c string) {
|
var push = func(c string) {
|
||||||
m.Lock()
|
m.Lock()
|
||||||
cleaned = append(cleaned, c)
|
cleaned = append(cleaned, c)
|
||||||
m.Unlock()
|
m.Unlock()
|
||||||
|
|||||||
@@ -107,7 +107,7 @@ func TestFilesystem_Blocks_Symlinks(t *testing.T) {
|
|||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := os.Mkdir(filepath.Join(rfs.root, "/malicious_dir"), 0o777); err != nil {
|
if err := os.Mkdir(filepath.Join(rfs.root, "/malicious_dir"), 0777); err != nil {
|
||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -119,6 +119,16 @@ func TestFilesystem_Blocks_Symlinks(t *testing.T) {
|
|||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
g.Describe("Readfile", func() {
|
||||||
|
g.It("cannot read a file symlinked outside the root", func() {
|
||||||
|
b := bytes.Buffer{}
|
||||||
|
|
||||||
|
err := fs.Readfile("symlinked.txt", &b)
|
||||||
|
g.Assert(err).IsNotNil()
|
||||||
|
g.Assert(IsErrorCode(err, ErrCodePathResolution)).IsTrue()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
g.Describe("Writefile", func() {
|
g.Describe("Writefile", func() {
|
||||||
g.It("cannot write to a file symlinked outside the root", func() {
|
g.It("cannot write to a file symlinked outside the root", func() {
|
||||||
r := bytes.NewReader([]byte("testing"))
|
r := bytes.NewReader([]byte("testing"))
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
package filesystem
|
package filesystem
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"encoding/json"
|
||||||
"os"
|
"os"
|
||||||
"strconv"
|
"strconv"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/gabriel-vasile/mimetype"
|
"github.com/gabriel-vasile/mimetype"
|
||||||
"github.com/goccy/go-json"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type Stat struct {
|
type Stat struct {
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ import (
|
|||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
@@ -24,17 +23,16 @@ import (
|
|||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Install executes the installation stack for a server process. Bubbles any
|
// Executes the installation stack for a server process. Bubbles any errors up to the calling
|
||||||
// errors up to the calling function which should handle contacting the panel to
|
// function which should handle contacting the panel to notify it of the server state.
|
||||||
// notify it of the server state.
|
|
||||||
//
|
//
|
||||||
// Pass true as the first argument in order to execute a server sync before the
|
// Pass true as the first argument in order to execute a server sync before the process to
|
||||||
// process to ensure the latest information is used.
|
// ensure the latest information is used.
|
||||||
func (s *Server) Install(sync bool) error {
|
func (s *Server) Install(sync bool) error {
|
||||||
if sync {
|
if sync {
|
||||||
s.Log().Info("syncing server state with remote source before executing installation process")
|
s.Log().Info("syncing server state with remote source before executing installation process")
|
||||||
if err := s.Sync(); err != nil {
|
if err := s.Sync(); err != nil {
|
||||||
return errors.WrapIf(err, "install: failed to sync server state with Panel")
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -58,7 +56,7 @@ func (s *Server) Install(sync bool) error {
|
|||||||
// error to this log entry. Otherwise ignore it in this log since whatever is calling
|
// error to this log entry. Otherwise ignore it in this log since whatever is calling
|
||||||
// this function should handle the error and will end up logging the same one.
|
// this function should handle the error and will end up logging the same one.
|
||||||
if err == nil {
|
if err == nil {
|
||||||
l.WithField("error", err)
|
l.WithField("error", serr)
|
||||||
}
|
}
|
||||||
|
|
||||||
l.Warn("failed to notify panel of server install state")
|
l.Warn("failed to notify panel of server install state")
|
||||||
@@ -72,7 +70,7 @@ func (s *Server) Install(sync bool) error {
|
|||||||
// the install is completed.
|
// the install is completed.
|
||||||
s.Events().Publish(InstallCompletedEvent, "")
|
s.Events().Publish(InstallCompletedEvent, "")
|
||||||
|
|
||||||
return errors.WithStackIf(err)
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Reinstalls a server's software by utilizing the install script for the server egg. This
|
// Reinstalls a server's software by utilizing the install script for the server egg. This
|
||||||
@@ -80,8 +78,8 @@ func (s *Server) Install(sync bool) error {
|
|||||||
func (s *Server) Reinstall() error {
|
func (s *Server) Reinstall() error {
|
||||||
if s.Environment.State() != environment.ProcessOfflineState {
|
if s.Environment.State() != environment.ProcessOfflineState {
|
||||||
s.Log().Debug("waiting for server instance to enter a stopped state")
|
s.Log().Debug("waiting for server instance to enter a stopped state")
|
||||||
if err := s.Environment.WaitForStop(s.Context(), time.Second*10, true); err != nil {
|
if err := s.Environment.WaitForStop(10, true); err != nil {
|
||||||
return errors.WrapIf(err, "install: failed to stop running environment")
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -90,7 +88,7 @@ func (s *Server) Reinstall() error {
|
|||||||
|
|
||||||
// Internal installation function used to simplify reporting back to the Panel.
|
// Internal installation function used to simplify reporting back to the Panel.
|
||||||
func (s *Server) internalInstall() error {
|
func (s *Server) internalInstall() error {
|
||||||
script, err := s.client.GetInstallationScript(s.Context(), s.ID())
|
script, err := s.client.GetInstallationScript(s.Context(), s.Id())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -111,7 +109,9 @@ func (s *Server) internalInstall() error {
|
|||||||
type InstallationProcess struct {
|
type InstallationProcess struct {
|
||||||
Server *Server
|
Server *Server
|
||||||
Script *remote.InstallationScript
|
Script *remote.InstallationScript
|
||||||
|
|
||||||
client *client.Client
|
client *client.Client
|
||||||
|
context context.Context
|
||||||
}
|
}
|
||||||
|
|
||||||
// Generates a new installation process struct that will be used to create containers,
|
// Generates a new installation process struct that will be used to create containers,
|
||||||
@@ -126,6 +126,7 @@ func NewInstallationProcess(s *Server, script *remote.InstallationScript) (*Inst
|
|||||||
return nil, err
|
return nil, err
|
||||||
} else {
|
} else {
|
||||||
proc.client = c
|
proc.client = c
|
||||||
|
proc.context = s.Context()
|
||||||
}
|
}
|
||||||
|
|
||||||
return proc, nil
|
return proc, nil
|
||||||
@@ -155,7 +156,7 @@ func (s *Server) SetRestoring(state bool) {
|
|||||||
|
|
||||||
// Removes the installer container for the server.
|
// Removes the installer container for the server.
|
||||||
func (ip *InstallationProcess) RemoveContainer() error {
|
func (ip *InstallationProcess) RemoveContainer() error {
|
||||||
err := ip.client.ContainerRemove(ip.Server.Context(), ip.Server.ID()+"_installer", types.ContainerRemoveOptions{
|
err := ip.client.ContainerRemove(ip.context, ip.Server.Id()+"_installer", types.ContainerRemoveOptions{
|
||||||
RemoveVolumes: true,
|
RemoveVolumes: true,
|
||||||
Force: true,
|
Force: true,
|
||||||
})
|
})
|
||||||
@@ -165,10 +166,11 @@ func (ip *InstallationProcess) RemoveContainer() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Run runs the installation process, this is done as in a background thread.
|
// Runs the installation process, this is done as in a background thread. This will configure
|
||||||
// This will configure the required environment, and then spin up the
|
// the required environment, and then spin up the installation container.
|
||||||
// installation container. Once the container finishes installing the results
|
//
|
||||||
// are stored in an installation log in the server's configuration directory.
|
// Once the container finishes installing the results will be stored in an installation
|
||||||
|
// log in the server's configuration directory.
|
||||||
func (ip *InstallationProcess) Run() error {
|
func (ip *InstallationProcess) Run() error {
|
||||||
ip.Server.Log().Debug("acquiring installation process lock")
|
ip.Server.Log().Debug("acquiring installation process lock")
|
||||||
if !ip.Server.installing.SwapIf(true) {
|
if !ip.Server.installing.SwapIf(true) {
|
||||||
@@ -204,7 +206,7 @@ func (ip *InstallationProcess) Run() error {
|
|||||||
|
|
||||||
// Returns the location of the temporary data for the installation process.
|
// Returns the location of the temporary data for the installation process.
|
||||||
func (ip *InstallationProcess) tempDir() string {
|
func (ip *InstallationProcess) tempDir() string {
|
||||||
return filepath.Join(config.Get().System.TmpDirectory, ip.Server.ID())
|
return filepath.Join(os.TempDir(), "pterodactyl/", ip.Server.Id())
|
||||||
}
|
}
|
||||||
|
|
||||||
// Writes the installation script to a temporary file on the host machine so that it
|
// Writes the installation script to a temporary file on the host machine so that it
|
||||||
@@ -212,11 +214,11 @@ func (ip *InstallationProcess) tempDir() string {
|
|||||||
func (ip *InstallationProcess) writeScriptToDisk() error {
|
func (ip *InstallationProcess) writeScriptToDisk() error {
|
||||||
// Make sure the temp directory root exists before trying to make a directory within it. The
|
// Make sure the temp directory root exists before trying to make a directory within it. The
|
||||||
// ioutil.TempDir call expects this base to exist, it won't create it for you.
|
// ioutil.TempDir call expects this base to exist, it won't create it for you.
|
||||||
if err := os.MkdirAll(ip.tempDir(), 0o700); err != nil {
|
if err := os.MkdirAll(ip.tempDir(), 0700); err != nil {
|
||||||
return errors.WithMessage(err, "could not create temporary directory for install process")
|
return errors.WithMessage(err, "could not create temporary directory for install process")
|
||||||
}
|
}
|
||||||
|
|
||||||
f, err := os.OpenFile(filepath.Join(ip.tempDir(), "install.sh"), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0o644)
|
f, err := os.OpenFile(filepath.Join(ip.tempDir(), "install.sh"), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.WithMessage(err, "failed to write server installation script to disk before mount")
|
return errors.WithMessage(err, "failed to write server installation script to disk before mount")
|
||||||
}
|
}
|
||||||
@@ -264,9 +266,9 @@ func (ip *InstallationProcess) pullInstallationImage() error {
|
|||||||
imagePullOptions.RegistryAuth = b64
|
imagePullOptions.RegistryAuth = b64
|
||||||
}
|
}
|
||||||
|
|
||||||
r, err := ip.client.ImagePull(ip.Server.Context(), ip.Script.ContainerImage, imagePullOptions)
|
r, err := ip.client.ImagePull(context.Background(), ip.Script.ContainerImage, imagePullOptions)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
images, ierr := ip.client.ImageList(ip.Server.Context(), types.ImageListOptions{})
|
images, ierr := ip.client.ImageList(context.Background(), types.ImageListOptions{})
|
||||||
if ierr != nil {
|
if ierr != nil {
|
||||||
// Well damn, something has gone really wrong here, just go ahead and abort there
|
// Well damn, something has gone really wrong here, just go ahead and abort there
|
||||||
// isn't much anything we can do to try and self-recover from this.
|
// isn't much anything we can do to try and self-recover from this.
|
||||||
@@ -309,10 +311,9 @@ func (ip *InstallationProcess) pullInstallationImage() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// BeforeExecute runs before the container is executed. This pulls down the
|
// Runs before the container is executed. This pulls down the required docker container image
|
||||||
// required docker container image as well as writes the installation script to
|
// as well as writes the installation script to the disk. This process is executed in an async
|
||||||
// the disk. This process is executed in an async manner, if either one fails
|
// manner, if either one fails the error is returned.
|
||||||
// the error is returned.
|
|
||||||
func (ip *InstallationProcess) BeforeExecute() error {
|
func (ip *InstallationProcess) BeforeExecute() error {
|
||||||
if err := ip.writeScriptToDisk(); err != nil {
|
if err := ip.writeScriptToDisk(); err != nil {
|
||||||
return errors.WithMessage(err, "failed to write installation script to disk")
|
return errors.WithMessage(err, "failed to write installation script to disk")
|
||||||
@@ -328,7 +329,7 @@ func (ip *InstallationProcess) BeforeExecute() error {
|
|||||||
|
|
||||||
// Returns the log path for the installation process.
|
// Returns the log path for the installation process.
|
||||||
func (ip *InstallationProcess) GetLogPath() string {
|
func (ip *InstallationProcess) GetLogPath() string {
|
||||||
return filepath.Join(config.Get().System.LogDirectory, "/install", ip.Server.ID()+".log")
|
return filepath.Join(config.Get().System.LogDirectory, "/install", ip.Server.Id()+".log")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Cleans up after the execution of the installation process. This grabs the logs from the
|
// Cleans up after the execution of the installation process. This grabs the logs from the
|
||||||
@@ -338,7 +339,7 @@ func (ip *InstallationProcess) AfterExecute(containerId string) error {
|
|||||||
defer ip.RemoveContainer()
|
defer ip.RemoveContainer()
|
||||||
|
|
||||||
ip.Server.Log().WithField("container_id", containerId).Debug("pulling installation logs for server")
|
ip.Server.Log().WithField("container_id", containerId).Debug("pulling installation logs for server")
|
||||||
reader, err := ip.client.ContainerLogs(ip.Server.Context(), containerId, types.ContainerLogsOptions{
|
reader, err := ip.client.ContainerLogs(ip.context, containerId, types.ContainerLogsOptions{
|
||||||
ShowStdout: true,
|
ShowStdout: true,
|
||||||
ShowStderr: true,
|
ShowStderr: true,
|
||||||
Follow: false,
|
Follow: false,
|
||||||
@@ -348,7 +349,7 @@ func (ip *InstallationProcess) AfterExecute(containerId string) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
f, err := os.OpenFile(ip.GetLogPath(), os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o600)
|
f, err := os.OpenFile(ip.GetLogPath(), os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -364,7 +365,7 @@ func (ip *InstallationProcess) AfterExecute(containerId string) error {
|
|||||||
|
|
|
|
||||||
| Details
|
| Details
|
||||||
| ------------------------------
|
| ------------------------------
|
||||||
Server UUID: {{.Server.ID}}
|
Server UUID: {{.Server.Id}}
|
||||||
Container Image: {{.Script.ContainerImage}}
|
Container Image: {{.Script.ContainerImage}}
|
||||||
Container Entrypoint: {{.Script.Entrypoint}}
|
Container Entrypoint: {{.Script.Entrypoint}}
|
||||||
|
|
||||||
@@ -393,13 +394,12 @@ func (ip *InstallationProcess) AfterExecute(containerId string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Execute executes the installation process inside a specially created docker
|
// Executes the installation process inside a specially created docker container.
|
||||||
// container.
|
|
||||||
func (ip *InstallationProcess) Execute() (string, error) {
|
func (ip *InstallationProcess) Execute() (string, error) {
|
||||||
// Create a child context that is canceled once this function is done running. This
|
// Create a child context that is canceled once this function is done running. This
|
||||||
// will also be canceled if the parent context (from the Server struct) is canceled
|
// will also be canceled if the parent context (from the Server struct) is canceled
|
||||||
// which occurs if the server is deleted.
|
// which occurs if the server is deleted.
|
||||||
ctx, cancel := context.WithCancel(ip.Server.Context())
|
ctx, cancel := context.WithCancel(ip.context)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
conf := &container.Config{
|
conf := &container.Config{
|
||||||
@@ -469,7 +469,7 @@ func (ip *InstallationProcess) Execute() (string, error) {
|
|||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
r, err := ip.client.ContainerCreate(ctx, conf, hostConf, nil, nil, ip.Server.ID()+"_installer")
|
r, err := ip.client.ContainerCreate(ctx, conf, hostConf, nil, nil, ip.Server.Id()+"_installer")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
@@ -506,19 +506,26 @@ func (ip *InstallationProcess) Execute() (string, error) {
|
|||||||
return r.ID, nil
|
return r.ID, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// StreamOutput streams the output of the installation process to a log file in
|
// Streams the output of the installation process to a log file in the server configuration
|
||||||
// the server configuration directory, as well as to a websocket listener so
|
// directory, as well as to a websocket listener so that the process can be viewed in
|
||||||
// that the process can be viewed in the panel by administrators.
|
// the panel by administrators.
|
||||||
func (ip *InstallationProcess) StreamOutput(ctx context.Context, id string) error {
|
func (ip *InstallationProcess) StreamOutput(ctx context.Context, id string) error {
|
||||||
opts := types.ContainerLogsOptions{ShowStdout: true, ShowStderr: true, Follow: true}
|
reader, err := ip.client.ContainerLogs(ctx, id, types.ContainerLogsOptions{
|
||||||
reader, err := ip.client.ContainerLogs(ctx, id, opts)
|
ShowStdout: true,
|
||||||
|
ShowStderr: true,
|
||||||
|
Follow: true,
|
||||||
|
})
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
defer reader.Close()
|
defer reader.Close()
|
||||||
|
|
||||||
err = system.ScanReader(reader, ip.Server.Sink(system.InstallSink).Push)
|
evts := ip.Server.Events()
|
||||||
if err != nil && !errors.Is(err, context.Canceled) {
|
err = system.ScanReader(reader, func(line string) {
|
||||||
|
evts.Publish(InstallOutputEvent, line)
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
ip.Server.Log().WithFields(log.Fields{"container_id": id, "error": err}).Warn("error processing install output lines")
|
ip.Server.Log().WithFields(log.Fields{"container_id": id, "error": err}).Warn("error processing install output lines")
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
@@ -566,5 +573,5 @@ func (ip *InstallationProcess) resourceLimits() container.Resources {
|
|||||||
// server is. A boolean value of "true" means everything was successful, "false"
|
// server is. A boolean value of "true" means everything was successful, "false"
|
||||||
// means something went wrong and the server must be deleted and re-created.
|
// means something went wrong and the server must be deleted and re-created.
|
||||||
func (s *Server) SyncInstallState(successful bool) error {
|
func (s *Server) SyncInstallState(successful bool) error {
|
||||||
return s.client.SetInstallationStatus(s.Context(), s.ID(), successful)
|
return s.client.SetInstallationStatus(s.Context(), s.Id(), successful)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,17 +1,15 @@
|
|||||||
package server
|
package server
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"encoding/json"
|
||||||
"regexp"
|
"regexp"
|
||||||
"strconv"
|
"strconv"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/pterodactyl/wings/events"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
|
"github.com/pterodactyl/wings/events"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -42,137 +40,136 @@ func (dsl *diskSpaceLimiter) Reset() {
|
|||||||
// 15 seconds, and terminate it forcefully if it does not stop.
|
// 15 seconds, and terminate it forcefully if it does not stop.
|
||||||
//
|
//
|
||||||
// This function is only executed one time, so whenever a server is marked as booting the limiter
|
// This function is only executed one time, so whenever a server is marked as booting the limiter
|
||||||
// should be reset, so it can properly be triggered as needed.
|
// should be reset so it can properly be triggered as needed.
|
||||||
func (dsl *diskSpaceLimiter) Trigger() {
|
func (dsl *diskSpaceLimiter) Trigger() {
|
||||||
dsl.o.Do(func() {
|
dsl.o.Do(func() {
|
||||||
dsl.server.PublishConsoleOutputFromDaemon("Server is exceeding the assigned disk space limit, stopping process now.")
|
dsl.server.PublishConsoleOutputFromDaemon("Server is exceeding the assigned disk space limit, stopping process now.")
|
||||||
if err := dsl.server.Environment.WaitForStop(dsl.server.Context(), time.Minute, true); err != nil {
|
if err := dsl.server.Environment.WaitForStop(60, true); err != nil {
|
||||||
dsl.server.Log().WithField("error", err).Error("failed to stop server after exceeding space limit!")
|
dsl.server.Log().WithField("error", err).Error("failed to stop server after exceeding space limit!")
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// processConsoleOutputEvent handles output from a server's Docker container
|
// Adds all of the internal event listeners we want to use for a server. These listeners can only be
|
||||||
// and runs through different limiting logic to ensure that spam console output
|
// removed by deleting the server as they should last for the duration of the process' lifetime.
|
||||||
// does not cause negative effects to the system. This will also monitor the
|
|
||||||
// output lines to determine if the server is started yet, and if the output is
|
|
||||||
// not being throttled, will send the data over to the websocket.
|
|
||||||
func (s *Server) processConsoleOutputEvent(v []byte) {
|
|
||||||
// Always process the console output, but do this in a seperate thread since we
|
|
||||||
// don't really care about side-effects from this call, and don't want it to block
|
|
||||||
// the console sending logic.
|
|
||||||
go s.onConsoleOutput(v)
|
|
||||||
|
|
||||||
// If the console is being throttled, do nothing else with it, we don't want
|
|
||||||
// to waste time. This code previously terminated server instances after violating
|
|
||||||
// different throttle limits. That code was clunky and difficult to reason about,
|
|
||||||
// in addition to being a consistent pain point for users.
|
|
||||||
//
|
|
||||||
// In the interest of building highly efficient software, that code has been removed
|
|
||||||
// here, and we'll rely on the host to detect bad actors through their own means.
|
|
||||||
if !s.Throttler().Allow() {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
s.Sink(system.LogSink).Push(v)
|
|
||||||
}
|
|
||||||
|
|
||||||
// StartEventListeners adds all the internal event listeners we want to use for
|
|
||||||
// a server. These listeners can only be removed by deleting the server as they
|
|
||||||
// should last for the duration of the process' lifetime.
|
|
||||||
func (s *Server) StartEventListeners() {
|
func (s *Server) StartEventListeners() {
|
||||||
c := make(chan []byte, 8)
|
console := func(e events.Event) {
|
||||||
limit := newDiskLimiter(s)
|
t := s.Throttler()
|
||||||
|
err := t.Increment(func() {
|
||||||
|
s.PublishConsoleOutputFromDaemon("Your server is outputting too much data and is being throttled.")
|
||||||
|
})
|
||||||
|
|
||||||
s.Log().Debug("registering event listeners: console, state, resources...")
|
// An error is only returned if the server has breached the thresholds set.
|
||||||
s.Environment.Events().On(c)
|
if err != nil {
|
||||||
s.Environment.SetLogCallback(s.processConsoleOutputEvent)
|
// If the process is already stopping, just let it continue with that action rather than attempting
|
||||||
|
// to terminate again.
|
||||||
|
if s.Environment.State() != environment.ProcessStoppingState {
|
||||||
|
s.Environment.SetState(environment.ProcessStoppingState)
|
||||||
|
|
||||||
go func() {
|
go func() {
|
||||||
for {
|
s.Log().Warn("stopping server instance, violating throttle limits")
|
||||||
select {
|
s.PublishConsoleOutputFromDaemon("Your server is being stopped for outputting too much data in a short period of time.")
|
||||||
case v := <-c:
|
|
||||||
go func(v []byte, limit *diskSpaceLimiter) {
|
// Completely skip over server power actions and terminate the running instance. This gives the
|
||||||
var e events.Event
|
// server 15 seconds to finish stopping gracefully before it is forcefully terminated.
|
||||||
if err := events.DecodeTo(v, &e); err != nil {
|
if err := s.Environment.WaitForStop(config.Get().Throttles.StopGracePeriod, true); err != nil {
|
||||||
return
|
// If there is an error set the process back to running so that this throttler is called
|
||||||
}
|
// again and hopefully kills the server.
|
||||||
switch e.Topic {
|
if s.Environment.State() != environment.ProcessOfflineState {
|
||||||
case environment.ResourceEvent:
|
s.Environment.SetState(environment.ProcessRunningState)
|
||||||
{
|
|
||||||
var stats struct {
|
|
||||||
Topic string
|
|
||||||
Data environment.Stats
|
|
||||||
}
|
|
||||||
if err := events.DecodeTo(v, &stats); err != nil {
|
|
||||||
s.Log().WithField("error", err).Warn("failed to decode server resource event")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
s.resources.UpdateStats(stats.Data)
|
|
||||||
// If there is no disk space available at this point, trigger the server
|
|
||||||
// disk limiter logic which will start to stop the running instance.
|
|
||||||
if !s.Filesystem().HasSpaceAvailable(true) {
|
|
||||||
limit.Trigger()
|
|
||||||
}
|
|
||||||
s.Events().Publish(StatsEvent, s.Proc())
|
|
||||||
}
|
|
||||||
case environment.StateChangeEvent:
|
|
||||||
{
|
|
||||||
// Reset the throttler when the process is started.
|
|
||||||
if e.Data == environment.ProcessStartingState {
|
|
||||||
limit.Reset()
|
|
||||||
s.Throttler().Reset()
|
|
||||||
}
|
|
||||||
s.OnStateChange()
|
|
||||||
}
|
|
||||||
case environment.DockerImagePullStatus:
|
|
||||||
s.Events().Publish(InstallOutputEvent, e.Data)
|
|
||||||
case environment.DockerImagePullStarted:
|
|
||||||
s.PublishConsoleOutputFromDaemon("Pulling Docker container image, this could take a few minutes to complete...")
|
|
||||||
case environment.DockerImagePullCompleted:
|
|
||||||
s.PublishConsoleOutputFromDaemon("Finished pulling Docker container image")
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
}(v, limit)
|
|
||||||
case <-s.Context().Done():
|
|
||||||
return
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
s.Log().WithField("error", err).Error("failed to terminate environment after triggering throttle")
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// If we are not throttled, go ahead and output the data.
|
||||||
|
if !t.Throttled() {
|
||||||
|
s.Events().Publish(ConsoleOutputEvent, e.Data)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Also pass the data along to the console output channel.
|
||||||
|
s.onConsoleOutput(e.Data)
|
||||||
|
}
|
||||||
|
|
||||||
|
l := newDiskLimiter(s)
|
||||||
|
state := func(e events.Event) {
|
||||||
|
// Reset the throttler when the process is started.
|
||||||
|
if e.Data == environment.ProcessStartingState {
|
||||||
|
l.Reset()
|
||||||
|
s.Throttler().Reset()
|
||||||
|
}
|
||||||
|
|
||||||
|
s.OnStateChange()
|
||||||
|
}
|
||||||
|
|
||||||
|
stats := func(e events.Event) {
|
||||||
|
st := new(environment.Stats)
|
||||||
|
if err := json.Unmarshal([]byte(e.Data), st); err != nil {
|
||||||
|
s.Log().WithField("error", err).Warn("failed to unmarshal server environment stats")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update the server resource tracking object with the resources we got here.
|
||||||
|
s.resources.mu.Lock()
|
||||||
|
s.resources.Stats = *st
|
||||||
|
s.resources.mu.Unlock()
|
||||||
|
|
||||||
|
// If there is no disk space available at this point, trigger the server disk limiter logic
|
||||||
|
// which will start to stop the running instance.
|
||||||
|
if !s.Filesystem().HasSpaceAvailable(true) {
|
||||||
|
l.Trigger()
|
||||||
|
}
|
||||||
|
|
||||||
|
s.emitProcUsage()
|
||||||
|
}
|
||||||
|
|
||||||
|
docker := func(e events.Event) {
|
||||||
|
if e.Topic == environment.DockerImagePullStatus {
|
||||||
|
s.Events().Publish(InstallOutputEvent, e.Data)
|
||||||
|
} else if e.Topic == environment.DockerImagePullStarted {
|
||||||
|
s.PublishConsoleOutputFromDaemon("Pulling Docker container image, this could take a few minutes to complete...")
|
||||||
|
} else {
|
||||||
|
s.PublishConsoleOutputFromDaemon("Finished pulling Docker container image")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
s.Log().Debug("registering event listeners: console, state, resources...")
|
||||||
|
s.Environment.Events().On(environment.ConsoleOutputEvent, &console)
|
||||||
|
s.Environment.Events().On(environment.StateChangeEvent, &state)
|
||||||
|
s.Environment.Events().On(environment.ResourceEvent, &stats)
|
||||||
|
for _, evt := range dockerEvents {
|
||||||
|
s.Environment.Events().On(evt, &docker)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
var stripAnsiRegex = regexp.MustCompile("[\u001B\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[a-zA-Z\\d]*)*)?\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PRZcf-ntqry=><~]))")
|
var stripAnsiRegex = regexp.MustCompile("[\u001B\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[a-zA-Z\\d]*)*)?\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PRZcf-ntqry=><~]))")
|
||||||
|
|
||||||
// Custom listener for console output events that will check if the given line
|
// Custom listener for console output events that will check if the given line
|
||||||
// of output matches one that should mark the server as started or not.
|
// of output matches one that should mark the server as started or not.
|
||||||
func (s *Server) onConsoleOutput(data []byte) {
|
func (s *Server) onConsoleOutput(data string) {
|
||||||
if s.Environment.State() != environment.ProcessStartingState && !s.IsRunning() {
|
// Get the server's process configuration.
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
processConfiguration := s.ProcessConfiguration()
|
processConfiguration := s.ProcessConfiguration()
|
||||||
|
|
||||||
// Make a copy of the data provided since it is by reference, otherwise you'll
|
|
||||||
// potentially introduce a race condition by modifying the value.
|
|
||||||
v := make([]byte, len(data))
|
|
||||||
copy(v, data)
|
|
||||||
|
|
||||||
// Check if the server is currently starting.
|
// Check if the server is currently starting.
|
||||||
if s.Environment.State() == environment.ProcessStartingState {
|
if s.Environment.State() == environment.ProcessStartingState {
|
||||||
// Check if we should strip ansi color codes.
|
// Check if we should strip ansi color codes.
|
||||||
if processConfiguration.Startup.StripAnsi {
|
if processConfiguration.Startup.StripAnsi {
|
||||||
v = stripAnsiRegex.ReplaceAll(v, []byte(""))
|
// Strip ansi color codes from the data string.
|
||||||
|
data = stripAnsiRegex.ReplaceAllString(data, "")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Iterate over all the done lines.
|
// Iterate over all the done lines.
|
||||||
for _, l := range processConfiguration.Startup.Done {
|
for _, l := range processConfiguration.Startup.Done {
|
||||||
if !l.Matches(v) {
|
if !l.Matches(data) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
s.Log().WithFields(log.Fields{
|
s.Log().WithFields(log.Fields{
|
||||||
"match": l.String(),
|
"match": l.String(),
|
||||||
"against": strconv.QuoteToASCII(string(v)),
|
"against": strconv.QuoteToASCII(data),
|
||||||
}).Debug("detected server in running state based on console line output")
|
}).Debug("detected server in running state based on console line output")
|
||||||
|
|
||||||
// If the specific line of output is one that would mark the server as started,
|
// If the specific line of output is one that would mark the server as started,
|
||||||
@@ -189,7 +186,7 @@ func (s *Server) onConsoleOutput(data []byte) {
|
|||||||
if s.IsRunning() {
|
if s.IsRunning() {
|
||||||
stop := processConfiguration.Stop
|
stop := processConfiguration.Stop
|
||||||
|
|
||||||
if stop.Type == remote.ProcessStopCommand && bytes.Equal(v, []byte(stop.Value)) {
|
if stop.Type == remote.ProcessStopCommand && data == stop.Value {
|
||||||
s.Environment.SetState(environment.ProcessOfflineState)
|
s.Environment.SetState(environment.ProcessOfflineState)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,8 +2,11 @@ package server
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/pterodactyl/wings/metrics"
|
||||||
"io"
|
"io"
|
||||||
|
"io/ioutil"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"runtime"
|
"runtime"
|
||||||
@@ -13,8 +16,6 @@ import (
|
|||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gammazero/workerpool"
|
"github.com/gammazero/workerpool"
|
||||||
"github.com/goccy/go-json"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
"github.com/pterodactyl/wings/environment/docker"
|
"github.com/pterodactyl/wings/environment/docker"
|
||||||
@@ -28,9 +29,9 @@ type Manager struct {
|
|||||||
servers []*Server
|
servers []*Server
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewManager returns a new server manager instance. This will boot up all the
|
// NewManager returns a new server manager instance. This will boot up all of
|
||||||
// servers that are currently present on the filesystem and set them into the
|
// the servers that are currently present on the filesystem and set them into
|
||||||
// manager.
|
// the manager.
|
||||||
func NewManager(ctx context.Context, client remote.Client) (*Manager, error) {
|
func NewManager(ctx context.Context, client remote.Client) (*Manager, error) {
|
||||||
m := NewEmptyManager(client)
|
m := NewEmptyManager(client)
|
||||||
if err := m.init(ctx); err != nil {
|
if err := m.init(ctx); err != nil {
|
||||||
@@ -52,25 +53,7 @@ func (m *Manager) Client() remote.Client {
|
|||||||
return m.client
|
return m.client
|
||||||
}
|
}
|
||||||
|
|
||||||
// Len returns the count of servers stored in the manager instance.
|
// Put replaces all of the current values in the collection with the value that
|
||||||
func (m *Manager) Len() int {
|
|
||||||
m.mu.RLock()
|
|
||||||
defer m.mu.RUnlock()
|
|
||||||
return len(m.servers)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Keys returns all of the server UUIDs stored in the manager set.
|
|
||||||
func (m *Manager) Keys() []string {
|
|
||||||
m.mu.RLock()
|
|
||||||
defer m.mu.RUnlock()
|
|
||||||
keys := make([]string, len(m.servers))
|
|
||||||
for i, s := range m.servers {
|
|
||||||
keys[i] = s.ID()
|
|
||||||
}
|
|
||||||
return keys
|
|
||||||
}
|
|
||||||
|
|
||||||
// Put replaces all the current values in the collection with the value that
|
|
||||||
// is passed through.
|
// is passed through.
|
||||||
func (m *Manager) Put(s []*Server) {
|
func (m *Manager) Put(s []*Server) {
|
||||||
m.mu.Lock()
|
m.mu.Lock()
|
||||||
@@ -78,7 +61,7 @@ func (m *Manager) Put(s []*Server) {
|
|||||||
m.mu.Unlock()
|
m.mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
// All returns all the items in the collection.
|
// All returns all of the items in the collection.
|
||||||
func (m *Manager) All() []*Server {
|
func (m *Manager) All() []*Server {
|
||||||
m.mu.RLock()
|
m.mu.RLock()
|
||||||
defer m.mu.RUnlock()
|
defer m.mu.RUnlock()
|
||||||
@@ -90,13 +73,16 @@ func (m *Manager) Add(s *Server) {
|
|||||||
m.mu.Lock()
|
m.mu.Lock()
|
||||||
m.servers = append(m.servers, s)
|
m.servers = append(m.servers, s)
|
||||||
m.mu.Unlock()
|
m.mu.Unlock()
|
||||||
|
|
||||||
|
// Add the server to the metrics with a offline status.
|
||||||
|
metrics.ServerStatus.WithLabelValues(s.Id()).Set(0)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get returns a single server instance and a boolean value indicating if it was
|
// Get returns a single server instance and a boolean value indicating if it was
|
||||||
// found in the global collection or not.
|
// found in the global collection or not.
|
||||||
func (m *Manager) Get(uuid string) (*Server, bool) {
|
func (m *Manager) Get(uuid string) (*Server, bool) {
|
||||||
match := m.Find(func(server *Server) bool {
|
match := m.Find(func(server *Server) bool {
|
||||||
return server.ID() == uuid
|
return server.Id() == uuid
|
||||||
})
|
})
|
||||||
return match, match != nil
|
return match, match != nil
|
||||||
}
|
}
|
||||||
@@ -135,6 +121,9 @@ func (m *Manager) Remove(filter func(match *Server) bool) {
|
|||||||
for _, v := range m.servers {
|
for _, v := range m.servers {
|
||||||
if !filter(v) {
|
if !filter(v) {
|
||||||
r = append(r, v)
|
r = append(r, v)
|
||||||
|
} else {
|
||||||
|
// Delete the server from the metric.
|
||||||
|
metrics.DeleteServer(v.Id())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
m.servers = r
|
m.servers = r
|
||||||
@@ -148,13 +137,13 @@ func (m *Manager) Remove(filter func(match *Server) bool) {
|
|||||||
func (m *Manager) PersistStates() error {
|
func (m *Manager) PersistStates() error {
|
||||||
states := map[string]string{}
|
states := map[string]string{}
|
||||||
for _, s := range m.All() {
|
for _, s := range m.All() {
|
||||||
states[s.ID()] = s.Environment.State()
|
states[s.Id()] = s.Environment.State()
|
||||||
}
|
}
|
||||||
data, err := json.Marshal(states)
|
data, err := json.Marshal(states)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.WithStack(err)
|
return errors.WithStack(err)
|
||||||
}
|
}
|
||||||
if err := os.WriteFile(config.Get().System.GetStatesPath(), data, 0o644); err != nil {
|
if err := ioutil.WriteFile(config.Get().System.GetStatesPath(), data, 0644); err != nil {
|
||||||
return errors.WithStack(err)
|
return errors.WithStack(err)
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
@@ -162,7 +151,7 @@ func (m *Manager) PersistStates() error {
|
|||||||
|
|
||||||
// ReadStates returns the state of the servers.
|
// ReadStates returns the state of the servers.
|
||||||
func (m *Manager) ReadStates() (map[string]string, error) {
|
func (m *Manager) ReadStates() (map[string]string, error) {
|
||||||
f, err := os.OpenFile(config.Get().System.GetStatesPath(), os.O_RDONLY|os.O_CREATE, 0o644)
|
f, err := os.OpenFile(config.Get().System.GetStatesPath(), os.O_RDONLY|os.O_CREATE, 0644)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, errors.WithStack(err)
|
return nil, errors.WithStack(err)
|
||||||
}
|
}
|
||||||
@@ -189,18 +178,15 @@ func (m *Manager) InitServer(data remote.ServerConfigurationResponse) (*Server,
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
if err := s.UpdateDataStructure(data.Settings); err != nil {
|
||||||
// Setup the base server configuration data which will be used for all of the
|
return nil, err
|
||||||
// remaining functionality in this call.
|
|
||||||
if err := s.SyncWithConfiguration(data); err != nil {
|
|
||||||
return nil, errors.WithStackIf(err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
s.fs = filesystem.New(filepath.Join(config.Get().System.Data, s.ID()), s.DiskSpace(), s.Config().Egg.FileDenylist)
|
s.fs = filesystem.New(filepath.Join(config.Get().System.Data, s.Id()), s.DiskSpace(), s.Config().Egg.FileDenylist)
|
||||||
|
|
||||||
// Right now we only support a Docker based environment, so I'm going to hard code
|
// Right now we only support a Docker based environment, so I'm going to hard code
|
||||||
// this logic in. When we're ready to support other environment we'll need to make
|
// this logic in. When we're ready to support other environment we'll need to make
|
||||||
// some modifications here, obviously.
|
// some modifications here obviously.
|
||||||
settings := environment.Settings{
|
settings := environment.Settings{
|
||||||
Mounts: s.Mounts(),
|
Mounts: s.Mounts(),
|
||||||
Allocations: s.cfg.Allocations,
|
Allocations: s.cfg.Allocations,
|
||||||
@@ -212,11 +198,17 @@ func (m *Manager) InitServer(data remote.ServerConfigurationResponse) (*Server,
|
|||||||
Image: s.Config().Container.Image,
|
Image: s.Config().Container.Image,
|
||||||
}
|
}
|
||||||
|
|
||||||
if env, err := docker.New(s.ID(), &meta, envCfg); err != nil {
|
if env, err := docker.New(s.Id(), &meta, envCfg); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
} else {
|
} else {
|
||||||
s.Environment = env
|
s.Environment = env
|
||||||
s.StartEventListeners()
|
s.StartEventListeners()
|
||||||
|
s.Throttler().StartTimer(s.Context())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Forces the configuration to be synced with the panel.
|
||||||
|
if err := s.SyncWithConfiguration(data); err != nil {
|
||||||
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the server's data directory exists, force disk usage calculation.
|
// If the server's data directory exists, force disk usage calculation.
|
||||||
@@ -227,7 +219,7 @@ func (m *Manager) InitServer(data remote.ServerConfigurationResponse) (*Server,
|
|||||||
return s, nil
|
return s, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// initializeFromRemoteSource iterates over a given directory and loads all
|
// initializeFromRemoteSource iterates over a given directory and loads all of
|
||||||
// the servers listed before returning them to the calling function.
|
// the servers listed before returning them to the calling function.
|
||||||
func (m *Manager) init(ctx context.Context) error {
|
func (m *Manager) init(ctx context.Context) error {
|
||||||
log.Info("fetching list of servers from API")
|
log.Info("fetching list of servers from API")
|
||||||
@@ -267,7 +259,7 @@ func (m *Manager) init(ctx context.Context) error {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// Wait until we've processed all the configuration files in the directory
|
// Wait until we've processed all of the configuration files in the directory
|
||||||
// before continuing.
|
// before continuing.
|
||||||
pool.StopWait()
|
pool.StopWait()
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
)
|
)
|
||||||
|
|||||||
112
server/power.go
112
server/power.go
@@ -2,14 +2,13 @@ package server
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
|
||||||
"os"
|
"os"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/google/uuid"
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
|
"golang.org/x/sync/semaphore"
|
||||||
)
|
)
|
||||||
|
|
||||||
type PowerAction string
|
type PowerAction string
|
||||||
@@ -19,7 +18,7 @@ type PowerAction string
|
|||||||
// example, sending two "start" actions back to back will not process the second action until
|
// example, sending two "start" actions back to back will not process the second action until
|
||||||
// the first action has been completed.
|
// the first action has been completed.
|
||||||
//
|
//
|
||||||
// This utilizes a workerpool with a limit of one worker so that all the actions execute
|
// This utilizes a workerpool with a limit of one worker so that all of the actions execute
|
||||||
// in a sync manner.
|
// in a sync manner.
|
||||||
const (
|
const (
|
||||||
PowerActionStart = "start"
|
PowerActionStart = "start"
|
||||||
@@ -28,7 +27,7 @@ const (
|
|||||||
PowerActionTerminate = "kill"
|
PowerActionTerminate = "kill"
|
||||||
)
|
)
|
||||||
|
|
||||||
// IsValid checks if the power action being received is valid.
|
// Checks if the power action being received is valid.
|
||||||
func (pa PowerAction) IsValid() bool {
|
func (pa PowerAction) IsValid() bool {
|
||||||
return pa == PowerActionStart ||
|
return pa == PowerActionStart ||
|
||||||
pa == PowerActionStop ||
|
pa == PowerActionStop ||
|
||||||
@@ -40,43 +39,45 @@ func (pa PowerAction) IsStart() bool {
|
|||||||
return pa == PowerActionStart || pa == PowerActionRestart
|
return pa == PowerActionStart || pa == PowerActionRestart
|
||||||
}
|
}
|
||||||
|
|
||||||
// ExecutingPowerAction checks if there is currently a power action being
|
// Check if there is currently a power action being processed for the server.
|
||||||
// processed for the server.
|
|
||||||
func (s *Server) ExecutingPowerAction() bool {
|
func (s *Server) ExecutingPowerAction() bool {
|
||||||
return s.powerLock.IsLocked()
|
if s.powerLock == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
ok := s.powerLock.TryAcquire(1)
|
||||||
|
if ok {
|
||||||
|
s.powerLock.Release(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Remember, if we acquired a lock it means nothing was running.
|
||||||
|
return !ok
|
||||||
}
|
}
|
||||||
|
|
||||||
// HandlePowerAction is a helper function that can receive a power action and then process the
|
// Helper function that can receive a power action and then process the actions that need
|
||||||
// actions that need to occur for it. This guards against someone calling Start() twice at the
|
// to occur for it. This guards against someone calling Start() twice at the same time, or
|
||||||
// same time, or trying to restart while another restart process is currently running.
|
// trying to restart while another restart process is currently running.
|
||||||
//
|
//
|
||||||
// However, the code design for the daemon does depend on the user correctly calling this
|
// However, the code design for the daemon does depend on the user correctly calling this
|
||||||
// function rather than making direct calls to the start/stop/restart functions on the
|
// function rather than making direct calls to the start/stop/restart functions on the
|
||||||
// environment struct.
|
// environment struct.
|
||||||
func (s *Server) HandlePowerAction(action PowerAction, waitSeconds ...int) error {
|
func (s *Server) HandlePowerAction(action PowerAction, waitSeconds ...int) error {
|
||||||
if s.IsInstalling() || s.IsTransferring() || s.IsRestoring() {
|
if s.IsInstalling() {
|
||||||
if s.IsRestoring() {
|
|
||||||
return ErrServerIsRestoring
|
|
||||||
} else if s.IsTransferring() {
|
|
||||||
return ErrServerIsTransferring
|
|
||||||
}
|
|
||||||
return ErrServerIsInstalling
|
return ErrServerIsInstalling
|
||||||
}
|
}
|
||||||
|
|
||||||
lockId, _ := uuid.NewUUID()
|
if s.IsTransferring() {
|
||||||
log := s.Log().WithField("lock_id", lockId.String()).WithField("action", action)
|
return ErrServerIsTransferring
|
||||||
|
|
||||||
cleanup := func() {
|
|
||||||
log.Info("releasing exclusive lock for power action")
|
|
||||||
s.powerLock.Release()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
var wait int
|
if s.IsRestoring() {
|
||||||
if len(waitSeconds) > 0 && waitSeconds[0] > 0 {
|
return ErrServerIsRestoring
|
||||||
wait = waitSeconds[0]
|
}
|
||||||
|
|
||||||
|
if s.powerLock == nil {
|
||||||
|
s.powerLock = semaphore.NewWeighted(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
log.WithField("wait_seconds", wait).Debug("acquiring power action lock for instance")
|
|
||||||
// Only attempt to acquire a lock on the process if this is not a termination event. We want to
|
// Only attempt to acquire a lock on the process if this is not a termination event. We want to
|
||||||
// just allow those events to pass right through for good reason. If a server is currently trying
|
// just allow those events to pass right through for good reason. If a server is currently trying
|
||||||
// to process a power action but has gotten stuck you still should be able to pass through the
|
// to process a power action but has gotten stuck you still should be able to pass through the
|
||||||
@@ -85,38 +86,33 @@ func (s *Server) HandlePowerAction(action PowerAction, waitSeconds ...int) error
|
|||||||
if action != PowerActionTerminate {
|
if action != PowerActionTerminate {
|
||||||
// Determines if we should wait for the lock or not. If a value greater than 0 is passed
|
// Determines if we should wait for the lock or not. If a value greater than 0 is passed
|
||||||
// into this function we will wait that long for a lock to be acquired.
|
// into this function we will wait that long for a lock to be acquired.
|
||||||
if wait > 0 {
|
if len(waitSeconds) > 0 && waitSeconds[0] != 0 {
|
||||||
ctx, cancel := context.WithTimeout(s.ctx, time.Second*time.Duration(wait))
|
ctx, cancel := context.WithTimeout(context.Background(), time.Second*time.Duration(waitSeconds[0]))
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
// Attempt to acquire a lock on the power action lock for up to 30 seconds. If more
|
// Attempt to acquire a lock on the power action lock for up to 30 seconds. If more
|
||||||
// time than that passes an error will be propagated back up the chain and this
|
// time than that passes an error will be propagated back up the chain and this
|
||||||
// request will be aborted.
|
// request will be aborted.
|
||||||
if err := s.powerLock.TryAcquire(ctx); err != nil {
|
if err := s.powerLock.Acquire(ctx, 1); err != nil {
|
||||||
return errors.Wrap(err, fmt.Sprintf("could not acquire lock on power action after %d seconds", wait))
|
return errors.WithMessage(err, "could not acquire lock on power state")
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
// If no wait duration was provided we will attempt to immediately acquire the lock
|
// If no wait duration was provided we will attempt to immediately acquire the lock
|
||||||
// and bail out with a context deadline error if it is not acquired immediately.
|
// and bail out with a context deadline error if it is not acquired immediately.
|
||||||
if err := s.powerLock.Acquire(); err != nil {
|
if ok := s.powerLock.TryAcquire(1); !ok {
|
||||||
return errors.Wrap(err, "failed to acquire exclusive lock for power actions")
|
return errors.WithMessage(context.DeadlineExceeded, "could not acquire lock on power state")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Info("acquired exclusive lock on power actions, processing event...")
|
// Release the lock once the process being requested has finished executing.
|
||||||
defer cleanup()
|
defer s.powerLock.Release(1)
|
||||||
} else {
|
} else {
|
||||||
// Still try to acquire the lock if terminating, and it is available, just so that
|
// Still try to acquire the lock if terminating and it is available, just so that other power
|
||||||
// other power actions are blocked until it has completed. However, if it cannot be
|
// actions are blocked until it has completed. However, if it is unavailable we won't stop
|
||||||
// acquired we won't stop the entire process.
|
// the entire process.
|
||||||
//
|
if ok := s.powerLock.TryAcquire(1); ok {
|
||||||
// If we did successfully acquire the lock, make sure we release it once we're done
|
// If we managed to acquire the lock be sure to released it once this process is completed.
|
||||||
// executiong the power actions.
|
defer s.powerLock.Release(1)
|
||||||
if err := s.powerLock.Acquire(); err == nil {
|
|
||||||
log.Info("acquired exclusive lock on power actions, processing event...")
|
|
||||||
defer cleanup()
|
|
||||||
} else {
|
|
||||||
log.Warn("failed to acquire exclusive lock, ignoring failure for termination event")
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -131,13 +127,13 @@ func (s *Server) HandlePowerAction(action PowerAction, waitSeconds ...int) error
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
return s.Environment.Start(s.Context())
|
return s.Environment.Start()
|
||||||
case PowerActionStop:
|
case PowerActionStop:
|
||||||
fallthrough
|
// We're specifically waiting for the process to be stopped here, otherwise the lock is released
|
||||||
|
// too soon, and you can rack up all sorts of issues.
|
||||||
|
return s.Environment.WaitForStop(10*60, true)
|
||||||
case PowerActionRestart:
|
case PowerActionRestart:
|
||||||
// We're specifically waiting for the process to be stopped here, otherwise the lock is
|
if err := s.Environment.WaitForStop(10*60, true); err != nil {
|
||||||
// released too soon, and you can rack up all sorts of issues.
|
|
||||||
if err := s.Environment.WaitForStop(s.Context(), time.Minute*10, true); err != nil {
|
|
||||||
// Even timeout errors should be bubbled back up the stack. If the process didn't stop
|
// Even timeout errors should be bubbled back up the stack. If the process didn't stop
|
||||||
// nicely, but the terminate argument was passed then the server is stopped without an
|
// nicely, but the terminate argument was passed then the server is stopped without an
|
||||||
// error being returned.
|
// error being returned.
|
||||||
@@ -149,18 +145,14 @@ func (s *Server) HandlePowerAction(action PowerAction, waitSeconds ...int) error
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if action == PowerActionStop {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Now actually try to start the process by executing the normal pre-boot logic.
|
// Now actually try to start the process by executing the normal pre-boot logic.
|
||||||
if err := s.onBeforeStart(); err != nil {
|
if err := s.onBeforeStart(); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
return s.Environment.Start(s.Context())
|
return s.Environment.Start()
|
||||||
case PowerActionTerminate:
|
case PowerActionTerminate:
|
||||||
return s.Environment.Terminate(s.Context(), os.Kill)
|
return s.Environment.Terminate(os.Kill)
|
||||||
}
|
}
|
||||||
|
|
||||||
return errors.New("attempting to handle unknown power action")
|
return errors.New("attempting to handle unknown power action")
|
||||||
@@ -198,22 +190,18 @@ func (s *Server) onBeforeStart() error {
|
|||||||
// Update the configuration files defined for the server before beginning the boot process.
|
// Update the configuration files defined for the server before beginning the boot process.
|
||||||
// This process executes a bunch of parallel updates, so we just block until that process
|
// This process executes a bunch of parallel updates, so we just block until that process
|
||||||
// is complete. Any errors as a result of this will just be bubbled out in the logger,
|
// is complete. Any errors as a result of this will just be bubbled out in the logger,
|
||||||
// we don't need to actively do anything about it at this point, worse comes to worst the
|
// we don't need to actively do anything about it at this point, worst comes to worst the
|
||||||
// server starts in a weird state and the user can manually adjust.
|
// server starts in a weird state and the user can manually adjust.
|
||||||
s.PublishConsoleOutputFromDaemon("Updating process configuration files...")
|
s.PublishConsoleOutputFromDaemon("Updating process configuration files...")
|
||||||
s.Log().Debug("updating server configuration files...")
|
|
||||||
s.UpdateConfigurationFiles()
|
s.UpdateConfigurationFiles()
|
||||||
s.Log().Debug("updated server configuration files")
|
|
||||||
|
|
||||||
if config.Get().System.CheckPermissionsOnBoot {
|
if config.Get().System.CheckPermissionsOnBoot {
|
||||||
s.PublishConsoleOutputFromDaemon("Ensuring file permissions are set correctly, this could take a few seconds...")
|
s.PublishConsoleOutputFromDaemon("Ensuring file permissions are set correctly, this could take a few seconds...")
|
||||||
// Ensure all the server file permissions are set correctly before booting the process.
|
// Ensure all of the server file permissions are set correctly before booting the process.
|
||||||
s.Log().Debug("chowning server root directory...")
|
|
||||||
if err := s.Filesystem().Chown("/"); err != nil {
|
if err := s.Filesystem().Chown("/"); err != nil {
|
||||||
return errors.WithMessage(err, "failed to chown root server directory during pre-boot process")
|
return errors.WithMessage(err, "failed to chown root server directory during pre-boot process")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
s.Log().Info("completed server preflight, starting boot process...")
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,22 +0,0 @@
|
|||||||
package server
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
. "github.com/franela/goblin"
|
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestPower(t *testing.T) {
|
|
||||||
g := Goblin(t)
|
|
||||||
|
|
||||||
g.Describe("Server#ExecutingPowerAction", func() {
|
|
||||||
g.It("should return based on locker status", func() {
|
|
||||||
s := &Server{powerLock: system.NewLocker()}
|
|
||||||
|
|
||||||
g.Assert(s.ExecutingPowerAction()).IsFalse()
|
|
||||||
s.powerLock.Acquire()
|
|
||||||
g.Assert(s.ExecutingPowerAction()).IsTrue()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
@@ -8,7 +8,7 @@ import (
|
|||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ResourceUsage defines the current resource usage for a given server instance. If a server is offline you
|
// Defines the current resource usage for a given server instance. If a server is offline you
|
||||||
// should obviously expect memory and CPU usage to be 0. However, disk will always be returned
|
// should obviously expect memory and CPU usage to be 0. However, disk will always be returned
|
||||||
// since that is not dependent on the server being running to collect that data.
|
// since that is not dependent on the server being running to collect that data.
|
||||||
type ResourceUsage struct {
|
type ResourceUsage struct {
|
||||||
@@ -26,7 +26,7 @@ type ResourceUsage struct {
|
|||||||
Disk int64 `json:"disk_bytes"`
|
Disk int64 `json:"disk_bytes"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Proc returns the current resource usage stats for the server instance. This returns
|
// Returns the current resource usage stats for the server instance. This returns
|
||||||
// a copy of the tracked resources, so making any changes to the response will not
|
// a copy of the tracked resources, so making any changes to the response will not
|
||||||
// have the desired outcome for you most likely.
|
// have the desired outcome for you most likely.
|
||||||
func (s *Server) Proc() ResourceUsage {
|
func (s *Server) Proc() ResourceUsage {
|
||||||
@@ -38,22 +38,19 @@ func (s *Server) Proc() ResourceUsage {
|
|||||||
return s.resources
|
return s.resources
|
||||||
}
|
}
|
||||||
|
|
||||||
// UpdateStats updates the current stats for the server's resource usage.
|
// Resets the usages values to zero, used when a server is stopped to ensure we don't hold
|
||||||
func (ru *ResourceUsage) UpdateStats(stats environment.Stats) {
|
|
||||||
ru.mu.Lock()
|
|
||||||
ru.Stats = stats
|
|
||||||
ru.mu.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reset resets the usages values to zero, used when a server is stopped to ensure we don't hold
|
|
||||||
// onto any values incorrectly.
|
// onto any values incorrectly.
|
||||||
func (ru *ResourceUsage) Reset() {
|
func (ru *ResourceUsage) Reset() {
|
||||||
ru.mu.Lock()
|
ru.mu.Lock()
|
||||||
defer ru.mu.Unlock()
|
defer ru.mu.Unlock()
|
||||||
|
|
||||||
ru.Memory = 0
|
ru.Memory = 0
|
||||||
ru.CpuAbsolute = 0
|
ru.CpuAbsolute = 0
|
||||||
ru.Uptime = 0
|
|
||||||
ru.Network.TxBytes = 0
|
ru.Network.TxBytes = 0
|
||||||
ru.Network.RxBytes = 0
|
ru.Network.RxBytes = 0
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (s *Server) emitProcUsage() {
|
||||||
|
if err := s.Events().PublishJson(StatsEvent, s.Proc()); err != nil {
|
||||||
|
s.Log().WithField("error", err).Warn("error while emitting server resource usage to listeners")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
120
server/server.go
120
server/server.go
@@ -11,14 +11,14 @@ import (
|
|||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/creasty/defaults"
|
"github.com/creasty/defaults"
|
||||||
"github.com/goccy/go-json"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
|
"github.com/pterodactyl/wings/environment/docker"
|
||||||
"github.com/pterodactyl/wings/events"
|
"github.com/pterodactyl/wings/events"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/server/filesystem"
|
"github.com/pterodactyl/wings/server/filesystem"
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
|
"golang.org/x/sync/semaphore"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Server is the high level definition for a server instance being controlled
|
// Server is the high level definition for a server instance being controlled
|
||||||
@@ -31,7 +31,8 @@ type Server struct {
|
|||||||
ctxCancel *context.CancelFunc
|
ctxCancel *context.CancelFunc
|
||||||
|
|
||||||
emitterLock sync.Mutex
|
emitterLock sync.Mutex
|
||||||
powerLock *system.Locker
|
powerLock *semaphore.Weighted
|
||||||
|
throttleOnce sync.Once
|
||||||
|
|
||||||
// Maintains the configuration for the server. This is the data that gets returned by the Panel
|
// Maintains the configuration for the server. This is the data that gets returned by the Panel
|
||||||
// such as build settings and container images.
|
// such as build settings and container images.
|
||||||
@@ -47,7 +48,7 @@ type Server struct {
|
|||||||
fs *filesystem.Filesystem
|
fs *filesystem.Filesystem
|
||||||
|
|
||||||
// Events emitted by the server instance.
|
// Events emitted by the server instance.
|
||||||
emitter *events.Bus
|
emitter *events.EventBus
|
||||||
|
|
||||||
// Defines the process configuration for the server instance. This is dynamically
|
// Defines the process configuration for the server instance. This is dynamically
|
||||||
// fetched from the Pterodactyl Server instance each time the server process is
|
// fetched from the Pterodactyl Server instance each time the server process is
|
||||||
@@ -63,17 +64,11 @@ type Server struct {
|
|||||||
restoring *system.AtomicBool
|
restoring *system.AtomicBool
|
||||||
|
|
||||||
// The console throttler instance used to control outputs.
|
// The console throttler instance used to control outputs.
|
||||||
throttler *ConsoleThrottle
|
throttler *ConsoleThrottler
|
||||||
throttleOnce sync.Once
|
|
||||||
|
|
||||||
// Tracks open websocket connections for the server.
|
// Tracks open websocket connections for the server.
|
||||||
wsBag *WebsocketBag
|
wsBag *WebsocketBag
|
||||||
wsBagLocker sync.Mutex
|
wsBagLocker sync.Mutex
|
||||||
|
|
||||||
sinks map[system.SinkName]*system.SinkPool
|
|
||||||
|
|
||||||
logSink *system.SinkPool
|
|
||||||
installSink *system.SinkPool
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// New returns a new server instance with a context and all of the default
|
// New returns a new server instance with a context and all of the default
|
||||||
@@ -87,11 +82,6 @@ func New(client remote.Client) (*Server, error) {
|
|||||||
installing: system.NewAtomicBool(false),
|
installing: system.NewAtomicBool(false),
|
||||||
transferring: system.NewAtomicBool(false),
|
transferring: system.NewAtomicBool(false),
|
||||||
restoring: system.NewAtomicBool(false),
|
restoring: system.NewAtomicBool(false),
|
||||||
powerLock: system.NewLocker(),
|
|
||||||
sinks: map[system.SinkName]*system.SinkPool{
|
|
||||||
system.LogSink: system.NewSinkPool(),
|
|
||||||
system.InstallSink: system.NewSinkPool(),
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
if err := defaults.Set(&s); err != nil {
|
if err := defaults.Set(&s); err != nil {
|
||||||
return nil, errors.Wrap(err, "server: could not set default values for struct")
|
return nil, errors.Wrap(err, "server: could not set default values for struct")
|
||||||
@@ -103,28 +93,9 @@ func New(client remote.Client) (*Server, error) {
|
|||||||
return &s, nil
|
return &s, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// CleanupForDestroy stops all running background tasks for this server that are
|
// Id returns the UUID for the server instance.
|
||||||
// using the context on the server struct. This will cancel any running install
|
|
||||||
// processes for the server as well.
|
|
||||||
func (s *Server) CleanupForDestroy() {
|
|
||||||
s.CtxCancel()
|
|
||||||
s.Events().Destroy()
|
|
||||||
s.DestroyAllSinks()
|
|
||||||
s.Websockets().CancelAll()
|
|
||||||
s.powerLock.Destroy()
|
|
||||||
}
|
|
||||||
|
|
||||||
// ID returns the UUID for the server instance.
|
|
||||||
func (s *Server) ID() string {
|
|
||||||
return s.Config().GetUuid()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Id returns the UUID for the server instance. This function is deprecated
|
|
||||||
// in favor of Server.ID().
|
|
||||||
//
|
|
||||||
// Deprecated
|
|
||||||
func (s *Server) Id() string {
|
func (s *Server) Id() string {
|
||||||
return s.ID()
|
return s.Config().GetUuid()
|
||||||
}
|
}
|
||||||
|
|
||||||
// Cancels the context assigned to this server instance. Assuming background tasks
|
// Cancels the context assigned to this server instance. Assuming background tasks
|
||||||
@@ -158,7 +129,7 @@ eloop:
|
|||||||
for k := range s.Config().EnvVars {
|
for k := range s.Config().EnvVars {
|
||||||
// Don't allow any environment variables that we have already set above.
|
// Don't allow any environment variables that we have already set above.
|
||||||
for _, e := range out {
|
for _, e := range out {
|
||||||
if strings.HasPrefix(e, strings.ToUpper(k)+"=") {
|
if strings.HasPrefix(e, strings.ToUpper(k)) {
|
||||||
continue eloop
|
continue eloop
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -170,7 +141,7 @@ eloop:
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) Log() *log.Entry {
|
func (s *Server) Log() *log.Entry {
|
||||||
return log.WithField("server", s.ID())
|
return log.WithField("server", s.Id())
|
||||||
}
|
}
|
||||||
|
|
||||||
// Sync syncs the state of the server on the Panel with Wings. This ensures that
|
// Sync syncs the state of the server on the Panel with Wings. This ensures that
|
||||||
@@ -180,57 +151,38 @@ func (s *Server) Log() *log.Entry {
|
|||||||
// This also means mass actions can be performed against servers on the Panel
|
// This also means mass actions can be performed against servers on the Panel
|
||||||
// and they will automatically sync with Wings when the server is started.
|
// and they will automatically sync with Wings when the server is started.
|
||||||
func (s *Server) Sync() error {
|
func (s *Server) Sync() error {
|
||||||
cfg, err := s.client.GetServerConfiguration(s.Context(), s.ID())
|
cfg, err := s.client.GetServerConfiguration(s.Context(), s.Id())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if err := remote.AsRequestError(err); err != nil && err.StatusCode() == http.StatusNotFound {
|
if err := remote.AsRequestError(err); err != nil && err.StatusCode() == http.StatusNotFound {
|
||||||
return &serverDoesNotExist{}
|
return &serverDoesNotExist{}
|
||||||
}
|
}
|
||||||
return errors.WithStackIf(err)
|
return errors.WithStackIf(err)
|
||||||
}
|
}
|
||||||
|
return s.SyncWithConfiguration(cfg)
|
||||||
if err := s.SyncWithConfiguration(cfg); err != nil {
|
|
||||||
return errors.WithStackIf(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Update the disk space limits for the server whenever the configuration for
|
|
||||||
// it changes.
|
|
||||||
s.fs.SetDiskLimit(s.DiskSpace())
|
|
||||||
|
|
||||||
s.SyncWithEnvironment()
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// SyncWithConfiguration accepts a configuration object for a server and will
|
|
||||||
// sync all of the values with the existing server state. This only replaces the
|
|
||||||
// existing configuration and process configuration for the server. The
|
|
||||||
// underlying environment will not be affected. This is because this function
|
|
||||||
// can be called from scoped where the server may not be fully initialized,
|
|
||||||
// therefore other things like the filesystem and environment may not exist yet.
|
|
||||||
func (s *Server) SyncWithConfiguration(cfg remote.ServerConfigurationResponse) error {
|
func (s *Server) SyncWithConfiguration(cfg remote.ServerConfigurationResponse) error {
|
||||||
c := Configuration{
|
// Update the data structure and persist it to the disk.
|
||||||
CrashDetectionEnabled: config.Get().System.CrashDetection.CrashDetectionEnabled,
|
if err := s.UpdateDataStructure(cfg.Settings); err != nil {
|
||||||
|
return err
|
||||||
}
|
}
|
||||||
if err := json.Unmarshal(cfg.Settings, &c); err != nil {
|
|
||||||
return errors.WithStackIf(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
s.cfg.mu.Lock()
|
|
||||||
defer s.cfg.mu.Unlock()
|
|
||||||
|
|
||||||
// Lock the new configuration. Since we have the deferred Unlock above we need
|
|
||||||
// to make sure that the NEW configuration object is already locked since that
|
|
||||||
// defer is running on the memory address for "s.cfg.mu" which we're explicitly
|
|
||||||
// changing on the next line.
|
|
||||||
c.mu.Lock()
|
|
||||||
|
|
||||||
//goland:noinspection GoVetCopyLock
|
|
||||||
s.cfg = c
|
|
||||||
|
|
||||||
s.Lock()
|
s.Lock()
|
||||||
s.procConfig = cfg.ProcessConfiguration
|
s.procConfig = cfg.ProcessConfiguration
|
||||||
s.Unlock()
|
s.Unlock()
|
||||||
|
|
||||||
|
// Update the disk space limits for the server whenever the configuration
|
||||||
|
// for it changes.
|
||||||
|
s.fs.SetDiskLimit(s.DiskSpace())
|
||||||
|
|
||||||
|
// If this is a Docker environment we need to sync the stop configuration with it so that
|
||||||
|
// the process isn't just terminated when a user requests it be stopped.
|
||||||
|
if e, ok := s.Environment.(*docker.Environment); ok {
|
||||||
|
s.Log().Debug("syncing stop configuration with configured docker environment")
|
||||||
|
e.SetImage(s.Config().Container.Image)
|
||||||
|
e.SetStopConfiguration(cfg.ProcessConfiguration.Stop)
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -239,6 +191,14 @@ func (s *Server) ReadLogfile(len int) ([]string, error) {
|
|||||||
return s.Environment.Readlog(len)
|
return s.Environment.Readlog(len)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Determine if the server is bootable in it's current state or not. This will not
|
||||||
|
// indicate why a server is not bootable, only if it is.
|
||||||
|
func (s *Server) IsBootable() bool {
|
||||||
|
exists, _ := s.Environment.Exists()
|
||||||
|
|
||||||
|
return exists
|
||||||
|
}
|
||||||
|
|
||||||
// Initializes a server instance. This will run through and ensure that the environment
|
// Initializes a server instance. This will run through and ensure that the environment
|
||||||
// for the server is setup, and that all of the necessary files are created.
|
// for the server is setup, and that all of the necessary files are created.
|
||||||
func (s *Server) CreateEnvironment() error {
|
func (s *Server) CreateEnvironment() error {
|
||||||
@@ -273,7 +233,7 @@ func (s *Server) EnsureDataDirectoryExists() error {
|
|||||||
if _, err := os.Lstat(s.fs.Path()); err != nil {
|
if _, err := os.Lstat(s.fs.Path()); err != nil {
|
||||||
if os.IsNotExist(err) {
|
if os.IsNotExist(err) {
|
||||||
s.Log().Debug("server: creating root directory and setting permissions")
|
s.Log().Debug("server: creating root directory and setting permissions")
|
||||||
if err := os.MkdirAll(s.fs.Path(), 0o700); err != nil {
|
if err := os.MkdirAll(s.fs.Path(), 0700); err != nil {
|
||||||
return errors.WithStack(err)
|
return errors.WithStack(err)
|
||||||
}
|
}
|
||||||
if err := s.fs.Chown("/"); err != nil {
|
if err := s.fs.Chown("/"); err != nil {
|
||||||
@@ -286,7 +246,7 @@ func (s *Server) EnsureDataDirectoryExists() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// OnStateChange sets the state of the server internally. This function handles crash detection as
|
// Sets the state of the server internally. This function handles crash detection as
|
||||||
// well as reporting to event listeners for the server.
|
// well as reporting to event listeners for the server.
|
||||||
func (s *Server) OnStateChange() {
|
func (s *Server) OnStateChange() {
|
||||||
prevState := s.resources.State.Load()
|
prevState := s.resources.State.Load()
|
||||||
@@ -301,11 +261,11 @@ func (s *Server) OnStateChange() {
|
|||||||
s.Events().Publish(StatusEvent, st)
|
s.Events().Publish(StatusEvent, st)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Reset the resource usage to 0 when the process fully stops so that all the UI
|
// Reset the resource usage to 0 when the process fully stops so that all of the UI
|
||||||
// views in the Panel correctly display 0.
|
// views in the Panel correctly display 0.
|
||||||
if st == environment.ProcessOfflineState {
|
if st == environment.ProcessOfflineState {
|
||||||
s.resources.Reset()
|
s.resources.Reset()
|
||||||
s.Events().Publish(StatsEvent, s.Proc())
|
s.emitProcUsage()
|
||||||
}
|
}
|
||||||
|
|
||||||
// If server was in an online state, and is now in an offline state we should handle
|
// If server was in an online state, and is now in an offline state we should handle
|
||||||
@@ -333,7 +293,7 @@ func (s *Server) OnStateChange() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// IsRunning determines if the server state is running or not. This is different
|
// IsRunning determines if the server state is running or not. This is different
|
||||||
// from the environment state, it is simply the tracked state from this daemon
|
// than the environment state, it is simply the tracked state from this daemon
|
||||||
// instance, and not the response from Docker.
|
// instance, and not the response from Docker.
|
||||||
func (s *Server) IsRunning() bool {
|
func (s *Server) IsRunning() bool {
|
||||||
st := s.Environment.State()
|
st := s.Environment.State()
|
||||||
|
|||||||
134
server/update.go
134
server/update.go
@@ -1,43 +1,127 @@
|
|||||||
package server
|
package server
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"time"
|
"encoding/json"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/environment/docker"
|
|
||||||
|
|
||||||
|
"emperror.dev/errors"
|
||||||
|
"github.com/buger/jsonparser"
|
||||||
|
"github.com/imdario/mergo"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
)
|
)
|
||||||
|
|
||||||
// SyncWithEnvironment updates the environment for the server to match any of
|
// UpdateDataStructure merges data passed through in JSON form into the existing
|
||||||
// the changed data. This pushes new settings and environment variables to the
|
// server object. Any changes to the build settings will apply immediately in
|
||||||
// environment. In addition, the in-situ update method is called on the
|
// the environment if the environment supports it.
|
||||||
// environment which will allow environments that make use of it (such as Docker)
|
|
||||||
// to immediately apply some settings without having to wait on a server to
|
|
||||||
// restart.
|
|
||||||
//
|
//
|
||||||
// This functionality allows a server's resources limits to be modified on the
|
// The server will be marked as requiring a rebuild on the next boot sequence,
|
||||||
// fly and have them apply right away allowing for dynamic resource allocation
|
// it is up to the specific environment to determine what needs to happen when
|
||||||
// and responses to abusive server processes.
|
// that is the case.
|
||||||
|
func (s *Server) UpdateDataStructure(data []byte) error {
|
||||||
|
src := new(Configuration)
|
||||||
|
if err := json.Unmarshal(data, src); err != nil {
|
||||||
|
return errors.Wrap(err, "server/update: could not unmarshal source data into Configuration struct")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Don't allow obviously corrupted data to pass through into this function. If the UUID
|
||||||
|
// doesn't match something has gone wrong and the API is attempting to meld this server
|
||||||
|
// instance into a totally different one, which would be bad.
|
||||||
|
if src.Uuid != "" && s.Id() != "" && src.Uuid != s.Id() {
|
||||||
|
return errors.New("server/update: attempting to merge a data stack with an invalid UUID")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Grab a copy of the configuration to work on.
|
||||||
|
c := *s.Config()
|
||||||
|
|
||||||
|
// Lock our copy of the configuration since the deferred unlock will end up acting upon this
|
||||||
|
// new memory address rather than the old one. If we don't lock this, the deferred unlock will
|
||||||
|
// cause a panic when it goes to run. However, since we only update s.cfg at the end, if there
|
||||||
|
// is an error before that point we'll still properly unlock the original configuration for the
|
||||||
|
// server.
|
||||||
|
c.mu.Lock()
|
||||||
|
|
||||||
|
// Lock the server configuration while we're doing this merge to avoid anything
|
||||||
|
// trying to overwrite it or make modifications while we're sorting out what we
|
||||||
|
// need to do.
|
||||||
|
s.cfg.mu.Lock()
|
||||||
|
defer s.cfg.mu.Unlock()
|
||||||
|
|
||||||
|
// Merge the new data object that we have received with the existing server data object
|
||||||
|
// and then save it to the disk so it is persistent.
|
||||||
|
if err := mergo.Merge(&c, src, mergo.WithOverride); err != nil {
|
||||||
|
return errors.WithStack(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Don't explode if we're setting CPU limits to 0. Mergo sees that as an empty value
|
||||||
|
// so it won't override the value we've passed through in the API call. However, we can
|
||||||
|
// safely assume that we're passing through valid data structures here. I foresee this
|
||||||
|
// backfiring at some point, but until then...
|
||||||
|
c.Build = src.Build
|
||||||
|
|
||||||
|
// Mergo can't quite handle this boolean value correctly, so for now we'll just
|
||||||
|
// handle this edge case manually since none of the other data passed through in this
|
||||||
|
// request is going to be boolean. Allegedly.
|
||||||
|
if v, err := jsonparser.GetBoolean(data, "container", "oom_disabled"); err != nil {
|
||||||
|
if err != jsonparser.KeyPathNotFoundError {
|
||||||
|
return errors.WithStack(err)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
c.Build.OOMDisabled = v
|
||||||
|
}
|
||||||
|
|
||||||
|
// Mergo also cannot handle this boolean value.
|
||||||
|
if v, err := jsonparser.GetBoolean(data, "suspended"); err != nil {
|
||||||
|
if err != jsonparser.KeyPathNotFoundError {
|
||||||
|
return errors.WithStack(err)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
c.Suspended = v
|
||||||
|
}
|
||||||
|
|
||||||
|
if v, err := jsonparser.GetBoolean(data, "skip_egg_scripts"); err != nil {
|
||||||
|
if err != jsonparser.KeyPathNotFoundError {
|
||||||
|
return errors.WithStack(err)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
c.SkipEggScripts = v
|
||||||
|
}
|
||||||
|
|
||||||
|
// Environment and Mappings should be treated as a full update at all times, never a
|
||||||
|
// true patch, otherwise we can't know what we're passing along.
|
||||||
|
if src.EnvVars != nil && len(src.EnvVars) > 0 {
|
||||||
|
c.EnvVars = src.EnvVars
|
||||||
|
}
|
||||||
|
|
||||||
|
if src.Allocations.Mappings != nil && len(src.Allocations.Mappings) > 0 {
|
||||||
|
c.Allocations.Mappings = src.Allocations.Mappings
|
||||||
|
}
|
||||||
|
|
||||||
|
if src.Mounts != nil && len(src.Mounts) > 0 {
|
||||||
|
c.Mounts = src.Mounts
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update the configuration once we have a lock on the configuration object.
|
||||||
|
s.cfg = c
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Updates the environment for the server to match any of the changed data. This pushes new settings and
|
||||||
|
// environment variables to the environment. In addition, the in-situ update method is called on the
|
||||||
|
// environment which will allow environments that make use of it (such as Docker) to immediately apply
|
||||||
|
// some settings without having to wait on a server to restart.
|
||||||
|
//
|
||||||
|
// This functionality allows a server's resources limits to be modified on the fly and have them apply
|
||||||
|
// right away allowing for dynamic resource allocation and responses to abusive server processes.
|
||||||
func (s *Server) SyncWithEnvironment() {
|
func (s *Server) SyncWithEnvironment() {
|
||||||
s.Log().Debug("syncing server settings with environment")
|
s.Log().Debug("syncing server settings with environment")
|
||||||
|
|
||||||
cfg := s.Config()
|
|
||||||
|
|
||||||
// Update the environment settings using the new information from this server.
|
// Update the environment settings using the new information from this server.
|
||||||
s.Environment.Config().SetSettings(environment.Settings{
|
s.Environment.Config().SetSettings(environment.Settings{
|
||||||
Mounts: s.Mounts(),
|
Mounts: s.Mounts(),
|
||||||
Allocations: cfg.Allocations,
|
Allocations: s.Config().Allocations,
|
||||||
Limits: cfg.Build,
|
Limits: s.Config().Build,
|
||||||
})
|
})
|
||||||
|
|
||||||
// For Docker specific environments we also want to update the configured image
|
|
||||||
// and stop configuration.
|
|
||||||
if e, ok := s.Environment.(*docker.Environment); ok {
|
|
||||||
s.Log().Debug("syncing stop configuration with configured docker environment")
|
|
||||||
e.SetImage(cfg.Container.Image)
|
|
||||||
e.SetStopConfiguration(s.ProcessConfiguration().Stop)
|
|
||||||
}
|
|
||||||
|
|
||||||
// If build limits are changed, environment variables also change. Plus, any modifications to
|
// If build limits are changed, environment variables also change. Plus, any modifications to
|
||||||
// the startup command also need to be properly propagated to this environment.
|
// the startup command also need to be properly propagated to this environment.
|
||||||
//
|
//
|
||||||
@@ -60,7 +144,7 @@ func (s *Server) SyncWithEnvironment() {
|
|||||||
s.Log().Info("server suspended with running process state, terminating now")
|
s.Log().Info("server suspended with running process state, terminating now")
|
||||||
|
|
||||||
go func(s *Server) {
|
go func(s *Server) {
|
||||||
if err := s.Environment.WaitForStop(s.Context(), time.Minute, true); err != nil {
|
if err := s.Environment.WaitForStop(60, true); err != nil {
|
||||||
s.Log().WithField("error", err).Warn("failed to terminate server environment after suspension")
|
s.Log().WithField("error", err).Warn("failed to terminate server environment after suspension")
|
||||||
}
|
}
|
||||||
}(s)
|
}(s)
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ type WebsocketBag struct {
|
|||||||
conns map[uuid.UUID]*context.CancelFunc
|
conns map[uuid.UUID]*context.CancelFunc
|
||||||
}
|
}
|
||||||
|
|
||||||
// Websockets returns the websocket bag which contains all the currently open websocket connections
|
// Returns the websocket bag which contains all of the currently open websocket connections
|
||||||
// for the server instance.
|
// for the server instance.
|
||||||
func (s *Server) Websockets() *WebsocketBag {
|
func (s *Server) Websockets() *WebsocketBag {
|
||||||
s.wsBagLocker.Lock()
|
s.wsBagLocker.Lock()
|
||||||
@@ -25,7 +25,7 @@ func (s *Server) Websockets() *WebsocketBag {
|
|||||||
return s.wsBag
|
return s.wsBag
|
||||||
}
|
}
|
||||||
|
|
||||||
// Push adds a new websocket connection to the end of the stack.
|
// Adds a new websocket connection to the stack.
|
||||||
func (w *WebsocketBag) Push(u uuid.UUID, cancel *context.CancelFunc) {
|
func (w *WebsocketBag) Push(u uuid.UUID, cancel *context.CancelFunc) {
|
||||||
w.mu.Lock()
|
w.mu.Lock()
|
||||||
defer w.mu.Unlock()
|
defer w.mu.Unlock()
|
||||||
@@ -37,22 +37,23 @@ func (w *WebsocketBag) Push(u uuid.UUID, cancel *context.CancelFunc) {
|
|||||||
w.conns[u] = cancel
|
w.conns[u] = cancel
|
||||||
}
|
}
|
||||||
|
|
||||||
// Remove removes a connection from the stack.
|
// Removes a connection from the stack.
|
||||||
func (w *WebsocketBag) Remove(u uuid.UUID) {
|
func (w *WebsocketBag) Remove(u uuid.UUID) {
|
||||||
w.mu.Lock()
|
w.mu.Lock()
|
||||||
delete(w.conns, u)
|
delete(w.conns, u)
|
||||||
w.mu.Unlock()
|
w.mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
// CancelAll cancels all the stored cancel functions which has the effect of
|
// Cancels all of the stored cancel functions which has the effect of disconnecting
|
||||||
// disconnecting every listening websocket for the server.
|
// every listening websocket for the server.
|
||||||
func (w *WebsocketBag) CancelAll() {
|
func (w *WebsocketBag) CancelAll() {
|
||||||
w.mu.Lock()
|
w.mu.Lock()
|
||||||
defer w.mu.Unlock()
|
w.mu.Unlock()
|
||||||
|
|
||||||
if w.conns != nil {
|
if w.conns != nil {
|
||||||
for _, cancel := range w.conns {
|
for _, cancel := range w.conns {
|
||||||
(*cancel)()
|
c := *cancel
|
||||||
|
c()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,58 +0,0 @@
|
|||||||
package sftp
|
|
||||||
|
|
||||||
import (
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/apex/log"
|
|
||||||
"github.com/pterodactyl/wings/internal/database"
|
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
|
||||||
)
|
|
||||||
|
|
||||||
type eventHandler struct {
|
|
||||||
ip string
|
|
||||||
user string
|
|
||||||
server string
|
|
||||||
}
|
|
||||||
|
|
||||||
type FileAction struct {
|
|
||||||
// Entity is the targeted file or directory (depending on the event) that the action
|
|
||||||
// is being performed _against_, such as "/foo/test.txt". This will always be the full
|
|
||||||
// path to the element.
|
|
||||||
Entity string
|
|
||||||
// Target is an optional (often blank) field that only has a value in it when the event
|
|
||||||
// is specifically modifying the entity, such as a rename or move event. In that case
|
|
||||||
// the Target field will be the final value, such as "/bar/new.txt"
|
|
||||||
Target string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Log parses a SFTP specific file activity event and then passes it off to be stored
|
|
||||||
// in the normal activity database.
|
|
||||||
func (eh *eventHandler) Log(e models.Event, fa FileAction) error {
|
|
||||||
metadata := map[string]interface{}{
|
|
||||||
"files": []string{fa.Entity},
|
|
||||||
}
|
|
||||||
if fa.Target != "" {
|
|
||||||
metadata["files"] = []map[string]string{
|
|
||||||
{"from": fa.Entity, "to": fa.Target},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
a := models.Activity{
|
|
||||||
Server: eh.server,
|
|
||||||
Event: e,
|
|
||||||
Metadata: metadata,
|
|
||||||
IP: eh.ip,
|
|
||||||
}
|
|
||||||
|
|
||||||
if tx := database.Instance().Create(a.SetUser(eh.user)); tx.Error != nil {
|
|
||||||
return errors.Wrap(tx.Error, "sftp: failed to save event to database")
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// MustLog is a wrapper around log that will trigger a fatal error and exit the application
|
|
||||||
// if an error is encountered during the logging of the event.
|
|
||||||
func (eh *eventHandler) MustLog(e models.Event, fa FileAction) {
|
|
||||||
if err := eh.Log(e, fa); err != nil {
|
|
||||||
log.WithField("error", err).Fatal("sftp: failed to log event")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -11,11 +11,9 @@ import (
|
|||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/pkg/sftp"
|
"github.com/pkg/sftp"
|
||||||
"golang.org/x/crypto/ssh"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/server"
|
|
||||||
"github.com/pterodactyl/wings/server/filesystem"
|
"github.com/pterodactyl/wings/server/filesystem"
|
||||||
|
"golang.org/x/crypto/ssh"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -27,40 +25,29 @@ const (
|
|||||||
)
|
)
|
||||||
|
|
||||||
type Handler struct {
|
type Handler struct {
|
||||||
mu sync.Mutex
|
|
||||||
server *server.Server
|
|
||||||
fs *filesystem.Filesystem
|
|
||||||
events *eventHandler
|
|
||||||
permissions []string
|
permissions []string
|
||||||
|
mu sync.Mutex
|
||||||
|
fs *filesystem.Filesystem
|
||||||
logger *log.Entry
|
logger *log.Entry
|
||||||
ro bool
|
ro bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewHandler returns a new connection handler for the SFTP server. This allows a given user
|
// Returns a new connection handler for the SFTP server. This allows a given user
|
||||||
// to access the underlying filesystem.
|
// to access the underlying filesystem.
|
||||||
func NewHandler(sc *ssh.ServerConn, srv *server.Server) (*Handler, error) {
|
func NewHandler(sc *ssh.ServerConn, fs *filesystem.Filesystem) *Handler {
|
||||||
uuid, ok := sc.Permissions.Extensions["user"]
|
|
||||||
if !ok {
|
|
||||||
return nil, errors.New("sftp: mismatched Wings and Panel versions — Panel 1.10 is required for this version of Wings.")
|
|
||||||
}
|
|
||||||
|
|
||||||
events := eventHandler{
|
|
||||||
ip: sc.RemoteAddr().String(),
|
|
||||||
user: uuid,
|
|
||||||
server: srv.ID(),
|
|
||||||
}
|
|
||||||
|
|
||||||
return &Handler{
|
return &Handler{
|
||||||
permissions: strings.Split(sc.Permissions.Extensions["permissions"], ","),
|
fs: fs,
|
||||||
server: srv,
|
|
||||||
fs: srv.Filesystem(),
|
|
||||||
events: &events,
|
|
||||||
ro: config.Get().System.Sftp.ReadOnly,
|
ro: config.Get().System.Sftp.ReadOnly,
|
||||||
logger: log.WithFields(log.Fields{"subsystem": "sftp", "user": uuid, "ip": sc.RemoteAddr()}),
|
permissions: strings.Split(sc.Permissions.Extensions["permissions"], ","),
|
||||||
}, nil
|
logger: log.WithFields(log.Fields{
|
||||||
|
"subsystem": "sftp",
|
||||||
|
"username": sc.User(),
|
||||||
|
"ip": sc.RemoteAddr(),
|
||||||
|
}),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Handlers returns the sftp.Handlers for this struct.
|
// Returns the sftp.Handlers for this struct.
|
||||||
func (h *Handler) Handlers() sftp.Handlers {
|
func (h *Handler) Handlers() sftp.Handlers {
|
||||||
return sftp.Handlers{
|
return sftp.Handlers{
|
||||||
FileGet: h,
|
FileGet: h,
|
||||||
@@ -127,14 +114,6 @@ func (h *Handler) Filewrite(request *sftp.Request) (io.WriterAt, error) {
|
|||||||
l.WithField("flags", request.Flags).WithField("error", err).Error("failed to open existing file on system")
|
l.WithField("flags", request.Flags).WithField("error", err).Error("failed to open existing file on system")
|
||||||
return nil, sftp.ErrSSHFxFailure
|
return nil, sftp.ErrSSHFxFailure
|
||||||
}
|
}
|
||||||
// Chown may or may not have been called in the touch function, so always do
|
|
||||||
// it at this point to avoid the file being improperly owned.
|
|
||||||
_ = h.fs.Chown(request.Filepath)
|
|
||||||
event := server.ActivitySftpWrite
|
|
||||||
if permission == PermissionFileCreate {
|
|
||||||
event = server.ActivitySftpCreate
|
|
||||||
}
|
|
||||||
h.events.MustLog(event, FileAction{Entity: request.Filepath})
|
|
||||||
return f, nil
|
return f, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -158,12 +137,12 @@ func (h *Handler) Filecmd(request *sftp.Request) error {
|
|||||||
}
|
}
|
||||||
mode := request.Attributes().FileMode().Perm()
|
mode := request.Attributes().FileMode().Perm()
|
||||||
// If the client passes an invalid FileMode just use the default 0644.
|
// If the client passes an invalid FileMode just use the default 0644.
|
||||||
if mode == 0o000 {
|
if mode == 0000 {
|
||||||
mode = os.FileMode(0o644)
|
mode = os.FileMode(0644)
|
||||||
}
|
}
|
||||||
// Force directories to be 0755.
|
// Force directories to be 0755.
|
||||||
if request.Attributes().FileMode().IsDir() {
|
if request.Attributes().FileMode().IsDir() {
|
||||||
mode = 0o755
|
mode = 0755
|
||||||
}
|
}
|
||||||
if err := h.fs.Chmod(request.Filepath, mode); err != nil {
|
if err := h.fs.Chmod(request.Filepath, mode); err != nil {
|
||||||
if errors.Is(err, os.ErrNotExist) {
|
if errors.Is(err, os.ErrNotExist) {
|
||||||
@@ -185,7 +164,6 @@ func (h *Handler) Filecmd(request *sftp.Request) error {
|
|||||||
l.WithField("error", err).Error("failed to rename file")
|
l.WithField("error", err).Error("failed to rename file")
|
||||||
return sftp.ErrSSHFxFailure
|
return sftp.ErrSSHFxFailure
|
||||||
}
|
}
|
||||||
h.events.MustLog(server.ActivitySftpRename, FileAction{Entity: request.Filepath, Target: request.Target})
|
|
||||||
break
|
break
|
||||||
// Handle deletion of a directory. This will properly delete all of the files and
|
// Handle deletion of a directory. This will properly delete all of the files and
|
||||||
// folders within that directory if it is not already empty (unlike a lot of SFTP
|
// folders within that directory if it is not already empty (unlike a lot of SFTP
|
||||||
@@ -194,12 +172,10 @@ func (h *Handler) Filecmd(request *sftp.Request) error {
|
|||||||
if !h.can(PermissionFileDelete) {
|
if !h.can(PermissionFileDelete) {
|
||||||
return sftp.ErrSSHFxPermissionDenied
|
return sftp.ErrSSHFxPermissionDenied
|
||||||
}
|
}
|
||||||
p := filepath.Clean(request.Filepath)
|
if err := h.fs.Delete(request.Filepath); err != nil {
|
||||||
if err := h.fs.Delete(p); err != nil {
|
|
||||||
l.WithField("error", err).Error("failed to remove directory")
|
l.WithField("error", err).Error("failed to remove directory")
|
||||||
return sftp.ErrSSHFxFailure
|
return sftp.ErrSSHFxFailure
|
||||||
}
|
}
|
||||||
h.events.MustLog(server.ActivitySftpDelete, FileAction{Entity: request.Filepath})
|
|
||||||
return sftp.ErrSSHFxOk
|
return sftp.ErrSSHFxOk
|
||||||
// Handle requests to create a new Directory.
|
// Handle requests to create a new Directory.
|
||||||
case "Mkdir":
|
case "Mkdir":
|
||||||
@@ -207,12 +183,11 @@ func (h *Handler) Filecmd(request *sftp.Request) error {
|
|||||||
return sftp.ErrSSHFxPermissionDenied
|
return sftp.ErrSSHFxPermissionDenied
|
||||||
}
|
}
|
||||||
name := strings.Split(filepath.Clean(request.Filepath), "/")
|
name := strings.Split(filepath.Clean(request.Filepath), "/")
|
||||||
p := strings.Join(name[0:len(name)-1], "/")
|
err := h.fs.CreateDirectory(name[len(name)-1], strings.Join(name[0:len(name)-1], "/"))
|
||||||
if err := h.fs.CreateDirectory(name[len(name)-1], p); err != nil {
|
if err != nil {
|
||||||
l.WithField("error", err).Error("failed to create directory")
|
l.WithField("error", err).Error("failed to create directory")
|
||||||
return sftp.ErrSSHFxFailure
|
return sftp.ErrSSHFxFailure
|
||||||
}
|
}
|
||||||
h.events.MustLog(server.ActivitySftpCreateDirectory, FileAction{Entity: request.Filepath})
|
|
||||||
break
|
break
|
||||||
// Support creating symlinks between files. The source and target must resolve within
|
// Support creating symlinks between files. The source and target must resolve within
|
||||||
// the server home directory.
|
// the server home directory.
|
||||||
@@ -245,7 +220,6 @@ func (h *Handler) Filecmd(request *sftp.Request) error {
|
|||||||
l.WithField("error", err).Error("failed to remove a file")
|
l.WithField("error", err).Error("failed to remove a file")
|
||||||
return sftp.ErrSSHFxFailure
|
return sftp.ErrSSHFxFailure
|
||||||
}
|
}
|
||||||
h.events.MustLog(server.ActivitySftpDelete, FileAction{Entity: request.Filepath})
|
|
||||||
return sftp.ErrSSHFxOk
|
return sftp.ErrSSHFxOk
|
||||||
default:
|
default:
|
||||||
return sftp.ErrSSHFxOpUnsupported
|
return sftp.ErrSSHFxOpUnsupported
|
||||||
@@ -281,6 +255,7 @@ func (h *Handler) Filelist(request *sftp.Request) (sftp.ListerAt, error) {
|
|||||||
files, err := ioutil.ReadDir(p)
|
files, err := ioutil.ReadDir(p)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
h.logger.WithField("source", request.Filepath).WithField("error", err).Error("error while listing directory")
|
h.logger.WithField("source", request.Filepath).WithField("error", err).Error("error while listing directory")
|
||||||
|
|
||||||
return nil, sftp.ErrSSHFxFailure
|
return nil, sftp.ErrSSHFxFailure
|
||||||
}
|
}
|
||||||
return ListerAt(files), nil
|
return ListerAt(files), nil
|
||||||
@@ -302,13 +277,14 @@ func (h *Handler) Filelist(request *sftp.Request) (sftp.ListerAt, error) {
|
|||||||
// Determines if a user has permission to perform a specific action on the SFTP server. These
|
// Determines if a user has permission to perform a specific action on the SFTP server. These
|
||||||
// permissions are defined and returned by the Panel API.
|
// permissions are defined and returned by the Panel API.
|
||||||
func (h *Handler) can(permission string) bool {
|
func (h *Handler) can(permission string) bool {
|
||||||
if h.server.IsSuspended() {
|
// SFTPServer owners and super admins have their permissions returned as '[*]' via the Panel
|
||||||
return false
|
// API, so for the sake of speed do an initial check for that before iterating over the
|
||||||
|
// entire array of permissions.
|
||||||
|
if len(h.permissions) == 1 && h.permissions[0] == "*" {
|
||||||
|
return true
|
||||||
}
|
}
|
||||||
for _, p := range h.permissions {
|
for _, p := range h.permissions {
|
||||||
// If we match the permission specifically, or the user has been granted the "*"
|
if p == permission {
|
||||||
// permission because they're an admin, let them through.
|
|
||||||
if p == permission || p == "*" {
|
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
105
sftp/server.go
105
sftp/server.go
@@ -3,9 +3,11 @@ package sftp
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"crypto/rand"
|
"crypto/rand"
|
||||||
|
"crypto/rsa"
|
||||||
"crypto/x509"
|
"crypto/x509"
|
||||||
"encoding/pem"
|
"encoding/pem"
|
||||||
"io"
|
"io"
|
||||||
|
"io/ioutil"
|
||||||
"net"
|
"net"
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
@@ -16,12 +18,10 @@ import (
|
|||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/pkg/sftp"
|
"github.com/pkg/sftp"
|
||||||
"golang.org/x/crypto/ed25519"
|
|
||||||
"golang.org/x/crypto/ssh"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
|
"golang.org/x/crypto/ssh"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Usernames all follow the same format, so don't even bother hitting the API if the username is not
|
// Usernames all follow the same format, so don't even bother hitting the API if the username is not
|
||||||
@@ -47,20 +47,18 @@ func New(m *server.Manager) *SFTPServer {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Run starts the SFTP server and add a persistent listener to handle inbound
|
// Starts the SFTP server and add a persistent listener to handle inbound SFTP connections.
|
||||||
// SFTP connections. This will automatically generate an ED25519 key if one does
|
|
||||||
// not already exist on the system for host key verification purposes.
|
|
||||||
func (c *SFTPServer) Run() error {
|
func (c *SFTPServer) Run() error {
|
||||||
if _, err := os.Stat(c.PrivateKeyPath()); os.IsNotExist(err) {
|
if _, err := os.Stat(path.Join(c.BasePath, ".sftp/id_rsa")); os.IsNotExist(err) {
|
||||||
if err := c.generateED25519PrivateKey(); err != nil {
|
if err := c.generatePrivateKey(); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
} else if err != nil {
|
} else if err != nil {
|
||||||
return errors.Wrap(err, "sftp: could not stat private key file")
|
return errors.Wrap(err, "sftp/server: could not stat private key file")
|
||||||
}
|
}
|
||||||
pb, err := os.ReadFile(c.PrivateKeyPath())
|
pb, err := ioutil.ReadFile(path.Join(c.BasePath, ".sftp/id_rsa"))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.Wrap(err, "sftp: could not read private key file")
|
return errors.Wrap(err, "sftp/server: could not read private key file")
|
||||||
}
|
}
|
||||||
private, err := ssh.ParsePrivateKey(pb)
|
private, err := ssh.ParsePrivateKey(pb)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -70,12 +68,7 @@ func (c *SFTPServer) Run() error {
|
|||||||
conf := &ssh.ServerConfig{
|
conf := &ssh.ServerConfig{
|
||||||
NoClientAuth: false,
|
NoClientAuth: false,
|
||||||
MaxAuthTries: 6,
|
MaxAuthTries: 6,
|
||||||
PasswordCallback: func(conn ssh.ConnMetadata, password []byte) (*ssh.Permissions, error) {
|
PasswordCallback: c.passwordCallback,
|
||||||
return c.makeCredentialsRequest(conn, remote.SftpAuthPassword, string(password))
|
|
||||||
},
|
|
||||||
PublicKeyCallback: func(conn ssh.ConnMetadata, key ssh.PublicKey) (*ssh.Permissions, error) {
|
|
||||||
return c.makeCredentialsRequest(conn, remote.SftpAuthPublicKey, string(ssh.MarshalAuthorizedKey(key)))
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
conf.AddHostKey(private)
|
conf.AddHostKey(private)
|
||||||
|
|
||||||
@@ -84,28 +77,24 @@ func (c *SFTPServer) Run() error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
public := string(ssh.MarshalAuthorizedKey(private.PublicKey()))
|
log.WithField("listen", c.Listen).Info("sftp server listening for connections")
|
||||||
log.WithField("listen", c.Listen).WithField("public_key", strings.Trim(public, "\n")).Info("sftp server listening for connections")
|
|
||||||
|
|
||||||
for {
|
for {
|
||||||
if conn, _ := listener.Accept(); conn != nil {
|
if conn, _ := listener.Accept(); conn != nil {
|
||||||
go func(conn net.Conn) {
|
go func(conn net.Conn) {
|
||||||
defer conn.Close()
|
defer conn.Close()
|
||||||
if err := c.AcceptInbound(conn, conf); err != nil {
|
c.AcceptInbound(conn, conf)
|
||||||
log.WithField("error", err).Error("sftp: failed to accept inbound connection")
|
|
||||||
}
|
|
||||||
}(conn)
|
}(conn)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// AcceptInbound handles an inbound connection to the instance and determines if we should
|
// Handles an inbound connection to the instance and determines if we should serve the
|
||||||
// serve the request or not.
|
// request or not.
|
||||||
func (c *SFTPServer) AcceptInbound(conn net.Conn, config *ssh.ServerConfig) error {
|
func (c *SFTPServer) AcceptInbound(conn net.Conn, config *ssh.ServerConfig) {
|
||||||
// Before beginning a handshake must be performed on the incoming net.Conn
|
// Before beginning a handshake must be performed on the incoming net.Conn
|
||||||
sconn, chans, reqs, err := ssh.NewServerConn(conn, config)
|
sconn, chans, reqs, err := ssh.NewServerConn(conn, config)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.WithStack(err)
|
return
|
||||||
}
|
}
|
||||||
defer sconn.Close()
|
defer sconn.Close()
|
||||||
go ssh.DiscardRequests(reqs)
|
go ssh.DiscardRequests(reqs)
|
||||||
@@ -143,7 +132,7 @@ func (c *SFTPServer) AcceptInbound(conn net.Conn, config *ssh.ServerConfig) erro
|
|||||||
if uuid == "" {
|
if uuid == "" {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
return s.ID() == uuid
|
return s.Id() == uuid
|
||||||
})
|
})
|
||||||
if srv == nil {
|
if srv == nil {
|
||||||
continue
|
continue
|
||||||
@@ -151,56 +140,46 @@ func (c *SFTPServer) AcceptInbound(conn net.Conn, config *ssh.ServerConfig) erro
|
|||||||
|
|
||||||
// Spin up a SFTP server instance for the authenticated user's server allowing
|
// Spin up a SFTP server instance for the authenticated user's server allowing
|
||||||
// them access to the underlying filesystem.
|
// them access to the underlying filesystem.
|
||||||
handler, err := NewHandler(sconn, srv)
|
handler := sftp.NewRequestServer(channel, NewHandler(sconn, srv.Filesystem()).Handlers())
|
||||||
if err != nil {
|
if err := handler.Serve(); err == io.EOF {
|
||||||
return errors.WithStackIf(err)
|
handler.Close()
|
||||||
}
|
|
||||||
rs := sftp.NewRequestServer(channel, handler.Handlers())
|
|
||||||
if err := rs.Serve(); err == io.EOF {
|
|
||||||
_ = rs.Close()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Generates a new ED25519 private key that is used for host authentication when
|
// Generates a private key that will be used by the SFTP server.
|
||||||
// a user connects to the SFTP server.
|
func (c *SFTPServer) generatePrivateKey() error {
|
||||||
func (c *SFTPServer) generateED25519PrivateKey() error {
|
key, err := rsa.GenerateKey(rand.Reader, 2048)
|
||||||
_, priv, err := ed25519.GenerateKey(rand.Reader)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.Wrap(err, "sftp: failed to generate ED25519 private key")
|
return errors.WithStack(err)
|
||||||
}
|
}
|
||||||
if err := os.MkdirAll(path.Dir(c.PrivateKeyPath()), 0o755); err != nil {
|
if err := os.MkdirAll(path.Join(c.BasePath, ".sftp"), 0755); err != nil {
|
||||||
return errors.Wrap(err, "sftp: could not create internal sftp data directory")
|
return errors.Wrap(err, "sftp/server: could not create .sftp directory")
|
||||||
}
|
}
|
||||||
o, err := os.OpenFile(c.PrivateKeyPath(), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0o600)
|
o, err := os.OpenFile(path.Join(c.BasePath, ".sftp/id_rsa"), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.WithStack(err)
|
return errors.WithStack(err)
|
||||||
}
|
}
|
||||||
defer o.Close()
|
defer o.Close()
|
||||||
|
|
||||||
b, err := x509.MarshalPKCS8PrivateKey(priv)
|
err = pem.Encode(o, &pem.Block{
|
||||||
if err != nil {
|
Type: "RSA PRIVATE KEY",
|
||||||
return errors.Wrap(err, "sftp: failed to marshal private key into bytes")
|
Bytes: x509.MarshalPKCS1PrivateKey(key),
|
||||||
}
|
})
|
||||||
if err := pem.Encode(o, &pem.Block{Type: "PRIVATE KEY", Bytes: b}); err != nil {
|
return errors.WithStack(err)
|
||||||
return errors.Wrap(err, "sftp: failed to write ED25519 private key to disk")
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *SFTPServer) makeCredentialsRequest(conn ssh.ConnMetadata, t remote.SftpAuthRequestType, p string) (*ssh.Permissions, error) {
|
// A function capable of validating user credentials with the Panel API.
|
||||||
|
func (c *SFTPServer) passwordCallback(conn ssh.ConnMetadata, pass []byte) (*ssh.Permissions, error) {
|
||||||
request := remote.SftpAuthRequest{
|
request := remote.SftpAuthRequest{
|
||||||
Type: t,
|
|
||||||
User: conn.User(),
|
User: conn.User(),
|
||||||
Pass: p,
|
Pass: string(pass),
|
||||||
IP: conn.RemoteAddr().String(),
|
IP: conn.RemoteAddr().String(),
|
||||||
SessionID: conn.SessionID(),
|
SessionID: conn.SessionID(),
|
||||||
ClientVersion: conn.ClientVersion(),
|
ClientVersion: conn.ClientVersion(),
|
||||||
}
|
}
|
||||||
|
|
||||||
logger := log.WithFields(log.Fields{"subsystem": "sftp", "method": request.Type, "username": request.User, "ip": request.IP})
|
logger := log.WithFields(log.Fields{"subsystem": "sftp", "username": conn.User(), "ip": conn.RemoteAddr().String()})
|
||||||
logger.Debug("validating credentials for SFTP connection")
|
logger.Debug("validating credentials for SFTP connection")
|
||||||
|
|
||||||
if !validUsernameRegexp.MatchString(request.User) {
|
if !validUsernameRegexp.MatchString(request.User) {
|
||||||
@@ -219,19 +198,13 @@ func (c *SFTPServer) makeCredentialsRequest(conn ssh.ConnMetadata, t remote.Sftp
|
|||||||
}
|
}
|
||||||
|
|
||||||
logger.WithField("server", resp.Server).Debug("credentials validated and matched to server instance")
|
logger.WithField("server", resp.Server).Debug("credentials validated and matched to server instance")
|
||||||
permissions := ssh.Permissions{
|
sshPerm := &ssh.Permissions{
|
||||||
Extensions: map[string]string{
|
Extensions: map[string]string{
|
||||||
"ip": conn.RemoteAddr().String(),
|
|
||||||
"uuid": resp.Server,
|
"uuid": resp.Server,
|
||||||
"user": resp.User,
|
"user": conn.User(),
|
||||||
"permissions": strings.Join(resp.Permissions, ","),
|
"permissions": strings.Join(resp.Permissions, ","),
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
return &permissions, nil
|
return sshPerm, nil
|
||||||
}
|
|
||||||
|
|
||||||
// PrivateKeyPath returns the path the host private key for this server instance.
|
|
||||||
func (c *SFTPServer) PrivateKeyPath() string {
|
|
||||||
return path.Join(c.BasePath, ".sftp/id_ed25519")
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,15 +6,15 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// ErrSSHQuotaExceeded extends the default SFTP server to return a quota exceeded error to the client.
|
// Extends the default SFTP server to return a quota exceeded error to the client.
|
||||||
//
|
//
|
||||||
// @see https://tools.ietf.org/id/draft-ietf-secsh-filexfer-13.txt
|
// @see https://tools.ietf.org/id/draft-ietf-secsh-filexfer-13.txt
|
||||||
ErrSSHQuotaExceeded = fxErr(15)
|
ErrSSHQuotaExceeded = fxerr(15)
|
||||||
)
|
)
|
||||||
|
|
||||||
type ListerAt []os.FileInfo
|
type ListerAt []os.FileInfo
|
||||||
|
|
||||||
// ListAt returns the number of entries copied and an io.EOF error if we made it to the end of the file list.
|
// Returns the number of entries copied and an io.EOF error if we made it to the end of the file list.
|
||||||
// Take a look at the pkg/sftp godoc for more information about how this function should work.
|
// Take a look at the pkg/sftp godoc for more information about how this function should work.
|
||||||
func (l ListerAt) ListAt(f []os.FileInfo, offset int64) (int, error) {
|
func (l ListerAt) ListAt(f []os.FileInfo, offset int64) (int, error) {
|
||||||
if offset >= int64(len(l)) {
|
if offset >= int64(len(l)) {
|
||||||
@@ -28,9 +28,9 @@ func (l ListerAt) ListAt(f []os.FileInfo, offset int64) (int, error) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
type fxErr uint32
|
type fxerr uint32
|
||||||
|
|
||||||
func (e fxErr) Error() string {
|
func (e fxerr) Error() string {
|
||||||
switch e {
|
switch e {
|
||||||
case ErrSSHQuotaExceeded:
|
case ErrSSHQuotaExceeded:
|
||||||
return "Quota Exceeded"
|
return "Quota Exceeded"
|
||||||
|
|||||||
@@ -1,3 +1,6 @@
|
|||||||
package system
|
package system
|
||||||
|
|
||||||
var Version = "develop"
|
var (
|
||||||
|
// The current version of this software.
|
||||||
|
Version = "0.0.1"
|
||||||
|
)
|
||||||
|
|||||||
@@ -1,84 +0,0 @@
|
|||||||
package system
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"sync"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
|
||||||
)
|
|
||||||
|
|
||||||
var ErrLockerLocked = errors.Sentinel("locker: cannot acquire lock, already locked")
|
|
||||||
|
|
||||||
type Locker struct {
|
|
||||||
mu sync.RWMutex
|
|
||||||
ch chan bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewLocker returns a new Locker instance.
|
|
||||||
func NewLocker() *Locker {
|
|
||||||
return &Locker{
|
|
||||||
ch: make(chan bool, 1),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsLocked returns the current state of the locker channel. If there is
|
|
||||||
// currently a value in the channel, it is assumed to be locked.
|
|
||||||
func (l *Locker) IsLocked() bool {
|
|
||||||
l.mu.RLock()
|
|
||||||
defer l.mu.RUnlock()
|
|
||||||
return len(l.ch) == 1
|
|
||||||
}
|
|
||||||
|
|
||||||
// Acquire will acquire the power lock if it is not currently locked. If it is
|
|
||||||
// already locked, acquire will fail to acquire the lock, and will return false.
|
|
||||||
func (l *Locker) Acquire() error {
|
|
||||||
l.mu.Lock()
|
|
||||||
defer l.mu.Unlock()
|
|
||||||
select {
|
|
||||||
case l.ch <- true:
|
|
||||||
default:
|
|
||||||
return ErrLockerLocked
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// TryAcquire will attempt to acquire a power-lock until the context provided
|
|
||||||
// is canceled.
|
|
||||||
func (l *Locker) TryAcquire(ctx context.Context) error {
|
|
||||||
select {
|
|
||||||
case l.ch <- true:
|
|
||||||
return nil
|
|
||||||
case <-ctx.Done():
|
|
||||||
if err := ctx.Err(); err != nil {
|
|
||||||
if errors.Is(err, context.DeadlineExceeded) || errors.Is(err, context.Canceled) {
|
|
||||||
return ErrLockerLocked
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Release will drain the locker channel so that we can properly re-acquire it
|
|
||||||
// at a later time. If the channel is not currently locked this function is a
|
|
||||||
// no-op and will immediately return.
|
|
||||||
func (l *Locker) Release() {
|
|
||||||
l.mu.Lock()
|
|
||||||
select {
|
|
||||||
case <-l.ch:
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
l.mu.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Destroy cleans up the power locker by closing the channel.
|
|
||||||
func (l *Locker) Destroy() {
|
|
||||||
l.mu.Lock()
|
|
||||||
if l.ch != nil {
|
|
||||||
select {
|
|
||||||
case <-l.ch:
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
close(l.ch)
|
|
||||||
}
|
|
||||||
l.mu.Unlock()
|
|
||||||
}
|
|
||||||
@@ -1,148 +0,0 @@
|
|||||||
package system
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
|
||||||
. "github.com/franela/goblin"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestPower(t *testing.T) {
|
|
||||||
g := Goblin(t)
|
|
||||||
|
|
||||||
g.Describe("Locker", func() {
|
|
||||||
var l *Locker
|
|
||||||
g.BeforeEach(func() {
|
|
||||||
l = NewLocker()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.Describe("PowerLocker#IsLocked", func() {
|
|
||||||
g.It("should return false when the channel is empty", func() {
|
|
||||||
g.Assert(cap(l.ch)).Equal(1)
|
|
||||||
g.Assert(l.IsLocked()).IsFalse()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("should return true when the channel is at capacity", func() {
|
|
||||||
l.ch <- true
|
|
||||||
|
|
||||||
g.Assert(l.IsLocked()).IsTrue()
|
|
||||||
<-l.ch
|
|
||||||
g.Assert(l.IsLocked()).IsFalse()
|
|
||||||
|
|
||||||
// We don't care what the channel value is, just that there is
|
|
||||||
// something in it.
|
|
||||||
l.ch <- false
|
|
||||||
g.Assert(l.IsLocked()).IsTrue()
|
|
||||||
g.Assert(cap(l.ch)).Equal(1)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
g.Describe("PowerLocker#Acquire", func() {
|
|
||||||
g.It("should acquire a lock when channel is empty", func() {
|
|
||||||
err := l.Acquire()
|
|
||||||
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
g.Assert(cap(l.ch)).Equal(1)
|
|
||||||
g.Assert(len(l.ch)).Equal(1)
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("should return an error when the channel is full", func() {
|
|
||||||
l.ch <- true
|
|
||||||
|
|
||||||
err := l.Acquire()
|
|
||||||
|
|
||||||
g.Assert(err).IsNotNil()
|
|
||||||
g.Assert(errors.Is(err, ErrLockerLocked)).IsTrue()
|
|
||||||
g.Assert(cap(l.ch)).Equal(1)
|
|
||||||
g.Assert(len(l.ch)).Equal(1)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
g.Describe("PowerLocker#TryAcquire", func() {
|
|
||||||
g.It("should acquire a lock when channel is empty", func() {
|
|
||||||
g.Timeout(time.Second)
|
|
||||||
|
|
||||||
err := l.TryAcquire(context.Background())
|
|
||||||
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
g.Assert(cap(l.ch)).Equal(1)
|
|
||||||
g.Assert(len(l.ch)).Equal(1)
|
|
||||||
g.Assert(l.IsLocked()).IsTrue()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("should block until context is canceled if channel is full", func() {
|
|
||||||
g.Timeout(time.Second)
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*500)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
l.ch <- true
|
|
||||||
err := l.TryAcquire(ctx)
|
|
||||||
|
|
||||||
g.Assert(err).IsNotNil()
|
|
||||||
g.Assert(errors.Is(err, ErrLockerLocked)).IsTrue()
|
|
||||||
g.Assert(cap(l.ch)).Equal(1)
|
|
||||||
g.Assert(len(l.ch)).Equal(1)
|
|
||||||
g.Assert(l.IsLocked()).IsTrue()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("should block until lock can be acquired", func() {
|
|
||||||
g.Timeout(time.Second)
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*200)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
l.Acquire()
|
|
||||||
go func() {
|
|
||||||
time.AfterFunc(time.Millisecond*50, func() {
|
|
||||||
l.Release()
|
|
||||||
})
|
|
||||||
}()
|
|
||||||
|
|
||||||
err := l.TryAcquire(ctx)
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
g.Assert(cap(l.ch)).Equal(1)
|
|
||||||
g.Assert(len(l.ch)).Equal(1)
|
|
||||||
g.Assert(l.IsLocked()).IsTrue()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
g.Describe("PowerLocker#Release", func() {
|
|
||||||
g.It("should release when channel is full", func() {
|
|
||||||
l.Acquire()
|
|
||||||
g.Assert(l.IsLocked()).IsTrue()
|
|
||||||
l.Release()
|
|
||||||
g.Assert(cap(l.ch)).Equal(1)
|
|
||||||
g.Assert(len(l.ch)).Equal(0)
|
|
||||||
g.Assert(l.IsLocked()).IsFalse()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("should release when channel is empty", func() {
|
|
||||||
g.Assert(l.IsLocked()).IsFalse()
|
|
||||||
l.Release()
|
|
||||||
g.Assert(cap(l.ch)).Equal(1)
|
|
||||||
g.Assert(len(l.ch)).Equal(0)
|
|
||||||
g.Assert(l.IsLocked()).IsFalse()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
g.Describe("PowerLocker#Destroy", func() {
|
|
||||||
g.It("should unlock and close the channel", func() {
|
|
||||||
l.Acquire()
|
|
||||||
g.Assert(l.IsLocked()).IsTrue()
|
|
||||||
l.Destroy()
|
|
||||||
g.Assert(l.IsLocked()).IsFalse()
|
|
||||||
|
|
||||||
defer func() {
|
|
||||||
r := recover()
|
|
||||||
|
|
||||||
g.Assert(r).IsNotNil()
|
|
||||||
g.Assert(r.(error).Error()).Equal("send on closed channel")
|
|
||||||
}()
|
|
||||||
|
|
||||||
l.Acquire()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user