path: root/src/loadmechanism.cpp

/*
Copyright (C) 2012 Sebastian Herbord. All rights reserved.

This file is part of Mod Organizer.

Mod Organizer 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 3 of the License, or
(at your option) any later version.

Mod Organizer 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 Mod Organizer.  If not, see <http://www.gnu.org/licenses/>.
*/

#include "loadmechanism.h"
#include "utility.h"
#include "util.h"
#include <iplugingame.h>
#include <scriptextender.h>
#include <appconfig.h>
#include <QFile>
#include <QFileInfo>
#include <QDir>
#include <QString>
#include <QMessageBox>
#include <QCryptographicHash>
#include <QCoreApplication>


using namespace MOBase;
using namespace MOShared;


LoadMechanism::LoadMechanism()
  : m_SelectedMechanism(LOAD_MODORGANIZER)
{
}

void LoadMechanism::writeHintFile(const QDir &targetDirectory)
{
  QString hintFilePath = targetDirectory.absoluteFilePath("mo_path.txt");
  QFile hintFile(hintFilePath);
  if (hintFile.exists()) {
    hintFile.remove();
  }
  if (!hintFile.open(QIODevice::WriteOnly)) {
    throw MyException(QObject::tr("failed to open %1: %2").arg(hintFilePath).arg(hintFile.errorString()));
  }
  hintFile.write(qApp->applicationDirPath().toUtf8().constData());
  hintFile.close();
}


void LoadMechanism::removeHintFile(QDir targetDirectory)
{
  targetDirectory.remove("mo_path.txt");
}


bool LoadMechanism::isDirectLoadingSupported()
{
  //FIXME: Seriously? isn't there a 'do i need steam' thing?
  IPluginGame const *game = qApp->property("managed_game").value<IPluginGame const *>();
  if (game->gameName().compare("oblivion", Qt::CaseInsensitive) == 0) {
    // oblivion can be loaded directly if it's not the steam variant
    return !game->gameDirectory().exists("steam_api.dll");
  } else {
    // all other games work afaik
    return true;
  }
}

bool LoadMechanism::isScriptExtenderSupported()
{
  IPluginGame const *game = qApp->property("managed_game").value<IPluginGame const *>();
  ScriptExtender *extender = game->feature<ScriptExtender>();

  // test if there even is an extender for the managed game and if so whether it's installed
  return extender != nullptr && extender->isInstalled();
}

bool LoadMechanism::isProxyDLLSupported()
{
  // using steam_api.dll as the proxy is way too game specific as many games will have different
  // versions of that game.
  // plus: the proxy dll hasn't been working for at least the whole 1.12.x versions of MO and
  // noone reported it so why maintain an unused feature?
  return false;
/*  IPluginGame const *game = qApp->property("managed_game").value<IPluginGame const *>();
  return game->gameDirectory().exists(QString::fromStdWString(AppConfig::proxyDLLTarget()));*/
}


bool LoadMechanism::hashIdentical(const QString &fileNameLHS, const QString &fileNameRHS)
{
  QFile fileLHS(fileNameLHS);
  if (!fileLHS.open(QIODevice::ReadOnly)) {
    throw MyException(QObject::tr("%1 not found").arg(fileNameLHS));
  }
  QByteArray dataLHS = fileLHS.readAll();
  QByteArray hashLHS = QCryptographicHash::hash(dataLHS, QCryptographicHash::Md5);

  fileLHS.close();

  QFile fileRHS(fileNameRHS);
  if (!fileRHS.open(QIODevice::ReadOnly)) {
    throw MyException(QObject::tr("%1 not found").arg(fileNameRHS));
  }
  QByteArray dataRHS = fileRHS.readAll();
  QByteArray hashRHS = QCryptographicHash::hash(dataRHS, QCryptographicHash::Md5);

  fileRHS.close();

  return hashLHS == hashRHS;
}


void LoadMechanism::deactivateScriptExtender()
{
  try {
    IPluginGame const *game = qApp->property("managed_game").value<IPluginGame const *>();
    ScriptExtender *extender = game->feature<ScriptExtender>();
    if (extender == nullptr) {
      throw MyException(QObject::tr("game doesn't support a script extender"));
    }

    QDir pluginsDir(game->gameDirectory().absolutePath() + "/data/" + extender->name() + "/plugins");

    QString hookDLLName = ToQString(AppConfig::hookDLLName());
    if (QFile(pluginsDir.absoluteFilePath(hookDLLName)).exists()) {
      // remove dll from SE plugins directory
      if (!pluginsDir.remove(hookDLLName)) {
        throw MyException(QObject::tr("Failed to delete %1").arg(pluginsDir.absoluteFilePath(hookDLLName)));
      }
    }

    removeHintFile(pluginsDir);
  } catch (const std::exception &e) {
    QMessageBox::critical(nullptr, QObject::tr("Failed to deactivate script extender loading"), e.what());
  }
}


void LoadMechanism::deactivateProxyDLL()
{
  try {
    IPluginGame const *game = qApp->property("managed_game").value<IPluginGame const *>();

    QString targetPath = game->gameDirectory().absoluteFilePath(QString::fromStdWString(AppConfig::proxyDLLTarget()));

    QFile targetDLL(targetPath);
    if (targetDLL.exists()) {
      QString origFile = game->gameDirectory().absoluteFilePath(QString::fromStdWString(AppConfig::proxyDLLOrig()));
      // determine if a proxy-dll is installed
      // this is a very crude way of making this decision but it should be good enough
      if ((targetDLL.size() < 24576) && (QFile(origFile).exists())) {
        // remove proxy-dll
        if (!targetDLL.remove()) {
          throw MyException(QObject::tr("Failed to remove %1: %2").arg(targetPath).arg(targetDLL.errorString()));
        } else if (!QFile::rename(origFile, targetPath)) {
          throw MyException(QObject::tr("Failed to rename %1 to %2").arg(origFile, targetPath));
        }
      }
    }

    removeHintFile(game->gameDirectory());
  } catch (const std::exception &e) {
    QMessageBox::critical(nullptr, QObject::tr("Failed to deactivate proxy-dll loading"), e.what());
  }
}


void LoadMechanism::activateScriptExtender()
{
  try {
    IPluginGame const *game = qApp->property("managed_game").value<IPluginGame const *>();
    ScriptExtender *extender = game->feature<ScriptExtender>();
    if (extender == nullptr) {
      throw MyException(QObject::tr("game doesn't support a script extender"));
    }

    QDir pluginsDir(game->gameDirectory().absolutePath() + "/data/" + extender->name() + "/plugins");

    if (!pluginsDir.exists()) {
      pluginsDir.mkpath(".");
    }

    QString targetPath = pluginsDir.absoluteFilePath(ToQString(AppConfig::hookDLLName()));
    QString hookDLLPath = qApp->applicationDirPath() + "/" + QString::fromStdWString(AppConfig::hookDLLName());

    QFile dllFile(targetPath);

    if (dllFile.exists()) {
      // may be outdated
      if (!hashIdentical(targetPath, hookDLLPath)) {
        dllFile.remove();
      }
    }

    if (!dllFile.exists()) {
      // install dll to SE plugins
      if (!QFile::copy(hookDLLPath, targetPath)) {
        throw MyException(QObject::tr("Failed to copy %1 to %2").arg(hookDLLPath, targetPath));
      }
    }
    writeHintFile(pluginsDir);
  } catch (const std::exception &e) {
    QMessageBox::critical(nullptr, QObject::tr("Failed to set up script extender loading"), e.what());
  }
}


void LoadMechanism::activateProxyDLL()
{
  try {
    IPluginGame const *game = qApp->property("managed_game").value<IPluginGame const *>();

    QString targetPath = game->gameDirectory().absoluteFilePath(QString::fromStdWString(AppConfig::proxyDLLTarget()));

    QFile targetDLL(targetPath);
    if (!targetDLL.exists()) {
      return;
    }

    QString sourcePath = qApp->applicationDirPath() + "/" + ToQString(AppConfig::proxyDLLSource());

    // this is a very crude way of making this decision but it should be good enough
    if (targetDLL.size() < 24576) {
      // determine if a proxy-dll is already installed and if so, if it's the right one
      if (!hashIdentical(targetPath, sourcePath)) {
        // wrong proxy dll, probably outdated. delete and install the new one
        if (!QFile::remove(targetPath)) {
          throw MyException(QObject::tr("Failed to delete old proxy-dll %1").arg(targetPath));
        }
        if (!QFile::copy(sourcePath, targetPath)) {
          throw MyException(QObject::tr("Failed to copy %1 to %2").arg(sourcePath).arg(targetPath));
        }
      } // otherwise the proxy-dll is already the right one
    } else {
      // no proxy dll installed yet. move the original and insert proxy-dll

      QString origFile = game->gameDirectory().absoluteFilePath(QString::fromStdWString(AppConfig::proxyDLLOrig()));

      if (QFile(origFile).exists()) {
        // orig-file exists. this may happen if the steam-api was updated or the user messed with the
        // dlls.
        if (!QFile::remove(origFile)) {
          throw MyException(QObject::tr("Failed to overwrite %1").arg(origFile));
        }
      }
      if (!QFile::rename(targetPath, origFile)) {
        throw MyException(QObject::tr("Failed to rename %1 to %2").arg(targetPath).arg(origFile));
      }
      if (!QFile::copy(sourcePath, targetPath)) {
        throw MyException(QObject::tr("Failed to copy %1 to %2").arg(sourcePath).arg(targetPath));
      }
    }
    writeHintFile(game->gameDirectory());
  } catch (const std::exception &e) {
    QMessageBox::critical(nullptr, QObject::tr("Failed to set up proxy-dll loading"), e.what());
  }
}


void LoadMechanism::activate(EMechanism mechanism)
{
  switch (mechanism) {
    case LOAD_MODORGANIZER: {
      deactivateProxyDLL();
      deactivateScriptExtender();
    } break;
    case LOAD_SCRIPTEXTENDER: {
      deactivateProxyDLL();
      activateScriptExtender();
    } break;
    case LOAD_PROXYDLL: {
      deactivateScriptExtender();
      activateProxyDLL();
    } break;
  }
}