-
Notifications
You must be signed in to change notification settings - Fork 774
/
FileUtils.cpp
608 lines (518 loc) · 17.1 KB
/
FileUtils.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
/* -*-c++-*- */
/* osgEarth - Geospatial SDK for OpenSceneGraph
* Copyright 2020 Pelican Mapping
* http://osgearth.org
*
* osgEarth is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>
*/
#include <osgEarth/FileUtils>
#include <osgEarth/Registry>
#include <osgEarth/StringUtils>
#include "Notify"
#include <osgDB/FileUtils>
#include <osgDB/FileNameUtils>
#include <osgDB/ConvertUTF>
#include <osg/Object>
#include <stack>
#include <errno.h>
#ifdef WIN32
# include <windows.h>
#else
# include <stdio.h>
# include <stdlib.h>
#endif
#ifdef WIN32
# include <sys/utime.h>
#else
# include <utime.h>
#endif
// currently this impl is for _all_ platforms, except as defined.
// the mac version will change soon to reflect the path scheme under osx, but
// for now, the above include is commented out, and the below code takes precedence.
#if defined(WIN32) && !defined(__CYGWIN__)
#include <io.h>
#define WINBASE_DECLARE_GET_MODULE_HANDLE_EX
#include <windows.h>
#include <winbase.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <direct.h> // for _mkdir
#define mkdir(x,y) _mkdir((x))
#define stat64 _stati64
// set up for windows so acts just like unix access().
#ifndef F_OK
#define F_OK 4
#endif
#else // unix
#if defined( __APPLE__ )
// I'm not sure how we would handle this in raw Darwin
// without the AvailablilityMacros.
#include <AvailabilityMacros.h>
//>OSG_IOS
//IOS includes
#include "TargetConditionals.h"
#if (TARGET_OS_IPHONE)
#include <Availability.h>
// workaround a bug which appears when compiling for SDK < 4.0 and for the simulator
#if defined(__IPHONE_4_0) && (__IPHONE_OS_VERSION_MIN_REQUIRED >= __IPHONE_4_0)
#define stat64 stat
#else
#if !TARGET_IPHONE_SIMULATOR
#define stat64 stat
#endif
#endif
#endif
//<OSG_IPHONE
// 10.5 defines stat64 so we can't use this #define
// By default, MAC_OS_X_VERSION_MAX_ALLOWED is set to the latest
// system the headers know about. So I will use this as the control
// variable. (MIN_ALLOWED is set low by default so it is
// unhelpful in this case.)
// Unfortunately, we can't use the label MAC_OS_X_VERSION_10_4
// for older OS's like Jaguar, Panther since they are not defined,
// so I am going to hardcode the number.
#if (MAC_OS_X_VERSION_MAX_ALLOWED <= 1040 )
#define stat64 stat
#endif
#if MAC_OS_X_VERSION_MAX_ALLOWED >= 101300 && __DARWIN_ONLY_64_BIT_INO_T
#define stat64 stat
#endif
#elif defined(__CYGWIN__) || defined(__FreeBSD__) || (defined(__hpux) && !defined(_LARGEFILE64_SOURCE))
#define stat64 stat
#endif
#include <stdlib.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#endif
// set up _S_ISDIR()
#if !defined(S_ISDIR)
# if defined( _S_IFDIR) && !defined( __S_IFDIR)
# define __S_IFDIR _S_IFDIR
# endif
# define S_ISDIR(mode) (mode&__S_IFDIR)
#endif
#define LC "[FileUtils] "
using namespace osgEarth;
using namespace osgEarth::Util;
namespace osgEarth
{
#ifdef OSG_USE_UTF8_FILENAME
#define OSGDB_STRING_TO_FILENAME(s) osgDB::convertUTF8toUTF16(s)
#define OSGDB_FILENAME_TO_STRING(s) osgDB::convertUTF16toUTF8(s)
#define OSGDB_FILENAME_TEXT(x) L ## x
#define OSGDB_WINDOWS_FUNCT(x) x ## W
#define OSGDB_WINDOWS_FUNCT_STRING(x) #x "W"
typedef wchar_t filenamechar;
typedef std::wstring filenamestring;
#else
#define OSGDB_STRING_TO_FILENAME(s) s
#define OSGDB_FILENAME_TO_STRING(s) s
#define OSGDB_FILENAME_TEXT(x) x
#define OSGDB_WINDOWS_FUNCT(x) x ## A
#define OSGDB_WINDOWS_FUNCT_STRING(x) #x "A"
typedef char filenamechar;
typedef std::string filenamestring;
#endif
}
std::string
osgEarth::Util::getAbsolutePath(const std::string& path)
{
return osgDB::convertFileNameToUnixStyle( osgDB::getRealPath(path) );
}
bool
osgEarth::Util::isRelativePath(const std::string& fileName)
{
//If it is a URL, it is not relative
if (osgDB::containsServerAddress( fileName ) ) return false;
std::string native = osgDB::convertFileNameToNativeStyle(fileName);
#if defined(WIN32) && !defined(__CYGWIN__)
//Check to see if the path begins with a drive letter like "C:\data"
if (native.size() >= 3 && native[1] == ':' && native[2] == '\\') return false;
//Check to see if the path is network path like "\\server1\data"
if (native.size() >= 2 && native[0] == '\\' && native[1] == '\\') return false;
//The path must be relative
return true;
#else
//Absolute paths in Unix will start with a '/'
return !(native.size() >= 1 && native[0] == '/');
#endif
}
std::map<std::string, std::string>
osgEarth::Util::extractQueryParams(const std::string& url) {
std::map<std::string, std::string> queryParams;
size_t pos = url.find('?');
if (pos != std::string::npos) {
std::string queryParameters = url.substr(pos + 1);
std::stringstream ss(queryParameters);
std::string param;
while (std::getline(ss, param, '&')) {
pos = param.find('=');
if (pos != std::string::npos) {
std::string key = param.substr(0, pos);
std::string value = param.substr(pos + 1);
queryParams[key] = value;
}
}
}
return queryParams;
}
std::string
osgEarth::Util::getFullPath(const std::string& relativeTo, const std::string &relativePath)
{
static std::unordered_map<std::string, std::string> s_cache;
static std::mutex s_cache_mutex;
//static float tries = 0, hits = 0;
std::string cacheKey = relativeTo + "&" + relativePath;
std::lock_guard<std::mutex> lock(s_cache_mutex);
//tries += 1.0f;
auto i = s_cache.find(cacheKey);
if (i != s_cache.end())
{
//hits += 1.0f;
//OE_INFO << "size=" << s_cache.size() << " tries=" << tries << " hits=" << (100.*hits/tries) << std::endl;
return i->second;
}
// prevent the cache from growing unbounded
if (s_cache.size() >= 20000)
s_cache.clear();
// result that will go into the cache:
std::string result;
std::string relativeToMinusQueryParams = relativeTo;
std::string relativePathMinusQueryParams = relativePath;
std::map< std::string, std::string> queryParams;
// We are going to merge query parameters on both the relativeTo and relativePath arguments for the final URL.
if (osgDB::containsServerAddress(relativeTo))
{
queryParams = extractQueryParams(relativeTo);
auto queryParams2 = extractQueryParams(relativePath);
for (auto& p : queryParams2)
{
queryParams.insert(p);
}
relativeToMinusQueryParams = removeQueryParams(relativeTo);
relativePathMinusQueryParams = removeQueryParams(relativePath);
}
// If the relativePath starts with a / then it's really relative to the root server address of the relativeTo.
// For example if relativeTo is http://example.com/assets/1 and the relativePath is /models/7 then the final URL should be
// http://example.com/models/7
if (osgDB::containsServerAddress(relativeToMinusQueryParams) && osgEarth::startsWith(relativePathMinusQueryParams, "/"))
{
std::string serverAddress = osgDB::getServerProtocol(relativeToMinusQueryParams) + "://" + osgDB::getServerAddress(relativeToMinusQueryParams);
std::string filename = serverAddress + relativePathMinusQueryParams;
std::string path = stripRelativePaths(filename);
result = path;
}
// If they passed in an absolute path, strip any relative paths that might be embedded in the path.
// So if they passed in c:/data/models/../../file.jpg this will return the resolved path of c:/file.jpg
else if (!isRelativePath(relativePathMinusQueryParams))
{
result = stripRelativePaths(relativePathMinusQueryParams);
}
// They passed in a relative path but no relativeTo, so just return the relativePath as is.
else if (relativeToMinusQueryParams.empty())
{
result = relativePathMinusQueryParams;
}
//If they didn't specify a relative path, just return the relativeTo
else if (relativePathMinusQueryParams.empty())
{
result = relativeToMinusQueryParams;
}
else
{
//Note: Modified from VPB
//Concatinate the paths together
std::string filename;
if ( !osgDB::containsServerAddress(relativeToMinusQueryParams) )
filename = osgDB::concatPaths( osgDB::getFilePath( osgDB::getRealPath(relativeToMinusQueryParams)), relativePathMinusQueryParams);
else
filename = osgDB::concatPaths( osgDB::getFilePath(relativeToMinusQueryParams), relativePathMinusQueryParams);
std::string path = stripRelativePaths(filename);
//OE_NOTICE << "FullPath " << path << std::endl;
result = path;
}
// Append the merged query parameters to the result
if (!queryParams.empty())
{
std::stringstream buf;
bool firstParam = true;
for (auto& p : queryParams)
{
if (!firstParam)
{
buf << "&";
}
buf << p.first << "=" << p.second;
firstParam = false;
}
std::string queryParamsStr = buf.str();
if (!queryParamsStr.empty())
{
result = result + "?" + queryParamsStr;
}
}
// cache the result and return it.
s_cache[cacheKey] = result;
return result;
}
std::string
osgEarth::Util::stripRelativePaths(const std::string& filename)
{
// If they pass in a relative path just return it unmodified
if (isRelativePath(filename))
{
return filename;
}
std::list<std::string> directories;
int start = 0;
for (unsigned int i = 0; i < filename.size(); ++i)
{
if (filename[i] == '\\' || filename[i] == '/')
{
//Get the current directory
std::string dir = filename.substr(start, i - start);
if (dir != "..")
{
if (dir != ".")
{
directories.push_back(dir);
}
}
else if (!directories.empty())
{
directories.pop_back();
}
start = i + 1;
}
}
std::string path;
for (std::list<std::string>::iterator itr = directories.begin();
itr != directories.end();
++itr)
{
path += *itr;
path += "/";
}
path += filename.substr(start, std::string::npos);
return path;
}
std::string osgEarth::Util::removeQueryParams(const std::string& uri) {
std::string::size_type pos = uri.find('?');
if (pos != std::string::npos) {
return uri.substr(0, pos);
}
return uri;
}
// force getFullPath's statics to be initialized at startup
OSG_INIT_SINGLETON_PROXY(osgEarthFileUtilsGetFullPathInitSingletonProxy, osgEarth::Util::getFullPath(std::string(), std::string()));
bool
osgEarth::Util::isArchive(const std::string& path)
{
osgDB::Registry::ArchiveExtensionList list = osgDB::Registry::instance()->getArchiveExtensions();
for( osgDB::Registry::ArchiveExtensionList::const_iterator i = list.begin(); i != list.end(); ++i )
{
if ( osgEarth::Util::endsWith(path, ("."+*i), false) )
return true;
}
return false;
}
bool
osgEarth::Util::isPathToArchivedFile(const std::string& path)
{
osgDB::Registry::ArchiveExtensionList list = osgDB::Registry::instance()->getArchiveExtensions();
for( osgDB::Registry::ArchiveExtensionList::const_iterator i = list.begin(); i != list.end(); ++i )
{
if (path.find("."+*i+"/") != std::string::npos ||
path.find("."+*i+"\\") != std::string::npos)
{
return true;
}
}
return false;
}
std::string
osgEarth::Util::getTempPath()
{
#if defined(WIN32) && !defined(__CYGWIN__)
BOOL fSuccess = FALSE;
TCHAR lpTempPathBuffer[MAX_PATH];
// Gets the temp path env string (no guarantee it's a valid path).
DWORD dwRetVal = ::GetTempPath(MAX_PATH, // length of the buffer
lpTempPathBuffer); // buffer for path
if (dwRetVal > MAX_PATH || (dwRetVal == 0))
{
OE_NOTICE << "GetTempPath failed" << std::endl;
return ".";
}
return std::string(lpTempPathBuffer);
#else
return "/tmp/";
#endif
}
std::string
osgEarth::Util::getTempName(const std::string& prefix, const std::string& suffix)
{
//tmpname is kind of busted on Windows, it always returns a file of the form \blah which gets put in your root directory but
//oftentimes can't get opened by some drivers b/c it doesn't have a drive letter in front of it.
while (true)
{
std::stringstream ss;
ss << prefix << "~" << std::this_thread::get_id() << "_" << rand() << suffix;
if (!osgDB::fileExists(ss.str()))
return ss.str();
}
}
bool
osgEarth::Util::makeDirectory( const std::string &path )
{
if (path.empty())
{
OSG_DEBUG << "osgDB::makeDirectory(): cannot create an empty directory" << std::endl;
return false;
}
struct stat64 stbuf;
#ifdef OSG_USE_UTF8_FILENAME
if( _wstat64( OSGDB_STRING_TO_FILENAME(path).c_str(), &stbuf ) == 0 )
#else
if( stat64( path.c_str(), &stbuf ) == 0 )
#endif
{
if( S_ISDIR(stbuf.st_mode))
return true;
else
{
OSG_DEBUG << "osgDB::makeDirectory(): " <<
path << " already exists and is not a directory!" << std::endl;
return false;
}
}
std::string dir = path;
std::stack<std::string> paths;
while( true )
{
if( dir.empty() )
break;
#ifdef OSG_USE_UTF8_FILENAME
if( _wstat64( OSGDB_STRING_TO_FILENAME(dir).c_str(), &stbuf ) < 0 )
#else
if( stat64( dir.c_str(), &stbuf ) < 0 )
#endif
{
switch( errno )
{
case ENOENT:
case ENOTDIR:
paths.push( dir );
break;
default:
OSG_DEBUG << "osgDB::makeDirectory(): " << strerror(errno) << std::endl;
return false;
}
}
dir = osgDB::getFilePath(std::string(dir));
}
while( !paths.empty() )
{
std::string dir = paths.top();
#if defined(WIN32)
//catch drive name
if (dir.size() == 2 && dir.c_str()[1] == ':') {
paths.pop();
continue;
}
#endif
#ifdef OSG_USE_UTF8_FILENAME
if ( _wmkdir(OSGDB_STRING_TO_FILENAME(dir).c_str())< 0 )
#else
if( mkdir( dir.c_str(), 0755 )< 0 )
#endif
{
if (osgDB::fileExists(dir))
{
OE_DEBUG << "Attempt to create directory that already exists " << dir << std::endl;
}
else
{
OSG_DEBUG << "osgDB::makeDirectory(): " << strerror(errno) << std::endl;
return false;
}
}
paths.pop();
}
return true;
}
bool
osgEarth::Util::makeDirectoryForFile( const std::string &path )
{
return makeDirectory( osgDB::getFilePath( path ));
}
bool
osgEarth::Util::touchFile(const std::string& path)
{
DateTime now;
struct ::utimbuf ut;
ut.actime = now.asTimeStamp();
ut.modtime = now.asTimeStamp();
return 0 == ::utime( path.c_str(), &ut );
}
TimeStamp
osgEarth::Util::getLastModifiedTime(const std::string& path)
{
struct stat buf;
if ( stat(path.c_str(), &buf) == 0 )
return buf.st_mtime;
else
return 0;
}
/**************************************************/
DirectoryVisitor::DirectoryVisitor()
{
}
void DirectoryVisitor::handleFile( const std::string& filename )
{
}
bool DirectoryVisitor::handleDir( const std::string& path )
{
return true;
}
void DirectoryVisitor::traverse(const std::string& path )
{
if ( osgDB::fileType(path) == osgDB::DIRECTORY )
{
if (handleDir( path ))
{
osgDB::DirectoryContents files = osgDB::getDirectoryContents(path);
for( osgDB::DirectoryContents::const_iterator f = files.begin(); f != files.end(); ++f )
{
if ( f->compare(".") == 0 || f->compare("..") == 0 )
continue;
std::string filepath = osgDB::concatPaths( path, *f );
traverse( filepath );
}
}
}
else if ( osgDB::fileType(path) == osgDB::REGULAR_FILE )
{
handleFile( path );
}
}
/**************************************************/
CollectFilesVisitor::CollectFilesVisitor()
{
}
void CollectFilesVisitor::handleFile( const std::string& filename )
{
filenames.push_back( filename );
}