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
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
|
/*
* Copyright 2011-2013 Blender Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "util/path.h"
#include "util/md5.h"
#include "util/string.h"
#include <OpenImageIO/filesystem.h>
#include <OpenImageIO/strutil.h>
#include <OpenImageIO/sysutil.h>
OIIO_NAMESPACE_USING
#include <stdio.h>
#include <sys/stat.h>
#if defined(_WIN32)
# define DIR_SEP '\\'
# define DIR_SEP_ALT '/'
# include <direct.h>
#else
# define DIR_SEP '/'
# include <dirent.h>
# include <pwd.h>
# include <sys/types.h>
# include <unistd.h>
#endif
#ifdef HAVE_SHLWAPI_H
# include <shlwapi.h>
#endif
#include "util/map.h"
#include "util/windows.h"
CCL_NAMESPACE_BEGIN
#ifdef _WIN32
# if defined(_MSC_VER) || defined(__MINGW64__)
typedef struct _stat64 path_stat_t;
# elif defined(__MINGW32__)
typedef struct _stati64 path_stat_t;
# else
typedef struct _stat path_stat_t;
# endif
# ifndef S_ISDIR
# define S_ISDIR(x) (((x)&_S_IFDIR) == _S_IFDIR)
# endif
#else
typedef struct stat path_stat_t;
#endif
static string cached_path = "";
static string cached_user_path = "";
static string cached_temp_path = "";
static string cached_xdg_cache_path = "";
namespace {
#ifdef _WIN32
class directory_iterator {
public:
class path_info {
public:
path_info(const string &path, const WIN32_FIND_DATAW &find_data)
: path_(path), find_data_(find_data)
{
}
string path()
{
return path_join(path_, string_from_wstring(find_data_.cFileName));
}
protected:
const string &path_;
const WIN32_FIND_DATAW &find_data_;
};
directory_iterator() : path_info_("", find_data_), h_find_(INVALID_HANDLE_VALUE)
{
}
explicit directory_iterator(const string &path) : path_(path), path_info_(path, find_data_)
{
string wildcard = path;
if (wildcard[wildcard.size() - 1] != DIR_SEP) {
wildcard += DIR_SEP;
}
wildcard += "*";
h_find_ = FindFirstFileW(string_to_wstring(wildcard).c_str(), &find_data_);
if (h_find_ != INVALID_HANDLE_VALUE) {
skip_dots();
}
}
~directory_iterator()
{
if (h_find_ != INVALID_HANDLE_VALUE) {
FindClose(h_find_);
}
}
directory_iterator &operator++()
{
step();
return *this;
}
path_info *operator->()
{
return &path_info_;
}
bool operator!=(const directory_iterator &other)
{
return h_find_ != other.h_find_;
}
protected:
bool step()
{
if (do_step()) {
return skip_dots();
}
return false;
}
bool do_step()
{
if (h_find_ != INVALID_HANDLE_VALUE) {
bool result = FindNextFileW(h_find_, &find_data_) == TRUE;
if (!result) {
FindClose(h_find_);
h_find_ = INVALID_HANDLE_VALUE;
}
return result;
}
return false;
}
bool skip_dots()
{
while (wcscmp(find_data_.cFileName, L".") == 0 || wcscmp(find_data_.cFileName, L"..") == 0) {
if (!do_step()) {
return false;
}
}
return true;
}
string path_;
path_info path_info_;
WIN32_FIND_DATAW find_data_;
HANDLE h_find_;
};
#else /* _WIN32 */
class directory_iterator {
public:
class path_info {
public:
explicit path_info(const string &path) : path_(path), entry_(NULL)
{
}
string path()
{
return path_join(path_, entry_->d_name);
}
void current_entry_set(const struct dirent *entry)
{
entry_ = entry;
}
protected:
const string &path_;
const struct dirent *entry_;
};
directory_iterator() : path_info_(""), name_list_(NULL), num_entries_(-1), cur_entry_(-1)
{
}
explicit directory_iterator(const string &path) : path_(path), path_info_(path_), cur_entry_(0)
{
num_entries_ = scandir(path.c_str(), &name_list_, NULL, alphasort);
if (num_entries_ < 0) {
perror("scandir");
}
else {
skip_dots();
}
}
~directory_iterator()
{
destroy_name_list();
}
directory_iterator &operator++()
{
step();
return *this;
}
path_info *operator->()
{
path_info_.current_entry_set(name_list_[cur_entry_]);
return &path_info_;
}
bool operator!=(const directory_iterator &other)
{
return name_list_ != other.name_list_;
}
protected:
bool step()
{
if (do_step()) {
return skip_dots();
}
return false;
}
bool do_step()
{
++cur_entry_;
if (cur_entry_ >= num_entries_) {
destroy_name_list();
return false;
}
return true;
}
/* Skip . and .. folders. */
bool skip_dots()
{
while (strcmp(name_list_[cur_entry_]->d_name, ".") == 0 ||
strcmp(name_list_[cur_entry_]->d_name, "..") == 0) {
if (!step()) {
return false;
}
}
return true;
}
void destroy_name_list()
{
if (name_list_ == NULL) {
return;
}
for (int i = 0; i < num_entries_; ++i) {
free(name_list_[i]);
}
free(name_list_);
name_list_ = NULL;
}
string path_;
path_info path_info_;
struct dirent **name_list_;
int num_entries_, cur_entry_;
};
#endif /* _WIN32 */
size_t find_last_slash(const string &path)
{
for (size_t i = 0; i < path.size(); ++i) {
size_t index = path.size() - 1 - i;
#ifdef _WIN32
if (path[index] == DIR_SEP || path[index] == DIR_SEP_ALT)
#else
if (path[index] == DIR_SEP)
#endif
{
return index;
}
}
return string::npos;
}
} /* namespace */
static char *path_specials(const string &sub)
{
static bool env_init = false;
static char *env_shader_path;
static char *env_source_path;
if (!env_init) {
env_shader_path = getenv("CYCLES_SHADER_PATH");
/* NOTE: It is KERNEL in env variable for compatibility reasons. */
env_source_path = getenv("CYCLES_KERNEL_PATH");
env_init = true;
}
if (env_shader_path != NULL && sub == "shader") {
return env_shader_path;
}
else if (env_source_path != NULL && sub == "source") {
return env_source_path;
}
return NULL;
}
#if defined(__linux__) || defined(__APPLE__)
static string path_xdg_cache_get()
{
const char *home = getenv("XDG_CACHE_HOME");
if (home) {
return string(home);
}
else {
home = getenv("HOME");
if (home == NULL) {
home = getpwuid(getuid())->pw_dir;
}
return path_join(string(home), ".cache");
}
}
#endif
void path_init(const string &path, const string &user_path, const string &temp_path)
{
cached_path = path;
cached_user_path = user_path;
cached_temp_path = temp_path;
#ifdef _MSC_VER
// workaround for https://svn.boost.org/trac/boost/ticket/6320
// indirectly init boost codec here since it's not thread safe, and can
// cause crashes when it happens in multithreaded image load
OIIO::Filesystem::exists(path);
#endif
}
string path_get(const string &sub)
{
char *special = path_specials(sub);
if (special != NULL)
return special;
if (cached_path == "")
cached_path = path_dirname(Sysutil::this_program_path());
return path_join(cached_path, sub);
}
string path_user_get(const string &sub)
{
if (cached_user_path == "")
cached_user_path = path_dirname(Sysutil::this_program_path());
return path_join(cached_user_path, sub);
}
string path_cache_get(const string &sub)
{
#if defined(__linux__) || defined(__APPLE__)
if (cached_xdg_cache_path == "") {
cached_xdg_cache_path = path_xdg_cache_get();
}
string result = path_join(cached_xdg_cache_path, "cycles");
return path_join(result, sub);
#else
/* TODO(sergey): What that should be on Windows? */
return path_user_get(path_join("cache", sub));
#endif
}
string path_temp_get(const string &sub)
{
if (cached_temp_path == "") {
cached_temp_path = Filesystem::temp_directory_path();
}
return path_join(cached_temp_path, sub);
}
#if defined(__linux__) || defined(__APPLE__)
string path_xdg_home_get(const string &sub = "");
#endif
string path_filename(const string &path)
{
size_t index = find_last_slash(path);
if (index != string::npos) {
/* Corner cases to match boost behavior. */
#ifndef _WIN32
if (index == 0 && path.size() == 1) {
return path;
}
#endif
if (index == path.size() - 1) {
#ifdef _WIN32
if (index == 2) {
return string(1, DIR_SEP);
}
#endif
return ".";
}
return path.substr(index + 1, path.size() - index - 1);
}
return path;
}
string path_dirname(const string &path)
{
size_t index = find_last_slash(path);
if (index != string::npos) {
#ifndef _WIN32
if (index == 0 && path.size() > 1) {
return string(1, DIR_SEP);
}
#endif
return path.substr(0, index);
}
return "";
}
string path_join(const string &dir, const string &file)
{
if (dir.size() == 0) {
return file;
}
if (file.size() == 0) {
return dir;
}
string result = dir;
#ifndef _WIN32
if (result[result.size() - 1] != DIR_SEP && file[0] != DIR_SEP)
#else
if (result[result.size() - 1] != DIR_SEP && result[result.size() - 1] != DIR_SEP_ALT &&
file[0] != DIR_SEP && file[0] != DIR_SEP_ALT)
#endif
{
result += DIR_SEP;
}
result += file;
return result;
}
string path_escape(const string &path)
{
string result = path;
string_replace(result, " ", "\\ ");
return result;
}
bool path_is_relative(const string &path)
{
#ifdef _WIN32
# ifdef HAVE_SHLWAPI_H
return PathIsRelative(path.c_str());
# else /* HAVE_SHLWAPI_H */
if (path.size() >= 3) {
return !(((path[0] >= 'a' && path[0] <= 'z') || (path[0] >= 'A' && path[0] <= 'Z')) &&
path[1] == ':' && path[2] == DIR_SEP);
}
return true;
# endif /* HAVE_SHLWAPI_H */
#else /* _WIN32 */
if (path.size() == 0) {
return 1;
}
return path[0] != DIR_SEP;
#endif /* _WIN32 */
}
#ifdef _WIN32
/* Add a slash if the UNC path points to a share. */
static string path_unc_add_slash_to_share(const string &path)
{
size_t slash_after_server = path.find(DIR_SEP, 2);
if (slash_after_server != string::npos) {
size_t slash_after_share = path.find(DIR_SEP, slash_after_server + 1);
if (slash_after_share == string::npos) {
return path + DIR_SEP;
}
}
return path;
}
/* Convert:
* \\?\UNC\server\share\folder\... to \\server\share\folder\...
* \\?\C:\ to C:\ and \\?\C:\folder\... to C:\folder\...
*/
static string path_unc_to_short(const string &path)
{
size_t len = path.size();
if ((len > 3) && (path[0] == DIR_SEP) && (path[1] == DIR_SEP) && (path[2] == '?') &&
((path[3] == DIR_SEP) || (path[3] == DIR_SEP_ALT))) {
if ((len > 5) && (path[5] == ':')) {
return path.substr(4, len - 4);
}
else if ((len > 7) && (path.substr(4, 3) == "UNC") &&
((path[7] == DIR_SEP) || (path[7] == DIR_SEP_ALT))) {
return "\\\\" + path.substr(8, len - 8);
}
}
return path;
}
static string path_cleanup_unc(const string &path)
{
string result = path_unc_to_short(path);
if (path.size() > 2) {
/* It's possible path is now a non-UNC. */
if (result[0] == DIR_SEP && result[1] == DIR_SEP) {
return path_unc_add_slash_to_share(result);
}
}
return result;
}
/* Make path compatible for stat() functions. */
static string path_make_compatible(const string &path)
{
string result = path;
/* In Windows stat() doesn't recognize dir ending on a slash. */
if (result.size() > 3 && result[result.size() - 1] == DIR_SEP) {
result.resize(result.size() - 1);
}
/* Clean up UNC path. */
if ((path.size() >= 3) && (path[0] == DIR_SEP) && (path[1] == DIR_SEP)) {
result = path_cleanup_unc(result);
}
/* Make sure volume-only path ends up wit a directory separator. */
if (result.size() == 2 && result[1] == ':') {
result += DIR_SEP;
}
return result;
}
static int path_wstat(const wstring &path_wc, path_stat_t *st)
{
# if defined(_MSC_VER) || defined(__MINGW64__)
return _wstat64(path_wc.c_str(), st);
# elif defined(__MINGW32__)
return _wstati64(path_wc.c_str(), st);
# else
return _wstat(path_wc.c_str(), st);
# endif
}
static int path_stat(const string &path, path_stat_t *st)
{
wstring path_wc = string_to_wstring(path);
return path_wstat(path_wc, st);
}
#else /* _WIN32 */
static int path_stat(const string &path, path_stat_t *st)
{
return stat(path.c_str(), st);
}
#endif /* _WIN32 */
size_t path_file_size(const string &path)
{
path_stat_t st;
if (path_stat(path, &st) != 0) {
return -1;
}
return st.st_size;
}
bool path_exists(const string &path)
{
#ifdef _WIN32
string fixed_path = path_make_compatible(path);
wstring path_wc = string_to_wstring(fixed_path);
path_stat_t st;
if (path_wstat(path_wc, &st) != 0) {
return false;
}
return st.st_mode != 0;
#else /* _WIN32 */
struct stat st;
if (stat(path.c_str(), &st) != 0) {
return 0;
}
return st.st_mode != 0;
#endif /* _WIN32 */
}
bool path_is_directory(const string &path)
{
path_stat_t st;
if (path_stat(path, &st) != 0) {
return false;
}
return S_ISDIR(st.st_mode);
}
static void path_files_md5_hash_recursive(MD5Hash &hash, const string &dir)
{
if (path_exists(dir)) {
directory_iterator it(dir), it_end;
for (; it != it_end; ++it) {
if (path_is_directory(it->path())) {
path_files_md5_hash_recursive(hash, it->path());
}
else {
string filepath = it->path();
hash.append((const uint8_t *)filepath.c_str(), filepath.size());
hash.append_file(filepath);
}
}
}
}
string path_files_md5_hash(const string &dir)
{
/* computes md5 hash of all files in the directory */
MD5Hash hash;
path_files_md5_hash_recursive(hash, dir);
return hash.get_hex();
}
static bool create_directories_recursivey(const string &path)
{
if (path_is_directory(path)) {
/* Directory already exists, nothing to do. */
return true;
}
if (path_exists(path)) {
/* File exists and it's not a directory. */
return false;
}
string parent = path_dirname(path);
if (parent.size() > 0 && parent != path) {
if (!create_directories_recursivey(parent)) {
return false;
}
}
#ifdef _WIN32
wstring path_wc = string_to_wstring(path);
return _wmkdir(path_wc.c_str()) == 0;
#else
return mkdir(path.c_str(), 0777) == 0;
#endif
}
void path_create_directories(const string &filepath)
{
string path = path_dirname(filepath);
create_directories_recursivey(path);
}
bool path_write_binary(const string &path, const vector<uint8_t> &binary)
{
path_create_directories(path);
/* write binary file from memory */
FILE *f = path_fopen(path, "wb");
if (!f)
return false;
if (binary.size() > 0)
fwrite(&binary[0], sizeof(uint8_t), binary.size(), f);
fclose(f);
return true;
}
bool path_write_text(const string &path, string &text)
{
vector<uint8_t> binary(text.length(), 0);
std::copy(text.begin(), text.end(), binary.begin());
return path_write_binary(path, binary);
}
bool path_read_binary(const string &path, vector<uint8_t> &binary)
{
/* read binary file into memory */
FILE *f = path_fopen(path, "rb");
if (!f) {
binary.resize(0);
return false;
}
binary.resize(path_file_size(path));
if (binary.size() == 0) {
fclose(f);
return false;
}
if (fread(&binary[0], sizeof(uint8_t), binary.size(), f) != binary.size()) {
fclose(f);
return false;
}
fclose(f);
return true;
}
bool path_read_text(const string &path, string &text)
{
vector<uint8_t> binary;
if (!path_exists(path) || !path_read_binary(path, binary))
return false;
const char *str = (const char *)&binary[0];
size_t size = binary.size();
text = string(str, size);
return true;
}
uint64_t path_modified_time(const string &path)
{
path_stat_t st;
if (path_stat(path, &st) != 0) {
return 0;
}
return st.st_mtime;
}
bool path_remove(const string &path)
{
return remove(path.c_str()) == 0;
}
FILE *path_fopen(const string &path, const string &mode)
{
#ifdef _WIN32
wstring path_wc = string_to_wstring(path);
wstring mode_wc = string_to_wstring(mode);
return _wfopen(path_wc.c_str(), mode_wc.c_str());
#else
return fopen(path.c_str(), mode.c_str());
#endif
}
void path_cache_clear_except(const string &name, const set<string> &except)
{
string dir = path_user_get("cache");
if (path_exists(dir)) {
directory_iterator it(dir), it_end;
for (; it != it_end; ++it) {
string filename = path_filename(it->path());
if (string_startswith(filename, name.c_str()))
if (except.find(filename) == except.end())
path_remove(it->path());
}
}
}
CCL_NAMESPACE_END
|