w32.c 96.9 KB
Newer Older
1
/* Utility and Unix shadow routines for GNU Emacs on the Microsoft W32 API.
2
   Copyright (C) 1994, 1995, 2000, 2001 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
3

4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
20 21 22 23

   Geoff Voelker (voelker@cs.washington.edu)                         7-29-94
*/

24

Geoff Voelker's avatar
Geoff Voelker committed
25
#include <stddef.h> /* for offsetof */
Richard M. Stallman's avatar
Richard M. Stallman committed
26 27 28
#include <stdlib.h>
#include <stdio.h>
#include <io.h>
29
#include <errno.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
30 31
#include <fcntl.h>
#include <ctype.h>
32
#include <signal.h>
Karl Heuer's avatar
Karl Heuer committed
33
#include <sys/file.h>
34
#include <sys/time.h>
35
#include <sys/utime.h>
36 37

/* must include CRT headers *before* config.h */
Pavel Janík's avatar
Pavel Janík committed
38 39 40 41 42

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
#undef access
#undef chdir
#undef chmod
#undef creat
#undef ctime
#undef fopen
#undef link
#undef mkdir
#undef mktemp
#undef open
#undef rename
#undef rmdir
#undef unlink

#undef close
#undef dup
#undef dup2
#undef pipe
#undef read
#undef write
Richard M. Stallman's avatar
Richard M. Stallman committed
63

Andrew Innes's avatar
Andrew Innes committed
64 65
#undef strerror

Richard M. Stallman's avatar
Richard M. Stallman committed
66 67 68 69
#include "lisp.h"

#include <pwd.h>

70 71 72 73
#ifdef __GNUC__
#define _ANONYMOUS_UNION
#define _ANONYMOUS_STRUCT
#endif
74
#include <windows.h>
75

76 77 78 79 80 81 82 83 84 85 86
#ifdef HAVE_SOCKETS	/* TCP connection support, if kernel can do it */
#include <sys/socket.h>
#undef socket
#undef bind
#undef connect
#undef htons
#undef ntohs
#undef inet_addr
#undef gethostname
#undef gethostbyname
#undef getservbyname
87
#undef getpeername
Geoff Voelker's avatar
Geoff Voelker committed
88
#undef shutdown
89 90 91 92 93 94
#undef setsockopt
#undef listen
#undef getsockname
#undef accept
#undef recvfrom
#undef sendto
95
#endif
96

Geoff Voelker's avatar
Geoff Voelker committed
97
#include "w32.h"
98
#include "ndir.h"
Geoff Voelker's avatar
Geoff Voelker committed
99
#include "w32heap.h"
100 101
#include "systime.h"

102 103
void globals_of_w32 ();

Geoff Voelker's avatar
Geoff Voelker committed
104 105 106
extern Lisp_Object Vw32_downcase_file_names;
extern Lisp_Object Vw32_generate_fake_inodes;
extern Lisp_Object Vw32_get_true_file_attributes;
107
extern Lisp_Object Vw32_num_mouse_buttons;
Geoff Voelker's avatar
Geoff Voelker committed
108

109

110 111 112 113 114 115 116 117 118
/*
	Initialization states
 */
static BOOL g_b_init_is_windows_9x;
static BOOL g_b_init_open_process_token;
static BOOL g_b_init_get_token_information;
static BOOL g_b_init_lookup_account_sid;
static BOOL g_b_init_get_sid_identifier_authority;

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
/*
  BEGIN: Wrapper functions around OpenProcessToken
  and other functions in advapi32.dll that are only
  supported in Windows NT / 2k / XP
*/
  /* ** Function pointer typedefs ** */
typedef BOOL (WINAPI * OpenProcessToken_Proc) (
    HANDLE ProcessHandle,
    DWORD DesiredAccess,
    PHANDLE TokenHandle);
typedef BOOL (WINAPI * GetTokenInformation_Proc) (
    HANDLE TokenHandle,
    TOKEN_INFORMATION_CLASS TokenInformationClass,
    LPVOID TokenInformation,
    DWORD TokenInformationLength,
    PDWORD ReturnLength);
#ifdef _UNICODE
const char * const LookupAccountSid_Name = "LookupAccountSidW";
#else
const char * const LookupAccountSid_Name = "LookupAccountSidA";
#endif
typedef BOOL (WINAPI * LookupAccountSid_Proc) (
    LPCTSTR lpSystemName,
    PSID Sid,
    LPTSTR Name,
    LPDWORD cbName,
    LPTSTR DomainName,
    LPDWORD cbDomainName,
    PSID_NAME_USE peUse);
typedef PSID_IDENTIFIER_AUTHORITY (WINAPI * GetSidIdentifierAuthority_Proc) (
    PSID pSid);

  /* ** A utility function ** */
static BOOL is_windows_9x ()
{
154
  static BOOL s_b_ret=0;
155
  OSVERSIONINFO os_ver;
156
  if (g_b_init_is_windows_9x == 0)
157
    {
158 159 160 161 162 163 164
      g_b_init_is_windows_9x = 1;
      ZeroMemory(&os_ver, sizeof(OSVERSIONINFO));
      os_ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
      if (GetVersionEx (&os_ver))
        {
          s_b_ret = (os_ver.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS);
        }
165
    }
166
  return s_b_ret;
167 168 169 170 171 172 173 174 175
}

  /* ** The wrapper functions ** */

BOOL WINAPI open_process_token (
    HANDLE ProcessHandle,
    DWORD DesiredAccess,
    PHANDLE TokenHandle)
{
176
  static OpenProcessToken_Proc s_pfn_Open_Process_Token = NULL;
177 178 179 180 181
  HMODULE hm_advapi32 = NULL;
  if (is_windows_9x () == TRUE)
    {
      return FALSE;
    }
182 183 184 185 186 187 188 189
  if (g_b_init_open_process_token == 0)
    {
      g_b_init_open_process_token = 1;
      hm_advapi32 = LoadLibrary ("Advapi32.dll");
      s_pfn_Open_Process_Token =
        (OpenProcessToken_Proc) GetProcAddress (hm_advapi32, "OpenProcessToken");
    }
  if (s_pfn_Open_Process_Token == NULL)
190 191 192 193
    {
      return FALSE;
    }
  return (
194
      s_pfn_Open_Process_Token (
195 196 197 198 199 200 201 202 203 204 205 206 207
          ProcessHandle,
          DesiredAccess,
          TokenHandle)
      );
}

BOOL WINAPI get_token_information (
    HANDLE TokenHandle,
    TOKEN_INFORMATION_CLASS TokenInformationClass,
    LPVOID TokenInformation,
    DWORD TokenInformationLength,
    PDWORD ReturnLength)
{
208
  static GetTokenInformation_Proc s_pfn_Get_Token_Information = NULL;
209 210 211 212 213
  HMODULE hm_advapi32 = NULL;
  if (is_windows_9x () == TRUE)
    {
      return FALSE;
    }
214 215 216 217 218 219 220 221
  if (g_b_init_get_token_information == 0)
    {
      g_b_init_get_token_information = 1;
      hm_advapi32 = LoadLibrary ("Advapi32.dll");
      s_pfn_Get_Token_Information =
        (GetTokenInformation_Proc) GetProcAddress (hm_advapi32, "GetTokenInformation");
    }
  if (s_pfn_Get_Token_Information == NULL)
222 223 224 225
    {
      return FALSE;
    }
  return (
226
      s_pfn_Get_Token_Information (
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
          TokenHandle,
          TokenInformationClass,
          TokenInformation,
          TokenInformationLength,
          ReturnLength)
      );
}

BOOL WINAPI lookup_account_sid (
    LPCTSTR lpSystemName,
    PSID Sid,
    LPTSTR Name,
    LPDWORD cbName,
    LPTSTR DomainName,
    LPDWORD cbDomainName,
    PSID_NAME_USE peUse)
{
244
  static LookupAccountSid_Proc s_pfn_Lookup_Account_Sid = NULL;
245 246 247 248 249
  HMODULE hm_advapi32 = NULL;
  if (is_windows_9x () == TRUE)
    {
      return FALSE;
    }
250 251 252 253 254 255 256 257
  if (g_b_init_lookup_account_sid == 0)
    {
      g_b_init_lookup_account_sid = 1;
      hm_advapi32 = LoadLibrary ("Advapi32.dll");
      s_pfn_Lookup_Account_Sid =
        (LookupAccountSid_Proc) GetProcAddress (hm_advapi32, LookupAccountSid_Name);
    }
  if (s_pfn_Lookup_Account_Sid == NULL)
258 259 260 261
    {
      return FALSE;
    }
  return (
262
      s_pfn_Lookup_Account_Sid (
263 264 265 266 267 268 269 270 271 272 273 274 275
          lpSystemName,
          Sid,
          Name,
          cbName,
          DomainName,
          cbDomainName,
          peUse)
      );
}

PSID_IDENTIFIER_AUTHORITY WINAPI get_sid_identifier_authority (
    PSID pSid)
{
276
  static GetSidIdentifierAuthority_Proc s_pfn_Get_Sid_Identifier_Authority = NULL;
277 278 279 280 281
  HMODULE hm_advapi32 = NULL;
  if (is_windows_9x () == TRUE)
    {
      return NULL;
    }
282 283 284 285 286 287 288 289 290
  if (g_b_init_get_sid_identifier_authority == 0)
    {
      g_b_init_get_sid_identifier_authority = 1;
      hm_advapi32 = LoadLibrary ("Advapi32.dll");
      s_pfn_Get_Sid_Identifier_Authority =
        (GetSidIdentifierAuthority_Proc) GetProcAddress (
            hm_advapi32, "GetSidIdentifierAuthority");
    }
  if (s_pfn_Get_Sid_Identifier_Authority == NULL)
291 292 293
    {
      return NULL;
    }
294
  return (s_pfn_Get_Sid_Identifier_Authority (pSid));
295 296 297 298 299 300 301 302
}

/*
  END: Wrapper functions around OpenProcessToken
  and other functions in advapi32.dll that are only
  supported in Windows NT / 2k / XP
*/

Andrew Innes's avatar
Andrew Innes committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321

/* Equivalent of strerror for W32 error codes.  */
char *
w32_strerror (int error_no)
{
  static char buf[500];

  if (error_no == 0)
    error_no = GetLastError ();

  buf[0] = '\0';
  if (!FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM, NULL,
		      error_no,
		      0, /* choose most suitable language */
		      buf, sizeof (buf), NULL))
    sprintf (buf, "w32 error %u", error_no);
  return buf;
}

Geoff Voelker's avatar
Geoff Voelker committed
322
static char startup_dir[MAXPATHLEN];
323

Richard M. Stallman's avatar
Richard M. Stallman committed
324
/* Get the current working directory.  */
325
char *
Richard M. Stallman's avatar
Richard M. Stallman committed
326 327
getwd (char *dir)
{
Geoff Voelker's avatar
Geoff Voelker committed
328
#if 0
329 330 331
  if (GetCurrentDirectory (MAXPATHLEN, dir) > 0)
    return dir;
  return NULL;
Geoff Voelker's avatar
Geoff Voelker committed
332 333 334 335 336 337 338
#else
  /* Emacs doesn't actually change directory itself, and we want to
     force our real wd to be where emacs.exe is to avoid unnecessary
     conflicts when trying to rename or delete directories.  */
  strcpy (dir, startup_dir);
  return dir;
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
339 340
}

341
#ifndef HAVE_SOCKETS
Richard M. Stallman's avatar
Richard M. Stallman committed
342 343 344 345
/* Emulate gethostname.  */
int
gethostname (char *buffer, int size)
{
346
  /* NT only allows small host names, so the buffer is
Richard M. Stallman's avatar
Richard M. Stallman committed
347 348 349
     certainly large enough.  */
  return !GetComputerName (buffer, &size);
}
350
#endif /* HAVE_SOCKETS */
Richard M. Stallman's avatar
Richard M. Stallman committed
351 352 353 354 355 356 357 358

/* Emulate getloadavg.  */
int
getloadavg (double loadavg[], int nelem)
{
  int i;

  /* A faithful emulation is going to have to be saved for a rainy day.  */
359
  for (i = 0; i < nelem; i++)
Richard M. Stallman's avatar
Richard M. Stallman committed
360 361 362 363 364 365
    {
      loadavg[i] = 0.0;
    }
  return i;
}

366
/* Emulate getpwuid, getpwnam and others.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
367

Geoff Voelker's avatar
Geoff Voelker committed
368 369 370 371 372 373 374
#define PASSWD_FIELD_SIZE 256

static char the_passwd_name[PASSWD_FIELD_SIZE];
static char the_passwd_passwd[PASSWD_FIELD_SIZE];
static char the_passwd_gecos[PASSWD_FIELD_SIZE];
static char the_passwd_dir[PASSWD_FIELD_SIZE];
static char the_passwd_shell[PASSWD_FIELD_SIZE];
Richard M. Stallman's avatar
Richard M. Stallman committed
375

376
static struct passwd the_passwd =
Richard M. Stallman's avatar
Richard M. Stallman committed
377 378 379 380 381 382 383 384 385 386 387
{
  the_passwd_name,
  the_passwd_passwd,
  0,
  0,
  0,
  the_passwd_gecos,
  the_passwd_dir,
  the_passwd_shell,
};

388 389 390
int
getuid ()
{
391 392 393
  return the_passwd.pw_uid;
}

394 395 396
int
geteuid ()
{
397 398 399
  /* I could imagine arguing for checking to see whether the user is
     in the Administrators group and returning a UID of 0 for that
     case, but I don't know how wise that would be in the long run.  */
400
  return getuid ();
401 402
}

403 404 405
int
getgid ()
{
406 407 408
  return the_passwd.pw_gid;
}

409 410 411
int
getegid ()
{
412 413 414
  return getgid ();
}

Richard M. Stallman's avatar
Richard M. Stallman committed
415 416 417
struct passwd *
getpwuid (int uid)
{
418 419 420
  if (uid == the_passwd.pw_uid)
    return &the_passwd;
  return NULL;
Richard M. Stallman's avatar
Richard M. Stallman committed
421 422 423 424 425 426
}

struct passwd *
getpwnam (char *name)
{
  struct passwd *pw;
427

Richard M. Stallman's avatar
Richard M. Stallman committed
428 429 430 431
  pw = getpwuid (getuid ());
  if (!pw)
    return pw;

432
  if (stricmp (name, pw->pw_name))
Richard M. Stallman's avatar
Richard M. Stallman committed
433 434 435 436 437
    return NULL;

  return pw;
}

438 439
void
init_user_info ()
Richard M. Stallman's avatar
Richard M. Stallman committed
440
{
441 442 443 444 445 446 447 448 449 450 451 452
  /* Find the user's real name by opening the process token and
     looking up the name associated with the user-sid in that token.

     Use the relative portion of the identifier authority value from
     the user-sid as the user id value (same for group id using the
     primary group sid from the process token). */

  char            user_sid[256], name[256], domain[256];
  DWORD           length = sizeof (name), dlength = sizeof (domain), trash;
  HANDLE          token = NULL;
  SID_NAME_USE    user_type;

453 454 455 456
  if (
			open_process_token (GetCurrentProcess (), TOKEN_QUERY, &token)
      && get_token_information (
					token, TokenUser,
457
			      (PVOID) user_sid, sizeof (user_sid), &trash)
458 459 460 461
      && lookup_account_sid (
					NULL, *((PSID *) user_sid), name, &length,
			   domain, &dlength, &user_type)
			)
Richard M. Stallman's avatar
Richard M. Stallman committed
462
    {
463 464 465 466 467 468 469 470 471 472 473
      strcpy (the_passwd.pw_name, name);
      /* Determine a reasonable uid value. */
      if (stricmp ("administrator", name) == 0)
	{
	  the_passwd.pw_uid = 0;
	  the_passwd.pw_gid = 0;
	}
      else
	{
	  SID_IDENTIFIER_AUTHORITY * pSIA;

474
	  pSIA = get_sid_identifier_authority (*((PSID *) user_sid));
475 476 477 478 479 480 481 482 483 484
	  /* I believe the relative portion is the last 4 bytes (of 6)
	     with msb first. */
	  the_passwd.pw_uid = ((pSIA->Value[2] << 24) +
			       (pSIA->Value[3] << 16) +
			       (pSIA->Value[4] << 8)  +
			       (pSIA->Value[5] << 0));
	  /* restrict to conventional uid range for normal users */
	  the_passwd.pw_uid = the_passwd.pw_uid % 60001;

	  /* Get group id */
485
	  if (get_token_information (token, TokenPrimaryGroup,
486 487 488 489
				   (PVOID) user_sid, sizeof (user_sid), &trash))
	    {
	      SID_IDENTIFIER_AUTHORITY * pSIA;

490
	      pSIA = get_sid_identifier_authority (*((PSID *) user_sid));
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
	      the_passwd.pw_gid = ((pSIA->Value[2] << 24) +
				   (pSIA->Value[3] << 16) +
				   (pSIA->Value[4] << 8)  +
				   (pSIA->Value[5] << 0));
	      /* I don't know if this is necessary, but for safety... */
	      the_passwd.pw_gid = the_passwd.pw_gid % 60001;
	    }
	  else
	    the_passwd.pw_gid = the_passwd.pw_uid;
	}
    }
  /* If security calls are not supported (presumably because we
       are running under Windows 95), fallback to this. */
  else if (GetUserName (name, &length))
    {
      strcpy (the_passwd.pw_name, name);
      if (stricmp ("administrator", name) == 0)
	the_passwd.pw_uid = 0;
      else
	the_passwd.pw_uid = 123;
      the_passwd.pw_gid = the_passwd.pw_uid;
    }
  else
    {
      strcpy (the_passwd.pw_name, "unknown");
      the_passwd.pw_uid = 123;
      the_passwd.pw_gid = 123;
Richard M. Stallman's avatar
Richard M. Stallman committed
518
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
519

520 521
  /* Ensure HOME and SHELL are defined. */
  if (getenv ("HOME") == NULL)
522
    abort ();
523
  if (getenv ("SHELL") == NULL)
524
    abort ();
Richard M. Stallman's avatar
Richard M. Stallman committed
525

526 527 528
  /* Set dir and shell from environment variables. */
  strcpy (the_passwd.pw_dir, getenv ("HOME"));
  strcpy (the_passwd.pw_shell, getenv ("SHELL"));
529

530 531
  if (token)
    CloseHandle (token);
Richard M. Stallman's avatar
Richard M. Stallman committed
532 533 534
}

int
535
random ()
Richard M. Stallman's avatar
Richard M. Stallman committed
536
{
537 538
  /* rand () on NT gives us 15 random bits...hack together 30 bits.  */
  return ((rand () << 15) | rand ());
Richard M. Stallman's avatar
Richard M. Stallman committed
539 540 541
}

void
542
srandom (int seed)
Richard M. Stallman's avatar
Richard M. Stallman committed
543
{
544
  srand (seed);
Richard M. Stallman's avatar
Richard M. Stallman committed
545 546
}

Geoff Voelker's avatar
Geoff Voelker committed
547

548 549 550 551 552 553 554 555 556 557 558 559
/* Normalize filename by converting all path separators to
   the specified separator.  Also conditionally convert upper
   case path name components to lower case.  */

static void
normalize_filename (fp, path_sep)
     register char *fp;
     char path_sep;
{
  char sep;
  char *elem;

560 561 562 563 564 565 566 567 568 569 570
  /* Always lower-case drive letters a-z, even if the filesystem
     preserves case in filenames.
     This is so filenames can be compared by string comparison
     functions that are case-sensitive.  Even case-preserving filesystems
     do not distinguish case in drive letters.  */
  if (fp[1] == ':' && *fp >= 'A' && *fp <= 'Z')
    {
      *fp += 'a' - 'A';
      fp += 2;
    }

571
  if (NILP (Vw32_downcase_file_names))
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
    {
      while (*fp)
	{
	  if (*fp == '/' || *fp == '\\')
	    *fp = path_sep;
	  fp++;
	}
      return;
    }

  sep = path_sep;		/* convert to this path separator */
  elem = fp;			/* start of current path element */

  do {
    if (*fp >= 'a' && *fp <= 'z')
      elem = 0;			/* don't convert this element */

    if (*fp == 0 || *fp == ':')
      {
	sep = *fp;		/* restore current separator (or 0) */
	*fp = '/';		/* after conversion of this element */
      }

    if (*fp == '/' || *fp == '\\')
      {
	if (elem && elem != fp)
	  {
	    *fp = 0;		/* temporary end of string */
	    _strlwr (elem);	/* while we convert to lower case */
	  }
	*fp = sep;		/* convert (or restore) path separator */
	elem = fp + 1;		/* next element starts after separator */
	sep = path_sep;
      }
  } while (*fp++);
}

609
/* Destructively turn backslashes into slashes.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
610
void
611 612
dostounix_filename (p)
     register char *p;
Richard M. Stallman's avatar
Richard M. Stallman committed
613
{
614
  normalize_filename (p, '/');
Richard M. Stallman's avatar
Richard M. Stallman committed
615 616
}

617
/* Destructively turn slashes into backslashes.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
618
void
619 620
unixtodos_filename (p)
     register char *p;
Richard M. Stallman's avatar
Richard M. Stallman committed
621
{
622
  normalize_filename (p, '\\');
Richard M. Stallman's avatar
Richard M. Stallman committed
623 624
}

625 626 627
/* Remove all CR's that are followed by a LF.
   (From msdos.c...probably should figure out a way to share it,
   although this code isn't going to ever change.)  */
Karl Heuer's avatar
Karl Heuer committed
628
int
629 630 631
crlf_to_lf (n, buf)
     register int n;
     register unsigned char *buf;
Karl Heuer's avatar
Karl Heuer committed
632
{
633 634 635
  unsigned char *np = buf;
  unsigned char *startp = buf;
  unsigned char *endp = buf + n;
Karl Heuer's avatar
Karl Heuer committed
636

637 638 639
  if (n == 0)
    return n;
  while (buf < endp - 1)
Richard M. Stallman's avatar
Richard M. Stallman committed
640
    {
641 642 643 644 645 646 647
      if (*buf == 0x0d)
	{
	  if (*(++buf) != 0x0a)
	    *np++ = 0x0d;
	}
      else
	*np++ = *buf++;
Richard M. Stallman's avatar
Richard M. Stallman committed
648
    }
649 650 651
  if (buf < endp)
    *np++ = *buf++;
  return np - startp;
Richard M. Stallman's avatar
Richard M. Stallman committed
652 653
}

Geoff Voelker's avatar
Geoff Voelker committed
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
/* Parse the root part of file name, if present.  Return length and
    optionally store pointer to char after root.  */
static int
parse_root (char * name, char ** pPath)
{
  char * start = name;

  if (name == NULL)
    return 0;

  /* find the root name of the volume if given */
  if (isalpha (name[0]) && name[1] == ':')
    {
      /* skip past drive specifier */
      name += 2;
      if (IS_DIRECTORY_SEP (name[0]))
	name++;
    }
  else if (IS_DIRECTORY_SEP (name[0]) && IS_DIRECTORY_SEP (name[1]))
    {
      int slashes = 2;
      name += 2;
      do
        {
	  if (IS_DIRECTORY_SEP (*name) && --slashes == 0)
	    break;
	  name++;
	}
      while ( *name );
      if (IS_DIRECTORY_SEP (name[0]))
	name++;
    }

  if (pPath)
    *pPath = name;

  return name - start;
}

/* Get long base name for name; name is assumed to be absolute.  */
static int
get_long_basename (char * name, char * buf, int size)
{
  WIN32_FIND_DATA find_data;
  HANDLE dir_handle;
  int len = 0;

701
  /* must be valid filename, no wild cards or other invalid characters */
702 703 704
  if (strpbrk (name, "*?|<>\""))
    return 0;

Geoff Voelker's avatar
Geoff Voelker committed
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
  dir_handle = FindFirstFile (name, &find_data);
  if (dir_handle != INVALID_HANDLE_VALUE)
    {
      if ((len = strlen (find_data.cFileName)) < size)
	memcpy (buf, find_data.cFileName, len + 1);
      else
	len = 0;
      FindClose (dir_handle);
    }
  return len;
}

/* Get long name for file, if possible (assumed to be absolute).  */
BOOL
w32_get_long_filename (char * name, char * buf, int size)
{
  char * o = buf;
  char * p;
  char * q;
  char full[ MAX_PATH ];
  int len;

  len = strlen (name);
  if (len >= MAX_PATH)
    return FALSE;

  /* Use local copy for destructive modification.  */
  memcpy (full, name, len+1);
  unixtodos_filename (full);

  /* Copy root part verbatim.  */
  len = parse_root (full, &p);
  memcpy (o, full, len);
  o += len;
739
  *o = '\0';
Geoff Voelker's avatar
Geoff Voelker committed
740 741
  size -= len;

742
  while (p != NULL && *p)
Geoff Voelker's avatar
Geoff Voelker committed
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
    {
      q = p;
      p = strchr (q, '\\');
      if (p) *p = '\0';
      len = get_long_basename (full, o, size);
      if (len > 0)
	{
	  o += len;
	  size -= len;
	  if (p != NULL)
	    {
	      *p++ = '\\';
	      if (size < 2)
		return FALSE;
	      *o++ = '\\';
	      size--;
	      *o = '\0';
	    }
	}
      else
	return FALSE;
    }

  return TRUE;
}

769 770 771 772 773 774 775 776 777 778 779 780 781
int
is_unc_volume (const char *filename)
{
  const char *ptr = filename;

  if (!IS_DIRECTORY_SEP (ptr[0]) || !IS_DIRECTORY_SEP (ptr[1]) || !ptr[2])
    return 0;

  if (strpbrk (ptr + 2, "*?|<>\"\\/"))
    return 0;

  return 1;
}
Geoff Voelker's avatar
Geoff Voelker committed
782

Richard M. Stallman's avatar
Richard M. Stallman committed
783 784
/* Routines that are no-ops on NT but are defined to get Emacs to compile.  */

785 786 787
int
sigsetmask (int signal_mask)
{
Richard M. Stallman's avatar
Richard M. Stallman committed
788 789 790
  return 0;
}

791 792 793
int
sigmask (int sig)
{
794 795 796
  return 0;
}

797 798 799
int
sigblock (int sig)
{
Richard M. Stallman's avatar
Richard M. Stallman committed
800 801 802
  return 0;
}

803 804 805
int
sigunblock (int sig)
{
806 807 808
  return 0;
}

809 810 811
int
setpgrp (int pid, int gid)
{
Richard M. Stallman's avatar
Richard M. Stallman committed
812 813 814
  return 0;
}

815 816 817
int
alarm (int seconds)
{
Richard M. Stallman's avatar
Richard M. Stallman committed
818 819 820
  return 0;
}

821 822 823
void
unrequest_sigio (void)
{
824
  return;
Richard M. Stallman's avatar
Richard M. Stallman committed
825 826
}

827
void
828 829
request_sigio (void)
{
830
  return;
Richard M. Stallman's avatar
Richard M. Stallman committed
831 832
}

833
#define REG_ROOT "SOFTWARE\\GNU\\Emacs"
834

835
LPBYTE
836
w32_get_resource (key, lpdwtype)
837 838 839 840 841 842 843
    char *key;
    LPDWORD lpdwtype;
{
  LPBYTE lpvalue;
  HKEY hrootkey = NULL;
  DWORD cbData;
  BOOL ok = FALSE;
844 845

  /* Check both the current user and the local machine to see if
846
     we have any resources.  */
847

848 849 850 851
  if (RegOpenKeyEx (HKEY_CURRENT_USER, REG_ROOT, 0, KEY_READ, &hrootkey) == ERROR_SUCCESS)
    {
      lpvalue = NULL;

852 853
      if (RegQueryValueEx (hrootkey, key, NULL, NULL, NULL, &cbData) == ERROR_SUCCESS
	  && (lpvalue = (LPBYTE) xmalloc (cbData)) != NULL
854 855 856 857 858 859
	  && RegQueryValueEx (hrootkey, key, NULL, lpdwtype, lpvalue, &cbData) == ERROR_SUCCESS)
	{
	  return (lpvalue);
	}

      if (lpvalue) xfree (lpvalue);
860

861
      RegCloseKey (hrootkey);
862 863
    }

864 865 866
  if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, REG_ROOT, 0, KEY_READ, &hrootkey) == ERROR_SUCCESS)
    {
      lpvalue = NULL;
867

Geoff Voelker's avatar
Geoff Voelker committed
868 869 870
      if (RegQueryValueEx (hrootkey, key, NULL, NULL, NULL, &cbData) == ERROR_SUCCESS
	  && (lpvalue = (LPBYTE) xmalloc (cbData)) != NULL
	  && RegQueryValueEx (hrootkey, key, NULL, lpdwtype, lpvalue, &cbData) == ERROR_SUCCESS)
871 872 873
	{
	  return (lpvalue);
	}
874

875
      if (lpvalue) xfree (lpvalue);
876

877
      RegCloseKey (hrootkey);
878 879
    }

880 881 882
  return (NULL);
}

883 884 885
char *get_emacs_configuration (void);
extern Lisp_Object Vsystem_configuration;

886
void
887
init_environment (char ** argv)
888
{
Karl Heuer's avatar
Karl Heuer committed
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
  static const char * const tempdirs[] = {
    "$TMPDIR", "$TEMP", "$TMP", "c:/"
  };
  int i;
  const int imax = sizeof (tempdirs) / sizeof (tempdirs[0]);

  /* Make sure they have a usable $TMPDIR.  Many Emacs functions use
     temporary files and assume "/tmp" if $TMPDIR is unset, which
     will break on DOS/Windows.  Refuse to work if we cannot find
     a directory, not even "c:/", usable for that purpose.  */
  for (i = 0; i < imax ; i++)
    {
      const char *tmp = tempdirs[i];

      if (*tmp == '$')
	tmp = getenv (tmp + 1);
      /* Note that `access' can lie to us if the directory resides on a
	 read-only filesystem, like CD-ROM or a write-protected floppy.
	 The only way to be really sure is to actually create a file and
	 see if it succeeds.  But I think that's too much to ask.  */
909
      if (tmp && _access (tmp, D_OK) == 0)
Karl Heuer's avatar
Karl Heuer committed
910 911 912
	{
	  char * var = alloca (strlen (tmp) + 8);
	  sprintf (var, "TMPDIR=%s", tmp);
913
	  _putenv (strdup (var));
Karl Heuer's avatar
Karl Heuer committed
914 915 916 917 918 919 920 921 922 923
	  break;
	}
    }
  if (i >= imax)
    cmd_error_internal
      (Fcons (Qerror,
	      Fcons (build_string ("no usable temporary directories found!!"),
		     Qnil)),
       "While setting TMPDIR: ");

924 925
  /* Check for environment variables and use registry settings if they
     don't exist.  Fallback on default values where applicable.  */
926
  {
927 928 929
    int i;
    LPBYTE lpval;
    DWORD dwType;
930
    char locale_name[32];
931

932 933 934 935
    static struct env_entry
    {
      char * name;
      char * def_value;
936
    } env_vars[] =
937 938 939 940
    {
      {"HOME", "C:/"},
      {"PRELOAD_WINSOCK", NULL},
      {"emacs_dir", "C:/emacs"},
941
      {"EMACSLOADPATH", "%emacs_dir%/site-lisp;%emacs_dir%/../site-lisp;%emacs_dir%/lisp;%emacs_dir%/leim"},
942 943 944
      {"SHELL", "%emacs_dir%/bin/cmdproxy.exe"},
      {"EMACSDATA", "%emacs_dir%/etc"},
      {"EMACSPATH", "%emacs_dir%/bin"},
Geoff Voelker's avatar
Geoff Voelker committed
945
      /* We no longer set INFOPATH because Info-default-directory-list
946 947 948
	 is then ignored.  */
      /*  {"INFOPATH", "%emacs_dir%/info"},  */
      {"EMACSDOC", "%emacs_dir%/etc"},
949 950
      {"TERM", "cmd"},
      {"LANG", NULL},
951 952
    };

953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
  /* Get default locale info and use it for LANG.  */
  if (GetLocaleInfo (LOCALE_USER_DEFAULT,
                     LOCALE_SABBREVLANGNAME | LOCALE_USE_CP_ACP,
                     locale_name, sizeof (locale_name)))
    {
      for (i = 0; i < (sizeof (env_vars) / sizeof (env_vars[0])); i++)
        {
          if (strcmp (env_vars[i].name, "LANG") == 0)
            {
              env_vars[i].def_value = locale_name;
              break;
            }
        }
    }

968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
#define SET_ENV_BUF_SIZE (4 * MAX_PATH)	/* to cover EMACSLOADPATH */

    /* Treat emacs_dir specially: set it unconditionally based on our
       location, if it appears that we are running from the bin subdir
       of a standard installation.  */
    {
      char *p;
      char modname[MAX_PATH];

      if (!GetModuleFileName (NULL, modname, MAX_PATH))
	abort ();
      if ((p = strrchr (modname, '\\')) == NULL)
	abort ();
      *p = 0;

      if ((p = strrchr (modname, '\\')) && stricmp (p, "\\bin") == 0)
	{
	  char buf[SET_ENV_BUF_SIZE];

	  *p = 0;
	  for (p = modname; *p; p++)
	    if (*p == '\\') *p = '/';
990

991
	  _snprintf (buf, sizeof(buf)-1, "emacs_dir=%s", modname);
992
	  _putenv (strdup (buf));
993 994 995
	}
    }

996
    for (i = 0; i < (sizeof (env_vars) / sizeof (env_vars[0])); i++)
997
      {
998
	if (!getenv (env_vars[i].name))
999
	  {
1000
	    int dont_free = 0;
1001

1002 1003 1004 1005 1006
	    if ((lpval = w32_get_resource (env_vars[i].name, &dwType)) == NULL)
	      {
		lpval = env_vars[i].def_value;
		dwType = REG_EXPAND_SZ;
		dont_free = 1;
1007
	      }
1008 1009

	    if (lpval)
1010
	      {
1011 1012 1013 1014 1015 1016
		if (dwType == REG_EXPAND_SZ)
		  {
		    char buf1[SET_ENV_BUF_SIZE], buf2[SET_ENV_BUF_SIZE];

		    ExpandEnvironmentStrings ((LPSTR) lpval, buf1, sizeof(buf1));
		    _snprintf (buf2, sizeof(buf2)-1, "%s=%s", env_vars[i].name, buf1);
1017
		    _putenv (strdup (buf2));
1018 1019 1020 1021
		  }
		else if (dwType == REG_SZ)
		  {
		    char buf[SET_ENV_BUF_SIZE];
1022

1023
		    _snprintf (buf, sizeof(buf)-1, "%s=%s", env_vars[i].name, lpval);
1024
		    _putenv (strdup (buf));
1025
		  }
1026

1027 1028 1029
		if (!dont_free)
		  xfree (lpval);
	      }
1030 1031 1032 1033
	  }
      }
  }

1034 1035 1036
  /* Rebuild system configuration to reflect invoking system.  */
  Vsystem_configuration = build_string (EMACS_CONFIGURATION);

Geoff Voelker's avatar
Geoff Voelker committed
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
  /* Another special case: on NT, the PATH variable is actually named
     "Path" although cmd.exe (perhaps NT itself) arranges for
     environment variable lookup and setting to be case insensitive.
     However, Emacs assumes a fully case sensitive environment, so we
     need to change "Path" to "PATH" to match the expectations of
     various elisp packages.  We do this by the sneaky method of
     modifying the string in the C runtime environ entry.

     The same applies to COMSPEC.  */
  {
    char ** envp;

    for (envp = environ; *envp; envp++)
      if (_strnicmp (*envp, "PATH=", 5) == 0)
	memcpy (*envp, "PATH=", 5);
      else if (_strnicmp (*envp, "COMSPEC=", 8) == 0)
	memcpy (*envp, "COMSPEC=", 8);
  }

  /* Remember the initial working directory for getwd, then make the
     real wd be the location of emacs.exe to avoid conflicts when
     renaming or deleting directories.  (We also don't call chdir when
     running subprocesses for the same reason.)  */
  if (!GetCurrentDirectory (MAXPATHLEN, startup_dir))
    abort ();

  {
    char *p;
1065
    static char modname[MAX_PATH];
Geoff Voelker's avatar
Geoff Voelker committed
1066 1067 1068 1069 1070 1071 1072 1073

    if (!GetModuleFileName (NULL, modname, MAX_PATH))
      abort ();
    if ((p = strrchr (modname, '\\')) == NULL)
      abort ();
    *p = 0;

    SetCurrentDirectory (modname);
1074 1075 1076 1077

    /* Ensure argv[0] has the full path to Emacs.  */
    *p = '\\';
    argv[0] = modname;
Geoff Voelker's avatar
Geoff Voelker committed
1078 1079
  }

1080 1081 1082 1083 1084
  /* Determine if there is a middle mouse button, to allow parse_button
     to decide whether right mouse events should be mouse-2 or
     mouse-3. */
  XSETINT (Vw32_num_mouse_buttons, GetSystemMetrics (SM_CMOUSEBUTTONS));

1085 1086 1087
  init_user_info ();
}

1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
char *
emacs_root_dir (void)
{
  static char root_dir[FILENAME_MAX];
  const char *p;

  p = getenv ("emacs_dir");
  if (p == NULL)
    abort ();
  strcpy (root_dir, p);
  root_dir[parse_root (root_dir, NULL)] = '\0';
  dostounix_filename (root_dir);
  return root_dir;
}

1103 1104 1105 1106 1107 1108 1109 1110 1111
/* We don't have scripts to automatically determine the system configuration
   for Emacs before it's compiled, and we don't want to have to make the
   user enter it, so we define EMACS_CONFIGURATION to invoke this runtime
   routine.  */

char *
get_emacs_configuration (void)
{
  char *arch, *oem, *os;
1112
  int build_num;
1113
  static char configuration_buffer[32];
1114 1115

  /* Determine the processor type.  */
1116
  switch (get_processor_type ())
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
    {

#ifdef PROCESSOR_INTEL_386
    case PROCESSOR_INTEL_386:
    case PROCESSOR_INTEL_486:
    case PROCESSOR_INTEL_PENTIUM:
      arch = "i386";
      break;
#endif

#ifdef PROCESSOR_INTEL_860
    case PROCESSOR_INTEL_860:
      arch = "i860";
      break;
#endif

#ifdef PROCESSOR_MIPS_R2000
    case PROCESSOR_MIPS_R2000:
    case PROCESSOR_MIPS_R3000:
    case PROCESSOR_MIPS_R4000:
      arch = "mips";
      break;
#endif

#ifdef PROCESSOR_ALPHA_21064
    case PROCESSOR_ALPHA_21064:
      arch = "alpha";
      break;
#endif

    default:
      arch = "unknown";
      break;
1150
    }
1151

1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
  /* Use the OEM field to reflect the compiler/library combination.  */
#ifdef _MSC_VER
#define COMPILER_NAME	"msvc"
#else
#ifdef __GNUC__
#define COMPILER_NAME	"mingw"
#else
#define COMPILER_NAME	"unknown"
#endif
#endif
  oem = COMPILER_NAME;
1163

1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
  switch (osinfo_cache.dwPlatformId) {
  case VER_PLATFORM_WIN32_NT:
    os = "nt";
    build_num = osinfo_cache.dwBuildNumber;
    break;
  case VER_PLATFORM_WIN32_WINDOWS:
    if (osinfo_cache.dwMinorVersion == 0) {
      os = "windows95";
    } else {
      os = "windows98";
    }
    build_num = LOWORD (osinfo_cache.dwBuildNumber);
    break;
  case VER_PLATFORM_WIN32s:
    /* Not supported, should not happen. */
    os = "windows32s";
    build_num = LOWORD (osinfo_cache.dwBuildNumber);
    break;
  default:
    os = "unknown";
    build_num = 0;
    break;
  }

  if (osinfo_cache.dwPlatformId == VER_PLATFORM_WIN32_NT) {
    sprintf (configuration_buffer, "%s-%s-%s%d.%d.%d", arch, oem, os,
	     get_w32_major_version (), get_w32_minor_version (), build_num);
  } else {
    sprintf (configuration_buffer, "%s-%s-%s.%d", arch, oem, os, build_num);
  }
1194 1195

  return configuration_buffer;
1196 1197
}

1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
char *
get_emacs_configuration_options (void)
{
  static char options_buffer[256];

/* Work out the effective configure options for this build.  */
#ifdef _MSC_VER
#define COMPILER_VERSION	"--with-msvc (%d.%02d)", _MSC_VER / 100, _MSC_VER % 100
#else
#ifdef __GNUC__
#define COMPILER_VERSION	"--with-gcc (%d.%d)", __GNUC__, __GNUC_MINOR__
#else
#define COMPILER_VERSION	""
#endif
#endif

  sprintf (options_buffer, COMPILER_VERSION);
#ifdef EMACSDEBUG
  strcat (options_buffer, " --no-opt");
#endif
#ifdef USER_CFLAGS
  strcat (options_buffer, " --cflags");
  strcat (options_buffer, USER_CFLAGS);
#endif
#ifdef USER_LDFLAGS
  strcat (options_buffer, " --ldflags");
  strcat (options_buffer, USER_LDFLAGS);
#endif
  return options_buffer;
}


Karl Heuer's avatar
Karl Heuer committed
1230 1231 1232
#include <sys/timeb.h>

/* Emulate gettimeofday (Ulrich Leodolter, 1/11/95).  */
1233
void
Karl Heuer's avatar
Karl Heuer committed
1234 1235
gettimeofday (struct timeval *tv, struct timezone *tz)
{
1236
  struct timeb tb;
Karl Heuer's avatar
Karl Heuer committed
1237 1238 1239 1240
  _ftime (&tb);

  tv->tv_sec = tb.time;
  tv->tv_usec = tb.millitm * 1000L;
1241
  if (tz)
Karl Heuer's avatar
Karl Heuer committed
1242 1243 1244 1245 1246 1247
    {
      tz->tz_minuteswest = tb.timezone;	/* minutes west of Greenwich  */
      tz->tz_dsttime = tb.dstflag;	/* type of dst correction  */
    }
}

1248
/* ------------------------------------------------------------------------- */
1249
/* IO support and wrapper functions for W32 API. */
1250
/* ------------------------------------------------------------------------- */
Richard M. Stallman's avatar
Richard M. Stallman committed
1251

1252
/* Place a wrapper around the MSVC version of ctime.  It returns NULL
1253
   on network directories, so we handle that case here.
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
   (Ulrich Leodolter, 1/11/95).  */
char *
sys_ctime (const time_t *t)
{
  char *str = (char *) ctime (t);
  return (str ? str : "Sun Jan 01 00:00:00 1970");
}

/* Emulate sleep...we could have done this with a define, but that
   would necessitate including windows.h in the files that used it.
   This is much easier.  */
void
sys_sleep (int seconds)
{
  Sleep (seconds * 1000);
}

Geoff Voelker's avatar
Geoff Voelker committed
1271
/* Internal MSVC functions for low-level descriptor munging */
1272 1273 1274 1275 1276 1277
extern int __cdecl _set_osfhnd (int fd, long h);
extern int __cdecl _free_osfhnd (int fd);

/* parallel array of private info on file handles */
filedesc fd_info [ MAXDESC ];

Geoff Voelker's avatar
Geoff Voelker committed
1278 1279 1280 1281 1282 1283 1284 1285
typedef struct volume_info_data {
  struct volume_info_data * next;

  /* time when info was obtained */
  DWORD     timestamp;

  /* actual volume info */
  char *    root_dir;
1286 1287 1288
  DWORD     serialnum;
  DWORD     maxcomp;
  DWORD     flags;
Geoff Voelker's avatar
Geoff Voelker committed
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
  char *    name;
  char *    type;
} volume_info_data;

/* Global referenced by various functions.  */
static volume_info_data volume_info;

/* Vector to indicate which drives are local and fixed (for which cached
   data never expires).  */
static BOOL fixed_drives[26];

/* Consider cached volume information to be stale if older than 10s,
   at least for non-local drives.  Info for fixed drives is never stale.  */
#define DRIVE_INDEX( c ) ( (c) <= 'Z' ? (c) - 'A' : (c) - 'a' )
#define VOLINFO_STILL_VALID( root_dir, info )		\
  ( ( isalpha (root_dir[0]) &&				\
      fixed_drives[ DRIVE_INDEX (root_dir[0]) ] )	\
    || GetTickCount () - info->timestamp < 10000 )

/* Cache support functions.  */

/* Simple linked list with linear search is sufficient.  */
static volume_info_data *volume_cache = NULL;

static volume_info_data *
lookup_volume_info (char * root_dir)
{
  volume_info_data * info;

  for (info = volume_cache; info; info = info->next)
    if (stricmp (info->root_dir, root_dir) == 0)
      break;
  return info;
}

static void
add_volume_info (char * root_dir, volume_info_data * info)
{
1327
  info->root_dir = xstrdup (root_dir);
Geoff Voelker's avatar
Geoff Voelker committed
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
  info->next = volume_cache;
  volume_cache = info;
}


/* Wrapper for GetVolumeInformation, which uses caching to avoid
   performance penalty (~2ms on 486 for local drives, 7.5ms for local
   cdrom drive, ~5-10ms or more for remote drives on LAN).  */
volume_info_data *
GetCachedVolumeInformation (char * root_dir)
{
  volume_info_data * info;
  char default_root[ MAX_PATH ];

  /* NULL for root_dir means use root from current directory.  */
  if (root_dir == NULL)
    {
      if (GetCurrentDirectory (MAX_PATH, default_root) == 0)
	return NULL;
      parse_root (default_root, &root_dir);
      *root_dir = 0;
      root_dir = default_root;
    }

  /* Local fixed drives can be cached permanently.  Removable drives
     cannot be cached permanently, since the volume name and serial
     number (if nothing else) can change.  Remote drives should be
     treated as if they are removable, since there is no sure way to
     tell whether they are or not.  Also, the UNC association of drive
     letters mapped to remote volumes can be changed at any time (even
     by other processes) without notice.
1359

Geoff Voelker's avatar
Geoff Voelker committed
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
     As a compromise, so we can benefit from caching info for remote
     volumes, we use a simple expiry mechanism to invalidate cache
     entries that are more than ten seconds old.  */

#if 0
  /* No point doing this, because WNetGetConnection is even slower than
     GetVolumeInformation, consistently taking ~50ms on a 486 (FWIW,
     GetDriveType is about the only call of this type which does not
     involve network access, and so is extremely quick).  */

  /* Map drive letter to UNC if remote. */
  if ( isalpha( root_dir[0] ) && !fixed[ DRIVE_INDEX( root_dir[0] ) ] )
    {
      char remote_name[ 256 ];
      char drive[3] = { root_dir[0], ':' };

      if (WNetGetConnection (drive, remote_name, sizeof (remote_name))
	  == NO_ERROR)
	/* do something */ ;
    }
#endif

  info = lookup_volume_info (root_dir);

  if (info == NULL || ! VOLINFO_STILL_VALID (root_dir, info))
  {
    char  name[ 256 ];
    DWORD serialnum;
    DWORD maxcomp;
    DWORD flags;
    char  type[ 256 ];

    /* Info is not cached, or is stale. */
    if (!GetVolumeInformation (root_dir,
			       name, sizeof (name),
			       &serialnum,
			       &maxcomp,
			       &flags,
			       type, sizeof (type)))
      return NULL;

    /* Cache the volume information for future use, overwriting existing
       entry if present.  */
    if (info == NULL)
      {
	info = (volume_info_data *) xmalloc (sizeof (volume_info_data));
	add_volume_info (root_dir, info);
      }
    else
      {
1410 1411
	xfree (info->name);
	xfree (info->type);
Geoff Voelker's avatar
Geoff Voelker committed
1412 1413
      }