qgsexpressiontreeview.cpp

Go to the documentation of this file.

/***************************************************************************
    qgsexpressiontreeview.cpp
     --------------------------------------
    Date                 : march 2020 - quarantine day 9
    Copyright            : (C) 2020 by Denis Rouzaud
    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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsexpressiontreeview.h"
 
#include "qgis.h"
#include "qgsapplication.h"
#include "qgsexpressioncontextutils.h"
#include "qgsiconutils.h"
#include "qgsrelationmanager.h"
#include "qgssettings.h"
#include "qgsvectorlayer.h"
 
#include <QMenu>
#include <QMessageBox>
#include <QString>
#include <QVersionNumber>
 
#include "moc_qgsexpressiontreeview.cpp"
 
using namespace Qt::StringLiterals;

QString formatRelationHelp( const QgsRelation &relation )
{
  QString text = u"<h3>%1</h3>\n<div class=\"description\"><p>%2</p></div>"_s
                   .arg( QCoreApplication::translate( "relation_help", "relation %1" ).arg( relation.name() ), QObject::tr( "Inserts the relation ID for the relation named '%1'." ).arg( relation.name() ) );
 
  text += u"<h4>%1</h4><div class=\"description\"><pre>%2</pre></div>"_s
            .arg( QObject::tr( "Current value" ), relation.id() );
 
  return text;
}
 

QString formatLayerHelp( const QgsMapLayer *layer )
{
  QString text = u"<h3>%1</h3>\n<div class=\"description\"><p>%2</p></div>"_s
                   .arg( QCoreApplication::translate( "layer_help", "map layer %1" ).arg( layer->name() ), QObject::tr( "Inserts the layer ID for the layer named '%1'." ).arg( layer->name() ) );
 
  text += u"<h4>%1</h4><div class=\"description\"><pre>%2</pre></div>"_s
            .arg( QObject::tr( "Current value" ), layer->id() );
 
  return text;
}

QString formatRecentExpressionHelp( const QString &label, const QString &expression )
{
  QString text = u"<h3>%1</h3>\n<div class=\"description\"><p>%2</p></div>"_s
                   .arg( QCoreApplication::translate( "recent_expression_help", "expression %1" ).arg( label ), QCoreApplication::translate( "recent_expression_help", "Recently used expression." ) );
 
  text += u"<h4>%1</h4><div class=\"description\"><pre>%2</pre></div>"_s
            .arg( QObject::tr( "Expression" ), expression );
 
  return text;
}

QString formatUserExpressionHelp( const QString &label, const QString &expression, const QString &description )
{
  QString text = u"<h3>%1</h3>\n<div class=\"description\"><p>%2</p></div>"_s
                   .arg( QCoreApplication::translate( "user_expression_help", "expression %1" ).arg( label ), description );
 
  text += u"<h4>%1</h4><div class=\"description\"><pre>%2</pre></div>"_s
            .arg( QObject::tr( "Expression" ), expression );
 
  return text;
}

QString formatVariableHelp( const QString &variable, const QString &description, bool showValue, const QVariant &value )
{
  QString text = u"<h3>%1</h3>\n<div class=\"description\"><p>%2</p></div>"_s
                   .arg( QCoreApplication::translate( "variable_help", "variable %1" ).arg( variable ), description );
 
  if ( showValue )
  {
    QString valueString = !value.isValid()
                            ? QCoreApplication::translate( "variable_help", "not set" )
                            : u"<pre>%1</pre>"_s.arg( QgsExpression::formatPreviewString( value ) );
 
    text += u"<h4>%1</h4><div class=\"description\"><p>%2</p></div>"_s
              .arg( QObject::tr( "Current value" ), valueString );
  }
 
  return text;
}
 
 
// ****************************
// ****************************
// QgsExpressionTreeView
// ****************************
 
 
QgsExpressionTreeView::QgsExpressionTreeView( QWidget *parent )
  : QTreeView( parent )
  , mProject( QgsProject::instance() )
{
  connect( this, &QTreeView::doubleClicked, this, &QgsExpressionTreeView::onDoubleClicked );
 
  mModel = std::make_unique<QStandardItemModel>();
  mProxyModel = std::make_unique<QgsExpressionItemSearchProxy>();
  mProxyModel->setDynamicSortFilter( true );
  mProxyModel->setSourceModel( mModel.get() );
  setModel( mProxyModel.get() );
  setSortingEnabled( true );
  sortByColumn( 0, Qt::AscendingOrder );
 
  setSelectionMode( QAbstractItemView::SelectionMode::SingleSelection );
 
  setContextMenuPolicy( Qt::CustomContextMenu );
  connect( this, &QWidget::customContextMenuRequested, this, &QgsExpressionTreeView::showContextMenu );
  connect( selectionModel(), &QItemSelectionModel::currentChanged, this, &QgsExpressionTreeView::currentItemChanged );
 
  updateFunctionTree();
  loadUserExpressions();
 
  // select the first item in the function list
  // in order to avoid a blank help widget
  QModelIndex firstItem = mProxyModel->index( 0, 0, QModelIndex() );
  setCurrentIndex( firstItem );
}
 
void QgsExpressionTreeView::setLayer( QgsVectorLayer *layer )
{
  mLayer = layer;
 
  //TODO - remove existing layer scope from context
 
  if ( mLayer )
    mExpressionContext << QgsExpressionContextUtils::layerScope( mLayer );
 
  loadFieldNames();
}
 
void QgsExpressionTreeView::setExpressionContext( const QgsExpressionContext &context )
{
  mExpressionContext = context;
  updateFunctionTree();
  loadFieldNames();
  loadRecent( mRecentKey );
  loadUserExpressions();
}
 
void QgsExpressionTreeView::setMenuProvider( QgsExpressionTreeView::MenuProvider *provider )
{
  mMenuProvider = provider;
}
 
void QgsExpressionTreeView::refresh()
{
  updateFunctionTree();
  loadFieldNames();
  loadRecent( mRecentKey );
  loadUserExpressions();
}
 
QgsExpressionItem *QgsExpressionTreeView::currentItem() const
{
  QModelIndex idx = mProxyModel->mapToSource( currentIndex() );
  QgsExpressionItem *item = static_cast<QgsExpressionItem *>( mModel->itemFromIndex( idx ) );
  return item;
}
 
QStandardItemModel *QgsExpressionTreeView::model()
{
  return mModel.get();
}
 
QgsProject *QgsExpressionTreeView::project()
{
  return mProject;
}
 
void QgsExpressionTreeView::setProject( QgsProject *project )
{
  mProject = project;
  updateFunctionTree();
}
 
 
void QgsExpressionTreeView::setSearchText( const QString &text )
{
  mProxyModel->setFilterString( text );
  if ( text.isEmpty() )
  {
    collapseAll();
  }
  else
  {
    expandAll();
    QModelIndex index = mProxyModel->index( 0, 0 );
    if ( mProxyModel->hasChildren( index ) )
    {
      QModelIndex child = mProxyModel->index( 0, 0, index );
      selectionModel()->setCurrentIndex( child, QItemSelectionModel::ClearAndSelect );
    }
  }
}
 
void QgsExpressionTreeView::onDoubleClicked( const QModelIndex &index )
{
  QModelIndex idx = mProxyModel->mapToSource( index );
  QgsExpressionItem *item = static_cast<QgsExpressionItem *>( mModel->itemFromIndex( idx ) );
  if ( !item )
    return;
 
  // Don't handle the double-click if we are on a header node.
  if ( item->getItemType() == QgsExpressionItem::Header )
    return;
 
  emit expressionItemDoubleClicked( item->getExpressionText() );
}
 
void QgsExpressionTreeView::showContextMenu( QPoint pt )
{
  QModelIndex idx = indexAt( pt );
  idx = mProxyModel->mapToSource( idx );
  QgsExpressionItem *item = static_cast<QgsExpressionItem *>( mModel->itemFromIndex( idx ) );
  if ( !item )
    return;
 
  if ( !mMenuProvider )
    return;
 
  QMenu *menu = mMenuProvider->createContextMenu( item );
 
  if ( menu )
    menu->popup( mapToGlobal( pt ) );
}
 
void QgsExpressionTreeView::currentItemChanged( const QModelIndex &index, const QModelIndex & )
{
  // Get the item
  QModelIndex idx = mProxyModel->mapToSource( index );
  QgsExpressionItem *item = static_cast<QgsExpressionItem *>( mModel->itemFromIndex( idx ) );
  if ( !item )
    return;
 
  emit currentExpressionItemChanged( item );
}
 
void QgsExpressionTreeView::updateFunctionTree()
{
  mModel->clear();
  mExpressionGroups.clear();
 
  //list of pairs where the first is the name and the second is the expression value when adding it
  static const QList<QPair<QString, QString>> operators = QList<QPair<QString, QString>>()
                                                          << QPair<QString, QString>( u"+"_s, u" + "_s )
                                                          << QPair<QString, QString>( u"-"_s, u" - "_s )
                                                          << QPair<QString, QString>( u"*"_s, u" * "_s )
                                                          << QPair<QString, QString>( u"/"_s, u" / "_s )
                                                          << QPair<QString, QString>( u"//"_s, u" // "_s )
                                                          << QPair<QString, QString>( u"%"_s, u" % "_s )
                                                          << QPair<QString, QString>( u"^"_s, u" ^ "_s )
                                                          << QPair<QString, QString>( u"="_s, u" = "_s )
                                                          << QPair<QString, QString>( u"~"_s, u" ~ "_s )
                                                          << QPair<QString, QString>( u">"_s, u" > "_s )
                                                          << QPair<QString, QString>( u"<"_s, u" < "_s )
                                                          << QPair<QString, QString>( u"<>"_s, u" <> "_s )
                                                          << QPair<QString, QString>( u"<="_s, u" <= "_s )
                                                          << QPair<QString, QString>( u">="_s, u" >= "_s )
                                                          << QPair<QString, QString>( u"[]"_s, u"[]"_s )
                                                          << QPair<QString, QString>( u"||"_s, u" || "_s )
                                                          << QPair<QString, QString>( u"BETWEEN"_s, u" BETWEEN "_s )
                                                          << QPair<QString, QString>( u"NOT BETWEEN"_s, u" NOT BETWEEN "_s )
                                                          << QPair<QString, QString>( u"IN"_s, u" IN "_s )
                                                          << QPair<QString, QString>( u"LIKE"_s, u" LIKE "_s )
                                                          << QPair<QString, QString>( u"ILIKE"_s, u" ILIKE "_s )
                                                          << QPair<QString, QString>( u"IS"_s, u" IS "_s )
                                                          << QPair<QString, QString>( u"IS NOT"_s, u" IS NOT "_s )
                                                          << QPair<QString, QString>( u"OR"_s, u" OR "_s )
                                                          << QPair<QString, QString>( u"AND"_s, u" AND "_s )
                                                          << QPair<QString, QString>( u"NOT"_s, u" NOT "_s );
  for ( const auto &name : operators )
  {
    registerItem( u"Operators"_s, name.first, name.second, QString(), QgsExpressionItem::ExpressionNode, false, -1, QIcon(), QgsExpression::tags( name.first ) );
  }
 
  QString casestring = u"CASE WHEN condition THEN result END"_s;
  registerItem( u"Conditionals"_s, u"CASE"_s, casestring, QString(), QgsExpressionItem::ExpressionNode, false, -1, QIcon(), QgsExpression::tags( "CASE" ) );
 
  // use -1 as sort order here -- NULL should always show before the field list
  registerItem( u"Fields and Values"_s, u"NULL"_s, u"NULL"_s, QString(), QgsExpressionItem::ExpressionNode, false, -1 );
 
  registerItem( u"String"_s, u"\\n (newline character)"_s, u"'\\n'"_s, QString(), QgsExpressionItem::ExpressionNode, false, -1, QIcon(), QgsExpression::tags( u"\\n"_s ) );
  registerItem( u"String"_s, u"\\t (tab character)"_s, u"'\\t'"_s, QString(), QgsExpressionItem::ExpressionNode, false, -1, QIcon(), QgsExpression::tags( u"\\t"_s ) );
  registerItem( u"String"_s, u"\\\\ (backslash character)"_s, u"'\\\\'"_s, QString(), QgsExpressionItem::ExpressionNode, false, -1, QIcon(), QgsExpression::tags( u"\\\\"_s ) );
  registerItem( u"String"_s, u"\\' (quote character)"_s, u"'\\''"_s, QString(), QgsExpressionItem::ExpressionNode, false, -1, QIcon(), QgsExpression::tags( u"\\'"_s ) );
 
  // Load the functions from the QgsExpression class
  int count = QgsExpression::functionCount();
  for ( int i = 0; i < count; i++ )
  {
    QgsExpressionFunction *func = QgsExpression::Functions()[i];
    QString name = func->name();
    if ( name.startsWith( '_' ) ) // do not display private functions
      continue;
    if ( func->isDeprecated() ) // don't show deprecated functions
      continue;
    if ( func->isContextual() )
    {
      //don't show contextual functions by default - it's up the the QgsExpressionContext
      //object to provide them if supported
      continue;
    }
    if ( func->params() != 0 )
      name += '(';
    else if ( !name.startsWith( '$' ) )
      name += "()"_L1;
    // this is where the functions are being registered, including functions under "Custom"
    registerItemForAllGroups( func->groups(), func->name(), ' ' + name + ' ', func->helpText(), QgsExpressionItem::ExpressionNode, mExpressionContext.isHighlightedFunction( func->name() ), 1, QgsExpression::tags( func->name() ) );
  }
 
  // load relation names
  loadRelations();
 
  // load layer IDs
  loadLayers();
 
  loadExpressionContext();
}
 
QgsExpressionItem *QgsExpressionTreeView::registerItem( const QString &group, const QString &label, const QString &expressionText, const QString &helpText, QgsExpressionItem::ItemType type, bool highlightedItem, int sortOrder, const QIcon &icon, const QStringList &tags, const QString &name )
{
  QgsExpressionItem *item = new QgsExpressionItem( label, expressionText, helpText, type );
  item->setData( label, Qt::UserRole );
  item->setData( sortOrder, QgsExpressionItem::CUSTOM_SORT_ROLE );
  item->setData( tags, QgsExpressionItem::SEARCH_TAGS_ROLE );
  item->setData( name, QgsExpressionItem::ITEM_NAME_ROLE );
  item->setIcon( icon );
 
  // Look up the group and insert the new function.
  if ( mExpressionGroups.contains( group ) )
  {
    QgsExpressionItem *groupNode = mExpressionGroups.value( group );
    groupNode->appendRow( item );
  }
  else
  {
    // If the group doesn't exist yet we make it first.
    QgsExpressionItem *newgroupNode = new QgsExpressionItem( QgsExpression::group( group ), QString(), QgsExpressionItem::Header );
    newgroupNode->setData( group, Qt::UserRole );
    //Recent group should always be last group
    newgroupNode->setData( group.startsWith( "Recent ("_L1 ) ? 2 : 1, QgsExpressionItem::CUSTOM_SORT_ROLE );
    newgroupNode->appendRow( item );
    newgroupNode->setBackground( QBrush( QColor( 150, 150, 150, 150 ) ) );
    mModel->appendRow( newgroupNode );
    mExpressionGroups.insert( group, newgroupNode );
  }
 
  if ( highlightedItem )
  {
    //insert a copy as a top level item
    QgsExpressionItem *topLevelItem = new QgsExpressionItem( label, expressionText, helpText, type );
    topLevelItem->setData( label, Qt::UserRole );
    item->setData( 0, QgsExpressionItem::CUSTOM_SORT_ROLE );
    QFont font = topLevelItem->font();
    font.setBold( true );
    topLevelItem->setFont( font );
    mModel->appendRow( topLevelItem );
  }
  return item;
}
 
void QgsExpressionTreeView::registerItemForAllGroups( const QStringList &groups, const QString &label, const QString &expressionText, const QString &helpText, QgsExpressionItem::ItemType type, bool highlightedItem, int sortOrder, const QStringList &tags )
{
  const auto constGroups = groups;
  for ( const QString &group : constGroups )
  {
    registerItem( group, label, expressionText, helpText, type, highlightedItem, sortOrder, QIcon(), tags );
  }
}
 
void QgsExpressionTreeView::loadExpressionContext()
{
  QStringList variableNames = mExpressionContext.filteredVariableNames();
  const auto constVariableNames = variableNames;
  for ( const QString &variable : constVariableNames )
  {
    registerItem( u"Variables"_s, variable, " @" + variable + ' ', formatVariableHelp( variable, mExpressionContext.description( variable ), true, mExpressionContext.variable( variable ) ), QgsExpressionItem::ExpressionNode, mExpressionContext.isHighlightedVariable( variable ) );
  }
 
  // Load the functions from the expression context
  QStringList contextFunctions = mExpressionContext.functionNames();
  const auto constContextFunctions = contextFunctions;
  for ( const QString &functionName : constContextFunctions )
  {
    QgsExpressionFunction *func = mExpressionContext.function( functionName );
    QString name = func->name();
    if ( name.startsWith( '_' ) ) // do not display private functions
      continue;
    if ( func->params() != 0 )
      name += '(';
    registerItemForAllGroups( func->groups(), func->name(), ' ' + name + ' ', func->helpText(), QgsExpressionItem::ExpressionNode, mExpressionContext.isHighlightedFunction( func->name() ), 1, QgsExpression::tags( func->name() ) );
  }
}
 
void QgsExpressionTreeView::loadLayers()
{
  if ( !mProject )
    return;
 
  QMap<QString, QgsMapLayer *> layers = mProject->mapLayers();
  QMap<QString, QgsMapLayer *>::const_iterator layerIt = layers.constBegin();
  for ( ; layerIt != layers.constEnd(); ++layerIt )
  {
    QIcon icon = QgsIconUtils::iconForLayer( layerIt.value() );
    QgsExpressionItem *parentItem = registerItem( u"Map Layers"_s, layerIt.value()->name(), u"'%1'"_s.arg( layerIt.key() ), formatLayerHelp( layerIt.value() ), QgsExpressionItem::ExpressionNode, false, 99, icon );
    loadLayerFields( qobject_cast<QgsVectorLayer *>( layerIt.value() ), parentItem );
  }
}
 
void QgsExpressionTreeView::loadLayerFields( QgsVectorLayer *layer, QgsExpressionItem *parentItem )
{
  if ( !layer )
    return;
 
  const QgsFields fields = layer->fields();
  for ( int fieldIdx = 0; fieldIdx < fields.count(); ++fieldIdx )
  {
    const QgsField field = fields.at( fieldIdx );
    QIcon icon = fields.iconForField( fieldIdx );
    const QString label { field.displayNameWithAlias() };
    QgsExpressionItem *item = new QgsExpressionItem( label, " '" + field.name() + "' ", QString(), QgsExpressionItem::Field );
    item->setData( label, Qt::UserRole );
    item->setData( 99, QgsExpressionItem::CUSTOM_SORT_ROLE );
    item->setData( QStringList(), QgsExpressionItem::SEARCH_TAGS_ROLE );
    item->setData( field.name(), QgsExpressionItem::ITEM_NAME_ROLE );
    item->setData( layer->id(), QgsExpressionItem::LAYER_ID_ROLE );
    item->setIcon( icon );
    parentItem->appendRow( item );
  }
}
 
void QgsExpressionTreeView::loadFieldNames( const QgsFields &fields )
{
  for ( int i = 0; i < fields.count(); ++i )
  {
    const QgsField field = fields.at( i );
    QIcon icon = fields.iconForField( i );
    registerItem( u"Fields and Values"_s, field.displayNameWithAlias(), " \"" + field.name() + "\" ", QString(), QgsExpressionItem::Field, false, i, icon, QStringList(), field.name() );
  }
}
 
void QgsExpressionTreeView::loadFieldNames()
{
  // Cleanup
  if ( mExpressionGroups.contains( u"Fields and Values"_s ) )
  {
    QgsExpressionItem *node = mExpressionGroups.value( u"Fields and Values"_s );
    node->removeRows( 0, node->rowCount() );
    // Re-add NULL and feature variables
    // use -1 as sort order here -- NULL and feature variables should always show before the field list
    registerItem( u"Fields and Values"_s, u"NULL"_s, u"NULL"_s, QString(), QgsExpressionItem::ExpressionNode, false, -1 );
  }
 
  if ( mLayer )
  {
    // Add feature variables to record and attributes group (and highlighted items)
 
    const QString currentFeatureHelp = formatVariableHelp( u"feature"_s, QgsExpression::variableHelpText( u"feature"_s ), false, QVariant() );
    const QString currentFeatureIdHelp = formatVariableHelp( u"id"_s, QgsExpression::variableHelpText( u"id"_s ), false, QVariant() );
    const QString currentGeometryHelp = formatVariableHelp( u"geometry"_s, QgsExpression::variableHelpText( u"geometry"_s ), false, QVariant() );
 
    registerItem( u"Fields and Values"_s, u"feature"_s, u"@feature"_s, currentFeatureHelp, QgsExpressionItem::ExpressionNode, false, -1 );
    registerItem( u"Fields and Values"_s, u"id"_s, u"@id"_s, currentFeatureIdHelp, QgsExpressionItem::ExpressionNode, false, -1 );
    registerItem( u"Fields and Values"_s, u"geometry"_s, u"@geometry"_s, currentGeometryHelp, QgsExpressionItem::ExpressionNode, false, -1 );
 
    registerItem( u"Variables"_s, u"feature"_s, u"@feature"_s, currentFeatureHelp, QgsExpressionItem::ExpressionNode );
    registerItem( u"Variables"_s, u"id"_s, u"@id"_s, currentFeatureIdHelp, QgsExpressionItem::ExpressionNode );
    registerItem( u"Variables"_s, u"geometry"_s, u"@geometry"_s, currentGeometryHelp, QgsExpressionItem::ExpressionNode, false );
 
    registerItem( u"Record and Attributes"_s, u"feature"_s, u"@feature"_s, currentFeatureHelp, QgsExpressionItem::ExpressionNode, true, -1 );
    registerItem( u"Record and Attributes"_s, u"id"_s, u"@id"_s, currentFeatureIdHelp, QgsExpressionItem::ExpressionNode, true, -1 );
    registerItem( u"Record and Attributes"_s, u"geometry"_s, u"@geometry"_s, currentGeometryHelp, QgsExpressionItem::ExpressionNode, true, -1 );
  }
 
  // this can happen if fields are manually set
  if ( !mLayer )
    return;
 
  const QgsFields &fields = mLayer->fields();
 
  loadFieldNames( fields );
}
 
void QgsExpressionTreeView::loadRelations()
{
  if ( !mProject )
    return;
 
  QMap<QString, QgsRelation> relations = mProject->relationManager()->relations();
  QMap<QString, QgsRelation>::const_iterator relIt = relations.constBegin();
  for ( ; relIt != relations.constEnd(); ++relIt )
  {
    registerItemForAllGroups( QStringList() << tr( "Relations" ), relIt->name(), u"'%1'"_s.arg( relIt->id() ), formatRelationHelp( relIt.value() ) );
  }
}
 
void QgsExpressionTreeView::loadRecent( const QString &collection )
{
  mRecentKey = collection;
  QString name = tr( "Recent (%1)" ).arg( collection );
  if ( mExpressionGroups.contains( name ) )
  {
    QgsExpressionItem *node = mExpressionGroups.value( name );
    node->removeRows( 0, node->rowCount() );
  }
 
  QgsSettings settings;
  const QString location = u"/expressions/recent/%1"_s.arg( collection );
  const QStringList expressions = settings.value( location ).toStringList();
  int i = 0;
  for ( const QString &expression : expressions )
  {
    QString help = formatRecentExpressionHelp( expression, expression );
    QString label = expression;
    label.replace( '\n', ' ' );
    registerItem( name, label, expression, help, QgsExpressionItem::ExpressionNode, false, i );
    i++;
  }
}
 
void QgsExpressionTreeView::saveToRecent( const QString &expressionText, const QString &collection )
{
  QgsSettings settings;
  QString location = u"/expressions/recent/%1"_s.arg( collection );
  QStringList expressions = settings.value( location ).toStringList();
  expressions.removeAll( expressionText );
 
  expressions.prepend( expressionText );
 
  while ( expressions.count() > 20 )
  {
    expressions.pop_back();
  }
 
  settings.setValue( location, expressions );
  loadRecent( collection );
}
 
void QgsExpressionTreeView::saveToUserExpressions( const QString &label, const QString &expression, const QString &helpText )
{
  QgsSettings settings;
  const QString location = u"user"_s;
  settings.beginGroup( location, QgsSettings::Section::Expressions );
  settings.beginGroup( label );
  settings.setValue( u"expression"_s, expression );
  settings.setValue( u"helpText"_s, helpText );
  loadUserExpressions();
  // Scroll
  const QModelIndexList idxs { mModel->match( mModel->index( 0, 0 ), Qt::DisplayRole, label, 1, Qt::MatchFlag::MatchRecursive ) };
  if ( !idxs.isEmpty() )
  {
    scrollTo( idxs.first() );
  }
}
 
void QgsExpressionTreeView::removeFromUserExpressions( const QString &label )
{
  QgsSettings settings;
  settings.remove( u"user/%1"_s.arg( label ), QgsSettings::Section::Expressions );
  loadUserExpressions();
}
 
// this is potentially very slow if there are thousands of user expressions, every time entire cleanup and load
void QgsExpressionTreeView::loadUserExpressions()
{
  // Cleanup
  if ( mExpressionGroups.contains( u"UserGroup"_s ) )
  {
    QgsExpressionItem *node = mExpressionGroups.value( u"UserGroup"_s );
    node->removeRows( 0, node->rowCount() );
  }
 
  QgsSettings settings;
  const QString location = u"user"_s;
  settings.beginGroup( location, QgsSettings::Section::Expressions );
  QString helpText;
  QString expression;
  int i = 0;
  mUserExpressionLabels = settings.childGroups();
  for ( const auto &label : std::as_const( mUserExpressionLabels ) )
  {
    settings.beginGroup( label );
    expression = settings.value( u"expression"_s ).toString();
    helpText = formatUserExpressionHelp( label, expression, settings.value( u"helpText"_s ).toString() );
    registerItem( u"UserGroup"_s, label, expression, helpText, QgsExpressionItem::ExpressionNode, false, i++ );
    settings.endGroup();
  }
}
 
QStringList QgsExpressionTreeView::userExpressionLabels() const
{
  return mUserExpressionLabels;
}
 
QJsonDocument QgsExpressionTreeView::exportUserExpressions()
{
  const QString group = u"user"_s;
  QgsSettings settings;
  QJsonArray exportList;
  QJsonObject exportObject {
    { "qgis_version", Qgis::version() },
    { "exported_at", QDateTime::currentDateTime().toString( Qt::ISODate ) },
    { "author", QgsApplication::userFullName() },
    { "expressions", exportList }
  };
 
  settings.beginGroup( group, QgsSettings::Section::Expressions );
 
  mUserExpressionLabels = settings.childGroups();
 
  for ( const QString &label : std::as_const( mUserExpressionLabels ) )
  {
    settings.beginGroup( label );
 
    const QString expression = settings.value( u"expression"_s ).toString();
    const QString helpText = settings.value( u"helpText"_s ).toString();
    const QJsonObject expressionObject {
      { "name", label },
      { "type", "expression" },
      { "expression", expression },
      { "group", group },
      { "description", helpText }
    };
    exportList.push_back( expressionObject );
 
    settings.endGroup();
  }
 
  exportObject[u"expressions"_s] = exportList;
  QJsonDocument exportJson = QJsonDocument( exportObject );
 
  return exportJson;
}
 
void QgsExpressionTreeView::loadExpressionsFromJson( const QJsonDocument &expressionsDocument )
{
  // if the root of the json document is not an object, it means it's a wrong file
  if ( !expressionsDocument.isObject() )
    return;
 
  QJsonObject expressionsObject = expressionsDocument.object();
 
  // validate json for manadatory fields
  if ( !expressionsObject[u"qgis_version"_s].isString()
       || !expressionsObject[u"exported_at"_s].isString()
       || !expressionsObject[u"author"_s].isString()
       || !expressionsObject[u"expressions"_s].isArray() )
    return;
 
  // validate versions
  QVersionNumber qgisJsonVersion = QVersionNumber::fromString( expressionsObject[u"qgis_version"_s].toString() );
  QVersionNumber qgisVersion = QVersionNumber::fromString( Qgis::version() );
 
  // if the expressions are from newer version of QGIS, we ask the user to confirm
  // they want to proceed
  if ( qgisJsonVersion > qgisVersion )
  {
    QMessageBox::StandardButtons buttons = QMessageBox::Yes | QMessageBox::No;
    switch ( QMessageBox::question( this, tr( "QGIS Version Mismatch" ), tr( "The imported expressions are from newer version of QGIS (%1) "
                                                                             "and some of the expression might not work the current version (%2). "
                                                                             "Are you sure you want to continue?" )
                                                                           .arg( qgisJsonVersion.toString(), qgisVersion.toString() ),
                                    buttons ) )
    {
      case QMessageBox::No:
        return;
 
      case QMessageBox::Yes:
        break;
 
      default:
        break;
    }
  }
 
  // we store the number of
  QStringList skippedExpressionLabels;
  bool isApplyToAll = false;
  bool isOkToOverwrite = false;
 
  QgsSettings settings;
  settings.beginGroup( u"user"_s, QgsSettings::Section::Expressions );
  mUserExpressionLabels = settings.childGroups();
 
  const QJsonArray expressions = expressionsObject[u"expressions"_s].toArray();
  for ( const QJsonValue &&expressionValue : expressions )
  {
    // validate the type of the array element, can be anything
    if ( !expressionValue.isObject() )
    {
      // try to stringify and put and indicator what happened
      skippedExpressionLabels.append( expressionValue.toString() );
      continue;
    }
 
    QJsonObject expressionObj = expressionValue.toObject();
 
    // make sure the required keys are the correct types
    if ( !expressionObj[u"name"_s].isString()
         || !expressionObj[u"type"_s].isString()
         || !expressionObj[u"expression"_s].isString()
         || !expressionObj[u"group"_s].isString()
         || !expressionObj[u"description"_s].isString() )
    {
      // try to stringify and put an indicator what happened. Try to stringify the name, if fails, go with the expression.
      if ( !expressionObj[u"name"_s].toString().isEmpty() )
        skippedExpressionLabels.append( expressionObj[u"name"_s].toString() );
      else
        skippedExpressionLabels.append( expressionObj[u"expression"_s].toString() );
 
      continue;
    }
 
    // we want to import only items of type expression for now
    if ( expressionObj[u"type"_s].toString() != "expression"_L1 )
    {
      skippedExpressionLabels.append( expressionObj[u"name"_s].toString() );
      continue;
    }
 
    // we want to import only items of type expression for now
    if ( expressionObj[u"group"_s].toString() != "user"_L1 )
    {
      skippedExpressionLabels.append( expressionObj[u"name"_s].toString() );
      continue;
    }
 
    const QString label = expressionObj[u"name"_s].toString();
    const QString expression = expressionObj[u"expression"_s].toString();
    const QString helpText = expressionObj[u"description"_s].toString();
 
    // make sure they have valid name
    if ( label.contains( "\\"_L1 ) || label.contains( '/' ) )
    {
      skippedExpressionLabels.append( expressionObj[u"name"_s].toString() );
      continue;
    }
 
    settings.beginGroup( label );
    const QString oldExpression = settings.value( u"expression"_s ).toString();
    settings.endGroup();
 
    // TODO would be nice to skip the cases when labels and expressions match
    if ( mUserExpressionLabels.contains( label ) && expression != oldExpression )
    {
      if ( !isApplyToAll )
        showMessageBoxConfirmExpressionOverwrite( isApplyToAll, isOkToOverwrite, label, oldExpression, expression );
 
      if ( isOkToOverwrite )
        saveToUserExpressions( label, expression, helpText );
      else
      {
        skippedExpressionLabels.append( label );
        continue;
      }
    }
    else
    {
      saveToUserExpressions( label, expression, helpText );
    }
  }
 
  loadUserExpressions();
 
  if ( !skippedExpressionLabels.isEmpty() )
  {
    QStringList skippedExpressionLabelsQuoted;
    skippedExpressionLabelsQuoted.reserve( skippedExpressionLabels.size() );
    for ( const QString &skippedExpressionLabel : skippedExpressionLabels )
      skippedExpressionLabelsQuoted.append( u"'%1'"_s.arg( skippedExpressionLabel ) );
 
    QMessageBox::information( this, tr( "Skipped Expression Imports" ), u"%1\n%2"_s.arg( tr( "The following expressions have been skipped:" ), skippedExpressionLabelsQuoted.join( ", "_L1 ) ) );
  }
}
 
const QList<QgsExpressionItem *> QgsExpressionTreeView::findExpressions( const QString &label )
{
  QList<QgsExpressionItem *> result;
  const QList<QStandardItem *> found { mModel->findItems( label, Qt::MatchFlag::MatchRecursive ) };
  result.reserve( found.size() );
  std::transform( found.begin(), found.end(), std::back_inserter( result ), []( QStandardItem *item ) -> QgsExpressionItem * { return static_cast<QgsExpressionItem *>( item ); } );
  return result;
}
 
void QgsExpressionTreeView::showMessageBoxConfirmExpressionOverwrite(
  bool &isApplyToAll,
  bool &isOkToOverwrite,
  const QString &label,
  const QString &oldExpression,
  const QString &newExpression
)
{
  QMessageBox::StandardButtons buttons = QMessageBox::Yes | QMessageBox::YesToAll | QMessageBox::No | QMessageBox::NoToAll;
  switch ( QMessageBox::question( this, tr( "Expression Overwrite" ), tr( "The expression with label '%1' was already defined."
                                                                          "The old expression \"%2\" will be overwritten by \"%3\"."
                                                                          "Are you sure you want to overwrite the expression?" )
                                                                        .arg( label, oldExpression, newExpression ),
                                  buttons ) )
  {
    case QMessageBox::NoToAll:
      isApplyToAll = true;
      isOkToOverwrite = false;
      break;
 
    case QMessageBox::No:
      isApplyToAll = false;
      isOkToOverwrite = false;
      break;
 
    case QMessageBox::YesToAll:
      isApplyToAll = true;
      isOkToOverwrite = true;
      break;
 
    case QMessageBox::Yes:
      isApplyToAll = false;
      isOkToOverwrite = true;
      break;
 
    default:
      break;
  }
}
 
 
// ****************************
// ****************************
// QgsExpressionItemSearchProxy
// ****************************
 
 
QgsExpressionItemSearchProxy::QgsExpressionItemSearchProxy()
{
  setFilterCaseSensitivity( Qt::CaseInsensitive );
}
 
bool QgsExpressionItemSearchProxy::filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const
{
  QModelIndex index = sourceModel()->index( source_row, 0, source_parent );
  const QgsExpressionItem::ItemType itemType = QgsExpressionItem::ItemType( sourceModel()->data( index, QgsExpressionItem::ITEM_TYPE_ROLE ).toInt() );
 
  if ( itemType == QgsExpressionItem::Header )
  {
    // show header if any child item matches
    int count = sourceModel()->rowCount( index );
    bool matchchild = false;
    for ( int i = 0; i < count; ++i )
    {
      if ( filterAcceptsRow( i, index ) )
      {
        matchchild = true;
        break;
      }
    }
    return matchchild;
  }
 
  // check match of item label or tags
  const QString name = sourceModel()->data( index, Qt::DisplayRole ).toString();
  if ( name.contains( mFilterString, Qt::CaseInsensitive ) )
  {
    return true;
  }
 
  const QStringList tags = sourceModel()->data( index, QgsExpressionItem::SEARCH_TAGS_ROLE ).toStringList();
  return std::any_of( tags.begin(), tags.end(), [this]( const QString &tag ) {
    return tag.contains( mFilterString, Qt::CaseInsensitive );
  } );
}
 
void QgsExpressionItemSearchProxy::setFilterString( const QString &string )
{
  mFilterString = string;
  invalidate();
}
 
bool QgsExpressionItemSearchProxy::lessThan( const QModelIndex &left, const QModelIndex &right ) const
{
  int leftSort = sourceModel()->data( left, QgsExpressionItem::CUSTOM_SORT_ROLE ).toInt();
  int rightSort = sourceModel()->data( right, QgsExpressionItem::CUSTOM_SORT_ROLE ).toInt();
  if ( leftSort != rightSort )
    return leftSort < rightSort;
 
  QString leftString = sourceModel()->data( left, Qt::DisplayRole ).toString();
  QString rightString = sourceModel()->data( right, Qt::DisplayRole ).toString();
 
  //ignore $ prefixes when sorting
  if ( leftString.startsWith( '$' ) )
    leftString = leftString.mid( 1 );
  if ( rightString.startsWith( '$' ) )
    rightString = rightString.mid( 1 );
 
  return QString::localeAwareCompare( leftString, rightString ) < 0;
}