bygfoot/src/file.c

#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>

#include "file.h"
#include "free.h"
#include "main.h"
#include "misc.h"
#include "option.h"
#include "support.h"
#include "variables.h"

/**
   Add the specified directory to the list of directories file_find_support_file()
   searches for support files.
   Any subdirectories are added recursively.
   @param directory The full path of the directory to be added.
   @see file_find_support_file()
   @see #support_directories  
*/
void
file_add_support_directory_recursive                   (const gchar     *directory)
{
    GDir *newdir =
	g_dir_open(directory, 0, NULL);
    const gchar *file;
    gchar *fullpath;

    if(newdir == NULL)
	return;

    add_pixmap_directory(directory);
    support_directories = g_list_prepend (support_directories,
					  g_strdup (directory));

    while(TRUE)
    {
	file = g_dir_read_name(newdir);

	if(file == NULL)
	    break;

	fullpath = g_strdup_printf ("%s%s%s", directory,
				    G_DIR_SEPARATOR_S, file);

	if(g_file_test(fullpath, G_FILE_TEST_IS_DIR))
	    file_add_support_directory_recursive(fullpath);
    
	g_free(fullpath);
    }

    g_dir_close(newdir);
}

/**
   Search the list of support directories for a given file and return
   the full path name.
   The return value must be freed.
   @param filename The name of the file we look for (without path).
   @param warning Whether to show a warning if we don't find the file.
   @return A pointer to the full path string of the file or NULL if
   we didn't find the file. The gchar* must be freed.
   @see #support_directories
   @see file_add_support_directory_recursive()
*/
gchar*
file_find_support_file                       (const gchar     *filename, gboolean warning)
{
    GList *elem = support_directories;

    while (elem)
    {
	gchar *pathname = g_strdup_printf ("%s%s%s", (gchar*)elem->data,
					   G_DIR_SEPARATOR_S, filename);
	if (g_file_test (pathname, G_FILE_TEST_EXISTS) &&
	    !g_file_test(pathname, G_FILE_TEST_IS_DIR))
	    return pathname;
      
	g_free (pathname);
	elem = elem->next;
    }
  
    if(warning)
	g_warning("file_find_support_file: file '%s' not found.", filename);

    return NULL;
}

/** Execute command with 'system' and give a warning if return value is -1.
    @return TRUE on success, FALSE, otherwise. */
gboolean
file_my_system(const gchar *command)
{
    if(system(command) != 0)
    {
	g_warning("file_my_system: system returned -1 when executing '%s'.", command);
	return FALSE;
    }

    return TRUE;
}

/** A custom function opening files.
    @param filename The full path to the file or a file name from the support files.
    @param bits The mode we use, e.g. "r" or "w". @see fopen()
    @param fil The file pointer that will point to the opened stream.
    @param abort_program Whether to abort the program if we encounter an error.
    @return TRUE on success, FALSE otherwise. */
gboolean
file_my_fopen(const gchar *filename, gchar *bits, FILE **fil, gboolean abort_program)
{
    gchar buf[SMALL];
    gchar *support_file = file_find_support_file(filename, FALSE);
    *fil = fopen(filename, bits);

    if(*fil != NULL)
    {
	g_free(support_file);
	return TRUE;
    }

    *fil = fopen(support_file, bits);
    if(*fil != NULL)
    {
	g_free(support_file);
	return TRUE;
    }

    sprintf(buf, "Could not open file '%s' in mode '%s'.\n", filename, bits);

    g_warning(buf);

    if(abort_program)
	main_exit_program(EXIT_FILE_OPEN_FAILED, NULL);

    return FALSE;
}

/** Create a $HOME/.bygfoot dir and other stuff if necessary. */
void
file_check_home_dir_create_dirs(void)
{
    gint i;
    gchar *dirs[3] =
	{HOMEDIRNAME,
	 HOMEDIRNAME G_DIR_SEPARATOR_S "definitions",
	 HOMEDIRNAME G_DIR_SEPARATOR_S "saves"};
    const gchar *home = g_get_home_dir();
    gchar buf[SMALL];

    for(i=0;i<3;i++)
    {
	sprintf(buf, "%s%s%s", home, G_DIR_SEPARATOR_S, dirs[i]);
	if(!g_file_test(buf, G_FILE_TEST_EXISTS))
	{
	    sprintf(buf, "%s%s%s", home, G_DIR_SEPARATOR_S, dirs[i]);
	    file_mkdir(buf);
	}
    }
}

/** Copy the basic config files into the user home dir. */
void
file_check_home_dir_copy_conf_files(void)
{
    gint i;
    gchar *conf_files[2] =
	{"bygfoot.conf",
	 "bygfoot_user.conf"};
    const gchar *home = g_get_home_dir();
    gchar *conf_file = NULL;
    gchar buf[SMALL];

    for(i=0;i<2;i++)
    {
	sprintf(buf, "%s%s%s%s%s", home, G_DIR_SEPARATOR_S, 
		HOMEDIRNAME, G_DIR_SEPARATOR_S, conf_files[i]);
	if(!g_file_test(buf, G_FILE_TEST_EXISTS))
	{
	    conf_file = file_find_support_file(conf_files[i], TRUE);	    
	    sprintf(buf, "%s%s%s%s%s",home, G_DIR_SEPARATOR_S,
		    HOMEDIRNAME, G_DIR_SEPARATOR_S, conf_files[i]);
	    file_copy_file(conf_file, buf);
	}
    }
}

/** Copy the xml definition files into the home dir. */
void
file_check_home_dir_copy_definition_dir(const gchar *dirname, const gchar *basename)
{
    gint i;
    gchar buf[SMALL], buf2[SMALL];
    const gchar *home = g_get_home_dir();
    GPtrArray *dir_contents = NULL;

    sprintf(buf, "%s%s%s%s%s", home, G_DIR_SEPARATOR_S,
	    HOMEDIRNAME, G_DIR_SEPARATOR_S, basename);

    if(!g_file_test(buf, G_FILE_TEST_EXISTS))
	file_mkdir(buf);

    dir_contents = file_dir_get_contents(dirname, "", "");

    for(i=0;i<dir_contents->len;i++)
    {
	sprintf(buf, "%s%s%s%s%s%s%s", home, G_DIR_SEPARATOR_S,
		HOMEDIRNAME, G_DIR_SEPARATOR_S, basename, G_DIR_SEPARATOR_S,
		((GString*)g_ptr_array_index(dir_contents, i))->str);
    
	if(g_str_has_suffix(((GString*)g_ptr_array_index(dir_contents, i))->str, ".xml") &&
	   !g_file_test(buf, G_FILE_TEST_EXISTS))
	{
        
	    sprintf(buf2, "%s%s%s", dirname, G_DIR_SEPARATOR_S,
		    ((GString*)g_ptr_array_index(dir_contents, i))->str);
	    file_copy_file(buf2, buf);
	}
	else
	{
	    sprintf(buf, "%s%s%s", dirname, G_DIR_SEPARATOR_S,
		    ((GString*)g_ptr_array_index(dir_contents, i))->str);

	    if(g_file_test(buf, G_FILE_TEST_IS_DIR))
	    {
		sprintf(buf2, "%s%s%s", basename, G_DIR_SEPARATOR_S,
			((GString*)g_ptr_array_index(dir_contents, i))->str);
		file_check_home_dir_copy_definition_dir(buf, buf2);
	    }
	}
    }
    
    free_g_string_array(&dir_contents);
}

/** Copy the xml definition files into the home dir. */
void
file_check_home_dir_copy_definition_files(void)
{
    GList *elem = support_directories;
  
    while(elem != NULL)
    {    
	if(g_str_has_suffix((gchar*)elem->data, "definitions"))
	    file_check_home_dir_copy_definition_dir((const gchar*)elem->data, "definitions");

	elem = elem->next;
    }
}

/** Copy some files into the user's home directory. */
void
file_check_home_dir(void)
{
    file_check_home_dir_create_dirs();
    file_check_home_dir_copy_conf_files();
    file_check_home_dir_copy_definition_files();
}

/**
   Retrieve those files in the given directory
   that start with the given prefix and suffix. The file names are stored
   in an array of GStrings.
   @param dir_name The full path to the directory.
   @param prefix The prefix that files must have to be included.
   @param suffix The suffix that files must have to be included.
   @return A GPtrArray with pointers to the GStrings of the file
   names. The GStrings and the array must be freed with free_g_string_array().
   @see free_g_string_array()
*/
GPtrArray*
file_dir_get_contents(const gchar *dir_name, const gchar *prefix, const gchar *suffix)
{
    GError *error = NULL;
    GDir *dir = g_dir_open(dir_name, 0, &error);
    GPtrArray *contents = g_ptr_array_new();
    GString *new = NULL;
    const gchar *file = NULL;

    misc_print_error(&error, FALSE);

    if(dir == NULL)
	return contents;
    
    file = g_dir_read_name(dir);

    if(file == NULL)
	return contents;

    while(file != NULL)
    {
	if(g_str_has_prefix(file, prefix) &&
	   g_str_has_suffix(file, suffix))
	{
	    new = g_string_new(file);
	    g_ptr_array_add(contents, (gpointer)new);
	}
	file = g_dir_read_name(dir);
    }

    g_dir_close(dir);

    return contents;
}

/** Return the country definition files found in the support dirs. */
GPtrArray*
file_get_country_files(void)
{
    gint i;
    GList *elem = support_directories;
    GPtrArray *country_files = g_ptr_array_new();
    GPtrArray *dir_contents = NULL;
    GString *new_string = NULL;

    while(elem != NULL)
    {
	dir_contents = file_dir_get_contents((gchar*)elem->data, "country_", ".xml");

	for(i=0;i<dir_contents->len;i++)
	    if(!query_misc_string_in_array(((GString*)g_ptr_array_index(dir_contents, i))->str,
					   country_files))
	    {
		new_string = g_string_new(((GString*)g_ptr_array_index(dir_contents, i))->str);
		g_ptr_array_add(country_files, new_string);
	    }

	free_g_string_array(&dir_contents);

	elem = elem->next;
    }

    return country_files;
}

/** Read the file until the next line that's not a comment or
    a blank line. Split the line into the part before and after
    the first white space and copy them into the char arrays.
    Trailing and leading white spaces and trailing comments are stripped.
    @param fil The file stream.
    @param opt_name The first char array (an option name, mostly).
    @param opt_value The second array (an option value, mostly).
    @return TRUE if the file still contains lines to read, FALSE otherwise. */
gboolean
file_get_next_opt_line(FILE *fil, gchar *opt_name, gchar *opt_value)
{
    gint i;
    gchar trash[SMALL];
    gchar buf[BIG];

    strcpy(buf, "");
    strcpy(opt_name, "");
    strcpy(opt_value, "");

    while( (buf[0] == '#' || strlen(buf) == 0) &&
	   feof(fil) == 0)
    {
        fscanf(fil, "%[\n \t]*", buf);
        fscanf(fil, "%[^\n]", buf);
    }

    if(buf[0] != '#' && strlen(buf) != 0)
    {
	if(strlen(buf) > 1000)
	    g_warning("\n the text file I'm reading contains a line longer than 1000 chars.\n\n");

	for(i=0;i<strlen(buf);i++)
	    if(buf[i] == '#')
	    {
		buf[i] = '\0';
		break;
	    }

	for(i=strlen(buf) - 1;i>0;i--)
	    if(buf[i] == '\t' || buf[i] == ' ')
		buf[i] = '\0';
	    else
		break;
    
	sscanf(buf, "%[^ \t]%[ \t]%[^\n]", opt_name, trash, opt_value);
    }

    return (feof(fil) == 0);
}

/** Save an optionlist to a file. */
void
file_save_opt_file(const gchar *filename, OptionList *optionlist)
{
    gint i;
    FILE *fil = NULL;

    file_my_fopen(filename, "w", &fil, TRUE);

    for(i=0;i<optionlist->list->len;i++)
	if(g_str_has_prefix(g_array_index(optionlist->list, Option, i).name->str, "string_"))
	    fprintf(fil, "%s %s\n", g_array_index(optionlist->list, Option, i).name->str,
		    g_array_index(optionlist->list, Option, i).string_value->str);
	else
	    fprintf(fil, "%s %d\n", g_array_index(optionlist->list, Option, i).name->str,
		    g_array_index(optionlist->list, Option, i).value);
    
    fclose(fil);
}

/** Load a file containing name - value pairs into
    the specified array. */
void
file_load_opt_file(const gchar *filename, OptionList *optionlist)
{
    gint i;
    gchar opt_name[SMALL], opt_value[SMALL];
    Option new;
    FILE *fil = NULL;

    free_option_list(optionlist, TRUE);

    file_my_fopen(filename, "r", &fil, TRUE);

    while(file_get_next_opt_line(fil, opt_name, opt_value))
    {
	new.name = g_string_new(opt_name);
	if(g_str_has_prefix(opt_name, "string_"))
	{
	    new.string_value = g_string_new(opt_value);
	    new.value = -1;
	}
	else
	{
	    new.string_value = NULL;
	    sscanf(opt_value, "%d", &new.value);
	}
	g_array_append_val(optionlist->list, new);

	if((g_str_has_suffix(new.name->str, "_unix") && os_is_unix) ||
	   (g_str_has_suffix(new.name->str, "_win32") && !os_is_unix))
	{
	    strcpy(opt_name, new.name->str);
	    opt_name[strlen(new.name->str) - (os_is_unix ? 5 : 6)] = '\0';
	    new.name = g_string_new(opt_name);
	    new.string_value = g_string_new(opt_value);
	    g_array_append_val(optionlist->list, new);
	}
    }

    for(i=0;i<optionlist->list->len;i++)
	g_datalist_set_data(&optionlist->datalist, g_array_index(optionlist->list, Option, i).name->str,
			    &g_array_index(optionlist->list, Option, i));

    fclose(fil);
}

/** Load the options at the beginning of a new game from
    the configuration files. */
void
file_load_conf_files(void)
{
    gint i;
    gchar *conf_file = file_find_support_file("bygfoot.conf", TRUE);

    file_load_opt_file(conf_file, &options);
    g_free(conf_file);

    file_load_opt_file(opt_str("string_opt_constants_file"), &constants);
    file_load_opt_file(opt_str("string_opt_appearance_file"), &constants_app);
    file_load_opt_file("bygfoot_lg_tokens", &lg_tokens);

    for(i=0;i<lg_tokens.list->len;i++)
	g_array_index(lg_tokens.list, Option, i).value = i;
}

/** Load a user-specific conf file.
    @param user The user we load the file for. */
void
file_load_user_conf_file(User *user)
{
    FILE *fil = NULL;
    gchar *conf_file = NULL, buf[SMALL];

    sprintf(buf, "bygfoot_%s.conf", user->name->str);
    conf_file = file_find_support_file(buf, FALSE);

    if(conf_file == NULL ||
       !file_my_fopen(conf_file, "r", &fil, FALSE))
    {
	g_free(conf_file);
	conf_file = file_find_support_file(opt_str("string_opt_default_user_conf_file"), TRUE);
    }

    file_load_opt_file(conf_file, &user->options);
    g_free(conf_file);
}

/** Return the primary support dir (probably './support_files' or 
    the Bygfoot dir in $HOME). */
const gchar*
file_get_first_support_dir(void)
{
    GList *elem = support_directories;
  
    while (elem)
    {
	if(g_str_has_suffix((gchar*)elem->data, HOMEDIRNAME) ||
	   g_str_has_suffix((gchar*)elem->data, "support_files"))
	    return (const gchar*)elem->data;

	elem = elem->next;
    }

    main_exit_program(EXIT_NO_SUPPORT_DIR,
		      "file_get_first_support_dir: no primary support dir found.");

    return NULL;
}

/** Compress the files starting with the prefix.
    @param destfile The name of the file to create. */
void
file_compress_files(const gchar *destfile, const gchar *prefix)
{
    gint i;
    gchar buf[SMALL];
    gchar *basename = g_path_get_basename(prefix),
	*dirname = g_path_get_dirname(prefix),
	*zipbasename = g_path_get_basename(destfile),
	*pwd = g_get_current_dir();
    GPtrArray *files = file_dir_get_contents(dirname, basename, "");
    
    chdir(dirname);
    
    if (os_is_unix)
        sprintf(buf, "%s %s %s", 
		const_str("string_fs_compress_command"), 
		const_str("string_fs_compress_switches"),
		zipbasename);
    else
        sprintf(buf, "\"%s%s%s\" %s %s", pwd, G_DIR_SEPARATOR_S, 
		const_str("string_fs_compress_command"),
		const_str("string_fs_compress_switches"),
		zipbasename);

    for(i=0;i<files->len;i++)
    {
	strcat(buf, " ");
	strcat(buf, ((GString*)g_ptr_array_index(files, i))->str);
    }

    file_my_system(buf);

    chdir(pwd);
    
    sprintf(buf, "%s%s%s*", dirname, G_DIR_SEPARATOR_S, basename);
    file_remove_files(buf);

    free_g_string_array(&files);

    g_free(basename);
    g_free(dirname);
    g_free(zipbasename);
    g_free(pwd);
}

/** Decompress the specified file. */
void
file_decompress(const gchar *filename)
{
    gchar buf[SMALL];
    gchar *dirname = g_path_get_dirname(filename),
	*basename = g_path_get_basename(filename),
	*pwd = g_get_current_dir();

    chdir(dirname);
	
    if (os_is_unix)
	sprintf(buf, "%s %s %s", 
		const_str("string_fs_uncompress_command"), 
		const_str("string_fs_uncompress_switches"),
		basename);
    else
	sprintf(buf, "\"%s%s%s\" %s %s", pwd, G_DIR_SEPARATOR_S,
		const_str("string_fs_uncompress_command"), 
		const_str("string_fs_uncompress_switches"), 
		basename);

    file_my_system(buf);

    g_free(dirname);
}

/** Execute the appropriate remove command with 'files'
    as argument (can be directories or a regexp, too). */
void
file_remove_files(const gchar *files)
{
    gchar buf[SMALL];

    if(os_is_unix)
	sprintf(buf, "%s %s", const_str("string_fs_remove_file_command"), files);
    else
	sprintf(buf, "%s \"%s\"", const_str("string_fs_remove_file_command"), files);

    file_my_system(buf);
}

/** Execute the appropriate copy command. */
void
file_copy_file(const gchar *source_file, const gchar *dest_file)
{
    gchar buf[SMALL];

    if(os_is_unix)
	sprintf(buf, "%s %s %s", const_str("string_fs_copy_file_command"),
		source_file, dest_file);
    else
	sprintf(buf, "%s \"%s\" \"%s\"", const_str("string_fs_copy_file_command"),
		source_file, dest_file);

    file_my_system(buf);
}