split the cli and the core functionnalities

This commit is contained in:
Marc
2023-01-14 17:34:19 +01:00
parent 0c2b3afa9b
commit fce1c2912c
41 changed files with 878 additions and 751 deletions
+587
View File
@@ -0,0 +1,587 @@
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <unistd.h>
#include <sys/mount.h>
#include <sys/wait.h>
#include <libaudit.h>
#include <gameData.h>
#include <loadOrder.h>
#include <deploy.h>
#include <steam.h>
#include <install.h>
#include <getHome.h>
#include <steam.h>
#include <file.h>
#include <fomod.h>
#include <order.h>
#include <constants.h>
#include <deploy.h>
#include <errorType.h>
#include "cli.h"
#include "fomod.h"
#define ENABLED_COLOR "\033[0;32m"
#define DISABLED_COLOR "\033[0;31m"
static bool isRoot() {
return getuid() == 0;
}
static int usage() {
printf("Use --list-games or -l to list compatible games\n");
printf("Use --bind or -d <APPID> to deploy the mods for the game\n");
printf("Use --unbind <APPID> to rollback a deployment\n");
printf("Use --add or -a <APPID> <FILENAME> to add a mod to a game\n");
printf("Use --remove or -r <APPID> <MODID> to remove a mod\n");
printf("Use --fomod <APPID> <MODID> to create a new mod using the result from the FOMod\n");
printf("Use --list-mods or -m <APPID> to list all mods for a game\n");
printf("Use --install or -i <APPID> <MODID> to add a mod to a game\n");
printf("Use --uninstall or -u <APPID> <MODID> to uninstall a mod from a game\n");
printf("Use --swap <APPID> <MODID A> MODID B> to swap two mod in the loading order\n");
printf("Use --version or -v to get the version number\n");
printf("Use --show-load-order <APPID>\n");
printf("Use --list-plugins <APPID>\n");
return EXIT_FAILURE;
}
static int listGames(int argc, char **) {
if(argc != 2) return usage();
GHashTable * gamePaths;
error_t status = steam_searchGames(&gamePaths);
if(status == ERR_FAILURE) {
return EXIT_FAILURE;
}
GList * gamesIds = g_hash_table_get_keys(gamePaths);
GList * gamesIdsFirstPointer = gamesIds;
if(g_list_length(gamesIds) == 0) {
printf("No game found\n");
} else {
while(gamesIds != NULL) {
const int * gameIndex = (int*)gamesIds->data;
printf("%d: %s\n", GAMES_APPIDS[*gameIndex], GAMES_NAMES[*gameIndex]);
gamesIds = g_list_next(gamesIds);
}
}
g_list_free(gamesIdsFirstPointer);
return EXIT_FAILURE;
}
static int add(int argc, char ** argv) {
if(argc != 4) return usage();
const char * appIdStr = argv[2];
int appid = steam_parseAppId(appIdStr);
if(appid < 0) {
return EXIT_FAILURE;
}
install_addMod(argv[3], appid);
return EXIT_SUCCESS;
}
static int listAllMods(int argc, char ** argv) {
if(argc != 3) return usage();
char * appIdStr = argv[2];
int appid = steam_parseAppId(appIdStr);
if( appid < 0) {
return EXIT_FAILURE;
}
//might crash if no mods were installed
char * home = getHome();
char * modFolder = g_build_filename(home, MODLIB_WORKING_DIR, MOD_FOLDER_NAME, appIdStr, NULL);
free(home);
GList * mods = order_listMods(appid);
GList * p_mods = mods;
unsigned short index = 0;
printf("Id | Installed | Name\n");
while(mods != NULL) {
char * modName = (char*)mods->data;
char * modPath = g_build_filename(modFolder, modName, INSTALLED_FLAG_FILE, NULL);
if(access(modPath, F_OK) == 0) {
printf(ENABLED_COLOR " %d | ✓ | %s\n", index, modName);
} else {
printf(DISABLED_COLOR " %d | ✕ | %s\n", index, modName);
}
g_free(modPath);
index++;
mods = g_list_next(mods);
}
free(modFolder);
g_list_free_full(p_mods, free);
return EXIT_SUCCESS;
}
/*
* THIS WILL NOT INSTALL THE MOD
* this will just flag the mod as needed to be deployed
* it's the deploying process that handle the rest
*/
static int installAndUninstallMod(int argc, char ** argv, bool install) {
if(argc != 4) return usage();
char * appIdStr = argv[2];
int appid = steam_parseAppId(appIdStr);
if(appid < 0) {
return EXIT_FAILURE;
}
int returnValue = EXIT_SUCCESS;
//strtoul set EINVAL if the string is invalid
unsigned long modId = strtoul(argv[3], NULL, 10);
if(errno == EINVAL) {
fprintf(stderr, "ModId has to be a valid number\n");
return -1;
}
//might crash if no mods were installed
char * home = getHome();
char * modFolder = g_build_filename(home, MODLIB_WORKING_DIR, MOD_FOLDER_NAME, appIdStr, NULL);
free(home);
GList * mods = order_listMods(appid);
GList * modsFirstPointer = mods;
for(unsigned long i = 0; i < modId; i++) {
mods = g_list_next(mods);
}
if(mods == NULL) {
fprintf(stderr, "Mod not found\n");
return EXIT_FAILURE;
}
char * modName = (char*)mods->data;
char * modFlag = g_build_filename(modFolder, modName, INSTALLED_FLAG_FILE, NULL);
if(install) {
if(access(modFlag, F_OK) == 0) {
fprintf(stderr, "The mod is already activated \n");
returnValue = EXIT_SUCCESS;
goto exit;
}
//Create activated file
FILE * fd = fopen(modFlag, "w+");
if(fd != NULL) {
fwrite("", 1, 1, fd);
fclose(fd);
} else {
printf("Could not interact with the activation file\n");
returnValue = EXIT_FAILURE;
}
} else {
if(access(modFlag, F_OK) != 0) {
printf("The mod is not activated \n");
returnValue = EXIT_SUCCESS;
goto exit;
}
if(unlink(modFlag) != 0) {
fprintf(stderr, "Error could not disable the mod.\n");
fprintf(stderr, "please remove this file '%s'\n", modFlag);
returnValue = EXIT_FAILURE;
goto exit;
}
}
exit:
g_free(modFolder);
g_list_free_full(modsFirstPointer, free);
g_free(modFlag);
return returnValue;
}
static error_t cli_deploy(int argc, char ** argv) {
if(argc != 3) return usage();
char * appIdStr = argv[2];
int appid = steam_parseAppId(appIdStr);
if(appid < 0) {
return EXIT_FAILURE;
}
GList * ignoredMods = NULL;
deploymentErrors_t errors = deploy(appIdStr, &ignoredMods);
switch(errors) {
//we prevalidate the appid so it is a bug
default:
case INVALID_APPID:
case BUG:
fprintf(stderr, "A bug was detected during the deployment\n");
return ERR_FAILURE;
case CANNOT_MOUNT:
fprintf(stderr, "Failed to mount the game files");
return ERR_FAILURE;
case FUSE_NOT_INSTALLED:
fprintf(stderr, "This software requires fuse-overlayfs to be installed");
return ERR_FAILURE;
case GAME_NOT_FOUND:
fprintf(stderr, "Could not find the game files");
return ERR_FAILURE;
case OK:
printf("Success");
return ERR_SUCCESS;
}
}
static int setup(int argc, char ** argv) {
if(argc != 3 ) return usage();
const char * appIdStr = argv[2];
int appid = steam_parseAppId(appIdStr);
if(appid < 0) {
return EXIT_FAILURE;
}
char * home = getHome();
char * gameUpperDir = g_build_filename(home, MODLIB_WORKING_DIR, GAME_UPPER_DIR_NAME, appIdStr, NULL);
char * gameWorkDir = g_build_filename(home, MODLIB_WORKING_DIR, GAME_WORK_DIR_NAME, appIdStr, NULL);
g_mkdir_with_parents(gameUpperDir, 0755);
g_mkdir_with_parents(gameWorkDir, 0755);
free(gameUpperDir);
free(gameWorkDir);
char * dataFolder = NULL;
error_t error = gameData_getDataPath(appid, &dataFolder);
if(error != ERR_SUCCESS) {
return ERR_FAILURE;
}
char * gameFolder = g_build_filename(home, MODLIB_WORKING_DIR, GAME_FOLDER_NAME, appIdStr, NULL);
if(access(gameFolder, F_OK) == 0) {
//if the game folder alredy exists just delete it
//this will allow the removal of dlcs and language change
file_delete(gameFolder, true);
}
g_mkdir_with_parents(gameFolder, 0755);
//links don't conflict with overlayfs and avoid coping 17Gb of files.
//but links require the files to be on the same filesystem
int returnValue = file_copy(dataFolder, gameFolder, FILE_CP_RECURSIVE | FILE_CP_NO_TARGET_DIR | FILE_CP_LINK);
if(returnValue < 0) {
printf("Coping game files. HINT: having the game on the same partition as you home director will make this operation use zero extra space");
returnValue = file_copy(dataFolder, gameFolder, FILE_CP_RECURSIVE | FILE_CP_NO_TARGET_DIR);
if(returnValue < 0) {
fprintf(stderr, "Copy failed make sure you have enough space on your device.");
free(dataFolder);
free(gameFolder);
return EXIT_FAILURE;
}
}
file_casefold(gameFolder);
free(dataFolder);
free(gameFolder);
printf("Done\n");
return EXIT_SUCCESS;
}
static int unbind(int argc, char ** argv) {
if(argc != 3 ) return usage();
const char * appIdStr = argv[2];
int appid = steam_parseAppId(appIdStr);
if(appid < 0) {
return EXIT_FAILURE;
}
char * dataFolder = NULL;
error_t error = gameData_getDataPath(appid, &dataFolder);
if(error != ERR_SUCCESS) {
return ERR_FAILURE;
}
while(umount2(dataFolder, MNT_FORCE | MNT_DETACH) == 0);
free(dataFolder);
return EXIT_SUCCESS;
}
static int removeMod(int argc, char ** argv) {
if(argc != 4) return usage();
const char * appIdStr = argv[2];
int appid = steam_parseAppId(appIdStr);
if(appid < 0) {
fprintf(stderr, "Invalid appid");
return EXIT_FAILURE;
}
//strtoul set EINVAL if the string is invalid
unsigned long modId = strtoul(argv[3], NULL, 10);
if(errno == EINVAL) {
fprintf(stderr, "Modid has to be a valid number\n");
return EXIT_FAILURE;
}
//might crash if no mods were installed
char * home = getHome();
char * modFolder = g_build_filename(home, MODLIB_WORKING_DIR, MOD_FOLDER_NAME, appIdStr, NULL);
free(home);
GList * mods = order_listMods(appid);
GList * modsFirstPointer = mods;
for(unsigned long i = 0; i < modId; i++) {
mods = g_list_next(mods);
}
if(mods == NULL) {
fprintf(stderr, "Mod not found\n");
return EXIT_FAILURE;
}
gchar * filename = g_build_filename(modFolder, mods->data, NULL);
file_delete(filename, true);
g_free(filename);
g_free(modFolder);
g_list_free_full(modsFirstPointer, free);
return EXIT_SUCCESS;
}
static int fomod(int argc, char ** argv) {
if(argc != 4) return usage();
char * appIdStr = argv[2];
int appid = steam_parseAppId(appIdStr);
if(appid < 0) {
fprintf(stderr, "Invalid appid");
return EXIT_FAILURE;
}
//strtoul set EINVAL if the string is invalid
unsigned long modId = strtoul(argv[3], NULL, 10);
if(errno == EINVAL) {
fprintf(stderr, "Modid has to be a valid number\n");
return -1;
}
//might crash if no mods were installed
char * home = getHome();
char * modFolder = g_build_filename(home, MODLIB_WORKING_DIR, MOD_FOLDER_NAME, appIdStr, NULL);
free(home);
GList * mods = order_listMods(appid);
GList * modsFirstPointer = mods;
for(unsigned long i = 0; i < modId; i++) {
mods = g_list_next(mods);
}
if(mods == NULL) {
fprintf(stderr, "Mod not found\n");
return EXIT_FAILURE;
}
char * destination = g_strconcat(mods->data, "__FOMOD", NULL);
if(access(destination, F_OK) == 0) {
file_delete(destination, true);
}
char * modDestination = g_build_filename(modFolder, destination, NULL);
char * modPath = g_build_filename(modFolder, mods->data, NULL);
//TODO: add error handling
int returnValue = fomod_installFOMod(modPath, modDestination);
free(destination);
g_list_free_full(modsFirstPointer, free);
g_free(modDestination);
g_free(modPath);
g_free(modFolder);
return returnValue;
}
static int swapMod(int argc, char ** argv) {
if(argc != 5) return usage();
char * appIdStr = argv[2];
int appid = steam_parseAppId(appIdStr);
if(appid < 0) {
fprintf(stderr, "Invalid appid");
return EXIT_FAILURE;
}
char * sentinel;
//no mod will go over the MAX_INT value
int modIdA = (int)strtoul(argv[3], &sentinel, 10);
if(errno == EINVAL || sentinel == argv[3]) {
fprintf(stderr, "Modid A has to be a valid number\n");
return -1;
}
int modIdB = (int)strtoul(argv[4], &sentinel, 10);
if(errno == EINVAL || sentinel == argv[4]) {
fprintf(stderr, "Modid B has to be a valid number\n");
return -1;
}
printf("%d, %d\n", modIdA, modIdB);
return order_swapPlace(appid, modIdA, modIdB);
}
static int printLoadOrder(int argc, char ** argv) {
if(argc != 3) return usage();
char * appIdStr = argv[2];
int appid = steam_parseAppId(appIdStr);
if(appid < 0) {
fprintf(stderr, "Invalid appid");
return EXIT_FAILURE;
}
GList * order = NULL;
error_t status = order_getLoadOrder(appid, &order);
if(status != ERR_SUCCESS) {
fprintf(stderr, "Could not fetch the load order\n");
return EXIT_FAILURE;
}
printf("If the load order is empty that mean it wasn't set\n");
GList * cur_order = order;
while (cur_order != NULL) {
printf("%s\n", (char *)cur_order->data);
cur_order = g_list_next(cur_order);
}
g_list_free_full(order, free);
return EXIT_SUCCESS;
}
static int printPlugins(int argc, char ** argv) {
if(argc != 3) return usage();
char * appIdStr = argv[2];
int appid = steam_parseAppId(appIdStr);
if(appid < 0) {
fprintf(stderr, "Invalid appid");
return EXIT_FAILURE;
}
GList * mods = NULL;
error_t status = order_listPlugins(appid, &mods);
if(status != ERR_SUCCESS) {
fprintf(stderr, "Could not list plugins\n");
return EXIT_FAILURE;
}
GList * cur_mods = mods;
while (cur_mods != NULL) {
printf("%s\n", (char *)cur_mods->data);
cur_mods = g_list_next(cur_mods);
}
g_list_free_full(mods, free);
return EXIT_SUCCESS;
}
int main(int argc, char ** argv) {
if(argc < 2 ) return usage();
if(audit_getloginuid() == 0 || isRoot()) {
fprintf(stderr, "Please don't run this software as root\n");
return EXIT_FAILURE;
}
int returnValue = EXIT_SUCCESS;
char * home = getHome();
char * configFolder = g_build_filename(home, MODLIB_WORKING_DIR, NULL);
free(home);
if(access(configFolder, F_OK) != 0) {
//check to NOT run this as root
//creating folder as root will causes lots of headache
//such as problem with access rights and taking the risk of
//running system as root (which is a big security issue)
if(getuid() == 0) {
fprintf(stderr, "For the first run please avoid sudo\n");
returnValue = EXIT_FAILURE;
goto exit;
} else {
//leading 0 == octal
int i = g_mkdir_with_parents(configFolder, 0755);
if(i < 0) {
fprintf(stderr, "Could not create configs, check access rights for this path: %s", configFolder);
goto exit;
}
}
}
if(strcmp(argv[1], "--list-games") == 0 || strcmp(argv[1], "-l") == 0)
returnValue = listGames(argc, argv);
else if(strcmp(argv[1], "--add") == 0 || strcmp(argv[1], "-a") == 0)
returnValue = add(argc, argv);
else if(strcmp(argv[1], "--list-mods") == 0 || strcmp(argv[1], "-m") == 0)
returnValue = listAllMods(argc, argv);
else if(strcmp(argv[1], "--install") == 0 || strcmp(argv[1], "-i") == 0)
returnValue = installAndUninstallMod(argc, argv, true);
else if(strcmp(argv[1], "--uninstall") == 0 || strcmp(argv[1], "-u") == 0)
returnValue = installAndUninstallMod(argc, argv, false);
else if(strcmp(argv[1], "--bind") == 0 || strcmp(argv[1], "-d") == 0)
returnValue = cli_deploy(argc, argv);
else if(strcmp(argv[1], "--unbind") == 0)
returnValue = unbind(argc, argv);
else if(strcmp(argv[1], "--setup") == 0)
returnValue = setup(argc, argv);
else if(strcmp(argv[1], "--fomod") == 0)
returnValue = fomod(argc, argv);
else if(strcmp(argv[1], "--remove") == 0 || strcmp(argv[1], "-r") == 0)
returnValue = removeMod(argc, argv);
else if(strcmp(argv[1], "--swap") == 0 || strcmp(argv[1], "-s") == 0)
returnValue = swapMod(argc, argv);
else if(strcmp(argv[1], "--list-plugins") == 0)
returnValue = printPlugins(argc, argv);
else if(strcmp(argv[1], "--show-load-order") == 0)
returnValue = printLoadOrder(argc, argv);
else if(strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-v") == 0) {
#ifdef __clang__
printf("%s: Clang: %d.%d.%d\n", VERSION, __clang_major__, __clang_minor__, __clang_patchlevel__);
#elifdef __GNUC__
printf("%s: GCC: %d.%d.%d\n", VERSION, __GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__);
#else
printf("%s: unknown compiler\n", VERSION);
#endif
} else {
usage();
returnValue = EXIT_FAILURE;
}
exit:
g_free(configFolder);
steam_freeGameTable();
return returnValue;
}