Commit 8b7304a3 authored by David Lawrence's avatar David Lawrence
Browse files

73. [func] New "file" API in libisc, including new function

                        isc_file_getmodtime, isc_mktemplate renamed to
                        isc_file_mktemplate and isc_ufile renamed to
                        isc_file_openunique.  By no means an exhaustive API,
                        it is just what's needed for now.
parent cabcfd3e
73. [func] New "file" API in libisc, including new function
isc_file_getmodtime, isc_mktemplate renamed to
isc_file_mktemplate and isc_ufile renamed to
isc_file_openunique. By no means an exhaustive API,
it is just what's needed for now.
72. [func] DNS_RBTFIND_NOPREDECESSOR and DNS_RBTFIND_NOOPTIONS
added for dns_rbt_findnode, the former to disable the
setting of the chain to the predecessor, and the
......
/*
* Copyright (C) 2000 Internet Software Consortium.
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
* ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
* CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
* ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
* SOFTWARE.
*/
#include <stdio.h>
#include <isc/lang.h>
#include <isc/result.h>
#include <isc/time.h>
ISC_LANG_BEGINDECLS
#ifndef ISC_FILE_H
#define ISC_FILE_H 1
isc_result_t
isc_file_getmodtime(const char *file, isc_time_t *time);
/*
* Get the time of last modication of a file.
*
* Notes:
* The time that is set is relative to the (OS-specific) epoch, as are
* all isc_time_t structures.
*
* Requires:
* file != NULL.
* time != NULL.
*
* Ensures:
* If the file could not be accessed, 'time' is unchanged.
*
* Returns:
* ISC_R_SUCCESS
* Success.
* ISC_R_NOTFOUND
* No such file exists.
* ISC_R_INVALIDFILE
* The path specified was not usable by the operating system.
* ISC_R_NOPERM
* The file's metainformation could not be retrieved because
* permission was denied to some part of the file's path.
* ISC_R_EIO
* Hardware error interacting with the filesystem.
* ISC_R_UNEXPECTED
* Something totally unexpected happened.
*
*/
isc_result_t
isc_file_mktemplate(const char *path, char *buf, size_t buflen);
/*
* Generate a template string suitable for use with isc_file_openunique.
*
* Notes:
* This function is intended to make creating temporary files
* portable between different operating systems.
*
* The path is prepended to an implementation-defined string and
* placed into buf. The string has no path characters in it,
* and its maximum length is 14 characters plus a NUL. Thus
* buflen should be at least strlen(path) + 15 characters or
* an error will be returned.
*
* Requires:
* buf != NULL.
*
* Ensures:
* If result == ISC_R_SUCCESS:
* buf contains a string suitable for use as the template argument
* to isc_file_openunique.
*
* If result != ISC_R_SUCCESS:
* buf is unchanged.
*
* Returns:
* ISC_R_SUCCESS Success.
* ISC_R_NOSPACE buflen indicates buf is too small for the catenation
* of the path with the internal template string.
*/
isc_result_t
isc_file_openunique(char *template, FILE **fp);
/*
* Create and open a file with a unique name based on 'template'.
*
* Notes:
* This function works by using the template to generate file names.
* The template must be a writable string, as it is modified in place.
* Trailing X characters in the file name (full file name on Unix,
* basename on Win32 -- eg, tmp-XXXXXX vs XXXXXX.tmp, respectively)
* are replaced with ASCII characters until a non-existent filename
* is found. If the template does not include pathname information,
* the files in the working directory of the program are searched.
*
* isc_file_mktemplate is a good, portable way to get a template.
*
* Requires:
* 'fp' is non-NULL and '*fp' is NULL.
*
* 'template' is non-NULL, and of a form suitable for use by
* the system as described above.
*
* Ensures:
* If result is ISC_R_SUCCESS:
* *fp points to an stream opening in stdio's "w+" mode.
*
* If result is not ISC_R_SUCCESS:
* *fp is NULL.
*
* No file is open. Even if one was created (but unable
* to be reopened as a stdio FILE pointer) then it has been
* removed.
*
* This function does *not* ensure that the template string has not been
* modified, even if the operation was unsuccessful.
*
* Returns:
* ISC_R_SUCCESS
* Success.
* ISC_R_EXISTS
* No file with a unique name could be created based on the
* template.
* ISC_R_INVALIDFILE
* The path specified was not usable by the operating system.
* ISC_R_NOPERM
* The file could not be created because permission was denied
* to some part of the file's path.
* ISC_R_EIO
* Hardware error interacting with the filesystem.
* ISC_R_UNEXPECTED
* Something totally unexpected happened.
*/
ISC_LANG_ENDDECLS
#endif /* ISC_FILE_H */
/*
* Copyright (C) 2000 Internet Software Consortium.
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
* ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
* CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
* ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
* SOFTWARE.
*/
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/stat.h>
#include <isc/assertions.h>
#include <isc/file.h>
#include <isc/result.h>
/*
* XXXDCL As the API for accessing file statistics undoubtedly gets expanded,
* it might be good to provide a mechanism that allows for the results
* of a previous stat() to be used again without having to do another stat.
* Such as perl's mechanism of using "_" in place of a file name to indicate
* that the results of the last stat should be used. But then you get into
* annoying MP issues. BTW, Win32 has stat().
*/
static isc_result_t
file_stats(const char *file, struct stat *stats) {
isc_result_t result = ISC_R_SUCCESS;
if (stat(file, stats) != 0) {
switch (errno) {
case ENOTDIR:
case ENOENT:
result = ISC_R_NOTFOUND;
break;
case ELOOP:
case EINVAL:
case ENAMETOOLONG:
result = ISC_R_INVALIDFILE;
break;
case EACCES:
result = ISC_R_NOPERM;
break;
case EIO:
result = ISC_R_IOERROR;
break;
case EFAULT:
default:
result = ISC_R_UNEXPECTED;
break;
}
}
return (result);
}
isc_result_t
isc_file_getmodtime(const char *file, isc_time_t *time) {
isc_result_t result;
struct stat stats;
REQUIRE(file != NULL && time != NULL);
result = file_stats(file, &stats);
if (result == ISC_R_SUCCESS)
/*
* XXXDCL some operating systems provide nanoseconds, too,
* such as BSD/OS via st_mtimespec.
*/
isc_time_set(time, stats.st_mtime, 0);
return (result);
}
#undef TEMPLATE
#define TEMPLATE "tmp-XXXXXXXXXX" /* 14 characters. */
isc_result_t
isc_file_mktemplate(const char *path, char *buf, size_t buflen) {
char *s;
REQUIRE(buf != NULL);
s = strrchr(path, '/');
if (s != NULL) {
if ((s - path + 1 + sizeof(TEMPLATE)) > buflen)
return (ISC_R_NOSPACE);
strncpy(buf, path, s - path + 1);
buf[s - path + 1] = '\0';
strcat(buf, TEMPLATE);
} else {
if (sizeof(TEMPLATE) > buflen)
return (ISC_R_NOSPACE);
strcpy(buf, TEMPLATE);
}
return (ISC_R_SUCCESS);
}
isc_result_t
isc_file_openunique(char *template, FILE **fp) {
int fd;
FILE *f;
isc_result_t result = ISC_R_SUCCESS;
REQUIRE(template != NULL);
REQUIRE(fp != NULL && *fp == NULL);
/*
* Win32 does not have mkstemp.
*/
fd = mkstemp(template);
if (fd == -1)
switch (errno) {
case ENOTDIR:
case ELOOP:
case EINVAL:
case ENAMETOOLONG:
result = ISC_R_INVALIDFILE;
break;
case EACCES:
result = ISC_R_NOPERM;
break;
case EEXIST:
result = ISC_R_EXISTS;
break;
case EIO:
result = ISC_R_IOERROR;
break;
default:
result = ISC_R_UNEXPECTED;
}
if (result == ISC_R_SUCCESS) {
f = fdopen(fd, "w+");
if (f == NULL) {
if (errno == ENOMEM)
result = ISC_R_NOMEMORY;
else
result = ISC_R_UNEXPECTED;
(void)remove(template);
(void)close(fd);
} else
*fp = f;
}
return (result);
}
/*
* Copyright (C) 2000 Internet Software Consortium.
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
* ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
* CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
* ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
* SOFTWARE.
*/
#include <string.h>
#undef TEMPLATE
#define TEMPLATE "tXXXXXXX.tmp"
isc_result_t
isc__file_mktemplate(const char *file, char *buf, size_t buflen) {
char *s;
s = ;
if ((s = strrchr(file, '\\')) != NULL) {
if ((s - file + 1 + sizeof(TEMPLATE)) > buflen)
return (ISC_R_NOSPACE);
strncpy(buf, file, s - file + 1);
buf[s - file + 1] = '\0';
strcat(buf, TEMPLATE);
} else if ((s = strrchr(file, ':')) != NULL) {
if ((s - file + 2 + sizeof(TEMPLATE)) > buflen)
return (ISC_R_NOSPACE);
strncpy(buf, file, s - file + 1);
buf[s - file + 1] = '\\';
buf[s - file + 2] = '\0';
strcat(buf, TEMPLATE);
} else {
if (sizeof(TEMPLATE) > buflen)
return (ISC_R_NOSPACE);
strcpy(buf, TEMPLATE);
}
return(ISC_R_SUCCESS);
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment