Directory Utilities

Typedefs
typedef int(*	amxp_dir_match_fn_t) (const char *name, void *priv)
	Matching file/directory callback function signature. More...

Functions
int	amxp_dir_make (const char *path, const mode_t mode)
	Creates sub-directories. More...
int	amxp_dir_owned_make (const char *path, const mode_t mode, uid_t uid, gid_t gid)
	Creates sub-directories and changes ownership. More...
int	amxp_dir_scan (const char *path, const char *filter, bool recursive, amxp_dir_match_fn_t fn, void *priv)
	Scans a directory and calls a callback function for each matching entry found. More...
bool	amxp_dir_is_empty (const char *path)
	Checks if a directory is empty. More...
bool	amxp_dir_is_directory (const char *path)
	Checks if a path is a directory. More...

Detailed Description

File system directory utilities and helper functions

Typedef Documentation

amxp_dir_match_fn_t

typedef int(* amxp_dir_match_fn_t) (const char *name, void *priv)

Matching file/directory callback function signature.

The amxp_dir_scan function will call the callback function for each matching file or directory found.

Parameters

name	full path of the matching file or directory
priv	a pointer to some data, provided to amxp_dir_scan

Returns

When the callback function returns a non-zero value, the scan of the directory stops.

Definition at line 96 of file amxp_dir.h.

Function Documentation

amxp_dir_is_directory()

bool amxp_dir_is_directory

(

const char *

path

)

Checks if a path is a directory.

Parameters

path	relative or absolute path to a file or directory

Returns

true when the path is a directory.

Definition at line 257 of file amxp_dir.c.

                                             {
    bool retval = false;
    struct stat sb;
    when_str_empty(path, exit);
 
    when_false(stat(path, &sb) == 0, exit);
    when_false((sb.st_mode & S_IFMT) == S_IFDIR, exit);
 
    retval = true;
 
exit:
    return retval;
}

amxp_dir_is_empty()

bool amxp_dir_is_empty

(

const char *

path

)

Checks if a directory is empty.

A directory is considered empty when it doesn't contain any file or sub-directory.

if the given path doesn't exist or is not a directory this function will return true.

Parameters

path	relative or absolute path to a directory that needs to be scanned

Returns

true when the path is an empty directory, doesn't exist or isn't a directory.

Definition at line 243 of file amxp_dir.c.

                                         {
    bool retval = true;
    when_str_empty(path, exit);
 
    when_false(amxp_dir_is_directory(path), exit);
 
    if(amxp_dir_scan(path, NULL, false, amxp_dir_check_is_empty, NULL)) {
        retval = false;
    }
 
exit:
    return retval;
}

amxp_dir_make()

int amxp_dir_make	(	const char *	path,
		const mode_t	mode
	)

Creates sub-directories.

This function will create all sub-directories, if not existing yet.

If the path provided contains intermediate sub-directories that don't exist, they will be created.

Parameters

path	relative or absolute path to sub-directories that needs to be created
mode	the argument mode specifies the permissions to use

Returns

0 when all directories has been created, otherwise an error occurred

Definition at line 212 of file amxp_dir.c.

                                                       {
    return amxp_dir_owned_make(path, mode, 0, 0);
}

amxp_dir_owned_make()

int amxp_dir_owned_make	(	const char *	path,
		const mode_t	mode,
		uid_t	uid,
		gid_t	gid
	)

Creates sub-directories and changes ownership.

This function will create all sub-directories, if not existing yet.

When a (sub)directory is created and the given user id and group id are not 0, ownership is changed and set to the given user id and group id.

Parameters

path	relative or absolute path to sub-directories that needs to be created
mode	the argument mode specifies the permissions to use
uid	a user id
gid	a group id

Returns

0 when all directories has been created, otherwise an error occurred

Definition at line 156 of file amxp_dir.c.

                                                                                   {
    int retval = -1;
    char* dir = NULL;
    char* current = NULL;
    struct stat sb;
 
    when_str_empty(path, exit);
 
    if(stat(path, &sb) == 0) {
        retval = 0;
        goto exit;
    }
 
    dir = strdup(path);
    when_null(dir, exit);
    /* 'dir' does not exist. Create it, from left to right. */
    current = strchr(dir, '/');
 
    while(current != NULL && *current != 0) {
        *current = '\0';
 
        if(dir[0] == 0) {
            *current = '/';
            current = strchr(current + 1, '/');
            continue;
        }
 
        if(stat(dir, &sb) == 0) {
            *current = '/';
            current = strchr(current + 1, '/');
            continue;
        }
 
        retval = mkdir(dir, mode);
        when_failed(retval, exit);
        if((uid != 0) || (gid != 0)) {
            retval = chown(dir, uid, gid);
            when_failed(retval, exit);
        }
        *current = '/';
        current = strchr(current + 1, '/');
    }
 
    if(stat(dir, &sb) != 0) {
        retval = mkdir(dir, mode);
        when_failed(retval, exit);
        if((uid != 0) || (gid != 0)) {
            retval = chown(dir, uid, gid);
        }
    }
 
exit:
    free(dir);
    return retval;
}

amxp_dir_scan()

int amxp_dir_scan	(	const char *	path,
		const char *	filter,
		bool	recursive,
		amxp_dir_match_fn_t	fn,
		void *	priv
	)

Scans a directory and calls a callback function for each matching entry found.

When no filter is provided, all found entries are considered a match.

The filter works on the directory entry data. The fields that can be used are:

• d_name
• d_type
• d_ino

When the argument recursive is set to true, the scan will enter all found directories and scan these as well.

Filter examples:

• "d_type == DT_REG" - all regular files are matching
• "d_type == DT_LNK" - all symbolic links are matching
• "d_type == DT_REG && d_name matches '.*\\.so'" - all regular files with extention so are matching

Parameters

path	relative or absolute path to a directory that needs to be scanned
filter	(optional) an expression that can be used to filter to directory entries
recursive	when set to true all found sub-directories will be scanned as well.
fn	callback function which is called for each matching entry
priv	some private data, will be passed to the callback function

Returns

0 when scan was successful, otherwise an error occurred

Definition at line 216 of file amxp_dir.c.

                              {
    int retval = -1;
    amxp_expr_t* expr = NULL;
    char* real_path = NULL;
 
    when_str_empty(path, exit);
 
    real_path = realpath(path, NULL);
    when_null(real_path, exit);
 
    if((filter != NULL) && (*filter != 0)) {
        when_failed(amxp_expr_new(&expr, filter), exit);
    }
 
    retval = amxp_dir_scan_impl(real_path, expr, recursive, fn, priv);
 
exit:
    free(real_path);
    amxp_expr_delete(&expr);
    return retval;
 
}