| 1 |
/* save-cwd.c -- Save and restore current working directory. |
| 2 |
|
| 3 |
Copyright (C) 1995, 1997-1998, 2003-2006, 2009-2024 Free Software |
| 4 |
Foundation, Inc. |
| 5 |
|
| 6 |
This program is free software: you can redistribute it and/or modify |
| 7 |
it under the terms of the GNU General Public License as published by |
| 8 |
the Free Software Foundation, either version 3 of the License, or |
| 9 |
(at your option) any later version. |
| 10 |
|
| 11 |
This program is distributed in the hope that it will be useful, |
| 12 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 |
GNU General Public License for more details. |
| 15 |
|
| 16 |
You should have received a copy of the GNU General Public License |
| 17 |
along with this program. If not, see <https://www.gnu.org/licenses/>. */ |
| 18 |
|
| 19 |
/* Written by Jim Meyering. */ |
| 20 |
|
| 21 |
#include <config.h> |
| 22 |
|
| 23 |
#include "save-cwd.h" |
| 24 |
|
| 25 |
#include <errno.h> |
| 26 |
#include <fcntl.h> |
| 27 |
#include <stdio.h> |
| 28 |
#include <stdlib.h> |
| 29 |
|
| 30 |
#include "chdir-long.h" |
| 31 |
|
| 32 |
#if GNULIB_FCNTL_SAFER |
| 33 |
# include "fcntl--.h" |
| 34 |
#endif |
| 35 |
|
| 36 |
/* Record the location of the current working directory in CWD so that |
| 37 |
the program may change to other directories and later use restore_cwd |
| 38 |
to return to the recorded location. This function may allocate |
| 39 |
space using malloc (via getcwd) or leave a file descriptor open; |
| 40 |
use free_cwd to perform the necessary free or close. Upon failure, |
| 41 |
no memory is allocated, any locally opened file descriptors are |
| 42 |
closed; return non-zero -- in that case, free_cwd need not be |
| 43 |
called, but doing so is ok. Otherwise, return zero. |
| 44 |
|
| 45 |
The _raison d'etre_ for this interface is that the working directory |
| 46 |
is sometimes inaccessible, and getcwd is not robust or as efficient. |
| 47 |
So, we prefer to use the open/fchdir approach, but fall back on |
| 48 |
getcwd if necessary. This module works for most cases with just |
| 49 |
the getcwd-lgpl module, but to be truly robust, use the getcwd module. |
| 50 |
|
| 51 |
Some systems lack fchdir altogether: e.g., OS/2, pre-2001 Cygwin, |
| 52 |
SCO Xenix. Also, SunOS 4 and Irix 5.3 provide the function, yet it |
| 53 |
doesn't work for partitions on which auditing is enabled. If |
| 54 |
you're still using an obsolete system with these problems, please |
| 55 |
send email to the maintainer of this code. */ |
| 56 |
|
| 57 |
int |
| 58 |
save_cwd (struct saved_cwd *cwd) |
| 59 |
{ |
| 60 |
cwd->name = NULL; |
| 61 |
|
| 62 |
cwd->desc = open (".", O_SEARCH | O_CLOEXEC); |
| 63 |
if (cwd->desc < 0) |
| 64 |
{ |
| 65 |
cwd->name = getcwd (NULL, 0); |
| 66 |
return cwd->name ? 0 : -1; |
| 67 |
} |
| 68 |
|
| 69 |
return 0; |
| 70 |
} |
| 71 |
|
| 72 |
/* Change to recorded location, CWD, in directory hierarchy. |
| 73 |
Upon failure, return -1 (errno is set by chdir or fchdir). |
| 74 |
Upon success, return zero. */ |
| 75 |
|
| 76 |
int |
| 77 |
restore_cwd (const struct saved_cwd *cwd) |
| 78 |
{ |
| 79 |
if (0 <= cwd->desc) |
| 80 |
return fchdir (cwd->desc); |
| 81 |
else |
| 82 |
return chdir_long (cwd->name); |
| 83 |
} |
| 84 |
|
| 85 |
void |
| 86 |
free_cwd (struct saved_cwd *cwd) |
| 87 |
{ |
| 88 |
if (cwd->desc >= 0) |
| 89 |
close (cwd->desc); |
| 90 |
free (cwd->name); |
| 91 |
} |