[Preview/Conflicts] Merge remote-tracking branch 'origin/ready-for-me…

…rge/trigger-repair-database' into 'staging'

src/library/library_prefs.cpp

@@ -109,3 +109,10 @@ const ConfigKey mixxx::library::prefs::kTagFetcherApplyCoverConfigKey =
         ConfigKey{
                 mixxx::library::prefs::kConfigGroup,
                 QStringLiteral("TagFetcherApplyCover")};
+
+const QString kTrackCollectionConfigGroup = QStringLiteral("[TrackCollection]");
+
+const ConfigKey mixxx::library::prefs::kRepairDatabaseOnNextRestart =
+        ConfigKey{
+                kTrackCollectionConfigGroup,
+                QStringLiteral("RepairDatabaseOnNextRestart")};

src/library/library_prefs.h

@@ -56,6 +56,8 @@ extern const ConfigKey kTagFetcherApplyTagsConfigKey;
 
 extern const ConfigKey kTagFetcherApplyCoverConfigKey;
 
+extern const ConfigKey kRepairDatabaseOnNextRestart;
+
 } // namespace prefs
 
 } // namespace library

src/library/trackcollectionmanager.cpp

@@ -10,17 +10,14 @@
 #include "sources/soundsourceproxy.h"
 #include "track/track.h"
 #include "util/assert.h"
+#include "util/cmdlineargs.h"
 #include "util/db/dbconnectionpooled.h"
 #include "util/logger.h"
 
 namespace {
 
 const mixxx::Logger kLogger("TrackCollectionManager");
 
-const QString kConfigGroup = QStringLiteral("[TrackCollection]");
-
-const ConfigKey kConfigKeyRepairDatabaseOnNextRestart(kConfigGroup, "RepairDatabaseOnNextRestart");
-
 inline
 parented_ptr<TrackCollection> createInternalTrackCollection(
         TrackCollectionManager* parent,
@@ -44,12 +41,14 @@ TrackCollectionManager::TrackCollectionManager(
       m_pInternalCollection(createInternalTrackCollection(this, pConfig, deleteTrackForTestingFn)) {
     const QSqlDatabase dbConnection = mixxx::DbConnectionPooled(pDbConnectionPool);
 
-    // TODO(XXX): Add a checkbox in the library preferences for checking
-    // and repairing the database on the next restart of the application.
-    if (pConfig->getValue(kConfigKeyRepairDatabaseOnNextRestart, false)) {
+    // The database repair can be triggered via "Repair Database"
+    // in the options menu, as well as using the command line option
+    // "--repair-database".
+    if (CmdlineArgs::Instance().getRepairDatabase() ||
+            pConfig->getValue(mixxx::library::prefs::kRepairDatabaseOnNextRestart, false)) {
         m_pInternalCollection->repairDatabase(dbConnection);
         // Reset config value
-        pConfig->setValue(kConfigKeyRepairDatabaseOnNextRestart, false);
+        pConfig->setValue(mixxx::library::prefs::kRepairDatabaseOnNextRestart, false);
     }
 
     m_pInternalCollection->connectDatabase(dbConnection);

src/mixxxmainwindow.cpp

@@ -808,6 +808,11 @@ void MixxxMainWindow::connectMenuBar() {
             this,
             &MixxxMainWindow::slotOptionsPreferences,
             Qt::UniqueConnection);
+    connect(m_pMenuBar,
+            &WMainMenuBar::repairDatabase,
+            this,
+            &MixxxMainWindow::slotOptionsRepairDatabase,
+            Qt::UniqueConnection);
     connect(m_pMenuBar,
             &WMainMenuBar::loadTrackToDeck,
             this,
@@ -1088,6 +1093,31 @@ void MixxxMainWindow::slotOptionsPreferences() {
     m_pPrefDlg->activateWindow();
 }
 
+void MixxxMainWindow::slotOptionsRepairDatabase() {
+    const QString kConfigGroup = QStringLiteral("[TrackCollection]");
+    const ConfigKey kConfigKeyRepairDatabaseOnNextRestart(
+            kConfigGroup, "RepairDatabaseOnNextRestart");
+
+    QMessageBox::StandardButton btn = QMessageBox::warning(
+            this,
+            VersionStore::applicationName(),
+            tr("Repairing the database requires a restart of Mixxx.\n"
+               "Do you want to exit out of Mixxx and run the database repair on the next launch?"),
+            QMessageBox::Yes | QMessageBox::No,
+            QMessageBox::No);
+    if (btn == QMessageBox::Yes) {
+        // TODO(cr7pt0gr4ph7): Implement an external restart handler that
+        // automatically restarts Mixxx here. Basically just a small
+        // cmdline application that, when invoked, forwards everything to the
+        // main Mixxx executable, but also listens for a a special restart flag.
+
+        // Set flag and exit out of Mixxx
+        m_pCoreServices->getSettings()->setValue(
+                mixxx::library::prefs::kRepairDatabaseOnNextRestart, true);
+        close();
+    }
+}
+
 void MixxxMainWindow::slotNoVinylControlInputConfigured() {
     QMessageBox::StandardButton btn = QMessageBox::warning(
             this,

src/mixxxmainwindow.h

@@ -61,6 +61,8 @@ class MixxxMainWindow : public QMainWindow {
     void slotFileLoadSongPlayer(int deck);
     /// show the preferences dialog
     void slotOptionsPreferences();
+    /// set up a database repair for next start
+    void slotOptionsRepairDatabase();
     /// show the about dialog
     void slotHelpAbout();
     // show keywheel

src/util/cmdlineargs.cpp

@@ -57,6 +57,7 @@ CmdlineArgs::CmdlineArgs()
           m_qml(false),
 #endif
           m_safeMode(false),
+          m_repairDatabase(false),
           m_useLegacyVuMeter(false),
           m_useLegacySpinny(false),
           m_debugAssertBreak(false),
@@ -194,6 +195,12 @@ bool CmdlineArgs::parse(const QStringList& arguments, CmdlineArgs::ParseMode mod
                             : QString());
     parser.addOption(rescanLibrary);
 
+    const QCommandLineOption repairDatabase(QStringLiteral("repair-database"),
+            forUserFeedback ? QCoreApplication::translate("CmdlineArgs",
+                                      "Run a database cleanup when Mixxx is launched.")
+                            : QString());
+    parser.addOption(repairDatabase);
+
     // An option with a value
     const QCommandLineOption settingsPath(QStringLiteral("settings-path"),
             forUserFeedback ? QCoreApplication::translate("CmdlineArgs",
@@ -402,6 +409,10 @@ bool CmdlineArgs::parse(const QStringList& arguments, CmdlineArgs::ParseMode mod
         m_rescanLibrary = true;
     }
 
+    if (parser.isSet(repairDatabase)) {
+        m_repairDatabase = true;
+    }
+
     if (parser.isSet(settingsPath)) {
         m_settingsPath = parser.value(settingsPath);
         if (!m_settingsPath.endsWith("/")) {

src/util/cmdlineargs.h

@@ -52,6 +52,9 @@ class CmdlineArgs final {
     }
 #endif
     bool getSafeMode() const { return m_safeMode; }
+    bool getRepairDatabase() const {
+        return m_repairDatabase;
+    }
     bool useColors() const {
         return m_useColors;
     }
@@ -101,6 +104,7 @@ class CmdlineArgs final {
     bool m_qml;
 #endif
     bool m_safeMode;
+    bool m_repairDatabase;
     bool m_useLegacyVuMeter;
     bool m_useLegacySpinny;
     bool m_debugAssertBreak;

src/widget/wmainmenubar.cpp

@@ -501,6 +501,14 @@ void WMainMenuBar::initialize() {
 
     pOptionsMenu->addSeparator();
 
+    QString repairDatabaseTitle = tr("Repair Database");
+    QString repairDatabaseText = tr("Restart Mixxx & repair database inconsistencies");
+    auto* pOptionsRepairDatabase = new QAction(repairDatabaseTitle, this);
+    pOptionsRepairDatabase->setStatusTip(repairDatabaseText);
+    pOptionsRepairDatabase->setWhatsThis(buildWhatsThis(repairDatabaseTitle, repairDatabaseText));
+    connect(pOptionsRepairDatabase, &QAction::triggered, this, &WMainMenuBar::repairDatabase);
+    pOptionsMenu->addAction(pOptionsRepairDatabase);
+
     QString preferencesTitle = tr("&Preferences");
     QString preferencesText = tr("Change Mixxx settings (e.g. playback, MIDI, controls)");
     auto* pOptionsPreferences = new QAction(preferencesTitle, this);

src/widget/wmainmenubar.h

@@ -63,6 +63,7 @@ class WMainMenuBar : public QMenuBar {
     void createPlaylist();
     void loadTrackToDeck(int deck);
     void reloadSkin();
+    void repairDatabase();
     void rescanLibrary();
 #ifdef __ENGINEPRIME__
     void exportLibrary();