qgsactionmenu.cpp

Go to the documentation of this file.

/***************************************************************************
    qgsactionmenu.cpp
     --------------------------------------
    Date                 : 11.8.2014
    Copyright            : (C) 2014 Matthias Kuhn
    Email                : matthias at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   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 "qgsactionmenu.h"
 
#include "qgsactionmanager.h"
#include "qgsfeatureiterator.h"
#include "qgsgui.h"
#include "qgsmaplayeraction.h"
#include "qgsmaplayeractioncontextgenerator.h"
#include "qgsmaplayeractionregistry.h"
#include "qgsvectorlayer.h"
 
#include <QString>
 
#include "moc_qgsactionmenu.cpp"
 
using namespace Qt::StringLiterals;
 
QgsActionMenu::QgsActionMenu( QgsVectorLayer *layer, const QgsFeature &feature, const QString &actionScope, QWidget *parent )
  : QMenu( parent )
  , mLayer( layer )
  , mFeature( feature )
  , mFeatureId( feature.id() )
  , mActionScope( actionScope )
{
  init();
}
 
QgsActionMenu::QgsActionMenu( QgsVectorLayer *layer, const QgsFeatureId fid, const QString &actionScope, QWidget *parent )
  : QMenu( parent )
  , mLayer( layer )
  , mFeatureId( fid )
  , mActionScope( actionScope )
{
  init();
}
 
void QgsActionMenu::setActionContextGenerator( QgsMapLayerActionContextGenerator *generator )
{
  mContextGenerator = generator;
  reloadActions();
}
 
void QgsActionMenu::init()
{
  setTitle( tr( "&Actions" ) );
 
  connect( QgsGui::mapLayerActionRegistry(), &QgsMapLayerActionRegistry::changed, this, &QgsActionMenu::reloadActions );
  connect( mLayer, &QgsVectorLayer::editingStarted, this, &QgsActionMenu::reloadActions );
  connect( mLayer, &QgsVectorLayer::editingStopped, this, &QgsActionMenu::reloadActions );
  connect( mLayer, &QgsVectorLayer::readOnlyChanged, this, &QgsActionMenu::reloadActions );
  connect( mLayer, &QgsMapLayer::willBeDeleted, this, &QgsActionMenu::layerWillBeDeleted );
 
  reloadActions();
}
 
QgsFeature QgsActionMenu::feature()
{
  if ( !mFeature.isValid() )
  {
    mLayer->getFeatures( QgsFeatureRequest( mFeatureId ) ).nextFeature( mFeature );
  }
 
  return mFeature;
}
 
void QgsActionMenu::setFeature( const QgsFeature &feature )
{
  mFeature = feature;
}
 
void QgsActionMenu::setMode( const QgsAttributeEditorContext::Mode mode )
{
  mMode = mode;
  reloadActions();
}
 
void QgsActionMenu::triggerAction()
{
  if ( !feature().isValid() )
    return;
 
  QAction *action = qobject_cast<QAction *>( sender() );
  if ( !action )
    return;
 
  if ( !action->data().isValid() || !action->data().canConvert<ActionData>() )
    return;
 
  const ActionData data = action->data().value<ActionData>();
 
  switch ( data.actionType )
  {
    case Qgis::ActionType::Invalid:
      return;
    case Qgis::ActionType::MapLayerAction:
    {
      QgsMapLayerAction *mapLayerAction = data.actionData.value<QgsMapLayerAction *>();
 
      const QgsMapLayerActionContext context = mContextGenerator ? mContextGenerator->createActionContext() : QgsMapLayerActionContext();
      Q_NOWARN_DEPRECATED_PUSH
      mapLayerAction->triggerForFeature( data.mapLayer, mFeature );
      Q_NOWARN_DEPRECATED_POP
      mapLayerAction->triggerForFeature( data.mapLayer, mFeature, context );
      break;
    }
    case Qgis::ActionType::AttributeAction:
    {
      const QgsAction act = data.actionData.value<QgsAction>();
      switch ( act.type() )
      {
        case Qgis::AttributeActionType::GenericPython:
        case Qgis::AttributeActionType::Mac:
        case Qgis::AttributeActionType::Windows:
        case Qgis::AttributeActionType::Unix:
        {
          const bool allowed = QgsGui::allowExecutionOfEmbeddedScripts( QgsProject::instance() );
          if ( !allowed )
          {
            emit messageEmitted( tr( "The action contains embedded scripts which have been denied execution." ), Qgis::MessageLevel::Warning );
            return;
          }
          break;
        }
 
        case Qgis::AttributeActionType::Generic:
        case Qgis::AttributeActionType::OpenUrl:
        case Qgis::AttributeActionType::SubmitUrlEncoded:
        case Qgis::AttributeActionType::SubmitUrlMultipart:
        {
          break;
        }
      }
 
      // define custom substitutions: layer id and clicked coords
      QgsExpressionContext context = mLayer->createExpressionContext();
      context.setFeature( mFeature );
 
      QgsExpressionContextScope *actionScope = new QgsExpressionContextScope();
      actionScope->addVariable( QgsExpressionContextScope::StaticVariable( u"action_scope"_s, mActionScope, true ) );
      context << actionScope;
      act.run( context );
      break;
    }
  }
}
 
void QgsActionMenu::reloadActions()
{
  clear();
 
  mVisibleActionCount = 0;
 
  mActions = mLayer->actions()->actions( mActionScope );
 
  const auto constMActions = mActions;
  for ( const QgsAction &action : constMActions )
  {
    if ( !mLayer->isEditable() && action.isEnabledOnlyWhenEditable() )
      continue;
 
    if ( action.isEnabledOnlyWhenEditable() && ( mMode == QgsAttributeEditorContext::AddFeatureMode || mMode == QgsAttributeEditorContext::IdentifyMode ) )
      continue;
 
    QgsAction act( action );
    act.setExpressionContextScope( mExpressionContextScope );
 
    QAction *qAction = new QAction( action.icon(), action.name(), this );
    qAction->setData( QVariant::fromValue<ActionData>( ActionData( act, mFeatureId, mLayer ) ) );
    qAction->setIcon( action.icon() );
 
    // Only enable items on supported platforms
    if ( !action.runable() )
    {
      qAction->setEnabled( false );
      qAction->setToolTip( tr( "Not supported on your platform" ) );
    }
    else
    {
      qAction->setToolTip( action.command() );
    }
    connect( qAction, &QAction::triggered, this, &QgsActionMenu::triggerAction );
    addAction( qAction );
 
    mVisibleActionCount++;
  }
 
  const QList<QgsMapLayerAction *> mapLayerActions = QgsGui::mapLayerActionRegistry()->mapLayerActions( mLayer, Qgis::MapLayerActionTarget::SingleFeature, mContextGenerator ? mContextGenerator->createActionContext() : QgsMapLayerActionContext() );
 
  if ( !mapLayerActions.isEmpty() )
  {
    //add a separator between user defined and standard actions
    if ( mVisibleActionCount > 0 )
      addSeparator();
 
    for ( int i = 0; i < mapLayerActions.size(); ++i )
    {
      QgsMapLayerAction *mapLayerAction = mapLayerActions.at( i );
 
      if ( mapLayerAction->isEnabledOnlyWhenEditable() && ( mMode == QgsAttributeEditorContext::AddFeatureMode || mMode == QgsAttributeEditorContext::IdentifyMode ) )
        continue;
 
      QAction *qAction = new QAction( mapLayerAction->icon(), mapLayerAction->text(), this );
      qAction->setData( QVariant::fromValue<ActionData>( ActionData( mapLayerAction, mFeatureId, mLayer ) ) );
      addAction( qAction );
      connect( qAction, &QAction::triggered, this, &QgsActionMenu::triggerAction );
      mVisibleActionCount++;
    }
  }
 
  emit reinit();
}
 
void QgsActionMenu::layerWillBeDeleted()
{
  // here we are just making sure that we are not going to have reloadActions() called again
  // with a dangling pointer to a layer when actions get removed on QGIS exit
  clear();
  mLayer = nullptr;
  disconnect( QgsGui::mapLayerActionRegistry(), &QgsMapLayerActionRegistry::changed, this, &QgsActionMenu::reloadActions );
}
 
 
QgsActionMenu::ActionData::ActionData( QgsMapLayerAction *action, QgsFeatureId featureId, QgsMapLayer *mapLayer )
  : actionType( Qgis::ActionType::MapLayerAction )
  , actionData( QVariant::fromValue<QgsMapLayerAction *>( action ) )
  , featureId( featureId )
  , mapLayer( mapLayer )
{}
 
 
QgsActionMenu::ActionData::ActionData( const QgsAction &action, QgsFeatureId featureId, QgsMapLayer *mapLayer )
  : actionType( Qgis::ActionType::AttributeAction )
  , actionData( QVariant::fromValue<QgsAction>( action ) )
  , featureId( featureId )
  , mapLayer( mapLayer )
{}
 
 
void QgsActionMenu::setExpressionContextScope( const QgsExpressionContextScope &scope )
{
  mExpressionContextScope = scope;
  reloadActions();
}
 
QgsExpressionContextScope QgsActionMenu::expressionContextScope() const
{
  return mExpressionContextScope;
}
 
QList<QgsAction> QgsActionMenu::menuActions() const
{
  return mActions;
}
 
bool QgsActionMenu::isEmpty() const
{
  return mVisibleActionCount == 0;
}