]> sjero.net Git - wget/blobdiff - src/mswindows.c
[svn] Fix a possible race condition when opening files.
[wget] / src / mswindows.c
index 424bb7eb0eaa4435774c8c430365b2bc6bff7183..22605a95d8fa6b345824c28e6681a43c090117d5 100644 (file)
@@ -1,5 +1,6 @@
 /* mswindows.c -- Windows-specific support
-   Copyright (C) 1995, 1996, 1997, 1998, 2004  Free Software Foundation, Inc.
+   Copyright (C) 1995, 1996, 1997, 1998, 2004
+   Free Software Foundation, Inc.
 
 This file is part of GNU Wget.
 
@@ -27,8 +28,6 @@ modify this file, you may extend this exception to your version of the
 file, but you are not obligated to do so.  If you do not wish to do
 so, delete this exception statement from your version.  */
 
-/* #### Someone please document what these functions do!  */
-
 #include <config.h>
 
 #include <stdio.h>
@@ -69,11 +68,6 @@ extern int errno;
 /* Defined in log.c.  */
 void log_request_redirect_output PARAMS ((const char *));
 
-static DWORD set_sleep_mode (DWORD mode);
-
-static DWORD pwr_mode = 0;
-static int windows_nt_p;
-
 /* Windows version of xsleep in utils.c.  */
 
 void
@@ -92,6 +86,129 @@ xsleep (double seconds)
 #endif /* not HAVE_USLEEP */
 }
 
+#if defined(__BORLANDC__) || (defined(_MSC_VER) && _MSC_VER < 1300)
+
+static inline int
+char_value (char c, int base)
+{
+  int value;
+  if (c < '0')
+    return -1;
+  if ('0' <= c && c <= '9')
+    value = c - '0';
+  else if ('a' <= c && c <= 'z')
+    value = c - 'a' + 10;
+  else if ('A' <= c && c <= 'Z')
+    value = c - 'A' + 10;
+  else
+    return -1;
+  if (value >= base)
+    return -1;
+  return value;
+}
+
+/* A fairly simple strtoll replacement for MS VC versions that don't
+   supply _strtoi64.  */
+
+__int64
+str_to_int64 (const char *nptr, char **endptr, int base)
+{
+#define OVERFLOW 9223372036854775807I64
+#define UNDERFLOW (-OVERFLOW - 1)
+
+  __int64 result = 0;
+  int negative;
+
+  if (base != 0 && (base < 2 || base > 36))
+    {
+      errno = EINVAL;
+      return 0;
+    }
+
+  while (*nptr == ' ' || *nptr == '\t')
+    ++nptr;
+  if (*nptr == '-')
+    {
+      negative = 1;
+      ++nptr;
+    }
+  else if (*nptr == '+')
+    {
+      negative = 0;
+      ++nptr;
+    }
+  else
+    negative = 0;
+
+  /* If base is 0, determine the real base based on the beginning on
+     the number; octal numbers begin with "0", hexadecimal with "0x",
+     and the others are considered octal.  */
+  if (*nptr == '0')
+    {
+      if ((base == 0 || base == 16)
+         &&
+         (*(nptr + 1) == 'x' || *(nptr + 1) == 'X'))
+       {
+         base = 16;
+         nptr += 2;
+       }
+      else if (base == 0)
+       base = 8;
+    }
+  else if (base == 0)
+    base = 10;
+
+  if (!negative)
+    {
+      /* Parse positive number, checking for overflow. */
+      int val;
+      for (; (val = char_value (*nptr, base)) != -1; ++nptr)
+       {
+         __int64 newresult = base * result + val;
+         if (newresult < result)
+           {
+             result = OVERFLOW;
+             errno = ERANGE;
+             break;
+           }
+         result = newresult;
+       }
+    }
+  else
+    {
+      /* Parse negative number, checking for underflow. */
+      int val;
+      for (; (val = char_value (*nptr, base)) != -1; ++nptr)
+       {
+         __int64 newresult = base * result - val;
+         if (newresult > result)
+           {
+             result = UNDERFLOW;
+             errno = ERANGE;
+             break;
+           }
+         result = newresult;
+       }
+    }
+  if (endptr)
+    *endptr = (char *) nptr;
+  return result;
+}
+
+#else  /* !defined(__BORLANDC__) && (!defined(_MSC_VER) || _MSC_VER >= 1300) */
+
+__int64
+str_to_int64 (const char *nptr, char **endptr, int base)
+{
+#ifdef _MSC_VER
+  return _strtoi64 (nptr, endptr, base);
+#else
+  return strtoll (nptr, endptr, base);
+#endif
+}
+
+#endif /* !defined(__BORLANDC__) && (!defined(_MSC_VER) || _MSC_VER >= 1300) */
+
 void
 windows_main_junk (int *argc, char **argv, char **exec_name)
 {
@@ -104,41 +221,253 @@ windows_main_junk (int *argc, char **argv, char **exec_name)
     *p = '\0';
 }
 \f
-/* Winsock stuff. */
-
 static void
 ws_cleanup (void)
 {
   WSACleanup ();
-  if (pwr_mode)
-     set_sleep_mode (pwr_mode);
-  pwr_mode = 0;
 }
 
 static void
-ws_hangup (void)
+ws_hangup (const char *reason)
 {
-  log_request_redirect_output ("CTRL+Break");
+  fprintf (stderr, _("Continuing in background.\n"));
+  log_request_redirect_output (reason);
+
+  /* Detach process from the current console.  Under Windows 9x, if we
+     were launched from a 16-bit process (which is usually the case;
+     command.com is 16-bit) the parent process should resume right away.
+     Under NT or if launched from a 32-process under 9x, this is a futile
+     gesture as the parent will wait for us to terminate before resuming.  */
+  FreeConsole ();
 }
 
-void
-fork_to_background (void)
+/* Construct the name for a named section (a.k.a. `file mapping') object.
+   The returned string is dynamically allocated and needs to be xfree()'d.  */
+static char *
+make_section_name (DWORD pid)
 {
-  /* Whether we arrange our own version of opt.lfilename here.  */
-  int changedp = 0;
+  return aprintf ("gnu_wget_fake_fork_%lu", pid);
+}
+
+/* This structure is used to hold all the data that is exchanged between
+   parent and child.  */
+struct fake_fork_info
+{
+  HANDLE event;
+  int logfile_changed;
+  char lfilename[MAX_PATH + 1];
+};
 
+/* Determines if we are the child and if so performs the child logic.
+   Return values:
+     < 0  error
+       0  parent
+     > 0  child
+*/
+static int
+fake_fork_child (void)
+{
+  HANDLE section, event;
+  struct fake_fork_info *info;
+  char *name;
+
+  name = make_section_name (GetCurrentProcessId ());
+  section = OpenFileMapping (FILE_MAP_WRITE, FALSE, name);
+  xfree (name);
+  /* It seems that Windows 9x and NT set last-error inconsistently when
+     OpenFileMapping() fails; so we assume it failed because the section
+     object does not exist.  */
+  if (!section)
+    return 0;                   /* We are the parent.  */
+
+  info = MapViewOfFile (section, FILE_MAP_WRITE, 0, 0, 0);
+  if (!info)
+    {
+      CloseHandle (section);
+      return -1;
+    }
+
+  event = info->event;
+
+  info->logfile_changed = 0;
   if (!opt.lfilename)
     {
-      opt.lfilename = unique_name (DEFAULT_LOGFILE, 0);
-      changedp = 1;
+      /* See utils:fork_to_background for explanation. */
+      FILE *new_log_fp = unique_create (DEFAULT_LOGFILE, 0, &opt.lfilename);
+      if (new_log_fp)
+       {
+         info->logfile_changed = 1;
+         strncpy (info->lfilename, opt.lfilename, sizeof (info->lfilename));
+         info->lfilename[sizeof (info->lfilename) - 1] = '\0';
+         fclose (new_log_fp);
+       }
+    }
+
+  UnmapViewOfFile (info);
+  CloseHandle (section);
+
+  /* Inform the parent that we've done our part.  */
+  if (!SetEvent (event))
+    return -1;
+
+  CloseHandle (event);
+  return 1;                     /* We are the child.  */
+}
+
+/* Windows doesn't support the fork() call; so we fake it by invoking
+   another copy of Wget with the same arguments with which we were
+   invoked.  The child copy of Wget should perform the same initialization
+   sequence as the parent; so we should have two processes that are
+   essentially identical.  We create a specially named section object that
+   allows the child to distinguish itself from the parent and is used to
+   exchange information between the two processes.  We use an event object
+   for synchronization.  */
+static void
+fake_fork (void)
+{
+  char exe[MAX_PATH + 1];
+  DWORD exe_len, le;
+  SECURITY_ATTRIBUTES sa;
+  HANDLE section, event, h[2];
+  STARTUPINFO si;
+  PROCESS_INFORMATION pi;
+  struct fake_fork_info *info;
+  char *name;
+  BOOL rv;
+
+  event = section = pi.hProcess = pi.hThread = NULL;
+
+  /* Get the fully qualified name of our executable.  This is more reliable
+     than using argv[0].  */
+  exe_len = GetModuleFileName (GetModuleHandle (NULL), exe, sizeof (exe));
+  if (!exe_len || (exe_len >= sizeof (exe)))
+    return;
+
+  sa.nLength = sizeof (sa);
+  sa.lpSecurityDescriptor = NULL;
+  sa.bInheritHandle = TRUE;
+
+  /* Create an anonymous inheritable event object that starts out
+     non-signaled.  */
+  event = CreateEvent (&sa, FALSE, FALSE, NULL);
+  if (!event)
+    return;
+
+  /* Create the child process detached form the current console and in a
+     suspended state.  */
+  memset (&si, 0, sizeof (si));
+  si.cb = sizeof (si);
+  rv = CreateProcess (exe, GetCommandLine (), NULL, NULL, TRUE,
+                      CREATE_SUSPENDED | DETACHED_PROCESS,
+                      NULL, NULL, &si, &pi);
+  if (!rv)
+    goto cleanup;
+
+  /* Create a named section object with a name based on the process id of
+     the child.  */
+  name = make_section_name (pi.dwProcessId);
+  section =
+      CreateFileMapping (INVALID_HANDLE_VALUE, NULL, PAGE_READWRITE, 0,
+                         sizeof (struct fake_fork_info), name);
+  le = GetLastError();
+  xfree (name);
+  /* Fail if the section object already exists (should not happen).  */
+  if (!section || (le == ERROR_ALREADY_EXISTS))
+    {
+      rv = FALSE;
+      goto cleanup;
+    }
+
+  /* Copy the event handle into the section object.  */
+  info = MapViewOfFile (section, FILE_MAP_WRITE, 0, 0, 0);
+  if (!info)
+    {
+      rv = FALSE;
+      goto cleanup;
+    }
+
+  info->event = event;
+
+  UnmapViewOfFile (info);
+
+  /* Start the child process.  */
+  rv = ResumeThread (pi.hThread);
+  if (!rv)
+    {
+      TerminateProcess (pi.hProcess, (DWORD) -1);
+      goto cleanup;
+    }
+
+  /* Wait for the child to signal to us that it has done its part.  If it
+     terminates before signaling us it's an error.  */
+
+  h[0] = event;
+  h[1] = pi.hProcess;
+  rv = WAIT_OBJECT_0 == WaitForMultipleObjects (2, h, FALSE, 5 * 60 * 1000);
+  if (!rv)
+    goto cleanup;
+
+  info = MapViewOfFile (section, FILE_MAP_READ, 0, 0, 0);
+  if (!info)
+    {
+      rv = FALSE;
+      goto cleanup;
     }
-  printf (_("Continuing in background.\n"));
-  if (changedp)
-    printf (_("Output will be written to `%s'.\n"), opt.lfilename);
 
-  ws_hangup ();
-  if (!windows_nt_p)
-    FreeConsole ();
+  /* Ensure string is properly terminated.  */
+  if (info->logfile_changed &&
+      !memchr (info->lfilename, '\0', sizeof (info->lfilename)))
+    {
+      rv = FALSE;
+      goto cleanup;
+    }
+
+  printf (_("Continuing in background, pid %lu.\n"), pi.dwProcessId);
+  if (info->logfile_changed)
+    printf (_("Output will be written to `%s'.\n"), info->lfilename);
+
+  UnmapViewOfFile (info);
+
+cleanup:
+
+  if (event)
+    CloseHandle (event);
+  if (section)
+    CloseHandle (section);
+  if (pi.hThread)
+    CloseHandle (pi.hThread);
+  if (pi.hProcess)
+    CloseHandle (pi.hProcess);
+
+  /* We're the parent.  If all is well, terminate.  */
+  if (rv)
+    exit (0);
+
+  /* We failed, return.  */
+}
+
+/* This is the corresponding Windows implementation of the
+   fork_to_background() function in utils.c.  */
+void
+fork_to_background (void)
+{
+  int rv;
+
+  rv = fake_fork_child ();
+  if (rv < 0)
+    {
+      fprintf (stderr, "fake_fork_child() failed\n");
+      abort ();
+    }
+  else if (rv == 0)
+    {
+      /* We're the parent.  */
+      fake_fork ();
+      /* If fake_fork() returns, it failed.  */
+      fprintf (stderr, "fake_fork() failed\n");
+      abort ();
+    }
+  /* If we get here, we're the child.  */
 }
 
 static BOOL WINAPI
@@ -148,53 +477,68 @@ ws_handler (DWORD dwEvent)
     {
 #ifdef CTRLC_BACKGND
     case CTRL_C_EVENT:
+      ws_hangup ("CTRL+C");
+      return TRUE;
 #endif
 #ifdef CTRLBREAK_BACKGND
     case CTRL_BREAK_EVENT:
+      ws_hangup ("CTRL+Break");
+      return TRUE;
 #endif
-      fork_to_background ();
-      break;
-    case CTRL_SHUTDOWN_EVENT:
-    case CTRL_CLOSE_EVENT:
-    case CTRL_LOGOFF_EVENT:
     default:
-      ws_cleanup ();
       return FALSE;
     }
-  return TRUE;
 }
 
 static char *title_buf = NULL;
 static char *curr_url  = NULL;
-static int   num_urls  = 0;
+static int old_percentage = -1;
 
+/* Updates the console title with the URL of the current file being
+   transferred.  */
 void
-ws_changetitle (const char *url, int nurl)
+ws_changetitle (const char *url)
 {
-  if (!nurl)
-    return;
-
-  num_urls = nurl;
-  if (title_buf)
-     xfree(title_buf);
-  if (curr_url)
-     xfree(curr_url);
+  xfree_null (title_buf);
+  xfree_null (curr_url);
   title_buf = (char *)xmalloc (strlen (url) + 20);
-  curr_url = xstrdup(url);
-  sprintf(title_buf, "Wget %s%s", url, nurl == 1 ? "" : " ...");
-  SetConsoleTitle(title_buf);
+  curr_url = xstrdup (url);
+  old_percentage = -1;
+  sprintf (title_buf, "Wget %s", curr_url);
+  SetConsoleTitle (title_buf);
 }
 
+/* Updates the console title with the percentage of the current file
+   transferred.  */
 void
-ws_percenttitle (double percent)
+ws_percenttitle (double percentage_float)
 {
-  if (num_urls == 1 && title_buf && curr_url && fabs(percent) <= 100.0)
-    {
-      sprintf (title_buf, "Wget [%.0f%%] %s", percent, curr_url);
-      SetConsoleTitle (title_buf);
-    }
+  int percentage;
+
+  if (!title_buf || !curr_url)
+    return;
+
+  percentage = (int) percentage_float;
+
+  /* Clamp percentage value.  */
+  if (percentage < 0)
+    percentage = 0;
+  if (percentage > 100)
+    percentage = 100;
+
+  /* Only update the title when the percentage has changed.  */
+  if (percentage == old_percentage)
+    return;
+
+  old_percentage = percentage;
+
+  sprintf (title_buf, "Wget [%d%%] %s", percentage, curr_url);
+  SetConsoleTitle (title_buf);
 }
 
+/* Returns a pointer to the fully qualified name of the directory that
+   contains the Wget binary (wget.exe).  The returned path does not have a
+   trailing path separator.  Returns NULL on failure.  */
 char *
 ws_mypath (void)
 {
@@ -221,43 +565,34 @@ ws_mypath (void)
   return wspathsave;
 }
 
-void
-ws_help (const char *name)
+/* Prevent Windows entering sleep/hibernation-mode while Wget is doing
+   a lengthy transfer.  Windows does not, by default, consider network
+   activity in console-programs as activity!  Works on Win-98/ME/2K
+   and up.  */
+static void
+set_sleep_mode (void)
 {
-  char *mypath = ws_mypath ();
+  typedef DWORD (WINAPI *func_t) (DWORD);
+  func_t set_exec_state;
 
-  if (mypath)
-    {
-      struct stat sbuf;
-      char *buf = (char *)alloca (strlen (mypath) + strlen (name) + 4 + 1);
-      sprintf (buf, "%s%s.HLP", mypath, name);
-      if (stat (buf, &sbuf) == 0) 
-       {
-          printf (_("Starting WinHelp %s\n"), buf);
-          WinHelp (NULL, buf, HELP_INDEX, 0);
-        }
-      else
-        {
-          printf ("%s: %s\n", buf, strerror (errno));
-        }
-    }
+  set_exec_state =
+      (func_t) GetProcAddress (GetModuleHandle ("KERNEL32.DLL"),
+                               "SetThreadExecutionState");
+
+  if (set_exec_state)
+    set_exec_state (ES_SYSTEM_REQUIRED | ES_CONTINUOUS);
 }
 
+/* Perform Windows specific initialization.  */
 void
 ws_startup (void)
 {
   WORD requested;
   WSADATA data;
   int err;
-  OSVERSIONINFO os;
-
-  if (GetVersionEx (&os) == TRUE
-      && os.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS)
-    windows_nt_p = 1;
 
   requested = MAKEWORD (1, 1);
   err = WSAStartup (requested, &data);
-
   if (err != 0)
     {
       fprintf (stderr, _("%s: Couldn't find usable socket driver.\n"),
@@ -272,8 +607,9 @@ ws_startup (void)
       WSACleanup ();
       exit (1);
     }
+
   atexit (ws_cleanup);
-  pwr_mode = set_sleep_mode (0);
+  set_sleep_mode ();
   SetConsoleCtrlHandler (ws_handler, TRUE);
 }
 
@@ -304,47 +640,18 @@ borland_utime (const char *path, const struct utimbuf *times)
   return res;
 }
 #endif
-
-/*
- * Prevent Windows entering sleep/hibernation-mode while wget is doing
- * a lengthy transfer.  Windows does by default not consider network
- * activity in console-programs as activity !  Works on Win-98/ME/2K
- * and up.
- */
-static DWORD
-set_sleep_mode (DWORD mode)
-{
-  HMODULE mod = LoadLibrary ("kernel32.dll");
-  DWORD (WINAPI *_SetThreadExecutionState) (DWORD) = NULL;
-  DWORD rc = (DWORD)-1;
-
-  if (mod)
-     (void *)_SetThreadExecutionState
-       = GetProcAddress ((HINSTANCE)mod, "SetThreadExecutionState");
-
-  if (_SetThreadExecutionState)
-    {
-      if (mode == 0)  /* first time */
-       mode = (ES_SYSTEM_REQUIRED | ES_CONTINUOUS);
-      rc = (*_SetThreadExecutionState) (mode);
-    }
-  if (mod)
-    FreeLibrary (mod);
-  DEBUGP (("set_sleep_mode(): mode 0x%08lX, rc 0x%08lX\n", mode, rc));
-  return rc;
-}
 \f
-/* run_with_timeout Windows implementation. */
+/* run_with_timeout Windows implementation.  */
 
- /* Stack size 0 uses default thread stack-size (reserve+commit).
-  * Determined by what's in the PE header.
- */
+/* Stack size 0 uses default thread stack-size (reserve+commit).
+   Determined by what's in the PE header.  */
 #define THREAD_STACK_SIZE  0
 
-struct thread_data {
-   void (*fun) (void *);
-   void  *arg;
-   DWORD ws_error; 
+struct thread_data
+{
+  void (*fun) (void *);
+  void *arg;
+  DWORD ws_error;
 };
 
 /* The callback that runs FUN(ARG) in a separate thread.  This
@@ -356,7 +663,7 @@ struct thread_data {
    [1] MSVC can use __fastcall globally (cl /Gr) and on Watcom this is
    the default (wcc386 -3r).  */
 
-static DWORD WINAPI 
+static DWORD WINAPI
 thread_helper (void *arg)
 {
   struct thread_data *td = (struct thread_data *) arg;
@@ -371,7 +678,7 @@ thread_helper (void *arg)
   /* Return Winsock error to the caller, in case FUN ran Winsock
      code.  */
   td->ws_error = WSAGetLastError ();
-  return 0; 
+  return 0;
 }
 
 /* Call FUN(ARG), but don't allow it to run for more than TIMEOUT
@@ -386,11 +693,11 @@ run_with_timeout (double seconds, void (*fun) (void *), void *arg)
 {
   static HANDLE thread_hnd = NULL;
   struct thread_data thread_arg;
-  DWORD  thread_id;
-  int    rc = 0;
+  DWORD thread_id;
+  int rc = 0;
 
   DEBUGP (("seconds %.2f, ", seconds));
-  
+
   if (seconds == 0)
     {
     blocking_fallback:
@@ -398,14 +705,14 @@ run_with_timeout (double seconds, void (*fun) (void *), void *arg)
       return 0;
     }
 
-  /* Should never happen, but test for recursivety anyway */
-  assert (thread_hnd == NULL);  
+  /* Should never happen, but test for recursivety anyway */
+  assert (thread_hnd == NULL);
 
   thread_arg.fun = fun;
   thread_arg.arg = arg;
   thread_arg.ws_error = WSAGetLastError ();
   thread_hnd = CreateThread (NULL, THREAD_STACK_SIZE, thread_helper,
-                            &thread_arg, 0, &thread_id); 
+                            &thread_arg, 0, &thread_id);
   if (!thread_hnd)
     {
       DEBUGP (("CreateThread() failed; %s\n", strerror (GetLastError ())));
@@ -427,7 +734,7 @@ run_with_timeout (double seconds, void (*fun) (void *), void *arg)
       rc = 1;
     }
 
-  CloseHandle (thread_hnd); /* clear-up after TerminateThread() */
+  CloseHandle (thread_hnd);    /* Clear-up after TerminateThread().  */
   thread_hnd = NULL;
   return rc;
 }