-
-
Notifications
You must be signed in to change notification settings - Fork 988
/
filesystem_boost.cpp
1378 lines (1196 loc) · 36.2 KB
/
filesystem_boost.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
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
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright (C) 2003 - 2012 by David White <dave@whitevine.net>
Part of the Battle for Wesnoth Project http://www.wesnoth.org/
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU 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.
See the COPYING file for more details.
*/
/**
* @file
* File-IO
*/
#include "filesystem.hpp"
#include "serialization/unicode.hpp"
#include <boost/filesystem.hpp>
#include <boost/filesystem/fstream.hpp>
#include <boost/system/windows_error.hpp>
#include <boost/iostreams/device/file_descriptor.hpp>
#include <boost/iostreams/stream.hpp>
#include <boost/algorithm/string.hpp>
#include <algorithm>
#include <set>
#ifdef _WIN32
#include "log_windows.hpp"
#include <boost/locale.hpp>
#include <windows.h>
#include <shlobj.h>
#include <shlwapi.h>
// Work around TDM-GCC not #defining this according to @newfrenchy83.
#define VOLUME_NAME_NONE 0x4
#endif /* !_WIN32 */
#include "config.hpp"
#include "game_config.hpp"
#include "log.hpp"
#include "serialization/unicode_cast.hpp"
#include "version.hpp"
static lg::log_domain log_filesystem("filesystem");
#define DBG_FS LOG_STREAM(debug, log_filesystem)
#define LOG_FS LOG_STREAM(info, log_filesystem)
#define WRN_FS LOG_STREAM(warn, log_filesystem)
#define ERR_FS LOG_STREAM(err, log_filesystem)
namespace bfs = boost::filesystem;
using boost::filesystem::path;
using boost::system::error_code;
namespace {
// These are the filenames that get special processing
const std::string maincfg_filename = "_main.cfg";
const std::string finalcfg_filename = "_final.cfg";
const std::string initialcfg_filename = "_initial.cfg";
}
namespace {
//only used by windows but put outside the ifdef to let it check by ci build.
class customcodecvt : public std::codecvt<wchar_t /*intern*/, char /*extern*/, std::mbstate_t>
{
private:
//private static helper things
template<typename char_t_to>
struct customcodecvt_do_conversion_writer
{
customcodecvt_do_conversion_writer(char_t_to*& _to_next, char_t_to* _to_end) :
to_next(_to_next),
to_end(_to_end)
{}
char_t_to*& to_next;
char_t_to* to_end;
bool can_push(std::size_t count) const
{
return static_cast<std::size_t>(to_end - to_next) > count;
}
void push(char_t_to val)
{
assert(to_next != to_end);
*to_next++ = val;
}
};
template<typename char_t_from , typename char_t_to>
static void customcodecvt_do_conversion( std::mbstate_t& /*state*/,
const char_t_from* from,
const char_t_from* from_end,
const char_t_from*& from_next,
char_t_to* to,
char_t_to* to_end,
char_t_to*& to_next )
{
typedef typename ucs4_convert_impl::convert_impl<char_t_from>::type impl_type_from;
typedef typename ucs4_convert_impl::convert_impl<char_t_to>::type impl_type_to;
from_next = from;
to_next = to;
customcodecvt_do_conversion_writer<char_t_to> writer(to_next, to_end);
while(from_next != from_end)
{
impl_type_to::write(writer, impl_type_from::read(from_next, from_end));
}
}
public:
//Not used by boost filesystem
int do_encoding() const noexcept { return 0; }
//Not used by boost filesystem
bool do_always_noconv() const noexcept { return false; }
int do_length( std::mbstate_t& /*state*/,
const char* /*from*/,
const char* /*from_end*/,
std::size_t /*max*/ ) const
{
//Not used by boost filesystem
throw "Not supported";
}
std::codecvt_base::result unshift( std::mbstate_t& /*state*/,
char* /*to*/,
char* /*to_end*/,
char*& /*to_next*/) const
{
//Not used by boost filesystem
throw "Not supported";
}
//there are still some methods which could be implemented but aren't because boost filesystem won't use them.
std::codecvt_base::result do_in( std::mbstate_t& state,
const char* from,
const char* from_end,
const char*& from_next,
wchar_t* to,
wchar_t* to_end,
wchar_t*& to_next ) const
{
try
{
customcodecvt_do_conversion<char, wchar_t>(state, from, from_end, from_next, to, to_end, to_next);
}
catch(...)
{
ERR_FS << "Invalid UTF-8 string'" << std::string(from, from_end) << "' " << std::endl;
return std::codecvt_base::error;
}
return std::codecvt_base::ok;
}
std::codecvt_base::result do_out( std::mbstate_t& state,
const wchar_t* from,
const wchar_t* from_end,
const wchar_t*& from_next,
char* to,
char* to_end,
char*& to_next ) const
{
try
{
customcodecvt_do_conversion<wchar_t, char>(state, from, from_end, from_next, to, to_end, to_next);
}
catch(...)
{
ERR_FS << "Invalid UTF-16 string" << std::endl;
return std::codecvt_base::error;
}
return std::codecvt_base::ok;
}
};
#ifdef _WIN32
class static_runner {
public:
static_runner() {
// Boost uses the current locale to generate a UTF-8 one
std::locale utf8_loc = boost::locale::generator().generate("");
// use a custom locale because we want to use out log.hpp functions in case of an invalid string.
utf8_loc = std::locale(utf8_loc, new customcodecvt());
boost::filesystem::path::imbue(utf8_loc);
}
};
static static_runner static_bfs_path_imbuer;
typedef DWORD(WINAPI *GetFinalPathNameByHandleWPtr)(HANDLE, LPWSTR, DWORD, DWORD);
static GetFinalPathNameByHandleWPtr dyn_GetFinalPathNameByHandle;
bool is_filename_case_correct(const std::string& fname, const boost::iostreams::file_descriptor_source& fd)
{
if(dyn_GetFinalPathNameByHandle == nullptr) {
// Windows XP. Just assume that the case is correct.
return true;
}
wchar_t real_path[MAX_PATH];
dyn_GetFinalPathNameByHandle(fd.handle(), real_path, MAX_PATH - 1, VOLUME_NAME_NONE);
std::string real_name = filesystem::base_name(unicode_cast<std::string>(std::wstring(real_path)));
return real_name == filesystem::base_name(fname);
}
#else
bool is_filename_case_correct(const std::string& /*fname*/, const boost::iostreams::file_descriptor_source& /*fd*/)
{
return true;
}
#endif
}
namespace filesystem {
void init()
{
#ifdef _WIN32
HMODULE kernel32 = GetModuleHandle(TEXT("Kernel32.dll"));
// Note that this returns a null pointer on Windows XP!
dyn_GetFinalPathNameByHandle = reinterpret_cast<GetFinalPathNameByHandleWPtr>(
GetProcAddress(kernel32, "GetFinalPathNameByHandleW"));
#endif
}
static void push_if_exists(std::vector<std::string> *vec, const path &file, bool full) {
if (vec != nullptr) {
if (full)
vec->push_back(file.generic_string());
else
vec->push_back(file.filename().generic_string());
}
}
static inline bool error_except_not_found(const error_code &ec)
{
return (ec
&& ec.value() != boost::system::errc::no_such_file_or_directory
#ifdef _WIN32
&& ec.value() != boost::system::windows_error::path_not_found
#endif /*_WIN32*/
);
}
static bool is_directory_internal(const path &fpath)
{
error_code ec;
bool is_dir = bfs::is_directory(fpath, ec);
if (error_except_not_found(ec)) {
LOG_FS << "Failed to check if " << fpath.string() << " is a directory: " << ec.message() << '\n';
}
return is_dir;
}
static bool file_exists(const path &fpath)
{
error_code ec;
bool exists = bfs::exists(fpath, ec);
if (error_except_not_found(ec)) {
ERR_FS << "Failed to check existence of file " << fpath.string() << ": " << ec.message() << '\n';
}
return exists;
}
static path get_dir(const path &dirpath)
{
bool is_dir = is_directory_internal(dirpath);
if (!is_dir) {
error_code ec;
bfs::create_directory(dirpath, ec);
if (ec) {
ERR_FS << "Failed to create directory " << dirpath.string() << ": " << ec.message() << '\n';
}
// This is probably redundant
is_dir = is_directory_internal(dirpath);
}
if (!is_dir) {
ERR_FS << "Could not open or create directory " << dirpath.string() << '\n';
return std::string();
}
return dirpath;
}
static bool create_directory_if_missing(const path &dirpath)
{
error_code ec;
bfs::file_status fs = bfs::status(dirpath, ec);
if (error_except_not_found(ec)) {
ERR_FS << "Failed to retrieve file status for " << dirpath.string() << ": " << ec.message() << '\n';
return false;
} else if (bfs::is_directory(fs)) {
DBG_FS << "directory " << dirpath.string() << " exists, not creating\n";
return true;
} else if (bfs::exists(fs)) {
ERR_FS << "cannot create directory " << dirpath.string() << "; file exists\n";
return false;
}
bool created = bfs::create_directory(dirpath, ec);
if (ec) {
ERR_FS << "Failed to create directory " << dirpath.string() << ": " << ec.message() << '\n';
}
return created;
}
static bool create_directory_if_missing_recursive(const path& dirpath)
{
DBG_FS << "creating recursive directory: " << dirpath.string() << '\n';
if (dirpath.empty())
return false;
error_code ec;
bfs::file_status fs = bfs::status(dirpath);
if (error_except_not_found(ec)) {
ERR_FS << "Failed to retrieve file status for " << dirpath.string() << ": " << ec.message() << '\n';
return false;
} else if (bfs::is_directory(fs)) {
return true;
} else if (bfs::exists(fs)) {
return false;
}
if (!dirpath.has_parent_path() || create_directory_if_missing_recursive(dirpath.parent_path())) {
return create_directory_if_missing(dirpath);
} else {
ERR_FS << "Could not create parents to " << dirpath.string() << '\n';
return false;
}
}
void get_files_in_dir(const std::string &dir,
std::vector<std::string>* files,
std::vector<std::string>* dirs,
file_name_option mode,
file_filter_option filter,
file_reorder_option reorder,
file_tree_checksum* checksum) {
if(path(dir).is_relative() && !game_config::path.empty()) {
path absolute_dir(game_config::path);
absolute_dir /= dir;
if(is_directory_internal(absolute_dir)) {
get_files_in_dir(absolute_dir.string(), files, dirs, mode, filter, reorder, checksum);
return;
}
}
const path dirpath(dir);
if (reorder == DO_REORDER) {
LOG_FS << "searching for _main.cfg in directory " << dir << '\n';
const path maincfg = dirpath / maincfg_filename;
if (file_exists(maincfg)) {
LOG_FS << "_main.cfg found : " << maincfg << '\n';
push_if_exists(files, maincfg, mode == ENTIRE_FILE_PATH);
return;
}
}
error_code ec;
bfs::directory_iterator di(dirpath, ec);
bfs::directory_iterator end;
if (ec) {
// Probably not a directory, let the caller deal with it.
return;
}
for(; di != end; ++di) {
bfs::file_status st = di->status(ec);
if (ec) {
LOG_FS << "Failed to get file status of " << di->path().string() << ": " << ec.message() << '\n';
continue;
}
if (st.type() == bfs::regular_file) {
{
std::string basename = di->path().filename().string();
if (filter == SKIP_PBL_FILES && looks_like_pbl(basename))
continue;
if(!basename.empty() && basename[0] == '.' )
continue;
}
push_if_exists(files, di->path(), mode == ENTIRE_FILE_PATH);
if (checksum != nullptr) {
std::time_t mtime = bfs::last_write_time(di->path(), ec);
if (ec) {
LOG_FS << "Failed to read modification time of " << di->path().string() << ": " << ec.message() << '\n';
} else if (mtime > checksum->modified) {
checksum->modified = mtime;
}
uintmax_t size = bfs::file_size(di->path(), ec);
if (ec) {
LOG_FS << "Failed to read filesize of " << di->path().string() << ": " << ec.message() << '\n';
} else {
checksum->sum_size += size;
}
checksum->nfiles++;
}
} else if (st.type() == bfs::directory_file) {
std::string basename = di->path().filename().string();
if(!basename.empty() && basename[0] == '.' )
continue;
if (filter == SKIP_MEDIA_DIR
&& (basename == "images" || basename == "sounds"))
continue;
const path inner_main(di->path() / maincfg_filename);
bfs::file_status main_st = bfs::status(inner_main, ec);
if (error_except_not_found(ec)) {
LOG_FS << "Failed to get file status of " << inner_main.string() << ": " << ec.message() << '\n';
} else if (reorder == DO_REORDER && main_st.type() == bfs::regular_file) {
LOG_FS << "_main.cfg found : " << (mode == ENTIRE_FILE_PATH ? inner_main.string() : inner_main.filename().string()) << '\n';
push_if_exists(files, inner_main, mode == ENTIRE_FILE_PATH);
} else {
push_if_exists(dirs, di->path(), mode == ENTIRE_FILE_PATH);
}
}
}
if (files != nullptr)
std::sort(files->begin(),files->end());
if (dirs != nullptr)
std::sort(dirs->begin(),dirs->end());
if (files != nullptr && reorder == DO_REORDER) {
// move finalcfg_filename, if present, to the end of the vector
for (unsigned int i = 0; i < files->size(); i++) {
if (ends_with((*files)[i], "/" + finalcfg_filename)) {
files->push_back((*files)[i]);
files->erase(files->begin()+i);
break;
}
}
// move initialcfg_filename, if present, to the beginning of the vector
int foundit = -1;
for (unsigned int i = 0; i < files->size(); i++)
if (ends_with((*files)[i], "/" + initialcfg_filename)) {
foundit = i;
break;
}
if (foundit > 0) {
std::string initialcfg = (*files)[foundit];
for (unsigned int i = foundit; i > 0; i--)
(*files)[i] = (*files)[i-1];
(*files)[0] = initialcfg;
}
}
}
std::string get_dir(const std::string &dir)
{
return get_dir(path(dir)).string();
}
std::string get_next_filename(const std::string& name, const std::string& extension)
{
std::string next_filename;
int counter = 0;
do {
std::stringstream filename;
filename << name;
filename.width(3);
filename.fill('0');
filename.setf(std::ios_base::right);
filename << counter << extension;
counter++;
next_filename = filename.str();
} while(file_exists(next_filename) && counter < 1000);
return next_filename;
}
static path user_data_dir, user_config_dir, cache_dir;
static const std::string& get_version_path_suffix()
{
static std::string suffix;
// We only really need to generate this once since
// the version number cannot change during runtime.
if(suffix.empty()) {
std::ostringstream s;
s << game_config::wesnoth_version.major_version() << '.'
<< game_config::wesnoth_version.minor_version();
suffix = s.str();
}
return suffix;
}
static void setup_user_data_dir()
{
if (!create_directory_if_missing_recursive(user_data_dir)) {
ERR_FS << "could not open or create user data directory at " << user_data_dir.string() << '\n';
return;
}
// TODO: this may not print the error message if the directory exists but we don't have the proper permissions
// Create user data and add-on directories
create_directory_if_missing(user_data_dir / "editor");
create_directory_if_missing(user_data_dir / "editor" / "maps");
create_directory_if_missing(user_data_dir / "editor" / "scenarios");
create_directory_if_missing(user_data_dir / "data");
create_directory_if_missing(user_data_dir / "data" / "add-ons");
create_directory_if_missing(user_data_dir / "saves");
create_directory_if_missing(user_data_dir / "persist");
#ifdef _WIN32
lg::finish_log_file_setup();
#endif
}
#ifdef _WIN32
// As a convenience for portable installs on Windows, relative paths with . or
// .. as the first component are considered relative to the current workdir
// instead of Documents/My Games.
static bool is_path_relative_to_cwd(const std::string& str)
{
const path p(str);
if(p.empty()) {
return false;
}
return *p.begin() == "." || *p.begin() == "..";
}
#endif
void set_user_data_dir(std::string newprefdir)
{
#ifdef PREFERENCES_DIR
if (newprefdir.empty()) newprefdir = PREFERENCES_DIR;
#endif
#ifdef _WIN32
if(newprefdir.size() > 2 && newprefdir[1] == ':') {
//allow absolute path override
user_data_dir = newprefdir;
} else if(is_path_relative_to_cwd(newprefdir)) {
// Custom directory relative to workdir (for portable installs, etc.)
user_data_dir = get_cwd() + "/" + newprefdir;
} else {
if(newprefdir.empty()) {
newprefdir = "Wesnoth" + get_version_path_suffix();
}
PWSTR docs_path = nullptr;
HRESULT res = SHGetKnownFolderPath(FOLDERID_Documents, KF_FLAG_CREATE, nullptr, &docs_path);
if(res != S_OK) {
//
// Crummy fallback path full of pain and suffering.
//
ERR_FS << "Could not determine path to user's Documents folder! ("
<< std::hex << "0x" << res << std::dec << ") "
<< "User config/data directories may be unavailable for "
<< "this session. Please report this as a bug.\n";
user_data_dir = path(get_cwd()) / newprefdir;
} else {
path games_path = path(docs_path) / "My Games";
create_directory_if_missing(games_path);
user_data_dir = games_path / newprefdir;
}
}
#else /*_WIN32*/
std::string backupprefdir = ".wesnoth" + get_version_path_suffix();
#ifdef _X11
const char *home_str = getenv("HOME");
if (newprefdir.empty()) {
char const *xdg_data = getenv("XDG_DATA_HOME");
if (!xdg_data || xdg_data[0] == '\0') {
if (!home_str) {
newprefdir = backupprefdir;
goto other;
}
user_data_dir = home_str;
user_data_dir /= ".local/share";
} else user_data_dir = xdg_data;
user_data_dir /= "wesnoth";
user_data_dir /= get_version_path_suffix();
} else {
other:
path home = home_str ? home_str : ".";
if (newprefdir[0] == '/')
user_data_dir = newprefdir;
else
user_data_dir = home / newprefdir;
}
#else
if (newprefdir.empty()) newprefdir = backupprefdir;
const char* home_str = getenv("HOME");
path home = home_str ? home_str : ".";
if (newprefdir[0] == '/')
user_data_dir = newprefdir;
else
user_data_dir = home / newprefdir;
#endif
#endif /*_WIN32*/
setup_user_data_dir();
user_data_dir = normalize_path(user_data_dir.string(), true, true);
}
static void set_user_config_path(path newconfig)
{
user_config_dir = newconfig;
if (!create_directory_if_missing_recursive(user_config_dir)) {
ERR_FS << "could not open or create user config directory at " << user_config_dir.string() << '\n';
}
}
void set_user_config_dir(const std::string& newconfigdir)
{
set_user_config_path(newconfigdir);
}
static const path &get_user_data_path()
{
if (user_data_dir.empty())
{
set_user_data_dir(std::string());
}
return user_data_dir;
}
std::string get_user_config_dir()
{
if (user_config_dir.empty())
{
#if defined(_X11) && !defined(PREFERENCES_DIR)
char const *xdg_config = getenv("XDG_CONFIG_HOME");
if (!xdg_config || xdg_config[0] == '\0') {
xdg_config = getenv("HOME");
if (!xdg_config) {
user_config_dir = get_user_data_path();
return user_config_dir.string();
}
user_config_dir = xdg_config;
user_config_dir /= ".config";
} else user_config_dir = xdg_config;
user_config_dir /= "wesnoth";
set_user_config_path(user_config_dir);
#else
user_config_dir = get_user_data_path();
#endif
}
return user_config_dir.string();
}
std::string get_user_data_dir()
{
return get_user_data_path().string();
}
std::string get_cache_dir()
{
if (cache_dir.empty())
{
#if defined(_X11) && !defined(PREFERENCES_DIR)
char const *xdg_cache = getenv("XDG_CACHE_HOME");
if (!xdg_cache || xdg_cache[0] == '\0') {
xdg_cache = getenv("HOME");
if (!xdg_cache) {
cache_dir = get_dir(get_user_data_path() / "cache");
return cache_dir.string();
}
cache_dir = xdg_cache;
cache_dir /= ".cache";
} else cache_dir = xdg_cache;
cache_dir /= "wesnoth";
create_directory_if_missing_recursive(cache_dir);
#else
cache_dir = get_dir(get_user_data_path() / "cache");
#endif
}
return cache_dir.string();
}
std::string get_cwd()
{
error_code ec;
path cwd = bfs::current_path(ec);
if (ec) {
ERR_FS << "Failed to get current directory: " << ec.message() << '\n';
return "";
}
return cwd.generic_string();
}
std::string get_exe_dir()
{
#ifdef _WIN32
wchar_t process_path[MAX_PATH];
SetLastError(ERROR_SUCCESS);
GetModuleFileNameW(nullptr, process_path, MAX_PATH);
if (GetLastError() != ERROR_SUCCESS) {
return get_cwd();
}
path exe(process_path);
return exe.parent_path().string();
#else
if (bfs::exists("/proc/")) {
path self_exe("/proc/self/exe");
error_code ec;
path exe = bfs::read_symlink(self_exe, ec);
if (ec) {
return std::string();
}
return exe.parent_path().string();
} else {
return get_cwd();
}
#endif
}
bool make_directory(const std::string& dirname)
{
error_code ec;
bool created = bfs::create_directory(path(dirname), ec);
if (ec) {
ERR_FS << "Failed to create directory " << dirname << ": " << ec.message() << '\n';
}
return created;
}
bool delete_directory(const std::string& dirname, const bool keep_pbl)
{
bool ret = true;
std::vector<std::string> files;
std::vector<std::string> dirs;
error_code ec;
get_files_in_dir(dirname, &files, &dirs, ENTIRE_FILE_PATH, keep_pbl ? SKIP_PBL_FILES : NO_FILTER);
if(!files.empty()) {
for(std::vector<std::string>::const_iterator i = files.begin(); i != files.end(); ++i) {
bfs::remove(path(*i), ec);
if (ec) {
LOG_FS << "remove(" << (*i) << "): " << ec.message() << '\n';
ret = false;
}
}
}
if(!dirs.empty()) {
for(std::vector<std::string>::const_iterator j = dirs.begin(); j != dirs.end(); ++j) {
//TODO: this does not preserve any other PBL files
// filesystem.cpp does this too, so this might be intentional
if(!delete_directory(*j))
ret = false;
}
}
if (ret) {
bfs::remove(path(dirname), ec);
if (ec) {
LOG_FS << "remove(" << dirname << "): " << ec.message() << '\n';
ret = false;
}
}
return ret;
}
bool delete_file(const std::string &filename)
{
error_code ec;
bool ret = bfs::remove(path(filename), ec);
if (ec) {
ERR_FS << "Could not delete file " << filename << ": " << ec.message() << '\n';
}
return ret;
}
std::string read_file(const std::string &fname)
{
scoped_istream is = istream_file(fname);
std::stringstream ss;
ss << is->rdbuf();
return ss.str();
}
filesystem::scoped_istream istream_file(const std::string &fname, bool treat_failure_as_error)
{
LOG_FS << "Streaming " << fname << " for reading.\n";
if (fname.empty()) {
ERR_FS << "Trying to open file with empty name.\n";
filesystem::scoped_istream s(new bfs::ifstream());
s->clear(std::ios_base::failbit);
return s;
}
//mingw doesn't support std::basic_ifstream::basic_ifstream(const wchar_t* fname)
//that why boost::filesystem::fstream.hpp doesn't work with mingw.
try
{
boost::iostreams::file_descriptor_source fd(bfs::path(fname), std::ios_base::binary);
//TODO: has this still use ?
if (!fd.is_open() && treat_failure_as_error) {
ERR_FS << "Could not open '" << fname << "' for reading.\n";
} else if (!is_filename_case_correct(fname, fd)) {
ERR_FS << "Not opening '" << fname << "' due to case mismatch.\n";
filesystem::scoped_istream s(new bfs::ifstream());
s->clear(std::ios_base::failbit);
return s;
}
return filesystem::scoped_istream(new boost::iostreams::stream<boost::iostreams::file_descriptor_source>(fd, 4096, 0));
}
catch(const std::exception&)
{
if(treat_failure_as_error)
{
ERR_FS << "Could not open '" << fname << "' for reading.\n";
}
filesystem::scoped_istream s(new bfs::ifstream());
s->clear(std::ios_base::failbit);
return s;
}
}
filesystem::scoped_ostream ostream_file(const std::string& fname, bool create_directory)
{
LOG_FS << "streaming " << fname << " for writing.\n";
#if 1
try
{
boost::iostreams::file_descriptor_sink fd(bfs::path(fname), std::ios_base::binary);
return filesystem::scoped_ostream(new boost::iostreams::stream<boost::iostreams::file_descriptor_sink>(fd, 4096, 0));
}
catch(BOOST_IOSTREAMS_FAILURE& e)
{
// If this operation failed because the parent directory didn't exist, create the parent directory and retry.
error_code ec_unused;
if(create_directory && bfs::create_directories(bfs::path(fname).parent_path(), ec_unused))
{
return ostream_file(fname, false);
}
throw filesystem::io_exception(e.what());
}
#else
return new bfs::ofstream(path(fname), std::ios_base::binary);
#endif
}
// Throws io_exception if an error occurs
void write_file(const std::string& fname, const std::string& data)
{
scoped_ostream os = ostream_file(fname);
os->exceptions(std::ios_base::goodbit);
const std::size_t block_size = 4096;
char buf[block_size];
for(std::size_t i = 0; i < data.size(); i += block_size) {
const std::size_t bytes = std::min<std::size_t>(block_size,data.size() - i);
std::copy(data.begin() + i, data.begin() + i + bytes,buf);
os->write(buf, bytes);
if (os->bad())
throw io_exception("Error writing to file: '" + fname + "'");
}
}
bool create_directory_if_missing(const std::string& dirname)
{
return create_directory_if_missing(path(dirname));
}
bool create_directory_if_missing_recursive(const std::string& dirname)
{
return create_directory_if_missing_recursive(path(dirname));
}
bool is_directory(const std::string& fname)
{
return is_directory_internal(path(fname));
}
bool file_exists(const std::string& name)
{
return file_exists(path(name));
}
time_t file_modified_time(const std::string& fname)
{
error_code ec;
std::time_t mtime = bfs::last_write_time(path(fname), ec);
if (ec) {
LOG_FS << "Failed to read modification time of " << fname << ": " << ec.message() << '\n';
}
return mtime;
}
bool is_gzip_file(const std::string& filename)
{
return path(filename).extension() == ".gz";
}
bool is_bzip2_file(const std::string& filename)
{
return path(filename).extension() == ".bz2";
}
int file_size(const std::string& fname)
{
error_code ec;
uintmax_t size = bfs::file_size(path(fname), ec);
if (ec) {
LOG_FS << "Failed to read filesize of " << fname << ": " << ec.message() << '\n';
return -1;
} else if (size > INT_MAX)
return INT_MAX;
else
return size;
}
int dir_size(const std::string& pname)
{
bfs::path p(pname);
uintmax_t size_sum = 0;
error_code ec;
for ( bfs::recursive_directory_iterator i(p), end; i != end && !ec; ++i ) {
if(bfs::is_regular_file(i->path())) {
size_sum += bfs::file_size(i->path(), ec);
}
}
if (ec) {
LOG_FS << "Failed to read directorysize of " << pname << ": " << ec.message() << '\n';
return -1;
}
else if (size_sum > INT_MAX)
return INT_MAX;
else
return size_sum;
}
std::string base_name(const std::string& file, const bool remove_extension)
{
if(!remove_extension) {
return path(file).filename().string();
} else {
return path(file).stem().string();
}
}
std::string directory_name(const std::string& file)
{
return path(file).parent_path().string();
}
std::string nearest_extant_parent(const std::string& file)
{
if(file.empty()) {
return "";
}
bfs::path p{file};
error_code ec;
do {
p = p.parent_path();
bfs::path q = canonical(p, ec);
if (!ec) {
p = q;
}
} while(ec && !is_root(p.string()));
return ec ? "" : p.string();
}
bool is_path_sep(char c)
{
static const path sep = path("/").make_preferred();
const std::string s = std::string(1, c);
return sep == path(s).make_preferred();
}
char path_separator()
{
return path::preferred_separator;
}
bool is_root(const std::string& path)
{
#ifndef _WIN32
error_code ec;
const bfs::path& p = bfs::canonical(path, ec);
return ec ? false : !p.has_parent_path();