finddialog.cpp

/*
    SPDX-FileCopyrightText: 2001 Jason Harris <jharris@30doradus.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#include "finddialog.h"
 
#include "kstars.h"
#include "kstarsdata.h"
#include "ksnotification.h"
#include "Options.h"
#include "detaildialog.h"
#include "skymap.h"
#include "skyobjects/skyobject.h"
#include "skycomponents/starcomponent.h"
#include "skycomponents/skymapcomposite.h"
#include "tools/nameresolver.h"
#include "skyobjectlistmodel.h"
#include "catalogscomponent.h"
#include <KMessageBox>
 
#include <QSortFilterProxyModel>
#include <QStringListModel>
#include <QTimer>
#include <QComboBox>
#include <QLineEdit>
#include <QPointer>
 
FindDialog *FindDialog::m_Instance = nullptr;
 
FindDialogUI::FindDialogUI(QWidget *parent) : QFrame(parent)
{
    setupUi(this);
 
    FilterType->addItem(i18n("Any"));
    FilterType->addItem(i18n("Stars"));
    FilterType->addItem(i18n("Solar System"));
    FilterType->addItem(i18n("Open Clusters"));
    FilterType->addItem(i18n("Globular Clusters"));
    FilterType->addItem(i18n("Gaseous Nebulae"));
    FilterType->addItem(i18n("Planetary Nebulae"));
    FilterType->addItem(i18n("Galaxies"));
    FilterType->addItem(i18n("Comets"));
    FilterType->addItem(i18n("Asteroids"));
    FilterType->addItem(i18n("Constellations"));
    FilterType->addItem(i18n("Supernovae"));
    FilterType->addItem(i18n("Satellites"));
 
    SearchList->setMinimumWidth(256);
    SearchList->setMinimumHeight(320);
}
 
FindDialog *FindDialog::Instance()
{
    if (m_Instance == nullptr)
        m_Instance = new FindDialog(KStars::Instance());
 
    return m_Instance;
}
 
FindDialog::FindDialog(QWidget *parent)
    : QDialog(parent)
    , timer(nullptr)
    , m_targetObject(nullptr)
    , m_dbManager(CatalogsDB::dso_db_path())
{
#ifdef Q_OS_MACOS
    setWindowFlags(Qt::Tool | Qt::WindowStaysOnTopHint);
#endif
    ui = new FindDialogUI(this);
 
    setWindowTitle(i18nc("@title:window", "Find Object"));
 
    QVBoxLayout *mainLayout = new QVBoxLayout;
    mainLayout->addWidget(ui);
    setLayout(mainLayout);
 
    QDialogButtonBox *buttonBox = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel);
    mainLayout->addWidget(buttonBox);
    connect(buttonBox, SIGNAL(accepted()), this, SLOT(slotOk()));
    connect(buttonBox, SIGNAL(rejected()), this, SLOT(reject()));
 
    okB = buttonBox->button(QDialogButtonBox::Ok);
    okB->setEnabled(false);
 
    m_DetailsB = new QPushButton(i18n("Details..."));
    buttonBox->addButton(m_DetailsB, QDialogButtonBox::ActionRole);
    connect(m_DetailsB, SIGNAL(clicked()), this, SLOT(slotDetails()));
 
    ui->InternetSearchButton->setVisible(Options::resolveNamesOnline());
    ui->InternetSearchButton->setEnabled(false);
    connect(ui->InternetSearchButton, SIGNAL(clicked()), this, SLOT(slotResolve()));
 
    ui->FilterType->setCurrentIndex(0); // show all types of objects
 
    fModel = new SkyObjectListModel(this);
    connect(KStars::Instance()->map(), &SkyMap::removeSkyObject, fModel, &SkyObjectListModel::removeSkyObject);
    sortModel = new QSortFilterProxyModel(ui->SearchList);
    sortModel->setFilterCaseSensitivity(Qt::CaseInsensitive);
    sortModel->setSourceModel(fModel);
    sortModel->setSortRole(Qt::DisplayRole);
    sortModel->setFilterRole(Qt::DisplayRole);
    sortModel->setDynamicSortFilter(true);
    sortModel->sort(0);
 
    ui->SearchList->setModel(sortModel);
 
    // Connect signals to slots
    connect(ui->clearHistoryB, &QPushButton::clicked, [&]()
    {
        ui->clearHistoryB->setEnabled(false);
        m_HistoryCombo->clear();
        m_HistoryList.clear();
    });
 
    m_HistoryCombo = new QComboBox(ui->showHistoryB);
    m_HistoryCombo->move(0, ui->showHistoryB->height());
    connect(ui->showHistoryB, &QPushButton::clicked, [&]()
    {
        if (m_HistoryList.empty() == false)
        {
            m_HistoryCombo->showPopup();
        }
    });
 
    connect(m_HistoryCombo, static_cast<void(QComboBox::*)(int)>(&QComboBox::activated),
            [&](int index)
    {
        m_targetObject = m_HistoryList[index];
        m_targetObject->updateCoordsNow(KStarsData::Instance()->updateNum());
        m_HistoryCombo->setCurrentIndex(-1);
        m_HistoryCombo->hidePopup();
        accept();
    });
    connect(ui->SearchBox, &QLineEdit::textChanged, this, &FindDialog::enqueueSearch);
    connect(ui->SearchBox, &QLineEdit::returnPressed, this, &FindDialog::slotOk);
    connect(ui->FilterType, &QComboBox::currentTextChanged, this, &FindDialog::enqueueSearch);
    connect(ui->SearchList, SIGNAL(doubleClicked(QModelIndex)), SLOT(slotOk()));
    connect(ui->SearchList->selectionModel(), &QItemSelectionModel::selectionChanged, this, &FindDialog::slotUpdateButtons);
 
    // Set focus to object name edit
    ui->SearchBox->setFocus();
 
    // First create and paint dialog and then load list
    QTimer::singleShot(0, this, SLOT(init()));
 
    listFiltered = false;
}
 
void FindDialog::init()
{
    const auto &objs = m_dbManager.get_objects(Options::magLimitDrawDeepSky(), 100);
    for (const auto &obj : objs)
    {
        KStarsData::Instance()->skyComposite()->catalogsComponent()->insertStaticObject(
            obj);
    }
    ui->SearchBox->clear();
    filterByType();
    sortModel->sort(0);
    initSelection();
    m_targetObject = nullptr;
}
 
void FindDialog::showEvent(QShowEvent *e)
{
    ui->SearchBox->setFocus();
    e->accept();
}
 
void FindDialog::initSelection()
{
    if (sortModel->rowCount() <= 0)
    {
        okB->setEnabled(false);
        return;
    }
 
    //    ui->SearchBox->setModel(sortModel);
    //    ui->SearchBox->setModelColumn(0);
 
    if (ui->SearchBox->text().isEmpty())
    {
        //Pre-select the first item
        QModelIndex selectItem = sortModel->index(0, sortModel->filterKeyColumn(), QModelIndex());
        switch (ui->FilterType->currentIndex())
        {
            case 0: //All objects, choose Andromeda galaxy
            {
                QModelIndex qmi = fModel->index(fModel->indexOf(i18n("Andromeda Galaxy")));
                selectItem      = sortModel->mapFromSource(qmi);
                break;
            }
            case 1: //Stars, choose Aldebaran
            {
                QModelIndex qmi = fModel->index(fModel->indexOf(i18n("Aldebaran")));
                selectItem      = sortModel->mapFromSource(qmi);
                break;
            }
            case 2: //Solar system or Asteroids, choose Aaltje
            case 9:
            {
                QModelIndex qmi = fModel->index(fModel->indexOf(i18n("Aaltje")));
                selectItem      = sortModel->mapFromSource(qmi);
                break;
            }
            case 8: //Comets, choose 'Aarseth-Brewington (1989 W1)'
            {
                QModelIndex qmi = fModel->index(fModel->indexOf(i18n("Aarseth-Brewington (1989 W1)")));
                selectItem      = sortModel->mapFromSource(qmi);
                break;
            }
        }
 
        if (selectItem.isValid())
        {
            ui->SearchList->selectionModel()->select(selectItem, QItemSelectionModel::ClearAndSelect);
            ui->SearchList->scrollTo(selectItem);
            ui->SearchList->setCurrentIndex(selectItem);
        }
    }
 
    listFiltered = true;
}
 
void FindDialog::filterByType()
{
    KStarsData *data = KStarsData::Instance();
 
    switch (ui->FilterType->currentIndex())
    {
        case 0: // All object types
        {
            QVector<QPair<QString, const SkyObject *>> allObjects;
            foreach (int type, data->skyComposite()->objectLists().keys())
            {
                allObjects.append(data->skyComposite()->objectLists(SkyObject::TYPE(type)));
            }
            fModel->setSkyObjectsList(allObjects);
            break;
        }
        case 1: //Stars
        {
            QVector<QPair<QString, const SkyObject *>> starObjects;
            starObjects.append(data->skyComposite()->objectLists(SkyObject::STAR));
            starObjects.append(data->skyComposite()->objectLists(SkyObject::CATALOG_STAR));
            fModel->setSkyObjectsList(starObjects);
            break;
        }
        case 2: //Solar system
        {
            QVector<QPair<QString, const SkyObject *>> ssObjects;
            ssObjects.append(data->skyComposite()->objectLists(SkyObject::PLANET));
            ssObjects.append(data->skyComposite()->objectLists(SkyObject::COMET));
            ssObjects.append(data->skyComposite()->objectLists(SkyObject::ASTEROID));
            ssObjects.append(data->skyComposite()->objectLists(SkyObject::MOON));
 
            fModel->setSkyObjectsList(ssObjects);
            break;
        }
        case 3: //Open Clusters
            fModel->setSkyObjectsList(data->skyComposite()->objectLists(SkyObject::OPEN_CLUSTER));
            break;
        case 4: //Globular Clusters
            fModel->setSkyObjectsList(data->skyComposite()->objectLists(SkyObject::GLOBULAR_CLUSTER));
            break;
        case 5: //Gaseous nebulae
            fModel->setSkyObjectsList(data->skyComposite()->objectLists(SkyObject::GASEOUS_NEBULA));
            break;
        case 6: //Planetary nebula
            fModel->setSkyObjectsList(data->skyComposite()->objectLists(SkyObject::PLANETARY_NEBULA));
            break;
        case 7: //Galaxies
            fModel->setSkyObjectsList(data->skyComposite()->objectLists(SkyObject::GALAXY));
            break;
        case 8: //Comets
            fModel->setSkyObjectsList(data->skyComposite()->objectLists(SkyObject::COMET));
            break;
        case 9: //Asteroids
            fModel->setSkyObjectsList(data->skyComposite()->objectLists(SkyObject::ASTEROID));
            break;
        case 10: //Constellations
            fModel->setSkyObjectsList(data->skyComposite()->objectLists(SkyObject::CONSTELLATION));
            break;
        case 11: //Supernovae
            fModel->setSkyObjectsList(data->skyComposite()->objectLists(SkyObject::SUPERNOVA));
            break;
        case 12: //Satellites
            fModel->setSkyObjectsList(data->skyComposite()->objectLists(SkyObject::SATELLITE));
            break;
    }
}
 
void FindDialog::filterList()
{
    QString SearchText = processSearchText();
    //const std::size_t searchId = m_currentSearchSequence;
 
    // JM 2022.08.28: Disabling use of async DB manager until further notice since it appears to cause a crash
    // on MacOS and some embedded systems.
    //    QEventLoop loop;
    //    QMutexLocker {&dbCallMutex}; // To prevent re-entrant calls into this
    //    connect(m_asyncDBManager.get(), &CatalogsDB::AsyncDBManager::resultReady, &loop, &QEventLoop::quit);
    //    QMetaObject::invokeMethod(m_asyncDBManager.get(), [&](){
    //        m_asyncDBManager->find_objects_by_name(SearchText, 10); });
    //    loop.exec();
    //    std::unique_ptr<CatalogsDB::CatalogObjectList> objs = m_asyncDBManager->result();
    //    if (m_currentSearchSequence != searchId) {
    //        return; // Ignore this search since the search text has changed
    //    }
 
    auto objs = m_dbManager.find_objects_by_name(SearchText, 10);
 
    bool exactMatchExists = objs.size() > 0 ? (QString::compare(objs.front().name(), SearchText,
                            Qt::CaseInsensitive) == 0) : false;
 
    for (const auto &obj : objs)
    {
        KStarsData::Instance()->skyComposite()->catalogsComponent()->insertStaticObject(
            obj);
    }
 
    sortModel->setFilterFixedString(SearchText);
    ui->InternetSearchButton->setText(i18n("Search the Internet for %1", SearchText.isEmpty() ? i18nc("no text to search for",
                                           "(nothing)") : SearchText));
    filterByType();
    initSelection();
 
    bool enableInternetSearch = (!exactMatchExists) && (ui->FilterType->currentIndex() == 0);
    //Select the first item in the list that begins with the filter string
    if (!SearchText.isEmpty())
    {
        QStringList mItems =
            fModel->filter(QRegularExpression('^' + SearchText, QRegularExpression::CaseInsensitiveOption));
        mItems.sort();
 
        if (mItems.size())
        {
            QModelIndex qmi        = fModel->index(fModel->indexOf(mItems[0]));
            QModelIndex selectItem = sortModel->mapFromSource(qmi);
 
            if (selectItem.isValid())
            {
                ui->SearchList->selectionModel()->select(
                    selectItem, QItemSelectionModel::ClearAndSelect);
                ui->SearchList->scrollTo(selectItem);
                ui->SearchList->setCurrentIndex(selectItem);
            }
        }
        ui->InternetSearchButton->setEnabled(enableInternetSearch && !mItems.contains(
                SearchText, Qt::CaseInsensitive)); // Disable searching the internet when an exact match for SearchText exists in KStars
    }
    else
        ui->InternetSearchButton->setEnabled(false);
 
    listFiltered = true;
    slotUpdateButtons();
}
 
void FindDialog::slotUpdateButtons()
{
    okB->setEnabled(ui->SearchList->selectionModel()->hasSelection());
 
    if (okB->isEnabled())
    {
        okB->setDefault(true);
    }
    else if (ui->InternetSearchButton->isEnabled())
    {
        ui->InternetSearchButton->setDefault(true);
    }
}
 
SkyObject *FindDialog::selectedObject() const
{
    QModelIndex i = ui->SearchList->currentIndex();
    QVariant sObj = sortModel->data(sortModel->index(i.row(), 0), SkyObjectListModel::SkyObjectRole);
 
    return reinterpret_cast<SkyObject*>(sObj.value<void *>());
}
 
void FindDialog::enqueueSearch()
{
    listFiltered = false;
    if (timer)
    {
        timer->stop();
    }
    else
    {
        timer = new QTimer(this);
        timer->setSingleShot(true);
        connect(timer, &QTimer::timeout, [&]()
        {
            this->m_currentSearchSequence++;
            this->filterList();
        });
    }
    timer->start(500);
}
 
// Process the search box text to replace equivalent names like "m93" with "m 93"
QString FindDialog::processSearchText(QString searchText)
{
    QRegularExpression re;
    re.setPatternOptions(QRegularExpression::CaseInsensitiveOption);
 
 
    // Remove multiple spaces and replace them by a single space
    re.setPattern("  +");
    searchText.replace(re, " ");
 
    // If it is an NGC/IC/M catalog number, as in "M 76" or "NGC 5139", check for absence of the space
    re.setPattern("^(m|ngc|ic)\\s*\\d*$");
    if (searchText.contains(re))
    {
        re.setPattern("\\s*(\\d+)");
        searchText.replace(re, " \\1");
        re.setPattern("\\s*$");
        searchText.remove(re);
        re.setPattern("^\\s*");
        searchText.remove(re);
    }
 
    // If it is a comet, and starts with c20## or c 20## make it c/20## (or similar with p).
    re.setPattern("^(c|p)\\s*((19|20).*)");
    if (searchText.contains(re))
    {
        if (searchText.at(0) == 'c' || searchText.at(0) == 'C')
            searchText.replace(re, "c/\\2");
        else searchText.replace(re, "p/\\2");
    }
 
    // TODO after KDE 4.1 release:
    // If it is a IAU standard three letter abbreviation for a constellation, then go to that constellation
    // Check for genetive names of stars. Example: alp CMa must go to alpha Canis Majoris
 
    return searchText;
}
 
void FindDialog::slotOk()
{
    // JM 2022.04.20 Below does not work when a user is simply browsing
    // and selecting an item without entering any text in the search box.
    //If no valid object selected, show a sorry-box.  Otherwise, emit accept()
    //    if (ui->SearchBox->text().isEmpty())
    //    {
    //        return;
    //    }
    SkyObject *selObj;
    if (!listFiltered)
    {
        filterList();
    }
    selObj = selectedObject();
    finishProcessing(selObj, Options::resolveNamesOnline() && ui->InternetSearchButton->isEnabled());
}
 
void FindDialog::slotResolve()
{
    finishProcessing(nullptr, true);
}
 
CatalogObject *FindDialog::resolveAndAdd(CatalogsDB::DBManager &db_manager, const QString &query)
{
    CatalogObject *dso = nullptr;
    const auto &cedata = NameResolver::resolveName(query);
 
    if (cedata.first)
    {
        db_manager.add_object(CatalogsDB::user_catalog_id, cedata.second);
        const auto &added_object =
            db_manager.get_object(cedata.second.getId(), CatalogsDB::user_catalog_id);
 
        if (added_object.first)
        {
            dso = &KStarsData::Instance()
                  ->skyComposite()
                  ->catalogsComponent()
                  ->insertStaticObject(added_object.second);
        }
    }
    return dso;
}
 
void FindDialog::finishProcessing(SkyObject *selObj, bool resolve)
{
    if (!selObj && resolve)
    {
        QString message = i18n("Searching the internet for \"%1\"", ui->SearchBox->text());
        QSharedPointer<QMessageBox> popup = KSNotification::closeableMessage(message, "");
        selObj = resolveAndAdd(m_dbManager, processSearchText());
        if (popup) popup->close();
    }
    m_targetObject = selObj;
    if (selObj == nullptr)
    {
        QString message = i18n("No object named %1 found.", ui->SearchBox->text());
        KSNotification::sorry(message, i18n("Bad object name"));
    }
    else
    {
        selObj->updateCoordsNow(KStarsData::Instance()->updateNum());
        if (m_HistoryList.contains(selObj) == false)
        {
            switch (selObj->type())
            {
                case SkyObject::OPEN_CLUSTER:
                case SkyObject::GLOBULAR_CLUSTER:
                case SkyObject::GASEOUS_NEBULA:
                case SkyObject::PLANETARY_NEBULA:
                case SkyObject::SUPERNOVA_REMNANT:
                case SkyObject::GALAXY:
                    if (selObj->name() != selObj->longname())
                        m_HistoryCombo->addItem(QString("%1 (%2)")
                                                .arg(selObj->name())
                                                .arg(selObj->longname()));
                    else
                        m_HistoryCombo->addItem(QString("%1").arg(selObj->longname()));
                    break;
 
                case SkyObject::STAR:
                case SkyObject::CATALOG_STAR:
                case SkyObject::PLANET:
                case SkyObject::COMET:
                case SkyObject::ASTEROID:
                case SkyObject::CONSTELLATION:
                case SkyObject::MOON:
                case SkyObject::ASTERISM:
                case SkyObject::GALAXY_CLUSTER:
                case SkyObject::DARK_NEBULA:
                case SkyObject::QUASAR:
                case SkyObject::MULT_STAR:
                case SkyObject::RADIO_SOURCE:
                case SkyObject::SATELLITE:
                case SkyObject::SUPERNOVA:
                default:
                    m_HistoryCombo->addItem(QString("%1").arg(selObj->longname()));
                    break;
            }
 
            m_HistoryList.append(selObj);
        }
        ui->clearHistoryB->setEnabled(true);
        accept();
    }
}
void FindDialog::keyPressEvent(QKeyEvent *e)
{
    switch (e->key())
    {
        case Qt::Key_Escape:
            reject();
            break;
        case Qt::Key_Up:
        {
            int currentRow = ui->SearchList->currentIndex().row();
            if (currentRow > 0)
            {
                QModelIndex selectItem = sortModel->index(currentRow - 1, sortModel->filterKeyColumn(), QModelIndex());
                ui->SearchList->selectionModel()->setCurrentIndex(selectItem, QItemSelectionModel::SelectCurrent);
            }
            break;
        }
        case Qt::Key_Down:
        {
            int currentRow = ui->SearchList->currentIndex().row();
            if (currentRow < sortModel->rowCount() - 1)
            {
                QModelIndex selectItem = sortModel->index(currentRow + 1, sortModel->filterKeyColumn(), QModelIndex());
                ui->SearchList->selectionModel()->setCurrentIndex(selectItem, QItemSelectionModel::SelectCurrent);
            }
            break;
        }
    }
}
 
void FindDialog::slotDetails()
{
    if (selectedObject())
    {
        QPointer<DetailDialog> dd = new DetailDialog(selectedObject(), KStarsData::Instance()->ut(),
                KStarsData::Instance()->geo(), KStars::Instance());
        dd->exec();
        delete dd;
    }
}
 
int FindDialog::execWithParent(QWidget* parent)
{
    QWidget * const oldParent = parentWidget();
 
    if (nullptr != parent)
    {
        setParent(parent);
        setWindowFlag(Qt::Dialog, true);
    }
 
    int const result = QDialog::exec();
 
    if (nullptr != parent)
    {
        setParent(oldParent);
        setWindowFlag(Qt::Dialog, true);
    }
 
    return result;
}
 
int FindDialog::execWithoutDetails()
{
    m_DetailsB->setEnabled(false);
    m_DetailsB->setVisible(false);
    int const result = QDialog::exec();
    m_DetailsB->setVisible(true);
    m_DetailsB->setEnabled(true);
    return result;
}