"Error: Unknown condition" in Rule for custom inline condition [#2066205]

I am trying to define a custom inline condition on the commerce_line_item entity that will apply a product discount if an authenticated user has a given role.

The inline form defined in the _configure callback function appears to works fine. However, when I look at the actual rule, I am getting this error on the conditions: Error: Unknown condition order_owner_has_role. (see attached screen cap)

I can't put my finger on what is missing that will get the inline condition to be recognized by the Rule. I based my code on documentation in the API and the examples provided through commerce_order.inline_conditions.inc and commerce_product.inline_conditions.inc

My module is called kcm_commerce_discount and the complete code in kcm_commerce_discount.inline_conditions.inc is presented below.

Please note: the order_owner_has_role_build function is a stub function and I haven't coded the actual logic yet. For now it just returns true

See attached screen caps for discount form and Rules

/**
* Implements hook_inline_conditions_info().
*/
function kcm_commerce_discount_inline_conditions_info() {
  $conditions = array();

  $conditions['order_owner_has_role'] = array(
    'label' => t('Role'),
    'entity type' => 'commerce_line_item',
    'callbacks' => array(
      'configure' => 'order_owner_has_role_configure',
      'build' => 'order_owner_has_role_build',
    ),
  );
  return $conditions;
}

/**
 * Configuration callback for order_owner_has_role.
 *
 * @param array $settings
 *   An array of rules condition settings.
 *
 * @return array;
 *   A form element array.
 */
function order_owner_has_role_configure($settings) {
  $form = array();
  $default_value = '';

  if (!empty($settings)) {
    $default_value = $settings['role'] != '' ? $settings['role'] : '';
  }

  $form['role'] = array(
    '#type' => 'select',
    '#title' => t('Role'),
    '#title_display' => 'invisible',
    '#options' => user_roles(true),
    '#default_value' => $default_value,
    '#required' => TRUE,
    '#suffix' => '<div class="condition-instructions">' . t('Discount is active if the order owner has the selected role.') . '</div>',
  );
  return $form;
}

/**
 * Build callback for order_owner_has_role.
 *
 * @param EntityDrupalWrapper $wrapper
 *   The wrapped entity given by the rule.
 * @param array $account
 *   A fully loaded drupal user.
 *
 * @return bool
 *   Returns true if condition is valid. false otherwise.
 */
function order_owner_has_role_build(EntityDrupalWrapper $wrapper, $role) {
  $has_role = FALSE;
  $tests = TRUE;

  // Do stuff to test condition. 
  if ($tests) {
    $has_role = TRUE;
  }
  return $has_role;
}

Thanks for your help.

Comment	File	Size	Author
#16	inline_conditions-new_rules_conditions_implementation-2066205-16.patch	55.99 KB	jkuma
#16
#14	inline_conditions-new_rules_conditions_implementation-2066205-14.patch	56.4 KB	jkuma
#14
#13	inline_conditions-new_rules_conditions_implementation-2066205-12.patch	29.08 KB	jkuma
#13
#11	inline_conditions-new_rules_conditions_implementation-2066205-10.patch	55.27 KB	jkuma
#11
#10	inline_conditions-new_rules_conditions_implementation-2066205-10.patch	55.27 KB	jkuma
#10
#4	inline_conditions-custom_inline_conditions-2066205-4.patch	1.23 KB	jkuma
#4
	Selection_060.png	42.96 KB	vuzzbox
	Selection_059.png	13.07 KB	vuzzbox

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

vuzzbox CreditAttribution: vuzzbox commented 16 August 2013 at 01:24

I believe I found a solution to my own problem.

I called hook_rules_condition_info_alter to define the parameters for the inline condition and now the Rule recognizes my custom inline condition and it is tested when the associated event fires.

From the documentation I read, I thought the inline_conditions module itself would have altered the conditions for the Rule itself, but I guess not.

Although I saw the call to this hook in the two sub-modules included with inline_conditions module, which I was referencing as examples, it took me some time to figure out that I needed to call the hook, too, because it didn't actually get called (and have any effect) until I put it into my .module file. Not sure why the hooks are recognized in the .inline_conditions.inc files in the two sub-modules, but not in my .inline_conditions.inc file. Is this by design?

In any event, for anyone else who is trying to define their own inline_conditions, here's the last piece of my puzzle (put it in your .module file):

/**
 * Implements hook_rules_condition_info_alter().
 *
 * Adds new rule conditions to commerce_line_item entity type.
 */
function kcm_commerce_discount_rules_condition_info_alter(&$conditions) {
  $inline_conditions = inline_conditions_get_info();

  $conditions['order_owner_has_role'] = array(
    'label' => t('Order owner has role'),
    'parameter' => array(
      'commerce_line_item' => array(
        'type' => 'commerce_line_item',
        'label' => t('Line Item'),
        'description' => t('A product line item.'),
        'wrapped' => TRUE,
      ),
      'role' => array(
        'type' => 'text',
        'label' => t('Role'),
        'description' => t('Role.'),
      ),
    ),
    'module' => 'kcm_commerce_discount',
    'group' => t('Commerce Order'),
    'callbacks' => array(
      'execute' => $inline_conditions['order_owner_has_role']['callbacks']['build'],
    ),
  );
}

Comment #2

vuzzbox CreditAttribution: vuzzbox commented 16 August 2013 at 01:37

And just for reference, here's the complete order_owner_has_role_build function:

/**
 * Build callback for order_owner_has_role.
 *
 * @param EntityDrupalWrapper $line_item_wrapper
 *   The wrapped entity given by the rule.
 * @param integer $role
 *   role id 
 *
 * @return bool
 *   Returns true if condition is valid. false otherwise.
 */
function order_owner_has_role_build(EntityDrupalWrapper $line_item_wrapper, $role) {
  module_load_include('module','commerce_order', 'commerce_order');
  if ($order = commerce_order_load($line_item_wrapper->order_id->value())) {
    if ($user = user_load($order->uid)) {
      if ($user->roles[$role]) {
        return TRUE;
      }
    }
  }
  return FALSE;
}

Comment #3

jkuma CreditAttribution: jkuma commented 31 October 2013 at 11:27

Status:

Active

» Needs work

Hello vuzzbox,

Thanks for your various posts here, indeed there is a bug that doesn't allow other modules to add theirs conditions in a .inline_conditions file. I'll soon post patch to fix that.

Comment #4

jkuma CreditAttribution: jkuma commented 31 October 2013 at 11:29

Status:

Needs work

» Needs review

File	Size
inline_conditions-custom_inline_conditions-2066205-4.patch	1.23 KB

Here is the patch attached.

Comment #5

jkuma CreditAttribution: jkuma commented 31 October 2013 at 11:31

Status:

Needs review

» Reviewed & tested by the community

Comment #6

jkuma CreditAttribution: jkuma commented 31 October 2013 at 11:32

Status:

Reviewed & tested by the community

» Closed (fixed)

Committed in 7.x-1.x branch.

Comment #7

roderik

Dutch

Amsterdam,NL / Budapest,HU

CreditAttribution: roderik commented 3 November 2013 at 14:17

I request you revise this.

The reason comes down to: you are not allowed to call any hook, in code that is immediately executed when including a .module file. This is not properly documented anywhere, but it's very true.

For details, look at the current code execution tree:

_drupal_bootstrap_full()
module_load_all() ... does drupal_load('module', $module) in a loop
your code at the beginning of inline_conditions.module
inline_conditions_get_info_by_module() -> inline_conditions_get_info()
module_implements()...and if the database row 'cache_bootstrap > module_implements' does not have the 'inline_conditions_info' data:
module_hook_info() ...and if the database row 'cache_bootstrap > hook_info' is not present:

module_hook_info() does a simple check on function_exists( {$module}_hook_info )

... and will not find and execute any {$module}_hook_info() for .module files that were not loaded yet, by module_load_all(). So it will cache incomplete 'cache_bootstrap > hook_info' data, with unpredictable effects for your site. (Semi-random hook implementations for semi-random modules will never be executed.)

This is probably the cause for #2125459: Node title and other fields disappeared (and the reason you can't reproduce things. You can try "DELETE FROM cache_bootstrap WHERE cid IN ('module_implements', 'hook_info')" but the effect may not be the same on your site.)

Comment #8

roderik

Dutch

Amsterdam,NL / Budapest,HU

CreditAttribution: roderik commented 3 November 2013 at 14:22

Issue summary:	View changes
Status:	Closed (fixed)	» Needs work

btw: see #496170: module_implements() cache can be polluted by module_invoke_all() being called (in)directly prior to full bootstrap completion and related for more about this issue. It's kinda been known for ages but never fixed.

Comment #9

jkuma CreditAttribution: jkuma commented 3 November 2013 at 21:01

Roderic, Thank you so much for your really useful comments on this issue. I'll fix that by tomorrow.

Comment #10

jkuma CreditAttribution: jkuma commented 4 November 2013 at 14:19

Assigned:	Unassigned	» jkuma
Status:	Needs work	» Needs review

File	Size
inline_conditions-new_rules_conditions_implementation-2066205-10.patch	55.27 KB

Hello roderik,

I've removed the plain php code at the top of inline conditions.module and also I've refactored the custom conditions exposed by IC. Indeed, only inline conditions info and configure callbacks are now placed in the .inline_conditions.inc file. The rules conditions are located in the .rules.inc file which makes more sense from my perspective.

I'll write a complete documentation on how to declare properly new inline conditions on the module page. Please tell me if the patch is working for you.

Comment #11

jkuma CreditAttribution: jkuma commented 5 November 2013 at 16:38

File	Size
inline_conditions-new_rules_conditions_implementation-2066205-10.patch	55.27 KB

Forgot to move some validate functions and fix a bug with the inline_condition widget form cache.

Comment #12

jkuma CreditAttribution: jkuma commented 5 November 2013 at 16:41

1 file was hidden/shown/deleted

File	Size
inline_conditions-new_rules_conditions_implementation-2066205-10.patch	55.27 KB

Comment #13

jkuma CreditAttribution: jkuma commented 5 November 2013 at 16:42

File	Size
inline_conditions-new_rules_conditions_implementation-2066205-12.patch	29.08 KB

Comment #14

jkuma CreditAttribution: jkuma commented 6 November 2013 at 09:16

File	Size
inline_conditions-new_rules_conditions_implementation-2066205-14.patch	56.4 KB

Final patch.

Comment #15

6 November 2013 at 09:24

Status:

Needs review

» Needs work

The last submitted patch, 14: inline_conditions-new_rules_conditions_implementation-2066205-14.patch, failed testing.

Comment #16

jkuma CreditAttribution: jkuma commented 6 November 2013 at 09:30

Status:

Needs work

» Needs review

File	Size
inline_conditions-new_rules_conditions_implementation-2066205-16.patch	55.99 KB

I hope this one will pass the tests.

Comment #17

jkuma CreditAttribution: jkuma commented 6 November 2013 at 10:16

Priority:

Normal

» Critical

Comment #18

jkuma CreditAttribution: jkuma commented 6 November 2013 at 15:47

Status:

Needs review

» Closed (fixed)

Hello,

I'm closing this post because I've tagged a new alpha version of IC. This version came with the patch above and fix a lot of errors raised by drupal users.

Feel free to reopen it if you are still encountering errors with inline conditions.

Comment #19

jkuma CreditAttribution: jkuma commented 6 November 2013 at 15:54

Status:

Closed (fixed)

» Fixed

Comment #20

roderik

Dutch

Amsterdam,NL / Budapest,HU

CreditAttribution: roderik commented 15 November 2013 at 02:17

Sorry, I somehow managed to miss the followup to this issue.

Thanks for rescuing a.o. me and getting a new release out the door so quickly!

I will report if I see anything weird, but trust that I won't.
I can't really comment on your code because I don't know the detailed functionality of this module. I just installed it as a dependency for commerce_coupon 2.x, and then started to see the same strange behavior that my site gave 2 months ago -- so I compiled that 'stack trace' in #7 without further knowledge/suggestions for fixing.

Comment #21

20 November 2013 at 15:58

Status:

Fixed

» Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

Comment #22

ikigeg CreditAttribution: ikigeg commented 2 March 2015 at 15:16

I realise this has been marked as closed, but I was having the same difficulty as outlined in https://www.drupal.org/node/2066753 (which was redirected to this post) even though I was running with the latest version. I even installed the dev version, but for the life of me, the .inline_conditions.inc would not be used beyond the initial page load following a flushing of the cache. A quick fix, which works wonderfully, is just to add the following line to the main .module file:

module_load_include('inc', 'my_module', 'my_module.inline_conditions');

It may very well turn out to be something odd I had done, but this works well enough.