qgskeyvaluewidgetfactory.cpp

Go to the documentation of this file.

/***************************************************************************
    qgskeyvaluewidgetfactory.cpp
     --------------------------------------
    Date                 : 08.2016
    Copyright            : (C) 2016 Patrick Valsecchi
    Email                : patrick.valsecchi@camptocamp.com
 ***************************************************************************
 *                                                                         *
 *   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 "qgskeyvaluewidgetfactory.h"
 
#include "qgsdummyconfigdlg.h"
#include "qgsfields.h"
#include "qgskeyvaluewidgetwrapper.h"
#include "qgsvectorlayer.h"
 
#include <QSettings>
#include <QString>
#include <QVariant>
 
using namespace Qt::StringLiterals;
 
QgsKeyValueWidgetFactory::QgsKeyValueWidgetFactory( const QString &name, const QIcon &icon )
  : QgsEditorWidgetFactory( name, icon )
{}
 
QgsEditorWidgetWrapper *QgsKeyValueWidgetFactory::create( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent ) const
{
  return new QgsKeyValueWidgetWrapper( vl, fieldIdx, editor, parent );
}
 
QgsEditorConfigWidget *QgsKeyValueWidgetFactory::configWidget( QgsVectorLayer *vl, int fieldIdx, QWidget *parent ) const
{
  Q_UNUSED( vl )
  Q_UNUSED( fieldIdx )
  Q_UNUSED( parent )
  return new QgsDummyConfigDlg( vl, fieldIdx, parent, QObject::tr( "Key/Value field" ) );
}
 
unsigned int QgsKeyValueWidgetFactory::fieldScore( const QgsVectorLayer *vl, int fieldIdx ) const
{
  const QgsField field = vl->fields().field( fieldIdx );
  // Handle the json field
  if ( field.typeName().compare( u"json"_s, Qt::CaseInsensitive ) == 0 || field.typeName().compare( u"jsonb"_s, Qt::CaseInsensitive ) == 0 )
  {
    // Look for the values in the first 20 features check if it contains only maps
    const int MAX_FEATURE_LIMIT { 20 };
    QgsFeatureRequest req;
    req.setFlags( Qgis::FeatureRequestFlag::NoGeometry );
    req.setSubsetOfAttributes( { fieldIdx } );
    req.setLimit( MAX_FEATURE_LIMIT );
    QgsFeature f;
    QgsFeatureIterator featureIt { vl->getFeatures( req ) };
    // The counter is an extra safety measure in case the provider does not respect the limit
    int featureCount = 0;
    bool foundNotNull = false;
    bool foundInvalidValue = false; // An invalid value is any value that is not a JSON object (map) or an object with nested or invalid values
    while ( featureIt.nextFeature( f ) )
    {
      ++featureCount;
      if ( featureCount > MAX_FEATURE_LIMIT )
      {
        break;
      }
      // Get attribute value and check if it is a valid JSON object
      const QVariant value( f.attribute( fieldIdx ) );
      if ( !value.isNull() )
      {
        foundNotNull = true;
 
        // Read the object from string or map
        QJsonObject jsonObject;
        bool validObject = false;
        if ( value.type() == QVariant::Type::Map )
        {
          validObject = true;
          jsonObject = QJsonObject::fromVariantMap( value.toMap() );
        }
        else
        {
          const QJsonDocument doc = QJsonDocument::fromJson( value.toString().toUtf8() );
          if ( doc.isObject() )
          {
            validObject = true;
            jsonObject = doc.object();
          }
        }
        if ( validObject ) // empty object {} counts as valid as well
        {
          // It's a map, check the first 20 entries if flat (not nested)
          int count = 0;
          for ( auto it = jsonObject.begin(); it != jsonObject.end(); ++it )
          {
            if ( count >= 20 )
            {
              break;
            }
            count++;
            const QJsonValue childValue = it.value();
            if ( childValue.isObject() || childValue.isArray() || childValue.isUndefined() )
            {
              // Stop when we find the first nested object
              foundInvalidValue = true;
              break;
            }
          }
          if ( foundInvalidValue )
          {
            break;
          }
        }
        else
        {
          // Stop when we find the first non-map value
          foundInvalidValue = true;
          break;
        }
      }
    }
    if ( foundNotNull )
    {
      if ( !foundInvalidValue )
      {
        return 20;
      }
      else
      {
        return 5;
      }
    }
    else
    {
      return 10;
    }
  }
 
  return field.type() == QMetaType::Type::QVariantMap && field.subType() != QMetaType::Type::UnknownType ? 20 : 0;
}