subsurface/qt-models/divelocationmodel.cpp
Berthold Stoeger f18ea2e3b6 Location model: treat invalid indexes gracefully
There have been crash reports in DiveSiteSortedModel::allSiteNames().
The only conceivable reason that this crashes is that the core knows
about more sites than the model and therefore on mapToSource() we
get an invalid index, which is translated to -1. Accessing the name
of that dive site will crash.

Handle such invalid indexes gracefully.

Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
2019-08-10 09:55:11 -07:00

344 lines
10 KiB
C++

// SPDX-License-Identifier: GPL-2.0
#include "core/units.h"
#include "qt-models/divelocationmodel.h"
#include "core/subsurface-qt/DiveListNotifier.h"
#include "core/qthelper.h"
#include "core/divesite.h"
#include "core/metrics.h"
#ifndef SUBSURFACE_MOBILE
#include "cleanertablemodel.h" // for trashIcon() and editIcon()
#include "desktop-widgets/mainwindow.h" // to place message box
#include "desktop-widgets/command.h"
#include <QMessageBox>
#endif
#include <QLineEdit>
#include <QIcon>
#include <core/gettextfromc.h>
LocationInformationModel *LocationInformationModel::instance()
{
static LocationInformationModel *self = new LocationInformationModel();
return self;
}
LocationInformationModel::LocationInformationModel(QObject *obj) : QAbstractTableModel(obj)
{
connect(&diveListNotifier, &DiveListNotifier::diveSiteDiveCountChanged, this, &LocationInformationModel::diveSiteDiveCountChanged);
connect(&diveListNotifier, &DiveListNotifier::diveSiteAdded, this, &LocationInformationModel::diveSiteAdded);
connect(&diveListNotifier, &DiveListNotifier::diveSiteDeleted, this, &LocationInformationModel::diveSiteDeleted);
connect(&diveListNotifier, &DiveListNotifier::diveSiteChanged, this, &LocationInformationModel::diveSiteChanged);
connect(&diveListNotifier, &DiveListNotifier::diveSiteDivesChanged, this, &LocationInformationModel::diveSiteDivesChanged);
}
int LocationInformationModel::columnCount(const QModelIndex &) const
{
return COLUMNS;
}
int LocationInformationModel::rowCount(const QModelIndex &) const
{
return dive_site_table.nr;
}
QVariant LocationInformationModel::headerData(int section, Qt::Orientation orientation, int role) const
{
if (orientation == Qt::Vertical)
return QVariant();
switch (role) {
case Qt::TextAlignmentRole:
return int(Qt::AlignLeft | Qt::AlignVCenter);
case Qt::FontRole:
return defaultModelFont();
case Qt::InitialSortOrderRole:
// By default, sort number of dives descending, everything else ascending.
return section == NUM_DIVES ? Qt::DescendingOrder : Qt::AscendingOrder;
case Qt::DisplayRole:
case Qt::ToolTipRole:
switch (section) {
case NAME:
return tr("Name");
case DESCRIPTION:
return tr("Description");
case NUM_DIVES:
return tr("# of dives");
}
break;
}
return QVariant();
}
Qt::ItemFlags LocationInformationModel::flags(const QModelIndex &index) const
{
switch (index.column()) {
case REMOVE:
return Qt::ItemIsEnabled;
case NAME:
case DESCRIPTION:
return QAbstractItemModel::flags(index) | Qt::ItemIsEditable;
}
return QAbstractItemModel::flags(index);
}
QVariant LocationInformationModel::getDiveSiteData(const struct dive_site *ds, int column, int role)
{
if (!ds)
return QVariant();
switch(role) {
case Qt::EditRole:
case Qt::DisplayRole:
switch(column) {
case DIVESITE: return QVariant::fromValue<dive_site *>((dive_site *)ds); // Not nice: casting away const
case NAME: return ds->name;
case NUM_DIVES: return ds->dives.nr;
case LOCATION: return "TODO";
case DESCRIPTION: return ds->description;
case NOTES: return ds->name;
case TAXONOMY: return "TODO";
}
break;
case Qt::ToolTipRole:
switch(column) {
case EDIT: return tr("Click here to edit the divesite.");
case REMOVE: return tr("Clicking here will remove this divesite.");
}
break;
case Qt::DecorationRole:
switch(column) {
#ifndef SUBSURFACE_MOBILE
case EDIT: return editIcon();
case REMOVE: return trashIcon();
#endif
case NAME: return dive_site_has_gps_location(ds) ? QIcon(":geotag-icon") : QVariant();
}
break;
case DIVESITE_ROLE:
return QVariant::fromValue<dive_site *>((dive_site *)ds); // Not nice: casting away const
}
return QVariant();
}
QVariant LocationInformationModel::data(const QModelIndex &index, int role) const
{
if (!index.isValid())
return QVariant();
struct dive_site *ds = get_dive_site(index.row(), &dive_site_table);
return getDiveSiteData(ds, index.column(), role);
}
void LocationInformationModel::update()
{
beginResetModel();
endResetModel();
}
void LocationInformationModel::diveSiteDiveCountChanged(dive_site *ds)
{
int idx = get_divesite_idx(ds, &dive_site_table);
if (idx >= 0)
dataChanged(createIndex(idx, NUM_DIVES), createIndex(idx, NUM_DIVES));
}
void LocationInformationModel::diveSiteAdded(struct dive_site *, int idx)
{
if (idx < 0)
return;
beginInsertRows(QModelIndex(), idx, idx);
// Row has already been added by Undo-Command.
endInsertRows();
}
void LocationInformationModel::diveSiteDeleted(struct dive_site *, int idx)
{
if (idx < 0)
return;
beginRemoveRows(QModelIndex(), idx, idx);
// Row has already been added by Undo-Command.
endRemoveRows();
}
void LocationInformationModel::diveSiteChanged(struct dive_site *ds, int field)
{
int idx = get_divesite_idx(ds, &dive_site_table);
if (idx < 0)
return;
dataChanged(createIndex(idx, field), createIndex(idx, field));
}
void LocationInformationModel::diveSiteDivesChanged(struct dive_site *ds)
{
int idx = get_divesite_idx(ds, &dive_site_table);
if (idx < 0)
return;
dataChanged(createIndex(idx, NUM_DIVES), createIndex(idx, NUM_DIVES));
}
bool DiveSiteSortedModel::filterAcceptsRow(int sourceRow, const QModelIndex &source_parent) const
{
if (fullText.isEmpty())
return true;
if (sourceRow < 0 || sourceRow > dive_site_table.nr)
return false;
struct dive_site *ds = dive_site_table.dive_sites[sourceRow];
QString text = QString(ds->name) + QString(ds->description) + QString(ds->notes);
return text.contains(fullText, Qt::CaseInsensitive);
}
bool DiveSiteSortedModel::lessThan(const QModelIndex &i1, const QModelIndex &i2) const
{
// The source indices correspond to indices in the global dive site table.
// Let's access them directly without going via the source model.
// Kind of dirty, but less effort.
struct dive_site *ds1 = get_dive_site(i1.row(), &dive_site_table);
struct dive_site *ds2 = get_dive_site(i2.row(), &dive_site_table);
if (!ds1 || !ds2) // Invalid dive sites compare as different
return false;
switch (i1.column()) {
case LocationInformationModel::NAME:
default:
return QString::localeAwareCompare(QString(ds1->name), QString(ds2->name)) < 0; // TODO: avoid copy
case LocationInformationModel::DESCRIPTION: {
int cmp = QString::localeAwareCompare(QString(ds1->description), QString(ds2->description)); // TODO: avoid copy
return cmp != 0 ? cmp < 0 :
QString::localeAwareCompare(QString(ds1->name), QString(ds2->name)) < 0; // TODO: avoid copy
}
case LocationInformationModel::NUM_DIVES: {
int cmp = ds1->dives.nr - ds2->dives.nr;
// Since by default nr dives is descending, invert sort direction of names, such that
// the names are listed as ascending.
return cmp != 0 ? cmp < 0 :
QString::localeAwareCompare(QString(ds1->name), QString(ds2->name)) < 0; // TODO: avoid copy
}
}
}
DiveSiteSortedModel::DiveSiteSortedModel()
{
setSourceModel(LocationInformationModel::instance());
}
QStringList DiveSiteSortedModel::allSiteNames() const
{
QStringList locationNames;
int num = rowCount();
for (int i = 0; i < num; i++) {
int idx = mapToSource(index(i, 0)).row();
// This shouldn't happen, but if model and core get out of sync,
// (more precisely: the core has more sites than the model is aware of),
// we might get an invalid index.
if (idx < 0 || idx > dive_site_table.nr) {
fprintf(stderr, "DiveSiteSortedModel::allSiteNames(): invalid index");
continue;
}
locationNames << QString(dive_site_table.dive_sites[idx]->name);
}
return locationNames;
}
struct dive_site *DiveSiteSortedModel::getDiveSite(const QModelIndex &idx)
{
return get_dive_site(mapToSource(idx).row(), &dive_site_table);
}
#ifndef SUBSURFACE_MOBILE
bool DiveSiteSortedModel::setData(const QModelIndex &index, const QVariant &value, int role)
{
struct dive_site *ds = getDiveSite(index);
if (!ds || value.isNull())
return false;
switch (index.column()) {
case LocationInformationModel::NAME:
Command::editDiveSiteName(ds, value.toString());
return true;
case LocationInformationModel::DESCRIPTION:
Command::editDiveSiteDescription(ds, value.toString());
return true;
default:
return false;
}
}
// TODO: Remove or edit. It doesn't make sense to call the model here, which calls the undo command,
// which in turn calls the model.
void DiveSiteSortedModel::remove(const QModelIndex &index)
{
struct dive_site *ds = getDiveSite(index);
if (!ds)
return;
switch (index.column()) {
case LocationInformationModel::EDIT:
MainWindow::instance()->editDiveSite(ds);
break;
case LocationInformationModel::REMOVE:
if (ds->dives.nr > 0 &&
QMessageBox::warning(MainWindow::instance(), tr("Delete dive site?"),
tr("This dive site has %n dive(s). Do you really want to delete it?\n", "", ds->dives.nr),
QMessageBox::Yes|QMessageBox::No) == QMessageBox::No)
return;
Command::deleteDiveSites(QVector<dive_site *>{ds});
break;
}
}
#endif // SUBSURFACE_MOBILE
void DiveSiteSortedModel::setFilter(const QString &text)
{
fullText = text.trimmed();
invalidateFilter();
}
GeoReferencingOptionsModel *GeoReferencingOptionsModel::instance()
{
static GeoReferencingOptionsModel *self = new GeoReferencingOptionsModel();
return self;
}
GeoReferencingOptionsModel::GeoReferencingOptionsModel(QObject *parent) : QStringListModel(parent)
{
QStringList list;
int i;
for (i = 0; i < TC_NR_CATEGORIES; i++)
list << gettextFromC::tr(taxonomy_category_names[i]);
setStringList(list);
}
bool GPSLocationInformationModel::filterAcceptsRow(int sourceRow, const QModelIndex &parent) const
{
struct dive_site *ds = sourceModel()->index(sourceRow, LocationInformationModel::DIVESITE, parent).data().value<dive_site *>();
if (!ds || ds == ignoreDs || ds == RECENTLY_ADDED_DIVESITE)
return false;
return distance <= 0 ? same_location(&ds->location, &location)
: (int64_t)get_distance(&ds->location, &location) * 1000 <= distance; // We need 64 bit to represent distances in mm
}
GPSLocationInformationModel::GPSLocationInformationModel(QObject *parent) : QSortFilterProxyModel(parent),
ignoreDs(nullptr),
location({{0},{0}}),
distance(0)
{
setSourceModel(LocationInformationModel::instance());
}
void GPSLocationInformationModel::set(const struct dive_site *ignoreDsIn, const location_t &locationIn)
{
ignoreDs = ignoreDsIn;
location = locationIn;
invalidate();
}
void GPSLocationInformationModel::setCoordinates(const location_t &locationIn)
{
location = locationIn;
invalidate();
}
void GPSLocationInformationModel::setDistance(int64_t dist)
{
distance = dist;
invalidate();
}