metrics: initial commit

.github/FUNDING.yml

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

.github/workflows/build-test.yml

@@ -2,17 +2,17 @@ name: Run Tests
 on:
   push:
     branches:
-      - develop
+      - 'develop'
   pull_request:
     branches:
-      - develop
+      - 'develop'
 jobs:
   build:
     strategy:
       fail-fast: false
       matrix:
         os: [ ubuntu-20.04 ]
-        go: [ '^1.17' ]
+        go: [ '^1.15', '^1.16' ]
         goos: [ linux ]
         goarch: [ amd64, arm64 ]
     runs-on: ${{ matrix.os }}
@@ -60,7 +60,7 @@ jobs:
         run: go test ./...
       - name: Upload Artifact
         uses: actions/upload-artifact@v2
-        if: ${{ github.ref == 'refs/heads/develop' || github.event_name == 'pull_request' }}
+        if: ${{ matrix.go == '^1.15' && (github.ref == 'refs/heads/develop' || github.event_name == 'pull_request') }}
         with:
           name: wings_${{ matrix.goos }}_${{ matrix.goarch }}
           path: build/wings_${{ matrix.goos }}_${{ matrix.goarch }}

.github/workflows/codeql-analysis.yml

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

.github/workflows/docker.yml

@@ -2,7 +2,8 @@ name: Publish Docker Image
 on:
   push:
     branches:
-      - develop
+      - 'develop'
+
     tags:
       - 'v*'
 jobs:
@@ -34,7 +35,7 @@ jobs:
       - name: Get Build Information
         id: build_info
         run: |
-          echo "::set-output name=version_tag::${GITHUB_REF/refs\/tags\/v/}"
+          echo "::set-output name=version_tag::${GITHUB_REF/refs\/tags\//}"
           echo "::set-output name=short_sha::$(git rev-parse --short HEAD)"
       - name: Release Production Build
         uses: docker/build-push-action@v2
@@ -43,7 +44,6 @@ jobs:
           build-args: |
             VERSION=${{ steps.build_info.outputs.version_tag }}
           labels: ${{ steps.docker_meta.outputs.labels }}
-          platforms: linux/amd64,linux/arm64
           push: true
           tags: ${{ steps.docker_meta.outputs.tags }}
       - name: Release Development Build
@@ -53,6 +53,5 @@ jobs:
           build-args: |
             VERSION=dev-${{ steps.build_info.outputs.short_sha }}
           labels: ${{ steps.docker_meta.outputs.labels }}
-          platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.docker_meta.outputs.tags }}

.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
         uses: actions/checkout@v2
       - uses: actions/setup-go@v2
         with:
-          go-version: '^1.17'
+          go-version: '^1.15'
       - name: Build
         env:
           REF: ${{ github.ref }}
@@ -45,7 +45,7 @@ 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

CHANGELOG.md

@@ -1,87 +1,5 @@
 # Changelog
 
-## 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,5 +1,5 @@
 # Stage 1 (Build)
-FROM --platform=$BUILDPLATFORM golang:1.17-alpine AS builder
+FROM golang:1.15-alpine3.12 AS builder
 
 ARG VERSION
 RUN apk add --update --no-cache git make upx
@@ -14,13 +14,9 @@ RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build \
     -o wings \
     wings.go
 RUN upx wings
-RUN echo "ID=\"distroless\"" > /etc/os-release
 
 # 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

README.md

@@ -30,11 +30,8 @@ I would like to extend my sincere thanks to the following sponsors for helping f
 | [**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://chs.gg/) | 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! |
+| [**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*! |
-| [**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. |
-| [**VibeGAMES**](https://vibegames.net/) | VibeGAMES is a game server provider that specializes in DDOS protection for the games we offer. We have multiple locations in the US, Brazil, France, Germany, Singapore, Australia and South Africa.|
-| [**RocketNode**](https://rocketnode.net) | RocketNode is a VPS and Game Server provider that offers the best performing VPS and Game hosting Solutions at affordable prices! |
 
 ## Documentation
 * [Panel Documentation](https://pterodactyl.io/panel/1.0/getting_started.html)

cmd/configure.go

@@ -4,7 +4,7 @@ import (
 	"crypto/tls"
 	"encoding/json"
 	"fmt"
-	"io"
+	"io/ioutil"
 	"net/http"
 	"net/url"
 	"os"
@@ -14,19 +14,20 @@ import (
 
 	"github.com/AlecAivazis/survey/v2"
 	"github.com/AlecAivazis/survey/v2/terminal"
-	"github.com/spf13/cobra"
-
 	"github.com/pterodactyl/wings/config"
+	"github.com/spf13/cobra"
 )
 
-var configureArgs struct {
+var (
-	PanelURL      string
+	configureArgs struct {
-	Token         string
+		PanelURL      string
-	ConfigPath    string
+		Token         string
-	Node          string
+		ConfigPath    string
-	Override      bool
+		Node          string
-	AllowInsecure bool
+		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 {

cmd/diagnostics.go

@@ -6,6 +6,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"io/ioutil"
 	"net/http"
 	"net/url"
 	"os/exec"
@@ -20,26 +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/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 (
-	IncludeEndpoints   bool
+	diagnosticsArgs struct {
-	IncludeLogs        bool
+		IncludeEndpoints   bool
-	ReviewBeforeUpload bool
+		IncludeLogs        bool
-	HastebinURL        string
+		ReviewBeforeUpload bool
-	LogLines           int
+		HastebinURL        string
-}
+		LogLines           int
+	}
+)
 
 func newDiagnosticsCommand() *cobra.Command {
 	command := &cobra.Command{
@@ -78,7 +78,7 @@ func diagnosticsCmdRun(cmd *cobra.Command, args []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,40 +96,41 @@ func diagnosticsCmdRun(cmd *cobra.Command, args []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)
+		fmt.Fprintln(output, "    OS:", os)
 	}
 
 	printHeader(output, "Wings Configuration")
 	if err := config.FromFile(config.DefaultLocation); err != nil {
+
 	}
 	cfg := config.Get()
-	fmt.Fprintln(output, "      Panel Location:", redact(cfg.PanelLocation))
+	fmt.Fprintln(output, "    Panel Location:", redact(cfg.PanelLocation))
 	fmt.Fprintln(output, "")
-	fmt.Fprintln(output, "  Internal Webserver:", redact(cfg.Api.Host), ":", cfg.Api.Port)
+	fmt.Fprintln(output, " Internal Webserver:", redact(cfg.Api.Host), ":", cfg.Api.Port)
-	fmt.Fprintln(output, "         SSL Enabled:", cfg.Api.Ssl.Enabled)
+	fmt.Fprintln(output, "        SSL Enabled:", cfg.Api.Ssl.Enabled)
-	fmt.Fprintln(output, "     SSL Certificate:", redact(cfg.Api.Ssl.CertificateFile))
+	fmt.Fprintln(output, "    SSL Certificate:", redact(cfg.Api.Ssl.CertificateFile))
-	fmt.Fprintln(output, "             SSL Key:", redact(cfg.Api.Ssl.KeyFile))
+	fmt.Fprintln(output, "            SSL Key:", redact(cfg.Api.Ssl.KeyFile))
 	fmt.Fprintln(output, "")
-	fmt.Fprintln(output, "         SFTP Server:", redact(cfg.System.Sftp.Address), ":", cfg.System.Sftp.Port)
+	fmt.Fprintln(output, "        SFTP Server:", redact(cfg.System.Sftp.Address), ":", cfg.System.Sftp.Port)
-	fmt.Fprintln(output, "      SFTP Read-Only:", cfg.System.Sftp.ReadOnly)
+	fmt.Fprintln(output, "     SFTP Read-Only:", cfg.System.Sftp.ReadOnly)
 	fmt.Fprintln(output, "")
-	fmt.Fprintln(output, "      Root Directory:", cfg.System.RootDirectory)
+	fmt.Fprintln(output, "     Root Directory:", cfg.System.RootDirectory)
-	fmt.Fprintln(output, "      Logs Directory:", cfg.System.LogDirectory)
+	fmt.Fprintln(output, "     Logs Directory:", cfg.System.LogDirectory)
-	fmt.Fprintln(output, "      Data Directory:", cfg.System.Data)
+	fmt.Fprintln(output, "     Data Directory:", cfg.System.Data)
-	fmt.Fprintln(output, "   Archive Directory:", cfg.System.ArchiveDirectory)
+	fmt.Fprintln(output, "  Archive Directory:", cfg.System.ArchiveDirectory)
-	fmt.Fprintln(output, "    Backup Directory:", cfg.System.BackupDirectory)
+	fmt.Fprintln(output, "   Backup Directory:", cfg.System.BackupDirectory)
 	fmt.Fprintln(output, "")
-	fmt.Fprintln(output, "            Username:", cfg.System.Username)
+	fmt.Fprintln(output, "           Username:", cfg.System.Username)
-	fmt.Fprintln(output, "         Server Time:", time.Now().Format(time.RFC1123Z))
+	fmt.Fprintln(output, "        Server Time:", time.Now().Format(time.RFC1123Z))
-	fmt.Fprintln(output, "          Debug Mode:", cfg.Debug)
+	fmt.Fprintln(output, "         Debug Mode:", cfg.Debug)
 
 	printHeader(output, "Docker: Info")
 	if dockerErr == nil {
@@ -188,16 +189,6 @@ func diagnosticsCmdRun(cmd *cobra.Command, args []string) {
 		survey.AskOne(&survey.Confirm{Message: "Upload to " + diagnosticsArgs.HastebinURL + "?", Default: false}, &upload)
 	}
 	if upload {
-		if !diagnosticsArgs.IncludeEndpoints {
-			s := output.String()
-			output.Reset()
-			a := strings.ReplaceAll(cfg.PanelLocation, s, "{redacted}")
-			a = strings.ReplaceAll(cfg.Api.Host, a, "{redacted}")
-			a = strings.ReplaceAll(cfg.Api.Ssl.CertificateFile, a, "{redacted}")
-			a = strings.ReplaceAll(cfg.Api.Ssl.KeyFile, a, "{redacted}")
-			a = strings.ReplaceAll(cfg.System.Sftp.Address, a, "{redacted}")
-			output.WriteString(a)
-		}
 		u, err := uploadToHastebin(diagnosticsArgs.HastebinURL, output.String())
 		if err == nil {
 			fmt.Println("Your report is available here: ", u)
@@ -234,7 +225,7 @@ func uploadToHastebin(hbUrl, content string) (string, error) {
 		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,10 +1,10 @@
 package cmd
 
 import (
-	"context"
 	"crypto/tls"
 	"errors"
 	"fmt"
+	"github.com/pterodactyl/wings/metrics"
 	log2 "log"
 	"net/http"
 	"os"
@@ -21,10 +21,6 @@ import (
 	"github.com/gammazero/workerpool"
 	"github.com/mitchellh/colorstring"
 	"github.com/pkg/profile"
-	"github.com/spf13/cobra"
-	"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/loggers/cli"
@@ -33,6 +29,9 @@ import (
 	"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 (
@@ -42,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()
@@ -92,9 +91,9 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 	case "mem":
 		defer profile.Start(profile.MemProfile).Stop()
 	case "alloc":
-		defer profile.Start(profile.MemProfile, profile.MemProfileAllocs).Stop()
+		defer profile.Start(profile.MemProfile, profile.MemProfileAllocs()).Stop()
 	case "heap":
-		defer profile.Start(profile.MemProfile, profile.MemProfileHeap).Stop()
+		defer profile.Start(profile.MemProfile, profile.MemProfileHeap()).Stop()
 	case "routines":
 		defer profile.Start(profile.GoroutineProfile).Stop()
 	case "mutex":
@@ -124,6 +123,11 @@ 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")
@@ -133,10 +137,9 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 		"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,
@@ -161,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()
@@ -200,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")
@@ -246,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 {
@@ -255,20 +254,13 @@ 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()
@@ -285,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")
@@ -294,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")
 	}
 
@@ -355,7 +347,7 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
 	// 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
@@ -364,10 +356,11 @@ 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 !strings.HasPrefix(configPath, "/") {
 		d, err := os.Getwd()
@@ -392,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")

config/config.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"crypto/tls"
 	"fmt"
+	"io/ioutil"
 	"os"
 	"os/exec"
 	"os/user"
@@ -20,9 +21,8 @@ import (
 	"github.com/cobaugh/osrelease"
 	"github.com/creasty/defaults"
 	"github.com/gbrlsnchs/jwt/v3"
-	"gopkg.in/yaml.v2"
-
 	"github.com/pterodactyl/wings/system"
+	"gopkg.in/yaml.v2"
 )
 
 const DefaultLocation = "/etc/pterodactyl/config.yml"
@@ -47,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.
@@ -93,6 +91,12 @@ type ApiConfiguration struct {
 	UploadLimit int `default:"100" json:"upload_limit" yaml:"upload_limit"`
 }
 
+// MetricsConfiguration .
+type MetricsConfiguration struct {
+	// Bind .
+	Bind string `default:":9000" yaml:"bind"`
+}
+
 // RemoteQueryConfiguration defines the configuration settings for remote requests
 // from Wings to the Panel.
 type RemoteQueryConfiguration struct {
@@ -182,9 +186,6 @@ type SystemConfiguration struct {
 }
 
 type CrashDetection struct {
-	// CrashDetectionEnabled sets if crash detection is enabled globally for all servers on this node.
-	CrashDetectionEnabled bool `default:"true" yaml:"enabled"`
-
 	// Determines if Wings should detect a server that stops with a normal exit code of
 	// "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.
@@ -265,9 +266,10 @@ type Configuration struct {
 	// validate against it.
 	AuthenticationToken string `json:"token" yaml:"token"`
 
-	Api    ApiConfiguration    `json:"api" yaml:"api"`
+	Api     ApiConfiguration     `json:"api" yaml:"api"`
-	System SystemConfiguration `json:"system" yaml:"system"`
+	System  SystemConfiguration  `json:"system" yaml:"system"`
-	Docker DockerConfiguration `json:"docker" yaml:"docker"`
+	Docker  DockerConfiguration  `json:"docker" yaml:"docker"`
+	Metrics MetricsConfiguration `json:"metrics" yaml:"metrics"`
 
 	// Defines internal throttling configurations for server processes to prevent
 	// someone from running an endless loop that spams data to logs.
@@ -286,12 +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"`
 }
 
 // NewAtPath creates a new struct and set the path where it should be stored.
@@ -385,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
@@ -405,7 +401,7 @@ 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"))
@@ -453,7 +449,7 @@ func EnsurePterodactylUser() error {
 // 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
 	}
@@ -461,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.
 //
@@ -479,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
 	}
 
@@ -500,17 +497,17 @@ 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
 	}
 
@@ -548,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
@@ -556,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 {
@@ -583,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")

config/config_docker.go

@@ -3,7 +3,6 @@ package config
 import (
 	"encoding/base64"
 	"encoding/json"
-	"sort"
 
 	"github.com/docker/docker/api/types"
 )
@@ -52,29 +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"`
 }
 
 // RegistryConfiguration defines the authentication credentials for a given
@@ -96,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,7 +5,6 @@ import (
 	"strconv"
 
 	"github.com/docker/go-connections/nat"
-
 	"github.com/pterodactyl/wings/config"
 )
 
@@ -20,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"`
 }
@@ -31,7 +30,7 @@ type Allocations struct {
 //
 // You'll want to use DockerBindings() if you need to re-map 127.0.0.1 to the Docker interface.
 func (a *Allocations) Bindings() nat.PortMap {
-	out := nat.PortMap{}
+	var out = nat.PortMap{}
 
 	for ip, ports := range a.Mappings {
 		for _, port := range ports {
@@ -63,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 {
@@ -94,7 +93,7 @@ func (a *Allocations) DockerBindings() nat.PortMap {
 // To accomplish this, we'll just get the values from "DockerBindings" and then set them
 // to 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/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

environment/docker/container.go

@@ -17,7 +17,6 @@ import (
 	"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"
@@ -45,7 +44,7 @@ func (nw noopWriter) Write(b []byte) (int, error) {
 // Calling this function will poll resources for the container in the background
 // until the provided context is canceled by the caller. Failure to cancel said
 // context will cause background memory leaks as the goroutine will not exit.
-func (e *Environment) Attach(ctx context.Context) error {
+func (e *Environment) Attach() error {
 	if e.IsAttached() {
 		return nil
 	}
@@ -62,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 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() {
@@ -81,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 {
@@ -143,7 +139,7 @@ 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 {
@@ -175,7 +171,7 @@ func (e *Environment) Create() error {
 	conf := &container.Config{
 		Hostname:     e.Id,
 		Domainname:   config.Get().Docker.Domainname,
-		User:         strconv.Itoa(config.Get().System.User.Uid) + ":" + strconv.Itoa(config.Get().System.User.Gid),
+		User:         strconv.Itoa(config.Get().System.User.Uid),
 		AttachStdin:  true,
 		AttachStdout: true,
 		AttachStderr: true,
@@ -196,7 +192,7 @@ func (e *Environment) Create() error {
 		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
@@ -342,11 +338,13 @@ func (e *Environment) followOutput() error {
 func (e *Environment) scanOutput(reader io.ReadCloser) {
 	defer reader.Close()
 
-	if err := system.ScanReader(reader, func(v []byte) {
+	events := e.Events()
-		e.logCallbackMx.Lock()
+
-		defer e.logCallbackMx.Unlock()
+	err := system.ScanReader(reader, func(line string) {
-		e.logCallback(v)
+		events.Publish(environment.ConsoleOutputEvent, line)
-	}); err != nil && err != io.EOF {
+	})
+
+	if err != nil && err != io.EOF {
 		log.WithField("error", err).WithField("container_id", e.Id).Warn("error processing scanner line in console output")
 		return
 	}
@@ -356,7 +354,7 @@ func (e *Environment) scanOutput(reader io.ReadCloser) {
 		return
 	}
 
-	// Close the current reader before starting a new one, the defer will still run,
+	// Close the current reader before starting a new one, the defer will still run
 	// but it will do nothing if we already closed the stream.
 	_ = reader.Close()
 
@@ -374,7 +372,7 @@ type imagePullStatus struct {
 // 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 {

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,7 +22,7 @@ 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)
 
@@ -49,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
@@ -103,9 +100,9 @@ func (e *Environment) IsAttached() bool {
 	return e.stream != nil
 }
 
-func (e *Environment) Events() *events.Bus {
+func (e *Environment) Events() *events.EventBus {
 	e.eventMu.Do(func() {
-		e.emitter = events.NewBus()
+		e.emitter = events.New()
 	})
 
 	return e.emitter
@@ -117,6 +114,7 @@ func (e *Environment) Events() *events.Bus {
 // ID auto-assigned when the container is created.
 func (e *Environment) Exists() (bool, error) {
 	_, 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.
@@ -130,20 +128,20 @@ func (e *Environment) Exists() (bool, error) {
 	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.client.ContainerInspect(ctx, e.Id)
+	c, err := e.client.ContainerInspect(context.Background(), e.Id)
 	if err != nil {
 		return false, err
 	}
+
 	return c.State.Running, nil
 }
 
@@ -215,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

@@ -12,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")
 		}
@@ -47,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
@@ -66,7 +64,7 @@ func (e *Environment) Start(ctx context.Context) error {
 		}
 	}()
 
-	if c, err := e.client.ContainerInspect(ctx, e.Id); 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.
@@ -80,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 {
@@ -102,23 +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.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()
 
-	if err := e.client.ContainerStart(actx, e.Id, types.ContainerStartOptions{}); err != nil {
+	if err := e.client.ContainerStart(ctx, 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 e.Attach(actx)
+	return e.Attach()
 }
 
 // Stop stops the container that the server is running in. This will allow up to
@@ -246,7 +242,7 @@ func (e *Environment) Terminate(signal os.Signal) 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 {

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/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.client.ContainerInspect(ctx, e.Id)
-	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 {

environment/environment.go

@@ -1,13 +1,13 @@
 package environment
 
 import (
-	"context"
 	"os"
 
 	"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,11 +52,11 @@ 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
 
 	// Stops a server instance. If the server is already stopped an error should
 	// not be returned.
@@ -84,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
@@ -103,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"`
 }
@@ -75,7 +74,13 @@ 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 {

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,126 +1,122 @@
 package events
 
 import (
+	"encoding/json"
 	"strings"
 	"sync"
+
+	"github.com/gammazero/workerpool"
 )
 
-type Listener chan Event
-
-// 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
-	listenersMx sync.Mutex
+	pools map[string]*CallbackPool
-	listeners   map[string][]Listener
 }
 
-// NewBus returns a new empty Event Bus.
+func New() *EventBus {
-func NewBus() *Bus {
+	return &EventBus{
-	return &Bus{
+		pools: make(map[string]*CallbackPool),
-		listeners: make(map[string][]Listener),
 	}
 }
 
-// Off unregisters a listener from the specified topics on the Bus.
+// Publish data to a given topic.
-func (b *Bus) Off(listener Listener, topics ...string) {
+func (e *EventBus) Publish(topic string, data string) {
-	b.listenersMx.Lock()
+	t := topic
-	defer b.listenersMx.Unlock()
-
-	for _, topic := range topics {
-		b.off(topic, listener)
-	}
-}
-
-func (b *Bus) off(topic string, listener Listener) bool {
-	listeners, ok := b.listeners[topic]
-	if !ok {
-		return false
-	}
-	for i, l := range listeners {
-		if l != listener {
-			continue
-		}
-
-		listeners = append(listeners[:i], listeners[i+1:]...)
-		b.listeners[topic] = listeners
-		return true
-	}
-	return false
-}
-
-// On registers a listener to the specified topics on the Bus.
-func (b *Bus) On(listener Listener, topics ...string) {
-	b.listenersMx.Lock()
-	defer b.listenersMx.Unlock()
-
-	for _, topic := range topics {
-		b.on(topic, listener)
-	}
-}
-
-func (b *Bus) on(topic string, listener Listener) {
-	listeners, ok := b.listeners[topic]
-	if !ok {
-		b.listeners[topic] = []Listener{listener}
-	} else {
-		b.listeners[topic] = append(listeners, listener)
-	}
-}
-
-// Publish publishes a message to the Bus.
-func (b *Bus) Publish(topic string, data interface{}) {
 	// 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]
 		}
 	}
 
-	b.listenersMx.Lock()
+	e.mu.RLock()
-	defer b.listenersMx.Unlock()
+	defer e.mu.RUnlock()
 
-	listeners, ok := b.listeners[topic]
+	// Acquire a read lock and loop over all of the channels registered for the topic. This
-	if !ok {
+	// avoids a panic crash if the process tries to unregister the channel while this routine
-		return
+	// 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)
+			})
+		}
 	}
-	if len(listeners) < 1 {
-		return
-	}
-
-	var wg sync.WaitGroup
-	event := Event{Topic: topic, Data: data}
-	for _, listener := range listeners {
-		l := listener
-		wg.Add(1)
-		go func(l Listener, event Event) {
-			defer wg.Done()
-			l <- event
-		}(l, event)
-	}
-	wg.Wait()
 }
 
-// Destroy destroys the Event Bus by unregistering and closing all listeners.
+// Publishes a JSON message to a given topic.
-func (b *Bus) Destroy() {
+func (e *EventBus) PublishJson(topic string, data interface{}) error {
-	b.listenersMx.Lock()
+	b, err := json.Marshal(data)
-	defer b.listenersMx.Unlock()
+	if err != nil {
+		return err
+	}
 
-	for _, listeners := range b.listeners {
+	e.Publish(topic, string(b))
-		for _, listener := range listeners {
+
-			close(listener)
+	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),
 		}
 	}
 
-	b.listeners = make(map[string][]Listener)
+	// 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,180 +0,0 @@
-package events
-
-import (
-	"testing"
-	"time"
-
-	. "github.com/franela/goblin"
-)
-
-func TestNewBus(t *testing.T) {
-	g := Goblin(t)
-	bus := NewBus()
-
-	g.Describe("NewBus", func() {
-		g.It("is not nil", func() {
-			g.Assert(bus).IsNotNil("Bus expected to not be nil")
-			g.Assert(bus.listeners).IsNotNil("Bus#listeners expected to not be nil")
-		})
-	})
-}
-
-func TestBus_Off(t *testing.T) {
-	g := Goblin(t)
-
-	const topic = "test"
-
-	g.Describe("Off", func() {
-		g.It("unregisters listener", func() {
-			bus := NewBus()
-
-			g.Assert(bus.listeners[topic]).IsNotNil()
-			g.Assert(len(bus.listeners[topic])).IsZero()
-			listener := make(chan Event)
-			bus.On(listener, topic)
-			g.Assert(len(bus.listeners[topic])).Equal(1, "Listener was not registered")
-
-			bus.Off(listener, topic)
-			g.Assert(len(bus.listeners[topic])).Equal(0, "Topic still has one or more listeners")
-
-			close(listener)
-		})
-
-		g.It("unregisters correct listener", func() {
-			bus := NewBus()
-
-			listener := make(chan Event)
-			listener2 := make(chan Event)
-			listener3 := make(chan Event)
-			bus.On(listener, topic)
-			bus.On(listener2, topic)
-			bus.On(listener3, topic)
-			g.Assert(len(bus.listeners[topic])).Equal(3, "Listeners were not registered")
-
-			bus.Off(listener, topic)
-			bus.Off(listener3, topic)
-			g.Assert(len(bus.listeners[topic])).Equal(1, "Expected 1 listener to remain")
-
-			if bus.listeners[topic][0] != listener2 {
-				// A normal Assert does not properly compare channels.
-				g.Fail("wrong listener unregistered")
-			}
-
-			// Cleanup
-			bus.Off(listener2, topic)
-			close(listener)
-			close(listener2)
-			close(listener3)
-		})
-	})
-}
-
-func TestBus_On(t *testing.T) {
-	g := Goblin(t)
-
-	const topic = "test"
-
-	g.Describe("On", func() {
-		g.It("registers listener", func() {
-			bus := NewBus()
-
-			g.Assert(bus.listeners[topic]).IsNotNil()
-			g.Assert(len(bus.listeners[topic])).IsZero()
-			listener := make(chan Event)
-			bus.On(listener, topic)
-			g.Assert(len(bus.listeners[topic])).Equal(1, "Listener was not registered")
-
-			if bus.listeners[topic][0] != listener {
-				// A normal Assert does not properly compare channels.
-				g.Fail("wrong listener registered")
-			}
-
-			// Cleanup
-			bus.Off(listener, topic)
-			close(listener)
-		})
-	})
-}
-
-func TestBus_Publish(t *testing.T) {
-	g := Goblin(t)
-
-	const topic = "test"
-	const message = "this is a test message!"
-
-	g.Describe("Publish", func() {
-		g.It("publishes message", func() {
-			bus := NewBus()
-
-			g.Assert(bus.listeners[topic]).IsNotNil()
-			g.Assert(len(bus.listeners[topic])).IsZero()
-			listener := make(chan Event)
-			bus.On(listener, topic)
-			g.Assert(len(bus.listeners[topic])).Equal(1, "Listener was not registered")
-
-			done := make(chan struct{}, 1)
-			go func() {
-				select {
-				case m := <-listener:
-					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
-			close(listener)
-			bus.Off(listener, topic)
-		})
-
-		g.It("publishes message to all listeners", func() {
-			bus := NewBus()
-
-			g.Assert(bus.listeners[topic]).IsNotNil()
-			g.Assert(len(bus.listeners[topic])).IsZero()
-			listener := make(chan Event)
-			listener2 := make(chan Event)
-			listener3 := make(chan Event)
-			bus.On(listener, topic)
-			bus.On(listener2, topic)
-			bus.On(listener3, topic)
-			g.Assert(len(bus.listeners[topic])).Equal(3, "Listener was not registered")
-
-			done := make(chan struct{}, 1)
-			go func() {
-				for i := 0; i < 3; i++ {
-					select {
-					case m := <-listener:
-						g.Assert(m.Topic).Equal(topic)
-						g.Assert(m.Data).Equal(message)
-					case m := <-listener2:
-						g.Assert(m.Topic).Equal(topic)
-						g.Assert(m.Data).Equal(message)
-					case m := <-listener3:
-						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, topic)
-			bus.Off(listener2, topic)
-			bus.Off(listener3, topic)
-			close(listener)
-			close(listener2)
-			close(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
+}

go.mod

@@ -1,115 +1,83 @@
 module github.com/pterodactyl/wings
 
-go 1.17
+go 1.14
 
 require (
 	emperror.dev/errors v0.8.0
-	github.com/AlecAivazis/survey/v2 v2.2.15
+	github.com/AlecAivazis/survey/v2 v2.2.7
-	github.com/Jeffail/gabs/v2 v2.6.1
+	github.com/Jeffail/gabs/v2 v2.6.0
+	github.com/Microsoft/go-winio v0.4.16 // indirect
+	github.com/Microsoft/hcsshim v0.8.14 // indirect
 	github.com/NYTimes/logrotate v1.0.0
+	github.com/andybalholm/brotli v1.0.1 // indirect
 	github.com/apex/log v1.9.0
-	github.com/asaskevich/govalidator v0.0.0-20210307081110-f21760c49a8d
+	github.com/asaskevich/govalidator v0.0.0-20200907205600-7a23bdc65eef
 	github.com/beevik/etree v1.1.0
-	github.com/buger/jsonparser v1.1.1
+	github.com/buger/jsonparser v1.1.0
-	github.com/cenkalti/backoff/v4 v4.1.1
+	github.com/cenkalti/backoff/v4 v4.1.0
 	github.com/cobaugh/osrelease v0.0.0-20181218015638-a93a0a55a249
+	github.com/containerd/containerd v1.4.3 // indirect
+	github.com/containerd/fifo v0.0.0-20201026212402-0724c46b320c // indirect
 	github.com/creasty/defaults v1.5.1
-	github.com/docker/docker v20.10.7+incompatible
+	github.com/docker/distribution v2.7.1+incompatible // indirect
+	github.com/docker/docker v20.10.1+incompatible
 	github.com/docker/go-connections v0.4.0
-	github.com/fatih/color v1.12.0
+	github.com/docker/go-metrics v0.0.1 // indirect
+	github.com/fatih/color v1.10.0
 	github.com/franela/goblin v0.0.0-20200825194134-80c0062ed6cd
-	github.com/gabriel-vasile/mimetype v1.3.1
+	github.com/fsnotify/fsnotify v1.4.9 // indirect
-	github.com/gammazero/workerpool v1.1.2
+	github.com/gabriel-vasile/mimetype v1.1.2
-	github.com/gbrlsnchs/jwt/v3 v3.0.1
+	github.com/gammazero/deque v0.0.0-20201010052221-3932da5530cc // indirect
-	github.com/gin-gonic/gin v1.7.2
+	github.com/gammazero/workerpool v1.1.1
-	github.com/google/uuid v1.3.0
+	github.com/gbrlsnchs/jwt/v3 v3.0.0
+	github.com/gin-gonic/gin v1.6.3
+	github.com/go-playground/validator/v10 v10.4.1 // indirect
+	github.com/golang/snappy v0.0.2 // indirect
+	github.com/google/go-cmp v0.5.2 // indirect
+	github.com/google/uuid v1.1.2
+	github.com/gorilla/mux v1.7.4 // indirect
 	github.com/gorilla/websocket v1.4.2
-	github.com/iancoleman/strcase v0.2.0
+	github.com/iancoleman/strcase v0.1.2
-	github.com/icza/dyno v0.0.0-20210726202311-f1bafe5d9996
+	github.com/icza/dyno v0.0.0-20200205103839-49cb13720835
+	github.com/imdario/mergo v0.3.9
 	github.com/juju/ratelimit v1.0.1
 	github.com/karrick/godirwalk v1.16.1
+	github.com/klauspost/compress v1.11.4 // indirect
 	github.com/klauspost/pgzip v1.2.5
-	github.com/magiconair/properties v1.8.5
+	github.com/leodido/go-urn v1.2.1 // indirect
+	github.com/magefile/mage v1.10.0 // indirect
+	github.com/magiconair/properties v1.8.4
 	github.com/mattn/go-colorable v0.1.8
+	github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
 	github.com/mholt/archiver/v3 v3.5.0
 	github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db
+	github.com/moby/term v0.0.0-20201216013528-df9cb8a40635 // indirect
+	github.com/morikuni/aec v1.0.0 // indirect
+	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
+	github.com/opencontainers/go-digest v1.0.0 // indirect
+	github.com/opencontainers/image-spec v1.0.1 // indirect
 	github.com/patrickmn/go-cache v2.1.0+incompatible
-	github.com/pkg/profile v1.6.0
+	github.com/pierrec/lz4/v4 v4.1.2 // indirect
-	github.com/pkg/sftp v1.13.2
+	github.com/pkg/profile v1.5.0
+	github.com/pkg/sftp v1.12.0
+	github.com/prometheus/client_golang v1.9.0 // indirect
 	github.com/sabhiram/go-gitignore v0.0.0-20201211210132-54b8a0bf510f
-	github.com/spf13/cobra v1.2.1
+	github.com/sirupsen/logrus v1.7.0 // indirect
-	github.com/stretchr/testify v1.7.0
+	github.com/spf13/cobra v1.1.1
-	golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97
+	github.com/stretchr/testify v1.6.1
-	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
+	github.com/ugorji/go v1.2.2 // indirect
+	github.com/ulikunitz/xz v0.5.9 // indirect
+	golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad
+	golang.org/x/net v0.0.0-20201224014010-6772e930b67b // indirect
+	golang.org/x/sync v0.0.0-20201207232520-09787c993a3a
+	golang.org/x/sys v0.0.0-20201223074533-0d417f636930 // indirect
+	golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf // indirect
+	golang.org/x/text v0.3.4 // indirect
+	golang.org/x/time v0.0.0-20201208040808-7e3f01d25324 // indirect
+	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
+	google.golang.org/genproto v0.0.0-20201214200347-8c77b98c765d // indirect
+	google.golang.org/grpc v1.34.0 // indirect
+	gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
 	gopkg.in/ini.v1 v1.62.0
 	gopkg.in/yaml.v2 v2.4.0
 )
-
-require (
-	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
-	github.com/Microsoft/go-winio v0.5.0 // indirect
-	github.com/Microsoft/hcsshim v0.8.20 // indirect
-	github.com/andybalholm/brotli v1.0.3 // indirect
-	github.com/beorn7/perks v1.0.1 // indirect
-	github.com/cespare/xxhash/v2 v2.1.1 // indirect
-	github.com/containerd/containerd v1.5.5 // indirect
-	github.com/containerd/fifo v1.0.0 // indirect
-	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/docker/distribution v2.7.1+incompatible // indirect
-	github.com/docker/go-metrics v0.0.1 // indirect
-	github.com/docker/go-units v0.4.0 // indirect
-	github.com/dsnet/compress v0.0.1 // indirect
-	github.com/fsnotify/fsnotify v1.4.9 // indirect
-	github.com/gammazero/deque v0.1.0 // indirect
-	github.com/gin-contrib/sse v0.1.0 // indirect
-	github.com/go-playground/locales v0.13.0 // indirect
-	github.com/go-playground/universal-translator v0.17.0 // indirect
-	github.com/go-playground/validator/v10 v10.8.0 // indirect
-	github.com/gogo/protobuf v1.3.2 // indirect
-	github.com/golang/protobuf v1.5.2 // indirect
-	github.com/golang/snappy v0.0.4 // indirect
-	github.com/gorilla/mux v1.7.4 // indirect
-	github.com/inconshreveable/mousetrap v1.0.0 // indirect
-	github.com/json-iterator/go v1.1.11 // indirect
-	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
-	github.com/klauspost/compress v1.13.2 // indirect
-	github.com/kr/fs v0.1.0 // indirect
-	github.com/leodido/go-urn v1.2.1 // indirect
-	github.com/magefile/mage v1.11.0 // indirect
-	github.com/mattn/go-isatty v0.0.13 // indirect
-	github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369 // indirect
-	github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
-	github.com/moby/term v0.0.0-20210619224110-3f7ff695adc6 // indirect
-	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
-	github.com/modern-go/reflect2 v1.0.1 // indirect
-	github.com/morikuni/aec v1.0.0 // indirect
-	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
-	github.com/nwaples/rardecode v1.1.1 // indirect
-	github.com/opencontainers/go-digest v1.0.0 // indirect
-	github.com/opencontainers/image-spec v1.0.1 // indirect
-	github.com/pierrec/lz4/v4 v4.1.8 // indirect
-	github.com/pkg/errors v0.9.1 // indirect
-	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/prometheus/client_golang v1.11.0 // indirect
-	github.com/prometheus/client_model v0.2.0 // indirect
-	github.com/prometheus/common v0.30.0 // indirect
-	github.com/prometheus/procfs v0.7.1 // indirect
-	github.com/sirupsen/logrus v1.8.1 // indirect
-	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/ugorji/go/codec v1.1.7 // indirect
-	github.com/ulikunitz/xz v0.5.10 // indirect
-	github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 // indirect
-	go.uber.org/atomic v1.9.0 // indirect
-	go.uber.org/multierr v1.7.0 // indirect
-	golang.org/x/net v0.0.0-20210726213435-c6fcb2dbf985 // indirect
-	golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect
-	golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b // indirect
-	golang.org/x/text v0.3.6 // indirect
-	golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac // indirect
-	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
-	google.golang.org/genproto v0.0.0-20210729151513-df9385d47c1b // indirect
-	google.golang.org/grpc v1.39.0 // indirect
-	google.golang.org/protobuf v1.27.1 // indirect
-	gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
-)

installer/installer.go

@@ -2,32 +2,70 @@ 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
+	server *server.Server
-	StartOnCompletion bool
 }
 
-type ServerDetails struct {
+// New validates the received data to ensure that all of the required fields
-	UUID              string `json:"uuid"`
-	StartOnCompletion bool   `json:"start_on_completion"`
-}
-
-// New validates the received data to ensure that all the required fields
 // have been passed along in the request. This should be manually run before
 // calling Execute().
-func New(ctx context.Context, manager *server.Manager, details ServerDetails) (*Installer, error) {
+func New(ctx context.Context, manager *server.Manager, data []byte) (*Installer, error) {
-	if !govalidator.IsUUIDv4(details.UUID) {
+	if !govalidator.IsUUIDv4(getString(data, "uuid")) {
 		return nil, NewValidationError("uuid provided was not in a valid format")
 	}
 
-	c, err := manager.Client().GetServerConfiguration(ctx, details.UUID)
+	cfg := &server.Configuration{
+		Uuid:           getString(data, "uuid"),
+		Suspended:      false,
+		Invocation:     getString(data, "invocation"),
+		SkipEggScripts: getBoolean(data, "skip_egg_scripts"),
+		Build: environment.Limits{
+			MemoryLimit: getInt(data, "build", "memory"),
+			Swap:        getInt(data, "build", "swap"),
+			IoWeight:    uint16(getInt(data, "build", "io")),
+			CpuLimit:    getInt(data, "build", "cpu"),
+			DiskSpace:   getInt(data, "build", "disk"),
+			Threads:     getString(data, "build", "threads"),
+		},
+		CrashDetectionEnabled: true,
+	}
+
+	cfg.Allocations.DefaultMapping.Ip = getString(data, "allocations", "default", "ip")
+	cfg.Allocations.DefaultMapping.Port = int(getInt(data, "allocations", "default", "port"))
+
+	// Unmarshal the environment variables from the request into the server struct.
+	if b, _, _, err := jsonparser.Get(data, "environment"); err != nil {
+		return nil, errors.WithStackIf(err)
+	} else {
+		cfg.EnvVars = make(environment.Variables)
+		if err := json.Unmarshal(b, &cfg.EnvVars); err != nil {
+			return nil, errors.WrapIf(err, "installer: could not unmarshal environment variables for server")
+		}
+	}
+
+	// Unmarshal the allocation mappings from the request into the server struct.
+	if b, _, _, err := jsonparser.Get(data, "allocations", "mappings"); err != nil {
+		return nil, errors.WithStackIf(err)
+	} else {
+		cfg.Allocations.Mappings = make(map[string][]int)
+		if err := json.Unmarshal(b, &cfg.Allocations.Mappings); err != nil {
+			return nil, errors.Wrap(err, "installer: could not unmarshal allocation mappings")
+		}
+	}
+
+	cfg.Container.Image = getString(data, "container", "image")
+
+	c, err := manager.Client().GetServerConfiguration(ctx, cfg.Uuid)
 	if err != nil {
 		if !remote.IsRequestError(err) {
 			return nil, errors.WithStackIf(err)
@@ -41,11 +79,35 @@ func New(ctx context.Context, manager *server.Manager, details ServerDetails) (*
 	if err != nil {
 		return nil, errors.WrapIf(err, "installer: could not init server instance")
 	}
-	i := Installer{server: s, StartOnCompletion: details.StartOnCompletion}
+	return &Installer{server: s}, nil
-	return &i, nil
+}
+
+// Uuid returns the UUID associated with this installer instance.
+func (i *Installer) Uuid() string {
+	return i.server.Id()
 }
 
 // Server returns the server instance.
 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
+}

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,7 +2,7 @@ package parser
 
 import (
 	"bytes"
-	"io"
+	"io/ioutil"
 	"os"
 	"regexp"
 	"strconv"
@@ -38,29 +38,29 @@ 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, 0o644)
+	file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0644)
 	if err != nil {
 		return nil, err
 	}
 	defer file.Close()
 
-	return io.ReadAll(file)
+	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
@@ -97,21 +97,22 @@ 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
+		} else {
-		}
+			if err = v.SetAtPathway(parsed, v.Match, []byte(value)); err != nil {
+				if errors.Is(err, gabs.ErrNotFound) {
+					continue
+				}
 
-		if err := v.SetAtPathway(parsed, v.Match, value); err != nil {
+				return nil, errors.WithMessage(err, "unable to set config value at pathway: "+v.Match)
-			if errors.Is(err, gabs.ErrNotFound) {
-				continue
 			}
-			return nil, errors.WithMessage(err, "unable to set config value at pathway: "+v.Match)
 		}
 	}
 
@@ -131,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 {
-		_, err = c.SetP(value, path)
+		// 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
 	}
 
@@ -192,34 +196,32 @@ func setValueAtPath(c *gabs.Container, path string, value interface{}) error {
 
 // Sets the value at a specific pathway, but checks if we were looking for a specific
 // 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

@@ -3,6 +3,7 @@ package parser
 import (
 	"bufio"
 	"encoding/json"
+	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strconv"
@@ -14,10 +15,9 @@ import (
 	"github.com/buger/jsonparser"
 	"github.com/icza/dyno"
 	"github.com/magiconair/properties"
+	"github.com/pterodactyl/wings/config"
 	"gopkg.in/ini.v1"
 	"gopkg.in/yaml.v2"
-
-	"github.com/pterodactyl/wings/config"
 )
 
 // The file parsing options that are available for a server configuration file.
@@ -56,22 +56,17 @@ func (cv *ReplaceValue) Type() jsonparser.ValueType {
 // handle casting the UTF-8 sequence into the expected value, switching something
 // 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 {
-		str, err := jsonparser.ParseString(cv.value)
+			return "<nil>"
-		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>"
 	}
+	str, err := jsonparser.ParseString(cv.value)
+	if err != nil {
+		panic(errors.Wrap(err, "parser: could not parse value"))
+	}
+	return str
 }
 
 type ConfigurationParser string
@@ -211,7 +206,7 @@ func (f *ConfigurationFile) Parse(path string, internal bool) error {
 		}
 
 		b := strings.TrimSuffix(path, filepath.Base(path))
-		if err := os.MkdirAll(b, 0o755); err != nil {
+		if err := os.MkdirAll(b, 0755); err != nil {
 			return errors.WithMessage(err, "failed to create base directory for missing configuration file")
 		} else {
 			if _, err := os.Create(path); err != nil {
@@ -228,7 +223,7 @@ func (f *ConfigurationFile) Parse(path string, internal bool) error {
 // Parses an xml file.
 func (f *ConfigurationFile) parseXmlFile(path string) error {
 	doc := etree.NewDocument()
-	file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0o644)
+	file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0644)
 	if err != nil {
 		return err
 	}
@@ -321,7 +316,7 @@ func (f *ConfigurationFile) parseIniFile(path string) error {
 	// Ini package can't handle a non-existent file, so handle that automatically here
 	// by creating it if not exists. Then, immediately close the file since we will use
 	// other methods to write the new contents.
-	file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0o644)
+	file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0644)
 	if err != nil {
 		return err
 	}
@@ -333,29 +328,7 @@ func (f *ConfigurationFile) parseIniFile(path string) error {
 	}
 
 	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 {
@@ -408,7 +381,7 @@ func (f *ConfigurationFile) parseJsonFile(path string) error {
 	}
 
 	output := []byte(data.StringIndent("", "    "))
-	return os.WriteFile(path, output, 0o644)
+	return ioutil.WriteFile(path, output, 0644)
 }
 
 // Parses a yaml file and updates any matching key/value pairs before persisting
@@ -445,14 +418,14 @@ func (f *ConfigurationFile) parseYamlFile(path string) error {
 		return err
 	}
 
-	return os.WriteFile(path, marshaled, 0o644)
+	return ioutil.WriteFile(path, marshaled, 0644)
 }
 
 // Parses a text file using basic find and replace. This is a highly inefficient method of
 // scanning a file and performing a replacement. You should attempt to use anything other
 // than this function where possible.
 func (f *ConfigurationFile) parseTextFile(path string) error {
-	input, err := os.ReadFile(path)
+	input, err := ioutil.ReadFile(path)
 	if err != nil {
 		return err
 	}
@@ -470,7 +443,7 @@ func (f *ConfigurationFile) parseTextFile(path string) error {
 		}
 	}
 
-	if err := os.WriteFile(path, []byte(strings.Join(lines, "\n")), 0o644); err != nil {
+	if err := ioutil.WriteFile(path, []byte(strings.Join(lines, "\n")), 0644); err != nil {
 		return err
 	}
 
@@ -566,7 +539,7 @@ func (f *ConfigurationFile) parsePropertiesFile(path string) error {
 	}
 
 	// Open the file for writing.
-	w, err := os.OpenFile(path, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0o644)
+	w, err := os.OpenFile(path, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644)
 	if err != nil {
 		return err
 	}

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

@@ -6,6 +6,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"io/ioutil"
 	"net/http"
 	"strconv"
 	"strings"
@@ -14,7 +15,6 @@ import (
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/cenkalti/backoff/v4"
-
 	"github.com/pterodactyl/wings/system"
 )
 
@@ -118,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
@@ -170,7 +170,7 @@ func (c *client) request(ctx context.Context, method, path string, body io.Reade
 // 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
@@ -223,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

@@ -12,11 +12,11 @@ import (
 func createTestClient(h http.HandlerFunc) (*client, *httptest.Server) {
 	s := httptest.NewServer(h)
 	c := &client{
-		httpClient:  s.Client(),
+		httpClient: s.Client(),
-		baseUrl:     s.URL,
+		baseUrl:    s.URL,
 		maxAttempts: 1,
-		tokenId:     "testid",
+		tokenId:  "testid",
-		token:       "testtoken",
+		token:    "testtoken",
 	}
 	return c, s
 }
@@ -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/types.go

@@ -6,7 +6,6 @@ import (
 	"strings"
 
 	"github.com/apex/log"
-
 	"github.com/pterodactyl/wings/parser"
 )
 
@@ -33,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

router/downloader/downloader.go

@@ -2,26 +2,26 @@ package downloader
 
 import (
 	"context"
+	"emperror.dev/errors"
 	"encoding/json"
 	"fmt"
+	"github.com/google/uuid"
+	"github.com/pterodactyl/wings/server"
 	"io"
 	"net"
 	"net/http"
 	"net/url"
 	"path/filepath"
+	"regexp"
+	"strconv"
 	"strings"
 	"sync"
 	"time"
-
-	"emperror.dev/errors"
-	"github.com/google/uuid"
-
-	"github.com/pterodactyl/wings/server"
 )
 
 var client = &http.Client{
 	Timeout: time.Hour * 12,
-	// Disallow any redirect on an HTTP call. This is a security requirement: do not modify
+	// Disallow any redirect on a HTTP call. This is a security requirement: do not modify
 	// this logic without first ensuring that the new target location IS NOT within the current
 	// instance's local network.
 	//
@@ -36,14 +36,18 @@ var client = &http.Client{
 }
 
 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"),
@@ -56,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
@@ -75,8 +77,8 @@ func (c *Counter) Write(p []byte) (int, error) {
 }
 
 type DownloadRequest struct {
-	Directory string
 	URL       *url.URL
+	Directory string
 }
 
 type Download struct {
@@ -88,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{
@@ -100,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)
 			}
 		}
@@ -115,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)
@@ -132,7 +134,7 @@ func (dl Download) MarshalJSON() ([]byte, error) {
 	})
 }
 
-// Execute executes a given download for the server and begins writing the file to the disk. Once
+// Executes a given download for the server and begins writing the file to the disk. Once
 // completed the download will be removed from the cache.
 func (dl *Download) Execute() error {
 	ctx, cancel := context.WithTimeout(context.Background(), time.Hour*12)
@@ -183,7 +185,7 @@ func (dl *Download) Execute() error {
 	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 {
@@ -192,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()
@@ -230,19 +232,15 @@ func (dl *Download) isExternalNetwork(ctx context.Context) error {
 
 	// This cluster-fuck of math and integer shit converts an integer IP into a proper IPv4.
 	// For example: 16843009 would become 1.1.1.1
-	//if i, err := strconv.ParseInt(host, 10, 64); err == nil {
+	if i, err := strconv.ParseInt(host, 10, 64); err == nil {
-	//	host = strconv.FormatInt((i>>24)&0xFF, 10) + "." + strconv.FormatInt((i>>16)&0xFF, 10) + "." + strconv.FormatInt((i>>8)&0xFF, 10) + "." + strconv.FormatInt(i&0xFF, 10)
+		host = strconv.FormatInt((i>>24)&0xFF, 10) + "." + strconv.FormatInt((i>>16)&0xFF, 10) + "." + strconv.FormatInt((i>>8)&0xFF, 10) + "." + strconv.FormatInt(i&0xFF, 10)
-	//}
+	}
 
-	if _, _, err := net.SplitHostPort(host); err != nil {
+	if !ipMatchRegex.MatchString(host) {
-		if !strings.Contains(err.Error(), "missing port in address") {
+		if dl.req.URL.Scheme == "https" {
-			return errors.WithStack(err)
+			host = host + ":443"
-		}
+		} else {
-		switch dl.req.URL.Scheme {
+			host = host + ":80"
-		case "http":
-			host += ":80"
-		case "https":
-			host += ":443"
 		}
 	}
 
@@ -252,11 +250,7 @@ func (dl *Download) isExternalNetwork(ctx context.Context) error {
 	}
 	_ = c.Close()
 
-	ipStr, _, err := net.SplitHostPort(c.RemoteAddr().String())
+	ip := net.ParseIP(ipMatchRegex.ReplaceAllString(c.RemoteAddr().String(), ""))
-	if err != nil {
-		return errors.WithStack(err)
-	}
-	ip := net.ParseIP(ipStr)
 	if ip == nil {
 		return errors.WithStack(ErrInvalidIPAddress)
 	}
@@ -271,7 +265,7 @@ func (dl *Download) isExternalNetwork(ctx context.Context) error {
 	return nil
 }
 
-// Downloader represents a global downloader that keeps track of all currently processing downloads
+// Defines a global downloader struct that keeps track of all currently processing downloads
 // for the machine.
 type Downloader struct {
 	mu            sync.RWMutex
@@ -279,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 {
@@ -293,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()
@@ -303,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

@@ -10,7 +10,6 @@ import (
 	"github.com/apex/log"
 	"github.com/gin-gonic/gin"
 	"github.com/google/uuid"
-
 	"github.com/pterodactyl/wings/server"
 	"github.com/pterodactyl/wings/server/filesystem"
 )

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

@@ -3,16 +3,17 @@ 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"
@@ -63,7 +64,7 @@ func (re *RequestError) Abort(c *gin.Context, status int) {
 	// 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())
+			event = event.WithField("server_id", s.Id())
 		}
 	}
 
@@ -218,29 +219,19 @@ func CaptureErrors() gin.HandlerFunc {
 // SetAccessControlHeaders sets the access request control headers on all of
 // 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
@@ -273,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()
 	}
@@ -363,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/router.go

@@ -3,18 +3,18 @@ package router
 import (
 	"github.com/apex/log"
 	"github.com/gin-gonic/gin"
-
 	"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())
+	router.Use(middleware.Metrics())
 	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.
@@ -63,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)
@@ -70,7 +71,6 @@ 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

router/router_download.go

@@ -8,7 +8,6 @@ import (
 	"strconv"
 
 	"github.com/gin-gonic/gin"
-
 	"github.com/pterodactyl/wings/router/middleware"
 	"github.com/pterodactyl/wings/router/tokens"
 	"github.com/pterodactyl/wings/server/backup"

router/router_server.go

@@ -1,6 +1,7 @@
 package router
 
 import (
+	"bytes"
 	"context"
 	"net/http"
 	"os"
@@ -101,7 +102,7 @@ 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 {
 		NewServerError(err, s).Abort(c)
 		return
 	} else if !running {
@@ -128,18 +129,21 @@ 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{}
-		WithError(c, err)
+	buf.ReadFrom(c.Request.Body)
-	} else {
+
-		c.Status(http.StatusNoContent)
+	if err := s.UpdateDataStructure(buf.Bytes()); err != nil {
+		NewServerError(err, s).Abort(c)
+		return
 	}
+
+	s.SyncWithEnvironment()
+
+	c.Status(http.StatusNoContent)
 }
 
 // Performs a server installation in a background thread.
@@ -188,12 +192,10 @@ func deleteServer(c *gin.Context) {
 	// as well.
 	s.CtxCancel()
 	s.Events().Destroy()
-	s.LogSink().Destroy()
-	s.InstallSink().Destroy()
 	s.Websockets().CancelAll()
 
 	// 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()
 	}
 
@@ -218,7 +220,7 @@ func deleteServer(c *gin.Context) {
 	}(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.

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,13 +16,12 @@ import (
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/gin-gonic/gin"
-	"golang.org/x/sync/errgroup"
-
 	"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.
@@ -246,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()),
 	})
 }
 
@@ -254,20 +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"`
+		Directory string `binding:"required,omitempty" json:"directory"`
 	}
 	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 {
@@ -285,7 +277,7 @@ func postServerPullRemoteFile(c *gin.Context) {
 		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.",
 		})
@@ -293,11 +285,11 @@ func postServerPullRemoteFile(c *gin.Context) {
 	}
 
 	dl := downloader.New(s, downloader.DownloadRequest{
-		Directory: data.RootPath,
 		URL:       u,
+		Directory: data.Directory,
 	})
 
-	// Execute this pull in a separate thread since it may take a long time to complete.
+	// 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 {

router/router_server_ws.go

@@ -7,31 +7,14 @@ import (
 
 	"github.com/gin-gonic/gin"
 	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"))
-
-	// 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)
 	if err != nil {
 		NewServerError(err, s).Abort(c)
@@ -39,37 +22,50 @@ func getServerWebsocket(c *gin.Context) {
 	}
 	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
+			select {
-	// be left hanging in the background.
+			case <-ctx.Done():
-	go func() {
+				handler.Connection.WriteControl(ws.CloseMessage, ws.FormatCloseMessage(ws.CloseGoingAway, "server deleted"), time.Now().Add(time.Second*5))
-		select {
+				// A break right here without defining the specific loop would only break the select
-		case <-ctx.Done():
+				// and not actually break the for loop, thus causing this routine to stick around forever.
-			break
+				break ListenerLoop
-		case <-s.Context().Done():
+			}
-			handler.Connection.WriteControl(ws.CloseMessage, ws.FormatCloseMessage(ws.CloseGoingAway, "server deleted"), time.Now().Add(time.Second*5))
-			break
 		}
-	}()
+	}(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,7 +78,7 @@ 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)
 			}
 		}(j)

router/router_system.go

@@ -1,14 +1,12 @@
 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"
@@ -43,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{
@@ -70,27 +65,14 @@ 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(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)
 
@@ -103,17 +85,15 @@ func postUpdateConfiguration(c *gin.Context) {
 	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 {

router/router_transfer.go

@@ -5,6 +5,7 @@ import (
 	"context"
 	"crypto/sha256"
 	"encoding/hex"
+	"encoding/json"
 	"fmt"
 	"io"
 	"net/http"
@@ -22,7 +23,6 @@ import (
 	"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"
@@ -46,10 +46,10 @@ type downloadProgress struct {
 
 // Data passed over to initiate a server transfer.
 type serverTransferRequest struct {
-	ServerID string                  `binding:"required" json:"server_id"`
+	ServerID string          `binding:"required" json:"server_id"`
-	URL      string                  `binding:"required" json:"url"`
+	URL      string          `binding:"required" json:"url"`
-	Token    string                  `binding:"required" json:"token"`
+	Token    string          `binding:"required" json:"token"`
-	Server   installer.ServerDetails `json:"server"`
+	Server   json.RawMessage `json:"server"`
 }
 
 func getArchivePath(sID string) string {
@@ -75,14 +75,14 @@ func getServerArchive(c *gin.Context) {
 	}
 
 	s := ExtractServer(c)
-	if token.Subject != s.ID() {
+	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())
+	archivePath := getArchivePath(s.Id())
 
 	// Stat the archive file.
 	st, err := os.Lstat(archivePath)
@@ -123,7 +123,7 @@ func getServerArchive(c *gin.Context) {
 	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-Disposition", "attachment; filename="+strconv.Quote(s.Id()+".tar.gz"))
 	c.Header("Content-Type", "application/octet-stream")
 
 	_, _ = bufio.NewReader(f).WriteTo(c.Writer)
@@ -134,7 +134,7 @@ func postServerArchive(c *gin.Context) {
 	manager := middleware.ExtractManager(c)
 
 	go func(s *server.Server) {
-		l := log.WithField("server", s.ID())
+		l := log.WithField("server", s.Id())
 
 		// This function automatically adds the Source Node prefix and Timestamp to the log
 		// output before sending it over the websocket.
@@ -157,7 +157,7 @@ func postServerArchive(c *gin.Context) {
 			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 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")
@@ -190,7 +190,7 @@ func postServerArchive(c *gin.Context) {
 		}
 
 		// Attempt to get an archive of the server.
-		if err := a.Create(getArchivePath(s.ID())); err != nil {
+		if err := a.Create(getArchivePath(s.Id())); err != nil {
 			sendTransferLog("An error occurred while archiving the server: " + err.Error())
 			l.WithField("error", err).Error("failed to get transfer archive for server")
 			return
@@ -199,7 +199,7 @@ func postServerArchive(c *gin.Context) {
 		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 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")
@@ -360,7 +360,7 @@ func postTransfer(c *gin.Context) {
 				sendTransferLog("Server transfer failed, check Wings logs for additional information.")
 				s.Events().Publish(server.TransferStatusEvent, "failure")
 				manager.Remove(func(match *server.Server) bool {
-					return match.ID() == s.ID()
+					return match.Id() == s.Id()
 				})
 
 				// If the transfer status was successful but the request failed, act like the transfer failed.

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/websocket.go

@@ -2,12 +2,11 @@ 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

router/websocket/listeners.go

@@ -2,48 +2,21 @@ package websocket
 
 import (
 	"context"
-	"encoding/json"
-	"sync"
-	"time"
-
-	"emperror.dev/errors"
 	"github.com/pterodactyl/wings/events"
 	"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 {
@@ -54,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})
 				}
 			}
 		}
@@ -77,88 +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 events.Event)
-	logOutput := make(chan []byte)
-	installOutput := make(chan []byte)
-	h.server.Events().On(eventChan, e...)
-	h.server.LogSink().On(logOutput)
-	h.server.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 e := <-logOutput:
+			for _, evt := range e {
-			sendErr := h.SendJson(Message{Event: server.ConsoleOutputEvent, Args: []string{string(e)}})
+				h.server.Events().Off(evt, &callback)
-			if sendErr == nil {
-				continue
 			}
-			onError(server.ConsoleOutputEvent, sendErr)
-		case e := <-installOutput:
-			sendErr := h.SendJson(Message{Event: server.InstallOutputEvent, Args: []string{string(e)}})
-			if sendErr == nil {
-				continue
-			}
-			onError(server.InstallOutputEvent, sendErr)
-		case e := <-eventChan:
-			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)}
-				}
-			}
-
-			if sendErr == nil {
-				sendErr = h.SendJson(message)
-				if sendErr == nil {
-					continue
-				}
-			}
-			onError(message.Event, sendErr)
 		}
-		break
+	}(ctx)
-	}
-
-	h.server.Events().Off(eventChan, e...)
-	h.server.InstallSink().Off(logOutput)
-	h.server.InstallSink().Off(installOutput)
-	close(eventChan)
-	close(logOutput)
-	close(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,24 +2,22 @@ package websocket
 
 import (
 	"context"
+	"emperror.dev/errors"
 	"encoding/json"
 	"fmt"
-	"net/http"
-	"strings"
-	"sync"
-	"time"
-
-	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/gbrlsnchs/jwt/v3"
 	"github.com/google/uuid"
 	"github.com/gorilla/websocket"
-
 	"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 (
@@ -57,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
 	}
 
@@ -75,7 +74,7 @@ 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) (*Handler, error) {
 	upgrader := websocket.Upgrader{
 		// Ensure that the websocket request is originating from the Panel itself,
@@ -116,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 {
@@ -186,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 {
@@ -205,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 {
@@ -242,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())
@@ -252,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()
@@ -260,15 +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.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{
@@ -284,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
 			}
 
@@ -296,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.
@@ -306,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},
 			})
@@ -326,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)},
 					})
@@ -356,7 +354,7 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
 			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},
 				})
@@ -368,9 +366,7 @@ func (h *Handler) HandleInbound(ctx context.Context, m Message) error {
 		}
 	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
 			}
 
@@ -380,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},
 				})
@@ -391,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)},
 			})

rpm/ptero-wings.spec

@@ -1,121 +0,0 @@
-Name:       ptero-wings
-Version:    1.5.3
-Release:    1%{?dist}
-Summary:    The server control plane for Pterodactyl Panel. Written from the ground-up with security, speed, and stability in mind.
-BuildArch:  x86_64
-License:    MIT
-URL:        https://github.com/pterodactyl/wings
-Source0:    https://github.com/pterodactyl/wings/releases/download/v%{version}/wings_linux_amd64
-
-%if 0%{?rhel} && 0%{?rhel} <= 8
-BuildRequires:  systemd
-%else
-BuildRequires:  systemd-rpm-macros
-%endif
-
-
-%description
-Wings is Pterodactyl's server control plane, built for the rapidly
-changing gaming industry and designed to be highly performant and
-secure. Wings provides an HTTP API allowing you to interface directly
-with running server instances, fetch server logs, generate backups,
-and control all aspects of the server lifecycle.
-
-In addition, Wings ships with a built-in SFTP server allowing your
-system to remain free of Pterodactyl specific dependencies, and
-allowing users to authenticate with the same credentials they would
-normally use to access the Panel.
-
-%prep
-
-%build
-#nothing required
-
-%install
-mkdir -p %{buildroot}%{_bindir}
-mkdir -p %{buildroot}%{_unitdir}
-cp %{_sourcedir}/wings_linux_amd64 %{buildroot}%{_bindir}/wings
-
-cat > %{buildroot}%{_unitdir}/wings.service << EOF
-[Unit]
-Description=Pterodactyl Wings Daemon
-After=docker.service
-Requires=docker.service
-PartOf=docker.service
-StartLimitIntervalSec=600
-
-[Service]
-WorkingDirectory=/etc/pterodactyl
-ExecStart=/usr/bin/wings
-ExecReload=/bin/kill -HUP $MAINPID
-Restart=on-failure
-StartLimitInterval=180
-StartLimitBurst=30
-RestartSec=5s
-
-[Install]
-WantedBy=multi-user.target
-EOF
-
-%files
-%attr(0755, root, root) %{_prefix}/bin/wings
-%attr(0644, root, root) %{_unitdir}/wings.service
-
-%post
-
-# Reload systemd
-systemctl daemon-reload
-
-# Create the required directory structure
-mkdir -p /etc/pterodactyl
-mkdir -p /var/lib/pterodactyl/{archives,backups,volumes}
-mkdir -p /var/log/pterodactyl/install
-
-%preun
-
-systemctl is-active %{name} >/dev/null 2>&1
-if [ $? -eq 0 ]; then
-    systemctl stop %{name}
-fi
-
-systemctl is-enabled %{name} >/dev/null 2>&1
-if [ $? -eq 0 ]; then
-    systemctl disable %{name}
-fi
-
-%postun
-rm -rf /var/log/pterodactyl
-
-%verifyscript
-
-wings --version
-
-%changelog
-* Wed Oct 27 2021 Capitol Hosting Solutions Systems Engineering <syseng@chs.gg> - 1.5.3-1
-- specfile by Capitol Hosting Solutions, Upstream by Pterodactyl
-- Rebased for https://github.com/pterodactyl/wings/releases/tag/v1.5.3
-- Fixes improper event registration and error handling during socket authentication that would cause the incorrect error message to be returned to the client, or no error in some scenarios. Event registration is now delayed until the socket is fully authenticated to ensure needless listeners are not registed.
-- Fixes dollar signs always being evaluated as environment variables with no way to escape them. They can now be escaped as $$ which will transform into a single dollar sign.
-- A websocket connection to a server will be closed by Wings if there is a send error encountered and the client will be left to handle reconnections, rather than simply logging the error and continuing to listen for new events.
-
-* Sun Sep 12 2021 Capitol Hosting Solutions Systems Engineering <syseng@chs.gg> - 1.5.0-1
-- specfile by Capitol Hosting Solutions, Upstream by Pterodactyl
-- Rebased for https://github.com/pterodactyl/wings/releases/tag/v1.5.0
-- Fixes a race condition when setting the application name in the console output for a server.
-- Fixes a server being reinstalled causing the file_denylist parameter for an Egg to be ignored until Wings is restarted.
-- Fixes YAML file parser not correctly setting boolean values.
-- Fixes potential issue where the underlying websocket connection is closed but the parent request context is not yet canceled causing a write over a closed connection.
-- Fixes race condition when closing all active websocket connections when a server is deleted.
-- Fixes logic to determine if a server's context is closed out and send a websocket close message to connected clients. Previously this fired off whenever the request itself was closed, and not when the server context was closed.
-- Exposes 8080 in the wings Dockerfile to better support reverse proxy tools.
-- Releases are now built using Go 1.17 — the minimum version required to build Wings remains Go 1.16.
-- Simplifed the logic powering server updates to only pull information from the Panel rather than trying to accept updated values. All parts of Wings needing the most up-to-date server details should call Server#Sync() to fetch the latest stored build information.
-- Installer#New() no longer requires passing all of the server data as a byte slice, rather a new Installer#ServerDetails struct is exposed which can be passed and accepts a UUID and if the server should be started after the installer finishes.
-- Removes complicated (and unused) logic during the server installation process that was a hold-over from legacy Wings architectures.
-- Removes the PATCH /api/servers/:server endpoint — if you were previously using this API call it should be replaced with POST /api/servers/:server/sync.
-
-* Wed Aug 25 2021 Capitol Hosting Solutions Systems Engineering <syseng@chs.gg> - 1.4.7-1
-- specfile by Capitol Hosting Solutions, Upstream by Pterodactyl
-- Rebased for https://github.com/pterodactyl/wings/releases/tag/v1.4.7
-- SFTP access is now properly denied if a server is suspended.
-- Correctly uses start_on_completion and crash_detection_enabled for servers.

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"
@@ -48,7 +46,7 @@ func (s *Server) getServerwideIgnoredFiles() (string, error) {
 		// Don't read a symlinked ignore file, or a file larger than 32KiB in size.
 		return "", nil
 	}
-	b, err := io.ReadAll(f)
+	b, err := ioutil.ReadAll(f)
 	if err != nil {
 		return "", err
 	}
@@ -62,7 +60,7 @@ 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
 		}
@@ -79,7 +77,7 @@ func (s *Server) Backup(b backup.BackupInterface) error {
 			s.Log().WithField("backup", b.Identifier()).Info("notified panel of failed backup state")
 		}
 
-		s.Events().Publish(BackupCompletedEvent+":"+b.Identifier(), map[string]interface{}{
+		_ = s.Events().PublishJson(BackupCompletedEvent+":"+b.Identifier(), map[string]interface{}{
 			"uuid":          b.Identifier(),
 			"is_successful": false,
 			"checksum":      "",
@@ -103,7 +101,7 @@ func (s *Server) Backup(b backup.BackupInterface) error {
 
 	// Emit an event over the socket so we can update the backup in realtime on
 	// 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,
@@ -152,15 +150,9 @@ func (s *Server) RestoreBackup(b backup.BackupInterface, reader io.ReadCloser) (
 	// Attempt to restore the backup to the server by running through each entry
 	// 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, r io.Reader, mode fs.FileMode, atime, mtime time.Time) error {
+	err = b.Restore(s.Context(), reader, func(file string, r io.Reader) error {
 		s.Events().Publish(DaemonMessageEvent, "(restoring): "+file)
-		if err := s.Filesystem().Writefile(file, r); err != nil {
+		return s.Filesystem().Writefile(file, r)
-			return err
-		}
-		if err := s.Filesystem().Chmod(file, mode); err != nil {
-			return err
-		}
-		return s.Filesystem().Chtimes(file, atime, mtime)
 	})
 
 	return errors.WithStackIf(err)

server/backup/backup.go

@@ -5,17 +5,14 @@ import (
 	"crypto/sha1"
 	"encoding/hex"
 	"io"
-	"io/fs"
 	"os"
 	"path"
-	"time"
 
 	"emperror.dev/errors"
 	"github.com/apex/log"
-	"golang.org/x/sync/errgroup"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/remote"
+	"golang.org/x/sync/errgroup"
 )
 
 type AdapterType string
@@ -27,7 +24,7 @@ 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, r io.Reader, mode fs.FileMode, atime, mtime time.Time) error
+type RestoreCallback func(file string, r io.Reader) error
 
 // noinspection GoNameStartsWithPackageName
 type BackupInterface interface {

server/backup/backup_local.go

@@ -6,10 +6,10 @@ import (
 	"os"
 
 	"emperror.dev/errors"
-	"github.com/mholt/archiver/v3"
-
-	"github.com/pterodactyl/wings/remote"
 	"github.com/pterodactyl/wings/server/filesystem"
+
+	"github.com/mholt/archiver/v3"
+	"github.com/pterodactyl/wings/remote"
 )
 
 type LocalBackup struct {
@@ -85,10 +85,12 @@ func (b *LocalBackup) Restore(ctx context.Context, _ io.Reader, callback Restore
 			// Stop walking if the context is canceled.
 			return archiver.ErrStopWalk
 		default:
-			if f.IsDir() {
+			{
-				return nil
+				if f.IsDir() {
+					return nil
+				}
+				return callback(filesystem.ExtractNameFromArchive(f), f)
 			}
-			return callback(filesystem.ExtractNameFromArchive(f), f, f.Mode(), f.ModTime(), f.ModTime())
 		}
 	})
 }

server/backup/backup_s3.go

@@ -13,11 +13,9 @@ import (
 
 	"emperror.dev/errors"
 	"github.com/cenkalti/backoff/v4"
-
 	"github.com/pterodactyl/wings/server/filesystem"
 
 	"github.com/juju/ratelimit"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/remote"
 )
@@ -116,7 +114,7 @@ func (s *S3Backup) Restore(ctx context.Context, r io.Reader, callback RestoreCal
 			return err
 		}
 		if header.Typeflag == tar.TypeReg {
-			if err := callback(header.Name, tr, header.FileInfo().Mode(), header.AccessTime, header.ModTime); err != nil {
+			if err := callback(header.Name, tr); err != nil {
 				return err
 			}
 		}

server/configuration.go

@@ -33,7 +33,7 @@ type Configuration struct {
 
 	// By default this is false, however if selected within the Panel while installing or re-installing a
 	// server, specific installation scripts will be skipped for the server process.
-	SkipEggScripts bool `json:"skip_egg_scripts"`
+	SkipEggScripts bool `default:"false" json:"skip_egg_scripts"`
 
 	// An array of environment variables that should be passed along to the running
 	// server process.
@@ -41,7 +41,7 @@ type Configuration struct {
 
 	Allocations           environment.Allocations `json:"allocations"`
 	Build                 environment.Limits      `json:"build"`
-	CrashDetectionEnabled bool                    `json:"crash_detection_enabled"`
+	CrashDetectionEnabled bool                    `default:"true" json:"enabled" yaml:"enabled"`
 	Mounts                []Mount                 `json:"mounts"`
 	Egg                   EggConfiguration        `json:"egg,omitempty"`
 
@@ -54,30 +54,34 @@ type Configuration struct {
 func (s *Server) Config() *Configuration {
 	s.cfg.mu.RLock()
 	defer s.cfg.mu.RUnlock()
+
 	return &s.cfg
 }
 
-// DiskSpace returns the amount of disk space available to a server in bytes.
+// Returns the amount of disk space available to a server in bytes.
 func (s *Server) DiskSpace() int64 {
 	s.cfg.mu.RLock()
 	defer s.cfg.mu.RUnlock()
+
 	return s.cfg.Build.DiskSpace * 1024.0 * 1024.0
 }
 
 func (s *Server) MemoryLimit() int64 {
 	s.cfg.mu.RLock()
 	defer s.cfg.mu.RUnlock()
+
 	return s.cfg.Build.MemoryLimit
 }
 
 func (c *Configuration) GetUuid() string {
 	c.mu.RLock()
 	defer c.mu.RUnlock()
+
 	return c.Uuid
 }
 
 func (c *Configuration) SetSuspended(s bool) {
 	c.mu.Lock()
-	defer c.mu.Unlock()
 	c.Suspended = s
+	c.mu.Unlock()
 }

server/console.go

@@ -9,7 +9,6 @@ import (
 
 	"emperror.dev/errors"
 	"github.com/mitchellh/colorstring"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/system"
 )
@@ -19,8 +18,6 @@ import (
 // a server.
 var appName string
 
-var appNameSync sync.Once
-
 var ErrTooMuchConsoleData = errors.New("console is outputting too much data")
 
 type ConsoleThrottler struct {
@@ -133,9 +130,9 @@ func (s *Server) Throttler() *ConsoleThrottler {
 // PublishConsoleOutputFromDaemon sends output to the server console formatted
 // to appear correctly as being sent from Wings.
 func (s *Server) PublishConsoleOutputFromDaemon(data string) {
-	appNameSync.Do(func() {
+	if appName == "" {
 		appName = config.Get().AppName
-	})
+	}
 	s.Events().Publish(
 		ConsoleOutputEvent,
 		colorstring.Color(fmt.Sprintf("[yellow][bold][%s Daemon]:[default] %s", appName, data)),

server/errors.go

@@ -12,7 +12,8 @@ var (
 	ErrServerIsRestoring    = errors.New("server is currently being restored")
 )
 
-type crashTooFrequent struct{}
+type crashTooFrequent struct {
+}
 
 func (e *crashTooFrequent) Error() string {
 	return "server has crashed too soon after the last detected crash"
@@ -24,7 +25,8 @@ func IsTooFrequentCrashError(err error) bool {
 	return ok
 }
 
-type serverDoesNotExist struct{}
+type serverDoesNotExist struct {
+}
 
 func (e *serverDoesNotExist) Error() string {
 	return "server does not exist on remote system"

server/events.go

@@ -21,12 +21,12 @@ const (
 )
 
 // Returns the server's emitter instance.
-func (s *Server) Events() *events.Bus {
+func (s *Server) Events() *events.EventBus {
 	s.emitterLock.Lock()
 	defer s.emitterLock.Unlock()
 
 	if s.emitter == nil {
-		s.emitter = events.NewBus()
+		s.emitter = events.New()
 	}
 
 	return s.emitter

server/filesystem/archive.go

@@ -3,7 +3,6 @@ package filesystem
 import (
 	"archive/tar"
 	"io"
-	"io/fs"
 	"os"
 	"path/filepath"
 	"strings"
@@ -14,9 +13,8 @@ import (
 	"github.com/juju/ratelimit"
 	"github.com/karrick/godirwalk"
 	"github.com/klauspost/pgzip"
-	ignore "github.com/sabhiram/go-gitignore"
-
 	"github.com/pterodactyl/wings/config"
+	"github.com/sabhiram/go-gitignore"
 )
 
 const memory = 4 * 1024
@@ -45,7 +43,7 @@ type Archive struct {
 // Create creates an archive at dst with all of the files defined in the
 // included files struct.
 func (a *Archive) Create(dst string) error {
-	f, err := os.OpenFile(dst, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o600)
+	f, err := os.OpenFile(dst, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
 	if err != nil {
 		return err
 	}
@@ -158,15 +156,9 @@ func (a *Archive) addToArchive(p string, rp string, w *tar.Writer) error {
 		return errors.WrapIff(err, "failed executing os.Lstat on '%s'", rp)
 	}
 
-	// Skip socket files as they are unsupported by archive/tar.
-	// Error will come from tar#FileInfoHeader: "archive/tar: sockets not supported"
-	if s.Mode()&fs.ModeSocket != 0 {
-		return nil
-	}
-
 	// Resolve the symlink target if the file is a symlink.
 	var target string
-	if s.Mode()&fs.ModeSymlink != 0 {
+	if s.Mode()&os.ModeSymlink != 0 {
 		// Read the target of the symlink. If there are any errors we will dump them out to
 		// the logs, but we're not going to stop the backup. There are far too many cases of
 		// symlinks causing all sorts of unnecessary pain in this process. Sucks to suck if
@@ -188,7 +180,7 @@ func (a *Archive) addToArchive(p string, rp string, w *tar.Writer) error {
 	}
 
 	// Fix the header name if the file is not a symlink.
-	if s.Mode()&fs.ModeSymlink == 0 {
+	if s.Mode()&os.ModeSymlink == 0 {
 		header.Name = rp
 	}
 

server/filesystem/compress.go

@@ -132,14 +132,6 @@ func (fs *Filesystem) DecompressFile(dir string, file string) error {
 		if err := fs.Writefile(p, f); err != nil {
 			return wrapError(err, source)
 		}
-		// Update the file permissions to the one set in the archive.
-		if err := fs.Chmod(p, f.Mode()); err != nil {
-			return wrapError(err, source)
-		}
-		// Update the file modification time to the one set in the archive.
-		if err := fs.Chtimes(p, f.ModTime(), f.ModTime()); err != nil {
-			return wrapError(err, source)
-		}
 		return nil
 	})
 	if err != nil {

server/filesystem/compress_test.go

@@ -1,7 +1,7 @@
 package filesystem
 
 import (
-	"os"
+	"io/ioutil"
 	"sync/atomic"
 	"testing"
 
@@ -19,10 +19,11 @@ func TestFilesystem_DecompressFile(t *testing.T) {
 	fs, rfs := NewFs()
 
 	g.Describe("Decompress", func() {
+
 		for _, ext := range []string{"zip", "rar", "tar", "tar.gz"} {
 			g.It("can decompress a "+ext, func() {
 				// copy the file to the new FS
-				c, err := os.ReadFile("./testdata/test." + ext)
+				c, err := ioutil.ReadFile("./testdata/test." + ext)
 				g.Assert(err).IsNil()
 				err = rfs.CreateServerFile("./test."+ext, c)
 				g.Assert(err).IsNil()

server/filesystem/filesystem.go

@@ -17,10 +17,9 @@ import (
 	"emperror.dev/errors"
 	"github.com/gabriel-vasile/mimetype"
 	"github.com/karrick/godirwalk"
-	ignore "github.com/sabhiram/go-gitignore"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/system"
+	ignore "github.com/sabhiram/go-gitignore"
 )
 
 type Filesystem struct {
@@ -85,7 +84,7 @@ func (fs *Filesystem) Touch(p string, flag int) (*os.File, error) {
 	if err != nil {
 		return nil, err
 	}
-	f, err := os.OpenFile(cleaned, flag, 0o644)
+	f, err := os.OpenFile(cleaned, flag, 0644)
 	if err == nil {
 		return f, nil
 	}
@@ -97,7 +96,7 @@ func (fs *Filesystem) Touch(p string, flag int) (*os.File, error) {
 	if _, err := os.Stat(filepath.Dir(cleaned)); errors.Is(err, os.ErrNotExist) {
 		// Create the path leading up to the file we're trying to create, setting the final perms
 		// on it as we go.
-		if err := os.MkdirAll(filepath.Dir(cleaned), 0o755); err != nil {
+		if err := os.MkdirAll(filepath.Dir(cleaned), 0755); err != nil {
 			return nil, errors.Wrap(err, "server/filesystem: touch: failed to create directory tree")
 		}
 		if err := fs.Chown(filepath.Dir(cleaned)); err != nil {
@@ -107,7 +106,7 @@ func (fs *Filesystem) Touch(p string, flag int) (*os.File, error) {
 	o := &fileOpener{}
 	// Try to open the file now that we have created the pathing necessary for it, and then
 	// Chown that file so that the permissions don't mess with things.
-	f, err = o.open(cleaned, flag, 0o644)
+	f, err = o.open(cleaned, flag, 0644)
 	if err != nil {
 		return nil, errors.Wrap(err, "server/filesystem: touch: failed to open file with wait")
 	}
@@ -181,7 +180,7 @@ func (fs *Filesystem) CreateDirectory(name string, p string) error {
 	if err != nil {
 		return err
 	}
-	return os.MkdirAll(cleaned, 0o755)
+	return os.MkdirAll(cleaned, 0755)
 }
 
 // Moves (or renames) a file or directory.
@@ -210,7 +209,7 @@ func (fs *Filesystem) Rename(from string, to string) error {
 	// Ensure that the directory we're moving into exists correctly on the system. Only do this if
 	// we're not at the root directory level.
 	if d != fs.Path() {
-		if mkerr := os.MkdirAll(d, 0o755); mkerr != nil {
+		if mkerr := os.MkdirAll(d, 0755); mkerr != nil {
 			return errors.WithMessage(mkerr, "failed to create directory structure for file rename")
 		}
 	}
@@ -377,7 +376,7 @@ func (fs *Filesystem) TruncateRootDirectory() error {
 	if err := os.RemoveAll(fs.Path()); err != nil {
 		return err
 	}
-	if err := os.Mkdir(fs.Path(), 0o755); err != nil {
+	if err := os.Mkdir(fs.Path(), 0755); err != nil {
 		return err
 	}
 	atomic.StoreInt64(&fs.diskUsed, 0)
@@ -485,7 +484,7 @@ func (fs *Filesystem) ListDirectory(p string) ([]Stat, error) {
 			defer wg.Done()
 
 			var m *mimetype.MIME
-			d := "inode/directory"
+			var d = "inode/directory"
 			if !f.IsDir() {
 				cleanedp := filepath.Join(cleaned, f.Name())
 				if f.Mode()&os.ModeSymlink != 0 {
@@ -528,20 +527,3 @@ func (fs *Filesystem) ListDirectory(p string) ([]Stat, error) {
 
 	return out, nil
 }
-
-func (fs *Filesystem) Chtimes(path string, atime, mtime time.Time) error {
-	cleaned, err := fs.SafePath(path)
-	if err != nil {
-		return err
-	}
-
-	if fs.isTest {
-		return nil
-	}
-
-	if err := os.Chtimes(cleaned, atime, mtime); err != nil {
-		return err
-	}
-
-	return nil
-}

server/filesystem/filesystem_test.go

@@ -3,6 +3,7 @@ package filesystem
 import (
 	"bytes"
 	"errors"
+	"io/ioutil"
 	"math/rand"
 	"os"
 	"path/filepath"
@@ -11,7 +12,6 @@ import (
 	"unicode/utf8"
 
 	. "github.com/franela/goblin"
-
 	"github.com/pterodactyl/wings/config"
 )
 
@@ -24,7 +24,7 @@ func NewFs() (*Filesystem, *rootFs) {
 		},
 	})
 
-	tmpDir, err := os.MkdirTemp(os.TempDir(), "pterodactyl")
+	tmpDir, err := ioutil.TempDir(os.TempDir(), "pterodactyl")
 	if err != nil {
 		panic(err)
 	}
@@ -70,7 +70,7 @@ func (rfs *rootFs) reset() {
 		}
 	}
 
-	if err := os.Mkdir(filepath.Join(rfs.root, "/server"), 0o755); err != nil {
+	if err := os.Mkdir(filepath.Join(rfs.root, "/server"), 0755); err != nil {
 		panic(err)
 	}
 }
@@ -98,7 +98,7 @@ func TestFilesystem_Readfile(t *testing.T) {
 		})
 
 		g.It("returns an error if the \"file\" is a directory", func() {
-			err := os.Mkdir(filepath.Join(rfs.root, "/server/test.txt"), 0o755)
+			err := os.Mkdir(filepath.Join(rfs.root, "/server/test.txt"), 0755)
 			g.Assert(err).IsNil()
 
 			err = fs.Readfile("test.txt", buf)
@@ -340,7 +340,7 @@ func TestFilesystem_Rename(t *testing.T) {
 		})
 
 		g.It("allows a folder to be renamed", func() {
-			err := os.Mkdir(filepath.Join(rfs.root, "/server/source_dir"), 0o755)
+			err := os.Mkdir(filepath.Join(rfs.root, "/server/source_dir"), 0755)
 			g.Assert(err).IsNil()
 
 			err = fs.Rename("source_dir", "target_dir")
@@ -404,7 +404,7 @@ func TestFilesystem_Copy(t *testing.T) {
 		})
 
 		g.It("should return an error if the source directory is outside the root", func() {
-			err := os.MkdirAll(filepath.Join(rfs.root, "/nested/in/dir"), 0o755)
+			err := os.MkdirAll(filepath.Join(rfs.root, "/nested/in/dir"), 0755)
 			g.Assert(err).IsNil()
 
 			err = rfs.CreateServerFileFromString("/../nested/in/dir/ext-source.txt", "external content")
@@ -420,7 +420,7 @@ func TestFilesystem_Copy(t *testing.T) {
 		})
 
 		g.It("should return an error if the source is a directory", func() {
-			err := os.Mkdir(filepath.Join(rfs.root, "/server/dir"), 0o755)
+			err := os.Mkdir(filepath.Join(rfs.root, "/server/dir"), 0755)
 			g.Assert(err).IsNil()
 
 			err = fs.Copy("dir")
@@ -465,7 +465,7 @@ func TestFilesystem_Copy(t *testing.T) {
 		})
 
 		g.It("should create a copy inside of a directory", func() {
-			err := os.MkdirAll(filepath.Join(rfs.root, "/server/nested/in/dir"), 0o755)
+			err := os.MkdirAll(filepath.Join(rfs.root, "/server/nested/in/dir"), 0755)
 			g.Assert(err).IsNil()
 
 			err = rfs.CreateServerFileFromString("nested/in/dir/source.txt", "test content")
@@ -544,7 +544,7 @@ func TestFilesystem_Delete(t *testing.T) {
 				"foo/bar/baz/source.txt",
 			}
 
-			err := os.MkdirAll(filepath.Join(rfs.root, "/server/foo/bar/baz"), 0o755)
+			err := os.MkdirAll(filepath.Join(rfs.root, "/server/foo/bar/baz"), 0755)
 			g.Assert(err).IsNil()
 
 			for _, s := range sources {

server/filesystem/path.go

@@ -115,8 +115,8 @@ func (fs *Filesystem) ParallelSafePath(paths []string) ([]string, error) {
 	var cleaned []string
 
 	// Simple locker function to avoid racy appends to the array of cleaned paths.
-	m := new(sync.Mutex)
+	var m = new(sync.Mutex)
-	push := func(c string) {
+	var push = func(c string) {
 		m.Lock()
 		cleaned = append(cleaned, c)
 		m.Unlock()

server/filesystem/path_test.go

@@ -107,7 +107,7 @@ func TestFilesystem_Blocks_Symlinks(t *testing.T) {
 		panic(err)
 	}
 
-	if err := os.Mkdir(filepath.Join(rfs.root, "/malicious_dir"), 0o777); err != nil {
+	if err := os.Mkdir(filepath.Join(rfs.root, "/malicious_dir"), 0777); err != nil {
 		panic(err)
 	}
 

server/install.go

@@ -17,7 +17,6 @@ import (
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/mount"
 	"github.com/docker/docker/client"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/environment"
 	"github.com/pterodactyl/wings/remote"
@@ -89,7 +88,7 @@ func (s *Server) Reinstall() error {
 
 // Internal installation function used to simplify reporting back to the Panel.
 func (s *Server) internalInstall() error {
-	script, err := s.client.GetInstallationScript(s.Context(), s.ID())
+	script, err := s.client.GetInstallationScript(s.Context(), s.Id())
 	if err != nil {
 		return err
 	}
@@ -157,7 +156,7 @@ func (s *Server) SetRestoring(state bool) {
 
 // Removes the installer container for the server.
 func (ip *InstallationProcess) RemoveContainer() error {
-	err := ip.client.ContainerRemove(ip.context, ip.Server.ID()+"_installer", types.ContainerRemoveOptions{
+	err := ip.client.ContainerRemove(ip.context, ip.Server.Id()+"_installer", types.ContainerRemoveOptions{
 		RemoveVolumes: true,
 		Force:         true,
 	})
@@ -207,7 +206,7 @@ func (ip *InstallationProcess) Run() error {
 
 // Returns the location of the temporary data for the installation process.
 func (ip *InstallationProcess) tempDir() string {
-	return filepath.Join(os.TempDir(), "pterodactyl/", ip.Server.ID())
+	return filepath.Join(os.TempDir(), "pterodactyl/", ip.Server.Id())
 }
 
 // Writes the installation script to a temporary file on the host machine so that it
@@ -215,11 +214,11 @@ func (ip *InstallationProcess) tempDir() string {
 func (ip *InstallationProcess) writeScriptToDisk() error {
 	// Make sure the temp directory root exists before trying to make a directory within it. The
 	// ioutil.TempDir call expects this base to exist, it won't create it for you.
-	if err := os.MkdirAll(ip.tempDir(), 0o700); err != nil {
+	if err := os.MkdirAll(ip.tempDir(), 0700); err != nil {
 		return errors.WithMessage(err, "could not create temporary directory for install process")
 	}
 
-	f, err := os.OpenFile(filepath.Join(ip.tempDir(), "install.sh"), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0o644)
+	f, err := os.OpenFile(filepath.Join(ip.tempDir(), "install.sh"), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644)
 	if err != nil {
 		return errors.WithMessage(err, "failed to write server installation script to disk before mount")
 	}
@@ -330,7 +329,7 @@ func (ip *InstallationProcess) BeforeExecute() error {
 
 // Returns the log path for the installation process.
 func (ip *InstallationProcess) GetLogPath() string {
-	return filepath.Join(config.Get().System.LogDirectory, "/install", ip.Server.ID()+".log")
+	return filepath.Join(config.Get().System.LogDirectory, "/install", ip.Server.Id()+".log")
 }
 
 // Cleans up after the execution of the installation process. This grabs the logs from the
@@ -350,7 +349,7 @@ func (ip *InstallationProcess) AfterExecute(containerId string) error {
 		return err
 	}
 
-	f, err := os.OpenFile(ip.GetLogPath(), os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o600)
+	f, err := os.OpenFile(ip.GetLogPath(), os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
 	if err != nil {
 		return err
 	}
@@ -366,7 +365,7 @@ func (ip *InstallationProcess) AfterExecute(containerId string) error {
 |
 | Details
 | ------------------------------
-  Server UUID:          {{.Server.ID}}
+  Server UUID:          {{.Server.Id}}
   Container Image:      {{.Script.ContainerImage}}
   Container Entrypoint: {{.Script.Entrypoint}}
 
@@ -470,7 +469,7 @@ func (ip *InstallationProcess) Execute() (string, error) {
 		}
 	}()
 
-	r, err := ip.client.ContainerCreate(ctx, conf, hostConf, nil, nil, ip.Server.ID()+"_installer")
+	r, err := ip.client.ContainerCreate(ctx, conf, hostConf, nil, nil, ip.Server.Id()+"_installer")
 	if err != nil {
 		return "", err
 	}
@@ -516,12 +515,16 @@ func (ip *InstallationProcess) StreamOutput(ctx context.Context, id string) erro
 		ShowStderr: true,
 		Follow:     true,
 	})
+
 	if err != nil {
 		return err
 	}
 	defer reader.Close()
 
-	err = system.ScanReader(reader, ip.Server.InstallSink().Push)
+	evts := ip.Server.Events()
+	err = system.ScanReader(reader, func(line string) {
+		evts.Publish(InstallOutputEvent, line)
+	})
 	if err != nil {
 		ip.Server.Log().WithFields(log.Fields{"container_id": id, "error": err}).Warn("error processing install output lines")
 	}
@@ -570,5 +573,5 @@ func (ip *InstallationProcess) resourceLimits() container.Resources {
 // server is. A boolean value of "true" means everything was successful, "false"
 // means something went wrong and the server must be deleted and re-created.
 func (s *Server) SyncInstallState(successful bool) error {
-	return s.client.SetInstallationStatus(s.Context(), s.ID(), successful)
+	return s.client.SetInstallationStatus(s.Context(), s.Id(), successful)
 }

server/listeners.go

@@ -1,12 +1,12 @@
 package server
 
 import (
+	"encoding/json"
 	"regexp"
 	"strconv"
 	"sync"
 
 	"github.com/apex/log"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/environment"
 	"github.com/pterodactyl/wings/events"
@@ -40,7 +40,7 @@ func (dsl *diskSpaceLimiter) Reset() {
 // 15 seconds, and terminate it forcefully if it does not stop.
 //
 // This function is only executed one time, so whenever a server is marked as booting the limiter
-// should be reset, so it can properly be triggered as needed.
+// should be reset so it can properly be triggered as needed.
 func (dsl *diskSpaceLimiter) Trigger() {
 	dsl.o.Do(func() {
 		dsl.server.PublishConsoleOutputFromDaemon("Server is exceeding the assigned disk space limit, stopping process now.")
@@ -50,103 +50,99 @@ func (dsl *diskSpaceLimiter) Trigger() {
 	})
 }
 
-func (s *Server) processConsoleOutputEvent(v []byte) {
+// Adds all of the internal event listeners we want to use for a server. These listeners can only be
-	t := s.Throttler()
-	err := t.Increment(func() {
-		s.PublishConsoleOutputFromDaemon("Your server is outputting too much data and is being throttled.")
-	})
-	// An error is only returned if the server has breached the thresholds set.
-	if err != nil {
-		// If the process is already stopping, just let it continue with that action rather than attempting
-		// to terminate again.
-		if s.Environment.State() != environment.ProcessStoppingState {
-			s.Environment.SetState(environment.ProcessStoppingState)
-
-			go func() {
-				s.Log().Warn("stopping server instance, violating throttle limits")
-				s.PublishConsoleOutputFromDaemon("Your server is being stopped for outputting too much data in a short period of time.")
-
-				// Completely skip over server power actions and terminate the running instance. This gives the
-				// server 15 seconds to finish stopping gracefully before it is forcefully terminated.
-				if err := s.Environment.WaitForStop(config.Get().Throttles.StopGracePeriod, true); err != nil {
-					// If there is an error set the process back to running so that this throttler is called
-					// again and hopefully kills the server.
-					if s.Environment.State() != environment.ProcessOfflineState {
-						s.Environment.SetState(environment.ProcessRunningState)
-					}
-
-					s.Log().WithField("error", err).Error("failed to terminate environment after triggering throttle")
-				}
-			}()
-		}
-	}
-
-	// If we are not throttled, go ahead and output the data.
-	if !t.Throttled() {
-		s.LogSink().Push(v)
-	}
-
-	// Also pass the data along to the console output channel.
-	s.onConsoleOutput(string(v))
-}
-
-// StartEventListeners adds all the internal event listeners we want to use for a server. These listeners can only be
 // removed by deleting the server as they should last for the duration of the process' lifetime.
 func (s *Server) StartEventListeners() {
-	state := make(chan events.Event)
+	console := func(e events.Event) {
-	stats := make(chan events.Event)
+		t := s.Throttler()
-	docker := make(chan events.Event)
+		err := t.Increment(func() {
+			s.PublishConsoleOutputFromDaemon("Your server is outputting too much data and is being throttled.")
+		})
 
-	go func() {
+		// An error is only returned if the server has breached the thresholds set.
-		l := newDiskLimiter(s)
+		if err != nil {
+			// If the process is already stopping, just let it continue with that action rather than attempting
+			// to terminate again.
+			if s.Environment.State() != environment.ProcessStoppingState {
+				s.Environment.SetState(environment.ProcessStoppingState)
 
-		for {
-			select {
-			case e := <-state:
 				go func() {
-					// Reset the throttler when the process is started.
+					s.Log().Warn("stopping server instance, violating throttle limits")
-					if e.Data == environment.ProcessStartingState {
+					s.PublishConsoleOutputFromDaemon("Your server is being stopped for outputting too much data in a short period of time.")
-						l.Reset()
-						s.Throttler().Reset()
-					}
 
-					s.OnStateChange()
+					// Completely skip over server power actions and terminate the running instance. This gives the
-				}()
+					// server 15 seconds to finish stopping gracefully before it is forcefully terminated.
-			case e := <-stats:
+					if err := s.Environment.WaitForStop(config.Get().Throttles.StopGracePeriod, true); err != nil {
-				go func() {
+						// If there is an error set the process back to running so that this throttler is called
-					// Update the server resource tracking object with the resources we got here.
+						// again and hopefully kills the server.
-					s.resources.mu.Lock()
+						if s.Environment.State() != environment.ProcessOfflineState {
-					s.resources.Stats = e.Data.(environment.Stats)
+							s.Environment.SetState(environment.ProcessRunningState)
-					s.resources.mu.Unlock()
+						}
 
-					// If there is no disk space available at this point, trigger the server disk limiter logic
+						s.Log().WithField("error", err).Error("failed to terminate environment after triggering throttle")
-					// which will start to stop the running instance.
-					if !s.Filesystem().HasSpaceAvailable(true) {
-						l.Trigger()
-					}
-
-					s.emitProcUsage()
-				}()
-			case e := <-docker:
-				go func() {
-					switch e.Topic {
-					case environment.DockerImagePullStatus:
-						s.Events().Publish(InstallOutputEvent, e.Data)
-					case environment.DockerImagePullStarted:
-						s.PublishConsoleOutputFromDaemon("Pulling Docker container image, this could take a few minutes to complete...")
-					default:
-						s.PublishConsoleOutputFromDaemon("Finished pulling Docker container image")
 					}
 				}()
 			}
 		}
-	}()
+
+		// If we are not throttled, go ahead and output the data.
+		if !t.Throttled() {
+			s.Events().Publish(ConsoleOutputEvent, e.Data)
+		}
+
+		// Also pass the data along to the console output channel.
+		s.onConsoleOutput(e.Data)
+	}
+
+	l := newDiskLimiter(s)
+	state := func(e events.Event) {
+		// Reset the throttler when the process is started.
+		if e.Data == environment.ProcessStartingState {
+			l.Reset()
+			s.Throttler().Reset()
+		}
+
+		s.OnStateChange()
+	}
+
+	stats := func(e events.Event) {
+		st := new(environment.Stats)
+		if err := json.Unmarshal([]byte(e.Data), st); err != nil {
+			s.Log().WithField("error", err).Warn("failed to unmarshal server environment stats")
+			return
+		}
+
+		// Update the server resource tracking object with the resources we got here.
+		s.resources.mu.Lock()
+		s.resources.Stats = *st
+		s.resources.mu.Unlock()
+
+		// If there is no disk space available at this point, trigger the server disk limiter logic
+		// which will start to stop the running instance.
+		if !s.Filesystem().HasSpaceAvailable(true) {
+			l.Trigger()
+		}
+
+		s.emitProcUsage()
+	}
+
+	docker := func(e events.Event) {
+		if e.Topic == environment.DockerImagePullStatus {
+			s.Events().Publish(InstallOutputEvent, e.Data)
+		} else if e.Topic == environment.DockerImagePullStarted {
+			s.PublishConsoleOutputFromDaemon("Pulling Docker container image, this could take a few minutes to complete...")
+		} else {
+			s.PublishConsoleOutputFromDaemon("Finished pulling Docker container image")
+		}
+	}
 
 	s.Log().Debug("registering event listeners: console, state, resources...")
-	s.Environment.SetLogCallback(s.processConsoleOutputEvent)
+	s.Environment.Events().On(environment.ConsoleOutputEvent, &console)
-	s.Environment.Events().On(state, environment.StateChangeEvent)
+	s.Environment.Events().On(environment.StateChangeEvent, &state)
-	s.Environment.Events().On(stats, environment.ResourceEvent)
+	s.Environment.Events().On(environment.ResourceEvent, &stats)
-	s.Environment.Events().On(docker, dockerEvents...)
+	for _, evt := range dockerEvents {
+		s.Environment.Events().On(evt, &docker)
+	}
 }
 
 var stripAnsiRegex = regexp.MustCompile("[\u001B\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[a-zA-Z\\d]*)*)?\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PRZcf-ntqry=><~]))")

server/manager.go

@@ -4,7 +4,9 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"github.com/pterodactyl/wings/metrics"
 	"io"
+	"io/ioutil"
 	"os"
 	"path/filepath"
 	"runtime"
@@ -14,7 +16,6 @@ import (
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/gammazero/workerpool"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/environment"
 	"github.com/pterodactyl/wings/environment/docker"
@@ -28,9 +29,9 @@ type Manager struct {
 	servers []*Server
 }
 
-// NewManager returns a new server manager instance. This will boot up all the
+// NewManager returns a new server manager instance. This will boot up all of
-// servers that are currently present on the filesystem and set them into the
+// the servers that are currently present on the filesystem and set them into
-// manager.
+// the manager.
 func NewManager(ctx context.Context, client remote.Client) (*Manager, error) {
 	m := NewEmptyManager(client)
 	if err := m.init(ctx); err != nil {
@@ -52,7 +53,7 @@ func (m *Manager) Client() remote.Client {
 	return m.client
 }
 
-// Put replaces all the current values in the collection with the value that
+// Put replaces all of the current values in the collection with the value that
 // is passed through.
 func (m *Manager) Put(s []*Server) {
 	m.mu.Lock()
@@ -60,7 +61,7 @@ func (m *Manager) Put(s []*Server) {
 	m.mu.Unlock()
 }
 
-// All returns all the items in the collection.
+// All returns all of the items in the collection.
 func (m *Manager) All() []*Server {
 	m.mu.RLock()
 	defer m.mu.RUnlock()
@@ -72,13 +73,16 @@ func (m *Manager) Add(s *Server) {
 	m.mu.Lock()
 	m.servers = append(m.servers, s)
 	m.mu.Unlock()
+
+	// Add the server to the metrics with a offline status.
+	metrics.ServerStatus.WithLabelValues(s.Id()).Set(0)
 }
 
 // Get returns a single server instance and a boolean value indicating if it was
 // found in the global collection or not.
 func (m *Manager) Get(uuid string) (*Server, bool) {
 	match := m.Find(func(server *Server) bool {
-		return server.ID() == uuid
+		return server.Id() == uuid
 	})
 	return match, match != nil
 }
@@ -117,6 +121,9 @@ func (m *Manager) Remove(filter func(match *Server) bool) {
 	for _, v := range m.servers {
 		if !filter(v) {
 			r = append(r, v)
+		} else {
+			// Delete the server from the metric.
+			metrics.DeleteServer(v.Id())
 		}
 	}
 	m.servers = r
@@ -130,13 +137,13 @@ func (m *Manager) Remove(filter func(match *Server) bool) {
 func (m *Manager) PersistStates() error {
 	states := map[string]string{}
 	for _, s := range m.All() {
-		states[s.ID()] = s.Environment.State()
+		states[s.Id()] = s.Environment.State()
 	}
 	data, err := json.Marshal(states)
 	if err != nil {
 		return errors.WithStack(err)
 	}
-	if err := os.WriteFile(config.Get().System.GetStatesPath(), data, 0o644); err != nil {
+	if err := ioutil.WriteFile(config.Get().System.GetStatesPath(), data, 0644); err != nil {
 		return errors.WithStack(err)
 	}
 	return nil
@@ -144,7 +151,7 @@ func (m *Manager) PersistStates() error {
 
 // ReadStates returns the state of the servers.
 func (m *Manager) ReadStates() (map[string]string, error) {
-	f, err := os.OpenFile(config.Get().System.GetStatesPath(), os.O_RDONLY|os.O_CREATE, 0o644)
+	f, err := os.OpenFile(config.Get().System.GetStatesPath(), os.O_RDONLY|os.O_CREATE, 0644)
 	if err != nil {
 		return nil, errors.WithStack(err)
 	}
@@ -171,18 +178,15 @@ func (m *Manager) InitServer(data remote.ServerConfigurationResponse) (*Server,
 	if err != nil {
 		return nil, err
 	}
-
+	if err := s.UpdateDataStructure(data.Settings); err != nil {
-	// Setup the base server configuration data which will be used for all of the
+		return nil, err
-	// remaining functionality in this call.
-	if err := s.SyncWithConfiguration(data); err != nil {
-		return nil, errors.WithStackIf(err)
 	}
 
-	s.fs = filesystem.New(filepath.Join(config.Get().System.Data, s.ID()), s.DiskSpace(), s.Config().Egg.FileDenylist)
+	s.fs = filesystem.New(filepath.Join(config.Get().System.Data, s.Id()), s.DiskSpace(), s.Config().Egg.FileDenylist)
 
 	// Right now we only support a Docker based environment, so I'm going to hard code
 	// this logic in. When we're ready to support other environment we'll need to make
-	// some modifications here, obviously.
+	// some modifications here obviously.
 	settings := environment.Settings{
 		Mounts:      s.Mounts(),
 		Allocations: s.cfg.Allocations,
@@ -194,7 +198,7 @@ func (m *Manager) InitServer(data remote.ServerConfigurationResponse) (*Server,
 		Image: s.Config().Container.Image,
 	}
 
-	if env, err := docker.New(s.ID(), &meta, envCfg); err != nil {
+	if env, err := docker.New(s.Id(), &meta, envCfg); err != nil {
 		return nil, err
 	} else {
 		s.Environment = env
@@ -202,6 +206,11 @@ func (m *Manager) InitServer(data remote.ServerConfigurationResponse) (*Server,
 		s.Throttler().StartTimer(s.Context())
 	}
 
+	// Forces the configuration to be synced with the panel.
+	if err := s.SyncWithConfiguration(data); err != nil {
+		return nil, err
+	}
+
 	// If the server's data directory exists, force disk usage calculation.
 	if _, err := os.Stat(s.Filesystem().Path()); err == nil {
 		s.Filesystem().HasSpaceAvailable(true)
@@ -210,7 +219,7 @@ func (m *Manager) InitServer(data remote.ServerConfigurationResponse) (*Server,
 	return s, nil
 }
 
-// initializeFromRemoteSource iterates over a given directory and loads all
+// initializeFromRemoteSource iterates over a given directory and loads all of
 // the servers listed before returning them to the calling function.
 func (m *Manager) init(ctx context.Context) error {
 	log.Info("fetching list of servers from API")
@@ -250,7 +259,7 @@ func (m *Manager) init(ctx context.Context) error {
 		})
 	}
 
-	// Wait until we've processed all the configuration files in the directory
+	// Wait until we've processed all of the configuration files in the directory
 	// before continuing.
 	pool.StopWait()
 

server/mounts.go

@@ -5,7 +5,6 @@ import (
 	"strings"
 
 	"github.com/apex/log"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/environment"
 )

server/power.go

@@ -6,10 +6,9 @@ import (
 	"time"
 
 	"emperror.dev/errors"
-	"golang.org/x/sync/semaphore"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/environment"
+	"golang.org/x/sync/semaphore"
 )
 
 type PowerAction string
@@ -19,7 +18,7 @@ type PowerAction string
 // example, sending two "start" actions back to back will not process the second action until
 // the first action has been completed.
 //
-// This utilizes a workerpool with a limit of one worker so that all the actions execute
+// This utilizes a workerpool with a limit of one worker so that all of the actions execute
 // in a sync manner.
 const (
 	PowerActionStart     = "start"
@@ -28,7 +27,7 @@ const (
 	PowerActionTerminate = "kill"
 )
 
-// IsValid checks if the power action being received is valid.
+// Checks if the power action being received is valid.
 func (pa PowerAction) IsValid() bool {
 	return pa == PowerActionStart ||
 		pa == PowerActionStop ||
@@ -40,7 +39,7 @@ func (pa PowerAction) IsStart() bool {
 	return pa == PowerActionStart || pa == PowerActionRestart
 }
 
-// ExecutingPowerAction checks if there is currently a power action being processed for the server.
+// Check if there is currently a power action being processed for the server.
 func (s *Server) ExecutingPowerAction() bool {
 	if s.powerLock == nil {
 		return false
@@ -55,9 +54,9 @@ func (s *Server) ExecutingPowerAction() bool {
 	return !ok
 }
 
-// HandlePowerAction is a helper function that can receive a power action and then process the
+// Helper function that can receive a power action and then process the actions that need
-// actions that need to occur for it. This guards against someone calling Start() twice at the
+// to occur for it. This guards against someone calling Start() twice at the same time, or
-// same time, or trying to restart while another restart process is currently running.
+// trying to restart while another restart process is currently running.
 //
 // However, the code design for the daemon does depend on the user correctly calling this
 // function rather than making direct calls to the start/stop/restart functions on the
@@ -108,7 +107,7 @@ func (s *Server) HandlePowerAction(action PowerAction, waitSeconds ...int) error
 		// Release the lock once the process being requested has finished executing.
 		defer s.powerLock.Release(1)
 	} else {
-		// Still try to acquire the lock if terminating, and it is available, just so that other power
+		// Still try to acquire the lock if terminating and it is available, just so that other power
 		// actions are blocked until it has completed. However, if it is unavailable we won't stop
 		// the entire process.
 		if ok := s.powerLock.TryAcquire(1); ok {
@@ -128,7 +127,7 @@ func (s *Server) HandlePowerAction(action PowerAction, waitSeconds ...int) error
 			return err
 		}
 
-		return s.Environment.Start(s.Context())
+		return s.Environment.Start()
 	case PowerActionStop:
 		// We're specifically waiting for the process to be stopped here, otherwise the lock is released
 		// too soon, and you can rack up all sorts of issues.
@@ -151,7 +150,7 @@ func (s *Server) HandlePowerAction(action PowerAction, waitSeconds ...int) error
 			return err
 		}
 
-		return s.Environment.Start(s.Context())
+		return s.Environment.Start()
 	case PowerActionTerminate:
 		return s.Environment.Terminate(os.Kill)
 	}
@@ -191,14 +190,14 @@ func (s *Server) onBeforeStart() error {
 	// Update the configuration files defined for the server before beginning the boot process.
 	// This process executes a bunch of parallel updates, so we just block until that process
 	// is complete. Any errors as a result of this will just be bubbled out in the logger,
-	// we don't need to actively do anything about it at this point, worse comes to worst the
+	// we don't need to actively do anything about it at this point, worst comes to worst the
 	// server starts in a weird state and the user can manually adjust.
 	s.PublishConsoleOutputFromDaemon("Updating process configuration files...")
 	s.UpdateConfigurationFiles()
 
 	if config.Get().System.CheckPermissionsOnBoot {
 		s.PublishConsoleOutputFromDaemon("Ensuring file permissions are set correctly, this could take a few seconds...")
-		// Ensure all the server file permissions are set correctly before booting the process.
+		// Ensure all of the server file permissions are set correctly before booting the process.
 		if err := s.Filesystem().Chown("/"); err != nil {
 			return errors.WithMessage(err, "failed to chown root server directory during pre-boot process")
 		}

server/resources.go

@@ -8,7 +8,7 @@ import (
 	"github.com/pterodactyl/wings/system"
 )
 
-// ResourceUsage defines the current resource usage for a given server instance. If a server is offline you
+// Defines the current resource usage for a given server instance. If a server is offline you
 // should obviously expect memory and CPU usage to be 0. However, disk will always be returned
 // since that is not dependent on the server being running to collect that data.
 type ResourceUsage struct {
@@ -26,7 +26,7 @@ type ResourceUsage struct {
 	Disk int64 `json:"disk_bytes"`
 }
 
-// Proc returns the current resource usage stats for the server instance. This returns
+// Returns the current resource usage stats for the server instance. This returns
 // a copy of the tracked resources, so making any changes to the response will not
 // have the desired outcome for you most likely.
 func (s *Server) Proc() ResourceUsage {
@@ -38,19 +38,19 @@ func (s *Server) Proc() ResourceUsage {
 	return s.resources
 }
 
-// Reset resets the usages values to zero, used when a server is stopped to ensure we don't hold
+// Resets the usages values to zero, used when a server is stopped to ensure we don't hold
 // onto any values incorrectly.
 func (ru *ResourceUsage) Reset() {
 	ru.mu.Lock()
 	defer ru.mu.Unlock()
-
 	ru.Memory = 0
 	ru.CpuAbsolute = 0
-	ru.Uptime = 0
 	ru.Network.TxBytes = 0
 	ru.Network.RxBytes = 0
 }
 
 func (s *Server) emitProcUsage() {
-	s.Events().Publish(StatsEvent, s.Proc())
+	if err := s.Events().PublishJson(StatsEvent, s.Proc()); err != nil {
+		s.Log().WithField("error", err).Warn("error while emitting server resource usage to listeners")
+	}
 }

server/server.go

@@ -2,7 +2,6 @@ package server
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"net/http"
 	"os"
@@ -12,14 +11,14 @@ import (
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/creasty/defaults"
-	"golang.org/x/sync/semaphore"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/environment"
+	"github.com/pterodactyl/wings/environment/docker"
 	"github.com/pterodactyl/wings/events"
 	"github.com/pterodactyl/wings/remote"
 	"github.com/pterodactyl/wings/server/filesystem"
 	"github.com/pterodactyl/wings/system"
+	"golang.org/x/sync/semaphore"
 )
 
 // Server is the high level definition for a server instance being controlled
@@ -49,7 +48,7 @@ type Server struct {
 	fs *filesystem.Filesystem
 
 	// Events emitted by the server instance.
-	emitter *events.Bus
+	emitter *events.EventBus
 
 	// Defines the process configuration for the server instance. This is dynamically
 	// fetched from the Pterodactyl Server instance each time the server process is
@@ -70,9 +69,6 @@ type Server struct {
 	// Tracks open websocket connections for the server.
 	wsBag       *WebsocketBag
 	wsBagLocker sync.Mutex
-
-	logSink     *sinkPool
-	installSink *sinkPool
 }
 
 // New returns a new server instance with a context and all of the default
@@ -86,9 +82,6 @@ func New(client remote.Client) (*Server, error) {
 		installing:   system.NewAtomicBool(false),
 		transferring: system.NewAtomicBool(false),
 		restoring:    system.NewAtomicBool(false),
-
-		logSink:     newSinkPool(),
-		installSink: newSinkPool(),
 	}
 	if err := defaults.Set(&s); err != nil {
 		return nil, errors.Wrap(err, "server: could not set default values for struct")
@@ -100,17 +93,9 @@ func New(client remote.Client) (*Server, error) {
 	return &s, nil
 }
 
-// ID returns the UUID for the server instance.
+// Id returns the UUID for the server instance.
-func (s *Server) ID() string {
-	return s.Config().GetUuid()
-}
-
-// Id returns the UUID for the server instance. This function is deprecated
-// in favor of Server.ID().
-//
-// Deprecated
 func (s *Server) Id() string {
-	return s.ID()
+	return s.Config().GetUuid()
 }
 
 // Cancels the context assigned to this server instance. Assuming background tasks
@@ -144,7 +129,7 @@ eloop:
 	for k := range s.Config().EnvVars {
 		// Don't allow any environment variables that we have already set above.
 		for _, e := range out {
-			if strings.HasPrefix(e, strings.ToUpper(k)+"=") {
+			if strings.HasPrefix(e, strings.ToUpper(k)) {
 				continue eloop
 			}
 		}
@@ -156,7 +141,7 @@ eloop:
 }
 
 func (s *Server) Log() *log.Entry {
-	return log.WithField("server", s.ID())
+	return log.WithField("server", s.Id())
 }
 
 // Sync syncs the state of the server on the Panel with Wings. This ensures that
@@ -166,57 +151,38 @@ func (s *Server) Log() *log.Entry {
 // This also means mass actions can be performed against servers on the Panel
 // and they will automatically sync with Wings when the server is started.
 func (s *Server) Sync() error {
-	cfg, err := s.client.GetServerConfiguration(s.Context(), s.ID())
+	cfg, err := s.client.GetServerConfiguration(s.Context(), s.Id())
 	if err != nil {
 		if err := remote.AsRequestError(err); err != nil && err.StatusCode() == http.StatusNotFound {
 			return &serverDoesNotExist{}
 		}
 		return errors.WithStackIf(err)
 	}
-
+	return s.SyncWithConfiguration(cfg)
-	if err := s.SyncWithConfiguration(cfg); err != nil {
-		return errors.WithStackIf(err)
-	}
-
-	// Update the disk space limits for the server whenever the configuration for
-	// it changes.
-	s.fs.SetDiskLimit(s.DiskSpace())
-
-	s.SyncWithEnvironment()
-
-	return nil
 }
 
-// SyncWithConfiguration accepts a configuration object for a server and will
-// sync all of the values with the existing server state. This only replaces the
-// existing configuration and process configuration for the server. The
-// underlying environment will not be affected. This is because this function
-// can be called from scoped where the server may not be fully initialized,
-// therefore other things like the filesystem and environment may not exist yet.
 func (s *Server) SyncWithConfiguration(cfg remote.ServerConfigurationResponse) error {
-	c := Configuration{
+	// Update the data structure and persist it to the disk.
-		CrashDetectionEnabled: config.Get().System.CrashDetection.CrashDetectionEnabled,
+	if err := s.UpdateDataStructure(cfg.Settings); err != nil {
+		return err
 	}
-	if err := json.Unmarshal(cfg.Settings, &c); err != nil {
-		return errors.WithStackIf(err)
-	}
-
-	s.cfg.mu.Lock()
-	defer s.cfg.mu.Unlock()
-
-	// Lock the new configuration. Since we have the deferred Unlock above we need
-	// to make sure that the NEW configuration object is already locked since that
-	// defer is running on the memory address for "s.cfg.mu" which we're explicitly
-	// changing on the next line.
-	c.mu.Lock()
-
-	//goland:noinspection GoVetCopyLock
-	s.cfg = c
 
 	s.Lock()
 	s.procConfig = cfg.ProcessConfiguration
 	s.Unlock()
 
+	// Update the disk space limits for the server whenever the configuration
+	// for it changes.
+	s.fs.SetDiskLimit(s.DiskSpace())
+
+	// If this is a Docker environment we need to sync the stop configuration with it so that
+	// the process isn't just terminated when a user requests it be stopped.
+	if e, ok := s.Environment.(*docker.Environment); ok {
+		s.Log().Debug("syncing stop configuration with configured docker environment")
+		e.SetImage(s.Config().Container.Image)
+		e.SetStopConfiguration(cfg.ProcessConfiguration.Stop)
+	}
+
 	return nil
 }
 
@@ -267,7 +233,7 @@ func (s *Server) EnsureDataDirectoryExists() error {
 	if _, err := os.Lstat(s.fs.Path()); err != nil {
 		if os.IsNotExist(err) {
 			s.Log().Debug("server: creating root directory and setting permissions")
-			if err := os.MkdirAll(s.fs.Path(), 0o700); err != nil {
+			if err := os.MkdirAll(s.fs.Path(), 0700); err != nil {
 				return errors.WithStack(err)
 			}
 			if err := s.fs.Chown("/"); err != nil {
@@ -280,7 +246,7 @@ func (s *Server) EnsureDataDirectoryExists() error {
 	return nil
 }
 
-// OnStateChange sets the state of the server internally. This function handles crash detection as
+// Sets the state of the server internally. This function handles crash detection as
 // well as reporting to event listeners for the server.
 func (s *Server) OnStateChange() {
 	prevState := s.resources.State.Load()
@@ -295,7 +261,7 @@ func (s *Server) OnStateChange() {
 		s.Events().Publish(StatusEvent, st)
 	}
 
-	// Reset the resource usage to 0 when the process fully stops so that all the UI
+	// Reset the resource usage to 0 when the process fully stops so that all of the UI
 	// views in the Panel correctly display 0.
 	if st == environment.ProcessOfflineState {
 		s.resources.Reset()
@@ -327,7 +293,7 @@ func (s *Server) OnStateChange() {
 }
 
 // IsRunning determines if the server state is running or not. This is different
-// from the environment state, it is simply the tracked state from this daemon
+// than the environment state, it is simply the tracked state from this daemon
 // instance, and not the response from Docker.
 func (s *Server) IsRunning() bool {
 	st := s.Environment.State()
@@ -355,11 +321,3 @@ func (s *Server) ToAPIResponse() APIResponse {
 		Configuration: *s.Config(),
 	}
 }
-
-func (s *Server) LogSink() *sinkPool {
-	return s.logSink
-}
-
-func (s *Server) InstallSink() *sinkPool {
-	return s.installSink
-}

server/sink.go

@@ -1,71 +0,0 @@
-package server
-
-import (
-	"sync"
-	"time"
-)
-
-// sinkPool represents a pool with sinks.
-type sinkPool struct {
-	mx    sync.RWMutex
-	sinks []chan []byte
-}
-
-// newSinkPool returns a new empty sinkPool.
-func newSinkPool() *sinkPool {
-	return &sinkPool{}
-}
-
-// On adds a sink on the pool.
-func (p *sinkPool) On(c chan []byte) {
-	p.mx.Lock()
-	defer p.mx.Unlock()
-
-	p.sinks = append(p.sinks, c)
-}
-
-// Off removes a sink from the pool.
-func (p *sinkPool) Off(c chan []byte) {
-	p.mx.Lock()
-	defer p.mx.Unlock()
-
-	sinks := p.sinks
-
-	for i, sink := range sinks {
-		if c != sink {
-			continue
-		}
-		copy(sinks[i:], sinks[i+1:])
-		sinks[len(sinks)-1] = nil
-		sinks = sinks[:len(sinks)-1]
-		p.sinks = sinks
-		return
-	}
-}
-
-// Destroy destroys the pool by removing and closing all sinks.
-func (p *sinkPool) Destroy() {
-	p.mx.Lock()
-	defer p.mx.Unlock()
-
-	for _, c := range p.sinks {
-		close(c)
-	}
-
-	p.sinks = nil
-}
-
-// Push pushes a message to all registered sinks.
-func (p *sinkPool) Push(v []byte) {
-	p.mx.RLock()
-	for _, c := range p.sinks {
-		// TODO: should this be done in parallel?
-		select {
-		// Send the log output to the channel
-		case c <- v:
-		// Timeout after 100 milliseconds, this will cause the write to the channel to be cancelled.
-		case <-time.After(100 * time.Millisecond):
-		}
-	}
-	p.mx.RUnlock()
-}

server/update.go

@@ -1,41 +1,127 @@
 package server
 
 import (
-	"github.com/pterodactyl/wings/environment/docker"
+	"encoding/json"
 
+	"emperror.dev/errors"
+	"github.com/buger/jsonparser"
+	"github.com/imdario/mergo"
 	"github.com/pterodactyl/wings/environment"
 )
 
-// SyncWithEnvironment updates the environment for the server to match any of
+// UpdateDataStructure merges data passed through in JSON form into the existing
-// the changed data. This pushes new settings and environment variables to the
+// server object. Any changes to the build settings will apply immediately in
-// environment. In addition, the in-situ update method is called on the
+// the environment if the environment supports it.
-// environment which will allow environments that make use of it (such as Docker)
-// to immediately apply some settings without having to wait on a server to
-// restart.
 //
-// This functionality allows a server's resources limits to be modified on the
+// The server will be marked as requiring a rebuild on the next boot sequence,
-// fly and have them apply right away allowing for dynamic resource allocation
+// it is up to the specific environment to determine what needs to happen when
-// and responses to abusive server processes.
+// that is the case.
+func (s *Server) UpdateDataStructure(data []byte) error {
+	src := new(Configuration)
+	if err := json.Unmarshal(data, src); err != nil {
+		return errors.Wrap(err, "server/update: could not unmarshal source data into Configuration struct")
+	}
+
+	// Don't allow obviously corrupted data to pass through into this function. If the UUID
+	// doesn't match something has gone wrong and the API is attempting to meld this server
+	// instance into a totally different one, which would be bad.
+	if src.Uuid != "" && s.Id() != "" && src.Uuid != s.Id() {
+		return errors.New("server/update: attempting to merge a data stack with an invalid UUID")
+	}
+
+	// Grab a copy of the configuration to work on.
+	c := *s.Config()
+
+	// Lock our copy of the configuration since the deferred unlock will end up acting upon this
+	// new memory address rather than the old one. If we don't lock this, the deferred unlock will
+	// cause a panic when it goes to run. However, since we only update s.cfg at the end, if there
+	// is an error before that point we'll still properly unlock the original configuration for the
+	// server.
+	c.mu.Lock()
+
+	// Lock the server configuration while we're doing this merge to avoid anything
+	// trying to overwrite it or make modifications while we're sorting out what we
+	// need to do.
+	s.cfg.mu.Lock()
+	defer s.cfg.mu.Unlock()
+
+	// Merge the new data object that we have received with the existing server data object
+	// and then save it to the disk so it is persistent.
+	if err := mergo.Merge(&c, src, mergo.WithOverride); err != nil {
+		return errors.WithStack(err)
+	}
+
+	// Don't explode if we're setting CPU limits to 0. Mergo sees that as an empty value
+	// so it won't override the value we've passed through in the API call. However, we can
+	// safely assume that we're passing through valid data structures here. I foresee this
+	// backfiring at some point, but until then...
+	c.Build = src.Build
+
+	// Mergo can't quite handle this boolean value correctly, so for now we'll just
+	// handle this edge case manually since none of the other data passed through in this
+	// request is going to be boolean. Allegedly.
+	if v, err := jsonparser.GetBoolean(data, "container", "oom_disabled"); err != nil {
+		if err != jsonparser.KeyPathNotFoundError {
+			return errors.WithStack(err)
+		}
+	} else {
+		c.Build.OOMDisabled = v
+	}
+
+	// Mergo also cannot handle this boolean value.
+	if v, err := jsonparser.GetBoolean(data, "suspended"); err != nil {
+		if err != jsonparser.KeyPathNotFoundError {
+			return errors.WithStack(err)
+		}
+	} else {
+		c.Suspended = v
+	}
+
+	if v, err := jsonparser.GetBoolean(data, "skip_egg_scripts"); err != nil {
+		if err != jsonparser.KeyPathNotFoundError {
+			return errors.WithStack(err)
+		}
+	} else {
+		c.SkipEggScripts = v
+	}
+
+	// Environment and Mappings should be treated as a full update at all times, never a
+	// true patch, otherwise we can't know what we're passing along.
+	if src.EnvVars != nil && len(src.EnvVars) > 0 {
+		c.EnvVars = src.EnvVars
+	}
+
+	if src.Allocations.Mappings != nil && len(src.Allocations.Mappings) > 0 {
+		c.Allocations.Mappings = src.Allocations.Mappings
+	}
+
+	if src.Mounts != nil && len(src.Mounts) > 0 {
+		c.Mounts = src.Mounts
+	}
+
+	// Update the configuration once we have a lock on the configuration object.
+	s.cfg = c
+
+	return nil
+}
+
+// Updates the environment for the server to match any of the changed data. This pushes new settings and
+// environment variables to the environment. In addition, the in-situ update method is called on the
+// environment which will allow environments that make use of it (such as Docker) to immediately apply
+// some settings without having to wait on a server to restart.
+//
+// This functionality allows a server's resources limits to be modified on the fly and have them apply
+// right away allowing for dynamic resource allocation and responses to abusive server processes.
 func (s *Server) SyncWithEnvironment() {
 	s.Log().Debug("syncing server settings with environment")
 
-	cfg := s.Config()
-
 	// Update the environment settings using the new information from this server.
 	s.Environment.Config().SetSettings(environment.Settings{
 		Mounts:      s.Mounts(),
-		Allocations: cfg.Allocations,
+		Allocations: s.Config().Allocations,
-		Limits:      cfg.Build,
+		Limits:      s.Config().Build,
 	})
 
-	// For Docker specific environments we also want to update the configured image
-	// and stop configuration.
-	if e, ok := s.Environment.(*docker.Environment); ok {
-		s.Log().Debug("syncing stop configuration with configured docker environment")
-		e.SetImage(cfg.Container.Image)
-		e.SetStopConfiguration(s.ProcessConfiguration().Stop)
-	}
-
 	// If build limits are changed, environment variables also change. Plus, any modifications to
 	// the startup command also need to be properly propagated to this environment.
 	//

server/websockets.go

@@ -12,7 +12,7 @@ type WebsocketBag struct {
 	conns map[uuid.UUID]*context.CancelFunc
 }
 
-// Websockets returns the websocket bag which contains all the currently open websocket connections
+// Returns the websocket bag which contains all of the currently open websocket connections
 // for the server instance.
 func (s *Server) Websockets() *WebsocketBag {
 	s.wsBagLocker.Lock()
@@ -25,7 +25,7 @@ func (s *Server) Websockets() *WebsocketBag {
 	return s.wsBag
 }
 
-// Push adds a new websocket connection to the end of the stack.
+// Adds a new websocket connection to the stack.
 func (w *WebsocketBag) Push(u uuid.UUID, cancel *context.CancelFunc) {
 	w.mu.Lock()
 	defer w.mu.Unlock()
@@ -37,22 +37,23 @@ func (w *WebsocketBag) Push(u uuid.UUID, cancel *context.CancelFunc) {
 	w.conns[u] = cancel
 }
 
-// Remove removes a connection from the stack.
+// Removes a connection from the stack.
 func (w *WebsocketBag) Remove(u uuid.UUID) {
 	w.mu.Lock()
 	delete(w.conns, u)
 	w.mu.Unlock()
 }
 
-// CancelAll cancels all the stored cancel functions which has the effect of
+// Cancels all of the stored cancel functions which has the effect of disconnecting
-// disconnecting every listening websocket for the server.
+// every listening websocket for the server.
 func (w *WebsocketBag) CancelAll() {
 	w.mu.Lock()
-	defer w.mu.Unlock()
+	w.mu.Unlock()
 
 	if w.conns != nil {
 		for _, cancel := range w.conns {
-			(*cancel)()
+			c := *cancel
+			c()
 		}
 	}
 

sftp/handler.go

@@ -11,11 +11,9 @@ import (
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/pkg/sftp"
-	"golang.org/x/crypto/ssh"
-
 	"github.com/pterodactyl/wings/config"
-	"github.com/pterodactyl/wings/server"
 	"github.com/pterodactyl/wings/server/filesystem"
+	"golang.org/x/crypto/ssh"
 )
 
 const (
@@ -27,10 +25,8 @@ const (
 )
 
 type Handler struct {
-	mu sync.Mutex
-
 	permissions []string
-	server      *server.Server
+	mu          sync.Mutex
 	fs          *filesystem.Filesystem
 	logger      *log.Entry
 	ro          bool
@@ -38,12 +34,11 @@ type Handler struct {
 
 // Returns a new connection handler for the SFTP server. This allows a given user
 // to access the underlying filesystem.
-func NewHandler(sc *ssh.ServerConn, srv *server.Server) *Handler {
+func NewHandler(sc *ssh.ServerConn, fs *filesystem.Filesystem) *Handler {
 	return &Handler{
-		permissions: strings.Split(sc.Permissions.Extensions["permissions"], ","),
+		fs:          fs,
-		server:      srv,
-		fs:          srv.Filesystem(),
 		ro:          config.Get().System.Sftp.ReadOnly,
+		permissions: strings.Split(sc.Permissions.Extensions["permissions"], ","),
 		logger: log.WithFields(log.Fields{
 			"subsystem": "sftp",
 			"username":  sc.User(),
@@ -142,12 +137,12 @@ func (h *Handler) Filecmd(request *sftp.Request) error {
 		}
 		mode := request.Attributes().FileMode().Perm()
 		// If the client passes an invalid FileMode just use the default 0644.
-		if mode == 0o000 {
+		if mode == 0000 {
-			mode = os.FileMode(0o644)
+			mode = os.FileMode(0644)
 		}
 		// Force directories to be 0755.
 		if request.Attributes().FileMode().IsDir() {
-			mode = 0o755
+			mode = 0755
 		}
 		if err := h.fs.Chmod(request.Filepath, mode); err != nil {
 			if errors.Is(err, os.ErrNotExist) {
@@ -260,6 +255,7 @@ func (h *Handler) Filelist(request *sftp.Request) (sftp.ListerAt, error) {
 		files, err := ioutil.ReadDir(p)
 		if err != nil {
 			h.logger.WithField("source", request.Filepath).WithField("error", err).Error("error while listing directory")
+
 			return nil, sftp.ErrSSHFxFailure
 		}
 		return ListerAt(files), nil
@@ -281,10 +277,6 @@ func (h *Handler) Filelist(request *sftp.Request) (sftp.ListerAt, error) {
 // Determines if a user has permission to perform a specific action on the SFTP server. These
 // permissions are defined and returned by the Panel API.
 func (h *Handler) can(permission string) bool {
-	if h.server.IsSuspended() {
-		return false
-	}
-
 	// SFTPServer owners and super admins have their permissions returned as '[*]' via the Panel
 	// API, so for the sake of speed do an initial check for that before iterating over the
 	// entire array of permissions.

sftp/server.go

@@ -3,9 +3,11 @@ package sftp
 import (
 	"context"
 	"crypto/rand"
+	"crypto/rsa"
 	"crypto/x509"
 	"encoding/pem"
 	"io"
+	"io/ioutil"
 	"net"
 	"os"
 	"path"
@@ -16,12 +18,10 @@ import (
 	"emperror.dev/errors"
 	"github.com/apex/log"
 	"github.com/pkg/sftp"
-	"golang.org/x/crypto/ed25519"
-	"golang.org/x/crypto/ssh"
-
 	"github.com/pterodactyl/wings/config"
 	"github.com/pterodactyl/wings/remote"
 	"github.com/pterodactyl/wings/server"
+	"golang.org/x/crypto/ssh"
 )
 
 // Usernames all follow the same format, so don't even bother hitting the API if the username is not
@@ -47,20 +47,18 @@ func New(m *server.Manager) *SFTPServer {
 	}
 }
 
-// Run starts the SFTP server and add a persistent listener to handle inbound
+// Starts the SFTP server and add a persistent listener to handle inbound SFTP connections.
-// SFTP connections. This will automatically generate an ED25519 key if one does
-// not already exist on the system for host key verification purposes.
 func (c *SFTPServer) Run() error {
-	if _, err := os.Stat(c.PrivateKeyPath()); os.IsNotExist(err) {
+	if _, err := os.Stat(path.Join(c.BasePath, ".sftp/id_rsa")); os.IsNotExist(err) {
-		if err := c.generateED25519PrivateKey(); err != nil {
+		if err := c.generatePrivateKey(); err != nil {
 			return err
 		}
 	} else if err != nil {
-		return errors.Wrap(err, "sftp: could not stat private key file")
+		return errors.Wrap(err, "sftp/server: could not stat private key file")
 	}
-	pb, err := os.ReadFile(c.PrivateKeyPath())
+	pb, err := ioutil.ReadFile(path.Join(c.BasePath, ".sftp/id_rsa"))
 	if err != nil {
-		return errors.Wrap(err, "sftp: could not read private key file")
+		return errors.Wrap(err, "sftp/server: could not read private key file")
 	}
 	private, err := ssh.ParsePrivateKey(pb)
 	if err != nil {
@@ -79,9 +77,7 @@ func (c *SFTPServer) Run() error {
 		return err
 	}
 
-	public := string(ssh.MarshalAuthorizedKey(private.PublicKey()))
+	log.WithField("listen", c.Listen).Info("sftp server listening for connections")
-	log.WithField("listen", c.Listen).WithField("public_key", strings.Trim(public, "\n")).Info("sftp server listening for connections")
-
 	for {
 		if conn, _ := listener.Accept(); conn != nil {
 			go func(conn net.Conn) {
@@ -136,7 +132,7 @@ func (c *SFTPServer) AcceptInbound(conn net.Conn, config *ssh.ServerConfig) {
 			if uuid == "" {
 				return false
 			}
-			return s.ID() == uuid
+			return s.Id() == uuid
 		})
 		if srv == nil {
 			continue
@@ -144,37 +140,33 @@ func (c *SFTPServer) AcceptInbound(conn net.Conn, config *ssh.ServerConfig) {
 
 		// Spin up a SFTP server instance for the authenticated user's server allowing
 		// them access to the underlying filesystem.
-		handler := sftp.NewRequestServer(channel, NewHandler(sconn, srv).Handlers())
+		handler := sftp.NewRequestServer(channel, NewHandler(sconn, srv.Filesystem()).Handlers())
 		if err := handler.Serve(); err == io.EOF {
 			handler.Close()
 		}
 	}
 }
 
-// Generates a new ED25519 private key that is used for host authentication when
+// Generates a private key that will be used by the SFTP server.
-// a user connects to the SFTP server.
+func (c *SFTPServer) generatePrivateKey() error {
-func (c *SFTPServer) generateED25519PrivateKey() error {
+	key, err := rsa.GenerateKey(rand.Reader, 2048)
-	_, priv, err := ed25519.GenerateKey(rand.Reader)
 	if err != nil {
-		return errors.Wrap(err, "sftp: failed to generate ED25519 private key")
+		return errors.WithStack(err)
 	}
-	if err := os.MkdirAll(path.Dir(c.PrivateKeyPath()), 0o755); err != nil {
+	if err := os.MkdirAll(path.Join(c.BasePath, ".sftp"), 0755); err != nil {
-		return errors.Wrap(err, "sftp: could not create internal sftp data directory")
+		return errors.Wrap(err, "sftp/server: could not create .sftp directory")
 	}
-	o, err := os.OpenFile(c.PrivateKeyPath(), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0o600)
+	o, err := os.OpenFile(path.Join(c.BasePath, ".sftp/id_rsa"), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
 	if err != nil {
 		return errors.WithStack(err)
 	}
 	defer o.Close()
 
-	b, err := x509.MarshalPKCS8PrivateKey(priv)
+	err = pem.Encode(o, &pem.Block{
-	if err != nil {
+		Type:  "RSA PRIVATE KEY",
-		return errors.Wrap(err, "sftp: failed to marshal private key into bytes")
+		Bytes: x509.MarshalPKCS1PrivateKey(key),
-	}
+	})
-	if err := pem.Encode(o, &pem.Block{Type: "PRIVATE KEY", Bytes: b}); err != nil {
+	return errors.WithStack(err)
-		return errors.Wrap(err, "sftp: failed to write ED25519 private key to disk")
-	}
-	return nil
 }
 
 // A function capable of validating user credentials with the Panel API.
@@ -216,8 +208,3 @@ func (c *SFTPServer) passwordCallback(conn ssh.ConnMetadata, pass []byte) (*ssh.
 
 	return sshPerm, nil
 }
-
-// PrivateKeyPath returns the path the host private key for this server instance.
-func (c *SFTPServer) PrivateKeyPath() string {
-	return path.Join(c.BasePath, ".sftp/id_ed25519")
-}

sftp/utils.go

@@ -6,15 +6,15 @@ import (
 )
 
 const (
-	// ErrSSHQuotaExceeded extends the default SFTP server to return a quota exceeded error to the client.
+	// Extends the default SFTP server to return a quota exceeded error to the client.
 	//
 	// @see https://tools.ietf.org/id/draft-ietf-secsh-filexfer-13.txt
-	ErrSSHQuotaExceeded = fxErr(15)
+	ErrSSHQuotaExceeded = fxerr(15)
 )
 
 type ListerAt []os.FileInfo
 
-// ListAt returns the number of entries copied and an io.EOF error if we made it to the end of the file list.
+// Returns the number of entries copied and an io.EOF error if we made it to the end of the file list.
 // Take a look at the pkg/sftp godoc for more information about how this function should work.
 func (l ListerAt) ListAt(f []os.FileInfo, offset int64) (int, error) {
 	if offset >= int64(len(l)) {
@@ -28,9 +28,9 @@ func (l ListerAt) ListAt(f []os.FileInfo, offset int64) (int, error) {
 	}
 }
 
-type fxErr uint32
+type fxerr uint32
 
-func (e fxErr) Error() string {
+func (e fxerr) Error() string {
 	switch e {
 	case ErrSSHQuotaExceeded:
 		return "Quota Exceeded"

system/const.go

@@ -1,3 +1,6 @@
 package system
 
-var Version = "develop"
+var (
+	// The current version of this software.
+	Version = "0.0.1"
+)

system/utils.go

@@ -8,16 +8,15 @@ import (
 	"fmt"
 	"io"
 	"strconv"
+	"strings"
 	"sync"
 	"time"
 
 	"emperror.dev/errors"
 )
 
-var (
+var cr = []byte(" \r")
-	cr  = []byte(" \r")
+var crr = []byte("\r\n")
-	crr = []byte("\r\n")
-)
 
 // FirstNotEmpty returns the first string passed in that is not an empty value.
 func FirstNotEmpty(v ...string) string {
@@ -37,14 +36,14 @@ func MustInt(v string) int {
 	return i
 }
 
-func ScanReader(r io.Reader, callback func(line []byte)) error {
+func ScanReader(r io.Reader, callback func(line string)) error {
 	br := bufio.NewReader(r)
 	// Avoid constantly re-allocating memory when we're flooding lines through this
 	// function by using the same buffer for the duration of the call and just truncating
 	// the value back to 0 every loop.
-	buf := &bytes.Buffer{}
+	var str strings.Builder
 	for {
-		buf.Reset()
+		str.Reset()
 		var err error
 		var line []byte
 		var isPrefix bool
@@ -56,7 +55,7 @@ func ScanReader(r io.Reader, callback func(line []byte)) error {
 			// in line with that it thinks is the terminal size. Those returns break a lot of output handling,
 			// so we'll just replace them with proper new-lines and then split it later and send each line as
 			// its own event in the response.
-			buf.Write(bytes.Replace(line, cr, crr, -1))
+			str.Write(bytes.Replace(line, cr, crr, -1))
 			// Finish this loop and begin outputting the line if there is no prefix (the line fit into
 			// the default buffer), or if we hit the end of the line.
 			if !isPrefix || err == io.EOF {
@@ -68,13 +67,10 @@ func ScanReader(r io.Reader, callback func(line []byte)) error {
 				return err
 			}
 		}
-		// Ensure that the scanner is always able to read the last line.
-		_, _ = buf.Write([]byte("\r\n"))
 		// Publish the line for this loop. Break on new-line characters so every line is sent as a single
 		// output event, otherwise you get funky handling in the browser console.
-		s := bufio.NewScanner(buf)
+		for _, line := range strings.Split(str.String(), "\r\n") {
-		for s.Scan() {
+			callback(line)
-			callback(s.Bytes())
 		}
 		// If the error we got previously that lead to the line being output is an io.EOF we want to
 		// exit the entire looping process.