contrib/bind9/lib/isc/include/isc/file.h

   1 /*
   2  * Copyright (C) 2004-2007, 2009, 2011, 2012  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 2000, 2001  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id$ */
  19
  20 #ifndef ISC_FILE_H
  21 #define ISC_FILE_H 1
  22
  23 /*! \file isc/file.h */
  24
  25 #include <stdio.h>
  26
  27 #include <isc/lang.h>
  28 #include <isc/stat.h>
  29 #include <isc/types.h>
  30
  31 ISC_LANG_BEGINDECLS
  32
  33 isc_result_t
  34 isc_file_settime(const char *file, isc_time_t *time);
  35
  36 isc_result_t
  37 isc_file_mode(const char *file, mode_t *modep);
  38
  39 isc_result_t
  40 isc_file_getmodtime(const char *file, isc_time_t *time);
  41 /*!<
  42  * \brief Get the time of last modification of a file.
  43  *
  44  * Notes:
  45  *\li   The time that is set is relative to the (OS-specific) epoch, as are
  46  *      all isc_time_t structures.
  47  *
  48  * Requires:
  49  *\li   file != NULL.
  50  *\li   time != NULL.
  51  *
  52  * Ensures:
  53  *\li   If the file could not be accessed, 'time' is unchanged.
  54  *
  55  * Returns:
  56  *\li   #ISC_R_SUCCESS
  57  *              Success.
  58  *\li   #ISC_R_NOTFOUND
  59  *              No such file exists.
  60  *\li   #ISC_R_INVALIDFILE
  61  *              The path specified was not usable by the operating system.
  62  *\li   #ISC_R_NOPERM
  63  *              The file's metainformation could not be retrieved because
  64  *              permission was denied to some part of the file's path.
  65  *\li   #ISC_R_EIO
  66  *              Hardware error interacting with the filesystem.
  67  *\li   #ISC_R_UNEXPECTED
  68  *              Something totally unexpected happened.
  69  *
  70  */
  71
  72 isc_result_t
  73 isc_file_mktemplate(const char *path, char *buf, size_t buflen);
  74 /*!<
  75  * \brief Generate a template string suitable for use with isc_file_openunique().
  76  *
  77  * Notes:
  78  *\li   This function is intended to make creating temporary files
  79  *      portable between different operating systems.
  80  *
  81  *\li   The path is prepended to an implementation-defined string and
  82  *      placed into buf.  The string has no path characters in it,
  83  *      and its maximum length is 14 characters plus a NUL.  Thus
  84  *      buflen should be at least strlen(path) + 15 characters or
  85  *      an error will be returned.
  86  *
  87  * Requires:
  88  *\li   buf != NULL.
  89  *
  90  * Ensures:
  91  *\li   If result == #ISC_R_SUCCESS:
  92  *              buf contains a string suitable for use as the template argument
  93  *              to isc_file_openunique().
  94  *
  95  *\li   If result != #ISC_R_SUCCESS:
  96  *              buf is unchanged.
  97  *
  98  * Returns:
  99  *\li   #ISC_R_SUCCESS  Success.
 100  *\li   #ISC_R_NOSPACE  buflen indicates buf is too small for the catenation
 101  *                              of the path with the internal template string.
 102  */
 103
 104 isc_result_t
 105 isc_file_openunique(char *templet, FILE **fp);
 106 isc_result_t
 107 isc_file_openuniqueprivate(char *templet, FILE **fp);
 108 isc_result_t
 109 isc_file_openuniquemode(char *templet, int mode, FILE **fp);
 110 isc_result_t
 111 isc_file_bopenunique(char *templet, FILE **fp);
 112 isc_result_t
 113 isc_file_bopenuniqueprivate(char *templet, FILE **fp);
 114 isc_result_t
 115 isc_file_bopenuniquemode(char *templet, int mode, FILE **fp);
 116 /*!<
 117  * \brief Create and open a file with a unique name based on 'templet'.
 118  *      isc_file_bopen*() open the file in binary mode in Windows.
 119  *      isc_file_open*() open the file in text mode in Windows.
 120  *
 121  * Notes:
 122  *\li   'template' is a reserved work in C++.  If you want to complain
 123  *      about the spelling of 'templet', first look it up in the
 124  *      Merriam-Webster English dictionary. (http://www.m-w.com/)
 125  *
 126  *\li   This function works by using the template to generate file names.
 127  *      The template must be a writable string, as it is modified in place.
 128  *      Trailing X characters in the file name (full file name on Unix,
 129  *      basename on Win32 -- eg, tmp-XXXXXX vs XXXXXX.tmp, respectively)
 130  *      are replaced with ASCII characters until a non-existent filename
 131  *      is found.  If the template does not include pathname information,
 132  *      the files in the working directory of the program are searched.
 133  *
 134  *\li   isc_file_mktemplate is a good, portable way to get a template.
 135  *
 136  * Requires:
 137  *\li   'fp' is non-NULL and '*fp' is NULL.
 138  *
 139  *\li   'template' is non-NULL, and of a form suitable for use by
 140  *      the system as described above.
 141  *
 142  * Ensures:
 143  *\li   If result is #ISC_R_SUCCESS:
 144  *              *fp points to an stream opening in stdio's "w+" mode.
 145  *
 146  *\li   If result is not #ISC_R_SUCCESS:
 147  *              *fp is NULL.
 148  *
 149  *              No file is open.  Even if one was created (but unable
 150  *              to be reopened as a stdio FILE pointer) then it has been
 151  *              removed.
 152  *
 153  *\li   This function does *not* ensure that the template string has not been
 154  *      modified, even if the operation was unsuccessful.
 155  *
 156  * Returns:
 157  *\li   #ISC_R_SUCCESS
 158  *              Success.
 159  *\li   #ISC_R_EXISTS
 160  *              No file with a unique name could be created based on the
 161  *              template.
 162  *\li   #ISC_R_INVALIDFILE
 163  *              The path specified was not usable by the operating system.
 164  *\li   #ISC_R_NOPERM
 165  *              The file could not be created because permission was denied
 166  *              to some part of the file's path.
 167  *\li   #ISC_R_IOERROR
 168  *              Hardware error interacting with the filesystem.
 169  *\li   #ISC_R_UNEXPECTED
 170  *              Something totally unexpected happened.
 171  */
 172
 173 isc_result_t
 174 isc_file_remove(const char *filename);
 175 /*!<
 176  * \brief Remove the file named by 'filename'.
 177  */
 178
 179 isc_result_t
 180 isc_file_rename(const char *oldname, const char *newname);
 181 /*!<
 182  * \brief Rename the file 'oldname' to 'newname'.
 183  */
 184
 185 isc_boolean_t
 186 isc_file_exists(const char *pathname);
 187 /*!<
 188  * \brief Return #ISC_TRUE if the calling process can tell that the given file exists.
 189  * Will not return true if the calling process has insufficient privileges
 190  * to search the entire path.
 191  */
 192
 193 isc_boolean_t
 194 isc_file_isabsolute(const char *filename);
 195 /*!<
 196  * \brief Return #ISC_TRUE if the given file name is absolute.
 197  */
 198
 199 isc_result_t
 200 isc_file_isplainfile(const char *name);
 201 /*!<
 202  * \brief Check that the file is a plain file
 203  *
 204  * Returns:
 205  *\li   #ISC_R_SUCCESS
 206  *              Success. The file is a plain file.
 207  *\li   #ISC_R_INVALIDFILE
 208  *              The path specified was not usable by the operating system.
 209  *\li   #ISC_R_FILENOTFOUND
 210  *              The file does not exist. This return code comes from
 211  *              errno=ENOENT when stat returns -1. This code is mentioned
 212  *              here, because in logconf.c, it is the one rcode that is
 213  *              permitted in addition to ISC_R_SUCCESS. This is done since
 214  *              the next call in logconf.c is to isc_stdio_open(), which
 215  *              will create the file if it can.
 216  *\li   #other ISC_R_* errors translated from errno
 217  *              These occur when stat returns -1 and an errno.
 218  */
 219
 220 isc_boolean_t
 221 isc_file_iscurrentdir(const char *filename);
 222 /*!<
 223  * \brief Return #ISC_TRUE if the given file name is the current directory (".").
 224  */
 225
 226 isc_boolean_t
 227 isc_file_ischdiridempotent(const char *filename);
 228 /*%<
 229  * Return #ISC_TRUE if calling chdir(filename) multiple times will give
 230  * the same result as calling it once.
 231  */
 232
 233 const char *
 234 isc_file_basename(const char *filename);
 235 /*%<
 236  * Return the final component of the path in the file name.
 237  */
 238
 239 isc_result_t
 240 isc_file_progname(const char *filename, char *buf, size_t buflen);
 241 /*!<
 242  * \brief Given an operating system specific file name "filename"
 243  * referring to a program, return the canonical program name.
 244  *
 245  *
 246  * Any directory prefix or executable file name extension (if
 247  * used on the OS in case) is stripped.  On systems where program
 248  * names are case insensitive, the name is canonicalized to all
 249  * lower case.  The name is written to 'buf', an array of 'buflen'
 250  * chars, and null terminated.
 251  *
 252  * Returns:
 253  *\li   #ISC_R_SUCCESS
 254  *\li   #ISC_R_NOSPACE  The name did not fit in 'buf'.
 255  */
 256
 257 isc_result_t
 258 isc_file_template(const char *path, const char *templet, char *buf,
 259                   size_t buflen);
 260 /*%<
 261  * Create an OS specific template using 'path' to define the directory
 262  * 'templet' to describe the filename and store the result in 'buf'
 263  * such that path can be renamed to buf atomically.
 264  */
 265
 266 isc_result_t
 267 isc_file_renameunique(const char *file, char *templet);
 268 /*%<
 269  * Rename 'file' using 'templet' as a template for the new file name.
 270  */
 271
 272 isc_result_t
 273 isc_file_absolutepath(const char *filename, char *path, size_t pathlen);
 274 /*%<
 275  * Given a file name, return the fully qualified path to the file.
 276  */
 277
 278 /*
 279  * XXX We should also have a isc_file_writeeopen() function
 280  * for safely open a file in a publicly writable directory
 281  * (see write_open() in BIND 8's ns_config.c).
 282  */
 283
 284 isc_result_t
 285 isc_file_truncate(const char *filename, isc_offset_t size);
 286 /*%<
 287  * Truncate/extend the file specified to 'size' bytes.
 288  */
 289
 290 isc_result_t
 291 isc_file_safecreate(const char *filename, FILE **fp);
 292 /*%<
 293  * Open 'filename' for writing, truncating if necessary.  Ensure that
 294  * if it existed it was a normal file.  If creating the file, ensure
 295  * that only the owner can read/write it.
 296  */
 297
 298 isc_result_t
 299 isc_file_splitpath(isc_mem_t *mctx, char *path,
 300                    char **dirname, char **basename);
 301 /*%<
 302  * Split a path into dirname and basename.  If 'path' contains no slash
 303  * (or, on windows, backslash), then '*dirname' is set to ".".
 304  *
 305  * Allocates memory for '*dirname', which can be freed with isc_mem_free().
 306  *
 307  * Returns:
 308  * - ISC_R_SUCCESS on success
 309  * - ISC_R_INVALIDFILE if 'path' is empty or ends with '/'
 310  * - ISC_R_NOMEMORY if unable to allocate memory
 311  */
 312
 313 ISC_LANG_ENDDECLS
 314
 315 #endif /* ISC_FILE_H */