Skip to content

[3.7] bpo-37369: Fix path handling when python.exe is used as a symlink #14461

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.

Sign up for GitHub

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

Merged
zooba merged 3 commits into from
Jun 29, 2019
Merged

[3.7] bpo-37369: Fix path handling when python.exe is used as a symlink #14461

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d196885
bpo-37369: Fix path handling when python.exe is used as a symlink
zooba Jun 28, 2019
3f9c8ce
Ensure PYTHONUSERBASE can be overridden
zooba Jun 29, 2019
b9ac7ab
Remove extra tests
zooba Jun 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 62 additions & 44 deletions PC/python_uwp.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,51 +27,70 @@ const wchar_t *PROGNAME = L"python.exe";
#endif
#endif

static void
set_user_base()
static std::wstring
get_user_base()
{
wchar_t envBuffer[2048];
try {
const auto appData = winrt::Windows::Storage::ApplicationData::Current();
if (appData) {
const auto localCache = appData.LocalCacheFolder();
if (localCache) {
auto path = localCache.Path();
if (!path.empty() &&
!wcscpy_s(envBuffer, path.c_str()) &&
!wcscat_s(envBuffer, L"\\local-packages")
) {
_wputenv_s(L"PYTHONUSERBASE", envBuffer);
if (!path.empty()) {
return std::wstring(path) + L"\\local-packages";
}
}
}
} catch (...) {
}
return std::wstring();
}

static winrt::hstring
static std::wstring
get_package_family()
{
try {
const auto package = winrt::Windows::ApplicationModel::Package::Current();
if (package) {
const auto id = package.Id();
return id ? id.FamilyName() : winrt::hstring();
if (id) {
return std::wstring(id.FamilyName());
}
}
}
catch (...) {
}

return winrt::hstring();
return std::wstring();
}

static std::wstring
get_package_home()
{
try {
const auto package = winrt::Windows::ApplicationModel::Package::Current();
if (package) {
const auto path = package.InstalledLocation();
if (path) {
return std::wstring(path.Path());
}
}
}
catch (...) {
}

return std::wstring();
}

static int
set_process_name()
{
std::wstring executable, home;

const auto home = get_package_home();
const auto family = get_package_family();

std::wstring executable;

/* If inside a package, use user's symlink name for executable */
if (!family.empty()) {
PWSTR localAppData;
if (SUCCEEDED(SHGetKnownFolderPath(FOLDERID_LocalAppData, 0,
Expand All @@ -86,44 +105,40 @@ set_process_name()
}
}

home.resize(MAX_PATH);
while (true) {
DWORD len = GetModuleFileNameW(
NULL, home.data(), (DWORD)home.size());
if (len == 0) {
home.clear();
break;
} else if (len == home.size() &&
GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
home.resize(len * 2);
} else {
home.resize(len);
size_t bslash = home.find_last_of(L"/\\");
if (bslash != std::wstring::npos) {
home.erase(bslash);
/* Only use module filename if we don't have a home */
if (home.empty() && executable.empty()) {
executable.resize(MAX_PATH);
while (true) {
DWORD len = GetModuleFileNameW(
NULL, executable.data(), (DWORD)executable.size());
if (len == 0) {
executable.clear();
break;
} else if (len == executable.size() &&
GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
executable.resize(len * 2);
} else {
executable.resize(len);
break;
}
break;
}
}

if (executable.empty() && !home.empty()) {
executable = home + L"\\" + PROGNAME;
}

if (!home.empty()) {
Py_SetPythonHome(home.c_str());
}
if (!executable.empty()) {
const wchar_t *launcherPath = _wgetenv(L"__PYVENV_LAUNCHER__");
if (launcherPath) {

const wchar_t *launcherPath = _wgetenv(L"__PYVENV_LAUNCHER__");
if (launcherPath) {
if (!executable.empty()) {
_wputenv_s(L"__PYVENV_BASE_EXECUTABLE__", executable.c_str());
_Py_SetProgramFullPath(launcherPath);
/* bpo-35873: Clear the environment variable to avoid it being
* inherited by child processes. */
_wputenv_s(L"__PYVENV_LAUNCHER__", L"");
} else {
_Py_SetProgramFullPath(executable.c_str());
}
_Py_SetProgramFullPath(launcherPath);
/* bpo-35873: Clear the environment variable to avoid it being
* inherited by child processes. */
_wputenv_s(L"__PYVENV_LAUNCHER__", L"");
} else if (!executable.empty()) {
_Py_SetProgramFullPath(executable.c_str());
}

return 1;
Expand All @@ -135,9 +150,12 @@ wmain(int argc, wchar_t **argv)
if (!set_process_name()) {
return 121;
}
set_user_base();
const wchar_t *p = _wgetenv(L"PYTHONUSERBASE");
if (!p || !*p) {
_wputenv_s(L"PYTHONUSERBASE", get_user_base().c_str());
}

const wchar_t *p = wcsrchr(argv[0], L'\\');
p = wcsrchr(argv[0], L'\\');
if (!p) {
p = argv[0];
}
Expand Down