-
-
Notifications
You must be signed in to change notification settings - Fork 531
/
main.cpp
2301 lines (2020 loc) · 67.3 KB
/
main.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
/*
This file is part of Warzone 2100.
Copyright (C) 1999-2004 Eidos Interactive
Copyright (C) 2005-2020 Warzone 2100 Project
Warzone 2100 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.
Warzone 2100 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/** @file
* The main file that launches the game and starts up everything.
*/
// Get platform defines before checking for them!
#include "lib/framework/wzapp.h"
#if defined(WZ_OS_WIN)
# if defined( _MSC_VER )
// Silence warning when using MSVC + the Windows 7 SDK (required for XP compatibility)
// warning C4091: 'typedef ': ignored on left of 'tagGPFIDL_FLAGS' when no variable is declared
#pragma warning( push )
#pragma warning( disable : 4091 )
# endif
# include <shlobj.h> /* For SHGetFolderPath */
# if defined( _MSC_VER )
#pragma warning( pop )
# endif
# include <shellapi.h> /* CommandLineToArgvW */
# include <ntverp.h> // Windows SDK - include for access to VER_PRODUCTBUILD
# if VER_PRODUCTBUILD >= 9200
// 9200 is the Windows SDK 8.0 (which introduced family support)
#include <winapifamily.h> // Windows SDK
# else
// Earlier SDKs don't have the concept of families - provide simple implementation
// that treats everything as "desktop"
#if !defined(WINAPI_PARTITION_DESKTOP)
#define WINAPI_PARTITION_DESKTOP 0x00000001
#endif
#if !defined(WINAPI_FAMILY_PARTITION)
#define WINAPI_FAMILY_PARTITION(Partition) ((WINAPI_PARTITION_DESKTOP & Partition) == Partition)
#endif
# endif
#elif defined(WZ_OS_UNIX)
# include <errno.h>
#endif // WZ_OS_WIN
#include "lib/framework/input.h"
#include "lib/framework/physfs_ext.h"
#include "lib/framework/wzpaths.h"
#include "lib/framework/wztime.h"
#include "lib/exceptionhandler/exceptionhandler.h"
#include "lib/exceptionhandler/dumpinfo.h"
#include "lib/sound/playlist.h"
#include "lib/gamelib/gtime.h"
#include "lib/ivis_opengl/pieblitfunc.h"
#include "lib/ivis_opengl/piestate.h"
#include "lib/ivis_opengl/piepalette.h"
#include "lib/ivis_opengl/piemode.h"
#include "lib/ivis_opengl/screen.h"
#include "lib/netplay/netplay.h"
#include "lib/netplay/netreplay.h"
#include "lib/sound/audio.h"
#include "lib/sound/cdaudio.h"
#include "clparse.h"
#include "challenge.h"
#include "configuration.h"
#include "display.h"
#include "display3d.h"
#include "frontend.h"
#include "game.h"
#include "init.h"
#include "levels.h"
#include "lighting.h"
#include "loadsave.h"
#include "loop.h"
#include "mission.h"
#include "modding.h"
#include "multiplay.h"
#include "notifications.h"
#include "qtscript.h"
#include "research.h"
#include "seqdisp.h"
#include "warzoneconfig.h"
#include "main.h"
#include "wrappers.h"
#include "version.h"
#include "map.h"
#include "keybind.h"
#include "random.h"
#include "urlhelpers.h"
#include "urlrequest.h"
#include <time.h>
#include <LaunchInfo.h>
#include <sodium.h>
#include "updatemanager.h"
#include "activity.h"
#include "stdinreader.h"
#include "gamehistorylogger.h"
#include "campaigninfo.h"
#if defined(ENABLE_DISCORD)
#include "integrations/wzdiscordrpc.h"
#endif
#include "wzcrashhandlingproviders.h"
#include "wzpropertyproviders.h"
#include "3rdparty/gsl_finally.h"
#include "wzapi.h"
#if defined(WZ_OS_UNIX)
# include <signal.h>
# include <time.h>
#endif
#if defined(WZ_OS_MAC)
# include <unistd.h>
# include "lib/framework/mac_wrapper.h"
# include "lib/framework/cocoa_wrapper.h"
#endif // WZ_OS_MAC
/* Always use fallbacks on Windows */
#if defined(WZ_OS_WIN)
# undef WZ_DATADIR
#endif
#if !defined(WZ_DATADIR)
# define WZ_DATADIR "data"
#endif
enum FOCUS_STATE
{
FOCUS_OUT, // Window does not have the focus
FOCUS_IN, // Window has got the focus
};
bool customDebugfile = false; // Default false: user has NOT specified where to store the stdout/err file.
char datadir[PATH_MAX] = ""; // Global that src/clparse.c:ParseCommandLine can write to, so it can override the default datadir on runtime. Needs to be empty on startup for ParseCommandLine to work!
char configdir[PATH_MAX] = ""; // specifies custom USER directory. Same rules apply as datadir above.
char rulesettag[40] = "";
//flag to indicate when initialisation is complete
const char* SAVEGAME_CAM = "savegames/campaign";
const char* SAVEGAME_CAM_AUTO = "savegames/campaign/auto";
const char* SAVEGAME_SKI = "savegames/skirmish";
const char* SAVEGAME_SKI_AUTO = "savegames/skirmish/auto";
const char *SaveGameLocToPath[] = {
SAVEGAME_CAM,
SAVEGAME_CAM_AUTO,
SAVEGAME_SKI,
SAVEGAME_SKI_AUTO,
};
std::string SaveGamePath_t::toPath(SaveGamePath_t::Extension ext)
{
std::string out;
switch (ext)
{
case SaveGamePath_t::Extension::GAM:
out = std::string(SaveGameLocToPath[loc]) + "/" + gameName + ".gam";
break;
case SaveGamePath_t::Extension::JSON:
out = std::string(SaveGameLocToPath[loc]) + "/" + gameName + ".json";
break;
};
return out;
}
bool gameInitialised = false;
char SaveGamePath[PATH_MAX];
char ReplayPath[PATH_MAX];
char ScreenDumpPath[PATH_MAX];
char MultiCustomMapsPath[PATH_MAX];
char MultiPlayersPath[PATH_MAX];
char KeyMapPath[PATH_MAX];
char FavoriteStructuresPath[PATH_MAX];
static uint32_t forcedAutosaveTime = 0;
// Start game in title mode:
static GS_GAMEMODE gameStatus = GS_TITLE_SCREEN;
// Status of the gameloop
static GAMECODE gameLoopStatus = GAMECODE_CONTINUE;
static FOCUS_STATE focusState = FOCUS_IN;
#if defined(WZ_OS_UNIX)
static bool ignoredSIGPIPE = false;
#endif
#if defined(WZ_OS_WIN)
#define WIN_MAX_EXTENDED_PATH 32767
// Gets the full path to the application executable (UTF-16)
static std::wstring getCurrentApplicationPath_WIN()
{
// On Windows, use GetModuleFileNameW to obtain the full path to the current EXE
std::vector<wchar_t> buffer(WIN_MAX_EXTENDED_PATH + 1, 0);
DWORD moduleFileNameLen = GetModuleFileNameW(NULL, &buffer[0], buffer.size() - 1);
DWORD lastError = GetLastError();
if ((moduleFileNameLen == 0) && (lastError != ERROR_SUCCESS))
{
// GetModuleFileName failed
debug(LOG_ERROR, "GetModuleFileName failed: %lu", moduleFileNameLen);
return std::wstring();
}
else if (moduleFileNameLen > (buffer.size() - 1))
{
debug(LOG_ERROR, "GetModuleFileName returned a length: %lu >= buffer length: %zu", moduleFileNameLen, buffer.size());
return std::wstring();
}
// Because Windows XP's GetModuleFileName does not guarantee null-termination,
// always append a null-terminator
buffer[moduleFileNameLen] = 0;
return std::wstring(buffer.data());
}
// Gets the full path to the folder that contains the application executable (UTF-16)
static std::wstring getCurrentApplicationFolder_WIN()
{
std::wstring applicationExecutablePath = getCurrentApplicationPath_WIN();
if (applicationExecutablePath.empty())
{
return std::wstring();
}
// Find the position of the last slash in the application executable path
size_t lastSlash = applicationExecutablePath.find_last_of(L"\\/", std::wstring::npos);
if (lastSlash == std::wstring::npos)
{
// Did not find a path separator - does not appear to be a valid application executable path?
debug(LOG_ERROR, "Unable to find path separator in application executable path");
return std::wstring();
}
// Trim off the executable name
return applicationExecutablePath.substr(0, lastSlash);
}
#endif
// Gets the full path to the folder that contains the application executable (UTF-8)
static std::string getCurrentApplicationFolder()
{
#if defined(WZ_OS_WIN)
std::wstring applicationFolderPath_utf16 = getCurrentApplicationFolder_WIN();
// Convert the UTF-16 to UTF-8
int outputLength = WideCharToMultiByte(CP_UTF8, 0, applicationFolderPath_utf16.c_str(), -1, NULL, 0, NULL, NULL);
if (outputLength <= 0)
{
debug(LOG_ERROR, "Encoding conversion error.");
return std::string();
}
std::vector<char> u8_buffer(outputLength, 0);
if (WideCharToMultiByte(CP_UTF8, 0, applicationFolderPath_utf16.c_str(), -1, &u8_buffer[0], outputLength, NULL, NULL) == 0)
{
debug(LOG_ERROR, "Encoding conversion error.");
return std::string();
}
return std::string(u8_buffer.data());
#else
// Not yet implemented for this platform
return std::string();
#endif
}
// Gets the full path to the prefix of the folder that contains the application executable (UTF-8)
static std::string getCurrentApplicationFolderPrefix()
{
// Remove the last path component
std::string appPath = getCurrentApplicationFolder();
if (appPath.empty())
{
return appPath;
}
// Remove trailing path separators (slashes)
while (!appPath.empty() && (appPath.back() == '\\' || appPath.back() == '/'))
{
appPath.pop_back();
}
// Find the position of the last slash in the application folder
size_t lastSlash = appPath.find_last_of("\\/", std::string::npos);
if (lastSlash == std::string::npos)
{
// Did not find a path separator - does not appear to be a valid app folder?
debug(LOG_ERROR, "Unable to find path separator in application executable path");
return std::string();
}
// Trim off the last path component
return appPath.substr(0, lastSlash);
}
static bool isPortableMode()
{
static bool _checkedMode = false;
static bool _isPortableMode = false;
if (!_checkedMode)
{
#if defined(WZ_OS_WIN)
// On Windows, check for the presence of a ".portable" file in the same directory as the application EXE
std::wstring portableFilePath = getCurrentApplicationFolder_WIN();
portableFilePath += L"\\.portable";
if (GetFileAttributesW(portableFilePath.c_str()) != INVALID_FILE_ATTRIBUTES)
{
// A .portable file exists in the application directory
debug(LOG_WARNING, ".portable file detected - enabling portable mode");
_isPortableMode = true;
}
#else
// Not yet implemented for this platform.
#endif
_checkedMode = true;
}
return _isPortableMode;
}
/*!
* Retrieves the current working directory and copies it into the provided output buffer
* \param[out] dest the output buffer to put the current working directory in
* \param size the size (in bytes) of \c dest
* \return true on success, false if an error occurred (and dest doesn't contain a valid directory)
*/
#if !defined(WZ_PHYSFS_2_1_OR_GREATER)
static bool getCurrentDir(char *const dest, size_t const size)
{
#if defined(WZ_OS_UNIX)
if (getcwd(dest, size) == nullptr)
{
if (errno == ERANGE)
{
debug(LOG_ERROR, "The buffer to contain our current directory is too small (%u bytes and more needed)", (unsigned int)size);
}
else
{
debug(LOG_ERROR, "getcwd failed: %s", strerror(errno));
}
return false;
}
#elif defined(WZ_OS_WIN)
wchar_t tmpWStr[PATH_MAX];
const int len = GetCurrentDirectoryW(PATH_MAX, tmpWStr);
if (len == 0)
{
// Retrieve Windows' error number
const DWORD err = GetLastError();
char *err_string = NULL;
// Retrieve a string describing the error number (uses LocalAlloc() to allocate memory for err_string)
FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM, NULL, err, 0, (char *)&err_string, 0, NULL);
// Print an error message with the above description
debug(LOG_ERROR, "GetCurrentDirectory failed (error code: %lu): %s", err, err_string);
// Free our chunk of memory FormatMessageA gave us
LocalFree(err_string);
return false;
}
else if (len > size)
{
debug(LOG_ERROR, "The buffer to contain our current directory is too small (%u bytes and %d needed)", (unsigned int)size, len);
return false;
}
if (WideCharToMultiByte(CP_UTF8, 0, tmpWStr, -1, dest, size, NULL, NULL) == 0)
{
dest[0] = '\0';
debug(LOG_ERROR, "Encoding conversion error.");
return false;
}
#else
# error "Provide an implementation here to copy the current working directory in 'dest', which is 'size' bytes large."
#endif
// If we got here everything went well
return true;
}
#endif
#if defined(WZ_OS_WIN)
#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) || !defined(WZ_PHYSFS_2_1_OR_GREATER)
static bool win_wcharConvToUtf8(wchar_t *pwStr, std::string &outputUtf8)
{
std::vector<char> utf8Buffer;
int utf8Len = WideCharToMultiByte(CP_UTF8, 0, pwStr, -1, NULL, 0, NULL, NULL);
if ( utf8Len <= 0 )
{
// Encoding conversion error
return false;
}
utf8Buffer.resize(utf8Len, 0);
if ( (utf8Len = WideCharToMultiByte(CP_UTF8, 0, pwStr, -1, &utf8Buffer[0], utf8Len, NULL, NULL)) <= 0 )
{
// Encoding conversion error
return false;
}
outputUtf8 = std::string(utf8Buffer.data(), utf8Len - 1);
return true;
}
#endif
#endif
// Fallback method for earlier PhysFS verions that do not support PHYSFS_getPrefDir
// Importantly, this creates the folders if they do not exist
#if !defined(WZ_PHYSFS_2_1_OR_GREATER)
static std::string getPlatformPrefDir_Fallback(const char *org, const char *app)
{
WzString basePath;
WzString appendPath;
char tmpstr[PATH_MAX] = { '\0' };
const size_t size = sizeof(tmpstr);
#if defined(WZ_OS_WIN)
wchar_t tmpWStr[MAX_PATH];
if (SUCCEEDED(SHGetFolderPathW(NULL, CSIDL_APPDATA | CSIDL_FLAG_CREATE, NULL, SHGFP_TYPE_CURRENT, tmpWStr)))
{
std::string utf8Path;
if (!win_wcharConvToUtf8(tmpWStr, utf8Path))
{
debug(LOG_FATAL, "Config directory encoding conversion error.");
exit(1);
}
basePath = WzString::fromUtf8(utf8Path);
appendPath = WzString();
// Must append org\app to APPDATA path
appendPath += org;
appendPath += PHYSFS_getDirSeparator();
appendPath += app;
}
else
#elif defined(WZ_OS_MAC)
if (cocoaGetApplicationSupportDir(tmpstr, size))
{
basePath = WzString::fromUtf8(tmpstr);
appendPath = WzString::fromUtf8(app);
}
else
#elif defined(WZ_OS_UNIX)
// Following PhysFS, use XDG's base directory spec, even if not on Linux.
// Reference: https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
const char *envPath = getenv("XDG_DATA_HOME");
if (envPath == nullptr)
{
// XDG_DATA_HOME isn't defined
// Use HOME, and append ".local/share/" to match XDG's base directory spec
envPath = getenv("HOME");
if (envPath == nullptr)
{
// On PhysFS < 2.1, fall-back to using PHYSFS_getUserDir() if HOME isn't defined
debug(LOG_INFO, "HOME environment variable isn't defined - falling back to PHYSFS_getUserDir()");
envPath = PHYSFS_getUserDir();
}
appendPath = WzString(".local") + PHYSFS_getDirSeparator() + "share";
}
if (envPath != nullptr)
{
basePath = WzString::fromUtf8(envPath);
if (!appendPath.isEmpty())
{
appendPath += PHYSFS_getDirSeparator();
}
appendPath += app;
}
else
#else
// On PhysFS < 2.1, fall-back to using PHYSFS_getUserDir() for other OSes
if (PHYSFS_getUserDir())
{
basePath = WzString::fromUtf8(PHYSFS_getUserDir());
appendPath = WzString::fromUtf8(app);
}
else
#endif
if (getCurrentDir(tmpstr, size))
{
basePath = WzString::fromUtf8(tmpstr);
appendPath = WzString::fromUtf8(app);
}
else
{
debug(LOG_FATAL, "Can't get home / prefs directory?");
abort();
}
// Create the folders within the basePath if they don't exist
if (!WZ_PHYSFS_createPlatformPrefDir(basePath, appendPath))
{
debug(LOG_FATAL, "Failed to create platform config dir: %s/%s",
basePath.toUtf8().c_str(), appendPath.toUtf8().c_str());
exit(1);
}
return (basePath + PHYSFS_getDirSeparator() + appendPath + PHYSFS_getDirSeparator()).toUtf8();
}
#endif
// Retrieves the appropriate storage directory for application-created files / prefs
// (Ensures the directory exists. Creates folders if necessary.)
static std::string getPlatformPrefDir(const char * org, const std::string &app)
{
if (isPortableMode())
{
// When isPortableMode is true, the config dir should be stored in the same prefix as the app's bindir.
// i.e. If the app executable path is: <prefix>/bin/warzone2100.exe
// the config directory should be: <prefix>/<app>/
std::string prefixPath = getCurrentApplicationFolderPrefix();
if (prefixPath.empty())
{
// Failed to get the current application folder
debug(LOG_FATAL, "Error getting the current application folder prefix - unable to proceed with portable mode");
exit(1);
}
std::string appendPath = app;
// Create the folders within the prefixPath if they don't exist
if (!PHYSFS_setWriteDir(prefixPath.c_str())) // Workaround for PhysFS not creating the writedir as expected.
{
debug(LOG_FATAL, "Error setting write directory to \"%s\": %s",
prefixPath.c_str(), WZ_PHYSFS_getLastError());
exit(1);
}
if (!PHYSFS_mkdir(appendPath.c_str()))
{
debug(LOG_FATAL, "Error creating directory \"%s\" in \"%s\": %s",
appendPath.c_str(), PHYSFS_getWriteDir(), WZ_PHYSFS_getLastError());
exit(1);
}
return prefixPath + PHYSFS_getDirSeparator() + appendPath + PHYSFS_getDirSeparator();
}
#if defined(WZ_OS_WIN)
#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)
BuildPropertyProvider buildPropProvider;
std::string win_package_fullname;
if (buildPropProvider.getPropertyValue("WIN_PACKAGE_FULLNAME", win_package_fullname) && !win_package_fullname.empty())
{
// Running as a packaged Windows desktop app - to behave nicely, we should always use the redirected app data folder location
// (so it can be cleanly uninstalled)
# if !defined(KF_FLAG_FORCE_APP_DATA_REDIRECTION)
# define KF_FLAG_FORCE_APP_DATA_REDIRECTION 0x00080000
# endif
wchar_t* appData = nullptr;
HRESULT result = SHGetKnownFolderPath(FOLDERID_LocalAppData, KF_FLAG_CREATE | KF_FLAG_FORCE_APP_DATA_REDIRECTION, NULL, &appData);
if (result == S_OK)
{
std::string utf8Path;
win_wcharConvToUtf8(appData, utf8Path);
CoTaskMemFree(appData);
appData = nullptr;
WzString basePath = WzString::fromUtf8(utf8Path);
WzString appendPath = WzString();
// Must append org\app to APPDATA path
appendPath += org;
appendPath += PHYSFS_getDirSeparator();
appendPath += WzString::fromUtf8(app);
// Create the folders within the basePath if they don't exist
if (!WZ_PHYSFS_createPlatformPrefDir(basePath, appendPath))
{
debug(LOG_FATAL, "Failed to create platform config dir: %s/%s",
basePath.toUtf8().c_str(), appendPath.toUtf8().c_str());
abort();
}
return (basePath + PHYSFS_getDirSeparator() + appendPath + PHYSFS_getDirSeparator()).toUtf8();
}
else
{
// log the failure
debug(LOG_INFO, "Unable to obtain the new AppModel paths - defaulting to the old method");
CoTaskMemFree(appData);
appData = nullptr;
// proceed to the default method
}
}
#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)
#endif // defined(WZ_OS_WIN)
#if defined(WZ_PHYSFS_2_1_OR_GREATER)
const char * prefsDir = PHYSFS_getPrefDir(org, app.c_str());
if (prefsDir == nullptr)
{
debug(LOG_FATAL, "Failed to obtain prefs directory: %s", WZ_PHYSFS_getLastError());
exit(1);
}
return std::string(prefsDir) + PHYSFS_getDirSeparator();
#else
// PHYSFS_getPrefDir is not available - use fallback method (which requires OS-specific code)
std::string prefDir = getPlatformPrefDir_Fallback(org, app.c_str());
if (prefDir.empty())
{
debug(LOG_FATAL, "Failed to obtain prefs directory (fallback)");
exit(1);
}
return prefDir;
#endif // defined(WZ_PHYSFS_2_1_OR_GREATER)
}
bool endsWith (std::string const &fullString, std::string const &endString) {
if (fullString.length() >= endString.length()) {
return (0 == fullString.compare (fullString.length() - endString.length(), endString.length(), endString));
} else {
return false;
}
}
static std::string getWzPlatformPrefDir()
{
return getPlatformPrefDir("Warzone 2100 Project", version_getVersionedAppDirFolderName());
}
static void initialize_ConfigDir()
{
std::string configDir;
if (strlen(configdir) == 0)
{
configDir = getWzPlatformPrefDir();
}
else
{
configDir = std::string(configdir);
// Make sure that we have a directory separator at the end of the string
if (!endsWith(configDir, PHYSFS_getDirSeparator()))
{
configDir += PHYSFS_getDirSeparator();
}
debug(LOG_WZ, "Using custom configuration directory: %s", configDir.c_str());
}
if (!PHYSFS_setWriteDir(configDir.c_str())) // Workaround for PhysFS not creating the writedir as expected.
{
debug(LOG_FATAL, "Error setting write directory to \"%s\": %s",
configDir.c_str(), WZ_PHYSFS_getLastError());
exit(1);
}
if (!OverrideRPTDirectory(configDir.c_str()))
{
// since it failed, we just use our default path, and not the user supplied one.
debug(LOG_ERROR, "Error setting exception handler to use directory %s", configDir.c_str());
}
// Config dir first so we always see what we write
PHYSFS_mount(PHYSFS_getWriteDir(), NULL, PHYSFS_PREPEND);
// Do not follow symlinks *inside* search paths / archives
PHYSFS_permitSymbolicLinks(0);
debug(LOG_WZ, "Write dir: %s", PHYSFS_getWriteDir());
debug(LOG_WZ, "Base dir: %s", PHYSFS_getBaseDir());
}
/*!
* Initialize the PhysicsFS library.
*/
static void initialize_PhysicsFS(const char *argv_0)
{
int result = PHYSFS_init(argv_0);
if (!result)
{
debug(LOG_FATAL, "There was a problem trying to init Physfs. Error was %s", WZ_PHYSFS_getLastError());
exit(-1);
}
}
static void check_Physfs()
{
const PHYSFS_ArchiveInfo **i;
PHYSFS_Version compiled;
PHYSFS_Version linked;
PHYSFS_VERSION(&compiled);
PHYSFS_getLinkedVersion(&linked);
debug(LOG_WZ, "Compiled against PhysFS version: %d.%d.%d",
compiled.major, compiled.minor, compiled.patch);
debug(LOG_WZ, "Linked against PhysFS version: %d.%d.%d",
linked.major, linked.minor, linked.patch);
if (linked.major < 2)
{
debug(LOG_FATAL, "At least version 2 of PhysicsFS required!");
exit(-1);
}
if (linked.major == 2 && linked.minor == 0 && linked.patch == 2)
{
debug(LOG_ERROR, "You have PhysicsFS 2.0.2, which is buggy. You may experience random errors/crashes due to spuriously missing files.");
debug(LOG_ERROR, "Please upgrade/downgrade PhysicsFS to a different version, such as 2.0.3 or 2.0.1.");
}
// Disable support for non-zip archive types
std::vector<std::string> archiveExtsToRemove;
for (i = PHYSFS_supportedArchiveTypes(); *i != nullptr; i++)
{
if ((*i)->extension == nullptr)
{
continue;
}
if (strcasecmp("zip", (*i)->extension) != 0)
{
archiveExtsToRemove.push_back((*i)->extension);
}
}
for (const auto& archiveExt : archiveExtsToRemove)
{
if (PHYSFS_deregisterArchiver(archiveExt.c_str()) == 0)
{
debug(LOG_WZ, "[**] Failed to unregister archive: [%s]", archiveExt.c_str());
}
}
// Check for "zip" archive support
bool zipfound = false;
for (i = PHYSFS_supportedArchiveTypes(); *i != nullptr; i++)
{
if ((*i)->extension == nullptr)
{
continue;
}
debug(LOG_WZ, "[**] Supported archive(s): [%s], which is [%s].", (*i)->extension, (*i)->description);
if (strcasecmp("zip", (*i)->extension) == 0)
{
zipfound = true;
}
}
if (!zipfound)
{
debug(LOG_FATAL, "Your Physfs wasn't compiled with zip support. Please recompile Physfs with zip support. Exiting program.");
exit(-1);
}
}
/*!
* \brief Adds default data dirs
*
* Priority:
* Lower loads first. Current:
* --datadir > User's home dir > source tree data > AutoPackage > BaseDir > DEFAULT_DATADIR
*
* Only --datadir and home dir are always examined. Others only if data still not found.
*
* We need ParseCommandLine, before we can add any mods...
*
* \sa rebuildSearchPath
*/
static void scanDataDirs()
{
#if !defined(WZ_OS_MAC)
// Check PREFIX-based paths
std::string tmpstr;
// Find out which PREFIX we are in...
std::string prefix = getWZInstallPrefix();
std::string dirSeparator(PHYSFS_getDirSeparator());
if (!PHYSFS_exists("gamedesc.lev"))
{
// Data in source tree (<prefix>/data/)
tmpstr = prefix + dirSeparator + "data" + dirSeparator;
registerSearchPath(tmpstr, 3);
rebuildSearchPath(mod_multiplay, true);
if (!PHYSFS_exists("gamedesc.lev"))
{
// Guessed fallback default datadir on Unix
std::string wzDataDir = WZ_DATADIR;
if(!wzDataDir.empty())
{
#ifndef WZ_DATADIR_ISABSOLUTE
// Treat WZ_DATADIR as a relative path - append to the install PREFIX
tmpstr = prefix + dirSeparator + wzDataDir;
registerSearchPath(tmpstr, 4);
rebuildSearchPath(mod_multiplay, true);
#else
// Treat WZ_DATADIR as an absolute path, and use directly
registerSearchPath(wzDataDir, 4);
rebuildSearchPath(mod_multiplay, true);
#endif
}
if (!PHYSFS_exists("gamedesc.lev"))
{
// Relocation for AutoPackage (<prefix>/share/warzone2100/)
tmpstr = prefix + dirSeparator + "share" + dirSeparator + "warzone2100" + dirSeparator;
registerSearchPath(tmpstr, 5);
rebuildSearchPath(mod_multiplay, true);
}
}
}
#endif
#ifdef WZ_OS_MAC
if (!PHYSFS_exists("gamedesc.lev"))
{
auto resourceDataPathResult = wzMacAppBundleGetResourceDirectoryPath();
if (resourceDataPathResult.has_value())
{
WzString resourceDataPath(resourceDataPathResult.value());
resourceDataPath += "/data";
registerSearchPath(resourceDataPath.toUtf8(), 3);
rebuildSearchPath(mod_multiplay, true);
}
else
{
debug(LOG_FATAL, "Could not obtain resources directory.");
}
}
#endif
// Commandline supplied datadir
if (strlen(datadir) != 0)
{
registerSearchPath(datadir, 1);
}
// User's home dir
const char *pCurrWriteDir = PHYSFS_getWriteDir();
if (pCurrWriteDir)
{
registerSearchPath(pCurrWriteDir, 2);
}
else
{
debug(LOG_FATAL, "No write dir set?");
}
rebuildSearchPath(mod_multiplay, true);
/** Debugging and sanity checks **/
printSearchPath();
if (PHYSFS_exists("gamedesc.lev"))
{
debug(LOG_WZ, "gamedesc.lev found at %s", WZ_PHYSFS_getRealDir_String("gamedesc.lev").c_str());
}
else
{
debug(LOG_FATAL, "Could not find game data. Aborting.");
exit(1);
}
}
/***************************************************************************
Make a directory in write path and set a variable to point to it.
***************************************************************************/
static void make_dir(char *dest, const char *dirname, const char *subdir)
{
strcpy(dest, dirname);
if (subdir != nullptr)
{
strcat(dest, "/");
strcat(dest, subdir);
}
{
size_t l = strlen(dest);
if (dest[l - 1] != '/')
{
dest[l] = '/';
dest[l + 1] = '\0';
}
}
if (!PHYSFS_mkdir(dest))
{
debug(LOG_FATAL, "Unable to create directory \"%s\" in write dir \"%s\"!",
dest, PHYSFS_getWriteDir());
exit(EXIT_FAILURE);
}
}
/*!
* Preparations before entering the title (mainmenu) loop
* Would start the timer in an event based mainloop
*/
static void startTitleLoop(bool onInitialStartup = false)
{
SetGameMode(GS_TITLE_SCREEN);
if (!onInitialStartup)
{
initLoadingScreen(true);
}
if (!frontendInitialise("wrf/frontend.wrf"))
{
debug(LOG_FATAL, "Shutting down after failure");
exit(EXIT_FAILURE);
}
if (!onInitialStartup)
{
closeLoadingScreen();
}
}
/*!
* Shutdown/cleanup after the title (mainmenu) loop
* Would stop the timer
*/
static void stopTitleLoop()
{
if (!frontendShutdown())
{
debug(LOG_FATAL, "Shutting down after failure");
exit(EXIT_FAILURE);
}
}
static void setCDAudioForCurrentGameMode()
{
auto gameMode = ActivityManager::instance().getCurrentGameMode();
switch (gameMode)
{
case ActivitySink::GameMode::CAMPAIGN:
cdAudio_SetGameMode(MusicGameMode::CAMPAIGN);
break;
case ActivitySink::GameMode::CHALLENGE:
cdAudio_SetGameMode(MusicGameMode::CHALLENGE);
break;
case ActivitySink::GameMode::SKIRMISH:
cdAudio_SetGameMode(MusicGameMode::SKIRMISH);
break;
case ActivitySink::GameMode::MULTIPLAYER:
cdAudio_SetGameMode(MusicGameMode::MULTIPLAYER);
break;
default:
debug(LOG_ERROR, "Unhandled started game mode for cd audio: %u", (unsigned int)gameMode);
break;
}
}
/*!
* Preparations before entering the game loop
* Would start the timer in an event based mainloop
*/
static void startGameLoop()
{
SetGameMode(GS_NORMAL);
initLoadingScreen(true);
ActivityManager::instance().startingGame();
// set up CD audio for game mode
setCDAudioForCurrentGameMode();
// Not sure what aLevelName is, in relation to game.map. But need to use aLevelName here, to be able to start the right map for campaign, and need game.hash, to start the right non-campaign map, if there are multiple identically named maps.
if (!levLoadData(aLevelName, &game.hash, nullptr, GTYPE_SCENARIO_START))
{
debug(LOG_FATAL, "Shutting down after failure");
wzQuit(EXIT_FAILURE);
return;
}
screen_StopBackDrop();
closeLoadingScreen();
// Trap the cursor if cursor snapping is enabled
if (war_GetTrapCursor())
{
wzGrabMouse();
}