Add unlockable icon

Author: GriffinRichards

include/mainwindow.h

@@ -34,6 +34,7 @@
 #include "newlayoutdialog.h"
 #include "message.h"
 #include "resizelayoutpopup.h"
+#include "unlockableicon.h"
 
 #if __has_include(<QJSValue>)
 #include <QJSValue>
@@ -354,6 +355,8 @@ private slots:
     MapNavigation forwardNavigation;
     bool ignoreNavigationRecords = false;
 
+    UnlockableIcon unlockableMainTabIcon;
+
     QAction *copyAction = nullptr;
     QAction *pasteAction = nullptr;
 
@@ -460,7 +463,8 @@ private slots:
     MapListToolBar* getCurrentMapListToolBar();
     MapTree* getCurrentMapList();
     void setLocationComboBoxes(const QStringList &locations);
-
+    void overrideMainTabIcons(const QIcon& icon);
+    void tryUnlockMainTabIcon(const Map* map);
     QObjectList shortcutableObjects() const;
     void addCustomHeaderValue(QString key, QJsonValue value, bool isNew = false);
 

include/ui/unlockableicon.h

@@ -0,0 +1,57 @@
+#ifndef UNLOCKABLEICON_H
+#define UNLOCKABLEICON_H
+
+// Manages an icon loaded from a mildly obfuscated data file containing the icon's pixmap and a key.
+// The icon can only be accessed by inputting the correct key.
+
+#include <QObject>
+#include <QIcon>
+#include <QString>
+#include <QSet>
+
+class UnlockableIcon : public QObject
+{
+    Q_OBJECT
+public:
+    UnlockableIcon(QObject* parent = nullptr);
+    UnlockableIcon(const QString& dataFilepath, QObject* parent = nullptr);
+    ~UnlockableIcon() {};
+
+    // Create the obfuscated data file to load an unlockable icon from.
+    // Normally unused, this is only needed to update the resource data file.
+    static bool createDataFile(const QString& dataFilepath, const QString& key, const QPixmap& icon);
+
+    bool load(const QString& dataFilepath);
+    void clear();
+
+    // Try to unlock the icon by matching the next character in the key.
+    // Progress resets if the character is not a match.
+    void tryUnlock(const QChar& c);
+
+    // Try to unlock the icon by matching the next character in the key.
+    // Progress resets if none of the characters in the set are a match.
+    void tryUnlock(const QSet<QChar>& cSet);
+
+    // Try to unlock the icon by matching the remaining characters in the key.
+    // Progress resets if any character in the string is not a match.
+    void tryUnlock(const QString& key);
+
+    bool isUnlocked() const { return m_loaded && m_keyIndex >= m_key.length(); }
+    QIcon icon() const { return isUnlocked() ? m_icon : QIcon(); }
+
+signals:
+    void unlocked(const QIcon& icon);
+
+private:
+    QIcon m_icon;
+    QString m_key;
+    quint32 m_keyIndex = 0;
+    bool m_loaded = false;
+
+    bool canUnlock() const { return m_loaded && m_keyIndex < m_key.length(); }
+    bool tryKeyMatch(const QSet<QChar>& cSet);
+};
+
+
+
+#endif // UNLOCKABLEICON_H

porymap.pro

@@ -148,6 +148,7 @@ SOURCES += src/core/advancemapparser.cpp \
     src/ui/regionmappropertiesdialog.cpp \
     src/ui/colorpicker.cpp \
     src/ui/loadingscreen.cpp \
+    src/ui/unlockableicon.cpp \
     src/config.cpp \
     src/editor.cpp \
     src/main.cpp \
@@ -268,6 +269,7 @@ HEADERS  += include/core/advancemapparser.h \
     include/ui/regionmappropertiesdialog.h \
     include/ui/colorpicker.h \
     include/ui/loadingscreen.h \
+    include/ui/unlockableicon.h \
     include/config.h \
     include/editor.h \
     include/mainwindow.h \

resources/images.qrc

@@ -102,6 +102,7 @@
         <file>images/Entities_16x16.png</file>
         <file>images/pokemon_icon_placeholder.png</file>
         <file>images/porysplash.gif</file>
+        <file>images/unlockable_tab_icon.dat</file>
         <file>icons/clipboard.ico</file>
         <file>icons/map_go.ico</file>
     </qresource>

resources/images/unlockable_tab_icon.dat

@@ -0,0 +1 @@
+	TUlTU0lOR05PN�iVBORw0KGgoAAAANSUhEUgAAADgAAAA4CAYAAACohjseAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAEXRFWHRfcV9pY29PcmlnRGVwdGgANBP37ZUAAAPjSURBVGiB1VqtuqMwED2734pKJPLKPkJlH2EfAYlERlZGIpE8Ao+A7CNUXlkZiWMFHW4YksDdSdre8318/LZkOpOcMzMFEiPPsnG4D/N2qZrxUjXzMb/Gz6Xv/xPDiBA+b3fnda1bKFXM50oV0Lqdj+kZKX6Lv+E/wA2gc6WKqMYBLzAw5Cm+j4HkIQqsB2yHpg/0zKUuRe9ObuBwraFUtbpuG01e5fsYSB6ix0JjuNb4OOaLfdMqVGczP2cbxUNYguQGloUGANxa5dwTYs47G8lDtDobHE7rEJ3Rt87LMbz3FORZNppOj6bTIx3bey4C+P1Xj38TXKXs2WyFI31/8jnYPOZaiOt8135EmHKNyfcUinyLFaK/YhgRAgnmLZ7jCoeOL3UpGuNTDByuNY4PuiAQTRxO1WxMw6jj1ipkf5VojMlpQusW1XnNe8AkAm4t0LST8cSZMQV3cg+aTo/kpa0QBdYq5pAf3jtETacXC8XkNbU4ByYP8+MfEaLHQi+S3rLIcDgVACZv8XsAUPdTuE7PrUP7O3hKPmjz3J4c0E58pXhKiFK4HZnw5t4l2MZKaSI5XIUk1zkXA7Gk2lMS3rrPFtdsD30c88W9W6vg4s23RUhI7ykfSt8v9uCeQYTKEz7JRguNtCYjRijlIW/Y4plvW96Ujk9ME3wOue5zmWaXLWxvcbUTA2IDfZVr4EtuuejBpo23RihE7ZJEKLP3hWiM3oSYRE2nR04DLrgq2sBa3fBQfXk+mGfZuNVgoXnqEtlloYPZhTSbEINWSV/JwceBXLX4+FA6viQe5KtgaKX9vN2diS15/m7Maz3oqnXadVDyhun0SqWEVE4sJSP+dXxhxOssnCIIdk3GtfhI52AUovfldkoVKAuNstCo+wx1n+Hzdp+P7ZI+X2jeJh/0hVGoBbZVVKLPNq0Sz0Gx2K7OZpUOAV8hNlxrAHA+A7g9RcY9ajKi8UWZg5S/2cUinxzzzUUOyvZfzoOm00GO862ivm6SvfrGKN0nLzpRF/dwqlCdzaLLS73DqYK23FOIShElRF0akqc9vn9W2G1sjrrPXq9Ft+TUxzGfUyqucLZK89XZiAu/YnynsRmqsKVSMk/9IxCvwWzxZAyyF/Pg3g6Qb9Bc/QzXGnaz5uX4Tji6MndbmNP2Y0PU15fgpB/Tc9FX0b19P9/z/LNSJRN9Du75v5l9P0ToWyXJPUiSTbiMdNU7XRXv1fcLiV7swb3zxeXVLWNjlO6fng/yH4TSKTvreOsWtt1U8eV6tocoT+SFq7LIUPfy8USnCd5r4NhafOx9DLpIRhO+soTvP9s+b0sXmX+4yahShjMNpAAAAABJRU5ErkJggg==

src/mainwindow.cpp

@@ -334,6 +334,8 @@ void MainWindow::initCustomUI() {
         ui->mainTabBar->setTabIcon(i, mainTabIcons.value(i));
     }
 
+    this->unlockableMainTabIcon.load(":/images/unlockable_tab_icon.dat");
+
     // Create map header data widget
     this->mapHeaderForm = new MapHeaderForm();
     ui->layout_HeaderData->addWidget(this->mapHeaderForm);
@@ -343,6 +345,12 @@ void MainWindow::initCustomUI() {
     ui->graphicsView_Map->setResizeAnchor(QGraphicsView::ViewportAnchor::AnchorUnderMouse);
 }
 
+void MainWindow::overrideMainTabIcons(const QIcon& icon) {
+    for (int i = 1; i < ui->mainTabBar->count(); i++) {
+        ui->mainTabBar->setTabIcon(i, icon);
+    }
+}
+
 void MainWindow::initExtraSignals() {
     connect(ui->tabWidget_EventType, &QTabWidget::currentChanged, this, &MainWindow::eventTabChanged);
 
@@ -2285,6 +2293,8 @@ void MainWindow::on_mainTabBar_tabBarClicked(int index)
         ui->stackedWidget_MapEvents->setCurrentIndex(1);
     } else if (index == MainTab::Connections) {
         ui->graphicsView_Connections->setFocus(); // Avoid opening tab with focus on something editable
+        connect(this, &MainWindow::mapOpened, this, &MainWindow::tryUnlockMainTabIcon, Qt::UniqueConnection);
+        connect(&this->unlockableMainTabIcon, &UnlockableIcon::unlocked, this, &MainWindow::overrideMainTabIcons, Qt::UniqueConnection);
     }
 
     if (!editor->map) return;
@@ -2294,6 +2304,18 @@ void MainWindow::on_mainTabBar_tabBarClicked(int index)
     }
 }
 
+void MainWindow::tryUnlockMainTabIcon(const Map* map) {
+    if (!map || this->unlockableMainTabIcon.isUnlocked()) return;
+    const Layout* layout = map->layout();
+    if (!layout) return;
+
+    QSet<QChar> chars;
+    if (!layout->name.isEmpty()) chars.insert(layout->name.at(0));
+    const QString tilesetName = Tileset::stripPrefix(layout->tileset_secondary_label);
+    if (!tilesetName.isEmpty()) chars.insert(tilesetName.at(0));
+    this->unlockableMainTabIcon.tryUnlock(chars);
+}
+
 void MainWindow::on_actionZoom_In_triggered() {
     editor->scaleMapView(1);
 }

src/ui/unlockableicon.cpp

@@ -0,0 +1,115 @@
+#include "unlockableicon.h"
+#include <QFile>
+#include <QBuffer>
+
+// TODO: QT_VERSION checks
+// TODO: Obfuscate the activation method?
+
+constexpr int Version = QDataStream::Qt_6_8;
+
+UnlockableIcon::UnlockableIcon(QObject* parent) : QObject(parent) {};
+UnlockableIcon::UnlockableIcon(const QString& dataFilepath, QObject* parent) : UnlockableIcon(parent) {
+    load(dataFilepath);
+};
+
+bool UnlockableIcon::createDataFile(const QString& filepath, const QString& key, const QPixmap& icon) {
+    QFile file(filepath);
+    if (!file.open(QIODevice::WriteOnly)) return false;
+
+    QDataStream out(&file);
+    out.setVersion(Version);
+
+    QByteArray key64 = key.toUtf8().toBase64();
+    out << (quint8)key.length();
+    out << (quint8)key64.length();
+    for (const auto& byte : key64) out << byte;
+
+    QByteArray iconData;
+    QBuffer buffer(&iconData);
+    buffer.open(QIODevice::WriteOnly);
+    icon.save(&buffer, "PNG");
+    buffer.close();
+
+    QByteArray iconData64 = iconData.toBase64();
+    out << (quint16)iconData.length();
+    out << (quint16)iconData64.length();
+    for (const auto& byte : iconData64) out << byte;
+
+    file.close();
+    return true;
+}
+
+bool UnlockableIcon::load(const QString& dataFilepath) {
+    clear();
+
+    QFile file(dataFilepath);
+    if (!file.open(QIODevice::ReadOnly)) return false;
+
+    QDataStream in(&file);
+    in.setVersion(Version);
+
+    quint8 keyLength = 0;
+    quint8 key64Length = 0;
+    in >> keyLength;
+    in >> key64Length;
+    if (keyLength == 0 || key64Length == 0) return false;
+
+    QByteArray key64(key64Length,0);
+    for (quint8 i = 0; i < key64Length; i++) in >> key64[i];
+    QString key = QString(QByteArray::fromBase64(key64));
+    if (key.length() != keyLength) return false;
+
+    quint16 iconDataLength = 0;
+    quint16 iconData64Length = 0;
+    in >> iconDataLength;
+    in >> iconData64Length;
+    if (iconDataLength == 0 || iconData64Length == 0) return false;
+
+    QByteArray iconData64(iconData64Length,0);
+    for (quint16 i = 0; i < iconData64Length; i++) in >> iconData64[i];
+    QByteArray iconData = QByteArray::fromBase64(iconData64);
+    if (iconData.length() != iconDataLength) return false;
+
+    QPixmap iconPixmap;
+    iconPixmap.loadFromData(iconData);
+    if (iconPixmap.isNull()) return false;
+
+    m_icon = QIcon(iconPixmap);
+    m_key = key;
+    m_loaded = true;
+    return true;
+}
+
+void UnlockableIcon::clear() {
+    m_icon = QIcon();
+    m_key = QString();
+    m_keyIndex = 0;
+    m_loaded = false;
+}
+
+bool UnlockableIcon::tryKeyMatch(const QSet<QChar>& cSet) {
+    if (m_keyIndex >= m_key.length()) return false;
+    if (!cSet.contains(m_key.at(m_keyIndex))) {
+        m_keyIndex = 0;
+        return false;
+    }
+    if (++m_keyIndex == m_key.length()) {
+        emit unlocked(m_icon);
+    }
+    return true;
+}
+
+void UnlockableIcon::tryUnlock(const QSet<QChar>& cSet) {
+    if (canUnlock()) tryKeyMatch(cSet);
+}
+
+void UnlockableIcon::tryUnlock(const QChar& c) {
+    tryUnlock(QSet<QChar>{c});
+}
+
+void UnlockableIcon::tryUnlock(const QString& key) {
+    if (!canUnlock()) return;
+    for (const QChar& c : key) {
+        if (!tryKeyMatch(QSet<QChar>{c})) return;
+    }
+}