Add error dialogs on GUI error & refactor run.go

Author: grandchild

install_linux.go

@@ -92,3 +92,14 @@ func osRunHookIfExists(scriptFile string) error {
 	}
 	return err
 }
+
+func osShowRawErrorDialog(message string) (err error) {
+	_, err = exec.Command(
+		"zenity",
+		"--error",
+		"--title", "error",
+		"--no-wrap",
+		"--text", message,
+	).Output()
+	return
+}

resources/config.yml

@@ -2,6 +2,7 @@
 variables:
   company: ACME Inc.
   company_short: ACME
+  company_email: support@example.com
   product: Example App
   version: 8.18.0.0
   applauncher: "{{.linux_app_launcher}}"
@@ -12,6 +13,7 @@ start_command: ExampleApp
 icon_file: ExampleApp.png
 
 data_filename: data.zip
+log_filename: installer.log
 
 gui_css: |
   window, dialog, button, entry {

resources/languages/de.yml

@@ -116,3 +116,16 @@ err_cli_mustacceptlicense: >
 err_gui_startup_failed: >
   Der graphische Installer konnte nicht gestartet werden. Die Installation per
   Kommandozeile akzeptiert folgende Parameter
+err_gui_startup_failed_nogtk: |
+  Ihre Linuxversion unterstützt den graphischen
+  Installationsmodus nicht (kein GTK3). Bitte
+  installieren Sie via Kommandozeilenmodus, im
+  Terminal.
+  Um die Hilfe anzuzeigen geben Sie folgendes ein:
+      {{.installerName}} -h
+err_gui_startup_internal_error: |
+  Es ist ein unerwarter Fehler beim Laden des graphischen
+  Installers aufgetreten. Bitte kontaktieren Sie den
+  {{.company_short}}-Support und senden die
+  installer.log-Datei mit wenn Sie können:
+      {{.company_email}}

resources/languages/en.yml

@@ -112,3 +112,14 @@ err_cli_mustacceptlicense: >
 err_gui_startup_failed: >
   The graphical installer failed to start. The installation via command line uses the
   following parameters
+err_gui_startup_failed_nogtk: |
+  Your Linux version does not support the graphical
+  installation mode (no GTK3). Please install via
+  command line mode, on the terminal.
+  To show help, run:
+      {{.installerName}} -h
+err_gui_startup_internal_error: |
+  An unexpected error occurred while loading the GUI,
+  please contact {{.company_short}} support, and provide
+  the installer.log file if you can:
+      {{.company_email}}

run.go

@@ -1,7 +1,6 @@
 package linux_installer
 
 import (
-	// "io"
 	"flag"
 	"fmt"
 	"log"
@@ -16,20 +15,9 @@ const (
 	// Linux terminal command string to clear the current line and reset the cursor
 	clearLineVT100         = "\033[2K\r"
 	cliInstallerMaxLineLen = 80
+	logFilename            = "installer.log"
 )
 
-// startLogging sets up the logging
-func startLogging(logFilename string) *os.File {
-	logfile, err := os.OpenFile(logFilename, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
-	if err != nil {
-		log.Fatal(err)
-	}
-	log.SetFlags(log.Ldate | log.Ltime)
-	// log.SetOutput(io.MultiWriter(os.Stdout, logfile))
-	log.SetOutput(logfile)
-	return logfile
-}
-
 // Run parses commandline options (if any) and starts one of two installer modes,
 // GUI or commandline mode.
 //
@@ -43,15 +31,18 @@ func startLogging(logFilename string) *os.File {
 // "silent" mode. -target and -accept-license are necessary to run commandline install.
 // -lang will also set the default GUI language.
 func Run() {
-	logfile := startLogging("installer.log")
+	logfile := startLogging(logFilename)
 	defer logfile.Close()
 
 	openBoxes()
 	config, err := NewConfig()
 	if err != nil {
 		return
 	}
+	config.Variables["installerName"] = os.Args[0]
 	translator := NewTranslatorVar(config.Variables)
+	installerTempPath := filepath.Join(os.TempDir(), "linux_installer")
+	defer os.RemoveAll(installerTempPath)
 
 	target := flag.String("target", "", translator.Get("cli_help_target"))
 	showLicense := flag.Bool("license", false, translator.Get("cli_help_showlicense"))
@@ -66,6 +57,7 @@ func Run() {
 			fmt.Printf("Language '%s' not available", *lang)
 		}
 	}
+
 	if *showLicense {
 		licenseFile, err := GetResource(
 			fmt.Sprintf("licenses/license_%s.txt", translator.language),
@@ -82,85 +74,122 @@ func Run() {
 		config.NoLauncher = true
 	}
 
-	installerTempPath := filepath.Join(os.TempDir(), "linux_installer")
-	defer os.RemoveAll(installerTempPath)
 	if len(*target) > 0 {
 		if *acceptLicense {
-			installer := NewInstallerTo(*target, installerTempPath, config)
-			installer.CreateLauncher = !config.NoLauncher
-			c := make(chan os.Signal, 1)
-			signal.Notify(c, os.Interrupt)
-			installer.SetProgressFunction(func(status InstallStatus) {
-				file := installer.NextFile().Target
-				if len(file) > cliInstallerMaxLineLen {
-					file = "..." + file[len(file)-(cliInstallerMaxLineLen-3):]
-				}
-				fmt.Print(clearLineVT100 + file)
-			})
-			fmt.Println(translator.Get("silent_installing"))
-			installer.PreInstall()
-			installer.StartInstall()
-			go func() {
-				for range c {
-					installer.Rollback()
-				}
-			}()
-			installer.WaitForDone()
-			installer.PostInstall(
-				translator.Variables,
-				translator.GetAllStringsRaw(),
-			)
-			fmt.Println(clearLineVT100 + installer.SizeString())
-			fmt.Println(translator.Get("silent_done"))
+			RunCliInstall(installerTempPath, *target, translator, config)
 		} else {
 			fmt.Println(translator.Get("err_cli_mustacceptlicense"))
 		}
 		return
 	}
 
-	var guiError error
-	UnpackResourceDir("gui", filepath.Join(installerTempPath, "gui"))
-	guiPlugin, guiError := plugin.Open(filepath.Join(installerTempPath, "gui", "gui.so"))
+	guiError := RunGuiInstall(installerTempPath, translator, config)
 	if guiError != nil {
-		fmt.Println("load plugin")
-		handleGuiErr(guiError, translator)
+		RunTuiInstall(installerTempPath, translator)
+	}
+}
+
+// RunGuiInstall loads the gui.so plugin, and starts the installer GUI.
+func RunGuiInstall(
+	installerTempPath string,
+	translator *Translator,
+	config *Config,
+) (err error) {
+	UnpackResourceDir("gui", filepath.Join(installerTempPath, "gui"))
+	guiPlugin, err := plugin.Open(filepath.Join(installerTempPath, "gui", "gui.so"))
+	if err != nil {
+		err = osShowRawErrorDialog(translator.Get("err_gui_startup_failed_nogtk"))
+		if err != nil {
+			handleGuiErr(err, translator.Get("err_gui_startup_failed_nogtk"))
+		}
 		return
 	}
 	NewGui, err := guiPlugin.Lookup("NewGui")
 	if err != nil {
-		fmt.Println("lookup NewGui")
-		handleGuiErr(guiError, translator)
+		osShowRawErrorDialog(translator.Get("err_gui_startup_internal_error"))
+		handleGuiErr(err, "")
 		return
 	}
 	RunGui, err := guiPlugin.Lookup("RunGui")
 	if err != nil {
-		fmt.Println("lookup RunGui")
-		handleGuiErr(guiError, translator)
+		osShowRawErrorDialog(translator.Get("err_gui_startup_internal_error"))
+		handleGuiErr(err, "")
 		return
 	}
 	installer := NewInstaller(installerTempPath, config)
-	guiError = NewGui.(func(string, *Installer, *Translator, *Config) error)(
+	err = NewGui.(func(string, *Installer, *Translator, *Config) error)(
 		installerTempPath, installer, translator, config,
 	)
-	if guiError != nil {
-		fmt.Println("NewGui()")
-		handleGuiErr(guiError, translator)
+	if err != nil {
+		handleGuiErr(err, translator.Get("err_gui_startup_failed"))
 		return
 	} else {
 		RunGui.(func())()
 	}
-	// if guiError != nil {
+	return
+}
+
+// RunCliInstall runs a "silent" installation, on the command line with no further user
+// interaction.
+func RunCliInstall(
+	installerTempPath, target string, translator *Translator, config *Config,
+) {
+	installer := NewInstallerTo(target, installerTempPath, config)
+	installer.CreateLauncher = !config.NoLauncher
+	cancelChannel := make(chan os.Signal, 1)
+	signal.Notify(cancelChannel, os.Interrupt)
+	installer.SetProgressFunction(func(status InstallStatus) {
+		file := installer.NextFile().Target
+		if len(file) > cliInstallerMaxLineLen {
+			file = "..." + file[len(file)-(cliInstallerMaxLineLen-3):]
+		}
+		fmt.Print(clearLineVT100 + file)
+	})
+	fmt.Println(translator.Get("silent_installing"))
+	installer.PreInstall()
+	installer.StartInstall()
+	go func() {
+		for range cancelChannel {
+			installer.Rollback()
+		}
+	}()
+	installer.WaitForDone()
+	installer.PostInstall(
+		translator.Variables,
+		translator.GetAllStringsRaw(),
+	)
+	fmt.Println(clearLineVT100 + installer.SizeString())
+	fmt.Println(translator.Get("silent_done"))
+}
+
+// RunTuiInstall starts a terminal curses-based UI (currently disabled).
+func RunTuiInstall(installerTempPath string, translator *Translator) {
 	// 	tui, err := NewTui(installerTempPath, translator)
 	// 	if err != nil {
 	// 		log.Println(err)
 	// 	} else {
 	// 		tui.Run()
 	// 	}
-	// }
 }
 
-func handleGuiErr(err error, translator *Translator) {
+// startLogging sets up the logging
+func startLogging(logFilename string) *os.File {
+	logfile, err := os.OpenFile(logFilename, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
+	if err != nil {
+		log.Fatal(err)
+	}
+	log.SetFlags(log.Ldate | log.Ltime)
+	// log.SetOutput(io.MultiWriter(os.Stdout, logfile))
+	log.SetOutput(logfile)
+	return logfile
+}
+
+// handleGuiErr prints and logs GUI startup errors, and prints the commandline usage.
+func handleGuiErr(err error, msg string) {
 	log.Println("Unable to load GUI:", err)
-	fmt.Println(translator.Get("err_gui_startup_failed"))
+	if len(msg) > 0 {
+		log.Println(msg)
+		fmt.Println(msg)
+	}
 	flag.PrintDefaults()
 }