qgsqueryresultwidget.h

Go to the documentation of this file.

/***************************************************************************
  qgsqueryresultwidget.h - QgsQueryResultWidget
 
 ---------------------
 begin                : 14.1.2021
 copyright            : (C) 2021 by elpaso
 email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSQUERYRESULTWIDGET_H
#define QGSQUERYRESULTWIDGET_H
 
#include "ui_qgsqueryresultpanelwidgetbase.h"
#include "ui_qgsqueryresultwidgetbase.h"
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsabstractdatabaseproviderconnection.h"
#include "qgsfeedback.h"
#include "qgsqueryresultmodel.h"
#include "qgssettingstree.h"
 
#include <QDialog>
#include <QMainWindow>
#include <QString>
#include <QStyledItemDelegate>
#include <QThread>
#include <QWidget>
#include <QtConcurrent>
 
using namespace Qt::StringLiterals;
 
class QgsCodeEditorWidget;
class QgsCodeEditorSQL;
class QgsQueryResultPanelWidget;
class QgsDatabaseQueryHistoryWidget;

 
#ifndef SIP_RUN

class GUI_EXPORT QgsQueryResultItemDelegate : public QStyledItemDelegate
{
    Q_OBJECT
 
    // QStyledItemDelegate interface
  public:
    explicit QgsQueryResultItemDelegate( QObject *parent = nullptr );
 
    QString displayText( const QVariant &value, const QLocale &locale ) const override;
};

class GUI_EXPORT QgsConnectionsApiFetcher : public QObject
{
    Q_OBJECT
 
  public:
    QgsConnectionsApiFetcher( const QString &uri, const QString &providerKey )
      : mUri( uri )
      , mProviderKey( providerKey )
    {}

    void fetchTokens();

    void stopFetching();
 
  signals:

    void tokensReady( const QStringList &newTokens );

    void fetchingFinished();
 
  private:
    QString mUri;
    QString mProviderKey;
    QAtomicInt mStopFetching = 0;
    std::unique_ptr<QgsFeedback> mFeedback;
};
 
#endif


class GUI_EXPORT QgsQueryResultWidget : public QWidget, private Ui::QgsQueryResultWidgetBase
{
    Q_OBJECT
 
  public:
#ifndef SIP_RUN
    static inline QgsSettingsTreeNode *sTreeSqlQueries = QgsSettingsTree::sTreeGui->createChildNode( u"sql-queries"_s );
    static const QgsSettingsEntryString *settingLastSourceFolder;
#endif

    enum class QueryWidgetMode : int SIP_ENUM_BASETYPE( IntFlag )
    {
      SqlQueryMode = 1 << 0,         
      QueryLayerUpdateMode = 1 << 1, 
    };
    Q_ENUM( QueryWidgetMode )
 
    
    QgsQueryResultWidget( QWidget *parent = nullptr, QgsAbstractDatabaseProviderConnection *connection SIP_TRANSFER = nullptr );
 
    ~QgsQueryResultWidget() override;

    void setSqlVectorLayerOptions( const QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions &options );

    void setWidgetMode( QueryWidgetMode widgetMode );

    void setConnection( QgsAbstractDatabaseProviderConnection *connection SIP_TRANSFER );

    void setQuery( const QString &sql );
 
    SIP_SKIP bool promptUnsavedChanges();
 
  public slots:

    void notify( const QString &title, const QString &text, Qgis::MessageLevel level = Qgis::MessageLevel::Info );

    void executeQuery();

    void showError( const QString &title, const QString &message, bool isSqlError = false );

    Q_DECL_DEPRECATED void tokensReady( const QStringList &tokens ) SIP_DEPRECATED;

    void copyResults();

    void copyResults( int fromRow, int toRow, int fromColumn, int toColumn );
 
  signals:

    void createSqlVectorLayer( const QString &providerKey, const QString &connectionUri, const QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions &options );

    void firstResultBatchFetched();
 
    SIP_SKIP void requestDialogTitleUpdate( const QString &filename );
 
  private slots:

    void updateButtons();
 
    void openQuery();
    void saveQuery( bool saveAs );
    void setHasChanged( bool hasChanged );
    void populatePresetQueryMenu();
    void showHistoryPanel( bool show );
 
  private:
    QgsQueryResultPanelWidget *mQueryWidget = nullptr;
    QPointer< QgsDatabaseQueryHistoryWidget > mHistoryWidget;
 
    QMenu *mPresetQueryMenu = nullptr;
 
    bool mHasChangedFileContents = false;
 
    void updateDialogTitle();
    void storeCurrentQuery( Qgis::QueryStorageBackend backend );
 
    friend class TestQgsQueryResultWidget;
};
 
#ifndef SIP_RUN

class GUI_EXPORT QgsQueryResultPanelWidget : public QgsPanelWidget, private Ui::QgsQueryResultPanelWidgetBase
{
    Q_OBJECT
 
  public:
    QgsQueryResultPanelWidget( QWidget *parent = nullptr, QgsAbstractDatabaseProviderConnection *connection SIP_TRANSFER = nullptr );
 
    ~QgsQueryResultPanelWidget() override;

    QgsCodeEditorSQL *sqlEditor();

    QgsCodeEditorWidget *codeEditorWidget();

    void setSqlVectorLayerOptions( const QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions &options );

    void setWidgetMode( QgsQueryResultWidget::QueryWidgetMode widgetMode );

    void setConnection( QgsAbstractDatabaseProviderConnection *connection SIP_TRANSFER );

    void setQuery( const QString &sql );
 
  public slots:

    void notify( const QString &title, const QString &text, Qgis::MessageLevel level = Qgis::MessageLevel::Info );

    void executeQuery();

    void showError( const QString &title, const QString &message, bool isSqlError = false );

    void tokensReady( const QStringList &tokens );

    void copyResults();

    void copyResults( int fromRow, int toRow, int fromColumn, int toColumn );
 
  signals:

    void createSqlVectorLayer( const QString &providerKey, const QString &connectionUri, const QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions &options );

    void firstResultBatchFetched();
 
  private slots:

    void updateButtons();
 
    void showCellContextMenu( QPoint point );
    void copySelection();
 
  private:
    QgsCodeEditorWidget *mCodeEditorWidget = nullptr;
    QgsCodeEditorSQL *mSqlEditor = nullptr;
 
    std::unique_ptr<QgsAbstractDatabaseProviderConnection> mConnection;
    std::unique_ptr<QgsQueryResultModel> mModel;
    std::unique_ptr<QgsFeedback> mFeedback;
 
    QPointer<QgsConnectionsApiFetcher> mApiFetcher;
 
    bool mWasCanceled = false;
    mutable QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions mSqlVectorLayerOptions;
    bool mFirstRowFetched = false;
    QFutureWatcher<QgsAbstractDatabaseProviderConnection::QueryResult> mQueryResultWatcher;
    QString mSqlErrorMessage;
    long long mActualRowCount = -1;
    long long mFetchedRowsBatchCount = 0;
    QgsQueryResultWidget::QueryWidgetMode mQueryWidgetMode = QgsQueryResultWidget::QueryWidgetMode::SqlQueryMode;
    long long mCurrentHistoryEntryId = -1;

    void updateSqlLayerColumns();

    void cancelRunningQuery();

    void cancelApiFetcher();

    void startFetching();

    QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions sqlVectorLayerOptions() const;
 
    void storeCurrentQuery( Qgis::QueryStorageBackend backend );
 
    friend class TestQgsQueryResultWidget;
    friend class QgsQueryResultWidget;
};
#endif

class GUI_EXPORT QgsQueryResultDialog : public QDialog
{
    Q_OBJECT
 
  public:
    QgsQueryResultDialog( QgsAbstractDatabaseProviderConnection *connection SIP_TRANSFER = nullptr, QWidget *parent = nullptr );

    QgsQueryResultWidget *resultWidget() { return mWidget; }
 
    void closeEvent( QCloseEvent *event ) override;
 
  private:
    QgsQueryResultWidget *mWidget = nullptr;
};

class GUI_EXPORT QgsQueryResultMainWindow : public QMainWindow
{
    Q_OBJECT
 
  public:
    QgsQueryResultMainWindow( QgsAbstractDatabaseProviderConnection *connection SIP_TRANSFER = nullptr, const QString &identifierName = QString() );

    QgsQueryResultWidget *resultWidget() { return mWidget; }
 
    void closeEvent( QCloseEvent *event ) override;
 
  private:
    QgsQueryResultWidget *mWidget = nullptr;
    QString mIdentifierName;
 
    void updateWindowTitle( const QString &fileName );
};
 
#endif // QGSQUERYRESULTWIDGET_H