Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Windows platform file access to allow file sharing with external programs #51430

Merged
merged 2 commits into from
Aug 10, 2021

Commits on Aug 9, 2021

  1. Fix Windows platform file access

    This restores Windows platform file handling back to open files non-exlusively by default, as was the case before October 2018. (See godotengine@b902a2f)
    Back then, while fixing warnings for MSVC, the function used for opening files was changed from _wfopen() to _wfopen_s() as suggsted by the warning C4996. ("This function may be unsafe, consider using _wfopen_s instead.")
    
    This new function
    1. did parameter validation and thus avoided some possible security issues due to nil pointers or wrongly terminated strings
    2. it also changed the default file sharing for opened files from _SH_DENYNO (which was the implicit default for the previous _wfopen()) to _SH_SECURE.
    
    _SH_DENYNO means every opened file could be opened by other calls (like is the default on other operating systems).
    _SH_SECURE means if the file is opened with READ access, others can still read the same file, but if it is opened with WRITE access, others can't open it at all, not even to read.
    
    This led to rarely occuring bugs on Windows, i.e. due to random access by Antivirus processes, or Godot/Windows not closing a file handle fast enough while trying to open it again elsewhere (i.e. project.godot, instead showing the Project manager, or saving shaders/debugging the game).
    
    What this PR does it change the file access to a third method, _wfsopen(). This is still secure, doing parameter validation and thus avoids the warning, but it allows us to actually SET the file sharing parameter. And we set it to _SH_DENYNO, as it was implicitely before the change. (And as it currently is on all non-Windows platforms, where file sharing restrictions don't exist by default.)
    
    Warning C4996 should really have been pointing this out. It should've been _wfsopen() all along. Let's hope this banishes those annoying, rare errors for all eternity.
    
    Fixes godotengine#28036.
    mhilbrunner committed Aug 9, 2021
    Configuration menu
    Copy the full SHA
    b48cbb5 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    a5c179e View commit details
    Browse the repository at this point in the history