Initial version

Author: xEtarusx

.gitignore

@@ -0,0 +1,3 @@
+.idea
+*.exe
+xplane-gateway-downloader

README.md

@@ -0,0 +1,109 @@
+# X-Plane Gateway Downloader
+
+With this console application you can download airport updates from the X-Plane Gateway directly into your CustomScenery folder.
+
+## Commands
+```
+$ xplane-gateway-downloader --help
+NAME:
+   X-Plane Gateway Downloader - Download airports from X-Plane Gateway with ease
+
+USAGE:
+   xplane-gateway-downloader [global options] command [command options] [arguments...]
+
+DESCRIPTION:
+   Update airport sceneries from the X-Plane Gateway
+
+COMMANDS:
+   install    Install a new airport scenery pack
+   update     Update all installed airport scenery packs
+   uninstall  Uninstall an installed airport scenery pack
+   config     Configure the application
+   help, h    Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+   --help, -h  show help (default: false)
+```
+
+### Configuration
+
+Before you can manage new airports you have to set up the application.
+
+```
+$ xplane-gateway-downloader config --help
+NAME:
+   xplane-gateway-downloader config - Configure the application
+
+USAGE:
+   xplane-gateway-downloader config [command options] [arguments...]
+
+OPTIONS:
+   --custom-scenery-folder path, --csf path  The path to CustomScenery folder of x-plane
+   --x-plane-version version, -v version     Set the current version of x-plane
+```
+
+Run the following commands and replace the placeholder.
+
+- Set the path to the CustomScenery folder in the x-plane game folder. The path must contain the ending slashes!
+  - **Windows:** (use double backslash due to character escaping)
+    ```
+    xplane-gateway-downloader config --custom-scenery-folder C:\\path\\to\\X-Plane 11\\Custom Scenery\\
+    ```
+  - **Linux:**
+    ```
+    xplane-gateway-downloader config --custom-scenery-folder /path/to/Custom Scenery/
+    ```
+
+- Set your X-Plane game version. This will allow the application to not download airports if there is no newer version available and therefore save disk space.
+    Most of you will be at the newest version which currently is 11.55. If not, change the version in the command below.
+    ```
+    xplane-gateway-downloader config --x-plane-version 11.55
+    ```
+
+### Install an airport
+
+```
+$ xplane-gateway-downloader install --help
+NAME:
+   xplane-gateway-downloader install - Install a new airport scenery pack
+
+USAGE:
+   xplane-gateway-downloader install [command options] [arguments...]
+
+OPTIONS:
+   --icao ICAO, -i ICAO  Install an airport by ICAO code
+```
+
+Example: ``xplane-gateway-downloader install --icao EDDF``
+
+### Update all installed airports
+
+```
+$ xplane-gateway-downloader update --help
+NAME:
+   xplane-gateway-downloader update - Update all installed airport scenery packs
+
+USAGE:
+   xplane-gateway-downloader update [command options] [arguments...]
+
+OPTIONS:
+   --help, -h  show help (default: false)
+```
+
+Example: ``xplane-gateway-downloader update``
+
+### Uninstall an installed airport
+
+```
+$ xplane-gateway-downloader uninstall --help
+NAME:
+   xplane-gateway-downloader uninstall - Uninstall an installed airport scenery pack
+
+USAGE:
+   xplane-gateway-downloader uninstall [command options] [arguments...]
+
+OPTIONS:
+   --icao ICAO, -i ICAO  Uninstall an airport by ICAO code
+```
+
+Example: ``xplane-gateway-downloader uninstall --icao EDDF``

app/config.go

@@ -0,0 +1,76 @@
+package app
+
+import (
+	"fmt"
+	"github.com/urfave/cli/v2"
+	"github.com/xEtarusx/xplane-gateway-downloader/config"
+	"github.com/xEtarusx/xplane-gateway-downloader/downloader"
+	"os"
+)
+
+func ActionConfig(c *cli.Context) error {
+	customSceneryFolder := c.String("custom-scenery-folder")
+	xPlaneVersion := c.String("x-plane-version")
+
+	if customSceneryFolder != "" {
+		handleCustomSceneryFolder(customSceneryFolder)
+	}
+
+	if xPlaneVersion != "" {
+		handleXPlaneVersion(xPlaneVersion)
+	}
+
+	return nil
+}
+
+func handleCustomSceneryFolder(path string) {
+	if _, err := os.Stat(path); os.IsNotExist(err) {
+		// path/to/custom-scenery-folder does not exist
+		fmt.Println("The path does not exist. Please make sure that it's pointing to your CustomScenery folder in the X-Plane game folder and ends with a slash")
+		return
+	}
+
+	// Persist the CustomScenery folder path in config.json
+	config.GlobalConfig.CustomSceneryFolder = path
+}
+
+func handleXPlaneVersion(version string) {
+	releases, err := downloader.GetReleaseData()
+	if err != nil {
+		fmt.Println("Could not download release list from gateway")
+		fmt.Println(err)
+		return
+	}
+
+	for _, release := range releases {
+		if release.Version != version {
+			continue
+		}
+
+		// Persist the X-Plane version in config.json
+		config.GlobalConfig.XPlaneVersion = version
+		fmt.Printf("Version X-Plane %s successfully saved\n", version)
+
+		// Download list of all sceneries released with version
+		fmt.Print("Downloading list of released sceneries ... ")
+		sceneriesList, err := downloader.GetReleaseSceneryData(version)
+		if err != nil {
+			fmt.Println("failed")
+			fmt.Printf("Could not download list of released sceneries from gateway for version %s\n", version)
+			fmt.Println(err)
+			return
+		}
+
+		config.GlobalConfig.ReleasedSceneryPacksWithVersion[version] = sceneriesList
+		fmt.Println("done")
+
+		return
+	}
+
+	fmt.Printf("The version %s is invalid\n\n", version)
+	fmt.Println("Valid versions:")
+
+	for _, release := range releases {
+		fmt.Printf("%s (released %s)\n", release.Version, release.Date.Format("2006-01-02"))
+	}
+}

app/helper.go

@@ -0,0 +1,56 @@
+package app
+
+import (
+	"archive/zip"
+	"bytes"
+	"io"
+	"os"
+	"path/filepath"
+)
+
+func GetSceneryPackFolderName(icao string) string {
+	return icao + "_Scenery_Pack"
+}
+
+// WriteZipToFolder Write bytes from a zip archive into destination path
+func WriteZipToFolder(zipContent []byte, destinationPath string) error {
+	// create a zip reader
+	zipReader, err := zip.NewReader(bytes.NewReader(zipContent), int64(len(zipContent)))
+	if err != nil {
+		return err
+	}
+
+	// loop through all the files of the zip archive
+	for _, zipFile := range zipReader.File {
+		fpath := filepath.Join(destinationPath, zipFile.Name)
+
+		if zipFile.FileInfo().IsDir() {
+			// Make Folder
+			_ = os.MkdirAll(fpath, os.ModePerm)
+			continue
+		}
+
+		// Make File
+		if err = os.MkdirAll(filepath.Dir(fpath), os.ModePerm); err != nil {
+			return err
+		}
+
+		outFile, err := os.OpenFile(fpath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, zipFile.Mode())
+		if err != nil {
+			return err
+		}
+
+		rc, err := zipFile.Open()
+		if err != nil {
+			return err
+		}
+
+		_, err = io.Copy(outFile, rc)
+
+		// Close the file without defer to close before next iteration of loop
+		_ = outFile.Close()
+		_ = rc.Close()
+	}
+
+	return nil
+}

app/install.go

@@ -0,0 +1,79 @@
+package app
+
+import (
+	"fmt"
+	"github.com/urfave/cli/v2"
+	"github.com/xEtarusx/xplane-gateway-downloader/config"
+	"github.com/xEtarusx/xplane-gateway-downloader/downloader"
+	"os"
+	"path"
+	"strings"
+)
+
+func ActionInstall(c *cli.Context) error {
+	icao := strings.ToUpper(c.String("icao"))
+
+	if icao == "" {
+		fmt.Println("--icao parameter cannot be empty")
+		return nil
+	}
+
+	// Check if airport is already installed locally
+	if config.GlobalConfig.IsAirportInstalled(icao) {
+		fmt.Printf("Airport %s already installed", icao)
+		return nil
+	}
+
+	// Check if the folder {ICAO}_Scenery_Pack already exist in CustomScenery folder
+	if _, err := os.Stat(path.Join(config.GlobalConfig.CustomSceneryFolder, GetSceneryPackFolderName(icao))); !os.IsNotExist(err) {
+		fmt.Printf("The folder %s already exists in your CustomScenery folder but not in the local config. Aborting\n", GetSceneryPackFolderName(icao))
+		return nil
+	}
+
+	airport, err := downloader.GetAirportData(icao)
+	if err != nil {
+		return err
+	}
+
+	// Check if the user has set their x-plane version
+	if config.GlobalConfig.IsXPlaneVersionSet() {
+		// Check if the airport scenery is already included in the x-plane release
+		if config.GlobalConfig.IsSceneryPackIncluded(airport.RecommendedSceneryId) {
+			fmt.Printf("There is no newer version of this airport available. X-Plane %v contains the latest update.\n", config.GlobalConfig.XPlaneVersion)
+			return nil
+		}
+	}
+
+	scenery, err := downloader.GetSceneryData(airport.RecommendedSceneryId)
+	if err != nil {
+		return err
+	}
+
+	// extract the {ICAO}_Scenery_Pack.zip form the downloaded zip archive
+	sceneryPackBytes, err := scenery.ExtractSceneryPackZip(icao)
+	if err != nil {
+		return err
+	}
+
+	// delete old scenery folder
+	err = os.RemoveAll(path.Join(config.GlobalConfig.CustomSceneryFolder, GetSceneryPackFolderName(icao)))
+	if err != nil {
+		return err
+	}
+
+	// create new scenery folder
+	err = WriteZipToFolder(sceneryPackBytes, config.GlobalConfig.CustomSceneryFolder)
+	if err != nil {
+		return err
+	}
+
+	fmt.Printf("%s was successfully installed\n", airport.ICAO)
+
+	// Store the scenery approved date for information purpose in the airport
+	airport.SceneryApprovedDate = scenery.DateApproved
+
+	// Store airport in config
+	config.GlobalConfig.SaveAirport(airport)
+
+	return nil
+}

app/uninstall.go

@@ -0,0 +1,36 @@
+package app
+
+import (
+	"fmt"
+	"github.com/urfave/cli/v2"
+	"github.com/xEtarusx/xplane-gateway-downloader/config"
+	"os"
+	"path"
+	"strings"
+)
+
+func ActionUninstall(c *cli.Context) error {
+	icao := strings.ToUpper(c.String("icao"))
+
+	if icao == "" {
+		fmt.Println("--icao parameter cannot be empty")
+		return nil
+	}
+
+	// Check if airport is not installed locally
+	if !config.GlobalConfig.IsAirportInstalled(icao) {
+		fmt.Printf("Airport %s is not installed", icao)
+		return nil
+	}
+
+	// delete scenery folder
+	err := os.RemoveAll(path.Join(config.GlobalConfig.CustomSceneryFolder, GetSceneryPackFolderName(icao)))
+	if err != nil {
+		return err
+	}
+
+	// delete airport from local config
+	config.GlobalConfig.AirportConfig = config.GlobalConfig.RemoveAirport(icao)
+
+	return nil
+}