porymap/src/scriptapi/scripting.cpp

#if __has_include(<QQmlEngine>)
#include <QQmlEngine>

#include "scripting.h"
#include "log.h"
#include "config.h"
#include "mainwindow.h"

const QMap<CallbackType, QString> callbackFunctions = {
    {OnProjectOpened, "onProjectOpened"},
    {OnProjectClosed, "onProjectClosed"},
    {OnBlockChanged, "onBlockChanged"},
    {OnBorderMetatileChanged, "onBorderMetatileChanged"},
    {OnBlockHoverChanged, "onBlockHoverChanged"},
    {OnBlockHoverCleared, "onBlockHoverCleared"},
    {OnMapOpened, "onMapOpened"},
    {OnLayoutOpened, "onLayoutOpened"},
    {OnMapResized, "onMapResized"},
    {OnBorderResized, "onBorderResized"},
    {OnMapShifted, "onMapShifted"},
    {OnTilesetUpdated, "onTilesetUpdated"},
    {OnMainTabChanged, "onMainTabChanged"},
    {OnMapViewTabChanged, "onMapViewTabChanged"},
    {OnBorderVisibilityToggled, "onBorderVisibilityToggled"},
};

Scripting *instance = nullptr;

void Scripting::stop() {
    delete instance;
    instance = nullptr;
}

void Scripting::init(MainWindow *mainWindow) {
    Scripting::stop();
    instance = new Scripting(mainWindow);
}

Scripting::Scripting(MainWindow *mainWindow) {
    this->mainWindow = mainWindow;
    this->engine = new QJSEngine();
    this->engine->installExtensions(QJSEngine::ConsoleExtension);
    const QStringList paths = userConfig.getCustomScriptPaths();
    const QList<bool> enabled = userConfig.getCustomScriptsEnabled();
    for (int i = 0; i < paths.length(); i++) {
        if (enabled.value(i, true))
            loadScript(paths.at(i));
    }
    this->scriptUtility = new ScriptUtility(mainWindow);
}

Scripting::~Scripting() {
    if (mainWindow) mainWindow->clearOverlay();
    this->engine->setInterrupted(true);
    qDeleteAll(this->imageCache);
    this->scripts.clear();
    this->scriptExecutionStack.clear();
    delete this->engine;
    delete this->scriptUtility;
}

void Scripting::loadScript(const QString &filepath) {
    if (filepath.isEmpty()) return;

    auto script = QSharedPointer<Script>(new Script());
    script->setFilepath(Project::getExistingFilepath(filepath));
    if (script->filepath().isEmpty()) {
        logError(QString("Failed to find script file '%1'.").arg(filepath));
    } else {
        script->setModule(this->engine->importModule(script->filepath()));
    }
    if (script->filepath().isEmpty() || tryErrorJS(script->module())) {
        QMessageBox messageBox(this->mainWindow);
        messageBox.setText("Failed to load script");
        messageBox.setInformativeText(QString("An error occurred while loading custom script file '%1'").arg(filepath));
        messageBox.setDetailedText(getMostRecentError());
        messageBox.setIcon(QMessageBox::Warning);
        messageBox.addButton(QMessageBox::Ok);
        messageBox.exec();
        return;
    }

    logInfo(QString("Successfully loaded custom script file '%1'").arg(filepath));
    this->scripts.append(script);
}

void Scripting::populateGlobalObject(MainWindow *mainWindow) {
    if (!instance || !instance->engine) return;

    instance->engine->globalObject().setProperty("map", instance->engine->newQObject(mainWindow));
    instance->engine->globalObject().setProperty("overlay", instance->engine->newQObject(mainWindow->ui->graphicsView_Map));
    instance->engine->globalObject().setProperty("utility", instance->engine->newQObject(instance->scriptUtility));

    // Note: QJSEngine also has these functions, but not in Qt 5.15.
    QQmlEngine::setObjectOwnership(mainWindow, QQmlEngine::CppOwnership);
    QQmlEngine::setObjectOwnership(mainWindow->ui->graphicsView_Map, QQmlEngine::CppOwnership);
    QQmlEngine::setObjectOwnership(instance->scriptUtility, QQmlEngine::CppOwnership);

    QJSValue constants = instance->engine->newObject();

    // Get version numbers
    QJSValue version = instance->engine->newObject();
    version.setProperty("major", porymapVersion.majorVersion());
    version.setProperty("minor", porymapVersion.minorVersion());
    version.setProperty("patch", porymapVersion.microVersion());
    constants.setProperty("version", version);

    // Get basic tileset information
    constants.setProperty("max_primary_tiles", Project::getNumTilesPrimary());
    constants.setProperty("max_secondary_tiles", Project::getNumTilesSecondary());
    constants.setProperty("max_primary_metatiles", Project::getNumMetatilesPrimary());
    constants.setProperty("max_secondary_metatiles", Project::getNumMetatilesSecondary());
    constants.setProperty("num_primary_palettes", Project::getNumPalettesPrimary());
    constants.setProperty("num_secondary_palettes", Project::getNumPalettesSecondary());
    constants.setProperty("layers_per_metatile", projectConfig.getNumLayersInMetatile());
    constants.setProperty("tiles_per_metatile", projectConfig.getNumTilesInMetatile());

    constants.setProperty("base_game_version", projectConfig.getBaseGameVersionString());

    // Read out behavior values into constants object
    QJSValue behaviorsArray = instance->engine->newObject();
    const QMap<QString, uint32_t> * map = &mainWindow->editor->project->metatileBehaviorMap;
    for (auto i = map->cbegin(), end = map->cend(); i != end; i++)
        behaviorsArray.setProperty(i.key(), i.value());
    constants.setProperty("metatile_behaviors", behaviorsArray);

    instance->engine->globalObject().setProperty("constants", constants);

    // Prevent changes to the constants object
    instance->engine->evaluate("Object.freeze(constants.metatile_behaviors);");
    instance->engine->evaluate("Object.freeze(constants.version);");
    instance->engine->evaluate("Object.freeze(constants);");
}

bool Scripting::tryErrorJS(QJSValue js) {
    if (!js.isError())
        return false;

    // Get properties of the error
    QFileInfo file(js.property("fileName").toString());
    QString fileName = file.fileName();
    QString lineNumber = js.property("lineNumber").toString();
    QString errStr = js.toString();

    // The script engine is interrupted during project reopen, during which
    // all script modules intentionally return as error objects.
    // We don't need to report these "errors" to the user.
    if (errStr == "Error: Interrupted")
        return false;

    // Convert properties to message strings
    QString fileErrStr = fileName == "undefined" ? "" : QString(" '%1'").arg(fileName);
    QString lineErrStr = lineNumber == "undefined" ? "" : QString(" at line %1").arg(lineNumber);

    logError(QString("Error in custom script%1%2: '%3'")
             .arg(fileErrStr)
             .arg(lineErrStr)
             .arg(errStr));
    return true;
}

void Scripting::invokeCallback(CallbackType type, const QJSValueList &args) {
    for (const auto& script : this->scripts) {
        this->scriptExecutionStack.push(script);
        invokeCallback(script, type, args);
        this->scriptExecutionStack.pop();
    }
}

void Scripting::invokeCallback(QSharedPointer<const Script> script, CallbackType type, const QJSValueList &args) {
    QString functionName = callbackFunctions[type];
    QJSValue callbackFunction = script->module().property(functionName);
    if (tryErrorJS(callbackFunction)) return;
    tryErrorJS(callbackFunction.call(args));
}

void Scripting::invokeAction(int actionIndex) {
    if (!instance || !instance->scriptUtility) return;
    QString functionName = instance->scriptUtility->getActionFunctionName(actionIndex);
    if (functionName.isEmpty()) return;

    bool foundFunction = false;
    for (const auto& script : instance->scripts) {
        instance->scriptExecutionStack.push(script);
        if (instance->invokeAction(script, functionName)) foundFunction = true;
        instance->scriptExecutionStack.pop();
    }
    if (!foundFunction) {
        logError(QString("Unknown custom script function '%1'").arg(functionName));
        QMessageBox messageBox(instance->mainWindow);
        messageBox.setText("Failed to run custom action");
        messageBox.setInformativeText(getMostRecentError());
        messageBox.setIcon(QMessageBox::Warning);
        messageBox.addButton(QMessageBox::Ok);
        messageBox.exec();
    }
}

// Returns true if the script had the specified function and tried to execute it (whether successful or not),
// returns false if the script did not have the specified function.
// TODO: Now that we can individually identify scripts, this should never happen.
//       We can always call the function using the script that registered this action.
bool Scripting::invokeAction(QSharedPointer<const Script> script, const QString &functionName) {
    QJSValue callbackFunction = script->module().property(functionName);
    if (callbackFunction.isUndefined() || !callbackFunction.isCallable())
        return false;
    if (tryErrorJS(callbackFunction)) return true;

    QJSValue result = callbackFunction.call(QJSValueList());
    tryErrorJS(result);
    return true;
}

void Scripting::cb_ProjectOpened(QString projectPath) {
    if (!instance) return;

    QJSValueList args {
        projectPath,
    };
    instance->invokeCallback(OnProjectOpened, args);
}

void Scripting::cb_ProjectClosed(QString projectPath) {
    if (!instance) return;

    QJSValueList args {
        projectPath,
    };
    instance->invokeCallback(OnProjectClosed, args);
}

void Scripting::cb_MetatileChanged(int x, int y, Block prevBlock, Block newBlock) {
    if (!instance) return;

    QJSValueList args {
        x,
        y,
        instance->fromBlock(prevBlock),
        instance->fromBlock(newBlock),
    };
    instance->invokeCallback(OnBlockChanged, args);
}

void Scripting::cb_BorderMetatileChanged(int x, int y, uint16_t prevMetatileId, uint16_t newMetatileId) {
    if (!instance) return;

    QJSValueList args {
        x,
        y,
        prevMetatileId,
        newMetatileId,
    };
    instance->invokeCallback(OnBorderMetatileChanged, args);
}

void Scripting::cb_BlockHoverChanged(int x, int y) {
    if (!instance) return;

    QJSValueList args {
        x,
        y,
    };
    instance->invokeCallback(OnBlockHoverChanged, args);
}

void Scripting::cb_BlockHoverCleared() {
    if (!instance) return;
    instance->invokeCallback(OnBlockHoverCleared, QJSValueList());
}

void Scripting::cb_MapOpened(QString mapName) {
    if (!instance) return;

    QJSValueList args {
        mapName,
    };
    instance->invokeCallback(OnMapOpened, args);
}

void Scripting::cb_LayoutOpened(QString layoutName) {
    if (!instance) return;

    QJSValueList args {
        layoutName,
    };
    instance->invokeCallback(OnLayoutOpened, args);
}

void Scripting::cb_MapResized(int oldWidth, int oldHeight, const QMargins &delta) {
    if (!instance) return;

    QJSValueList args {
        oldWidth,
        oldHeight,
        Scripting::margins(delta),
    };
    instance->invokeCallback(OnMapResized, args);
}

void Scripting::cb_BorderResized(int oldWidth, int oldHeight, int newWidth, int newHeight) {
    if (!instance) return;

    QJSValueList args {
        oldWidth,
        oldHeight,
        newWidth,
        newHeight,
    };
    instance->invokeCallback(OnBorderResized, args);
}

void Scripting::cb_MapShifted(int xDelta, int yDelta) {
    if (!instance) return;

    QJSValueList args {
        xDelta,
        yDelta,
    };
    instance->invokeCallback(OnMapShifted, args);
}

void Scripting::cb_TilesetUpdated(const QString &tilesetName) {
    if (!instance) return;

    QJSValueList args {
        tilesetName,
    };
    instance->invokeCallback(OnTilesetUpdated, args);
}

void Scripting::cb_MainTabChanged(int oldTab, int newTab) {
    if (!instance) return;

    QJSValueList args {
        oldTab,
        newTab,
    };
    instance->invokeCallback(OnMainTabChanged, args);
}

void Scripting::cb_MapViewTabChanged(int oldTab, int newTab) {
    if (!instance) return;

    QJSValueList args {
        oldTab,
        newTab,
    };
    instance->invokeCallback(OnMapViewTabChanged, args);
}

void Scripting::cb_BorderVisibilityToggled(bool visible) {
    if (!instance) return;

    QJSValueList args {
        visible,
    };
    instance->invokeCallback(OnBorderVisibilityToggled, args);
}

QJSValue Scripting::fromBlock(Block block) {
    QJSValue obj = instance->engine->newObject();
    obj.setProperty("metatileId", block.metatileId());
    obj.setProperty("collision", block.collision());
    obj.setProperty("elevation", block.elevation());
    obj.setProperty("rawValue", block.rawValue());
    return obj;
}

QJSValue Scripting::dimensions(int width, int height) {
    QJSValue obj = instance->engine->newObject();
    obj.setProperty("width", width);
    obj.setProperty("height", height);
    return obj;
}

QJSValue Scripting::margins(const QMargins &margins) {
    QJSValue obj = instance->engine->newObject();
    obj.setProperty("left", margins.left());
    obj.setProperty("right", margins.right());
    obj.setProperty("top", margins.top());
    obj.setProperty("bottom", margins.bottom());
    return obj;
}

QJSValue Scripting::position(int x, int y) {
    QJSValue obj = instance->engine->newObject();
    obj.setProperty("x", x);
    obj.setProperty("y", y);
    return obj;
}

Tile Scripting::toTile(QJSValue obj) {
    Tile tile = Tile();

    if (obj.hasProperty("tileId"))
        tile.tileId = obj.property("tileId").toInt();
    if (obj.hasProperty("xflip"))
        tile.xflip = obj.property("xflip").toBool();
    if (obj.hasProperty("yflip"))
        tile.yflip = obj.property("yflip").toBool();
    if (obj.hasProperty("palette"))
        tile.palette = obj.property("palette").toInt();

    return tile;
}

QJSValue Scripting::fromTile(Tile tile) {
    QJSValue obj = instance->engine->newObject();
    obj.setProperty("tileId", tile.tileId);
    obj.setProperty("xflip", tile.xflip);
    obj.setProperty("yflip", tile.yflip);
    obj.setProperty("palette", tile.palette);
    return obj;
}

QJSValue Scripting::dialogInput(QJSValue input, bool selectedOk) {
    QJSValue obj = instance->engine->newObject();
    obj.setProperty("input", input);
    obj.setProperty("ok", selectedOk);
    return obj;
}

QJSValue Scripting::fileResponse(const QString &s, bool isError) {
    QJSValue obj = instance->engine->newObject();
    obj.setProperty("content", isError ? QString() : s);
    obj.setProperty("error", isError ? s : QString());
    return obj;
}

QSharedPointer<Scripting::Script> Scripting::getActiveScript() const {
    return this->scriptExecutionStack.isEmpty() ? nullptr : this->scriptExecutionStack.top();
}

bool Scripting::checkFilePermissions(const QString &filepath) {
    // Scripts are allowed to read/write files inside the project directory without explicit permission.
    // Normal file permission rules will still apply.
    if (QDir::cleanPath(filepath).startsWith(QDir::cleanPath(projectConfig.root()))) return true;

    if (!instance) return false;
    QSharedPointer<Script> script = instance->getActiveScript();
    if (!script || script->hash().isEmpty()) return false;

    if (porymapConfig.trustedScriptHashes.contains(script->hash()))
        return true; // User has already opted to trust this script

    QString reason = QString("'%1' would like to access files outside your project folder.").arg(script->filepath());
    return instance->askForTrust(script, reason);
}

bool Scripting::askForTrust(QSharedPointer<Script> script, const QString &reason) {
    QuestionMessage messageBox(QString("Allow '%1' to continue?").arg(script->fileName()), this->mainWindow);
    messageBox.setInformativeText(reason);
    if (messageBox.exec() == QMessageBox::Yes) {
        // User has opted to trust this script. If this script had an old hash saved, remove that first.
        QList<QString> oldHashes = porymapConfig.trustedScriptHashes.keys(script->filepath());
        for (const auto& oldHash : oldHashes) porymapConfig.trustedScriptHashes.remove(oldHash);
        porymapConfig.trustedScriptHashes.insert(script->hash(), script->filepath());
        return true;
    }
    return false;
}

QJSEngine *Scripting::getEngine() {
    return instance->engine;
}

const QImage * Scripting::getImage(const QString &inputFilepath, bool useCache) {
    if (inputFilepath.isEmpty())
        return nullptr;

    const QImage * image;
    if (useCache) {
        // Try to retrieve image from the cache
        image = instance->imageCache.value(inputFilepath, nullptr);
        if (image) return image;
    }

    const QString filepath = Project::getExistingFilepath(inputFilepath);
    if (filepath.isEmpty())
        return nullptr;

    image = new QImage(filepath);
    instance->imageCache.insert(inputFilepath, image);
    return image;
}


#endif // __has_include(<QQmlEngine>)