26#include "moc_qgsactionmanager.cpp"
40#include <QDesktopServices>
43#include <QRegularExpression>
70 if ( !mOnNotifyConnected )
74 mOnNotifyConnected =
true;
79void QgsActionManager::onNotifyRunActions(
const QString &message )
81 for (
const QgsAction &act : std::as_const( mActions ) )
83 if ( !act.notificationMessage().isEmpty() && QRegularExpression( act.notificationMessage() ).match( message ).hasMatch() )
85 if ( !act.isValid() || !act.runable() )
95 if ( expandedAction.isEmpty() )
97 runAction(
QgsAction( act.type(), act.name(), expandedAction, act.capture() ) );
109 mActions.removeAt( i );
115 if ( mOnNotifyConnected )
117 bool hasActionOnNotify =
false;
120 if ( !hasActionOnNotify && mLayer && mLayer->
dataProvider() )
125 mOnNotifyConnected =
false;
135 if ( defaultValueIndex >= 0 && defaultValueIndex < feature.
fields().
size() )
138 context << actionScope;
139 doAction( actionId, feature, context );
156 if ( expandedAction.isEmpty() )
160 runAction( newAction );
166 if ( mOnNotifyConnected && mLayer && mLayer->
dataProvider() )
171 mOnNotifyConnected =
false;
177 if ( actionScope.isNull() )
193void QgsActionManager::runAction(
const QgsAction &action )
200 if ( finfo.exists() && finfo.isFile() )
201 QDesktopServices::openUrl( QUrl::fromLocalFile(
action.
command() ) );
203 QDesktopServices::openUrl( QUrl(
action.
command(), QUrl::TolerantMode ) );
239 QDomElement aActions = layer_node.ownerDocument().createElement( QStringLiteral(
"attributeactions" ) );
242 QDomElement defaultActionElement = layer_node.ownerDocument().createElement( QStringLiteral(
"defaultAction" ) );
243 defaultActionElement.setAttribute( QStringLiteral(
"key" ),
defaultAction.key() );
244 defaultActionElement.setAttribute( QStringLiteral(
"value" ),
defaultAction.value().toString() );
245 aActions.appendChild( defaultActionElement );
252 layer_node.appendChild( aActions );
261 QDomNode aaNode = layer_node.namedItem( QStringLiteral(
"attributeactions" ) );
263 if ( !aaNode.isNull() )
265 QDomNodeList actionsettings = aaNode.toElement().elementsByTagName( QStringLiteral(
"actionsetting" ) );
266 for (
int i = 0; i < actionsettings.size(); ++i )
273 QDomNodeList defaultActionNodes = aaNode.toElement().elementsByTagName( QStringLiteral(
"defaultAction" ) );
275 for (
int i = 0; i < defaultActionNodes.size(); ++i )
277 QDomElement defaultValueElem = defaultActionNodes.at( i ).toElement();
278 mDefaultActions.insert( defaultValueElem.attribute( QStringLiteral(
"key" ) ), QUuid( defaultValueElem.attribute( QStringLiteral(
"value" ) ) ) );
308 mDefaultActions[ actionScope ] = actionId;
313 return action( mDefaultActions.value( actionScope ) );
AttributeActionType
Attribute action types.
@ OpenUrl
Open URL action.
@ SubmitUrlMultipart
POST data to an URL using "multipart/form-data".
@ Windows
Windows specific.
@ SubmitUrlEncoded
POST data to an URL, using "application/x-www-form-urlencoded" or "application/json" if the body is v...
void removeAction(QUuid actionId)
Remove an action by its id.
bool writeXml(QDomNode &layer_node) const
Writes the actions out in XML format.
QList< QgsAction > actions(const QString &actionScope=QString()) const
Returns a list of actions that are available in the given action scope.
void doAction(QUuid actionId, const QgsFeature &feature, int defaultValueIndex=0, const QgsExpressionContextScope &scope=QgsExpressionContextScope())
Does the given action.
void clearActions()
Removes all actions.
QUuid addAction(Qgis::AttributeActionType type, const QString &name, const QString &command, bool capture=false)
Add an action with the given name and action details.
void setDefaultAction(const QString &actionScope, QUuid actionId)
Each scope can have a default action.
QgsActionManager(QgsVectorLayer *layer)
Constructor.
QgsAction defaultAction(const QString &actionScope)
Each scope can have a default action.
bool readXml(const QDomNode &layer_node)
Reads the actions in in XML format.
QgsAction action(QUuid id) const
Gets an action by its id.
Utility class that encapsulates an action based on vector attributes.
QString notificationMessage() const
Returns the notification message that triggers the action.
QString name() const
The name of the action. This may be a longer description.
QSet< QString > actionScopes() const
The action scopes define where an action will be available.
Qgis::AttributeActionType type() const
The action type.
void readXml(const QDomNode &actionNode)
Reads an XML definition from actionNode into this object.
void run(QgsVectorLayer *layer, const QgsFeature &feature, const QgsExpressionContext &expressionContext) const
Run this action.
bool runable() const
Checks if the action is runable on the current platform.
bool isValid() const
Returns true if this action was a default constructed one.
QString command() const
Returns the command that is executed by this action.
bool capture() const
Whether to capture output for display when this action is run.
void writeXml(QDomNode &actionsNode) const
Appends an XML definition for this action as a new child node to actionsNode.
QUuid id() const
Returns a unique id for this action.
virtual void setListening(bool isListening)
Set whether the provider will listen to datasource notifications If set, the provider will issue noti...
void notify(const QString &msg)
Emitted when the datasource issues a notification.
Single scope for storing variables and functions for use within a QgsExpressionContext.
void addVariable(const QgsExpressionContextScope::StaticVariable &variable)
Adds a variable into the context scope.
static QgsExpressionContextScope * notificationScope(const QString &message=QString())
Creates a new scope which contains variables and functions relating to provider notifications.
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
static QString replaceExpressionText(const QString &action, const QgsExpressionContext *context, const QgsDistanceArea *distanceArea=nullptr)
This function replaces each expression between [% and %] in the string with the result of its evaluat...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
int size() const
Returns number of items.
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
static QgsProject * instance()
Returns the QgsProject singleton instance.
static QgsRunProcess * create(const QString &action, bool capture)
Represents a vector layer which manages a vector based data sets.
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
#define QgsDebugMsgLevel(str, level)
Single variable definition for use within a QgsExpressionContextScope.