add support for rules
| Project: | Views Bulk Operations (VBO) |
| Version: | 6.x-1.x-dev |
| Component: | Code |
| Category: | feature request |
| Priority: | normal |
| Assigned: | kratib |
| Status: | needs work |
| Issue tags: | rules integration |
http://drupal.org/project/rules
It would be really nice to have support to execute any "rule set" instead of an action or operation. Rule sets can be created by users, and may contain multiple rules. So this would allow users not only to execute any by rules supported action (e.g. populate a cck field) to be used with vbo but also to execute them only conditionally!
Executing a rule set is as simple as calling
<? php
rules_invoke_rule_set('set_name', arg1, arg2);
//e.g.
rules_invoke_rule_set('publish_node', $node);
?>
To get information about all available rule sets just call
<?php
rules_get_configured_items('rule_sets')
?>I also plan to add a mapping from rule data types to views base tables to rules - similar as your hook_object_info(). However it's not there yet. However if it's needed, I got give it priority and add it asap.
#1
Thanks for the interesting suggestion. I'll work on it in the near future.
#2
Here's a simple solution for this feature: export each ruleset as an action that VBO can readily consume. Attached is a file that does this, if you would like to incorporate it in your module that would be great. Otherwise, I can host it in my module, although it will be tightly coupled to your ruleset data structure.
Note that you'll need the latest 6.x-1.x-dev release (that I just checked in) for this to work properly.
#3
I added this file in the VBO directory but any action created with rules appear in vbo style plugin ! and it create a callback warning error .
This issues is very interesting ! :-)
Merci !
Sorry for my english .
#4
#5
@servicedevis: Please don't change the title of the issue :-) As for your comment:
* The point of this file is to show rulesets, not rules, as part of the available VBO operations.
* What's the callback message you get? Is it a warning , or an error?
#6
cool!
However you accidentally implement hook_rules_action_info() for vbo - so best we should rename the function a bit to avoid troubles.
#7
Subscribe for later testing.
#8
@fago: please let me know if you'd like to integrate this code (after suitable modifications) to your module. Otherwise I'll just bundle it in VBO.
#9
@Kratib,
It should be bundled with VBO (as CCK and OG did with their integration).
Having this feature in VBO is very cool :)
#10
As amitaibu said, it should be bundled with vbo. Indeed this feature is really cool :)
#11
Hm, the actions provided by vbo have troubles with rules: #372114: Crash with "Modifying node's taxonomy terms"
What about adding some code directly into .rules.inc that includes the action includes of vbo? So once .rules.inc gets included, it would automatically include the actions includes and everything should work.
#12
I don't understand the relationship between invoking an action from a rule, and including VBO actions inside the rules.inc file. Does the rules.inc file automatically get loaded when a rule fires?
#13
ok !
It's a warning message.
#14
The latest VBO 6.x-1.x-dev contains support for rules as specified above.
@fago, I'm marking this issue as fixed and please feel free to open a new issue concerning the ability of calling VBO actions from within rules.
#15
ok, see #383852: Using vbo actions with rules
#16
Automatically closed -- issue fixed for 2 weeks with no activity.
#17
Hi everybody,
Is it complicate to add the $user as second argument ?
The benefit of this will be great ...
Allowing only one argument limit the power of the rules (more php rules, less built-in rules)...
#18
Second argument to which function?
#19
Sorry,
I mean a second parameter,
The user as second parameter for the ruleset...
#20
I still don't understand what you mean. Here's what happens on the VBO side:
* The user selects a few objects (nodes, users) that are shown in the view
* The user chooses to execute one of the rule_set actions
* For each selected object, VBO calls the rule_set action by calling
rules_invoke_rule_set()and passing it the objectIf the objects are nodes, where are the users that you are referring to?
If you mean that VBO should be able to invoke rule_sets for users, that is possible today by creating a VBO of type User. Then, any rule_set that is declared to act on users (i.e. where the rule_set has one argument whose type = 'User') will be available for that VBO.
Currently, the rule_set action does not handle rule_sets with more than one argument. This is because the action would not know what to pass as values for the remaining arguments. Do you have a suggestion on how this situation could be handled?
#21
Hi ,Kratib,
thanks for your fast ansers,
I was talking about the "global $user"...
Im trying to do something like that:
<?php
>
<?php
function views_bulk_operations_ruleset_action_info() {
if (!module_exists('rules')) return array();
$actions = array();
foreach (rules_get_configured_items('rule_sets') as $ruleset_key => $ruleset) {
if (count($ruleset['arguments']) == 2) { // For now, we only accept rulesets with one parameter (taken to be the 'type')
$arg = key(current($ruleset['arguments']));
$arg1 = key(current($ruleset['arguments']));
$arg2 = key(next($ruleset['arguments']));
$actions["views_bulk_operations_ruleset_action_{$ruleset_key}"] = array(
'type' => $ruleset['arguments'][$arg]['type'],
'parameters' => array('ruleset' => $ruleset_key),
'description' => $ruleset['label'],
'configurable' => FALSE,
'rules_ignore' => TRUE,
);
eval(<<<EOS
if (!function_exists('views_bulk_operations_ruleset_action_{$ruleset_key}')) {
function views_bulk_operations_ruleset_action_{$ruleset_key}(&\$object, \$context) {
global \$user;
rules_invoke_rule_set(\$context['ruleset'], \$object, \$user);
}
}
EOS
);
}
}
return $actions;
}
?>
This should allow to make more condition in the rules such as "if the current user has a certain role..." etc ...
#22
@kratib,
Rules sets accept pre-defined arguments (node, user, number, etc'). If you pass more arguments chances are you are able trigger more rule sets. So even if you pass a node, passing a user argument will allow you for example to flag (using flag module) that node in the name of the user.
@dimiduj,
THe question is which user should be passed - The acting user? The content author? I would answer the acting user - simply because it's a simple
global $user.#23
I'm working on it with the global user...
Actually the code looks like
If there are two parameter it test if the second is of type user...
And it seems to work fine ...
<?php
<?php
function views_bulk_operations_ruleset_action_info() {
if (!module_exists('rules')) return array();
$actions = array();
foreach (rules_get_configured_items('rule_sets') as $ruleset_key => $ruleset) {
if (count($ruleset['arguments']) <= 1) { // For now, we only accept rulesets with one parameter (taken to be the 'type')
$arg = key($ruleset['arguments']);
// $arg1 = key(current($ruleset['arguments']));
// $arg2 = key(next($ruleset['arguments']));
$actions["views_bulk_operations_ruleset_action_{$ruleset_key}"] = array(
'type' => $ruleset['arguments'][$arg]['type'],
'parameters' => array('ruleset' => $ruleset_key),
'description' => $ruleset['label'],
'configurable' => FALSE,
'rules_ignore' => TRUE,
);
eval(<<<EOS
if (!function_exists('views_bulk_operations_ruleset_action_{$ruleset_key}')) {
function views_bulk_operations_ruleset_action_{$ruleset_key}(&\$object, \$context) {
rules_invoke_rule_set(\$context['ruleset'], \$object);
}
}
EOS
);
}
if (count($ruleset['arguments']) == 2) {
$arg = key($ruleset['arguments']);
$arg2=next($ruleset["arguments"]);
if($arg2['type']=='user'){
$actions["views_bulk_operations_ruleset_action_{$ruleset_key}"] = array(
'type' => $ruleset['arguments'][$arg]['type'],
'parameters' => array('ruleset' => $ruleset_key),
'description' => $ruleset['label'],
'configurable' => FALSE,
'rules_ignore' => TRUE,
);
eval(<<<EOS
if (!function_exists('views_bulk_operations_ruleset_action_{$ruleset_key}')) {
function views_bulk_operations_ruleset_action_{$ruleset_key}(&\$object, \$context) {
global \$user;
rules_invoke_rule_set(\$context['ruleset'], \$object,\$user);
}
}
EOS
);
}
}
}
return $actions;
}
?>
#24
Hi,
I provide a patch,
I don't know if i can/should change the status of the post ...?
#25
Thanks for the patch. I'm still thinking about the generality of this solution so don't expect the patch to be committed very soon.
#26
No matter...
I'm agree with you that it 's a little tricky...