Merge pull request #954 from ModOrganizer2/Develop

Stage for release 2.2.2

1 files changed, 331 insertions, 0 deletions

diff --git a/src/settingsutilities.cpp b/src/settingsutilities.cpp
new file mode 100644
index 00000000..db7c1818
--- /dev/null
+++ b/src/settingsutilities.cpp
@@ -0,0 +1,331 @@
+#include "settingsutilities.h"
+#include "expanderwidget.h"
+#include <utility.h>
+
+using namespace MOBase;
+
+bool shouldLogSetting(const QString& displayName)
+{
+  // don't log Geometry/ and Widgets/, too noisy and not very useful
+  static const QStringList ignorePrefixes = {"Geometry/", "Widgets/"};
+
+  for (auto&& prefix : ignorePrefixes) {
+    if (displayName.startsWith(prefix, Qt::CaseInsensitive)) {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+void logRemoval(const QString& name)
+{
+  if (!shouldLogSetting(name)) {
+    return;
+  }
+
+  log::debug("setting '{}' removed", name);
+}
+
+
+QString settingName(const QString& section, const QString& key)
+{
+  if (section.isEmpty()) {
+    return key;
+  } else if (key.isEmpty()) {
+    return section;
+  } else {
+    if (section.compare("General", Qt::CaseInsensitive) == 0) {
+      return key;
+    } else {
+      return section + "/" + key;
+    }
+  }
+}
+
+void removeImpl(
+  QSettings& settings, const QString& displayName,
+  const QString& section, const QString& key)
+{
+  if (key.isEmpty()) {
+    if (!settings.childGroups().contains(section, Qt::CaseInsensitive)) {
+      // not there
+      return;
+    }
+  } else {
+    if (!settings.contains(settingName(section, key))) {
+      // not there
+      return;
+    }
+  }
+
+  logRemoval(displayName);
+  settings.remove(settingName(section, key));
+}
+
+void remove(QSettings& settings, const QString& section, const QString& key)
+{
+  removeImpl(settings, settingName(section, key), section, key);
+}
+
+void removeSection(QSettings& settings, const QString& section)
+{
+  removeImpl(settings, section, section, "");
+}
+
+
+ScopedGroup::ScopedGroup(QSettings& s, const QString& name)
+  : m_settings(s), m_name(name)
+{
+  m_settings.beginGroup(m_name);
+}
+
+ScopedGroup::~ScopedGroup()
+{
+  m_settings.endGroup();
+}
+
+void ScopedGroup::remove(const QString& key)
+{
+  removeImpl(m_settings, settingName(m_name, key), "", key);
+}
+
+QStringList ScopedGroup::keys() const
+{
+  return m_settings.childKeys();
+}
+
+
+ScopedReadArray::ScopedReadArray(QSettings& s, const QString& section)
+  : m_settings(s), m_count(0)
+{
+  m_count = m_settings.beginReadArray(section);
+}
+
+ScopedReadArray::~ScopedReadArray()
+{
+  m_settings.endArray();
+}
+
+int ScopedReadArray::count() const
+{
+  return m_count;
+}
+
+QStringList ScopedReadArray::keys() const
+{
+  return m_settings.childKeys();
+}
+
+
+ScopedWriteArray::ScopedWriteArray(
+  QSettings& s, const QString& section, std::size_t size)
+    : m_settings(s), m_section(section), m_i(0)
+{
+  m_settings.beginWriteArray(
+    section, size == NoSize ? -1 : static_cast<int>(size));
+}
+
+ScopedWriteArray::~ScopedWriteArray()
+{
+  m_settings.endArray();
+}
+
+void ScopedWriteArray::next()
+{
+  m_settings.setArrayIndex(m_i);
+  ++m_i;
+}
+
+
+QString widgetNameWithTopLevel(const QWidget* widget)
+{
+  QStringList components;
+
+  auto* tl = widget->window();
+
+  if (tl == widget) {
+    // this is a top level widget, such as a dialog
+    components.push_back(widget->objectName());
+  } else {
+    // this is a widget
+    const auto toplevelName = tl->objectName();
+    if (!toplevelName.isEmpty()) {
+      components.push_back(toplevelName);
+    }
+
+    const auto widgetName = widget->objectName();
+    if (!widgetName.isEmpty()) {
+      components.push_back(widgetName);
+    }
+  }
+
+  if (components.isEmpty()) {
+    // can't do much
+    return "unknown_widget";
+  }
+
+  return components.join("_");
+}
+
+QString widgetName(const QMainWindow* w)
+{
+  return w->objectName();
+}
+
+QString widgetName(const QHeaderView* w)
+{
+  return widgetNameWithTopLevel(w->parentWidget());
+}
+
+QString widgetName(const ExpanderWidget* w)
+{
+  return widgetNameWithTopLevel(w->button());
+}
+
+QString widgetName(const QWidget* w)
+{
+  return widgetNameWithTopLevel(w);
+}
+
+QString dockSettingName(const QDockWidget* dock)
+{
+  return "MainWindow_docks_" + dock->objectName() + "_size";
+}
+
+QString indexSettingName(const QWidget* widget)
+{
+  return widgetNameWithTopLevel(widget) + "_index";
+}
+
+QString checkedSettingName(const QAbstractButton* b)
+{
+  return widgetNameWithTopLevel(b) + "_checked";
+}
+
+void warnIfNotCheckable(const QAbstractButton* b)
+{
+  if (!b->isCheckable()) {
+    log::warn(
+      "button '{}' used in the settings as a checkbox or radio button "
+      "but is not checkable", b->objectName());
+  }
+}
+
+
+QString credentialName(const QString& key)
+{
+  return "ModOrganizer2_" + key;
+}
+
+bool deleteWindowsCredential(const QString& key)
+{
+  const auto credName = credentialName(key);
+
+  if (!CredDeleteW(credName.toStdWString().c_str(), CRED_TYPE_GENERIC, 0)) {
+    const auto e = GetLastError();
+
+    // not an error if the key already doesn't exist, and don't log it because
+    // it happens all the time when the settings dialog is closed since it
+    // doesn't check first
+    if (e == ERROR_NOT_FOUND) {
+      return true;
+    }
+
+    log::error(
+      "failed to delete windows credential {}, {}",
+      credName, formatSystemMessage(e));
+    return false;
+  }
+
+  log::debug("deleted windows credential {}", credName);
+
+  return true;
+}
+
+bool addWindowsCredential(const QString& key, const QString& data)
+{
+  const auto credName = credentialName(key);
+
+  const auto wname = credName.toStdWString();
+  const auto wdata = data.toStdWString();
+
+  const auto* blob = reinterpret_cast<const BYTE*>(wdata.data());
+  const auto blobSize = wdata.size() * sizeof(decltype(wdata)::value_type);
+
+  CREDENTIALW cred = {};
+  cred.Flags = 0;
+  cred.Type = CRED_TYPE_GENERIC;
+  cred.TargetName = const_cast<wchar_t*>(wname.c_str());
+  cred.CredentialBlob = const_cast<BYTE*>(blob);
+  cred.CredentialBlobSize = static_cast<DWORD>(blobSize);
+  cred.Persist = CRED_PERSIST_LOCAL_MACHINE;
+
+  if (!CredWriteW(&cred, 0)) {
+    const auto e = GetLastError();
+
+    log::error(
+      "failed to delete windows credential {}, {}",
+      credName, formatSystemMessage(e));
+
+    return false;
+  }
+
+  log::debug("set windows credential {}", credName);
+
+  return true;
+}
+
+struct CredentialFreer
+{
+  void operator()(CREDENTIALW* c)
+  {
+    if (c) {
+      CredFree(c);
+    }
+  }
+};
+
+using CredentialPtr = std::unique_ptr<CREDENTIALW, CredentialFreer>;
+
+QString getWindowsCredential(const QString& key)
+{
+  const QString credName = credentialName(key);
+
+  CREDENTIALW* rawCreds = nullptr;
+
+  const auto ret = CredReadW(
+    credName.toStdWString().c_str(), CRED_TYPE_GENERIC, 0, &rawCreds);
+
+  CredentialPtr creds(rawCreds);
+
+  if (!ret) {
+    const auto e = GetLastError();
+
+    if (e != ERROR_NOT_FOUND) {
+      log::error(
+        "failed to retrieve windows credential {}: {}",
+        credName, formatSystemMessage(e));
+    }
+
+    return {};
+  }
+
+  QString value;
+  if (creds->CredentialBlob) {
+    value = QString::fromWCharArray(
+      reinterpret_cast<const wchar_t*>(creds->CredentialBlob),
+      creds->CredentialBlobSize / sizeof(wchar_t));
+  }
+
+  return value;
+}
+
+bool setWindowsCredential(const QString& key, const QString& data)
+{
+  if (data.isEmpty()) {
+    return deleteWindowsCredential(key);
+  } else {
+    return addWindowsCredential(key, data);
+  }
+}