mirror of
https://git.tartarus.org/simon/putty.git
synced 2025-07-07 14:25:40 -05:00
Windows: rewrite request_file() to support Unicode.
This centralises into windows/utils/request_file.c all of the code that deals with the OPENFILENAME structure, and decides centrally whether to use the Unicode or ANSI version of that structure and its associated APIs. Now the output of any request_file function is our own 'Filename' abstract type, instead of a raw char or wchar_t buffer, which means that _any_ file dialog can produce a full Unicode filename if the user wants to select one - and yet, in the w32old build, they all uniformly fall back to the ANSI version, which is the only one that works at all pre-NT. A side effect: I've turned the FILTER_FOO_FILES family of definitions from platform-specific #defines into a reasonably sensible enum. This didn't affect the GTK side of things , because I'd never got round to figuring out how to filter a file dialog down to a subset of files in GTK, and still haven't. So I've just moved the existing FIXME comment from platform.h to dialog.c.
This commit is contained in:
Simon Tatham
@ -1,114 +1,376 @@
|
||||
/*
|
||||
* GetOpenFileName/GetSaveFileName tend to muck around with the process'
|
||||
* working directory on at least some versions of Windows.
|
||||
* Here's a wrapper that gives more control over this, and hides a little
|
||||
* bit of other grottiness.
|
||||
*/
|
||||
|
||||
#include "putty.h"
|
||||
|
||||
struct filereq_tag {
|
||||
TCHAR cwd[MAX_PATH];
|
||||
WCHAR wcwd[MAX_PATH];
|
||||
typedef enum SavedDir { SD_NONE, SD_WCHAR, SD_CHAR } SavedDir;
|
||||
|
||||
struct filereq_saved_dir {
|
||||
SavedDir which;
|
||||
union {
|
||||
WCHAR wcwd[MAX_PATH];
|
||||
TCHAR cwd[MAX_PATH];
|
||||
};
|
||||
};
|
||||
|
||||
/*
|
||||
* `of' is expected to be initialised with most interesting fields, but
|
||||
* this function does some administrivia. (assume `of' was memset to 0)
|
||||
* save==1 -> GetSaveFileName; save==0 -> GetOpenFileName
|
||||
* `state' is optional.
|
||||
*/
|
||||
bool request_file(filereq *state, OPENFILENAME *of, bool preserve, bool save)
|
||||
filereq_saved_dir *filereq_saved_dir_new(void)
|
||||
{
|
||||
TCHAR cwd[MAX_PATH]; /* process CWD */
|
||||
bool ret;
|
||||
filereq_saved_dir *state = snew(filereq_saved_dir);
|
||||
state->which = SD_NONE;
|
||||
return state;
|
||||
}
|
||||
|
||||
/* Get process CWD */
|
||||
if (preserve) {
|
||||
DWORD r = GetCurrentDirectory(lenof(cwd), cwd);
|
||||
if (r == 0 || r >= lenof(cwd))
|
||||
/* Didn't work, oh well. Stop trying to be clever. */
|
||||
preserve = false;
|
||||
void filereq_saved_dir_free(filereq_saved_dir *state)
|
||||
{
|
||||
sfree(state);
|
||||
}
|
||||
|
||||
static void save_dir(filereq_saved_dir *state)
|
||||
{
|
||||
DWORD dirlen;
|
||||
|
||||
dirlen = GetCurrentDirectoryW(lenof(state->wcwd), state->wcwd);
|
||||
if (dirlen > 0 && dirlen < lenof(state->wcwd)) {
|
||||
state->which = SD_WCHAR;
|
||||
return;
|
||||
}
|
||||
|
||||
/* Open the file requester, maybe setting lpstrInitialDir */
|
||||
{
|
||||
dirlen = GetCurrentDirectoryA(lenof(state->cwd), state->cwd);
|
||||
if (dirlen > 0 && dirlen < lenof(state->cwd)) {
|
||||
state->which = SD_CHAR;
|
||||
return;
|
||||
}
|
||||
|
||||
state->which = SD_NONE;
|
||||
}
|
||||
|
||||
static void restore_dir(filereq_saved_dir *state)
|
||||
{
|
||||
switch (state->which) {
|
||||
case SD_WCHAR:
|
||||
SetCurrentDirectoryW(state->wcwd);
|
||||
break;
|
||||
case SD_CHAR:
|
||||
SetCurrentDirectoryA(state->cwd);
|
||||
break;
|
||||
case SD_NONE:
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Internal function that brings up an ANSI-coded file dialog,
|
||||
* returning a raw char * buffer containing the output.
|
||||
*
|
||||
* Inputs:
|
||||
* - hwnd: the parent window for the dialog, or NULL if none
|
||||
* - title: the window title
|
||||
* - initial: a filename to populate the new dialog with, or NULL
|
||||
* - dir: a location in which to persist the logical cwd used by
|
||||
* successive file dialogs
|
||||
* - save: true if the file dialog is for write rather than loading a file
|
||||
* - filter: the default type of file being asked about, which will inform
|
||||
* the choice of which files to display in the dialog, and also a default
|
||||
* file extension for saving files
|
||||
* - multi_filename_offset: NULL if you want to return exactly one file.
|
||||
* Otherwise points to a size_t which gets nFileOffset from the result
|
||||
* structure. This is passed to the request_multi_file_populate_* helpers
|
||||
* below.
|
||||
* - filename: buffer to put the output in
|
||||
* - filename_size: size of the buffer.
|
||||
*/
|
||||
static bool do_filereq_a(
|
||||
HWND hwnd, const char *title, Filename *initial, filereq_saved_dir *dir,
|
||||
bool save, FilereqFilter filter, size_t *multi_filename_offset,
|
||||
char *filename, size_t filename_size)
|
||||
{
|
||||
OPENFILENAMEA of;
|
||||
|
||||
memset(&of, 0, sizeof(of));
|
||||
#ifdef OPENFILENAME_SIZE_VERSION_400
|
||||
of->lStructSize = OPENFILENAME_SIZE_VERSION_400;
|
||||
of.lStructSize = OPENFILENAME_SIZE_VERSION_400;
|
||||
#else
|
||||
of->lStructSize = sizeof(*of);
|
||||
of.lStructSize = sizeof(of);
|
||||
#endif
|
||||
of->lpstrInitialDir = (state && state->cwd[0]) ? state->cwd : NULL;
|
||||
/* Actually put up the requester. */
|
||||
ret = save ? GetSaveFileName(of) : GetOpenFileName(of);
|
||||
|
||||
if (dir && dir->which == SD_CHAR)
|
||||
of.lpstrInitialDir = dir->cwd;
|
||||
|
||||
switch (filter) {
|
||||
default: /* FILTER_ALL_FILES */
|
||||
of.lpstrFilter = "All Files (*.*)\0*\0\0\0";
|
||||
break;
|
||||
case FILTER_KEY_FILES:
|
||||
of.lpstrFilter = "PuTTY Private Key Files (*.ppk)\0*.ppk\0"
|
||||
"All Files (*.*)\0*\0\0\0";
|
||||
of.lpstrDefExt = ".ppk";
|
||||
break;
|
||||
case FILTER_DYNLIB_FILES:
|
||||
of.lpstrFilter = "Dynamic Library Files (*.dll)\0*.dll\0"
|
||||
"All Files (*.*)\0*\0\0\0";
|
||||
of.lpstrDefExt = ".dll";
|
||||
break;
|
||||
case FILTER_SOUND_FILES:
|
||||
of.lpstrFilter = "Wave Files (*.wav)\0*.WAV\0"
|
||||
"All Files (*.*)\0*\0\0\0";
|
||||
of.lpstrDefExt = ".wav";
|
||||
break;
|
||||
}
|
||||
of.nFilterIndex = 1;
|
||||
|
||||
/* Get CWD left by requester */
|
||||
if (state) {
|
||||
DWORD r = GetCurrentDirectory(lenof(state->cwd), state->cwd);
|
||||
if (r == 0 || r >= lenof(state->cwd))
|
||||
/* Didn't work, oh well. */
|
||||
state->cwd[0] = '\0';
|
||||
of.hwndOwner = hwnd;
|
||||
|
||||
if (initial) {
|
||||
strncpy(filename, filename_to_str(initial), filename_size - 1);
|
||||
filename[filename_size - 1] = '\0';
|
||||
} else {
|
||||
*filename = '\0';
|
||||
}
|
||||
of.lpstrFile = filename;
|
||||
of.nMaxFile = filename_size;
|
||||
|
||||
/* Restore process CWD */
|
||||
if (preserve)
|
||||
/* If it fails, there's not much we can do. */
|
||||
(void) SetCurrentDirectory(cwd);
|
||||
of.lpstrTitle = title;
|
||||
|
||||
return ret;
|
||||
if (multi_filename_offset)
|
||||
of.Flags |= OFN_ALLOWMULTISELECT | OFN_EXPLORER;
|
||||
|
||||
bool toret = save ? GetSaveFileNameA(&of) : GetOpenFileNameA(&of);
|
||||
|
||||
if (dir)
|
||||
save_dir(dir);
|
||||
|
||||
if (multi_filename_offset)
|
||||
*multi_filename_offset = of.nFileOffset;
|
||||
|
||||
return toret;
|
||||
}
|
||||
|
||||
/*
|
||||
* Here's the same one again, the wide-string version
|
||||
*/
|
||||
bool request_file_w(filereq *state, OPENFILENAMEW *of,
|
||||
bool preserve, bool save)
|
||||
static bool do_filereq_w(
|
||||
HWND hwnd, const char *title, Filename *initial, filereq_saved_dir *dir,
|
||||
bool save, FilereqFilter filter, size_t *multi_filename_offset,
|
||||
wchar_t *filename, size_t filename_size)
|
||||
{
|
||||
WCHAR cwd[MAX_PATH]; /* process CWD */
|
||||
bool ret;
|
||||
OPENFILENAMEW of;
|
||||
void *tofree1 = NULL, *tofree2 = NULL;
|
||||
|
||||
/* Get process CWD */
|
||||
if (preserve) {
|
||||
DWORD r = GetCurrentDirectoryW(lenof(cwd), cwd);
|
||||
if (r == 0 || r >= lenof(cwd))
|
||||
/* Didn't work, oh well. Stop trying to be clever. */
|
||||
preserve = false;
|
||||
memset(&of, 0, sizeof(of));
|
||||
of.lStructSize = sizeof(of);
|
||||
|
||||
if (dir && dir->which == SD_WCHAR)
|
||||
of.lpstrInitialDir = dir->wcwd;
|
||||
else if (dir && dir->which == SD_CHAR) {
|
||||
wchar_t *winitdir = dup_mb_to_wc(CP_ACP, dir->cwd);
|
||||
tofree1 = winitdir;
|
||||
of.lpstrInitialDir = winitdir;
|
||||
}
|
||||
|
||||
/* Open the file requester, maybe setting lpstrInitialDir */
|
||||
{
|
||||
of->lStructSize = sizeof(*of);
|
||||
of->lpstrInitialDir = (state && state->wcwd[0]) ? state->wcwd : NULL;
|
||||
/* Actually put up the requester. */
|
||||
ret = save ? GetSaveFileNameW(of) : GetOpenFileNameW(of);
|
||||
switch (filter) {
|
||||
default: /* FILTER_ALL_FILES */
|
||||
of.lpstrFilter = L"All Files (*.*)\0*\0\0\0";
|
||||
break;
|
||||
case FILTER_KEY_FILES:
|
||||
of.lpstrFilter = L"PuTTY Private Key Files (*.ppk)\0*.ppk\0"
|
||||
"All Files (*.*)\0*\0\0\0";
|
||||
of.lpstrDefExt = L".ppk";
|
||||
break;
|
||||
case FILTER_DYNLIB_FILES:
|
||||
of.lpstrFilter = L"Dynamic Library Files (*.dll)\0*.dll\0"
|
||||
"All Files (*.*)\0*\0\0\0";
|
||||
of.lpstrDefExt = L".dll";
|
||||
break;
|
||||
case FILTER_SOUND_FILES:
|
||||
of.lpstrFilter = L"Wave Files (*.wav)\0*.WAV\0"
|
||||
"All Files (*.*)\0*\0\0\0";
|
||||
of.lpstrDefExt = L".wav";
|
||||
break;
|
||||
}
|
||||
of.nFilterIndex = 1;
|
||||
|
||||
of.hwndOwner = hwnd;
|
||||
|
||||
if (initial) {
|
||||
wcsncpy(filename, filename_to_wstr(initial), filename_size - 1);
|
||||
filename[filename_size - 1] = L'\0';
|
||||
} else {
|
||||
*filename = L'\0';
|
||||
}
|
||||
of.lpstrFile = filename;
|
||||
of.nMaxFile = filename_size;
|
||||
|
||||
if (title) {
|
||||
wchar_t *wtitle = dup_mb_to_wc(CP_ACP, title);
|
||||
tofree2 = wtitle;
|
||||
of.lpstrTitle = wtitle;
|
||||
}
|
||||
|
||||
/* Get CWD left by requester */
|
||||
if (state) {
|
||||
DWORD r = GetCurrentDirectoryW(lenof(state->wcwd), state->wcwd);
|
||||
if (r == 0 || r >= lenof(state->wcwd))
|
||||
/* Didn't work, oh well. */
|
||||
state->wcwd[0] = L'\0';
|
||||
if (multi_filename_offset)
|
||||
of.Flags |= OFN_ALLOWMULTISELECT | OFN_EXPLORER;
|
||||
|
||||
bool toret = save ? GetSaveFileNameW(&of) : GetOpenFileNameW(&of);
|
||||
|
||||
if (dir)
|
||||
save_dir(dir);
|
||||
|
||||
sfree(tofree1);
|
||||
sfree(tofree2);
|
||||
|
||||
if (multi_filename_offset)
|
||||
*multi_filename_offset = of.nFileOffset;
|
||||
|
||||
return toret;
|
||||
}
|
||||
|
||||
Filename *request_file(
|
||||
HWND hwnd, const char *title, Filename *initial, bool save,
|
||||
filereq_saved_dir *dir, bool preserve_cwd, FilereqFilter filter)
|
||||
{
|
||||
filereq_saved_dir saved_cwd[1];
|
||||
Filename *filename = NULL;
|
||||
|
||||
if (preserve_cwd)
|
||||
save_dir(saved_cwd);
|
||||
|
||||
init_winver();
|
||||
if (osPlatformId != VER_PLATFORM_WIN32_NT) {
|
||||
char namebuf[MAX_PATH];
|
||||
if (do_filereq_a(
|
||||
hwnd, title, initial, dir, save, filter,
|
||||
NULL, namebuf, sizeof(namebuf)))
|
||||
filename = filename_from_str(namebuf);
|
||||
} else {
|
||||
wchar_t namebuf[MAX_PATH];
|
||||
if (do_filereq_w(
|
||||
hwnd, title, initial, dir, save, filter,
|
||||
NULL, namebuf, sizeof(namebuf)))
|
||||
filename = filename_from_wstr(namebuf);
|
||||
}
|
||||
|
||||
/* Restore process CWD */
|
||||
if (preserve)
|
||||
/* If it fails, there's not much we can do. */
|
||||
(void) SetCurrentDirectoryW(cwd);
|
||||
if (preserve_cwd)
|
||||
restore_dir(saved_cwd);
|
||||
|
||||
return ret;
|
||||
return filename;
|
||||
}
|
||||
|
||||
filereq *filereq_new(void)
|
||||
static struct request_multi_file_return *request_multi_file_populate_a(
|
||||
const char *buf, size_t first_filename_offset)
|
||||
{
|
||||
filereq *state = snew(filereq);
|
||||
state->cwd[0] = '\0';
|
||||
state->wcwd[0] = L'\0';
|
||||
return state;
|
||||
struct request_multi_file_return *rmf =
|
||||
snew(struct request_multi_file_return);
|
||||
|
||||
/*
|
||||
* We expect one of two situations (guaranteed by the return from
|
||||
* the OFN_MULTISELECT file dialog API function):
|
||||
*
|
||||
* 1. There is a single NUL-terminated filename string in buf,
|
||||
* potentially including a path, and first_filename_offset points
|
||||
* to the leaf name part of it.
|
||||
*
|
||||
* 2. There are multiple NUL-terminated strings in buf, with the
|
||||
* first being a path, and the remaining ones being leaf names to
|
||||
* concatenate to that path. An empty string / extra NUL
|
||||
* terminates the whole list. first_filename_offset points to the
|
||||
* start of the first leaf name.
|
||||
*
|
||||
* Hence, we can tell these apart by finding out whether a NUL
|
||||
* appears in the buffer before first_filename_offset. If no,
|
||||
* we're in case 1; if yes, case 2.
|
||||
*/
|
||||
if (strlen(buf) > first_filename_offset) {
|
||||
/* Case 1: a single filename. */
|
||||
rmf->nfilenames = 1;
|
||||
rmf->filenames = snewn(1, Filename *);
|
||||
rmf->filenames[0] = filename_from_str(buf);
|
||||
} else {
|
||||
/* Case 2: multiple filenames preceded by a path. */
|
||||
size_t filenamesize = 16;
|
||||
rmf->nfilenames = 0;
|
||||
rmf->filenames = snewn(filenamesize, Filename *);
|
||||
|
||||
const char *dir = buf;
|
||||
const char *sep =
|
||||
(*dir && dir[strlen(dir)-1] == '\\') ? "" : "\\";
|
||||
const char *p = buf + strlen(dir) + 1;
|
||||
for (; *p; p += strlen(p) + 1) {
|
||||
char *filename = dupcat(dir, sep, p);
|
||||
sgrowarray(rmf->filenames, filenamesize, rmf->nfilenames);
|
||||
rmf->filenames[rmf->nfilenames++] = filename_from_str(filename);
|
||||
sfree(filename);
|
||||
}
|
||||
}
|
||||
return rmf;
|
||||
}
|
||||
|
||||
void filereq_free(filereq *state)
|
||||
/*
|
||||
* Here's the same one again, the wide-string version
|
||||
*/
|
||||
static struct request_multi_file_return *request_multi_file_populate_w(
|
||||
const wchar_t *buf, size_t first_filename_offset)
|
||||
{
|
||||
sfree(state);
|
||||
struct request_multi_file_return *rmf =
|
||||
snew(struct request_multi_file_return);
|
||||
if (wcslen(buf) > first_filename_offset) {
|
||||
rmf->nfilenames = 1;
|
||||
rmf->filenames = snewn(1, Filename *);
|
||||
rmf->filenames[0] = filename_from_wstr(buf);
|
||||
} else {
|
||||
size_t filenamesize = 16;
|
||||
rmf->nfilenames = 0;
|
||||
rmf->filenames = snewn(filenamesize, Filename *);
|
||||
|
||||
const wchar_t *dir = buf;
|
||||
const wchar_t *sep =
|
||||
(*dir && dir[wcslen(dir)-1] == L'\\') ? L"" : L"\\";
|
||||
const wchar_t *p = buf + wcslen(dir) + 1;
|
||||
for (; *p; p += wcslen(p) + 1) {
|
||||
wchar_t *filename = dupwcscat(dir, sep, p);
|
||||
sgrowarray(rmf->filenames, filenamesize, rmf->nfilenames);
|
||||
rmf->filenames[rmf->nfilenames++] = filename_from_wstr(filename);
|
||||
sfree(filename);
|
||||
}
|
||||
}
|
||||
return rmf;
|
||||
}
|
||||
|
||||
#define MULTI_FACTOR 32
|
||||
|
||||
struct request_multi_file_return *request_multi_file(
|
||||
HWND hwnd, const char *title, Filename *initial, bool save,
|
||||
filereq_saved_dir *dir, bool preserve_cwd, FilereqFilter filter)
|
||||
{
|
||||
filereq_saved_dir saved_cwd[1];
|
||||
struct request_multi_file_return *rmf = NULL;
|
||||
size_t first_filename_offset;
|
||||
|
||||
if (preserve_cwd)
|
||||
save_dir(saved_cwd);
|
||||
|
||||
init_winver();
|
||||
if (osPlatformId != VER_PLATFORM_WIN32_NT) {
|
||||
char namebuf[MAX_PATH * MULTI_FACTOR];
|
||||
if (do_filereq_a(
|
||||
hwnd, title, initial, dir, save, filter,
|
||||
&first_filename_offset, namebuf, sizeof(namebuf)))
|
||||
rmf = request_multi_file_populate_a(
|
||||
namebuf, first_filename_offset);
|
||||
} else {
|
||||
wchar_t namebuf[MAX_PATH * MULTI_FACTOR];
|
||||
if (do_filereq_w(
|
||||
hwnd, title, initial, dir, save, filter,
|
||||
&first_filename_offset, namebuf, sizeof(namebuf)))
|
||||
rmf = request_multi_file_populate_w(
|
||||
namebuf, first_filename_offset);
|
||||
}
|
||||
|
||||
if (preserve_cwd)
|
||||
restore_dir(saved_cwd);
|
||||
|
||||
return rmf;
|
||||
}
|
||||
|
||||
void request_multi_file_free(struct request_multi_file_return *rmf)
|
||||
{
|
||||
for (size_t i = 0; i < rmf->nfilenames; i++)
|
||||
filename_free(rmf->filenames[i]);
|
||||
sfree(rmf->filenames);
|
||||
sfree(rmf);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user