Implement persistent custom Date Format using Q_ENUM and QVariant

Author: xARSENICx

src/library/basetracktablemodel.cpp

@@ -115,6 +115,13 @@ void BaseTrackTableModel::setApplyPlayedTrackColor(bool apply) {
     s_bApplyPlayedTrackColor = apply;
 }
 
+const QString BaseTrackTableModel::kDateFormatDefault = QString();
+QString BaseTrackTableModel::s_dateFormat = BaseTrackTableModel::kDateFormatDefault;
+
+void BaseTrackTableModel::setDateFormat(const QString& format) {
+    s_dateFormat = format;
+}
+
 BaseTrackTableModel::BaseTrackTableModel(
         QObject* parent,
         TrackCollectionManager* pTrackCollectionManager,
@@ -689,10 +696,10 @@ QVariant BaseTrackTableModel::roleValue(
             if (field == ColumnCache::COLUMN_PLAYLISTTRACKSTABLE_DATETIMEADDED) {
                 // Timestamp column in history feature:
                 // Use localized date/time format without text: "5/20/98 03:40 AM"
-                return mixxx::displayLocalDateTime(dt);
+                return mixxx::displayLocalDateTime(dt, s_dateFormat);
             }
             // For Date Added, use just the date: "5/20/98"
-            return dt.date();
+            return mixxx::formatDate(dt.date(), s_dateFormat);
         }
         case ColumnCache::COLUMN_LIBRARYTABLE_LAST_PLAYED_AT: {
             QDateTime lastPlayedAt;
@@ -718,7 +725,7 @@ QVariant BaseTrackTableModel::roleValue(
             if (role == Qt::ToolTipRole || role == kDataExportRole) {
                 return dt;
             }
-            return dt.date();
+            return mixxx::formatDate(dt.date(), s_dateFormat);
         }
         case ColumnCache::COLUMN_LIBRARYTABLE_BPM: {
             mixxx::Bpm bpm;

src/library/basetracktablemodel.h

@@ -9,6 +9,7 @@
 #include "library/trackmodel.h"
 #include "track/track_decl.h"
 #include "util/color/colorpalette.h"
+#include "util/datetime.h"
 
 class TrackCollectionManager;
 
@@ -132,6 +133,18 @@ class BaseTrackTableModel : public QAbstractTableModel, public TrackModel {
     static constexpr bool kApplyPlayedTrackColorDefault = true;
     static void setApplyPlayedTrackColor(bool apply);
 
+    enum class DateFormat {
+        Native = 0,        // System Default
+        ISO8601 = 1,       // yyyy-MM-dd
+        RegionalShort = 2, // d/M/yy
+        RegionalLong = 3,  // dd.MM.yyyy
+        Custom = 4,
+    };
+    Q_ENUM(DateFormat)
+
+    static const QString kDateFormatDefault;
+    static void setDateFormat(const QString& format);
+
   protected:
     // Build a map from the column names to their indices
     // used by fieldIndex().
@@ -307,4 +320,5 @@ class BaseTrackTableModel : public QAbstractTableModel, public TrackModel {
     static std::optional<ColorPalette> s_keyColorPalette;
 
     static bool s_bApplyPlayedTrackColor;
+    static QString s_dateFormat;
 };

src/library/library_prefs.cpp

@@ -114,3 +114,8 @@ const ConfigKey mixxx::library::prefs::kTagFetcherApplyCoverConfigKey =
         ConfigKey{
                 mixxx::library::prefs::kConfigGroup,
                 QStringLiteral("TagFetcherApplyCover")};
+
+const ConfigKey mixxx::library::prefs::kDateFormatConfigKey =
+        ConfigKey{
+                mixxx::library::prefs::kConfigGroup,
+                QStringLiteral("DateFormat")};

src/library/library_prefs.h

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

src/preferences/dialog/dlgpreflibrary.cpp

@@ -205,11 +205,12 @@ void DlgPrefLibrary::slotHide() {
     QMessageBox msgBox;
     msgBox.setIcon(QMessageBox::Warning);
     msgBox.setWindowTitle(tr("Music Directory Added"));
-    msgBox.setText(tr("You added one or more music directories. The tracks in "
-                      "these directories won't be available until you rescan "
-                      "your library. Would you like to rescan now?"));
+    msgBox.setText(tr(
+            "You added one or more music directories. The tracks in "
+            "these directories won't be available until you rescan "
+            "your library. Would you like to rescan now?"));
     QPushButton* scanButton = msgBox.addButton(
-        tr("Scan"), QMessageBox::AcceptRole);
+            tr("Scan"), QMessageBox::AcceptRole);
     msgBox.addButton(QMessageBox::Cancel);
     msgBox.setDefaultButton(scanButton);
     msgBox.exec();
@@ -777,3 +778,66 @@ void DlgPrefLibrary::setSeratoMetadataEnabled(bool shouldSyncTrackMetadata) {
         checkBox_serato_metadata_export->setChecked(false);
     }
 }
+
+void DlgPrefLibrary::slotDateFormatIndexChanged(int index) {
+    auto type = comboBox_dateFormat->itemData(index)
+                        .value<BaseTrackTableModel::DateFormat>();
+
+    if (type == BaseTrackTableModel::DateFormat::Custom) {
+        // Enable editing for Custom
+        if (!comboBox_dateFormat->isEditable()) {
+            comboBox_dateFormat->setEditable(true);
+            comboBox_dateFormat->setEditText(m_lastCustomDateFormat);
+        }
+    } else {
+        // Disable editing for Presets
+        comboBox_dateFormat->setEditable(false);
+
+        QString format;
+        switch (type) {
+        case BaseTrackTableModel::DateFormat::Native:
+            format = QString();
+            break;
+        case BaseTrackTableModel::DateFormat::ISO8601:
+            format = QStringLiteral("yyyy-MM-dd");
+            break;
+        case BaseTrackTableModel::DateFormat::RegionalShort:
+            format = QStringLiteral("d/M/yy");
+            break;
+        case BaseTrackTableModel::DateFormat::RegionalLong:
+            format = QStringLiteral("dd.MM.yyyy");
+            break;
+        case BaseTrackTableModel::DateFormat::Custom:
+            // Should not happen here given the if/else above
+            break;
+        }
+        slotDateFormatChanged(format);
+    }
+}
+
+void DlgPrefLibrary::slotDateFormatChanged(const QString& text) {
+    QString format = text;
+    // If not editable, we are in a Preset mode, but 'text' might be the Item
+    // Label (e.g. "Native ...") depending on how this was called. However, our
+    // slotDateFormatIndexChanged calls this explicitly with the correct format
+    // string. The editTextChanged signal only fires when editable. So 'text'
+    // should be the correct format string in all valid cases.
+
+    if (comboBox_dateFormat->isEditable()) {
+        int index = comboBox_dateFormat->currentIndex();
+        if (index >= 0) {
+            auto type = comboBox_dateFormat->itemData(index)
+                                .value<BaseTrackTableModel::DateFormat>();
+            if (type == BaseTrackTableModel::DateFormat::Custom) {
+                m_lastCustomDateFormat = format;
+            }
+        }
+    }
+
+    // Update Preview
+    const QString previewStr = mixxx::formatDate(QDate::currentDate(), format);
+    label_dateFormatPreview->setText(previewStr);
+
+    m_pConfig->setValue(kDateFormatConfigKey, format);
+    BaseTrackTableModel::setDateFormat(format);
+}

src/preferences/dialog/dlgpreflibrary.h

@@ -13,7 +13,7 @@
 class QWidget;
 class ControlProxy;
 
-class DlgPrefLibrary : public DlgPreferencePage, public Ui::DlgPrefLibraryDlg  {
+class DlgPrefLibrary : public DlgPreferencePage, public Ui::DlgPrefLibraryDlg {
     Q_OBJECT
   public:
     enum class TrackDoubleClickAction : int {
@@ -67,6 +67,8 @@ class DlgPrefLibrary : public DlgPreferencePage, public Ui::DlgPrefLibraryDlg  {
     void slotBpmRangeSelected(int index);
     void slotBpmColumnPrecisionChanged(int bpmPrecision);
     void slotSeratoMetadataExportClicked(bool);
+    void slotDateFormatIndexChanged(int index);
+    void slotDateFormatChanged(const QString& text);
 
   private:
     void populateDirList();
@@ -83,4 +85,6 @@ class DlgPrefLibrary : public DlgPreferencePage, public Ui::DlgPrefLibraryDlg  {
     int m_iOriginalTrackTableRowHeight;
     // Listen to rate range changes in order to update the fuzzy BPM range
     parented_ptr<ControlProxy> m_pRateRangeDeck1;
+
+    QString m_lastCustomDateFormat;
 };

src/preferences/dialog/dlgpreflibrarydlg.ui

@@ -173,15 +173,15 @@
      </property>
      <layout class="QGridLayout" name="gridLayout_track_table_view">
 
-      <item row="1" column="0" colspan="3">
+      <item row="1" column="0" colspan="4">
        <widget class="QCheckBox" name="checkBox_edit_metadata_selected_clicked">
         <property name="text">
          <string>Edit metadata after clicking selected track</string>
         </property>
        </widget>
       </item>
 
-      <item row="2" column="0" colspan="3">
+      <item row="2" column="0" colspan="4">
        <widget class="QLabel" name="label_doubeClickAction">
         <property name="text">
          <string>Track Double-Click Action:</string>
@@ -192,7 +192,7 @@
        </widget>
       </item>
 
-      <item row="3" column="0" colspan="3">
+      <item row="3" column="0" colspan="4">
        <widget class="QRadioButton" name="radioButton_dbclick_deck">
         <property name="text">
          <string>Load track to next available deck</string>
@@ -202,21 +202,21 @@
         </property>
        </widget>
       </item>
-      <item row="4" column="0" colspan="3">
+      <item row="4" column="0" colspan="4">
        <widget class="QRadioButton" name="radioButton_dbclick_bottom">
         <property name="text">
          <string>Add track to Auto DJ queue (bottom)</string>
         </property>
        </widget>
       </item>
-      <item row="5" column="0" colspan="3">
+      <item row="5" column="0" colspan="4">
        <widget class="QRadioButton" name="radioButton_dbclick_top">
         <property name="text">
          <string>Add track to Auto DJ queue (top)</string>
         </property>
        </widget>
       </item>
-      <item row="6" column="0" colspan="3">
+      <item row="6" column="0" colspan="4">
        <widget class="QRadioButton" name="radioButton_dbclick_ignore">
         <property name="text">
          <string>Ignore</string>
@@ -290,14 +290,58 @@
        <widget class="QSpinBox" name="spinbox_bpm_precision"/>
       </item>
 
-      <item row="10" column="0" colspan="3">
+      <item row="10" column="0" colspan="4">
        <widget class="QCheckBox" name="checkbox_played_track_color">
         <property name="text">
          <string>Grey out played tracks</string>
         </property>
        </widget>
       </item>
 
+      <item row="11" column="0">
+       <widget class="QLabel" name="label_dateFormat">
+        <property name="text">
+         <string>Date Format:</string>
+        </property>
+        <property name="alignment">
+         <set>Qt::AlignLeft|Qt::AlignVCenter</set>
+        </property>
+       </widget>
+      </item>
+      <item row="11" column="1" colspan="3">
+       <layout class="QHBoxLayout" name="horizontalLayout_dateFormat">
+        <property name="leftMargin">
+         <number>0</number>
+        </property>
+        <property name="topMargin">
+         <number>0</number>
+        </property>
+        <property name="rightMargin">
+         <number>0</number>
+        </property>
+        <property name="bottomMargin">
+         <number>0</number>
+        </property>
+        <item>
+         <widget class="QComboBox" name="comboBox_dateFormat">
+          <property name="sizePolicy">
+           <sizepolicy hsizetype="Expanding" vsizetype="Fixed">
+            <horstretch>0</horstretch>
+            <verstretch>0</verstretch>
+           </sizepolicy>
+          </property>
+         </widget>
+        </item>
+        <item>
+         <widget class="QLabel" name="label_dateFormatPreview">
+          <property name="text">
+           <string>Preview</string>
+          </property>
+         </widget>
+        </item>
+       </layout>
+      </item>
+
      </layout>
     </widget>
    </item><!-- Track Table View -->
@@ -695,6 +739,7 @@
   <tabstop>btn_library_font</tabstop>
   <tabstop>spinbox_bpm_precision</tabstop>
   <tabstop>checkbox_played_track_color</tabstop>
+  <tabstop>comboBox_dateFormat</tabstop>
   <tabstop>spinBox_search_debouncing_timeout</tabstop>
   <tabstop>checkBox_enable_search_completions</tabstop>
   <tabstop>checkBox_enable_search_history_shortcuts</tabstop>

src/test/datetime_test.cpp

@@ -0,0 +1,36 @@
+#include "util/datetime.h"
+
+#include <gtest/gtest.h>
+
+#include <QDate>
+#include <QLocale>
+
+namespace mixxx {
+
+TEST(DateTimeTest, FormatDate) {
+    QDate date(2023, 10, 25);
+
+    // Test ISO
+    EXPECT_EQ(formatDate(date, "yyyy-MM-dd"), "2023-10-25");
+
+    // Test Custom
+    EXPECT_EQ(formatDate(date, "dd.MM.yy"), "25.10.23");
+
+    // Test Native (empty string)
+    // Should fallback to QLocale::ShortFormat
+    QString native = QLocale().toString(date, QLocale::ShortFormat);
+    EXPECT_EQ(formatDate(date, ""), native);
+}
+
+TEST(DateTimeTest, FormatDateTime) {
+    QDateTime dt(QDate(2023, 10, 25), QTime(14, 30, 0));
+
+    // Test Custom
+    EXPECT_EQ(formatDateTime(dt, "yyyy-MM-dd HH:mm"), "2023-10-25 14:30");
+
+    // Test Native (empty string)
+    QString native = QLocale().toString(dt, QLocale::ShortFormat);
+    EXPECT_EQ(formatDateTime(dt, ""), native);
+}
+
+} // namespace mixxx

src/util/datetime.h

@@ -28,11 +28,39 @@ inline QDateTime convertVariantToDateTime(
     return data.toDateTime();
 }
 
+/// Helper to format a QDate according to a format string.
+/// If format is empty, uses the system's default locale short format.
+inline QString formatDate(
+        const QDate& date,
+        const QString& format = QString()) {
+    if (!date.isValid()) {
+        return QString();
+    }
+    if (format.isEmpty()) {
+        return QLocale().toString(date, QLocale::ShortFormat);
+    }
+    return date.toString(format);
+}
+
+/// Helper to format a QDateTime according to a format string.
+/// If format is empty, uses the system's default locale short format.
+inline QString formatDateTime(
+        const QDateTime& dt,
+        const QString& format = QString()) {
+    if (!dt.isValid()) {
+        return QString();
+    }
+    if (format.isEmpty()) {
+        return QLocale().toString(dt, QLocale::ShortFormat);
+    }
+    return dt.toString(format);
+}
+
 /// Format a QDateTime for display to the user using the
-/// application's locale settings.
+/// application's locale settings or specified preference.
 inline QString displayLocalDateTime(
-        const QDateTime& dt) {
-    return QLocale().toString(dt, QLocale::ShortFormat);
+        const QDateTime& dt, const QString& format = QString()) {
+    return formatDateTime(dt, format);
 }
 
 } // namespace mixxx