revisioning.rules.inc in Revisioning 8

Same filename and directory in other branches

Rules integration for Revisioning module.

File

revisioning.rules.inc

View source

<?php

/**
 * @file
 * Rules integration for Revisioning module.
 *
 * @addtogroup rules
 * @{
 */

/************************** Rules Events **************************************/

/**
 * Implements hook_rules_event_info().
 *
 * On behalf of the Revisioning module.
 */
function revisioning_rules_event_info() {
  $default = array(
    'group' => t('Revisioning'),
    'variables' => _revisioning_rules_event_variables(),
  );
  $events = array(
    'revisioning_post_update' => $default + array(
      'label' => t('Content revision has been updated'),
    ),
    'revisioning_pre_publish' => $default + array(
      'label' => t('Content revision is going to be published'),
    ),
    'revisioning_post_publish' => $default + array(
      'label' => t('Pending revision has been published'),
    ),
    'revisioning_pre_revert' => $default + array(
      'label' => t('Content is going to be reverted to revision'),
    ),
    'revisioning_post_revert' => $default + array(
      'label' => t('Content has been reverted to revision'),
    ),
    'revisioning_post_unpublish' => $default + array(
      'label' => t('Content has been unpublished'),
    ),
    'revisioning_pre_delete' => $default + array(
      'label' => t('Content revision is going to be deleted'),
    ),
  );
  return $events;
}

/**
 * Returns event variables suitable for use with a node revision event.
 *
 * (aka Data Selectors)
 */
function _revisioning_rules_event_variables() {
  $vars = array(
    'user' => array(
      'type' => 'user',
      'label' => t('acting user'),
      'description' => t('The acting user.'),
      'handler' => 'revisioning_events_argument_global_user',
    ),
    'revision' => array(
      // Type revisioning_revision' ?
      'type' => 'node',
      'label' => t('current revision of target content.'),
      'description' => t('The current content revision'),
      'handler' => 'revisioning_events_argument_current_revision',
    ),
  );
  return $vars;
}

/**
 * Get global user argument.
 */
function revisioning_events_argument_global_user($arguments, $name, $info) {
  global $user;
  return user_load($user->uid);
}

/**
 * Evaluate revision argument.
 */
function revisioning_events_argument_current_revision($arguments, $name, $info) {
  if (empty($arguments['node'])) {
    drupal_set_message(t('Revisioning: could not evaluate rule condition -- node variable missing.'), 'warning');
    return FALSE;
  }
  $node = $arguments['node'];

  // Use revisioning_get_current_node_revision_id($node->nid); ?
  $current_vid = $node->current_revision_id;
  if ($node->vid != $current_vid) {
    $current = node_load($node->nid, $current_vid);
    return $current;
  }
  return $node;
}

/**
 * Target revision author argument handler.
 *
function revisioning_events_argument_target_revision_author($arguments,
$name, $info) {
  global $user;
  $node = $arguments['node'];
  return $user; // user_load($node->revision_uid);
}

function revisioning_events_argument_node_author($arguments, $name, $info) {
  $node = $arguments['node'];
  return user_load($node->uid);
}

function revisioning_events_argument_current_revision_author($arguments, $name,
$info) {
  $node = $arguments['node'];
  $current_vid = $node->current_revision_id;
  if ($node->vid != $current_vid) {
    $current = node_load($node->nid, $current_vid);
    return user_load($current->revision_uid);
  }
  return user_load($node->revision_uid);
}

/*************************** Rules Conditions ********************************/

/**
 * Implements hook_rules_condition_info().
 */
function revisioning_rules_condition_info() {
  $defaults = array(
    'group' => t('Revisioning'),
    'parameter' => array(
      'node' => array(
        'type' => 'node',
        'label' => t('Content'),
      ),
    ),
  );
  $items['revisioning_node_has_pending'] = $defaults + array(
    'label' => t('Content has pending revision'),
    'help' => t('Evaluates to TRUE, if the content has one or more pending revisions.'),
    'module' => 'revisioning',
  );
  $items['revisioning_condition_revision_is'] = $defaults + array(
    'label' => t('Content revision state'),
    'help' => t('Evaluates to TRUE, if the revision is in one of the selected states.'),
    'module' => 'revisioning',
    'base' => 'revisioning_condition_revision_is',
  );
  $items['revisioning_condition_revision_is']['parameter']['revision_type'] = array(
    'type' => 'list<text>',
    'label' => t('Is one of'),
    'options list' => 'revisioning_revision_states_all',
    'description' => t('The content state(s) to check for.'),
  );
  return $items;
}

/**
 * Wrapper function to always return all revisioning states.
 */
function revisioning_revision_states_all() {
  return revisioning_revision_states();
}

/**
 * Condition: check for pending revisions of the node.
 */
function revisioning_node_has_pending($node, $settings) {
  revisioning_set_node_revision_info($node);
  return $node->revision_moderation && $node->num_revisions == 1 && !$node->status || ($num_pending = _revisioning_get_number_of_pending_revisions($node->nid)) > 0;
}

/**
 * Condition: check revision state.
 */
function revisioning_condition_revision_is($node, $settings) {
  revisioning_set_node_revision_info($node);

  // Should we return FALSE here if $node->revision_moderation is not set?
  $type = _revisioning_revision_is($node);
  return in_array($type, $settings);
}

/**
 * Label callback for "revisioning_revision_is" condition.
 */
function revisioning_condition_revision_is_label($settings, $argument_labels) {
  $names = array_intersect_key(revisioning_revision_states(), $settings['revision_type']);
  return t('Revision status of @node is: @type', $argument_labels + array(
    '@type' => implode(t(' or '), $names),
  ));
}

/**
 * Label callback for "revisioning_node_has_pending" condition.
 */
function revisioning_node_has_pending_label($settings, $argument_labels) {
  return t('Content "@node" has pending revision(s)', $argument_labels);
}

/*************************** Rules Actions ************************************/

/**
 * Implements hook_rules_action_info().
 */
function revisioning_rules_action_info() {
  $default = array(
    'group' => t('Revisioning'),
  );
  return array(
    'revisioning_rules_action_publish_latest' => $default + array(
      'label' => t('Publish the most recent pending revision'),
      'parameter' => array(
        'node' => array(
          'type' => 'node',
          'label' => t('content'),
        ),
      ),
    ),
    'revisioning_rules_action_load_current' => $default + array(
      'label' => t('Load current revision of content'),
      'parameter' => array(
        'node' => array(
          'type' => 'node',
          'label' => t('content'),
        ),
      ),
      'new variables' => array(
        'loaded_current_revision' => array(
          'type' => 'node',
          'label' => t('Loaded current revision of content'),
          'save' => FALSE,
          'label callback' => 'revisioning_rules_loaded_current_label',
        ),
      ),
    ),
  );
}

/**
 * Label callback for "revisioning_rules_action_load_current" action.
 * @obsolete ?
 */
function revisioning_rules_action_load_current_label($settings, $argument_labels) {
  return t('Load current revision of "@node"', $argument_labels);
}

/**
 * Label callback for "loaded_current_revision" variable.
 * @obsolete ?
 */
function revisioning_rules_loaded_current_label($settings, $argument_labels) {
  return t('Loaded current revision of "@node"', $argument_labels);
}

/**
 * Action: load current revision of provided node.
 */
function revisioning_rules_action_load_current($node) {

  // Or revisioning_get_current_node_revision_id($node->nid); ?
  $current_vid = $node->current_revision_id;
  if ($node->vid != $current_vid) {
    $current = node_load($node->nid, $current_vid);
    return array(
      'loaded_current_revision' => $current,
    );
  }
  return array(
    'loaded_current_revision' => $node,
  );
}

/**
 * Action: publish most recent pending revision.
 */
function revisioning_rules_action_publish_latest($node) {
  _revisioning_publish_latest_revision($node);
}

/**
 * Implements hook_entity_property_info_alter().
 */
function revisioning_entity_property_info_alter(&$info) {

  // $info['node']['properties']['author']['getter callback'] =
  // 'revisioning_user_get_properties';
}

/**
 * @}
 */

Functions

Name	Description
revisioning_condition_revision_is	Condition: check revision state.
revisioning_condition_revision_is_label	Label callback for "revisioning_revision_is" condition.
revisioning_entity_property_info_alter	Implements hook_entity_property_info_alter().
revisioning_events_argument_current_revision	Evaluate revision argument.
revisioning_events_argument_global_user	Get global user argument.
revisioning_node_has_pending	Condition: check for pending revisions of the node.
revisioning_node_has_pending_label	Label callback for "revisioning_node_has_pending" condition.
revisioning_revision_states_all	Wrapper function to always return all revisioning states.
revisioning_rules_action_info	Implements hook_rules_action_info().
revisioning_rules_action_load_current	Action: load current revision of provided node.
revisioning_rules_action_load_current_label	Label callback for "revisioning_rules_action_load_current" action. @obsolete ?
revisioning_rules_action_publish_latest	Action: publish most recent pending revision.
revisioning_rules_condition_info	Implements hook_rules_condition_info().
revisioning_rules_event_info	Implements hook_rules_event_info().
revisioning_rules_loaded_current_label	Label callback for "loaded_current_revision" variable. @obsolete ?
_revisioning_rules_event_variables	Returns event variables suitable for use with a node revision event.

You are here

revisioning.rules.inc in Revisioning 8

File

Functions

API Navigation