Merge pull request #2439 from ivan-mogilko/361--warningslog-location

Engine: hotfix certain platforms to not save "warnings.log" in current working dir

Author: ivan-mogilko

Engine/debug/debug.cpp

@@ -161,23 +161,32 @@ void SDL_Log_Output(void* /*userdata*/, int category, SDL_LogPriority priority,
 // Log configuration
 // ----------------------------------------------------------------------------
 
-PDebugOutput create_log_output(const String &name, const String &path = "", LogFile::OpenMode open_mode = LogFile::kLogFile_Overwrite)
+// Create a new log output by ID
+PDebugOutput create_log_output(const String &name, const String &dir = "", const String &filename = "",
+    LogFile::OpenMode open_mode = LogFile::kLogFile_Overwrite)
 {
-    // Else create new one, if we know this ID
     if (name.CompareNoCase(OutputSystemID) == 0)
     {
         return DbgMgr.RegisterOutput(OutputSystemID, AGSPlatformDriver::GetDriver(), kDbgMsg_None);
     }
     else if (name.CompareNoCase(OutputFileID) == 0)
     {
         DebugLogFile.reset(new LogFile());
-        String logfile_path = path;
-        if (logfile_path.IsEmpty())
+        String logfile_dir = dir;
+        if (dir.IsEmpty())
         {
             FSLocation fs = platform->GetAppOutputDirectory();
             CreateFSDirs(fs);
-            logfile_path = Path::ConcatPaths(fs.FullDir, "ags.log");
+            logfile_dir = fs.FullDir;
         }
+        else if (Path::IsRelativePath(dir) && platform->IsLocalDirRestricted())
+        {
+            FSLocation fs = GetGameUserDataDir();
+            CreateFSDirs(fs);
+            logfile_dir = fs.FullDir;
+        }
+        String logfilename = filename.IsEmpty() ? "ags.log" : filename;
+        String logfile_path = Path::ConcatPaths(logfile_dir, logfilename);
         if (!DebugLogFile->OpenFile(logfile_path, open_mode))
             return nullptr;
         Debug::Printf(kDbgMsg_Info, "Logging to %s", logfile_path.GetCStr());
@@ -336,7 +345,7 @@ void apply_debug_config(const ConfigTree &cfg)
     // then open "warnings.log" for printing script warnings.
     if (game.options[OPT_DEBUGMODE] != 0 && !DebugLogFile)
     {
-        auto dbgout = create_log_output(OutputFileID, "warnings.log", LogFile::kLogFile_OverwriteAtFirstMessage);
+        auto dbgout = create_log_output(OutputFileID, "./", "warnings.log", LogFile::kLogFile_OverwriteAtFirstMessage);
         if (dbgout)
         {
             dbgout->SetGroupFilter(kDbgGroup_Game, kDbgMsg_Warn);

Engine/platform/base/agsplatform_xdg_unix.cpp

@@ -84,6 +84,12 @@ FSLocation AGSPlatformXDGUnix::GetAppOutputDirectory()
     return UserDataDirectory;
 }
 
+bool AGSPlatformXDGUnix::IsLocalDirRestricted()
+{
+    // Let them to create temp files in the current working dir
+    return false;
+}
+
 uint64_t AGSPlatformXDGUnix::GetDiskFreeSpaceMB(const String &path) {
     // placeholder
     return 100;

Engine/platform/base/agsplatform_xdg_unix.h

@@ -31,6 +31,7 @@ struct AGSPlatformXDGUnix : AGSPlatformDriver {
     FSLocation GetUserConfigDirectory() override;
     FSLocation GetUserGlobalConfigDirectory() override;
     FSLocation GetAppOutputDirectory() override;
+    bool IsLocalDirRestricted() override;
     uint64_t GetDiskFreeSpaceMB(const AGS::Common::String &path) override;
     const char* GetBackendFailUserHint() override;
 };

Engine/platform/base/agsplatformdriver.h

@@ -95,6 +95,10 @@ class AGSPlatformDriver
     virtual FSLocation GetUserGlobalConfigDirectory()  { return FSLocation("."); }
     // Get default directory for program output (logs)
     virtual FSLocation GetAppOutputDirectory() { return FSLocation("."); }
+    // Tells whether it's not permitted to write to the local directory (cwd, or game dir),
+    // and only specified user/app directories should be used.
+    // FIXME: this is a part of a hotfix, review uses of this function later.
+    virtual bool IsLocalDirRestricted() { return true; }
     // Returns array of characters illegal to use in file names
     virtual const char *GetIllegalFileChars() { return "\\/"; }
     virtual const char *GetDiskWriteAccessTroubleshootingText();

Engine/platform/windows/acplwin.cpp

@@ -62,6 +62,7 @@ struct AGSWin32 : AGSPlatformDriver {
   FSLocation GetUserConfigDirectory() override;
   FSLocation GetUserGlobalConfigDirectory() override;
   FSLocation GetAppOutputDirectory() override;
+  bool IsLocalDirRestricted() override;
   const char *GetIllegalFileChars() override;
   const char *GetGraphicsTroubleshootingText() override;
   uint64_t GetDiskFreeSpaceMB(const String &path) override;
@@ -240,6 +241,12 @@ FSLocation AGSWin32::GetAppOutputDirectory()
   return win32OutputDirectory;
 }
 
+bool AGSWin32::IsLocalDirRestricted()
+{
+  // Let them to create temp files in the current working dir
+  return false;
+}
+
 const char *AGSWin32::GetIllegalFileChars()
 {
     return "\\/:?\"<>|*";