You are here

Home » API reference » Rules 6

rules_admin.module in Rules 6

Same filename and directory in other branches
  1. 7.2 rules_admin/rules_admin.module

Rules administration UI

Only hook implementations should be inside the .module file.

File

rules_admin/rules_admin.module
View source 
<?php

/**
 * @file Rules administration UI
 *
 * Only hook implementations should be inside the .module file.
 */

// Defines paths of the admin interface
define('RULES_ADMIN_PATH', 'admin/rules');
define('RULES_ADMIN_TRIGGER_PATH', RULES_ADMIN_PATH . '/trigger');
define('RULES_ADMIN_SET_PATH', RULES_ADMIN_PATH . '/rule_sets');
define('RULES_ADMIN_RULE_PATH', RULES_ADMIN_PATH . '/rules');

/**
 * Implementation of hook_help().
 */
function rules_help($path, $arg) {
  switch ($path) {
    case RULES_ADMIN_SET_PATH:
      return '<p>' . t('Rule sets are similar in concept to subroutines and can be invoked by actions or manually by code or another module.') . '</p>';
    case RULES_ADMIN_TRIGGER_PATH:
      return '<p>' . t('This is an overview about rules that are triggered by a certain event. A rule may contain conditions and actions, which are executed only when the conditions are met.') . '</p>';
  }
}

/**
 * Implementation of hook_menu().
 */
function rules_admin_menu() {
  $items = array();
  $items[RULES_ADMIN_PATH] = array(
    'title' => 'Rules',
    'description' => 'Rules administration links.',
    'position' => 'right',
    'weight' => 5,
    'page callback' => 'system_admin_menu_block_page',
    'access arguments' => array(
      'administer rules',
    ),
    'file' => 'system.admin.inc',
    'file path' => drupal_get_path('module', 'system'),
  );
  $items[RULES_ADMIN_PATH . '/autocomplete'] = array(
    'page callback' => 'rules_admin_categories_autocomplete',
    'access arguments' => array(
      'administer rules',
    ),
    'type' => MENU_CALLBACK,
    'file' => 'rules_admin.rule_forms.inc',
  );
  $items[RULES_ADMIN_TRIGGER_PATH] = array(
    'title' => 'Triggered rules',
    'description' => 'Customize your site by configuring rules that are evaluated on events.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_form_overview',
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'type' => MENU_NORMAL_ITEM,
    'weight' => -2,
    'file' => 'rules_admin.rule_forms.inc',
  );
  $items[RULES_ADMIN_TRIGGER_PATH . '/list'] = array(
    'title' => 'Overview',
    'weight' => -5,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items[RULES_ADMIN_TRIGGER_PATH . '/add'] = array(
    'title' => 'Add a new rule',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_form_add_rule',
      FALSE,
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'file' => 'rules_admin.rule_forms.inc',
  );
  foreach (rules_get_items() as $item_type => $info) {
    $items[RULES_ADMIN_PATH . '/' . $item_type . '/%rules_item/delete'] = array(
      'title' => 'Delete',
      'type' => MENU_CALLBACK,
      'page callback' => 'drupal_get_form',
      'page arguments' => array(
        'rules_admin_item_form_delete',
        2,
        3,
      ),
      'access arguments' => array(
        'administer rules',
      ),
      'load arguments' => array(
        2,
      ),
      'file' => 'rules_admin.sets.inc',
    );
    $items[RULES_ADMIN_PATH . '/' . $item_type . '/%rules_item/revert'] = array(
      'title' => 'Revert',
      'type' => MENU_CALLBACK,
      'page callback' => 'drupal_get_form',
      'page arguments' => array(
        'rules_admin_item_form_revert',
        2,
        3,
      ),
      'access arguments' => array(
        'administer rules',
      ),
      'load arguments' => array(
        2,
      ),
      'file' => 'rules_admin.sets.inc',
    );
  }
  $items[RULES_ADMIN_PATH . '/ie'] = array(
    'title' => 'Import / Export',
    'description' => 'Export your rules as text or import rules.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_form_export',
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'file' => 'rules_admin.export.inc',
    'weight' => 5,
    'type' => MENU_NORMAL_ITEM,
  );
  $items[RULES_ADMIN_PATH . '/ie/export'] = array(
    'title' => 'Export',
    'weight' => 0,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items[RULES_ADMIN_PATH . '/ie/import'] = array(
    'title' => 'Import',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_form_import',
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'weight' => 7,
    'type' => MENU_LOCAL_TASK,
    'file' => 'rules_admin.export.inc',
  );
  $items[RULES_ADMIN_PATH . '/settings'] = array(
    'title' => 'Settings',
    'description' => 'Set display options, show/hide Rules messages.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_settings',
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'file' => 'rules_admin.rule_forms.inc',
    'weight' => 7,
    'type' => MENU_NORMAL_ITEM,
  );

  //paths for modifing rules
  $items[RULES_ADMIN_RULE_PATH . '/%rule'] = array(
    'title callback' => 'rules_admin_rule_title',
    'title arguments' => array(
      'Editing rule @label',
      3,
    ),
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_form_edit_rule',
      3,
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'file' => 'rules_admin.rule_forms.inc',
  );
  $items[RULES_ADMIN_RULE_PATH . '/%rule/add'] = array(
    'title' => 'Add',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_form_add',
      3,
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'file' => 'rules_admin.rule_forms.inc',
  );
  $items[RULES_ADMIN_RULE_PATH . '/%rule/edit/%rule_element'] = array(
    'title' => 'Edit',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_form_edit',
      3,
      5,
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'load arguments' => array(
      3,
    ),
    'file' => 'rules_admin.rule_forms.inc',
  );
  $items[RULES_ADMIN_RULE_PATH . '/%rule/delete/%rule_element'] = array(
    'title' => 'Delete',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_form_delete',
      3,
      5,
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'load arguments' => array(
      3,
    ),
    'file' => 'rules_admin.rule_forms.inc',
  );
  $items[RULES_ADMIN_RULE_PATH . '/%rule/clone'] = array(
    'title' => 'Clone rule',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_form_clone',
      3,
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'file' => 'rules_admin.rule_forms.inc',
  );
  $items[RULES_ADMIN_SET_PATH] = array(
    'title' => 'Rule sets',
    'description' => 'Create and manage rule sets.',
    'page callback' => 'rules_admin_sets_overview',
    'access arguments' => array(
      'administer rules',
    ),
    'type' => MENU_NORMAL_ITEM,
    'weight' => 0,
    'file' => 'rules_admin.sets.inc',
  );
  $items[RULES_ADMIN_SET_PATH . '/list'] = array(
    'title' => 'Overview',
    'weight' => -5,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items[RULES_ADMIN_SET_PATH . '/add'] = array(
    'title' => 'Add a new rule set',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_form_add_rule_set',
      2,
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'file' => 'rules_admin.sets.inc',
    'weight' => 3,
  );
  $items[RULES_ADMIN_SET_PATH . '/js'] = array(
    'type' => MENU_CALLBACK,
    'page callback' => 'rules_admin_form_js',
    'page arguments' => array(
      'rules_admin_form_add_rule_set_add_arguments',
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'file' => 'rules_admin.sets.inc',
  );
  $items[RULES_ADMIN_SET_PATH . '/%rules_item'] = array(
    'type' => MENU_CALLBACK,
    'title callback' => 'rules_admin_item_title',
    'title arguments' => array(
      3,
    ),
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_form_edit_rule_set',
      3,
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'load arguments' => array(
      2,
    ),
    'file' => 'rules_admin.sets.inc',
  );
  $items[RULES_ADMIN_SET_PATH . '/%rules_item/list'] = array(
    'title' => 'Overview',
    'weight' => -5,
    'load arguments' => array(
      2,
    ),
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items[RULES_ADMIN_SET_PATH . '/%rules_item/add'] = array(
    'title' => 'Add a new rule',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'rules_admin_form_add_rule',
      3,
    ),
    'access arguments' => array(
      'administer rules',
    ),
    'load arguments' => array(
      2,
    ),
    'file' => 'rules_admin.rule_forms.inc',
  );
  return $items;
}

/**
 * Loads the admin proxy of the rule with the given name
 */
function rule_load($name) {
  static $proxies = array();
  if (!isset($proxies[$name])) {
    $proxies[$name] = FALSE;
    $rules = rules_get_configured_items('rules');

    // Let's make sure the #set actually exists
    if (isset($rules[$name]) && rules_get_rule_sets($rules[$name]['#set'])) {
      rules_include('rules_admin');
      $proxies[$name] = new rules_admin_rule_proxy($name, $rules[$name]);
      rules_admin_fix_breadcrumb($rules[$name], $name);
    }
  }
  return $proxies[$name];
}
function rule_element_load($id, $rule_name) {
  $proxy = rule_load($rule_name);
  $element = $proxy
    ->get_element($id);
  return is_array($element) ? $element + array(
    '#id' => intval($id),
  ) : FALSE;
}
function rules_admin_rule_title($text, $proxy) {
  $rule = $proxy
    ->get_rule();
  return t($text, array(
    '@label' => $rule['#label'],
  ));
}

/**
 * Validate the machine name.
 */
function rules_admin_validate_machine_name($item_type, $element_name, $machine_name) {

  // Check that the machine name is valid. We only
  if (!preg_match('/^[a-z][a-z0-9_]*$/', $machine_name)) {
    form_set_error($element_name, t('Machine name must be alphanumeric and underscores only, and the first character must be a lower case letter.'));
    return;
  }

  // Fetch information about table.
  $info = rules_get_items($item_type);

  // Check that the machine name doesn't exist.
  $count = db_result(db_query("SELECT COUNT(*) FROM {" . $info['db_table'] . "} WHERE name = '%s'", 'rules_' . $machine_name));
  if ($count) {
    form_set_error($element_name, t('The given machine name already exists.'));
  }
}
function rules_item_load($name, $item_type) {
  $items = rules_get_configured_items($item_type);
  if (!isset($items[$name])) {
    return FALSE;
  }
  return $items[$name] + array(
    'name' => $name,
  );
}
function rules_admin_item_title($item) {
  return check_plain(rules_get_element_label($item));
}

/**
 * Implementation of hook_perm().
 */
function rules_admin_perm() {
  return array(
    'administer rules',
  );
}

/**
 * Implementation of hook_theme()
 */
function rules_admin_theme() {
  foreach (array(
    'rules_admin_rule_render',
    'rule',
    'condition',
    'action',
    'rules_icon',
    'rules_operation',
    'OR',
    'AND',
    'rules_logical_operation_label',
  ) as $name) {
    $items[$name] = array(
      'arguments' => array(
        'elements' => NULL,
      ),
      'file' => 'rules_admin.render.inc',
    );
  }
  $items['rules_admin_form_arguments'] = array(
    'arguments' => array(
      'elements' => NULL,
    ),
    'file' => 'rules_admin.sets.inc',
  );
  $items['rules_admin_unsatisfied_elements'] = array(
    'arguments' => array(
      'element' => NULL,
    ),
    'file' => 'rules_admin.inc',
  );
  $items['rules_admin_unsatisfied_elements_group'] = array(
    'arguments' => array(
      'grouped_rules' => NULL,
      'elements' => array(),
    ),
    'file' => 'rules_admin.inc',
  );
  $items['rules_admin_unsatisfied_elements_group'] = array(
    'arguments' => array(
      'grouped_rules' => NULL,
      'elements' => array(),
    ),
    'file' => 'rules_admin.inc',
  );
  $items['rules_admin_configuration_status'] = array(
    'arguments' => array(
      'status' => NULL,
    ),
    'file' => 'rules_admin.inc',
  );
  return $items;
}

Functions

Namesort descending Description
rules_admin_item_title
rules_admin_menu Implementation of hook_menu().
rules_admin_perm Implementation of hook_perm().
rules_admin_rule_title
rules_admin_theme Implementation of hook_theme()
rules_admin_validate_machine_name Validate the machine name.
rules_help Implementation of hook_help().
rules_item_load
rule_element_load
rule_load Loads the admin proxy of the rule with the given name

Constants

Namesort descending Description
RULES_ADMIN_PATH
RULES_ADMIN_RULE_PATH
RULES_ADMIN_SET_PATH
RULES_ADMIN_TRIGGER_PATH