Skip to content

Commit

Permalink
Correctly open files with non-ASCII paths on Windows
Browse files Browse the repository at this point in the history
This fixes debauchee#976, fixes debauchee#974, fixes debauchee#444.

On Windows the standard stream open() functions expect bytes encoded in
current system encoding, not UTF8. Since we're dealing with UTF8
throughout the application this results in wrong paths being passed and
failure to open files. As a solution, we convert the paths to UTF16 via
the WCHAR character type and use the special Windows-specific overloads
of open() functions.
  • Loading branch information
p12tic committed Oct 29, 2021
1 parent a94af53 commit 4139fb2
Show file tree
Hide file tree
Showing 7 changed files with 111 additions and 4 deletions.
3 changes: 2 additions & 1 deletion src/lib/barrier/DropHelper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
#include "barrier/DropHelper.h"

#include "base/Log.h"
#include "io/fstream.h"

#include <fstream>

Expand All @@ -35,7 +36,7 @@ DropHelper::writeToDir(const String& destination, DragFileList& fileList, String
dropTarget.append("/");
#endif
dropTarget.append(fileList.at(0).getFilename());
file.open(dropTarget.c_str(), std::ios::out | std::ios::binary);
barrier::open_utf8_path(file, dropTarget, std::ios::out | std::ios::binary);
if (!file.is_open()) {
LOG((CLOG_ERR "drop file failed: can not open %s", dropTarget.c_str()));
}
Expand Down
4 changes: 2 additions & 2 deletions src/lib/base/log_outputters.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#include "base/TMethodJob.h"
#include "arch/Arch.h"
#include "base/String.h"

#include "io/fstream.h"
#include <fstream>

enum EFileLogOutputter {
Expand Down Expand Up @@ -260,7 +260,7 @@ FileLogOutputter::write(ELevel level, const char *message)
bool moveFile = false;

std::ofstream m_handle;
m_handle.open(m_fileName.c_str(), std::fstream::app);
barrier::open_utf8_path(m_handle, m_fileName, std::fstream::app);
if (m_handle.is_open() && m_handle.fail() != true) {
m_handle << message << std::endl;

Expand Down
10 changes: 10 additions & 0 deletions src/lib/common/win32/encoding_utilities.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
*/

#include "encoding_utilities.h"
#include <stringapiset.h>

std::string win_wchar_to_utf8(const WCHAR* utfStr)
{
Expand All @@ -25,3 +26,12 @@ std::string win_wchar_to_utf8(const WCHAR* utfStr)
WideCharToMultiByte(CP_UTF8, 0, utfStr, utfLength, &mbStr[0], mbLength, NULL, NULL);
return mbStr;
}

std::vector<WCHAR> utf8_to_win_char(const std::string& str)
{
int result_len = MultiByteToWideChar(CP_UTF8, 0, str.data(), str.size(), NULL, 0);
std::vector<WCHAR> result;
result.resize(result_len + 1, 0);
MultiByteToWideChar(CP_UTF8, 0, str.data(), str.size(), result.data(), result_len);
return result;
}
3 changes: 3 additions & 0 deletions src/lib/common/win32/encoding_utilities.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,11 @@
#ifndef BARRIER_LIB_COMMON_WIN32_ENCODING_UTILITIES_H
#define BARRIER_LIB_COMMON_WIN32_ENCODING_UTILITIES_H

#include <windows.h>
#include <string>
#include <vector>

std::string win_wchar_to_utf8(const WCHAR* utfStr);
std::vector<WCHAR> utf8_to_win_char(const std::string& str);

#endif
57 changes: 57 additions & 0 deletions src/lib/io/fstream.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/*
barrier -- mouse and keyboard sharing utility
Copyright (C) Barrier contributors
This package is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
found in the file LICENSE that should have accompanied this file.
This package 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/

#include "fstream.h"
#if SYSAPI_WIN32
#include "common/win32/encoding_utilities.h"
#endif
#include <fstream>

namespace barrier {

namespace {

template<class Stream>
void open_utf8_path_impl(Stream& stream, const std::string& path, std::ios_base::openmode mode)
{
#if SYSAPI_WIN32
// on Windows we need to use a private constructor from wchar_t* string.
auto wchar_path = utf8_to_win_char(path);
stream.open(wchar_path.data(), mode);
#else
stream.open(path.c_str(), mode);
#endif
}

} // namespace

void open_utf8_path(std::ifstream& stream, const std::string& path, std::ios_base::openmode mode)
{
open_utf8_path_impl(stream, path, mode);
}

void open_utf8_path(std::ofstream& stream, const std::string& path, std::ios_base::openmode mode)
{
open_utf8_path_impl(stream, path, mode);
}

void open_utf8_path(std::fstream& stream, const std::string& path, std::ios_base::openmode mode)
{
open_utf8_path_impl(stream, path, mode);
}

} // namespace barrier
35 changes: 35 additions & 0 deletions src/lib/io/fstream.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/*
barrier -- mouse and keyboard sharing utility
Copyright (C) Barrier contributors
This package is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
found in the file LICENSE that should have accompanied this file.
This package 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef BARRIER_LIB_IO_FSTREAM_H
#define BARRIER_LIB_IO_FSTREAM_H

#include <iosfwd>
#include <ios>

namespace barrier {

void open_utf8_path(std::ifstream& stream, const std::string& path,
std::ios_base::openmode mode = std::ios_base::in);
void open_utf8_path(std::ofstream& stream, const std::string& path,
std::ios_base::openmode mode = std::ios_base::out);
void open_utf8_path(std::fstream& stream, const std::string& path,
std::ios_base::openmode mode = std::ios_base::in | std::ios_base::out);

} // namespace barrier

#endif
3 changes: 2 additions & 1 deletion src/lib/net/SecureSocket.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
#include "base/Log.h"
#include "base/String.h"
#include "common/DataDirectories.h"
#include "io/fstream.h"

#include <openssl/ssl.h>
#include <openssl/err.h>
Expand Down Expand Up @@ -708,7 +709,7 @@ SecureSocket::verifyCertFingerprint()
// check if this fingerprint exist
std::string fileLine;
std::ifstream file;
file.open(trustedServersFilename.c_str());
barrier::open_utf8_path(file, trustedServersFilename);

if (!file.is_open()) {
LOG((CLOG_NOTE "Unable to open trustedServersFile: %s", trustedServersFilename.c_str() ));
Expand Down

0 comments on commit 4139fb2

Please sign in to comment.