diff --git a/core/CHANGELOG.txt b/core/CHANGELOG.txt index 431574b..37f510c 100644 --- a/core/CHANGELOG.txt +++ b/core/CHANGELOG.txt @@ -9,6 +9,7 @@ Drupal 8.0, xxxx-xx-xx (development version) modules with similar functionality are available: * Blog * Profile + * Trigger - Removed the Garland theme from core. - Universally Unique IDentifier (UUID): * Support for generating and validating UUIDs. diff --git a/core/MAINTAINERS.txt b/core/MAINTAINERS.txt index 98df6c6..16e254d 100644 --- a/core/MAINTAINERS.txt +++ b/core/MAINTAINERS.txt @@ -263,9 +263,6 @@ Tracker module Translation module - Francesco Placella 'plach' -Trigger module -- ? - Update module - Derek Wright 'dww' diff --git a/core/includes/actions.inc b/core/includes/actions.inc deleted file mode 100644 index 760de83..0000000 --- a/core/includes/actions.inc +++ /dev/null @@ -1,383 +0,0 @@ - variable_get('actions_max_stack', 35)) { - watchdog('actions', 'Stack overflow: too many calls to actions_do(). Aborting to prevent infinite recursion.', array(), WATCHDOG_ERROR); - return; - } - $actions = array(); - $available_actions = actions_list(); - $actions_result = array(); - if (is_array($action_ids)) { - $conditions = array(); - foreach ($action_ids as $action_id) { - if (is_numeric($action_id)) { - $conditions[] = $action_id; - } - elseif (isset($available_actions[$action_id])) { - $actions[$action_id] = $available_actions[$action_id]; - } - } - - // When we have action instances we must go to the database to retrieve - // instance data. - if (!empty($conditions)) { - $query = db_select('actions'); - $query->addField('actions', 'aid'); - $query->addField('actions', 'type'); - $query->addField('actions', 'callback'); - $query->addField('actions', 'parameters'); - $query->condition('aid', $conditions, 'IN'); - $result = $query->execute(); - foreach ($result as $action) { - $actions[$action->aid] = $action->parameters ? unserialize($action->parameters) : array(); - $actions[$action->aid]['callback'] = $action->callback; - $actions[$action->aid]['type'] = $action->type; - } - } - - // Fire actions, in no particular order. - foreach ($actions as $action_id => $params) { - // Configurable actions need parameters. - if (is_numeric($action_id)) { - $function = $params['callback']; - if (function_exists($function)) { - $context = array_merge($context, $params); - $actions_result[$action_id] = $function($object, $context, $a1, $a2); - } - else { - $actions_result[$action_id] = FALSE; - } - } - // Singleton action; $action_id is the function name. - else { - $actions_result[$action_id] = $action_id($object, $context, $a1, $a2); - } - } - } - // Optimized execution of a single action. - else { - // If it's a configurable action, retrieve stored parameters. - if (is_numeric($action_ids)) { - $action = db_query("SELECT callback, parameters FROM {actions} WHERE aid = :aid", array(':aid' => $action_ids))->fetchObject(); - $function = $action->callback; - if (function_exists($function)) { - $context = array_merge($context, unserialize($action->parameters)); - $actions_result[$action_ids] = $function($object, $context, $a1, $a2); - } - else { - $actions_result[$action_ids] = FALSE; - } - } - // Singleton action; $action_ids is the function name. - else { - if (function_exists($action_ids)) { - $actions_result[$action_ids] = $action_ids($object, $context, $a1, $a2); - } - else { - // Set to avoid undefined index error messages later. - $actions_result[$action_ids] = FALSE; - } - } - } - $stack--; - return $actions_result; -} - -/** - * Discovers all available actions by invoking hook_action_info(). - * - * This function contrasts with actions_get_all_actions(); see the - * documentation of actions_get_all_actions() for an explanation. - * - * @param $reset - * Reset the action info static cache. - * @return - * An associative array keyed on action function name, with the same format - * as the return value of hook_action_info(), containing all - * modules' hook_action_info() return values as modified by any - * hook_action_info_alter() implementations. - * - * @see hook_action_info() - */ -function actions_list($reset = FALSE) { - $actions = &drupal_static(__FUNCTION__); - if (!isset($actions) || $reset) { - $actions = module_invoke_all('action_info'); - drupal_alter('action_info', $actions); - } - - // See module_implements() for an explanation of this cast. - return (array) $actions; -} - -/** - * Retrieves all action instances from the database. - * - * This function differs from the actions_list() function, which gathers - * actions by invoking hook_action_info(). The actions returned by this - * function and the actions returned by actions_list() are partially - * synchronized. Non-configurable actions from hook_action_info() - * implementations are put into the database when actions_synchronize() is - * called, which happens when admin/config/system/actions is visited. Configurable - * actions are not added to the database until they are configured in the - * user interface, in which case a database row is created for each - * configuration of each action. - * - * @return - * Associative array keyed by numeric action ID. Each value is an associative - * array with keys 'callback', 'label', 'type' and 'configurable'. - */ -function actions_get_all_actions() { - $actions = db_query("SELECT aid, type, callback, parameters, label FROM {actions}")->fetchAllAssoc('aid', PDO::FETCH_ASSOC); - foreach ($actions as &$action) { - $action['configurable'] = (bool) $action['parameters']; - unset($action['parameters']); - unset($action['aid']); - } - return $actions; -} - -/** - * Creates an associative array keyed by hashes of function names or IDs. - * - * Hashes are used to prevent actual function names from going out into HTML - * forms and coming back. - * - * @param $actions - * An associative array with function names or action IDs as keys - * and associative arrays with keys 'label', 'type', etc. as values. - * This is usually the output of actions_list() or actions_get_all_actions(). - * @return - * An associative array whose keys are hashes of the input array keys, and - * whose corresponding values are associative arrays with components - * 'callback', 'label', 'type', and 'configurable' from the input array. - */ -function actions_actions_map($actions) { - $actions_map = array(); - foreach ($actions as $callback => $array) { - $key = drupal_hash_base64($callback); - $actions_map[$key]['callback'] = isset($array['callback']) ? $array['callback'] : $callback; - $actions_map[$key]['label'] = $array['label']; - $actions_map[$key]['type'] = $array['type']; - $actions_map[$key]['configurable'] = $array['configurable']; - } - return $actions_map; -} - -/** - * Given a hash of an action array key, returns the key (function or ID). - * - * Faster than actions_actions_map() when you only need the function name or ID. - * - * @param $hash - * Hash of a function name or action ID array key. The array key - * is a key into the return value of actions_list() (array key is the action - * function name) or actions_get_all_actions() (array key is the action ID). - * @return - * The corresponding array key, or FALSE if no match is found. - */ -function actions_function_lookup($hash) { - // Check for a function name match. - $actions_list = actions_list(); - foreach ($actions_list as $function => $array) { - if (drupal_hash_base64($function) == $hash) { - return $function; - } - } - $aid = FALSE; - // Must be a configurable action; check database. - $result = db_query("SELECT aid FROM {actions} WHERE parameters <> ''")->fetchAll(PDO::FETCH_ASSOC); - foreach ($result as $row) { - if (drupal_hash_base64($row['aid']) == $hash) { - $aid = $row['aid']; - break; - } - } - return $aid; -} - -/** - * Synchronizes actions that are provided by modules in hook_action_info(). - * - * Actions provided by modules in hook_action_info() implementations are - * synchronized with actions that are stored in the actions database table. - * This is necessary so that actions that do not require configuration can - * receive action IDs. - * - * @param $delete_orphans - * If TRUE, any actions that exist in the database but are no longer - * found in the code (for example, because the module that provides them has - * been disabled) will be deleted. - */ -function actions_synchronize($delete_orphans = FALSE) { - $actions_in_code = actions_list(TRUE); - $actions_in_db = db_query("SELECT aid, callback, label FROM {actions} WHERE parameters = ''")->fetchAllAssoc('callback', PDO::FETCH_ASSOC); - - // Go through all the actions provided by modules. - foreach ($actions_in_code as $callback => $array) { - // Ignore configurable actions since their instances get put in when the - // user adds the action. - if (!$array['configurable']) { - // If we already have an action ID for this action, no need to assign aid. - if (isset($actions_in_db[$callback])) { - unset($actions_in_db[$callback]); - } - else { - // This is a new singleton that we don't have an aid for; assign one. - db_insert('actions') - ->fields(array( - 'aid' => $callback, - 'type' => $array['type'], - 'callback' => $callback, - 'parameters' => '', - 'label' => $array['label'], - )) - ->execute(); - watchdog('actions', "Action '%action' added.", array('%action' => $array['label'])); - } - } - } - - // Any actions that we have left in $actions_in_db are orphaned. - if ($actions_in_db) { - $orphaned = array_keys($actions_in_db); - - if ($delete_orphans) { - $actions = db_query('SELECT aid, label FROM {actions} WHERE callback IN (:orphaned)', array(':orphaned' => $orphaned))->fetchAll(); - foreach ($actions as $action) { - actions_delete($action->aid); - watchdog('actions', "Removed orphaned action '%action' from database.", array('%action' => $action->label)); - } - } - else { - $link = l(t('Remove orphaned actions'), 'admin/config/system/actions/orphan'); - $count = count($actions_in_db); - $orphans = implode(', ', $orphaned); - watchdog('actions', '@count orphaned actions (%orphans) exist in the actions table. !link', array('@count' => $count, '%orphans' => $orphans, '!link' => $link), WATCHDOG_INFO); - } - } -} - -/** - * Saves an action and its user-supplied parameter values to the database. - * - * @param $function - * The name of the function to be called when this action is performed. - * @param $type - * The type of action, to describe grouping and/or context, e.g., 'node', - * 'user', 'comment', or 'system'. - * @param $params - * An associative array with parameter names as keys and parameter values as - * values. - * @param $label - * A user-supplied label of this particular action, e.g., 'Send e-mail - * to Jim'. - * @param $aid - * The ID of this action. If omitted, a new action is created. - * @return - * The ID of the action. - */ -function actions_save($function, $type, $params, $label, $aid = NULL) { - // aid is the callback for singleton actions so we need to keep a separate - // table for numeric aids. - if (!$aid) { - $aid = db_next_id(); - } - - db_merge('actions') - ->key(array('aid' => $aid)) - ->fields(array( - 'callback' => $function, - 'type' => $type, - 'parameters' => serialize($params), - 'label' => $label, - )) - ->execute(); - - watchdog('actions', 'Action %action saved.', array('%action' => $label)); - return $aid; -} - -/** - * Retrieves a single action from the database. - * - * @param $aid - * The ID of the action to retrieve. - * @return - * The appropriate action row from the database as an object. - */ -function actions_load($aid) { - return db_query("SELECT aid, type, callback, parameters, label FROM {actions} WHERE aid = :aid", array(':aid' => $aid))->fetchObject(); -} - -/** - * Deletes a single action from the database. - * - * @param $aid - * The ID of the action to delete. - */ -function actions_delete($aid) { - db_delete('actions') - ->condition('aid', $aid) - ->execute(); - module_invoke_all('actions_delete', $aid); -} - diff --git a/core/includes/bootstrap.inc b/core/includes/bootstrap.inc index 9780ed2..4ef8add 100644 --- a/core/includes/bootstrap.inc +++ b/core/includes/bootstrap.inc @@ -3164,11 +3164,11 @@ function registry_update() { * * Example: * @code - * function actions_do(...) { + * function system_count_stack(...) { * // $stack tracks the number of recursive calls. * static $stack; * $stack++; - * if ($stack > variable_get('actions_max_stack', 35)) { + * if ($stack > variable_get('system_max_stack', 35)) { * ... * return; * } diff --git a/core/includes/common.inc b/core/includes/common.inc index 75dacc2..5d62f1a 100644 --- a/core/includes/common.inc +++ b/core/includes/common.inc @@ -4899,7 +4899,6 @@ function _drupal_bootstrap_full() { require_once DRUPAL_ROOT . '/core/includes/image.inc'; require_once DRUPAL_ROOT . '/core/includes/form.inc'; require_once DRUPAL_ROOT . '/core/includes/mail.inc'; - require_once DRUPAL_ROOT . '/core/includes/actions.inc'; require_once DRUPAL_ROOT . '/core/includes/ajax.inc'; require_once DRUPAL_ROOT . '/core/includes/token.inc'; require_once DRUPAL_ROOT . '/core/includes/errors.inc'; @@ -7153,9 +7152,6 @@ function drupal_flush_all_caches() { // after node types are rebuilt. menu_rebuild(); - // Synchronize to catch any actions that were added or removed. - actions_synchronize(); - // Don't clear cache_form - in-progress form submissions may break. // Ordered so clearing the page cache will always be the last action. $core = array('cache', 'path', 'filter', 'bootstrap', 'page'); diff --git a/core/modules/simpletest/tests/actions.test b/core/modules/simpletest/tests/actions.test deleted file mode 100644 index 23587f0..0000000 --- a/core/modules/simpletest/tests/actions.test +++ /dev/null @@ -1,126 +0,0 @@ - 'Actions configuration', - 'description' => 'Tests complex actions configuration by adding, editing, and deleting a complex action.', - 'group' => 'Actions', - ); - } - - /** - * Test the configuration of advanced actions through the administration - * interface. - */ - function testActionConfiguration() { - // Create a user with permission to view the actions administration pages. - $user = $this->drupalCreateUser(array('administer actions')); - $this->drupalLogin($user); - - // Make a POST request to admin/config/system/actions/manage. - $edit = array(); - $edit['action'] = drupal_hash_base64('system_goto_action'); - $this->drupalPost('admin/config/system/actions/manage', $edit, t('Create')); - - // Make a POST request to the individual action configuration page. - $edit = array(); - $action_label = $this->randomName(); - $edit['actions_label'] = $action_label; - $edit['url'] = 'admin'; - $this->drupalPost('admin/config/system/actions/configure/' . drupal_hash_base64('system_goto_action'), $edit, t('Save')); - - // Make sure that the new complex action was saved properly. - $this->assertText(t('The action has been successfully saved.'), t("Make sure we get a confirmation that we've successfully saved the complex action.")); - $this->assertText($action_label, t("Make sure the action label appears on the configuration page after we've saved the complex action.")); - - // Make another POST request to the action edit page. - $this->clickLink(t('configure')); - preg_match('|admin/config/system/actions/configure/(\d+)|', $this->getUrl(), $matches); - $aid = $matches[1]; - $edit = array(); - $new_action_label = $this->randomName(); - $edit['actions_label'] = $new_action_label; - $edit['url'] = 'admin'; - $this->drupalPost(NULL, $edit, t('Save')); - - // Make sure that the action updated properly. - $this->assertText(t('The action has been successfully saved.'), t("Make sure we get a confirmation that we've successfully updated the complex action.")); - $this->assertNoText($action_label, t("Make sure the old action label does NOT appear on the configuration page after we've updated the complex action.")); - $this->assertText($new_action_label, t("Make sure the action label appears on the configuration page after we've updated the complex action.")); - - // Make sure that deletions work properly. - $this->clickLink(t('delete')); - $edit = array(); - $this->drupalPost("admin/config/system/actions/delete/$aid", $edit, t('Delete')); - - // Make sure that the action was actually deleted. - $this->assertRaw(t('Action %action was deleted', array('%action' => $new_action_label)), t('Make sure that we get a delete confirmation message.')); - $this->drupalGet('admin/config/system/actions/manage'); - $this->assertNoText($new_action_label, t("Make sure the action label does not appear on the overview page after we've deleted the action.")); - $exists = db_query('SELECT aid FROM {actions} WHERE callback = :callback', array(':callback' => 'drupal_goto_action'))->fetchField(); - $this->assertFalse($exists, t('Make sure the action is gone from the database after being deleted.')); - } -} - -/** - * Test actions executing in a potential loop, and make sure they abort properly. - */ -class ActionLoopTestCase extends DrupalWebTestCase { - public static function getInfo() { - return array( - 'name' => 'Actions executing in a potentially infinite loop', - 'description' => 'Tests actions executing in a loop, and makes sure they abort properly.', - 'group' => 'Actions', - ); - } - - function setUp() { - parent::setUp('dblog', 'trigger', 'actions_loop_test'); - } - - /** - * Set up a loop with 3 - 12 recursions, and see if it aborts properly. - */ - function testActionLoop() { - $user = $this->drupalCreateUser(array('administer actions')); - $this->drupalLogin($user); - - $hash = drupal_hash_base64('actions_loop_test_log'); - $edit = array('aid' => $hash); - $this->drupalPost('admin/structure/trigger/actions_loop_test', $edit, t('Assign')); - - // Delete any existing watchdog messages to clear the plethora of - // "Action added" messages from when Drupal was installed. - db_delete('watchdog')->execute(); - // To prevent this test from failing when xdebug is enabled, the maximum - // recursion level should be kept low enough to prevent the xdebug - // infinite recursion protection mechanism from aborting the request. - // See http://drupal.org/node/587634. - variable_set('actions_max_stack', mt_rand(3, 12)); - $this->triggerActions(); - } - - /** - * Create an infinite loop by causing a watchdog message to be set, - * which causes the actions to be triggered again, up to actions_max_stack - * times. - */ - protected function triggerActions() { - $this->drupalGet('', array('query' => array('trigger_actions_on_watchdog' => TRUE))); - $expected = array(); - $expected[] = 'Triggering action loop'; - for ($i = 1; $i <= variable_get('actions_max_stack', 35); $i++) { - $expected[] = "Test log #$i"; - } - $expected[] = 'Stack overflow: too many calls to actions_do(). Aborting to prevent infinite recursion.'; - - $result = db_query("SELECT message FROM {watchdog} WHERE type = 'actions_loop_test' OR type = 'actions' ORDER BY wid"); - $loop_started = FALSE; - foreach ($result as $row) { - $expected_message = array_shift($expected); - $this->assertEqual($row->message, $expected_message, t('Expected message %expected, got %message.', array('%expected' => $expected_message, '%message' => $row->message))); - } - $this->assertTrue(empty($expected), t('All expected messages found.')); - } -} diff --git a/core/modules/simpletest/tests/actions_loop_test.info b/core/modules/simpletest/tests/actions_loop_test.info deleted file mode 100644 index 3507511..0000000 --- a/core/modules/simpletest/tests/actions_loop_test.info +++ /dev/null @@ -1,6 +0,0 @@ -name = Actions loop test -description = Support module for action loop testing. -package = Testing -version = VERSION -core = 8.x -hidden = TRUE diff --git a/core/modules/simpletest/tests/actions_loop_test.install b/core/modules/simpletest/tests/actions_loop_test.install deleted file mode 100644 index b22fd85..0000000 --- a/core/modules/simpletest/tests/actions_loop_test.install +++ /dev/null @@ -1,11 +0,0 @@ -fields(array('weight' => 1)) - ->condition('name', 'actions_loop_test') - ->execute(); -} diff --git a/core/modules/simpletest/tests/actions_loop_test.module b/core/modules/simpletest/tests/actions_loop_test.module deleted file mode 100644 index 7776490..0000000 --- a/core/modules/simpletest/tests/actions_loop_test.module +++ /dev/null @@ -1,94 +0,0 @@ - array( - 'watchdog' => array( - 'label' => t('When a message is logged'), - ), - ), - ); -} - -/** - * Implements hook_watchdog(). - */ -function actions_loop_test_watchdog(array $log_entry) { - // If the triggering actions are not explicitly enabled, abort. - if (empty($_GET['trigger_actions_on_watchdog'])) { - return; - } - // Get all the action ids assigned to the trigger on the watchdog hook's - // "run" event. - $aids = trigger_get_assigned_actions('watchdog'); - // We can pass in any applicable information in $context. There isn't much in - // this case, but we'll pass in the hook name as the bare minimum. - $context = array( - 'hook' => 'watchdog', - ); - // Fire the actions on the associated object ($log_entry) and the context - // variable. - actions_do(array_keys($aids), $log_entry, $context); -} - -/** - * Implements hook_init(). - */ -function actions_loop_test_init() { - if (!empty($_GET['trigger_actions_on_watchdog'])) { - watchdog_skip_semaphore('actions_loop_test', 'Triggering action loop'); - } -} - -/** - * Implements hook_action_info(). - */ -function actions_loop_test_action_info() { - return array( - 'actions_loop_test_log' => array( - 'label' => t('Write a message to the log.'), - 'type' => 'system', - 'configurable' => FALSE, - 'triggers' => array('any'), - ), - ); -} - -/** - * Write a message to the log. - */ -function actions_loop_test_log() { - $count = &drupal_static(__FUNCTION__, 0); - $count++; - watchdog_skip_semaphore('actions_loop_test', "Test log #$count"); -} - -/** - * Replacement of the watchdog() function that eliminates the use of semaphores - * so that we can test the abortion of an action loop. - */ -function watchdog_skip_semaphore($type, $message, $variables = array(), $severity = WATCHDOG_NOTICE, $link = NULL) { - global $user, $base_root; - - // Prepare the fields to be logged - $log_entry = array( - 'type' => $type, - 'message' => $message, - 'variables' => $variables, - 'severity' => $severity, - 'link' => $link, - 'user' => $user, - 'request_uri' => $base_root . request_uri(), - 'referer' => $_SERVER['HTTP_REFERER'], - 'ip' => ip_address(), - 'timestamp' => REQUEST_TIME, - ); - - // Call the logging hooks to log/process the message - foreach (module_implements('watchdog') as $module) { - module_invoke($module, 'watchdog', $log_entry); - } -} diff --git a/core/modules/system/system.admin.inc b/core/modules/system/system.admin.inc index a5a8885..bb5becc 100644 --- a/core/modules/system/system.admin.inc +++ b/core/modules/system/system.admin.inc @@ -2898,276 +2898,3 @@ function system_add_date_formats_form_submit($form, &$form_state) { $form_state['redirect'] = 'admin/config/regional/date-time/formats'; } - -/** - * Menu callback; Displays an overview of available and configured actions. - */ -function system_actions_manage() { - actions_synchronize(); - $actions = actions_list(); - $actions_map = actions_actions_map($actions); - $options = array(); - $unconfigurable = array(); - - foreach ($actions_map as $key => $array) { - if ($array['configurable']) { - $options[$key] = $array['label'] . '...'; - } - else { - $unconfigurable[] = $array; - } - } - - $row = array(); - $instances_present = db_query("SELECT aid FROM {actions} WHERE parameters <> ''")->fetchField(); - $header = array( - array('data' => t('Action type'), 'field' => 'type'), - array('data' => t('Label'), 'field' => 'label'), - array('data' => $instances_present ? t('Operations') : '', 'colspan' => '2') - ); - $query = db_select('actions')->extend('PagerDefault')->extend('TableSort'); - $result = $query - ->fields('actions') - ->limit(50) - ->orderByHeader($header) - ->execute(); - - foreach ($result as $action) { - $row[] = array( - array('data' => $action->type), - array('data' => check_plain($action->label)), - array('data' => $action->parameters ? l(t('configure'), "admin/config/system/actions/configure/$action->aid") : ''), - array('data' => $action->parameters ? l(t('delete'), "admin/config/system/actions/delete/$action->aid") : '') - ); - } - - if ($row) { - $pager = theme('pager'); - if (!empty($pager)) { - $row[] = array(array('data' => $pager, 'colspan' => '3')); - } - $build['system_actions_header'] = array('#markup' => '

' . t('Available actions:') . '

'); - $build['system_actions_table'] = array('#markup' => theme('table', array('header' => $header, 'rows' => $row))); - } - - if ($actions_map) { - $build['system_actions_manage_form'] = drupal_get_form('system_actions_manage_form', $options); - } - - return $build; -} - -/** - * Define the form for the actions overview page. - * - * @param $form_state - * An associative array containing the current state of the form; not used. - * @param $options - * An array of configurable actions. - * @return - * Form definition. - * - * @ingroup forms - * @see system_actions_manage_form_submit() - */ -function system_actions_manage_form($form, &$form_state, $options = array()) { - $form['parent'] = array( - '#type' => 'fieldset', - '#title' => t('Create an advanced action'), - '#attributes' => array('class' => array('container-inline')), - ); - $form['parent']['action'] = array( - '#type' => 'select', - '#title' => t('Action'), - '#title_display' => 'invisible', - '#options' => $options, - '#empty_option' => t('Choose an advanced action'), - ); - $form['parent']['actions'] = array('#type' => 'actions'); - $form['parent']['actions']['submit'] = array( - '#type' => 'submit', - '#value' => t('Create'), - ); - return $form; -} - -/** - * Process system_actions_manage form submissions. - * - * @see system_actions_manage_form() - */ -function system_actions_manage_form_submit($form, &$form_state) { - if ($form_state['values']['action']) { - $form_state['redirect'] = 'admin/config/system/actions/configure/' . $form_state['values']['action']; - } -} - -/** - * Menu callback; Creates the form for configuration of a single action. - * - * We provide the "Description" field. The rest of the form is provided by the - * action. We then provide the Save button. Because we are combining unknown - * form elements with the action configuration form, we use an 'actions_' prefix - * on our elements. - * - * @param $action - * Hash of an action ID or an integer. If it is a hash, we are - * creating a new instance. If it is an integer, we are editing an existing - * instance. - * @return - * A form definition. - * - * @see system_actions_configure_validate() - * @see system_actions_configure_submit() - */ -function system_actions_configure($form, &$form_state, $action = NULL) { - if ($action === NULL) { - drupal_goto('admin/config/system/actions'); - } - - $actions_map = actions_actions_map(actions_list()); - $edit = array(); - - // Numeric action denotes saved instance of a configurable action. - if (is_numeric($action)) { - $aid = $action; - // Load stored parameter values from database. - $data = db_query("SELECT * FROM {actions} WHERE aid = :aid", array(':aid' => $aid))->fetch(); - $edit['actions_label'] = $data->label; - $edit['actions_type'] = $data->type; - $function = $data->callback; - $action = drupal_hash_base64($data->callback); - $params = unserialize($data->parameters); - if ($params) { - foreach ($params as $name => $val) { - $edit[$name] = $val; - } - } - } - // Otherwise, we are creating a new action instance. - else { - $function = $actions_map[$action]['callback']; - $edit['actions_label'] = $actions_map[$action]['label']; - $edit['actions_type'] = $actions_map[$action]['type']; - } - - $form['actions_label'] = array( - '#type' => 'textfield', - '#title' => t('Label'), - '#default_value' => $edit['actions_label'], - '#maxlength' => '255', - '#description' => t('A unique label for this advanced action. This label will be displayed in the interface of modules that integrate with actions, such as Trigger module.'), - '#weight' => -10 - ); - $action_form = $function . '_form'; - $form = array_merge($form, $action_form($edit)); - $form['actions_type'] = array( - '#type' => 'value', - '#value' => $edit['actions_type'], - ); - $form['actions_action'] = array( - '#type' => 'hidden', - '#value' => $action, - ); - // $aid is set when configuring an existing action instance. - if (isset($aid)) { - $form['actions_aid'] = array( - '#type' => 'hidden', - '#value' => $aid, - ); - } - $form['actions_configured'] = array( - '#type' => 'hidden', - '#value' => '1', - ); - $form['actions'] = array('#type' => 'actions'); - $form['actions']['submit'] = array( - '#type' => 'submit', - '#value' => t('Save'), - '#weight' => 13 - ); - - return $form; -} - -/** - * Validate system_actions_configure() form submissions. - */ -function system_actions_configure_validate($form, &$form_state) { - $function = actions_function_lookup($form_state['values']['actions_action']) . '_validate'; - // Hand off validation to the action. - if (function_exists($function)) { - $function($form, $form_state); - } -} - -/** - * Process system_actions_configure() form submissions. - */ -function system_actions_configure_submit($form, &$form_state) { - $function = actions_function_lookup($form_state['values']['actions_action']); - $submit_function = $function . '_submit'; - - // Action will return keyed array of values to store. - $params = $submit_function($form, $form_state); - $aid = isset($form_state['values']['actions_aid']) ? $form_state['values']['actions_aid'] : NULL; - - actions_save($function, $form_state['values']['actions_type'], $params, $form_state['values']['actions_label'], $aid); - drupal_set_message(t('The action has been successfully saved.')); - - $form_state['redirect'] = 'admin/config/system/actions/manage'; -} - -/** - * Create the form for confirmation of deleting an action. - * - * @see system_actions_delete_form_submit() - * @ingroup forms - */ -function system_actions_delete_form($form, &$form_state, $action) { - $form['aid'] = array( - '#type' => 'hidden', - '#value' => $action->aid, - ); - return confirm_form($form, - t('Are you sure you want to delete the action %action?', array('%action' => $action->label)), - 'admin/config/system/actions/manage', - t('This cannot be undone.'), - t('Delete'), - t('Cancel') - ); -} - -/** - * Process system_actions_delete form submissions. - * - * Post-deletion operations for action deletion. - */ -function system_actions_delete_form_submit($form, &$form_state) { - $aid = $form_state['values']['aid']; - $action = actions_load($aid); - actions_delete($aid); - watchdog('user', 'Deleted action %aid (%action)', array('%aid' => $aid, '%action' => $action->label)); - drupal_set_message(t('Action %action was deleted', array('%action' => $action->label))); - $form_state['redirect'] = 'admin/config/system/actions/manage'; -} - -/** - * Post-deletion operations for deleting action orphans. - * - * @param $orphaned - * An array of orphaned actions. - */ -function system_action_delete_orphans_post($orphaned) { - foreach ($orphaned as $callback) { - drupal_set_message(t("Deleted orphaned action (%action).", array('%action' => $callback))); - } -} - -/** - * Remove actions that are in the database but not supported by any enabled module. - */ -function system_actions_remove_orphans() { - actions_synchronize(TRUE); - drupal_goto('admin/config/system/actions/manage'); -} diff --git a/core/modules/system/system.api.php b/core/modules/system/system.api.php index 851b6fd..e78c113 100644 --- a/core/modules/system/system.api.php +++ b/core/modules/system/system.api.php @@ -3279,103 +3279,6 @@ function hook_file_mimetype_mapping_alter(&$mapping) { } /** - * Declares information about actions. - * - * Any module can define actions, and then call actions_do() to make those - * actions happen in response to events. The trigger module provides a user - * interface for associating actions with module-defined triggers, and it makes - * sure the core triggers fire off actions when their events happen. - * - * An action consists of two or three parts: - * - an action definition (returned by this hook) - * - a function which performs the action (which by convention is named - * MODULE_description-of-function_action) - * - an optional form definition function that defines a configuration form - * (which has the name of the action function with '_form' appended to it.) - * - * The action function takes two to four arguments, which come from the input - * arguments to actions_do(). - * - * @return - * An associative array of action descriptions. The keys of the array - * are the names of the action functions, and each corresponding value - * is an associative array with the following key-value pairs: - * - 'type': The type of object this action acts upon. Core actions have types - * 'node', 'user', 'comment', and 'system'. - * - 'label': The human-readable name of the action, which should be passed - * through the t() function for translation. - * - 'configurable': If FALSE, then the action doesn't require any extra - * configuration. If TRUE, then your module must define a form function with - * the same name as the action function with '_form' appended (e.g., the - * form for 'node_assign_owner_action' is 'node_assign_owner_action_form'.) - * This function takes $context as its only parameter, and is paired with - * the usual _submit function, and possibly a _validate function. - * - 'triggers': An array of the events (that is, hooks) that can trigger this - * action. For example: array('node_insert', 'user_update'). You can also - * declare support for any trigger by returning array('any') for this value. - * - 'behavior': (optional) A machine-readable array of behaviors of this - * action, used to signal additionally required actions that may need to be - * triggered. Currently recognized behaviors by Trigger module: - * - 'changes_property': If an action with this behavior is assigned to a - * trigger other than a "presave" hook, any save actions also assigned to - * this trigger are moved later in the list. If no save action is present, - * one will be added. - * Modules that are processing actions (like Trigger module) should take - * special care for the "presave" hook, in which case a dependent "save" - * action should NOT be invoked. - * - * @ingroup actions - */ -function hook_action_info() { - return array( - 'comment_unpublish_action' => array( - 'type' => 'comment', - 'label' => t('Unpublish comment'), - 'configurable' => FALSE, - 'behavior' => array('changes_property'), - 'triggers' => array('comment_presave', 'comment_insert', 'comment_update'), - ), - 'comment_unpublish_by_keyword_action' => array( - 'type' => 'comment', - 'label' => t('Unpublish comment containing keyword(s)'), - 'configurable' => TRUE, - 'behavior' => array('changes_property'), - 'triggers' => array('comment_presave', 'comment_insert', 'comment_update'), - ), - 'comment_save_action' => array( - 'type' => 'comment', - 'label' => t('Save comment'), - 'configurable' => FALSE, - 'triggers' => array('comment_insert', 'comment_update'), - ), - ); -} - -/** - * Executes code after an action is deleted. - * - * @param $aid - * The action ID. - */ -function hook_actions_delete($aid) { - db_delete('actions_assignments') - ->condition('aid', $aid) - ->execute(); -} - -/** - * Alters the actions declared by another module. - * - * Called by actions_list() to allow modules to alter the return values from - * implementations of hook_action_info(). - * - * @see trigger_example_action_info_alter() - */ -function hook_action_info_alter(&$actions) { - $actions['node_unpublish_action']['label'] = t('Unpublish and remove from public view.'); -} - -/** * Declare archivers to the system. * * An archiver is a class that is able to package and unpackage one or more files diff --git a/core/modules/system/system.install b/core/modules/system/system.install index 6f81509..61a2833 100644 --- a/core/modules/system/system.install +++ b/core/modules/system/system.install @@ -539,47 +539,6 @@ function system_schema() { 'primary key' => array('name'), ); - $schema['actions'] = array( - 'description' => 'Stores action information.', - 'fields' => array( - 'aid' => array( - 'description' => 'Primary Key: Unique actions ID.', - 'type' => 'varchar', - 'length' => 255, - 'not null' => TRUE, - 'default' => '0', - ), - 'type' => array( - 'description' => 'The object that that action acts on (node, user, comment, system or custom types.)', - 'type' => 'varchar', - 'length' => 32, - 'not null' => TRUE, - 'default' => '', - ), - 'callback' => array( - 'description' => 'The callback function that executes when the action runs.', - 'type' => 'varchar', - 'length' => 255, - 'not null' => TRUE, - 'default' => '', - ), - 'parameters' => array( - 'description' => 'Parameters to be passed to the callback function.', - 'type' => 'blob', - 'not null' => TRUE, - 'size' => 'big', - ), - 'label' => array( - 'description' => 'Label of the action.', - 'type' => 'varchar', - 'length' => 255, - 'not null' => TRUE, - 'default' => '0', - ), - ), - 'primary key' => array('aid'), - ); - $schema['batch'] = array( 'description' => 'Stores details about batches (processes that run in multiple HTTP requests).', 'fields' => array( diff --git a/core/modules/system/system.module b/core/modules/system/system.module index e2e16ae..35cff38 100644 --- a/core/modules/system/system.module +++ b/core/modules/system/system.module @@ -82,8 +82,6 @@ function system_help($path, $arg) { $output .= '
' . t('In order for the site and its modules to continue to operate well, a set of routine administrative operations must run on a regular basis. The System module manages this task by making use of a system cron job. You can verify the status of cron tasks by visiting the Status report page. For more information, see the online handbook entry for configuring cron jobs. You can set up cron job by visiting Cron configuration page', array('@status' => url('admin/reports/status'), '@handbook' => 'http://drupal.org/cron', '@cron' => url('admin/config/system/cron'))) . '
'; $output .= '
' . t('Configuring basic site settings') . '
'; $output .= '
' . t('The System module also handles basic configuration options for your site, including Date and time settings, File system settings, Clean URL support, Site name and other information, and a Maintenance mode for taking your site temporarily offline.', array('@date-time-settings' => url('admin/config/regional/date-time'), '@file-system' => url('admin/config/media/file-system'), '@clean-url' => url('admin/config/search/clean-urls'), '@site-info' => url('admin/config/system/site-information'), '@maintenance-mode' => url('admin/config/development/maintenance'))) . '
'; - $output .= '
' . t('Configuring actions') . '
'; - $output .= '
' . t('Actions are individual tasks that the system can do, such as unpublishing a piece of content or banning a user. Modules, such as the Trigger module, can fire these actions when certain system events happen; for example, when a new post is added or when a user logs in. Modules may also provide additional actions. Visit the Actions page to configure actions.', array('@trigger-help' => url('admin/help/trigger'), '@actions' => url('admin/config/system/actions'))) . '
'; $output .= ''; return $output; case 'admin/index': @@ -124,16 +122,6 @@ function system_help($path, $arg) { return '

' . t('Use maintenance mode when making major updates, particularly if the updates could disrupt visitors or the update process. Examples include upgrading, importing or exporting content, modifying a theme, modifying content types, and making backups.') . '

'; } break; - case 'admin/config/system/actions': - case 'admin/config/system/actions/manage': - $output = ''; - $output .= '

' . t('There are two types of actions: simple and advanced. Simple actions do not require any additional configuration and are listed here automatically. Advanced actions need to be created and configured before they can be used because they have options that need to be specified; for example, sending an e-mail to a specified address or unpublishing content containing certain words. To create an advanced action, select the action from the drop-down list in the advanced action section below and click the Create button.') . '

'; - if (module_exists('trigger')) { - $output .= '

' . t('You may proceed to the Triggers page to assign these actions to system events.', array('@url' => url('admin/structure/trigger'))) . '

'; - } - return $output; - case 'admin/config/system/actions/configure': - return t('An advanced action offers additional configuration options which may be filled out below. Changing the Description field is recommended in order to better identify the precise action taking place. This description will be displayed in modules such as the Trigger module when assigning actions to system events, so it is best if it is as descriptive as possible (for example, "Send e-mail to Moderation Team" rather than simply "Send e-mail").'); case 'admin/config/people/ip-blocking': return '

' . t('IP addresses listed here are blocked from your site. Blocked addresses are completely forbidden from accessing the site and instead see a brief message explaining the situation.') . '

'; case 'admin/reports/status': @@ -220,9 +208,6 @@ function system_permission() { 'title' => t('Administer software updates'), 'restrict access' => TRUE, ), - 'administer actions' => array( - 'title' => t('Administer actions'), - ), 'access administration pages' => array( 'title' => t('Use the administration pages and help'), ), @@ -929,44 +914,6 @@ function system_menu() { 'access arguments' => array('access administration pages'), 'file' => 'system.admin.inc', ); - $items['admin/config/system/actions'] = array( - 'title' => 'Actions', - 'description' => 'Manage the actions defined for your site.', - 'access arguments' => array('administer actions'), - 'page callback' => 'system_actions_manage', - 'file' => 'system.admin.inc', - ); - $items['admin/config/system/actions/manage'] = array( - 'title' => 'Manage actions', - 'description' => 'Manage the actions defined for your site.', - 'page callback' => 'system_actions_manage', - 'type' => MENU_DEFAULT_LOCAL_TASK, - 'weight' => -2, - 'file' => 'system.admin.inc', - ); - $items['admin/config/system/actions/configure'] = array( - 'title' => 'Configure an advanced action', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('system_actions_configure'), - 'access arguments' => array('administer actions'), - 'type' => MENU_VISIBLE_IN_BREADCRUMB, - 'file' => 'system.admin.inc', - ); - $items['admin/config/system/actions/delete/%actions'] = array( - 'title' => 'Delete action', - 'description' => 'Delete an action.', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('system_actions_delete_form', 5), - 'access arguments' => array('administer actions'), - 'file' => 'system.admin.inc', - ); - $items['admin/config/system/actions/orphan'] = array( - 'title' => 'Remove orphans', - 'page callback' => 'system_actions_remove_orphans', - 'access arguments' => array('administer actions'), - 'type' => MENU_CALLBACK, - 'file' => 'system.admin.inc', - ); $items['admin/config/system/site-information'] = array( 'title' => 'Site information', 'description' => t('Change site name, e-mail address, slogan, default front page, and number of posts per page, error pages.'), @@ -3041,159 +2988,6 @@ function system_flush_caches() { } /** - * Implements hook_action_info(). - */ -function system_action_info() { - return array( - 'system_message_action' => array( - 'type' => 'system', - 'label' => t('Display a message to the user'), - 'configurable' => TRUE, - 'triggers' => array('any'), - ), - 'system_send_email_action' => array( - 'type' => 'system', - 'label' => t('Send e-mail'), - 'configurable' => TRUE, - 'triggers' => array('any'), - ), - 'system_block_ip_action' => array( - 'type' => 'user', - 'label' => t('Ban IP address of current user'), - 'configurable' => FALSE, - 'triggers' => array('any'), - ), - 'system_goto_action' => array( - 'type' => 'system', - 'label' => t('Redirect to URL'), - 'configurable' => TRUE, - 'triggers' => array('any'), - ), - ); -} - -/** - * Return a form definition so the Send email action can be configured. - * - * @param $context - * Default values (if we are editing an existing action instance). - * - * @return - * Form definition. - * - * @see system_send_email_action_validate() - * @see system_send_email_action_submit() - */ -function system_send_email_action_form($context) { - // Set default values for form. - if (!isset($context['recipient'])) { - $context['recipient'] = ''; - } - if (!isset($context['subject'])) { - $context['subject'] = ''; - } - if (!isset($context['message'])) { - $context['message'] = ''; - } - - $form['recipient'] = array( - '#type' => 'textfield', - '#title' => t('Recipient'), - '#default_value' => $context['recipient'], - '#maxlength' => '254', - '#description' => t('The e-mail address to which the message should be sent OR enter [node:author:mail], [comment:author:mail], etc. if you would like to send an e-mail to the author of the original post.'), - ); - $form['subject'] = array( - '#type' => 'textfield', - '#title' => t('Subject'), - '#default_value' => $context['subject'], - '#maxlength' => '254', - '#description' => t('The subject of the message.'), - ); - $form['message'] = array( - '#type' => 'textarea', - '#title' => t('Message'), - '#default_value' => $context['message'], - '#cols' => '80', - '#rows' => '20', - '#description' => t('The message that should be sent. You may include placeholders like [node:title], [user:name], and [comment:body] to represent data that will be different each time message is sent. Not all placeholders will be available in all contexts.'), - ); - return $form; -} - -/** - * Validate system_send_email_action form submissions. - */ -function system_send_email_action_validate($form, $form_state) { - $form_values = $form_state['values']; - // Validate the configuration form. - if (!valid_email_address($form_values['recipient']) && strpos($form_values['recipient'], ':mail') === FALSE) { - // We want the literal %author placeholder to be emphasized in the error message. - form_set_error('recipient', t('Enter a valid email address or use a token e-mail address such as %author.', array('%author' => '[node:author:mail]'))); - } -} - -/** - * Process system_send_email_action form submissions. - */ -function system_send_email_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( - 'recipient' => $form_values['recipient'], - 'subject' => $form_values['subject'], - 'message' => $form_values['message'], - ); - return $params; -} - -/** - * Sends an e-mail message. - * - * @param object $entity - * An optional node object, which will be added as $context['node'] if - * provided. - * @param array $context - * Array with the following elements: - * - 'recipient': E-mail message recipient. This will be passed through - * token_replace(). - * - 'subject': The subject of the message. This will be passed through - * token_replace(). - * - 'message': The message to send. This will be passed through - * token_replace(). - * - Other elements will be used as the data for token replacement. - * - * @ingroup actions - */ -function system_send_email_action($entity, $context) { - if (empty($context['node'])) { - $context['node'] = $entity; - } - - $recipient = token_replace($context['recipient'], $context); - - // If the recipient is a registered user with a language preference, use - // the recipient's preferred language. Otherwise, use the system default - // language. - $recipient_account = user_load_by_mail($recipient); - if ($recipient_account) { - $language = user_preferred_language($recipient_account); - } - else { - $language = language_default(); - } - $params = array('context' => $context); - - if (drupal_mail('system', 'action_send_email', $recipient, $language, $params)) { - watchdog('action', 'Sent email to %recipient', array('%recipient' => $recipient)); - } - else { - watchdog('error', 'Unable to send email to %recipient', array('%recipient' => $recipient)); - } -} - -/** * Implements hook_mail(). */ function system_mail($key, &$message, $params) { @@ -3206,96 +3000,6 @@ function system_mail($key, &$message, $params) { $message['body'][] = $body; } -function system_message_action_form($context) { - $form['message'] = array( - '#type' => 'textarea', - '#title' => t('Message'), - '#default_value' => isset($context['message']) ? $context['message'] : '', - '#required' => TRUE, - '#rows' => '8', - '#description' => t('The message to be displayed to the current user. You may include placeholders like [node:title], [user:name], and [comment:body] to represent data that will be different each time message is sent. Not all placeholders will be available in all contexts.'), - ); - return $form; -} - -function system_message_action_submit($form, $form_state) { - return array('message' => $form_state['values']['message']); -} - -/** - * Sends a message to the current user's screen. - * - * @param object $entity - * An optional node object, which will be added as $context['node'] if - * provided. - * @param array $context - * Array with the following elements: - * - 'message': The message to send. This will be passed through - * token_replace(). - * - Other elements will be used as the data for token replacement in - * the message. - * - * @ingroup actions - */ -function system_message_action(&$entity, $context = array()) { - if (empty($context['node'])) { - $context['node'] = $entity; - } - - $context['message'] = token_replace(filter_xss_admin($context['message']), $context); - drupal_set_message($context['message']); -} - -/** - * Settings form for system_goto_action(). - */ -function system_goto_action_form($context) { - $form['url'] = array( - '#type' => 'textfield', - '#title' => t('URL'), - '#description' => t('The URL to which the user should be redirected. This can be an internal URL like node/1234 or an external URL like http://drupal.org.'), - '#default_value' => isset($context['url']) ? $context['url'] : '', - '#required' => TRUE, - ); - return $form; -} - -function system_goto_action_submit($form, $form_state) { - return array( - 'url' => $form_state['values']['url'] - ); -} - -/** - * Redirects to a different URL. - * - * @param $entity - * Ignored. - * @param array $context - * Array with the following elements: - * - 'url': URL to redirect to. This will be passed through - * token_replace(). - * - Other elements will be used as the data for token replacement. - * - * @ingroup actions - */ -function system_goto_action($entity, $context) { - drupal_goto(token_replace($context['url'], $context)); -} - -/** - * Blocks the current user's IP address. - * - * @ingroup actions - */ -function system_block_ip_action() { - $ip = ip_address(); - db_insert('blocked_ips') - ->fields(array('ip' => $ip)) - ->execute(); - watchdog('action', 'Banned IP address %ip', array('%ip' => $ip)); -} - /** * Generate an array of time zones and their local time&date. * diff --git a/core/modules/trigger/tests/trigger_test.info b/core/modules/trigger/tests/trigger_test.info deleted file mode 100644 index 8b25cd9..0000000 --- a/core/modules/trigger/tests/trigger_test.info +++ /dev/null @@ -1,5 +0,0 @@ -name = "Trigger Test" -description = "Support module for Trigger tests." -package = Testing -core = 8.x -hidden = TRUE diff --git a/core/modules/trigger/tests/trigger_test.module b/core/modules/trigger/tests/trigger_test.module deleted file mode 100644 index 0e3f3f8..0000000 --- a/core/modules/trigger/tests/trigger_test.module +++ /dev/null @@ -1,133 +0,0 @@ - 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. - 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'), - ), - ), - ); -} - -/** - * 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); -} diff --git a/core/modules/trigger/trigger.admin.inc b/core/modules/trigger/trigger.admin.inc deleted file mode 100644 index 7509eb3..0000000 --- a/core/modules/trigger/trigger.admin.inc +++ /dev/null @@ -1,309 +0,0 @@ - $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; -} - -/** - * Confirm 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 - * @param $aid - * The action ID. - * @ingroup forms - * @see trigger_unassign_submit() - */ -function trigger_unassign($form, $form_state, $module, $hook = NULL, $aid = NULL) { - if (!($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') - ); -} - -/** - * Submit callback for trigger_unassign() form. - */ -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(); - $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. - * - * @ingoup forms - * @see trigger_assign_form_validate() - * @see trigger_assign_form_submit() - */ -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. Add action.', array('@link' => url('admin/config/system/actions/manage'))) - ); - } - return $form; -} - -/** - * Validation function for trigger_assign_form(). - * - * Makes sure that the user is not re-assigning an action to an event. - */ -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.')); - } - } -} - -/** - * Submit function for trigger_assign_form(). - */ -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']))); - } - } - } -} - -/** - * 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; -} - diff --git a/core/modules/trigger/trigger.api.php b/core/modules/trigger/trigger.api.php deleted file mode 100644 index 839c1d4..0000000 --- a/core/modules/trigger/trigger.api.php +++ /dev/null @@ -1,78 +0,0 @@ - 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". - */ diff --git a/core/modules/trigger/trigger.info b/core/modules/trigger/trigger.info deleted file mode 100644 index f47604d..0000000 --- a/core/modules/trigger/trigger.info +++ /dev/null @@ -1,7 +0,0 @@ -name = Trigger -description = Enables actions to be fired on certain system events, such as when new content is created. -package = Core -version = VERSION -core = 8.x -files[] = trigger.test -configure = admin/structure/trigger diff --git a/core/modules/trigger/trigger.install b/core/modules/trigger/trigger.install deleted file mode 100644 index 7dded60..0000000 --- a/core/modules/trigger/trigger.install +++ /dev/null @@ -1,53 +0,0 @@ - 'Maps trigger to hook and operation assignments from trigger.module.', - 'fields' => array( - 'hook' => array( - 'type' => 'varchar', - 'length' => 32, - '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(); -} diff --git a/core/modules/trigger/trigger.module b/core/modules/trigger/trigger.module deleted file mode 100644 index 6c1f58f..0000000 --- a/core/modules/trigger/trigger.module +++ /dev/null @@ -1,631 +0,0 @@ -' . 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 Actions settings page 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'))) . '

'; - - $module = $matches[1]; - $trigger_info = _trigger_tab_information(); - if (!empty($trigger_info[$module])) { - $explanation .= '

' . 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 @module-name module happen.', array('@module-help' => url('admin/help/' . $module), '@module-name' => $trigger_info[$module])) . '

'; - } - - return $explanation; - } - - if ($path == 'admin/help#trigger') { - $output = ''; - $output .= '

' . t('About') . '

'; - $output .= '

' . t('The Trigger module provides the ability to cause actions to run when certain triggers 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 Trigger module.', array('@trigger' => 'http://drupal.org/handbook/modules/trigger/')) . '

'; - $output .= '

' . t('Uses') . '

'; - $output .= '
'; - $output .= '
' . t('Configuring triggers and actions') . '
'; - $output .= '
' . 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 Actions configuration page, where you can either verify that the action you want is already listed, or create a new advanced 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 Triggers configuration page 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'))) . '
'; - $output .= '
'; - 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'), - 'access arguments' => array('administer actions'), - 'file' => 'trigger.admin.inc', - ); - - return $items; -} - -/** - * 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) { - return 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); -} - -/** - * 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 $op - * Operation 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 $op - * Operation 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. - */ -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(); -} - -/** - * Retrieves and caches information from hook_trigger_info() implementations. - */ -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; -} diff --git a/core/modules/trigger/trigger.test b/core/modules/trigger/trigger.test deleted file mode 100644 index 9a9a4ba..0000000 --- a/core/modules/trigger/trigger.test +++ /dev/null @@ -1,740 +0,0 @@ -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"])), t('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'], t('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.'), t('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']))), t('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, t('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); - - for ($index = 0; $index < 3; $index++) { - $edit = array('title' => $this->randomName()); - $this->drupalPost('node/add/page', $edit, t('Save')); - } - - $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[1]' => TRUE, - 'nodes[2]' => TRUE, - ); - $this->drupalPost('admin/content', $edit, t('Update')); - $count = variable_get('trigger_test_generic_any_action', 0); - $this->assertTrue($count == 2, t('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, t('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, t('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]), t('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); - } - - - /** - * 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); - } - - /** - * 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, - t('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, t('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, t('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, t('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), t('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), t('One Action assigned to the hook')); - $this->assertEqual($actions[$aid]['label'], $action_edit['actions_label'], t('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), t('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), t('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"])), t('Make sure the Basic page has actually been created')); - - // Action should have been fired. - $this->assertTrue(variable_get('trigger_test_generic_any_action', FALSE), t('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"])), t('Make sure the Basic page can be updated with the missing trigger function.')); - } -}