qgsactionwidgetwrapper.cpp

Go to the documentation of this file.

/***************************************************************************
  qgsactionwidgetwrapper.cpp - QgsActionWidgetWrapper
 
 ---------------------
 begin                : 14.8.2021
 copyright            : (C) 2021 by Alessandro Pasotti
 email                : elpaso at itopen dot it
 ***************************************************************************
 *                                                                         *
 *   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 "qgsactionwidgetwrapper.h"
 
#include "qgsattributeform.h"
#include "qgsexpressioncontextutils.h"
#include "qgsgui.h"
#include "qgsmessagebar.h"
 
#include <QLayout>
#include <QString>
 
#include "moc_qgsactionwidgetwrapper.cpp"
 
using namespace Qt::StringLiterals;
 
QgsActionWidgetWrapper::QgsActionWidgetWrapper( QgsVectorLayer *layer, QWidget *editor, QWidget *parent, QgsMessageBar *messageBar )
  : QgsWidgetWrapper( layer, editor, parent )
  , mMessageBar( messageBar )
{
  connect( this, &QgsWidgetWrapper::contextChanged, [this] {
    const bool actionIsVisible {
      ( context().attributeFormMode() == QgsAttributeEditorContext::Mode::SingleEditMode ) || ( context().attributeFormMode() == QgsAttributeEditorContext::Mode::AddFeatureMode )
    };
    if ( mActionButton )
    {
      mActionButton->setVisible( actionIsVisible );
    }
  } );
}
 
void QgsActionWidgetWrapper::setAction( const QgsAction &action )
{
  mAction = action;
}
 
void QgsActionWidgetWrapper::setFeature( const QgsFeature &feature )
{
  mFeature = feature;
}
 
void QgsActionWidgetWrapper::setEnabled( bool enabled )
{
  if ( valid() && layer() )
  {
    mActionButton->setEnabled( !mAction.isEnabledOnlyWhenEditable() || enabled );
  }
}
 
bool QgsActionWidgetWrapper::valid() const
{
  return mAction.isValid() && mAction.runable();
}
 
QWidget *QgsActionWidgetWrapper::createWidget( QWidget *parent )
{
  return new QPushButton( parent );
}
 
void QgsActionWidgetWrapper::initWidget( QWidget *editor )
{
  mActionButton = qobject_cast<QPushButton *>( editor );
 
  if ( !mActionButton )
    return;
 
  if ( valid() && layer() )
  {
    const QString shortTitle { mAction.shortTitle() }; // might be empty
    const QString description { mAction.name() };      // mandatory
    const QIcon icon { mAction.icon() };               // might be invalid
 
    // Configure push button
    if ( !icon.isNull() )
    {
      mActionButton->setIcon( icon );
      mActionButton->setToolTip( description );
    }
    else
    {
      mActionButton->setText( shortTitle.isEmpty() ? description : shortTitle );
      if ( !shortTitle.isEmpty() )
      {
        mActionButton->setToolTip( description );
      }
    }
 
    if ( mAction.isEnabledOnlyWhenEditable() && !layer()->isEditable() )
    {
      mActionButton->setEnabled( false );
    }
 
    // Always connect
    connect( mActionButton, &QPushButton::clicked, this, [&] {
      const QgsAttributeEditorContext attributecontext = context();
      QgsExpressionContext expressionContext = layer()->createExpressionContext();
      expressionContext << QgsExpressionContextUtils::formScope( mFeature, attributecontext.attributeFormModeString() );
      expressionContext.setFeature( mFeature );
      switch ( mAction.type() )
      {
        case Qgis::AttributeActionType::GenericPython:
        case Qgis::AttributeActionType::Mac:
        case Qgis::AttributeActionType::Windows:
        case Qgis::AttributeActionType::Unix:
        {
          if ( QgsAttributeForm *form = qobject_cast<QgsAttributeForm *>( parent() ) )
          {
            const bool allowed = QgsGui::allowExecutionOfEmbeddedScripts( QgsProject::instance() );
            if ( !allowed )
            {
              if ( mMessageBar )
              {
                mMessageBar->pushMessage(
                  tr( "Security warning" ),
                  tr( "The action contains an embedded script which has been denied execution." ),
                  Qgis::MessageLevel::Warning
                );
              }
              return;
            }
 
            const QString formCode = u"locals()[\"form\"] = sip.wrapinstance( %1, qgis.gui.QgsAttributeForm )\n"_s
                                       .arg( ( quint64 ) form );
            QgsAction action { mAction };
            action.setCommand( formCode + mAction.command() );
            action.run( layer(), mFeature, expressionContext );
          }
          break;
        }
 
        case Qgis::AttributeActionType::Generic:
        case Qgis::AttributeActionType::OpenUrl:
        case Qgis::AttributeActionType::SubmitUrlEncoded:
        case Qgis::AttributeActionType::SubmitUrlMultipart:
        {
          mAction.run( layer(), mFeature, expressionContext );
          break;
        }
      }
    } );
  }
}