2 * Copyright (C) 2004, 2005, 2007, 2009, 2011 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 2000-2002 Internet Software Consortium.
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.
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.
19 * Portions Copyright (c) 1987, 1993
20 * The Regents of the University of California. All rights reserved.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the above copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * This product includes software developed by the University of
33 * California, Berkeley and its contributors.
34 * 4. Neither the name of the University nor the names of its contributors
35 * may be used to endorse or promote products derived from this software
36 * without specific prior written permission.
38 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
39 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
41 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
42 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
43 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
44 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
45 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
46 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
47 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51 /* $Id: file.c,v 1.57.10.1 2011-03-04 14:10:13 smann Exp $ */
61 #include <time.h> /* Required for utimes on some platforms. */
62 #include <unistd.h> /* Required for mkstemp on NetBSD. */
72 #include <isc/random.h>
73 #include <isc/string.h>
77 #include "errno2result.h"
80 * XXXDCL As the API for accessing file statistics undoubtedly gets expanded,
81 * it might be good to provide a mechanism that allows for the results
82 * of a previous stat() to be used again without having to do another stat,
83 * such as perl's mechanism of using "_" in place of a file name to indicate
84 * that the results of the last stat should be used. But then you get into
85 * annoying MP issues. BTW, Win32 has stat().
88 file_stats(const char *file, struct stat *stats) {
89 isc_result_t result = ISC_R_SUCCESS;
91 REQUIRE(file != NULL);
92 REQUIRE(stats != NULL);
94 if (stat(file, stats) != 0)
95 result = isc__errno2result(errno);
101 isc_file_getmodtime(const char *file, isc_time_t *time) {
105 REQUIRE(file != NULL);
106 REQUIRE(time != NULL);
108 result = file_stats(file, &stats);
110 if (result == ISC_R_SUCCESS)
112 * XXXDCL some operating systems provide nanoseconds, too,
113 * such as BSD/OS via st_mtimespec.
115 isc_time_set(time, stats.st_mtime, 0);
121 isc_file_settime(const char *file, isc_time_t *time) {
122 struct timeval times[2];
124 REQUIRE(file != NULL && time != NULL);
127 * tv_sec is at least a 32 bit quantity on all platforms we're
128 * dealing with, but it is signed on most (all?) of them,
129 * so we need to make sure the high bit isn't set. This unfortunately
131 * * tv_sec becomes a signed 64 bit integer but long is 32 bits
132 * and isc_time_seconds > LONG_MAX, or
133 * * isc_time_seconds is changed to be > 32 bits but long is 32 bits
134 * and isc_time_seconds has at least 33 significant bits.
136 times[0].tv_sec = times[1].tv_sec = (long)isc_time_seconds(time);
139 * Here is the real check for the high bit being set.
141 if ((times[0].tv_sec &
142 (1ULL << (sizeof(times[0].tv_sec) * CHAR_BIT - 1))) != 0)
143 return (ISC_R_RANGE);
146 * isc_time_nanoseconds guarantees a value that divided by 1000 will
147 * fit into the minimum possible size tv_usec field. Unfortunately,
148 * we don't know what that type is so can't cast directly ... but
149 * we can at least cast to signed so the IRIX compiler shuts up.
151 times[0].tv_usec = times[1].tv_usec =
152 (isc_int32_t)(isc_time_nanoseconds(time) / 1000);
154 if (utimes(file, times) < 0)
155 return (isc__errno2result(errno));
157 return (ISC_R_SUCCESS);
161 #define TEMPLATE "tmp-XXXXXXXXXX" /*%< 14 characters. */
164 isc_file_mktemplate(const char *path, char *buf, size_t buflen) {
165 return (isc_file_template(path, TEMPLATE, buf, buflen));
169 isc_file_template(const char *path, const char *templet, char *buf,
173 REQUIRE(path != NULL);
174 REQUIRE(templet != NULL);
175 REQUIRE(buf != NULL);
177 s = strrchr(templet, '/');
181 s = strrchr(path, '/');
184 if ((s - path + 1 + strlen(templet) + 1) > buflen)
185 return (ISC_R_NOSPACE);
187 strncpy(buf, path, s - path + 1);
188 buf[s - path + 1] = '\0';
189 strcat(buf, templet);
191 if ((strlen(templet) + 1) > buflen)
192 return (ISC_R_NOSPACE);
194 strcpy(buf, templet);
197 return (ISC_R_SUCCESS);
200 static char alphnum[] =
201 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
204 isc_file_renameunique(const char *file, char *templet) {
209 REQUIRE(file != NULL);
210 REQUIRE(templet != NULL);
216 return (ISC_R_FAILURE);
219 while (cp >= templet && *cp == 'X') {
220 isc_random_get(&which);
221 *cp = alphnum[which % (sizeof(alphnum) - 1)];
224 while (link(file, templet) == -1) {
226 return (isc__errno2result(errno));
230 return (ISC_R_FAILURE);
231 t = strchr(alphnum, *cp);
232 if (t == NULL || *++t == '\0')
240 if (unlink(file) < 0)
242 return (isc__errno2result(errno));
243 return (ISC_R_SUCCESS);
247 isc_file_openunique(char *templet, FILE **fp) {
248 int mode = S_IWUSR|S_IRUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH;
249 return (isc_file_openuniquemode(templet, mode, fp));
253 isc_file_openuniqueprivate(char *templet, FILE **fp) {
254 int mode = S_IWUSR|S_IRUSR;
255 return (isc_file_openuniquemode(templet, mode, fp));
259 isc_file_openuniquemode(char *templet, int mode, FILE **fp) {
262 isc_result_t result = ISC_R_SUCCESS;
267 REQUIRE(templet != NULL);
268 REQUIRE(fp != NULL && *fp == NULL);
274 return (ISC_R_FAILURE);
277 while (cp >= templet && *cp == 'X') {
278 isc_random_get(&which);
279 *cp = alphnum[which % (sizeof(alphnum) - 1)];
284 while ((fd = open(templet, O_RDWR|O_CREAT|O_EXCL, mode)) == -1) {
286 return (isc__errno2result(errno));
290 return (ISC_R_FAILURE);
291 t = strchr(alphnum, *cp);
292 if (t == NULL || *++t == '\0')
300 f = fdopen(fd, "w+");
302 result = isc__errno2result(errno);
303 if (remove(templet) < 0) {
304 isc_log_write(isc_lctx, ISC_LOGCATEGORY_GENERAL,
305 ISC_LOGMODULE_FILE, ISC_LOG_ERROR,
306 "remove '%s': failed", templet);
316 isc_file_remove(const char *filename) {
319 REQUIRE(filename != NULL);
321 r = unlink(filename);
323 return (ISC_R_SUCCESS);
325 return (isc__errno2result(errno));
329 isc_file_rename(const char *oldname, const char *newname) {
332 REQUIRE(oldname != NULL);
333 REQUIRE(newname != NULL);
335 r = rename(oldname, newname);
337 return (ISC_R_SUCCESS);
339 return (isc__errno2result(errno));
343 isc_file_exists(const char *pathname) {
346 REQUIRE(pathname != NULL);
348 return (ISC_TF(file_stats(pathname, &stats) == ISC_R_SUCCESS));
352 isc_file_isplainfile(const char *filename) {
354 * This function returns success if filename is a plain file.
356 struct stat filestat;
357 memset(&filestat,0,sizeof(struct stat));
359 if ((stat(filename, &filestat)) == -1)
360 return(isc__errno2result(errno));
362 if(! S_ISREG(filestat.st_mode))
363 return(ISC_R_INVALIDFILE);
365 return(ISC_R_SUCCESS);
369 isc_file_isabsolute(const char *filename) {
370 REQUIRE(filename != NULL);
371 return (ISC_TF(filename[0] == '/'));
375 isc_file_iscurrentdir(const char *filename) {
376 REQUIRE(filename != NULL);
377 return (ISC_TF(filename[0] == '.' && filename[1] == '\0'));
381 isc_file_ischdiridempotent(const char *filename) {
382 REQUIRE(filename != NULL);
383 if (isc_file_isabsolute(filename))
385 if (isc_file_iscurrentdir(filename))
391 isc_file_basename(const char *filename) {
394 REQUIRE(filename != NULL);
396 s = strrchr(filename, '/');
404 isc_file_progname(const char *filename, char *buf, size_t buflen) {
408 REQUIRE(filename != NULL);
409 REQUIRE(buf != NULL);
411 base = isc_file_basename(filename);
412 len = strlen(base) + 1;
415 return (ISC_R_NOSPACE);
416 memcpy(buf, base, len);
418 return (ISC_R_SUCCESS);
422 * Put the absolute name of the current directory into 'dirname', which is
423 * a buffer of at least 'length' characters. End the string with the
424 * appropriate path separator, such that the final product could be
425 * concatenated with a relative pathname to make a valid pathname string.
428 dir_current(char *dirname, size_t length) {
430 isc_result_t result = ISC_R_SUCCESS;
432 REQUIRE(dirname != NULL);
433 REQUIRE(length > 0U);
435 cwd = getcwd(dirname, length);
439 result = ISC_R_NOSPACE;
441 result = isc__errno2result(errno);
443 if (strlen(dirname) + 1 == length)
444 result = ISC_R_NOSPACE;
445 else if (dirname[1] != '\0')
446 strcat(dirname, "/");
453 isc_file_absolutepath(const char *filename, char *path, size_t pathlen) {
455 result = dir_current(path, pathlen);
456 if (result != ISC_R_SUCCESS)
458 if (strlen(path) + strlen(filename) + 1 > pathlen)
459 return (ISC_R_NOSPACE);
460 strcat(path, filename);
461 return (ISC_R_SUCCESS);
465 isc_file_truncate(const char *filename, isc_offset_t size) {
466 isc_result_t result = ISC_R_SUCCESS;
468 if (truncate(filename, size) < 0)
469 result = isc__errno2result(errno);
474 isc_file_safecreate(const char *filename, FILE **fp) {
481 REQUIRE(filename != NULL);
482 REQUIRE(fp != NULL && *fp == NULL);
484 result = file_stats(filename, &sb);
485 if (result == ISC_R_SUCCESS) {
486 if ((sb.st_mode & S_IFREG) == 0)
487 return (ISC_R_INVALIDFILE);
488 flags = O_WRONLY | O_TRUNC;
489 } else if (result == ISC_R_FILENOTFOUND) {
490 flags = O_WRONLY | O_CREAT | O_EXCL;
494 fd = open(filename, flags, S_IRUSR | S_IWUSR);
496 return (isc__errno2result(errno));
500 result = isc__errno2result(errno);
506 return (ISC_R_SUCCESS);
510 isc_file_splitpath(isc_mem_t *mctx, char *path, char **dirname, char **basename)
512 char *dir, *file, *slash;
514 slash = strrchr(path, '/');
518 dir = isc_mem_strdup(mctx, "/");
519 } else if (slash != NULL) {
521 dir = isc_mem_allocate(mctx, slash - path);
523 strlcpy(dir, path, slash - path);
526 dir = isc_mem_strdup(mctx, ".");
530 return (ISC_R_NOMEMORY);
533 isc_mem_free(mctx, dir);
534 return (ISC_R_INVALIDFILE);
540 return (ISC_R_SUCCESS);