Initial commit

This commit is contained in:
Mauricio Dinarte 2024-07-22 21:38:34 -06:00
commit 1664d5cfe6
2772 changed files with 600692 additions and 0 deletions

View file

@ -0,0 +1,10 @@
name = "Trigger Test"
description = "Support module for Trigger tests."
package = Testing
core = 7.x
hidden = TRUE
; Information added by Drupal.org packaging script on 2024-03-06
version = "7.100"
project = "drupal"
datestamp = "1709734591"

View file

@ -0,0 +1,136 @@
<?php
/**
* @file
* Mock module to aid in testing trigger.module.
*/
/**
* Implements hook_action_info().
*/
function trigger_test_action_info() {
// Register an action that can be assigned to the trigger "cron".
return array(
'trigger_test_system_cron_action' => array(
'type' => 'system',
'label' => t('Cron test action'),
'configurable' => FALSE,
'triggers' => array('cron'),
),
'trigger_test_system_cron_conf_action' => array(
'type' => 'system',
'label' => t('Cron test configurable action'),
'configurable' => TRUE,
'triggers' => array('cron'),
),
'trigger_test_generic_action' => array(
'type' => 'system',
'label' => t('Generic test action'),
'configurable' => FALSE,
'triggers' => array(
'taxonomy_term_insert',
'taxonomy_term_update',
'taxonomy_delete',
'comment_insert',
'comment_update',
'comment_delete',
'user_insert',
'user_update',
'user_delete',
'user_login',
'user_logout',
'user_view',
),
),
'trigger_test_generic_any_action' => array(
'type' => 'system',
'label' => t('Generic test action for any trigger'),
'configurable' => FALSE,
'triggers' => array('any'),
),
);
}
/**
* Implements hook_trigger_info().
*/
function trigger_test_trigger_info() {
// Register triggers that this module provides. The first is an additional
// node trigger and the second is our own, which should create a new tab
// on the trigger assignment page. The last tests long trigger names.
return array(
'node' => array(
'node_triggertest' => array(
'label' => t('A test trigger is fired'),
),
),
'trigger_test' => array(
'trigger_test_triggertest' => array(
'label' => t('Another test trigger is fired'),
),
'trigger_test_we_sweat_it_out_in_the_streets_of_a_runaway_american_dream' => array(
'label' => t('A test trigger with a name over 64 characters'),
),
),
);
}
/**
* Action fired during the "cron run" trigger test.
*/
function trigger_test_system_cron_action() {
// Indicate successful execution by setting a persistent variable.
variable_set('trigger_test_system_cron_action', TRUE);
}
/**
* Implement a configurable Drupal action.
*/
function trigger_test_system_cron_conf_action($object, $context) {
// Indicate successful execution by incrementing a persistent variable.
$value = variable_get('trigger_test_system_cron_conf_action', 0) + 1;
variable_set('trigger_test_system_cron_conf_action', $value);
}
/**
* Form for configurable test action.
*/
function trigger_test_system_cron_conf_action_form($context) {
if (!isset($context['subject'])) {
$context['subject'] = '';
}
$form['subject'] = array(
'#type' => 'textfield',
'#default_value' => $context['subject'],
);
return $form;
}
/**
* Form submission handler for configurable test action.
*/
function trigger_test_system_cron_conf_action_submit($form, $form_state) {
$form_values = $form_state['values'];
// Process the HTML form to store configuration. The keyed array that
// we return will be serialized to the database.
$params = array(
'subject' => $form_values['subject'],
);
return $params;
}
/**
* Action fired during the "taxonomy", "comment", and "user" trigger tests.
*/
function trigger_test_generic_action($context) {
// Indicate successful execution by setting a persistent variable.
variable_set('trigger_test_generic_action', TRUE);
}
/**
* Action fired during the additional trigger tests.
*/
function trigger_test_generic_any_action($context) {
// Indicate successful execution by setting a persistent variable.
variable_set('trigger_test_generic_any_action', variable_get('trigger_test_generic_any_action', 0) + 1);
}

View file

@ -0,0 +1,319 @@
<?php
/**
* @file
* Admin page callbacks for the trigger module.
*/
/**
* Builds a form that allows users to assign actions to triggers.
*
* @param $module_to_display
* Which tab of triggers to display. E.g., 'node' for all node-related
* triggers.
*
* @return
* HTML form.
*
* @see trigger_menu()
*/
function trigger_assign($module_to_display = NULL) {
// If no type is specified we default to node actions, since they
// are the most common.
if (!isset($module_to_display)) {
drupal_goto('admin/structure/trigger/node');
}
$build = array();
$trigger_info = module_invoke_all('trigger_info');
drupal_alter('trigger_info', $trigger_info);
foreach ($trigger_info as $module => $hooks) {
if ($module == $module_to_display) {
foreach ($hooks as $hook => $description) {
$form_id = 'trigger_' . $hook . '_assign_form';
$build[$form_id] = drupal_get_form($form_id, $module, $hook, $description['label']);
}
}
}
return $build;
}
/**
* Form constructor for confirmation page for removal of an assigned action.
*
* @param $module
* The tab of triggers the user will be directed to after successful
* removal of the action, or if the confirmation form is cancelled.
* @param $hook
* The name of the trigger hook, e.g., 'node_insert'.
* @param $aid
* The action ID.
*
* @see trigger_unassign_submit()
* @ingroup forms
*/
function trigger_unassign($form, $form_state, $module, $hook = NULL, $aid = NULL) {
if (!isset($hook, $aid)) {
drupal_goto('admin/structure/trigger');
}
$form['hook'] = array(
'#type' => 'value',
'#value' => $hook,
);
$form['module'] = array(
'#type' => 'value',
'#value' => $module,
);
$form['aid'] = array(
'#type' => 'value',
'#value' => $aid,
);
$action = actions_function_lookup($aid);
$actions = actions_get_all_actions();
$destination = 'admin/structure/trigger/' . $module;
return confirm_form($form,
t('Are you sure you want to unassign the action %title?', array('%title' => $actions[$action]['label'])),
$destination,
t('You can assign it again later if you wish.'),
t('Unassign'), t('Cancel')
);
}
/**
* Form submission handler for trigger_unassign().
*/
function trigger_unassign_submit($form, &$form_state) {
if ($form_state['values']['confirm'] == 1) {
$aid = actions_function_lookup($form_state['values']['aid']);
db_delete('trigger_assignments')
->condition('hook', $form_state['values']['hook'])
->condition('aid', $aid)
->execute();
drupal_static_reset('trigger_get_assigned_actions');
$actions = actions_get_all_actions();
watchdog('actions', 'Action %action has been unassigned.', array('%action' => $actions[$aid]['label']));
drupal_set_message(t('Action %action has been unassigned.', array('%action' => $actions[$aid]['label'])));
$form_state['redirect'] = 'admin/structure/trigger/' . $form_state['values']['module'];
}
else {
drupal_goto('admin/structure/trigger');
}
}
/**
* Returns the form for assigning an action to a trigger.
*
* @param $module
* The name of the trigger group, e.g., 'node'.
* @param $hook
* The name of the trigger hook, e.g., 'node_insert'.
* @param $label
* A plain English description of what this trigger does.
*
* @see trigger_assign_form_validate()
* @see trigger_assign_form_submit()
* @ingroup forms
*/
function trigger_assign_form($form, $form_state, $module, $hook, $label) {
$form['module'] = array(
'#type' => 'hidden',
'#value' => $module,
);
$form['hook'] = array(
'#type' => 'hidden',
'#value' => $hook,
);
// All of these forms use the same validate and submit functions.
$form['#validate'][] = 'trigger_assign_form_validate';
$form['#submit'][] = 'trigger_assign_form_submit';
$options = array();
$functions = array();
// Restrict the options list to actions that declare support for this hook.
foreach (actions_list() as $func => $metadata) {
if (isset($metadata['triggers']) && array_intersect(array($hook, 'any'), $metadata['triggers'])) {
$functions[] = $func;
}
}
foreach (actions_actions_map(actions_get_all_actions()) as $aid => $action) {
if (in_array($action['callback'], $functions)) {
$options[$action['type']][$aid] = $action['label'];
}
}
$form[$hook] = array(
'#type' => 'fieldset',
// !description is correct, since these labels are passed through t() in
// hook_trigger_info().
'#title' => t('Trigger: !description', array('!description' => $label)),
'#theme' => 'trigger_display',
);
// Retrieve actions that are already assigned to this hook combination.
$actions = trigger_get_assigned_actions($hook);
$form[$hook]['assigned']['#type'] = 'value';
$form[$hook]['assigned']['#value'] = array();
foreach ($actions as $aid => $info) {
// If action is defined unassign it, otherwise offer to delete all orphaned
// actions.
$hash = drupal_hash_base64($aid, TRUE);
if (actions_function_lookup($hash)) {
$form[$hook]['assigned']['#value'][$aid] = array(
'label' => $info['label'],
'link' => l(t('unassign'), "admin/structure/trigger/unassign/$module/$hook/$hash"),
);
}
else {
// Link to system_actions_remove_orphans() to do the clean up.
$form[$hook]['assigned']['#value'][$aid] = array(
'label' => $info['label'],
'link' => l(t('Remove orphaned actions'), "admin/config/system/actions/orphan"),
);
}
}
$form[$hook]['parent'] = array(
'#type' => 'container',
'#attributes' => array('class' => array('container-inline')),
);
// List possible actions that may be assigned.
if (count($options) != 0) {
$form[$hook]['parent']['aid'] = array(
'#type' => 'select',
'#title' => t('List of trigger actions when !description', array('!description' => $label)),
'#title_display' => 'invisible',
'#options' => $options,
'#empty_option' => t('Choose an action'),
);
$form[$hook]['parent']['submit'] = array(
'#type' => 'submit',
'#value' => t('Assign')
);
}
else {
$form[$hook]['none'] = array(
'#markup' => t('No actions available for this trigger. <a href="@link">Add action</a>.', array('@link' => url('admin/config/system/actions/manage')))
);
}
return $form;
}
/**
* Form validation handler for trigger_assign_form().
*
* Makes sure that the user is not re-assigning an action to an event.
*
* @see trigger_assign_form_submit()
*/
function trigger_assign_form_validate($form, $form_state) {
$form_values = $form_state['values'];
if (!empty($form_values['aid'])) {
$aid = actions_function_lookup($form_values['aid']);
$aid_exists = db_query("SELECT aid FROM {trigger_assignments} WHERE hook = :hook AND aid = :aid", array(
':hook' => $form_values['hook'],
':aid' => $aid,
))->fetchField();
if ($aid_exists) {
form_set_error($form_values['hook'], t('The action you chose is already assigned to that trigger.'));
}
}
}
/**
* Form submission handler for trigger_assign_form().
*
* @see trigger_assign_form_validate()
*/
function trigger_assign_form_submit($form, &$form_state) {
if (!empty($form_state['values']['aid'])) {
$aid = actions_function_lookup($form_state['values']['aid']);
$weight = db_query("SELECT MAX(weight) FROM {trigger_assignments} WHERE hook = :hook", array(':hook' => $form_state['values']['hook']))->fetchField();
// Insert the new action.
db_insert('trigger_assignments')
->fields(array(
'hook' => $form_state['values']['hook'],
'aid' => $aid,
'weight' => $weight + 1,
))
->execute();
// If we are not configuring an action for a "presave" hook and this action
// changes an object property, then we need to save the object, so the
// property change will persist.
$actions = actions_list();
if (strpos($form_state['values']['hook'], 'presave') === FALSE && isset($actions[$aid]['behavior']) && in_array('changes_property', $actions[$aid]['behavior'])) {
// Determine the corresponding save action name for this action.
$save_action = strtok($aid, '_') . '_save_action';
// If no corresponding save action exists, we need to bail out.
if (!isset($actions[$save_action])) {
throw new Exception(t('Missing/undefined save action (%save_aid) for %aid action.', array('%save_aid' => $aid, '%aid' => $aid)));
}
// Delete previous save action if it exists, and re-add it using a higher
// weight.
$save_action_assigned = db_query("SELECT aid FROM {trigger_assignments} WHERE hook = :hook AND aid = :aid", array(':hook' => $form_state['values']['hook'], ':aid' => $save_action))->fetchField();
if ($save_action_assigned) {
db_delete('trigger_assignments')
->condition('hook', $form_state['values']['hook'])
->condition('aid', $save_action)
->execute();
}
db_insert('trigger_assignments')
->fields(array(
'hook' => $form_state['values']['hook'],
'aid' => $save_action,
'weight' => $weight + 2,
))
->execute();
// If no save action existed before, inform the user about it.
if (!$save_action_assigned) {
drupal_set_message(t('The %label action has been appended, which is required to save the property change.', array('%label' => $actions[$save_action]['label'])));
}
// Otherwise, just inform about the new weight.
else {
drupal_set_message(t('The %label action was moved to save the property change.', array('%label' => $actions[$save_action]['label'])));
}
}
}
drupal_static_reset('trigger_get_assigned_actions');
}
/**
* Returns HTML for the form showing actions assigned to a trigger.
*
* @param $variables
* An associative array containing:
* - element: The fieldset including all assigned actions.
*
* @ingroup themeable
*/
function theme_trigger_display($variables) {
$element = $variables['element'];
$header = array();
$rows = array();
if (isset($element['assigned']) && count($element['assigned']['#value'])) {
$header = array(array('data' => t('Name')), array('data' => t('Operation')));
$rows = array();
foreach ($element['assigned']['#value'] as $aid => $info) {
$rows[] = array(
check_plain($info['label']),
$info['link']
);
}
}
if (count($rows)) {
$output = theme('table', array('header' => $header, 'rows' => $rows)) . drupal_render_children($element);
}
else {
$output = drupal_render_children($element);
}
return $output;
}

View file

@ -0,0 +1,78 @@
<?php
/**
* @file
* Hooks provided by the Trigger module.
*/
/**
* @addtogroup hooks
* @{
*/
/**
* Declare triggers (events) for users to assign actions to.
*
* This hook is used by the trigger module to create a list of triggers (events)
* that users can assign actions to. Your module is responsible for detecting
* that the events have occurred, calling trigger_get_assigned_actions() to find
* out which actions the user has associated with your trigger, and then calling
* actions_do() to fire off the actions.
*
* @return
* A nested associative array.
* - The outermost key is the name of the module that is defining the triggers.
* This will be used to create a local task (tab) in the trigger module's
* user interface. A contrib module may supply a trigger for a core module by
* giving the core module's name as the key. For example, you could use the
* 'node' key to add a node-related trigger.
* - Within each module, each individual trigger is keyed by a hook name
* describing the particular trigger (this is not visible to the user, but
* can be used by your module for identification).
* - Each trigger is described by an associative array. Currently, the only
* key-value pair is 'label', which contains a translated human-readable
* description of the triggering event.
* For example, the trigger set for the 'node' module has 'node' as the
* outermost key and defines triggers for 'node_insert', 'node_update',
* 'node_delete' etc. that fire when a node is saved, updated, etc.
*
* @see hook_action_info()
* @see hook_trigger_info_alter()
*/
function hook_trigger_info() {
return array(
'node' => array(
'node_presave' => array(
'label' => t('When either saving new content or updating existing content'),
),
'node_insert' => array(
'label' => t('After saving new content'),
),
'node_update' => array(
'label' => t('After saving updated content'),
),
'node_delete' => array(
'label' => t('After deleting content'),
),
'node_view' => array(
'label' => t('When content is viewed by an authenticated user'),
),
),
);
}
/**
* Alter triggers declared by hook_trigger_info().
*
* @param $triggers
* Array of trigger information returned by hook_trigger_info()
* implementations. Modify this array in place. See hook_trigger_info()
* for information on what this might contain.
*/
function hook_trigger_info_alter(&$triggers) {
$triggers['node']['node_insert']['label'] = t('When content is saved');
}
/**
* @} End of "addtogroup hooks".
*/

View file

@ -0,0 +1,12 @@
name = Trigger
description = Enables actions to be fired on certain system events, such as when new content is created.
package = Core
version = VERSION
core = 7.x
files[] = trigger.test
configure = admin/structure/trigger
; Information added by Drupal.org packaging script on 2024-03-06
version = "7.100"
project = "drupal"
datestamp = "1709734591"

View file

@ -0,0 +1,116 @@
<?php
/**
* @file
* Install, update and uninstall functions for the trigger module.
*/
/**
* Implements hook_schema().
*/
function trigger_schema() {
// The total index length (hook and aid) must be less than 333. Since the aid
// field is 255 characters, the hook field can have a maximum length of 78.
$schema['trigger_assignments'] = array(
'description' => 'Maps trigger to hook and operation assignments from trigger.module.',
'fields' => array(
'hook' => array(
'type' => 'varchar',
'length' => 78,
'not null' => TRUE,
'default' => '',
'description' => 'Primary Key: The name of the internal Drupal hook; for example, node_insert.',
),
'aid' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
'description' => "Primary Key: Action's {actions}.aid.",
),
'weight' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'The weight of the trigger assignment in relation to other triggers.',
),
),
'primary key' => array('hook', 'aid'),
'foreign keys' => array(
'action' => array(
'table' => 'actions',
'columns' => array('aid' => 'aid'),
),
),
);
return $schema;
}
/**
* Implements hook_install().
*/
function trigger_install() {
// Do initial synchronization of actions in code and the database.
actions_synchronize();
}
/**
* Alter the "hook" field and drop the "op field" of {trigger_assignments}.
*
* Increase the length of the "hook" field to 78 characters and adds operation
* names to the hook names, and drops the "op" field.
*/
function trigger_update_7000() {
db_drop_primary_key('trigger_assignments');
db_change_field('trigger_assignments', 'hook', 'hook', array('type' => 'varchar', 'length' => 78, 'not null' => TRUE, 'default' => '', 'description' => 'Primary Key: The name of the internal Drupal hook; for example, node_insert.'));
$result = db_query("SELECT hook, op, aid FROM {trigger_assignments} WHERE op <> ''");
foreach ($result as $record) {
db_update('trigger_assignments')
->fields(array('hook' => $record->hook . '_' . $record->op))
->condition('hook', $record->hook)
->condition('op', $record->op)
->condition('aid', $record->aid)
->execute();
}
db_drop_field('trigger_assignments', 'op');
db_add_primary_key('trigger_assignments', array('hook', 'aid'));
}
/**
* @addtogroup updates-7.x-extra
* @{
*/
/**
* Increase the length of the "hook" field to 78 characters.
*
* This is a separate function for those who ran an older version of
* trigger_update_7000() that did not do this.
*/
function trigger_update_7001() {
db_drop_primary_key('trigger_assignments');
db_change_field('trigger_assignments', 'hook', 'hook', array('type' => 'varchar', 'length' => 78, 'not null' => TRUE, 'default' => '', 'description' => 'Primary Key: The name of the internal Drupal hook; for example, node_insert.', ), array('primary key' => array('hook', 'aid')));
}
/**
* Renames nodeapi to node.
*/
function trigger_update_7002() {
$result = db_query("SELECT hook, aid FROM {trigger_assignments}");
foreach($result as $record) {
$new_hook = str_replace('nodeapi', 'node', $record->hook);
db_update('trigger_assignments')
->fields(array('hook' => $new_hook))
->condition('hook', $record->hook)
->condition('aid', $record->aid)
->execute();
}
}
/**
* @} End of "addtogroup updates-7.x-extra".
*/

View file

@ -0,0 +1,671 @@
<?php
/**
* @file
* Enables functions to be stored and executed at a later time.
*/
/**
* Implements hook_help().
*/
function trigger_help($path, $arg) {
// Generate help text for admin/structure/trigger/(module) tabs.
$matches = array();
if (preg_match('|^admin/structure/trigger/(.*)$|', $path, $matches)) {
$explanation = '<p>' . t('Triggers are events on your site, such as new content being added or a user logging in. The Trigger module associates these triggers with actions (functional tasks), such as unpublishing content containing certain keywords or e-mailing an administrator. The <a href="@url">Actions settings page</a> contains a list of existing actions and provides the ability to create and configure advanced actions (actions requiring configuration, such as an e-mail address or a list of banned words).', array('@url' => url('admin/config/system/actions'))) . '</p>';
$module = $matches[1];
$trigger_info = _trigger_tab_information();
if (!empty($trigger_info[$module])) {
$explanation .= '<p>' . t('There is a tab on this page for each module that defines triggers. On this tab you can assign actions to run when triggers from the <a href="@module-help">@module-name module</a> happen.', array('@module-help' => url('admin/help/' . $module), '@module-name' => $trigger_info[$module])) . '</p>';
}
return $explanation;
}
if ($path == 'admin/help#trigger') {
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('The Trigger module provides the ability to cause <em>actions</em> to run when certain <em>triggers</em> take place on your site. Triggers are events, such as new content being added to your site or a user logging in, and actions are tasks, such as unpublishing content or e-mailing an administrator. For more information, see the online handbook entry for <a href="@trigger">Trigger module</a>.', array('@trigger' => 'http://drupal.org/documentation/modules/trigger/')) . '</p>';
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Configuring triggers and actions') . '</dt>';
$output .= '<dd>' . t('The combination of actions and triggers can perform many useful tasks, such as e-mailing an administrator if a user account is deleted, or automatically unpublishing comments that contain certain words. To set up a trigger/action combination, first visit the <a href="@actions-page">Actions configuration page</a>, where you can either verify that the action you want is already listed, or create a new <em>advanced</em> action. You will need to set up an advanced action if there are configuration options in your trigger/action combination, such as specifying an e-mail address or a list of banned words. After configuring or verifying your action, visit the <a href="@triggers-page">Triggers configuration page</a> and choose the appropriate tab (Comment, Taxonomy, etc.), where you can assign the action to run when the trigger event occurs.', array('@triggers-page' => url('admin/structure/trigger'), '@actions-page' => url('admin/config/system/actions'))) . '</dd>';
$output .= '</dl>';
return $output;
}
}
/**
* Implements hook_menu().
*/
function trigger_menu() {
$items['admin/structure/trigger'] = array(
'title' => 'Triggers',
'description' => 'Configure when to execute actions.',
'page callback' => 'trigger_assign',
'access arguments' => array('administer actions'),
'file' => 'trigger.admin.inc',
);
$trigger_info = _trigger_tab_information();
foreach ($trigger_info as $module => $module_name) {
$items["admin/structure/trigger/$module"] = array(
'title' => $module_name,
'page callback' => 'trigger_assign',
'page arguments' => array($module),
'access arguments' => array('administer actions'),
'type' => MENU_LOCAL_TASK,
'file' => 'trigger.admin.inc',
);
}
$items['admin/structure/trigger/unassign'] = array(
'title' => 'Unassign',
'description' => 'Unassign an action from a trigger.',
'page callback' => 'drupal_get_form',
'page arguments' => array('trigger_unassign'),
// Only accessible if there are any actions that can be unassigned.
'access callback' => 'trigger_menu_unassign_access',
// Only output in the breadcrumb, not in menu trees.
'type' => MENU_VISIBLE_IN_BREADCRUMB,
'file' => 'trigger.admin.inc',
);
return $items;
}
/**
* Access callback: Determines if triggers can be unassigned.
*
* @return bool
* TRUE if there are triggers that the user can unassign, FALSE otherwise.
*
* @see trigger_menu()
*/
function trigger_menu_unassign_access() {
if (!user_access('administer actions')) {
return FALSE;
}
$count = db_select('trigger_assignments')
->countQuery()
->execute()
->fetchField();
return $count > 0;
}
/**
* Implements hook_trigger_info().
*
* Defines all the triggers that this module implements triggers for.
*/
function trigger_trigger_info() {
return array(
'node' => array(
'node_presave' => array(
'label' => t('When either saving new content or updating existing content'),
),
'node_insert' => array(
'label' => t('After saving new content'),
),
'node_update' => array(
'label' => t('After saving updated content'),
),
'node_delete' => array(
'label' => t('After deleting content'),
),
'node_view' => array(
'label' => t('When content is viewed by an authenticated user'),
),
),
'comment' => array(
'comment_presave' => array(
'label' => t('When either saving a new comment or updating an existing comment'),
),
'comment_insert' => array(
'label' => t('After saving a new comment'),
),
'comment_update' => array(
'label' => t('After saving an updated comment'),
),
'comment_delete' => array(
'label' => t('After deleting a comment'),
),
'comment_view' => array(
'label' => t('When a comment is being viewed by an authenticated user'),
),
),
'taxonomy' => array(
'taxonomy_term_insert' => array(
'label' => t('After saving a new term to the database'),
),
'taxonomy_term_update' => array(
'label' => t('After saving an updated term to the database'),
),
'taxonomy_term_delete' => array(
'label' => t('After deleting a term'),
),
),
'system' => array(
'cron' => array(
'label' => t('When cron runs'),
),
),
'user' => array(
'user_insert' => array(
'label' => t('After creating a new user account'),
),
'user_update' => array(
'label' => t('After updating a user account'),
),
'user_delete' => array(
'label' => t('After a user has been deleted'),
),
'user_login' => array(
'label' => t('After a user has logged in'),
),
'user_logout' => array(
'label' => t('After a user has logged out'),
),
'user_view' => array(
'label' => t("When a user's profile is being viewed"),
),
),
);
}
/**
* Gets the action IDs of actions to be executed for a hook.
*
* @param $hook
* The name of the hook being fired.
*
* @return
* An array whose keys are action IDs that the user has associated with
* this trigger, and whose values are arrays containing the action type and
* label.
*/
function trigger_get_assigned_actions($hook) {
$actions = &drupal_static(__FUNCTION__, array());
if (!isset($actions[$hook])) {
$actions[$hook] = db_query("SELECT ta.aid, a.type, a.label FROM {trigger_assignments} ta LEFT JOIN {actions} a ON ta.aid = a.aid WHERE ta.hook = :hook ORDER BY ta.weight", array(
':hook' => $hook,
))->fetchAllAssoc('aid', PDO::FETCH_ASSOC);
}
return $actions[$hook];
}
/**
* Implements hook_theme().
*/
function trigger_theme() {
return array(
'trigger_display' => array(
'render element' => 'element',
'file' => 'trigger.admin.inc',
),
);
}
/**
* Implements hook_forms().
*
* We re-use code by using the same assignment form definition for each hook.
*/
function trigger_forms() {
$trigger_info = _trigger_get_all_info();
$forms = array();
foreach ($trigger_info as $module => $hooks) {
foreach ($hooks as $hook => $description) {
$forms['trigger_' . $hook . '_assign_form'] = array('callback' => 'trigger_assign_form');
}
}
return $forms;
}
/**
* Loads associated objects for node triggers.
*
* When an action is called in a context that does not match its type, the
* object that the action expects must be retrieved. For example, when an action
* that works on users is called during a node hook implementation, the user
* object is not available since the node hook call doesn't pass it. So here we
* load the object the action expects.
*
* @param $type
* The type of action that is about to be called.
* @param $node
* The node that was passed via the node hook.
*
* @return
* The object expected by the action that is about to be called.
*/
function _trigger_normalize_node_context($type, $node) {
// Note that comment-type actions are not supported in node contexts,
// because we wouldn't know which comment to choose.
switch ($type) {
// An action that works on users is being called in a node context.
// Load the user object of the node's author.
case 'user':
return user_load($node->uid);
}
}
/**
* Calls action functions for node triggers.
*
* @param $node
* Node object.
* @param $hook
* Hook to trigger.
* @param $a3
* Additional argument to action function.
* @param $a4
* Additional argument to action function.
*/
function _trigger_node($node, $hook, $a3 = NULL, $a4 = NULL) {
// Keep objects for reuse so that changes actions make to objects can persist.
static $objects;
// Prevent recursion by tracking which operations have already been called.
static $recursion;
$aids = trigger_get_assigned_actions($hook);
if (!$aids) {
return;
}
if (isset($recursion[$hook])) {
return;
}
$recursion[$hook] = TRUE;
$context = array(
'group' => 'node',
'hook' => $hook,
);
// We need to get the expected object if the action's type is not 'node'.
// We keep the object in $objects so we can reuse it if we have multiple actions
// that make changes to an object.
foreach ($aids as $aid => $info) {
$type = $info['type'];
if ($type != 'node') {
if (!isset($objects[$type])) {
$objects[$type] = _trigger_normalize_node_context($type, $node);
}
// Since we know about the node, we pass that info along to the action.
$context['node'] = $node;
$result = actions_do($aid, $objects[$type], $context, $a3, $a4);
}
else {
actions_do($aid, $node, $context, $a3, $a4);
}
}
unset($recursion[$hook]);
}
/**
* Implements hook_node_view().
*/
function trigger_node_view($node, $view_mode) {
_trigger_node($node, 'node_view', $view_mode);
}
/**
* Implements hook_node_update().
*/
function trigger_node_update($node) {
_trigger_node($node, 'node_update');
}
/**
* Implements hook_node_presave().
*/
function trigger_node_presave($node) {
_trigger_node($node, 'node_presave');
}
/**
* Implements hook_node_insert().
*/
function trigger_node_insert($node) {
_trigger_node($node, 'node_insert');
}
/**
* Implements hook_node_delete().
*/
function trigger_node_delete($node) {
_trigger_node($node, 'node_delete');
}
/**
* Loads associated objects for comment triggers.
*
* When an action is called in a context that does not match its type, the
* object that the action expects must be retrieved. For example, when an action
* that works on nodes is called during the comment hook, the node object is not
* available since the comment hook doesn't pass it. So here we load the object
* the action expects.
*
* @param $type
* The type of action that is about to be called.
* @param $comment
* The comment that was passed via the comment hook.
*
* @return
* The object expected by the action that is about to be called.
*/
function _trigger_normalize_comment_context($type, $comment) {
switch ($type) {
// An action that works with nodes is being called in a comment context.
case 'node':
return node_load(is_array($comment) ? $comment['nid'] : $comment->nid);
// An action that works on users is being called in a comment context.
case 'user':
return user_load(is_array($comment) ? $comment['uid'] : $comment->uid);
}
}
/**
* Implements hook_comment_presave().
*/
function trigger_comment_presave($comment) {
_trigger_comment($comment, 'comment_presave');
}
/**
* Implements hook_comment_insert().
*/
function trigger_comment_insert($comment) {
_trigger_comment($comment, 'comment_insert');
}
/**
* Implements hook_comment_update().
*/
function trigger_comment_update($comment) {
_trigger_comment($comment, 'comment_update');
}
/**
* Implements hook_comment_delete().
*/
function trigger_comment_delete($comment) {
_trigger_comment($comment, 'comment_delete');
}
/**
* Implements hook_comment_view().
*/
function trigger_comment_view($comment) {
_trigger_comment($comment, 'comment_view');
}
/**
* Calls action functions for comment triggers.
*
* @param $a1
* Comment object or array of form values.
* @param $hook
* Hook to trigger.
*/
function _trigger_comment($a1, $hook) {
// Keep objects for reuse so that changes actions make to objects can persist.
static $objects;
$aids = trigger_get_assigned_actions($hook);
$context = array(
'group' => 'comment',
'hook' => $hook,
);
// We need to get the expected object if the action's type is not 'comment'.
// We keep the object in $objects so we can reuse it if we have multiple
// actions that make changes to an object.
foreach ($aids as $aid => $info) {
$type = $info['type'];
if ($type != 'comment') {
if (!isset($objects[$type])) {
$objects[$type] = _trigger_normalize_comment_context($type, $a1);
}
// Since we know about the comment, we pass it along to the action
// in case it wants to peek at it.
$context['comment'] = (object) $a1;
actions_do($aid, $objects[$type], $context);
}
else {
actions_do($aid, $a1, $context);
}
}
}
/**
* Implements hook_cron().
*/
function trigger_cron() {
$aids = trigger_get_assigned_actions('cron');
$context = array(
'group' => 'cron',
'hook' => 'cron',
);
// Cron does not act on any specific object.
$object = NULL;
actions_do(array_keys($aids), $object, $context);
}
/**
* Loads associated objects for user triggers.
*
* When an action is called in a context that does not match its type, the
* object that the action expects must be retrieved. For example, when an action
* that works on nodes is called during the user hook, the node object is not
* available since the user hook doesn't pass it. So here we load the object the
* action expects.
*
* @param $type
* The type of action that is about to be called.
* @param $account
* The account object that was passed via the user hook.
*
* @return
* The object expected by the action that is about to be called.
*/
function _trigger_normalize_user_context($type, $account) {
// Note that comment-type actions are not supported in user contexts,
// because we wouldn't know which comment to choose.
switch ($type) {
// An action that works with nodes is being called in a user context.
// If a single node is being viewed, return the node.
case 'node':
// If we are viewing an individual node, return the node.
if (arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == NULL) {
return node_load(array('nid' => arg(1)));
}
break;
}
}
/**
* Implements hook_user_login().
*/
function trigger_user_login(&$edit, $account, $category) {
_trigger_user('user_login', $edit, $account, $category);
}
/**
* Implements hook_user_logout().
*/
function trigger_user_logout($account) {
$edit = array();
_trigger_user('user_logout', $edit, $account);
}
/**
* Implements hook_user_insert().
*/
function trigger_user_insert(&$edit, $account, $category) {
_trigger_user('user_insert', $edit, $account, $category);
}
/**
* Implements hook_user_update().
*/
function trigger_user_update(&$edit, $account, $category) {
_trigger_user('user_update', $edit, $account, $category);
}
/**
* Implements hook_user_cancel().
*/
function trigger_user_cancel($edit, $account, $method) {
switch ($method) {
case 'user_cancel_reassign':
_trigger_user('user_delete', $edit, $account, $method);
break;
}
}
/**
* Implements hook_user_delete().
*/
function trigger_user_delete($account) {
$edit = array();
_trigger_user('user_delete', $edit, $account, NULL);
}
/**
* Implements hook_user_view().
*/
function trigger_user_view($account) {
$edit = NULL;
_trigger_user('user_view', $edit, $account, NULL);
}
/**
* Calls action functions for user triggers.
*
* @param $hook
* The hook that called this function.
* @param $edit
* Edit variable passed in to the hook or empty array if not needed.
* @param $account
* Account variable passed in to the hook.
* @param $method
* Method variable passed in to the hook or NULL if not needed.
*/
function _trigger_user($hook, &$edit, $account, $category = NULL) {
// Keep objects for reuse so that changes actions make to objects can persist.
static $objects;
$aids = trigger_get_assigned_actions($hook);
$context = array(
'group' => 'user',
'hook' => $hook,
'form_values' => &$edit,
);
foreach ($aids as $aid => $info) {
$type = $info['type'];
if ($type != 'user') {
if (!isset($objects[$type])) {
$objects[$type] = _trigger_normalize_user_context($type, $account);
}
$context['user'] = $account;
actions_do($aid, $objects[$type], $context);
}
else {
actions_do($aid, $account, $context, $category);
}
}
}
/**
* Calls action functions for taxonomy triggers.
*
* @param $hook
* Hook to trigger actions for taxonomy_term_insert(),
* taxonomy_term_update(), and taxonomy_term_delete().
* @param $array
* Item on which operation is being performed, either a term or
* form values.
*/
function _trigger_taxonomy($hook, $array) {
$aids = trigger_get_assigned_actions($hook);
$context = array(
'group' => 'taxonomy',
'hook' => $hook
);
actions_do(array_keys($aids), (object) $array, $context);
}
/**
* Implements hook_taxonomy_term_insert().
*/
function trigger_taxonomy_term_insert($term) {
_trigger_taxonomy('taxonomy_term_insert', (array) $term);
}
/**
* Implements hook_taxonomy_term_update().
*/
function trigger_taxonomy_term_update($term) {
_trigger_taxonomy('taxonomy_term_update', (array) $term);
}
/**
* Implements hook_taxonomy_term_delete().
*/
function trigger_taxonomy_term_delete($term) {
_trigger_taxonomy('taxonomy_term_delete', (array) $term);
}
/**
* Implements hook_actions_delete().
*
* Removes all trigger entries for the given action, when an action is deleted.
*/
function trigger_actions_delete($aid) {
db_delete('trigger_assignments')
->condition('aid', $aid)
->execute();
drupal_static_reset('trigger_get_assigned_actions');
}
/**
* Retrieves and caches information from hook_trigger_info() implementations.
*
* @return
* Array of all triggers.
*/
function _trigger_get_all_info() {
$triggers = &drupal_static(__FUNCTION__);
if (!isset($triggers)) {
$triggers = module_invoke_all('trigger_info');
drupal_alter('trigger_info', $triggers);
}
return $triggers;
}
/**
* Gathers information about tabs on the triggers administration screen.
*
* @return
* Array of modules that have triggers, with the keys being the
* machine-readable name of the module, and the values being the
* human-readable name of the module.
*/
function _trigger_tab_information() {
// Gather information about all triggers and modules.
$trigger_info = _trigger_get_all_info();
$modules = system_get_info('module');
$modules = array_intersect_key($modules, $trigger_info);
$return_info = array();
foreach ($modules as $name => $info) {
$return_info[$name] = $info['name'];
}
return $return_info;
}

View file

@ -0,0 +1,771 @@
<?php
/**
* @file
* Tests for trigger.module.
*/
/**
* Provides common helper methods.
*/
class TriggerWebTestCase extends DrupalWebTestCase {
/**
* Configures an advanced action.
*
* @param $action
* The name of the action callback. For example: 'user_block_user_action'
* @param $edit
* The $edit array for the form to be used to configure.
* Example members would be 'actions_label' (always), 'message', etc.
*
* @return
* the aid (action id) of the configured action, or FALSE if none.
*/
protected function configureAdvancedAction($action, $edit) {
// Create an advanced action.
$hash = drupal_hash_base64($action);
$this->drupalPost("admin/config/system/actions/configure/$hash", $edit, t('Save'));
$this->assertText(t('The action has been successfully saved.'));
// Now we have to find out the action ID of what we created.
return db_query('SELECT aid FROM {actions} WHERE callback = :callback AND label = :label', array(':callback' => $action, ':label' => $edit['actions_label']))->fetchField();
}
}
/**
* Provides tests for node triggers.
*/
class TriggerContentTestCase extends TriggerWebTestCase {
var $_cleanup_roles = array();
var $_cleanup_users = array();
public static function getInfo() {
return array(
'name' => 'Trigger content (node) actions',
'description' => 'Perform various tests with content actions.',
'group' => 'Trigger',
);
}
function setUp() {
parent::setUp('trigger', 'trigger_test');
}
/**
* Tests several content-oriented trigger issues.
*
* These are in one function to assure they happen in the right order.
*/
function testActionsContent() {
global $user;
$content_actions = array('node_publish_action', 'node_unpublish_action', 'node_make_sticky_action', 'node_make_unsticky_action', 'node_promote_action', 'node_unpromote_action');
$test_user = $this->drupalCreateUser(array('administer actions'));
$web_user = $this->drupalCreateUser(array('create page content', 'access content', 'administer nodes'));
foreach ($content_actions as $action) {
$hash = drupal_hash_base64($action);
$info = $this->actionInfo($action);
// Assign an action to a trigger, then pull the trigger, and make sure
// the actions fire.
$this->drupalLogin($test_user);
$edit = array('aid' => $hash);
$this->drupalPost('admin/structure/trigger/node', $edit, t('Assign'), array(), array(), 'trigger-node-presave-assign-form');
// Create an unpublished node.
$this->drupalLogin($web_user);
$edit = array();
$langcode = LANGUAGE_NONE;
$edit["title"] = '!SimpleTest test node! ' . $this->randomName(10);
$edit["body[$langcode][0][value]"] = '!SimpleTest test body! ' . $this->randomName(32) . ' ' . $this->randomName(32);
$edit[$info['property']] = !$info['expected'];
$this->drupalPost('node/add/page', $edit, t('Save'));
// Make sure the text we want appears.
$this->assertRaw(t('!post %title has been created.', array('!post' => 'Basic page', '%title' => $edit["title"])), 'Make sure the Basic page has actually been created');
// Action should have been fired.
$loaded_node = $this->drupalGetNodeByTitle($edit["title"]);
$this->assertTrue($loaded_node->{$info['property']} == $info['expected'], format_string('Make sure the @action action fired.', array('@action' => $info['name'])));
// Leave action assigned for next test
// There should be an error when the action is assigned to the trigger
// twice.
$this->drupalLogin($test_user);
// This action already assigned in this test.
$edit = array('aid' => $hash);
$this->drupalPost('admin/structure/trigger/node', $edit, t('Assign'), array(), array(), 'trigger-node-presave-assign-form');
$this->assertRaw(t('The action you chose is already assigned to that trigger.'), 'Check to make sure an error occurs when assigning an action to a trigger twice.');
// The action should be able to be unassigned from a trigger.
$this->drupalPost('admin/structure/trigger/unassign/node/node_presave/' . $hash, array(), t('Unassign'));
$this->assertRaw(t('Action %action has been unassigned.', array('%action' => ucfirst($info['name']))), format_string('Check to make sure the @action action can be unassigned from the trigger.', array('@action' => $info['name'])));
$assigned = db_query("SELECT COUNT(*) FROM {trigger_assignments} WHERE aid IN (:keys)", array(':keys' => $content_actions))->fetchField();
$this->assertFalse($assigned, 'Check to make sure unassign worked properly at the database level.');
}
}
/**
* Tests multiple node actions.
*
* Verifies that node actions are fired for each node individually, if acting
* on multiple nodes.
*/
function testActionContentMultiple() {
// Assign an action to the node save/update trigger.
$test_user = $this->drupalCreateUser(array('administer actions', 'administer nodes', 'create page content', 'access administration pages', 'access content overview'));
$this->drupalLogin($test_user);
$nodes = array();
for ($index = 0; $index < 3; $index++) {
$nodes[] = $this->drupalCreateNode(array('type' => 'page'));
}
$action_id = 'trigger_test_generic_any_action';
$hash = drupal_hash_base64($action_id);
$edit = array('aid' => $hash);
$this->drupalPost('admin/structure/trigger/node', $edit, t('Assign'), array(), array(), 'trigger-node-update-assign-form');
$edit = array(
'operation' => 'unpublish',
'nodes[' . $nodes[0]->nid . ']' => TRUE,
'nodes[' . $nodes[1]->nid . ']' => TRUE,
);
$this->drupalPost('admin/content', $edit, t('Update'));
$count = variable_get('trigger_test_generic_any_action', 0);
$this->assertTrue($count == 2, format_string('Action was triggered 2 times. Actual: %count', array('%count' => $count)));
}
/**
* Returns some info about each of the content actions.
*
* This is helper function for testActionsContent().
*
* @param $action
* The name of the action to return info about.
*
* @return
* An associative array of info about the action.
*/
function actionInfo($action) {
$info = array(
'node_publish_action' => array(
'property' => 'status',
'expected' => 1,
'name' => t('publish content'),
),
'node_unpublish_action' => array(
'property' => 'status',
'expected' => 0,
'name' => t('unpublish content'),
),
'node_make_sticky_action' => array(
'property' => 'sticky',
'expected' => 1,
'name' => t('make content sticky'),
),
'node_make_unsticky_action' => array(
'property' => 'sticky',
'expected' => 0,
'name' => t('make content unsticky'),
),
'node_promote_action' => array(
'property' => 'promote',
'expected' => 1,
'name' => t('promote content to front page'),
),
'node_unpromote_action' => array(
'property' => 'promote',
'expected' => 0,
'name' => t('remove content from front page'),
),
);
return $info[$action];
}
}
/**
* Tests cron trigger.
*/
class TriggerCronTestCase extends TriggerWebTestCase {
public static function getInfo() {
return array(
'name' => 'Trigger cron (system) actions',
'description' => 'Perform various tests with cron trigger.',
'group' => 'Trigger',
);
}
function setUp() {
parent::setUp('trigger', 'trigger_test');
}
/**
* Tests assigning multiple actions to the cron trigger.
*
* This test ensures that both simple and multiple complex actions
* succeed properly. This is done in the cron trigger test because
* cron allows passing multiple actions in at once.
*/
function testActionsCron() {
// Create an administrative user.
$test_user = $this->drupalCreateUser(array('administer actions'));
$this->drupalLogin($test_user);
// Assign a non-configurable action to the cron run trigger.
$edit = array('aid' => drupal_hash_base64('trigger_test_system_cron_action'));
$this->drupalPost('admin/structure/trigger/system', $edit, t('Assign'), array(), array(), 'trigger-cron-assign-form');
// Assign a configurable action to the cron trigger.
$action_label = $this->randomName();
$edit = array(
'actions_label' => $action_label,
'subject' => $action_label,
);
$aid = $this->configureAdvancedAction('trigger_test_system_cron_conf_action', $edit);
// $aid is likely 3 but if we add more uses for the sequences table in
// core it might break, so it is easier to get the value from the database.
$edit = array('aid' => drupal_hash_base64($aid));
$this->drupalPost('admin/structure/trigger/system', $edit, t('Assign'), array(), array(), 'trigger-cron-assign-form');
// Add a second configurable action to the cron trigger.
$action_label = $this->randomName();
$edit = array(
'actions_label' => $action_label,
'subject' => $action_label,
);
$aid = $this->configureAdvancedAction('trigger_test_system_cron_conf_action', $edit);
$edit = array('aid' => drupal_hash_base64($aid));
$this->drupalPost('admin/structure/trigger/system', $edit, t('Assign'), array(), array(), 'trigger-cron-assign-form');
// Force a cron run.
$this->cronRun();
// Make sure the non-configurable action has fired.
$action_run = variable_get('trigger_test_system_cron_action', FALSE);
$this->assertTrue($action_run, 'Check that the cron run triggered the test action.');
// Make sure that both configurable actions have fired.
$action_run = variable_get('trigger_test_system_cron_conf_action', 0) == 2;
$this->assertTrue($action_run, 'Check that the cron run triggered both complex actions.');
}
}
/**
* Provides a base class with trigger assignments and test comparisons.
*/
class TriggerActionTestCase extends TriggerWebTestCase {
function setUp() {
parent::setUp('trigger');
}
/**
* Creates a message with tokens.
*
* @param $trigger
*
* @return
* A message with embedded tokens.
*/
function generateMessageWithTokens($trigger) {
// Note that subject is limited to 254 characters in action configuration.
$message = t('Action was triggered by trigger @trigger user:name=[user:name] user:uid=[user:uid] user:mail=[user:mail] user:url=[user:url] user:edit-url=[user:edit-url] user:created=[user:created]',
array('@trigger' => $trigger));
return trim($message);
}
/**
* Generates a comparison message to match the pre-token-replaced message.
*
* @param $trigger
* Trigger, like 'user_login'.
* @param $account
* Associated user account.
*
* @return
* The token-replaced equivalent message. This does not use token
* functionality.
*
* @see generateMessageWithTokens()
*/
function generateTokenExpandedComparison($trigger, $account) {
// Note that user:last-login was omitted because it changes and can't
// be properly verified.
$message = t('Action was triggered by trigger @trigger user:name=@username user:uid=@uid user:mail=@mail user:url=@user_url user:edit-url=@user_edit_url user:created=@user_created',
array(
'@trigger' => $trigger,
'@username' => $account->name,
'@uid' => !empty($account->uid) ? $account->uid : t('not yet assigned'),
'@mail' => $account->mail,
'@user_url' => !empty($account->uid) ? url("user/$account->uid", array('absolute' => TRUE)) : t('not yet assigned'),
'@user_edit_url' => !empty($account->uid) ? url("user/$account->uid/edit", array('absolute' => TRUE)) : t('not yet assigned'),
'@user_created' => isset($account->created) ? format_date($account->created, 'medium') : t('not yet created'),
)
);
return trim($message);
}
/**
* Assigns a simple (non-configurable) action to a trigger.
*
* @param $trigger
* The trigger to assign to, like 'user_login'.
* @param $action
* The simple action to be assigned, like 'comment_insert'.
*/
function assignSimpleAction($trigger, $action) {
$form_name = "trigger_{$trigger}_assign_form";
$form_html_id = strtr($form_name, '_', '-');
$edit = array('aid' => drupal_hash_base64($action));
$trigger_type = preg_replace('/_.*/', '', $trigger);
$this->drupalPost("admin/structure/trigger/$trigger_type", $edit, t('Assign'), array(), array(), $form_html_id);
$actions = trigger_get_assigned_actions($trigger);
$this->assertTrue(!empty($actions[$action]), format_string('Simple action @action assigned to trigger @trigger', array('@action' => $action, '@trigger' => $trigger)));
}
/**
* Assigns a system message action to the passed-in trigger.
*
* @param $trigger
* For example, 'user_login'
*/
function assignSystemMessageAction($trigger) {
$form_name = "trigger_{$trigger}_assign_form";
$form_html_id = strtr($form_name, '_', '-');
// Assign a configurable action 'System message' to the passed trigger.
$action_edit = array(
'actions_label' => $trigger . "_system_message_action_" . $this->randomName(16),
'message' => $this->generateMessageWithTokens($trigger),
);
// Configure an advanced action that we can assign.
$aid = $this->configureAdvancedAction('system_message_action', $action_edit);
$edit = array('aid' => drupal_hash_base64($aid));
$this->drupalPost('admin/structure/trigger/user', $edit, t('Assign'), array(), array(), $form_html_id);
drupal_static_reset('trigger_get_asssigned_actions');
}
/**
* Assigns a system_send_email_action to the passed-in trigger.
*
* @param $trigger
* For example, 'user_login'
*/
function assignSystemEmailAction($trigger) {
$form_name = "trigger_{$trigger}_assign_form";
$form_html_id = strtr($form_name, '_', '-');
$message = $this->generateMessageWithTokens($trigger);
// Assign a configurable action 'System message' to the passed trigger.
$action_edit = array(
// 'actions_label' => $trigger . "_system_send_message_action_" . $this->randomName(16),
'actions_label' => $trigger . "_system_send_email_action",
'recipient' => '[user:mail]',
'subject' => $message,
'message' => $message,
);
// Configure an advanced action that we can assign.
$aid = $this->configureAdvancedAction('system_send_email_action', $action_edit);
$edit = array('aid' => drupal_hash_base64($aid));
$this->drupalPost('admin/structure/trigger/user', $edit, t('Assign'), array(), array(), $form_html_id);
drupal_static_reset('trigger_get_assigned_actions');
}
/**
* Asserts correct token replacement in both system message and email.
*
* @param $trigger
* A trigger like 'user_login'.
* @param $account
* The user account which triggered the action.
* @param $email_depth
* Number of emails to scan, starting with most recent.
*/
function assertSystemMessageAndEmailTokenReplacement($trigger, $account, $email_depth = 1) {
$this->assertSystemMessageTokenReplacement($trigger, $account);
$this->assertSystemEmailTokenReplacement($trigger, $account, $email_depth);
}
/**
* Asserts correct token replacement for the given trigger and account.
*
* @param $trigger
* A trigger like 'user_login'.
* @param $account
* The user account which triggered the action.
*/
function assertSystemMessageTokenReplacement($trigger, $account) {
$expected = $this->generateTokenExpandedComparison($trigger, $account);
$this->assertText($expected,
format_string('Expected system message to contain token-replaced text "@expected" found in configured system message action', array('@expected' => $expected )) );
}
/**
* Asserts correct token replacement for the given trigger and account.
*
* @param $trigger
* A trigger like 'user_login'.
* @param $account
* The user account which triggered the action.
* @param $email_depth
* Number of emails to scan, starting with most recent.
*/
function assertSystemEmailTokenReplacement($trigger, $account, $email_depth = 1) {
$this->verboseEmail($email_depth);
$expected = $this->generateTokenExpandedComparison($trigger, $account);
$this->assertMailString('subject', $expected, $email_depth);
$this->assertMailString('body', $expected, $email_depth);
$this->assertMail('to', $account->mail, 'Mail sent to correct destination');
}
}
/**
* Tests token substitution in trigger actions.
*
* This tests nearly every permutation of user triggers with system actions
* and checks the token replacement.
*/
class TriggerUserTokenTestCase extends TriggerActionTestCase {
public static function getInfo() {
return array(
'name' => 'Test user triggers',
'description' => 'Test user triggers and system actions with token replacement.',
'group' => 'Trigger',
);
}
/**
* Tests a variety of token replacements in actions.
*/
function testUserTriggerTokenReplacement() {
$test_user = $this->drupalCreateUser(array('administer actions', 'administer users', 'change own username', 'access user profiles'));
$this->drupalLogin($test_user);
$triggers = array('user_login', 'user_insert', 'user_update', 'user_delete', 'user_logout', 'user_view');
foreach ($triggers as $trigger) {
$this->assignSystemMessageAction($trigger);
$this->assignSystemEmailAction($trigger);
}
$this->drupalLogout();
$this->assertSystemEmailTokenReplacement('user_logout', $test_user);
$this->drupalLogin($test_user);
$this->assertSystemMessageAndEmailTokenReplacement('user_login', $test_user, 2);
$this->assertSystemMessageAndEmailTokenReplacement('user_view', $test_user, 2);
$this->drupalPost("user/{$test_user->uid}/edit", array('name' => $test_user->name . '_changed'), t('Save'));
$test_user->name .= '_changed'; // Since we just changed it.
$this->assertSystemMessageAndEmailTokenReplacement('user_update', $test_user, 2);
$this->drupalGet('user');
$this->assertSystemMessageAndEmailTokenReplacement('user_view', $test_user);
$new_user = $this->drupalCreateUser(array('administer actions', 'administer users', 'cancel account', 'access administration pages'));
$this->assertSystemEmailTokenReplacement('user_insert', $new_user);
$this->drupalLogin($new_user);
$user_to_delete = $this->drupalCreateUser(array('access content'));
variable_set('user_cancel_method', 'user_cancel_delete');
$this->drupalPost("user/{$user_to_delete->uid}/cancel", array(), t('Cancel account'));
$this->assertSystemMessageAndEmailTokenReplacement('user_delete', $user_to_delete);
}
}
/**
* Tests token substitution in trigger actions.
*
* This tests nearly every permutation of user triggers with system actions
* and checks the token replacement.
*/
class TriggerUserActionTestCase extends TriggerActionTestCase {
public static function getInfo() {
return array(
'name' => 'Test user actions',
'description' => 'Test user actions.',
'group' => 'Trigger',
);
}
/**
* Tests user action assignment and execution.
*/
function testUserActionAssignmentExecution() {
$test_user = $this->drupalCreateUser(array('administer actions', 'create article content', 'access comments', 'administer comments', 'skip comment approval', 'edit own comments'));
$this->drupalLogin($test_user);
$triggers = array('comment_presave', 'comment_insert', 'comment_update');
// system_block_ip_action is difficult to test without ruining the test.
$actions = array('user_block_user_action');
foreach ($triggers as $trigger) {
foreach ($actions as $action) {
$this->assignSimpleAction($trigger, $action);
}
}
$node = $this->drupalCreateNode(array('type' => 'article'));
$this->drupalPost("node/{$node->nid}", array('comment_body[und][0][value]' => t("my comment"), 'subject' => t("my comment subject")), t('Save'));
// Posting a comment should have blocked this user.
$account = user_load($test_user->uid, TRUE);
$this->assertTrue($account->status == 0, 'Account is blocked');
$comment_author_uid = $account->uid;
// Now rehabilitate the comment author so it can be be blocked again when
// the comment is updated.
user_save($account, array('status' => TRUE));
$test_user = $this->drupalCreateUser(array('administer actions', 'create article content', 'access comments', 'administer comments', 'skip comment approval', 'edit own comments'));
$this->drupalLogin($test_user);
// Our original comment will have been comment 1.
$this->drupalPost("comment/1/edit", array('comment_body[und][0][value]' => t("my comment, updated"), 'subject' => t("my comment subject")), t('Save'));
$comment_author_account = user_load($comment_author_uid, TRUE);
$this->assertTrue($comment_author_account->status == 0, format_string('Comment author account (uid=@uid) is blocked after update to comment', array('@uid' => $comment_author_uid)));
// Verify that the comment was updated.
$test_user = $this->drupalCreateUser(array('administer actions', 'create article content', 'access comments', 'administer comments', 'skip comment approval', 'edit own comments'));
$this->drupalLogin($test_user);
$this->drupalGet("node/$node->nid");
$this->assertText(t("my comment, updated"));
$this->verboseEmail();
}
}
/**
* Tests other triggers.
*/
class TriggerOtherTestCase extends TriggerWebTestCase {
var $_cleanup_roles = array();
var $_cleanup_users = array();
public static function getInfo() {
return array(
'name' => 'Trigger other actions',
'description' => 'Test triggering of user, comment, taxonomy actions.',
'group' => 'Trigger',
);
}
function setUp() {
parent::setUp('trigger', 'trigger_test', 'contact');
}
/**
* Tests triggering on user create and user login.
*/
function testActionsUser() {
// Assign an action to the create user trigger.
$test_user = $this->drupalCreateUser(array('administer actions'));
$this->drupalLogin($test_user);
$action_id = 'trigger_test_generic_action';
$hash = drupal_hash_base64($action_id);
$edit = array('aid' => $hash);
$this->drupalPost('admin/structure/trigger/user', $edit, t('Assign'), array(), array(), 'trigger-user-insert-assign-form');
// Set action variable to FALSE.
variable_set($action_id, FALSE);
// Create an unblocked user
$web_user = $this->drupalCreateUser(array('administer users'));
$this->drupalLogin($web_user);
$name = $this->randomName();
$pass = user_password();
$edit = array();
$edit['name'] = $name;
$edit['mail'] = $name . '@example.com';
$edit['pass[pass1]'] = $pass;
$edit['pass[pass2]'] = $pass;
$edit['status'] = 1;
$this->drupalPost('admin/people/create', $edit, t('Create new account'));
// Verify that the action variable has been set.
$this->assertTrue(variable_get($action_id, FALSE), 'Check that creating a user triggered the test action.');
// Reset the action variable.
variable_set($action_id, FALSE);
$this->drupalLogin($test_user);
// Assign a configurable action 'System message' to the user_login trigger.
$action_edit = array(
'actions_label' => $this->randomName(16),
'message' => t("You have logged in:") . $this->randomName(16),
);
// Configure an advanced action that we can assign.
$aid = $this->configureAdvancedAction('system_message_action', $action_edit);
$edit = array('aid' => drupal_hash_base64($aid));
$this->drupalPost('admin/structure/trigger/user', $edit, t('Assign'), array(), array(), 'trigger-user-login-assign-form');
// Verify that the action has been assigned to the correct hook.
$actions = trigger_get_assigned_actions('user_login');
$this->assertEqual(1, count($actions), 'One Action assigned to the hook');
$this->assertEqual($actions[$aid]['label'], $action_edit['actions_label'], 'Correct action label found.');
// User should get the configured message at login.
$contact_user = $this->drupalCreateUser(array('access site-wide contact form'));;
$this->drupalLogin($contact_user);
$this->assertText($action_edit['message']);
}
/**
* Tests triggering on comment save.
*/
function testActionsComment() {
// Assign an action to the comment save trigger.
$test_user = $this->drupalCreateUser(array('administer actions'));
$this->drupalLogin($test_user);
$action_id = 'trigger_test_generic_action';
$hash = drupal_hash_base64($action_id);
$edit = array('aid' => $hash);
$this->drupalPost('admin/structure/trigger/comment', $edit, t('Assign'), array(), array(), 'trigger-comment-insert-assign-form');
// Set action variable to FALSE.
variable_set($action_id, FALSE);
// Create a node and add a comment to it.
$web_user = $this->drupalCreateUser(array('create article content', 'access content', 'skip comment approval', 'post comments'));
$this->drupalLogin($web_user);
$node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1));
$edit = array();
$edit['subject'] = $this->randomName(10);
$edit['comment_body[' . LANGUAGE_NONE . '][0][value]'] = $this->randomName(10) . ' ' . $this->randomName(10);
$this->drupalGet('comment/reply/' . $node->nid);
$this->drupalPost(NULL, $edit, t('Save'));
// Verify that the action variable has been set.
$this->assertTrue(variable_get($action_id, FALSE), 'Check that creating a comment triggered the action.');
}
/**
* Tests triggering on taxonomy new term.
*/
function testActionsTaxonomy() {
// Assign an action to the taxonomy term save trigger.
$test_user = $this->drupalCreateUser(array('administer actions'));
$this->drupalLogin($test_user);
$action_id = 'trigger_test_generic_action';
$hash = drupal_hash_base64($action_id);
$edit = array('aid' => $hash);
$this->drupalPost('admin/structure/trigger/taxonomy', $edit, t('Assign'), array(), array(), 'trigger-taxonomy-term-insert-assign-form');
// Set action variable to FALSE.
variable_set($action_id, FALSE);
// Create a taxonomy vocabulary and add a term to it.
// Create a vocabulary.
$vocabulary = new stdClass();
$vocabulary->name = $this->randomName();
$vocabulary->description = $this->randomName();
$vocabulary->machine_name = drupal_strtolower($this->randomName());
$vocabulary->help = '';
$vocabulary->nodes = array('article' => 'article');
$vocabulary->weight = mt_rand(0, 10);
taxonomy_vocabulary_save($vocabulary);
$term = new stdClass();
$term->name = $this->randomName();
$term->vid = $vocabulary->vid;
taxonomy_term_save($term);
// Verify that the action variable has been set.
$this->assertTrue(variable_get($action_id, FALSE), 'Check that creating a taxonomy term triggered the action.');
}
}
/**
* Tests that orphaned actions are properly handled.
*/
class TriggerOrphanedActionsTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Trigger orphaned actions',
'description' => 'Test triggering an action that has since been removed.',
'group' => 'Trigger',
);
}
function setUp() {
parent::setUp('trigger', 'trigger_test');
}
/**
* Tests logic around orphaned actions.
*/
function testActionsOrphaned() {
$action = 'trigger_test_generic_any_action';
$hash = drupal_hash_base64($action);
// Assign an action from a disable-able module to a trigger, then pull the
// trigger, and make sure the actions fire.
$test_user = $this->drupalCreateUser(array('administer actions'));
$this->drupalLogin($test_user);
$edit = array('aid' => $hash);
$this->drupalPost('admin/structure/trigger/node', $edit, t('Assign'), array(), array(), 'trigger-node-presave-assign-form');
// Create an unpublished node.
$web_user = $this->drupalCreateUser(array('create page content', 'edit own page content', 'access content', 'administer nodes'));
$this->drupalLogin($web_user);
$edit = array();
$langcode = LANGUAGE_NONE;
$edit["title"] = '!SimpleTest test node! ' . $this->randomName(10);
$edit["body[$langcode][0][value]"] = '!SimpleTest test body! ' . $this->randomName(32) . ' ' . $this->randomName(32);
$this->drupalPost('node/add/page', $edit, t('Save'));
$this->assertRaw(t('!post %title has been created.', array('!post' => 'Basic page', '%title' => $edit["title"])), 'Make sure the Basic page has actually been created');
// Action should have been fired.
$this->assertTrue(variable_get('trigger_test_generic_any_action', FALSE), 'Trigger test action successfully fired.');
// Disable the module that provides the action and make sure the trigger
// doesn't white screen.
module_disable(array('trigger_test'));
$loaded_node = $this->drupalGetNodeByTitle($edit["title"]);
$edit["body[$langcode][0][value]"] = '!SimpleTest test body! ' . $this->randomName(32) . ' ' . $this->randomName(32);
$this->drupalPost("node/$loaded_node->nid/edit", $edit, t('Save'));
// If the node body was updated successfully we have dealt with the
// unavailable action.
$this->assertRaw(t('!post %title has been updated.', array('!post' => 'Basic page', '%title' => $edit["title"])), 'Make sure the Basic page can be updated with the missing trigger function.');
}
}
/**
* Tests the unassigning of triggers.
*/
class TriggerUnassignTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Trigger unassigning',
'description' => 'Tests the unassigning of triggers.',
'group' => 'Trigger',
);
}
function setUp() {
parent::setUp('trigger', 'trigger_test');
$web_user = $this->drupalCreateUser(array('administer actions'));
$this->drupalLogin($web_user);
}
/**
* Tests an attempt to unassign triggers when none are assigned.
*/
function testUnassignAccessDenied() {
$this->drupalGet('admin/structure/trigger/unassign');
$this->assertResponse(403, 'If there are no actions available, return access denied.');
}
}