diff --git a/includes/actions.inc b/includes/actions.inc deleted file mode 100644 index 5dce71e..0000000 --- a/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(), LOG_ERR); - 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), LOG_WARNING); - } - } -} - -/** - * 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/includes/common.inc b/includes/common.inc index 95e03e8..8e039f5 100644 --- a/includes/common.inc +++ b/includes/common.inc @@ -4898,7 +4898,6 @@ function _drupal_bootstrap_full() { require_once DRUPAL_ROOT . '/includes/image.inc'; require_once DRUPAL_ROOT . '/includes/form.inc'; require_once DRUPAL_ROOT . '/includes/mail.inc'; - require_once DRUPAL_ROOT . '/includes/actions.inc'; require_once DRUPAL_ROOT . '/includes/ajax.inc'; require_once DRUPAL_ROOT . '/includes/token.inc'; require_once DRUPAL_ROOT . '/includes/errors.inc'; @@ -7123,9 +7122,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', 'cache_filter', 'cache_bootstrap', 'cache_page'); diff --git a/includes/theme.inc b/includes/theme.inc index 67cbe85..c211248 100644 --- a/includes/theme.inc +++ b/includes/theme.inc @@ -985,7 +985,7 @@ function drupal_find_theme_functions($cache, $prefixes) { // start with. The default is the name of the hook followed by '__'. An // 'base hook' key is added to each entry made for a found suggestion, // so that common functionality can be implemented for all suggestions of - // the same base hook. To keep things simple, deep heirarchy of + // the same base hook. To keep things simple, deep hierarchy of // suggestions is not supported: each suggestion's 'base hook' key // refers to a base hook, not to another suggestion, and all suggestions // are found using the base hook's pattern, not a pattern from an @@ -995,7 +995,7 @@ function drupal_find_theme_functions($cache, $prefixes) { $matches = preg_grep('/^' . $prefix . '_' . $pattern . '/', $functions['user']); if ($matches) { foreach ($matches as $match) { - $new_hook = str_replace($prefix . '_', '', $match); + $new_hook = substr($match, strlen($prefix) + 1); $arg_name = isset($info['variables']) ? 'variables' : 'render element'; $implementations[$new_hook] = array( 'function' => $match, diff --git a/includes/token.inc b/includes/token.inc index 0e12223..7a5fea1 100644 --- a/includes/token.inc +++ b/includes/token.inc @@ -4,16 +4,16 @@ * @file * Drupal placeholder/token replacement system. * - * Provides a set of extensible API functions for replacing placeholders in text - * with meaningful values. + * API functions for replacing placeholders in text with meaningful values. * - * For example: When configuring automated emails, an administrator enters standard - * text for the email. Variables like the title of a node and the date the email - * was sent can be entered as placeholders like [node:title] and [date:short]. - * When a Drupal module prepares to send the email, it can call the token_replace() - * function, passing in the text. The token system will scan the text for placeholder - * tokens, give other modules an opportunity to replace them with meaningful text, - * then return the final product to the original module. + * For example: When configuring automated emails, an administrator enters + * standard text for the email. Variables like the title of a node and the date + * the email was sent can be entered as placeholders like [node:title] and + * [date:short]. When a Drupal module prepares to send the email, it can call + * the token_replace() function, passing in the text. The token system will + * scan the text for placeholder tokens, give other modules an opportunity to + * replace them with meaningful text, then return the final product to the + * original module. * * Tokens follow the form: [$type:$name], where $type is a general class of * tokens like 'node', 'user', or 'comment' and $name is the name of a given @@ -37,8 +37,8 @@ * Some tokens may be chained in the form of [$type:$pointer:$name], where $type * is a normal token type, $pointer is a reference to another token type, and * $name is the name of a given placeholder. For example, [node:author:mail]. In - * that example, 'author' is a pointer to the 'user' account that created the node, - * and 'mail' is a placeholder available for any 'user'. + * that example, 'author' is a pointer to the 'user' account that created the + * node, and 'mail' is a placeholder available for any 'user'. * * @see token_replace() * @see hook_tokens() @@ -46,7 +46,7 @@ */ /** - * Replace all tokens in a given string with appropriate values. + * Replaces all tokens in a given string with appropriate values. * * @param $text * A string potentially containing replaceable tokens. @@ -54,22 +54,25 @@ * (optional) An array of keyed objects. For simple replacement scenarios * 'node', 'user', and others are common keys, with an accompanying node or * user object being the value. Some token types, like 'site', do not require - * any explicit information from $data and can be replaced even if it is empty. + * any explicit information from $data and can be replaced even if it is + * empty. * @param $options * (optional) A keyed array of settings and flags to control the token * replacement process. Supported options are: * - language: A language object to be used when generating locale-sensitive * tokens. * - callback: A callback function that will be used to post-process the array - * of token replacements after they are generated. For example, a module using - * tokens in a text-only email might provide a callback to strip HTML + * of token replacements after they are generated. For example, a module + * using tokens in a text-only email might provide a callback to strip HTML * entities from token values before they are inserted into the final text. * - clear: A boolean flag indicating that tokens should be removed from the * final text if no replacement value can be generated. * - sanitize: A boolean flag indicating that tokens should be sanitized for - * display to a web browser. Defaults to TRUE. Developers who set this option - * to FALSE assume responsibility for running filter_xss(), check_plain() or - * other appropriate scrubbing functions before displaying data to users. + * display to a web browser. Defaults to TRUE. Developers who set this + * option to FALSE assume responsibility for running filter_xss(), + * check_plain() or other appropriate scrubbing functions before displaying + * data to users. + * * @return * Text with tokens replaced. */ @@ -95,10 +98,11 @@ function token_replace($text, array $data = array(), array $options = array()) { } /** - * Build a list of all token-like patterns that appear in the text. + * Builds a list of all token-like patterns that appear in the text. * * @param $text * The text to be scanned for possible tokens. + * * @return * An associative array of discovered tokens, grouped by type. */ @@ -129,7 +133,7 @@ function token_scan($text) { } /** - * Generate replacement values for a list of tokens. + * Generates replacement values for a list of tokens. * * @param $type * The type of token being replaced. 'node', 'user', and 'date' are common. @@ -140,20 +144,22 @@ function token_scan($text) { * (optional) An array of keyed objects. For simple replacement scenarios * 'node', 'user', and others are common keys, with an accompanying node or * user object being the value. Some token types, like 'site', do not require - * any explicit information from $data and can be replaced even if it is empty. + * any explicit information from $data and can be replaced even if it is + * empty. * @param $options * (optional) A keyed array of settings and flags to control the token * replacement process. Supported options are: - * - 'language' A language object to be used when generating locale-sensitive + * - language: A language object to be used when generating locale-sensitive * tokens. - * - 'callback' A callback function that will be used to post-process the array - * of token replacements after they are generated. Can be used when modules - * require special formatting of token text, for example URL encoding or - * truncation to a specific length. - * - 'sanitize' A boolean flag indicating that tokens should be sanitized for + * - callback: A callback function that will be used to post-process the + * array of token replacements after they are generated. Can be used when + * modules require special formatting of token text, for example URL + * encoding or truncation to a specific length. + * - sanitize: A boolean flag indicating that tokens should be sanitized for * display to a web browser. Developers who set this option to FALSE assume * responsibility for running filter_xss(), check_plain() or other * appropriate scrubbing functions before displaying data to users. + * * @return * An associative array of replacement values, keyed by the original 'raw' * tokens that were found in the source text. For example: @@ -179,7 +185,7 @@ function token_generate($type, array $tokens, array $data = array(), array $opti } /** - * Given a list of tokens, return those that begin with a specific prefix. + * Given a list of tokens, returns those that begin with a specific prefix. * * Used to extract a group of 'chained' tokens (such as [node:author:name]) from * the full list of tokens found in text. For example: @@ -187,7 +193,7 @@ function token_generate($type, array $tokens, array $data = array(), array $opti * $data = array( * 'author:name' => '[node:author:name]', * 'title' => '[node:title]', - * 'created' => '[node:author:name]', + * 'created' => '[node:created]', * ); * $results = token_find_with_prefix($data, 'author'); * $results == array('name' => '[node:author:name]'); @@ -200,6 +206,7 @@ function token_generate($type, array $tokens, array $data = array(), array $opti * @param $delimiter * An optional string containing the character that separates the prefix from * the rest of the token. Defaults to ':'. + * * @return * An associative array of discovered tokens, with the prefix and delimiter * stripped from the key. @@ -236,6 +243,7 @@ function token_find_with_prefix(array $tokens, $prefix, $delimiter = ':') { * 'type' => 'user', * ); * @endcode + * * @return * An associative array of token information, grouped by token type. */ diff --git a/modules/actions/actions.admin.inc b/modules/actions/actions.admin.inc new file mode 100644 index 0000000..ae8cdc9 --- /dev/null +++ b/modules/actions/actions.admin.inc @@ -0,0 +1,279 @@ + $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['actions_actions_header'] = array('#markup' => '

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

'); + $build['actions_actions_table'] = array('#markup' => theme('table', array('header' => $header, 'rows' => $row))); + } + + if ($actions_map) { + $build['actions_actions_manage_form'] = drupal_get_form('actions_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 actions_actions_manage_form_submit() + */ +function actions_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 actions_actions_manage form submissions. + * + * @see actions_actions_manage_form() + */ +function actions_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 actions_actions_configure_validate() + * @see actions_actions_configure_submit() + */ +function actions_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 actions_actions_configure() form submissions. + */ +function actions_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 actions_actions_configure() form submissions. + */ +function actions_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 actions_actions_delete_form_submit() + * @ingroup forms + */ +function actions_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 actions_actions_delete form submissions. + * + * Post-deletion operations for action deletion. + */ +function actions_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 actions_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 actions_actions_remove_orphans() { + actions_synchronize(TRUE); + drupal_goto('admin/config/system/actions/manage'); +} diff --git a/modules/actions/actions.api.php b/modules/actions/actions.api.php new file mode 100644 index 0000000..78d3439 --- /dev/null +++ b/modules/actions/actions.api.php @@ -0,0 +1,108 @@ + 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.'); +} diff --git a/modules/actions/actions.info b/modules/actions/actions.info new file mode 100644 index 0000000..0bcc7f0 --- /dev/null +++ b/modules/actions/actions.info @@ -0,0 +1,7 @@ +name = Actions +description = Provides the actions API. +package = Core +version = VERSION +core = 7.x +files[] = tests/actions.test +configure = admin/config/system/actions diff --git a/modules/actions/actions.install b/modules/actions/actions.install new file mode 100644 index 0000000..2a9a39c --- /dev/null +++ b/modules/actions/actions.install @@ -0,0 +1,55 @@ + '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'), + ); + + return $schema; +} diff --git a/modules/actions/actions.module b/modules/actions/actions.module new file mode 100644 index 0000000..953cabb --- /dev/null +++ b/modules/actions/actions.module @@ -0,0 +1,741 @@ + array( + 'title' => t('Administer actions'), + ), + ); +} + +/** + * Implements hook_menu_info(). + */ +function actions_menu() { + $items = array(); + + $items['admin/config/system/actions'] = array( + 'title' => 'Actions', + 'description' => 'Manage the actions defined for your site.', + 'access arguments' => array('administer actions'), + 'page callback' => 'actions_actions_manage', + 'file' => 'actions.admin.inc', + ); + $items['admin/config/system/actions/manage'] = array( + 'title' => 'Manage actions', + 'description' => 'Manage the actions defined for your site.', + 'page callback' => 'actions_actions_manage', + 'type' => MENU_DEFAULT_LOCAL_TASK, + 'weight' => -2, + 'file' => 'actions.admin.inc', + ); + $items['admin/config/system/actions/configure'] = array( + 'title' => 'Configure an advanced action', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('actions_actions_configure'), + 'access arguments' => array('administer actions'), + 'type' => MENU_VISIBLE_IN_BREADCRUMB, + 'file' => 'actions.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('actions_actions_delete_form', 5), + 'access arguments' => array('administer actions'), + 'file' => 'actions.admin.inc', + ); + $items['admin/config/system/actions/orphan'] = array( + 'title' => 'Remove orphans', + 'page callback' => 'actions_actions_remove_orphans', + 'access arguments' => array('administer actions'), + 'type' => MENU_CALLBACK, + 'file' => 'actions.admin.inc', + ); + + return $items; +} + +/** + * Implements hook_help(). + */ +function actions_help($path, $arg) { + switch ($arg) { + case 'admin/help#actions': + $output = ''; + $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'))) . '
'; + 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.') . '

'; + } +} + +/** + * Implements hook_flush_caches(). + */ +function actions_flush_caches() { + actions_synchronize(); +} + +/** + * Implements hook_action_info(). + */ +function actions_action_info() { + return array( + 'actions_message_action' => array( + 'type' => 'system', + 'label' => t('Display a message to the user'), + 'configurable' => TRUE, + 'triggers' => array('any'), + ), + 'actions_send_email_action' => array( + 'type' => 'system', + 'label' => t('Send e-mail'), + 'configurable' => TRUE, + 'triggers' => array('any'), + ), + 'actions_block_ip_action' => array( + 'type' => 'user', + 'label' => t('Ban IP address of current user'), + 'configurable' => FALSE, + 'triggers' => array('any'), + ), + 'actions_goto_action' => array( + 'type' => 'system', + 'label' => t('Redirect to URL'), + 'configurable' => TRUE, + 'triggers' => array('any'), + ), + ); +} + +/** + * Implements hook_mail(). + */ +function actions_mail($key, &$message, $params) { + $context = $params['context']; + + $subject = token_replace($context['subject'], $context); + $body = token_replace($context['message'], $context); + + $message['subject'] .= str_replace(array("\r", "\n"), '', $subject); + $message['body'][] = $body; +} + +function actions_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; +} + +/** + * 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 actions_send_email_action_validate() + * @see actions_send_email_action_submit() + */ +function actions_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 email 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 actions_send_email_action form submissions. + */ +function actions_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 actions_send_email_action form submissions. + */ +function actions_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 actions_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('actions', '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)); + } +} + +function actions_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 actions_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 actions_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 actions_goto_action(). + */ +function actions_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 actions_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 actions_goto_action($entity, $context) { + drupal_goto(token_replace($context['url'], $context)); +} + +/** + * Blocks the current user's IP address. + * + * @ingroup actions + */ +function actions_block_ip_action() { + $ip = ip_address(); + db_insert('blocked_ips') + ->fields(array('ip' => $ip)) + ->execute(); + watchdog('action', 'Banned IP address %ip', array('%ip' => $ip)); +} + +/** + * @defgroup actions Actions + * @{ + * Functions that perform an action on a certain system object. + * + * Action functions are declared by modules by implementing hook_action_info(). + * Modules can cause action functions to run by calling actions_do(), and + * trigger.module provides a user interface that lets administrators define + * events that cause action functions to run. + * + * Each action function takes two to four arguments: + * - $entity: The object that the action acts on, such as a node, comment, or + * user. + * - $context: Array of additional information about what triggered the action. + * - $a1, $a2: Optional additional information, which can be passed into + * actions_do() and will be passed along to the action function. + * + * @} End of "defgroup actions". + */ + +/** + * Performs a given list of actions by executing their callback functions. + * + * Given the IDs of actions to perform, this function finds out what the + * callback functions for the actions are by querying the database. Then + * it calls each callback using the function call $function($object, $context, + * $a1, $a2), passing the input arguments of this function (see below) to the + * action function. + * + * @param $action_ids + * The IDs of the actions to perform. Can be a single action ID or an array + * of IDs. IDs of configurable actions must be given as numeric action IDs; + * IDs of non-configurable actions may be given as action function names. + * @param $object + * The object that the action will act on: a node, user, or comment object. + * @param $context + * Associative array containing extra information about what triggered + * the action call, with $context['hook'] giving the name of the hook + * that resulted in this call to actions_do(). + * @param $a1 + * Passed along to the callback. + * @param $a2 + * Passed along to the callback. + * @return + * An associative array containing the results of the functions that + * perform the actions, keyed on action ID. + * + * @ingroup actions + */ +function actions_do($action_ids, $object = NULL, $context = NULL, $a1 = NULL, $a2 = NULL) { + // $stack tracks the number of recursive calls. + static $stack; + $stack++; + if ($stack > 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_WARNING); + } + } +} + +/** + * 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/modules/actions/tests/actions.test b/modules/actions/tests/actions.test new file mode 100644 index 0000000..23587f0 --- /dev/null +++ b/modules/actions/tests/actions.test @@ -0,0 +1,126 @@ + '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/modules/actions/tests/actions_loop_test.info b/modules/actions/tests/actions_loop_test.info new file mode 100644 index 0000000..4350d3d --- /dev/null +++ b/modules/actions/tests/actions_loop_test.info @@ -0,0 +1,6 @@ +name = Actions loop test +description = Support module for action loop testing. +package = Testing +version = VERSION +core = 7.x +hidden = TRUE diff --git a/modules/actions/tests/actions_loop_test.install b/modules/actions/tests/actions_loop_test.install new file mode 100644 index 0000000..b22fd85 --- /dev/null +++ b/modules/actions/tests/actions_loop_test.install @@ -0,0 +1,11 @@ +fields(array('weight' => 1)) + ->condition('name', 'actions_loop_test') + ->execute(); +} diff --git a/modules/actions/tests/actions_loop_test.module b/modules/actions/tests/actions_loop_test.module new file mode 100644 index 0000000..7776490 --- /dev/null +++ b/modules/actions/tests/actions_loop_test.module @@ -0,0 +1,94 @@ + 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/modules/block/block.admin.inc b/modules/block/block.admin.inc index 3981de9..7cf299c 100644 --- a/modules/block/block.admin.inc +++ b/modules/block/block.admin.inc @@ -16,7 +16,7 @@ function block_admin_demo($theme = NULL) { /** * Menu callback for admin/structure/block. * - * @param $theme + * @param $theme * The theme to display the administration page for. If not provided, defaults * to the currently used theme. */ diff --git a/modules/block/block.module b/modules/block/block.module index c5e229b..e0cb691 100644 --- a/modules/block/block.module +++ b/modules/block/block.module @@ -355,7 +355,7 @@ function _block_get_renderable_array($list = array()) { /** * Update the 'block' DB table with the blocks currently exported by modules. * - * @param $theme + * @param $theme * The theme to rehash blocks for. If not provided, defaults to the currently * used theme. * @@ -943,7 +943,15 @@ function template_preprocess_block(&$variables) { $variables['theme_hook_suggestions'][] = 'block__' . $variables['block']->region; $variables['theme_hook_suggestions'][] = 'block__' . $variables['block']->module; - $variables['theme_hook_suggestions'][] = 'block__' . $variables['block']->module . '__' . $variables['block']->delta; + // Hyphens (-) and underscores (_) play a special role in theme suggestions. + // Theme suggestions should only contain underscores, because within + // drupal_find_theme_templates(), underscores are converted to hyphens to + // match template file names, and then converted back to hyphens to match + // pre-processing and other function names. So if your theme suggestion + // contains a hyphen, it will end up as an underscore after this conversion, + // and your function names won't be recognized. So, we need to convert + // hyphens to underscores in block deltas for the theme suggestions. + $variables['theme_hook_suggestions'][] = 'block__' . $variables['block']->module . '__' . strtr($variables['block']->delta, '-', '_'); // Create a valid HTML ID and make sure it is unique. $variables['block_html_id'] = drupal_html_id('block-' . $variables['block']->module . '-' . $variables['block']->delta); diff --git a/modules/block/block.test b/modules/block/block.test index af118a9..022bf38 100644 --- a/modules/block/block.test +++ b/modules/block/block.test @@ -666,3 +666,45 @@ class BlockHTMLIdTestCase extends DrupalWebTestCase { $this->assertRaw('block-block-test-test-html-id', t('HTML id for test block is valid.')); } } + + +/** + * Unit tests for template_preprocess_block(). + */ +class BlockTemplateSuggestionsUnitTest extends DrupalUnitTestCase { + public static function getInfo() { + return array( + 'name' => 'Block template suggestions', + 'description' => 'Test the template_preprocess_block() function.', + 'group' => 'Block', + ); + } + + /** + * Test if template_preprocess_block() handles the suggestions right. + */ + function testBlockThemeHookSuggestions() { + // Define block delta with underscore to be preprocessed + $block1 = new stdClass(); + $block1->module = 'block'; + $block1->delta = 'underscore_test'; + $block1->region = 'footer'; + $variables1 = array(); + $variables1['elements']['#block'] = $block1; + $variables1['elements']['#children'] = ''; + template_preprocess_block($variables1); + $this->assertEqual($variables1['theme_hook_suggestions'], array('block__footer', 'block__block', 'block__block__underscore_test'), t('Found expected block suggestions for delta with underscore')); + + // Define block delta with hyphens to be preprocessed. Hyphens should be + // replaced with underscores. + $block2 = new stdClass(); + $block2->module = 'block'; + $block2->delta = 'hyphen-test'; + $block2->region = 'footer'; + $variables2 = array(); + $variables2['elements']['#block'] = $block2; + $variables2['elements']['#children'] = ''; + template_preprocess_block($variables2); + $this->assertEqual($variables2['theme_hook_suggestions'], array('block__footer', 'block__block', 'block__block__hyphen_test'), t('Hyphens (-) in block delta were replaced by underscore (_)')); + } +} diff --git a/modules/blog/blog.install b/modules/blog/blog.install index f591e71..fffb14b 100644 --- a/modules/blog/blog.install +++ b/modules/blog/blog.install @@ -14,3 +14,10 @@ function blog_install() { $types = node_type_get_types(); node_add_body_field($types['blog']); } + +/** + * Implements hook_uninstall(). + */ +function blog_uninstall() { + variable_del('blog_block_count'); +} diff --git a/modules/book/book.module b/modules/book/book.module index 82d38f7..de9561f 100644 --- a/modules/book/book.module +++ b/modules/book/book.module @@ -279,10 +279,10 @@ function book_block_view($delta = '') { } elseif ($current_bid) { // Only display this block when the user is browsing a book. - $select = db_select('node'); - $select->addField('node', 'title'); - $select->condition('nid', $node->book['bid']); - $select->addTag('node_access'); + $select = db_select('node', 'n') + ->fields('n', array('title')) + ->condition('nid', $node->book['bid']) + ->addTag('node_access'); $title = $select->execute()->fetchField(); // Only show the block if the user has view access for the top-level node. if ($title) { diff --git a/modules/comment/comment.module b/modules/comment/comment.module index ec57dd4..60a9ca4 100644 --- a/modules/comment/comment.module +++ b/modules/comment/comment.module @@ -1465,21 +1465,8 @@ function comment_save($comment) { module_invoke_all('entity_presave', $comment, 'comment'); if ($comment->cid) { - // Update the comment in the database. - db_update('comment') - ->fields(array( - 'status' => $comment->status, - 'created' => $comment->created, - 'changed' => $comment->changed, - 'subject' => $comment->subject, - 'uid' => $comment->uid, - 'name' => $comment->name, - 'mail' => $comment->mail, - 'homepage' => $comment->homepage, - 'language' => $comment->language, - )) - ->condition('cid', $comment->cid) - ->execute(); + + drupal_write_record('comment', $comment, 'cid'); // Ignore slave server temporarily to give time for the // saved comment to be propagated to the slave. @@ -1551,23 +1538,16 @@ function comment_save($comment) { $comment->name = $user->name; } - $comment->cid = db_insert('comment') - ->fields(array( - 'nid' => $comment->nid, - 'pid' => empty($comment->pid) ? 0 : $comment->pid, - 'uid' => $comment->uid, - 'subject' => $comment->subject, - 'hostname' => ip_address(), - 'created' => $comment->created, - 'changed' => $comment->changed, - 'status' => $comment->status, - 'thread' => $thread, - 'name' => $comment->name, - 'mail' => $comment->mail, - 'homepage' => $comment->homepage, - 'language' => $comment->language, - )) - ->execute(); + // Ensure the parent id (pid) has a value set. + if (empty($comment->pid)) { + $comment->pid = 0; + } + + // Add the values which aren't passed into the function. + $comment->thread = $thread; + $comment->hostname = ip_address(); + + drupal_write_record('comment', $comment); // Ignore slave server temporarily to give time for the // created comment to be propagated to the slave. diff --git a/modules/field/field.attach.inc b/modules/field/field.attach.inc index 3b15c76..4ca15f5 100644 --- a/modules/field/field.attach.inc +++ b/modules/field/field.attach.inc @@ -348,7 +348,7 @@ function _field_invoke_multiple($op, $entity_type, $entities, &$a = NULL, &$b = // fields with an empty array (those are not equivalent on update). foreach ($grouped_entities[$field_id] as $id => $entity) { foreach ($grouped_items[$field_id] as $langcode => $items) { - if ($grouped_items[$field_id][$langcode][$id] !== array() || isset($entity->{$field_name}[$langcode])) { + if (isset($grouped_items[$field_id][$langcode][$id]) && ($grouped_items[$field_id][$langcode][$id] !== array() || isset($entity->{$field_name}[$langcode]))) { $entity->{$field_name}[$langcode] = $grouped_items[$field_id][$langcode][$id]; } } diff --git a/modules/field/tests/field.test b/modules/field/tests/field.test index 97510e4..9281273 100644 --- a/modules/field/tests/field.test +++ b/modules/field/tests/field.test @@ -2690,7 +2690,7 @@ class FieldTranslationsTestCase extends FieldTestCase { $extra_languages = mt_rand(1, 4); $languages = $available_languages = field_available_languages($this->entity_type, $this->field); for ($i = 0; $i < $extra_languages; ++$i) { - $languages[] = $this->randomString(2); + $languages[] = $this->randomName(2); } // For each given language provide some random values. @@ -2715,10 +2715,14 @@ class FieldTranslationsTestCase extends FieldTestCase { * Test the multilanguage logic of _field_invoke_multiple(). */ function testFieldInvokeMultiple() { + // Enable field translations for the entity. + field_test_entity_info_translatable('test_entity', TRUE); + $values = array(); + $options = array(); $entities = array(); $entity_type = 'test_entity'; - $entity_count = mt_rand(1, 5); + $entity_count = mt_rand(2, 5); $available_languages = field_available_languages($this->entity_type, $this->field); for ($id = 1; $id <= $entity_count; ++$id) { @@ -2729,29 +2733,55 @@ class FieldTranslationsTestCase extends FieldTestCase { // correctly uses the result of field_available_languages(). $extra_languages = mt_rand(1, 4); for ($i = 0; $i < $extra_languages; ++$i) { - $languages[] = $this->randomString(2); + $languages[] = $this->randomName(2); } // For each given language provide some random values. - foreach ($languages as $langcode) { - for ($delta = 0; $delta < $this->field['cardinality']; $delta++) { - $values[$id][$langcode][$delta]['value'] = mt_rand(1, 127); + $language_count = count($languages); + for ($i = 0; $i < $language_count; ++$i) { + $langcode = $languages[$i]; + // Avoid to populate at least one field translation to check that + // per-entity language suggestions work even when available field values + // are different for each language. + if ($i !== $id) { + for ($delta = 0; $delta < $this->field['cardinality']; $delta++) { + $values[$id][$langcode][$delta]['value'] = mt_rand(1, 127); + } + } + // Ensure that a language for which there is no field translation is + // used as display language to prepare per-entity language suggestions. + elseif (!isset($display_language)) { + $display_language = $langcode; } } + $entity->{$this->field_name} = $values[$id]; $entities[$id] = $entity; + + // Store per-entity language suggestions. + $options['language'][$id] = field_language($entity_type, $entity, NULL, $display_language); } $grouped_results = _field_invoke_multiple('test_op_multiple', $entity_type, $entities); foreach ($grouped_results as $id => $results) { foreach ($results as $langcode => $result) { - $hash = hash('sha256', serialize(array($entity_type, $entities[$id], $this->field_name, $langcode, $values[$id][$langcode]))); - // Check whether the parameters passed to _field_invoke() were correctly - // forwarded to the callback function. - $this->assertEqual($hash, $result, t('The result for entity %id/%language is correctly stored.', array('%id' => $id, '%language' => $langcode))); + if (isset($values[$id][$langcode])) { + $hash = hash('sha256', serialize(array($entity_type, $entities[$id], $this->field_name, $langcode, $values[$id][$langcode]))); + // Check whether the parameters passed to _field_invoke() were correctly + // forwarded to the callback function. + $this->assertEqual($hash, $result, t('The result for entity %id/%language is correctly stored.', array('%id' => $id, '%language' => $langcode))); + } } $this->assertEqual(count($results), count($available_languages), t('No unavailable language has been processed for entity %id.', array('%id' => $id))); } + + $null = NULL; + $grouped_results = _field_invoke_multiple('test_op_multiple', $entity_type, $entities, $null, $null, $options); + foreach ($grouped_results as $id => $results) { + foreach ($results as $langcode => $result) { + $this->assertTrue(isset($options['language'][$id]), t('The result language %language for entity %id was correctly suggested (display language: %display_language).', array('%id' => $id, '%language' => $langcode, '%display_language' => $display_language))); + } + } } /** diff --git a/modules/field/tests/field_test.module b/modules/field/tests/field_test.module index 237b833..7e34906 100644 --- a/modules/field/tests/field_test.module +++ b/modules/field/tests/field_test.module @@ -88,7 +88,9 @@ function field_test_field_test_op($entity_type, $entity, $field, $instance, $lan function field_test_field_test_op_multiple($entity_type, $entities, $field, $instances, $langcode, &$items) { $result = array(); foreach ($entities as $id => $entity) { - $result[$id] = array($langcode => hash('sha256', serialize(array($entity_type, $entity, $field['field_name'], $langcode, $items[$id])))); + if (isset($items[$id])) { + $result[$id] = array($langcode => hash('sha256', serialize(array($entity_type, $entity, $field['field_name'], $langcode, $items[$id])))); + } } return $result; } diff --git a/modules/simpletest/tests/actions.test b/modules/simpletest/tests/actions.test deleted file mode 100644 index 23587f0..0000000 --- a/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/modules/simpletest/tests/actions_loop_test.info b/modules/simpletest/tests/actions_loop_test.info deleted file mode 100644 index 3507511..0000000 --- a/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/modules/simpletest/tests/actions_loop_test.install b/modules/simpletest/tests/actions_loop_test.install deleted file mode 100644 index b22fd85..0000000 --- a/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/modules/simpletest/tests/actions_loop_test.module b/modules/simpletest/tests/actions_loop_test.module deleted file mode 100644 index afc5a26..0000000 --- a/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 = LOG_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/modules/system/system.admin.inc b/modules/system/system.admin.inc index 9e7d69d..11ef314 100644 --- a/modules/system/system.admin.inc +++ b/modules/system/system.admin.inc @@ -2858,276 +2858,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/modules/system/system.api.php b/modules/system/system.api.php index c2a613e..938251f 100644 --- a/modules/system/system.api.php +++ b/modules/system/system.api.php @@ -3594,103 +3594,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/modules/system/system.install b/modules/system/system.install index 6d2fc80..e132943 100644 --- a/modules/system/system.install +++ b/modules/system/system.install @@ -548,47 +548,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/modules/system/system.module b/modules/system/system.module index 3ebc657..d07b1e6 100644 --- a/modules/system/system.module +++ b/modules/system/system.module @@ -220,9 +220,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 +926,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.'), @@ -3032,262 +2991,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 email 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) { - $context = $params['context']; - - $subject = token_replace($context['subject'], $context); - $body = token_replace($context['message'], $context); - - $message['subject'] .= str_replace(array("\r", "\n"), '', $subject); - $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. * * @param $blank diff --git a/modules/translation/translation.module b/modules/translation/translation.module index 1fd12a5..697929f 100644 --- a/modules/translation/translation.module +++ b/modules/translation/translation.module @@ -133,7 +133,7 @@ function translation_form_node_form_alter(&$form, &$form_state) { // might need to distinguish between enabled and disabled languages, hence // we divide them in two option groups. if ($translator_widget) { - $options = array(); + $options = array($groups[1] => array(LANGUAGE_NONE => t('Language neutral'))); $language_list = locale_language_list('name', TRUE); foreach (array(1, 0) as $status) { $group = $groups[$status]; diff --git a/modules/translation/translation.test b/modules/translation/translation.test index c4a04c4..fa8c6b6 100644 --- a/modules/translation/translation.test +++ b/modules/translation/translation.test @@ -125,6 +125,13 @@ class TranslationTestCase extends DrupalWebTestCase { $translation_it = $this->createTranslation($node, $this->randomName(), $this->randomName(), 'it'); $this->assertRaw($translation_it->body['it'][0]['value'], t('Content created in Italian (disabled).')); + // Confirm that language neutral is an option for translators when there are + // disabled languages. + $this->drupalGet('node/add/page'); + $this->assertFieldByXPath('//select[@name="language"]//option', LANGUAGE_NONE, t('Language neutral is available in language selection with disabled languages.')); + $node2 = $this->createPage($this->randomName(), $this->randomName(), LANGUAGE_NONE); + $this->assertRaw($node2->body[LANGUAGE_NONE][0]['value'], t('Language neutral content created with disabled languages available.')); + // Leave just one language enabled and check that the translation overview // page is still accessible. $this->drupalLogin($this->admin_user); diff --git a/modules/trigger/trigger.info b/modules/trigger/trigger.info index f47604d..b5dfbe1 100644 --- a/modules/trigger/trigger.info +++ b/modules/trigger/trigger.info @@ -4,4 +4,5 @@ package = Core version = VERSION core = 8.x files[] = trigger.test +dependencies[] = actions configure = admin/structure/trigger diff --git a/themes/bartik/css/style.css b/themes/bartik/css/style.css index d3cca07..7c14277 100644 --- a/themes/bartik/css/style.css +++ b/themes/bartik/css/style.css @@ -1136,7 +1136,7 @@ fieldset { .fieldset-wrapper { margin-top: 25px; } -.vertical-tabs .fieldset-wrapper { +.node-form .vertical-tabs .fieldset-wrapper { margin-top: 0; } .filter-wrapper {