gnc-filepath-utils.h File Reference

File path resolution utility functions. More...

Go to the source code of this file.

Functions
gchar *	gnc_resolve_file_path (const gchar *filefrag)
	Create an absolute path when given a relative path; otherwise return the argument. More...
gchar *	gnc_path_find_localized_html_file (const gchar *file_name)
	Find an absolute path to a localized version of a given relative path to a html or html related file. If no localized version exists, an absolute path to the file is searched for. If that file doesn't exist either, returns NULL. More...
const gchar *	gnc_dotgnucash_dir (void)
	Ensure that the user's configuration directory exists and is minimally populated. More...
gchar *	gnc_build_dotgnucash_path (const gchar *filename)
	Make a path to filename in the user's configuration directory. More...
gchar *	gnc_build_book_path (const gchar *filename)
	Make a path to filename in the book subdirectory of the user's configuration directory. More...
gchar *	gnc_build_translog_path (const gchar *filename)
	Make a path to filename in the translog subdirectory of the user's configuration directory. More...
gchar *	gnc_build_data_path (const gchar *filename)
	Make a path to filename in the data subdirectory of the user's configuration directory. More...
gchar *	gnc_build_report_path (const gchar *filename)
	Make a path to filename in the report directory. More...
gchar *	gnc_build_stdreports_path (const gchar *filename)
	Make a path to filename in the standard reports directory. More...
gchar *	gnc_filepath_locate_pixmap (const gchar *name)
gchar *	gnc_filepath_locate_data_file (const gchar *name)
gchar *	gnc_filepath_locate_ui_file (const gchar *name)
gchar *	gnc_filepath_locate_doc_file (const gchar *name)

Detailed Description

File path resolution utility functions.

Author

Copyright (c) 1998-2004 Linas Vepstas linas.nosp@m.@lin.nosp@m.as.or.nosp@m.g

Copyright (c) 2000 Dave Peticolas

Definition in file gnc-filepath-utils.h.

Function Documentation

gchar* gnc_build_book_path

(

const gchar *

filename

)

Make a path to filename in the book subdirectory of the user's configuration directory.

Parameters

filename

The name of the file

Returns

An absolute path.

Definition at line 491 of file gnc-filepath-utils.c.

{
    gchar* filename_dup = g_strdup(filename);
    gchar* result = NULL;

    scrub_filename(filename_dup);
    result = g_build_filename(gnc_dotgnucash_dir(), "books",
                              filename_dup, (gchar *)NULL);
    g_free(filename_dup);
    return result;
}

gchar* gnc_build_data_path

(

const gchar *

filename

)

Make a path to filename in the data subdirectory of the user's configuration directory.

Parameters

filename

The name of the file

Returns

An absolute path.

Definition at line 533 of file gnc-filepath-utils.c.

{
    gchar* filename_dup = g_strdup(filename);
    gchar* result;

    scrub_filename(filename_dup);
    result = g_build_filename(gnc_dotgnucash_dir(), "data", filename_dup, (gchar *)NULL);
    g_free(filename_dup);
    return result;
}

gchar* gnc_build_dotgnucash_path

(

const gchar *

filename

)

Make a path to filename in the user's configuration directory.

Parameters

filename

The name of the file

Returns

An absolute path.

Definition at line 477 of file gnc-filepath-utils.c.

{
    return g_build_filename(gnc_dotgnucash_dir(), filename, (gchar *)NULL);
}

gchar* gnc_build_report_path

(

const gchar *

filename

)

Make a path to filename in the report directory.

Parameters

filename

The name of the file

Returns

An absolute path.

Definition at line 553 of file gnc-filepath-utils.c.

{
    gchar *result = g_build_filename(gnc_path_get_reportdir(), filename, (gchar *)NULL);
    return result;
}

gchar* gnc_build_stdreports_path

(

const gchar *

filename

)

Make a path to filename in the standard reports directory.

Parameters

filename

The name of the file

Returns

An absolute path.

Definition at line 568 of file gnc-filepath-utils.c.

{
    gchar *result = g_build_filename(gnc_path_get_stdreportsdir(), filename, (gchar *)NULL);
    return result;
}

gchar* gnc_build_translog_path

(

const gchar *

filename

)

Make a path to filename in the translog subdirectory of the user's configuration directory.

Parameters

filename

The name of the file

Returns

An absolute path.

Definition at line 512 of file gnc-filepath-utils.c.

{
    gchar* filename_dup = g_strdup(filename);
    gchar* result = NULL;

    scrub_filename(filename_dup);
    result = g_build_filename(gnc_dotgnucash_dir(), "translog",
                              filename_dup, (gchar *)NULL);
    g_free(filename_dup);
    return result;
}

const gchar* gnc_dotgnucash_dir

(

void

)

Ensure that the user's configuration directory exists and is minimally populated.

Note that the default path is $HOME/.gnucash; This can be changed by the environment variable $GNC_DOT_DIR.

Returns

An absolute path to the configuration directory

Definition at line 413 of file gnc-filepath-utils.c.

{
    static gchar *dotgnucash = NULL;
    gchar *tmp_dir;
    gchar *errmsg = NULL;

    if (dotgnucash)
        return dotgnucash;

    dotgnucash = g_strdup(g_getenv("GNC_DOT_DIR"));

    if (!dotgnucash)
    {
        const gchar *home = g_get_home_dir();
        if (!home || !gnc_validate_directory(home, FALSE, &errmsg))
        {
            g_free(errmsg);
            g_warning("Cannot find suitable home directory. Using tmp directory instead.");
            home = g_get_tmp_dir();
        }
        g_assert(home);

        dotgnucash = g_build_filename(home, ".gnucash", (gchar *)NULL);
    }
    if (!gnc_validate_directory(dotgnucash, TRUE, &errmsg))
    {
        const gchar *tmp = g_get_tmp_dir();
        g_free(errmsg);
        g_free(dotgnucash);
        g_warning("Cannot find suitable .gnucash directory in home directory. Using tmp directory instead.");
        g_assert(tmp);

        dotgnucash = g_build_filename(tmp, ".gnucash", (gchar *)NULL);
        
        if (!gnc_validate_directory(dotgnucash, TRUE, &errmsg))
            exit(1);
    }

    /* Since we're in code that is only executed once.... */
    tmp_dir = g_build_filename(dotgnucash, "books", (gchar *)NULL);
    if (!gnc_validate_directory(tmp_dir, TRUE, &errmsg))
        exit(1);
    g_free(tmp_dir);
    tmp_dir = g_build_filename(dotgnucash, "checks", (gchar *)NULL);
    if (!gnc_validate_directory(tmp_dir, TRUE, &errmsg))
        exit(1);
    g_free(tmp_dir);
    tmp_dir = g_build_filename(tmp_dir, "translog", (gchar *)NULL);
    if (!gnc_validate_directory(dotgnucash, TRUE, &errmsg))
        exit(1);
    g_free(tmp_dir);

    return dotgnucash;
}

gchar* gnc_filepath_locate_data_file

(

const gchar *

name

)

Given a file name, find the file in the directories associated with this application. This routine will display an error message if it can't find the file.

Parameters

name	The name of the file to be found.

Returns

the full path name of the file, or NULL of the file can't be found.

Note

It is the caller's responsibility to free the returned string.

Definition at line 599 of file gnc-filepath-utils.c.

{
    return gnc_filepath_locate_file (gnc_path_get_pkgdatadir(), name);
}

gchar* gnc_filepath_locate_doc_file

(

const gchar *

name

)

Given a documentation file name, find the file in the doc directory associated with this application. This routine will display an error message if it can't find the file.

Parameters

name	The name of the file to be found.

Returns

the full path name of the file, or NULL of the file can't be found.

Note

It is the caller's responsibility to free the returned string.

Definition at line 631 of file gnc-filepath-utils.c.

{
    return gnc_filepath_locate_file (gnc_path_get_pkgdocdir(), name);
}

gchar* gnc_filepath_locate_pixmap

(

const gchar *

name

)

Given a pixmap/pixbuf file name, find the file in the pixmap directory associated with this application. This routine will display an error message if it can't find the file.

Parameters

name	The name of the file to be found.

Returns

the full path name of the file, or NULL of the file can't be found.

Note

It is the caller's responsibility to free the returned string.

Definition at line 605 of file gnc-filepath-utils.c.

{
    gchar *default_path;
    gchar *fullname;

    default_path = g_build_filename (gnc_path_get_pkgdatadir (), "pixmaps", NULL);
    fullname = gnc_filepath_locate_file (default_path, name);
    g_free(default_path);

    return fullname;
}

gchar* gnc_filepath_locate_ui_file

(

const gchar *

name

)

Given a ui file name, find the file in the ui directory associated with this application. This routine will display an error message if it can't find the file.

Parameters

name	The name of the file to be found.

Returns

the full path name of the file, or NULL of the file can't be found.

Note

It is the caller's responsibility to free the returned string.

Definition at line 618 of file gnc-filepath-utils.c.

{
    gchar *default_path;
    gchar *fullname;

    default_path = g_build_filename (gnc_path_get_pkgdatadir (), "ui", NULL);
    fullname = gnc_filepath_locate_file (default_path, name);
    g_free(default_path);

    return fullname;
}

gchar* gnc_path_find_localized_html_file

(

const gchar *

file_name

)

Find an absolute path to a localized version of a given relative path to a html or html related file. If no localized version exists, an absolute path to the file is searched for. If that file doesn't exist either, returns NULL.

Warning

file_name should be a simple path fragment. It shouldn't contain xml:// or http:// or <whatever>:// other protocol specifiers.

If passed a string which g_path_is_absolute declares an absolute path, return the argument.

Otherwise, assume that file_name is a well-formed relative path and try to find a file with its path relative to

• a localized subdirectory in the html directory of the user's configuration directory (e.g. $HOME/.gnucash/html/de_DE, $HOME/.gnucash/html/en,...)
• a localized subdirectory in the gnucash documentation directory (e.g. /usr/share/doc/gnucash/C,...)
• the html directory of the user's configuration directory (e.g. $HOME/.gnucash/html)
• the gnucash documentation directory (e.g. /usr/share/doc/gnucash/)

The paths are searched for in that order. If a matching file is found, return the absolute path to it.

If one isn't found, return NULL.

Parameters

file_name

The file path to resolve

Returns

An absolute file path or NULL if no file is found.

Warning

file_name should be a simple path fragment. It shouldn't contain xml:// or http:// or <whatever>:// other protocol specifiers.

If passed a string which g_path_is_absolute declares an absolute path, return the argument.

Otherwise, assume that file_name is a well-formed relative path and try to find a file with its path relative to

• a localized subdirectory in the html directory of the user's configuration directory (e.g. $HOME/.gnucash/html/de_DE, $HOME/.gnucash/html/en,...)
• a localized subdirectory in the gnucash documentation directory (e.g. /usr/share/doc/gnucash/C,...)
• the html directory of the user's configuration directory (e.g. $HOME/.gnucash/html)
• the gnucash documentation directory (e.g. /usr/share/doc/gnucash/)
• last resort option: the gnucash data directory (e.g. /usr/share/gnucash/)

The paths are searched for in that order. If a matching file is found, return the absolute path to it.

If one isn't found, return NULL.

Parameters

file_name

The file path to resolve

Returns

An absolute file path or NULL if no file is found.

Definition at line 262 of file gnc-filepath-utils.c.

{
    gchar *loc_file_name = NULL;
    gchar *full_path = NULL;
    const gchar * const *lang;
    int i;

    if (!file_name || *file_name == '\0')
        return NULL;

    /* An absolute path is returned unmodified. */
    if (g_path_is_absolute (file_name))
        return g_strdup (file_name);

    /* First try to find the file in any of the localized directories
     * the user has set up on his system
     */
    for (lang = g_get_language_names (); *lang; lang++)
    {
        loc_file_name = g_build_filename (*lang, file_name, (gchar *)NULL);
        full_path = gnc_path_find_localized_html_file_internal (loc_file_name);
        g_free (loc_file_name);
        if (full_path != NULL)
            return full_path;
    }

    /* If not found in a localized directory, try to find the file
     * in any of the base directories
     */
    return gnc_path_find_localized_html_file_internal (file_name);

}

gchar* gnc_resolve_file_path

(

const gchar *

filefrag

)

Create an absolute path when given a relative path; otherwise return the argument.

The gnc_resolve_file_path() routine is a utility that will accept a fragmentary filename as input, and resolve it into a fully qualified path in the file system, i.e. a path that begins with a leading slash. First, the current working directory is searched for the file. Next, the directory $HOME/.gnucash/data, and finally, a list of other (configurable) paths. If the file is not found, then the path $HOME/.gnucash/data is used. If $HOME is not defined, then the current working directory is used.

Warning

filefrag should be a simple path fragment. It shouldn't contain xml:// or http:// or <whatever>:// other protocol specifiers.

If passed a string which g_path_is_absolute declares an absolute path, return the argument.

Otherwise, assume that filefrag is a well-formed relative path and try to find a file with its path relative to

• the current working directory,
• the installed system-wide data directory (e.g., /usr/local/share/gnucash),
• the installed system configuration directory (e.g., /usr/local/etc/gnucash),
• or in the user's configuration directory (e.g., $HOME/.gnucash/data)

The paths are searched for in that order. If a matching file is found, return the absolute path to it.

If one isn't found, return a absolute path relative to the user's configuration directory and note in the trace file that it needs to be created.

Parameters

filefrag

The file path to resolve

Returns

An absolute file path.

Definition at line 124 of file gnc-filepath-utils.c.

{
    gchar *fullpath = NULL, *tmp_path = NULL;

    /* seriously invalid */
    if (!filefrag)
    {
        g_critical("filefrag is NULL");
        return NULL;
    }

    /* ---------------------------------------------------- */
    /* OK, now we try to find or build an absolute file path */

    /* check for an absolute file path */
    if (g_path_is_absolute(filefrag))
        return g_strdup (filefrag);

    /* Look in the current working directory */
    tmp_path = g_get_current_dir();
    fullpath = g_build_filename(tmp_path, filefrag, (gchar *)NULL);
    g_free(tmp_path);
    fullpath = check_path_return_if_valid(fullpath);
    if (fullpath != NULL)
        return fullpath;

    /* Look in the data dir (e.g. $PREFIX/share/gnucash) */
    tmp_path = gnc_path_get_pkgdatadir();
    fullpath = g_build_filename(tmp_path, filefrag, (gchar *)NULL);
    g_free(tmp_path);
    fullpath = check_path_return_if_valid(fullpath);
    if (fullpath != NULL)
        return fullpath;

    /* Look in the config dir (e.g. $PREFIX/share/gnucash/accounts) */
    tmp_path = gnc_path_get_accountsdir();
    fullpath = g_build_filename(tmp_path, filefrag, (gchar *)NULL);
    g_free(tmp_path);
    fullpath = check_path_return_if_valid(fullpath);
    if (fullpath != NULL)
        return fullpath;

    /* Look in the users config dir (e.g. $HOME/.gnucash/data) */
    fullpath = gnc_build_data_path(filefrag);
    if (g_file_test(fullpath, G_FILE_TEST_IS_REGULAR))
        return fullpath;

    /* OK, it's not there. Note that it needs to be created and pass it
     * back anyway */
    g_warning("create new file %s", fullpath);
    return fullpath;

}