-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
basesqltablemodel.cpp
1097 lines (970 loc) · 43.6 KB
/
basesqltablemodel.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Created by RJ Ryan ([email protected]) 1/29/2010
#include <QtAlgorithms>
#include <QtDebug>
#include <QUrl>
#include <QTableView>
#include "library/basesqltablemodel.h"
#include "library/coverartdelegate.h"
#include "library/stardelegate.h"
#include "library/starrating.h"
#include "library/bpmdelegate.h"
#include "library/previewbuttondelegate.h"
#include "library/locationdelegate.h"
#include "library/queryutil.h"
#include "mixer/playermanager.h"
#include "mixer/playerinfo.h"
#include "track/keyutils.h"
#include "track/trackmetadata.h"
#include "util/db/dbconnection.h"
#include "util/duration.h"
#include "util/dnd.h"
#include "util/assert.h"
#include "util/performancetimer.h"
static const bool sDebug = false;
// The logic in the following code relies to a track column = 0
// Do not change it without changing the logic
// Column 0 is skipped when calculating the the columns of the view table
static const int kIdColumn = 0;
static const int kMaxSortColumns = 3;
// Constant for getModelSetting(name)
static const char* COLUMNS_SORTING = "ColumnsSorting";
BaseSqlTableModel::BaseSqlTableModel(QObject* pParent,
TrackCollection* pTrackCollection,
const char* settingsNamespace)
: QAbstractTableModel(pParent),
TrackModel(pTrackCollection->database(), settingsNamespace),
m_pTrackCollection(pTrackCollection),
m_database(pTrackCollection->database()),
m_previewDeckGroup(PlayerManager::groupForPreviewDeck(0)),
m_bInitialized(false),
m_currentSearch("") {
DEBUG_ASSERT(m_pTrackCollection);
connect(&PlayerInfo::instance(), SIGNAL(trackLoaded(QString, TrackPointer)),
this, SLOT(trackLoaded(QString, TrackPointer)));
connect(&m_pTrackCollection->getTrackDAO(), SIGNAL(forceModelUpdate()),
this, SLOT(select()));
// TODO(rryan): This is a virtual function call from a constructor.
trackLoaded(m_previewDeckGroup, PlayerInfo::instance().getTrackInfo(m_previewDeckGroup));
}
BaseSqlTableModel::~BaseSqlTableModel() {
}
void BaseSqlTableModel::initHeaderData() {
// Set the column heading labels, rename them for translations and have
// proper capitalization
// TODO(owilliams): Clean this up to make it readable.
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_TIMESPLAYED,
tr("Played"), 50);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_ARTIST,
tr("Artist"), 200);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_TITLE,
tr("Title"), 300);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_ALBUM,
tr("Album"), 200);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_ALBUMARTIST,
tr("Album Artist"), 100);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_GENRE,
tr("Genre"), 100);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_COMPOSER,
tr("Composer"), 50);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_GROUPING,
tr("Grouping"), 10);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_YEAR,
tr("Year"), 40);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_FILETYPE,
tr("Type"), 50);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_NATIVELOCATION,
tr("Location"), 100);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_COMMENT,
tr("Comment"), 250);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_DURATION,
tr("Duration"), 70);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_RATING,
tr("Rating"), 100);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_BITRATE,
tr("Bitrate"), 50);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_BPM,
tr("BPM"), 70);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_TRACKNUMBER,
tr("Track #"), 10);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_DATETIMEADDED,
tr("Date Added"), 90);
setHeaderProperties(ColumnCache::COLUMN_PLAYLISTTRACKSTABLE_POSITION,
tr("#"), 30);
setHeaderProperties(ColumnCache::COLUMN_PLAYLISTTRACKSTABLE_DATETIMEADDED,
tr("Timestamp"), 80);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_KEY,
tr("Key"), 50);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_BPM_LOCK,
tr("BPM Lock"), 10);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_PREVIEW,
tr("Preview"), 50);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_COVERART,
tr("Cover Art"), 90);
setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_REPLAYGAIN,
tr("ReplayGain"), 50);
}
void BaseSqlTableModel::setHeaderProperties(
ColumnCache::Column column, QString title, int defaultWidth) {
int fi = fieldIndex(column);
setHeaderData(fi, Qt::Horizontal, m_tableColumnCache.columnName(column),
TrackModel::kHeaderNameRole);
setHeaderData(fi, Qt::Horizontal, title, Qt::DisplayRole);
setHeaderData(fi, Qt::Horizontal, defaultWidth, TrackModel::kHeaderWidthRole);
}
bool BaseSqlTableModel::setHeaderData(int section, Qt::Orientation orientation,
const QVariant &value, int role) {
int numColumns = columnCount();
if (section < 0 || section >= numColumns) {
return false;
}
if (orientation != Qt::Horizontal) {
// We only care about horizontal headers.
return false;
}
if (m_headerInfo.size() != numColumns) {
m_headerInfo.resize(numColumns);
}
m_headerInfo[section][role] = value;
emit(headerDataChanged(orientation, section, section));
return true;
}
QVariant BaseSqlTableModel::headerData(int section, Qt::Orientation orientation,
int role) const {
if (role == Qt::DisplayRole && orientation == Qt::Horizontal) {
QVariant headerValue = m_headerInfo.value(section).value(role);
if (!headerValue.isValid()) {
// Try EditRole if DisplayRole wasn't present
headerValue = m_headerInfo.value(section).value(Qt::EditRole);
}
if (!headerValue.isValid()) {
headerValue = QVariant(section).toString();
}
return headerValue;
} else if (role == TrackModel::kHeaderWidthRole && orientation == Qt::Horizontal) {
QVariant widthValue = m_headerInfo.value(section).value(role);
if (!widthValue.isValid()) {
return 50;
}
return widthValue;
} else if (role == TrackModel::kHeaderNameRole && orientation == Qt::Horizontal) {
return m_headerInfo.value(section).value(role);
} else if (role == Qt::ToolTipRole && orientation == Qt::Horizontal) {
QVariant tooltip = m_headerInfo.value(section).value(role);
if (tooltip.isValid()) return tooltip;
}
return QAbstractTableModel::headerData(section, orientation, role);
}
bool BaseSqlTableModel::isColumnHiddenByDefault(int column) {
if ((column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COMPOSER)) ||
(column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TRACKNUMBER)) ||
(column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_YEAR)) ||
(column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_GROUPING)) ||
(column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_NATIVELOCATION)) ||
(column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_ALBUMARTIST)) ||
(column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_REPLAYGAIN))) {
return true;
}
return false;
}
void BaseSqlTableModel::clearRows() {
DEBUG_ASSERT(m_rowInfo.empty() == m_trackIdToRows.empty());
DEBUG_ASSERT(m_rowInfo.size() >= m_trackIdToRows.size());
if (!m_rowInfo.isEmpty()) {
beginRemoveRows(QModelIndex(), 0, m_rowInfo.size() - 1);
m_rowInfo.clear();
m_trackIdToRows.clear();
endRemoveRows();
}
DEBUG_ASSERT(m_rowInfo.isEmpty());
DEBUG_ASSERT(m_trackIdToRows.isEmpty());
}
void BaseSqlTableModel::replaceRows(
QVector<RowInfo>&& rows,
TrackId2Rows&& trackIdToRows) {
// NOTE(uklotzde): Use r-value references for parameters here, because
// conceptually those parameters should replace the corresponding internal
// member variables. Currently Qt4/5 doesn't support move semantics and
// instead prevents unnecessary deep copying by implicit sharing (COW)
// behind the scenes. Moving would be more efficient, although implicit
// sharing meets all requirements. If Qt will ever add move support for
// its container types in the future this code becomes even more efficient.
DEBUG_ASSERT(rows.empty() == trackIdToRows.empty());
DEBUG_ASSERT(rows.size() >= trackIdToRows.size());
if (rows.isEmpty()) {
clearRows();
} else {
beginInsertRows(QModelIndex(), 0, rows.size() - 1);
m_rowInfo = rows;
m_trackIdToRows = trackIdToRows;
endInsertRows();
}
}
void BaseSqlTableModel::select() {
if (!m_bInitialized) {
return;
}
// We should be able to detect when a select() would be a no-op. The DAO's
// do not currently broadcast signals for when common things happen. In the
// future, we can turn this check on and avoid a lot of needless
// select()'s. rryan 9/2011
// if (!m_bDirty) {
// if (sDebug) {
// qDebug() << this << "Skipping non-dirty select()";
// }
// return;
// }
if (sDebug) {
qDebug() << this << "select()";
}
PerformanceTimer time;
time.start();
// Prepare query for id and all columns not in m_trackSource
QString queryString = QString("SELECT %1 FROM %2 %3")
.arg(m_tableColumns.join(","), m_tableName, m_tableOrderBy);
if (sDebug) {
qDebug() << this << "select() executing:" << queryString;
}
QSqlQuery query(m_database);
// This causes a memory savings since QSqlCachedResult (what QtSQLite uses)
// won't allocate a giant in-memory table that we won't use at all.
query.setForwardOnly(true);
if (!query.prepare(queryString)) {
LOG_FAILED_QUERY(query);
return;
}
if (!query.exec()) {
LOG_FAILED_QUERY(query);
return;
}
// Remove all the rows from the table after(!) the query has been
// executed successfully. See Bug #1090888.
// TODO(rryan) we could edit the table in place instead of clearing it?
clearRows();
// The size of the result set is not known in advance for a
// forward-only query, so we cannot reserve memory for rows
// in advance.
QVector<RowInfo> rowInfos;
QSet<TrackId> trackIds;
int idColumn = -1;
while (query.next()) {
QSqlRecord sqlRecord = query.record();
if (idColumn < 0) {
idColumn = sqlRecord.indexOf(m_idColumn);
}
VERIFY_OR_DEBUG_ASSERT(idColumn >= 0) {
qCritical()
<< "ID column not available in database query results:"
<< m_idColumn;
return;
}
// TODO(XXX): Can we get rid of the hard-coded assumption that
// the the first column always contains the id?
DEBUG_ASSERT(idColumn == kIdColumn);
TrackId trackId(sqlRecord.value(idColumn));
trackIds.insert(trackId);
RowInfo rowInfo;
rowInfo.trackId = trackId;
// current position defines the ordering
rowInfo.order = rowInfos.size();
rowInfo.metadata.reserve(sqlRecord.count());
for (int i = 0; i < m_tableColumns.size(); ++i) {
rowInfo.metadata.push_back(sqlRecord.value(i));
}
rowInfos.push_back(rowInfo);
}
if (sDebug) {
qDebug() << "Rows actually received:" << rowInfos.size();
}
if (m_trackSource) {
m_trackSource->filterAndSort(trackIds,
m_currentSearch,
m_currentSearchFilter,
m_trackSourceOrderBy,
m_sortColumns,
m_tableColumns.size() - 1, // exclude the 1st column with the id
&m_trackSortOrder);
// Re-sort the track IDs since filterAndSort can change their order or mark
// them for removal (by setting their row to -1).
for (auto& rowInfo: rowInfos) {
// If the sort is not a track column then we will sort only to
// separate removed tracks (order == -1) from present tracks (order ==
// 0). Otherwise we sort by the order that filterAndSort returned to us.
if (m_trackSourceOrderBy.isEmpty()) {
rowInfo.order = m_trackSortOrder.contains(rowInfo.trackId) ? 0 : -1;
} else {
rowInfo.order = m_trackSortOrder.value(rowInfo.trackId, -1);
}
}
}
// RowInfo::operator< sorts by the order field, except -1 is placed at the
// end so we can easily slice off rows that are no longer present. Stable
// sort is necessary because the tracks may be in pre-sorted order so we
// should not disturb that if we are only removing tracks.
qStableSort(rowInfos.begin(), rowInfos.end());
TrackId2Rows trackIdToRows;
// We expect almost all rows to be valid and that only a few tracks
// are contained multiple times in rowInfos (e.g. in history playlists)
trackIdToRows.reserve(rowInfos.size());
for (int i = 0; i < rowInfos.size(); ++i) {
const RowInfo& rowInfo = rowInfos[i];
if (rowInfo.order == -1) {
// We've reached the end of valid rows. Resize rowInfo to cut off
// this and all further elements.
rowInfos.resize(i);
break;
}
trackIdToRows[rowInfo.trackId].push_back(i);
}
// The number of unique tracks cannot be greater than the
// number of total rows returned by the query
DEBUG_ASSERT(trackIdToRows.size() <= rowInfos.size());
// We're done! Issue the update signals and replace the master maps.
replaceRows(
std::move(rowInfos),
std::move(trackIdToRows));
// Both rowInfo and trackIdToRows (might) have been moved and
// must not be used afterwards!
qDebug() << this << "select() took" << time.elapsed().debugMillisWithUnit()
<< m_rowInfo.size();
}
void BaseSqlTableModel::setTable(const QString& tableName,
const QString& idColumn,
const QStringList& tableColumns,
QSharedPointer<BaseTrackCache> trackSource) {
if (sDebug) {
qDebug() << this << "setTable" << tableName << tableColumns << idColumn;
}
m_tableName = tableName;
m_idColumn = idColumn;
m_tableColumns = tableColumns;
if (m_trackSource) {
disconnect(m_trackSource.data(), SIGNAL(tracksChanged(QSet<TrackId>)),
this, SLOT(tracksChanged(QSet<TrackId>)));
}
m_trackSource = trackSource;
if (m_trackSource) {
// It's important that this not be a direct connection, or else the UI
// might try to update while a cache operation is in progress, and that
// will hit the cache again and cause dangerous reentry cycles
// See https://bugs.launchpad.net/mixxx/+bug/1365708
// TODO: A better fix is to have cache and trackpointers defer saving
// and deleting, so those operations only take place at the top of
// the call stack.
connect(m_trackSource.data(), SIGNAL(tracksChanged(QSet<TrackId>)),
this, SLOT(tracksChanged(QSet<TrackId>)), Qt::QueuedConnection);
}
// Build a map from the column names to their indices, used by fieldIndex()
m_tableColumnCache.setColumns(m_tableColumns);
initHeaderData();
m_bInitialized = true;
}
const QString BaseSqlTableModel::currentSearch() const {
return m_currentSearch;
}
void BaseSqlTableModel::setSearch(const QString& searchText, const QString& extraFilter) {
if (sDebug) {
qDebug() << this << "setSearch" << searchText;
}
bool searchIsDifferent = m_currentSearch.isNull() || m_currentSearch != searchText;
bool filterDisabled = (m_currentSearchFilter.isNull() && extraFilter.isNull());
bool searchFilterIsDifferent = m_currentSearchFilter != extraFilter;
if (!searchIsDifferent && (filterDisabled || !searchFilterIsDifferent)) {
// Do nothing if the filters are no different.
return;
}
m_currentSearch = searchText;
m_currentSearchFilter = extraFilter;
}
void BaseSqlTableModel::search(const QString& searchText, const QString& extraFilter) {
if (sDebug) {
qDebug() << this << "search" << searchText;
}
setSearch(searchText, extraFilter);
select();
}
void BaseSqlTableModel::setSort(int column, Qt::SortOrder order) {
if (sDebug) {
qDebug() << this << "setSort()" << column << order << m_tableColumns;
}
int trackSourceColumnCount = m_trackSource ? m_trackSource->columnCount() : 0;
if (column < 0 ||
column >= trackSourceColumnCount + m_sortColumns.size() - 1) {
// -1 because id column is in both tables
qWarning() << "BaseSqlTableModel::setSort invalid column:" << column;
return;
}
// There's no item to sort already, load from Settings last sort
if (m_sortColumns.isEmpty()) {
QString val = getModelSetting(COLUMNS_SORTING);
QTextStream in(&val);
while (!in.atEnd()) {
int ordI = -1;
QString name;
in >> name >> ordI;
int col = fieldIndex(name);
if (col < 0) continue;
Qt::SortOrder ord;
ord = ordI > 0 ? Qt::AscendingOrder : Qt::DescendingOrder;
m_sortColumns << SortColumn(col, ord);
}
}
if (m_sortColumns.size() > 0 && m_sortColumns.at(0).m_column == column) {
// Only the order has changed
m_sortColumns.replace(0, SortColumn(column, order));
} else {
// Remove column if already in history
// As reverse loop to not skip an entry when removing the previous
for (int i = m_sortColumns.size() - 1; i >= 0; --i) {
if (m_sortColumns.at(i).m_column == column) {
m_sortColumns.removeAt(i);
break;
}
}
// set new sort as head and shift out old sort
m_sortColumns.prepend(SortColumn(column, order));
if (m_sortColumns.size() > kMaxSortColumns) {
m_sortColumns.removeLast();
}
}
// Write new sortColumns order to user settings
QString val;
QTextStream out(&val);
for (SortColumn& sc : m_sortColumns) {
QString name;
if (sc.m_column > 0 && sc.m_column < m_tableColumns.size()) {
name = m_tableColumns[sc.m_column];
} else {
// ccColumn between 1..x to skip the id column
int ccColumn = sc.m_column - m_tableColumns.size() + 1;
name = m_trackSource->columnNameForFieldIndex(ccColumn);
}
out << name << " ";
out << (sc.m_order == Qt::AscendingOrder ? 1 : -1) << " ";
}
out.flush();
setModelSetting(COLUMNS_SORTING, val);
if (sDebug) {
qDebug() << "setSort() sortColumns:" << val;
}
// we have two selects for sorting, since keeping the select history
// across the two selects is hard, we do this only for the trackSource
// this is OK, because the columns of the table are virtual in case of
// preview column or individual like playlist track number so that we
// do not need the history anyway.
// reset the old order by clauses
m_trackSourceOrderBy.clear();
m_tableOrderBy.clear();
if (column > 0 && column < m_tableColumns.size()) {
// Table sorting, no history
if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_PREVIEW)) {
// Random sort easter egg
m_tableOrderBy = "ORDER BY RANDOM()";
} else {
m_tableOrderBy = "ORDER BY ";
QString field = m_tableColumns[column];
QString sort_field = QString("%1.%2").arg(m_tableName, field);
m_tableOrderBy.append(mixxx::DbConnection::collateLexicographically(sort_field));
m_tableOrderBy.append((order == Qt::AscendingOrder) ? " ASC" : " DESC");
}
m_sortColumns.clear();
m_sortColumns.prepend(SortColumn(column, order));
} else if (m_trackSource) {
bool first = true;
for (const SortColumn &sc : m_sortColumns) {
QString sort_field;
if (sc.m_column < m_tableColumns.size()) {
if (sc.m_column == kIdColumn) {
sort_field = m_trackSource->columnSortForFieldIndex(kIdColumn);
} else if (sc.m_column ==
fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_PREVIEW)) {
sort_field = "RANDOM()";
} else {
// we can't sort by other table columns here since primary sort is a track
// column: skip
continue;
}
} else {
// + 1 to skip id column
int ccColumn = sc.m_column - m_tableColumns.size() + 1;
sort_field = m_trackSource->columnSortForFieldIndex(ccColumn);
}
VERIFY_OR_DEBUG_ASSERT(!sort_field.isEmpty()) {
continue;
}
m_trackSourceOrderBy.append(first ? "ORDER BY ": ", ");
m_trackSourceOrderBy.append(mixxx::DbConnection::collateLexicographically(sort_field));
m_trackSourceOrderBy.append((sc.m_order == Qt::AscendingOrder) ?
" ASC" : " DESC");
//qDebug() << m_trackSourceOrderBy;
first = false;
}
}
}
void BaseSqlTableModel::sort(int column, Qt::SortOrder order) {
if (sDebug) {
qDebug() << this << "sort()" << column << order;
}
setSort(column, order);
select();
}
int BaseSqlTableModel::rowCount(const QModelIndex& parent) const {
int count = parent.isValid() ? 0 : m_rowInfo.size();
//qDebug() << "rowCount()" << parent << count;
return count;
}
int BaseSqlTableModel::columnCount(const QModelIndex& parent) const {
if (parent.isValid()) {
return 0;
}
// Subtract one from trackSource::columnCount to ignore the id column
int count = m_tableColumns.size() +
(m_trackSource ? m_trackSource->columnCount() - 1: 0);
return count;
}
int BaseSqlTableModel::fieldIndex(ColumnCache::Column column) const {
int tableIndex = m_tableColumnCache.fieldIndex(column);
if (tableIndex > -1) {
return tableIndex;
}
if (m_trackSource) {
// We need to account for the case where the field name is not a table
// column or a source column.
int sourceTableIndex = m_trackSource->fieldIndex(column);
if (sourceTableIndex > -1) {
// Subtract one from the fieldIndex() result to account for the id column
return m_tableColumns.size() + sourceTableIndex - 1;
}
}
return -1;
}
int BaseSqlTableModel::fieldIndex(const QString& fieldName) const {
int tableIndex = m_tableColumnCache.fieldIndex(fieldName);
if (tableIndex > -1) {
return tableIndex;
}
if (m_trackSource) {
// We need to account for the case where the field name is not a table
// column or a source column.
int sourceTableIndex = m_trackSource->fieldIndex(fieldName);
if (sourceTableIndex > -1) {
// Subtract one from the fieldIndex() result to account for the id column
return m_tableColumns.size() + sourceTableIndex - 1;
}
}
return -1;
}
QVariant BaseSqlTableModel::data(const QModelIndex& index, int role) const {
//qDebug() << this << "data()";
if (!index.isValid() || (role != Qt::DisplayRole &&
role != Qt::EditRole &&
role != Qt::CheckStateRole &&
role != Qt::ToolTipRole)) {
return QVariant();
}
int row = index.row();
int column = index.column();
// This value is the value in its most raw form. It was looked up either
// from the SQL table or from the cached track layer.
QVariant value = getBaseValue(index, role);
// Format the value based on whether we are in a tooltip, display, or edit
// role
switch (role) {
case Qt::ToolTipRole:
case Qt::DisplayRole:
if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_DURATION)) {
int duration = value.toInt();
if (duration > 0) {
value = mixxx::Duration::formatTime(duration);
} else {
value = QString();
}
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_RATING)) {
if (value.canConvert(QMetaType::Int))
value = qVariantFromValue(StarRating(value.toInt()));
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TIMESPLAYED)) {
if (value.canConvert(QMetaType::Int))
value = QString("(%1)").arg(value.toInt());
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_PLAYED)) {
value = value.toBool();
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_DATETIMEADDED)) {
QDateTime gmtDate = value.toDateTime();
gmtDate.setTimeSpec(Qt::UTC);
value = gmtDate.toLocalTime();
} else if (column == fieldIndex(ColumnCache::COLUMN_PLAYLISTTRACKSTABLE_DATETIMEADDED)) {
QDateTime gmtDate = value.toDateTime();
gmtDate.setTimeSpec(Qt::UTC);
value = gmtDate.toLocalTime();
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM)) {
if (role == Qt::DisplayRole) {
value = value.toDouble() == 0.0
? "-" : QString("%1").arg(value.toDouble(), 0, 'f', 1);
}
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM_LOCK)) {
value = value.toBool();
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_YEAR)) {
value = mixxx::TrackMetadata::formatCalendarYear(value.toString());
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TRACKNUMBER)) {
int track_number = value.toInt();
if (track_number <= 0) {
// clear invalid values
value = QString();
}
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BITRATE)) {
int bitrate = value.toInt();
if (bitrate <= 0) {
// clear invalid values
value = QString();
}
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_KEY)) {
// If we know the semantic key via the LIBRARYTABLE_KEY_ID
// column (as opposed to the string representation of the key
// currently stored in the DB) then lookup the key and render it
// using the user's selected notation.
int keyIdColumn = fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_KEY_ID);
if (keyIdColumn != -1) {
mixxx::track::io::key::ChromaticKey key =
KeyUtils::keyFromNumericValue(
index.sibling(row, keyIdColumn).data().toInt());
if (key != mixxx::track::io::key::INVALID) {
// Render this key with the user-provided notation.
value = KeyUtils::keyToString(key);
}
}
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_REPLAYGAIN)) {
value = mixxx::ReplayGain::ratioToString(value.toDouble());
} // Otherwise, just use the column value.
break;
case Qt::EditRole:
if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM)) {
value = value.toDouble();
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TIMESPLAYED)) {
value = index.sibling(
row, fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_PLAYED)).data().toBool();
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_RATING)) {
if (value.canConvert(QMetaType::Int)) {
value = qVariantFromValue(StarRating(value.toInt()));
}
}
break;
case Qt::CheckStateRole:
if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TIMESPLAYED)) {
bool played = index.sibling(
row, fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_PLAYED)).data().toBool();
value = played ? Qt::Checked : Qt::Unchecked;
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM)) {
bool locked = index.sibling(
row, fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM_LOCK)).data().toBool();
value = locked ? Qt::Checked : Qt::Unchecked;
}
break;
default:
break;
}
return value;
}
bool BaseSqlTableModel::setData(
const QModelIndex& index, const QVariant& value, int role) {
if (!index.isValid())
return false;
int row = index.row();
int column = index.column();
if (sDebug) {
qDebug() << this << "setData() column:" << column << "value:" << value << "role:" << role;
}
// Over-ride sets to TIMESPLAYED and re-direct them to PLAYED
if (role == Qt::CheckStateRole) {
QString val = value.toInt() > 0 ? QString("true") : QString("false");
if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TIMESPLAYED)) {
QModelIndex playedIndex = index.sibling(index.row(), fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_PLAYED));
return setData(playedIndex, val, Qt::EditRole);
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM)) {
QModelIndex bpmLockindex = index.sibling(index.row(), fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM_LOCK));
return setData(bpmLockindex, val, Qt::EditRole);
}
return false;
}
if (row < 0 || row >= m_rowInfo.size()) {
return false;
}
const RowInfo& rowInfo = m_rowInfo[row];
TrackId trackId(rowInfo.trackId);
// You can't set something in the table columns because we have no way of
// persisting it.
if (column < m_tableColumns.size()) {
return false;
}
// TODO(rryan) ugly and only works because the mixxx library tables are the
// only ones that aren't read-only. This should be moved into BTC.
TrackPointer pTrack = m_pTrackCollection->getTrackDAO().getTrack(trackId);
if (!pTrack) {
return false;
}
setTrackValueForColumn(pTrack, column, value);
// Do not save the track here. Changing the track dirties it and the caching
// system will automatically save the track once it is unloaded from
// memory. rryan 10/2010
return true;
}
Qt::ItemFlags BaseSqlTableModel::flags(const QModelIndex &index) const {
return readWriteFlags(index);
}
Qt::ItemFlags BaseSqlTableModel::readWriteFlags(
const QModelIndex &index) const {
if (!index.isValid())
return Qt::ItemIsEnabled;
Qt::ItemFlags defaultFlags = QAbstractItemModel::flags(index);
// Enable dragging songs from this data model to elsewhere (like the
// waveform widget to load a track into a Player).
defaultFlags |= Qt::ItemIsDragEnabled;
int column = index.column();
if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_FILETYPE) ||
column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_NATIVELOCATION) ||
column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_DURATION) ||
column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BITRATE) ||
column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_DATETIMEADDED) ||
column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COVERART) ||
column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_REPLAYGAIN)) {
return defaultFlags;
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TIMESPLAYED)) {
return defaultFlags | Qt::ItemIsUserCheckable;
} else if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM_LOCK)) {
return defaultFlags | Qt::ItemIsUserCheckable;
} else if(column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM)) {
// Allow checking of the BPM-locked indicator.
defaultFlags |= Qt::ItemIsUserCheckable;
// Disable editing of BPM field when BPM is locked
bool locked = index.sibling(
index.row(), fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM_LOCK))
.data().toBool();
return locked ? defaultFlags : defaultFlags | Qt::ItemIsEditable;
} else {
return defaultFlags | Qt::ItemIsEditable;
}
}
Qt::ItemFlags BaseSqlTableModel::readOnlyFlags(const QModelIndex &index) const {
Qt::ItemFlags defaultFlags = QAbstractItemModel::flags(index);
if (!index.isValid())
return Qt::ItemIsEnabled;
// Enable dragging songs from this data model to elsewhere (like the
// waveform widget to load a track into a Player).
defaultFlags |= Qt::ItemIsDragEnabled;
return defaultFlags;
}
TrackId BaseSqlTableModel::getTrackId(const QModelIndex& index) const {
if (index.isValid()) {
return TrackId(index.sibling(index.row(), fieldIndex(m_idColumn)).data());
} else {
return TrackId();
}
}
TrackPointer BaseSqlTableModel::getTrack(const QModelIndex& index) const {
return m_pTrackCollection->getTrackDAO().getTrack(getTrackId(index));
}
QString BaseSqlTableModel::getTrackLocation(const QModelIndex& index) const {
if (!index.isValid()) {
return "";
}
QString nativeLocation =
index.sibling(index.row(),
fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_NATIVELOCATION))
.data().toString();
QString location = QDir::fromNativeSeparators(nativeLocation);
return location;
}
void BaseSqlTableModel::trackLoaded(QString group, TrackPointer pTrack) {
if (group == m_previewDeckGroup) {
// If there was a previously loaded track, refresh its rows so the
// preview state will update.
if (m_previewDeckTrackId.isValid()) {
const int numColumns = columnCount();
QLinkedList<int> rows = getTrackRows(m_previewDeckTrackId);
m_previewDeckTrackId = TrackId(); // invalidate
foreach (int row, rows) {
QModelIndex left = index(row, 0);
QModelIndex right = index(row, numColumns);
emit(dataChanged(left, right));
}
}
m_previewDeckTrackId = pTrack ? pTrack->getId() : TrackId();
}
}
void BaseSqlTableModel::tracksChanged(QSet<TrackId> trackIds) {
if (sDebug) {
qDebug() << this << "trackChanged" << trackIds.size();
}
const int numColumns = columnCount();
for (const auto& trackId : trackIds) {
QLinkedList<int> rows = getTrackRows(trackId);
foreach (int row, rows) {
//qDebug() << "Row in this result set was updated. Signalling update. track:" << trackId << "row:" << row;
QModelIndex left = index(row, 0);
QModelIndex right = index(row, numColumns);
emit(dataChanged(left, right));
}
}
}
void BaseSqlTableModel::setTrackValueForColumn(TrackPointer pTrack, int column,
QVariant value) {
// TODO(XXX) Qt properties could really help here.
if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_ARTIST) == column) {
pTrack->setArtist(value.toString());
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TITLE) == column) {
pTrack->setTitle(value.toString());
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_ALBUM) == column) {
pTrack->setAlbum(value.toString());
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_ALBUMARTIST) == column) {
pTrack->setAlbumArtist(value.toString());
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_YEAR) == column) {
pTrack->setYear(value.toString());
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_GENRE) == column) {
pTrack->setGenre(value.toString());
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COMPOSER) == column) {
pTrack->setComposer(value.toString());
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_GROUPING) == column) {
pTrack->setGrouping(value.toString());
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TRACKNUMBER) == column) {
pTrack->setTrackNumber(value.toString());
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_COMMENT) == column) {
pTrack->setComment(value.toString());
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM) == column) {
// QVariant::toFloat needs >= QT 4.6.x
pTrack->setBpm(static_cast<double>(value.toDouble()));
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_PLAYED) == column) {
// Update both the played flag and the number of times played
pTrack->updatePlayCounter(value.toBool());
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_TIMESPLAYED) == column) {
const int timesPlayed = value.toInt();
if (0 < timesPlayed) {
// Preserve the played flag and only set the number of times played
PlayCounter playCounter(pTrack->getPlayCounter());
playCounter.setTimesPlayed(timesPlayed);
pTrack->setPlayCounter(playCounter);
} else {
// Reset both the played flag and the number of times played
pTrack->resetPlayCounter();
}
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_RATING) == column) {
StarRating starRating = value.value<StarRating>();
pTrack->setRating(starRating.starCount());
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_KEY) == column) {
pTrack->setKeyText(value.toString(),
mixxx::track::io::key::USER);
} else if (fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM_LOCK) == column) {
pTrack->setBpmLocked(value.toBool());
} else {
// We never should get up to this point!
VERIFY_OR_DEBUG_ASSERT(false) {
qWarning() << "Column"
<< m_tableColumnCache.columnNameForFieldIndex(column)
<< "is not editable!";
}
}
}
QVariant BaseSqlTableModel::getBaseValue(
const QModelIndex& index, int role) const {
if (role != Qt::DisplayRole &&
role != Qt::ToolTipRole &&
role != Qt::EditRole) {
return QVariant();
}
int row = index.row();
int column = index.column();
if (row < 0 || row >= m_rowInfo.size()) {
return QVariant();
}
// TODO(rryan) check range on column
const RowInfo& rowInfo = m_rowInfo[row];
TrackId trackId(rowInfo.trackId);
// If the row info has the row-specific column, return that.
if (column < m_tableColumns.size()) {
// Special case for preview column. Return whether trackId is the
// current preview deck track.
if (column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_PREVIEW)) {
if (role == Qt::ToolTipRole) {
return "";