2 * winsftp.c: the Windows-specific parts of PSFTP and PSCP.
10 /* ----------------------------------------------------------------------
11 * Interface to GUI driver program.
14 /* This is just a base value from which the main message numbers are
16 #define WM_APP_BASE 0x8000
18 /* These two pass a single character value in wParam. They represent
19 * the visible output from PSCP. */
20 #define WM_STD_OUT_CHAR ( WM_APP_BASE+400 )
21 #define WM_STD_ERR_CHAR ( WM_APP_BASE+401 )
23 /* These pass a transfer status update. WM_STATS_CHAR passes a single
24 * character in wParam, and is called repeatedly to pass the name of
25 * the file, terminated with "\n". WM_STATS_SIZE passes the size of
26 * the file being transferred in wParam. WM_STATS_ELAPSED is called
27 * to pass the elapsed time (in seconds) in wParam, and
28 * WM_STATS_PERCENT passes the percentage of the transfer which is
29 * complete, also in wParam. */
30 #define WM_STATS_CHAR ( WM_APP_BASE+402 )
31 #define WM_STATS_SIZE ( WM_APP_BASE+403 )
32 #define WM_STATS_PERCENT ( WM_APP_BASE+404 )
33 #define WM_STATS_ELAPSED ( WM_APP_BASE+405 )
35 /* These are used at the end of a run to pass an error code in
36 * wParam: zero means success, nonzero means failure. WM_RET_ERR_CNT
37 * is used after a copy, and WM_LS_RET_ERR_CNT is used after a file
39 #define WM_RET_ERR_CNT ( WM_APP_BASE+406 )
40 #define WM_LS_RET_ERR_CNT ( WM_APP_BASE+407 )
42 /* More transfer status update messages. WM_STATS_DONE passes the
43 * number of bytes sent so far in wParam. WM_STATS_ETA passes the
44 * estimated time to completion (in seconds). WM_STATS_RATEBS passes
45 * the average transfer rate (in bytes per second). */
46 #define WM_STATS_DONE ( WM_APP_BASE+408 )
47 #define WM_STATS_ETA ( WM_APP_BASE+409 )
48 #define WM_STATS_RATEBS ( WM_APP_BASE+410 )
50 #define NAME_STR_MAX 2048
51 static char statname
[NAME_STR_MAX
+ 1];
52 static unsigned long statsize
= 0;
53 static unsigned long statdone
= 0;
54 static unsigned long stateta
= 0;
55 static unsigned long statratebs
= 0;
56 static int statperct
= 0;
57 static unsigned long statelapsed
= 0;
59 static HWND gui_hwnd
= NULL
;
61 static void send_msg(HWND h
, UINT message
, WPARAM wParam
)
63 while (!PostMessage(h
, message
, wParam
, 0))
67 void gui_send_char(int is_stderr
, int c
)
69 unsigned int msg_id
= WM_STD_OUT_CHAR
;
71 msg_id
= WM_STD_ERR_CHAR
;
72 send_msg(gui_hwnd
, msg_id
, (WPARAM
) c
);
75 void gui_send_errcount(int list
, int errs
)
77 unsigned int msg_id
= WM_RET_ERR_CNT
;
79 msg_id
= WM_LS_RET_ERR_CNT
;
80 while (!PostMessage(gui_hwnd
, msg_id
, (WPARAM
) errs
, 0))
84 void gui_update_stats(char *name
, unsigned long size
,
85 int percentage
, unsigned long elapsed
,
86 unsigned long done
, unsigned long eta
,
91 if (strcmp(name
, statname
) != 0) {
92 for (i
= 0; i
< strlen(name
); ++i
)
93 send_msg(gui_hwnd
, WM_STATS_CHAR
, (WPARAM
) name
[i
]);
94 send_msg(gui_hwnd
, WM_STATS_CHAR
, (WPARAM
) '\n');
95 strcpy(statname
, name
);
97 if (statsize
!= size
) {
98 send_msg(gui_hwnd
, WM_STATS_SIZE
, (WPARAM
) size
);
101 if (statdone
!= done
) {
102 send_msg(gui_hwnd
, WM_STATS_DONE
, (WPARAM
) done
);
105 if (stateta
!= eta
) {
106 send_msg(gui_hwnd
, WM_STATS_ETA
, (WPARAM
) eta
);
109 if (statratebs
!= ratebs
) {
110 send_msg(gui_hwnd
, WM_STATS_RATEBS
, (WPARAM
) ratebs
);
113 if (statelapsed
!= elapsed
) {
114 send_msg(gui_hwnd
, WM_STATS_ELAPSED
, (WPARAM
) elapsed
);
115 statelapsed
= elapsed
;
117 if (statperct
!= percentage
) {
118 send_msg(gui_hwnd
, WM_STATS_PERCENT
, (WPARAM
) percentage
);
119 statperct
= percentage
;
123 void gui_enable(char *arg
)
125 gui_hwnd
= (HWND
) atoi(arg
);
128 /* ----------------------------------------------------------------------
129 * File access abstraction.
133 * Set local current directory. Returns NULL on success, or else an
134 * error message which must be freed after printing.
136 char *psftp_lcd(char *dir
)
140 if (!SetCurrentDirectory(dir
)) {
143 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER
|
144 FORMAT_MESSAGE_FROM_SYSTEM
|
145 FORMAT_MESSAGE_IGNORE_INSERTS
,
146 NULL
, GetLastError(),
147 MAKELANGID(LANG_NEUTRAL
, SUBLANG_DEFAULT
),
148 (LPTSTR
)&message
, 0, NULL
);
149 i
= strcspn((char *)message
, "\n");
150 ret
= dupprintf("%.*s", i
, (LPCTSTR
)message
);
158 * Get local current directory. Returns a string which must be
161 char *psftp_getcwd(void)
163 char *ret
= snewn(256, char);
164 int len
= GetCurrentDirectory(256, ret
);
166 ret
= sresize(ret
, len
, char);
167 GetCurrentDirectory(len
, ret
);
171 #define TIME_POSIX_TO_WIN(t, ft) (*(LONGLONG*)&(ft) = \
172 ((LONGLONG) (t) + (LONGLONG) 11644473600) * (LONGLONG) 10000000)
173 #define TIME_WIN_TO_POSIX(ft, t) ((t) = (unsigned long) \
174 ((*(LONGLONG*)&(ft)) / (LONGLONG) 10000000 - (LONGLONG) 11644473600))
180 RFile
*open_existing_file(char *name
, unsigned long *size
,
181 unsigned long *mtime
, unsigned long *atime
)
186 h
= CreateFile(name
, GENERIC_READ
, FILE_SHARE_READ
, NULL
,
187 OPEN_EXISTING
, 0, 0);
188 if (h
== INVALID_HANDLE_VALUE
)
195 *size
= GetFileSize(h
, NULL
);
197 if (mtime
|| atime
) {
198 FILETIME actime
, wrtime
;
199 GetFileTime(h
, NULL
, &actime
, &wrtime
);
201 TIME_WIN_TO_POSIX(actime
, *atime
);
203 TIME_WIN_TO_POSIX(wrtime
, *mtime
);
209 int read_from_file(RFile
*f
, void *buffer
, int length
)
212 ret
= ReadFile(f
->h
, buffer
, length
, &read
, NULL
);
214 return -1; /* error */
219 void close_rfile(RFile
*f
)
229 WFile
*open_new_file(char *name
)
234 h
= CreateFile(name
, GENERIC_WRITE
, 0, NULL
,
235 CREATE_ALWAYS
, FILE_ATTRIBUTE_NORMAL
, 0);
236 if (h
== INVALID_HANDLE_VALUE
)
245 int write_to_file(WFile
*f
, void *buffer
, int length
)
248 ret
= WriteFile(f
->h
, buffer
, length
, &written
, NULL
);
250 return -1; /* error */
255 void set_file_times(WFile
*f
, unsigned long mtime
, unsigned long atime
)
257 FILETIME actime
, wrtime
;
258 TIME_POSIX_TO_WIN(atime
, actime
);
259 TIME_POSIX_TO_WIN(mtime
, wrtime
);
260 SetFileTime(f
->h
, NULL
, &actime
, &wrtime
);
263 void close_wfile(WFile
*f
)
269 int file_type(char *name
)
272 attr
= GetFileAttributes(name
);
273 /* We know of no `weird' files under Windows. */
274 if (attr
== (DWORD
)-1)
275 return FILE_TYPE_NONEXISTENT
;
276 else if (attr
& FILE_ATTRIBUTE_DIRECTORY
)
277 return FILE_TYPE_DIRECTORY
;
279 return FILE_TYPE_FILE
;
287 DirHandle
*open_directory(char *name
)
290 WIN32_FIND_DATA fdat
;
294 /* Enumerate files in dir `foo'. */
295 findfile
= dupcat(name
, "/*", NULL
);
296 h
= FindFirstFile(findfile
, &fdat
);
297 if (h
== INVALID_HANDLE_VALUE
)
301 ret
= snew(DirHandle
);
303 ret
->name
= dupstr(fdat
.cFileName
);
307 char *read_filename(DirHandle
*dir
)
312 WIN32_FIND_DATA fdat
;
313 int ok
= FindNextFile(dir
->h
, &fdat
);
317 dir
->name
= dupstr(fdat
.cFileName
);
321 if (dir
->name
[0] == '.' &&
322 (dir
->name
[1] == '\0' ||
323 (dir
->name
[1] == '.' && dir
->name
[2] == '\0'))) {
328 } while (!dir
->name
);
331 char *ret
= dir
->name
;
338 void close_directory(DirHandle
*dir
)
346 int test_wildcard(char *name
, int cmdline
)
349 WIN32_FIND_DATA fdat
;
351 /* First see if the exact name exists. */
352 if (GetFileAttributes(name
) != (DWORD
)-1)
353 return WCTYPE_FILENAME
;
355 /* Otherwise see if a wildcard match finds anything. */
356 fh
= FindFirstFile(name
, &fdat
);
357 if (fh
== INVALID_HANDLE_VALUE
)
358 return WCTYPE_NONEXISTENT
;
361 return WCTYPE_WILDCARD
;
364 struct WildcardMatcher
{
371 * Return a pointer to the portion of str that comes after the last
372 * slash (or backslash or colon, if `local' is TRUE).
374 static char *stripslashes(char *str
, int local
)
379 p
= strchr(str
, ':');
383 p
= strrchr(str
, '/');
387 p
= strrchr(str
, '\\');
394 WildcardMatcher
*begin_wildcard_matching(char *name
)
397 WIN32_FIND_DATA fdat
;
398 WildcardMatcher
*ret
;
401 h
= FindFirstFile(name
, &fdat
);
402 if (h
== INVALID_HANDLE_VALUE
)
405 ret
= snew(WildcardMatcher
);
407 ret
->srcpath
= dupstr(name
);
408 last
= stripslashes(ret
->srcpath
, 1);
410 if (fdat
.cFileName
[0] == '.' &&
411 (fdat
.cFileName
[1] == '\0' ||
412 (fdat
.cFileName
[1] == '.' && fdat
.cFileName
[2] == '\0')))
415 ret
->name
= dupcat(ret
->srcpath
, fdat
.cFileName
, NULL
);
420 char *wildcard_get_filename(WildcardMatcher
*dir
)
423 WIN32_FIND_DATA fdat
;
424 int ok
= FindNextFile(dir
->h
, &fdat
);
429 if (fdat
.cFileName
[0] == '.' &&
430 (fdat
.cFileName
[1] == '\0' ||
431 (fdat
.cFileName
[1] == '.' && fdat
.cFileName
[2] == '\0')))
434 dir
->name
= dupcat(dir
->srcpath
, fdat
.cFileName
, NULL
);
438 char *ret
= dir
->name
;
445 void finish_wildcard_matching(WildcardMatcher
*dir
)
454 int vet_filename(char *name
)
456 if (strchr(name
, '/') || strchr(name
, '\\') || strchr(name
, ':'))
459 if (!name
[strspn(name
, ".")]) /* entirely composed of dots */
465 int create_directory(char *name
)
467 return CreateDirectory(name
, NULL
) != 0;
470 char *dir_file_cat(char *dir
, char *file
)
472 return dupcat(dir
, "\\", file
, NULL
);
475 /* ----------------------------------------------------------------------
476 * Platform-specific network handling.
480 * Be told what socket we're supposed to be using.
482 static SOCKET sftp_ssh_socket
= INVALID_SOCKET
;
483 static HANDLE netevent
= NULL
;
484 char *do_select(SOCKET skt
, int startup
)
488 sftp_ssh_socket
= skt
;
490 sftp_ssh_socket
= INVALID_SOCKET
;
492 if (p_WSAEventSelect
) {
494 events
= (FD_CONNECT
| FD_READ
| FD_WRITE
|
495 FD_OOB
| FD_CLOSE
| FD_ACCEPT
);
496 netevent
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
500 if (p_WSAEventSelect(skt
, netevent
, events
) == SOCKET_ERROR
) {
501 switch (p_WSAGetLastError()) {
503 return "Network is down";
505 return "WSAEventSelect(): unknown error";
511 extern int select_result(WPARAM
, LPARAM
);
513 int do_eventsel_loop(HANDLE other_event
)
520 long now
= GETTICKCOUNT();
523 return -1; /* doom */
526 handles
[0] = netevent
;
527 handles
[1] = other_event
;
529 if (run_timers(now
, &next
)) {
530 ticks
= next
- GETTICKCOUNT();
531 if (ticks
< 0) ticks
= 0; /* just in case */
536 n
= MsgWaitForMultipleObjects(other_event ?
2 : 1, handles
, FALSE
, ticks
,
539 if (n
== WAIT_OBJECT_0
+ 0) {
540 WSANETWORKEVENTS things
;
542 extern SOCKET
first_socket(int *), next_socket(int *);
543 extern int select_result(WPARAM
, LPARAM
);
547 * We must not call select_result() for any socket
548 * until we have finished enumerating within the
549 * tree. This is because select_result() may close
550 * the socket and modify the tree.
552 /* Count the active sockets. */
554 for (socket
= first_socket(&socketstate
);
555 socket
!= INVALID_SOCKET
;
556 socket
= next_socket(&socketstate
)) i
++;
558 /* Expand the buffer if necessary. */
559 sklist
= snewn(i
, SOCKET
);
561 /* Retrieve the sockets into sklist. */
563 for (socket
= first_socket(&socketstate
);
564 socket
!= INVALID_SOCKET
;
565 socket
= next_socket(&socketstate
)) {
566 sklist
[skcount
++] = socket
;
569 /* Now we're done enumerating; go through the list. */
570 for (i
= 0; i
< skcount
; i
++) {
573 wp
= (WPARAM
) socket
;
574 if (!p_WSAEnumNetworkEvents(socket
, NULL
, &things
)) {
575 static const struct { int bit
, mask
; } eventtypes
[] = {
576 {FD_CONNECT_BIT
, FD_CONNECT
},
577 {FD_READ_BIT
, FD_READ
},
578 {FD_CLOSE_BIT
, FD_CLOSE
},
579 {FD_OOB_BIT
, FD_OOB
},
580 {FD_WRITE_BIT
, FD_WRITE
},
581 {FD_ACCEPT_BIT
, FD_ACCEPT
},
585 noise_ultralight(socket
);
586 noise_ultralight(things
.lNetworkEvents
);
588 for (e
= 0; e
< lenof(eventtypes
); e
++)
589 if (things
.lNetworkEvents
& eventtypes
[e
].mask
) {
591 int err
= things
.iErrorCode
[eventtypes
[e
].bit
];
592 lp
= WSAMAKESELECTREPLY(eventtypes
[e
].mask
, err
);
593 select_result(wp
, lp
);
601 if (n
== WAIT_TIMEOUT
) {
604 now
= GETTICKCOUNT();
607 if (other_event
&& n
== WAIT_OBJECT_0
+ 1)
614 * Wait for some network data and process it.
616 * We have two variants of this function. One uses select() so that
617 * it's compatible with WinSock 1. The other uses WSAEventSelect
618 * and MsgWaitForMultipleObjects, so that we can consistently use
619 * WSAEventSelect throughout; this enables us to also implement
620 * ssh_sftp_get_cmdline() using a parallel mechanism.
622 int ssh_sftp_loop_iteration(void)
624 if (sftp_ssh_socket
== INVALID_SOCKET
)
625 return -1; /* doom */
627 if (p_WSAEventSelect
== NULL
) {
630 long now
= GETTICKCOUNT();
632 if (socket_writable(sftp_ssh_socket
))
633 select_result((WPARAM
) sftp_ssh_socket
, (LPARAM
) FD_WRITE
);
637 struct timeval tv
, *ptv
;
639 if (run_timers(now
, &next
)) {
640 ticks
= next
- GETTICKCOUNT();
642 ticks
= 1; /* just in case */
643 tv
.tv_sec
= ticks
/ 1000;
644 tv
.tv_usec
= ticks
% 1000 * 1000;
651 FD_SET(sftp_ssh_socket
, &readfds
);
652 ret
= p_select(1, &readfds
, NULL
, NULL
, ptv
);
655 return -1; /* doom */
659 now
= GETTICKCOUNT();
663 select_result((WPARAM
) sftp_ssh_socket
, (LPARAM
) FD_READ
);
667 return do_eventsel_loop(NULL
);
672 * Read a command line from standard input.
674 * In the presence of WinSock 2, we can use WSAEventSelect to
675 * mediate between the socket and stdin, meaning we can send
676 * keepalives and respond to server events even while waiting at
677 * the PSFTP command prompt. Without WS2, we fall back to a simple
680 struct command_read_ctx
{
685 static DWORD WINAPI
command_read_thread(void *param
)
687 struct command_read_ctx
*ctx
= (struct command_read_ctx
*) param
;
689 ctx
->line
= fgetline(stdin
);
691 SetEvent(ctx
->event
);
696 char *ssh_sftp_get_cmdline(char *prompt
, int no_fds_ok
)
699 struct command_read_ctx actx
, *ctx
= &actx
;
702 fputs(prompt
, stdout
);
705 if ((sftp_ssh_socket
== INVALID_SOCKET
&& no_fds_ok
) ||
706 p_WSAEventSelect
== NULL
) {
707 return fgetline(stdin
); /* very simple */
711 * Create a second thread to read from stdin. Process network
712 * and timing events until it terminates.
714 ctx
->event
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
717 if (!CreateThread(NULL
, 0, command_read_thread
,
718 ctx
, 0, &threadid
)) {
719 fprintf(stderr
, "Unable to create command input thread\n");
724 ret
= do_eventsel_loop(ctx
->event
);
726 /* Error return can only occur if netevent==NULL, and it ain't. */
733 /* ----------------------------------------------------------------------
734 * Main program. Parse arguments etc.
736 int main(int argc
, char *argv
[])
740 ret
= psftp_main(argc
, argv
);