2 * Copyright (C) 2004, 2005, 2007, 2009, 2011, 2012 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
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_mode(const char *file, mode_t *modep) {
105 REQUIRE(modep != NULL);
107 result = file_stats(file, &stats);
108 if (result == ISC_R_SUCCESS)
109 *modep = (stats.st_mode & 07777);
115 isc_file_getmodtime(const char *file, isc_time_t *time) {
119 REQUIRE(file != NULL);
120 REQUIRE(time != NULL);
122 result = file_stats(file, &stats);
124 if (result == ISC_R_SUCCESS)
126 * XXXDCL some operating systems provide nanoseconds, too,
127 * such as BSD/OS via st_mtimespec.
129 isc_time_set(time, stats.st_mtime, 0);
135 isc_file_settime(const char *file, isc_time_t *time) {
136 struct timeval times[2];
138 REQUIRE(file != NULL && time != NULL);
141 * tv_sec is at least a 32 bit quantity on all platforms we're
142 * dealing with, but it is signed on most (all?) of them,
143 * so we need to make sure the high bit isn't set. This unfortunately
145 * * tv_sec becomes a signed 64 bit integer but long is 32 bits
146 * and isc_time_seconds > LONG_MAX, or
147 * * isc_time_seconds is changed to be > 32 bits but long is 32 bits
148 * and isc_time_seconds has at least 33 significant bits.
150 times[0].tv_sec = times[1].tv_sec = (long)isc_time_seconds(time);
153 * Here is the real check for the high bit being set.
155 if ((times[0].tv_sec &
156 (1ULL << (sizeof(times[0].tv_sec) * CHAR_BIT - 1))) != 0)
157 return (ISC_R_RANGE);
160 * isc_time_nanoseconds guarantees a value that divided by 1000 will
161 * fit into the minimum possible size tv_usec field. Unfortunately,
162 * we don't know what that type is so can't cast directly ... but
163 * we can at least cast to signed so the IRIX compiler shuts up.
165 times[0].tv_usec = times[1].tv_usec =
166 (isc_int32_t)(isc_time_nanoseconds(time) / 1000);
168 if (utimes(file, times) < 0)
169 return (isc__errno2result(errno));
171 return (ISC_R_SUCCESS);
175 #define TEMPLATE "tmp-XXXXXXXXXX" /*%< 14 characters. */
178 isc_file_mktemplate(const char *path, char *buf, size_t buflen) {
179 return (isc_file_template(path, TEMPLATE, buf, buflen));
183 isc_file_template(const char *path, const char *templet, char *buf,
187 REQUIRE(path != NULL);
188 REQUIRE(templet != NULL);
189 REQUIRE(buf != NULL);
191 s = strrchr(templet, '/');
195 s = strrchr(path, '/');
198 if ((s - path + 1 + strlen(templet) + 1) > buflen)
199 return (ISC_R_NOSPACE);
201 strncpy(buf, path, s - path + 1);
202 buf[s - path + 1] = '\0';
203 strcat(buf, templet);
205 if ((strlen(templet) + 1) > buflen)
206 return (ISC_R_NOSPACE);
208 strcpy(buf, templet);
211 return (ISC_R_SUCCESS);
214 static char alphnum[] =
215 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
218 isc_file_renameunique(const char *file, char *templet) {
223 REQUIRE(file != NULL);
224 REQUIRE(templet != NULL);
230 return (ISC_R_FAILURE);
233 while (cp >= templet && *cp == 'X') {
234 isc_random_get(&which);
235 *cp = alphnum[which % (sizeof(alphnum) - 1)];
238 while (link(file, templet) == -1) {
240 return (isc__errno2result(errno));
244 return (ISC_R_FAILURE);
245 t = strchr(alphnum, *cp);
246 if (t == NULL || *++t == '\0')
254 if (unlink(file) < 0)
256 return (isc__errno2result(errno));
257 return (ISC_R_SUCCESS);
261 isc_file_openunique(char *templet, FILE **fp) {
262 int mode = S_IWUSR|S_IRUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH;
263 return (isc_file_openuniquemode(templet, mode, fp));
267 isc_file_openuniqueprivate(char *templet, FILE **fp) {
268 int mode = S_IWUSR|S_IRUSR;
269 return (isc_file_openuniquemode(templet, mode, fp));
273 isc_file_openuniquemode(char *templet, int mode, FILE **fp) {
276 isc_result_t result = ISC_R_SUCCESS;
281 REQUIRE(templet != NULL);
282 REQUIRE(fp != NULL && *fp == NULL);
288 return (ISC_R_FAILURE);
291 while (cp >= templet && *cp == 'X') {
292 isc_random_get(&which);
293 *cp = alphnum[which % (sizeof(alphnum) - 1)];
298 while ((fd = open(templet, O_RDWR|O_CREAT|O_EXCL, mode)) == -1) {
300 return (isc__errno2result(errno));
304 return (ISC_R_FAILURE);
305 t = strchr(alphnum, *cp);
306 if (t == NULL || *++t == '\0')
314 f = fdopen(fd, "w+");
316 result = isc__errno2result(errno);
317 if (remove(templet) < 0) {
318 isc_log_write(isc_lctx, ISC_LOGCATEGORY_GENERAL,
319 ISC_LOGMODULE_FILE, ISC_LOG_ERROR,
320 "remove '%s': failed", templet);
330 isc_file_bopenunique(char *templet, FILE **fp) {
331 int mode = S_IWUSR|S_IRUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH;
332 return (isc_file_openuniquemode(templet, mode, fp));
336 isc_file_bopenuniqueprivate(char *templet, FILE **fp) {
337 int mode = S_IWUSR|S_IRUSR;
338 return (isc_file_openuniquemode(templet, mode, fp));
342 isc_file_bopenuniquemode(char *templet, int mode, FILE **fp) {
343 return (isc_file_openuniquemode(templet, mode, fp));
347 isc_file_remove(const char *filename) {
350 REQUIRE(filename != NULL);
352 r = unlink(filename);
354 return (ISC_R_SUCCESS);
356 return (isc__errno2result(errno));
360 isc_file_rename(const char *oldname, const char *newname) {
363 REQUIRE(oldname != NULL);
364 REQUIRE(newname != NULL);
366 r = rename(oldname, newname);
368 return (ISC_R_SUCCESS);
370 return (isc__errno2result(errno));
374 isc_file_exists(const char *pathname) {
377 REQUIRE(pathname != NULL);
379 return (ISC_TF(file_stats(pathname, &stats) == ISC_R_SUCCESS));
383 isc_file_isplainfile(const char *filename) {
385 * This function returns success if filename is a plain file.
387 struct stat filestat;
388 memset(&filestat,0,sizeof(struct stat));
390 if ((stat(filename, &filestat)) == -1)
391 return(isc__errno2result(errno));
393 if(! S_ISREG(filestat.st_mode))
394 return(ISC_R_INVALIDFILE);
396 return(ISC_R_SUCCESS);
400 isc_file_isabsolute(const char *filename) {
401 REQUIRE(filename != NULL);
402 return (ISC_TF(filename[0] == '/'));
406 isc_file_iscurrentdir(const char *filename) {
407 REQUIRE(filename != NULL);
408 return (ISC_TF(filename[0] == '.' && filename[1] == '\0'));
412 isc_file_ischdiridempotent(const char *filename) {
413 REQUIRE(filename != NULL);
414 if (isc_file_isabsolute(filename))
416 if (isc_file_iscurrentdir(filename))
422 isc_file_basename(const char *filename) {
425 REQUIRE(filename != NULL);
427 s = strrchr(filename, '/');
435 isc_file_progname(const char *filename, char *buf, size_t buflen) {
439 REQUIRE(filename != NULL);
440 REQUIRE(buf != NULL);
442 base = isc_file_basename(filename);
443 len = strlen(base) + 1;
446 return (ISC_R_NOSPACE);
447 memcpy(buf, base, len);
449 return (ISC_R_SUCCESS);
453 * Put the absolute name of the current directory into 'dirname', which is
454 * a buffer of at least 'length' characters. End the string with the
455 * appropriate path separator, such that the final product could be
456 * concatenated with a relative pathname to make a valid pathname string.
459 dir_current(char *dirname, size_t length) {
461 isc_result_t result = ISC_R_SUCCESS;
463 REQUIRE(dirname != NULL);
464 REQUIRE(length > 0U);
466 cwd = getcwd(dirname, length);
470 result = ISC_R_NOSPACE;
472 result = isc__errno2result(errno);
474 if (strlen(dirname) + 1 == length)
475 result = ISC_R_NOSPACE;
476 else if (dirname[1] != '\0')
477 strcat(dirname, "/");
484 isc_file_absolutepath(const char *filename, char *path, size_t pathlen) {
486 result = dir_current(path, pathlen);
487 if (result != ISC_R_SUCCESS)
489 if (strlen(path) + strlen(filename) + 1 > pathlen)
490 return (ISC_R_NOSPACE);
491 strcat(path, filename);
492 return (ISC_R_SUCCESS);
496 isc_file_truncate(const char *filename, isc_offset_t size) {
497 isc_result_t result = ISC_R_SUCCESS;
499 if (truncate(filename, size) < 0)
500 result = isc__errno2result(errno);
505 isc_file_safecreate(const char *filename, FILE **fp) {
512 REQUIRE(filename != NULL);
513 REQUIRE(fp != NULL && *fp == NULL);
515 result = file_stats(filename, &sb);
516 if (result == ISC_R_SUCCESS) {
517 if ((sb.st_mode & S_IFREG) == 0)
518 return (ISC_R_INVALIDFILE);
519 flags = O_WRONLY | O_TRUNC;
520 } else if (result == ISC_R_FILENOTFOUND) {
521 flags = O_WRONLY | O_CREAT | O_EXCL;
525 fd = open(filename, flags, S_IRUSR | S_IWUSR);
527 return (isc__errno2result(errno));
531 result = isc__errno2result(errno);
537 return (ISC_R_SUCCESS);
541 isc_file_splitpath(isc_mem_t *mctx, char *path, char **dirname, char **basename)
543 char *dir, *file, *slash;
545 slash = strrchr(path, '/');
549 dir = isc_mem_strdup(mctx, "/");
550 } else if (slash != NULL) {
552 dir = isc_mem_allocate(mctx, slash - path);
554 strlcpy(dir, path, slash - path);
557 dir = isc_mem_strdup(mctx, ".");
561 return (ISC_R_NOMEMORY);
564 isc_mem_free(mctx, dir);
565 return (ISC_R_INVALIDFILE);
571 return (ISC_R_SUCCESS);