Automatic Card Database Updates (#6004)

* Add the option to background the oracle wizard, add an option to automatically launch oracle wizard in background every X days since last launch.

* Mocks and a typo.

* Lint.

* Lint?

* qOverload the spinBox.

* Change to a prompt instead.

* An Label.

* Update window_main.cpp

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
Co-authored-by: Zach H <zahalpern+github@gmail.com>

cockatrice/src/dialogs/dlg_settings.cpp

@@ -52,6 +52,13 @@
 #define WIKI_CUSTOM_SHORTCUTS "https://github.com/Cockatrice/Cockatrice/wiki/Custom-Keyboard-Shortcuts"
 #define WIKI_TRANSLATION_FAQ "https://github.com/Cockatrice/Cockatrice/wiki/Translation-FAQ"
 
+enum startupCardUpdateCheckBehaviorIndex
+{
+    startupCardUpdateCheckBehaviorIndexNone,
+    startupCardUpdateCheckBehaviorIndexPrompt,
+    startupCardUpdateCheckBehaviorIndexAlways
+};
+
 GeneralSettingsPage::GeneralSettingsPage()
 {
     QStringList languageCodes = findQmFiles();
@@ -71,6 +78,21 @@ GeneralSettingsPage::GeneralSettingsPage()
     // updates
     SettingsCache &settings = SettingsCache::instance();
     startupUpdateCheckCheckBox.setChecked(settings.getCheckUpdatesOnStartup());
+
+    startupCardUpdateCheckBehaviorSelector.addItem(""); // these will be set in retranslateUI
+    startupCardUpdateCheckBehaviorSelector.addItem("");
+    startupCardUpdateCheckBehaviorSelector.addItem("");
+    if (SettingsCache::instance().getStartupCardUpdateCheckPromptForUpdate()) {
+        startupCardUpdateCheckBehaviorSelector.setCurrentIndex(startupCardUpdateCheckBehaviorIndexPrompt);
+    } else if (SettingsCache::instance().getStartupCardUpdateCheckAlwaysUpdate()) {
+        startupCardUpdateCheckBehaviorSelector.setCurrentIndex(startupCardUpdateCheckBehaviorIndexAlways);
+    } else {
+        startupCardUpdateCheckBehaviorSelector.setCurrentIndex(startupCardUpdateCheckBehaviorIndexNone);
+    }
+
+    cardUpdateCheckIntervalSpinBox.setMinimum(1);
+    cardUpdateCheckIntervalSpinBox.setMaximum(30);
+    cardUpdateCheckIntervalSpinBox.setValue(settings.getCardUpdateCheckInterval());
     updateNotificationCheckBox.setChecked(settings.getNotifyAboutUpdates());
     newVersionOracleCheckBox.setChecked(settings.getNotifyAboutNewVersion());
 
@@ -83,6 +105,15 @@ GeneralSettingsPage::GeneralSettingsPage()
             &GeneralSettingsPage::languageBoxChanged);
     connect(&startupUpdateCheckCheckBox, &QCheckBox::QT_STATE_CHANGED, &settings,
             &SettingsCache::setCheckUpdatesOnStartup);
+    connect(&startupCardUpdateCheckBehaviorSelector, QOverload<int>::of(&QComboBox::currentIndexChanged), this,
+            [](int index) {
+                SettingsCache::instance().setStartupCardUpdateCheckPromptForUpdate(
+                    index == startupCardUpdateCheckBehaviorIndexPrompt);
+                SettingsCache::instance().setStartupCardUpdateCheckAlwaysUpdate(
+                    index == startupCardUpdateCheckBehaviorIndexAlways);
+            });
+    connect(&cardUpdateCheckIntervalSpinBox, qOverload<int>(&QSpinBox::valueChanged), &settings,
+            &SettingsCache::setCardUpdateCheckInterval);
     connect(&updateNotificationCheckBox, &QCheckBox::QT_STATE_CHANGED, &settings, &SettingsCache::setNotifyAboutUpdate);
     connect(&newVersionOracleCheckBox, &QCheckBox::QT_STATE_CHANGED, &settings,
             &SettingsCache::setNotifyAboutNewVersion);
@@ -95,9 +126,14 @@ GeneralSettingsPage::GeneralSettingsPage()
     personalGrid->addWidget(&updateReleaseChannelLabel, 2, 0);
     personalGrid->addWidget(&updateReleaseChannelBox, 2, 1);
     personalGrid->addWidget(&startupUpdateCheckCheckBox, 4, 0, 1, 2);
-    personalGrid->addWidget(&updateNotificationCheckBox, 5, 0, 1, 2);
-    personalGrid->addWidget(&newVersionOracleCheckBox, 6, 0, 1, 2);
-    personalGrid->addWidget(&showTipsOnStartup, 7, 0, 1, 2);
+    personalGrid->addWidget(&startupCardUpdateCheckBehaviorLabel, 5, 0);
+    personalGrid->addWidget(&startupCardUpdateCheckBehaviorSelector, 5, 1);
+    personalGrid->addWidget(&cardUpdateCheckIntervalLabel, 6, 0);
+    personalGrid->addWidget(&cardUpdateCheckIntervalSpinBox, 6, 1);
+    personalGrid->addWidget(&lastCardUpdateCheckDateLabel, 7, 1);
+    personalGrid->addWidget(&updateNotificationCheckBox, 8, 0, 1, 2);
+    personalGrid->addWidget(&newVersionOracleCheckBox, 9, 0, 1, 2);
+    personalGrid->addWidget(&showTipsOnStartup, 10, 0, 1, 2);
 
     personalGroupBox = new QGroupBox;
     personalGroupBox->setLayout(personalGrid);
@@ -341,6 +377,14 @@ void GeneralSettingsPage::retranslateUi()
     tokenDatabasePathLabel.setText(tr("Token database:"));
     updateReleaseChannelLabel.setText(tr("Update channel"));
     startupUpdateCheckCheckBox.setText(tr("Check for client updates on startup"));
+    startupCardUpdateCheckBehaviorLabel.setText(tr("Check for card database updates on startup"));
+    startupCardUpdateCheckBehaviorSelector.setItemText(startupCardUpdateCheckBehaviorIndexNone, tr("Don't check"));
+    startupCardUpdateCheckBehaviorSelector.setItemText(startupCardUpdateCheckBehaviorIndexPrompt,
+                                                       tr("Prompt for update"));
+    startupCardUpdateCheckBehaviorSelector.setItemText(startupCardUpdateCheckBehaviorIndexAlways,
+                                                       tr("Always update in the background"));
+    cardUpdateCheckIntervalLabel.setText(tr("Check for card database updates every"));
+    cardUpdateCheckIntervalSpinBox.setSuffix(tr(" days"));
     updateNotificationCheckBox.setText(tr("Notify if a feature supported by the server is missing in my client"));
     newVersionOracleCheckBox.setText(tr("Automatically run Oracle when running a new version of Cockatrice"));
     showTipsOnStartup.setText(tr("Show tips on startup"));
@@ -348,6 +392,12 @@ void GeneralSettingsPage::retranslateUi()
 
     const auto &settings = SettingsCache::instance();
 
+    QDate lastCheckDate = settings.getLastCardUpdateCheck();
+    int daysAgo = lastCheckDate.daysTo(QDate::currentDate());
+
+    lastCardUpdateCheckDateLabel.setText(
+        tr("Last update check on %1 (%2 days ago)").arg(lastCheckDate.toString()).arg(daysAgo));
+
     // We can't change the strings after they're put into the QComboBox, so this is our workaround
     int oldIndex = updateReleaseChannelBox.currentIndex();
     updateReleaseChannelBox.clear();

cockatrice/src/dialogs/dlg_settings.h

@@ -71,6 +71,11 @@ private:
     QGroupBox *pathsGroupBox;
     QComboBox languageBox;
     QCheckBox startupUpdateCheckCheckBox;
+    QLabel startupCardUpdateCheckBehaviorLabel;
+    QComboBox startupCardUpdateCheckBehaviorSelector;
+    QLabel cardUpdateCheckIntervalLabel;
+    QSpinBox cardUpdateCheckIntervalSpinBox;
+    QLabel lastCardUpdateCheckDateLabel;
     QCheckBox updateNotificationCheckBox;
     QCheckBox newVersionOracleCheckBox;
     QComboBox updateReleaseChannelBox;

cockatrice/src/dialogs/dlg_startup_card_check.cpp

@@ -0,0 +1,50 @@
+#include "dlg_startup_card_check.h"
+
+#include "../settings/cache_settings.h"
+
+#include <QDate>
+
+DlgStartupCardCheck::DlgStartupCardCheck(QWidget *parent) : QDialog(parent)
+{
+    setWindowTitle(tr("Card Update Check"));
+
+    layout = new QVBoxLayout(this);
+
+    QDate lastCheckDate = SettingsCache::instance().getLastCardUpdateCheck();
+    int daysAgo = lastCheckDate.daysTo(QDate::currentDate());
+
+    instructionLabel = new QLabel(
+        tr("It has been more than %2 days since you last checked your card database for updates.\nChoose how you would "
+           "like to run the card database updater.\nYou can always change this behavior in the 'General' settings tab.")
+            .arg(daysAgo));
+
+    layout->addWidget(instructionLabel);
+
+    group = new QButtonGroup(this);
+
+    foregroundBtn = new QRadioButton(tr("Run in foreground"));
+    backgroundBtn = new QRadioButton(tr("Run in background"));
+    backgroundAlwaysBtn = new QRadioButton(tr("Run in background and always from now on"));
+    dontPromptBtn = new QRadioButton(tr("Don't prompt again and don't run"));
+    dontRunBtn = new QRadioButton(tr("Don't run this time"));
+
+    group->addButton(foregroundBtn, 0);
+    group->addButton(backgroundBtn, 1);
+    group->addButton(backgroundAlwaysBtn, 2);
+    group->addButton(dontPromptBtn, 3);
+    group->addButton(dontRunBtn, 4);
+
+    foregroundBtn->setChecked(true); // default
+
+    layout->addWidget(foregroundBtn);
+    layout->addWidget(backgroundBtn);
+    layout->addWidget(backgroundAlwaysBtn);
+    layout->addWidget(dontPromptBtn);
+    layout->addWidget(dontRunBtn);
+
+    buttonBox = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel);
+    layout->addWidget(buttonBox);
+
+    connect(buttonBox, &QDialogButtonBox::accepted, this, &QDialog::accept);
+    connect(buttonBox, &QDialogButtonBox::rejected, this, &QDialog::reject);
+}

cockatrice/src/dialogs/dlg_startup_card_check.h

@@ -0,0 +1,24 @@
+#ifndef DLG_STARTUP_CARD_CHECK_H
+#define DLG_STARTUP_CARD_CHECK_H
+
+#include <QButtonGroup>
+#include <QDialog>
+#include <QDialogButtonBox>
+#include <QLabel>
+#include <QRadioButton>
+#include <QVBoxLayout>
+
+class DlgStartupCardCheck : public QDialog
+{
+    Q_OBJECT
+public:
+    explicit DlgStartupCardCheck(QWidget *parent);
+
+    QVBoxLayout *layout;
+    QLabel *instructionLabel;
+    QButtonGroup *group;
+    QRadioButton *foregroundBtn, *backgroundBtn, *backgroundAlwaysBtn, *dontPromptBtn, *dontRunBtn;
+    QDialogButtonBox *buttonBox;
+};
+
+#endif // DLG_STARTUP_CARD_CHECK_H