metrics: initial commit

.envrc

@@ -1 +0,0 @@
-use flake

.github/FUNDING.yaml

@@ -1 +0,0 @@
-github: [matthewpi]

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: [DaneEveritt]
+custom: ["https://paypal.me/PterodactylSoftware"]

.github/workflows/build-test.yml

@@ -0,0 +1,66 @@
+name: Run Tests
+on:
+  push:
+    branches:
+      - 'develop'
+  pull_request:
+    branches:
+      - 'develop'
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-20.04 ]
+        go: [ '^1.15', '^1.16' ]
+        goos: [ linux ]
+        goarch: [ amd64, arm64 ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Code Checkout
+        uses: actions/checkout@v2
+      - name: Setup Go v${{ matrix.go }}
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go }}
+      - name: Print Environment
+        id: env
+        run: |
+          printf "Go Executable Path: $(which go)\n"
+          printf "Go Version: $(go version)\n"
+          printf "\n\nGo Environment:\n\n"
+          go env
+          printf "\n\nSystem Environment:\n\n"
+          env
+
+          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=go_cache::$(go env GOCACHE)"
+      - name: Build Cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.env.outputs.go_cache }}
+          key: ${{ runner.os }}-${{ matrix.go }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.go }}-go
+      - name: Get Dependencies
+        run: |
+          go get -v -t -d ./...
+      - name: Build
+        env:
+          GOOS: ${{ matrix.goos }}
+          GOARCH: ${{ matrix.goarch }}
+          CGO_ENABLED: 0
+          SRC_PATH: github.com/pterodactyl/wings
+        run: |
+          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
+          upx build/wings_${{ matrix.goos }}_${{ matrix.goarch }}
+          chmod +x build/wings_${{ matrix.goos }}_${{ matrix.goarch }}
+      - name: Test
+        run: go test ./...
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v2
+        if: ${{ matrix.go == '^1.15' && (github.ref == 'refs/heads/develop' || github.event_name == 'pull_request') }}
+        with:
+          name: wings_${{ matrix.goos }}_${{ matrix.goarch }}
+          path: build/wings_${{ matrix.goos }}_${{ matrix.goarch }}

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,31 @@
+name: CodeQL
+on:
+  push:
+    branches:
+      - 'develop'
+  pull_request:
+    branches:
+      - 'develop'
+  schedule:
+    - cron: '0 9 * * 4'
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        language:
+          - go
+    steps:
+      - name: Code Checkout
+        uses: actions/checkout@v2
+      - name: Checkout Head
+        run: git checkout HEAD^2
+        if: ${{ github.event_name == 'pull_request' }}
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.github/workflows/codeql.yaml

@@ -1,42 +0,0 @@
-name: CodeQL
-
-on:
-  push:
-    branches:
-      - develop
-  pull_request:
-    branches:
-      - develop
-  schedule:
-    - cron: "0 9 * * 4"
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-22.04
-
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language:
-          - go
-
-    steps:
-      - name: Code Checkout
-        uses: actions/checkout@v4
-
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
-        with:
-          languages: ${{ matrix.language }}
-
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2

.github/workflows/docker.yaml

@@ -1,78 +0,0 @@
-name: Docker
-
-on:
-  push:
-    branches:
-      - develop
-  release:
-    types:
-      - published
-
-jobs:
-  build-and-push:
-    name: Build and Push
-    runs-on: ubuntu-22.04
-    # Always run against a tag, even if the commit into the tag has [docker skip] within the commit message.
-    if: "!contains(github.ref, 'develop') || (!contains(github.event.head_commit.message, 'skip docker') && !contains(github.event.head_commit.message, 'docker skip'))"
-    steps:
-      - name: Code checkout
-        uses: actions/checkout@v4
-
-      - name: Docker metadata
-        id: docker_meta
-        uses: docker/metadata-action@v5
-        with:
-          images: ghcr.io/pterodactyl/wings
-          flavor: |
-            latest=false
-          tags: |
-            type=raw,value=latest,enable=${{ github.event_name == 'release' && github.event.action == 'published' && github.event.release.prerelease == false }}
-            type=ref,event=tag
-            type=ref,event=branch
-
-      - name: Setup QEMU
-        uses: docker/setup-qemu-action@v3
-
-      - name: Setup Docker buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Login to GitHub Container Registry
-        uses: docker/login-action@v3
-        with:
-          registry: ghcr.io
-          username: ${{ github.repository_owner }}
-          password: ${{ secrets.REGISTRY_TOKEN }}
-
-      - name: Get Build Information
-        id: build_info
-        run: |
-          echo "version_tag=${GITHUB_REF/refs\/tags\/v/}" >> $GITHUB_OUTPUT
-          echo "short_sha=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
-
-      - name: Build and Push (tag)
-        uses: docker/build-push-action@v5
-        if: "github.event_name == 'release' && github.event.action == 'published'"
-        with:
-          context: .
-          file: ./Dockerfile
-          push: true
-          platforms: linux/amd64,linux/arm64
-          build-args: |
-            VERSION=${{ steps.build_info.outputs.version_tag }}
-          labels: ${{ steps.docker_meta.outputs.labels }}
-          tags: ${{ steps.docker_meta.outputs.tags }}
-
-      - name: Build and Push (develop)
-        uses: docker/build-push-action@v5
-        if: "github.event_name == 'push' && contains(github.ref, 'develop')"
-        with:
-          context: .
-          file: ./Dockerfile
-          push: ${{ github.event_name != 'pull_request' }}
-          platforms: linux/amd64,linux/arm64
-          build-args: |
-            VERSION=dev-${{ steps.build_info.outputs.short_sha }}
-          labels: ${{ steps.docker_meta.outputs.labels }}
-          tags: ${{ steps.docker_meta.outputs.tags }}
-          cache-from: type=gha
-          cache-to: type=gha,mode=max

.github/workflows/docker.yml

@@ -0,0 +1,57 @@
+name: Publish Docker Image
+on:
+  push:
+    branches:
+      - 'develop'
+
+    tags:
+      - 'v*'
+jobs:
+  push:
+    name: Push
+    runs-on: ubuntu-20.04
+    # Always run against a tag, even if the commit into the tag has [docker skip] within the commit message.
+    if: "!contains(github.ref, 'develop') || (!contains(github.event.head_commit.message, 'skip docker') && !contains(github.event.head_commit.message, 'docker skip'))"
+    steps:
+      - name: Code Checkout
+        uses: actions/checkout@v2
+      - name: Docker Meta
+        id: docker_meta
+        uses: crazy-max/ghaction-docker-meta@v1
+        with:
+          images: ghcr.io/pterodactyl/wings
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      - name: Install buildx
+        uses: docker/setup-buildx-action@v1
+        with:
+          version: v0.5.1
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.REGISTRY_TOKEN }}
+      - name: Get Build Information
+        id: build_info
+        run: |
+          echo "::set-output name=version_tag::${GITHUB_REF/refs\/tags\//}"
+          echo "::set-output name=short_sha::$(git rev-parse --short HEAD)"
+      - name: Release Production Build
+        uses: docker/build-push-action@v2
+        if: "!contains(github.ref, 'develop')"
+        with:
+          build-args: |
+            VERSION=${{ steps.build_info.outputs.version_tag }}
+          labels: ${{ steps.docker_meta.outputs.labels }}
+          push: true
+          tags: ${{ steps.docker_meta.outputs.tags }}
+      - name: Release Development Build
+        uses: docker/build-push-action@v2
+        if: "contains(github.ref, 'develop')"
+        with:
+          build-args: |
+            VERSION=dev-${{ steps.build_info.outputs.short_sha }}
+          labels: ${{ steps.docker_meta.outputs.labels }}
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.docker_meta.outputs.tags }}

.github/workflows/push.yaml

@@ -1,75 +0,0 @@
-name: Push
-
-on:
-  push:
-    branches:
-      - develop
-  pull_request:
-    branches:
-      - develop
-
-jobs:
-  build-and-test:
-    name: Build and Test
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-22.04]
-        go: ["1.22.5"]
-        goos: [linux]
-        goarch: [amd64, arm64]
-
-    steps:
-      - name: Setup Go
-        uses: actions/setup-go@v5
-        with:
-          go-version: ${{ matrix.go }}
-
-      - name: Code checkout
-        uses: actions/checkout@v4
-
-      - name: go mod download
-        env:
-          CGO_ENABLED: 0
-        run: |
-          go mod download
-
-      - name: Build
-        env:
-          GOOS: ${{ matrix.goos }}
-          GOARCH: ${{ matrix.goarch }}
-          CGO_ENABLED: 0
-          SRC_PATH: github.com/pterodactyl/wings
-        run: |
-          go build -v -trimpath -ldflags="-s -w -X ${SRC_PATH}/system.Version=dev-${GIT_COMMIT:0:7}" -o dist/wings ${SRC_PATH}
-          go build -v -trimpath -ldflags="-X ${SRC_PATH}/system.Version=dev-${GIT_COMMIT:0:7}" -o dist/wings_debug ${SRC_PATH}
-          chmod 755 dist/*
-
-      - name: go test
-        if: ${{ matrix.goarch == 'amd64' }}
-        env:
-          CGO_ENABLED: 0
-        run: |
-          go test $(go list ./...)
-
-      - name: go test -race
-        if: ${{ matrix.goarch == 'amd64' }}
-        env:
-          CGO_ENABLED: 1
-        run: |
-          go test -race $(go list ./...)
-
-      - name: Upload Release Artifact
-        uses: actions/upload-artifact@v4
-        if: ${{ (github.ref == 'refs/heads/develop' || github.event_name == 'pull_request') && matrix.go == '1.22.5' }}
-        with:
-          name: wings_linux_${{ matrix.goarch }}
-          path: dist/wings
-
-      - name: Upload Debug Artifact
-        uses: actions/upload-artifact@v4
-        if: ${{ (github.ref == 'refs/heads/develop' || github.event_name == 'pull_request') && matrix.go == '1.22.5' }}
-        with:
-          name: wings_linux_${{ matrix.goarch }}_debug
-          path: dist/wings_debug

.github/workflows/release.yml

@@ -1,47 +1,41 @@
-name: Release
+name: Create Release
-
 on:
   push:
     tags:
-      - "v*"
+      - 'v*'
-
 jobs:
   release:
-    name: Release
+    runs-on: ubuntu-20.04
-    runs-on: ubuntu-22.04
-
     steps:
       - name: Code Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2
-
+      - uses: actions/setup-go@v2
-      - name: Setup Go
-        uses: actions/setup-go@v5
         with:
-          go-version: "1.22.5"
+          go-version: '^1.15'
-
+      - name: Build
-      - name: Build release binaries
         env:
-          CGO_ENABLED: 0
           REF: ${{ github.ref }}
         run: |
-          GOARCH=amd64 go build -o dist/wings_linux_amd64 -v -trimpath -ldflags="-s -w -X github.com/pterodactyl/wings/system.Version=${REF:11}" github.com/pterodactyl/wings
+          CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="-s -w -X github.com/pterodactyl/wings/system.Version=${REF:11}" -o build/wings_linux_amd64 -v wings.go
-          chmod 755 dist/wings_linux_amd64
+          CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -ldflags="-s -w -X github.com/pterodactyl/wings/system.Version=${REF:11}" -o build/wings_linux_arm64 -v wings.go
-          GOARCH=arm64 go build -o dist/wings_linux_arm64 -v -trimpath -ldflags="-s -w -X github.com/pterodactyl/wings/system.Version=${REF:11}" github.com/pterodactyl/wings
+      - name: Test
-          chmod 755 dist/wings_linux_arm64
+        run: go test ./...
-
+      - name: Compress binary and make it executable
+        run: |
+          upx build/wings_linux_amd64 && chmod +x build/wings_linux_amd64
+          upx build/wings_linux_arm64 && chmod +x build/wings_linux_arm64
       - name: Extract changelog
         env:
           REF: ${{ github.ref }}
         run: |
           sed -n "/^## ${REF:10}/,/^## /{/^## /b;p}" CHANGELOG.md > ./RELEASE_CHANGELOG
-
+          echo ::set-output name=version_name::`sed -nr "s/^## (${REF:10} .*)$/\1/p" CHANGELOG.md`
       - name: Create checksum and add to changelog
         run: |
-          SUM=`cd dist && sha256sum wings_linux_amd64`
+          SUM=`cd build && sha256sum wings_linux_amd64`
-          SUM2=`cd dist && sha256sum wings_linux_arm64`
+          SUM2=`cd build && sha256sum wings_linux_arm64`
           echo -e "\n#### SHA256 Checksum\n\`\`\`\n$SUM\n$SUM2\n\`\`\`\n" >> ./RELEASE_CHANGELOG
           echo -e "$SUM\n$SUM2" > checksums.txt
-
       - name: Create release branch
         env:
           REF: ${{ github.ref }}
@@ -51,41 +45,39 @@ jobs:
           git config --local user.name "Pterodactyl CI"
           git checkout -b $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 commit -m "bump version for release"
           git push
-
+      - name: Create Release
-      - name: Create release
         id: create_release
-        uses: softprops/action-gh-release@v1
+        uses: actions/create-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          draft: true
+          tag_name: ${{ github.ref }}
-          prerelease: ${{ contains(github.ref, 'rc') || contains(github.ref, 'beta') || contains(github.ref, 'alpha') }}
+          release_name: ${{ steps.extract_changelog.outputs.version_name }}
           body_path: ./RELEASE_CHANGELOG
-
+          draft: true
-      - name: Upload amd64 binary
+          prerelease: ${{ contains(github.ref, 'beta') || contains(github.ref, 'alpha') }}
+      - name: Upload amd64 Binary
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: dist/wings_linux_amd64
+          asset_path: build/wings_linux_amd64
           asset_name: wings_linux_amd64
           asset_content_type: application/octet-stream
-
+      - name: Upload arm64 Binary
-      - name: Upload arm64 binary
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: dist/wings_linux_arm64
+          asset_path: build/wings_linux_arm64
           asset_name: wings_linux_arm64
           asset_content_type: application/octet-stream
-
       - name: Upload checksum
         uses: actions/upload-release-asset@v1
         env:

.gitignore

@@ -23,8 +23,6 @@
 # ignore configuration file
 /config.yml
 /config*.yml
-/config.yaml
-/config*.yaml
 
 # Ignore Vagrant stuff
 /.vagrant
@@ -51,4 +49,3 @@ debug
 .DS_Store
 *.pprof
 *.pdf
-pprof.*

CHANGELOG.md

@@ -1,319 +1,5 @@
 # Changelog
 
-## v1.11.14
-
-### Added
-
-* Support relative file paths for the Wings config ([#180](https://github.com/pterodactyl/wings/pull/180))
-
-### Fixed
-
-* Folders not being sorted before files properly ([#5078](https://github.com/pterodactyl/panel/issues/5078)
-
-## v1.11.13
-
-### Fixed
-
-* Auto-configure not working ([#5087](https://github.com/pterodactyl/panel/issues/5087))
-* Individual files unable to be decompressed ([#5034](https://github.com/pterodactyl/panel/issues/5034))
-
-## v1.11.12
-
-### Fixed
-* Arbitrary File Write/Read ([GHSA-gqmf-jqgv-v8fw](https://github.com/pterodactyl/wings/security/advisories/GHSA-gqmf-jqgv-v8fw))
-* Server-side Request Forgery (SSRF) during remote file pull ([GHSA-qq22-jj8x-4wwv](https://github.com/pterodactyl/wings/security/advisories/GHSA-qq22-jj8x-4wwv))
-* Invalid `Content-Type` being used with the `wings diagnostics` command ([#186](https://github.com/pterodactyl/wings/pull/186))
-
-## v1.11.11
-### Fixed
-* Backups missing content when a `.pteroignore` file is used
-* Archives originating from a subdirectory not containing any files ([#5030](https://github.com/pterodactyl/panel/issues/5030))
-
-## v1.11.10
-### Fixed
-* Archives randomly ignoring files and directories ([#5027](https://github.com/pterodactyl/panel/issues/5027))
-* Crash when deleting or transferring a server ([#5028](https://github.com/pterodactyl/panel/issues/5028))
-
-## v1.11.9
-### Changed
-* Release binaries are now built with Go 1.21.8
-* Updated Go dependencies
-
-### Fixed
-* [CVE-2024-27102](https://www.cve.org/CVERecord?id=CVE-2024-27102)
-
-## v1.11.8
-### Changed
-* Release binaries are now built with Go 1.20.10 (resolves [CVE-2023-44487](https://www.cve.org/CVERecord?id=CVE-2023-44487))
-* Updated Go dependencies
-
-## v1.11.7
-### Changed
-* Updated Go dependencies (this resolves an issue related to `http: invalid Host header` with Docker)
-* Wings is now built with go1.19.11
-
-## v1.11.6
-### Fixed
-* CVE-2023-32080
-
-## v1.11.5
-### Added
-* Added a config option to disable Wings config.yml updates from the Panel (https://github.com/pterodactyl/wings/commit/ec6d6d83ea3eb14995c24f001233e85b37ffb87b)
-
-### Changed
-* Wings is now built with Go 1.19.7
-
-### Fixed
-* Fixed archives containing partially matched file names (https://github.com/pterodactyl/wings/commit/43b3496f0001cec231c80af1f9a9b3417d04e8d4)
-
-## v1.11.4
-### Fixed
-* CVE-2023-25168
-
-## v1.11.3
-### Fixed
-* CVE-2023-25152
-
-## v1.11.2
-### Fixed
-* Backups being restored from remote storage (s3) erroring out due to a closed stream.
-* Fix IP validation logic for activity logs filtering out valid IPs instead of invalid IPs
-
-## v1.11.1
-### Changed
-* Release binaries are now built with Go 1.18.10
-* Timeout when stopping a server before a transfer begins has been reduced to 15 seconds from 1 minute
-* Removed insecure SSH protocols for use with the SFTP server
-
-### Fixed
-* Unnecessary Docker client connections being left open, causing a slow leak of file descriptors
-* Files being left open in parts of the server's filesystem, causing a leak of file descriptors
-* IPv6 addresses being corrupted by flawed port stripping logic for activity logs, old entries with malformed IPs will be deleted from the local SQLite database automatically
-* A server that times out while being stopped at the beginning of a transfer no longer causes the server to become stuck in a transferring state
-
-## v1.11.0
-### Added (since 1.7.2)
-* More detailed information returned by the `/api/system` endpoint when using the `?v=2` query parameter.
-
-### Changed (since 1.7.2)
-* Send re-installation status separately from installation status.
-* Wings release versions will now follow the major and minor version of the Panel.
-* Transfers no longer buffer to disk, instead they are fully streamed with only a small amount of memory used for buffering.
-* Release binaries are no longer compressed with UPX.
-* Use `POST` instead of `GET` for sending the status of a transfer to the Panel.
-
-### Fixed (since 1.7.2)
-* Fixed servers outgoing IP not being updated whenever a server's primary allocation is changed when using the Force Outgoing IP option.
-* Fixed servers being terminated rather than gracefully stopped when a signal is used to stop the container rather than a command.
-* Fixed file not found errors being treated as an internal error, they are now treated as a 404.
-* Wings can be run with Podman instead of Docker, this is still experimental and not recommended for production use.
-* Archive progress is now reported correctly.
-* Labels for containers can now be set by the Panel.
-* Fixed servers becoming deadlocked when the target node of a transfer goes offline.
-
-## v1.11.0-rc.2
-### Added
-* More detailed information returned by the `/api/system` endpoint when using the `?v=2` query parameter.
-
-### Changed
-* Send reinstallation status separately from installation status.
-
-### Fixed
-* Fixed servers outgoing IP not being updated whenever a server's primary allocation is changed when using the Force Outgoing IP option.
-* Fixed servers being terminated rather than gracefully stopped when a signal is used to stop the container rather than a command.
-* Fixed file not found errors being treated as an internal error, they are now treated as a 404.
-
-## v1.11.0-rc.1
-### Changed
-* Wings release versions will now follow the major and minor version of the panel.
-* Transfers no longer buffer to disk, instead they are fully streamed with only a small amount of memory used for buffering.
-* Release binaries are no longer compressed with UPX.
-
-### Fixed
-* Wings can be run with podman instead of Docker, this is still experimental and not recommended for production use.
-* Archive progress is now reported correctly.
-* Labels for containers can now be set by the Panel.
-
-## v1.7.5
-### Fixed
-* CVE-2023-32080
-
-## v1.7.4
-### Fixed
-* CVE-2023-25168
-
-## v1.7.3
-### Fixed
-* CVE-2023-25152
-
-## v1.7.2
-### Fixed
-* The S3 backup driver now supports Cloudflare R2
-
-### Added
-* During a server transfer, there is a new "Archiving" status that outputs the progress of creating the server transfer archive.
-* Adds a configuration option to control the list of trusted proxies that can be used to determine the client IP address.
-* Adds a configuration option to control the Docker username space setting when Wings creates containers.
-
-### Changed
-* Releases are now built using `Go 1.18` — the minimum version required to build Wings is now `Go 1.18`.
-
-## v1.7.1
-### Fixed
-* YAML parser has been updated to fix some strange issues
-
-### Added
-* Added `Force Outgoing IP` option for servers to ensure outgoing traffic uses the server's IP address
-* Adds an option to control the level of gzip compression for backups
-
-## v1.7.0
-### Fixed
-* Fixes multi-platform support for Wings' Docker image.
-
-### Added
-* Adds support for tracking of SFTP actions, power actions, server commands, and file uploads by utilizing a local SQLite database and processing events before sending them to the Panel.
-* Adds support for configuring the MTU on the `pterodactyl0` network.
-
-## 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
 ### 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.

Dockerfile

@@ -1,25 +1,22 @@
 # Stage 1 (Build)
-FROM golang:1.22.5-alpine AS builder
+FROM golang:1.15-alpine3.12 AS builder
 
 ARG VERSION
-RUN apk add --update --no-cache git make
+RUN apk add --update --no-cache git make upx
 WORKDIR /app/
 COPY go.mod go.sum /app/
 RUN go mod download
 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" \
     -v \
     -trimpath \
     -o wings \
     wings.go
-RUN echo "ID=\"distroless\"" > /etc/os-release
+RUN upx wings
 
 # 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/
-CMD [ "/usr/bin/wings", "--config", "/etc/pterodactyl/config.yml" ]
+CMD [ "wings", "--config", "/etc/pterodactyl/config.yml" ]
-
-EXPOSE 8080

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
 
 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
 # different breakpoints.
@@ -14,6 +14,9 @@ rmdebug:
 	go build -gcflags "all=-N -l" -ldflags="-X github.com/pterodactyl/wings/system.Version=$(GIT_HEAD)" -race
 	sudo dlv --listen=:2345 --headless=true --api-version=2 --accept-multiclient exec ./wings -- --debug --ignore-certificate-errors --config config.yml
 
+compress:
+	upx --brute build/wings_*
+
 cross-build: clean build compress
 
 clean:

README.md

@@ -5,7 +5,6 @@
 [![Go Report Card](https://goreportcard.com/badge/github.com/pterodactyl/wings)](https://goreportcard.com/report/github.com/pterodactyl/wings)
 
 # Pterodactyl Wings
-
 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.
@@ -14,29 +13,33 @@ In addition, Wings ships with a built-in SFTP server allowing your system to rem
 dependencies, and allowing users to authenticate with the same credentials they would normally use to access the Panel.
 
 ## Sponsors
-
+I would like to extend my sincere thanks to the following sponsors for helping find Pterodactyl's developement.
-I would like to extend my sincere thanks to the following sponsors for helping fund Pterodactyl's development.
+[Interested in becoming a sponsor?](https://github.com/sponsors/DaneEveritt)
-[Interested in becoming a sponsor?](https://github.com/sponsors/matthewpi)
 
 | Company | About |
-|--------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ------- | ----- |
-| [**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.                                                                                                                       |
+| [**WISP**](https://wisp.gg) | Extra features. |
-| [**CodeNode LLC**](https://codenode.gg/)                     | Looking for simplicity? Well, look no further! CodeNode has got you covered with everything you need at the rock-bottom price of $1.75 per GB, including dedicated IPs in Dallas, Texas, and Amsterdam, Netherlands. We're not just good, we're the best in the game! |
+| [**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. |
-| [**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!                                                                                                                       |
+| [**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. |
-| [**HostEZ**](https://hostez.io)                              | US & EU Rust & Minecraft Hosting. DDoS Protected bare metal, VPS and colocation with low latency, high uptime and maximum availability. EZ!                                                                                                                           |
+| [**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. |
-| [**Blueprint**](https://blueprint.zip/?pterodactyl=true)     | Create and install Pterodactyl addons and themes with the growing Blueprint framework - the package-manager for Pterodactyl. Use multiple modifications at once without worrying about conflicts and make use of the large extension ecosystem.                       |
+| [**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. |
-| [**indifferent broccoli**](https://indifferentbroccoli.com/) | indifferent broccoli is a game server hosting and rental company. With us, you get top-notch computer power for your gaming sessions. We destroy lag, latency, and complexity--letting you focus on the fun stuff.                                                    |
+| [**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. |
+| [**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. |
+| [**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! |
+| [**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*! |
 
 ## Documentation
-
 * [Panel Documentation](https://pterodactyl.io/panel/1.0/getting_started.html)
 * [Wings Documentation](https://pterodactyl.io/wings/1.0/installing.html)
 * [Community Guides](https://pterodactyl.io/community/about.html)
 * Or, get additional help [via Discord](https://discord.gg/pterodactyl)
 
 ## Reporting Issues
-
 Please use the [pterodactyl/panel](https://github.com/pterodactyl/panel) repository to report any issues or make
 feature requests for Wings. In addition, the [security policy](https://github.com/pterodactyl/panel/security/policy) listed
 within that repository also applies to Wings.

cmd/configure.go

@@ -2,8 +2,9 @@ package cmd
 
 import (
 	"crypto/tls"
+	"encoding/json"
 	"fmt"
-	"io"
+	"io/ioutil"
 	"net/http"
 	"net/url"
 	"os"
@@ -13,20 +14,20 @@ import (
 
 	"github.com/AlecAivazis/survey/v2"
 	"github.com/AlecAivazis/survey/v2/terminal"
-	"github.com/goccy/go-json"
-	"github.com/spf13/cobra"
-
 	"github.com/pterodactyl/wings/config"
+	"github.com/spf13/cobra"
 )
 
-var configureArgs struct {
+var (
+	configureArgs struct {
 		PanelURL      string
 		Token         string
 		ConfigPath    string
 		Node          string
 		Override      bool
 		AllowInsecure bool
-}
+	}
+)
 
 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.")
 		os.Exit(1)
 	} 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))
 		os.Exit(1)
 	}
 
-	b, err := io.ReadAll(res.Body)
+	b, err := ioutil.ReadAll(res.Body)
 
 	cfg, err := config.NewAtPath(configPath)
 	if err != nil {
@@ -155,9 +156,6 @@ func configureCmdRun(cmd *cobra.Command, args []string) {
 		panic(err)
 	}
 
-	// Manually specify the Panel URL as it won't be decoded from JSON.
-	cfg.PanelLocation = configureArgs.PanelURL
-
 	if err = config.WriteToDisk(cfg); err != nil {
 		panic(err)
 	}

cmd/diagnostics.go

@@ -2,9 +2,11 @@ package cmd
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"io"
+	"io/ioutil"
 	"net/http"
 	"net/url"
 	"os/exec"
@@ -19,27 +21,25 @@ import (
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/pkg/parsers/kernel"
 	"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/environment"
 	"github.com/pterodactyl/wings/loggers/cli"
 	"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
 		IncludeLogs        bool
 		ReviewBeforeUpload bool
 		HastebinURL        string
 		LogLines           int
-}
+	}
+)
 
 func newDiagnosticsCommand() *cobra.Command {
 	command := &cobra.Command{
@@ -58,14 +58,14 @@ func newDiagnosticsCommand() *cobra.Command {
 	return command
 }
 
-// diagnosticsCmdRun collects diagnostics about wings, its configuration and the node.
+// diagnosticsCmdRun collects diagnostics about wings, it's configuration and the node.
 // We collect:
 // - wings and docker versions
 // - relevant parts of daemon configuration
 // - the docker debug output
 // - running docker containers
 // - logs
-func diagnosticsCmdRun(*cobra.Command, []string) {
+func diagnosticsCmdRun(cmd *cobra.Command, args []string) {
 	questions := []*survey.Question{
 		{
 			Name:   "IncludeEndpoints",
@@ -78,7 +78,7 @@ func diagnosticsCmdRun(*cobra.Command, []string) {
 		{
 			Name: "ReviewBeforeUpload",
 			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.",
 				Default: true,
 			},
@@ -96,12 +96,12 @@ func diagnosticsCmdRun(*cobra.Command, []string) {
 	output := &strings.Builder{}
 	fmt.Fprintln(output, "Pterodactyl Wings - Diagnostics Report")
 	printHeader(output, "Versions")
-	fmt.Fprintln(output, "               Wings:", system.Version)
+	fmt.Fprintln(output, "         wings:", system.Version)
 	if dockerErr == nil {
-		fmt.Fprintln(output, "              Docker:", dockerVersion.Version)
+		fmt.Fprintln(output, "Docker:", dockerVersion.Version)
 	}
 	if v, err := kernel.GetKernelVersion(); err == nil {
-		fmt.Fprintln(output, "              Kernel:", v)
+		fmt.Fprintln(output, "Kernel:", v)
 	}
 	if os, err := operatingsystem.GetOperatingSystem(); err == nil {
 		fmt.Fprintln(output, "    OS:", os)
@@ -109,6 +109,7 @@ func diagnosticsCmdRun(*cobra.Command, []string) {
 
 	printHeader(output, "Wings Configuration")
 	if err := config.FromFile(config.DefaultLocation); err != nil {
+
 	}
 	cfg := config.Get()
 	fmt.Fprintln(output, "    Panel Location:", redact(cfg.PanelLocation))
@@ -179,17 +180,6 @@ func diagnosticsCmdRun(*cobra.Command, []string) {
 		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(output.String())
 	fmt.Print("---------------   end of report    ---------------\n\n")
@@ -229,13 +219,13 @@ func uploadToHastebin(hbUrl, content string) (string, error) {
 		return "", err
 	}
 	u.Path = path.Join(u.Path, "documents")
-	res, err := http.Post(u.String(), "text/plain", r)
+	res, err := http.Post(u.String(), "plain/text", r)
-	if err != nil || res.StatusCode < 200 || res.StatusCode >= 300 {
+	if err != nil || res.StatusCode != 200 {
 		fmt.Println("Failed to upload report to ", u.String(), err)
 		return "", err
 	}
 	pres := make(map[string]interface{})
-	body, err := io.ReadAll(res.Body)
+	body, err := ioutil.ReadAll(res.Body)
 	if err != nil {
 		fmt.Println("Failed to parse response.", err)
 		return "", err

cmd/root.go

@@ -1,18 +1,17 @@
 package cmd
 
 import (
-	"context"
 	"crypto/tls"
 	"errors"
 	"fmt"
+	"github.com/pterodactyl/wings/metrics"
 	log2 "log"
 	"net/http"
-	_ "net/http/pprof"
 	"os"
 	"path"
 	"path/filepath"
-	"runtime"
 	"strconv"
+	"strings"
 	"time"
 
 	"github.com/NYTimes/logrotate"
@@ -21,20 +20,18 @@ import (
 	"github.com/docker/docker/client"
 	"github.com/gammazero/workerpool"
 	"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/environment"
-	"github.com/pterodactyl/wings/internal/cron"
-	"github.com/pterodactyl/wings/internal/database"
 	"github.com/pterodactyl/wings/loggers/cli"
 	"github.com/pterodactyl/wings/remote"
 	"github.com/pterodactyl/wings/router"
 	"github.com/pterodactyl/wings/server"
 	"github.com/pterodactyl/wings/sftp"
 	"github.com/pterodactyl/wings/system"
+	"github.com/spf13/cobra"
+	"golang.org/x/crypto/acme"
+	"golang.org/x/crypto/acme/autocert"
 )
 
 var (
@@ -44,7 +41,7 @@ var (
 
 var rootCommand = &cobra.Command{
 	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) {
 		initConfig()
 		initLogging()
@@ -77,10 +74,8 @@ func init() {
 	rootCommand.PersistentFlags().BoolVar(&debug, "debug", false, "pass in order to run wings in debug mode")
 
 	// 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().Bool("auto-tls", false, "pass in order to have wings generate and manage it's own SSL certificates using Let's Encrypt")
-	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 its 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().Bool("ignore-certificate-errors", false, "ignore certificate verification errors when executing API calls")
 
@@ -90,6 +85,25 @@ func init() {
 }
 
 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()
 	log.Debug("running in debug mode")
 	log.WithField("config_file", configPath).Info("loading configuration from file")
@@ -109,21 +123,23 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 		log.WithField("error", err).Fatal("failed to configure system directories for pterodactyl")
 		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")
 	if err := config.EnsurePterodactylUser(); err != nil {
 		log.WithField("error", err).Fatal("failed to create pterodactyl system user")
 	}
-	if err := config.ConfigurePasswd(); err != nil {
-		log.WithField("error", err).Fatal("failed to configure container passwd file")
-	}
 	log.WithFields(log.Fields{
 		"username": config.Get().System.Username,
 		"uid":      config.Get().System.User.Uid,
 		"gid":      config.Get().System.User.Gid,
 	}).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(
 		config.Get().PanelLocation,
@@ -133,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)
 	if err != nil {
 		log.WithField("error", err).Fatal("failed to load server configurations")
@@ -152,7 +164,7 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 
 	// Just for some nice log output.
 	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()
@@ -163,7 +175,7 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 	ticker := time.NewTicker(time.Minute)
 	// Every minute, write the current server states to the disk to allow for a more
 	// seamless hard-reboot process in which wings will re-sync server states based
-	// on its last tracked state.
+	// on it's last tracked state.
 	go func() {
 		for {
 			select {
@@ -191,27 +203,23 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 			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() {
 			s.Log().Info("configuring server environment and restoring to previous state")
 			var st string
-			if state, exists := states[s.ID()]; exists {
+			if state, exists := states[s.Id()]; exists {
 				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
-			// 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.
 			if err != nil && !client.IsErrNotFound(err) {
 				s.Log().WithField("error", err).Error("error checking server environment status")
@@ -237,7 +245,7 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 				s.Log().Info("detected server is running, re-attaching to process...")
 
 				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")
 				}
 			} else {
@@ -246,33 +254,19 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 				// state being tracked.
 				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()
 	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.
 		for _, s := range manager.All() {
 			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() {
 		// Run the SFTP server.
 		if err := sftp.New(manager).Run(); err != nil {
@@ -283,7 +277,7 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 
 	go func() {
 		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.
 		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")
@@ -292,12 +286,12 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 
 	sys := config.Get().System
 	// 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")
 	}
 
 	// 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")
 	}
 
@@ -323,20 +317,6 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 		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.
 	if autotls {
 		m := autocert.Manager{
@@ -364,10 +344,10 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 		return
 	}
 
-	// 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.
 	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")
 		}
 		return
@@ -376,19 +356,19 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 	if err := s.ListenAndServe(); err != nil {
 		log.WithField("error", err).Fatal("failed to configure HTTP server")
 	}
+	<-done
 }
 
 // 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() {
-	if !filepath.IsAbs(configPath) {
+	if !strings.HasPrefix(configPath, "/") {
-		d, err := filepath.Abs(configPath)
+		d, err := os.Getwd()
 		if err != nil {
-			log2.Fatalf("cmd/root: failed to get path to config file: %s", err)
+			log2.Fatalf("cmd/root: could not determine directory: %s", err)
 		}
-		configPath = d
+		configPath = path.Clean(path.Join(d, configPath))
 	}
-
 	err := config.FromFile(configPath)
 	if err != nil {
 		if errors.Is(err, os.ErrNotExist) {
@@ -405,7 +385,7 @@ func initConfig() {
 // in the code without having to pass around a logger instance.
 func initLogging() {
 	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)
 	}
 	p := filepath.Join(dir, "/wings.log")
@@ -443,18 +423,18 @@ in all copies or substantial portions of the Software.%s`), system.Version, time
 }
 
 func exitWithConfigurationNotice() {
-	fmt.Printf(colorstring.Color(`
+	fmt.Print(colorstring.Color(`
 [_red_][white][bold]Error: Configuration File Not Found[reset]
 
 Wings was not able to locate your configuration file, and therefore is not
 able to complete its boot process. Please ensure you have copied your instance
 configuration file into the default location below.
 
-Default Location: %s
+Default Location: /etc/pterodactyl/config.yml
 
 [yellow]This is not a bug with this software. Please do not make a bug report
 for this issue, it will be closed.[reset]
 
-`), config.DefaultLocation)
+`))
 	os.Exit(1)
 }

config/config.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"crypto/tls"
 	"fmt"
+	"io/ioutil"
 	"os"
 	"os/exec"
 	"os/user"
@@ -12,19 +13,16 @@ import (
 	"regexp"
 	"strings"
 	"sync"
-	"sync/atomic"
 	"text/template"
 	"time"
 
 	"emperror.dev/errors"
-	"github.com/acobaugh/osrelease"
 	"github.com/apex/log"
+	"github.com/cobaugh/osrelease"
 	"github.com/creasty/defaults"
 	"github.com/gbrlsnchs/jwt/v3"
-	"golang.org/x/sys/unix"
-	"gopkg.in/yaml.v2"
-
 	"github.com/pterodactyl/wings/system"
+	"gopkg.in/yaml.v2"
 )
 
 const DefaultLocation = "/etc/pterodactyl/config.yml"
@@ -49,15 +47,13 @@ var DefaultTLSConfig = &tls.Config{
 	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
-// 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
 
 // SftpConfiguration defines the configuration of the internal SFTP server.
@@ -89,13 +85,16 @@ type ApiConfiguration struct {
 	// Determines if functionality for allowing remote download of files into server directories
 	// is enabled on this instance. If set to "true" remote downloads will not be possible for
 	// servers.
-	DisableRemoteDownload bool `json:"-" 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"`
+}
 
-	// A list of IP address of proxies that may send a X-Forwarded-For header to set the true clients IP
+// MetricsConfiguration .
-	TrustedProxies []string `json:"trusted_proxies" yaml:"trusted_proxies"`
+type MetricsConfiguration struct {
+	// Bind .
+	Bind string `default:":9000" yaml:"bind"`
 }
 
 // RemoteQueryConfiguration defines the configuration settings for remote requests
@@ -123,23 +122,19 @@ type RemoteQueryConfiguration struct {
 // SystemConfiguration defines basic system configuration settings.
 type SystemConfiguration struct {
 	// The root directory where all of the pterodactyl data is stored at.
-	RootDirectory string `default:"/var/lib/pterodactyl" json:"-" yaml:"root_directory"`
+	RootDirectory string `default:"/var/lib/pterodactyl" yaml:"root_directory"`
 
 	// Directory where logs for server installations and other wings events are logged.
-	LogDirectory string `default:"/var/log/pterodactyl" json:"-" yaml:"log_directory"`
+	LogDirectory string `default:"/var/log/pterodactyl" yaml:"log_directory"`
 
 	// Directory where the server data is stored at.
-	Data string `default:"/var/lib/pterodactyl/volumes" json:"-" yaml:"data"`
+	Data string `default:"/var/lib/pterodactyl/volumes" yaml:"data"`
 
 	// Directory where server archives for transferring will be stored.
-	ArchiveDirectory string `default:"/var/lib/pterodactyl/archives" json:"-" yaml:"archive_directory"`
+	ArchiveDirectory string `default:"/var/lib/pterodactyl/archives" yaml:"archive_directory"`
 
 	// Directory where local backups will be stored on the machine.
-	BackupDirectory string `default:"/var/lib/pterodactyl/backups" json:"-" 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" json:"-" yaml:"tmp_directory"`
 
 	// The user that should own all of the server files, and be used for containers.
 	Username string `default:"pterodactyl" yaml:"username"`
@@ -154,42 +149,9 @@ type SystemConfiguration struct {
 	// Definitions for the user that gets created to ensure that we can quickly access
 	// this information without constantly having to do a system lookup.
 	User struct {
-		// Rootless controls settings related to rootless container daemons.
+		Uid int
-		Rootless struct {
+		Gid int
-			// Enabled controls whether rootless containers are enabled.
+	}
-			Enabled bool `yaml:"enabled" default:"false"`
-			// ContainerUID controls the UID of the user inside the container.
-			// This should likely be set to 0 so the container runs as the user
-			// running Wings.
-			ContainerUID int `yaml:"container_uid" default:"0"`
-			// ContainerGID controls the GID of the user inside the container.
-			// This should likely be set to 0 so the container runs as the user
-			// running Wings.
-			ContainerGID int `yaml:"container_gid" default:"0"`
-		} `yaml:"rootless"`
-
-		Uid int `yaml:"uid"`
-		Gid int `yaml:"gid"`
-	} `yaml:"user"`
-
-	// Passwd controls the mounting of a generated passwd files into containers started by Wings.
-	Passwd struct {
-		// Enable controls whether generated passwd files should be mounted into containers.
-		//
-		// By default this option is disabled and Wings will not mount any additional passwd
-		// files into containers.
-		Enable bool `yaml:"enabled" default:"false"`
-
-		// Directory is the directory on disk where the generated files will be stored.
-		// This directory may be temporary as it will be re-created whenever Wings is started.
-		//
-		// This path **WILL** be both written to by Wings and mounted into containers created by
-		// Wings. If you are running Wings itself in a container, this path will need to be mounted
-		// into the Wings container as the exact path on the host, which should match the value
-		// specified here. If you are using SELinux, you will need to make sure this file has the
-		// correct SELinux context in order for containers to use it.
-		Directory string `yaml:"directory" default:"/run/wings/etc"`
-	} `yaml:"passwd"`
 
 	// The amount of time in seconds that can elapse before a server's disk space calculation is
 	// considered stale and a re-check should occur. DANGER: setting this value too low can seriously
@@ -201,15 +163,6 @@ type SystemConfiguration struct {
 	// disk usage is not a concern.
 	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 int `default:"60" yaml:"activity_send_interval"`
-
-	// ActivitySendCount is the number of activity events to send per batch.
-	ActivitySendCount int `default:"100" yaml:"activity_send_count"`
-
 	// 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
 	// cases disabling this should not have any major impact unless external processes are
@@ -230,14 +183,9 @@ type SystemConfiguration struct {
 	Backups Backups `yaml:"backups"`
 
 	Transfers Transfers `yaml:"transfers"`
-
-	OpenatMode string `default:"auto" yaml:"openat_mode"`
 }
 
 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
 	// "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.
@@ -259,15 +207,6 @@ type Backups struct {
 	//
 	// Defaults to 0 (unlimited)
 	WriteLimit int `default:"0" yaml:"write_limit"`
-
-	// CompressionLevel determines how much backups created by wings should be compressed.
-	//
-	// "none" -> no compression will be applied
-	// "best_speed" -> uses gzip level 1 for fast speed
-	// "best_compression" -> uses gzip level 9 for minimal disk space useage
-	//
-	// Defaults to "best_speed" (level 1)
-	CompressionLevel string `default:"best_speed" yaml:"compression_level"`
 }
 
 type Transfers struct {
@@ -284,14 +223,26 @@ type ConsoleThrottles struct {
 	// Whether or not the throttler is enabled for this instance.
 	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.
 	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
 	// 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.
-	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 {
@@ -318,6 +269,7 @@ type Configuration struct {
 	Api     ApiConfiguration     `json:"api" yaml:"api"`
 	System  SystemConfiguration  `json:"system" yaml:"system"`
 	Docker  DockerConfiguration  `json:"docker" yaml:"docker"`
+	Metrics MetricsConfiguration `json:"metrics" yaml:"metrics"`
 
 	// Defines internal throttling configurations for server processes to prevent
 	// someone from running an endless loop that spams data to logs.
@@ -325,7 +277,7 @@ type Configuration struct {
 
 	// The location where the panel is running that this daemon should connect to
 	// to collect data and send events.
-	PanelLocation string                   `json:"-" yaml:"remote"`
+	PanelLocation string                   `json:"remote" yaml:"remote"`
 	RemoteQuery   RemoteQueryConfiguration `json:"remote_query" yaml:"remote_query"`
 
 	// AllowedMounts is a list of allowed host-system mount points.
@@ -336,15 +288,6 @@ type Configuration struct {
 	// The Panel URL is automatically allowed, this is only needed for adding
 	// additional 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"`
-
-	// IgnorePanelConfigUpdates causes confiuration updates that are sent by the panel to be ignored.
-	IgnorePanelConfigUpdates bool `json:"ignore_panel_config_updates" yaml:"ignore_panel_config_updates"`
 }
 
 // NewAtPath creates a new struct and set the path where it should be stored.
@@ -438,7 +381,7 @@ func WriteToDisk(c *Configuration) error {
 	if err != nil {
 		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 nil
@@ -458,26 +401,13 @@ func EnsurePterodactylUser() error {
 	}
 
 	// 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.User.Uid = system.MustInt(system.FirstNotEmpty(os.Getenv("WINGS_UID"), "988"))
 		_config.System.User.Gid = system.MustInt(system.FirstNotEmpty(os.Getenv("WINGS_GID"), "988"))
 		return nil
 	}
 
-	if _config.System.User.Rootless.Enabled {
-		log.Info("rootless mode is enabled, skipping user creation...")
-		u, err := user.Current()
-		if err != nil {
-			return err
-		}
-		_config.System.Username = u.Username
-		_config.System.User.Uid = system.MustInt(u.Uid)
-		_config.System.User.Gid = system.MustInt(u.Gid)
-		return nil
-	}
-
-	log.WithField("username", _config.System.Username).Info("checking for pterodactyl system user")
 	u, err := user.Lookup(_config.System.Username)
 	// If an error is returned but it isn't the unknown user error just abort
 	// the process entirely. If we did find a user, return it immediately.
@@ -516,41 +446,10 @@ func EnsurePterodactylUser() error {
 	return nil
 }
 
-// ConfigurePasswd generates required passwd files for use with containers started by Wings.
-func ConfigurePasswd() error {
-	passwd := _config.System.Passwd
-	if !passwd.Enable {
-		return nil
-	}
-
-	v := []byte(fmt.Sprintf(
-		`root:x:0:
-container:x:%d:
-nogroup:x:65534:`,
-		_config.System.User.Gid,
-	))
-	if err := os.WriteFile(filepath.Join(passwd.Directory, "group"), v, 0o644); err != nil {
-		return fmt.Errorf("failed to write file to %s/group: %v", passwd.Directory, err)
-	}
-
-	v = []byte(fmt.Sprintf(
-		`root:x:0:0::/root:/bin/sh
-container:x:%d:%d::/home/container:/bin/sh
-nobody:x:65534:65534::/var/empty:/bin/sh
-`,
-		_config.System.User.Uid,
-		_config.System.User.Gid,
-	))
-	if err := os.WriteFile(filepath.Join(passwd.Directory, "passwd"), v, 0o644); err != nil {
-		return fmt.Errorf("failed to write file to %s/passwd: %v", passwd.Directory, err)
-	}
-	return nil
-}
-
 // FromFile reads the configuration from the provided file and stores it in the
 // global singleton for this instance.
 func FromFile(path string) error {
-	b, err := os.ReadFile(path)
+	b, err := ioutil.ReadFile(path)
 	if err != nil {
 		return err
 	}
@@ -558,17 +457,18 @@ func FromFile(path string) error {
 	if err != nil {
 		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 {
 		return err
 	}
-
 	// Store this configuration in the global state.
 	Set(c)
 	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,
 // and no other users.
 //
@@ -576,7 +476,7 @@ func FromFile(path string) error {
 func ConfigureDirectories() error {
 	root := _config.System.RootDirectory
 	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
 	}
 
@@ -597,27 +497,20 @@ func ConfigureDirectories() error {
 	}
 
 	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
 	}
 
 	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
 	}
 
 	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
 	}
 
-	if _config.System.Passwd.Enable {
-		log.WithField("path", _config.System.Passwd.Directory).Debug("ensuring passwd directory exists")
-		if err := os.MkdirAll(_config.System.Passwd.Directory, 0o755); err != nil {
-			return err
-		}
-	}
-
 	return nil
 }
 
@@ -652,7 +545,8 @@ func EnableLogRotation() error {
 	}
 	defer f.Close()
 
-	t, err := template.New("logrotate").Parse(`{{.LogDirectory}}/wings.log {
+	t, err := template.New("logrotate").Parse(`
+{{.LogDirectory}}/wings.log {
     size 10M
     compress
     delaycompress
@@ -660,8 +554,9 @@ func EnableLogRotation() error {
     maxage 7
     missingok
     notifempty
+    create 0640 {{.User.Uid}} {{.User.Gid}}
     postrotate
-        /usr/bin/systemctl kill -s HUP wings.service >/dev/null 2>&1 || true
+        killall -SIGHUP wings
     endscript
 }`)
 	if err != nil {
@@ -687,7 +582,7 @@ func ConfigureTimezone() error {
 		_config.System.Timezone = tz
 	}
 	if _config.System.Timezone == "" {
-		b, err := os.ReadFile("/etc/timezone")
+		b, err := ioutil.ReadFile("/etc/timezone")
 		if err != nil {
 			if !os.IsNotExist(err) {
 				return errors.WithMessage(err, "config: failed to open timezone file")
@@ -732,36 +627,3 @@ func getSystemName() (string, error) {
 	}
 	return release["ID"], nil
 }
-
-var (
-	openat2    atomic.Bool
-	openat2Set atomic.Bool
-)
-
-func UseOpenat2() bool {
-	if openat2Set.Load() {
-		return openat2.Load()
-	}
-	defer openat2Set.Store(true)
-
-	c := Get()
-	openatMode := c.System.OpenatMode
-	switch openatMode {
-	case "openat2":
-		openat2.Store(true)
-		return true
-	case "openat":
-		openat2.Store(false)
-		return false
-	default:
-		fd, err := unix.Openat2(unix.AT_FDCWD, "/", &unix.OpenHow{})
-		if err != nil {
-			log.WithError(err).Warn("error occurred while checking for openat2 support, falling back to openat")
-			openat2.Store(false)
-			return false
-		}
-		_ = unix.Close(fd)
-		openat2.Store(true)
-		return true
-	}
-}

config/config_docker.go

@@ -2,11 +2,9 @@ package config
 
 import (
 	"encoding/base64"
-	"sort"
+	"encoding/json"
 
-	"github.com/docker/docker/api/types/container"
+	"github.com/docker/docker/api/types"
-	"github.com/docker/docker/api/types/registry"
-	"github.com/goccy/go-json"
 )
 
 type dockerNetworkInterfaces struct {
@@ -37,7 +35,6 @@ type DockerNetworkConfiguration struct {
 	Mode       string                  `default:"pterodactyl_nw" yaml:"network_mode"`
 	IsInternal bool                    `default:"false" yaml:"is_internal"`
 	EnableICC  bool                    `default:"true" yaml:"enable_icc"`
-	NetworkMTU int64                   `default:"1500" yaml:"network_mtu"`
 	Interfaces dockerNetworkInterfaces `yaml:"interfaces"`
 }
 
@@ -54,55 +51,25 @@ type DockerConfiguration struct {
 	// 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"`
 
 	// 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
 	// malicious process could create enough processes to cause the host node to run out of
 	// 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
 	// 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 {
 		Memory int64 `default:"1024" json:"memory" yaml:"memory"`
 		Cpu    int64 `default:"100" json:"cpu" yaml:"cpu"`
 	} `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"`
-
-	// Sets the user namespace mode for the container when user namespace remapping option is
-	// enabled.
-	//
-	// If the value is blank, the daemon's user namespace remapping configuration is used,
-	// if the value is "host", then the pterodactyl containers are started with user namespace
-	// remapping disabled
-	UsernsMode string `default:"" json:"userns_mode" yaml:"userns_mode"`
-
-	LogConfig struct {
-		Type   string            `default:"local" json:"type" yaml:"type"`
-		Config map[string]string `default:"{\"max-size\":\"5m\",\"max-file\":\"1\",\"compress\":\"false\",\"mode\":\"non-blocking\"}" json:"config" yaml:"config"`
-	} `json:"log_config" yaml:"log_config"`
-}
-
-func (c DockerConfiguration) ContainerLogConfig() container.LogConfig {
-	if c.LogConfig.Type == "" {
-		return container.LogConfig{}
-	}
-
-	return container.LogConfig{
-		Type:   c.LogConfig.Type,
-		Config: c.LogConfig.Config,
-	}
 }
 
 // RegistryConfiguration defines the authentication credentials for a given
@@ -115,7 +82,7 @@ type RegistryConfiguration struct {
 // Base64 returns the authentication for a given registry as a base64 encoded
 // string value.
 func (c RegistryConfiguration) Base64() (string, error) {
-	b, err := json.Marshal(registry.AuthConfig{
+	b, err := json.Marshal(types.AuthConfig{
 		Username: c.Username,
 		Password: c.Password,
 	})
@@ -124,62 +91,3 @@ func (c RegistryConfiguration) Base64() (string, error) {
 	}
 	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
-}

environment/allocations.go

@@ -5,18 +5,12 @@ import (
 	"strconv"
 
 	"github.com/docker/go-connections/nat"
-
 	"github.com/pterodactyl/wings/config"
 )
 
 // Defines the allocations available for a given server. When using the Docker environment
 // driver these correspond to mappings for the container that allow external connections.
 type Allocations struct {
-	// ForceOutgoingIP causes a dedicated bridge network to be created for the
-	// server with a special option, causing Docker to SNAT outgoing traffic to
-	// the DefaultMapping's IP. This is important to servers which rely on external
-	// services that check the IP of the server (Source Engine servers, for example).
-	ForceOutgoingIP bool `json:"force_outgoing_ip"`
 	// Defines the default allocation that should be used for this server. This is
 	// what will be used for {SERVER_IP} and {SERVER_PORT} when modifying configuration
 	// files or the startup arguments for a server.
@@ -25,7 +19,7 @@ type Allocations struct {
 		Port int    `json:"port"`
 	} `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.
 	Mappings map[string][]int `json:"mappings"`
 }
@@ -36,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.
 func (a *Allocations) Bindings() nat.PortMap {
-	out := nat.PortMap{}
+	var out = nat.PortMap{}
 
 	for ip, ports := range a.Mappings {
 		for _, port := range ports {
@@ -68,7 +62,7 @@ func (a *Allocations) DockerBindings() nat.PortMap {
 	iface := config.Get().Docker.Network.Interface
 
 	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
 	// trying to do when creating servers.
 	for p, binds := range out {
@@ -99,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 empty structs. Because why not.
 func (a *Allocations) Exposed() nat.PortSet {
-	out := nat.PortSet{}
+	var out = nat.PortSet{}
 
 	for port := range a.DockerBindings() {
 		out[port] = struct{}{}

environment/config.go

@@ -8,7 +8,6 @@ type Settings struct {
 	Mounts      []Mount
 	Allocations Allocations
 	Limits      Limits
-	Labels      map[string]string
 }
 
 // Defines the actual configuration struct for the environment with all of the settings
@@ -69,14 +68,6 @@ func (c *Configuration) Mounts() []Mount {
 	return c.settings.Mounts
 }
 
-// Labels returns the container labels associated with this instance.
-func (c *Configuration) Labels() map[string]string {
-	c.mu.RLock()
-	defer c.mu.RUnlock()
-
-	return c.settings.Labels
-}
-
 // Returns the environment variables associated with this instance.
 func (c *Configuration) EnvironmentVariables() []string {
 	c.mu.RLock()

environment/docker.go

@@ -10,14 +10,11 @@ import (
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/network"
 	"github.com/docker/docker/client"
-
 	"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
 // client has been created it will be returned for all subsequent calls to this
@@ -41,14 +38,14 @@ func ConfigureDocker(ctx context.Context) error {
 	nw := config.Get().Docker.Network
 	resource, err := cli.NetworkInspect(ctx, nw.Name, types.NetworkInspectOptions{})
 	if err != nil {
-		if !client.IsErrNotFound(err) {
+		if client.IsErrNotFound(err) {
-			return err
-		}
-
 			log.Info("creating missing pterodactyl0 interface, this could take a few seconds...")
 			if err := createDockerNetwork(ctx, cli); err != nil {
 				return err
 			}
+		} else {
+			return err
+		}
 	}
 
 	config.Update(func(c *config.Configuration) {
@@ -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.host_binding_ipv4":    "0.0.0.0",
 			"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 {

environment/docker/api.go

@@ -1,120 +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")
-}

environment/docker/container.go

@@ -3,6 +3,7 @@ package docker
 import (
 	"bufio"
 	"context"
+	"encoding/json"
 	"fmt"
 	"io"
 	"strconv"
@@ -11,12 +12,11 @@ import (
 
 	"emperror.dev/errors"
 	"github.com/apex/log"
-	"github.com/buger/jsonparser"
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/mount"
 	"github.com/docker/docker/client"
-
+	"github.com/docker/docker/daemon/logger/jsonfilelog"
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/environment"
 	"github.com/pterodactyl/wings/system"
@@ -37,18 +37,22 @@ func (nw noopWriter) Write(b []byte) (int, error) {
 }
 
 // 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
-// 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 second 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() {
 		return nil
 	}
 
+	if err := e.followOutput(); err != nil {
+		return err
+	}
+
 	opts := types.ContainerAttachOptions{
 		Stdin:  true,
 		Stdout: true,
@@ -57,17 +61,14 @@ func (e *Environment) Attach(ctx context.Context) error {
 	}
 
 	// 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 errors.WrapIf(err, "environment/docker: error while attaching to container")
+		return err
 	} else {
 		e.SetStream(&st)
 	}
 
 	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 e.stream.Close()
 		defer func() {
@@ -76,7 +77,7 @@ func (e *Environment) Attach(ctx context.Context) error {
 		}()
 
 		go func() {
-			if err := e.pollResources(pollCtx); err != nil {
+			if err := e.pollResources(ctx); err != nil {
 				if !errors.Is(err, context.Canceled) {
 					e.log().WithField("error", err).Error("error during environment resource polling")
 				} else {
@@ -85,13 +86,20 @@ func (e *Environment) Attach(ctx context.Context) error {
 			}
 		}()
 
-		if err := system.ScanReader(e.stream.Reader, func(v []byte) {
+		// Block the completion of this routine until the container is no longer running. This allows
-			e.logCallbackMx.Lock()
+		// the pollResources function to run until it needs to be stopped. Because the container
-			defer e.logCallbackMx.Unlock()
+		// can be polled for resource usage, even when stopped, we need to have this logic present
-			e.logCallback(v)
+		// in order to cancel the context and therefore stop the routine that is spawned.
-		}); err != nil && err != io.EOF {
+		//
-			log.WithField("error", err).WithField("container_id", e.Id).Warn("error processing scanner line in console output")
+		// For now, DO NOT use client#ContainerWait from the Docker package. There is a nasty
-			return
+		// bug causing containers to hang on deletion and cause servers to lock up on the system.
+		//
+		// This weird code isn't intuitive, but it keeps the function from ending until the container
+		// is stopped and therefore the stream reader ends up closed.
+		// @see https://github.com/moby/moby/issues/41827
+		c := new(noopWriter)
+		if _, err := io.Copy(c, e.stream.Reader); err != nil {
+			e.log().WithField("error", err).Error("could not copy from environment stream to noop writer")
 		}
 	}()
 
@@ -106,7 +114,7 @@ func (e *Environment) InSituUpdate() error {
 	ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
 	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
 		// 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
@@ -131,19 +139,17 @@ func (e *Environment) InSituUpdate() error {
 	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
 // returned.
 func (e *Environment) Create() error {
-	ctx := context.Background()
-
 	// 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
 	// container anyways.
-	if _, err := e.ContainerInspect(ctx); err == nil {
+	if _, err := e.client.ContainerInspect(context.Background(), e.Id); err == nil {
 		return nil
 	} else if !client.IsErrNotFound(err) {
-		return errors.WrapIf(err, "environment/docker: failed to inspect container")
+		return errors.Wrap(err, "environment/docker: failed to inspect container")
 	}
 
 	// Try to pull the requested image before creating the container.
@@ -151,30 +157,21 @@ func (e *Environment) Create() error {
 		return errors.WithStackIf(err)
 	}
 
-	cfg := config.Get()
 	a := e.Configuration.Allocations()
+
 	evs := e.Configuration.EnvironmentVariables()
 	for i, v := range evs {
 		// Convert 127.0.0.1 to the pterodactyl0 network interface if the environment is Docker
 		// so that the server operates as expected.
 		if v == "SERVER_IP=127.0.0.1" {
-			evs[i] = "SERVER_IP=" + cfg.Docker.Network.Interface
+			evs[i] = "SERVER_IP=" + config.Get().Docker.Network.Interface
 		}
 	}
 
-	// Merge user-provided labels with system labels
-	confLabels := e.Configuration.Labels()
-	labels := make(map[string]string, 2+len(confLabels))
-
-	for key := range confLabels {
-		labels[key] = confLabels[key]
-	}
-	labels["Service"] = "Pterodactyl"
-	labels["ContainerType"] = "server_process"
-
 	conf := &container.Config{
 		Hostname:     e.Id,
-		Domainname:   cfg.Docker.Domainname,
+		Domainname:   config.Get().Docker.Domainname,
+		User:         strconv.Itoa(config.Get().System.User.Uid),
 		AttachStdin:  true,
 		AttachStdout: true,
 		AttachStderr: true,
@@ -183,69 +180,45 @@ func (e *Environment) Create() error {
 		ExposedPorts: a.Exposed(),
 		Image:        strings.TrimPrefix(e.meta.Image, "~"),
 		Env:          e.Configuration.EnvironmentVariables(),
-		Labels:       labels,
+		Labels: map[string]string{
-	}
+			"Service":       "Pterodactyl",
-
+			"ContainerType": "server_process",
-	// Set the user running the container properly depending on what mode we are operating in.
-	if cfg.System.User.Rootless.Enabled {
-		conf.User = fmt.Sprintf("%d:%d", cfg.System.User.Rootless.ContainerUID, cfg.System.User.Rootless.ContainerGID)
-	} else {
-		conf.User = strconv.Itoa(cfg.System.User.Uid) + ":" + strconv.Itoa(cfg.System.User.Gid)
-	}
-
-	networkMode := container.NetworkMode(cfg.Docker.Network.Mode)
-	if a.ForceOutgoingIP {
-		e.log().Debug("environment/docker: forcing outgoing IP address")
-		networkName := "ip-" + strings.ReplaceAll(strings.ReplaceAll(a.DefaultMapping.Ip, ".", "-"), ":", "-")
-		networkMode = container.NetworkMode(networkName)
-
-		if _, err := e.client.NetworkInspect(ctx, networkName, types.NetworkInspectOptions{}); err != nil {
-			if !client.IsErrNotFound(err) {
-				return err
-			}
-
-			if _, err := e.client.NetworkCreate(ctx, networkName, types.NetworkCreate{
-				Driver:     "bridge",
-				EnableIPv6: false,
-				Internal:   false,
-				Attachable: false,
-				Ingress:    false,
-				ConfigOnly: false,
-				Options: map[string]string{
-					"encryption": "false",
-					"com.docker.network.bridge.default_bridge": "false",
-					"com.docker.network.host_ipv4":             a.DefaultMapping.Ip,
 		},
-			}); err != nil {
-				return err
-			}
-		}
 	}
 
+	tmpfsSize := strconv.Itoa(int(config.Get().Docker.TmpfsSize))
+
 	hostConf := &container.HostConfig{
 		PortBindings: a.DockerBindings(),
 
 		// 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(),
 
 		// Configure the /tmp folder mapping in containers. This is necessary for some
 		// games that need to make use of it for downloads and other installation processes.
 		Tmpfs: map[string]string{
-			"/tmp": "rw,exec,nosuid,size=" + strconv.Itoa(int(cfg.Docker.TmpfsSize)) + "M",
+			"/tmp": "rw,exec,nosuid,size=" + tmpfsSize + "M",
 		},
 
 		// Define resource limits for the container based on the data passed through
 		// from the Panel.
 		Resources: e.Configuration.Limits().AsContainerResources(),
 
-		DNS: cfg.Docker.Network.Dns,
+		DNS: config.Get().Docker.Network.Dns,
 
 		// Configure logging for the container to make it easier on the Daemon to grab
 		// the server output. Ensure that we don't use too much space on the host machine
 		// since we only need it for the last few hundred lines of output and don't care
 		// about anything else in it.
-		LogConfig: cfg.Docker.ContainerLogConfig(),
+		LogConfig: container.LogConfig{
+			Type: jsonfilelog.Name,
+			Config: map[string]string{
+				"max-size": "5m",
+				"max-file": "1",
+				"compress": "false",
+			},
+		},
 
 		SecurityOpt:    []string{"no-new-privileges"},
 		ReadonlyRootfs: true,
@@ -253,11 +226,10 @@ func (e *Environment) Create() error {
 			"setpcap", "mknod", "audit_write", "net_raw", "dac_override",
 			"fowner", "fsetid", "net_bind_service", "sys_chroot", "setfcap",
 		},
-		NetworkMode: networkMode,
+		NetworkMode: container.NetworkMode(config.Get().Docker.Network.Mode),
-		UsernsMode:  container.UsernsMode(cfg.Docker.UsernsMode),
 	}
 
-	if _, err := e.client.ContainerCreate(ctx, conf, hostConf, nil, nil, e.Id); err != nil {
+	if _, err := e.client.ContainerCreate(context.Background(), conf, hostConf, nil, nil, e.Id); err != nil {
 		return errors.Wrap(err, "environment/docker: failed to create container")
 	}
 
@@ -335,12 +307,72 @@ func (e *Environment) Readlog(lines int) ([]string, error) {
 	return out, nil
 }
 
+// Attaches to the log for the container. This avoids us missing crucial output
+// that happens in the split seconds before the code moves from 'Starting' to
+// 'Attaching' on the process.
+func (e *Environment) followOutput() error {
+	if exists, err := e.Exists(); !exists {
+		if err != nil {
+			return err
+		}
+		return errors.New(fmt.Sprintf("no such container: %s", e.Id))
+	}
+
+	opts := types.ContainerLogsOptions{
+		ShowStderr: true,
+		ShowStdout: true,
+		Follow:     true,
+		Since:      time.Now().Format(time.RFC3339),
+	}
+
+	reader, err := e.client.ContainerLogs(context.Background(), e.Id, opts)
+	if err != nil {
+		return err
+	}
+
+	go e.scanOutput(reader)
+
+	return nil
+}
+
+func (e *Environment) scanOutput(reader io.ReadCloser) {
+	defer reader.Close()
+
+	events := e.Events()
+
+	err := system.ScanReader(reader, func(line string) {
+		events.Publish(environment.ConsoleOutputEvent, line)
+	})
+
+	if err != nil && err != io.EOF {
+		log.WithField("error", err).WithField("container_id", e.Id).Warn("error processing scanner line in console output")
+		return
+	}
+
+	// Return here if the server is offline or currently stopping.
+	if e.State() == environment.ProcessStoppingState || e.State() == environment.ProcessOfflineState {
+		return
+	}
+
+	// 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.
+	_ = reader.Close()
+
+	// Start following the output of the server again.
+	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
 // from the source but the image already exists locally, we will report that
 // error to the logger but continue with the process.
 //
 // 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
 // badly. It'll at least keep existing servers working correctly if anything.
 func (e *Environment) ensureImageExists(image string) error {
@@ -420,11 +452,12 @@ func (e *Environment) ensureImageExists(image string) error {
 	scanner := bufio.NewScanner(out)
 
 	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 {
@@ -450,3 +483,21 @@ func (e *Environment) convertMounts() []mount.Mount {
 
 	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,
+	}
+}

environment/docker/environment.go

@@ -3,6 +3,7 @@ package docker
 import (
 	"context"
 	"fmt"
+	"github.com/pterodactyl/wings/metrics"
 	"io"
 	"sync"
 
@@ -10,7 +11,6 @@ import (
 	"github.com/apex/log"
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/client"
-
 	"github.com/pterodactyl/wings/environment"
 	"github.com/pterodactyl/wings/events"
 	"github.com/pterodactyl/wings/remote"
@@ -22,12 +22,13 @@ type Metadata struct {
 	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.
 var _ environment.ProcessEnvironment = (*Environment)(nil)
 
 type Environment struct {
 	mu      sync.RWMutex
+	eventMu sync.Once
 
 	// 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.
@@ -48,10 +49,7 @@ type Environment struct {
 	// Holds the stats stream used by the polling commands so that we can easily close it out.
 	stats io.ReadCloser
 
-	emitter *events.Bus
+	emitter *events.EventBus
-
-	logCallbackMx sync.Mutex
-	logCallback   func([]byte)
 
 	// Tracks the environment state.
 	st *system.AtomicString
@@ -73,7 +71,6 @@ func New(id string, m *Metadata, c *environment.Configuration) (*Environment, er
 		meta:          m,
 		client:        cli,
 		st:            system.NewAtomicString(environment.ProcessOfflineState),
-		emitter:       events.NewBus(),
 	}
 
 	return e, nil
@@ -87,67 +84,71 @@ func (e *Environment) Type() string {
 	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) {
 	e.mu.Lock()
+	defer e.mu.Unlock()
+
 	e.stream = s
-	e.mu.Unlock()
 }
 
-// IsAttached determines if 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 {
 	e.mu.RLock()
 	defer e.mu.RUnlock()
+
 	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
 }
 
-// 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) {
-	_, err := e.ContainerInspect(context.Background())
+	_, err := e.client.ContainerInspect(context.Background(), e.Id)
+
 	if err != nil {
 		// If this error is because the container instance wasn't found via Docker we
 		// can safely ignore the error and just return false.
 		if client.IsErrNotFound(err) {
 			return false, nil
 		}
+
 		return false, err
 	}
+
 	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
-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 {
 		return false, err
 	}
+
 	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.
 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 {
 		// 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
@@ -161,13 +162,15 @@ func (e *Environment) ExitState() (uint32, bool, error) {
 		if client.IsErrNotFound(err) {
 			return 1, false, nil
 		}
-		return 0, false, errors.WrapIf(err, "environment/docker: failed to inspect container")
+
+		return 0, false, err
 	}
+
 	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 {
 	e.mu.RLock()
 	defer e.mu.RUnlock()
@@ -175,11 +178,12 @@ func (e *Environment) Config() *environment.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) {
 	e.mu.Lock()
+	defer e.mu.Unlock()
+
 	e.meta.Stop = c
-	e.mu.Unlock()
 }
 
 func (e *Environment) SetImage(i string) {
@@ -209,12 +213,15 @@ func (e *Environment) SetState(state string) {
 		// If the state changed make sure we update the internal tracking to note that.
 		e.st.Store(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
-}

environment/docker/power.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"os"
 	"strings"
+	"syscall"
 	"time"
 
 	"emperror.dev/errors"
@@ -11,22 +12,20 @@ import (
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/client"
-
 	"github.com/pterodactyl/wings/environment"
 	"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.
-	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) {
 			return errors.WrapIf(err, "environment/docker: failed to remove container during pre-boot")
 		}
@@ -38,7 +37,7 @@ func (e *Environment) OnBeforeStart(ctx context.Context) error {
 	//
 	// This won't actually run an installation process however, it is just here to ensure the
 	// environment gets created properly if it is missing and the server is started. We're making
-	// an assumption that all the files will still exist at this point.
+	// an assumption that all of the files will still exist at this point.
 	if err := e.Create(); err != nil {
 		return err
 	}
@@ -46,10 +45,10 @@ func (e *Environment) OnBeforeStart(ctx context.Context) error {
 	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
 
 	// If sawError is set to true there was an error somewhere in the pipeline that
@@ -65,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
 		// to the next block of code here. This check was inlined here to guard against
 		// a nil-pointer when checking c.State below.
@@ -79,10 +78,10 @@ func (e *Environment) Start(ctx context.Context) error {
 		if c.State.Running {
 			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 truncate them.
 		if _, err := os.Stat(c.LogPath); err == nil {
@@ -101,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
 	// exists on the system, and rebuild the container if that is required for server booting to
 	// occur.
-	if err := e.OnBeforeStart(ctx); err != nil {
+	if err := e.OnBeforeStart(); err != nil {
-		return errors.WrapIf(err, "environment/docker: failed to run pre-boot process")
+		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()
 
-	// 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 errors.WrapIf(err, "environment/docker: failed to attach to container")
-	}
-
-	if err := e.client.ContainerStart(actx, e.Id, types.ContainerStartOptions{}); err != nil {
 		return errors.WrapIf(err, "environment/docker: failed to start container")
 	}
 
 	// No errors, good to continue through.
 	sawError = false
-	return nil
+
+	return e.Attach()
 }
 
 // Stop stops the container that the server is running in. This will allow up to
@@ -137,60 +124,49 @@ func (e *Environment) Start(ctx context.Context) error {
 // 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
 // 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()
 	s := e.meta.Stop
 	e.mu.RUnlock()
 
+	// A native "stop" as the Type field value will just skip over all of this
+	// logic and end up only executing the container stop command (which may or
+	// may not work as expected).
+	if s.Type == "" || s.Type == remote.ProcessStopSignal {
+		if s.Type == "" {
+			log.WithField("container_id", e.Id).Warn("no stop configuration detected for environment, using termination procedure")
+		}
+
+		signal := os.Kill
+		// Handle a few common cases, otherwise just fall through and just pass along
+		// the os.Kill signal to the process.
+		switch strings.ToUpper(s.Value) {
+		case "SIGABRT":
+			signal = syscall.SIGABRT
+		case "SIGINT":
+			signal = syscall.SIGINT
+		case "SIGTERM":
+			signal = syscall.SIGTERM
+		}
+		return e.Terminate(signal)
+	}
+
 	// If the process is already offline don't switch it back to stopping. Just leave it how
 	// it is and continue through to the stop handling for the process.
 	if e.st.Load() != environment.ProcessOfflineState {
 		e.SetState(environment.ProcessStoppingState)
 	}
 
-	// Handle signal based actions
-	if s.Type == remote.ProcessStopSignal {
-		log.WithField("signal_value", s.Value).Debug("stopping server using signal")
-
-		// Handle some common signals - Default to SIGKILL
-		signal := "SIGKILL"
-		switch strings.ToUpper(s.Value) {
-		case "SIGABRT":
-			signal = "SIGABRT"
-		case "SIGINT", "C":
-			signal = "SIGINT"
-		case "SIGTERM":
-			signal = "SIGTERM"
-		case "SIGKILL":
-			signal = "SIGKILL"
-		default:
-			log.Info("Unrecognised signal requested, defaulting to SIGKILL")
-		}
-
-		return e.SignalContainer(ctx, signal)
-
-	}
-
-	// Handle command based stops
 	// Only attempt to send the stop command to the instance if we are actually attached to
 	// the instance. If we are not for some reason, just send the container stop event.
 	if e.IsAttached() && s.Type == remote.ProcessStopCommand {
 		return e.SendCommand(s.Value)
 	}
 
-	if s.Type == "" {
+	t := time.Second * 30
-		log.WithField("container_id", e.Id).Warn("no stop configuration detected for environment, using native docker stop")
+	if err := e.client.ContainerStop(context.Background(), e.Id, &t); err != nil {
-	}
-
-	// Fallback to a native docker stop. As we aren't passing a signal to ContainerStop docker will
-	// attempt to stop the container using the default stop signal, SIGTERM, unless
-	// another signal was specified in the Dockerfile
-	//
-	// Using a negative timeout here will allow the container to stop gracefully,
-	// rather than forcefully terminating it.  Value is in seconds, but -1 is
-	// treated as indefinitely.
-	timeout := -1
-	if err := e.client.ContainerStop(ctx, e.Id, container.StopOptions{Timeout: &timeout}); err != nil {
 		// If the container does not exist just mark the process as stopped and return without
 		// an error.
 		if client.IsErrNotFound(err) {
@@ -208,75 +184,54 @@ func (e *Environment) Stop(ctx context.Context) error {
 // 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
 // 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, "SIGKILL")
-	}
-
-	// 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
 	}
 
+	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
 	// longer running. If this wait does not end by the time seconds have passed,
 	// 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 {
 	case <-ctx.Done():
-		if err := ctx.Err(); err != nil {
+		if ctxErr := ctx.Err(); ctxErr != nil {
 			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:
 		// If the error stems from the container not existing there is no point in wasting
 		// 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 !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")
+		}
 	case <-ok:
 	}
 
 	return nil
 }
 
-// Sends the specified signal to the container in an attempt to stop it.
+// Terminate forcefully terminates the container using the signal provided.
-func (e *Environment) SignalContainer(ctx context.Context, signal string) 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 {
 		// Treat missing containers as an okay error state, means it is obviously
 		// already terminated at this point.
@@ -287,7 +242,7 @@ func (e *Environment) SignalContainer(ctx context.Context, signal string) error
 	}
 
 	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
 		// first so crash detection is not triggered.
 		if e.st.Load() != environment.ProcessOfflineState {
@@ -300,27 +255,11 @@ func (e *Environment) SignalContainer(ctx context.Context, signal string) error
 
 	// We set it to stopping than offline to prevent crash detection from being triggered.
 	e.SetState(environment.ProcessStoppingState)
-	if err := e.client.ContainerKill(ctx, e.Id, signal); err != nil && !client.IsErrNotFound(err) {
+	sig := strings.TrimSuffix(strings.TrimPrefix(signal.String(), "signal "), "ed")
+	if err := e.client.ContainerKill(context.Background(), e.Id, sig); err != nil && !client.IsErrNotFound(err) {
 		return errors.WithStack(err)
 	}
-
-	return nil
-
-}
-
-// Terminate forcefully terminates the container using the signal provided.
-// then sets its state to stopped.
-func (e *Environment) Terminate(ctx context.Context, signal string) error {
-
-	// Send the signal to the container to kill it
-	if err := e.SignalContainer(ctx, signal); err != nil {
-		return errors.WithStack(err)
-	}
-
-	// We expect Terminate to instantly kill the container
-	// so go ahead and mark it as dead and clean up
 	e.SetState(environment.ProcessOfflineState)
 
 	return nil
-
 }

environment/docker/stats.go

@@ -2,34 +2,15 @@ package docker
 
 import (
 	"context"
+	"emperror.dev/errors"
+	"encoding/json"
+	"github.com/docker/docker/api/types"
+	"github.com/pterodactyl/wings/environment"
+	"github.com/pterodactyl/wings/metrics"
 	"io"
 	"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
 // server process changes.
 func (e *Environment) pollResources(ctx context.Context) error {
@@ -46,11 +27,6 @@ func (e *Environment) pollResources(ctx context.Context) error {
 	}
 	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)
 	for {
 		select {
@@ -73,12 +49,7 @@ func (e *Environment) pollResources(ctx context.Context) error {
 				return nil
 			}
 
-			if !v.PreRead.IsZero() {
-				uptime = uptime + v.Read.Sub(v.PreRead).Milliseconds()
-			}
-
 			st := environment.Stats{
-				Uptime:      uptime,
 				Memory:      calculateDockerMemory(v.MemoryStats),
 				MemoryLimit: v.MemoryStats.Limit,
 				CpuAbsolute: calculateDockerAbsoluteCpu(v.PreCPUStats, v.CPUStats),
@@ -90,7 +61,16 @@ func (e *Environment) pollResources(ctx context.Context) error {
 				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
 // 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
 func calculateDockerMemory(stats types.MemoryStats) uint64 {
@@ -134,11 +115,7 @@ func calculateDockerAbsoluteCpu(pStats types.CPUStats, stats types.CPUStats) flo
 
 	percent := 0.0
 	if systemDelta > 0.0 && cpuDelta > 0.0 {
-		percent = (cpuDelta / systemDelta) * 100.0
+		percent = (cpuDelta / systemDelta) * cpus * 100.0
-
-		if cpus > 0 {
-			percent *= cpus
-		}
 	}
 
 	return math.Round(percent*1000) / 1000

environment/environment.go

@@ -1,13 +1,13 @@
 package environment
 
 import (
-	"context"
+	"os"
-	"time"
 
 	"github.com/pterodactyl/wings/events"
 )
 
 const (
+	ConsoleOutputEvent       = "console output"
 	StateChangeEvent         = "state change"
 	ResourceEvent            = "resources"
 	DockerImagePullStarted   = "docker image pull started"
@@ -34,16 +34,16 @@ type ProcessEnvironment interface {
 	// 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, only subscribe to them.
-	Events() *events.Bus
+	Events() *events.EventBus
 
 	// 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
 	// a basic CLI environment this can probably just return true right away.
 	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
 	// process. This only executes if the environment supports it, otherwise it is
@@ -52,26 +52,24 @@ type ProcessEnvironment interface {
 
 	// Runs before the environment is started. If an error is returned starting will
 	// 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
 	// 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 string) error
+	Terminate(signal os.Signal) error
 
 	// Destroys the environment removing any containers that were created (in Docker
 	// environments at least).
@@ -86,10 +84,10 @@ type ProcessEnvironment interface {
 	// server.
 	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.
-	Attach(ctx context.Context) error
+	Attach() error
 
 	// Sends the provided command to the running server instance.
 	SendCommand(string) error
@@ -105,11 +103,4 @@ type ProcessEnvironment interface {
 	// handle this itself, but there are some scenarios where it is helpful for the server
 	// to update the state externally (e.g. starting -> started).
 	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))
 }

environment/settings.go

@@ -7,7 +7,6 @@ import (
 
 	"github.com/apex/log"
 	"github.com/docker/docker/api/types/container"
-
 	"github.com/pterodactyl/wings/config"
 )
 
@@ -26,7 +25,7 @@ type Mount struct {
 	// that we're mounting into the container at the Target location.
 	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.
 	ReadOnly bool `json:"read_only"`
 }
@@ -34,7 +33,7 @@ type Mount struct {
 // Limits is the build settings for a given server that impact docker container
 // creation and resource limits for a server instance.
 type Limits struct {
-	// The total amount of memory in mebibytes that this server is allowed to
+	// The total amount of memory in megabytes that this server is allowed to
 	// use on the host system.
 	MemoryLimit int64 `json:"memory_limit"`
 
@@ -75,11 +74,17 @@ func (l Limits) ConvertedCpuLimit() int64 {
 // server is < 4G, use 10%, if less than 2G use 15%. This avoids unexpected
 // crashes from processes like Java which run over the limit.
 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 {
-	return int64(math.Round(float64(l.MemoryLimit) * l.MemoryOverheadMultiplier() * 1024 * 1024))
+	return int64(math.Round(float64(l.MemoryLimit) * l.MemoryOverheadMultiplier() * 1_000_000))
 }
 
 // ConvertedSwap returns the amount of swap available as a total in bytes. This
@@ -90,7 +95,7 @@ func (l Limits) ConvertedSwap() int64 {
 		return -1
 	}
 
-	return (l.Swap * 1024 * 1024) + l.BoundedMemoryLimit()
+	return (l.Swap * 1_000_000) + l.BoundedMemoryLimit()
 }
 
 // ProcessLimit returns the process limit for a container. This is currently
@@ -99,36 +104,21 @@ func (l Limits) ProcessLimit() int64 {
 	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 {
 	pids := l.ProcessLimit()
-	resources := container.Resources{
+
+	return container.Resources{
 		Memory:            l.BoundedMemoryLimit(),
-		MemoryReservation: l.MemoryLimit * 1024 * 1024,
+		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,
 	}
-
-	// 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{}

environment/stats.go

@@ -1,6 +1,8 @@
 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 {
 	// 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
@@ -10,18 +12,19 @@ type Stats struct {
 
 	// 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
-	// 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"`
 
 	// 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.
 	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.
 	Network NetworkStats `json:"network"`
-
-	// The current uptime of the container, in milliseconds.
-	Uptime int64 `json:"uptime"`
 }
 
 type NetworkStats struct {

events/events.go

@@ -1,71 +1,122 @@
 package events
 
 import (
+	"encoding/json"
 	"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 {
+	Data  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.
 	//
-	// 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".
 	if strings.Contains(topic, ":") {
 		parts := strings.SplitN(topic, ":", 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 {
-		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
 }
+
+// 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)
+}

events/events_test.go

@@ -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)
-			})
-		})
-	})
-}

events/pool.go

@@ -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
+}

flake.lock

@@ -1,79 +0,0 @@
-{
-  "nodes": {
-    "flake-parts": {
-      "inputs": {
-        "nixpkgs-lib": "nixpkgs-lib"
-      },
-      "locked": {
-        "lastModified": 1719994518,
-        "narHash": "sha256-pQMhCCHyQGRzdfAkdJ4cIWiw+JNuWsTX7f0ZYSyz0VY=",
-        "owner": "hercules-ci",
-        "repo": "flake-parts",
-        "rev": "9227223f6d922fee3c7b190b2cc238a99527bbb7",
-        "type": "github"
-      },
-      "original": {
-        "owner": "hercules-ci",
-        "repo": "flake-parts",
-        "type": "github"
-      }
-    },
-    "nixpkgs": {
-      "locked": {
-        "lastModified": 1721562059,
-        "narHash": "sha256-Tybxt65eyOARf285hMHIJ2uul8SULjFZbT9ZaEeUnP8=",
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "68c9ed8bbed9dfce253cc91560bf9043297ef2fe",
-        "type": "github"
-      },
-      "original": {
-        "owner": "NixOS",
-        "ref": "nixos-unstable",
-        "repo": "nixpkgs",
-        "type": "github"
-      }
-    },
-    "nixpkgs-lib": {
-      "locked": {
-        "lastModified": 1719876945,
-        "narHash": "sha256-Fm2rDDs86sHy0/1jxTOKB1118Q0O3Uc7EC0iXvXKpbI=",
-        "type": "tarball",
-        "url": "https://github.com/NixOS/nixpkgs/archive/5daf0514482af3f97abaefc78a6606365c9108e2.tar.gz"
-      },
-      "original": {
-        "type": "tarball",
-        "url": "https://github.com/NixOS/nixpkgs/archive/5daf0514482af3f97abaefc78a6606365c9108e2.tar.gz"
-      }
-    },
-    "root": {
-      "inputs": {
-        "flake-parts": "flake-parts",
-        "nixpkgs": "nixpkgs",
-        "treefmt-nix": "treefmt-nix"
-      }
-    },
-    "treefmt-nix": {
-      "inputs": {
-        "nixpkgs": [
-          "nixpkgs"
-        ]
-      },
-      "locked": {
-        "lastModified": 1721769617,
-        "narHash": "sha256-6Pqa0bi5nV74IZcENKYRToRNM5obo1EQ+3ihtunJ014=",
-        "owner": "numtide",
-        "repo": "treefmt-nix",
-        "rev": "8db8970be1fb8be9c845af7ebec53b699fe7e009",
-        "type": "github"
-      },
-      "original": {
-        "owner": "numtide",
-        "repo": "treefmt-nix",
-        "type": "github"
-      }
-    }
-  },
-  "root": "root",
-  "version": 7
-}

flake.nix

@@ -1,54 +0,0 @@
-{
-  description = "Wings";
-
-  inputs = {
-    flake-parts.url = "github:hercules-ci/flake-parts";
-    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
-
-    treefmt-nix = {
-      url = "github:numtide/treefmt-nix";
-      inputs.nixpkgs.follows = "nixpkgs";
-    };
-  };
-
-  outputs = {...} @ inputs:
-    inputs.flake-parts.lib.mkFlake {inherit inputs;} {
-      systems = ["aarch64-darwin" "aarch64-linux" "x86_64-darwin" "x86_64-linux"];
-
-      imports = [
-        inputs.treefmt-nix.flakeModule
-      ];
-
-      perSystem = {system, ...}: let
-        pkgs = import inputs.nixpkgs {inherit system;};
-      in {
-         devShells.default = pkgs.mkShell {
-          buildInputs = with pkgs; [
-            go_1_22
-            gofumpt
-            golangci-lint
-            gotools 
-          ];
-        };
-
-        treefmt = {
-          projectRootFile = "flake.nix";
-
-          programs = {
-            alejandra.enable = true;
-            deadnix.enable = true;
-            gofumpt = {
-              enable = true;
-              extra = true;
-            };
-            shellcheck.enable = true;
-            shfmt = {
-              enable = true;
-              indent_size = 0; # 0 causes shfmt to use tabs
-            };
-            yamlfmt.enable = true;
-          };
-        };
-      };
-    };
-}

go.mod

@@ -1,137 +1,83 @@
 module github.com/pterodactyl/wings
 
-go 1.21
+go 1.14
 
 require (
-	emperror.dev/errors v0.8.1
+	emperror.dev/errors v0.8.0
-	github.com/AlecAivazis/survey/v2 v2.3.7
+	github.com/AlecAivazis/survey/v2 v2.2.7
-	github.com/Jeffail/gabs/v2 v2.7.0
+	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/acobaugh/osrelease v0.1.0
+	github.com/andybalholm/brotli v1.0.1 // indirect
 	github.com/apex/log v1.9.0
-	github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2
+	github.com/asaskevich/govalidator v0.0.0-20200907205600-7a23bdc65eef
-	github.com/beevik/etree v1.3.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.3.0
+	github.com/cenkalti/backoff/v4 v4.1.0
-	github.com/creasty/defaults v1.7.0
+	github.com/cobaugh/osrelease v0.0.0-20181218015638-a93a0a55a249
-	github.com/docker/docker v25.0.4+incompatible
+	github.com/containerd/containerd v1.4.3 // indirect
-	github.com/docker/go-connections v0.5.0
+	github.com/containerd/fifo v0.0.0-20201026212402-0724c46b320c // indirect
-	github.com/fatih/color v1.16.0
+	github.com/creasty/defaults v1.5.1
-	github.com/franela/goblin v0.0.0-20211003143422-0a4f594942bf
+	github.com/docker/distribution v2.7.1+incompatible // indirect
-	github.com/gabriel-vasile/mimetype v1.4.3
+	github.com/docker/docker v20.10.1+incompatible
-	github.com/gammazero/workerpool v1.1.3
+	github.com/docker/go-connections v0.4.0
-	github.com/gbrlsnchs/jwt/v3 v3.0.1
+	github.com/docker/go-metrics v0.0.1 // indirect
-	github.com/gin-gonic/gin v1.9.1
+	github.com/fatih/color v1.10.0
-	github.com/glebarez/sqlite v1.11.0
+	github.com/franela/goblin v0.0.0-20200825194134-80c0062ed6cd
-	github.com/go-co-op/gocron v1.37.0
+	github.com/fsnotify/fsnotify v1.4.9 // indirect
-	github.com/goccy/go-json v0.10.2
+	github.com/gabriel-vasile/mimetype v1.1.2
-	github.com/google/uuid v1.6.0
+	github.com/gammazero/deque v0.0.0-20201010052221-3932da5530cc // indirect
-	github.com/gorilla/websocket v1.5.1
+	github.com/gammazero/workerpool v1.1.1
-	github.com/iancoleman/strcase v0.3.0
+	github.com/gbrlsnchs/jwt/v3 v3.0.0
-	github.com/icza/dyno v0.0.0-20230330125955-09f820a8d9c0
+	github.com/gin-gonic/gin v1.6.3
-	github.com/juju/ratelimit v1.0.2
+	github.com/go-playground/validator/v10 v10.4.1 // indirect
-	github.com/klauspost/compress v1.17.8
+	github.com/golang/snappy v0.0.2 // indirect
-	github.com/klauspost/pgzip v1.2.6
+	github.com/google/go-cmp v0.5.2 // indirect
-	github.com/magiconair/properties v1.8.7
+	github.com/google/uuid v1.1.2
-	github.com/mattn/go-colorable v0.1.13
+	github.com/gorilla/mux v1.7.4 // indirect
-	github.com/mholt/archiver/v4 v4.0.0-alpha.8
+	github.com/gorilla/websocket v1.4.2
-	github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db
+	github.com/iancoleman/strcase v0.1.2
-	github.com/patrickmn/go-cache v2.1.0+incompatible
+	github.com/icza/dyno v0.0.0-20200205103839-49cb13720835
-	github.com/pkg/sftp v1.13.6
+	github.com/imdario/mergo v0.3.9
-	github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06
+	github.com/juju/ratelimit v1.0.1
-	github.com/spf13/cobra v1.8.0
+	github.com/karrick/godirwalk v1.16.1
-	github.com/stretchr/testify v1.9.0
+	github.com/klauspost/compress v1.11.4 // indirect
-	golang.org/x/crypto v0.22.0
+	github.com/klauspost/pgzip v1.2.5
-	golang.org/x/sync v0.7.0
+	github.com/leodido/go-urn v1.2.1 // indirect
-	golang.org/x/sys v0.19.0
+	github.com/magefile/mage v1.10.0 // indirect
-	gopkg.in/ini.v1 v1.67.0
+	github.com/magiconair/properties v1.8.4
-	gopkg.in/yaml.v2 v2.4.0
+	github.com/mattn/go-colorable v0.1.8
-	gopkg.in/yaml.v3 v3.0.1
-	gorm.io/gorm v1.25.9
-)
-
-require (
-	github.com/Microsoft/go-winio v0.6.1 // indirect
-	github.com/Microsoft/hcsshim v0.12.2 // indirect
-	github.com/andybalholm/brotli v1.1.0 // indirect
-	github.com/bodgit/plumbing v1.3.0 // indirect
-	github.com/bodgit/sevenzip v1.5.1 // indirect
-	github.com/bodgit/windows v1.0.1 // indirect
-	github.com/bytedance/sonic v1.11.3 // indirect
-	github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d // indirect
-	github.com/chenzhuoyu/iasm v0.9.1 // indirect
-	github.com/containerd/log v0.1.0 // indirect
-	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/distribution/reference v0.6.0 // indirect
-	github.com/docker/go-units v0.5.0 // indirect
-	github.com/dsnet/compress v0.0.2-0.20210315054119-f66993602bf5 // indirect
-	github.com/dustin/go-humanize v1.0.1 // indirect
-	github.com/felixge/httpsnoop v1.0.4 // indirect
-	github.com/gammazero/deque v0.2.1 // indirect
-	github.com/gin-contrib/sse v0.1.0 // indirect
-	github.com/glebarez/go-sqlite v1.22.0 // indirect
-	github.com/go-logr/logr v1.4.1 // indirect
-	github.com/go-logr/stdr v1.2.2 // indirect
-	github.com/go-playground/locales v0.14.1 // indirect
-	github.com/go-playground/universal-translator v0.18.1 // indirect
-	github.com/go-playground/validator/v10 v10.19.0 // indirect
-	github.com/gogo/protobuf v1.3.2 // indirect
-	github.com/golang/snappy v0.0.4 // indirect
-	github.com/hashicorp/errwrap v1.1.0 // indirect
-	github.com/hashicorp/go-multierror v1.1.1 // indirect
-	github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
-	github.com/inconshreveable/mousetrap v1.1.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/klauspost/cpuid/v2 v2.2.7 // indirect
-	github.com/kr/fs v0.1.0 // indirect
-	github.com/leodido/go-urn v1.4.0 // indirect
-	github.com/magefile/mage v1.15.0 // indirect
-	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
-	github.com/moby/term v0.0.0-20220808134915-39b0c02b01ae // indirect
+	github.com/mholt/archiver/v3 v3.5.0
-	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db
-	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/moby/term v0.0.0-20201216013528-df9cb8a40635 // indirect
 	github.com/morikuni/aec v1.0.0 // indirect
-	github.com/ncruces/go-strftime v0.1.9 // indirect
+	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
-	github.com/nwaples/rardecode/v2 v2.0.0-beta.2 // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect
-	github.com/opencontainers/image-spec v1.1.0 // indirect
+	github.com/opencontainers/image-spec v1.0.1 // indirect
-	github.com/pelletier/go-toml/v2 v2.2.0 // indirect
+	github.com/patrickmn/go-cache v2.1.0+incompatible
-	github.com/pierrec/lz4/v4 v4.1.21 // indirect
+	github.com/pierrec/lz4/v4 v4.1.2 // indirect
-	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pkg/profile v1.5.0
-	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/pkg/sftp v1.12.0
-	github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
+	github.com/prometheus/client_golang v1.9.0 // indirect
-	github.com/robfig/cron/v3 v3.0.1 // indirect
+	github.com/sabhiram/go-gitignore v0.0.0-20201211210132-54b8a0bf510f
-	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/sirupsen/logrus v1.7.0 // indirect
-	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/spf13/cobra v1.1.1
-	github.com/therootcompany/xz v1.0.1 // indirect
+	github.com/stretchr/testify v1.6.1
-	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
+	github.com/ugorji/go v1.2.2 // indirect
-	github.com/ugorji/go/codec v1.2.12 // indirect
+	github.com/ulikunitz/xz v0.5.9 // indirect
-	github.com/ulikunitz/xz v0.5.12 // indirect
+	golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad
-	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.50.0 // indirect
+	golang.org/x/net v0.0.0-20201224014010-6772e930b67b // indirect
-	go.opentelemetry.io/otel v1.25.0 // indirect
+	golang.org/x/sync v0.0.0-20201207232520-09787c993a3a
-	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.24.0 // indirect
+	golang.org/x/sys v0.0.0-20201223074533-0d417f636930 // indirect
-	go.opentelemetry.io/otel/metric v1.25.0 // indirect
+	golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf // indirect
-	go.opentelemetry.io/otel/sdk v1.24.0 // indirect
+	golang.org/x/text v0.3.4 // indirect
-	go.opentelemetry.io/otel/trace v1.25.0 // indirect
+	golang.org/x/time v0.0.0-20201208040808-7e3f01d25324 // indirect
-	go.uber.org/atomic v1.11.0 // indirect
+	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
-	go.uber.org/multierr v1.11.0 // indirect
+	google.golang.org/genproto v0.0.0-20201214200347-8c77b98c765d // indirect
-	go4.org v0.0.0-20230225012048-214862532bf5 // indirect
+	google.golang.org/grpc v1.34.0 // indirect
-	golang.org/x/arch v0.7.0 // indirect
+	gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
-	golang.org/x/mod v0.17.0 // indirect
+	gopkg.in/ini.v1 v1.62.0
-	golang.org/x/net v0.24.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0
-	golang.org/x/term v0.19.0 // indirect
-	golang.org/x/text v0.14.0 // indirect
-	golang.org/x/time v0.0.0-20220922220347-f3bd1da661af // indirect
-	golang.org/x/tools v0.20.0 // indirect
-	golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028 // indirect
-	google.golang.org/protobuf v1.33.0 // indirect
-	gotest.tools/v3 v3.0.2 // indirect
-	modernc.org/libc v1.49.3 // indirect
-	modernc.org/mathutil v1.6.0 // indirect
-	modernc.org/memory v1.8.0 // indirect
-	modernc.org/sqlite v1.29.6 // indirect
 )

installer/installer.go

@@ -0,0 +1,113 @@
+package installer
+
+import (
+	"context"
+	"encoding/json"
+
+	"emperror.dev/errors"
+	"github.com/asaskevich/govalidator"
+	"github.com/buger/jsonparser"
+	"github.com/pterodactyl/wings/environment"
+	"github.com/pterodactyl/wings/remote"
+	"github.com/pterodactyl/wings/server"
+)
+
+type Installer struct {
+	server *server.Server
+}
+
+// New validates the received data to ensure that all of the required fields
+// have been passed along in the request. This should be manually run before
+// calling Execute().
+func New(ctx context.Context, manager *server.Manager, data []byte) (*Installer, error) {
+	if !govalidator.IsUUIDv4(getString(data, "uuid")) {
+		return nil, NewValidationError("uuid provided was not in a valid format")
+	}
+
+	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 !remote.IsRequestError(err) {
+			return nil, errors.WithStackIf(err)
+		}
+		return nil, errors.WrapIf(err, "installer: could not get server configuration from remote API")
+	}
+
+	// Create a new server instance using the configuration we wrote to the disk
+	// so that everything gets instantiated correctly on the struct.
+	s, err := manager.InitServer(c)
+	if err != nil {
+		return nil, errors.WrapIf(err, "installer: could not init server instance")
+	}
+	return &Installer{server: s}, nil
+}
+
+// Uuid returns the UUID associated with this installer instance.
+func (i *Installer) Uuid() string {
+	return i.server.Id()
+}
+
+// Server returns the server instance.
+func (i *Installer) Server() *server.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
+}

internal/cron/activity_cron.go

@@ -1,86 +0,0 @@
-package cron
-
-import (
-	"context"
-	"net"
-
-	"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     int
-}
-
-// Run executes the cronjob and ensures we fetch and send all 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 separately 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(ac.max).
-		Find(&activity)
-	if tx.Error != nil {
-		return errors.WithStack(tx.Error)
-	}
-	if len(activity) == 0 {
-		return nil
-	}
-
-	// ids to delete from the database.
-	ids := make([]int, 0, len(activity))
-	// activities to send to the panel.
-	activities := make([]models.Activity, 0, len(activity))
-	for _, v := range activity {
-		// Delete any activity that has an invalid IP address. This is a fix for
-		// a bug that truncated the last octet of an IPv6 address in the database.
-		if ip := net.ParseIP(v.IP); ip == nil {
-			ids = append(ids, v.ID)
-			continue
-		}
-		activities = append(activities, v)
-	}
-
-	if len(ids) > 0 {
-		tx = database.Instance().WithContext(ctx).Where("id IN ?", ids).Delete(&models.Activity{})
-		if tx.Error != nil {
-			return errors.WithStack(tx.Error)
-		}
-	}
-
-	if len(activities) == 0 {
-		return nil
-	}
-
-	if err := ac.manager.Client().SendActivityLogs(ctx, activities); err != nil {
-		return errors.WrapIf(err, "cron: failed to send activity events to Panel")
-	}
-
-	// Add all the successful activities to the list of IDs to delete.
-	ids = make([]int, len(activities))
-	for i, v := range activities {
-		ids[i] = v.ID
-	}
-
-	// Delete all the activities that were sent to the Panel (or that were invalid).
-	tx = database.Instance().WithContext(ctx).Where("id IN ?", ids).Delete(&models.Activity{})
-	if tx.Error != nil {
-		return errors.WithStack(tx.Error)
-	}
-	return nil
-}

internal/cron/cron.go

@@ -1,73 +0,0 @@
-package cron
-
-import (
-	"context"
-	"time"
-
-	"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"
-)
-
-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")
-	}
-	location, 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(location)
-	l := log.WithField("subsystem", "cron")
-
-	interval := time.Duration(config.Get().System.ActivitySendInterval) * time.Second
-	l.WithField("interval", interval).Info("configuring system crons")
-
-	_, _ = s.Tag("activity").Every(interval).Do(func() {
-		l.WithField("cron", "activity").Debug("sending internal activity events to Panel")
-		if err := activity.Run(ctx); err != nil {
-			if errors.Is(err, ErrCronRunning) {
-				l.WithField("cron", "activity").Warn("activity process is already running, skipping...")
-			} else {
-				l.WithField("cron", "activity").WithField("error", err).Error("activity process failed to execute")
-			}
-		}
-	})
-
-	_, _ = s.Tag("sftp").Every(interval).Do(func() {
-		l.WithField("cron", "sftp").Debug("sending sftp events to Panel")
-		if err := sftp.Run(ctx); err != nil {
-			if errors.Is(err, ErrCronRunning) {
-				l.WithField("cron", "sftp").Warn("sftp events process already running, skipping...")
-			} else {
-				l.WithField("cron", "sftp").WithField("error", err).Error("sftp events process failed to execute")
-			}
-		}
-	})
-
-	return s, nil
-}

internal/cron/sftp_cron.go

@@ -1,177 +0,0 @@
-package cron
-
-import (
-	"context"
-	"reflect"
-
-	"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 sftpCron struct {
-	mu      *system.AtomicBool
-	manager *server.Manager
-	max     int
-}
-
-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: 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
-	}
-	if err := sc.manager.Client().SendActivityLogs(ctx, events.Elements()); err != nil {
-		return errors.Wrap(err, "failed to send sftp activity logs to Panel")
-	}
-	if tx := database.Instance().Where("id IN ?", events.ids).Delete(&models.Activity{}); tx.Error != nil {
-		return errors.WithStack(tx.Error)
-	}
-	return nil
-}
-
-// 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(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
-}

internal/database/database.go

@@ -1,61 +0,0 @@
-package database
-
-import (
-	"path/filepath"
-	"time"
-
-	"emperror.dev/errors"
-	"github.com/glebarez/sqlite"
-	"gorm.io/gorm"
-	"gorm.io/gorm/logger"
-
-	"github.com/pterodactyl/wings/config"
-	"github.com/pterodactyl/wings/internal/models"
-	"github.com/pterodactyl/wings/system"
-)
-
-var (
-	o  system.AtomicBool
-	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{
-		Logger: logger.Default.LogMode(logger.Silent),
-	})
-	if err != nil {
-		return errors.Wrap(err, "database: could not open database file")
-	}
-	db = instance
-	if sql, err := db.DB(); err != nil {
-		return errors.WithStack(err)
-	} else {
-		sql.SetMaxOpenConns(1)
-		sql.SetConnMaxLifetime(time.Hour)
-	}
-	if tx := db.Exec("PRAGMA synchronous = OFF"); tx.Error != nil {
-		return errors.WithStack(tx.Error)
-	}
-	if tx := db.Exec("PRAGMA journal_mode = MEMORY"); tx.Error != nil {
-		return errors.WithStack(tx.Error)
-	}
-	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
-}

internal/models/activity.go

@@ -1,71 +0,0 @@
-package models
-
-import (
-	"net"
-	"strings"
-	"time"
-
-	"gorm.io/gorm"
-)
-
-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 {
-	if ip, _, err := net.SplitHostPort(strings.TrimSpace(a.IP)); err == nil {
-		a.IP = ip
-	}
-	if a.Timestamp.IsZero() {
-		a.Timestamp = time.Now()
-	}
-	a.Timestamp = a.Timestamp.UTC()
-	if a.Metadata == nil {
-		a.Metadata = ActivityMeta{}
-	}
-	return nil
-}

internal/models/models.go

@@ -1,32 +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
-}

internal/progress/progress.go

@@ -1,90 +0,0 @@
-package progress
-
-import (
-	"io"
-	"strings"
-	"sync/atomic"
-
-	"github.com/pterodactyl/wings/system"
-)
-
-// Progress is used to track the progress of any I/O operation that are being
-// performed.
-type Progress struct {
-	// written is the total size of the files that have been written to the writer.
-	written uint64
-	// Total is the total size of the archive in bytes.
-	total uint64
-
-	// Writer .
-	Writer io.Writer
-}
-
-// NewProgress returns a new progress tracker for the given total size.
-func NewProgress(total uint64) *Progress {
-	return &Progress{total: total}
-}
-
-// Written returns the total number of bytes written.
-// This function should be used when the progress is tracking data being written.
-func (p *Progress) Written() uint64 {
-	return atomic.LoadUint64(&p.written)
-}
-
-// Total returns the total size in bytes.
-func (p *Progress) Total() uint64 {
-	return atomic.LoadUint64(&p.total)
-}
-
-// SetTotal sets the total size of the archive in bytes. This function is safe
-// to call concurrently and can be used to update the total size if it changes,
-// such as when the total size is simultaneously being calculated as data is
-// being written through the progress writer.
-func (p *Progress) SetTotal(total uint64) {
-	atomic.StoreUint64(&p.total, total)
-}
-
-// Write totals the number of bytes that have been written to the writer.
-func (p *Progress) Write(v []byte) (int, error) {
-	n := len(v)
-	atomic.AddUint64(&p.written, uint64(n))
-	if p.Writer != nil {
-		return p.Writer.Write(v)
-	}
-	return n, nil
-}
-
-// Progress returns a formatted progress string for the current progress.
-func (p *Progress) Progress(width int) string {
-	// current = 100 (Progress, dynamic)
-	// total = 1000 (Content-Length, dynamic)
-	// width = 25 (Number of ticks to display, static)
-	// widthPercentage = 100 / width (What percentage does each tick represent, static)
-	//
-	// percentageDecimal = current / total = 0.1
-	// percentage = percentageDecimal * 100 = 10%
-	// ticks = percentage / widthPercentage = 2.5
-	//
-	// ticks is a float64, so we cast it to an int which rounds it down to 2.
-
-	// Values are cast to floats to prevent integer division.
-	current := p.Written()
-	total := p.Total()
-	// width := is passed as a parameter
-	widthPercentage := float64(100) / float64(width)
-	percentageDecimal := float64(current) / float64(total)
-	percentage := percentageDecimal * 100
-	ticks := int(percentage / widthPercentage)
-
-	// Ensure that we never get a negative number of ticks, this will prevent strings#Repeat
-	// from panicking.  A negative number of ticks is likely to happen when the total size is
-	// inaccurate, such as when we are going off of rough disk usage calculation.
-	if ticks < 0 {
-		ticks = 0
-	} else if ticks > width {
-		ticks = width
-	}
-
-	bar := strings.Repeat("=", ticks) + strings.Repeat(" ", width-ticks)
-	return "[" + bar + "] " + system.FormatBytes(current) + " / " + system.FormatBytes(total)
-}

internal/progress/progress_test.go

@@ -1,50 +0,0 @@
-package progress_test
-
-import (
-	"bytes"
-	"testing"
-
-	"github.com/franela/goblin"
-
-	"github.com/pterodactyl/wings/internal/progress"
-)
-
-func TestProgress(t *testing.T) {
-	g := goblin.Goblin(t)
-
-	g.Describe("Progress", func() {
-		g.It("properly initializes", func() {
-			total := uint64(1000)
-			p := progress.NewProgress(total)
-			g.Assert(p).IsNotNil()
-			g.Assert(p.Total()).Equal(total)
-			g.Assert(p.Written()).Equal(uint64(0))
-		})
-
-		g.It("increments written when Write is called", func() {
-			v := []byte("hello")
-			p := progress.NewProgress(1000)
-			_, err := p.Write(v)
-			g.Assert(err).IsNil()
-			g.Assert(p.Written()).Equal(uint64(len(v)))
-		})
-
-		g.It("renders a progress bar", func() {
-			v := bytes.Repeat([]byte{' '}, 100)
-			p := progress.NewProgress(1000)
-			_, err := p.Write(v)
-			g.Assert(err).IsNil()
-			g.Assert(p.Written()).Equal(uint64(len(v)))
-			g.Assert(p.Progress(25)).Equal("[==                       ] 100 B / 1000 B")
-		})
-
-		g.It("renders a progress bar when written exceeds total", func() {
-			v := bytes.Repeat([]byte{' '}, 1001)
-			p := progress.NewProgress(1000)
-			_, err := p.Write(v)
-			g.Assert(err).IsNil()
-			g.Assert(p.Written()).Equal(uint64(len(v)))
-			g.Assert(p.Progress(25)).Equal("[=========================] 1001 B / 1000 B")
-		})
-	})
-}

internal/ufs/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Matthew Penner
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

internal/ufs/README.md

@@ -1,17 +0,0 @@
-# Filesystem
-
-## Licensing
-
-Most code in this package is licensed under `MIT` with some exceptions.
-
-The following files are licensed under `BSD-3-Clause` due to them being copied
-verbatim or derived from [Go](https://go.dev)'s source code.
-
-- [`file_posix.go`](./file_posix.go)
-- [`mkdir_unix.go`](./mkdir_unix.go)
-- [`path_unix.go`](./path_unix.go)
-- [`removeall_unix.go`](./removeall_unix.go)
-- [`stat_unix.go`](./stat_unix.go) 
-- [`walk.go`](./walk.go)
-
-These changes are not associated with nor endorsed by The Go Authors.

internal/ufs/doc.go

@@ -1,12 +0,0 @@
-// SPDX-License-Identifier: MIT
-// SPDX-FileCopyrightText: Copyright (c) 2024 Matthew Penner
-
-// Package ufs provides an abstraction layer for performing I/O on filesystems.
-// This package is designed to be used in-place of standard `os` package I/O
-// calls, and is not designed to be used as a generic filesystem abstraction
-// like the `io/fs` package.
-//
-// The primary use-case of this package was to provide a "chroot-like" `os`
-// wrapper, so we can safely sandbox I/O operations within a directory and
-// use untrusted arbitrary paths.
-package ufs

internal/ufs/error.go

@@ -1,120 +0,0 @@
-// SPDX-License-Identifier: MIT
-// SPDX-FileCopyrightText: Copyright (c) 2024 Matthew Penner
-
-package ufs
-
-import (
-	"errors"
-	iofs "io/fs"
-	"os"
-
-	"golang.org/x/sys/unix"
-)
-
-var (
-	// ErrIsDirectory is an error for when an operation that operates only on
-	// files is given a path to a directory.
-	ErrIsDirectory = errors.New("is a directory")
-	// ErrNotDirectory is an error for when an operation that operates only on
-	// directories is given a path to a file.
-	ErrNotDirectory = errors.New("not a directory")
-	// ErrBadPathResolution is an error for when a sand-boxed filesystem
-	// resolves a given path to a forbidden location.
-	ErrBadPathResolution = errors.New("bad path resolution")
-	// ErrNotRegular is an error for when an operation that operates only on
-	// regular files is passed something other than a regular file.
-	ErrNotRegular = errors.New("not a regular file")
-
-	// ErrClosed is an error for when an entry was accessed after being closed.
-	ErrClosed = iofs.ErrClosed
-	// ErrInvalid is an error for when an invalid argument was used.
-	ErrInvalid = iofs.ErrInvalid
-	// ErrExist is an error for when an entry already exists.
-	ErrExist = iofs.ErrExist
-	// ErrNotExist is an error for when an entry does not exist.
-	ErrNotExist = iofs.ErrNotExist
-	// ErrPermission is an error for when the required permissions to perform an
-	// operation are missing.
-	ErrPermission = iofs.ErrPermission
-)
-
-// LinkError records an error during a link or symlink or rename
-// system call and the paths that caused it.
-type LinkError = os.LinkError
-
-// PathError records an error and the operation and file path that caused it.
-type PathError = iofs.PathError
-
-// SyscallError records an error from a specific system call.
-type SyscallError = os.SyscallError
-
-// NewSyscallError returns, as an error, a new SyscallError
-// with the given system call name and error details.
-// As a convenience, if err is nil, NewSyscallError returns nil.
-func NewSyscallError(syscall string, err error) error {
-	return os.NewSyscallError(syscall, err)
-}
-
-// convertErrorType converts errors into our custom errors to ensure consistent
-// error values.
-func convertErrorType(err error) error {
-	if err == nil {
-		return nil
-	}
-	var pErr *PathError
-	switch {
-	case errors.As(err, &pErr):
-		switch {
-		// File exists
-		case errors.Is(pErr.Err, unix.EEXIST):
-			return &PathError{
-				Op:   pErr.Op,
-				Path: pErr.Path,
-				Err:  ErrExist,
-			}
-		// Is a directory
-		case errors.Is(pErr.Err, unix.EISDIR):
-			return &PathError{
-				Op:   pErr.Op,
-				Path: pErr.Path,
-				Err:  ErrIsDirectory,
-			}
-		// Not a directory
-		case errors.Is(pErr.Err, unix.ENOTDIR):
-			return &PathError{
-				Op:   pErr.Op,
-				Path: pErr.Path,
-				Err:  ErrNotDirectory,
-			}
-		// No such file or directory
-		case errors.Is(pErr.Err, unix.ENOENT):
-			return &PathError{
-				Op:   pErr.Op,
-				Path: pErr.Path,
-				Err:  ErrNotExist,
-			}
-		// Operation not permitted
-		case errors.Is(pErr.Err, unix.EPERM):
-			return &PathError{
-				Op:   pErr.Op,
-				Path: pErr.Path,
-				Err:  ErrPermission,
-			}
-		// Invalid cross-device link
-		case errors.Is(pErr.Err, unix.EXDEV):
-			return &PathError{
-				Op:   pErr.Op,
-				Path: pErr.Path,
-				Err:  ErrBadPathResolution,
-			}
-		// Too many levels of symbolic links
-		case errors.Is(pErr.Err, unix.ELOOP):
-			return &PathError{
-				Op:   pErr.Op,
-				Path: pErr.Path,
-				Err:  ErrBadPathResolution,
-			}
-		}
-	}
-	return err
-}

internal/ufs/file.go

@@ -1,179 +0,0 @@
-// SPDX-License-Identifier: MIT
-// SPDX-FileCopyrightText: Copyright (c) 2024 Matthew Penner
-
-package ufs
-
-import (
-	"io"
-	iofs "io/fs"
-
-	"golang.org/x/sys/unix"
-)
-
-// DirEntry is an entry read from a directory.
-type DirEntry = iofs.DirEntry
-
-// File describes readable and/or writable file from a Filesystem.
-type File interface {
-	// Name returns the base name of the file.
-	Name() string
-
-	// Stat returns the FileInfo structure describing the file.
-	// If there is an error, it will be of type *PathError.
-	Stat() (FileInfo, error)
-
-	// ReadDir reads the contents of the directory associated with the file f
-	// and returns a slice of DirEntry values in directory order.
-	// Subsequent calls on the same file will yield later DirEntry records in the directory.
-	//
-	// If n > 0, ReadDir returns at most n DirEntry records.
-	// In this case, if ReadDir returns an empty slice, it will return an error explaining why.
-	// At the end of a directory, the error is io.EOF.
-	//
-	// If n <= 0, ReadDir returns all the DirEntry records remaining in the directory.
-	// When it succeeds, it returns a nil error (not io.EOF).
-	ReadDir(n int) ([]DirEntry, error)
-
-	// Readdirnames reads the contents of the directory associated with file
-	// and returns a slice of up to n names of files in the directory,
-	// in directory order. Subsequent calls on the same file will yield
-	// further names.
-	//
-	// If n > 0, Readdirnames returns at most n names. In this case, if
-	// Readdirnames returns an empty slice, it will return a non-nil error
-	// explaining why. At the end of a directory, the error is io.EOF.
-	//
-	// If n <= 0, Readdirnames returns all the names from the directory in
-	// a single slice. In this case, if Readdirnames succeeds (reads all
-	// the way to the end of the directory), it returns the slice and a
-	// nil error. If it encounters an error before the end of the
-	// directory, Readdirnames returns the names read until that point and
-	// a non-nil error.
-	Readdirnames(n int) (names []string, err error)
-
-	// Fd returns the integer Unix file descriptor referencing the open file.
-	// If f is closed, the file descriptor becomes invalid.
-	// If f is garbage collected, a finalizer may close the file descriptor,
-	// making it invalid; see runtime.SetFinalizer for more information on when
-	// a finalizer might be run. On Unix systems this will cause the SetDeadline
-	// methods to stop working.
-	// Because file descriptors can be reused, the returned file descriptor may
-	// only be closed through the Close method of f, or by its finalizer during
-	// garbage collection. Otherwise, during garbage collection the finalizer
-	// may close an unrelated file descriptor with the same (reused) number.
-	//
-	// As an alternative, see the f.SyscallConn method.
-	Fd() uintptr
-
-	// Truncate changes the size of the file.
-	// It does not change the I/O offset.
-	// If there is an error, it will be of type *PathError.
-	Truncate(size int64) error
-
-	io.Closer
-
-	io.Reader
-	io.ReaderAt
-	io.ReaderFrom
-
-	io.Writer
-	io.WriterAt
-
-	io.Seeker
-}
-
-// FileInfo describes a file and is returned by Stat and Lstat.
-type FileInfo = iofs.FileInfo
-
-// FileMode represents a file's mode and permission bits.
-// The bits have the same definition on all systems, so that
-// information about files can be moved from one system
-// to another portably. Not all bits apply to all systems.
-// The only required bit is ModeDir for directories.
-type FileMode = iofs.FileMode
-
-// The defined file mode bits are the most significant bits of the FileMode.
-// The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
-// The values of these bits should be considered part of the public API and
-// may be used in wire protocols or disk representations: they must not be
-// changed, although new bits might be added.
-const (
-	// ModeDir represents a directory.
-	// d: is a directory
-	ModeDir = iofs.ModeDir
-	// ModeAppend represents an append-only file.
-	// a: append-only
-	ModeAppend = iofs.ModeAppend
-	// ModeExclusive represents an exclusive file.
-	// l: exclusive use
-	ModeExclusive = iofs.ModeExclusive
-	// ModeTemporary .
-	// T: temporary file; Plan 9 only.
-	ModeTemporary = iofs.ModeTemporary
-	// ModeSymlink .
-	// L: symbolic link.
-	ModeSymlink = iofs.ModeSymlink
-	// ModeDevice .
-	// D: device file.
-	ModeDevice = iofs.ModeDevice
-	// ModeNamedPipe .
-	// p: named pipe (FIFO)
-	ModeNamedPipe = iofs.ModeNamedPipe
-	// ModeSocket .
-	// S: Unix domain socket.
-	ModeSocket = iofs.ModeSocket
-	// ModeSetuid .
-	// u: setuid
-	ModeSetuid = iofs.ModeSetuid
-	// ModeSetgid .
-	// g: setgid
-	ModeSetgid = iofs.ModeSetgid
-	// ModeCharDevice .
-	// c: Unix character device, when ModeDevice is set
-	ModeCharDevice = iofs.ModeCharDevice
-	// ModeSticky .
-	// t: sticky
-	ModeSticky = iofs.ModeSticky
-	// ModeIrregular .
-	// ?: non-regular file; nothing else is known about this file.
-	ModeIrregular = iofs.ModeIrregular
-
-	// ModeType .
-	ModeType = iofs.ModeType
-
-	// ModePerm .
-	// Unix permission bits, 0o777.
-	ModePerm = iofs.ModePerm
-)
-
-const (
-	// O_RDONLY opens the file read-only.
-	O_RDONLY = unix.O_RDONLY
-	// O_WRONLY opens the file write-only.
-	O_WRONLY = unix.O_WRONLY
-	// O_RDWR opens the file read-write.
-	O_RDWR = unix.O_RDWR
-	// O_APPEND appends data to the file when writing.
-	O_APPEND = unix.O_APPEND
-	// O_CREATE creates a new file if it doesn't exist.
-	O_CREATE = unix.O_CREAT
-	// O_EXCL is used with O_CREATE, file must not exist.
-	O_EXCL = unix.O_EXCL
-	// O_SYNC open for synchronous I/O.
-	O_SYNC = unix.O_SYNC
-	// O_TRUNC truncates regular writable file when opened.
-	O_TRUNC = unix.O_TRUNC
-	// O_DIRECTORY opens a directory only. If the entry is not a directory an
-	// error will be returned.
-	O_DIRECTORY = unix.O_DIRECTORY
-	// O_NOFOLLOW opens the exact path given without following symlinks.
-	O_NOFOLLOW  = unix.O_NOFOLLOW
-	O_CLOEXEC   = unix.O_CLOEXEC
-	O_LARGEFILE = unix.O_LARGEFILE
-)
-
-const (
-	AT_SYMLINK_NOFOLLOW = unix.AT_SYMLINK_NOFOLLOW
-	AT_REMOVEDIR        = unix.AT_REMOVEDIR
-	AT_EMPTY_PATH       = unix.AT_EMPTY_PATH
-)

internal/ufs/file_posix.go

@@ -1,49 +0,0 @@
-// SPDX-License-Identifier: BSD-3-Clause
-
-// Code in this file was copied from `go/src/os/file_posix.go`.
-
-// Copyright 2009 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the `go.LICENSE` file.
-
-//go:build unix || (js && wasm) || wasip1 || windows
-
-package ufs
-
-import (
-	"golang.org/x/sys/unix"
-)
-
-// ignoringEINTR makes a function call and repeats it if it returns an
-// EINTR error. This appears to be required even though we install all
-// signal handlers with SA_RESTART: see https://go.dev/issue/22838,
-// https://go.dev/issue/38033, https://go.dev/issue/38836,
-// https://go.dev/issue/40846. Also, https://go.dev/issue/20400 and
-// https://go.dev/issue/36644 are issues in which a signal handler is
-// installed without setting SA_RESTART. None of these are the common case,
-// but there are enough of them that it seems that we can't avoid
-// an EINTR loop.
-func ignoringEINTR(fn func() error) error {
-	for {
-		err := fn()
-		if err != unix.EINTR {
-			return err
-		}
-	}
-}
-
-// syscallMode returns the syscall-specific mode bits from Go's portable mode bits.
-func syscallMode(i FileMode) (o FileMode) {
-	o |= i.Perm()
-	if i&ModeSetuid != 0 {
-		o |= unix.S_ISUID
-	}
-	if i&ModeSetgid != 0 {
-		o |= unix.S_ISGID
-	}
-	if i&ModeSticky != 0 {
-		o |= unix.S_ISVTX
-	}
-	// No mapping for Go's ModeTemporary (plan9 only).
-	return
-}

internal/ufs/filesystem.go

@@ -1,168 +0,0 @@
-// SPDX-License-Identifier: MIT
-// SPDX-FileCopyrightText: Copyright (c) 2024 Matthew Penner
-
-package ufs
-
-import (
-	"time"
-)
-
-// Filesystem represents a filesystem capable of performing I/O operations.
-type Filesystem interface {
-	// Chmod changes the mode of the named file to mode.
-	//
-	// If the file is a symbolic link, it changes the mode of the link's target.
-	// If there is an error, it will be of type *PathError.
-	//
-	// A different subset of the mode bits are used, depending on the
-	// operating system.
-	//
-	// On Unix, the mode's permission bits, ModeSetuid, ModeSetgid, and
-	// ModeSticky are used.
-	//
-	// On Windows, only the 0200 bit (owner writable) of mode is used; it
-	// controls whether the file's read-only attribute is set or cleared.
-	// The other bits are currently unused. For compatibility with Go 1.12
-	// and earlier, use a non-zero mode. Use mode 0400 for a read-only
-	// file and 0600 for a readable+writable file.
-	//
-	// On Plan 9, the mode's permission bits, ModeAppend, ModeExclusive,
-	// and ModeTemporary are used.
-	Chmod(name string, mode FileMode) error
-
-	// Chown changes the numeric uid and gid of the named file.
-	//
-	// If the file is a symbolic link, it changes the uid and gid of the link's target.
-	// A uid or gid of -1 means to not change that value.
-	// If there is an error, it will be of type *PathError.
-	//
-	// On Windows or Plan 9, Chown always returns the syscall.EWINDOWS or
-	// EPLAN9 error, wrapped in *PathError.
-	Chown(name string, uid, gid int) error
-
-	// Lchown changes the numeric uid and gid of the named file.
-	//
-	// If the file is a symbolic link, it changes the uid and gid of the link itself.
-	// If there is an error, it will be of type *PathError.
-	//
-	// On Windows, it always returns the syscall.EWINDOWS error, wrapped
-	// in *PathError.
-	Lchown(name string, uid, gid int) error
-
-	// Chtimes changes the access and modification times of the named
-	// file, similar to the Unix utime() or utimes() functions.
-	//
-	// The underlying filesystem may truncate or round the values to a
-	// less precise time unit.
-	//
-	// If there is an error, it will be of type *PathError.
-	Chtimes(name string, atime, mtime time.Time) error
-
-	// Create creates or truncates the named file. If the file already exists,
-	// it is truncated.
-	//
-	// If the file does not exist, it is created with mode 0666
-	// (before umask). If successful, methods on the returned File can
-	// be used for I/O; the associated file descriptor has mode O_RDWR.
-	// If there is an error, it will be of type *PathError.
-	Create(name string) (File, error)
-
-	// Mkdir creates a new directory with the specified name and permission
-	// bits (before umask).
-	//
-	// If there is an error, it will be of type *PathError.
-	Mkdir(name string, perm FileMode) error
-
-	// MkdirAll creates a directory named path, along with any necessary
-	// parents, and returns nil, or else returns an error.
-	//
-	// The permission bits perm (before umask) are used for all
-	// directories that MkdirAll creates.
-	// If path is already a directory, MkdirAll does nothing
-	// and returns nil.
-	MkdirAll(path string, perm FileMode) error
-
-	// Open opens the named file for reading.
-	//
-	// If successful, methods on the returned file can be used for reading; the
-	// associated file descriptor has mode O_RDONLY.
-	//
-	// If there is an error, it will be of type *PathError.
-	Open(name string) (File, error)
-
-	// OpenFile is the generalized open call; most users will use Open
-	// or Create instead. It opens the named file with specified flag
-	// (O_RDONLY etc.).
-	//
-	// If the file does not exist, and the O_CREATE flag
-	// is passed, it is created with mode perm (before umask). If successful,
-	// methods on the returned File can be used for I/O.
-	//
-	// If there is an error, it will be of type *PathError.
-	OpenFile(name string, flag int, perm FileMode) (File, error)
-
-	// ReadDir reads the named directory,
-	//
-	// returning all its directory entries sorted by filename.
-	// If an error occurs reading the directory, ReadDir returns the entries it
-	// was able to read before the error, along with the error.
-	ReadDir(name string) ([]DirEntry, error)
-
-	// Remove removes the named file or (empty) directory.
-	//
-	// If there is an error, it will be of type *PathError.
-	Remove(name string) error
-
-	// RemoveAll removes path and any children it contains.
-	//
-	// It removes everything it can but returns the first error
-	// it encounters. If the path does not exist, RemoveAll
-	// returns nil (no error).
-	//
-	// If there is an error, it will be of type *PathError.
-	RemoveAll(path string) error
-
-	// Rename renames (moves) oldpath to newpath.
-	//
-	// If newpath already exists and is not a directory, Rename replaces it.
-	// OS-specific restrictions may apply when oldpath and newpath are in different directories.
-	// Even within the same directory, on non-Unix platforms Rename is not an atomic operation.
-	//
-	// If there is an error, it will be of type *LinkError.
-	Rename(oldname, newname string) error
-
-	// Stat returns a FileInfo describing the named file.
-	//
-	// If there is an error, it will be of type *PathError.
-	Stat(name string) (FileInfo, error)
-
-	// Lstat returns a FileInfo describing the named file.
-	//
-	// If the file is a symbolic link, the returned FileInfo
-	// describes the symbolic link. Lstat makes no attempt to follow the link.
-	//
-	// If there is an error, it will be of type *PathError.
-	Lstat(name string) (FileInfo, error)
-
-	// Symlink creates newname as a symbolic link to oldname.
-	//
-	// On Windows, a symlink to a non-existent oldname creates a file symlink;
-	// if oldname is later created as a directory the symlink will not work.
-	//
-	// If there is an error, it will be of type *LinkError.
-	Symlink(oldname, newname string) error
-
-	// WalkDir walks the file tree rooted at root, calling fn for each file or
-	// directory in the tree, including root.
-	//
-	// All errors that arise visiting files and directories are filtered by fn:
-	// see the [WalkDirFunc] documentation for details.
-	//
-	// The files are walked in lexical order, which makes the output deterministic
-	// but requires WalkDir to read an entire directory into memory before proceeding
-	// to walk that directory.
-	//
-	// WalkDir does not follow symbolic links found in directories,
-	// but if root itself is a symbolic link, its target will be walked.
-	WalkDir(root string, fn WalkDirFunc) error
-}

internal/ufs/fs_quota.go

@@ -1,159 +0,0 @@
-// SPDX-License-Identifier: MIT
-// SPDX-FileCopyrightText: Copyright (c) 2024 Matthew Penner
-
-package ufs
-
-import (
-	"sync/atomic"
-)
-
-type Quota struct {
-	// fs is the underlying filesystem that runs the actual I/O operations.
-	*UnixFS
-
-	// limit is the size limit of the filesystem.
-	//
-	// limit is atomic to allow the limit to be safely changed after the
-	// filesystem was created.
-	//
-	// A limit of `-1` disables any write operation from being performed.
-	// A limit of `0` disables any limit checking.
-	limit atomic.Int64
-
-	// usage is the current usage of the filesystem.
-	//
-	// If usage is set to `-1`, it hasn't been calculated yet.
-	usage atomic.Int64
-}
-
-func NewQuota(fs *UnixFS, limit int64) *Quota {
-	qfs := Quota{UnixFS: fs}
-	qfs.limit.Store(limit)
-	return &qfs
-}
-
-// Close closes the filesystem.
-func (fs *Quota) Close() (err error) {
-	err = fs.UnixFS.Close()
-	return
-}
-
-// Limit returns the limit of the filesystem.
-func (fs *Quota) Limit() int64 {
-	return fs.limit.Load()
-}
-
-// SetLimit returns the limit of the filesystem.
-func (fs *Quota) SetLimit(newLimit int64) int64 {
-	return fs.limit.Swap(newLimit)
-}
-
-// Usage returns the current usage of the filesystem.
-func (fs *Quota) Usage() int64 {
-	return fs.usage.Load()
-}
-
-// SetUsage updates the total usage of the filesystem.
-func (fs *Quota) SetUsage(newUsage int64) int64 {
-	return fs.usage.Swap(newUsage)
-}
-
-// Add adds `i` to the tracked usage total.
-func (fs *Quota) Add(i int64) int64 {
-	usage := fs.Usage()
-
-	// If adding `i` to the usage will put us below 0, cap it. (`i` can be negative)
-	if usage+i < 0 {
-		fs.usage.Store(0)
-		return 0
-	}
-	return fs.usage.Add(i)
-}
-
-// CanFit checks if the given size can fit in the filesystem without exceeding
-// the limit of the filesystem.
-func (fs *Quota) CanFit(size int64) bool {
-	// Get the size limit of the filesystem.
-	limit := fs.Limit()
-	switch limit {
-	case -1:
-		// A limit of -1 means no write operations are allowed.
-		return false
-	case 0:
-		// A limit of 0 means unlimited.
-		return true
-	}
-
-	// Any other limit is a value we need to check.
-	usage := fs.Usage()
-	if usage == -1 {
-		// We don't know what the current usage is yet.
-		return true
-	}
-
-	// If the current usage + the requested size are under the limit of the
-	// filesystem, allow it.
-	if usage+size <= limit {
-		return true
-	}
-
-	// Welp, the size would exceed the limit of the filesystem, deny it.
-	return false
-}
-
-func (fs *Quota) Remove(name string) error {
-	// For information on why this interface is used here, check its
-	// documentation.
-	s, err := fs.RemoveStat(name)
-	if err != nil {
-		return err
-	}
-
-	// Don't reduce the quota's usage as `name` is not a regular file.
-	if !s.Mode().IsRegular() {
-		return nil
-	}
-
-	// Remove the size of the deleted file from the quota usage.
-	fs.Add(-s.Size())
-	return nil
-}
-
-// RemoveAll removes path and any children it contains.
-//
-// It removes everything it can but returns the first error
-// it encounters. If the path does not exist, RemoveAll
-// returns nil (no error).
-//
-// If there is an error, it will be of type *PathError.
-func (fs *Quota) RemoveAll(name string) error {
-	name, err := fs.unsafePath(name)
-	if err != nil {
-		return err
-	}
-	// While removeAll internally checks this, I want to make sure we check it
-	// and return the proper error so our tests can ensure that this will never
-	// be a possibility.
-	if name == "." {
-		return &PathError{
-			Op:   "removeall",
-			Path: name,
-			Err:  ErrBadPathResolution,
-		}
-	}
-	return fs.removeAll(name)
-}
-
-func (fs *Quota) removeAll(path string) error {
-	return removeAll(fs, path)
-}
-
-func (fs *Quota) unlinkat(dirfd int, name string, flags int) error {
-	if flags == 0 {
-		s, err := fs.Lstatat(dirfd, name)
-		if err == nil && s.Mode().IsRegular() {
-			fs.Add(-s.Size())
-		}
-	}
-	return fs.UnixFS.unlinkat(dirfd, name, flags)
-}

internal/ufs/fs_unix.go

@@ -1,825 +0,0 @@
-// SPDX-License-Identifier: MIT
-// SPDX-FileCopyrightText: Copyright (c) 2024 Matthew Penner
-
-//go:build unix
-
-package ufs
-
-import (
-	"errors"
-	"fmt"
-	"os"
-	"path/filepath"
-	"strconv"
-	"strings"
-	"sync/atomic"
-	"time"
-
-	"golang.org/x/sys/unix"
-)
-
-// UnixFS is a filesystem that uses the unix package to make io calls.
-//
-// This is used for proper sand-boxing and full control over the exact syscalls
-// being performed.
-type UnixFS struct {
-	// basePath is the base path for file operations to take place in.
-	basePath string
-
-	// dirfd holds the file descriptor of BasePath and is used to ensure
-	// operations are restricted into descendants of BasePath.
-	dirfd atomic.Int64
-
-	// useOpenat2 controls whether the `openat2` syscall is used instead of the
-	// older `openat` syscall.
-	useOpenat2 bool
-}
-
-// NewUnixFS creates a new sandboxed unix filesystem. BasePath is used as the
-// sandbox path, operations on BasePath itself are not allowed, but any
-// operations on its descendants are. Symlinks pointing outside BasePath are
-// checked and prevented from enabling an escape in a non-raceable manor.
-func NewUnixFS(basePath string, useOpenat2 bool) (*UnixFS, error) {
-	basePath = strings.TrimSuffix(basePath, "/")
-	// We don't need Openat2, if we are given a basePath that is already unsafe
-	// I give up on trying to sandbox it.
-	dirfd, err := unix.Openat(AT_EMPTY_PATH, basePath, O_DIRECTORY|O_RDONLY, 0)
-	if err != nil {
-		return nil, convertErrorType(err)
-	}
-
-	fs := &UnixFS{
-		basePath:   basePath,
-		useOpenat2: useOpenat2,
-	}
-	fs.dirfd.Store(int64(dirfd))
-	return fs, nil
-}
-
-// BasePath returns the base path of the UnixFS sandbox, file operations
-// pointing outside this path are prohibited and will be blocked by all
-// operations implemented by UnixFS.
-func (fs *UnixFS) BasePath() string {
-	return fs.basePath
-}
-
-// Close releases the file descriptor used to sandbox operations within the
-// base path of the filesystem.
-func (fs *UnixFS) Close() error {
-	// Once closed, change dirfd to something invalid to detect when it has been
-	// closed.
-	defer func() {
-		fs.dirfd.Store(-1)
-	}()
-	return unix.Close(int(fs.dirfd.Load()))
-}
-
-// Chmod changes the mode of the named file to mode.
-//
-// If the file is a symbolic link, it changes the mode of the link's target.
-// If there is an error, it will be of type *PathError.
-//
-// A different subset of the mode bits are used, depending on the
-// operating system.
-//
-// On Unix, the mode's permission bits, ModeSetuid, ModeSetgid, and
-// ModeSticky are used.
-//
-// On Windows, only the 0200 bit (owner writable) of mode is used; it
-// controls whether the file's read-only attribute is set or cleared.
-// The other bits are currently unused. For compatibility with Go 1.12
-// and earlier, use a non-zero mode. Use mode 0400 for a read-only
-// file and 0600 for a readable+writable file.
-//
-// On Plan 9, the mode's permission bits, ModeAppend, ModeExclusive,
-// and ModeTemporary are used.
-func (fs *UnixFS) Chmod(name string, mode FileMode) error {
-	dirfd, name, closeFd, err := fs.safePath(name)
-	defer closeFd()
-	if err != nil {
-		return err
-	}
-	return convertErrorType(unix.Fchmodat(dirfd, name, uint32(mode), 0))
-}
-
-// Chown changes the numeric uid and gid of the named file.
-//
-// If the file is a symbolic link, it changes the uid and gid of the link's target.
-// A uid or gid of -1 means to not change that value.
-// If there is an error, it will be of type *PathError.
-//
-// On Windows or Plan 9, Chown always returns the syscall.EWINDOWS or
-// EPLAN9 error, wrapped in *PathError.
-func (fs *UnixFS) Chown(name string, uid, gid int) error {
-	return fs.fchown(name, uid, gid, 0)
-}
-
-// Lchown changes the numeric uid and gid of the named file.
-//
-// If the file is a symbolic link, it changes the uid and gid of the link itself.
-// If there is an error, it will be of type *PathError.
-//
-// On Windows, it always returns the syscall.EWINDOWS error, wrapped
-// in *PathError.
-func (fs *UnixFS) Lchown(name string, uid, gid int) error {
-	// With AT_SYMLINK_NOFOLLOW, Fchownat acts like Lchown but allows us to
-	// pass a dirfd.
-	return fs.fchown(name, uid, gid, AT_SYMLINK_NOFOLLOW)
-}
-
-// fchown is a re-usable Fchownat syscall used by Chown and Lchown.
-func (fs *UnixFS) fchown(name string, uid, gid, flags int) error {
-	dirfd, name, closeFd, err := fs.safePath(name)
-	defer closeFd()
-	if err != nil {
-		return err
-	}
-	return convertErrorType(unix.Fchownat(dirfd, name, uid, gid, flags))
-}
-
-// Chownat is like Chown but allows passing an existing directory file
-// descriptor rather than needing to resolve one.
-func (fs *UnixFS) Chownat(dirfd int, name string, uid, gid int) error {
-	return convertErrorType(unix.Fchownat(dirfd, name, uid, gid, 0))
-}
-
-// Lchownat is like Lchown but allows passing an existing directory file
-// descriptor rather than needing to resolve one.
-func (fs *UnixFS) Lchownat(dirfd int, name string, uid, gid int) error {
-	return convertErrorType(unix.Fchownat(dirfd, name, uid, gid, AT_SYMLINK_NOFOLLOW))
-}
-
-// Chtimes changes the access and modification times of the named
-// file, similar to the Unix utime() or utimes() functions.
-//
-// The underlying filesystem may truncate or round the values to a
-// less precise time unit.
-//
-// If there is an error, it will be of type *PathError.
-func (fs *UnixFS) Chtimes(name string, atime, mtime time.Time) error {
-	dirfd, name, closeFd, err := fs.safePath(name)
-	defer closeFd()
-	if err != nil {
-		return err
-	}
-	return fs.Chtimesat(dirfd, name, atime, mtime)
-}
-
-// Chtimesat is like Chtimes but allows passing an existing directory file
-// descriptor rather than needing to resolve one.
-func (fs *UnixFS) Chtimesat(dirfd int, name string, atime, mtime time.Time) error {
-	var utimes [2]unix.Timespec
-	set := func(i int, t time.Time) {
-		if t.IsZero() {
-			utimes[i] = unix.Timespec{Sec: unix.UTIME_OMIT, Nsec: unix.UTIME_OMIT}
-		} else {
-			utimes[i] = unix.NsecToTimespec(t.UnixNano())
-		}
-	}
-	set(0, atime)
-	set(1, mtime)
-	// This does support `AT_SYMLINK_NOFOLLOW` as well if needed.
-	if err := unix.UtimesNanoAt(dirfd, name, utimes[0:], 0); err != nil {
-		return convertErrorType(&PathError{Op: "chtimes", Path: name, Err: err})
-	}
-	return nil
-}
-
-// Create creates or truncates the named file. If the file already exists,
-// it is truncated.
-//
-// If the file does not exist, it is created with mode 0666
-// (before umask). If successful, methods on the returned File can
-// be used for I/O; the associated file descriptor has mode O_RDWR.
-// If there is an error, it will be of type *PathError.
-func (fs *UnixFS) Create(name string) (File, error) {
-	return fs.OpenFile(name, O_CREATE|O_WRONLY|O_TRUNC, 0o644)
-}
-
-// Mkdir creates a new directory with the specified name and permission
-// bits (before umask).
-//
-// If there is an error, it will be of type *PathError.
-func (fs *UnixFS) Mkdir(name string, mode FileMode) error {
-	dirfd, name, closeFd, err := fs.safePath(name)
-	defer closeFd()
-	if err != nil {
-		return err
-	}
-	return fs.Mkdirat(dirfd, name, mode)
-}
-
-func (fs *UnixFS) Mkdirat(dirfd int, name string, mode FileMode) error {
-	return convertErrorType(unix.Mkdirat(dirfd, name, uint32(mode)))
-}
-
-// MkdirAll creates a directory named path, along with any necessary
-// parents, and returns nil, or else returns an error.
-//
-// The permission bits perm (before umask) are used for all
-// directories that MkdirAll creates.
-// If path is already a directory, MkdirAll does nothing
-// and returns nil.
-func (fs *UnixFS) MkdirAll(name string, mode FileMode) error {
-	// Ensure name is somewhat clean before continuing.
-	name, err := fs.unsafePath(name)
-	if err != nil {
-		return err
-	}
-	return fs.mkdirAll(name, mode)
-}
-
-// Open opens the named file for reading.
-//
-// If successful, methods on the returned file can be used for reading; the
-// associated file descriptor has mode O_RDONLY.
-//
-// If there is an error, it will be of type *PathError.
-func (fs *UnixFS) Open(name string) (File, error) {
-	return fs.OpenFile(name, O_RDONLY, 0)
-}
-
-// OpenFile is the generalized open call; most users will use Open
-// or Create instead. It opens the named file with specified flag
-// (O_RDONLY etc.).
-//
-// If the file does not exist, and the O_CREATE flag
-// is passed, it is created with mode perm (before umask). If successful,
-// methods on the returned File can be used for I/O.
-//
-// If there is an error, it will be of type *PathError.
-func (fs *UnixFS) OpenFile(name string, flag int, mode FileMode) (File, error) {
-	fd, err := fs.openFile(name, flag, mode)
-	if err != nil {
-		return nil, err
-	}
-	// Do not close `fd` here, it is passed to a file that needs the fd, the
-	// caller of this function is responsible for calling Close() on the File
-	// to release the file descriptor.
-	return os.NewFile(uintptr(fd), name), nil
-}
-
-func (fs *UnixFS) openFile(name string, flag int, mode FileMode) (int, error) {
-	dirfd, name, closeFd, err := fs.safePath(name)
-	defer closeFd()
-	if err != nil {
-		return 0, err
-	}
-	return fs.openat(dirfd, name, flag, mode)
-}
-
-func (fs *UnixFS) OpenFileat(dirfd int, name string, flag int, mode FileMode) (File, error) {
-	fd, err := fs.openat(dirfd, name, flag, mode)
-	if err != nil {
-		return nil, err
-	}
-	// Do not close `fd` here, it is passed to a file that needs the fd, the
-	// caller of this function is responsible for calling Close() on the File
-	// to release the file descriptor.
-	return os.NewFile(uintptr(fd), name), nil
-}
-
-// ReadDir reads the named directory,
-//
-// returning all its directory entries sorted by filename.
-// If an error occurs reading the directory, ReadDir returns the entries it
-// was able to read before the error, along with the error.
-func (fs *UnixFS) ReadDir(path string) ([]DirEntry, error) {
-	dirfd, name, closeFd, err := fs.safePath(path)
-	defer closeFd()
-	if err != nil {
-		return nil, err
-	}
-	fd, err := fs.openat(dirfd, name, O_DIRECTORY|O_RDONLY, 0)
-	if err != nil {
-		return nil, err
-	}
-	defer unix.Close(fd)
-	return fs.readDir(fd, name, nil)
-}
-
-// RemoveStat is a combination of Stat and Remove, it is used to more
-// efficiently remove a file when the caller needs to stat it before
-// removing it.
-//
-// This optimized function exists for our QuotaFS abstraction, which needs
-// to track writes to a filesystem. When removing a file, the QuotaFS needs
-// to know if the entry is a file and if so, how large it is. Because we
-// need to Stat a file in order to get its mode and size, we will already
-// know if the entry needs to be removed by using Unlink or Rmdir. The
-// standard `Remove` method just tries both Unlink and Rmdir (in that order)
-// as it ends up usually being faster and more efficient than calling Stat +
-// the proper operation in the first place.
-func (fs *UnixFS) RemoveStat(name string) (FileInfo, error) {
-	dirfd, name, closeFd, err := fs.safePath(name)
-	defer closeFd()
-	if err != nil {
-		return nil, err
-	}
-
-	// Lstat name, we use Lstat as Unlink doesn't care about symlinks.
-	s, err := fs.Lstatat(dirfd, name)
-	if err != nil {
-		return nil, err
-	}
-
-	if s.IsDir() {
-		err = fs.unlinkat(dirfd, name, AT_REMOVEDIR) // Rmdir
-	} else {
-		err = fs.unlinkat(dirfd, name, 0)
-	}
-	if err != nil {
-		return s, convertErrorType(&PathError{Op: "remove", Path: name, Err: err})
-	}
-	return s, nil
-}
-
-// Remove removes the named file or (empty) directory.
-//
-// If there is an error, it will be of type *PathError.
-func (fs *UnixFS) Remove(name string) error {
-	dirfd, name, closeFd, err := fs.safePath(name)
-	defer closeFd()
-	if err != nil {
-		return err
-	}
-
-	// Prevent trying to Remove the base directory.
-	if name == "." {
-		return &PathError{
-			Op:   "remove",
-			Path: name,
-			Err:  ErrBadPathResolution,
-		}
-	}
-
-	// System call interface forces us to know
-	// whether name is a file or directory.
-	// Try both: it is cheaper on average than
-	// doing a Stat plus the right one.
-	err = fs.unlinkat(dirfd, name, 0)
-	if err == nil {
-		return nil
-	}
-	err1 := fs.unlinkat(dirfd, name, AT_REMOVEDIR) // Rmdir
-	if err1 == nil {
-		return nil
-	}
-
-	// Both failed: figure out which error to return.
-	// OS X and Linux differ on whether unlink(dir)
-	// returns EISDIR, so can't use that. However,
-	// both agree that rmdir(file) returns ENOTDIR,
-	// so we can use that to decide which error is real.
-	// Rmdir might also return ENOTDIR if given a bad
-	// file path, like /etc/passwd/foo, but in that case,
-	// both errors will be ENOTDIR, so it's okay to
-	// use the error from unlink.
-	if err1 != unix.ENOTDIR {
-		err = err1
-	}
-	return convertErrorType(&PathError{Op: "remove", Path: name, Err: err})
-}
-
-// RemoveAll removes path and any children it contains.
-//
-// It removes everything it can but returns the first error
-// it encounters. If the path does not exist, RemoveAll
-// returns nil (no error).
-//
-// If there is an error, it will be of type *PathError.
-func (fs *UnixFS) RemoveAll(name string) error {
-	name, err := fs.unsafePath(name)
-	if err != nil {
-		return err
-	}
-	// While removeAll internally checks this, I want to make sure we check it
-	// and return the proper error so our tests can ensure that this will never
-	// be a possibility.
-	if name == "." {
-		return &PathError{
-			Op:   "removeall",
-			Path: name,
-			Err:  ErrBadPathResolution,
-		}
-	}
-	return fs.removeAll(name)
-}
-
-func (fs *UnixFS) unlinkat(dirfd int, name string, flags int) error {
-	return ignoringEINTR(func() error {
-		return unix.Unlinkat(dirfd, name, flags)
-	})
-}
-
-// Rename renames (moves) oldpath to newpath.
-//
-// If newpath already exists and is not a directory, Rename replaces it.
-// OS-specific restrictions may apply when oldpath and newpath are in different directories.
-// Even within the same directory, on non-Unix platforms Rename is not an atomic operation.
-//
-// If there is an error, it will be of type *LinkError.
-func (fs *UnixFS) Rename(oldpath, newpath string) error {
-	// Simple case: both paths are the same.
-	if oldpath == newpath {
-		return nil
-	}
-
-	olddirfd, oldname, closeFd, err := fs.safePath(oldpath)
-	defer closeFd()
-	if err != nil {
-		return err
-	}
-	// Ensure that we are not trying to rename the base directory itself.
-	// While unix.Renameat ends up throwing a "device or resource busy" error,
-	// that doesn't mean we are protecting the system properly.
-	if oldname == "." {
-		return convertErrorType(&PathError{
-			Op:   "rename",
-			Path: oldname,
-			Err:  ErrBadPathResolution,
-		})
-	}
-	// Stat the old target to return proper errors.
-	if _, err := fs.Lstatat(olddirfd, oldname); err != nil {
-		return err
-	}
-
-	newdirfd, newname, closeFd2, err := fs.safePath(newpath)
-	if err != nil {
-		closeFd2()
-		if !errors.Is(err, ErrNotExist) {
-			return convertErrorType(err)
-		}
-		var pathErr *PathError
-		if !errors.As(err, &pathErr) {
-			return convertErrorType(err)
-		}
-		if err := fs.MkdirAll(pathErr.Path, 0o755); err != nil {
-			return err
-		}
-		newdirfd, newname, closeFd2, err = fs.safePath(newpath)
-		defer closeFd2()
-		if err != nil {
-			return err
-		}
-	} else {
-		defer closeFd2()
-	}
-
-	// Ensure that we are not trying to rename the base directory itself.
-	// While unix.Renameat ends up throwing a "device or resource busy" error,
-	// that doesn't mean we are protecting the system properly.
-	if newname == "." {
-		return convertErrorType(&PathError{
-			Op:   "rename",
-			Path: newname,
-			Err:  ErrBadPathResolution,
-		})
-	}
-	// Stat the new target to return proper errors.
-	_, err = fs.Lstatat(newdirfd, newname)
-	switch {
-	case err == nil:
-		return convertErrorType(&PathError{
-			Op:   "rename",
-			Path: newname,
-			Err:  ErrExist,
-		})
-	case !errors.Is(err, ErrNotExist):
-		return err
-	}
-	return unix.Renameat(olddirfd, oldname, newdirfd, newname)
-}
-
-// Stat returns a FileInfo describing the named file.
-//
-// If there is an error, it will be of type *PathError.
-func (fs *UnixFS) Stat(name string) (FileInfo, error) {
-	return fs.fstat(name, 0)
-}
-
-// Statat is like Stat but allows passing an existing directory file
-// descriptor rather than needing to resolve one.
-func (fs *UnixFS) Statat(dirfd int, name string) (FileInfo, error) {
-	return fs.fstatat(dirfd, name, 0)
-}
-
-// Lstat returns a FileInfo describing the named file.
-//
-// If the file is a symbolic link, the returned FileInfo
-// describes the symbolic link. Lstat makes no attempt to follow the link.
-//
-// If there is an error, it will be of type *PathError.
-func (fs *UnixFS) Lstat(name string) (FileInfo, error) {
-	return fs.fstat(name, AT_SYMLINK_NOFOLLOW)
-}
-
-// Lstatat is like Lstat but allows passing an existing directory file
-// descriptor rather than needing to resolve one.
-func (fs *UnixFS) Lstatat(dirfd int, name string) (FileInfo, error) {
-	return fs.fstatat(dirfd, name, AT_SYMLINK_NOFOLLOW)
-}
-
-func (fs *UnixFS) fstat(name string, flags int) (FileInfo, error) {
-	dirfd, name, closeFd, err := fs.safePath(name)
-	defer closeFd()
-	if err != nil {
-		return nil, err
-	}
-	return fs.fstatat(dirfd, name, flags)
-}
-
-func (fs *UnixFS) fstatat(dirfd int, name string, flags int) (FileInfo, error) {
-	var s fileStat
-	if err := ignoringEINTR(func() error {
-		return unix.Fstatat(dirfd, name, &s.sys, flags)
-	}); err != nil {
-		return nil, &PathError{Op: "stat", Path: name, Err: err}
-	}
-	fillFileStatFromSys(&s, name)
-	return &s, nil
-}
-
-// Symlink creates newname as a symbolic link to oldname.
-//
-// On Windows, a symlink to a non-existent oldname creates a file symlink;
-// if oldname is later created as a directory the symlink will not work.
-//
-// If there is an error, it will be of type *LinkError.
-func (fs *UnixFS) Symlink(oldpath, newpath string) error {
-	dirfd, newpath, closeFd, err := fs.safePath(newpath)
-	defer closeFd()
-	if err != nil {
-		return err
-	}
-	if err := ignoringEINTR(func() error {
-		// We aren't concerned with oldpath here as a symlink can point anywhere
-		// it wants.
-		return unix.Symlinkat(oldpath, dirfd, newpath)
-	}); err != nil {
-		return &LinkError{Op: "symlink", Old: oldpath, New: newpath, Err: err}
-	}
-	return nil
-}
-
-// Touch will attempt to open a file for reading and/or writing. If the file
-// does not exist it will be created, and any missing parent directories will
-// also be created. The opened file may be truncated, only if `flag` has
-// O_TRUNC set.
-func (fs *UnixFS) Touch(path string, flag int, mode FileMode) (File, error) {
-	if flag&O_CREATE == 0 {
-		flag |= O_CREATE
-	}
-	dirfd, name, closeFd, err := fs.safePath(path)
-	defer closeFd()
-	if err == nil {
-		return fs.OpenFileat(dirfd, name, flag, mode)
-	}
-	if !errors.Is(err, ErrNotExist) {
-		return nil, err
-	}
-	var pathErr *PathError
-	if !errors.As(err, &pathErr) {
-		return nil, err
-	}
-	if err := fs.MkdirAll(pathErr.Path, 0o755); err != nil {
-		return nil, err
-	}
-	// Try to open the file one more time after creating its parent directories.
-	return fs.OpenFile(path, flag, mode)
-}
-
-// WalkDir walks the file tree rooted at root, calling fn for each file or
-// directory in the tree, including root.
-//
-// All errors that arise visiting files and directories are filtered by fn:
-// see the [WalkDirFunc] documentation for details.
-//
-// The files are walked in lexical order, which makes the output deterministic
-// but requires WalkDir to read an entire directory into memory before proceeding
-// to walk that directory.
-//
-// WalkDir does not follow symbolic links found in directories,
-// but if root itself is a symbolic link, its target will be walked.
-func (fs *UnixFS) WalkDir(root string, fn WalkDirFunc) error {
-	return WalkDir(fs, root, fn)
-}
-
-// openat is a wrapper around both unix.Openat and unix.Openat2. If the UnixFS
-// was configured to enable openat2 support, unix.Openat2 will be used instead
-// of unix.Openat due to having better security properties for our use-case.
-func (fs *UnixFS) openat(dirfd int, name string, flag int, mode FileMode) (int, error) {
-	if flag&O_NOFOLLOW == 0 {
-		flag |= O_NOFOLLOW
-	}
-
-	var fd int
-	for {
-		var err error
-		if fs.useOpenat2 {
-			fd, err = fs._openat2(dirfd, name, uint64(flag), uint64(syscallMode(mode)))
-		} else {
-			fd, err = fs._openat(dirfd, name, flag, uint32(syscallMode(mode)))
-		}
-		if err == nil {
-			break
-		}
-		// We have to check EINTR here, per issues https://go.dev/issue/11180 and https://go.dev/issue/39237.
-		if err == unix.EINTR {
-			continue
-		}
-		return 0, convertErrorType(err)
-	}
-
-	// If we are not using openat2, do additional path checking. This assumes
-	// that openat2 is using `RESOLVE_BENEATH` to avoid the same security
-	// issue.
-	if !fs.useOpenat2 {
-		var finalPath string
-		finalPath, err := filepath.EvalSymlinks(filepath.Join("/proc/self/fd/", strconv.Itoa(dirfd)))
-		if err != nil {
-			return fd, convertErrorType(err)
-		}
-		if err != nil {
-			if !errors.Is(err, ErrNotExist) {
-				return fd, fmt.Errorf("failed to evaluate symlink: %w", convertErrorType(err))
-			}
-
-			// The target of one of the symlinks (EvalSymlinks is recursive)
-			// does not exist. So get the path that does not exist and use
-			// that for further validation instead.
-			var pErr *PathError
-			if ok := errors.As(err, &pErr); !ok {
-				return fd, fmt.Errorf("failed to evaluate symlink: %w", convertErrorType(err))
-			}
-			finalPath = pErr.Path
-		}
-
-		// Check if the path is within our root.
-		if !fs.unsafeIsPathInsideOfBase(finalPath) {
-			return fd, convertErrorType(&PathError{
-				Op:   "openat",
-				Path: name,
-				Err:  ErrBadPathResolution,
-			})
-		}
-	}
-	return fd, nil
-}
-
-// _openat is a wrapper around unix.Openat. This method should never be directly
-// called, use `openat` instead.
-func (fs *UnixFS) _openat(dirfd int, name string, flag int, mode uint32) (int, error) {
-	// Ensure the O_CLOEXEC flag is set.
-	// Go sets this in the os package, but since we are directly using unix
-	// we need to set it ourselves.
-	if flag&O_CLOEXEC == 0 {
-		flag |= O_CLOEXEC
-	}
-	// O_LARGEFILE is set by Openat for us automatically.
-	fd, err := unix.Openat(dirfd, name, flag, mode)
-	switch {
-	case err == nil:
-		return fd, nil
-	case err == unix.EINTR:
-		return 0, err
-	case err == unix.EAGAIN:
-		return 0, err
-	default:
-		return 0, &PathError{Op: "openat", Path: name, Err: err}
-	}
-}
-
-// _openat2 is a wonderful syscall that supersedes the `openat` syscall. It has
-// improved validation and security characteristics that weren't available or
-// considered when `openat` was originally implemented. As such, it is only
-// present in Kernel 5.6 and above.
-//
-// This method should never be directly called, use `openat` instead.
-func (fs *UnixFS) _openat2(dirfd int, name string, flag uint64, mode uint64) (int, error) {
-	// Ensure the O_CLOEXEC flag is set.
-	// Go sets this when using the os package, but since we are directly using
-	// the unix package we need to set it ourselves.
-	if flag&O_CLOEXEC == 0 {
-		flag |= O_CLOEXEC
-	}
-	// Ensure the O_LARGEFILE flag is set.
-	// Go sets this for unix.Open, unix.Openat, but not unix.Openat2.
-	if flag&O_LARGEFILE == 0 {
-		flag |= O_LARGEFILE
-	}
-	fd, err := unix.Openat2(dirfd, name, &unix.OpenHow{
-		Flags: flag,
-		Mode:  mode,
-		// This is the bread and butter of preventing a symlink escape, without
-		// this option, we have to handle path validation fully on our own.
-		//
-		// This is why using Openat2 over Openat is preferred if available.
-		Resolve: unix.RESOLVE_BENEATH,
-	})
-	switch {
-	case err == nil:
-		return fd, nil
-	case err == unix.EINTR:
-		return 0, err
-	case err == unix.EAGAIN:
-		return 0, err
-	default:
-		return 0, &PathError{Op: "openat2", Path: name, Err: err}
-	}
-}
-
-func (fs *UnixFS) SafePath(path string) (int, string, func(), error) {
-	return fs.safePath(path)
-}
-
-func (fs *UnixFS) safePath(path string) (dirfd int, file string, closeFd func(), err error) {
-	// Default closeFd to a NO-OP.
-	closeFd = func() {}
-
-	// Use unsafePath to clean the path and strip BasePath if path is absolute.
-	var name string
-	name, err = fs.unsafePath(path)
-	if err != nil {
-		return
-	}
-
-	// Check if dirfd was closed, this will happen if (*UnixFS).Close()
-	// was called.
-	fsDirfd := int(fs.dirfd.Load())
-	if fsDirfd == -1 {
-		err = ErrClosed
-		return
-	}
-
-	// Split the parent from the last element in the path, this gives us the
-	// "file name" and the full path to its parent.
-	var dir string
-	dir, file = filepath.Split(name)
-	// If dir is empty then name is not nested.
-	if dir == "" {
-		// We don't need to set closeFd here as it will default to a NO-OP and
-		// `fs.dirfd` is re-used until the filesystem is no-longer needed.
-		dirfd = fsDirfd
-
-		// Return dirfd, name, an empty closeFd func, and no error
-		return
-	}
-
-	// Dir will usually contain a trailing slash as filepath.Split doesn't
-	// trim slashes.
-	dir = strings.TrimSuffix(dir, "/")
-	dirfd, err = fs.openat(fsDirfd, dir, O_DIRECTORY|O_RDONLY, 0)
-	if dirfd != 0 {
-		// Set closeFd to close the newly opened directory file descriptor.
-		closeFd = func() { _ = unix.Close(dirfd) }
-	}
-
-	// Return dirfd, name, the closeFd func, and err
-	return
-}
-
-// unsafePath prefixes the given path and prefixes it with the filesystem's
-// base path, cleaning the result. The path returned by this function may not
-// be inside the filesystem's base path, additional checks are required to
-// safely use paths returned by this function.
-func (fs *UnixFS) unsafePath(path string) (string, error) {
-	// Calling filepath.Clean on the joined directory will resolve it to the
-	// absolute path, removing any ../ type of resolution arguments, and leaving
-	// us with a direct path link.
-	//
-	// This will also trim the existing root path off the beginning of the path
-	// passed to the function since that can get a bit messy.
-	r := filepath.Clean(filepath.Join(fs.basePath, strings.TrimPrefix(path, fs.basePath)))
-
-	if fs.unsafeIsPathInsideOfBase(r) {
-		// This is kinda ironic isn't it.
-		// We do this as we are operating with dirfds and `*at` syscalls which
-		// behave differently if given an absolute path.
-		//
-		// First trim the BasePath, then trim any leading slashes.
-		r = strings.TrimPrefix(strings.TrimPrefix(r, fs.basePath), "/")
-		// If the path is empty then return "." as the path is pointing to the
-		// root.
-		if r == "" {
-			return ".", nil
-		}
-		return r, nil
-	}
-
-	return "", &PathError{
-		Op:   "safePath",
-		Path: path,
-		Err:  ErrBadPathResolution,
-	}
-}
-
-// unsafeIsPathInsideOfBase checks if the given path is inside the filesystem's
-// base path.
-func (fs *UnixFS) unsafeIsPathInsideOfBase(path string) bool {
-	return strings.HasPrefix(
-		strings.TrimSuffix(path, "/")+"/",
-		fs.basePath+"/",
-	)
-}

internal/ufs/fs_unix_test.go

@@ -1,255 +0,0 @@
-// SPDX-License-Identifier: MIT
-// SPDX-FileCopyrightText: Copyright (c) 2024 Matthew Penner
-
-//go:build unix
-
-package ufs_test
-
-import (
-	"errors"
-	"os"
-	"path/filepath"
-	"testing"
-
-	"github.com/pterodactyl/wings/internal/ufs"
-)
-
-type testUnixFS struct {
-	*ufs.UnixFS
-
-	TmpDir string
-	Root   string
-}
-
-func (fs *testUnixFS) Cleanup() {
-	_ = fs.Close()
-	_ = os.RemoveAll(fs.TmpDir)
-}
-
-func newTestUnixFS() (*testUnixFS, error) {
-	tmpDir, err := os.MkdirTemp(os.TempDir(), "ufs")
-	if err != nil {
-		return nil, err
-	}
-	root := filepath.Join(tmpDir, "root")
-	if err := os.Mkdir(root, 0o755); err != nil {
-		return nil, err
-	}
-	// TODO: test both disabled and enabled.
-	fs, err := ufs.NewUnixFS(root, false)
-	if err != nil {
-		return nil, err
-	}
-	tfs := &testUnixFS{
-		UnixFS: fs,
-		TmpDir: tmpDir,
-		Root:   root,
-	}
-	return tfs, nil
-}
-
-func TestUnixFS_Remove(t *testing.T) {
-	t.Parallel()
-	fs, err := newTestUnixFS()
-	if err != nil {
-		t.Fatal(err)
-		return
-	}
-	defer fs.Cleanup()
-
-	t.Run("base directory", func(t *testing.T) {
-		// Try to remove the base directory.
-		if err := fs.Remove(""); !errors.Is(err, ufs.ErrBadPathResolution) {
-			t.Errorf("expected an a bad path resolution error, but got: %v", err)
-			return
-		}
-	})
-
-	t.Run("path traversal", func(t *testing.T) {
-		// Try to remove the base directory.
-		if err := fs.RemoveAll("../root"); !errors.Is(err, ufs.ErrBadPathResolution) {
-			t.Errorf("expected an a bad path resolution error, but got: %v", err)
-			return
-		}
-	})
-}
-
-func TestUnixFS_RemoveAll(t *testing.T) {
-	t.Parallel()
-	fs, err := newTestUnixFS()
-	if err != nil {
-		t.Fatal(err)
-		return
-	}
-	defer fs.Cleanup()
-
-	t.Run("base directory", func(t *testing.T) {
-		// Try to remove the base directory.
-		if err := fs.RemoveAll(""); !errors.Is(err, ufs.ErrBadPathResolution) {
-			t.Errorf("expected an a bad path resolution error, but got: %v", err)
-			return
-		}
-	})
-
-	t.Run("path traversal", func(t *testing.T) {
-		// Try to remove the base directory.
-		if err := fs.RemoveAll("../root"); !errors.Is(err, ufs.ErrBadPathResolution) {
-			t.Errorf("expected an a bad path resolution error, but got: %v", err)
-			return
-		}
-	})
-}
-
-func TestUnixFS_Rename(t *testing.T) {
-	t.Parallel()
-	fs, err := newTestUnixFS()
-	if err != nil {
-		t.Fatal(err)
-		return
-	}
-	defer fs.Cleanup()
-
-	t.Run("rename base directory", func(t *testing.T) {
-		// Try to rename the base directory.
-		if err := fs.Rename("", "yeet"); !errors.Is(err, ufs.ErrBadPathResolution) {
-			t.Errorf("expected an a bad path resolution error, but got: %v", err)
-			return
-		}
-	})
-
-	t.Run("rename over base directory", func(t *testing.T) {
-		// Create a directory that we are going to try and move over top of the
-		// existing base directory.
-		if err := fs.Mkdir("overwrite_dir", 0o755); err != nil {
-			t.Error(err)
-			return
-		}
-
-		// Try to rename over the base directory.
-		if err := fs.Rename("overwrite_dir", ""); !errors.Is(err, ufs.ErrBadPathResolution) {
-			t.Errorf("expected an a bad path resolution error, but got: %v", err)
-			return
-		}
-	})
-
-	t.Run("directory rename", func(t *testing.T) {
-		// Create a directory to rename to something else.
-		if err := fs.Mkdir("test_directory", 0o755); err != nil {
-			t.Error(err)
-			return
-		}
-
-		// Try to rename "test_directory" to "directory".
-		if err := fs.Rename("test_directory", "directory"); err != nil {
-			t.Errorf("expected no error, but got: %v", err)
-			return
-		}
-
-		// Sanity check
-		if _, err := os.Lstat(filepath.Join(fs.Root, "directory")); err != nil {
-			t.Errorf("Lstat errored when performing sanity check: %v", err)
-			return
-		}
-	})
-
-	t.Run("file rename", func(t *testing.T) {
-		// Create a directory to rename to something else.
-		if f, err := fs.Create("test_file"); err != nil {
-			t.Error(err)
-			return
-		} else {
-			_ = f.Close()
-		}
-
-		// Try to rename "test_file" to "file".
-		if err := fs.Rename("test_file", "file"); err != nil {
-			t.Errorf("expected no error, but got: %v", err)
-			return
-		}
-
-		// Sanity check
-		if _, err := os.Lstat(filepath.Join(fs.Root, "file")); err != nil {
-			t.Errorf("Lstat errored when performing sanity check: %v", err)
-			return
-		}
-	})
-}
-
-func TestUnixFS_Touch(t *testing.T) {
-	t.Parallel()
-	fs, err := newTestUnixFS()
-	if err != nil {
-		t.Fatal(err)
-		return
-	}
-	defer fs.Cleanup()
-
-	t.Run("base directory", func(t *testing.T) {
-		path := "i_touched_a_file"
-		f, err := fs.Touch(path, ufs.O_RDWR, 0o644)
-		if err != nil {
-			t.Error(err)
-			return
-		}
-		_ = f.Close()
-
-		// Sanity check
-		if _, err := os.Lstat(filepath.Join(fs.Root, path)); err != nil {
-			t.Errorf("Lstat errored when performing sanity check: %v", err)
-			return
-		}
-	})
-
-	t.Run("existing parent directory", func(t *testing.T) {
-		dir := "some_parent_directory"
-		if err := fs.Mkdir(dir, 0o755); err != nil {
-			t.Errorf("error creating parent directory: %v", err)
-			return
-		}
-		path := filepath.Join(dir, "i_touched_a_file")
-		f, err := fs.Touch(path, ufs.O_RDWR, 0o644)
-		if err != nil {
-			t.Errorf("error touching file: %v", err)
-			return
-		}
-		_ = f.Close()
-
-		// Sanity check
-		if _, err := os.Lstat(filepath.Join(fs.Root, path)); err != nil {
-			t.Errorf("Lstat errored when performing sanity check: %v", err)
-			return
-		}
-	})
-
-	t.Run("non-existent parent directory", func(t *testing.T) {
-		path := "some_other_directory/i_touched_a_file"
-		f, err := fs.Touch(path, ufs.O_RDWR, 0o644)
-		if err != nil {
-			t.Errorf("error touching file: %v", err)
-			return
-		}
-		_ = f.Close()
-
-		// Sanity check
-		if _, err := os.Lstat(filepath.Join(fs.Root, path)); err != nil {
-			t.Errorf("Lstat errored when performing sanity check: %v", err)
-			return
-		}
-	})
-
-	t.Run("non-existent parent directories", func(t *testing.T) {
-		path := "some_other_directory/some_directory/i_touched_a_file"
-		f, err := fs.Touch(path, ufs.O_RDWR, 0o644)
-		if err != nil {
-			t.Errorf("error touching file: %v", err)
-			return
-		}
-		_ = f.Close()
-
-		// Sanity check
-		if _, err := os.Lstat(filepath.Join(fs.Root, path)); err != nil {
-			t.Errorf("Lstat errored when performing sanity check: %v", err)
-			return
-		}
-	})
-}

internal/ufs/go.LICENSE

@@ -1,27 +0,0 @@
-Copyright (c) 2009 The Go Authors. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   * Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-   * Redistributions in binary form must reproduce the above
-copyright notice, this list of conditions and the following disclaimer
-in the documentation and/or other materials provided with the
-distribution.
-   * Neither the name of Google Inc. nor the names of its
-contributors may be used to endorse or promote products derived from
-this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

internal/ufs/mkdir_unix.go

@@ -1,67 +0,0 @@
-// SPDX-License-Identifier: BSD-3-Clause
-
-// Code in this file was derived from `go/src/os/path.go`.
-
-// Copyright 2009 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the `go.LICENSE` file.
-
-//go:build unix
-
-package ufs
-
-import (
-	"golang.org/x/sys/unix"
-)
-
-// mkdirAll is a recursive Mkdir implementation that properly handles symlinks.
-func (fs *UnixFS) mkdirAll(name string, mode FileMode) error {
-	// Fast path: if we can tell whether path is a directory or file, stop with success or error.
-	dir, err := fs.Lstat(name)
-	if err == nil {
-		if dir.Mode()&ModeSymlink != 0 {
-			// If the final path is a symlink, resolve its target and use that
-			// to check instead.
-			dir, err = fs.Stat(name)
-			if err != nil {
-				return err
-			}
-		}
-		if dir.IsDir() {
-			return nil
-		}
-		return convertErrorType(&PathError{Op: "mkdir", Path: name, Err: unix.ENOTDIR})
-	}
-
-	// Slow path: make sure parent exists and then call Mkdir for path.
-	i := len(name)
-	for i > 0 && name[i-1] == '/' { // Skip trailing path separator.
-		i--
-	}
-
-	j := i
-	for j > 0 && name[j-1] != '/' { // Scan backward over element.
-		j--
-	}
-
-	if j > 1 {
-		// Create parent.
-		err = fs.mkdirAll(name[:j-1], mode)
-		if err != nil {
-			return err
-		}
-	}
-
-	// Parent now exists; invoke Mkdir and use its result.
-	err = fs.Mkdir(name, mode)
-	if err != nil {
-		// Handle arguments like "foo/." by
-		// double-checking that directory doesn't exist.
-		dir, err1 := fs.Lstat(name)
-		if err1 == nil && dir.IsDir() {
-			return nil
-		}
-		return err
-	}
-	return nil
-}

internal/ufs/path_unix.go

@@ -1,80 +0,0 @@
-// SPDX-License-Identifier: BSD-3-Clause
-
-// Code in this file was copied from `go/src/os/path.go`
-// and `go/src/os/path_unix.go`.
-
-// Copyright 2009 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the `go.LICENSE` file.
-
-//go:build unix
-
-package ufs
-
-import (
-	"os"
-)
-
-// basename removes trailing slashes and the leading directory name from path name.
-func basename(name string) string {
-	i := len(name) - 1
-	// Remove trailing slashes
-	for ; i > 0 && name[i] == '/'; i-- {
-		name = name[:i]
-	}
-	// Remove leading directory name
-	for i--; i >= 0; i-- {
-		if name[i] == '/' {
-			name = name[i+1:]
-			break
-		}
-	}
-	return name
-}
-
-// endsWithDot reports whether the final component of path is ".".
-func endsWithDot(path string) bool {
-	if path == "." {
-		return true
-	}
-	if len(path) >= 2 && path[len(path)-1] == '.' && os.IsPathSeparator(path[len(path)-2]) {
-		return true
-	}
-	return false
-}
-
-// splitPath returns the base name and parent directory.
-func splitPath(path string) (string, string) {
-	// if no better parent is found, the path is relative from "here"
-	dirname := "."
-
-	// Remove all but one leading slash.
-	for len(path) > 1 && path[0] == '/' && path[1] == '/' {
-		path = path[1:]
-	}
-
-	i := len(path) - 1
-
-	// Remove trailing slashes.
-	for ; i > 0 && path[i] == '/'; i-- {
-		path = path[:i]
-	}
-
-	// if no slashes in path, base is path
-	basename := path
-
-	// Remove leading directory path
-	for i--; i >= 0; i-- {
-		if path[i] == '/' {
-			if i == 0 {
-				dirname = path[:1]
-			} else {
-				dirname = path[:i]
-			}
-			basename = path[i+1:]
-			break
-		}
-	}
-
-	return dirname, basename
-}

internal/ufs/quota_writer.go

@@ -1,117 +0,0 @@
-// SPDX-License-Identifier: MIT
-// SPDX-FileCopyrightText: Copyright (c) 2024 Matthew Penner
-
-package ufs
-
-import (
-	"errors"
-	"io"
-	"sync/atomic"
-)
-
-// CountedWriter is a writer that counts the amount of data written to the
-// underlying writer.
-type CountedWriter struct {
-	File
-
-	counter atomic.Int64
-	err     error
-}
-
-// NewCountedWriter returns a new countedWriter that counts the amount of bytes
-// written to the underlying writer.
-func NewCountedWriter(f File) *CountedWriter {
-	return &CountedWriter{File: f}
-}
-
-// BytesWritten returns the amount of bytes that have been written to the
-// underlying writer.
-func (w *CountedWriter) BytesWritten() int64 {
-	return w.counter.Load()
-}
-
-// Error returns the error from the writer if any. If the error is an EOF, nil
-// will be returned.
-func (w *CountedWriter) Error() error {
-	if errors.Is(w.err, io.EOF) {
-		return nil
-	}
-	return w.err
-}
-
-// Write writes bytes to the underlying writer while tracking the total amount
-// of bytes written.
-func (w *CountedWriter) Write(p []byte) (int, error) {
-	if w.err != nil {
-		return 0, io.EOF
-	}
-
-	// Write is a very simple operation for us to handle.
-	n, err := w.File.Write(p)
-	w.counter.Add(int64(n))
-	w.err = err
-
-	// TODO: is this how we actually want to handle errors with this?
-	if err == io.EOF {
-		return n, io.EOF
-	} else {
-		return n, nil
-	}
-}
-
-func (w *CountedWriter) ReadFrom(r io.Reader) (n int64, err error) {
-	cr := NewCountedReader(r)
-	n, err = w.File.ReadFrom(cr)
-	w.counter.Add(n)
-	return
-}
-
-// CountedReader is a reader that counts the amount of data read from the
-// underlying reader.
-type CountedReader struct {
-	reader io.Reader
-
-	counter atomic.Int64
-	err     error
-}
-
-var _ io.Reader = (*CountedReader)(nil)
-
-// NewCountedReader returns a new countedReader that counts the amount of bytes
-// read from the underlying reader.
-func NewCountedReader(r io.Reader) *CountedReader {
-	return &CountedReader{reader: r}
-}
-
-// BytesRead returns the amount of bytes that have been read from the underlying
-// reader.
-func (r *CountedReader) BytesRead() int64 {
-	return r.counter.Load()
-}
-
-// Error returns the error from the reader if any. If the error is an EOF, nil
-// will be returned.
-func (r *CountedReader) Error() error {
-	if errors.Is(r.err, io.EOF) {
-		return nil
-	}
-	return r.err
-}
-
-// Read reads bytes from the underlying reader while tracking the total amount
-// of bytes read.
-func (r *CountedReader) Read(p []byte) (int, error) {
-	if r.err != nil {
-		return 0, io.EOF
-	}
-
-	n, err := r.reader.Read(p)
-	r.counter.Add(int64(n))
-	r.err = err
-
-	if err == io.EOF {
-		return n, io.EOF
-	} else {
-		return n, nil
-	}
-}

internal/ufs/removeall_unix.go

@@ -1,207 +0,0 @@
-// SPDX-License-Identifier: BSD-3-Clause
-
-// Code in this file was derived from `go/src/os/removeall_at.go`.
-
-// Copyright 2009 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the `go.LICENSE` file.
-
-//go:build unix
-
-package ufs
-
-import (
-	"errors"
-	"io"
-	"os"
-
-	"golang.org/x/sys/unix"
-)
-
-type unixFS interface {
-	Open(name string) (File, error)
-	Remove(name string) error
-	unlinkat(dirfd int, path string, flags int) error
-}
-
-func (fs *UnixFS) removeAll(path string) error {
-	return removeAll(fs, path)
-}
-
-func removeAll(fs unixFS, path string) error {
-	if path == "" {
-		// fail silently to retain compatibility with previous behavior
-		// of RemoveAll. See issue https://go.dev/issue/28830.
-		return nil
-	}
-
-	// The rmdir system call does not permit removing ".",
-	// so we don't permit it either.
-	if endsWithDot(path) {
-		return &PathError{Op: "removeall", Path: path, Err: unix.EINVAL}
-	}
-
-	// Simple case: if Remove works, we're done.
-	err := fs.Remove(path)
-	if err == nil || errors.Is(err, ErrNotExist) {
-		return nil
-	}
-
-	// RemoveAll recurses by deleting the path base from
-	// its parent directory
-	parentDir, base := splitPath(path)
-
-	parent, err := fs.Open(parentDir)
-	if errors.Is(err, ErrNotExist) {
-		// If parent does not exist, base cannot exist. Fail silently
-		return nil
-	}
-	if err != nil {
-		return err
-	}
-	defer parent.Close()
-
-	if err := removeAllFrom(fs, parent, base); err != nil {
-		if pathErr, ok := err.(*PathError); ok {
-			pathErr.Path = parentDir + string(os.PathSeparator) + pathErr.Path
-			err = pathErr
-		}
-		return convertErrorType(err)
-	}
-	return nil
-}
-
-func removeAllFrom(fs unixFS, parent File, base string) error {
-	parentFd := int(parent.Fd())
-	// Simple case: if Unlink (aka remove) works, we're done.
-	err := fs.unlinkat(parentFd, base, 0)
-	if err == nil || errors.Is(err, ErrNotExist) {
-		return nil
-	}
-
-	// EISDIR means that we have a directory, and we need to
-	// remove its contents.
-	// EPERM or EACCES means that we don't have write permission on
-	// the parent directory, but this entry might still be a directory
-	// whose contents need to be removed.
-	// Otherwise, just return the error.
-	if err != unix.EISDIR && err != unix.EPERM && err != unix.EACCES {
-		return &PathError{Op: "unlinkat", Path: base, Err: err}
-	}
-
-	// Is this a directory we need to recurse into?
-	var statInfo unix.Stat_t
-	statErr := ignoringEINTR(func() error {
-		return unix.Fstatat(parentFd, base, &statInfo, AT_SYMLINK_NOFOLLOW)
-	})
-	if statErr != nil {
-		if errors.Is(statErr, ErrNotExist) {
-			return nil
-		}
-		return &PathError{Op: "fstatat", Path: base, Err: statErr}
-	}
-	if statInfo.Mode&unix.S_IFMT != unix.S_IFDIR {
-		// Not a directory; return the error from the unix.Unlinkat.
-		return &PathError{Op: "unlinkat", Path: base, Err: err}
-	}
-
-	// Remove the directory's entries.
-	var recurseErr error
-	for {
-		const reqSize = 1024
-		var respSize int
-
-		// Open the directory to recurse into
-		file, err := openFdAt(parentFd, base)
-		if err != nil {
-			if errors.Is(err, ErrNotExist) {
-				return nil
-			}
-			recurseErr = &PathError{Op: "openfdat", Path: base, Err: err}
-			break
-		}
-
-		for {
-			numErr := 0
-
-			names, readErr := file.Readdirnames(reqSize)
-			// Errors other than EOF should stop us from continuing.
-			if readErr != nil && readErr != io.EOF {
-				_ = file.Close()
-				if errors.Is(readErr, ErrNotExist) {
-					return nil
-				}
-				return &PathError{Op: "readdirnames", Path: base, Err: readErr}
-			}
-
-			respSize = len(names)
-			for _, name := range names {
-				err := removeAllFrom(fs, file, name)
-				if err != nil {
-					if pathErr, ok := err.(*PathError); ok {
-						pathErr.Path = base + string(os.PathSeparator) + pathErr.Path
-					}
-					numErr++
-					if recurseErr == nil {
-						recurseErr = err
-					}
-				}
-			}
-
-			// If we can delete any entry, break to start new iteration.
-			// Otherwise, we discard current names, get next entries and try deleting them.
-			if numErr != reqSize {
-				break
-			}
-		}
-
-		// Removing files from the directory may have caused
-		// the OS to reshuffle it. Simply calling Readdirnames
-		// again may skip some entries. The only reliable way
-		// to avoid this is to close and re-open the
-		// directory. See issue https://go.dev/issue/20841.
-		_ = file.Close()
-
-		// Finish when the end of the directory is reached
-		if respSize < reqSize {
-			break
-		}
-	}
-
-	// Remove the directory itself.
-	unlinkErr := fs.unlinkat(parentFd, base, AT_REMOVEDIR)
-	if unlinkErr == nil || errors.Is(unlinkErr, ErrNotExist) {
-		return nil
-	}
-
-	if recurseErr != nil {
-		return recurseErr
-	}
-	return &PathError{Op: "unlinkat", Path: base, Err: unlinkErr}
-}
-
-// openFdAt opens path relative to the directory in fd.
-// Other than that this should act like openFileNolog.
-// This acts like openFileNolog rather than OpenFile because
-// we are going to (try to) remove the file.
-// The contents of this file are not relevant for test caching.
-func openFdAt(dirfd int, name string) (File, error) {
-	var fd int
-	for {
-		var err error
-		fd, err = unix.Openat(dirfd, name, O_RDONLY|O_CLOEXEC|O_NOFOLLOW, 0)
-		if err == nil {
-			break
-		}
-
-		// See comment in openFileNolog.
-		if err == unix.EINTR {
-			continue
-		}
-
-		return nil, err
-	}
-	// This is stupid, os.NewFile immediately casts `fd` to an `int`, but wants
-	// it to be passed as a `uintptr`.
-	return os.NewFile(uintptr(fd), name), nil
-}

internal/ufs/stat_unix.go

@@ -1,67 +0,0 @@
-// SPDX-License-Identifier: BSD-3-Clause
-
-// Code in this file was copied from `go/src/os/stat_linux.go`
-// and `go/src/os/types_unix.go`.
-
-// Copyright 2009 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the `go.LICENSE` file.
-
-//go:build unix
-
-package ufs
-
-import (
-	"time"
-
-	"golang.org/x/sys/unix"
-)
-
-type fileStat struct {
-	name    string
-	size    int64
-	mode    FileMode
-	modTime time.Time
-	sys     unix.Stat_t
-}
-
-var _ FileInfo = (*fileStat)(nil)
-
-func (fs *fileStat) Size() int64        { return fs.size }
-func (fs *fileStat) Mode() FileMode     { return fs.mode }
-func (fs *fileStat) ModTime() time.Time { return fs.modTime }
-func (fs *fileStat) Sys() any           { return &fs.sys }
-func (fs *fileStat) Name() string       { return fs.name }
-func (fs *fileStat) IsDir() bool        { return fs.Mode().IsDir() }
-
-func fillFileStatFromSys(fs *fileStat, name string) {
-	fs.name = basename(name)
-	fs.size = fs.sys.Size
-	fs.modTime = time.Unix(fs.sys.Mtim.Unix())
-	fs.mode = FileMode(fs.sys.Mode & 0o777)
-	switch fs.sys.Mode & unix.S_IFMT {
-	case unix.S_IFBLK:
-		fs.mode |= ModeDevice
-	case unix.S_IFCHR:
-		fs.mode |= ModeDevice | ModeCharDevice
-	case unix.S_IFDIR:
-		fs.mode |= ModeDir
-	case unix.S_IFIFO:
-		fs.mode |= ModeNamedPipe
-	case unix.S_IFLNK:
-		fs.mode |= ModeSymlink
-	case unix.S_IFREG:
-		// nothing to do
-	case unix.S_IFSOCK:
-		fs.mode |= ModeSocket
-	}
-	if fs.sys.Mode&unix.S_ISGID != 0 {
-		fs.mode |= ModeSetgid
-	}
-	if fs.sys.Mode&unix.S_ISUID != 0 {
-		fs.mode |= ModeSetuid
-	}
-	if fs.sys.Mode&unix.S_ISVTX != 0 {
-		fs.mode |= ModeSticky
-	}
-}

internal/ufs/walk.go

@@ -1,123 +0,0 @@
-// SPDX-License-Identifier: BSD-3-Clause
-
-// Code in this file was derived from `go/src/io/fs/walk.go`.
-
-// Copyright 2020 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the `go.LICENSE` file.
-
-package ufs
-
-import (
-	iofs "io/fs"
-	"path"
-)
-
-// SkipDir is used as a return value from [WalkDirFunc] to indicate that
-// the directory named in the call is to be skipped. It is not returned
-// as an error by any function.
-var SkipDir = iofs.SkipDir
-
-// SkipAll is used as a return value from [WalkDirFunc] to indicate that
-// all remaining files and directories are to be skipped. It is not returned
-// as an error by any function.
-var SkipAll = iofs.SkipAll
-
-// WalkDirFunc is the type of the function called by [WalkDir] to visit
-// each file or directory.
-//
-// The path argument contains the argument to [WalkDir] as a prefix.
-// That is, if WalkDir is called with root argument "dir" and finds a file
-// named "a" in that directory, the walk function will be called with
-// argument "dir/a".
-//
-// The d argument is the [DirEntry] for the named path.
-//
-// The error result returned by the function controls how [WalkDir]
-// continues. If the function returns the special value [SkipDir], WalkDir
-// skips the current directory (path if d.IsDir() is true, otherwise
-// path's parent directory). If the function returns the special value
-// [SkipAll], WalkDir skips all remaining files and directories. Otherwise,
-// if the function returns a non-nil error, WalkDir stops entirely and
-// returns that error.
-//
-// The err argument reports an error related to path, signaling that
-// [WalkDir] will not walk into that directory. The function can decide how
-// to handle that error; as described earlier, returning the error will
-// cause WalkDir to stop walking the entire tree.
-//
-// [WalkDir] calls the function with a non-nil err argument in two cases.
-//
-// First, if the initial [Stat] on the root directory fails, WalkDir
-// calls the function with path set to root, d set to nil, and err set to
-// the error from [fs.Stat].
-//
-// Second, if a directory's ReadDir method (see [ReadDirFile]) fails, WalkDir calls the
-// function with path set to the directory's path, d set to an
-// [DirEntry] describing the directory, and err set to the error from
-// ReadDir. In this second case, the function is called twice with the
-// path of the directory: the first call is before the directory read is
-// attempted and has err set to nil, giving the function a chance to
-// return [SkipDir] or [SkipAll] and avoid the ReadDir entirely. The second call
-// is after a failed ReadDir and reports the error from ReadDir.
-// (If ReadDir succeeds, there is no second call.)
-type WalkDirFunc func(path string, d DirEntry, err error) error
-
-// WalkDir walks the file tree rooted at root, calling fn for each file or
-// directory in the tree, including root.
-//
-// All errors that arise visiting files and directories are filtered by fn:
-// see the [WalkDirFunc] documentation for details.
-//
-// The files are walked in lexical order, which makes the output deterministic
-// but requires WalkDir to read an entire directory into memory before proceeding
-// to walk that directory.
-//
-// WalkDir does not follow symbolic links found in directories,
-// but if root itself is a symbolic link, its target will be walked.
-func WalkDir(fs Filesystem, root string, fn WalkDirFunc) error {
-	info, err := fs.Stat(root)
-	if err != nil {
-		err = fn(root, nil, err)
-	} else {
-		err = walkDir(fs, root, iofs.FileInfoToDirEntry(info), fn)
-	}
-	if err == SkipDir || err == SkipAll {
-		return nil
-	}
-	return err
-}
-
-// walkDir recursively descends path, calling walkDirFn.
-func walkDir(fs Filesystem, name string, d DirEntry, walkDirFn WalkDirFunc) error {
-	if err := walkDirFn(name, d, nil); err != nil || !d.IsDir() {
-		if err == SkipDir && d.IsDir() {
-			// Successfully skipped directory.
-			err = nil
-		}
-		return err
-	}
-
-	dirs, err := fs.ReadDir(name)
-	if err != nil {
-		// Second call, to report ReadDir error.
-		err = walkDirFn(name, d, err)
-		if err != nil {
-			if err == SkipDir && d.IsDir() {
-				err = nil
-			}
-			return err
-		}
-	}
-
-	for _, d1 := range dirs {
-		name1 := path.Join(name, d1.Name())
-		if err := walkDir(fs, name1, d1, walkDirFn); err != nil {
-			if err == SkipDir {
-				break
-			}
-			return err
-		}
-	}
-	return nil
-}

internal/ufs/walk_unix.go

@@ -1,298 +0,0 @@
-// SPDX-License-Identifier: BSD-2-Clause
-
-// Some code in this file was derived from https://github.com/karrick/godirwalk.
-
-//go:build unix
-
-package ufs
-
-import (
-	"bytes"
-	iofs "io/fs"
-	"os"
-	"path"
-	"path/filepath"
-	"reflect"
-	"unsafe"
-
-	"golang.org/x/sys/unix"
-)
-
-type WalkDiratFunc func(dirfd int, name, relative string, d DirEntry, err error) error
-
-func (fs *UnixFS) WalkDirat(dirfd int, name string, fn WalkDiratFunc) error {
-	if dirfd == 0 {
-		// TODO: proper validation, ideally a dedicated function.
-		dirfd = int(fs.dirfd.Load())
-	}
-	info, err := fs.Lstatat(dirfd, name)
-	if err != nil {
-		err = fn(dirfd, name, name, nil, err)
-	} else {
-		b := newScratchBuffer()
-		err = fs.walkDir(b, dirfd, name, name, iofs.FileInfoToDirEntry(info), fn)
-	}
-	if err == SkipDir || err == SkipAll {
-		return nil
-	}
-	return err
-}
-
-func (fs *UnixFS) walkDir(b []byte, parentfd int, name, relative string, d DirEntry, walkDirFn WalkDiratFunc) error {
-	if err := walkDirFn(parentfd, name, relative, d, nil); err != nil || !d.IsDir() {
-		if err == SkipDir && d.IsDir() {
-			// Successfully skipped directory.
-			err = nil
-		}
-		return err
-	}
-
-	dirfd, err := fs.openat(parentfd, name, O_DIRECTORY|O_RDONLY, 0)
-	if err != nil {
-		return err
-	}
-	defer unix.Close(dirfd)
-
-	dirs, err := fs.readDir(dirfd, name, b)
-	if err != nil {
-		// Second call, to report ReadDir error.
-		err = walkDirFn(dirfd, name, relative, d, err)
-		if err != nil {
-			if err == SkipDir && d.IsDir() {
-				err = nil
-			}
-			return err
-		}
-	}
-
-	for _, d1 := range dirs {
-		// TODO: the path.Join on this line may actually be partially incorrect.
-		// If we are not walking starting at the root, relative will contain the
-		// name of the directory we are starting the walk from, which will be
-		// relative to the root of the filesystem instead of from where the walk
-		// was initiated from.
-		//
-		// ref; https://github.com/pterodactyl/panel/issues/5030
-		if err := fs.walkDir(b, dirfd, d1.Name(), path.Join(relative, d1.Name()), d1, walkDirFn); err != nil {
-			if err == SkipDir {
-				break
-			}
-			return err
-		}
-	}
-	return nil
-}
-
-// ReadDirMap .
-// TODO: document
-func ReadDirMap[T any](fs *UnixFS, path string, fn func(DirEntry) (T, error)) ([]T, error) {
-	dirfd, name, closeFd, err := fs.safePath(path)
-	defer closeFd()
-	if err != nil {
-		return nil, err
-	}
-	fd, err := fs.openat(dirfd, name, O_DIRECTORY|O_RDONLY, 0)
-	if err != nil {
-		return nil, err
-	}
-	defer unix.Close(fd)
-
-	entries, err := fs.readDir(fd, ".", nil)
-	if err != nil {
-		return nil, err
-	}
-
-	out := make([]T, len(entries))
-	for i, e := range entries {
-		idx := i
-		e := e
-		v, err := fn(e)
-		if err != nil {
-			return nil, err
-		}
-		out[idx] = v
-	}
-	return out, nil
-}
-
-// nameOffset is a compile time constant
-const nameOffset = int(unsafe.Offsetof(unix.Dirent{}.Name))
-
-func nameFromDirent(de *unix.Dirent) (name []byte) {
-	// Because this GOOS' syscall.Dirent does not provide a field that specifies
-	// the name length, this function must first calculate the max possible name
-	// length, and then search for the NULL byte.
-	ml := int(de.Reclen) - nameOffset
-
-	// Convert syscall.Dirent.Name, which is array of int8, to []byte, by
-	// overwriting Cap, Len, and Data slice header fields to the max possible
-	// name length computed above, and finding the terminating NULL byte.
-	//
-	// TODO: is there an alternative to the deprecated SliceHeader?
-	// SliceHeader was mainly deprecated due to it being misused for avoiding
-	// allocations when converting a byte slice to a string, ref;
-	// https://go.dev/issue/53003
-	sh := (*reflect.SliceHeader)(unsafe.Pointer(&name))
-	sh.Cap = ml
-	sh.Len = ml
-	sh.Data = uintptr(unsafe.Pointer(&de.Name[0]))
-
-	if index := bytes.IndexByte(name, 0); index >= 0 {
-		// Found NULL byte; set slice's cap and len accordingly.
-		sh.Cap = index
-		sh.Len = index
-		return
-	}
-
-	// NOTE: This branch is not expected, but included for defensive
-	// programming, and provides a hard stop on the name based on the structure
-	// field array size.
-	sh.Cap = len(de.Name)
-	sh.Len = sh.Cap
-	return
-}
-
-// modeTypeFromDirent converts a syscall defined constant, which is in purview
-// of OS, to a constant defined by Go, assumed by this project to be stable.
-//
-// When the syscall constant is not recognized, this function falls back to a
-// Stat on the file system.
-func (fs *UnixFS) modeTypeFromDirent(fd int, de *unix.Dirent, osDirname, osBasename string) (FileMode, error) {
-	switch de.Type {
-	case unix.DT_REG:
-		return 0, nil
-	case unix.DT_DIR:
-		return ModeDir, nil
-	case unix.DT_LNK:
-		return ModeSymlink, nil
-	case unix.DT_CHR:
-		return ModeDevice | ModeCharDevice, nil
-	case unix.DT_BLK:
-		return ModeDevice, nil
-	case unix.DT_FIFO:
-		return ModeNamedPipe, nil
-	case unix.DT_SOCK:
-		return ModeSocket, nil
-	default:
-		// If syscall returned unknown type (e.g., DT_UNKNOWN, DT_WHT), then
-		// resolve actual mode by reading file information.
-		return fs.modeType(fd, filepath.Join(osDirname, osBasename))
-	}
-}
-
-// modeType returns the mode type of the file system entry identified by
-// osPathname by calling os.LStat function, to intentionally not follow symbolic
-// links.
-//
-// Even though os.LStat provides all file mode bits, we want to ensure same
-// values returned to caller regardless of whether we obtained file mode bits
-// from syscall or stat call. Therefore, mask out the additional file mode bits
-// that are provided by stat but not by the syscall, so users can rely on their
-// values.
-func (fs *UnixFS) modeType(dirfd int, name string) (os.FileMode, error) {
-	fi, err := fs.Lstatat(dirfd, name)
-	if err == nil {
-		return fi.Mode() & ModeType, nil
-	}
-	return 0, err
-}
-
-var minimumScratchBufferSize = os.Getpagesize()
-
-func newScratchBuffer() []byte {
-	return make([]byte, minimumScratchBufferSize)
-}
-
-func (fs *UnixFS) readDir(fd int, name string, b []byte) ([]DirEntry, error) {
-	scratchBuffer := b
-	if scratchBuffer == nil || len(scratchBuffer) < minimumScratchBufferSize {
-		scratchBuffer = newScratchBuffer()
-	}
-
-	var entries []DirEntry
-	var workBuffer []byte
-
-	var sde unix.Dirent
-	for {
-		if len(workBuffer) == 0 {
-			n, err := unix.Getdents(fd, scratchBuffer)
-			if err != nil {
-				if err == unix.EINTR {
-					continue
-				}
-				return nil, convertErrorType(err)
-			}
-			if n <= 0 {
-				// end of directory: normal exit
-				return entries, nil
-			}
-			workBuffer = scratchBuffer[:n] // trim work buffer to number of bytes read
-		}
-
-		// "Go is like C, except that you just put `unsafe` all over the place".
-		copy((*[unsafe.Sizeof(unix.Dirent{})]byte)(unsafe.Pointer(&sde))[:], workBuffer)
-		workBuffer = workBuffer[sde.Reclen:] // advance buffer for next iteration through loop
-
-		if sde.Ino == 0 {
-			continue // inode set to 0 indicates an entry that was marked as deleted
-		}
-
-		nameSlice := nameFromDirent(&sde)
-		nameLength := len(nameSlice)
-
-		if nameLength == 0 || (nameSlice[0] == '.' && (nameLength == 1 || (nameLength == 2 && nameSlice[1] == '.'))) {
-			continue
-		}
-
-		childName := string(nameSlice)
-		mt, err := fs.modeTypeFromDirent(fd, &sde, name, childName)
-		if err != nil {
-			return nil, convertErrorType(err)
-		}
-		entries = append(entries, &dirent{name: childName, path: name, modeType: mt, dirfd: fd, fs: fs})
-	}
-}
-
-// dirent stores the name and file system mode type of discovered file system
-// entries.
-type dirent struct {
-	name     string
-	path     string
-	modeType FileMode
-
-	dirfd int
-	fs    *UnixFS
-}
-
-func (de dirent) Name() string {
-	return de.name
-}
-
-func (de dirent) IsDir() bool {
-	return de.modeType&ModeDir != 0
-}
-
-func (de dirent) Type() FileMode {
-	return de.modeType
-}
-
-func (de dirent) Info() (FileInfo, error) {
-	if de.fs == nil {
-		return nil, nil
-	}
-	return de.fs.Lstatat(de.dirfd, de.name)
-}
-
-func (de dirent) Open() (File, error) {
-	if de.fs == nil {
-		return nil, nil
-	}
-	return de.fs.OpenFileat(de.dirfd, de.name, O_RDONLY, 0)
-}
-
-// reset releases memory held by entry err and name, and resets mode type to 0.
-func (de *dirent) reset() {
-	de.name = ""
-	de.path = ""
-	de.modeType = 0
-}

loggers/cli/cli.go

@@ -1,25 +1,22 @@
 package cli
 
 import (
+	"emperror.dev/errors"
 	"fmt"
+	"github.com/apex/log"
+	"github.com/apex/log/handlers/cli"
+	color2 "github.com/fatih/color"
+	"github.com/mattn/go-colorable"
 	"io"
 	"os"
 	"strings"
 	"sync"
 	"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{
 	log.DebugLevel: "DEBUG",

metrics/metrics.go

@@ -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)
+}

parser/helpers.go

@@ -2,6 +2,8 @@ package parser
 
 import (
 	"bytes"
+	"io/ioutil"
+	"os"
 	"regexp"
 	"strconv"
 	"strings"
@@ -27,28 +29,38 @@ var configMatchRegex = regexp.MustCompile(`{{\s?config\.([\w.-]+)\s?}}`)
 // matching:
 //
 // <Root>
-//
 //   <Property value="testing"/>
-//
 // </Root>
 //
 // noinspection RegExpRedundantEscape
 var xmlValueMatchRegex = regexp.MustCompile(`^\[([\w]+)='(.*)'\]$`)
 
+// 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.
+func readFileBytes(path string) ([]byte, error) {
+	file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0644)
+	if err != nil {
+		return nil, err
+	}
+	defer file.Close()
+
+	return ioutil.ReadAll(file)
+}
+
 // 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 {
-		v, _ := strconv.ParseBool(value)
+		v, _ := strconv.ParseBool(string(value))
 		return v
 	}
 
 	// Try to parse into an int, if this fails just ignore the error and continue
 	// through, returning the string.
-	if v, err := strconv.Atoi(value); err == nil {
+	if v, err := strconv.Atoi(string(value)); err == nil {
 		return v
 	}
 
-	return value
+	return string(value)
 }
 
 // Iterate over an unstructured JSON/YAML/etc. interface and set all of the required
@@ -85,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
 			// time this code is being written.
 			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) {
 						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) {
 					continue
 				}
+
 				return nil, errors.WithMessage(err, "unable to set config value at pathway: "+v.Match)
 			}
 		}
+	}
 
 	return parsed, nil
 }
@@ -119,10 +132,13 @@ func setValueAtPath(c *gabs.Container, path string, value interface{}) error {
 	var err error
 
 	matches := checkForArrayElement.FindStringSubmatch(path)
-
-	// Check if we are **NOT** updating an array element.
 	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)
+		}
+
 		return err
 	}
 
@@ -180,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
 // 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 == "" {
 		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:"))
 		if err != nil {
 			log.WithFields(log.Fields{"if_value": strings.TrimPrefix(cfr.IfValue, "regex:"), "error": err}).
 				Warn("configuration if_value using invalid regexp, cannot perform replacement")
+
 			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)) {
-			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
 	}
 

parser/parser.go

@@ -2,8 +2,10 @@ package parser
 
 import (
 	"bufio"
-	"bytes"
+	"encoding/json"
-	"io"
+	"io/ioutil"
+	"os"
+	"path/filepath"
 	"strconv"
 	"strings"
 
@@ -11,14 +13,11 @@ import (
 	"github.com/apex/log"
 	"github.com/beevik/etree"
 	"github.com/buger/jsonparser"
-	"github.com/goccy/go-json"
 	"github.com/icza/dyno"
 	"github.com/magiconair/properties"
-	"gopkg.in/ini.v1"
-	"gopkg.in/yaml.v3"
-
 	"github.com/pterodactyl/wings/config"
-	"github.com/pterodactyl/wings/internal/ufs"
+	"gopkg.in/ini.v1"
+	"gopkg.in/yaml.v2"
 )
 
 // The file parsing options that are available for a server configuration file.
@@ -57,42 +56,17 @@ func (cv *ReplaceValue) Type() jsonparser.ValueType {
 // handle casting the UTF-8 sequence into the expected value, switching something
 // like "\u00a7Foo" into "§Foo".
 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)
 	if err != nil {
 		panic(errors.Wrap(err, "parser: could not parse value"))
 	}
 	return str
-	case jsonparser.Null:
-		return "<nil>"
-	case jsonparser.Boolean:
-		return string(cv.value)
-	case jsonparser.Number:
-		return string(cv.value)
-	default:
-		return "<invalid>"
-	}
-}
-
-func (cv *ReplaceValue) Bytes() []byte {
-	switch cv.Type() {
-	case jsonparser.String:
-		var stackbuf [64]byte
-		bU, err := jsonparser.Unescape(cv.value, stackbuf[:])
-		if err != nil {
-			panic(errors.Wrap(err, "parser: could not parse value"))
-		}
-		return bU
-	case jsonparser.Null:
-		return []byte("<nil>")
-	case jsonparser.Boolean:
-		return cv.value
-	case jsonparser.Number:
-		return cv.value
-	default:
-		return []byte("<invalid>")
-	}
 }
 
 type ConfigurationParser string
@@ -101,8 +75,8 @@ func (cp ConfigurationParser) String() string {
 	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 {
 	FileName string                         `json:"file"`
 	Parser   ConfigurationParser            `json:"parser"`
@@ -113,10 +87,12 @@ type ConfigurationFile struct {
 	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 {
 	var m map[string]*json.RawMessage
 	if err := json.Unmarshal(data, &m); err != nil {
@@ -188,12 +164,11 @@ func (cfr *ConfigurationFileReplacement) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
-// Parse parses a given configuration file and updates all the values within
+// Parses a given configuration file and updates all of the values within as defined
-// as defined in the API response from the Panel.
+// in the API response from the Panel.
-func (f *ConfigurationFile) Parse(file ufs.File) error {
+func (f *ConfigurationFile) Parse(path string, internal bool) error {
-	//log.WithField("path", path).WithField("parser", f.Parser.String()).Debug("parsing server configuration file")
+	log.WithField("path", path).WithField("parser", f.Parser.String()).Debug("parsing server configuration file")
 
-	// What the fuck is going on here?
 	if mb, err := json.Marshal(config.Get()); err != nil {
 		return err
 	} else {
@@ -204,24 +179,56 @@ func (f *ConfigurationFile) Parse(file ufs.File) error {
 
 	switch f.Parser {
 	case Properties:
-		err = f.parsePropertiesFile(file)
+		err = f.parsePropertiesFile(path)
+		break
 	case File:
-		err = f.parseTextFile(file)
+		err = f.parseTextFile(path)
+		break
 	case Yaml, "yml":
-		err = f.parseYamlFile(file)
+		err = f.parseYamlFile(path)
+		break
 	case Json:
-		err = f.parseJsonFile(file)
+		err = f.parseJsonFile(path)
+		break
 	case Ini:
-		err = f.parseIniFile(file)
+		err = f.parseIniFile(path)
+		break
 	case Xml:
-		err = f.parseXmlFile(file)
+		err = f.parseXmlFile(path)
+		break
 	}
+
+	if errors.Is(err, os.ErrNotExist) {
+		// File doesn't exist, we tried creating it, and same error is returned? Pretty
+		// sure this pathway is impossible, but if not, abort here.
+		if internal {
+			return nil
+		}
+
+		b := strings.TrimSuffix(path, filepath.Base(path))
+		if err := os.MkdirAll(b, 0755); err != nil {
+			return errors.WithMessage(err, "failed to create base directory for missing configuration file")
+		} else {
+			if _, err := os.Create(path); err != nil {
+				return errors.WithMessage(err, "failed to create missing configuration file")
+			}
+		}
+
+		return f.Parse(path, true)
+	}
+
 	return err
 }
 
 // Parses an xml file.
-func (f *ConfigurationFile) parseXmlFile(file ufs.File) error {
+func (f *ConfigurationFile) parseXmlFile(path string) error {
 	doc := etree.NewDocument()
+	file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0644)
+	if err != nil {
+		return err
+	}
+	defer file.Close()
+
 	if _, err := doc.ReadFrom(file); err != nil {
 		return err
 	}
@@ -281,55 +288,47 @@ func (f *ConfigurationFile) parseXmlFile(file ufs.File) error {
 		}
 	}
 
-	if _, err := file.Seek(0, io.SeekStart); err != nil {
+	// If you don't truncate the file you'll end up duplicating the data in there (or just appending
-		return err
+	// to the end of the file. We don't want to do that.
-	}
 	if err := file.Truncate(0); err != nil {
 		return err
 	}
 
+	// Move the cursor to the start of the file to avoid weird spacing issues.
+	file.Seek(0, 0)
+
 	// Ensure the XML is indented properly.
 	doc.Indent(2)
 
-	// Write the XML to the file.
+	// Truncate the file before attempting to write the changes.
-	if _, err := doc.WriteTo(file); err != nil {
+	if err := os.Truncate(path, 0); err != nil {
 		return err
 	}
-	return nil
+
+	// Write the XML to the file.
+	_, err = doc.WriteTo(file)
+
+	return err
 }
 
 // Parses an ini file.
-func (f *ConfigurationFile) parseIniFile(file ufs.File) error {
+func (f *ConfigurationFile) parseIniFile(path string) error {
-	// Wrap the file in a NopCloser so the ini package doesn't close the file.
+	// Ini package can't handle a non-existent file, so handle that automatically here
-	cfg, err := ini.Load(io.NopCloser(file))
+	// by creating it if not exists. Then, immediately close the file since we will use
+	// other methods to write the new contents.
+	file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0644)
+	if err != nil {
+		return err
+	}
+	file.Close()
+
+	cfg, err := ini.Load(path)
 	if err != nil {
 		return err
 	}
 
 	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)
 		if err != nil {
@@ -364,24 +363,14 @@ func (f *ConfigurationFile) parseIniFile(file ufs.File) error {
 		}
 	}
 
-	if _, err := file.Seek(0, io.SeekStart); err != nil {
+	return cfg.SaveTo(path)
-		return err
-	}
-	if err := file.Truncate(0); err != nil {
-		return err
-	}
-
-	if _, err := cfg.WriteTo(file); err != nil {
-		return err
-	}
-	return nil
 }
 
 // Parses a json file updating any matching key/value pairs. If a match is not found, the
 // value is set regardless in the file. See the commentary in parseYamlFile for more details
 // about what is happening during this process.
-func (f *ConfigurationFile) parseJsonFile(file ufs.File) error {
+func (f *ConfigurationFile) parseJsonFile(path string) error {
-	b, err := io.ReadAll(file)
+	b, err := readFileBytes(path)
 	if err != nil {
 		return err
 	}
@@ -391,24 +380,14 @@ func (f *ConfigurationFile) parseJsonFile(file ufs.File) error {
 		return err
 	}
 
-	if _, err := file.Seek(0, io.SeekStart); err != nil {
+	output := []byte(data.StringIndent("", "    "))
-		return err
+	return ioutil.WriteFile(path, output, 0644)
-	}
-	if err := file.Truncate(0); err != nil {
-		return err
-	}
-
-	// Write the data to the file.
-	if _, err := io.Copy(file, bytes.NewReader(data.BytesIndent("", "    "))); err != nil {
-		return errors.Wrap(err, "parser: failed to write properties file to disk")
-	}
-	return nil
 }
 
 // Parses a yaml file and updates any matching key/value pairs before persisting
 // it back to the disk.
-func (f *ConfigurationFile) parseYamlFile(file ufs.File) error {
+func (f *ConfigurationFile) parseYamlFile(path string) error {
-	b, err := io.ReadAll(file)
+	b, err := readFileBytes(path)
 	if err != nil {
 		return err
 	}
@@ -439,56 +418,35 @@ func (f *ConfigurationFile) parseYamlFile(file ufs.File) error {
 		return err
 	}
 
-	if _, err := file.Seek(0, io.SeekStart); err != nil {
+	return ioutil.WriteFile(path, marshaled, 0644)
-		return err
-	}
-	if err := file.Truncate(0); err != nil {
-		return err
-	}
-
-	// Write the data to the file.
-	if _, err := io.Copy(file, bytes.NewReader(marshaled)); err != nil {
-		return errors.Wrap(err, "parser: failed to write properties file to disk")
-	}
-	return nil
 }
 
 // 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
 // than this function where possible.
-func (f *ConfigurationFile) parseTextFile(file ufs.File) error {
+func (f *ConfigurationFile) parseTextFile(path string) error {
-	b := bytes.NewBuffer(nil)
+	input, err := ioutil.ReadFile(path)
-	s := bufio.NewScanner(file)
+	if err != nil {
-	var replaced bool
+		return err
-	for s.Scan() {
+	}
-		line := s.Bytes()
+
-		replaced = false
+	lines := strings.Split(string(input), "\n")
+	for i, line := range lines {
 		for _, replace := range f.Replace {
 			// If this line doesn't match what we expect for the replacement, move on to the next
 			// line. Otherwise, update the line to have the replacement value.
-			if !bytes.HasPrefix(line, []byte(replace.Match)) {
+			if !strings.HasPrefix(line, replace.Match) {
 				continue
 			}
-			b.Write(replace.ReplaceWith.Bytes())
+
-			replaced = true
+			lines[i] = replace.ReplaceWith.String()
 		}
-		if !replaced {
-			b.Write(line)
-		}
-		b.WriteByte('\n')
 	}
 
-	if _, err := file.Seek(0, io.SeekStart); err != nil {
+	if err := ioutil.WriteFile(path, []byte(strings.Join(lines, "\n")), 0644); err != nil {
-		return err
-	}
-	if err := file.Truncate(0); err != nil {
 		return err
 	}
 
-	// Write the data to the file.
-	if _, err := io.Copy(file, b); err != nil {
-		return errors.Wrap(err, "parser: failed to write properties file to disk")
-	}
 	return nil
 }
 
@@ -518,29 +476,31 @@ func (f *ConfigurationFile) parseTextFile(file ufs.File) error {
 //
 // @see https://github.com/pterodactyl/panel/issues/2308 (original)
 // @see https://github.com/pterodactyl/panel/issues/3009 ("bug" introduced as result)
-func (f *ConfigurationFile) parsePropertiesFile(file ufs.File) error {
+func (f *ConfigurationFile) parsePropertiesFile(path string) error {
-	b, err := io.ReadAll(file)
+	var s strings.Builder
-	if err != nil {
+	// Open the file and attempt to load any comments that currenty exist at the start
-		return err
+	// of the file. This is kind of a hack, but should work for a majority of users for
-	}
+	// the time being.
-
+	if fd, err := os.Open(path); err != nil {
-	s := bytes.NewBuffer(nil)
+		return errors.Wrap(err, "parser: could not open file for reading")
-	scanner := bufio.NewScanner(bytes.NewReader(b))
+	} else {
+		scanner := bufio.NewScanner(fd)
 		// Scan until we hit a line that is not a comment that actually has content
 		// on it. Keep appending the comments until that time.
 		for scanner.Scan() {
-		text := scanner.Bytes()
+			text := scanner.Text()
 			if len(text) > 0 && text[0] != '#' {
 				break
 			}
-		s.Write(text)
+			s.WriteString(text + "\n")
-		s.WriteByte('\n')
 		}
+		_ = fd.Close()
 		if err := scanner.Err(); err != nil {
 			return errors.WithStackIf(err)
 		}
+	}
 
-	p, err := properties.Load(b, properties.UTF8)
+	p, err := properties.LoadFile(path, properties.UTF8)
 	if err != nil {
 		return errors.Wrap(err, "parser: could not load properties file for configuration update")
 	}
@@ -578,16 +538,17 @@ func (f *ConfigurationFile) parsePropertiesFile(file ufs.File) error {
 		s.WriteString(key + "=" + strings.Trim(strconv.QuoteToASCII(value), "\"") + "\n")
 	}
 
-	if _, err := file.Seek(0, io.SeekStart); err != nil {
+	// Open the file for writing.
-		return err
+	w, err := os.OpenFile(path, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644)
-	}
+	if err != nil {
-	if err := file.Truncate(0); err != nil {
 		return err
 	}
+	defer w.Close()
 
 	// Write the data to the file.
-	if _, err := io.Copy(file, s); err != nil {
+	if _, err := w.Write([]byte(s.String())); err != nil {
 		return errors.Wrap(err, "parser: failed to write properties file to disk")
 	}
+
 	return nil
 }

remote/errors.go

@@ -57,7 +57,8 @@ func (re *RequestError) StatusCode() int {
 	return re.response.StatusCode
 }
 
-type SftpInvalidCredentialsError struct{}
+type SftpInvalidCredentialsError struct {
+}
 
 func (ice SftpInvalidCredentialsError) Error() string {
 	return "the credentials provided were invalid"

remote/http.go

@@ -3,20 +3,18 @@ package remote
 import (
 	"bytes"
 	"context"
+	"encoding/json"
 	"fmt"
 	"io"
+	"io/ioutil"
 	"net/http"
 	"strconv"
 	"strings"
 	"time"
 
-	"github.com/pterodactyl/wings/internal/models"
-
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/cenkalti/backoff/v4"
-	"github.com/goccy/go-json"
-
 	"github.com/pterodactyl/wings/system"
 )
 
@@ -29,10 +27,9 @@ type Client interface {
 	SetArchiveStatus(ctx context.Context, uuid string, successful bool) error
 	SetBackupStatus(ctx context.Context, backup string, data BackupRequest) error
 	SendRestorationStatus(ctx context.Context, backup string, successful bool) error
-	SetInstallationStatus(ctx context.Context, uuid string, data InstallStatusRequest) error
+	SetInstallationStatus(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)
-	SendActivityLogs(ctx context.Context, activity []models.Activity) error
 }
 
 type client struct {
@@ -121,7 +118,7 @@ func (c *client) requestOnce(ctx context.Context, method, path string, body io.R
 	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.
 // 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
@@ -131,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
 // created. Errors returned will be of the RequestError type if there was some
 // 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
 	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 errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
 				return backoff.Permanent(err)
@@ -154,10 +142,12 @@ func (c *client) request(ctx context.Context, method, path string, body *bytes.B
 		if r.HasError() {
 			// Close the request body after returning the error to free up resources.
 			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 r.Error()
@@ -180,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
 // slower SQL queries on the Panel to potentially self-resolve without just
 // 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.
 //
 // If maxAttempts is a value greater than 0 the backoff will be capped at a total
@@ -233,9 +223,9 @@ func (r *Response) Read() ([]byte, error) {
 		return nil, errors.New("remote: attempting to read missing response")
 	}
 	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
 }
 

remote/http_test.go

@@ -87,6 +87,7 @@ func TestPost(t *testing.T) {
 	}
 	c, _ := createTestClient(func(rw http.ResponseWriter, r *http.Request) {
 		assert.Equal(t, http.MethodPost, r.Method)
+
 	})
 	r, err := c.Post(context.Background(), "/test", test)
 	assert.NoError(t, err)

remote/servers.go

@@ -6,8 +6,6 @@ import (
 	"strconv"
 	"sync"
 
-	"github.com/pterodactyl/wings/internal/models"
-
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"golang.org/x/sync/errgroup"
@@ -19,7 +17,7 @@ const (
 	ProcessStopNativeStop = "stop"
 )
 
-// GetServers returns all the servers that are present on the Panel making
+// GetServers returns all of the servers that are present on the Panel making
 // parallel API calls to the endpoint if more than one page of servers is
 // returned.
 func (c *client) GetServers(ctx context.Context, limit int) ([]RawServerData, error) {
@@ -58,7 +56,7 @@ func (c *client) GetServers(ctx context.Context, limit int) ([]RawServerData, er
 //
 // This handles Wings exiting during either of these processes which will leave
 // things in a bad state within the Panel. This API call is executed once Wings
-// has fully booted all the servers.
+// has fully booted all of the servers.
 func (c *client) ResetServersState(ctx context.Context) error {
 	res, err := c.Post(ctx, "/servers/reset", nil)
 	if err != nil {
@@ -92,8 +90,8 @@ func (c *client) GetInstallationScript(ctx context.Context, uuid string) (Instal
 	return config, err
 }
 
-func (c *client) SetInstallationStatus(ctx context.Context, uuid string, data InstallStatusRequest) error {
+func (c *client) SetInstallationStatus(ctx context.Context, uuid string, successful bool) error {
-	resp, err := c.Post(ctx, fmt.Sprintf("/servers/%s/install", uuid), data)
+	resp, err := c.Post(ctx, fmt.Sprintf("/servers/%s/install", uuid), d{"successful": successful})
 	if err != nil {
 		return err
 	}
@@ -115,7 +113,7 @@ func (c *client) SetTransferStatus(ctx context.Context, uuid string, successful
 	if successful {
 		state = "success"
 	}
-	resp, err := c.Post(ctx, fmt.Sprintf("/servers/%s/transfer/%s", uuid, state), nil)
+	resp, err := c.Get(ctx, fmt.Sprintf("/servers/%s/transfer/%s", uuid, state), nil)
 	if err != nil {
 		return err
 	}
@@ -127,7 +125,7 @@ func (c *client) SetTransferStatus(ctx context.Context, uuid string, successful
 // password combination provided is associated with a valid server on the instance
 // using the Panel's authentication control mechanisms. This will get itself
 // throttled if too many requests are made, allowing us to completely offload
-// all the authorization security logic to the Panel.
+// all of the authorization security logic to the Panel.
 func (c *client) ValidateSftpCredentials(ctx context.Context, request SftpAuthRequest) (SftpAuthResponse, error) {
 	var auth SftpAuthResponse
 	res, err := c.Post(ctx, "/sftp/auth", request)
@@ -180,16 +178,6 @@ func (c *client) SendRestorationStatus(ctx context.Context, backup string, succe
 	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
 // pagination query parameters.
 func (c *client) getServersPaged(ctx context.Context, page, limit int) ([]RawServerData, Pagination, error) {

remote/types.go

@@ -1,21 +1,14 @@
 package remote
 
 import (
-	"bytes"
+	"encoding/json"
 	"regexp"
 	"strings"
 
 	"github.com/apex/log"
-	"github.com/goccy/go-json"
-
 	"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
 // endpoints that only expect a singular argument or something that would not
 // benefit from being a typed struct.
@@ -39,7 +32,7 @@ type Pagination struct {
 
 // ServerConfigurationResponse holds the server configuration data returned from
 // 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.
 //
 // This means we do not need to hit Wings each time part of the server is
@@ -68,12 +61,9 @@ type RawServerData struct {
 	ProcessConfiguration json.RawMessage `json:"process_configuration"`
 }
 
-type SftpAuthRequestType string
-
 // SftpAuthRequest defines the request details that are passed along to the Panel
 // when determining if the credentials provided to Wings are valid.
 type SftpAuthRequest struct {
-	Type          SftpAuthRequestType `json:"type"`
 	User          string `json:"username"`
 	Pass          string `json:"password"`
 	IP            string `json:"ip"`
@@ -87,45 +77,44 @@ type SftpAuthRequest struct {
 // user for the SFTP subsystem.
 type SftpAuthResponse struct {
 	Server      string   `json:"server"`
-	User        string   `json:"user"`
+	Token       string   `json:"token"`
 	Permissions []string `json:"permissions"`
 }
 
 type OutputLineMatcher struct {
-	// 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
 }
 
-// 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 {
-		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.
 func (olm *OutputLineMatcher) String() string {
-	return string(olm.raw)
+	return olm.raw
 }
 
 // UnmarshalJSON unmarshals the startup lines into individual structs for easier
 // matching abilities.
 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
 	}
 
-	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 {
-			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
 	}
 
@@ -139,9 +128,9 @@ type ProcessStopConfiguration struct {
 }
 
 // ProcessConfiguration defines the process configuration for a given server
-// instance. This sets what Wings is looking for to mark a server as done
+// instance. This sets what Wings is looking for to mark a server as done starting
-// starting what to do when stopping, and what changes to make to the
+// what to do when stopping, and what changes to make to the configuration file
-// configuration file for a server.
+// for a server.
 type ProcessConfiguration struct {
 	Startup struct {
 		Done            []*OutputLineMatcher `json:"done"`
@@ -157,20 +146,9 @@ type BackupRemoteUploadResponse struct {
 	PartSize int64    `json:"part_size"`
 }
 
-type BackupPart struct {
-	ETag       string `json:"etag"`
-	PartNumber int    `json:"part_number"`
-}
-
 type BackupRequest struct {
 	Checksum     string `json:"checksum"`
 	ChecksumType string `json:"checksum_type"`
 	Size         int64  `json:"size"`
 	Successful   bool   `json:"successful"`
-	Parts        []BackupPart `json:"parts"`
-}
-
-type InstallStatusRequest struct {
-	Successful bool `json:"successful"`
-	Reinstall  bool `json:"reinstall"`
 }

router/downloader/downloader.go

@@ -2,64 +2,26 @@ package downloader
 
 import (
 	"context"
+	"emperror.dev/errors"
+	"encoding/json"
 	"fmt"
+	"github.com/google/uuid"
+	"github.com/pterodactyl/wings/server"
 	"io"
-	"mime"
 	"net"
 	"net/http"
 	"net/url"
 	"path/filepath"
+	"regexp"
+	"strconv"
 	"strings"
 	"sync"
 	"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{
-
-func init() {
-	dialer := &net.Dialer{
-		LocalAddr: nil,
-	}
-
-	trnspt := http.DefaultTransport.(*http.Transport).Clone()
-	trnspt.DialContext = func(ctx context.Context, network, addr string) (net.Conn, error) {
-		c, err := dialer.DialContext(ctx, network, addr)
-		if err != nil {
-			return nil, errors.WithStack(err)
-		}
-
-		ipStr, _, err := net.SplitHostPort(c.RemoteAddr().String())
-		if err != nil {
-			return c, errors.WithStack(err)
-		}
-		ip := net.ParseIP(ipStr)
-		if ip == nil {
-			return c, errors.WithStack(ErrInvalidIPAddress)
-		}
-		if ip.IsLoopback() || ip.IsLinkLocalUnicast() || ip.IsLinkLocalMulticast() || ip.IsInterfaceLocalMulticast() {
-			return c, errors.WithStack(ErrInternalResolution)
-		}
-		for _, block := range internalRanges {
-			if !block.Contains(ip) {
-				continue
-			}
-			return c, errors.WithStack(ErrInternalResolution)
-		}
-		return c, nil
-	}
-
-	client = &http.Client{
 	Timeout: time.Hour * 12,
-
+	// Disallow any redirect on a HTTP call. This is a security requirement: do not modify
-		Transport: trnspt,
-
-		// Disallow any redirect on an 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
 	// instance's local network.
 	//
@@ -71,18 +33,21 @@ func init() {
 	CheckRedirect: func(req *http.Request, via []*http.Request) error {
 		return http.ErrUseLastResponse
 	},
-	}
 }
 
 var instance = &Downloader{
-	// Tracks all the active downloads.
+	// Tracks all of the active downloads.
 	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
 	// legible throughout here.
 	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.
 var internalRanges = []*net.IPNet{
 	mustParseCIDR("127.0.0.1/8"),
@@ -95,11 +60,9 @@ var internalRanges = []*net.IPNet{
 	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 {
 	total   int
@@ -114,15 +77,12 @@ func (c *Counter) Write(p []byte) (int, error) {
 }
 
 type DownloadRequest struct {
-	Directory string
 	URL       *url.URL
-	FileName  string
+	Directory string
-	UseHeader bool
 }
 
 type Download struct {
 	Identifier string
-	path       string
 	mu         sync.RWMutex
 	req        DownloadRequest
 	server     *server.Server
@@ -130,7 +90,7 @@ type Download struct {
 	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.
 func New(s *server.Server, r DownloadRequest) *Download {
 	dl := Download{
@@ -142,14 +102,14 @@ func New(s *server.Server, r DownloadRequest) *Download {
 	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 {
 	instance.mu.Lock()
 	defer instance.mu.Unlock()
 	var downloads []*Download
 	if v, ok := instance.serverCache[sid]; ok {
 		for _, id := range v {
-			if dl, ok := instance.downloadCache[id]; ok {
+			if dl, dlok := instance.downloadCache[id]; dlok {
 				downloads = append(downloads, dl)
 			}
 		}
@@ -157,7 +117,7 @@ func ByServer(sid string) []*Download {
 	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.
 func ByID(dlid string) *Download {
 	return instance.find(dlid)
@@ -174,13 +134,19 @@ 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.
 func (dl *Download) Execute() error {
 	ctx, cancel := context.WithTimeout(context.Background(), time.Hour*12)
 	dl.cancelFunc = &cancel
 	defer dl.Cancel()
 
+	// Always ensure that we're checking the destination for the download to avoid a malicious
+	// user from accessing internal network resources.
+	if err := dl.isExternalNetwork(ctx); err != nil {
+		return err
+	}
+
 	// At this point we have verified the destination is not within the local network, so we can
 	// now make a request to that URL and pull down the file, saving it to the server's data
 	// directory.
@@ -199,44 +165,27 @@ func (dl *Download) Execute() error {
 		return errors.New("downloader: got bad response status from endpoint: " + res.Status)
 	}
 
-	if res.ContentLength < 1 {
+	// If there is a Content-Length header on this request go ahead and check that we can
-		return errors.New("downloader: request is missing ContentLength")
+	// even write the whole file before beginning this process. If there is no header present
-	}
+	// we'll just have to give it a spin and see how it goes.
-
+	if res.ContentLength > 0 {
-	if dl.req.UseHeader {
+		if err := dl.server.Filesystem().HasSpaceFor(res.ContentLength); err != nil {
-		if contentDisposition := res.Header.Get("Content-Disposition"); contentDisposition != "" {
+			return errors.WrapIf(err, "downloader: failed to write file: not enough space")
-			_, 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()
+	fnameparts := strings.Split(dl.req.URL.Path, "/")
+	p := filepath.Join(dl.req.Directory, fnameparts[len(fnameparts)-1])
 	dl.server.Log().WithField("path", p).Debug("writing remote file to disk")
 
-	// Write the file while tracking the progress, Write will check that the
-	// size of the file won't exceed the disk limit.
 	r := io.TeeReader(res.Body, dl.counter(res.ContentLength))
-	if err := dl.server.Filesystem().Write(p, r, res.ContentLength, 0o644); err != nil {
+	if err := dl.server.Filesystem().Writefile(p, r); err != nil {
 		return errors.WrapIf(err, "downloader: failed to write file to server directory")
 	}
 	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.
 func (dl *Download) Cancel() {
 	if dl.cancelFunc != nil {
@@ -245,12 +194,12 @@ func (dl *Download) Cancel() {
 	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 {
-	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.
 func (dl *Download) Progress() float64 {
 	dl.mu.RLock()
@@ -258,10 +207,6 @@ func (dl *Download) Progress() float64 {
 	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
 // events to the server websocket as needed.
 func (dl *Download) counter(contentLength int64) *Counter {
@@ -275,7 +220,52 @@ func (dl *Download) counter(contentLength int64) *Counter {
 	}
 }
 
-// Downloader represents a global downloader that keeps track of all currently processing downloads
+// Verifies that a given download resolves to a location not within the current local
+// network for the machine. If the final destination of a resource is within the local
+// network an ErrInternalResolution error is returned.
+func (dl *Download) isExternalNetwork(ctx context.Context) error {
+	dialer := &net.Dialer{
+		LocalAddr: nil,
+	}
+
+	host := dl.req.URL.Host
+
+	// 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
+	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)
+	}
+
+	if !ipMatchRegex.MatchString(host) {
+		if dl.req.URL.Scheme == "https" {
+			host = host + ":443"
+		} else {
+			host = host + ":80"
+		}
+	}
+
+	c, err := dialer.DialContext(ctx, "tcp", host)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+	_ = c.Close()
+
+	ip := net.ParseIP(ipMatchRegex.ReplaceAllString(c.RemoteAddr().String(), ""))
+	if ip == nil {
+		return errors.WithStack(ErrInvalidIPAddress)
+	}
+	if ip.IsLoopback() || ip.IsLinkLocalUnicast() || ip.IsLinkLocalMulticast() || ip.IsInterfaceLocalMulticast() {
+		return errors.WithStack(ErrInternalResolution)
+	}
+	for _, block := range internalRanges {
+		if block.Contains(ip) {
+			return errors.WithStack(ErrInternalResolution)
+		}
+	}
+	return nil
+}
+
+// Defines a global downloader struct that keeps track of all currently processing downloads
 // for the machine.
 type Downloader struct {
 	mu            sync.RWMutex
@@ -283,11 +273,11 @@ type Downloader struct {
 	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) {
 	d.mu.Lock()
 	defer d.mu.Unlock()
-	sid := dl.server.ID()
+	sid := dl.server.Id()
 	if _, ok := d.downloadCache[dl.Identifier]; !ok {
 		d.downloadCache[dl.Identifier] = dl
 		if _, ok := d.serverCache[sid]; !ok {
@@ -297,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 {
 	d.mu.RLock()
 	defer d.mu.RUnlock()
@@ -307,24 +297,24 @@ func (d *Downloader) find(dlid string) *Download {
 	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.
-func (d *Downloader) remove(dlID string) {
+func (d *Downloader) remove(dlid string) {
 	d.mu.Lock()
 	defer d.mu.Unlock()
-	if _, ok := d.downloadCache[dlID]; !ok {
+	if _, ok := d.downloadCache[dlid]; !ok {
 		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
 		for _, k := range tracked {
-			if k != dlID {
+			if k != dlid {
 				out = append(out, k)
 			}
 		}
-		d.serverCache[sID] = out
+		d.serverCache[sid] = out
 	}
 }
 

router/error.go

@@ -0,0 +1,156 @@
+package router
+
+import (
+	"fmt"
+	"net/http"
+	"os"
+	"strings"
+
+	"emperror.dev/errors"
+	"github.com/apex/log"
+	"github.com/gin-gonic/gin"
+	"github.com/google/uuid"
+	"github.com/pterodactyl/wings/server"
+	"github.com/pterodactyl/wings/server/filesystem"
+)
+
+type RequestError struct {
+	err     error
+	uuid    string
+	message string
+	server  *server.Server
+}
+
+// Attaches an error to the gin.Context object for the request and ensures that it
+// has a proper stacktrace associated with it when doing so.
+//
+// If you just call c.Error(err) without using this function you'll likely end up
+// with an error that has no annotated stack on it.
+func WithError(c *gin.Context, err error) error {
+	return c.Error(errors.WithStackDepthIf(err, 1))
+}
+
+// Generates a new tracked error, which simply tracks the specific error that
+// is being passed in, and also assigned a UUID to the error so that it can be
+// cross referenced in the logs.
+func NewTrackedError(err error) *RequestError {
+	return &RequestError{
+		err:  err,
+		uuid: uuid.Must(uuid.NewRandom()).String(),
+	}
+}
+
+// Same as NewTrackedError, except this will also attach the server instance that
+// generated this server for the purposes of logging.
+func NewServerError(err error, s *server.Server) *RequestError {
+	return &RequestError{
+		err:    err,
+		uuid:   uuid.Must(uuid.NewRandom()).String(),
+		server: s,
+	}
+}
+
+func (e *RequestError) logger() *log.Entry {
+	if e.server != nil {
+		return e.server.Log().WithField("error_id", e.uuid).WithField("error", e.err)
+	}
+	return log.WithField("error_id", e.uuid).WithField("error", e.err)
+}
+
+// Sets the output message to display to the user in the error.
+func (e *RequestError) SetMessage(msg string) *RequestError {
+	e.message = msg
+	return e
+}
+
+// Aborts the request with the given status code, and responds with the error. This
+// will also include the error UUID in the output so that the user can report that
+// and link the response to a specific error in the logs.
+func (e *RequestError) AbortWithStatus(status int, c *gin.Context) {
+	// In instances where the status has already been set just use that existing status
+	// since we cannot change it at this point, and trying to do so will emit a gin warning
+	// into the program output.
+	if c.Writer.Status() != 200 {
+		status = c.Writer.Status()
+	}
+
+	// If this error is because the resource does not exist, we likely do not need to log
+	// the error anywhere, just return a 404 and move on with our lives.
+	if errors.Is(e.err, os.ErrNotExist) {
+		c.AbortWithStatusJSON(http.StatusNotFound, gin.H{
+			"error": "The requested resource was not found on the system.",
+		})
+		return
+	}
+
+	if strings.HasPrefix(e.err.Error(), "invalid URL escape") {
+		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{
+			"error": "Some of the data provided in the request appears to be escaped improperly.",
+		})
+		return
+	}
+
+	// If this is a Filesystem error just return it without all of the tracking code nonsense
+	// since we don't need to be logging it into the logs or anything, its just a normal error
+	// that the user can solve on their end.
+	if st, msg := e.getAsFilesystemError(); st != 0 {
+		c.AbortWithStatusJSON(st, gin.H{"error": msg})
+		return
+	}
+
+	// Otherwise, log the error to zap, and then report the error back to the user.
+	if status >= 500 {
+		e.logger().Error("unexpected error while handling HTTP request")
+	} else {
+		e.logger().Debug("non-server error encountered while handling HTTP request")
+	}
+
+	if e.message == "" {
+		e.message = "An unexpected error was encountered while processing this request."
+	}
+
+	c.AbortWithStatusJSON(status, gin.H{"error": e.message, "error_id": e.uuid})
+}
+
+// Helper function to just abort with an internal server error. This is generally the response
+// from most errors encountered by the API.
+func (e *RequestError) Abort(c *gin.Context) {
+	e.AbortWithStatus(http.StatusInternalServerError, c)
+}
+
+// Looks at the given RequestError and determines if it is a specific filesystem error that
+// we can process and return differently for the user.
+func (e *RequestError) getAsFilesystemError() (int, string) {
+	// Some external things end up calling fmt.Errorf() on our filesystem errors
+	// which ends up just unleashing chaos on the system. For the sake of this
+	// fallback to using text checks...
+	if filesystem.IsErrorCode(e.err, filesystem.ErrCodeDenylistFile) || strings.Contains(e.err.Error(), "filesystem: file access prohibited") {
+		return http.StatusForbidden, "This file cannot be modified: present in egg denylist."
+	}
+	if filesystem.IsErrorCode(e.err, filesystem.ErrCodePathResolution) || strings.Contains(e.err.Error(), "resolves to a location outside the server root") {
+		return http.StatusNotFound, "The requested resource was not found on the system."
+	}
+	if filesystem.IsErrorCode(e.err, filesystem.ErrCodeIsDirectory) || strings.Contains(e.err.Error(), "filesystem: is a directory") {
+		return http.StatusBadRequest, "Cannot perform that action: file is a directory."
+	}
+	if filesystem.IsErrorCode(e.err, filesystem.ErrCodeDiskSpace) || strings.Contains(e.err.Error(), "filesystem: not enough disk space") {
+		return http.StatusBadRequest, "Cannot perform that action: not enough disk space available."
+	}
+	if strings.HasSuffix(e.err.Error(), "file name too long") {
+		return http.StatusBadRequest, "Cannot perform that action: file name is too long."
+	}
+	if e, ok := e.err.(*os.SyscallError); ok && e.Syscall == "readdirent" {
+		return http.StatusNotFound, "The requested directory does not exist."
+	}
+	return 0, ""
+}
+
+// Handle specific filesystem errors for a server.
+func (e *RequestError) AbortFilesystemError(c *gin.Context) {
+	e.Abort(c)
+}
+
+// Format the error to a string and include the UUID.
+func (e *RequestError) Error() string {
+	return fmt.Sprintf("%v (uuid: %s)", e.err, e.uuid)
+}

router/middleware.go

@@ -2,7 +2,6 @@ package router
 
 import (
 	"github.com/gin-gonic/gin"
-
 	"github.com/pterodactyl/wings/router/middleware"
 	"github.com/pterodactyl/wings/server"
 )

router/middleware/middleware.go

@@ -1,21 +1,149 @@
 package middleware
 
 import (
+	"context"
 	"crypto/subtle"
+	"github.com/pterodactyl/wings/metrics"
 	"io"
 	"net/http"
+	"os"
+	"strconv"
 	"strings"
 
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/gin-gonic/gin"
 	"github.com/google/uuid"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/remote"
 	"github.com/pterodactyl/wings/server"
+	"github.com/pterodactyl/wings/server/filesystem"
 )
 
+// RequestError is a custom error type returned when something goes wrong with
+// any of the HTTP endpoints.
+type RequestError struct {
+	err    error
+	status int
+	msg    string
+}
+
+// NewError returns a new RequestError for the provided error.
+func NewError(err error) *RequestError {
+	return &RequestError{
+		// Attach a stacktrace to the error if it is missing at this point and mark it
+		// as originating from the location where NewError was called, rather than this
+		// specific point in the code.
+		err: errors.WithStackDepthIf(err, 1),
+	}
+}
+
+// SetMessage allows for a custom error message to be set on an existing
+// RequestError instance.
+func (re *RequestError) SetMessage(m string) {
+	re.msg = m
+}
+
+// SetStatus sets the HTTP status code for the error response. By default this
+// is a HTTP-500 error.
+func (re *RequestError) SetStatus(s int) {
+	re.status = s
+}
+
+// Abort aborts the given HTTP request with the specified status code and then
+// logs the event into the logs. The error that is output will include the unique
+// request ID if it is present.
+func (re *RequestError) Abort(c *gin.Context, status int) {
+	reqId := c.Writer.Header().Get("X-Request-Id")
+
+	// Generate the base logger instance, attaching the unique request ID and
+	// the URL that was requested.
+	event := log.WithField("request_id", reqId).WithField("url", c.Request.URL.String())
+	// If there is a server present in the gin.Context stack go ahead and pull it
+	// and attach that server UUID to the logs as well so that we can see what specific
+	// server triggered this error.
+	if s, ok := c.Get("server"); ok {
+		if s, ok := s.(*server.Server); ok {
+			event = event.WithField("server_id", s.Id())
+		}
+	}
+
+	if c.Writer.Status() == 200 {
+		// Handle context deadlines being exceeded a little differently since we want
+		// to report a more user-friendly error and a proper error code. The "context
+		// canceled" error is generally when a request is terminated before all of the
+		// logic is finished running.
+		if errors.Is(re.err, context.DeadlineExceeded) {
+			re.SetStatus(http.StatusGatewayTimeout)
+			re.SetMessage("The server could not process this request in time, please try again.")
+		} else if strings.Contains(re.Cause().Error(), "context canceled") {
+			re.SetStatus(http.StatusBadRequest)
+			re.SetMessage("Request aborted by client.")
+		}
+	}
+
+	// c.Writer.Status() will be a non-200 value if the headers have already been sent
+	// to the requester but an error is encountered. This can happen if there is an issue
+	// marshaling a struct placed into a c.JSON() call (or c.AbortWithJSON() call).
+	if status >= 500 || c.Writer.Status() != 200 {
+		event.WithField("status", status).WithField("error", re.err).Error("error while handling HTTP request")
+	} else {
+		event.WithField("status", status).WithField("error", re.err).Debug("error handling HTTP request (not a server error)")
+	}
+	if re.msg == "" {
+		re.msg = "An unexpected error was encountered while processing this request"
+	}
+	// Now abort the request with the error message and include the unique request
+	// ID that was present to make things super easy on people who don't know how
+	// or cannot view the response headers (where X-Request-Id would be present).
+	c.AbortWithStatusJSON(status, gin.H{"error": re.msg, "request_id": reqId})
+}
+
+// Cause returns the underlying error.
+func (re *RequestError) Cause() error {
+	return re.err
+}
+
+// Error returns the underlying error message for this request.
+func (re *RequestError) Error() string {
+	return re.err.Error()
+}
+
+// Looks at the given RequestError and determines if it is a specific filesystem
+// error that we can process and return differently for the user.
+//
+// Some external things end up calling fmt.Errorf() on our filesystem errors
+// which ends up just unleashing chaos on the system. For the sake of this,
+// fallback to using text checks.
+//
+// If the error passed into this call is nil or does not match empty values will
+// be returned to the caller.
+func (re *RequestError) asFilesystemError() (int, string) {
+	err := re.Cause()
+	if err == nil {
+		return 0, ""
+	}
+	if filesystem.IsErrorCode(err, filesystem.ErrCodeDenylistFile) || strings.Contains(err.Error(), "filesystem: file access prohibited") {
+		return http.StatusForbidden, "This file cannot be modified: present in egg denylist."
+	}
+	if filesystem.IsErrorCode(err, filesystem.ErrCodePathResolution) || strings.Contains(err.Error(), "resolves to a location outside the server root") {
+		return http.StatusNotFound, "The requested resource was not found on the system."
+	}
+	if filesystem.IsErrorCode(err, filesystem.ErrCodeIsDirectory) || strings.Contains(err.Error(), "filesystem: is a directory") {
+		return http.StatusBadRequest, "Cannot perform that action: file is a directory."
+	}
+	if filesystem.IsErrorCode(err, filesystem.ErrCodeDiskSpace) || strings.Contains(err.Error(), "filesystem: not enough disk space") {
+		return http.StatusBadRequest, "There is not enough disk space available to perform that action."
+	}
+	if strings.HasSuffix(err.Error(), "file name too long") {
+		return http.StatusBadRequest, "Cannot perform that action: file name is too long."
+	}
+	if e, ok := err.(*os.SyscallError); ok && e.Syscall == "readdirent" {
+		return http.StatusNotFound, "The requested directory does not exist."
+	}
+	return 0, ""
+}
+
 // AttachRequestID attaches a unique ID to the incoming HTTP request so that any
 // errors that are generated or returned to the client will include this reference
 // allowing for an easier time identifying the specific request that failed for
@@ -53,7 +181,7 @@ func AttachApiClient(client remote.Client) gin.HandlerFunc {
 }
 
 // CaptureAndAbort aborts the request and attaches the provided error to the gin
-// context, so it can be reported properly. If the error is missing a stacktrace
+// context so it can be reported properly. If the error is missing a stacktrace
 // at the time it is called the stack will be attached.
 func CaptureAndAbort(c *gin.Context, err error) {
 	c.Abort()
@@ -91,29 +219,19 @@ func CaptureErrors() gin.HandlerFunc {
 // SetAccessControlHeaders sets the access request control headers on all of
 // the requests.
 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) {
-		c.Header("Access-Control-Allow-Origin", location)
 		c.Header("Access-Control-Allow-Credentials", "true")
 		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
 		// 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
 		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
 		// 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
@@ -146,14 +264,14 @@ func ServerExists() gin.HandlerFunc {
 		if c.Param("server") != "" {
 			manager := ExtractManager(c)
 			s = manager.Find(func(s *server.Server) bool {
-				return c.Param("server") == s.ID()
+				return c.Param("server") == s.Id()
 			})
 		}
 		if s == nil {
 			c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"error": "The requested resource does not exist on this instance."})
 			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.Next()
 	}
@@ -236,3 +354,19 @@ func ExtractManager(c *gin.Context) *server.Manager {
 	}
 	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()
+	}
+}

router/middleware/request_error.go

@@ -1,141 +0,0 @@
-package middleware
-
-import (
-	"context"
-	"net/http"
-	"os"
-	"strings"
-
-	"emperror.dev/errors"
-	"github.com/apex/log"
-	"github.com/gin-gonic/gin"
-
-	"github.com/pterodactyl/wings/server"
-	"github.com/pterodactyl/wings/server/filesystem"
-)
-
-// RequestError is a custom error type returned when something goes wrong with
-// any of the HTTP endpoints.
-type RequestError struct {
-	err    error
-	status int
-	msg    string
-}
-
-// NewError returns a new RequestError for the provided error.
-func NewError(err error) *RequestError {
-	return &RequestError{
-		// Attach a stacktrace to the error if it is missing at this point and mark it
-		// as originating from the location where NewError was called, rather than this
-		// specific point in the code.
-		err: errors.WithStackDepthIf(err, 1),
-	}
-}
-
-// SetMessage allows for a custom error message to be set on an existing
-// RequestError instance.
-func (re *RequestError) SetMessage(m string) {
-	re.msg = m
-}
-
-// SetStatus sets the HTTP status code for the error response. By default this
-// is a HTTP-500 error.
-func (re *RequestError) SetStatus(s int) {
-	re.status = s
-}
-
-// Abort aborts the given HTTP request with the specified status code and then
-// logs the event into the logs. The error that is output will include the unique
-// request ID if it is present.
-func (re *RequestError) Abort(c *gin.Context, status int) {
-	reqId := c.Writer.Header().Get("X-Request-Id")
-
-	// Generate the base logger instance, attaching the unique request ID and
-	// the URL that was requested.
-	event := log.WithField("request_id", reqId).WithField("url", c.Request.URL.String())
-	// If there is a server present in the gin.Context stack go ahead and pull it
-	// and attach that server UUID to the logs as well so that we can see what specific
-	// server triggered this error.
-	if s, ok := c.Get("server"); ok {
-		if s, ok := s.(*server.Server); ok {
-			event = event.WithField("server_id", s.ID())
-		}
-	}
-
-	if c.Writer.Status() == 200 {
-		// Handle context deadlines being exceeded a little differently since we want
-		// to report a more user-friendly error and a proper error code. The "context
-		// canceled" error is generally when a request is terminated before all of the
-		// logic is finished running.
-		if errors.Is(re.err, context.DeadlineExceeded) {
-			re.SetStatus(http.StatusGatewayTimeout)
-			re.SetMessage("The server could not process this request in time, please try again.")
-		} else if strings.Contains(re.Cause().Error(), "context canceled") {
-			re.SetStatus(http.StatusBadRequest)
-			re.SetMessage("Request aborted by client.")
-		}
-	}
-
-	// c.Writer.Status() will be a non-200 value if the headers have already been sent
-	// to the requester but an error is encountered. This can happen if there is an issue
-	// marshaling a struct placed into a c.JSON() call (or c.AbortWithJSON() call).
-	if status >= 500 || c.Writer.Status() != 200 {
-		event.WithField("status", status).WithField("error", re.err).Error("error while handling HTTP request")
-	} else {
-		event.WithField("status", status).WithField("error", re.err).Debug("error handling HTTP request (not a server error)")
-	}
-	if re.msg == "" {
-		re.msg = "An unexpected error was encountered while processing this request"
-	}
-	// Now abort the request with the error message and include the unique request
-	// ID that was present to make things super easy on people who don't know how
-	// or cannot view the response headers (where X-Request-Id would be present).
-	c.AbortWithStatusJSON(status, gin.H{"error": re.msg, "request_id": reqId})
-}
-
-// Cause returns the underlying error.
-func (re *RequestError) Cause() error {
-	return re.err
-}
-
-// Error returns the underlying error message for this request.
-func (re *RequestError) Error() string {
-	return re.err.Error()
-}
-
-// Looks at the given RequestError and determines if it is a specific filesystem
-// error that we can process and return differently for the user.
-//
-// Some external things end up calling fmt.Errorf() on our filesystem errors
-// which ends up just unleashing chaos on the system. For the sake of this,
-// fallback to using text checks.
-//
-// If the error passed into this call is nil or does not match empty values will
-// be returned to the caller.
-func (re *RequestError) asFilesystemError() (int, string) {
-	err := re.Cause()
-	if err == nil {
-		return 0, ""
-	}
-	if filesystem.IsErrorCode(err, filesystem.ErrNotExist) ||
-		filesystem.IsErrorCode(err, filesystem.ErrCodePathResolution) ||
-		strings.Contains(err.Error(), "resolves to a location outside the server root") {
-		return http.StatusNotFound, "The requested resources was not found on the system."
-	}
-	if filesystem.IsErrorCode(err, filesystem.ErrCodeDenylistFile) || strings.Contains(err.Error(), "filesystem: file access prohibited") {
-		return http.StatusForbidden, "This file cannot be modified: present in egg denylist."
-	}
-	if filesystem.IsErrorCode(err, filesystem.ErrCodeIsDirectory) || strings.Contains(err.Error(), "filesystem: is a directory") {
-		return http.StatusBadRequest, "Cannot perform that action: file is a directory."
-	}
-	if filesystem.IsErrorCode(err, filesystem.ErrCodeDiskSpace) || strings.Contains(err.Error(), "filesystem: not enough disk space") {
-		return http.StatusBadRequest, "There is not enough disk space available to perform that action."
-	}
-	if strings.HasSuffix(err.Error(), "file name too long") {
-		return http.StatusBadRequest, "Cannot perform that action: file name is too long."
-	}
-	if e, ok := err.(*os.SyscallError); ok && e.Syscall == "readdirent" {
-		return http.StatusNotFound, "The requested directory does not exist."
-	}
-	return 0, ""
-}

router/router.go

@@ -1,26 +1,20 @@
 package router
 
 import (
-	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/gin-gonic/gin"
-
-	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/remote"
 	"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.
-func Configure(m *wserver.Manager, client remote.Client) *gin.Engine {
+func Configure(m *server.Manager, client remote.Client) *gin.Engine {
 	gin.SetMode("release")
 
 	router := gin.New()
 	router.Use(gin.Recovery())
-	if err := router.SetTrustedProxies(config.Get().Api.TrustedProxies); err != nil {
+	router.Use(middleware.Metrics())
-		panic(errors.WithStack(err))
-		return nil
-	}
 	router.Use(middleware.AttachRequestID(), middleware.CaptureErrors(), middleware.SetAccessControlHeaders())
 	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.
@@ -44,7 +38,7 @@ func Configure(m *wserver.Manager, client remote.Client) *gin.Engine {
 	router.GET("/download/file", getDownloadFile)
 	router.POST("/upload/file", postServerUploadFiles)
 
-	// This route is special it sits above all the other requests because we are
+	// This route is special it sits above all of the other requests because we are
 	// using a JWT to authorize access to it, therefore it needs to be publicly
 	// accessible.
 	router.GET("/api/servers/:server/ws", middleware.ServerExists(), getServerWebsocket)
@@ -52,16 +46,16 @@ func Configure(m *wserver.Manager, client remote.Client) *gin.Engine {
 	// This request is called by another daemon when a server is going to be transferred out.
 	// This request does not need the AuthorizationMiddleware as the panel should never call it
 	// and requests are authenticated through a JWT the panel issues to the other daemon.
-	router.POST("/api/transfers", postTransfers)
+	router.GET("/api/servers/:server/archive", middleware.ServerExists(), getServerArchive)
 
-	// All the routes beyond this mount will use an authorization middleware
+	// All of the routes beyond this mount will use an authorization middleware
 	// and will not be accessible without the correct Authorization header provided.
 	protected := router.Use(middleware.RequireAuthorization())
 	protected.POST("/api/update", postUpdateConfiguration)
 	protected.GET("/api/system", getSystemInformation)
 	protected.GET("/api/servers", getAllServers)
 	protected.POST("/api/servers", postCreateServer)
-	protected.DELETE("/api/transfers/:server", deleteTransfer)
+	protected.POST("/api/transfer", postTransfer)
 
 	// These are server specific routes, and require that the request be authorized, and
 	// that the server exist on the Daemon.
@@ -69,6 +63,7 @@ func Configure(m *wserver.Manager, client remote.Client) *gin.Engine {
 	server.Use(middleware.RequireAuthorization(), middleware.ServerExists())
 	{
 		server.GET("", getServer)
+		server.PATCH("", patchServer)
 		server.DELETE("", deleteServer)
 
 		server.GET("/logs", getServerLogs)
@@ -76,13 +71,11 @@ func Configure(m *wserver.Manager, client remote.Client) *gin.Engine {
 		server.POST("/commands", postServerCommands)
 		server.POST("/install", postServerInstall)
 		server.POST("/reinstall", postServerReinstall)
-		server.POST("/sync", postServerSync)
 		server.POST("/ws/deny", postServerDenyWSTokens)
 
 		// This archive request causes the archive to start being created
 		// this should only be triggered by the panel.
-		server.POST("/transfer", postServerTransfer)
+		server.POST("/archive", postServerArchive)
-		server.DELETE("/transfer", deleteServerTransfer)
 
 		files := server.Group("/files")
 		{

router/router_download.go

@@ -8,8 +8,6 @@ import (
 	"strconv"
 
 	"github.com/gin-gonic/gin"
-	"github.com/google/uuid"
-
 	"github.com/pterodactyl/wings/router/middleware"
 	"github.com/pterodactyl/wings/router/tokens"
 	"github.com/pterodactyl/wings/server/backup"
@@ -20,64 +18,9 @@ func getDownloadBackup(c *gin.Context) {
 	client := middleware.ExtractApiClient(c)
 	manager := middleware.ExtractManager(c)
 
-	// Get the payload from the token.
 	token := tokens.BackupPayload{}
 	if err := tokens.ParseToken([]byte(c.Query("token")), &token); err != nil {
-		middleware.CaptureAndAbort(c, err)
+		NewTrackedError(err).Abort(c)
-		return
-	}
-
-	// Get the server using the UUID from the token.
-	if _, ok := manager.Get(token.ServerUuid); !ok || !token.IsUniqueRequest() {
-		c.AbortWithStatusJSON(http.StatusNotFound, gin.H{
-			"error": "The requested resource was not found on this server.",
-		})
-		return
-	}
-
-	// Validate that the BackupUuid field is actually a UUID and not some random characters or a
-	// file path.
-	if _, err := uuid.Parse(token.BackupUuid); err != nil {
-		middleware.CaptureAndAbort(c, err)
-		return
-	}
-
-	// Locate the backup on the local disk.
-	b, st, err := backup.LocateLocal(client, token.BackupUuid)
-	if err != nil {
-		if errors.Is(err, os.ErrNotExist) {
-			c.AbortWithStatusJSON(http.StatusNotFound, gin.H{
-				"error": "The requested backup was not found on this server.",
-			})
-			return
-		}
-
-		middleware.CaptureAndAbort(c, err)
-		return
-	}
-
-	// The use of `os` here is safe as backups are not stored within server
-	// accessible directories.
-	f, err := os.Open(b.Path())
-	if err != nil {
-		middleware.CaptureAndAbort(c, err)
-		return
-	}
-	defer f.Close()
-
-	c.Header("Content-Length", strconv.Itoa(int(st.Size())))
-	c.Header("Content-Disposition", "attachment; filename="+strconv.Quote(st.Name()))
-	c.Header("Content-Type", "application/octet-stream")
-
-	_, _ = bufio.NewReader(f).WriteTo(c.Writer)
-}
-
-// Handles downloading a specific file for a server.
-func getDownloadFile(c *gin.Context) {
-	manager := middleware.ExtractManager(c)
-	token := tokens.FilePayload{}
-	if err := tokens.ParseToken([]byte(c.Query("token")), &token); err != nil {
-		middleware.CaptureAndAbort(c, err)
 		return
 	}
 
@@ -89,22 +32,73 @@ func getDownloadFile(c *gin.Context) {
 		return
 	}
 
-	f, st, err := s.Filesystem().File(token.FilePath)
+	b, st, err := backup.LocateLocal(client, token.BackupUuid)
 	if err != nil {
-		middleware.CaptureAndAbort(c, err)
+		if errors.Is(err, os.ErrNotExist) {
+			c.AbortWithStatusJSON(http.StatusNotFound, gin.H{
+				"error": "The requested backup was not found on this server.",
+			})
+			return
+		}
+
+		NewServerError(err, s).Abort(c)
+		return
+	}
+
+	f, err := os.Open(b.Path())
+	if err != nil {
+		NewServerError(err, s).Abort(c)
 		return
 	}
 	defer f.Close()
-	if st.IsDir() {
+
+	c.Header("Content-Length", strconv.Itoa(int(st.Size())))
+	c.Header("Content-Disposition", "attachment; filename="+strconv.Quote(st.Name()))
+	c.Header("Content-Type", "application/octet-stream")
+
+	bufio.NewReader(f).WriteTo(c.Writer)
+}
+
+// Handles downloading a specific file for a server.
+func getDownloadFile(c *gin.Context) {
+	manager := middleware.ExtractManager(c)
+	token := tokens.FilePayload{}
+	if err := tokens.ParseToken([]byte(c.Query("token")), &token); err != nil {
+		NewTrackedError(err).Abort(c)
+		return
+	}
+
+	s, ok := manager.Get(token.ServerUuid)
+	if !ok || !token.IsUniqueRequest() {
 		c.AbortWithStatusJSON(http.StatusNotFound, gin.H{
 			"error": "The requested resource was not found on this server.",
 		})
 		return
 	}
 
+	p, _ := s.Filesystem().SafePath(token.FilePath)
+	st, err := os.Stat(p)
+	// If there is an error or we're somehow trying to download a directory, just
+	// respond with the appropriate error.
+	if err != nil {
+		NewServerError(err, s).Abort(c)
+		return
+	} else if st.IsDir() {
+		c.AbortWithStatusJSON(http.StatusNotFound, gin.H{
+			"error": "The requested resource was not found on this server.",
+		})
+		return
+	}
+
+	f, err := os.Open(p)
+	if err != nil {
+		NewServerError(err, s).Abort(c)
+		return
+	}
+
 	c.Header("Content-Length", strconv.Itoa(int(st.Size())))
 	c.Header("Content-Disposition", "attachment; filename="+strconv.Quote(st.Name()))
 	c.Header("Content-Type", "application/octet-stream")
 
-	_, _ = bufio.NewReader(f).WriteTo(c.Writer)
+	bufio.NewReader(f).WriteTo(c.Writer)
 }

router/router_server.go

@@ -1,6 +1,7 @@
 package router
 
 import (
+	"bytes"
 	"context"
 	"net/http"
 	"os"
@@ -9,12 +10,10 @@ import (
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/gin-gonic/gin"
-
 	"github.com/pterodactyl/wings/router/downloader"
 	"github.com/pterodactyl/wings/router/middleware"
 	"github.com/pterodactyl/wings/router/tokens"
 	"github.com/pterodactyl/wings/server"
-	"github.com/pterodactyl/wings/server/transfer"
 )
 
 // Returns a single server from the collection of servers.
@@ -35,7 +34,7 @@ func getServerLogs(c *gin.Context) {
 
 	out, err := s.ReadLogfile(l)
 	if err != nil {
-		middleware.CaptureAndAbort(c, err)
+		NewServerError(err, s).Abort(c)
 		return
 	}
 
@@ -55,7 +54,6 @@ func postServerPower(c *gin.Context) {
 
 	var data struct {
 		Action server.PowerAction `json:"action"`
-		WaitSeconds int                `json:"wait_seconds"`
 	}
 
 	if err := c.BindJSON(&data); err != nil {
@@ -86,16 +84,12 @@ func postServerPower(c *gin.Context) {
 	// we can immediately return a response from the server. Some of these actions
 	// can take quite some time, especially stopping or restarting.
 	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) {
-				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 {
-				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")
 			}
 		}
@@ -108,8 +102,8 @@ func postServerPower(c *gin.Context) {
 func postServerCommands(c *gin.Context) {
 	s := ExtractServer(c)
 
-	if running, err := s.Environment.IsRunning(c.Request.Context()); err != nil {
+	if running, err := s.Environment.IsRunning(); err != nil {
-		middleware.CaptureAndAbort(c, err)
+		NewServerError(err, s).Abort(c)
 		return
 	} else if !running {
 		c.AbortWithStatusJSON(http.StatusBadGateway, gin.H{
@@ -135,33 +129,30 @@ func postServerCommands(c *gin.Context) {
 	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)
 
-	if err := s.Sync(); err != nil {
+	buf := bytes.Buffer{}
-		middleware.CaptureAndAbort(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.
 func postServerInstall(c *gin.Context) {
 	s := ExtractServer(c)
 
-	go func(s *server.Server) {
+	go func(serv *server.Server) {
-		s.Log().Info("syncing server state with remote source before executing installation process")
+		if err := serv.Install(true); err != nil {
-		if err := s.Sync(); err != nil {
+			serv.Log().WithField("error", err).Error("failed to execute server installation process")
-			s.Log().WithField("error", err).Error("failed to sync server state with Panel")
-			return
-		}
-
-		if err := s.Install(); err != nil {
-			s.Log().WithField("error", err).Error("failed to execute server installation process")
 		}
 	}(s)
 
@@ -188,7 +179,7 @@ func postServerReinstall(c *gin.Context) {
 	c.Status(http.StatusAccepted)
 }
 
-// Deletes a server from the wings daemon and dissociate its objects.
+// Deletes a server from the wings daemon and dissociate it's objects.
 func deleteServer(c *gin.Context) {
 	s := middleware.ExtractServer(c)
 
@@ -196,20 +187,15 @@ func deleteServer(c *gin.Context) {
 	// to start it while this process is running.
 	s.Config().SetSuspended(true)
 
-	// Notify all websocket clients that the server is being deleted.
+	// Stop all running background tasks for this server that are using the context on
-	// This is useful for two reasons, one to tell clients not to bother
+	// the server struct. This will cancel any running install processes for the server
-	// retrying to connect to the websocket.  And two, for transfers when
+	// as well.
-	// the server has been successfully transferred to another node, and
+	s.CtxCancel()
-	// the client needs to switch to the new node.
+	s.Events().Destroy()
-	if s.IsTransferring() {
+	s.Websockets().CancelAll()
-		s.Events().Publish(server.TransferStatusEvent, transfer.StatusCompleted)
-	}
-	s.Events().Publish(server.DeletedEvent, nil)
-
-	s.CleanupForDestroy()
 
 	// 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()
 	}
 
@@ -217,7 +203,7 @@ func deleteServer(c *gin.Context) {
 	// forcibly terminate it before removing the container, so we do not need to handle
 	// that here.
 	if err := s.Environment.Destroy(); err != nil {
-		middleware.CaptureAndAbort(c, err)
+		WithError(c, err)
 		return
 	}
 
@@ -225,21 +211,21 @@ func deleteServer(c *gin.Context) {
 	// done in a separate process since failure is not the end of the world and can be
 	// manually cleaned up after the fact.
 	//
-	// In addition, servers with large amounts of files can take some time to finish deleting,
+	// In addition, servers with large amounts of files can take some time to finish deleting
 	// so we don't want to block the HTTP call while waiting on this.
-	go func(s *server.Server) {
+	go func(p string) {
-		fs := s.Filesystem()
-		p := fs.Path()
-		_ = fs.UnixFS().Close()
 		if err := os.RemoveAll(p); err != nil {
 			log.WithFields(log.Fields{"path": p, "error": err}).Warn("failed to remove server files during deletion process")
 		}
-	}(s)
+	}(s.Filesystem().Path())
 
 	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.
+	s = nil
+
 	c.Status(http.StatusNoContent)
 }
 

router/router_server_backup.go

@@ -8,7 +8,6 @@ import (
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/gin-gonic/gin"
-
 	"github.com/pterodactyl/wings/router/middleware"
 	"github.com/pterodactyl/wings/server"
 	"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
 	// parsing in the logs.
 	adapter.WithLogContext(map[string]interface{}{
-		"server":     s.ID(),
+		"server":     s.Id(),
 		"request_id": c.GetString("request_id"),
 	})
 

router/router_server_files.go

@@ -16,36 +16,24 @@ import (
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/gin-gonic/gin"
-	"golang.org/x/sync/errgroup"
-
-	"github.com/pterodactyl/wings/config"
-	"github.com/pterodactyl/wings/internal/models"
 	"github.com/pterodactyl/wings/router/downloader"
 	"github.com/pterodactyl/wings/router/middleware"
 	"github.com/pterodactyl/wings/router/tokens"
 	"github.com/pterodactyl/wings/server"
 	"github.com/pterodactyl/wings/server/filesystem"
+	"golang.org/x/sync/errgroup"
 )
 
 // getServerFileContents returns the contents of a file on the server.
 func getServerFileContents(c *gin.Context) {
 	s := middleware.ExtractServer(c)
-	p := strings.TrimLeft(c.Query("file"), "/")
+	p := "/" + strings.TrimLeft(c.Query("file"), "/")
 	f, st, err := s.Filesystem().File(p)
 	if err != nil {
 		middleware.CaptureAndAbort(c, err)
 		return
 	}
 	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("Content-Length", strconv.Itoa(int(st.Size())))
@@ -79,7 +67,7 @@ func getServerListDirectory(c *gin.Context) {
 	s := ExtractServer(c)
 	dir := c.Query("directory")
 	if stats, err := s.Filesystem().ListDirectory(dir); err != nil {
-		middleware.CaptureAndAbort(c, err)
+		WithError(c, err)
 	} else {
 		c.JSON(http.StatusOK, stats)
 	}
@@ -129,11 +117,8 @@ func putServerRenameFiles(c *gin.Context) {
 				}
 				if err := fs.Rename(pf, pt); err != nil {
 					// Return nil if the error is an is not exists.
+					// NOTE: os.IsNotExist() does not work if the error is wrapped.
 					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 err
@@ -151,7 +136,7 @@ func putServerRenameFiles(c *gin.Context) {
 			return
 		}
 
-		middleware.CaptureAndAbort(c, err)
+		NewServerError(err, s).AbortFilesystemError(c)
 		return
 	}
 
@@ -171,11 +156,11 @@ func postServerCopyFile(c *gin.Context) {
 	}
 
 	if err := s.Filesystem().IsIgnored(data.Location); err != nil {
-		middleware.CaptureAndAbort(c, err)
+		NewServerError(err, s).Abort(c)
 		return
 	}
 	if err := s.Filesystem().Copy(data.Location); err != nil {
-		middleware.CaptureAndAbort(c, err)
+		NewServerError(err, s).AbortFilesystemError(c)
 		return
 	}
 
@@ -220,7 +205,7 @@ func postServerDeleteFiles(c *gin.Context) {
 	}
 
 	if err := g.Wait(); err != nil {
-		middleware.CaptureAndAbort(c, err)
+		NewServerError(err, s).Abort(c)
 		return
 	}
 
@@ -235,19 +220,10 @@ func postServerWriteFile(c *gin.Context) {
 	f = "/" + strings.TrimLeft(f, "/")
 
 	if err := s.Filesystem().IsIgnored(f); err != nil {
-		middleware.CaptureAndAbort(c, err)
+		NewServerError(err, s).Abort(c)
 		return
 	}
-
+	if err := s.Filesystem().Writefile(f, c.Request.Body); err != nil {
-	// A content length of -1 means the actual length is unknown.
-	if c.Request.ContentLength == -1 {
-		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{
-			"error": "Missing Content-Length",
-		})
-		return
-	}
-
-	if err := s.Filesystem().Write(f, c.Request.Body, c.Request.ContentLength, 0o644); err != nil {
 		if filesystem.IsErrorCode(err, filesystem.ErrCodeIsDirectory) {
 			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{
 				"error": "Cannot write file, name conflicts with an existing directory by the same name.",
@@ -255,7 +231,7 @@ func postServerWriteFile(c *gin.Context) {
 			return
 		}
 
-		middleware.CaptureAndAbort(c, err)
+		NewServerError(err, s).AbortFilesystemError(c)
 		return
 	}
 
@@ -269,7 +245,7 @@ func postServerWriteFile(c *gin.Context) {
 func getServerPullingFiles(c *gin.Context) {
 	s := ExtractServer(c)
 	c.JSON(http.StatusOK, gin.H{
-		"downloads": downloader.ByServer(s.ID()),
+		"downloads": downloader.ByServer(s.Id()),
 	})
 }
 
@@ -277,23 +253,13 @@ func getServerPullingFiles(c *gin.Context) {
 func postServerPullRemoteFile(c *gin.Context) {
 	s := ExtractServer(c)
 	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"`
-		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 {
 		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)
 	if err != nil {
 		if e, ok := err.(*url.Error); ok {
@@ -302,16 +268,16 @@ func postServerPullRemoteFile(c *gin.Context) {
 			})
 			return
 		}
-		middleware.CaptureAndAbort(c, err)
+		WithError(c, err)
 		return
 	}
 
 	if err := s.Filesystem().HasSpaceErr(true); err != nil {
-		middleware.CaptureAndAbort(c, err)
+		WithError(c, err)
 		return
 	}
 	// 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{
 			"error": "This server has reached its limit of 3 simultaneous remote file downloads at once. Please wait for one to complete before trying again.",
 		})
@@ -319,43 +285,23 @@ func postServerPullRemoteFile(c *gin.Context) {
 	}
 
 	dl := downloader.New(s, downloader.DownloadRequest{
-		Directory: data.RootPath,
 		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")
 		if err := dl.Execute(); err != nil {
 			s.Log().WithField("download_id", dl.Identifier).WithField("error", err).Error("failed to pull remote file")
-			return err
 		} else {
 			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{
 		"identifier": dl.Identifier,
 	})
-		return
-	}
-
-	if err := download(); err != nil {
-		middleware.CaptureAndAbort(c, err)
-		return
-	}
-
-	st, err := s.Filesystem().Stat(dl.Path())
-	if err != nil {
-		middleware.CaptureAndAbort(c, err)
-		return
-	}
-	c.JSON(http.StatusOK, &st)
 }
 
 // Stops a remote file download if it exists and belongs to this server.
@@ -388,7 +334,7 @@ func postServerCreateDirectory(c *gin.Context) {
 			return
 		}
 
-		middleware.CaptureAndAbort(c, err)
+		NewServerError(err, s).Abort(c)
 		return
 	}
 
@@ -423,7 +369,7 @@ func postServerCompressFiles(c *gin.Context) {
 
 	f, err := s.Filesystem().CompressFiles(data.RootPath, data.Files)
 	if err != nil {
-		middleware.CaptureAndAbort(c, err)
+		NewServerError(err, s).AbortFilesystemError(c)
 		return
 	}
 
@@ -448,7 +394,7 @@ func postServerDecompressFiles(c *gin.Context) {
 	s := middleware.ExtractServer(c)
 	lg := middleware.ExtractLogger(c).WithFields(log.Fields{"root_path": data.RootPath, "file": data.File})
 	lg.Debug("checking if space is available for file decompression")
-	err := s.Filesystem().SpaceAvailableForDecompression(context.Background(), data.RootPath, data.File)
+	err := s.Filesystem().SpaceAvailableForDecompression(data.RootPath, data.File)
 	if err != nil {
 		if filesystem.IsErrorCode(err, filesystem.ErrCodeUnknownArchive) {
 			lg.WithField("error", err).Warn("failed to decompress file: unknown archive format")
@@ -460,7 +406,7 @@ func postServerDecompressFiles(c *gin.Context) {
 	}
 
 	lg.Info("starting file decompression")
-	if err := s.Filesystem().DecompressFile(context.Background(), data.RootPath, data.File); err != nil {
+	if err := s.Filesystem().DecompressFile(data.RootPath, data.File); err != nil {
 		// If the file is busy for some reason just return a nicer error to the user since there is not
 		// much we specifically can do. They'll need to stop the running server process in order to overwrite
 		// a file like this.
@@ -541,7 +487,7 @@ func postServerChmodFile(c *gin.Context) {
 			return
 		}
 
-		middleware.CaptureAndAbort(c, err)
+		NewServerError(err, s).AbortFilesystemError(c)
 		return
 	}
 
@@ -553,7 +499,7 @@ func postServerUploadFiles(c *gin.Context) {
 
 	token := tokens.UploadPayload{}
 	if err := tokens.ParseToken([]byte(c.Query("token")), &token); err != nil {
-		middleware.CaptureAndAbort(c, err)
+		NewTrackedError(err).Abort(c)
 		return
 	}
 
@@ -583,30 +529,23 @@ func postServerUploadFiles(c *gin.Context) {
 
 	directory := c.Query("directory")
 
-	maxFileSize := config.Get().Api.UploadLimit
-	maxFileSizeBytes := maxFileSize * 1024 * 1024
 	var totalSize int64
 	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
 	}
 
 	for _, header := range headers {
+		p, err := s.Filesystem().SafePath(filepath.Join(directory, header.Filename))
+		if err != nil {
+			NewServerError(err, s).Abort(c)
+			return
+		}
+
 		// We run this in a different method so I can use defer without any of
 		// the consequences caused by calling it in a loop.
-		if err := handleFileUpload(filepath.Join(directory, header.Filename), s, header); err != nil {
+		if err := handleFileUpload(p, s, header); err != nil {
-			middleware.CaptureAndAbort(c, err)
+			NewServerError(err, s).Abort(c)
 			return
-		} else {
-			s.SaveActivity(s.NewRequestActivity(token.UserUuid, c.ClientIP()), server.ActivityFileUploaded, models.ActivityMeta{
-				"file":      header.Filename,
-				"directory": filepath.Clean(directory),
-			})
 		}
 	}
 }
@@ -621,9 +560,9 @@ func handleFileUpload(p string, s *server.Server, header *multipart.FileHeader)
 	if err := s.Filesystem().IsIgnored(p); err != nil {
 		return err
 	}
-
+	if err := s.Filesystem().Writefile(p, file); err != nil {
-	if err := s.Filesystem().Write(p, file, header.Size, 0o644); err != nil {
 		return err
 	}
+
 	return nil
 }

router/router_server_transfer.go

@@ -1,130 +0,0 @@
-package router
-
-import (
-	"context"
-	"net/http"
-	"strings"
-	"time"
-
-	"emperror.dev/errors"
-	"github.com/gin-gonic/gin"
-
-	"github.com/pterodactyl/wings/environment"
-	"github.com/pterodactyl/wings/router/middleware"
-	"github.com/pterodactyl/wings/server"
-	"github.com/pterodactyl/wings/server/installer"
-	"github.com/pterodactyl/wings/server/transfer"
-)
-
-// Data passed over to initiate a server transfer.
-type serverTransferRequest struct {
-	URL    string                  `binding:"required" json:"url"`
-	Token  string                  `binding:"required" json:"token"`
-	Server installer.ServerDetails `json:"server"`
-}
-
-// postServerTransfer handles the start of a transfer for a server.
-func postServerTransfer(c *gin.Context) {
-	var data serverTransferRequest
-	if err := c.BindJSON(&data); err != nil {
-		return
-	}
-
-	s := ExtractServer(c)
-
-	// Check if the server is already being transferred.
-	// There will be another endpoint for resetting this value either by deleting the
-	// server, or by canceling the transfer.
-	if s.IsTransferring() {
-		c.AbortWithStatusJSON(http.StatusConflict, gin.H{
-			"error": "A transfer is already in progress for this server.",
-		})
-		return
-	}
-
-	manager := middleware.ExtractManager(c)
-
-	notifyPanelOfFailure := func() {
-		if err := manager.Client().SetTransferStatus(context.Background(), s.ID(), false); err != nil {
-			s.Log().WithField("subsystem", "transfer").
-				WithField("status", false).
-				WithError(err).
-				Error("failed to set transfer status")
-		}
-
-		s.Events().Publish(server.TransferStatusEvent, "failure")
-		s.SetTransferring(false)
-	}
-
-	// Block the server from starting while we are transferring it.
-	s.SetTransferring(true)
-
-	// Ensure the server is offline. Sometimes a "No such container" error gets through
-	// which means the server is already stopped. We can ignore that.
-	if s.Environment.State() != environment.ProcessOfflineState {
-		if err := s.Environment.WaitForStop(
-			s.Context(),
-			time.Second*15,
-			false,
-		); err != nil && !strings.Contains(strings.ToLower(err.Error()), "no such container") {
-			s.SetTransferring(false)
-			middleware.CaptureAndAbort(c, errors.Wrap(err, "failed to stop server for transfer"))
-			return
-		}
-	}
-
-	// Create a new transfer instance for this server.
-	trnsfr := transfer.New(context.Background(), s)
-	transfer.Outgoing().Add(trnsfr)
-
-	go func() {
-		defer transfer.Outgoing().Remove(trnsfr)
-
-		if _, err := trnsfr.PushArchiveToTarget(data.URL, data.Token); err != nil {
-			notifyPanelOfFailure()
-
-			if err == context.Canceled {
-				trnsfr.Log().Debug("canceled")
-				trnsfr.SendMessage("Canceled.")
-				return
-			}
-
-			trnsfr.Log().WithError(err).Error("failed to push archive to target")
-			return
-		}
-
-		// DO NOT NOTIFY THE PANEL OF SUCCESS HERE. The only node that should send
-		// a success status is the destination node.  When we send a failure status,
-		// the panel will automatically cancel the transfer and attempt to reset
-		// the server state on the destination node, we just need to make sure
-		// we clean up our statuses for failure.
-
-		trnsfr.Log().Debug("transfer complete")
-	}()
-
-	c.Status(http.StatusAccepted)
-}
-
-// deleteServerTransfer cancels an outgoing transfer for a server.
-func deleteServerTransfer(c *gin.Context) {
-	s := ExtractServer(c)
-
-	if !s.IsTransferring() {
-		c.AbortWithStatusJSON(http.StatusConflict, gin.H{
-			"error": "Server is not currently being transferred.",
-		})
-		return
-	}
-
-	trnsfr := transfer.Outgoing().Get(s.ID())
-	if trnsfr == nil {
-		c.AbortWithStatusJSON(http.StatusConflict, gin.H{
-			"error": "Server is not currently being transferred.",
-		})
-		return
-	}
-
-	trnsfr.Cancel()
-
-	c.Status(http.StatusAccepted)
-}

router/router_server_ws.go

@@ -2,74 +2,70 @@ package router
 
 import (
 	"context"
+	"encoding/json"
 	"time"
 
 	"github.com/gin-gonic/gin"
-	"github.com/goccy/go-json"
 	ws "github.com/gorilla/websocket"
-
 	"github.com/pterodactyl/wings/router/middleware"
 	"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.
 func getServerWebsocket(c *gin.Context) {
 	manager := middleware.ExtractManager(c)
 	s, _ := manager.Get(c.Param("server"))
-
+	handler, err := websocket.GetHandler(s, c.Writer, c.Request)
-	// 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, c)
 	if err != nil {
-		middleware.CaptureAndAbort(c, err)
+		NewServerError(err, s).Abort(c)
 		return
 	}
 	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
 	// if the server is deleted.
 	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 {
 			case <-ctx.Done():
-			break
+				handler.Connection.WriteControl(ws.CloseMessage, ws.FormatCloseMessage(ws.CloseGoingAway, "server deleted"), time.Now().Add(time.Second*5))
-		case <-s.Context().Done():
+				// A break right here without defining the specific loop would only break the select
-			_ = handler.Connection.WriteControl(ws.CloseMessage, ws.FormatCloseMessage(ws.CloseGoingAway, "server deleted"), time.Now().Add(time.Second*5))
+				// and not actually break the for loop, thus causing this routine to stick around forever.
-			break
+				break ListenerLoop
 			}
-	}()
+		}
+	}(ctx, handler.Connection)
+
+	go handler.ListenForServerEvents(ctx)
+	go handler.ListenForExpiration(ctx)
 
 	for {
 		j := websocket.Message{}
 
 		_, p, err := handler.Connection.ReadMessage()
 		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
 		}
@@ -82,8 +78,8 @@ func getServerWebsocket(c *gin.Context) {
 		}
 
 		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)
 	}

router/router_system.go

@@ -1,18 +1,16 @@
 package router
 
 import (
-	"context"
+	"bytes"
-	"errors"
 	"net/http"
 	"strings"
 
 	"github.com/apex/log"
 	"github.com/gin-gonic/gin"
-
 	"github.com/pterodactyl/wings/config"
+	"github.com/pterodactyl/wings/installer"
 	"github.com/pterodactyl/wings/router/middleware"
 	"github.com/pterodactyl/wings/server"
-	"github.com/pterodactyl/wings/server/installer"
 	"github.com/pterodactyl/wings/system"
 )
 
@@ -20,31 +18,15 @@ import (
 func getSystemInformation(c *gin.Context) {
 	i, err := system.GetSystemInformation()
 	if err != nil {
-		middleware.CaptureAndAbort(c, err)
+		NewTrackedError(err).Abort(c)
+
 		return
 	}
 
-	if c.Query("v") == "2" {
 	c.JSON(http.StatusOK, i)
-		return
-	}
-
-	c.JSON(http.StatusOK, struct {
-		Architecture  string `json:"architecture"`
-		CPUCount      int    `json:"cpu_count"`
-		KernelVersion string `json:"kernel_version"`
-		OS            string `json:"os"`
-		Version       string `json:"version"`
-	}{
-		Architecture:  i.System.Architecture,
-		CPUCount:      i.System.CPUThreads,
-		KernelVersion: i.System.KernelVersion,
-		OS:            i.System.OSType,
-		Version:       i.Version,
-	})
 }
 
-// Returns all the servers that are registered and configured correctly on
+// Returns all of the servers that are registered and configured correctly on
 // this wings instance.
 func getAllServers(c *gin.Context) {
 	servers := middleware.ExtractManager(c).All()
@@ -59,13 +41,10 @@ func getAllServers(c *gin.Context) {
 // for it.
 func postCreateServer(c *gin.Context) {
 	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 installer.IsValidationError(err) {
 			c.AbortWithStatusJSON(http.StatusUnprocessableEntity, gin.H{
@@ -86,72 +65,43 @@ func postCreateServer(c *gin.Context) {
 	// cycle. If there are any errors they will be logged and communicated back
 	// to the Panel where a reinstall may take place.
 	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")
 			return
 		}
 
-		if err := i.Server().Install(); 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)
 
 	c.Status(http.StatusAccepted)
 }
 
-type postUpdateConfigurationResponse struct {
-	Applied bool `json:"applied"`
-}
-
 // Updates the running configuration for this Wings instance.
 func postUpdateConfiguration(c *gin.Context) {
 	cfg := config.Get()
-
-	if cfg.IgnorePanelConfigUpdates {
-		c.JSON(http.StatusOK, postUpdateConfigurationResponse{
-			Applied: false,
-		})
-		return
-	}
-
 	if err := c.BindJSON(&cfg); err != nil {
 		return
 	}
-
 	// 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
 	// want to override that.
 	//
 	// 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/") {
-		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
 	// state with it.
 	if err := config.WriteToDisk(cfg); err != nil {
-		middleware.CaptureAndAbort(c, err)
+		WithError(c, err)
 		return
 	}
 	// Since we wrote it to the disk successfully now update the global configuration
 	// state to use this new configuration struct.
 	config.Set(cfg)
-	c.JSON(http.StatusOK, postUpdateConfigurationResponse{
+	c.Status(http.StatusNoContent)
-		Applied: true,
-	})
 }

router/router_transfer.go

@@ -1,33 +1,65 @@
 package router
 
 import (
-	"bytes"
+	"bufio"
 	"context"
 	"crypto/sha256"
 	"encoding/hex"
-	"errors"
+	"encoding/json"
 	"fmt"
 	"io"
-	"mime"
-	"mime/multipart"
 	"net/http"
 	"os"
+	"path/filepath"
+	"strconv"
 	"strings"
+	"sync/atomic"
+	"time"
 
+	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/gin-gonic/gin"
 	"github.com/google/uuid"
-
+	"github.com/juju/ratelimit"
+	"github.com/mholt/archiver/v3"
+	"github.com/mitchellh/colorstring"
+	"github.com/pterodactyl/wings/config"
+	"github.com/pterodactyl/wings/installer"
+	"github.com/pterodactyl/wings/remote"
 	"github.com/pterodactyl/wings/router/middleware"
 	"github.com/pterodactyl/wings/router/tokens"
 	"github.com/pterodactyl/wings/server"
-	"github.com/pterodactyl/wings/server/installer"
+	"github.com/pterodactyl/wings/server/filesystem"
-	"github.com/pterodactyl/wings/server/transfer"
+	"github.com/pterodactyl/wings/system"
 )
 
-// postTransfers .
+// Number of ticks in the progress bar
-func postTransfers(c *gin.Context) {
+const ticks = 25
+
+// 100% / number of ticks = percentage represented by each tick
+const tickPercentage = 100 / ticks
+
+type downloadProgress struct {
+	size     int64
+	progress int64
+}
+
+// Data passed over to initiate a server transfer.
+type serverTransferRequest struct {
+	ServerID string          `binding:"required" json:"server_id"`
+	URL      string          `binding:"required" json:"url"`
+	Token    string          `binding:"required" json:"token"`
+	Server   json.RawMessage `json:"server"`
+}
+
+func getArchivePath(sID string) string {
+	return filepath.Join(config.Get().System.ArchiveDirectory, sID+".tar.gz")
+}
+
+// Returns the archive for a server so that it can be transferred to a new node.
+func getServerArchive(c *gin.Context) {
 	auth := strings.SplitN(c.GetHeader("Authorization"), " ", 2)
+
 	if len(auth) != 2 || auth[0] != "Bearer" {
 		c.Header("WWW-Authenticate", "Bearer")
 		c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{
@@ -38,237 +70,441 @@ func postTransfers(c *gin.Context) {
 
 	token := tokens.TransferPayload{}
 	if err := tokens.ParseToken([]byte(auth[1]), &token); err != nil {
-		middleware.CaptureAndAbort(c, err)
+		NewTrackedError(err).Abort(c)
+		return
+	}
+
+	s := ExtractServer(c)
+	if token.Subject != s.Id() {
+		c.AbortWithStatusJSON(http.StatusForbidden, gin.H{
+			"error": "Missing required token subject, or subject is not valid for the requested server.",
+		})
+		return
+	}
+
+	archivePath := getArchivePath(s.Id())
+
+	// Stat the archive file.
+	st, err := os.Lstat(archivePath)
+	if err != nil {
+		if !errors.Is(err, os.ErrNotExist) {
+			_ = WithError(c, err)
+			return
+		}
+		c.AbortWithStatus(http.StatusNotFound)
+		return
+	}
+
+	// Compute sha1 checksum.
+	h := sha256.New()
+	f, err := os.Open(archivePath)
+	if err != nil {
+		return
+	}
+	if _, err := io.Copy(h, bufio.NewReader(f)); err != nil {
+		_ = f.Close()
+		_ = WithError(c, err)
+		return
+	}
+	if err := f.Close(); err != nil {
+		_ = WithError(c, err)
+		return
+	}
+	checksum := hex.EncodeToString(h.Sum(nil))
+
+	// Stream the file to the client.
+	f, err = os.Open(archivePath)
+	if err != nil {
+		_ = WithError(c, err)
+		return
+	}
+	defer f.Close()
+
+	c.Header("X-Checksum", checksum)
+	c.Header("X-Mime-Type", "application/tar+gzip")
+	c.Header("Content-Length", strconv.Itoa(int(st.Size())))
+	c.Header("Content-Disposition", "attachment; filename="+strconv.Quote(s.Id()+".tar.gz"))
+	c.Header("Content-Type", "application/octet-stream")
+
+	_, _ = bufio.NewReader(f).WriteTo(c.Writer)
+}
+
+func postServerArchive(c *gin.Context) {
+	s := middleware.ExtractServer(c)
+	manager := middleware.ExtractManager(c)
+
+	go func(s *server.Server) {
+		l := log.WithField("server", s.Id())
+
+		// This function automatically adds the Source Node prefix and Timestamp to the log
+		// output before sending it over the websocket.
+		sendTransferLog := func(data string) {
+			output := colorstring.Color(fmt.Sprintf("[yellow][bold]%s [Pterodactyl Transfer System] [Source Node]:[default] %s", time.Now().Format(time.RFC1123), data))
+			s.Events().Publish(server.TransferLogsEvent, output)
+		}
+
+		s.Events().Publish(server.TransferStatusEvent, "starting")
+		sendTransferLog("Attempting to archive server...")
+
+		hasError := true
+		defer func() {
+			if !hasError {
+				return
+			}
+
+			// Mark the server as not being transferred so it can actually be used.
+			s.SetTransferring(false)
+			s.Events().Publish(server.TransferStatusEvent, "failure")
+
+			sendTransferLog("Attempting to notify panel of archive failure..")
+			if err := manager.Client().SetArchiveStatus(s.Context(), s.Id(), false); err != nil {
+				if !remote.IsRequestError(err) {
+					sendTransferLog("Failed to notify panel of archive failure: " + err.Error())
+					l.WithField("error", err).Error("failed to notify panel of failed archive status")
+					return
+				}
+
+				sendTransferLog("Panel returned an error while notifying it of a failed archive: " + err.Error())
+				l.WithField("error", err.Error()).Error("panel returned an error when notifying it of a failed archive status")
+				return
+			}
+
+			sendTransferLog("Successfully notified panel of failed archive status")
+			l.Info("successfully notified panel of failed archive status")
+		}()
+
+		// Mark the server as transferring to prevent problems.
+		s.SetTransferring(true)
+
+		// Ensure the server is offline. Sometimes a "No such container" error gets through
+		// which means the server is already stopped. We can ignore that.
+		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..")
+			l.WithField("error", err).Error("failed to stop server")
+			return
+		}
+
+		// Create an archive of the entire server's data directory.
+		a := &filesystem.Archive{
+			BasePath: s.Filesystem().Path(),
+		}
+
+		// Attempt to get an archive of the server.
+		if err := a.Create(getArchivePath(s.Id())); err != nil {
+			sendTransferLog("An error occurred while archiving the server: " + err.Error())
+			l.WithField("error", err).Error("failed to get transfer archive for server")
+			return
+		}
+
+		sendTransferLog("Successfully created archive, attempting to notify panel..")
+		l.Info("successfully created server transfer archive, notifying panel..")
+
+		if err := manager.Client().SetArchiveStatus(s.Context(), s.Id(), true); err != nil {
+			if !remote.IsRequestError(err) {
+				sendTransferLog("Failed to notify panel of archive success: " + err.Error())
+				l.WithField("error", err).Error("failed to notify panel of successful archive status")
+				return
+			}
+
+			sendTransferLog("Panel returned an error while notifying it of a successful archive: " + err.Error())
+			l.WithField("error", err.Error()).Error("panel returned an error when notifying it of a successful archive status")
+			return
+		}
+
+		hasError = false
+
+		// This log may not be displayed by the client due to the status event being sent before or at the same time.
+		sendTransferLog("Successfully notified panel of successful archive status")
+
+		l.Info("successfully notified panel of successful transfer archive status")
+		s.Events().Publish(server.TransferStatusEvent, "archived")
+	}(s)
+
+	c.Status(http.StatusAccepted)
+}
+
+func (w *downloadProgress) Write(v []byte) (int, error) {
+	n := len(v)
+	atomic.AddInt64(&w.progress, int64(n))
+	return n, nil
+}
+
+// Log helper function to attach all errors and info output to a consistently formatted
+// log string for easier querying.
+func (str serverTransferRequest) log() *log.Entry {
+	return log.WithField("subsystem", "transfers").WithField("server_id", str.ServerID)
+}
+
+// Downloads an archive from the machine that the server currently lives on.
+func (str serverTransferRequest) downloadArchive() (*http.Response, error) {
+	client := http.Client{Timeout: 0}
+	req, err := http.NewRequest(http.MethodGet, str.URL, nil)
+	if err != nil {
+		return nil, err
+	}
+	req.Header.Set("Authorization", str.Token)
+	res, err := client.Do(req) // lgtm [go/request-forgery]
+	if err != nil {
+		return nil, err
+	}
+	return res, nil
+}
+
+// Returns the path to the local archive on the system.
+func (str serverTransferRequest) path() string {
+	return getArchivePath(str.ServerID)
+}
+
+// Creates the archive location on this machine by first checking that the required file
+// does not already exist. If it does exist, the file is deleted and then re-created as
+// an empty file.
+func (str serverTransferRequest) createArchiveFile() (*os.File, error) {
+	p := str.path()
+	if _, err := os.Stat(p); err != nil {
+		if !os.IsNotExist(err) {
+			return nil, err
+		}
+	} else if err := os.Remove(p); err != nil {
+		return nil, err
+	}
+	return os.Create(p)
+}
+
+// Deletes the archive from the local filesystem. This is executed as a deferred function.
+func (str serverTransferRequest) removeArchivePath() {
+	p := str.path()
+	str.log().Debug("deleting temporary transfer archive")
+	if err := os.Remove(p); err != nil && !os.IsNotExist(err) {
+		str.log().WithField("path", p).WithField("error", err).Error("failed to delete temporary transfer archive file")
+		return
+	}
+	str.log().Debug("deleted temporary transfer archive successfully")
+}
+
+// Verifies that the SHA-256 checksum of the file on the local filesystem matches the
+// expected value from the transfer request. The string value returned is the computed
+// checksum on the system.
+func (str serverTransferRequest) verifyChecksum(matches string) (bool, string, error) {
+	f, err := os.Open(str.path())
+	if err != nil {
+		return false, "", err
+	}
+	defer f.Close()
+	h := sha256.New()
+	if _, err := io.Copy(h, bufio.NewReader(f)); err != nil {
+		return false, "", err
+	}
+	checksum := hex.EncodeToString(h.Sum(nil))
+	return checksum == matches, checksum, nil
+}
+
+// Sends a notification to the Panel letting it know what the status of this transfer is.
+func (str serverTransferRequest) sendTransferStatus(client remote.Client, successful bool) error {
+	lg := str.log().WithField("transfer_successful", successful)
+	lg.Info("notifying Panel of server transfer state")
+	if err := client.SetTransferStatus(context.Background(), str.ServerID, successful); err != nil {
+		lg.WithField("error", err).Error("error notifying panel of transfer state")
+		return err
+	}
+	lg.Debug("notified panel of transfer state")
+	return nil
+}
+
+// Initiates a transfer between two nodes for a server by downloading an archive from the
+// remote node and then applying the server details to this machine.
+func postTransfer(c *gin.Context) {
+	var data serverTransferRequest
+	if err := c.BindJSON(&data); err != nil {
 		return
 	}
 
 	manager := middleware.ExtractManager(c)
-	u, err := uuid.Parse(token.Subject)
+	u, err := uuid.Parse(data.ServerID)
 	if err != nil {
-		middleware.CaptureAndAbort(c, err)
+		WithError(c, err)
+		return
+	}
+	// Force the server ID to be a valid UUID string at this point. If it is not an error
+	// is returned to the caller. This limits injection vulnerabilities that would cause
+	// the str.path() function to return a location not within the server archive directory.
+	data.ServerID = u.String()
+
+	data.log().Info("handling incoming server transfer request")
+	go func(data *serverTransferRequest) {
+		hasError := true
+
+		// Create a new server installer. This will only configure the environment and not
+		// run the installer scripts.
+		i, err := installer.New(context.Background(), manager, data.Server)
+		if err != nil {
+			_ = data.sendTransferStatus(manager.Client(), false)
+			data.log().WithField("error", err).Error("failed to validate received server data")
 			return
 		}
 
-	// Get or create a new transfer instance for this server.
+		// This function automatically adds the Target Node prefix and Timestamp to the log output before sending it
-	var (
+		// over the websocket.
-		ctx    context.Context
+		sendTransferLog := func(data string) {
-		cancel context.CancelFunc
+			output := colorstring.Color(fmt.Sprintf("[yellow][bold]%s [Pterodactyl Transfer System] [Target Node]:[default] %s", time.Now().Format(time.RFC1123), data))
-	)
+			i.Server().Events().Publish(server.TransferLogsEvent, output)
-	trnsfr := transfer.Incoming().Get(u.String())
-	if trnsfr == nil {
-		// TODO: should this use the request context?
-		trnsfr = transfer.New(c, nil)
-
-		ctx, cancel = context.WithCancel(trnsfr.Context())
-		defer cancel()
-
-		i, err := installer.New(ctx, manager, installer.ServerDetails{
-			UUID:              u.String(),
-			StartOnCompletion: false,
-		})
-		if err != nil {
-			if err := manager.Client().SetTransferStatus(context.Background(), trnsfr.Server.ID(), false); err != nil {
-				trnsfr.Log().WithField("status", false).WithError(err).Error("failed to set transfer status")
-			}
-			middleware.CaptureAndAbort(c, err)
-			return
 		}
 
+		// Mark the server as transferring to prevent problems later on during the process and
+		// then push the server into the global server collection for this instance.
 		i.Server().SetTransferring(true)
 		manager.Add(i.Server())
-
+		defer func(s *server.Server) {
-		// We add the transfer to the list of transfers once we have a server instance to use.
+			// In the event that this transfer call fails, remove the server from the global
-		trnsfr.Server = i.Server()
+			// server tracking so that we don't have a dangling instance.
-		transfer.Incoming().Add(trnsfr)
+			if err := data.sendTransferStatus(manager.Client(), !hasError); hasError || err != nil {
-	} else {
+				sendTransferLog("Server transfer failed, check Wings logs for additional information.")
-		ctx, cancel = context.WithCancel(trnsfr.Context())
+				s.Events().Publish(server.TransferStatusEvent, "failure")
-		defer cancel()
-	}
-
-	// Any errors past this point (until the transfer is complete) will abort
-	// the transfer.
-
-	successful := false
-	defer func(ctx context.Context, trnsfr *transfer.Transfer) {
-		// Remove the transfer from the list of incoming transfers.
-		transfer.Incoming().Remove(trnsfr)
-
-		if !successful {
-			trnsfr.Server.Events().Publish(server.TransferStatusEvent, "failure")
 				manager.Remove(func(match *server.Server) bool {
-				return match.ID() == trnsfr.Server.ID()
+					return match.Id() == s.Id()
 				})
-		}
 
-		if err := manager.Client().SetTransferStatus(context.Background(), trnsfr.Server.ID(), successful); err != nil {
+				// If the transfer status was successful but the request failed, act like the transfer failed.
-			// Only delete the files if the transfer actually failed, otherwise we could have
+				if !hasError && err != nil {
-			// unrecoverable data-loss.
-			if !successful && err != nil {
 					// Delete all extracted files.
-				go func(trnsfr *transfer.Transfer) {
+					if err := os.RemoveAll(s.Filesystem().Path()); err != nil && !os.IsNotExist(err) {
-					_ = trnsfr.Server.Filesystem().UnixFS().Close()
+						data.log().WithField("error", err).Warn("failed to delete local server files directory")
-					if err := os.RemoveAll(trnsfr.Server.Filesystem().Path()); err != nil && !os.IsNotExist(err) {
-						trnsfr.Log().WithError(err).Warn("failed to delete local server files")
 					}
-				}(trnsfr)
 				}
-
+			} else {
-			trnsfr.Log().WithField("status", successful).WithError(err).Error("failed to set transfer status on panel")
+				s.SetTransferring(false)
-			return
+				s.Events().Publish(server.TransferStatusEvent, "success")
+				sendTransferLog("Transfer completed.")
 			}
+		}(i.Server())
 
-		trnsfr.Server.SetTransferring(false)
+		data.log().Info("downloading server archive from current server node")
-		trnsfr.Server.Events().Publish(server.TransferStatusEvent, "success")
+		sendTransferLog("Received incoming transfer from Panel, attempting to download archive from source node...")
-	}(ctx, trnsfr)
+		res, err := data.downloadArchive()
-
-	mediaType, params, err := mime.ParseMediaType(c.GetHeader("Content-Type"))
 		if err != nil {
-		trnsfr.Log().Debug("failed to parse content type header")
+			sendTransferLog("Failed to retrieve server archive from remote node: " + err.Error())
-		middleware.CaptureAndAbort(c, err)
+			data.log().WithField("error", err).Error("failed to download archive for server transfer")
+			return
+		}
+		defer res.Body.Close()
+		if res.StatusCode != http.StatusOK {
+			data.log().WithField("error", err).WithField("status", res.StatusCode).Error("unexpected error response from transfer endpoint")
 			return
 		}
 
-	if !strings.HasPrefix(mediaType, "multipart/") {
+		size := res.ContentLength
-		trnsfr.Log().Debug("invalid content type")
+		if size == 0 {
-		middleware.CaptureAndAbort(c, fmt.Errorf("invalid content type \"%s\", expected \"multipart/form-data\"", mediaType))
+			data.log().WithField("error", err).Error("received an archive response with Content-Length of 0")
 			return
 		}
-
+		sendTransferLog("Got server archive response from remote node. (Content-Length: " + strconv.Itoa(int(size)) + ")")
-	// Used to calculate the hash of the file as it is being uploaded.
+		sendTransferLog("Creating local archive file...")
-	h := sha256.New()
+		file, err := data.createArchiveFile()
-
-	// Used to read the file and checksum from the request body.
-	mr := multipart.NewReader(c.Request.Body, params["boundary"])
-
-	// Loop through the parts of the request body and process them.
-	var (
-		hasArchive       bool
-		hasChecksum      bool
-		checksumVerified bool
-	)
-out:
-	for {
-		select {
-		case <-ctx.Done():
-			break out
-		default:
-			p, err := mr.NextPart()
-			if err == io.EOF {
-				break out
-			}
 		if err != nil {
-				middleware.CaptureAndAbort(c, err)
+			data.log().WithField("error", err).Error("failed to create archive file on local filesystem")
 			return
 		}
 
-			name := p.FormName()
+		sendTransferLog("Writing archive to disk...")
-			switch name {
+		data.log().Info("writing transfer archive to disk...")
-			case "archive":
-				trnsfr.Log().Debug("received archive")
 
-				if err := trnsfr.Server.EnsureDataDirectoryExists(); err != nil {
+		// Copy the file.
-					middleware.CaptureAndAbort(c, err)
+		progress := &downloadProgress{size: size}
+		ticker := time.NewTicker(3 * time.Second)
+		go func(progress *downloadProgress, t *time.Ticker) {
+			for range ticker.C {
+				// p = 100 (Downloaded)
+				// size = 1000 (Content-Length)
+				// p / size = 0.1
+				// * 100 = 10% (Multiply by 100 to get a percentage of the download)
+				// 10% / tickPercentage = (10% / (100 / 25)) (Divide by tick percentage to get the number of ticks)
+				// 2.5 (Number of ticks as a float64)
+				// 2 (convert to an integer)
+				p := atomic.LoadInt64(&progress.progress)
+				// We have to cast these numbers to float in order to get a float result from the division.
+				width := ((float64(p) / float64(size)) * 100) / tickPercentage
+				bar := strings.Repeat("=", int(width)) + strings.Repeat(" ", ticks-int(width))
+				sendTransferLog("Downloading [" + bar + "] " + system.FormatBytes(p) + " / " + system.FormatBytes(progress.size))
+			}
+		}(progress, ticker)
+
+		var reader io.Reader
+		downloadLimit := float64(config.Get().System.Transfers.DownloadLimit) * 1024 * 1024
+		if downloadLimit > 0 {
+			// Wrap the body with a reader that is limited to the defined download limit speed.
+			reader = ratelimit.Reader(res.Body, ratelimit.NewBucketWithRate(downloadLimit, int64(downloadLimit)))
+		} else {
+			reader = res.Body
+		}
+
+		buf := make([]byte, 1024*4)
+		if _, err := io.CopyBuffer(file, io.TeeReader(reader, progress), buf); err != nil {
+			ticker.Stop()
+			_ = file.Close()
+
+			sendTransferLog("Failed while writing archive file to disk: " + err.Error())
+			data.log().WithField("error", err).Error("failed to copy archive file to disk")
+			return
+		}
+		ticker.Stop()
+
+		// Show 100% completion.
+		humanSize := system.FormatBytes(progress.size)
+		sendTransferLog("Downloading [" + strings.Repeat("=", ticks) + "] " + humanSize + " / " + humanSize)
+
+		if err := file.Close(); err != nil {
+			data.log().WithField("error", err).Error("unable to close archive file on local filesystem")
+			return
+		}
+		data.log().Info("finished writing transfer archive to disk")
+		sendTransferLog("Successfully wrote archive to disk.")
+
+		// Whenever the transfer fails or succeeds, delete the temporary transfer archive that
+		// was created on the disk.
+		defer data.removeArchivePath()
+
+		sendTransferLog("Verifying checksum of downloaded archive...")
+		data.log().Info("computing checksum of downloaded archive file")
+		expected := res.Header.Get("X-Checksum")
+		if matches, computed, err := data.verifyChecksum(expected); err != nil {
+			data.log().WithField("error", err).Error("encountered an error while calculating local filesystem archive checksum")
+			return
+		} else if !matches {
+			sendTransferLog("@@@@@ CHECKSUM VERIFICATION FAILED @@@@@")
+			sendTransferLog("  -   Source Checksum: " + expected)
+			sendTransferLog("  - Computed Checksum: " + computed)
+			data.log().WithField("expected_sum", expected).WithField("computed_checksum", computed).Error("checksum mismatch when verifying integrity of local archive")
 			return
 		}
 
-				tee := io.TeeReader(p, h)
+		// Create the server's environment.
-				if err := trnsfr.Server.Filesystem().ExtractStreamUnsafe(ctx, "/", tee); err != nil {
+		sendTransferLog("Creating server environment, this could take a while..")
-					middleware.CaptureAndAbort(c, err)
+		data.log().Info("creating server environment")
+		if err := i.Server().CreateEnvironment(); err != nil {
+			data.log().WithField("error", err).Error("failed to create server environment")
 			return
 		}
 
-				hasArchive = true
+		sendTransferLog("Server environment has been created, extracting transfer archive..")
-			case "checksum":
+		data.log().Info("server environment configured, extracting transfer archive")
-				trnsfr.Log().Debug("received checksum")
+		if err := archiver.NewTarGz().Unarchive(data.path(), i.Server().Filesystem().Path()); err != nil {
-
+			// Un-archiving failed, delete the server's data directory.
-				if !hasArchive {
+			if err := os.RemoveAll(i.Server().Filesystem().Path()); err != nil && !os.IsNotExist(err) {
-					middleware.CaptureAndAbort(c, errors.New("archive must be sent before the checksum"))
+				data.log().WithField("error", err).Warn("failed to delete local server files directory")
+			}
+			data.log().WithField("error", err).Error("failed to extract server archive")
 			return
 		}
 
-				hasChecksum = true
+		// We mark the process as being successful here as if we fail to send a transfer success,
+		// then a transfer failure won't probably be successful either.
+		//
+		// It may be useful to retry sending the transfer success every so often just in case of a small
+		// hiccup or the fix of whatever error causing the success request to fail.
+		hasError = false
 
-				v, err := io.ReadAll(p)
+		data.log().Info("archive extracted successfully, notifying Panel of status")
-				if err != nil {
+		sendTransferLog("Archive extracted successfully.")
-					middleware.CaptureAndAbort(c, err)
+	}(&data)
-					return
-				}
-
-				expected := make([]byte, hex.DecodedLen(len(v)))
-				n, err := hex.Decode(expected, v)
-				if err != nil {
-					middleware.CaptureAndAbort(c, err)
-					return
-				}
-				actual := h.Sum(nil)
-
-				trnsfr.Log().WithFields(log.Fields{
-					"expected": hex.EncodeToString(expected),
-					"actual":   hex.EncodeToString(actual),
-				}).Debug("checksums")
-
-				if !bytes.Equal(expected[:n], actual) {
-					middleware.CaptureAndAbort(c, errors.New("checksums don't match"))
-					return
-				}
-
-				trnsfr.Log().Debug("checksums match")
-				checksumVerified = true
-			default:
-				continue
-			}
-		}
-	}
-
-	if !hasArchive || !hasChecksum {
-		middleware.CaptureAndAbort(c, errors.New("missing archive or checksum"))
-		return
-	}
-
-	if !checksumVerified {
-		middleware.CaptureAndAbort(c, errors.New("checksums don't match"))
-		return
-	}
-
-	// Transfer is almost complete, we just want to ensure the environment is
-	// configured correctly.  We might want to not fail the transfer at this
-	// stage, but we will just to be safe.
-
-	// Ensure the server environment gets configured.
-	if err := trnsfr.Server.CreateEnvironment(); err != nil {
-		middleware.CaptureAndAbort(c, err)
-		return
-	}
-
-	// Changing this causes us to notify the panel about a successful transfer,
-	// rather than failing the transfer like we do by default.
-	successful = true
-
-	// The rest of the logic for ensuring the server is unlocked and everything
-	// is handled in the deferred function above.
-	trnsfr.Log().Debug("done!")
-}
-
-// deleteTransfer cancels an incoming transfer for a server.
-func deleteTransfer(c *gin.Context) {
-	s := ExtractServer(c)
-
-	if !s.IsTransferring() {
-		c.AbortWithStatusJSON(http.StatusConflict, gin.H{
-			"error": "Server is not currently being transferred.",
-		})
-		return
-	}
-
-	trnsfr := transfer.Incoming().Get(s.ID())
-	if trnsfr == nil {
-		c.AbortWithStatusJSON(http.StatusConflict, gin.H{
-			"error": "Server is not currently being transferred.",
-		})
-		return
-	}
-
-	trnsfr.Cancel()
 
 	c.Status(http.StatusAccepted)
 }

router/tokens/parser.go

@@ -1,11 +1,9 @@
 package tokens
 
 import (
-	"time"
-
 	"github.com/gbrlsnchs/jwt/v3"
-
 	"github.com/pterodactyl/wings/config"
+	"time"
 )
 
 type TokenData interface {

router/tokens/token_store.go

@@ -1,10 +1,9 @@
 package tokens
 
 import (
+	"github.com/patrickmn/go-cache"
 	"sync"
 	"time"
-
-	"github.com/patrickmn/go-cache"
 )
 
 type TokenStore struct {

router/tokens/upload.go

@@ -8,7 +8,6 @@ type UploadPayload struct {
 	jwt.Payload
 
 	ServerUuid string `json:"server_uuid"`
-	UserUuid   string `json:"user_uuid"`
 	UniqueId   string `json:"unique_id"`
 }
 

router/tokens/websocket.go

@@ -1,12 +1,12 @@
 package tokens
 
 import (
+	"encoding/json"
+	"github.com/apex/log"
+	"github.com/gbrlsnchs/jwt/v3"
 	"strings"
 	"sync"
 	"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
@@ -34,13 +34,13 @@ func DenyJTI(jti string) {
 	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 {
 	jwt.Payload
 	sync.RWMutex
 
-	UserUUID    string   `json:"user_uuid"`
+	UserID      json.Number `json:"user_id"`
 	ServerUUID  string      `json:"server_uuid"`
 	Permissions []string    `json:"permissions"`
 }

router/websocket/listeners.go

@@ -2,51 +2,21 @@ package websocket
 
 import (
 	"context"
-	"sync"
-	"time"
-
-	"emperror.dev/errors"
-	"github.com/goccy/go-json"
-
 	"github.com/pterodactyl/wings/events"
-	"github.com/pterodactyl/wings/system"
-
 	"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
 	// JWT stored in the session to send events to the socket when it is expiring.
 	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()
 
 	for {
@@ -57,9 +27,9 @@ func (h *Handler) listenForExpiration(ctx context.Context) {
 			jwt := h.GetJwt()
 			if jwt != nil {
 				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 {
-					_ = h.SendJson(Message{Event: TokenExpiringEvent})
+					_ = h.SendJson(&Message{Event: TokenExpiringEvent})
 				}
 			}
 		}
@@ -80,91 +50,29 @@ var e = []string{
 	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 {
 		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
 }

router/websocket/websocket.go

@@ -2,29 +2,22 @@ package websocket
 
 import (
 	"context"
-	"fmt"
-	"net/http"
-	"strings"
-	"sync"
-	"time"
-
-	"github.com/pterodactyl/wings/internal/models"
-
 	"emperror.dev/errors"
+	"encoding/json"
+	"fmt"
 	"github.com/apex/log"
 	"github.com/gbrlsnchs/jwt/v3"
-	"github.com/gin-gonic/gin"
-	"github.com/goccy/go-json"
 	"github.com/google/uuid"
 	"github.com/gorilla/websocket"
-
-	"github.com/pterodactyl/wings/system"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/environment"
 	"github.com/pterodactyl/wings/environment/docker"
 	"github.com/pterodactyl/wings/router/tokens"
 	"github.com/pterodactyl/wings/server"
+	"net/http"
+	"strings"
+	"sync"
+	"time"
 )
 
 const (
@@ -44,7 +37,6 @@ type Handler struct {
 	Connection   *websocket.Conn `json:"-"`
 	jwt          *tokens.WebsocketPayload
 	server       *server.Server
-	ra           server.RequestActivity
 	uuid         uuid.UUID
 }
 
@@ -63,10 +55,11 @@ func IsJwtError(err error) bool {
 		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) {
-	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
 	}
 
@@ -81,8 +74,8 @@ func NewTokenPayload(token []byte) (*tokens.WebsocketPayload, error) {
 	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, c *gin.Context) (*Handler, error) {
+func GetHandler(s *server.Server, w http.ResponseWriter, r *http.Request) (*Handler, error) {
 	upgrader := websocket.Upgrader{
 		// Ensure that the websocket request is originating from the Panel itself,
 		// and not some other location.
@@ -114,7 +107,6 @@ func GetHandler(s *server.Server, w http.ResponseWriter, r *http.Request, c *gin
 		Connection: conn,
 		jwt:        nil,
 		server:     s,
-		ra:         s.NewRequestActivity("", c.ClientIP()),
 		uuid:       u,
 	}, nil
 }
@@ -123,23 +115,18 @@ func (h *Handler) Uuid() uuid.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!
 	if err := h.TokenValid(); err != nil {
-		_ = h.unsafeSendJson(Message{
+		h.unsafeSendJson(Message{
 			Event: JwtErrorEvent,
 			Args:  []string{err.Error()},
 		})
 		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
 		// permissions to see the output, don't send it down the line.
 		if v.Event == server.InstallOutputEvent {
@@ -193,7 +180,7 @@ func (h *Handler) unsafeSendJson(v interface{}) error {
 	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 {
 	j := h.GetJwt()
 	if j == nil {
@@ -212,14 +199,14 @@ func (h *Handler) TokenValid() error {
 		return ErrJwtNoConnectPerm
 	}
 
-	if h.server.ID() != j.GetServerUuid() {
+	if h.server.Id() != j.GetServerUuid() {
 		return ErrJwtUuidMismatch
 	}
 
 	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
 // error message, otherwise we just send back a standard error message.
 func (h *Handler) SendErrorJson(msg Message, err error, shouldLog ...bool) error {
@@ -249,7 +236,7 @@ func (h *Handler) SendErrorJson(msg Message, err error, shouldLog ...bool) error
 	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.
 func (h *Handler) GetErrorMessage(msg string) (string, uuid.UUID) {
 	u := uuid.Must(uuid.NewRandom())
@@ -259,7 +246,13 @@ func (h *Handler) GetErrorMessage(msg string) (string, uuid.UUID) {
 	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 {
 	h.RLock()
 	defer h.RUnlock()
@@ -267,16 +260,8 @@ func (h *Handler) GetJwt() *tokens.WebsocketPayload {
 	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 err := h.TokenValid(); err != nil {
 			h.unsafeSendJson(Message{
@@ -292,6 +277,13 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
 		{
 			token, err := NewTokenPayload([]byte(strings.Join(m.Args, "")))
 			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
 			}
 
@@ -304,7 +296,10 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
 			h.setJwt(token)
 
 			// 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
 			// instead of authenticating for the first time.
@@ -314,15 +309,10 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
 				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
 			// to the client. :)
 			state := h.server.Environment.State()
-			_ = h.SendJson(Message{
+			h.SendJson(&Message{
 				Event: server.StatusEvent,
 				Args:  []string{state},
 			})
@@ -334,7 +324,7 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
 					_ = h.server.Filesystem().HasSpaceAvailable(false)
 
 					b, _ := json.Marshal(h.server.Proc())
-					_ = h.SendJson(Message{
+					h.SendJson(&Message{
 						Event: server.StatsEvent,
 						Args:  []string{string(b)},
 					})
@@ -361,10 +351,10 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
 			}
 
 			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")
 
-				_ = h.SendJson(Message{
+				h.SendJson(&Message{
 					Event: ErrorEvent,
 					Args:  []string{m},
 				})
@@ -372,17 +362,11 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
 				return nil
 			}
 
-			if err == nil {
-				h.server.SaveActivity(h.ra, models.Event(server.ActivityPowerPrefix+action), nil)
-			}
-
 			return err
 		}
 	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
 			}
 
@@ -392,7 +376,7 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
 			}
 
 			for _, line := range logs {
-				_ = h.SendJson(Message{
+				h.SendJson(&Message{
 					Event: server.ConsoleOutputEvent,
 					Args:  []string{line},
 				})
@@ -403,7 +387,7 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
 	case SendStatsEvent:
 		{
 			b, _ := json.Marshal(h.server.Proc())
-			_ = h.SendJson(Message{
+			h.SendJson(&Message{
 				Event: server.StatsEvent,
 				Args:  []string{string(b)},
 			})
@@ -432,13 +416,7 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
 				}
 			}
 
-			if err := h.server.Environment.SendCommand(strings.Join(m.Args, "")); err != nil {
+			return h.server.Environment.SendCommand(strings.Join(m.Args, ""))
-				return err
-			}
-			h.server.SaveActivity(h.ra, server.ActivityConsoleCommand, models.ActivityMeta{
-				"command": strings.Join(m.Args, ""),
-			})
-			return nil
 		}
 	}
 

server/activity.go

@@ -1,66 +0,0 @@
-package server
-
-import (
-	"context"
-	"time"
-
-	"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")
-	ActivityFileUploaded        = models.Event("server:file.uploaded")
-)
-
-// 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)
-}
-
-// 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}
-}
-
-// SaveActivity saves an activity entry to the database in a background routine. If an error is
-// encountered it is logged but not returned to the caller.
-func (s *Server) SaveActivity(a RequestActivity, event models.Event, metadata models.ActivityMeta) {
-	ctx, cancel := context.WithTimeout(s.Context(), time.Second*3)
-	go func() {
-		defer cancel()
-		if tx := database.Instance().WithContext(ctx).Create(a.Event(event, metadata)); tx.Error != nil {
-			s.Log().WithField("error", errors.WithStack(tx.Error)).
-				WithField("event", event).
-				Error("activity: failed to save event")
-		}
-	}()
-}

server/backup.go

@@ -2,14 +2,12 @@ package server
 
 import (
 	"io"
-	"io/fs"
+	"io/ioutil"
 	"os"
-	"time"
 
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/docker/docker/client"
-
 	"github.com/pterodactyl/wings/environment"
 	"github.com/pterodactyl/wings/remote"
 	"github.com/pterodactyl/wings/server/backup"
@@ -24,6 +22,7 @@ func (s *Server) notifyPanelOfBackup(uuid string, ad *backup.ArchiveDetails, suc
 				"backup": uuid,
 				"error":  err,
 			}).Error("failed to notify panel of backup status due to wings error")
+
 			return err
 		}
 
@@ -47,7 +46,7 @@ func (s *Server) getServerwideIgnoredFiles() (string, error) {
 		// Don't read a symlinked ignore file, or a file larger than 32KiB in size.
 		return "", nil
 	}
-	b, err := io.ReadAll(f)
+	b, err := ioutil.ReadAll(f)
 	if err != nil {
 		return "", err
 	}
@@ -61,13 +60,13 @@ func (s *Server) Backup(b backup.BackupInterface) error {
 	ignored := b.Ignored()
 	if b.Ignored() == "" {
 		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 {
 			ignored = i
 		}
 	}
 
-	ad, err := b.Generate(s.Context(), s.Filesystem(), ignored)
+	ad, err := b.Generate(s.Context(), s.Filesystem().Path(), ignored)
 	if err != nil {
 		if err := s.notifyPanelOfBackup(b.Identifier(), &backup.ArchiveDetails{}, false); err != nil {
 			s.Log().WithFields(log.Fields{
@@ -78,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.Events().Publish(BackupCompletedEvent+":"+b.Identifier(), map[string]interface{}{
+		_ = s.Events().PublishJson(BackupCompletedEvent+":"+b.Identifier(), map[string]interface{}{
 			"uuid":          b.Identifier(),
 			"is_successful": false,
 			"checksum":      "",
@@ -102,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
 	// 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(),
 		"is_successful": true,
 		"checksum":      ad.Checksum,
@@ -126,7 +125,7 @@ func (s *Server) RestoreBackup(b backup.BackupInterface, reader io.ReadCloser) (
 	defer func() {
 		s.Config().SetSuspended(false)
 		if reader != nil {
-			_ = reader.Close()
+			reader.Close()
 		}
 	}()
 	// Send an API call to the Panel as soon as this function is done running so that
@@ -141,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
 	// server being suspended.
 	if s.Environment.State() != environment.ProcessOfflineState {
-		if err = s.Environment.WaitForStop(s.Context(), 2*time.Minute, false); err != nil {
+		if err = s.Environment.WaitForStop(120, false); err != nil {
 			if !client.IsErrNotFound(err) {
 				return errors.WrapIf(err, "server/backup: restore: failed to wait for container stop")
 			}
@@ -151,17 +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
 	// in the file one at a time and writing them to the disk.
 	s.Log().Debug("starting file writing process for backup restoration")
-	err = b.Restore(s.Context(), reader, func(file string, info fs.FileInfo, r io.ReadCloser) error {
+	err = b.Restore(s.Context(), reader, func(file string, r io.Reader) error {
-		defer r.Close()
 		s.Events().Publish(DaemonMessageEvent, "(restoring): "+file)
-		// TODO: since this will be called a lot, it may be worth adding an optimized
+		return s.Filesystem().Writefile(file, r)
-		// Write with Chtimes method to the UnixFS that is able to re-use the
-		// same dirfd and file name.
-		if err := s.Filesystem().Write(file, r, info.Size(), info.Mode()); err != nil {
-			return err
-		}
-		atime := info.ModTime()
-		return s.Filesystem().Chtimes(file, atime, atime)
 	})
 
 	return errors.WithStackIf(err)

server/backup/backup.go

@@ -5,25 +5,16 @@ import (
 	"crypto/sha1"
 	"encoding/hex"
 	"io"
-	"io/fs"
 	"os"
 	"path"
 
 	"emperror.dev/errors"
 	"github.com/apex/log"
-	"github.com/mholt/archiver/v4"
-	"golang.org/x/sync/errgroup"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/remote"
-	"github.com/pterodactyl/wings/server/filesystem"
+	"golang.org/x/sync/errgroup"
 )
 
-var format = archiver.CompressedArchive{
-	Compression: archiver.Gz{},
-	Archival:    archiver.Tar{},
-}
-
 type AdapterType string
 
 const (
@@ -33,12 +24,12 @@ const (
 
 // RestoreCallback is a generic restoration callback that exists for both local
 // and remote backups allowing the files to be restored.
-type RestoreCallback func(file string, info fs.FileInfo, r io.ReadCloser) error
+type RestoreCallback func(file string, r io.Reader) error
 
 // noinspection GoNameStartsWithPackageName
 type BackupInterface interface {
 	// SetClient sets the API request client on the backup interface.
-	SetClient(remote.Client)
+	SetClient(c remote.Client)
 	// Identifier returns the UUID of this backup as tracked by the panel
 	// instance.
 	Identifier() string
@@ -47,7 +38,7 @@ type BackupInterface interface {
 	WithLogContext(map[string]interface{})
 	// Generate creates a backup in whatever the configured source for the
 	// specific implementation is.
-	Generate(context.Context, *filesystem.Filesystem, string) (*ArchiveDetails, error)
+	Generate(ctx context.Context, basePath string, ignore string) (*ArchiveDetails, error)
 	// Ignored returns the ignored files for this backup instance.
 	Ignored() string
 	// Checksum returns a SHA1 checksum for the generated backup.
@@ -59,13 +50,13 @@ type BackupInterface interface {
 	// to store it until it is moved to the final spot.
 	Path() string
 	// Details returns details about the archive.
-	Details(context.Context, []remote.BackupPart) (*ArchiveDetails, error)
+	Details(ctx context.Context) (*ArchiveDetails, error)
 	// Remove removes a backup file.
 	Remove() error
 	// Restore is called when a backup is ready to be restored to the disk from
 	// the given source. Not every backup implementation will support this nor
 	// will every implementation require a reader be provided.
-	Restore(context.Context, io.Reader, RestoreCallback) error
+	Restore(ctx context.Context, reader io.Reader, callback RestoreCallback) error
 }
 
 type Backup struct {
@@ -125,8 +116,8 @@ func (b *Backup) Checksum() ([]byte, error) {
 
 // Details returns both the checksum and size of the archive currently stored on
 // the disk to the caller.
-func (b *Backup) Details(ctx context.Context, parts []remote.BackupPart) (*ArchiveDetails, error) {
+func (b *Backup) Details(ctx context.Context) (*ArchiveDetails, error) {
-	ad := ArchiveDetails{ChecksumType: "sha1", Parts: parts}
+	ad := ArchiveDetails{ChecksumType: "sha1"}
 	g, ctx := errgroup.WithContext(ctx)
 
 	g.Go(func() error {
@@ -171,7 +162,6 @@ type ArchiveDetails struct {
 	Checksum     string `json:"checksum"`
 	ChecksumType string `json:"checksum_type"`
 	Size         int64  `json:"size"`
-	Parts        []remote.BackupPart `json:"parts"`
 }
 
 // ToRequest returns a request object.
@@ -181,6 +171,5 @@ func (ad *ArchiveDetails) ToRequest(successful bool) remote.BackupRequest {
 		ChecksumType: ad.ChecksumType,
 		Size:         ad.Size,
 		Successful:   successful,
-		Parts:        ad.Parts,
 	}
 }

server/backup/backup_local.go

@@ -6,12 +6,10 @@ import (
 	"os"
 
 	"emperror.dev/errors"
-	"github.com/juju/ratelimit"
-	"github.com/mholt/archiver/v4"
-
-	"github.com/pterodactyl/wings/config"
-	"github.com/pterodactyl/wings/remote"
 	"github.com/pterodactyl/wings/server/filesystem"
+
+	"github.com/mholt/archiver/v3"
+	"github.com/pterodactyl/wings/remote"
 )
 
 type LocalBackup struct {
@@ -59,19 +57,19 @@ func (b *LocalBackup) WithLogContext(c map[string]interface{}) {
 
 // Generate generates a backup of the selected files and pushes it to the
 // defined location for this instance.
-func (b *LocalBackup) Generate(ctx context.Context, fsys *filesystem.Filesystem, ignore string) (*ArchiveDetails, error) {
+func (b *LocalBackup) Generate(ctx context.Context, basePath, ignore string) (*ArchiveDetails, error) {
 	a := &filesystem.Archive{
-		Filesystem: fsys,
+		BasePath: basePath,
 		Ignore:   ignore,
 	}
 
 	b.log().WithField("path", b.Path()).Info("creating backup for server")
-	if err := a.Create(ctx, b.Path()); err != nil {
+	if err := a.Create(b.Path()); err != nil {
 		return nil, err
 	}
 	b.log().Info("created backup successfully")
 
-	ad, err := b.Details(ctx, nil)
+	ad, err := b.Details(ctx)
 	if err != nil {
 		return nil, errors.WrapIf(err, "backup: failed to get archive details for local backup")
 	}
@@ -81,28 +79,18 @@ func (b *LocalBackup) Generate(ctx context.Context, fsys *filesystem.Filesystem,
 // Restore will walk over the archive and call the callback function for each
 // file encountered.
 func (b *LocalBackup) Restore(ctx context.Context, _ io.Reader, callback RestoreCallback) error {
-	f, err := os.Open(b.Path())
+	return archiver.Walk(b.Path(), func(f archiver.File) error {
-	if err != nil {
+		select {
-		return err
+		case <-ctx.Done():
-	}
+			// Stop walking if the context is canceled.
-	defer f.Close()
+			return archiver.ErrStopWalk
-
+		default:
-	var reader io.Reader = f
+			{
-	// Steal the logic we use for making backups which will be applied when restoring
+				if f.IsDir() {
-	// this specific backup. This allows us to prevent overloading the disk unintentionally.
-	if writeLimit := int64(config.Get().System.Backups.WriteLimit * 1024 * 1024); writeLimit > 0 {
-		reader = ratelimit.Reader(f, ratelimit.NewBucketWithRate(float64(writeLimit), writeLimit))
-	}
-	if err := format.Extract(ctx, reader, nil, func(ctx context.Context, f archiver.File) error {
-		r, err := f.Open()
-		if err != nil {
-			return err
-		}
-		defer r.Close()
-
-		return callback(f.NameInArchive, f.FileInfo, r)
-	}); err != nil {
-		return err
-	}
 					return nil
+				}
+				return callback(filesystem.ExtractNameFromArchive(f), f)
+			}
+		}
+	})
 }

server/backup/backup_s3.go

@@ -1,6 +1,8 @@
 package backup
 
 import (
+	"archive/tar"
+	"compress/gzip"
 	"context"
 	"fmt"
 	"io"
@@ -11,12 +13,11 @@ import (
 
 	"emperror.dev/errors"
 	"github.com/cenkalti/backoff/v4"
-	"github.com/juju/ratelimit"
+	"github.com/pterodactyl/wings/server/filesystem"
-	"github.com/mholt/archiver/v4"
 
+	"github.com/juju/ratelimit"
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/remote"
-	"github.com/pterodactyl/wings/server/filesystem"
 )
 
 type S3Backup struct {
@@ -48,16 +49,16 @@ func (s *S3Backup) WithLogContext(c map[string]interface{}) {
 
 // Generate creates a new backup on the disk, moves it into the S3 bucket via
 // the provided presigned URL, and then deletes the backup from the disk.
-func (s *S3Backup) Generate(ctx context.Context, fsys *filesystem.Filesystem, ignore string) (*ArchiveDetails, error) {
+func (s *S3Backup) Generate(ctx context.Context, basePath, ignore string) (*ArchiveDetails, error) {
 	defer s.Remove()
 
 	a := &filesystem.Archive{
-		Filesystem: fsys,
+		BasePath: basePath,
 		Ignore:   ignore,
 	}
 
 	s.log().WithField("path", s.Path()).Info("creating backup for server")
-	if err := a.Create(ctx, s.Path()); err != nil {
+	if err := a.Create(s.Path()); err != nil {
 		return nil, err
 	}
 	s.log().Info("created backup successfully")
@@ -68,11 +69,10 @@ func (s *S3Backup) Generate(ctx context.Context, fsys *filesystem.Filesystem, ig
 	}
 	defer rc.Close()
 
-	parts, err := s.generateRemoteRequest(ctx, rc)
+	if err := s.generateRemoteRequest(ctx, rc); err != nil {
-	if err != nil {
 		return nil, err
 	}
-	ad, err := s.Details(ctx, parts)
+	ad, err := s.Details(ctx)
 	if err != nil {
 		return nil, errors.WrapIf(err, "backup: failed to get archive details after upload")
 	}
@@ -93,35 +93,50 @@ func (s *S3Backup) Restore(ctx context.Context, r io.Reader, callback RestoreCal
 	if writeLimit := int64(config.Get().System.Backups.WriteLimit * 1024 * 1024); writeLimit > 0 {
 		reader = ratelimit.Reader(r, ratelimit.NewBucketWithRate(float64(writeLimit), writeLimit))
 	}
-	if err := format.Extract(ctx, reader, nil, func(ctx context.Context, f archiver.File) error {
+	gr, err := gzip.NewReader(reader)
-		r, err := f.Open()
 	if err != nil {
 		return err
 	}
-		defer r.Close()
+	defer gr.Close()
-
+	tr := tar.NewReader(gr)
-		return callback(f.NameInArchive, f.FileInfo, r)
+	for {
-	}); err != nil {
+		select {
+		case <-ctx.Done():
+			return nil
+		default:
+			// Do nothing, fall through to the next block of code in this loop.
+		}
+		header, err := tr.Next()
+		if err != nil {
+			if err == io.EOF {
+				break
+			}
 			return err
 		}
+		if header.Typeflag == tar.TypeReg {
+			if err := callback(header.Name, tr); err != nil {
+				return err
+			}
+		}
+	}
 	return nil
 }
 
 // Generates the remote S3 request and begins the upload.
-func (s *S3Backup) generateRemoteRequest(ctx context.Context, rc io.ReadCloser) ([]remote.BackupPart, error) {
+func (s *S3Backup) generateRemoteRequest(ctx context.Context, rc io.ReadCloser) error {
 	defer rc.Close()
 
 	s.log().Debug("attempting to get size of backup...")
 	size, err := s.Backup.Size()
 	if err != nil {
-		return nil, err
+		return err
 	}
 	s.log().WithField("size", size).Debug("got size of backup")
 
 	s.log().Debug("attempting to get S3 upload urls from Panel...")
 	urls, err := s.client.GetBackupRemoteUploadURLs(context.Background(), s.Backup.Uuid, size)
 	if err != nil {
-		return nil, err
+		return err
 	}
 	s.log().Debug("got S3 upload urls from the Panel")
 	s.log().WithField("parts", len(urls.Parts)).Info("attempting to upload backup to s3 endpoint...")
@@ -139,26 +154,22 @@ func (s *S3Backup) generateRemoteRequest(ctx context.Context, rc io.ReadCloser)
 		}
 
 		// Attempt to upload the part.
-		etag, err := uploader.uploadPart(ctx, part, partSize)
+		if _, err := uploader.uploadPart(ctx, part, partSize); err != nil {
-		if err != nil {
 			s.log().WithField("part_id", i+1).WithError(err).Warn("failed to upload part")
-			return nil, err
+			return err
 		}
-		uploader.uploadedParts = append(uploader.uploadedParts, remote.BackupPart{
+
-			ETag:       etag,
-			PartNumber: i + 1,
-		})
 		s.log().WithField("part_id", i+1).Info("successfully uploaded backup part")
 	}
+
 	s.log().WithField("parts", len(urls.Parts)).Info("backup has been successfully uploaded")
 
-	return uploader.uploadedParts, nil
+	return nil
 }
 
 type s3FileUploader struct {
 	io.ReadCloser
 	client *http.Client
-	uploadedParts []remote.BackupPart
 }
 
 // newS3FileUploader returns a new file uploader instance.