Merge pull request #1495 from hydralauncher/feat/automatic-cloud-sync

feat: adding automatic cloud sync

Author: thegrannychaseroperation

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hydralauncher",
-  "version": "3.2.3",
+  "version": "3.3.0",
   "description": "Hydra",
   "main": "./out/main/index.js",
   "author": "Los Broxas",

src/locales/en/translation.json

@@ -178,6 +178,8 @@
     "manage_files_description": "Manage which files will be backed up and restored",
     "select_folder": "Select folder",
     "backup_from": "Backup from {{date}}",
+    "automatic_backup_from": "Automatic backup from {{date}}",
+    "enable_automatic_cloud_sync": "Enable automatic cloud sync",
     "custom_backup_location_set": "Custom backup location set",
     "no_directory_selected": "No directory selected",
     "no_write_permission": "Cannot download into this directory. Click here to learn more.",

src/locales/es/translation.json

@@ -174,6 +174,8 @@
     "manage_files_description": "Gestiona los archivos que serán respaldados y restaurados",
     "select_folder": "Seleccionar carpeta",
     "backup_from": "Copia de seguridad de {{date}}",
+    "automatic_backup_from": "Copia de seguridad automática de {{date}}",
+    "enable_automatic_cloud_sync": "Habilitar sincronización automática en la nube",
     "custom_backup_location_set": "Se configuró la carpeta de copia de seguridad",
     "clear": "Limpiar",
     "no_directory_selected": "No se seleccionó un directorio",

src/locales/pt-BR/translation.json

@@ -165,6 +165,8 @@
     "max_number_of_artifacts_reached": "Número máximo de backups atingido para este jogo",
     "achievements_not_sync": "Veja como exibir suas conquistas no perfil",
     "backup_from": "Backup de {{date}}",
+    "automatic_backup_from": "Backup automático de {{date}}",
+    "enable_automatic_cloud_sync": "Habilitar sincronização automática na nuvem",
     "custom_backup_location_set": "Localização customizada selecionada",
     "select_folder": "Selecione a pasta",
     "manage_files_description": "Gerencie quais arquivos serão feitos backup",

src/locales/ru/translation.json

@@ -178,6 +178,8 @@
     "manage_files_description": "Управляйте файлами, которые будут сохраняться и восстанавливаться",
     "select_folder": "Выбрать папку",
     "backup_from": "Резервная копия от {{date}}",
+    "automatic_backup_from": "Автоматическая резервная копия от {{date}}",
+    "enable_automatic_cloud_sync": "Включить автоматическую синхронизацию в облаке",
     "custom_backup_location_set": "Установлено настраиваемое местоположение резервной копии",
     "no_directory_selected": "Не выбран каталог",
     "no_write_permission": "Невозможно загрузить в эту директорию. Нажмите здесь, чтобы узнать больше.",

src/main/events/cloud-save/upload-save-game.ts

@@ -1,106 +1,24 @@
-import { HydraApi, logger, Ludusavi, WindowManager } from "@main/services";
+import { CloudSync } from "@main/services";
 import { registerEvent } from "../register-event";
-import fs from "node:fs";
-import path from "node:path";
-import * as tar from "tar";
-import crypto from "node:crypto";
 import type { GameShop } from "@types";
-import axios from "axios";
-import os from "node:os";
-import { backupsPath } from "@main/constants";
-import { app } from "electron";
-import { normalizePath } from "@main/helpers";
-import { gamesSublevel, levelKeys } from "@main/level";
-
-const bundleBackup = async (
-  shop: GameShop,
-  objectId: string,
-  winePrefix: string | null
-) => {
-  const backupPath = path.join(backupsPath, `${shop}-${objectId}`);
-
-  // Remove existing backup
-  if (fs.existsSync(backupPath)) {
-    fs.rmSync(backupPath, { recursive: true });
-  }
-
-  await Ludusavi.backupGame(shop, objectId, backupPath, winePrefix);
-
-  const tarLocation = path.join(backupsPath, `${crypto.randomUUID()}.tar`);
-
-  await tar.create(
-    {
-      gzip: false,
-      file: tarLocation,
-      cwd: backupPath,
-    },
-    ["."]
-  );
-
-  return tarLocation;
-};
+import { t } from "i18next";
+import { format } from "date-fns";
 
 const uploadSaveGame = async (
   _event: Electron.IpcMainInvokeEvent,
   objectId: string,
   shop: GameShop,
   downloadOptionTitle: string | null
 ) => {
-  const game = await gamesSublevel.get(levelKeys.game(shop, objectId));
-
-  const bundleLocation = await bundleBackup(
-    shop,
+  return CloudSync.uploadSaveGame(
     objectId,
-    game?.winePrefixPath ?? null
+    shop,
+    downloadOptionTitle,
+    t("backup_from", {
+      ns: "game_details",
+      date: format(new Date(), "dd/MM/yyyy"),
+    })
   );
-
-  fs.stat(bundleLocation, async (err, stat) => {
-    if (err) {
-      logger.error("Failed to get zip file stats", err);
-      throw err;
-    }
-
-    const { uploadUrl } = await HydraApi.post<{
-      id: string;
-      uploadUrl: string;
-    }>("/profile/games/artifacts", {
-      artifactLengthInBytes: stat.size,
-      shop,
-      objectId,
-      hostname: os.hostname(),
-      homeDir: normalizePath(app.getPath("home")),
-      downloadOptionTitle,
-      platform: os.platform(),
-    });
-
-    fs.readFile(bundleLocation, async (err, fileBuffer) => {
-      if (err) {
-        logger.error("Failed to read zip file", err);
-        throw err;
-      }
-
-      await axios.put(uploadUrl, fileBuffer, {
-        headers: {
-          "Content-Type": "application/tar",
-        },
-        onUploadProgress: (progressEvent) => {
-          logger.log(progressEvent);
-        },
-      });
-
-      WindowManager.mainWindow?.webContents.send(
-        `on-upload-complete-${objectId}-${shop}`,
-        true
-      );
-
-      fs.rm(bundleLocation, (err) => {
-        if (err) {
-          logger.error("Failed to remove tar file", err);
-          throw err;
-        }
-      });
-    });
-  });
 };
 
 registerEvent("uploadSaveGame", uploadSaveGame);

src/main/events/index.ts

@@ -31,11 +31,13 @@ import "./library/remove-game";
 import "./library/remove-game-from-library";
 import "./library/select-game-wine-prefix";
 import "./library/reset-game-achievements";
+import "./library/toggle-automatic-cloud-sync";
 import "./misc/open-checkout";
 import "./misc/open-external";
 import "./misc/show-open-dialog";
 import "./misc/get-features";
 import "./misc/show-item-in-folder";
+import "./misc/get-badges";
 import "./torrenting/cancel-game-download";
 import "./torrenting/pause-game-download";
 import "./torrenting/resume-game-download";
@@ -58,6 +60,7 @@ import "./user/get-blocked-users";
 import "./user/block-user";
 import "./user/unblock-user";
 import "./user/get-user-friends";
+import "./user/get-auth";
 import "./user/get-user-stats";
 import "./user/report-user";
 import "./user/get-unlocked-achievements";
@@ -87,7 +90,6 @@ import "./themes/get-custom-theme-by-id";
 import "./themes/get-active-custom-theme";
 import "./themes/close-editor-window";
 import "./themes/toggle-custom-theme";
-import "./misc/get-badges";
 import { isPortableVersion } from "@main/helpers";
 
 ipcMain.handle("ping", () => "pong");

src/main/events/library/toggle-automatic-cloud-sync.ts

@@ -0,0 +1,23 @@
+import { registerEvent } from "../register-event";
+import { levelKeys, gamesSublevel } from "@main/level";
+import type { GameShop } from "@types";
+
+const toggleAutomaticCloudSync = async (
+  _event: Electron.IpcMainInvokeEvent,
+  shop: GameShop,
+  objectId: string,
+  automaticCloudSync: boolean
+) => {
+  const gameKey = levelKeys.game(shop, objectId);
+
+  const game = await gamesSublevel.get(gameKey);
+
+  if (!game) return;
+
+  await gamesSublevel.put(gameKey, {
+    ...game,
+    automaticCloudSync,
+  });
+};
+
+registerEvent("toggleAutomaticCloudSync", toggleAutomaticCloudSync);

src/main/events/user/get-auth.ts

@@ -0,0 +1,11 @@
+import { db, levelKeys } from "@main/level";
+import type { Auth } from "@types";
+
+import { registerEvent } from "../register-event";
+
+const getAuth = async (_event: Electron.IpcMainInvokeEvent) =>
+  db.get<string, Auth>(levelKeys.auth, {
+    valueEncoding: "json",
+  });
+
+registerEvent("getAuth", getAuth);

src/main/main.ts

@@ -62,8 +62,6 @@ export const loadState = async () => {
       game.uri !== null
   );
 
-  console.log("downloadsToSeed", downloadsToSeed);
-
   await DownloadManager.startRPC(nextItemOnQueue, downloadsToSeed);
 
   startMainLoop();

src/main/services/cloud-sync.ts

@@ -0,0 +1,112 @@
+import { levelKeys, gamesSublevel, db } from "@main/level";
+import { app } from "electron";
+import path from "node:path";
+import * as tar from "tar";
+import crypto from "node:crypto";
+import fs from "node:fs";
+import os from "node:os";
+import type { GameShop, User } from "@types";
+import { backupsPath } from "@main/constants";
+import { HydraApi } from "./hydra-api";
+import { normalizePath } from "@main/helpers";
+import { logger } from "./logger";
+import { WindowManager } from "./window-manager";
+import axios from "axios";
+import { Ludusavi } from "./ludusavi";
+import { isFuture, isToday } from "date-fns";
+import { SubscriptionRequiredError } from "@shared";
+
+export class CloudSync {
+  private static async bundleBackup(
+    shop: GameShop,
+    objectId: string,
+    winePrefix: string | null
+  ) {
+    const backupPath = path.join(backupsPath, `${shop}-${objectId}`);
+
+    // Remove existing backup
+    if (fs.existsSync(backupPath)) {
+      fs.rmSync(backupPath, { recursive: true });
+    }
+
+    await Ludusavi.backupGame(shop, objectId, backupPath, winePrefix);
+
+    const tarLocation = path.join(backupsPath, `${crypto.randomUUID()}.tar`);
+
+    await tar.create(
+      {
+        gzip: false,
+        file: tarLocation,
+        cwd: backupPath,
+      },
+      ["."]
+    );
+
+    return tarLocation;
+  }
+
+  public static async uploadSaveGame(
+    objectId: string,
+    shop: GameShop,
+    downloadOptionTitle: string | null,
+    label?: string
+  ) {
+    const hasActiveSubscription = await db
+      .get<string, User>(levelKeys.user, { valueEncoding: "json" })
+      .then((user) => {
+        const expiresAt = user?.subscription?.expiresAt;
+        return expiresAt && (isFuture(expiresAt) || isToday(expiresAt));
+      });
+
+    if (!hasActiveSubscription) {
+      throw new SubscriptionRequiredError();
+    }
+
+    const game = await gamesSublevel.get(levelKeys.game(shop, objectId));
+
+    const bundleLocation = await this.bundleBackup(
+      shop,
+      objectId,
+      game?.winePrefixPath ?? null
+    );
+
+    const stat = await fs.promises.stat(bundleLocation);
+
+    const { uploadUrl } = await HydraApi.post<{
+      id: string;
+      uploadUrl: string;
+    }>("/profile/games/artifacts", {
+      artifactLengthInBytes: stat.size,
+      shop,
+      objectId,
+      hostname: os.hostname(),
+      homeDir: normalizePath(app.getPath("home")),
+      downloadOptionTitle,
+      platform: os.platform(),
+      label,
+    });
+
+    const fileBuffer = await fs.promises.readFile(bundleLocation);
+
+    await axios.put(uploadUrl, fileBuffer, {
+      headers: {
+        "Content-Type": "application/tar",
+      },
+      onUploadProgress: (progressEvent) => {
+        logger.log(progressEvent);
+      },
+    });
+
+    WindowManager.mainWindow?.webContents.send(
+      `on-upload-complete-${objectId}-${shop}`,
+      true
+    );
+
+    fs.rm(bundleLocation, (err) => {
+      if (err) {
+        logger.error("Failed to remove tar file", err);
+        throw err;
+      }
+    });
+  }
+}

src/main/services/download/torbox.ts

@@ -6,6 +6,7 @@ import type {
   TorBoxAddTorrentRequest,
   TorBoxRequestLinkRequest,
 } from "@types";
+import { appVersion } from "@main/constants";
 
 export class TorBoxClient {
   private static instance: AxiosInstance;
@@ -18,6 +19,7 @@ export class TorBoxClient {
       baseURL: this.baseURL,
       headers: {
         Authorization: `Bearer ${apiToken}`,
+        "User-Agent": `Hydra/${appVersion}`,
       },
     });
   }

src/main/services/index.ts

@@ -7,3 +7,4 @@ export * from "./process-watcher";
 export * from "./main-loop";
 export * from "./hydra-api";
 export * from "./ludusavi";
+export * from "./cloud-sync";