1 // Copyright 2008, Google Inc.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
13 // distribution.
14 // * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
17 //
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 #include "gtest/internal/gtest-filepath.h"
31
32 #include <stdlib.h>
33 #include "gtest/internal/gtest-port.h"
34 #include "gtest/gtest-message.h"
35
36 #if GTEST_OS_WINDOWS_MOBILE
37 #include <windows.h>
38 #elif GTEST_OS_WINDOWS
39 #include <direct.h>
40 #include <io.h>
41 #else
42 #include <limits.h>
43 #include <climits> // Some Linux distributions define PATH_MAX here.
44 #endif // GTEST_OS_WINDOWS_MOBILE
45
46 #include "gtest/internal/gtest-string.h"
47
48 #if GTEST_OS_WINDOWS
49 #define GTEST_PATH_MAX_ _MAX_PATH
50 #elif defined(PATH_MAX)
51 #define GTEST_PATH_MAX_ PATH_MAX
52 #elif defined(_XOPEN_PATH_MAX)
53 #define GTEST_PATH_MAX_ _XOPEN_PATH_MAX
54 #else
55 #define GTEST_PATH_MAX_ _POSIX_PATH_MAX
56 #endif // GTEST_OS_WINDOWS
57
58 namespace testing {
59 namespace internal {
60
61 #if GTEST_OS_WINDOWS
62 // On Windows, '\\' is the standard path separator, but many tools and the
63 // Windows API also accept '/' as an alternate path separator. Unless otherwise
64 // noted, a file path can contain either kind of path separators, or a mixture
65 // of them.
66 const char kPathSeparator = '\\';
67 const char kAlternatePathSeparator = '/';
68 const char kAlternatePathSeparatorString[] = "/";
69 #if GTEST_OS_WINDOWS_MOBILE
70 // Windows CE doesn't have a current directory. You should not use
71 // the current directory in tests on Windows CE, but this at least
72 // provides a reasonable fallback.
73 const char kCurrentDirectoryString[] = "\\";
74 // Windows CE doesn't define INVALID_FILE_ATTRIBUTES
75 const DWORD kInvalidFileAttributes = 0xffffffff;
76 #else
77 const char kCurrentDirectoryString[] = ".\\";
78 #endif // GTEST_OS_WINDOWS_MOBILE
79 #else
80 const char kPathSeparator = '/';
81 const char kCurrentDirectoryString[] = "./";
82 #endif // GTEST_OS_WINDOWS
83
84 // Returns whether the given character is a valid path separator.
IsPathSeparator(char c)85 static bool IsPathSeparator(char c) {
86 #if GTEST_HAS_ALT_PATH_SEP_
87 return (c == kPathSeparator) || (c == kAlternatePathSeparator);
88 #else
89 return c == kPathSeparator;
90 #endif
91 }
92
93 // Returns the current working directory, or "" if unsuccessful.
GetCurrentDir()94 FilePath FilePath::GetCurrentDir() {
95 #if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_WINDOWS_PHONE || \
96 GTEST_OS_WINDOWS_RT || ARDUINO || defined(ESP_PLATFORM)
97 // These platforms do not have a current directory, so we just return
98 // something reasonable.
99 return FilePath(kCurrentDirectoryString);
100 #elif GTEST_OS_WINDOWS
101 char cwd[GTEST_PATH_MAX_ + 1] = {'\0'};
102 return FilePath(_getcwd(cwd, sizeof(cwd)) == nullptr ? "" : cwd);
103 #else
104 char cwd[GTEST_PATH_MAX_ + 1] = {'\0'};
105 char* result = getcwd(cwd, sizeof(cwd));
106 #if GTEST_OS_NACL
107 // getcwd will likely fail in NaCl due to the sandbox, so return something
108 // reasonable. The user may have provided a shim implementation for getcwd,
109 // however, so fallback only when failure is detected.
110 return FilePath(result == nullptr ? kCurrentDirectoryString : cwd);
111 #endif // GTEST_OS_NACL
112 return FilePath(result == nullptr ? "" : cwd);
113 #endif // GTEST_OS_WINDOWS_MOBILE
114 }
115
116 // Returns a copy of the FilePath with the case-insensitive extension removed.
117 // Example: FilePath("dir/file.exe").RemoveExtension("EXE") returns
118 // FilePath("dir/file"). If a case-insensitive extension is not
119 // found, returns a copy of the original FilePath.
RemoveExtension(const char * extension) const120 FilePath FilePath::RemoveExtension(const char* extension) const {
121 const std::string dot_extension = std::string(".") + extension;
122 if (String::EndsWithCaseInsensitive(pathname_, dot_extension)) {
123 return FilePath(
124 pathname_.substr(0, pathname_.length() - dot_extension.length()));
125 }
126 return *this;
127 }
128
129 // Returns a pointer to the last occurrence of a valid path separator in
130 // the FilePath. On Windows, for example, both '/' and '\' are valid path
131 // separators. Returns NULL if no path separator was found.
FindLastPathSeparator() const132 const char* FilePath::FindLastPathSeparator() const {
133 const char* const last_sep = strrchr(c_str(), kPathSeparator);
134 #if GTEST_HAS_ALT_PATH_SEP_
135 const char* const last_alt_sep = strrchr(c_str(), kAlternatePathSeparator);
136 // Comparing two pointers of which only one is NULL is undefined.
137 if (last_alt_sep != nullptr &&
138 (last_sep == nullptr || last_alt_sep > last_sep)) {
139 return last_alt_sep;
140 }
141 #endif
142 return last_sep;
143 }
144
145 // Returns a copy of the FilePath with the directory part removed.
146 // Example: FilePath("path/to/file").RemoveDirectoryName() returns
147 // FilePath("file"). If there is no directory part ("just_a_file"), it returns
148 // the FilePath unmodified. If there is no file part ("just_a_dir/") it
149 // returns an empty FilePath ("").
150 // On Windows platform, '\' is the path separator, otherwise it is '/'.
RemoveDirectoryName() const151 FilePath FilePath::RemoveDirectoryName() const {
152 const char* const last_sep = FindLastPathSeparator();
153 return last_sep ? FilePath(last_sep + 1) : *this;
154 }
155
156 // RemoveFileName returns the directory path with the filename removed.
157 // Example: FilePath("path/to/file").RemoveFileName() returns "path/to/".
158 // If the FilePath is "a_file" or "/a_file", RemoveFileName returns
159 // FilePath("./") or, on Windows, FilePath(".\\"). If the filepath does
160 // not have a file, like "just/a/dir/", it returns the FilePath unmodified.
161 // On Windows platform, '\' is the path separator, otherwise it is '/'.
RemoveFileName() const162 FilePath FilePath::RemoveFileName() const {
163 const char* const last_sep = FindLastPathSeparator();
164 std::string dir;
165 if (last_sep) {
166 dir = std::string(c_str(), static_cast<size_t>(last_sep + 1 - c_str()));
167 } else {
168 dir = kCurrentDirectoryString;
169 }
170 return FilePath(dir);
171 }
172
173 // Helper functions for naming files in a directory for xml output.
174
175 // Given directory = "dir", base_name = "test", number = 0,
176 // extension = "xml", returns "dir/test.xml". If number is greater
177 // than zero (e.g., 12), returns "dir/test_12.xml".
178 // On Windows platform, uses \ as the separator rather than /.
MakeFileName(const FilePath & directory,const FilePath & base_name,int number,const char * extension)179 FilePath FilePath::MakeFileName(const FilePath& directory,
180 const FilePath& base_name, int number,
181 const char* extension) {
182 std::string file;
183 if (number == 0) {
184 file = base_name.string() + "." + extension;
185 } else {
186 file =
187 base_name.string() + "_" + StreamableToString(number) + "." + extension;
188 }
189 return ConcatPaths(directory, FilePath(file));
190 }
191
192 // Given directory = "dir", relative_path = "test.xml", returns "dir/test.xml".
193 // On Windows, uses \ as the separator rather than /.
ConcatPaths(const FilePath & directory,const FilePath & relative_path)194 FilePath FilePath::ConcatPaths(const FilePath& directory,
195 const FilePath& relative_path) {
196 if (directory.IsEmpty()) return relative_path;
197 const FilePath dir(directory.RemoveTrailingPathSeparator());
198 return FilePath(dir.string() + kPathSeparator + relative_path.string());
199 }
200
201 // Returns true if pathname describes something findable in the file-system,
202 // either a file, directory, or whatever.
FileOrDirectoryExists() const203 bool FilePath::FileOrDirectoryExists() const {
204 #if GTEST_OS_WINDOWS_MOBILE
205 LPCWSTR unicode = String::AnsiToUtf16(pathname_.c_str());
206 const DWORD attributes = GetFileAttributes(unicode);
207 delete[] unicode;
208 return attributes != kInvalidFileAttributes;
209 #else
210 posix::StatStruct file_stat;
211 return posix::Stat(pathname_.c_str(), &file_stat) == 0;
212 #endif // GTEST_OS_WINDOWS_MOBILE
213 }
214
215 // Returns true if pathname describes a directory in the file-system
216 // that exists.
DirectoryExists() const217 bool FilePath::DirectoryExists() const {
218 bool result = false;
219 #if GTEST_OS_WINDOWS
220 // Don't strip off trailing separator if path is a root directory on
221 // Windows (like "C:\\").
222 const FilePath& path(IsRootDirectory() ? *this
223 : RemoveTrailingPathSeparator());
224 #else
225 const FilePath& path(*this);
226 #endif
227
228 #if GTEST_OS_WINDOWS_MOBILE
229 LPCWSTR unicode = String::AnsiToUtf16(path.c_str());
230 const DWORD attributes = GetFileAttributes(unicode);
231 delete[] unicode;
232 if ((attributes != kInvalidFileAttributes) &&
233 (attributes & FILE_ATTRIBUTE_DIRECTORY)) {
234 result = true;
235 }
236 #else
237 posix::StatStruct file_stat;
238 result =
239 posix::Stat(path.c_str(), &file_stat) == 0 && posix::IsDir(file_stat);
240 #endif // GTEST_OS_WINDOWS_MOBILE
241
242 return result;
243 }
244
245 // Returns true if pathname describes a root directory. (Windows has one
246 // root directory per disk drive.)
IsRootDirectory() const247 bool FilePath::IsRootDirectory() const {
248 #if GTEST_OS_WINDOWS
249 return pathname_.length() == 3 && IsAbsolutePath();
250 #else
251 return pathname_.length() == 1 && IsPathSeparator(pathname_.c_str()[0]);
252 #endif
253 }
254
255 // Returns true if pathname describes an absolute path.
IsAbsolutePath() const256 bool FilePath::IsAbsolutePath() const {
257 const char* const name = pathname_.c_str();
258 #if GTEST_OS_WINDOWS
259 return pathname_.length() >= 3 && ((name[0] >= 'a' && name[0] <= 'z') ||
260 (name[0] >= 'A' && name[0] <= 'Z')) &&
261 name[1] == ':' && IsPathSeparator(name[2]);
262 #else
263 return IsPathSeparator(name[0]);
264 #endif
265 }
266
267 // Returns a pathname for a file that does not currently exist. The pathname
268 // will be directory/base_name.extension or
269 // directory/base_name_<number>.extension if directory/base_name.extension
270 // already exists. The number will be incremented until a pathname is found
271 // that does not already exist.
272 // Examples: 'dir/foo_test.xml' or 'dir/foo_test_1.xml'.
273 // There could be a race condition if two or more processes are calling this
274 // function at the same time -- they could both pick the same filename.
GenerateUniqueFileName(const FilePath & directory,const FilePath & base_name,const char * extension)275 FilePath FilePath::GenerateUniqueFileName(const FilePath& directory,
276 const FilePath& base_name,
277 const char* extension) {
278 FilePath full_pathname;
279 int number = 0;
280 do {
281 full_pathname.Set(MakeFileName(directory, base_name, number++, extension));
282 } while (full_pathname.FileOrDirectoryExists());
283 return full_pathname;
284 }
285
286 // Returns true if FilePath ends with a path separator, which indicates that
287 // it is intended to represent a directory. Returns false otherwise.
288 // This does NOT check that a directory (or file) actually exists.
IsDirectory() const289 bool FilePath::IsDirectory() const {
290 return !pathname_.empty() &&
291 IsPathSeparator(pathname_.c_str()[pathname_.length() - 1]);
292 }
293
294 // Create directories so that path exists. Returns true if successful or if
295 // the directories already exist; returns false if unable to create directories
296 // for any reason.
CreateDirectoriesRecursively() const297 bool FilePath::CreateDirectoriesRecursively() const {
298 if (!this->IsDirectory()) {
299 return false;
300 }
301
302 if (pathname_.length() == 0 || this->DirectoryExists()) {
303 return true;
304 }
305
306 const FilePath parent(this->RemoveTrailingPathSeparator().RemoveFileName());
307 return parent.CreateDirectoriesRecursively() && this->CreateFolder();
308 }
309
310 // Create the directory so that path exists. Returns true if successful or
311 // if the directory already exists; returns false if unable to create the
312 // directory for any reason, including if the parent directory does not
313 // exist. Not named "CreateDirectory" because that's a macro on Windows.
CreateFolder() const314 bool FilePath::CreateFolder() const {
315 #if GTEST_OS_WINDOWS_MOBILE
316 FilePath removed_sep(this->RemoveTrailingPathSeparator());
317 LPCWSTR unicode = String::AnsiToUtf16(removed_sep.c_str());
318 int result = CreateDirectory(unicode, nullptr) ? 0 : -1;
319 delete[] unicode;
320 #elif GTEST_OS_WINDOWS
321 int result = _mkdir(pathname_.c_str());
322 #else
323 int result = mkdir(pathname_.c_str(), 0777);
324 #endif // GTEST_OS_WINDOWS_MOBILE
325
326 if (result == -1) {
327 return this->DirectoryExists(); // An error is OK if the directory exists.
328 }
329 return true; // No error.
330 }
331
332 // If input name has a trailing separator character, remove it and return the
333 // name, otherwise return the name string unmodified.
334 // On Windows platform, uses \ as the separator, other platforms use /.
RemoveTrailingPathSeparator() const335 FilePath FilePath::RemoveTrailingPathSeparator() const {
336 return IsDirectory() ? FilePath(pathname_.substr(0, pathname_.length() - 1))
337 : *this;
338 }
339
340 // Removes any redundant separators that might be in the pathname.
341 // For example, "bar///foo" becomes "bar/foo". Does not eliminate other
342 // redundancies that might be in a pathname involving "." or "..".
Normalize()343 void FilePath::Normalize() {
344 if (pathname_.c_str() == nullptr) {
345 pathname_ = "";
346 return;
347 }
348 const char* src = pathname_.c_str();
349 char* const dest = new char[pathname_.length() + 1];
350 char* dest_ptr = dest;
351 memset(dest_ptr, 0, pathname_.length() + 1);
352
353 while (*src != '\0') {
354 *dest_ptr = *src;
355 if (!IsPathSeparator(*src)) {
356 src++;
357 } else {
358 #if GTEST_HAS_ALT_PATH_SEP_
359 if (*dest_ptr == kAlternatePathSeparator) {
360 *dest_ptr = kPathSeparator;
361 }
362 #endif
363 while (IsPathSeparator(*src)) src++;
364 }
365 dest_ptr++;
366 }
367 *dest_ptr = '\0';
368 pathname_ = dest;
369 delete[] dest;
370 }
371
372 } // namespace internal
373 } // namespace testing
374