Improve error handling

- Improved the error handling when using `catalogue` and `download` commands.
- Reduced the timeout for the login in headless mode.
- Fixed a few errors in the documentation and added an example for running Gogg in debug mode in Windows.

Author: habedi

README.md

@@ -65,7 +65,8 @@ Additionally, it allows users to perform the following actions:
 - Download game files (like installers, patches, and bonus content)
 - Filter files to be downloaded by platform, language, and other attributes like content type
 - Download files using multiple threads to speed up the process
-- Resume interrupted downloads
+- Resume interrupted downloads and only download missing or newer files
+- Verify the integrity of downloaded files by calculating their hashes
 
 ## Getting Started
 

client/login.go

@@ -37,16 +37,19 @@ func Login(loginURL string, username string, password string, headless bool) err
 	ctx, cancel := createChromeContext(headless)
 	defer cancel()
 
+	log.Info().Msg("Trying to login to GOG.com.")
+
 	// Perform the login
-	finalURL, err := performLogin(ctx, loginURL, username, password)
+	finalURL, err := performLogin(ctx, loginURL, username, password, headless)
 	if err != nil {
 		if headless {
-			log.Warn().Err(err).Msg("Headless login failed, retrying with window mode")
+			log.Warn().Err(err).Msg("Headless login failed, retrying with window mode.")
+			fmt.Println("Headless login failed, retrying with window mode.")
 			// Retry with window mode if headless login fails
 			ctx, cancel = createChromeContext(false)
 			defer cancel()
 
-			finalURL, err = performLogin(ctx, loginURL, username, password)
+			finalURL, err = performLogin(ctx, loginURL, username, password, false)
 			if err != nil {
 				return fmt.Errorf("failed to login: %w", err)
 			}
@@ -86,7 +89,11 @@ func RefreshToken() (*db.Token, error) {
 		return nil, fmt.Errorf("failed to retrieve token record: %w", err)
 	}
 
-	if !isTokenValid(token) {
+	// Check if the token is valid and refresh it if necessary
+	tokenStatus, err := isTokenValid(token)
+	if err != nil {
+		return nil, fmt.Errorf("failed to check token validity: %w", err)
+	} else if !tokenStatus {
 		if err := refreshAccessToken(token); err != nil {
 			return nil, fmt.Errorf("failed to refresh token: %w", err)
 		}
@@ -135,23 +142,24 @@ func refreshAccessToken(token *db.Token) error {
 
 // isTokenValid checks if the access token (stored in the database) is still valid.
 // It takes a pointer to the token record and returns a boolean indicating whether the token is valid.
-func isTokenValid(token *db.Token) bool {
+func isTokenValid(token *db.Token) (bool, error) {
 
 	if token == nil {
-		return false
+		return false, fmt.Errorf("access token data does not exist in the database. Please login first")
 	}
 
-	if token.AccessToken == "" || token.ExpiresAt == "" {
-		return false
+	// Check if the token fields are empty (needs refresh)
+	if token.AccessToken == "" || token.RefreshToken == "" || token.ExpiresAt == "" {
+		return false, nil
 	}
 
 	expiresAt, err := time.Parse(time.RFC3339, token.ExpiresAt)
 	if err != nil {
-		log.Error().Err(err).Msg("Invalid expiration time format")
-		return false
+		log.Error().Msgf("Failed to parse expiration time: %s", token.ExpiresAt)
+		return false, err
+	} else {
+		return time.Now().Before(expiresAt), nil
 	}
-
-	return time.Now().Before(expiresAt)
 }
 
 // createChromeContext creates a new ChromeDP context with the specified option to run Chrome in headless mode or not.
@@ -188,12 +196,27 @@ func createChromeContext(headless bool) (context.Context, context.CancelFunc) {
 }
 
 // performLogin performs the login process using the provided username and password and returns the final URL after successful login.
-// It takes the ChromeDP context, login URL, username, and password as parameters and returns the final URL and an error if the login process fails.
-func performLogin(ctx context.Context, loginURL string, username string, password string) (string, error) {
-	timeoutCtx, cancel := context.WithTimeout(ctx, 4*time.Minute)
-	defer cancel()
+// It takes the ChromeDP context, login URL, username, password, and a boolean indicating whether to use headless mode as parameters, and returns the final URL and an error if the login process fails.
+func performLogin(ctx context.Context, loginURL string, username string, password string,
+	headlessMode bool) (string, error) {
 
+	var timeoutCtx context.Context
+	var cancel context.CancelFunc
 	var finalURL string
+
+	if headlessMode {
+		// Timeout for login in headless mode 30
+		timeoutCtx, cancel = context.WithTimeout(ctx, 30*time.Second)
+		defer cancel()
+	} else {
+		// Timeout for login in window mode 4 minutes
+		timeoutCtx, cancel = context.WithTimeout(ctx, 4*time.Minute)
+	}
+
+	// Close the context when the function returns
+	defer cancel()
+
+	// Start the login process
 	err := chromedp.Run(timeoutCtx,
 		chromedp.Navigate(loginURL),
 		chromedp.WaitVisible(`#login_username`, chromedp.ByID),

cmd/catalogue.go

@@ -64,7 +64,7 @@ func listGames(cmd *cobra.Command, args []string) {
 
 	// Check if there are any games to display
 	if len(games) == 0 {
-		cmd.Println("No games found in the catalogue. Use `gogg catalogue refresh` to update the catalogue.")
+		cmd.Println("Game catalogue is empty. Did you refresh the catalogue?")
 		return
 	}
 
@@ -137,7 +137,7 @@ func showGameInfo(cmd *cobra.Command, gameID int) {
 	// Check if the game was found
 	if game == nil {
 		log.Info().Msgf("No game found with ID=%d", gameID)
-		cmd.Println("No game found with the specified ID.")
+		cmd.Println("No game found with the specified ID. Please check the game ID.")
 		return
 	}
 
@@ -196,11 +196,7 @@ func refreshCatalogue(cmd *cobra.Command, numThreads int) {
 
 	// Try to refresh the access token
 	token, err := client.RefreshToken()
-	if err != nil {
-		cmd.PrintErrln("Error: Failed to refresh the access token. Please login again.")
-	}
-
-	if token == nil {
+	if err != nil || token == nil {
 		cmd.PrintErrln("Error: Failed to refresh the access token. Did you login?")
 		return
 	}
@@ -387,13 +383,6 @@ func exportCmd() *cobra.Command {
 func exportCatalogue(cmd *cobra.Command, exportPath, exportFormat string) {
 	log.Info().Msg("Exporting the game catalogue...")
 
-	// Ensure the directory exists or create it
-	if err := os.MkdirAll(exportPath, os.ModePerm); err != nil {
-		log.Error().Err(err).Msg("Failed to create export directory.")
-		cmd.PrintErrln("Error: Failed to create export directory.")
-		return
-	}
-
 	// Validate the export format
 	if exportFormat != "json" && exportFormat != "csv" {
 		log.Error().Msg("Invalid export format. Supported formats: json, csv")
@@ -427,7 +416,7 @@ func exportCatalogue(cmd *cobra.Command, exportPath, exportFormat string) {
 		return
 	}
 
-	log.Info().Msgf("Game catalogue exported successfully to %s.", filePath)
+	cmd.Printf("Game catalogue exported successfully to: \"%s\"\n", filePath)
 }
 
 // exportCatalogueToCSV exports the game catalogue to a CSV file.
@@ -438,6 +427,13 @@ func exportCatalogueToCSV(path string) error {
 	games, err := db.GetCatalogue()
 	if err != nil {
 		return err
+	} else if len(games) == 0 {
+		fmt.Println("No games found to export. Did you refresh the catalogue?")
+	}
+
+	//  Make sure the directory of the path exists
+	if err := ensurePathExists(path); err != nil {
+		return err
 	}
 
 	// writeGamesToCSV writes the games to a CSV file.
@@ -479,6 +475,14 @@ func exportCatalogueToJSON(path string) error {
 	games, err := db.GetCatalogue()
 	if err != nil {
 		return err
+	} else if len(games) == 0 {
+		fmt.Println("No games found to export. Did you refresh the catalogue?")
+		return nil
+	}
+
+	//  Make sure the directory of the path exists
+	if err := ensurePathExists(path); err != nil {
+		return err
 	}
 
 	// writeGamesToJSON writes the games to a JSON file.
@@ -503,3 +507,15 @@ func exportCatalogueToJSON(path string) error {
 	// Write the full game catalogue to a JSON file
 	return writeGamesToJSON(path, games)
 }
+
+// ensurePathExists checks if the directory of the given path exists and creates it if it doesn't.
+// It takes a string representing the path and returns an error if any.
+func ensurePathExists(path string) error {
+	if _, err := os.Stat(filepath.Dir(path)); os.IsNotExist(err) {
+		if err := os.MkdirAll(filepath.Dir(path), 0750); err != nil {
+			log.Error().Err(err).Msgf("Failed to create directory %s", filepath.Dir(path))
+			return err
+		}
+	}
+	return nil
+}

cmd/download.go

@@ -80,7 +80,7 @@ func executeDownload(gameID int, downloadPath, language, platformName string, ex
 
 	// Try to refresh the access token
 	if _, err := client.RefreshToken(); err != nil {
-		log.Error().Msg("Failed to refresh the access token. Please login again.")
+		fmt.Println("Failed to find or refresh the access token. Did you login?")
 		return
 	}
 

cmd/version.go

@@ -6,7 +6,7 @@ import (
 
 var (
 	// version holds the current version of the Gogg.
-	version = "0.3.0"
+	version = "0.3.1"
 )
 
 // versionCmd creates a new cobra.Command that shows the version of Gogg.

db/db.go

@@ -29,6 +29,7 @@ func InitDB() error {
 		return err
 	}
 
+	// Configure the GORM logger
 	configureLogger()
 
 	log.Info().Msg("Database initialized successfully")
@@ -39,7 +40,7 @@ func InitDB() error {
 // It returns an error if the directory creation fails.
 func createDBDirectory() error {
 	if _, err := os.Stat(filepath.Dir(Path)); os.IsNotExist(err) {
-		if err := os.MkdirAll(filepath.Dir(Path), 0755); err != nil {
+		if err := os.MkdirAll(filepath.Dir(Path), 0750); err != nil {
 			log.Error().Err(err).Msg("Failed to create database directory")
 			return err
 		}
@@ -94,3 +95,5 @@ func CloseDB() error {
 	}
 	return sqlDB.Close()
 }
+
+//

docs/README.md

@@ -102,16 +102,16 @@ gogg download <game_id> <download_dir>
 The `download` command supports the following additional options:
 
 - `--platform`: Filter the files to be downloaded by platform (all, windows, mac, linux) (default is windows)
-- `--lang`: Filter the files to be downloaded by language (all, en, fr, de, es, it, pl, ru, zh) (default is en)
+- `--lang`: Filter the files to be downloaded by language (en, fr, de, es, it, ru, pl, pt-BR, zh-Hans, ja, ko) (default
+  is en)
 - `--dlcs`: Include DLC files in the download (default is true)
 - `--extras`: Include extra files in the download like soundtracks, wallpapers, etc. (default is true)
 - `--resume`: Resume interrupted downloads (default is true)
 - `--threads`: Number of worker threads to use for downloading (default is 5)
 - `--flatten`: Flatten the directory structure of the downloaded files (default is true)
 
 For example, to download all files (English language) of a game with the ID `<game_id>` to the directory
-`<download_dir>`
-with the specified options:
+`<download_dir>` with the specified options:
 
 ```sh
 gogg download <game_id> <download_dir> --platform=all --lang=en --dlcs=true --extras=true \
@@ -123,7 +123,15 @@ gogg download <game_id> <download_dir> --platform=all --lang=en --dlcs=true --ex
 To enable debug mode, set the `DEBUG_GOGG` environment variable to `true` or `1` when running Gogg.
 In debug mode, Gogg will be much more verbose and print a lot of information to the console.
 
+#### Linux and macOS
+
 ```sh
 DEBUG_GOGG=true gogg <command>
 ```
 
+#### Windows (PowerShell)
+
+```powershell
+$env:DEBUG_GOGG = "true"; gogg <command>
+```
+