Make Crashpad use the user data dir, rather than always default location

chrome/install_static/install_util.cc

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/install_static/install_util.h"
 
 #include <windows.h>
 #include <assert.h>
 #include <algorithm>
 #include <iostream>
 #include <iterator>
 #include <memory>
 #include <sstream>
 
+#include "chrome/install_static/policy_path_parser.h"
 #include "chrome_elf/nt_registry/nt_registry.h"
 
 namespace install_static {
 
 ProcessType g_process_type = ProcessType::UNINITIALIZED;
 
 // TODO(ananta)
 // http://crbug.com/604923
 // The constants defined in this file are also defined in chrome/installer and
 // other places. we need to unify them.
@@ skipping 29 matching lines @@
 const wchar_t kAppGuidGoogleChrome[] =
     L"{8A69D345-D564-463c-AFF1-A69D9E530F96}";
 const wchar_t kAppGuidGoogleBinaries[] =
     L"{4DC8B4CA-1BDA-483e-B5FA-D3C12E15B62D}";
 
 const wchar_t kHeadless[] = L"CHROME_HEADLESS";
 const wchar_t kShowRestart[] = L"CHROME_CRASHED";
 const wchar_t kRestartInfo[] = L"CHROME_RESTART";
 const wchar_t kRtlLocale[] = L"RIGHT_TO_LEFT";
 
-const char kGpuProcess[] = "gpu-process";
-const char kPpapiPluginProcess[] = "ppapi";
-const char kRendererProcess[] = "renderer";
-const char kUtilityProcess[] = "utility";
-const char kProcessType[] = "type";
-const char kCrashpadHandler[] = "crashpad-handler";
+const wchar_t kCrashpadHandler[] = L"crashpad-handler";
+const wchar_t kProcessType[] = L"type";
+const wchar_t kUserDataDirSwitch[] = L"user-data-dir";

[grt (UTC plus 2), 2016/11/16 13:24:52]

nit: either use "Swtich" on all of these constants that are switches, or on none
of them.

[scottmg, 2016/11/16 21:01:18]

Hrm, I don't like "Switch" on there, but there's 3 different "user data dirs" in
here: "user-data-dir" for the command line, "UserDataDir" for the registry key
and "User Data" for the directory name!

So it was intended to be parallel to kUserDataDirRegKey and kUserDataDirname.

+const wchar_t kUtilityProcess[] = L"utility";
+
+#if defined(GOOGLE_CHROME_BUILD)
+const wchar_t kRegistryChromePolicyKey[] =
+    L"SOFTWARE\\Policies\\Google\\Chrome";
+#else
+const wchar_t kRegistryChromePolicyKey[] =
+    L"SOFTWARE\\Policies\\Chromium";
+#endif
+const wchar_t kUserDataDirRegKey[] = L"UserDataDir";
 
 namespace {
 
 // TODO(ananta)
 // http://crbug.com/604923
 // These constants are defined in the chrome/installer directory as well. We
 // need to unify them.
 #if defined(GOOGLE_CHROME_BUILD)
 const wchar_t kSxSSuffix[] = L" SxS";
 const wchar_t kGoogleChromeInstallSubDir1[] = L"Google";
@@ skipping 99 matching lines @@
 }
 
 // Returns the executable path for the current process.
 std::wstring GetCurrentProcessExePath() {
   wchar_t exe_path[MAX_PATH];
   if (::GetModuleFileName(nullptr, exe_path, MAX_PATH) == 0)
     return std::wstring();
   return exe_path;
 }
 
+std::wstring MakeAbsoluteFilePath(const std::wstring& input) {
+  wchar_t file_path[MAX_PATH];
+  if (!_wfullpath(file_path, input.c_str(), MAX_PATH))

[grt (UTC plus 2), 2016/11/16 13:24:52]

#include <stdlib.h> for _wfullpath

[grt (UTC plus 2), 2016/11/16 13:24:52]

nit: MAX_PATH -> _countof(file_path)

[scottmg, 2016/11/16 21:01:18]

Done.

[scottmg, 2016/11/16 21:01:18]

Done.

+    return std::wstring();
+  return file_path;
+}
+
+bool DirectoryExists(const std::wstring& path) {
+  DWORD file_attributes = ::GetFileAttributes(path.c_str());
+  if (file_attributes != INVALID_FILE_ATTRIBUTES)

[grt (UTC plus 2), 2016/11/16 13:24:52]

uber nit: either handle failure with an early return for consistency with the
function above, or turn this into one return statement:
  return file_attributes != INVALID_FILE_ATTRIBUTES && (file_attributes &
FILE_ATTRIBUTE_DIRECTORY) != 0;

[scottmg, 2016/11/16 21:01:18]

Done.

+    return (file_attributes & FILE_ATTRIBUTE_DIRECTORY) != 0;
+  return false;
+}
+
 bool RecursiveDirectoryCreate(const std::wstring& full_path) {
   // If the path exists, we've succeeded if it's a directory, failed otherwise.
   const wchar_t* full_path_str = full_path.c_str();
   DWORD file_attributes = ::GetFileAttributes(full_path_str);
   if (file_attributes != INVALID_FILE_ATTRIBUTES) {
     if ((file_attributes & FILE_ATTRIBUTE_DIRECTORY) != 0) {
       Trace(L"%hs( %ls directory exists )\n", __func__, full_path_str);
       return true;
     }
     Trace(L"%hs( %ls directory conflicts with an existing file. )\n", __func__,
@@ skipping 10 matching lines @@
   std::size_t pos = full_path.find_last_of(L"/\\");
   if (pos != std::wstring::npos) {
     parent_path = full_path.substr(0, pos);
     if (!RecursiveDirectoryCreate(parent_path)) {
       Trace(L"Failed to create one of the parent directories");
       return false;
     }
   }
   if (!::CreateDirectory(full_path_str, nullptr)) {
     DWORD error_code = ::GetLastError();
-    if (error_code == ERROR_ALREADY_EXISTS) {
-      DWORD file_attributes = ::GetFileAttributes(full_path_str);
-      if ((file_attributes != INVALID_FILE_ATTRIBUTES) &&
-          ((file_attributes & FILE_ATTRIBUTE_DIRECTORY) != 0)) {
-        // This error code ERROR_ALREADY_EXISTS doesn't indicate whether we
-        // were racing with someone creating the same directory, or a file
-        // with the same path.  If the directory exists, we lost the
-        // race to create the same directory.
-        return true;
-      } else {
-        Trace(L"Failed to create directory %ls, last error is %d\n",
-              full_path_str, error_code);
-        return false;
-      }
+    if (error_code == ERROR_ALREADY_EXISTS && DirectoryExists(full_path_str)) {
+      // This error code ERROR_ALREADY_EXISTS doesn't indicate whether we
+      // were racing with someone creating the same directory, or a file
+      // with the same path.  If the directory exists, we lost the
+      // race to create the same directory.
+      return true;
+    } else {
+      Trace(L"Failed to create directory %ls, last error is %d\n",
+            full_path_str, error_code);
+      return false;
     }
   }
   return true;
 }
 
 std::wstring GetChromeInstallRegistryPath() {
   std::wstring registry_path = L"Software\\";
   registry_path += GetChromeInstallSubDirectory();
   return registry_path;
 }
@@ skipping 126 matching lines @@
   std::vector<StringType> tokens;
   std::basic_istringstream<typename StringType::value_type> buffer(str);
   for (StringType token; std::getline(buffer, token, delimiter);) {
     if (trim_spaces)
       TrimT<StringType>(&token);
     tokens.push_back(token);
   }
   return tokens;
 }
 
+// Checks if the key exists in the given hive and expands any string variables.
+bool LoadUserDataDirPolicyFromRegistry(nt::ROOT_KEY hive,
+                                       const wchar_t* key_name,
+                                       std::wstring* dir) {
+  std::wstring value;
+  bool result = false;
+  HANDLE key;
+  if (nt::OpenRegKey(hive, kRegistryChromePolicyKey, KEY_READ, &key, nullptr)) {
+    if (nt::QueryRegValueSZ(key, key_name, &value)) {
+      *dir = install_static::ExpandPathVariables(value);
+      result = true;
+    }
+    nt::CloseRegKey(key);
+  }
+  return result;
+}
+
+void CheckUserDataDirPolicy(std::wstring* user_data_dir) {
+  assert(user_data_dir);
+  // Policy from the HKLM hive has precedence over HKCU.
+  if (!LoadUserDataDirPolicyFromRegistry(nt::HKLM, kUserDataDirRegKey,
+                                         user_data_dir)) {
+    LoadUserDataDirPolicyFromRegistry(nt::HKCU, kUserDataDirRegKey,
+                                      user_data_dir);
+  }
+}
+
 }  // namespace
 
 bool IsSxSChrome(const wchar_t* exe_path) {
   return ::wcsstr(exe_path, L"Chrome SxS\\Application") != nullptr;
 }
 
 bool IsSystemInstall(const wchar_t* exe_path) {
   wchar_t program_dir[MAX_PATH] = {};
   DWORD ret = ::GetEnvironmentVariable(L"PROGRAMFILES", program_dir, MAX_PATH);
   if (ret && ret < MAX_PATH && !::wcsnicmp(exe_path, program_dir, ret)) {
@@ skipping 100 matching lines @@
 }
 
 bool IsNonBrowserProcess() {
   assert(g_process_type != ProcessType::UNINITIALIZED);
   return g_process_type == ProcessType::NON_BROWSER_PROCESS;
 }
 
 bool GetDefaultUserDataDirectory(std::wstring* result) {
   static const wchar_t kLocalAppData[] = L"%LOCALAPPDATA%";
 
-  std::unique_ptr<wchar_t> user_data_dir_path;
+  std::unique_ptr<wchar_t[]> user_data_dir_path;
 
   // This environment variable should be set on Windows 7 and up.
   // If we fail to find this variable then we default to the temporary files
   // path.
   DWORD size = ::ExpandEnvironmentStrings(kLocalAppData, nullptr, 0);
   if (size) {
     user_data_dir_path.reset(new wchar_t[size]);
     if (::ExpandEnvironmentStrings(kLocalAppData, user_data_dir_path.get(),
                                    size) != size) {
       user_data_dir_path.reset();
@@ skipping 14 matching lines @@
 
   *result = user_data_dir_path.get();
   if ((*result)[result->length() - 1] != L'\\')
     result->append(L"\\");
   result->append(install_sub_directory);
   result->append(L"\\");
   result->append(kUserDataDirname);
   return true;
 }
 
-bool GetDefaultCrashDumpLocation(std::wstring* crash_dir) {
-  // In order to be able to start crash handling very early, we do not rely on
-  // chrome's PathService entries (for DIR_CRASH_DUMPS) being available on
-  // Windows. See https://crbug.com/564398.
-  if (!GetDefaultUserDataDirectory(crash_dir))
+bool GetUserDataDirectory(const std::wstring& user_data_dir_from_command_line,
+                          std::wstring* result) {
+  // WARNING! This has to mirror the logic in chrome/app/chrome_main_delegate.cc
+  // in InitializeUserDataDir(). This function derives the path in the same way,
+  // but without using base, nor reporting on failure as the Chrome
+  // implementation does.
+  std::wstring user_data_dir = user_data_dir_from_command_line;
+
+  CheckUserDataDirPolicy(&user_data_dir);
+
+  // On Windows, trailing separators leave Chrome in a bad state. See
+  // crbug.com/464616.
+  while (!user_data_dir.empty() &&
+         (user_data_dir.back() == '\\' || user_data_dir.back() == '/')) {
+    user_data_dir.pop_back();
+  }
+
+  bool have_valid_directory =

[grt (UTC plus 2), 2016/11/16 13:24:52]

i gently prefer this, but it's your call:
  bool have_valid_directory =
      (!user_data_dir.empty() && RecursiveDirectoryCreate(user_data_dir)) ||
      GetDefaultUserDataDirectory(&user_data_dir);

  // The Chrome implementation CHECKs() here in the browser process. We don't as
  // this function is used to initialize crash reporting, so we would get no
  // report of this failure.
  assert(have_valid_directory);
  if (!have_valid_directory)
    return false;

[scottmg, 2016/11/16 21:01:18]

Done.

+      !user_data_dir.empty() && RecursiveDirectoryCreate(user_data_dir);
+
+  if (!have_valid_directory && !GetDefaultUserDataDirectory(&user_data_dir)) {
+    // The Chrome implementation CHECKs() here in the browser process. We
+    // don't as this function is used to initialize crash reporting, so
+    // we would get no report of this failure.
+    assert(false);
     return false;
+  }
+
+  *result = MakeAbsoluteFilePath(user_data_dir);
+  return true;
+}
+
+bool GetUserDataDirectoryUsingProcessCommandLine(std::wstring* result) {
+  return GetUserDataDirectory(
+      GetSwitchValueFromCommandLine(::GetCommandLine(),
+                                    install_static::kUserDataDirSwitch),
+      result);
+}
+
+bool GetCrashDumpLocation(std::wstring* crash_dir) {
+  // In order to be able to start crash handling very early and in chrome_elf,
+  // we cannot rely on chrome's PathService entries (for DIR_CRASH_DUMPS)
+  // being

[grt (UTC plus 2), 2016/11/16 13:24:52]

nit: wrap

[scottmg, 2016/11/16 21:01:18]

Done.

+  // available on Windows. See https://crbug.com/564398.
+  if (!GetUserDataDirectoryUsingProcessCommandLine(crash_dir)) {

[grt (UTC plus 2), 2016/11/16 13:24:52]

nit: omit braces

[scottmg, 2016/11/16 21:01:18]

Done.

+    return false;
+  }
 
   // We have to make sure the user data dir exists on first run. See
   // http://crbug.com/591504.
   if (!RecursiveDirectoryCreate(crash_dir->c_str()))
     return false;
   crash_dir->append(L"\\Crashpad");
   return true;
 }
 
 std::string GetEnvironmentString(const std::string& variable_name) {
@@ skipping 287 matching lines @@
         *result = -1;
         return true;
       }
     }
   }
   // Here it means that both versions are equal.
   *result = 0;
   return true;
 }
 
-std::string GetSwitchValueFromCommandLine(const std::string& command_line,
-                                          const std::string& switch_name) {
+std::wstring GetSwitchValueFromCommandLine(const std::wstring& command_line,
+                                           const std::wstring& switch_name) {
   assert(!command_line.empty());
   assert(!switch_name.empty());
 
-  std::string command_line_copy = command_line;
+  std::wstring command_line_copy = command_line;
   // Remove leading and trailing spaces.
-  TrimT<std::string>(&command_line_copy);
+  TrimT<std::wstring>(&command_line_copy);
 
   // Find the switch in the command line. If we don't find the switch, return
   // an empty string.
-  std::string switch_token = "--";
+  std::wstring switch_token = L"--";
   switch_token += switch_name;
-  switch_token += "=";
+  switch_token += L"=";
   size_t switch_offset = command_line_copy.find(switch_token);
   if (switch_offset == std::string::npos)
-    return std::string();
+    return std::wstring();
 
   // The format is "--<switch name>=blah". Look for a space after the
   // "--<switch name>=" string. If we don't find a space assume that the switch
   // value ends at the end of the command line.
   size_t switch_value_start_offset = switch_offset + switch_token.length();
-  if (std::string(kWhiteSpaces).find(
-          command_line_copy[switch_value_start_offset]) != std::string::npos) {
+  if (std::wstring(kWhiteSpaces16).find(
+          command_line_copy[switch_value_start_offset]) != std::wstring::npos) {
     switch_value_start_offset = command_line_copy.find_first_not_of(
-        GetWhiteSpacesForType<std::string>(), switch_value_start_offset);
-    if (switch_value_start_offset == std::string::npos)
-      return std::string();
+        GetWhiteSpacesForType<std::wstring>(), switch_value_start_offset);
+    if (switch_value_start_offset == std::wstring::npos)
+      return std::wstring();
   }
   size_t switch_value_end_offset =
-      command_line_copy.find_first_of(GetWhiteSpacesForType<std::string>(),
+      command_line_copy.find_first_of(GetWhiteSpacesForType<std::wstring>(),
                                       switch_value_start_offset);
-  if (switch_value_end_offset == std::string::npos)
+  if (switch_value_end_offset == std::wstring::npos)
     switch_value_end_offset = command_line_copy.length();
 
-  std::string switch_value = command_line_copy.substr(
+  std::wstring switch_value = command_line_copy.substr(
       switch_value_start_offset,
       switch_value_end_offset - (switch_offset + switch_token.length()));
-  TrimT<std::string>(&switch_value);
+  TrimT<std::wstring>(&switch_value);
   return switch_value;
 }
 
 }  // namespace install_static