file.h

Go to the documentation of this file.

#pragma once
/*
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Lesser General Public
 *   License as published by the Free Software Foundation; either
 *   version 2.1 of the License, or (at your option) any later version.
 *
 *   This library is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 *   Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public
 *   License along with this library; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
/** Various miscellaneous functions to manipulate files and paths
 *
 * @file src/lib/util/file.h
 *
 * @copyright 2019 The FreeRADIUS project
 * @copyright 2019 Arran Cudbard-Bell (a.cudbardb@freeradius.org)
 */
RCSIDH(util_file_h, "$Id: 18cccafebe739ba0133538433c664f388e30c58f $")
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <freeradius-devel/util/sbuff.h>
#include <freeradius-devel/util/value.h>
 
#ifdef HAVE_DIRENT_H
#  include <dirent.h>
#endif
 
#ifdef HAVE_GLOB_H
#include <glob.h>
#endif
 
/** Callback for allowing additional operations on newly created directories
 *
 * @param[in] fd        Of newly created directory.
 * @param[in] path      Either relative or full to the new directory.
 *                      Should only be used for debug messages or functions
 *                      that don't have an 'at' variant.
 * @param[in] uctx      User data to pass to callback.
 * @return
 *      - 0 on success.
 *      - -1 on failure.
 */
typedef int(*fr_mkdir_func_t)(int fd, char const *path, void *uctx);
 
typedef struct {
        uid_t           uid;
        gid_t           gid;
} fr_mkdir_chown_t;
 
int             fr_mkdir_chown(int fd, char const *path, void *uctx);
 
ssize_t         fr_mkdir(int *fd_out, char const *path, ssize_t len, mode_t mode,
                         fr_mkdir_func_t func, void *uctx);
 
char            *fr_realpath(TALLOC_CTX *ctx, char const *path, ssize_t len);
 
ssize_t         fr_touch(int *fd_out, char const *filename, mode_t mode, bool mkdir, mode_t dir_mode);
 
int             fr_unlink(char const *filename);
 
char const      *fr_cwd_strip(char const *filename);
 
int             fr_dirfd(int *dirfd, char const **filename, char const *pathname) CC_HINT(nonnull);
 
typedef enum {
        FR_GLOBDIR_INVALID = 0,
        FR_GLOBDIR_FILE,
#ifdef HAVE_DIRENT_H
        FR_GLOBDIR_DIR,
#endif
#ifdef HAVE_GLOB_H
        FR_GLOBDIR_GLOB,
#endif
} fr_globdir_type_t;
 
typedef struct {
        fr_globdir_type_t       type;
 
        char                    *path;
        char                    *filename;
 
        union {
                DIR             *dir;
#ifdef HAVE_GLOB_H
                struct {
                        size_t  gl_current;
                        glob_t  glob;
                };
#endif
        };
} fr_globdir_iter_t;
 
int             fr_globdir_iter_init(char const **filename, char const *dir, char const *pattern, fr_globdir_iter_t *iter);
int             fr_globdir_iter_next(char const **filename, fr_globdir_iter_t *iter);
int             fr_globdir_iter_free(fr_globdir_iter_t *iter);
 
bool            fr_filename_ok(char const *filename) CC_HINT(nonnull);
char const      *fr_filename(char const *path);
char const      *fr_filename_common_trim(char const *path, char const *common);
 
int             fr_filename_box_make_safe(TALLOC_CTX *ctx, fr_value_box_t *vb) CC_HINT(nonnull(2));
 
extern const fr_sbuff_escape_rules_t fr_filename_escape;
extern const fr_sbuff_escape_rules_t fr_filename_escape_dots;
 
#ifdef __cplusplus
}
#endif