put explore and open functions in namespace shell

previewDataFile() was duplicated in both MainWindow and ModInfoDialog, moved to OrganizerCore
added preview menu item to filetree
better logging when shell operations fail

1 files changed, 217 insertions, 11 deletions

diff --git a/src/organizercore.cpp b/src/organizercore.cpp
index d228dfe1..3a6b810e 100644
--- a/src/organizercore.cpp
+++ b/src/organizercore.cpp
@@ -35,6 +35,7 @@
 #include "instancemanager.h"
 #include <scriptextender.h>
 #include "helper.h"
+#include "previewdialog.h"
 
 #include <QApplication>
 #include <QCoreApplication>
@@ -331,16 +332,103 @@ bool GetFileExecutionContext(
 }
 
 
-bool ExploreDirectory(const QFileInfo& info)
+const char* ShellExecuteError(int i)
 {
-  const auto path = QDir::toNativeSeparators(info.absoluteFilePath());
-  const auto ws_path = path.toStdWString();
+  switch (i) {
+    case 0:
+      return "The operating system is out of memory or resources";
+
+    case ERROR_FILE_NOT_FOUND:
+      return "The specified file was not found";
+
+    case ERROR_PATH_NOT_FOUND:
+      return "The specified path was not found";
+
+    case ERROR_BAD_FORMAT:
+      return "The .exe file is invalid (non-Win32 .exe or error in .exe image)";
+
+    case SE_ERR_ACCESSDENIED:
+      return "The operating system denied access to the specified file";
+
+    case SE_ERR_ASSOCINCOMPLETE:
+      return "The file name association is incomplete or invalid";
+
+    case SE_ERR_DDEBUSY:
+      return "The DDE transaction could not be completed because other DDE "
+             "transactions were being processed";
+
+    case SE_ERR_DDEFAIL:
+      return "The DDE transaction failed";
+
+    case SE_ERR_DDETIMEOUT:
+      return "The DDE transaction could not be completed because the request "
+             "timed out";
+
+    case SE_ERR_DLLNOTFOUND:
+      return "The specified DLL was not found";
+
+    case SE_ERR_NOASSOC:
+      return "There is no application associated with the given file name "
+             "extension";
+
+    case SE_ERR_OOM:
+      return "There was not enough memory to complete the operation";
+
+    case SE_ERR_SHARE:
+      return "A sharing violation occurred";
+
+    default:
+      return "Unknown error";
+  }
+}
+
+void LogShellFailure(
+  const wchar_t* operation, const wchar_t* file, const wchar_t* params,
+  HINSTANCE h)
+{
+  const auto code = static_cast<int>(reinterpret_cast<std::size_t>(h));
+
+  QString s = "failed to invoke";
+
+  if (operation) {
+    s += " " + QString::fromWCharArray(operation);
+  }
+
+  if (file) {
+    s += " " + QString::fromWCharArray(file);
+  }
 
+  if (params) {
+    s += " " + QString::fromWCharArray(params);
+  }
+
+  qCritical(
+    "failed to invoke %s: %s (error %d)",
+    s, ShellExecuteError(code), code);
+}
+
+bool ShellExecuteWrapper(
+  const wchar_t* operation, const wchar_t* file, const wchar_t* params)
+{
   const auto h = ::ShellExecuteW(
-    nullptr, L"explore", ws_path.c_str(), nullptr, nullptr, SW_SHOWNORMAL);
+    0, operation, file, params, nullptr, SW_SHOWNORMAL);
 
   // anything <= 32 is not an actual HINSTANCE and signals failure
-  return (h > reinterpret_cast<HINSTANCE>(32));
+  if (h <= reinterpret_cast<HINSTANCE>(32))
+  {
+    LogShellFailure(operation, file, params, h);
+    return false;
+  }
+
+  return true;
+}
+
+bool ExploreDirectory(const QFileInfo& info)
+{
+  const auto path = QDir::toNativeSeparators(info.absoluteFilePath());
+  const auto ws_path = path.toStdWString();
+
+  return ShellExecuteWrapper(L"explore", ws_path.c_str(), nullptr);
 }
 
 bool ExploreFileInDirectory(const QFileInfo& info)
@@ -349,14 +437,13 @@ bool ExploreFileInDirectory(const QFileInfo& info)
   const auto params = "/select,\"" + path + "\"";
   const auto ws_params = params.toStdWString();
 
-  const auto h = ::ShellExecuteW(
-    nullptr, nullptr, L"explorer", ws_params.c_str(), nullptr, SW_SHOWNORMAL);
-
-  // anything <= 32 is not an actual HINSTANCE and signals failure
-  return (h > reinterpret_cast<HINSTANCE>(32));
+  return ShellExecuteWrapper(nullptr, L"explorer", ws_params.c_str());
 }
 
 
+namespace shell
+{
+
 bool ExploreFile(const QFileInfo& info)
 {
   if (info.isFile()) {
@@ -385,6 +472,14 @@ bool ExploreFile(const QDir& dir)
   return ExploreFile(QFileInfo(dir.absolutePath()));
 }
 
+bool OpenFile(const QString& path)
+{
+  const auto ws_path = path.toStdWString();
+  return ShellExecuteWrapper(L"open", ws_path.c_str(), nullptr);
+}
+
+} // namespace shell
+
 
 OrganizerCore::OrganizerCore(const QSettings &initSettings)
   : m_UserInterface(nullptr)
@@ -1339,7 +1434,8 @@ QStringList OrganizerCore::modsSortedByProfilePriority() const
   return res;
 }
 
-bool OrganizerCore::executeFile(QWidget* parent, const QFileInfo& targetInfo)
+bool OrganizerCore::executeFileVirtualized(
+  QWidget* parent, const QFileInfo& targetInfo)
 {
   QFileInfo binaryInfo;
   QString arguments;
@@ -1372,6 +1468,116 @@ bool OrganizerCore::executeFile(QWidget* parent, const QFileInfo& targetInfo)
   return false;
 }
 
+bool OrganizerCore::previewFileWithAlternatives(
+  QWidget* parent, QString fileName)
+{
+  // what we have is an absolute path to the file in its actual location (for the primary origin)
+  // what we want is the path relative to the virtual data directory
+
+  // we need to look in the virtual directory for the file to make sure the info is up to date.
+
+  // check if the file comes from the actual data folder instead of a mod
+  QDir gameDirectory = managedGame()->dataDirectory().absolutePath();
+  QString relativePath = gameDirectory.relativeFilePath(fileName);
+  QDir dirRelativePath = gameDirectory.relativeFilePath(fileName);
+
+  // if the file is on a different drive the dirRelativePath will actually be an
+  // absolute path so we make sure that is not the case
+  if (!dirRelativePath.isAbsolute() && !relativePath.startsWith("..")) {
+    fileName = relativePath;
+  }
+  else {
+    // crude: we search for the next slash after the base mod directory to skip
+    // everything up to the data-relative directory
+    int offset = settings().getModDirectory().size() + 1;
+    offset = fileName.indexOf("/", offset);
+    fileName = fileName.mid(offset + 1);
+  }
+
+
+
+  const FileEntry::Ptr file = directoryStructure()->searchFile(ToWString(fileName), nullptr);
+
+  if (file.get() == nullptr) {
+    reportError(tr("file not found: %1").arg(qUtf8Printable(fileName)));
+    return false;
+  }
+
+  // set up preview dialog
+  PreviewDialog preview(fileName);
+  auto addFunc = [&](int originId) {
+    FilesOrigin &origin = directoryStructure()->getOriginByID(originId);
+    QString filePath = QDir::fromNativeSeparators(ToQString(origin.getPath())) + "/" + fileName;
+    if (QFile::exists(filePath)) {
+      // it's very possible the file doesn't exist, because it's inside an archive. we don't support that
+      QWidget *wid = m_PluginContainer->previewGenerator().genPreview(filePath);
+      if (wid == nullptr) {
+        reportError(tr("failed to generate preview for %1").arg(filePath));
+      }
+      else {
+        preview.addVariant(ToQString(origin.getName()), wid);
+      }
+    }
+  };
+
+  addFunc(file->getOrigin());
+  for (auto alt : file->getAlternatives()) {
+    addFunc(alt.first);
+  }
+
+  if (preview.numVariants() > 0) {
+    QSettings &s = settings().directInterface();
+    QString key = QString("geometry/%1").arg(preview.objectName());
+    if (s.contains(key)) {
+      preview.restoreGeometry(s.value(key).toByteArray());
+    }
+
+    preview.exec();
+
+    s.setValue(key, preview.saveGeometry());
+
+    return true;
+  }
+  else {
+    QMessageBox::information(
+      parent, tr("Sorry"),
+      tr("Sorry, can't preview anything. This function currently does not support extracting from bsas."));
+
+    return false;
+  }
+}
+
+bool OrganizerCore::previewFile(
+  QWidget* parent, const QString& originName, const QString& path)
+{
+  if (!QFile::exists(path)) {
+    reportError(tr("File '%1' not found.").arg(path));
+    return false;
+  }
+
+  PreviewDialog preview(path);
+
+  QWidget *wid = m_PluginContainer->previewGenerator().genPreview(path);
+  if (wid == nullptr) {
+    reportError(tr("Failed to generate preview for %1").arg(path));
+    return false;
+  }
+
+  preview.addVariant(originName, wid);
+
+  QSettings &s = settings().directInterface();
+  QString key = QString("geometry/%1").arg(preview.objectName());
+  if (s.contains(key)) {
+    preview.restoreGeometry(s.value(key).toByteArray());
+  }
+
+  preview.exec();
+
+  s.setValue(key, preview.saveGeometry());
+
+  return true;
+}
+
 void OrganizerCore::spawnBinary(const QFileInfo &binary,
                                 const QString &arguments,
                                 const QDir &currentDirectory,