stack_file_system.dart

/* 
 * This file is part of Stack Wallet.
 * 
 * Copyright (c) 2023 Cypher Stack
 * All Rights Reserved.
 * The code is distributed under GPLv3 license, see LICENSE file for details.
 * Generated by Cypher Stack on 2023-05-26
 *
 */

import 'dart:io';

import 'package:path/path.dart' as path;
import 'package:path_provider/path_provider.dart';

import '../app_config.dart';
import 'prefs.dart';
import 'util.dart';

abstract class StackFileSystem {
  static String? _overrideDesktopDirPath;
  static bool _overrideDirSet = false;
  static void setDesktopOverrideDir(String dirPath) {
    if (_overrideDirSet) {
      throw Exception(
        "Attempted to change StackFileSystem._overrideDir unexpectedly",
      );
    }
    _overrideDesktopDirPath = dirPath;
    _overrideDirSet = true;
  }

  static bool get _createSubDirs =>
      Util.isDesktop || AppConfig.appName == "Campfire";

  static Future<Directory> applicationRootDirectory() async {
    Directory appDirectory;

    // todo: can merge and do same as regular linux home dir?
    if (Util.isArmLinux) {
      appDirectory = await getApplicationDocumentsDirectory();
      appDirectory = Directory(
        path.join(appDirectory.path, ".${AppConfig.appDefaultDataDirName}"),
      );
    } else if (Platform.isLinux) {
      if (_overrideDesktopDirPath != null) {
        appDirectory = Directory(_overrideDesktopDirPath!);
      } else {
        appDirectory = Directory(
          path.join(
            Platform.environment['HOME']!,
            ".${AppConfig.appDefaultDataDirName}",
          ),
        );
      }
    } else if (Platform.isWindows) {
      if (_overrideDesktopDirPath != null) {
        appDirectory = Directory(_overrideDesktopDirPath!);
      } else {
        appDirectory = await getApplicationSupportDirectory();
      }
    } else if (Platform.isMacOS) {
      if (_overrideDesktopDirPath != null) {
        appDirectory = Directory(_overrideDesktopDirPath!);
      } else {
        appDirectory = await getLibraryDirectory();
        appDirectory = Directory(
          path.join(appDirectory.path, AppConfig.appDefaultDataDirName),
        );
      }
    } else if (Platform.isIOS) {
      // todo: check if we need different behaviour here
      if (Util.isDesktop) {
        appDirectory = await getLibraryDirectory();
      } else {
        appDirectory = await getLibraryDirectory();
      }
    } else if (Platform.isAndroid) {
      appDirectory = await getApplicationDocumentsDirectory();
    } else {
      throw Exception("Unsupported platform");
    }
    if (!appDirectory.existsSync()) {
      await appDirectory.create(recursive: true);
    }
    return appDirectory;
  }

  static Future<Directory> applicationIsarDirectory() async {
    final root = await applicationRootDirectory();
    if (_createSubDirs) {
      final dir = Directory(path.join(root.path, "isar"));
      if (!dir.existsSync()) {
        await dir.create();
      }
      return dir;
    } else {
      return root;
    }
  }

  static Future<Directory> applicationDriftDirectory() async {
    final root = await applicationRootDirectory();
    if (_createSubDirs) {
      final dir = Directory(path.join(root.path, "drift"));
      if (!dir.existsSync()) {
        await dir.create();
      }
      return dir;
    } else {
      return root;
    }
  }

  // Not used in general now. See applicationFiroCacheSQLiteDirectory()
  // static Future<Directory> applicationSQLiteDirectory() async {
  //   final root = await applicationRootDirectory();
  //   if (_createSubDirs) {
  //     final dir = Directory("${root.path}/sqlite");
  //     if (!dir.existsSync()) {
  //       await dir.create();
  //     }
  //     return dir;
  //   } else {
  //     return root;
  //   }
  // }

  static Future<Directory> applicationTorDirectory() async {
    final root = await applicationRootDirectory();
    if (_createSubDirs) {
      final dir = Directory(path.join(root.path, "tor"));
      if (!dir.existsSync()) {
        await dir.create();
      }
      return dir;
    } else {
      return root;
    }
  }

  static Future<Directory> applicationMwebdDirectory(String network) async {
    final root = await applicationRootDirectory();
    final dir = Directory(path.join(root.path, "mwebd", network));
    if (!dir.existsSync()) {
      await dir.create(recursive: true);
    }
    return dir;
  }

  static Future<Directory> applicationFiroCacheSQLiteDirectory() async {
    final root = await applicationRootDirectory();
    if (_createSubDirs) {
      final dir = Directory(path.join(root.path, "sqlite", "firo_cache"));
      if (!dir.existsSync()) {
        await dir.create(recursive: true);
      }
      return dir;
    } else {
      return root;
    }
  }

  static Future<Directory> applicationHiveDirectory() async {
    final root = await applicationRootDirectory();
    if (_createSubDirs) {
      final dir = Directory(path.join(root.path, "hive"));
      if (!dir.existsSync()) {
        await dir.create();
      }
      return dir;
    } else {
      return root;
    }
  }

  static Future<Directory> applicationXelisDirectory() async {
    final root = await applicationRootDirectory();
    final dir = Directory(path.join(root.path, "xelis"));
    if (!dir.existsSync()) {
      await dir.create();
    }
    return dir;
  }

  static Future<Directory> applicationXelisTableDirectory() async {
    final xelis = await applicationXelisDirectory();
    final dir = Directory(path.join(xelis.path, "table"));
    if (!dir.existsSync()) {
      await dir.create();
    }
    return dir;
  }

  static Future<void> initThemesDir() async {
    final root = await applicationRootDirectory();

    final dir = Directory(path.join(root.path, "themes"));
    if (!dir.existsSync()) {
      await dir.create();
    }
    themesDir = dir;
  }

  static Directory? themesDir;

  static Future<Directory> applicationLogsDirectory(Prefs prefs) async {
    // if prefs logs path is set, use that
    if (prefs.logsPath != null) {
      final dir = Directory(prefs.logsPath!);
      if (await dir.exists()) {
        return dir;
      }
    }

    final Directory logsDir;

    // When a desktop override dir is set (e.g. the Flatpak XDG_DATA_HOME
    // location or the -d launch flag) keep logs under that persistent root
    // so they follow the data directory rather than landing in the
    // application documents directory.
    if (_overrideDesktopDirPath != null) {
      logsDir = Directory(path.join(_overrideDesktopDirPath!, "logs"));
    } else {
      final appDocsDir = await getApplicationDocumentsDirectory();
      const logsDirName = "${AppConfig.prefix}_Logs";

      if (Platform.isIOS) {
        logsDir = Directory(path.join(appDocsDir.path, "logs"));
      } else if (Platform.isMacOS || Platform.isLinux || Platform.isWindows) {
        // TODO check this is correct for macos
        logsDir = Directory(path.join(appDocsDir.path, logsDirName));
      } else if (Platform.isAndroid) {
        // final dir = await wtfAndroidDocumentsPath();
        // final logsDirPath = path.join(dir.path, logsDirName);
        // logsDir = Directory(logsDirPath);

        logsDir = Directory(path.join(appDocsDir.path, "logs"));
      } else {
        throw Exception("Unsupported Platform");
      }
    }

    if (!logsDir.existsSync()) {
      await logsDir.create(recursive: true);
    }

    return logsDir;
  }
}