(calc-read-var-name-history): New variable.
[bpt/emacs.git] / src / w32.c
1 /* Utility and Unix shadow routines for GNU Emacs on the Microsoft W32 API.
2 Copyright (C) 1994, 1995, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
10 any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA.
21
22 Geoff Voelker (voelker@cs.washington.edu) 7-29-94
23 */
24 #include <stddef.h> /* for offsetof */
25 #include <stdlib.h>
26 #include <stdio.h>
27 #include <io.h>
28 #include <errno.h>
29 #include <fcntl.h>
30 #include <ctype.h>
31 #include <signal.h>
32 #include <sys/file.h>
33 #include <sys/time.h>
34 #include <sys/utime.h>
35 #include <mbstring.h> /* for _mbspbrk */
36
37 /* must include CRT headers *before* config.h */
38
39 #ifdef HAVE_CONFIG_H
40 #include <config.h>
41 #endif
42
43 #undef access
44 #undef chdir
45 #undef chmod
46 #undef creat
47 #undef ctime
48 #undef fopen
49 #undef link
50 #undef mkdir
51 #undef mktemp
52 #undef open
53 #undef rename
54 #undef rmdir
55 #undef unlink
56
57 #undef close
58 #undef dup
59 #undef dup2
60 #undef pipe
61 #undef read
62 #undef write
63
64 #undef strerror
65
66 #include "lisp.h"
67
68 #include <pwd.h>
69 #include <grp.h>
70
71 #ifdef __GNUC__
72 #define _ANONYMOUS_UNION
73 #define _ANONYMOUS_STRUCT
74 #endif
75 #include <windows.h>
76 #include <lmcons.h>
77 #include <shlobj.h>
78
79 #ifdef HAVE_SOCKETS /* TCP connection support, if kernel can do it */
80 #include <sys/socket.h>
81 #undef socket
82 #undef bind
83 #undef connect
84 #undef htons
85 #undef ntohs
86 #undef inet_addr
87 #undef gethostname
88 #undef gethostbyname
89 #undef getservbyname
90 #undef getpeername
91 #undef shutdown
92 #undef setsockopt
93 #undef listen
94 #undef getsockname
95 #undef accept
96 #undef recvfrom
97 #undef sendto
98 #endif
99
100 #include "w32.h"
101 #include "ndir.h"
102 #include "w32heap.h"
103 #include "systime.h"
104
105 typedef HRESULT (WINAPI * ShGetFolderPath_fn)
106 (IN HWND, IN int, IN HANDLE, IN DWORD, OUT char *);
107
108 void globals_of_w32 ();
109
110 extern Lisp_Object Vw32_downcase_file_names;
111 extern Lisp_Object Vw32_generate_fake_inodes;
112 extern Lisp_Object Vw32_get_true_file_attributes;
113 extern int w32_num_mouse_buttons;
114
115 \f
116 /* Initialization states.
117
118 WARNING: If you add any more such variables for additional APIs,
119 you MUST add initialization for them to globals_of_w32
120 below. This is because these variables might get set
121 to non-NULL values during dumping, but the dumped Emacs
122 cannot reuse those values, because it could be run on a
123 different version of the OS, where API addresses are
124 different. */
125 static BOOL g_b_init_is_windows_9x;
126 static BOOL g_b_init_open_process_token;
127 static BOOL g_b_init_get_token_information;
128 static BOOL g_b_init_lookup_account_sid;
129 static BOOL g_b_init_get_sid_identifier_authority;
130 static BOOL g_b_init_get_sid_sub_authority;
131 static BOOL g_b_init_get_sid_sub_authority_count;
132
133 /*
134 BEGIN: Wrapper functions around OpenProcessToken
135 and other functions in advapi32.dll that are only
136 supported in Windows NT / 2k / XP
137 */
138 /* ** Function pointer typedefs ** */
139 typedef BOOL (WINAPI * OpenProcessToken_Proc) (
140 HANDLE ProcessHandle,
141 DWORD DesiredAccess,
142 PHANDLE TokenHandle);
143 typedef BOOL (WINAPI * GetTokenInformation_Proc) (
144 HANDLE TokenHandle,
145 TOKEN_INFORMATION_CLASS TokenInformationClass,
146 LPVOID TokenInformation,
147 DWORD TokenInformationLength,
148 PDWORD ReturnLength);
149 typedef BOOL (WINAPI * GetProcessTimes_Proc) (
150 HANDLE process_handle,
151 LPFILETIME creation_time,
152 LPFILETIME exit_time,
153 LPFILETIME kernel_time,
154 LPFILETIME user_time);
155
156 GetProcessTimes_Proc get_process_times_fn = NULL;
157
158 #ifdef _UNICODE
159 const char * const LookupAccountSid_Name = "LookupAccountSidW";
160 #else
161 const char * const LookupAccountSid_Name = "LookupAccountSidA";
162 #endif
163 typedef BOOL (WINAPI * LookupAccountSid_Proc) (
164 LPCTSTR lpSystemName,
165 PSID Sid,
166 LPTSTR Name,
167 LPDWORD cbName,
168 LPTSTR DomainName,
169 LPDWORD cbDomainName,
170 PSID_NAME_USE peUse);
171 typedef PSID_IDENTIFIER_AUTHORITY (WINAPI * GetSidIdentifierAuthority_Proc) (
172 PSID pSid);
173 typedef PDWORD (WINAPI * GetSidSubAuthority_Proc) (
174 PSID pSid,
175 DWORD n);
176 typedef PUCHAR (WINAPI * GetSidSubAuthorityCount_Proc) (
177 PSID pSid);
178
179
180 /* ** A utility function ** */
181 static BOOL
182 is_windows_9x ()
183 {
184 static BOOL s_b_ret=0;
185 OSVERSIONINFO os_ver;
186 if (g_b_init_is_windows_9x == 0)
187 {
188 g_b_init_is_windows_9x = 1;
189 ZeroMemory(&os_ver, sizeof(OSVERSIONINFO));
190 os_ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
191 if (GetVersionEx (&os_ver))
192 {
193 s_b_ret = (os_ver.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS);
194 }
195 }
196 return s_b_ret;
197 }
198
199 /* Get total user and system times for get-internal-run-time.
200 Returns a list of three integers if the times are provided by the OS
201 (NT derivatives), otherwise it returns the result of current-time. */
202 Lisp_Object
203 w32_get_internal_run_time ()
204 {
205 if (get_process_times_fn)
206 {
207 FILETIME create, exit, kernel, user;
208 HANDLE proc = GetCurrentProcess();
209 if ((*get_process_times_fn) (proc, &create, &exit, &kernel, &user))
210 {
211 LARGE_INTEGER user_int, kernel_int, total;
212 int microseconds;
213 user_int.LowPart = user.dwLowDateTime;
214 user_int.HighPart = user.dwHighDateTime;
215 kernel_int.LowPart = kernel.dwLowDateTime;
216 kernel_int.HighPart = kernel.dwHighDateTime;
217 total.QuadPart = user_int.QuadPart + kernel_int.QuadPart;
218 /* FILETIME is 100 nanosecond increments, Emacs only wants
219 microsecond resolution. */
220 total.QuadPart /= 10;
221 microseconds = total.QuadPart % 1000000;
222 total.QuadPart /= 1000000;
223
224 /* Sanity check to make sure we can represent the result. */
225 if (total.HighPart == 0)
226 {
227 int secs = total.LowPart;
228
229 return list3 (make_number ((secs >> 16) & 0xffff),
230 make_number (secs & 0xffff),
231 make_number (microseconds));
232 }
233 }
234 }
235
236 return Fcurrent_time ();
237 }
238
239 /* ** The wrapper functions ** */
240
241 BOOL WINAPI open_process_token (
242 HANDLE ProcessHandle,
243 DWORD DesiredAccess,
244 PHANDLE TokenHandle)
245 {
246 static OpenProcessToken_Proc s_pfn_Open_Process_Token = NULL;
247 HMODULE hm_advapi32 = NULL;
248 if (is_windows_9x () == TRUE)
249 {
250 return FALSE;
251 }
252 if (g_b_init_open_process_token == 0)
253 {
254 g_b_init_open_process_token = 1;
255 hm_advapi32 = LoadLibrary ("Advapi32.dll");
256 s_pfn_Open_Process_Token =
257 (OpenProcessToken_Proc) GetProcAddress (hm_advapi32, "OpenProcessToken");
258 }
259 if (s_pfn_Open_Process_Token == NULL)
260 {
261 return FALSE;
262 }
263 return (
264 s_pfn_Open_Process_Token (
265 ProcessHandle,
266 DesiredAccess,
267 TokenHandle)
268 );
269 }
270
271 BOOL WINAPI get_token_information (
272 HANDLE TokenHandle,
273 TOKEN_INFORMATION_CLASS TokenInformationClass,
274 LPVOID TokenInformation,
275 DWORD TokenInformationLength,
276 PDWORD ReturnLength)
277 {
278 static GetTokenInformation_Proc s_pfn_Get_Token_Information = NULL;
279 HMODULE hm_advapi32 = NULL;
280 if (is_windows_9x () == TRUE)
281 {
282 return FALSE;
283 }
284 if (g_b_init_get_token_information == 0)
285 {
286 g_b_init_get_token_information = 1;
287 hm_advapi32 = LoadLibrary ("Advapi32.dll");
288 s_pfn_Get_Token_Information =
289 (GetTokenInformation_Proc) GetProcAddress (hm_advapi32, "GetTokenInformation");
290 }
291 if (s_pfn_Get_Token_Information == NULL)
292 {
293 return FALSE;
294 }
295 return (
296 s_pfn_Get_Token_Information (
297 TokenHandle,
298 TokenInformationClass,
299 TokenInformation,
300 TokenInformationLength,
301 ReturnLength)
302 );
303 }
304
305 BOOL WINAPI lookup_account_sid (
306 LPCTSTR lpSystemName,
307 PSID Sid,
308 LPTSTR Name,
309 LPDWORD cbName,
310 LPTSTR DomainName,
311 LPDWORD cbDomainName,
312 PSID_NAME_USE peUse)
313 {
314 static LookupAccountSid_Proc s_pfn_Lookup_Account_Sid = NULL;
315 HMODULE hm_advapi32 = NULL;
316 if (is_windows_9x () == TRUE)
317 {
318 return FALSE;
319 }
320 if (g_b_init_lookup_account_sid == 0)
321 {
322 g_b_init_lookup_account_sid = 1;
323 hm_advapi32 = LoadLibrary ("Advapi32.dll");
324 s_pfn_Lookup_Account_Sid =
325 (LookupAccountSid_Proc) GetProcAddress (hm_advapi32, LookupAccountSid_Name);
326 }
327 if (s_pfn_Lookup_Account_Sid == NULL)
328 {
329 return FALSE;
330 }
331 return (
332 s_pfn_Lookup_Account_Sid (
333 lpSystemName,
334 Sid,
335 Name,
336 cbName,
337 DomainName,
338 cbDomainName,
339 peUse)
340 );
341 }
342
343 PSID_IDENTIFIER_AUTHORITY WINAPI get_sid_identifier_authority (
344 PSID pSid)
345 {
346 static GetSidIdentifierAuthority_Proc s_pfn_Get_Sid_Identifier_Authority = NULL;
347 HMODULE hm_advapi32 = NULL;
348 if (is_windows_9x () == TRUE)
349 {
350 return NULL;
351 }
352 if (g_b_init_get_sid_identifier_authority == 0)
353 {
354 g_b_init_get_sid_identifier_authority = 1;
355 hm_advapi32 = LoadLibrary ("Advapi32.dll");
356 s_pfn_Get_Sid_Identifier_Authority =
357 (GetSidIdentifierAuthority_Proc) GetProcAddress (
358 hm_advapi32, "GetSidIdentifierAuthority");
359 }
360 if (s_pfn_Get_Sid_Identifier_Authority == NULL)
361 {
362 return NULL;
363 }
364 return (s_pfn_Get_Sid_Identifier_Authority (pSid));
365 }
366
367 PDWORD WINAPI get_sid_sub_authority (
368 PSID pSid,
369 DWORD n)
370 {
371 static GetSidSubAuthority_Proc s_pfn_Get_Sid_Sub_Authority = NULL;
372 static DWORD zero = 0U;
373 HMODULE hm_advapi32 = NULL;
374 if (is_windows_9x () == TRUE)
375 {
376 return &zero;
377 }
378 if (g_b_init_get_sid_sub_authority == 0)
379 {
380 g_b_init_get_sid_sub_authority = 1;
381 hm_advapi32 = LoadLibrary ("Advapi32.dll");
382 s_pfn_Get_Sid_Sub_Authority =
383 (GetSidSubAuthority_Proc) GetProcAddress (
384 hm_advapi32, "GetSidSubAuthority");
385 }
386 if (s_pfn_Get_Sid_Sub_Authority == NULL)
387 {
388 return &zero;
389 }
390 return (s_pfn_Get_Sid_Sub_Authority (pSid, n));
391 }
392
393 PUCHAR WINAPI get_sid_sub_authority_count (
394 PSID pSid)
395 {
396 static GetSidSubAuthorityCount_Proc s_pfn_Get_Sid_Sub_Authority_Count = NULL;
397 static UCHAR zero = 0U;
398 HMODULE hm_advapi32 = NULL;
399 if (is_windows_9x () == TRUE)
400 {
401 return &zero;
402 }
403 if (g_b_init_get_sid_sub_authority_count == 0)
404 {
405 g_b_init_get_sid_sub_authority_count = 1;
406 hm_advapi32 = LoadLibrary ("Advapi32.dll");
407 s_pfn_Get_Sid_Sub_Authority_Count =
408 (GetSidSubAuthorityCount_Proc) GetProcAddress (
409 hm_advapi32, "GetSidSubAuthorityCount");
410 }
411 if (s_pfn_Get_Sid_Sub_Authority_Count == NULL)
412 {
413 return &zero;
414 }
415 return (s_pfn_Get_Sid_Sub_Authority_Count (pSid));
416 }
417
418 /*
419 END: Wrapper functions around OpenProcessToken
420 and other functions in advapi32.dll that are only
421 supported in Windows NT / 2k / XP
422 */
423
424 \f
425 /* Equivalent of strerror for W32 error codes. */
426 char *
427 w32_strerror (int error_no)
428 {
429 static char buf[500];
430
431 if (error_no == 0)
432 error_no = GetLastError ();
433
434 buf[0] = '\0';
435 if (!FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM, NULL,
436 error_no,
437 0, /* choose most suitable language */
438 buf, sizeof (buf), NULL))
439 sprintf (buf, "w32 error %u", error_no);
440 return buf;
441 }
442
443 /* Return 1 if P is a valid pointer to an object of size SIZE. Return
444 0 if P is NOT a valid pointer. Return -1 if we cannot validate P.
445
446 This is called from alloc.c:valid_pointer_p. */
447 int
448 w32_valid_pointer_p (void *p, int size)
449 {
450 SIZE_T done;
451 HANDLE h = OpenProcess (PROCESS_VM_READ, FALSE, GetCurrentProcessId ());
452
453 if (h)
454 {
455 unsigned char *buf = alloca (size);
456 int retval = ReadProcessMemory (h, p, buf, size, &done);
457
458 CloseHandle (h);
459 return retval;
460 }
461 else
462 return -1;
463 }
464
465 static char startup_dir[MAXPATHLEN];
466
467 /* Get the current working directory. */
468 char *
469 getwd (char *dir)
470 {
471 #if 0
472 if (GetCurrentDirectory (MAXPATHLEN, dir) > 0)
473 return dir;
474 return NULL;
475 #else
476 /* Emacs doesn't actually change directory itself, and we want to
477 force our real wd to be where emacs.exe is to avoid unnecessary
478 conflicts when trying to rename or delete directories. */
479 strcpy (dir, startup_dir);
480 return dir;
481 #endif
482 }
483
484 #ifndef HAVE_SOCKETS
485 /* Emulate gethostname. */
486 int
487 gethostname (char *buffer, int size)
488 {
489 /* NT only allows small host names, so the buffer is
490 certainly large enough. */
491 return !GetComputerName (buffer, &size);
492 }
493 #endif /* HAVE_SOCKETS */
494
495 /* Emulate getloadavg. */
496 int
497 getloadavg (double loadavg[], int nelem)
498 {
499 int i;
500
501 /* A faithful emulation is going to have to be saved for a rainy day. */
502 for (i = 0; i < nelem; i++)
503 {
504 loadavg[i] = 0.0;
505 }
506 return i;
507 }
508
509 /* Emulate getpwuid, getpwnam and others. */
510
511 #define PASSWD_FIELD_SIZE 256
512
513 static char the_passwd_name[PASSWD_FIELD_SIZE];
514 static char the_passwd_passwd[PASSWD_FIELD_SIZE];
515 static char the_passwd_gecos[PASSWD_FIELD_SIZE];
516 static char the_passwd_dir[PASSWD_FIELD_SIZE];
517 static char the_passwd_shell[PASSWD_FIELD_SIZE];
518
519 static struct passwd the_passwd =
520 {
521 the_passwd_name,
522 the_passwd_passwd,
523 0,
524 0,
525 0,
526 the_passwd_gecos,
527 the_passwd_dir,
528 the_passwd_shell,
529 };
530
531 static struct group the_group =
532 {
533 /* There are no groups on NT, so we just return "root" as the
534 group name. */
535 "root",
536 };
537
538 int
539 getuid ()
540 {
541 return the_passwd.pw_uid;
542 }
543
544 int
545 geteuid ()
546 {
547 /* I could imagine arguing for checking to see whether the user is
548 in the Administrators group and returning a UID of 0 for that
549 case, but I don't know how wise that would be in the long run. */
550 return getuid ();
551 }
552
553 int
554 getgid ()
555 {
556 return the_passwd.pw_gid;
557 }
558
559 int
560 getegid ()
561 {
562 return getgid ();
563 }
564
565 struct passwd *
566 getpwuid (int uid)
567 {
568 if (uid == the_passwd.pw_uid)
569 return &the_passwd;
570 return NULL;
571 }
572
573 struct group *
574 getgrgid (gid_t gid)
575 {
576 return &the_group;
577 }
578
579 struct passwd *
580 getpwnam (char *name)
581 {
582 struct passwd *pw;
583
584 pw = getpwuid (getuid ());
585 if (!pw)
586 return pw;
587
588 if (stricmp (name, pw->pw_name))
589 return NULL;
590
591 return pw;
592 }
593
594 void
595 init_user_info ()
596 {
597 /* Find the user's real name by opening the process token and
598 looking up the name associated with the user-sid in that token.
599
600 Use the relative portion of the identifier authority value from
601 the user-sid as the user id value (same for group id using the
602 primary group sid from the process token). */
603
604 char name[UNLEN+1], domain[1025];
605 DWORD length = sizeof (name), dlength = sizeof (domain), trash;
606 HANDLE token = NULL;
607 SID_NAME_USE user_type;
608 unsigned char buf[1024];
609 TOKEN_USER user_token;
610 TOKEN_PRIMARY_GROUP group_token;
611
612 if (open_process_token (GetCurrentProcess (), TOKEN_QUERY, &token)
613 && get_token_information (token, TokenUser,
614 (PVOID)buf, sizeof (buf), &trash)
615 && (memcpy (&user_token, buf, sizeof (user_token)),
616 lookup_account_sid (NULL, user_token.User.Sid, name, &length,
617 domain, &dlength, &user_type)))
618 {
619 strcpy (the_passwd.pw_name, name);
620 /* Determine a reasonable uid value. */
621 if (stricmp ("administrator", name) == 0)
622 {
623 the_passwd.pw_uid = 500; /* well-known Administrator uid */
624 the_passwd.pw_gid = 513; /* well-known None gid */
625 }
626 else
627 {
628 /* Use the last sub-authority value of the RID, the relative
629 portion of the SID, as user/group ID. */
630 DWORD n_subauthorities =
631 *get_sid_sub_authority_count (user_token.User.Sid);
632
633 if (n_subauthorities < 1)
634 the_passwd.pw_uid = 0; /* the "World" RID */
635 else
636 {
637 the_passwd.pw_uid =
638 *get_sid_sub_authority (user_token.User.Sid,
639 n_subauthorities - 1);
640 /* Restrict to conventional uid range for normal users. */
641 the_passwd.pw_uid %= 60001;
642 }
643
644 /* Get group id */
645 if (get_token_information (token, TokenPrimaryGroup,
646 (PVOID)buf, sizeof (buf), &trash))
647 {
648 memcpy (&group_token, buf, sizeof (group_token));
649 n_subauthorities =
650 *get_sid_sub_authority_count (group_token.PrimaryGroup);
651
652 if (n_subauthorities < 1)
653 the_passwd.pw_gid = 0; /* the "World" RID */
654 else
655 {
656 the_passwd.pw_gid =
657 *get_sid_sub_authority (group_token.PrimaryGroup,
658 n_subauthorities - 1);
659 /* I don't know if this is necessary, but for safety... */
660 the_passwd.pw_gid %= 60001;
661 }
662 }
663 else
664 the_passwd.pw_gid = the_passwd.pw_uid;
665 }
666 }
667 /* If security calls are not supported (presumably because we
668 are running under Windows 95), fallback to this. */
669 else if (GetUserName (name, &length))
670 {
671 strcpy (the_passwd.pw_name, name);
672 if (stricmp ("administrator", name) == 0)
673 the_passwd.pw_uid = 0;
674 else
675 the_passwd.pw_uid = 123;
676 the_passwd.pw_gid = the_passwd.pw_uid;
677 }
678 else
679 {
680 strcpy (the_passwd.pw_name, "unknown");
681 the_passwd.pw_uid = 123;
682 the_passwd.pw_gid = 123;
683 }
684
685 /* Ensure HOME and SHELL are defined. */
686 if (getenv ("HOME") == NULL)
687 abort ();
688 if (getenv ("SHELL") == NULL)
689 abort ();
690
691 /* Set dir and shell from environment variables. */
692 strcpy (the_passwd.pw_dir, getenv ("HOME"));
693 strcpy (the_passwd.pw_shell, getenv ("SHELL"));
694
695 if (token)
696 CloseHandle (token);
697 }
698
699 int
700 random ()
701 {
702 /* rand () on NT gives us 15 random bits...hack together 30 bits. */
703 return ((rand () << 15) | rand ());
704 }
705
706 void
707 srandom (int seed)
708 {
709 srand (seed);
710 }
711
712
713 /* Normalize filename by converting all path separators to
714 the specified separator. Also conditionally convert upper
715 case path name components to lower case. */
716
717 static void
718 normalize_filename (fp, path_sep)
719 register char *fp;
720 char path_sep;
721 {
722 char sep;
723 char *elem;
724
725 /* Always lower-case drive letters a-z, even if the filesystem
726 preserves case in filenames.
727 This is so filenames can be compared by string comparison
728 functions that are case-sensitive. Even case-preserving filesystems
729 do not distinguish case in drive letters. */
730 if (fp[1] == ':' && *fp >= 'A' && *fp <= 'Z')
731 {
732 *fp += 'a' - 'A';
733 fp += 2;
734 }
735
736 if (NILP (Vw32_downcase_file_names))
737 {
738 while (*fp)
739 {
740 if (*fp == '/' || *fp == '\\')
741 *fp = path_sep;
742 fp++;
743 }
744 return;
745 }
746
747 sep = path_sep; /* convert to this path separator */
748 elem = fp; /* start of current path element */
749
750 do {
751 if (*fp >= 'a' && *fp <= 'z')
752 elem = 0; /* don't convert this element */
753
754 if (*fp == 0 || *fp == ':')
755 {
756 sep = *fp; /* restore current separator (or 0) */
757 *fp = '/'; /* after conversion of this element */
758 }
759
760 if (*fp == '/' || *fp == '\\')
761 {
762 if (elem && elem != fp)
763 {
764 *fp = 0; /* temporary end of string */
765 _strlwr (elem); /* while we convert to lower case */
766 }
767 *fp = sep; /* convert (or restore) path separator */
768 elem = fp + 1; /* next element starts after separator */
769 sep = path_sep;
770 }
771 } while (*fp++);
772 }
773
774 /* Destructively turn backslashes into slashes. */
775 void
776 dostounix_filename (p)
777 register char *p;
778 {
779 normalize_filename (p, '/');
780 }
781
782 /* Destructively turn slashes into backslashes. */
783 void
784 unixtodos_filename (p)
785 register char *p;
786 {
787 normalize_filename (p, '\\');
788 }
789
790 /* Remove all CR's that are followed by a LF.
791 (From msdos.c...probably should figure out a way to share it,
792 although this code isn't going to ever change.) */
793 int
794 crlf_to_lf (n, buf)
795 register int n;
796 register unsigned char *buf;
797 {
798 unsigned char *np = buf;
799 unsigned char *startp = buf;
800 unsigned char *endp = buf + n;
801
802 if (n == 0)
803 return n;
804 while (buf < endp - 1)
805 {
806 if (*buf == 0x0d)
807 {
808 if (*(++buf) != 0x0a)
809 *np++ = 0x0d;
810 }
811 else
812 *np++ = *buf++;
813 }
814 if (buf < endp)
815 *np++ = *buf++;
816 return np - startp;
817 }
818
819 /* Parse the root part of file name, if present. Return length and
820 optionally store pointer to char after root. */
821 static int
822 parse_root (char * name, char ** pPath)
823 {
824 char * start = name;
825
826 if (name == NULL)
827 return 0;
828
829 /* find the root name of the volume if given */
830 if (isalpha (name[0]) && name[1] == ':')
831 {
832 /* skip past drive specifier */
833 name += 2;
834 if (IS_DIRECTORY_SEP (name[0]))
835 name++;
836 }
837 else if (IS_DIRECTORY_SEP (name[0]) && IS_DIRECTORY_SEP (name[1]))
838 {
839 int slashes = 2;
840 name += 2;
841 do
842 {
843 if (IS_DIRECTORY_SEP (*name) && --slashes == 0)
844 break;
845 name++;
846 }
847 while ( *name );
848 if (IS_DIRECTORY_SEP (name[0]))
849 name++;
850 }
851
852 if (pPath)
853 *pPath = name;
854
855 return name - start;
856 }
857
858 /* Get long base name for name; name is assumed to be absolute. */
859 static int
860 get_long_basename (char * name, char * buf, int size)
861 {
862 WIN32_FIND_DATA find_data;
863 HANDLE dir_handle;
864 int len = 0;
865
866 /* must be valid filename, no wild cards or other invalid characters */
867 if (_mbspbrk (name, "*?|<>\""))
868 return 0;
869
870 dir_handle = FindFirstFile (name, &find_data);
871 if (dir_handle != INVALID_HANDLE_VALUE)
872 {
873 if ((len = strlen (find_data.cFileName)) < size)
874 memcpy (buf, find_data.cFileName, len + 1);
875 else
876 len = 0;
877 FindClose (dir_handle);
878 }
879 return len;
880 }
881
882 /* Get long name for file, if possible (assumed to be absolute). */
883 BOOL
884 w32_get_long_filename (char * name, char * buf, int size)
885 {
886 char * o = buf;
887 char * p;
888 char * q;
889 char full[ MAX_PATH ];
890 int len;
891
892 len = strlen (name);
893 if (len >= MAX_PATH)
894 return FALSE;
895
896 /* Use local copy for destructive modification. */
897 memcpy (full, name, len+1);
898 unixtodos_filename (full);
899
900 /* Copy root part verbatim. */
901 len = parse_root (full, &p);
902 memcpy (o, full, len);
903 o += len;
904 *o = '\0';
905 size -= len;
906
907 while (p != NULL && *p)
908 {
909 q = p;
910 p = strchr (q, '\\');
911 if (p) *p = '\0';
912 len = get_long_basename (full, o, size);
913 if (len > 0)
914 {
915 o += len;
916 size -= len;
917 if (p != NULL)
918 {
919 *p++ = '\\';
920 if (size < 2)
921 return FALSE;
922 *o++ = '\\';
923 size--;
924 *o = '\0';
925 }
926 }
927 else
928 return FALSE;
929 }
930
931 return TRUE;
932 }
933
934 int
935 is_unc_volume (const char *filename)
936 {
937 const char *ptr = filename;
938
939 if (!IS_DIRECTORY_SEP (ptr[0]) || !IS_DIRECTORY_SEP (ptr[1]) || !ptr[2])
940 return 0;
941
942 if (_mbspbrk (ptr + 2, "*?|<>\"\\/"))
943 return 0;
944
945 return 1;
946 }
947
948 /* Routines that are no-ops on NT but are defined to get Emacs to compile. */
949
950 int
951 sigsetmask (int signal_mask)
952 {
953 return 0;
954 }
955
956 int
957 sigmask (int sig)
958 {
959 return 0;
960 }
961
962 int
963 sigblock (int sig)
964 {
965 return 0;
966 }
967
968 int
969 sigunblock (int sig)
970 {
971 return 0;
972 }
973
974 int
975 setpgrp (int pid, int gid)
976 {
977 return 0;
978 }
979
980 int
981 alarm (int seconds)
982 {
983 return 0;
984 }
985
986 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
987
988 LPBYTE
989 w32_get_resource (key, lpdwtype)
990 char *key;
991 LPDWORD lpdwtype;
992 {
993 LPBYTE lpvalue;
994 HKEY hrootkey = NULL;
995 DWORD cbData;
996
997 /* Check both the current user and the local machine to see if
998 we have any resources. */
999
1000 if (RegOpenKeyEx (HKEY_CURRENT_USER, REG_ROOT, 0, KEY_READ, &hrootkey) == ERROR_SUCCESS)
1001 {
1002 lpvalue = NULL;
1003
1004 if (RegQueryValueEx (hrootkey, key, NULL, NULL, NULL, &cbData) == ERROR_SUCCESS
1005 && (lpvalue = (LPBYTE) xmalloc (cbData)) != NULL
1006 && RegQueryValueEx (hrootkey, key, NULL, lpdwtype, lpvalue, &cbData) == ERROR_SUCCESS)
1007 {
1008 RegCloseKey (hrootkey);
1009 return (lpvalue);
1010 }
1011
1012 if (lpvalue) xfree (lpvalue);
1013
1014 RegCloseKey (hrootkey);
1015 }
1016
1017 if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, REG_ROOT, 0, KEY_READ, &hrootkey) == ERROR_SUCCESS)
1018 {
1019 lpvalue = NULL;
1020
1021 if (RegQueryValueEx (hrootkey, key, NULL, NULL, NULL, &cbData) == ERROR_SUCCESS
1022 && (lpvalue = (LPBYTE) xmalloc (cbData)) != NULL
1023 && RegQueryValueEx (hrootkey, key, NULL, lpdwtype, lpvalue, &cbData) == ERROR_SUCCESS)
1024 {
1025 RegCloseKey (hrootkey);
1026 return (lpvalue);
1027 }
1028
1029 if (lpvalue) xfree (lpvalue);
1030
1031 RegCloseKey (hrootkey);
1032 }
1033
1034 return (NULL);
1035 }
1036
1037 char *get_emacs_configuration (void);
1038 extern Lisp_Object Vsystem_configuration;
1039
1040 void
1041 init_environment (char ** argv)
1042 {
1043 static const char * const tempdirs[] = {
1044 "$TMPDIR", "$TEMP", "$TMP", "c:/"
1045 };
1046
1047 int i;
1048
1049 const int imax = sizeof (tempdirs) / sizeof (tempdirs[0]);
1050
1051 /* Make sure they have a usable $TMPDIR. Many Emacs functions use
1052 temporary files and assume "/tmp" if $TMPDIR is unset, which
1053 will break on DOS/Windows. Refuse to work if we cannot find
1054 a directory, not even "c:/", usable for that purpose. */
1055 for (i = 0; i < imax ; i++)
1056 {
1057 const char *tmp = tempdirs[i];
1058
1059 if (*tmp == '$')
1060 tmp = getenv (tmp + 1);
1061 /* Note that `access' can lie to us if the directory resides on a
1062 read-only filesystem, like CD-ROM or a write-protected floppy.
1063 The only way to be really sure is to actually create a file and
1064 see if it succeeds. But I think that's too much to ask. */
1065 if (tmp && _access (tmp, D_OK) == 0)
1066 {
1067 char * var = alloca (strlen (tmp) + 8);
1068 sprintf (var, "TMPDIR=%s", tmp);
1069 _putenv (strdup (var));
1070 break;
1071 }
1072 }
1073 if (i >= imax)
1074 cmd_error_internal
1075 (Fcons (Qerror,
1076 Fcons (build_string ("no usable temporary directories found!!"),
1077 Qnil)),
1078 "While setting TMPDIR: ");
1079
1080 /* Check for environment variables and use registry settings if they
1081 don't exist. Fallback on default values where applicable. */
1082 {
1083 int i;
1084 LPBYTE lpval;
1085 DWORD dwType;
1086 char locale_name[32];
1087 struct stat ignored;
1088 char default_home[MAX_PATH];
1089
1090 static const struct env_entry
1091 {
1092 char * name;
1093 char * def_value;
1094 } dflt_envvars[] =
1095 {
1096 {"HOME", "C:/"},
1097 {"PRELOAD_WINSOCK", NULL},
1098 {"emacs_dir", "C:/emacs"},
1099 {"EMACSLOADPATH", "%emacs_dir%/site-lisp;%emacs_dir%/../site-lisp;%emacs_dir%/lisp;%emacs_dir%/leim"},
1100 {"SHELL", "%emacs_dir%/bin/cmdproxy.exe"},
1101 {"EMACSDATA", "%emacs_dir%/etc"},
1102 {"EMACSPATH", "%emacs_dir%/bin"},
1103 /* We no longer set INFOPATH because Info-default-directory-list
1104 is then ignored. */
1105 /* {"INFOPATH", "%emacs_dir%/info"}, */
1106 {"EMACSDOC", "%emacs_dir%/etc"},
1107 {"TERM", "cmd"},
1108 {"LANG", NULL},
1109 };
1110
1111 #define N_ENV_VARS sizeof(dflt_envvars)/sizeof(dflt_envvars[0])
1112
1113 /* We need to copy dflt_envvars[] and work on the copy because we
1114 don't want the dumped Emacs to inherit the values of
1115 environment variables we saw during dumping (which could be on
1116 a different system). The defaults above must be left intact. */
1117 struct env_entry env_vars[N_ENV_VARS];
1118
1119 for (i = 0; i < N_ENV_VARS; i++)
1120 env_vars[i] = dflt_envvars[i];
1121
1122 /* For backwards compatibility, check if a .emacs file exists in C:/
1123 If not, then we can try to default to the appdata directory under the
1124 user's profile, which is more likely to be writable. */
1125 if (stat ("C:/.emacs", &ignored) < 0)
1126 {
1127 HRESULT profile_result;
1128 /* Dynamically load ShGetFolderPath, as it won't exist on versions
1129 of Windows 95 and NT4 that have not been updated to include
1130 MSIE 5. Also we don't link with shell32.dll by default. */
1131 HMODULE shell32_dll;
1132 ShGetFolderPath_fn get_folder_path;
1133 shell32_dll = GetModuleHandle ("shell32.dll");
1134 get_folder_path = (ShGetFolderPath_fn)
1135 GetProcAddress (shell32_dll, "SHGetFolderPathA");
1136
1137 if (get_folder_path != NULL)
1138 {
1139 profile_result = get_folder_path (NULL, CSIDL_APPDATA, NULL,
1140 0, default_home);
1141
1142 /* If we can't get the appdata dir, revert to old behaviour. */
1143 if (profile_result == S_OK)
1144 env_vars[0].def_value = default_home;
1145 }
1146
1147 /* Unload shell32.dll, it is not needed anymore. */
1148 FreeLibrary (shell32_dll);
1149 }
1150
1151 /* Get default locale info and use it for LANG. */
1152 if (GetLocaleInfo (LOCALE_USER_DEFAULT,
1153 LOCALE_SABBREVLANGNAME | LOCALE_USE_CP_ACP,
1154 locale_name, sizeof (locale_name)))
1155 {
1156 for (i = 0; i < N_ENV_VARS; i++)
1157 {
1158 if (strcmp (env_vars[i].name, "LANG") == 0)
1159 {
1160 env_vars[i].def_value = locale_name;
1161 break;
1162 }
1163 }
1164 }
1165
1166 #define SET_ENV_BUF_SIZE (4 * MAX_PATH) /* to cover EMACSLOADPATH */
1167
1168 /* Treat emacs_dir specially: set it unconditionally based on our
1169 location, if it appears that we are running from the bin subdir
1170 of a standard installation. */
1171 {
1172 char *p;
1173 char modname[MAX_PATH];
1174
1175 if (!GetModuleFileName (NULL, modname, MAX_PATH))
1176 abort ();
1177 if ((p = strrchr (modname, '\\')) == NULL)
1178 abort ();
1179 *p = 0;
1180
1181 if ((p = strrchr (modname, '\\')) && stricmp (p, "\\bin") == 0)
1182 {
1183 char buf[SET_ENV_BUF_SIZE];
1184
1185 *p = 0;
1186 for (p = modname; *p; p++)
1187 if (*p == '\\') *p = '/';
1188
1189 _snprintf (buf, sizeof(buf)-1, "emacs_dir=%s", modname);
1190 _putenv (strdup (buf));
1191 }
1192 /* Handle running emacs from the build directory: src/oo-spd/i386/ */
1193
1194 /* FIXME: should use substring of get_emacs_configuration ().
1195 But I don't think the Windows build supports alpha, mips etc
1196 anymore, so have taken the easy option for now. */
1197 else if (p && stricmp (p, "\\i386") == 0)
1198 {
1199 *p = 0;
1200 p = strrchr (modname, '\\');
1201 if (p != NULL)
1202 {
1203 *p = 0;
1204 p = strrchr (modname, '\\');
1205 if (p && stricmp (p, "\\src") == 0)
1206 {
1207 char buf[SET_ENV_BUF_SIZE];
1208
1209 *p = 0;
1210 for (p = modname; *p; p++)
1211 if (*p == '\\') *p = '/';
1212
1213 _snprintf (buf, sizeof(buf)-1, "emacs_dir=%s", modname);
1214 _putenv (strdup (buf));
1215 }
1216 }
1217 }
1218 }
1219
1220 for (i = 0; i < N_ENV_VARS; i++)
1221 {
1222 if (!getenv (env_vars[i].name))
1223 {
1224 int dont_free = 0;
1225
1226 if ((lpval = w32_get_resource (env_vars[i].name, &dwType)) == NULL
1227 /* Also ignore empty environment variables. */
1228 || *lpval == 0)
1229 {
1230 if (lpval) xfree (lpval);
1231 lpval = env_vars[i].def_value;
1232 dwType = REG_EXPAND_SZ;
1233 dont_free = 1;
1234 }
1235
1236 if (lpval)
1237 {
1238 char buf1[SET_ENV_BUF_SIZE], buf2[SET_ENV_BUF_SIZE];
1239
1240 if (dwType == REG_EXPAND_SZ)
1241 ExpandEnvironmentStrings ((LPSTR) lpval, buf1, sizeof(buf1));
1242 else if (dwType == REG_SZ)
1243 strcpy (buf1, lpval);
1244 if (dwType == REG_EXPAND_SZ || dwType == REG_SZ)
1245 {
1246 _snprintf (buf2, sizeof(buf2)-1, "%s=%s", env_vars[i].name,
1247 buf1);
1248 _putenv (strdup (buf2));
1249 }
1250
1251 if (!dont_free)
1252 xfree (lpval);
1253 }
1254 }
1255 }
1256 }
1257
1258 /* Rebuild system configuration to reflect invoking system. */
1259 Vsystem_configuration = build_string (EMACS_CONFIGURATION);
1260
1261 /* Another special case: on NT, the PATH variable is actually named
1262 "Path" although cmd.exe (perhaps NT itself) arranges for
1263 environment variable lookup and setting to be case insensitive.
1264 However, Emacs assumes a fully case sensitive environment, so we
1265 need to change "Path" to "PATH" to match the expectations of
1266 various elisp packages. We do this by the sneaky method of
1267 modifying the string in the C runtime environ entry.
1268
1269 The same applies to COMSPEC. */
1270 {
1271 char ** envp;
1272
1273 for (envp = environ; *envp; envp++)
1274 if (_strnicmp (*envp, "PATH=", 5) == 0)
1275 memcpy (*envp, "PATH=", 5);
1276 else if (_strnicmp (*envp, "COMSPEC=", 8) == 0)
1277 memcpy (*envp, "COMSPEC=", 8);
1278 }
1279
1280 /* Remember the initial working directory for getwd, then make the
1281 real wd be the location of emacs.exe to avoid conflicts when
1282 renaming or deleting directories. (We also don't call chdir when
1283 running subprocesses for the same reason.) */
1284 if (!GetCurrentDirectory (MAXPATHLEN, startup_dir))
1285 abort ();
1286
1287 {
1288 char *p;
1289 static char modname[MAX_PATH];
1290
1291 if (!GetModuleFileName (NULL, modname, MAX_PATH))
1292 abort ();
1293 if ((p = strrchr (modname, '\\')) == NULL)
1294 abort ();
1295 *p = 0;
1296
1297 SetCurrentDirectory (modname);
1298
1299 /* Ensure argv[0] has the full path to Emacs. */
1300 *p = '\\';
1301 argv[0] = modname;
1302 }
1303
1304 /* Determine if there is a middle mouse button, to allow parse_button
1305 to decide whether right mouse events should be mouse-2 or
1306 mouse-3. */
1307 w32_num_mouse_buttons = GetSystemMetrics (SM_CMOUSEBUTTONS);
1308
1309 init_user_info ();
1310 }
1311
1312 char *
1313 emacs_root_dir (void)
1314 {
1315 static char root_dir[FILENAME_MAX];
1316 const char *p;
1317
1318 p = getenv ("emacs_dir");
1319 if (p == NULL)
1320 abort ();
1321 strcpy (root_dir, p);
1322 root_dir[parse_root (root_dir, NULL)] = '\0';
1323 dostounix_filename (root_dir);
1324 return root_dir;
1325 }
1326
1327 /* We don't have scripts to automatically determine the system configuration
1328 for Emacs before it's compiled, and we don't want to have to make the
1329 user enter it, so we define EMACS_CONFIGURATION to invoke this runtime
1330 routine. */
1331
1332 char *
1333 get_emacs_configuration (void)
1334 {
1335 char *arch, *oem, *os;
1336 int build_num;
1337 static char configuration_buffer[32];
1338
1339 /* Determine the processor type. */
1340 switch (get_processor_type ())
1341 {
1342
1343 #ifdef PROCESSOR_INTEL_386
1344 case PROCESSOR_INTEL_386:
1345 case PROCESSOR_INTEL_486:
1346 case PROCESSOR_INTEL_PENTIUM:
1347 arch = "i386";
1348 break;
1349 #endif
1350
1351 #ifdef PROCESSOR_MIPS_R2000
1352 case PROCESSOR_MIPS_R2000:
1353 case PROCESSOR_MIPS_R3000:
1354 case PROCESSOR_MIPS_R4000:
1355 arch = "mips";
1356 break;
1357 #endif
1358
1359 #ifdef PROCESSOR_ALPHA_21064
1360 case PROCESSOR_ALPHA_21064:
1361 arch = "alpha";
1362 break;
1363 #endif
1364
1365 default:
1366 arch = "unknown";
1367 break;
1368 }
1369
1370 /* Use the OEM field to reflect the compiler/library combination. */
1371 #ifdef _MSC_VER
1372 #define COMPILER_NAME "msvc"
1373 #else
1374 #ifdef __GNUC__
1375 #define COMPILER_NAME "mingw"
1376 #else
1377 #define COMPILER_NAME "unknown"
1378 #endif
1379 #endif
1380 oem = COMPILER_NAME;
1381
1382 switch (osinfo_cache.dwPlatformId) {
1383 case VER_PLATFORM_WIN32_NT:
1384 os = "nt";
1385 build_num = osinfo_cache.dwBuildNumber;
1386 break;
1387 case VER_PLATFORM_WIN32_WINDOWS:
1388 if (osinfo_cache.dwMinorVersion == 0) {
1389 os = "windows95";
1390 } else {
1391 os = "windows98";
1392 }
1393 build_num = LOWORD (osinfo_cache.dwBuildNumber);
1394 break;
1395 case VER_PLATFORM_WIN32s:
1396 /* Not supported, should not happen. */
1397 os = "windows32s";
1398 build_num = LOWORD (osinfo_cache.dwBuildNumber);
1399 break;
1400 default:
1401 os = "unknown";
1402 build_num = 0;
1403 break;
1404 }
1405
1406 if (osinfo_cache.dwPlatformId == VER_PLATFORM_WIN32_NT) {
1407 sprintf (configuration_buffer, "%s-%s-%s%d.%d.%d", arch, oem, os,
1408 get_w32_major_version (), get_w32_minor_version (), build_num);
1409 } else {
1410 sprintf (configuration_buffer, "%s-%s-%s.%d", arch, oem, os, build_num);
1411 }
1412
1413 return configuration_buffer;
1414 }
1415
1416 char *
1417 get_emacs_configuration_options (void)
1418 {
1419 static char options_buffer[256];
1420
1421 /* Work out the effective configure options for this build. */
1422 #ifdef _MSC_VER
1423 #define COMPILER_VERSION "--with-msvc (%d.%02d)", _MSC_VER / 100, _MSC_VER % 100
1424 #else
1425 #ifdef __GNUC__
1426 #define COMPILER_VERSION "--with-gcc (%d.%d)", __GNUC__, __GNUC_MINOR__
1427 #else
1428 #define COMPILER_VERSION ""
1429 #endif
1430 #endif
1431
1432 sprintf (options_buffer, COMPILER_VERSION);
1433 #ifdef EMACSDEBUG
1434 strcat (options_buffer, " --no-opt");
1435 #endif
1436 #ifdef USER_CFLAGS
1437 strcat (options_buffer, " --cflags");
1438 strcat (options_buffer, USER_CFLAGS);
1439 #endif
1440 #ifdef USER_LDFLAGS
1441 strcat (options_buffer, " --ldflags");
1442 strcat (options_buffer, USER_LDFLAGS);
1443 #endif
1444 return options_buffer;
1445 }
1446
1447
1448 #include <sys/timeb.h>
1449
1450 /* Emulate gettimeofday (Ulrich Leodolter, 1/11/95). */
1451 void
1452 gettimeofday (struct timeval *tv, struct timezone *tz)
1453 {
1454 struct _timeb tb;
1455 _ftime (&tb);
1456
1457 tv->tv_sec = tb.time;
1458 tv->tv_usec = tb.millitm * 1000L;
1459 if (tz)
1460 {
1461 tz->tz_minuteswest = tb.timezone; /* minutes west of Greenwich */
1462 tz->tz_dsttime = tb.dstflag; /* type of dst correction */
1463 }
1464 }
1465
1466 /* ------------------------------------------------------------------------- */
1467 /* IO support and wrapper functions for W32 API. */
1468 /* ------------------------------------------------------------------------- */
1469
1470 /* Place a wrapper around the MSVC version of ctime. It returns NULL
1471 on network directories, so we handle that case here.
1472 (Ulrich Leodolter, 1/11/95). */
1473 char *
1474 sys_ctime (const time_t *t)
1475 {
1476 char *str = (char *) ctime (t);
1477 return (str ? str : "Sun Jan 01 00:00:00 1970");
1478 }
1479
1480 /* Emulate sleep...we could have done this with a define, but that
1481 would necessitate including windows.h in the files that used it.
1482 This is much easier. */
1483 void
1484 sys_sleep (int seconds)
1485 {
1486 Sleep (seconds * 1000);
1487 }
1488
1489 /* Internal MSVC functions for low-level descriptor munging */
1490 extern int __cdecl _set_osfhnd (int fd, long h);
1491 extern int __cdecl _free_osfhnd (int fd);
1492
1493 /* parallel array of private info on file handles */
1494 filedesc fd_info [ MAXDESC ];
1495
1496 typedef struct volume_info_data {
1497 struct volume_info_data * next;
1498
1499 /* time when info was obtained */
1500 DWORD timestamp;
1501
1502 /* actual volume info */
1503 char * root_dir;
1504 DWORD serialnum;
1505 DWORD maxcomp;
1506 DWORD flags;
1507 char * name;
1508 char * type;
1509 } volume_info_data;
1510
1511 /* Global referenced by various functions. */
1512 static volume_info_data volume_info;
1513
1514 /* Vector to indicate which drives are local and fixed (for which cached
1515 data never expires). */
1516 static BOOL fixed_drives[26];
1517
1518 /* Consider cached volume information to be stale if older than 10s,
1519 at least for non-local drives. Info for fixed drives is never stale. */
1520 #define DRIVE_INDEX( c ) ( (c) <= 'Z' ? (c) - 'A' : (c) - 'a' )
1521 #define VOLINFO_STILL_VALID( root_dir, info ) \
1522 ( ( isalpha (root_dir[0]) && \
1523 fixed_drives[ DRIVE_INDEX (root_dir[0]) ] ) \
1524 || GetTickCount () - info->timestamp < 10000 )
1525
1526 /* Cache support functions. */
1527
1528 /* Simple linked list with linear search is sufficient. */
1529 static volume_info_data *volume_cache = NULL;
1530
1531 static volume_info_data *
1532 lookup_volume_info (char * root_dir)
1533 {
1534 volume_info_data * info;
1535
1536 for (info = volume_cache; info; info = info->next)
1537 if (stricmp (info->root_dir, root_dir) == 0)
1538 break;
1539 return info;
1540 }
1541
1542 static void
1543 add_volume_info (char * root_dir, volume_info_data * info)
1544 {
1545 info->root_dir = xstrdup (root_dir);
1546 info->next = volume_cache;
1547 volume_cache = info;
1548 }
1549
1550
1551 /* Wrapper for GetVolumeInformation, which uses caching to avoid
1552 performance penalty (~2ms on 486 for local drives, 7.5ms for local
1553 cdrom drive, ~5-10ms or more for remote drives on LAN). */
1554 volume_info_data *
1555 GetCachedVolumeInformation (char * root_dir)
1556 {
1557 volume_info_data * info;
1558 char default_root[ MAX_PATH ];
1559
1560 /* NULL for root_dir means use root from current directory. */
1561 if (root_dir == NULL)
1562 {
1563 if (GetCurrentDirectory (MAX_PATH, default_root) == 0)
1564 return NULL;
1565 parse_root (default_root, &root_dir);
1566 *root_dir = 0;
1567 root_dir = default_root;
1568 }
1569
1570 /* Local fixed drives can be cached permanently. Removable drives
1571 cannot be cached permanently, since the volume name and serial
1572 number (if nothing else) can change. Remote drives should be
1573 treated as if they are removable, since there is no sure way to
1574 tell whether they are or not. Also, the UNC association of drive
1575 letters mapped to remote volumes can be changed at any time (even
1576 by other processes) without notice.
1577
1578 As a compromise, so we can benefit from caching info for remote
1579 volumes, we use a simple expiry mechanism to invalidate cache
1580 entries that are more than ten seconds old. */
1581
1582 #if 0
1583 /* No point doing this, because WNetGetConnection is even slower than
1584 GetVolumeInformation, consistently taking ~50ms on a 486 (FWIW,
1585 GetDriveType is about the only call of this type which does not
1586 involve network access, and so is extremely quick). */
1587
1588 /* Map drive letter to UNC if remote. */
1589 if ( isalpha( root_dir[0] ) && !fixed[ DRIVE_INDEX( root_dir[0] ) ] )
1590 {
1591 char remote_name[ 256 ];
1592 char drive[3] = { root_dir[0], ':' };
1593
1594 if (WNetGetConnection (drive, remote_name, sizeof (remote_name))
1595 == NO_ERROR)
1596 /* do something */ ;
1597 }
1598 #endif
1599
1600 info = lookup_volume_info (root_dir);
1601
1602 if (info == NULL || ! VOLINFO_STILL_VALID (root_dir, info))
1603 {
1604 char name[ 256 ];
1605 DWORD serialnum;
1606 DWORD maxcomp;
1607 DWORD flags;
1608 char type[ 256 ];
1609
1610 /* Info is not cached, or is stale. */
1611 if (!GetVolumeInformation (root_dir,
1612 name, sizeof (name),
1613 &serialnum,
1614 &maxcomp,
1615 &flags,
1616 type, sizeof (type)))
1617 return NULL;
1618
1619 /* Cache the volume information for future use, overwriting existing
1620 entry if present. */
1621 if (info == NULL)
1622 {
1623 info = (volume_info_data *) xmalloc (sizeof (volume_info_data));
1624 add_volume_info (root_dir, info);
1625 }
1626 else
1627 {
1628 xfree (info->name);
1629 xfree (info->type);
1630 }
1631
1632 info->name = xstrdup (name);
1633 info->serialnum = serialnum;
1634 info->maxcomp = maxcomp;
1635 info->flags = flags;
1636 info->type = xstrdup (type);
1637 info->timestamp = GetTickCount ();
1638 }
1639
1640 return info;
1641 }
1642
1643 /* Get information on the volume where name is held; set path pointer to
1644 start of pathname in name (past UNC header\volume header if present). */
1645 int
1646 get_volume_info (const char * name, const char ** pPath)
1647 {
1648 char temp[MAX_PATH];
1649 char *rootname = NULL; /* default to current volume */
1650 volume_info_data * info;
1651
1652 if (name == NULL)
1653 return FALSE;
1654
1655 /* find the root name of the volume if given */
1656 if (isalpha (name[0]) && name[1] == ':')
1657 {
1658 rootname = temp;
1659 temp[0] = *name++;
1660 temp[1] = *name++;
1661 temp[2] = '\\';
1662 temp[3] = 0;
1663 }
1664 else if (IS_DIRECTORY_SEP (name[0]) && IS_DIRECTORY_SEP (name[1]))
1665 {
1666 char *str = temp;
1667 int slashes = 4;
1668 rootname = temp;
1669 do
1670 {
1671 if (IS_DIRECTORY_SEP (*name) && --slashes == 0)
1672 break;
1673 *str++ = *name++;
1674 }
1675 while ( *name );
1676
1677 *str++ = '\\';
1678 *str = 0;
1679 }
1680
1681 if (pPath)
1682 *pPath = name;
1683
1684 info = GetCachedVolumeInformation (rootname);
1685 if (info != NULL)
1686 {
1687 /* Set global referenced by other functions. */
1688 volume_info = *info;
1689 return TRUE;
1690 }
1691 return FALSE;
1692 }
1693
1694 /* Determine if volume is FAT format (ie. only supports short 8.3
1695 names); also set path pointer to start of pathname in name. */
1696 int
1697 is_fat_volume (const char * name, const char ** pPath)
1698 {
1699 if (get_volume_info (name, pPath))
1700 return (volume_info.maxcomp == 12);
1701 return FALSE;
1702 }
1703
1704 /* Map filename to a valid 8.3 name if necessary. */
1705 const char *
1706 map_w32_filename (const char * name, const char ** pPath)
1707 {
1708 static char shortname[MAX_PATH];
1709 char * str = shortname;
1710 char c;
1711 char * path;
1712 const char * save_name = name;
1713
1714 if (strlen (name) >= MAX_PATH)
1715 {
1716 /* Return a filename which will cause callers to fail. */
1717 strcpy (shortname, "?");
1718 return shortname;
1719 }
1720
1721 if (is_fat_volume (name, (const char **)&path)) /* truncate to 8.3 */
1722 {
1723 register int left = 8; /* maximum number of chars in part */
1724 register int extn = 0; /* extension added? */
1725 register int dots = 2; /* maximum number of dots allowed */
1726
1727 while (name < path)
1728 *str++ = *name++; /* skip past UNC header */
1729
1730 while ((c = *name++))
1731 {
1732 switch ( c )
1733 {
1734 case '\\':
1735 case '/':
1736 *str++ = '\\';
1737 extn = 0; /* reset extension flags */
1738 dots = 2; /* max 2 dots */
1739 left = 8; /* max length 8 for main part */
1740 break;
1741 case ':':
1742 *str++ = ':';
1743 extn = 0; /* reset extension flags */
1744 dots = 2; /* max 2 dots */
1745 left = 8; /* max length 8 for main part */
1746 break;
1747 case '.':
1748 if ( dots )
1749 {
1750 /* Convert path components of the form .xxx to _xxx,
1751 but leave . and .. as they are. This allows .emacs
1752 to be read as _emacs, for example. */
1753
1754 if (! *name ||
1755 *name == '.' ||
1756 IS_DIRECTORY_SEP (*name))
1757 {
1758 *str++ = '.';
1759 dots--;
1760 }
1761 else
1762 {
1763 *str++ = '_';
1764 left--;
1765 dots = 0;
1766 }
1767 }
1768 else if ( !extn )
1769 {
1770 *str++ = '.';
1771 extn = 1; /* we've got an extension */
1772 left = 3; /* 3 chars in extension */
1773 }
1774 else
1775 {
1776 /* any embedded dots after the first are converted to _ */
1777 *str++ = '_';
1778 }
1779 break;
1780 case '~':
1781 case '#': /* don't lose these, they're important */
1782 if ( ! left )
1783 str[-1] = c; /* replace last character of part */
1784 /* FALLTHRU */
1785 default:
1786 if ( left )
1787 {
1788 *str++ = tolower (c); /* map to lower case (looks nicer) */
1789 left--;
1790 dots = 0; /* started a path component */
1791 }
1792 break;
1793 }
1794 }
1795 *str = '\0';
1796 }
1797 else
1798 {
1799 strcpy (shortname, name);
1800 unixtodos_filename (shortname);
1801 }
1802
1803 if (pPath)
1804 *pPath = shortname + (path - save_name);
1805
1806 return shortname;
1807 }
1808
1809 static int
1810 is_exec (const char * name)
1811 {
1812 char * p = strrchr (name, '.');
1813 return
1814 (p != NULL
1815 && (stricmp (p, ".exe") == 0 ||
1816 stricmp (p, ".com") == 0 ||
1817 stricmp (p, ".bat") == 0 ||
1818 stricmp (p, ".cmd") == 0));
1819 }
1820
1821 /* Emulate the Unix directory procedures opendir, closedir,
1822 and readdir. We can't use the procedures supplied in sysdep.c,
1823 so we provide them here. */
1824
1825 struct direct dir_static; /* simulated directory contents */
1826 static HANDLE dir_find_handle = INVALID_HANDLE_VALUE;
1827 static int dir_is_fat;
1828 static char dir_pathname[MAXPATHLEN+1];
1829 static WIN32_FIND_DATA dir_find_data;
1830
1831 /* Support shares on a network resource as subdirectories of a read-only
1832 root directory. */
1833 static HANDLE wnet_enum_handle = INVALID_HANDLE_VALUE;
1834 HANDLE open_unc_volume (const char *);
1835 char *read_unc_volume (HANDLE, char *, int);
1836 void close_unc_volume (HANDLE);
1837
1838 DIR *
1839 opendir (char *filename)
1840 {
1841 DIR *dirp;
1842
1843 /* Opening is done by FindFirstFile. However, a read is inherent to
1844 this operation, so we defer the open until read time. */
1845
1846 if (dir_find_handle != INVALID_HANDLE_VALUE)
1847 return NULL;
1848 if (wnet_enum_handle != INVALID_HANDLE_VALUE)
1849 return NULL;
1850
1851 if (is_unc_volume (filename))
1852 {
1853 wnet_enum_handle = open_unc_volume (filename);
1854 if (wnet_enum_handle == INVALID_HANDLE_VALUE)
1855 return NULL;
1856 }
1857
1858 if (!(dirp = (DIR *) malloc (sizeof (DIR))))
1859 return NULL;
1860
1861 dirp->dd_fd = 0;
1862 dirp->dd_loc = 0;
1863 dirp->dd_size = 0;
1864
1865 strncpy (dir_pathname, map_w32_filename (filename, NULL), MAXPATHLEN);
1866 dir_pathname[MAXPATHLEN] = '\0';
1867 dir_is_fat = is_fat_volume (filename, NULL);
1868
1869 return dirp;
1870 }
1871
1872 void
1873 closedir (DIR *dirp)
1874 {
1875 /* If we have a find-handle open, close it. */
1876 if (dir_find_handle != INVALID_HANDLE_VALUE)
1877 {
1878 FindClose (dir_find_handle);
1879 dir_find_handle = INVALID_HANDLE_VALUE;
1880 }
1881 else if (wnet_enum_handle != INVALID_HANDLE_VALUE)
1882 {
1883 close_unc_volume (wnet_enum_handle);
1884 wnet_enum_handle = INVALID_HANDLE_VALUE;
1885 }
1886 xfree ((char *) dirp);
1887 }
1888
1889 struct direct *
1890 readdir (DIR *dirp)
1891 {
1892 int downcase = !NILP (Vw32_downcase_file_names);
1893
1894 if (wnet_enum_handle != INVALID_HANDLE_VALUE)
1895 {
1896 if (!read_unc_volume (wnet_enum_handle,
1897 dir_find_data.cFileName,
1898 MAX_PATH))
1899 return NULL;
1900 }
1901 /* If we aren't dir_finding, do a find-first, otherwise do a find-next. */
1902 else if (dir_find_handle == INVALID_HANDLE_VALUE)
1903 {
1904 char filename[MAXNAMLEN + 3];
1905 int ln;
1906
1907 strcpy (filename, dir_pathname);
1908 ln = strlen (filename) - 1;
1909 if (!IS_DIRECTORY_SEP (filename[ln]))
1910 strcat (filename, "\\");
1911 strcat (filename, "*");
1912
1913 dir_find_handle = FindFirstFile (filename, &dir_find_data);
1914
1915 if (dir_find_handle == INVALID_HANDLE_VALUE)
1916 return NULL;
1917 }
1918 else
1919 {
1920 if (!FindNextFile (dir_find_handle, &dir_find_data))
1921 return NULL;
1922 }
1923
1924 /* Emacs never uses this value, so don't bother making it match
1925 value returned by stat(). */
1926 dir_static.d_ino = 1;
1927
1928 strcpy (dir_static.d_name, dir_find_data.cFileName);
1929
1930 /* If the file name in cFileName[] includes `?' characters, it means
1931 the original file name used characters that cannot be represented
1932 by the current ANSI codepage. To avoid total lossage, retrieve
1933 the short 8+3 alias of the long file name. */
1934 if (_mbspbrk (dir_static.d_name, "?"))
1935 {
1936 strcpy (dir_static.d_name, dir_find_data.cAlternateFileName);
1937 downcase = 1; /* 8+3 aliases are returned in all caps */
1938 }
1939 dir_static.d_namlen = strlen (dir_static.d_name);
1940 dir_static.d_reclen = sizeof (struct direct) - MAXNAMLEN + 3 +
1941 dir_static.d_namlen - dir_static.d_namlen % 4;
1942 if (dir_is_fat)
1943 _strlwr (dir_static.d_name);
1944 else if (downcase)
1945 {
1946 register char *p;
1947 for (p = dir_static.d_name; *p; p++)
1948 if (*p >= 'a' && *p <= 'z')
1949 break;
1950 if (!*p)
1951 _strlwr (dir_static.d_name);
1952 }
1953
1954 return &dir_static;
1955 }
1956
1957 HANDLE
1958 open_unc_volume (const char *path)
1959 {
1960 NETRESOURCE nr;
1961 HANDLE henum;
1962 int result;
1963
1964 nr.dwScope = RESOURCE_GLOBALNET;
1965 nr.dwType = RESOURCETYPE_DISK;
1966 nr.dwDisplayType = RESOURCEDISPLAYTYPE_SERVER;
1967 nr.dwUsage = RESOURCEUSAGE_CONTAINER;
1968 nr.lpLocalName = NULL;
1969 nr.lpRemoteName = (LPSTR)map_w32_filename (path, NULL);
1970 nr.lpComment = NULL;
1971 nr.lpProvider = NULL;
1972
1973 result = WNetOpenEnum(RESOURCE_GLOBALNET, RESOURCETYPE_DISK,
1974 RESOURCEUSAGE_CONNECTABLE, &nr, &henum);
1975
1976 if (result == NO_ERROR)
1977 return henum;
1978 else
1979 return INVALID_HANDLE_VALUE;
1980 }
1981
1982 char *
1983 read_unc_volume (HANDLE henum, char *readbuf, int size)
1984 {
1985 DWORD count;
1986 int result;
1987 DWORD bufsize = 512;
1988 char *buffer;
1989 char *ptr;
1990
1991 count = 1;
1992 buffer = alloca (bufsize);
1993 result = WNetEnumResource (wnet_enum_handle, &count, buffer, &bufsize);
1994 if (result != NO_ERROR)
1995 return NULL;
1996
1997 /* WNetEnumResource returns \\resource\share...skip forward to "share". */
1998 ptr = ((LPNETRESOURCE) buffer)->lpRemoteName;
1999 ptr += 2;
2000 while (*ptr && !IS_DIRECTORY_SEP (*ptr)) ptr++;
2001 ptr++;
2002
2003 strncpy (readbuf, ptr, size);
2004 return readbuf;
2005 }
2006
2007 void
2008 close_unc_volume (HANDLE henum)
2009 {
2010 if (henum != INVALID_HANDLE_VALUE)
2011 WNetCloseEnum (henum);
2012 }
2013
2014 DWORD
2015 unc_volume_file_attributes (const char *path)
2016 {
2017 HANDLE henum;
2018 DWORD attrs;
2019
2020 henum = open_unc_volume (path);
2021 if (henum == INVALID_HANDLE_VALUE)
2022 return -1;
2023
2024 attrs = FILE_ATTRIBUTE_READONLY | FILE_ATTRIBUTE_DIRECTORY;
2025
2026 close_unc_volume (henum);
2027
2028 return attrs;
2029 }
2030
2031 /* Ensure a network connection is authenticated. */
2032 static void
2033 logon_network_drive (const char *path)
2034 {
2035 NETRESOURCE resource;
2036 char share[MAX_PATH];
2037 int i, n_slashes;
2038
2039 /* Only logon to networked drives. */
2040 if (!IS_DIRECTORY_SEP (path[0]) || !IS_DIRECTORY_SEP (path[1]))
2041 return;
2042 n_slashes = 2;
2043 strncpy (share, path, MAX_PATH);
2044 /* Truncate to just server and share name. */
2045 for (i = 2; i < MAX_PATH; i++)
2046 {
2047 if (IS_DIRECTORY_SEP (share[i]) && ++n_slashes > 3)
2048 {
2049 share[i] = '\0';
2050 break;
2051 }
2052 }
2053
2054 resource.dwType = RESOURCETYPE_DISK;
2055 resource.lpLocalName = NULL;
2056 resource.lpRemoteName = share;
2057 resource.lpProvider = NULL;
2058
2059 WNetAddConnection2 (&resource, NULL, NULL, CONNECT_INTERACTIVE);
2060 }
2061
2062 /* Shadow some MSVC runtime functions to map requests for long filenames
2063 to reasonable short names if necessary. This was originally added to
2064 permit running Emacs on NT 3.1 on a FAT partition, which doesn't support
2065 long file names. */
2066
2067 int
2068 sys_access (const char * path, int mode)
2069 {
2070 DWORD attributes;
2071
2072 /* MSVC implementation doesn't recognize D_OK. */
2073 path = map_w32_filename (path, NULL);
2074 if (is_unc_volume (path))
2075 {
2076 attributes = unc_volume_file_attributes (path);
2077 if (attributes == -1) {
2078 errno = EACCES;
2079 return -1;
2080 }
2081 }
2082 else if ((attributes = GetFileAttributes (path)) == -1)
2083 {
2084 /* Should try mapping GetLastError to errno; for now just indicate
2085 that path doesn't exist. */
2086 errno = EACCES;
2087 return -1;
2088 }
2089 if ((mode & X_OK) != 0 && !is_exec (path))
2090 {
2091 errno = EACCES;
2092 return -1;
2093 }
2094 if ((mode & W_OK) != 0 && (attributes & FILE_ATTRIBUTE_READONLY) != 0)
2095 {
2096 errno = EACCES;
2097 return -1;
2098 }
2099 if ((mode & D_OK) != 0 && (attributes & FILE_ATTRIBUTE_DIRECTORY) == 0)
2100 {
2101 errno = EACCES;
2102 return -1;
2103 }
2104 return 0;
2105 }
2106
2107 int
2108 sys_chdir (const char * path)
2109 {
2110 return _chdir (map_w32_filename (path, NULL));
2111 }
2112
2113 int
2114 sys_chmod (const char * path, int mode)
2115 {
2116 return _chmod (map_w32_filename (path, NULL), mode);
2117 }
2118
2119 int
2120 sys_chown (const char *path, uid_t owner, gid_t group)
2121 {
2122 if (sys_chmod (path, _S_IREAD) == -1) /* check if file exists */
2123 return -1;
2124 return 0;
2125 }
2126
2127 int
2128 sys_creat (const char * path, int mode)
2129 {
2130 return _creat (map_w32_filename (path, NULL), mode);
2131 }
2132
2133 FILE *
2134 sys_fopen(const char * path, const char * mode)
2135 {
2136 int fd;
2137 int oflag;
2138 const char * mode_save = mode;
2139
2140 /* Force all file handles to be non-inheritable. This is necessary to
2141 ensure child processes don't unwittingly inherit handles that might
2142 prevent future file access. */
2143
2144 if (mode[0] == 'r')
2145 oflag = O_RDONLY;
2146 else if (mode[0] == 'w' || mode[0] == 'a')
2147 oflag = O_WRONLY | O_CREAT | O_TRUNC;
2148 else
2149 return NULL;
2150
2151 /* Only do simplistic option parsing. */
2152 while (*++mode)
2153 if (mode[0] == '+')
2154 {
2155 oflag &= ~(O_RDONLY | O_WRONLY);
2156 oflag |= O_RDWR;
2157 }
2158 else if (mode[0] == 'b')
2159 {
2160 oflag &= ~O_TEXT;
2161 oflag |= O_BINARY;
2162 }
2163 else if (mode[0] == 't')
2164 {
2165 oflag &= ~O_BINARY;
2166 oflag |= O_TEXT;
2167 }
2168 else break;
2169
2170 fd = _open (map_w32_filename (path, NULL), oflag | _O_NOINHERIT, 0644);
2171 if (fd < 0)
2172 return NULL;
2173
2174 return _fdopen (fd, mode_save);
2175 }
2176
2177 /* This only works on NTFS volumes, but is useful to have. */
2178 int
2179 sys_link (const char * old, const char * new)
2180 {
2181 HANDLE fileh;
2182 int result = -1;
2183 char oldname[MAX_PATH], newname[MAX_PATH];
2184
2185 if (old == NULL || new == NULL)
2186 {
2187 errno = ENOENT;
2188 return -1;
2189 }
2190
2191 strcpy (oldname, map_w32_filename (old, NULL));
2192 strcpy (newname, map_w32_filename (new, NULL));
2193
2194 fileh = CreateFile (oldname, 0, 0, NULL, OPEN_EXISTING,
2195 FILE_FLAG_BACKUP_SEMANTICS, NULL);
2196 if (fileh != INVALID_HANDLE_VALUE)
2197 {
2198 int wlen;
2199
2200 /* Confusingly, the "alternate" stream name field does not apply
2201 when restoring a hard link, and instead contains the actual
2202 stream data for the link (ie. the name of the link to create).
2203 The WIN32_STREAM_ID structure before the cStreamName field is
2204 the stream header, which is then immediately followed by the
2205 stream data. */
2206
2207 struct {
2208 WIN32_STREAM_ID wid;
2209 WCHAR wbuffer[MAX_PATH]; /* extra space for link name */
2210 } data;
2211
2212 wlen = MultiByteToWideChar (CP_ACP, MB_PRECOMPOSED, newname, -1,
2213 data.wid.cStreamName, MAX_PATH);
2214 if (wlen > 0)
2215 {
2216 LPVOID context = NULL;
2217 DWORD wbytes = 0;
2218
2219 data.wid.dwStreamId = BACKUP_LINK;
2220 data.wid.dwStreamAttributes = 0;
2221 data.wid.Size.LowPart = wlen * sizeof(WCHAR);
2222 data.wid.Size.HighPart = 0;
2223 data.wid.dwStreamNameSize = 0;
2224
2225 if (BackupWrite (fileh, (LPBYTE)&data,
2226 offsetof (WIN32_STREAM_ID, cStreamName)
2227 + data.wid.Size.LowPart,
2228 &wbytes, FALSE, FALSE, &context)
2229 && BackupWrite (fileh, NULL, 0, &wbytes, TRUE, FALSE, &context))
2230 {
2231 /* succeeded */
2232 result = 0;
2233 }
2234 else
2235 {
2236 /* Should try mapping GetLastError to errno; for now just
2237 indicate a general error (eg. links not supported). */
2238 errno = EINVAL; // perhaps EMLINK?
2239 }
2240 }
2241
2242 CloseHandle (fileh);
2243 }
2244 else
2245 errno = ENOENT;
2246
2247 return result;
2248 }
2249
2250 int
2251 sys_mkdir (const char * path)
2252 {
2253 return _mkdir (map_w32_filename (path, NULL));
2254 }
2255
2256 /* Because of long name mapping issues, we need to implement this
2257 ourselves. Also, MSVC's _mktemp returns NULL when it can't generate
2258 a unique name, instead of setting the input template to an empty
2259 string.
2260
2261 Standard algorithm seems to be use pid or tid with a letter on the
2262 front (in place of the 6 X's) and cycle through the letters to find a
2263 unique name. We extend that to allow any reasonable character as the
2264 first of the 6 X's. */
2265 char *
2266 sys_mktemp (char * template)
2267 {
2268 char * p;
2269 int i;
2270 unsigned uid = GetCurrentThreadId ();
2271 static char first_char[] = "abcdefghijklmnopqrstuvwyz0123456789!%-_@#";
2272
2273 if (template == NULL)
2274 return NULL;
2275 p = template + strlen (template);
2276 i = 5;
2277 /* replace up to the last 5 X's with uid in decimal */
2278 while (--p >= template && p[0] == 'X' && --i >= 0)
2279 {
2280 p[0] = '0' + uid % 10;
2281 uid /= 10;
2282 }
2283
2284 if (i < 0 && p[0] == 'X')
2285 {
2286 i = 0;
2287 do
2288 {
2289 int save_errno = errno;
2290 p[0] = first_char[i];
2291 if (sys_access (template, 0) < 0)
2292 {
2293 errno = save_errno;
2294 return template;
2295 }
2296 }
2297 while (++i < sizeof (first_char));
2298 }
2299
2300 /* Template is badly formed or else we can't generate a unique name,
2301 so return empty string */
2302 template[0] = 0;
2303 return template;
2304 }
2305
2306 int
2307 sys_open (const char * path, int oflag, int mode)
2308 {
2309 const char* mpath = map_w32_filename (path, NULL);
2310 /* Try to open file without _O_CREAT, to be able to write to hidden
2311 and system files. Force all file handles to be
2312 non-inheritable. */
2313 int res = _open (mpath, (oflag & ~_O_CREAT) | _O_NOINHERIT, mode);
2314 if (res >= 0)
2315 return res;
2316 return _open (mpath, oflag | _O_NOINHERIT, mode);
2317 }
2318
2319 int
2320 sys_rename (const char * oldname, const char * newname)
2321 {
2322 BOOL result;
2323 char temp[MAX_PATH];
2324
2325 /* MoveFile on Windows 95 doesn't correctly change the short file name
2326 alias in a number of circumstances (it is not easy to predict when
2327 just by looking at oldname and newname, unfortunately). In these
2328 cases, renaming through a temporary name avoids the problem.
2329
2330 A second problem on Windows 95 is that renaming through a temp name when
2331 newname is uppercase fails (the final long name ends up in
2332 lowercase, although the short alias might be uppercase) UNLESS the
2333 long temp name is not 8.3.
2334
2335 So, on Windows 95 we always rename through a temp name, and we make sure
2336 the temp name has a long extension to ensure correct renaming. */
2337
2338 strcpy (temp, map_w32_filename (oldname, NULL));
2339
2340 if (os_subtype == OS_WIN95)
2341 {
2342 char * o;
2343 char * p;
2344 int i = 0;
2345
2346 oldname = map_w32_filename (oldname, NULL);
2347 if (o = strrchr (oldname, '\\'))
2348 o++;
2349 else
2350 o = (char *) oldname;
2351
2352 if (p = strrchr (temp, '\\'))
2353 p++;
2354 else
2355 p = temp;
2356
2357 do
2358 {
2359 /* Force temp name to require a manufactured 8.3 alias - this
2360 seems to make the second rename work properly. */
2361 sprintf (p, "_.%s.%u", o, i);
2362 i++;
2363 result = rename (oldname, temp);
2364 }
2365 /* This loop must surely terminate! */
2366 while (result < 0 && errno == EEXIST);
2367 if (result < 0)
2368 return -1;
2369 }
2370
2371 /* Emulate Unix behaviour - newname is deleted if it already exists
2372 (at least if it is a file; don't do this for directories).
2373
2374 Since we mustn't do this if we are just changing the case of the
2375 file name (we would end up deleting the file we are trying to
2376 rename!), we let rename detect if the destination file already
2377 exists - that way we avoid the possible pitfalls of trying to
2378 determine ourselves whether two names really refer to the same
2379 file, which is not always possible in the general case. (Consider
2380 all the permutations of shared or subst'd drives, etc.) */
2381
2382 newname = map_w32_filename (newname, NULL);
2383 result = rename (temp, newname);
2384
2385 if (result < 0
2386 && errno == EEXIST
2387 && _chmod (newname, 0666) == 0
2388 && _unlink (newname) == 0)
2389 result = rename (temp, newname);
2390
2391 return result;
2392 }
2393
2394 int
2395 sys_rmdir (const char * path)
2396 {
2397 return _rmdir (map_w32_filename (path, NULL));
2398 }
2399
2400 int
2401 sys_unlink (const char * path)
2402 {
2403 path = map_w32_filename (path, NULL);
2404
2405 /* On Unix, unlink works without write permission. */
2406 _chmod (path, 0666);
2407 return _unlink (path);
2408 }
2409
2410 static FILETIME utc_base_ft;
2411 static long double utc_base;
2412 static int init = 0;
2413
2414 static time_t
2415 convert_time (FILETIME ft)
2416 {
2417 long double ret;
2418
2419 if (!init)
2420 {
2421 /* Determine the delta between 1-Jan-1601 and 1-Jan-1970. */
2422 SYSTEMTIME st;
2423
2424 st.wYear = 1970;
2425 st.wMonth = 1;
2426 st.wDay = 1;
2427 st.wHour = 0;
2428 st.wMinute = 0;
2429 st.wSecond = 0;
2430 st.wMilliseconds = 0;
2431
2432 SystemTimeToFileTime (&st, &utc_base_ft);
2433 utc_base = (long double) utc_base_ft.dwHighDateTime
2434 * 4096.0L * 1024.0L * 1024.0L + utc_base_ft.dwLowDateTime;
2435 init = 1;
2436 }
2437
2438 if (CompareFileTime (&ft, &utc_base_ft) < 0)
2439 return 0;
2440
2441 ret = (long double) ft.dwHighDateTime
2442 * 4096.0L * 1024.0L * 1024.0L + ft.dwLowDateTime;
2443 ret -= utc_base;
2444 return (time_t) (ret * 1e-7L);
2445 }
2446
2447 void
2448 convert_from_time_t (time_t time, FILETIME * pft)
2449 {
2450 long double tmp;
2451
2452 if (!init)
2453 {
2454 /* Determine the delta between 1-Jan-1601 and 1-Jan-1970. */
2455 SYSTEMTIME st;
2456
2457 st.wYear = 1970;
2458 st.wMonth = 1;
2459 st.wDay = 1;
2460 st.wHour = 0;
2461 st.wMinute = 0;
2462 st.wSecond = 0;
2463 st.wMilliseconds = 0;
2464
2465 SystemTimeToFileTime (&st, &utc_base_ft);
2466 utc_base = (long double) utc_base_ft.dwHighDateTime
2467 * 4096 * 1024 * 1024 + utc_base_ft.dwLowDateTime;
2468 init = 1;
2469 }
2470
2471 /* time in 100ns units since 1-Jan-1601 */
2472 tmp = (long double) time * 1e7 + utc_base;
2473 pft->dwHighDateTime = (DWORD) (tmp / (4096.0 * 1024 * 1024));
2474 pft->dwLowDateTime = (DWORD) (tmp - (4096.0 * 1024 * 1024) * pft->dwHighDateTime);
2475 }
2476
2477 #if 0
2478 /* No reason to keep this; faking inode values either by hashing or even
2479 using the file index from GetInformationByHandle, is not perfect and
2480 so by default Emacs doesn't use the inode values on Windows.
2481 Instead, we now determine file-truename correctly (except for
2482 possible drive aliasing etc). */
2483
2484 /* Modified version of "PJW" algorithm (see the "Dragon" compiler book). */
2485 static unsigned
2486 hashval (const unsigned char * str)
2487 {
2488 unsigned h = 0;
2489 while (*str)
2490 {
2491 h = (h << 4) + *str++;
2492 h ^= (h >> 28);
2493 }
2494 return h;
2495 }
2496
2497 /* Return the hash value of the canonical pathname, excluding the
2498 drive/UNC header, to get a hopefully unique inode number. */
2499 static DWORD
2500 generate_inode_val (const char * name)
2501 {
2502 char fullname[ MAX_PATH ];
2503 char * p;
2504 unsigned hash;
2505
2506 /* Get the truly canonical filename, if it exists. (Note: this
2507 doesn't resolve aliasing due to subst commands, or recognise hard
2508 links. */
2509 if (!w32_get_long_filename ((char *)name, fullname, MAX_PATH))
2510 abort ();
2511
2512 parse_root (fullname, &p);
2513 /* Normal W32 filesystems are still case insensitive. */
2514 _strlwr (p);
2515 return hashval (p);
2516 }
2517
2518 #endif
2519
2520 /* MSVC stat function can't cope with UNC names and has other bugs, so
2521 replace it with our own. This also allows us to calculate consistent
2522 inode values without hacks in the main Emacs code. */
2523 int
2524 stat (const char * path, struct stat * buf)
2525 {
2526 char *name, *r;
2527 WIN32_FIND_DATA wfd;
2528 HANDLE fh;
2529 DWORD fake_inode;
2530 int permission;
2531 int len;
2532 int rootdir = FALSE;
2533
2534 if (path == NULL || buf == NULL)
2535 {
2536 errno = EFAULT;
2537 return -1;
2538 }
2539
2540 name = (char *) map_w32_filename (path, &path);
2541 /* Must be valid filename, no wild cards or other invalid
2542 characters. We use _mbspbrk to support multibyte strings that
2543 might look to strpbrk as if they included literal *, ?, and other
2544 characters mentioned below that are disallowed by Windows
2545 filesystems. */
2546 if (_mbspbrk (name, "*?|<>\""))
2547 {
2548 errno = ENOENT;
2549 return -1;
2550 }
2551
2552 /* If name is "c:/.." or "/.." then stat "c:/" or "/". */
2553 r = IS_DEVICE_SEP (name[1]) ? &name[2] : name;
2554 if (IS_DIRECTORY_SEP (r[0]) && r[1] == '.' && r[2] == '.' && r[3] == '\0')
2555 {
2556 r[1] = r[2] = '\0';
2557 }
2558
2559 /* Remove trailing directory separator, unless name is the root
2560 directory of a drive or UNC volume in which case ensure there
2561 is a trailing separator. */
2562 len = strlen (name);
2563 rootdir = (path >= name + len - 1
2564 && (IS_DIRECTORY_SEP (*path) || *path == 0));
2565 name = strcpy (alloca (len + 2), name);
2566
2567 if (is_unc_volume (name))
2568 {
2569 DWORD attrs = unc_volume_file_attributes (name);
2570
2571 if (attrs == -1)
2572 return -1;
2573
2574 memset (&wfd, 0, sizeof (wfd));
2575 wfd.dwFileAttributes = attrs;
2576 wfd.ftCreationTime = utc_base_ft;
2577 wfd.ftLastAccessTime = utc_base_ft;
2578 wfd.ftLastWriteTime = utc_base_ft;
2579 strcpy (wfd.cFileName, name);
2580 }
2581 else if (rootdir)
2582 {
2583 if (!IS_DIRECTORY_SEP (name[len-1]))
2584 strcat (name, "\\");
2585 if (GetDriveType (name) < 2)
2586 {
2587 errno = ENOENT;
2588 return -1;
2589 }
2590 memset (&wfd, 0, sizeof (wfd));
2591 wfd.dwFileAttributes = FILE_ATTRIBUTE_DIRECTORY;
2592 wfd.ftCreationTime = utc_base_ft;
2593 wfd.ftLastAccessTime = utc_base_ft;
2594 wfd.ftLastWriteTime = utc_base_ft;
2595 strcpy (wfd.cFileName, name);
2596 }
2597 else
2598 {
2599 if (IS_DIRECTORY_SEP (name[len-1]))
2600 name[len - 1] = 0;
2601
2602 /* (This is hacky, but helps when doing file completions on
2603 network drives.) Optimize by using information available from
2604 active readdir if possible. */
2605 len = strlen (dir_pathname);
2606 if (IS_DIRECTORY_SEP (dir_pathname[len-1]))
2607 len--;
2608 if (dir_find_handle != INVALID_HANDLE_VALUE
2609 && strnicmp (name, dir_pathname, len) == 0
2610 && IS_DIRECTORY_SEP (name[len])
2611 && stricmp (name + len + 1, dir_static.d_name) == 0)
2612 {
2613 /* This was the last entry returned by readdir. */
2614 wfd = dir_find_data;
2615 }
2616 else
2617 {
2618 logon_network_drive (name);
2619
2620 fh = FindFirstFile (name, &wfd);
2621 if (fh == INVALID_HANDLE_VALUE)
2622 {
2623 errno = ENOENT;
2624 return -1;
2625 }
2626 FindClose (fh);
2627 }
2628 }
2629
2630 if (!NILP (Vw32_get_true_file_attributes)
2631 /* No access rights required to get info. */
2632 && (fh = CreateFile (name, 0, 0, NULL, OPEN_EXISTING,
2633 FILE_FLAG_BACKUP_SEMANTICS, NULL))
2634 != INVALID_HANDLE_VALUE)
2635 {
2636 /* This is more accurate in terms of gettting the correct number
2637 of links, but is quite slow (it is noticeable when Emacs is
2638 making a list of file name completions). */
2639 BY_HANDLE_FILE_INFORMATION info;
2640
2641 if (GetFileInformationByHandle (fh, &info))
2642 {
2643 buf->st_nlink = info.nNumberOfLinks;
2644 /* Might as well use file index to fake inode values, but this
2645 is not guaranteed to be unique unless we keep a handle open
2646 all the time (even then there are situations where it is
2647 not unique). Reputedly, there are at most 48 bits of info
2648 (on NTFS, presumably less on FAT). */
2649 fake_inode = info.nFileIndexLow ^ info.nFileIndexHigh;
2650 }
2651 else
2652 {
2653 buf->st_nlink = 1;
2654 fake_inode = 0;
2655 }
2656
2657 if (wfd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
2658 {
2659 buf->st_mode = _S_IFDIR;
2660 }
2661 else
2662 {
2663 switch (GetFileType (fh))
2664 {
2665 case FILE_TYPE_DISK:
2666 buf->st_mode = _S_IFREG;
2667 break;
2668 case FILE_TYPE_PIPE:
2669 buf->st_mode = _S_IFIFO;
2670 break;
2671 case FILE_TYPE_CHAR:
2672 case FILE_TYPE_UNKNOWN:
2673 default:
2674 buf->st_mode = _S_IFCHR;
2675 }
2676 }
2677 CloseHandle (fh);
2678 }
2679 else
2680 {
2681 /* Don't bother to make this information more accurate. */
2682 buf->st_mode = (wfd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) ?
2683 _S_IFDIR : _S_IFREG;
2684 buf->st_nlink = 1;
2685 fake_inode = 0;
2686 }
2687
2688 #if 0
2689 /* Not sure if there is any point in this. */
2690 if (!NILP (Vw32_generate_fake_inodes))
2691 fake_inode = generate_inode_val (name);
2692 else if (fake_inode == 0)
2693 {
2694 /* For want of something better, try to make everything unique. */
2695 static DWORD gen_num = 0;
2696 fake_inode = ++gen_num;
2697 }
2698 #endif
2699
2700 /* MSVC defines _ino_t to be short; other libc's might not. */
2701 if (sizeof (buf->st_ino) == 2)
2702 buf->st_ino = fake_inode ^ (fake_inode >> 16);
2703 else
2704 buf->st_ino = fake_inode;
2705
2706 /* consider files to belong to current user */
2707 buf->st_uid = the_passwd.pw_uid;
2708 buf->st_gid = the_passwd.pw_gid;
2709
2710 /* volume_info is set indirectly by map_w32_filename */
2711 buf->st_dev = volume_info.serialnum;
2712 buf->st_rdev = volume_info.serialnum;
2713
2714
2715 buf->st_size = wfd.nFileSizeLow;
2716
2717 /* Convert timestamps to Unix format. */
2718 buf->st_mtime = convert_time (wfd.ftLastWriteTime);
2719 buf->st_atime = convert_time (wfd.ftLastAccessTime);
2720 if (buf->st_atime == 0) buf->st_atime = buf->st_mtime;
2721 buf->st_ctime = convert_time (wfd.ftCreationTime);
2722 if (buf->st_ctime == 0) buf->st_ctime = buf->st_mtime;
2723
2724 /* determine rwx permissions */
2725 if (wfd.dwFileAttributes & FILE_ATTRIBUTE_READONLY)
2726 permission = _S_IREAD;
2727 else
2728 permission = _S_IREAD | _S_IWRITE;
2729
2730 if (wfd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
2731 permission |= _S_IEXEC;
2732 else if (is_exec (name))
2733 permission |= _S_IEXEC;
2734
2735 buf->st_mode |= permission | (permission >> 3) | (permission >> 6);
2736
2737 return 0;
2738 }
2739
2740 /* Provide fstat and utime as well as stat for consistent handling of
2741 file timestamps. */
2742 int
2743 fstat (int desc, struct stat * buf)
2744 {
2745 HANDLE fh = (HANDLE) _get_osfhandle (desc);
2746 BY_HANDLE_FILE_INFORMATION info;
2747 DWORD fake_inode;
2748 int permission;
2749
2750 switch (GetFileType (fh) & ~FILE_TYPE_REMOTE)
2751 {
2752 case FILE_TYPE_DISK:
2753 buf->st_mode = _S_IFREG;
2754 if (!GetFileInformationByHandle (fh, &info))
2755 {
2756 errno = EACCES;
2757 return -1;
2758 }
2759 break;
2760 case FILE_TYPE_PIPE:
2761 buf->st_mode = _S_IFIFO;
2762 goto non_disk;
2763 case FILE_TYPE_CHAR:
2764 case FILE_TYPE_UNKNOWN:
2765 default:
2766 buf->st_mode = _S_IFCHR;
2767 non_disk:
2768 memset (&info, 0, sizeof (info));
2769 info.dwFileAttributes = 0;
2770 info.ftCreationTime = utc_base_ft;
2771 info.ftLastAccessTime = utc_base_ft;
2772 info.ftLastWriteTime = utc_base_ft;
2773 }
2774
2775 if (info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
2776 buf->st_mode = _S_IFDIR;
2777
2778 buf->st_nlink = info.nNumberOfLinks;
2779 /* Might as well use file index to fake inode values, but this
2780 is not guaranteed to be unique unless we keep a handle open
2781 all the time (even then there are situations where it is
2782 not unique). Reputedly, there are at most 48 bits of info
2783 (on NTFS, presumably less on FAT). */
2784 fake_inode = info.nFileIndexLow ^ info.nFileIndexHigh;
2785
2786 /* MSVC defines _ino_t to be short; other libc's might not. */
2787 if (sizeof (buf->st_ino) == 2)
2788 buf->st_ino = fake_inode ^ (fake_inode >> 16);
2789 else
2790 buf->st_ino = fake_inode;
2791
2792 /* consider files to belong to current user */
2793 buf->st_uid = the_passwd.pw_uid;
2794 buf->st_gid = the_passwd.pw_gid;
2795
2796 buf->st_dev = info.dwVolumeSerialNumber;
2797 buf->st_rdev = info.dwVolumeSerialNumber;
2798
2799 buf->st_size = info.nFileSizeLow;
2800
2801 /* Convert timestamps to Unix format. */
2802 buf->st_mtime = convert_time (info.ftLastWriteTime);
2803 buf->st_atime = convert_time (info.ftLastAccessTime);
2804 if (buf->st_atime == 0) buf->st_atime = buf->st_mtime;
2805 buf->st_ctime = convert_time (info.ftCreationTime);
2806 if (buf->st_ctime == 0) buf->st_ctime = buf->st_mtime;
2807
2808 /* determine rwx permissions */
2809 if (info.dwFileAttributes & FILE_ATTRIBUTE_READONLY)
2810 permission = _S_IREAD;
2811 else
2812 permission = _S_IREAD | _S_IWRITE;
2813
2814 if (info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
2815 permission |= _S_IEXEC;
2816 else
2817 {
2818 #if 0 /* no way of knowing the filename */
2819 char * p = strrchr (name, '.');
2820 if (p != NULL &&
2821 (stricmp (p, ".exe") == 0 ||
2822 stricmp (p, ".com") == 0 ||
2823 stricmp (p, ".bat") == 0 ||
2824 stricmp (p, ".cmd") == 0))
2825 permission |= _S_IEXEC;
2826 #endif
2827 }
2828
2829 buf->st_mode |= permission | (permission >> 3) | (permission >> 6);
2830
2831 return 0;
2832 }
2833
2834 int
2835 utime (const char *name, struct utimbuf *times)
2836 {
2837 struct utimbuf deftime;
2838 HANDLE fh;
2839 FILETIME mtime;
2840 FILETIME atime;
2841
2842 if (times == NULL)
2843 {
2844 deftime.modtime = deftime.actime = time (NULL);
2845 times = &deftime;
2846 }
2847
2848 /* Need write access to set times. */
2849 fh = CreateFile (name, GENERIC_WRITE, FILE_SHARE_READ | FILE_SHARE_WRITE,
2850 0, OPEN_EXISTING, 0, NULL);
2851 if (fh)
2852 {
2853 convert_from_time_t (times->actime, &atime);
2854 convert_from_time_t (times->modtime, &mtime);
2855 if (!SetFileTime (fh, NULL, &atime, &mtime))
2856 {
2857 CloseHandle (fh);
2858 errno = EACCES;
2859 return -1;
2860 }
2861 CloseHandle (fh);
2862 }
2863 else
2864 {
2865 errno = EINVAL;
2866 return -1;
2867 }
2868 return 0;
2869 }
2870
2871 #ifdef HAVE_SOCKETS
2872
2873 /* Wrappers for winsock functions to map between our file descriptors
2874 and winsock's handles; also set h_errno for convenience.
2875
2876 To allow Emacs to run on systems which don't have winsock support
2877 installed, we dynamically link to winsock on startup if present, and
2878 otherwise provide the minimum necessary functionality
2879 (eg. gethostname). */
2880
2881 /* function pointers for relevant socket functions */
2882 int (PASCAL *pfn_WSAStartup) (WORD wVersionRequired, LPWSADATA lpWSAData);
2883 void (PASCAL *pfn_WSASetLastError) (int iError);
2884 int (PASCAL *pfn_WSAGetLastError) (void);
2885 int (PASCAL *pfn_WSAEventSelect) (SOCKET s, HANDLE hEventObject, long lNetworkEvents);
2886 HANDLE (PASCAL *pfn_WSACreateEvent) (void);
2887 int (PASCAL *pfn_WSACloseEvent) (HANDLE hEvent);
2888 int (PASCAL *pfn_socket) (int af, int type, int protocol);
2889 int (PASCAL *pfn_bind) (SOCKET s, const struct sockaddr *addr, int namelen);
2890 int (PASCAL *pfn_connect) (SOCKET s, const struct sockaddr *addr, int namelen);
2891 int (PASCAL *pfn_ioctlsocket) (SOCKET s, long cmd, u_long *argp);
2892 int (PASCAL *pfn_recv) (SOCKET s, char * buf, int len, int flags);
2893 int (PASCAL *pfn_send) (SOCKET s, const char * buf, int len, int flags);
2894 int (PASCAL *pfn_closesocket) (SOCKET s);
2895 int (PASCAL *pfn_shutdown) (SOCKET s, int how);
2896 int (PASCAL *pfn_WSACleanup) (void);
2897
2898 u_short (PASCAL *pfn_htons) (u_short hostshort);
2899 u_short (PASCAL *pfn_ntohs) (u_short netshort);
2900 unsigned long (PASCAL *pfn_inet_addr) (const char * cp);
2901 int (PASCAL *pfn_gethostname) (char * name, int namelen);
2902 struct hostent * (PASCAL *pfn_gethostbyname) (const char * name);
2903 struct servent * (PASCAL *pfn_getservbyname) (const char * name, const char * proto);
2904 int (PASCAL *pfn_getpeername) (SOCKET s, struct sockaddr *addr, int * namelen);
2905 int (PASCAL *pfn_setsockopt) (SOCKET s, int level, int optname,
2906 const char * optval, int optlen);
2907 int (PASCAL *pfn_listen) (SOCKET s, int backlog);
2908 int (PASCAL *pfn_getsockname) (SOCKET s, struct sockaddr * name,
2909 int * namelen);
2910 SOCKET (PASCAL *pfn_accept) (SOCKET s, struct sockaddr * addr, int * addrlen);
2911 int (PASCAL *pfn_recvfrom) (SOCKET s, char * buf, int len, int flags,
2912 struct sockaddr * from, int * fromlen);
2913 int (PASCAL *pfn_sendto) (SOCKET s, const char * buf, int len, int flags,
2914 const struct sockaddr * to, int tolen);
2915
2916 /* SetHandleInformation is only needed to make sockets non-inheritable. */
2917 BOOL (WINAPI *pfn_SetHandleInformation) (HANDLE object, DWORD mask, DWORD flags);
2918 #ifndef HANDLE_FLAG_INHERIT
2919 #define HANDLE_FLAG_INHERIT 1
2920 #endif
2921
2922 HANDLE winsock_lib;
2923 static int winsock_inuse;
2924
2925 BOOL
2926 term_winsock (void)
2927 {
2928 if (winsock_lib != NULL && winsock_inuse == 0)
2929 {
2930 /* Not sure what would cause WSAENETDOWN, or even if it can happen
2931 after WSAStartup returns successfully, but it seems reasonable
2932 to allow unloading winsock anyway in that case. */
2933 if (pfn_WSACleanup () == 0 ||
2934 pfn_WSAGetLastError () == WSAENETDOWN)
2935 {
2936 if (FreeLibrary (winsock_lib))
2937 winsock_lib = NULL;
2938 return TRUE;
2939 }
2940 }
2941 return FALSE;
2942 }
2943
2944 BOOL
2945 init_winsock (int load_now)
2946 {
2947 WSADATA winsockData;
2948
2949 if (winsock_lib != NULL)
2950 return TRUE;
2951
2952 pfn_SetHandleInformation = NULL;
2953 pfn_SetHandleInformation
2954 = (void *) GetProcAddress (GetModuleHandle ("kernel32.dll"),
2955 "SetHandleInformation");
2956
2957 winsock_lib = LoadLibrary ("Ws2_32.dll");
2958
2959 if (winsock_lib != NULL)
2960 {
2961 /* dynamically link to socket functions */
2962
2963 #define LOAD_PROC(fn) \
2964 if ((pfn_##fn = (void *) GetProcAddress (winsock_lib, #fn)) == NULL) \
2965 goto fail;
2966
2967 LOAD_PROC( WSAStartup );
2968 LOAD_PROC( WSASetLastError );
2969 LOAD_PROC( WSAGetLastError );
2970 LOAD_PROC( WSAEventSelect );
2971 LOAD_PROC( WSACreateEvent );
2972 LOAD_PROC( WSACloseEvent );
2973 LOAD_PROC( socket );
2974 LOAD_PROC( bind );
2975 LOAD_PROC( connect );
2976 LOAD_PROC( ioctlsocket );
2977 LOAD_PROC( recv );
2978 LOAD_PROC( send );
2979 LOAD_PROC( closesocket );
2980 LOAD_PROC( shutdown );
2981 LOAD_PROC( htons );
2982 LOAD_PROC( ntohs );
2983 LOAD_PROC( inet_addr );
2984 LOAD_PROC( gethostname );
2985 LOAD_PROC( gethostbyname );
2986 LOAD_PROC( getservbyname );
2987 LOAD_PROC( getpeername );
2988 LOAD_PROC( WSACleanup );
2989 LOAD_PROC( setsockopt );
2990 LOAD_PROC( listen );
2991 LOAD_PROC( getsockname );
2992 LOAD_PROC( accept );
2993 LOAD_PROC( recvfrom );
2994 LOAD_PROC( sendto );
2995 #undef LOAD_PROC
2996
2997 /* specify version 1.1 of winsock */
2998 if (pfn_WSAStartup (0x101, &winsockData) == 0)
2999 {
3000 if (winsockData.wVersion != 0x101)
3001 goto fail;
3002
3003 if (!load_now)
3004 {
3005 /* Report that winsock exists and is usable, but leave
3006 socket functions disabled. I am assuming that calling
3007 WSAStartup does not require any network interaction,
3008 and in particular does not cause or require a dial-up
3009 connection to be established. */
3010
3011 pfn_WSACleanup ();
3012 FreeLibrary (winsock_lib);
3013 winsock_lib = NULL;
3014 }
3015 winsock_inuse = 0;
3016 return TRUE;
3017 }
3018
3019 fail:
3020 FreeLibrary (winsock_lib);
3021 winsock_lib = NULL;
3022 }
3023
3024 return FALSE;
3025 }
3026
3027
3028 int h_errno = 0;
3029
3030 /* function to set h_errno for compatability; map winsock error codes to
3031 normal system codes where they overlap (non-overlapping definitions
3032 are already in <sys/socket.h> */
3033 static void
3034 set_errno ()
3035 {
3036 if (winsock_lib == NULL)
3037 h_errno = EINVAL;
3038 else
3039 h_errno = pfn_WSAGetLastError ();
3040
3041 switch (h_errno)
3042 {
3043 case WSAEACCES: h_errno = EACCES; break;
3044 case WSAEBADF: h_errno = EBADF; break;
3045 case WSAEFAULT: h_errno = EFAULT; break;
3046 case WSAEINTR: h_errno = EINTR; break;
3047 case WSAEINVAL: h_errno = EINVAL; break;
3048 case WSAEMFILE: h_errno = EMFILE; break;
3049 case WSAENAMETOOLONG: h_errno = ENAMETOOLONG; break;
3050 case WSAENOTEMPTY: h_errno = ENOTEMPTY; break;
3051 }
3052 errno = h_errno;
3053 }
3054
3055 static void
3056 check_errno ()
3057 {
3058 if (h_errno == 0 && winsock_lib != NULL)
3059 pfn_WSASetLastError (0);
3060 }
3061
3062 /* Extend strerror to handle the winsock-specific error codes. */
3063 struct {
3064 int errnum;
3065 char * msg;
3066 } _wsa_errlist[] = {
3067 WSAEINTR , "Interrupted function call",
3068 WSAEBADF , "Bad file descriptor",
3069 WSAEACCES , "Permission denied",
3070 WSAEFAULT , "Bad address",
3071 WSAEINVAL , "Invalid argument",
3072 WSAEMFILE , "Too many open files",
3073
3074 WSAEWOULDBLOCK , "Resource temporarily unavailable",
3075 WSAEINPROGRESS , "Operation now in progress",
3076 WSAEALREADY , "Operation already in progress",
3077 WSAENOTSOCK , "Socket operation on non-socket",
3078 WSAEDESTADDRREQ , "Destination address required",
3079 WSAEMSGSIZE , "Message too long",
3080 WSAEPROTOTYPE , "Protocol wrong type for socket",
3081 WSAENOPROTOOPT , "Bad protocol option",
3082 WSAEPROTONOSUPPORT , "Protocol not supported",
3083 WSAESOCKTNOSUPPORT , "Socket type not supported",
3084 WSAEOPNOTSUPP , "Operation not supported",
3085 WSAEPFNOSUPPORT , "Protocol family not supported",
3086 WSAEAFNOSUPPORT , "Address family not supported by protocol family",
3087 WSAEADDRINUSE , "Address already in use",
3088 WSAEADDRNOTAVAIL , "Cannot assign requested address",
3089 WSAENETDOWN , "Network is down",
3090 WSAENETUNREACH , "Network is unreachable",
3091 WSAENETRESET , "Network dropped connection on reset",
3092 WSAECONNABORTED , "Software caused connection abort",
3093 WSAECONNRESET , "Connection reset by peer",
3094 WSAENOBUFS , "No buffer space available",
3095 WSAEISCONN , "Socket is already connected",
3096 WSAENOTCONN , "Socket is not connected",
3097 WSAESHUTDOWN , "Cannot send after socket shutdown",
3098 WSAETOOMANYREFS , "Too many references", /* not sure */
3099 WSAETIMEDOUT , "Connection timed out",
3100 WSAECONNREFUSED , "Connection refused",
3101 WSAELOOP , "Network loop", /* not sure */
3102 WSAENAMETOOLONG , "Name is too long",
3103 WSAEHOSTDOWN , "Host is down",
3104 WSAEHOSTUNREACH , "No route to host",
3105 WSAENOTEMPTY , "Buffer not empty", /* not sure */
3106 WSAEPROCLIM , "Too many processes",
3107 WSAEUSERS , "Too many users", /* not sure */
3108 WSAEDQUOT , "Double quote in host name", /* really not sure */
3109 WSAESTALE , "Data is stale", /* not sure */
3110 WSAEREMOTE , "Remote error", /* not sure */
3111
3112 WSASYSNOTREADY , "Network subsystem is unavailable",
3113 WSAVERNOTSUPPORTED , "WINSOCK.DLL version out of range",
3114 WSANOTINITIALISED , "Winsock not initialized successfully",
3115 WSAEDISCON , "Graceful shutdown in progress",
3116 #ifdef WSAENOMORE
3117 WSAENOMORE , "No more operations allowed", /* not sure */
3118 WSAECANCELLED , "Operation cancelled", /* not sure */
3119 WSAEINVALIDPROCTABLE , "Invalid procedure table from service provider",
3120 WSAEINVALIDPROVIDER , "Invalid service provider version number",
3121 WSAEPROVIDERFAILEDINIT , "Unable to initialize a service provider",
3122 WSASYSCALLFAILURE , "System call failure",
3123 WSASERVICE_NOT_FOUND , "Service not found", /* not sure */
3124 WSATYPE_NOT_FOUND , "Class type not found",
3125 WSA_E_NO_MORE , "No more resources available", /* really not sure */
3126 WSA_E_CANCELLED , "Operation already cancelled", /* really not sure */
3127 WSAEREFUSED , "Operation refused", /* not sure */
3128 #endif
3129
3130 WSAHOST_NOT_FOUND , "Host not found",
3131 WSATRY_AGAIN , "Authoritative host not found during name lookup",
3132 WSANO_RECOVERY , "Non-recoverable error during name lookup",
3133 WSANO_DATA , "Valid name, no data record of requested type",
3134
3135 -1, NULL
3136 };
3137
3138 char *
3139 sys_strerror(int error_no)
3140 {
3141 int i;
3142 static char unknown_msg[40];
3143
3144 if (error_no >= 0 && error_no < sys_nerr)
3145 return sys_errlist[error_no];
3146
3147 for (i = 0; _wsa_errlist[i].errnum >= 0; i++)
3148 if (_wsa_errlist[i].errnum == error_no)
3149 return _wsa_errlist[i].msg;
3150
3151 sprintf(unknown_msg, "Unidentified error: %d", error_no);
3152 return unknown_msg;
3153 }
3154
3155 /* [andrewi 3-May-96] I've had conflicting results using both methods,
3156 but I believe the method of keeping the socket handle separate (and
3157 insuring it is not inheritable) is the correct one. */
3158
3159 //#define SOCK_REPLACE_HANDLE
3160
3161 #ifdef SOCK_REPLACE_HANDLE
3162 #define SOCK_HANDLE(fd) ((SOCKET) _get_osfhandle (fd))
3163 #else
3164 #define SOCK_HANDLE(fd) ((SOCKET) fd_info[fd].hnd)
3165 #endif
3166
3167 int socket_to_fd (SOCKET s);
3168
3169 int
3170 sys_socket(int af, int type, int protocol)
3171 {
3172 SOCKET s;
3173
3174 if (winsock_lib == NULL)
3175 {
3176 h_errno = ENETDOWN;
3177 return INVALID_SOCKET;
3178 }
3179
3180 check_errno ();
3181
3182 /* call the real socket function */
3183 s = pfn_socket (af, type, protocol);
3184
3185 if (s != INVALID_SOCKET)
3186 return socket_to_fd (s);
3187
3188 set_errno ();
3189 return -1;
3190 }
3191
3192 /* Convert a SOCKET to a file descriptor. */
3193 int
3194 socket_to_fd (SOCKET s)
3195 {
3196 int fd;
3197 child_process * cp;
3198
3199 /* Although under NT 3.5 _open_osfhandle will accept a socket
3200 handle, if opened with SO_OPENTYPE == SO_SYNCHRONOUS_NONALERT,
3201 that does not work under NT 3.1. However, we can get the same
3202 effect by using a backdoor function to replace an existing
3203 descriptor handle with the one we want. */
3204
3205 /* allocate a file descriptor (with appropriate flags) */
3206 fd = _open ("NUL:", _O_RDWR);
3207 if (fd >= 0)
3208 {
3209 #ifdef SOCK_REPLACE_HANDLE
3210 /* now replace handle to NUL with our socket handle */
3211 CloseHandle ((HANDLE) _get_osfhandle (fd));
3212 _free_osfhnd (fd);
3213 _set_osfhnd (fd, s);
3214 /* setmode (fd, _O_BINARY); */
3215 #else
3216 /* Make a non-inheritable copy of the socket handle. Note
3217 that it is possible that sockets aren't actually kernel
3218 handles, which appears to be the case on Windows 9x when
3219 the MS Proxy winsock client is installed. */
3220 {
3221 /* Apparently there is a bug in NT 3.51 with some service
3222 packs, which prevents using DuplicateHandle to make a
3223 socket handle non-inheritable (causes WSACleanup to
3224 hang). The work-around is to use SetHandleInformation
3225 instead if it is available and implemented. */
3226 if (pfn_SetHandleInformation)
3227 {
3228 pfn_SetHandleInformation ((HANDLE) s, HANDLE_FLAG_INHERIT, 0);
3229 }
3230 else
3231 {
3232 HANDLE parent = GetCurrentProcess ();
3233 HANDLE new_s = INVALID_HANDLE_VALUE;
3234
3235 if (DuplicateHandle (parent,
3236 (HANDLE) s,
3237 parent,
3238 &new_s,
3239 0,
3240 FALSE,
3241 DUPLICATE_SAME_ACCESS))
3242 {
3243 /* It is possible that DuplicateHandle succeeds even
3244 though the socket wasn't really a kernel handle,
3245 because a real handle has the same value. So
3246 test whether the new handle really is a socket. */
3247 long nonblocking = 0;
3248 if (pfn_ioctlsocket ((SOCKET) new_s, FIONBIO, &nonblocking) == 0)
3249 {
3250 pfn_closesocket (s);
3251 s = (SOCKET) new_s;
3252 }
3253 else
3254 {
3255 CloseHandle (new_s);
3256 }
3257 }
3258 }
3259 }
3260 fd_info[fd].hnd = (HANDLE) s;
3261 #endif
3262
3263 /* set our own internal flags */
3264 fd_info[fd].flags = FILE_SOCKET | FILE_BINARY | FILE_READ | FILE_WRITE;
3265
3266 cp = new_child ();
3267 if (cp)
3268 {
3269 cp->fd = fd;
3270 cp->status = STATUS_READ_ACKNOWLEDGED;
3271
3272 /* attach child_process to fd_info */
3273 if (fd_info[ fd ].cp != NULL)
3274 {
3275 DebPrint (("sys_socket: fd_info[%d] apparently in use!\n", fd));
3276 abort ();
3277 }
3278
3279 fd_info[ fd ].cp = cp;
3280
3281 /* success! */
3282 winsock_inuse++; /* count open sockets */
3283 return fd;
3284 }
3285
3286 /* clean up */
3287 _close (fd);
3288 }
3289 pfn_closesocket (s);
3290 h_errno = EMFILE;
3291 return -1;
3292 }
3293
3294
3295 int
3296 sys_bind (int s, const struct sockaddr * addr, int namelen)
3297 {
3298 if (winsock_lib == NULL)
3299 {
3300 h_errno = ENOTSOCK;
3301 return SOCKET_ERROR;
3302 }
3303
3304 check_errno ();
3305 if (fd_info[s].flags & FILE_SOCKET)
3306 {
3307 int rc = pfn_bind (SOCK_HANDLE (s), addr, namelen);
3308 if (rc == SOCKET_ERROR)
3309 set_errno ();
3310 return rc;
3311 }
3312 h_errno = ENOTSOCK;
3313 return SOCKET_ERROR;
3314 }
3315
3316
3317 int
3318 sys_connect (int s, const struct sockaddr * name, int namelen)
3319 {
3320 if (winsock_lib == NULL)
3321 {
3322 h_errno = ENOTSOCK;
3323 return SOCKET_ERROR;
3324 }
3325
3326 check_errno ();
3327 if (fd_info[s].flags & FILE_SOCKET)
3328 {
3329 int rc = pfn_connect (SOCK_HANDLE (s), name, namelen);
3330 if (rc == SOCKET_ERROR)
3331 set_errno ();
3332 return rc;
3333 }
3334 h_errno = ENOTSOCK;
3335 return SOCKET_ERROR;
3336 }
3337
3338 u_short
3339 sys_htons (u_short hostshort)
3340 {
3341 return (winsock_lib != NULL) ?
3342 pfn_htons (hostshort) : hostshort;
3343 }
3344
3345 u_short
3346 sys_ntohs (u_short netshort)
3347 {
3348 return (winsock_lib != NULL) ?
3349 pfn_ntohs (netshort) : netshort;
3350 }
3351
3352 unsigned long
3353 sys_inet_addr (const char * cp)
3354 {
3355 return (winsock_lib != NULL) ?
3356 pfn_inet_addr (cp) : INADDR_NONE;
3357 }
3358
3359 int
3360 sys_gethostname (char * name, int namelen)
3361 {
3362 if (winsock_lib != NULL)
3363 return pfn_gethostname (name, namelen);
3364
3365 if (namelen > MAX_COMPUTERNAME_LENGTH)
3366 return !GetComputerName (name, (DWORD *)&namelen);
3367
3368 h_errno = EFAULT;
3369 return SOCKET_ERROR;
3370 }
3371
3372 struct hostent *
3373 sys_gethostbyname(const char * name)
3374 {
3375 struct hostent * host;
3376
3377 if (winsock_lib == NULL)
3378 {
3379 h_errno = ENETDOWN;
3380 return NULL;
3381 }
3382
3383 check_errno ();
3384 host = pfn_gethostbyname (name);
3385 if (!host)
3386 set_errno ();
3387 return host;
3388 }
3389
3390 struct servent *
3391 sys_getservbyname(const char * name, const char * proto)
3392 {
3393 struct servent * serv;
3394
3395 if (winsock_lib == NULL)
3396 {
3397 h_errno = ENETDOWN;
3398 return NULL;
3399 }
3400
3401 check_errno ();
3402 serv = pfn_getservbyname (name, proto);
3403 if (!serv)
3404 set_errno ();
3405 return serv;
3406 }
3407
3408 int
3409 sys_getpeername (int s, struct sockaddr *addr, int * namelen)
3410 {
3411 if (winsock_lib == NULL)
3412 {
3413 h_errno = ENETDOWN;
3414 return SOCKET_ERROR;
3415 }
3416
3417 check_errno ();
3418 if (fd_info[s].flags & FILE_SOCKET)
3419 {
3420 int rc = pfn_getpeername (SOCK_HANDLE (s), addr, namelen);
3421 if (rc == SOCKET_ERROR)
3422 set_errno ();
3423 return rc;
3424 }
3425 h_errno = ENOTSOCK;
3426 return SOCKET_ERROR;
3427 }
3428
3429
3430 int
3431 sys_shutdown (int s, int how)
3432 {
3433 if (winsock_lib == NULL)
3434 {
3435 h_errno = ENETDOWN;
3436 return SOCKET_ERROR;
3437 }
3438
3439 check_errno ();
3440 if (fd_info[s].flags & FILE_SOCKET)
3441 {
3442 int rc = pfn_shutdown (SOCK_HANDLE (s), how);
3443 if (rc == SOCKET_ERROR)
3444 set_errno ();
3445 return rc;
3446 }
3447 h_errno = ENOTSOCK;
3448 return SOCKET_ERROR;
3449 }
3450
3451 int
3452 sys_setsockopt (int s, int level, int optname, const void * optval, int optlen)
3453 {
3454 if (winsock_lib == NULL)
3455 {
3456 h_errno = ENETDOWN;
3457 return SOCKET_ERROR;
3458 }
3459
3460 check_errno ();
3461 if (fd_info[s].flags & FILE_SOCKET)
3462 {
3463 int rc = pfn_setsockopt (SOCK_HANDLE (s), level, optname,
3464 (const char *)optval, optlen);
3465 if (rc == SOCKET_ERROR)
3466 set_errno ();
3467 return rc;
3468 }
3469 h_errno = ENOTSOCK;
3470 return SOCKET_ERROR;
3471 }
3472
3473 int
3474 sys_listen (int s, int backlog)
3475 {
3476 if (winsock_lib == NULL)
3477 {
3478 h_errno = ENETDOWN;
3479 return SOCKET_ERROR;
3480 }
3481
3482 check_errno ();
3483 if (fd_info[s].flags & FILE_SOCKET)
3484 {
3485 int rc = pfn_listen (SOCK_HANDLE (s), backlog);
3486 if (rc == SOCKET_ERROR)
3487 set_errno ();
3488 else
3489 fd_info[s].flags |= FILE_LISTEN;
3490 return rc;
3491 }
3492 h_errno = ENOTSOCK;
3493 return SOCKET_ERROR;
3494 }
3495
3496 int
3497 sys_getsockname (int s, struct sockaddr * name, int * namelen)
3498 {
3499 if (winsock_lib == NULL)
3500 {
3501 h_errno = ENETDOWN;
3502 return SOCKET_ERROR;
3503 }
3504
3505 check_errno ();
3506 if (fd_info[s].flags & FILE_SOCKET)
3507 {
3508 int rc = pfn_getsockname (SOCK_HANDLE (s), name, namelen);
3509 if (rc == SOCKET_ERROR)
3510 set_errno ();
3511 return rc;
3512 }
3513 h_errno = ENOTSOCK;
3514 return SOCKET_ERROR;
3515 }
3516
3517 int
3518 sys_accept (int s, struct sockaddr * addr, int * addrlen)
3519 {
3520 if (winsock_lib == NULL)
3521 {
3522 h_errno = ENETDOWN;
3523 return -1;
3524 }
3525
3526 check_errno ();
3527 if (fd_info[s].flags & FILE_LISTEN)
3528 {
3529 SOCKET t = pfn_accept (SOCK_HANDLE (s), addr, addrlen);
3530 int fd = -1;
3531 if (t == INVALID_SOCKET)
3532 set_errno ();
3533 else
3534 fd = socket_to_fd (t);
3535
3536 fd_info[s].cp->status = STATUS_READ_ACKNOWLEDGED;
3537 ResetEvent (fd_info[s].cp->char_avail);
3538 return fd;
3539 }
3540 h_errno = ENOTSOCK;
3541 return -1;
3542 }
3543
3544 int
3545 sys_recvfrom (int s, char * buf, int len, int flags,
3546 struct sockaddr * from, int * fromlen)
3547 {
3548 if (winsock_lib == NULL)
3549 {
3550 h_errno = ENETDOWN;
3551 return SOCKET_ERROR;
3552 }
3553
3554 check_errno ();
3555 if (fd_info[s].flags & FILE_SOCKET)
3556 {
3557 int rc = pfn_recvfrom (SOCK_HANDLE (s), buf, len, flags, from, fromlen);
3558 if (rc == SOCKET_ERROR)
3559 set_errno ();
3560 return rc;
3561 }
3562 h_errno = ENOTSOCK;
3563 return SOCKET_ERROR;
3564 }
3565
3566 int
3567 sys_sendto (int s, const char * buf, int len, int flags,
3568 const struct sockaddr * to, int tolen)
3569 {
3570 if (winsock_lib == NULL)
3571 {
3572 h_errno = ENETDOWN;
3573 return SOCKET_ERROR;
3574 }
3575
3576 check_errno ();
3577 if (fd_info[s].flags & FILE_SOCKET)
3578 {
3579 int rc = pfn_sendto (SOCK_HANDLE (s), buf, len, flags, to, tolen);
3580 if (rc == SOCKET_ERROR)
3581 set_errno ();
3582 return rc;
3583 }
3584 h_errno = ENOTSOCK;
3585 return SOCKET_ERROR;
3586 }
3587
3588 /* Windows does not have an fcntl function. Provide an implementation
3589 solely for making sockets non-blocking. */
3590 int
3591 fcntl (int s, int cmd, int options)
3592 {
3593 if (winsock_lib == NULL)
3594 {
3595 h_errno = ENETDOWN;
3596 return -1;
3597 }
3598
3599 check_errno ();
3600 if (fd_info[s].flags & FILE_SOCKET)
3601 {
3602 if (cmd == F_SETFL && options == O_NDELAY)
3603 {
3604 unsigned long nblock = 1;
3605 int rc = pfn_ioctlsocket (SOCK_HANDLE (s), FIONBIO, &nblock);
3606 if (rc == SOCKET_ERROR)
3607 set_errno();
3608 /* Keep track of the fact that we set this to non-blocking. */
3609 fd_info[s].flags |= FILE_NDELAY;
3610 return rc;
3611 }
3612 else
3613 {
3614 h_errno = EINVAL;
3615 return SOCKET_ERROR;
3616 }
3617 }
3618 h_errno = ENOTSOCK;
3619 return SOCKET_ERROR;
3620 }
3621
3622 #endif /* HAVE_SOCKETS */
3623
3624
3625 /* Shadow main io functions: we need to handle pipes and sockets more
3626 intelligently, and implement non-blocking mode as well. */
3627
3628 int
3629 sys_close (int fd)
3630 {
3631 int rc;
3632
3633 if (fd < 0)
3634 {
3635 errno = EBADF;
3636 return -1;
3637 }
3638
3639 if (fd < MAXDESC && fd_info[fd].cp)
3640 {
3641 child_process * cp = fd_info[fd].cp;
3642
3643 fd_info[fd].cp = NULL;
3644
3645 if (CHILD_ACTIVE (cp))
3646 {
3647 /* if last descriptor to active child_process then cleanup */
3648 int i;
3649 for (i = 0; i < MAXDESC; i++)
3650 {
3651 if (i == fd)
3652 continue;
3653 if (fd_info[i].cp == cp)
3654 break;
3655 }
3656 if (i == MAXDESC)
3657 {
3658 #ifdef HAVE_SOCKETS
3659 if (fd_info[fd].flags & FILE_SOCKET)
3660 {
3661 #ifndef SOCK_REPLACE_HANDLE
3662 if (winsock_lib == NULL) abort ();
3663
3664 pfn_shutdown (SOCK_HANDLE (fd), 2);
3665 rc = pfn_closesocket (SOCK_HANDLE (fd));
3666 #endif
3667 winsock_inuse--; /* count open sockets */
3668 }
3669 #endif
3670 delete_child (cp);
3671 }
3672 }
3673 }
3674
3675 /* Note that sockets do not need special treatment here (at least on
3676 NT and Windows 95 using the standard tcp/ip stacks) - it appears that
3677 closesocket is equivalent to CloseHandle, which is to be expected
3678 because socket handles are fully fledged kernel handles. */
3679 rc = _close (fd);
3680
3681 if (rc == 0 && fd < MAXDESC)
3682 fd_info[fd].flags = 0;
3683
3684 return rc;
3685 }
3686
3687 int
3688 sys_dup (int fd)
3689 {
3690 int new_fd;
3691
3692 new_fd = _dup (fd);
3693 if (new_fd >= 0 && new_fd < MAXDESC)
3694 {
3695 /* duplicate our internal info as well */
3696 fd_info[new_fd] = fd_info[fd];
3697 }
3698 return new_fd;
3699 }
3700
3701
3702 int
3703 sys_dup2 (int src, int dst)
3704 {
3705 int rc;
3706
3707 if (dst < 0 || dst >= MAXDESC)
3708 {
3709 errno = EBADF;
3710 return -1;
3711 }
3712
3713 /* make sure we close the destination first if it's a pipe or socket */
3714 if (src != dst && fd_info[dst].flags != 0)
3715 sys_close (dst);
3716
3717 rc = _dup2 (src, dst);
3718 if (rc == 0)
3719 {
3720 /* duplicate our internal info as well */
3721 fd_info[dst] = fd_info[src];
3722 }
3723 return rc;
3724 }
3725
3726 /* Unix pipe() has only one arg */
3727 int
3728 sys_pipe (int * phandles)
3729 {
3730 int rc;
3731 unsigned flags;
3732
3733 /* make pipe handles non-inheritable; when we spawn a child, we
3734 replace the relevant handle with an inheritable one. Also put
3735 pipes into binary mode; we will do text mode translation ourselves
3736 if required. */
3737 rc = _pipe (phandles, 0, _O_NOINHERIT | _O_BINARY);
3738
3739 if (rc == 0)
3740 {
3741 /* Protect against overflow, since Windows can open more handles than
3742 our fd_info array has room for. */
3743 if (phandles[0] >= MAXDESC || phandles[1] >= MAXDESC)
3744 {
3745 _close (phandles[0]);
3746 _close (phandles[1]);
3747 rc = -1;
3748 }
3749 else
3750 {
3751 flags = FILE_PIPE | FILE_READ | FILE_BINARY;
3752 fd_info[phandles[0]].flags = flags;
3753
3754 flags = FILE_PIPE | FILE_WRITE | FILE_BINARY;
3755 fd_info[phandles[1]].flags = flags;
3756 }
3757 }
3758
3759 return rc;
3760 }
3761
3762 /* From ntproc.c */
3763 extern int w32_pipe_read_delay;
3764
3765 /* Function to do blocking read of one byte, needed to implement
3766 select. It is only allowed on sockets and pipes. */
3767 int
3768 _sys_read_ahead (int fd)
3769 {
3770 child_process * cp;
3771 int rc;
3772
3773 if (fd < 0 || fd >= MAXDESC)
3774 return STATUS_READ_ERROR;
3775
3776 cp = fd_info[fd].cp;
3777
3778 if (cp == NULL || cp->fd != fd || cp->status != STATUS_READ_READY)
3779 return STATUS_READ_ERROR;
3780
3781 if ((fd_info[fd].flags & (FILE_PIPE | FILE_SOCKET)) == 0
3782 || (fd_info[fd].flags & FILE_READ) == 0)
3783 {
3784 DebPrint (("_sys_read_ahead: internal error: fd %d is not a pipe or socket!\n", fd));
3785 abort ();
3786 }
3787
3788 cp->status = STATUS_READ_IN_PROGRESS;
3789
3790 if (fd_info[fd].flags & FILE_PIPE)
3791 {
3792 rc = _read (fd, &cp->chr, sizeof (char));
3793
3794 /* Give subprocess time to buffer some more output for us before
3795 reporting that input is available; we need this because Windows 95
3796 connects DOS programs to pipes by making the pipe appear to be
3797 the normal console stdout - as a result most DOS programs will
3798 write to stdout without buffering, ie. one character at a
3799 time. Even some W32 programs do this - "dir" in a command
3800 shell on NT is very slow if we don't do this. */
3801 if (rc > 0)
3802 {
3803 int wait = w32_pipe_read_delay;
3804
3805 if (wait > 0)
3806 Sleep (wait);
3807 else if (wait < 0)
3808 while (++wait <= 0)
3809 /* Yield remainder of our time slice, effectively giving a
3810 temporary priority boost to the child process. */
3811 Sleep (0);
3812 }
3813 }
3814 #ifdef HAVE_SOCKETS
3815 else if (fd_info[fd].flags & FILE_SOCKET)
3816 {
3817 unsigned long nblock = 0;
3818 /* We always want this to block, so temporarily disable NDELAY. */
3819 if (fd_info[fd].flags & FILE_NDELAY)
3820 pfn_ioctlsocket (SOCK_HANDLE (fd), FIONBIO, &nblock);
3821
3822 rc = pfn_recv (SOCK_HANDLE (fd), &cp->chr, sizeof (char), 0);
3823
3824 if (fd_info[fd].flags & FILE_NDELAY)
3825 {
3826 nblock = 1;
3827 pfn_ioctlsocket (SOCK_HANDLE (fd), FIONBIO, &nblock);
3828 }
3829 }
3830 #endif
3831
3832 if (rc == sizeof (char))
3833 cp->status = STATUS_READ_SUCCEEDED;
3834 else
3835 cp->status = STATUS_READ_FAILED;
3836
3837 return cp->status;
3838 }
3839
3840 int
3841 _sys_wait_accept (int fd)
3842 {
3843 HANDLE hEv;
3844 child_process * cp;
3845 int rc;
3846
3847 if (fd < 0 || fd >= MAXDESC)
3848 return STATUS_READ_ERROR;
3849
3850 cp = fd_info[fd].cp;
3851
3852 if (cp == NULL || cp->fd != fd || cp->status != STATUS_READ_READY)
3853 return STATUS_READ_ERROR;
3854
3855 cp->status = STATUS_READ_FAILED;
3856
3857 hEv = pfn_WSACreateEvent ();
3858 rc = pfn_WSAEventSelect (SOCK_HANDLE (fd), hEv, FD_ACCEPT);
3859 if (rc != SOCKET_ERROR)
3860 {
3861 rc = WaitForSingleObject (hEv, INFINITE);
3862 pfn_WSAEventSelect (SOCK_HANDLE (fd), NULL, 0);
3863 if (rc == WAIT_OBJECT_0)
3864 cp->status = STATUS_READ_SUCCEEDED;
3865 }
3866 pfn_WSACloseEvent (hEv);
3867
3868 return cp->status;
3869 }
3870
3871 int
3872 sys_read (int fd, char * buffer, unsigned int count)
3873 {
3874 int nchars;
3875 int to_read;
3876 DWORD waiting;
3877 char * orig_buffer = buffer;
3878
3879 if (fd < 0)
3880 {
3881 errno = EBADF;
3882 return -1;
3883 }
3884
3885 if (fd < MAXDESC && fd_info[fd].flags & (FILE_PIPE | FILE_SOCKET))
3886 {
3887 child_process *cp = fd_info[fd].cp;
3888
3889 if ((fd_info[fd].flags & FILE_READ) == 0)
3890 {
3891 errno = EBADF;
3892 return -1;
3893 }
3894
3895 nchars = 0;
3896
3897 /* re-read CR carried over from last read */
3898 if (fd_info[fd].flags & FILE_LAST_CR)
3899 {
3900 if (fd_info[fd].flags & FILE_BINARY) abort ();
3901 *buffer++ = 0x0d;
3902 count--;
3903 nchars++;
3904 fd_info[fd].flags &= ~FILE_LAST_CR;
3905 }
3906
3907 /* presence of a child_process structure means we are operating in
3908 non-blocking mode - otherwise we just call _read directly.
3909 Note that the child_process structure might be missing because
3910 reap_subprocess has been called; in this case the pipe is
3911 already broken, so calling _read on it is okay. */
3912 if (cp)
3913 {
3914 int current_status = cp->status;
3915
3916 switch (current_status)
3917 {
3918 case STATUS_READ_FAILED:
3919 case STATUS_READ_ERROR:
3920 /* report normal EOF if nothing in buffer */
3921 if (nchars <= 0)
3922 fd_info[fd].flags |= FILE_AT_EOF;
3923 return nchars;
3924
3925 case STATUS_READ_READY:
3926 case STATUS_READ_IN_PROGRESS:
3927 DebPrint (("sys_read called when read is in progress\n"));
3928 errno = EWOULDBLOCK;
3929 return -1;
3930
3931 case STATUS_READ_SUCCEEDED:
3932 /* consume read-ahead char */
3933 *buffer++ = cp->chr;
3934 count--;
3935 nchars++;
3936 cp->status = STATUS_READ_ACKNOWLEDGED;
3937 ResetEvent (cp->char_avail);
3938
3939 case STATUS_READ_ACKNOWLEDGED:
3940 break;
3941
3942 default:
3943 DebPrint (("sys_read: bad status %d\n", current_status));
3944 errno = EBADF;
3945 return -1;
3946 }
3947
3948 if (fd_info[fd].flags & FILE_PIPE)
3949 {
3950 PeekNamedPipe ((HANDLE) _get_osfhandle (fd), NULL, 0, NULL, &waiting, NULL);
3951 to_read = min (waiting, (DWORD) count);
3952
3953 if (to_read > 0)
3954 nchars += _read (fd, buffer, to_read);
3955 }
3956 #ifdef HAVE_SOCKETS
3957 else /* FILE_SOCKET */
3958 {
3959 if (winsock_lib == NULL) abort ();
3960
3961 /* do the equivalent of a non-blocking read */
3962 pfn_ioctlsocket (SOCK_HANDLE (fd), FIONREAD, &waiting);
3963 if (waiting == 0 && nchars == 0)
3964 {
3965 h_errno = errno = EWOULDBLOCK;
3966 return -1;
3967 }
3968
3969 if (waiting)
3970 {
3971 /* always use binary mode for sockets */
3972 int res = pfn_recv (SOCK_HANDLE (fd), buffer, count, 0);
3973 if (res == SOCKET_ERROR)
3974 {
3975 DebPrint(("sys_read.recv failed with error %d on socket %ld\n",
3976 pfn_WSAGetLastError (), SOCK_HANDLE (fd)));
3977 set_errno ();
3978 return -1;
3979 }
3980 nchars += res;
3981 }
3982 }
3983 #endif
3984 }
3985 else
3986 {
3987 int nread = _read (fd, buffer, count);
3988 if (nread >= 0)
3989 nchars += nread;
3990 else if (nchars == 0)
3991 nchars = nread;
3992 }
3993
3994 if (nchars <= 0)
3995 fd_info[fd].flags |= FILE_AT_EOF;
3996 /* Perform text mode translation if required. */
3997 else if ((fd_info[fd].flags & FILE_BINARY) == 0)
3998 {
3999 nchars = crlf_to_lf (nchars, orig_buffer);
4000 /* If buffer contains only CR, return that. To be absolutely
4001 sure we should attempt to read the next char, but in
4002 practice a CR to be followed by LF would not appear by
4003 itself in the buffer. */
4004 if (nchars > 1 && orig_buffer[nchars - 1] == 0x0d)
4005 {
4006 fd_info[fd].flags |= FILE_LAST_CR;
4007 nchars--;
4008 }
4009 }
4010 }
4011 else
4012 nchars = _read (fd, buffer, count);
4013
4014 return nchars;
4015 }
4016
4017 /* For now, don't bother with a non-blocking mode */
4018 int
4019 sys_write (int fd, const void * buffer, unsigned int count)
4020 {
4021 int nchars;
4022
4023 if (fd < 0)
4024 {
4025 errno = EBADF;
4026 return -1;
4027 }
4028
4029 if (fd < MAXDESC && fd_info[fd].flags & (FILE_PIPE | FILE_SOCKET))
4030 {
4031 if ((fd_info[fd].flags & FILE_WRITE) == 0)
4032 {
4033 errno = EBADF;
4034 return -1;
4035 }
4036
4037 /* Perform text mode translation if required. */
4038 if ((fd_info[fd].flags & FILE_BINARY) == 0)
4039 {
4040 char * tmpbuf = alloca (count * 2);
4041 unsigned char * src = (void *)buffer;
4042 unsigned char * dst = tmpbuf;
4043 int nbytes = count;
4044
4045 while (1)
4046 {
4047 unsigned char *next;
4048 /* copy next line or remaining bytes */
4049 next = _memccpy (dst, src, '\n', nbytes);
4050 if (next)
4051 {
4052 /* copied one line ending with '\n' */
4053 int copied = next - dst;
4054 nbytes -= copied;
4055 src += copied;
4056 /* insert '\r' before '\n' */
4057 next[-1] = '\r';
4058 next[0] = '\n';
4059 dst = next + 1;
4060 count++;
4061 }
4062 else
4063 /* copied remaining partial line -> now finished */
4064 break;
4065 }
4066 buffer = tmpbuf;
4067 }
4068 }
4069
4070 #ifdef HAVE_SOCKETS
4071 if (fd < MAXDESC && fd_info[fd].flags & FILE_SOCKET)
4072 {
4073 unsigned long nblock = 0;
4074 if (winsock_lib == NULL) abort ();
4075
4076 /* TODO: implement select() properly so non-blocking I/O works. */
4077 /* For now, make sure the write blocks. */
4078 if (fd_info[fd].flags & FILE_NDELAY)
4079 pfn_ioctlsocket (SOCK_HANDLE (fd), FIONBIO, &nblock);
4080
4081 nchars = pfn_send (SOCK_HANDLE (fd), buffer, count, 0);
4082
4083 /* Set the socket back to non-blocking if it was before,
4084 for other operations that support it. */
4085 if (fd_info[fd].flags & FILE_NDELAY)
4086 {
4087 nblock = 1;
4088 pfn_ioctlsocket (SOCK_HANDLE (fd), FIONBIO, &nblock);
4089 }
4090
4091 if (nchars == SOCKET_ERROR)
4092 {
4093 DebPrint(("sys_write.send failed with error %d on socket %ld\n",
4094 pfn_WSAGetLastError (), SOCK_HANDLE (fd)));
4095 set_errno ();
4096 }
4097 }
4098 else
4099 #endif
4100 nchars = _write (fd, buffer, count);
4101
4102 return nchars;
4103 }
4104
4105 static void
4106 check_windows_init_file ()
4107 {
4108 extern int noninteractive, inhibit_window_system;
4109
4110 /* A common indication that Emacs is not installed properly is when
4111 it cannot find the Windows installation file. If this file does
4112 not exist in the expected place, tell the user. */
4113
4114 if (!noninteractive && !inhibit_window_system)
4115 {
4116 extern Lisp_Object Vwindow_system, Vload_path, Qfile_exists_p;
4117 Lisp_Object objs[2];
4118 Lisp_Object full_load_path;
4119 Lisp_Object init_file;
4120 int fd;
4121
4122 objs[0] = Vload_path;
4123 objs[1] = decode_env_path (0, (getenv ("EMACSLOADPATH")));
4124 full_load_path = Fappend (2, objs);
4125 init_file = build_string ("term/w32-win");
4126 fd = openp (full_load_path, init_file, Fget_load_suffixes (), NULL, Qnil);
4127 if (fd < 0)
4128 {
4129 Lisp_Object load_path_print = Fprin1_to_string (full_load_path, Qnil);
4130 char *init_file_name = SDATA (init_file);
4131 char *load_path = SDATA (load_path_print);
4132 char *buffer = alloca (1024
4133 + strlen (init_file_name)
4134 + strlen (load_path));
4135
4136 sprintf (buffer,
4137 "The Emacs Windows initialization file \"%s.el\" "
4138 "could not be found in your Emacs installation. "
4139 "Emacs checked the following directories for this file:\n"
4140 "\n%s\n\n"
4141 "When Emacs cannot find this file, it usually means that it "
4142 "was not installed properly, or its distribution file was "
4143 "not unpacked properly.\nSee the README.W32 file in the "
4144 "top-level Emacs directory for more information.",
4145 init_file_name, load_path);
4146 MessageBox (NULL,
4147 buffer,
4148 "Emacs Abort Dialog",
4149 MB_OK | MB_ICONEXCLAMATION | MB_TASKMODAL);
4150 /* Use the low-level Emacs abort. */
4151 #undef abort
4152 abort ();
4153 }
4154 else
4155 {
4156 _close (fd);
4157 }
4158 }
4159 }
4160
4161 void
4162 term_ntproc ()
4163 {
4164 #ifdef HAVE_SOCKETS
4165 /* shutdown the socket interface if necessary */
4166 term_winsock ();
4167 #endif
4168
4169 term_w32select ();
4170 }
4171
4172 void
4173 init_ntproc ()
4174 {
4175 #ifdef HAVE_SOCKETS
4176 /* Initialise the socket interface now if available and requested by
4177 the user by defining PRELOAD_WINSOCK; otherwise loading will be
4178 delayed until open-network-stream is called (w32-has-winsock can
4179 also be used to dynamically load or reload winsock).
4180
4181 Conveniently, init_environment is called before us, so
4182 PRELOAD_WINSOCK can be set in the registry. */
4183
4184 /* Always initialize this correctly. */
4185 winsock_lib = NULL;
4186
4187 if (getenv ("PRELOAD_WINSOCK") != NULL)
4188 init_winsock (TRUE);
4189 #endif
4190
4191 /* Initial preparation for subprocess support: replace our standard
4192 handles with non-inheritable versions. */
4193 {
4194 HANDLE parent;
4195 HANDLE stdin_save = INVALID_HANDLE_VALUE;
4196 HANDLE stdout_save = INVALID_HANDLE_VALUE;
4197 HANDLE stderr_save = INVALID_HANDLE_VALUE;
4198
4199 parent = GetCurrentProcess ();
4200
4201 /* ignore errors when duplicating and closing; typically the
4202 handles will be invalid when running as a gui program. */
4203 DuplicateHandle (parent,
4204 GetStdHandle (STD_INPUT_HANDLE),
4205 parent,
4206 &stdin_save,
4207 0,
4208 FALSE,
4209 DUPLICATE_SAME_ACCESS);
4210
4211 DuplicateHandle (parent,
4212 GetStdHandle (STD_OUTPUT_HANDLE),
4213 parent,
4214 &stdout_save,
4215 0,
4216 FALSE,
4217 DUPLICATE_SAME_ACCESS);
4218
4219 DuplicateHandle (parent,
4220 GetStdHandle (STD_ERROR_HANDLE),
4221 parent,
4222 &stderr_save,
4223 0,
4224 FALSE,
4225 DUPLICATE_SAME_ACCESS);
4226
4227 fclose (stdin);
4228 fclose (stdout);
4229 fclose (stderr);
4230
4231 if (stdin_save != INVALID_HANDLE_VALUE)
4232 _open_osfhandle ((long) stdin_save, O_TEXT);
4233 else
4234 _open ("nul", O_TEXT | O_NOINHERIT | O_RDONLY);
4235 _fdopen (0, "r");
4236
4237 if (stdout_save != INVALID_HANDLE_VALUE)
4238 _open_osfhandle ((long) stdout_save, O_TEXT);
4239 else
4240 _open ("nul", O_TEXT | O_NOINHERIT | O_WRONLY);
4241 _fdopen (1, "w");
4242
4243 if (stderr_save != INVALID_HANDLE_VALUE)
4244 _open_osfhandle ((long) stderr_save, O_TEXT);
4245 else
4246 _open ("nul", O_TEXT | O_NOINHERIT | O_WRONLY);
4247 _fdopen (2, "w");
4248 }
4249
4250 /* unfortunately, atexit depends on implementation of malloc */
4251 /* atexit (term_ntproc); */
4252 signal (SIGABRT, term_ntproc);
4253
4254 /* determine which drives are fixed, for GetCachedVolumeInformation */
4255 {
4256 /* GetDriveType must have trailing backslash. */
4257 char drive[] = "A:\\";
4258
4259 /* Loop over all possible drive letters */
4260 while (*drive <= 'Z')
4261 {
4262 /* Record if this drive letter refers to a fixed drive. */
4263 fixed_drives[DRIVE_INDEX (*drive)] =
4264 (GetDriveType (drive) == DRIVE_FIXED);
4265
4266 (*drive)++;
4267 }
4268
4269 /* Reset the volume info cache. */
4270 volume_cache = NULL;
4271 }
4272
4273 /* Check to see if Emacs has been installed correctly. */
4274 check_windows_init_file ();
4275 }
4276
4277 /*
4278 shutdown_handler ensures that buffers' autosave files are
4279 up to date when the user logs off, or the system shuts down.
4280 */
4281 BOOL WINAPI shutdown_handler(DWORD type)
4282 {
4283 /* Ctrl-C and Ctrl-Break are already suppressed, so don't handle them. */
4284 if (type == CTRL_CLOSE_EVENT /* User closes console window. */
4285 || type == CTRL_LOGOFF_EVENT /* User logs off. */
4286 || type == CTRL_SHUTDOWN_EVENT) /* User shutsdown. */
4287 {
4288 /* Shut down cleanly, making sure autosave files are up to date. */
4289 shut_down_emacs (0, 0, Qnil);
4290 }
4291
4292 /* Allow other handlers to handle this signal. */
4293 return FALSE;
4294 }
4295
4296 /*
4297 globals_of_w32 is used to initialize those global variables that
4298 must always be initialized on startup even when the global variable
4299 initialized is non zero (see the function main in emacs.c).
4300 */
4301 void
4302 globals_of_w32 ()
4303 {
4304 HMODULE kernel32 = GetModuleHandle ("kernel32.dll");
4305
4306 get_process_times_fn = (GetProcessTimes_Proc)
4307 GetProcAddress (kernel32, "GetProcessTimes");
4308
4309 g_b_init_is_windows_9x = 0;
4310 g_b_init_open_process_token = 0;
4311 g_b_init_get_token_information = 0;
4312 g_b_init_lookup_account_sid = 0;
4313 g_b_init_get_sid_identifier_authority = 0;
4314 g_b_init_get_sid_sub_authority = 0;
4315 g_b_init_get_sid_sub_authority_count = 0;
4316 /* The following sets a handler for shutdown notifications for
4317 console apps. This actually applies to Emacs in both console and
4318 GUI modes, since we had to fool windows into thinking emacs is a
4319 console application to get console mode to work. */
4320 SetConsoleCtrlHandler(shutdown_handler, TRUE);
4321 }
4322
4323 /* end of w32.c */
4324
4325 /* arch-tag: 90442dd3-37be-482b-b272-ac752e3049f1
4326 (do not change this comment) */