Index: modules/actions/actions.info =================================================================== RCS file: modules/actions/actions.info diff -N modules/actions/actions.info --- modules/actions/actions.info 29 Jun 2007 18:06:50 -0000 1.1 +++ /dev/null 1 Jan 1970 00:00:00 -0000 @@ -1,6 +0,0 @@ -; $Id: actions.info,v 1.1 2007/06/29 18:06:50 dries Exp $ -name = Actions -description = Enables triggerable Drupal actions. -package = Core - optional -version = VERSION -core = 6.x Index: modules/actions/actions.install =================================================================== RCS file: modules/actions/actions.install diff -N modules/actions/actions.install --- modules/actions/actions.install 29 Aug 2007 14:57:49 -0000 1.3 +++ /dev/null 1 Jan 1970 00:00:00 -0000 @@ -1,21 +0,0 @@ -'. $explanation .' '. t('Below you can assign actions to run when certain comment-related operations happen. For example, you could promote a post to the front page when a comment is added.') .'

'; - break; - case 'admin/build/actions/assign/node': - $output = '

'. $explanation .' '. t('Below you can assign actions to run when certain post-related operations happen. For example, you could remove a post from the front page when the post is updated. Note that if you are running actions that modify the characteristics of a post (such as making a post sticky or removing a post from the front page), you will need to add the %node_save action to save the changes.', array('%node_save' => t('Save post'))) .'

'; - break; - case 'admin/build/actions/assign/user': - $output = '

'. $explanation .' '. t("Below you can assign actions to run when certain user-related operations happen. For example, you could block a user when the user's account is edited by assigning the %block_user action to the user %update operation.", array('%block_user' => t('Block user'), '%update' => t('update'))) .'

'; - break; - case 'admin/build/actions/assign/cron': - $output = '

'. t('Actions are functions that Drupal can execute when certain events happen, such as when a post is added or a user logs in. Below you can assign actions to run when cron runs.') .'

'; - break; - } - - return $output; -} - -/** - * Implementation of hook_menu(). - */ -function actions_menu() { - $items['admin/build/actions/assign'] = array( - 'title' => 'Assign actions', - 'description' => 'Tell Drupal when to execute actions.', - 'page callback' => 'actions_assign', - 'type' => MENU_LOCAL_TASK, - ); - $items['admin/build/actions/assign/node'] = array( - 'title' => 'Content', - 'page callback' => 'actions_assign', - 'page arguments' => array('node'), - 'type' => MENU_LOCAL_TASK, - ); - $items['admin/build/actions/assign/user'] = array( - 'title' => 'User', - 'page callback' => 'actions_assign', - 'page arguments' => array('user'), - 'type' => MENU_LOCAL_TASK, - ); - $items['admin/build/actions/assign/comment'] = array( - 'title' => 'Comment', - 'page callback' => 'actions_assign', - 'page arguments' => array('comment'), - 'access callback' => 'actions_access_check', - 'access arguments' => array('comment'), - 'type' => MENU_LOCAL_TASK, - ); - $items['admin/build/actions/assign/taxonomy'] = array( - 'title' => 'Taxonomy', - 'page callback' => 'actions_assign', - 'page arguments' => array('taxonomy'), - 'access callback' => 'actions_access_check', - 'access arguments' => array('taxonomy'), - 'type' => MENU_LOCAL_TASK, - ); - $items['admin/build/actions/assign/cron'] = array( - 'title' => 'Cron', - 'page callback' => 'actions_assign', - 'page arguments' => array('cron'), - 'type' => MENU_LOCAL_TASK, - ); - - // We want contributed modules to be able to describe - // their hooks and have actions assignable to them. - $hooks = module_invoke_all('hook_info'); - foreach ($hooks as $module => $hook) { - if (in_array($module, array('node', 'comment', 'user', 'system', 'taxonomy'))) { - continue; - } - $info = db_result(db_query("SELECT info FROM {system} WHERE name = '%s'", $module)); - $info = unserialize($info); - $nice_name = $info['name']; - $items["admin/build/actions/assign/$module"] = array( - 'title' => $nice_name, - 'page callback' => 'actions_assign', - 'page arguments' => array($module), - 'type' => MENU_LOCAL_TASK, - ); - } - $items['admin/build/actions/assign/remove'] = array( - 'title' => 'Unassign', - 'description' => 'Remove an action assignment.', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('actions_unassign'), - 'type' => MENU_CALLBACK, - ); - - return $items; -} - -/** - * Access callback for menu system. - */ -function actions_access_check($module) { - return (module_exists($module) && user_access('administer actions')); -} - - - -/** - * Get the actions that have already been defined for this - * type-hook-op combination. - * - * @param $type - * One of 'node', 'user', 'comment'. - * @param $hook - * The name of the hook for which actions have been assigned, - * e.g. 'nodeapi'. - * @param $op - * The hook operation for which the actions have been assigned, - * e.g., 'view'. - * @return - * An array of action descriptions keyed by action IDs. - */ -function _actions_get_hook_actions($hook, $op, $type = NULL) { - $actions = array(); - if ($type) { - $result = db_query("SELECT h.aid, a.description FROM {actions_assignments} h LEFT JOIN {actions} a on a.aid = h.aid WHERE a.type = '%s' AND h.hook = '%s' AND h.op = '%s' ORDER BY h.weight", $type, $hook, $op); - } - else { - $result = db_query("SELECT h.aid, a.description FROM {actions_assignments} h LEFT JOIN {actions} a on a.aid = h.aid WHERE h.hook = '%s' AND h.op = '%s' ORDER BY h.weight", $hook, $op); - } - while ($action = db_fetch_object($result)) { - $actions[$action->aid] = $action->description; - } - return $actions; -} - -/** - * Get the aids of actions to be executed for a hook-op combination. - * - * @param $hook - * The name of the hook being fired. - * @param $op - * The name of the operation being executed. Defaults to an empty string - * because some hooks (e.g., hook_cron()) do not have operations. - * @return - * An array of action IDs. - */ -function _actions_get_hook_aids($hook, $op = '') { - $aids = array(); - $result = db_query("SELECT aa.aid, a.type FROM {actions_assignments} aa LEFT JOIN {actions} a ON aa.aid = a.aid WHERE aa.hook = '%s' AND aa.op = '%s' ORDER BY weight", $hook, $op); - while ($action = db_fetch_object($result)) { - $aids[$action->aid]['type'] = $action->type; - } - return $aids; -} - -/** - * Create the form definition for assigning an action to a hook-op combination. - * - * @param $form_state - * Information about the current form. - * @param $hook - * The name of the hook, e.g., 'nodeapi'. - * @param $op - * The name of the hook operation, e.g., 'insert'. - * @param $description - * A plain English description of what this hook operation does. - * @return - */ -function actions_assign_form($form_state, $hook, $op, $description) { - $form['hook'] = array( - '#type' => 'hidden', - '#value' => $hook, - ); - $form['operation'] = array( - '#type' => 'hidden', - '#value' => $op, - ); - // All of these forms use the same #submit function. - $form['#submit'][] = 'actions_assign_form_submit'; - - $options = array(); - $functions = array(); - // Restrict the options list to actions that declare support for this hook-op combination. - foreach (actions_list() as $func => $metadata) { - if (isset($metadata['hooks']['any']) || (isset($metadata['hooks'][$hook]) && is_array($metadata['hooks'][$hook]) && (in_array($op, $metadata['hooks'][$hook])))) { - $functions[] = $func; - } - } - foreach (actions_actions_map(actions_get_all_actions()) as $aid => $action) { - if (in_array($action['callback'], $functions)) { - $options[$action['type']][$aid] = $action['description']; - } - } - - $form[$op] = array( - '#type' => 'fieldset', - '#title' => $description, - '#theme' => 'actions_display' - ); - // Retrieve actions that are already assigned to this hook-op combination. - $actions = _actions_get_hook_actions($hook, $op); - $form[$op]['assigned']['#type'] = 'value'; - $form[$op]['assigned']['#value'] = array(); - foreach ($actions as $aid => $description) { - $form[$op]['assigned']['#value'][$aid] = array( - 'description' => $description, - 'link' => l(t('remove'), "admin/build/actions/assign/remove/$hook/$op/". md5($aid)) - ); - } - - $form[$op]['parent'] = array( - '#prefix' => "
", - '#suffix' => '
', - ); - // List possible actions that may be assigned. - if (count($options) != 0) { - array_unshift($options, t('Choose an action')); - $form[$op]['parent']['aid'] = array( - '#type' => 'select', - '#options' => $options, - ); - $form[$op]['parent']['submit'] = array( - '#type' => 'submit', - '#value' => t('Assign') - ); - } - else { - $form[$op]['none'] = array( - '#value' => t('No available actions support this context.') - ); - } - return $form; -} - -function actions_assign_form_submit($form, $form_state) { - $form_values = $form_state['values']; - if (!empty($form_values['aid'])) { - $aid = actions_function_lookup($form_values['aid']); - $weight = db_result(db_query("SELECT MAX(weight) FROM {actions_assignments} WHERE hook = '%s' AND op = '%s'", $form_values['hook'], $form_values['operation'])); - db_query("INSERT INTO {actions_assignments} values ('%s', '%s', '%s', %d)", $form_values['hook'], $form_values['operation'], $aid, $weight + 1); - } -} - -/** - * Implementation of hook_theme(). - */ -function actions_theme() { - return array( - 'actions_display' => array( - 'arguments' => array('element') - ), - ); -} - -/** - * Display actions assigned to this hook-op combination in a table. - * - * @param array $element - * The fieldset including all assigned actions. - * @return - * The rendered form with the table prepended. - */ -function theme_actions_display($element) { - $header = array(); - $rows = array(); - if (count($element['assigned']['#value'])) { - $header = array(array('data' => t('Name')), array('data' => t('Operation'))); - $rows = array(); - foreach ($element['assigned']['#value'] as $aid => $info) { - $rows[] = array( - $info['description'], - $info['link'] - ); - } - } - - $output = theme('table', $header, $rows) . drupal_render($element); - return $output; -} - -/** - * Implementation of hook_forms(). We reuse code by using the - * same assignment form definition for each node-op combination. - */ -function actions_forms() { - $hooks = module_invoke_all('hook_info'); - foreach ($hooks as $module => $info) { - foreach ($hooks[$module] as $hook => $ops) { - foreach ($ops as $op => $description) { - $forms['actions_'. $hook .'_'. $op .'_assign_form'] = array('callback' => 'actions_assign_form'); - } - } - } - - return $forms; -} - -/** - * Build the form that allows users to assign actions to hooks. - * - * @param $type - * Name of hook. - * @return - * HTML form. - */ -function actions_assign($type = NULL) { - // If no type is specified we default to node actions, since they - // are the most common. - if (!isset($type)) { - drupal_goto('admin/build/actions/assign/node'); - } - if ($type == 'node') { - $type = 'nodeapi'; - } - - $output = ''; - $hooks = module_invoke_all('hook_info'); - foreach ($hooks as $module => $hook) { - if (isset($hook[$type])) { - foreach ($hook[$type] as $op => $description) { - $form_id = 'actions_'. $type .'_'. $op .'_assign_form'; - $output .= drupal_get_form($form_id, $type, $op, $description['runs when']); - } - } - } - return $output; -} - -/** - * Confirm removal of an assigned action. - * - * @param $hook - * @param $op - * @param $aid - * The action ID. - */ -function actions_unassign($form_state, $hook = NULL, $op = NULL, $aid = NULL) { - if (!($hook && $op && $aid)) { - drupal_goto('admin/build/actions/assign'); - } - - $form['hook'] = array( - '#type' => 'value', - '#value' => $hook, - ); - $form['operation'] = array( - '#type' => 'value', - '#value' => $op, - ); - $form['aid'] = array( - '#type' => 'value', - '#value' => $aid, - ); - - $action = actions_function_lookup($aid); - $actions = actions_get_all_actions(); - - $destination = 'admin/build/actions/assign/'. ($hook == 'nodeapi' ? 'node' : $hook); - - return confirm_form($form, - t('Are you sure you want to remove the action %title?', array('%title' => $actions[$action]['description'])), - $destination, - t('You can assign it again later if you wish.'), - t('Remove'), t('Cancel') - ); -} - -function actions_unassign_submit($form, &$form_state) { - $form_values = $form_state['values']; - if ($form_values['confirm'] == 1) { - $aid = actions_function_lookup($form_values['aid']); - db_query("DELETE FROM {actions_assignments} WHERE hook = '%s' AND op = '%s' AND aid = '%s'", $form_values['hook'], $form_values['operation'], $aid); - $actions = actions_get_all_actions(); - watchdog('actions', 'Action %action has been unassigned.', array('%action' => check_plain($actions[$aid]['description']))); - drupal_set_message(t('Action %action has been unassigned.', array('%action' => $actions[$aid]['description']))); - $hook = $form_values['hook'] == 'nodeapi' ? 'node' : $form_values['hook']; - $form_state['redirect'] = 'admin/build/actions/assign/'. $hook; - } - else { - drupal_goto('admin/build/actions'); - } -} - -/** - * When an action is called in a context that does not match its type, - * the object that the action expects must be retrieved. For example, when - * an action that works on users is called during the node hook, the - * user object is not available since the node hook doesn't pass it. - * So here we load the object the action expects. - * - * @param $type - * The type of action that is about to be called. - * @param $node - * The node that was passed via the nodeapi hook. - * @return - * The object expected by the action that is about to be called. - */ -function _actions_normalize_node_context($type, $node) { - switch ($type) { - // If an action that works on comments is being called in a node context, - // the action is expecting a comment object. But we do not know which comment - // to give it. The first? The most recent? All of them? So comment actions - // in a node context are not supported. - - // An action that works on users is being called in a node context. - // Load the user object of the node's author. - case 'user': - return user_load(array('uid' => $node->uid)); - } -} - -/** - * Implementation of hook_nodeapi(). - */ -function actions_nodeapi($node, $op, $a3, $a4) { - // Keep objects for reuse so that changes actions make to objects can persist. - static $objects; - // Prevent recursion by tracking which operations have already been called. - static $recursion; - // Support a subset of operations. - if (!in_array($op, array('view', 'update', 'presave', 'insert', 'delete')) || isset($recursion[$op])) { - return; - } - $recursion[$op] = TRUE; - - $aids = _actions_get_hook_aids('nodeapi', $op); - if (!$aids) { - return; - } - $context = array( - 'hook' => 'nodeapi', - 'op' => $op, - ); - - // We need to get the expected object if the action's type is not 'node'. - // We keep the object in $objects so we can reuse it if we have multiple actions - // that make changes to an object. - foreach ($aids as $aid => $action_info) { - if ($action_info['type'] != 'node') { - if (!isset($objects[$action_info['type']])) { - $objects[$action_info['type']] = _actions_normalize_node_context($action_info['type'], $node); - } - // Since we know about the node, we pass that info along to the action. - $context['node'] = $node; - $result = actions_do($aid, $objects[$action_info['type']], $context, $a4, $a4); - } - else { - actions_do($aid, $node, $context, $a3, $a4); - } - } -} - -/** - * When an action is called in a context that does not match its type, - * the object that the action expects must be retrieved. For example, when - * an action that works on nodes is called during the comment hook, the - * node object is not available since the comment hook doesn't pass it. - * So here we load the object the action expects. - * - * @param $type - * The type of action that is about to be called. - * @param $comment - * The comment that was passed via the comment hook. - * @return - * The object expected by the action that is about to be called. - */ -function _actions_normalize_comment_context($type, $comment) { - switch ($type) { - // An action that works with nodes is being called in a comment context. - case 'node': - return node_load(is_array($comment) ? $comment['nid'] : $comment->nid); - - // An action that works on users is being called in a comment context. - case 'user': - return user_load(array('uid' => is_array($comment) ? $comment['uid'] : $comment->uid)); - } -} - -/** - * Implementation of hook_comment(). - */ -function actions_comment($a1, $op) { - // Keep objects for reuse so that changes actions make to objects can persist. - static $objects; - // We support a subset of operations. - if (!in_array($op, array('insert', 'update', 'delete', 'view'))) { - return; - } - $aids = _actions_get_hook_aids('comment', $op); - $context = array( - 'hook' => 'comment', - 'op' => $op, - ); - // We need to get the expected object if the action's type is not 'comment'. - // We keep the object in $objects so we can reuse it if we have multiple actions - // that make changes to an object. - foreach ($aids as $aid => $action_info) { - if ($action_info['type'] != 'comment') { - if (!isset($objects[$action_info['type']])) { - $objects[$action_info['type']] = _actions_normalize_comment_context($action_info['type'], $a1); - } - // Since we know about the comment, we pass it along to the action - // in case it wants to peek at it. - $context['comment'] = (object) $a1; - actions_do($aid, $objects[$action_info['type']], $context); - } - else { - actions_do($aid, (object) $a1, $context); - } - } -} - -/** - * Implementation of hook_cron(). - */ -function actions_cron() { - $aids = _actions_get_hook_aids('cron'); - $context = array( - 'hook' => 'cron', - 'op' => '', - ); - // Cron does not act on any specific object. - $object = NULL; - actions_do(array_keys($aids), $object, $context); -} - -/** - * When an action is called in a context that does not match its type, - * the object that the action expects must be retrieved. For example, when - * an action that works on nodes is called during the user hook, the - * node object is not available since the user hook doesn't pass it. - * So here we load the object the action expects. - * - * @param $type - * The type of action that is about to be called. - * @param $account - * The account object that was passed via the user hook. - * @return - * The object expected by the action that is about to be called. - */ -function _actions_normalize_user_context($type, $account) { - switch ($type) { - // If an action that works on comments is being called in a user context, - // the action is expecting a comment object. But we have no way of - // determining the appropriate comment object to pass. So comment - // actions in a user context are not supported. - - // An action that works with nodes is being called in a user context. - // If a single node is being viewed, return the node. - case 'node': - // If we are viewing an individual node, return the node. - if ((arg(0) == 'node') && is_numeric(arg(1)) && (arg(2) == NULL)) { - return node_load(array('nid' => arg(1))); - } - } -} - -/** - * Implementation of hook_user(). - */ -function actions_user($op, &$edit, &$account, $category = NULL) { - // Keep objects for reuse so that changes actions make to objects can persist. - static $objects; - // We support a subset of operations. - if (!in_array($op, array('login', 'logout', 'insert', 'update', 'delete', 'view'))) { - return; - } - $aids = _actions_get_hook_aids('user', $op); - $context = array( - 'hook' => 'user', - 'op' => $op, - 'form_values' => &$edit, - ); - foreach ($aids as $aid => $action_info) { - if ($action_info['type'] != 'user') { - if (!isset($objects[$action_info['type']])) { - $objects[$action_info['type']] = _actions_normalize_user_context($action_info['type'], $account); - } - $context['account'] = $account; - actions_do($aid, $objects[$action_info['type']], $context); - } - else { - actions_do($aid, $account, $context, $category); - } - } -} - -/** - * Implementation of hook_taxonomy(). - */ -function actions_taxonomy($op, $type, $array) { - if ($type != 'term') { - return; - } - $aids = _actions_get_hook_aids('taxonomy', $op); - $context = array( - 'hook' => 'taxonomy', - 'op' => $op - ); - foreach ($aids as $aid => $action_info) { - actions_do($aid, (object) $array, $context); - } -} - -/** - * Often we generate a select field of all actions. This function - * generates the options for that select. - * - * @param $type - * One of 'node', 'user', 'comment'. - * @return - * Array keyed by action ID. - */ -function actions_options($type = 'all') { - $options = array(t('Choose an action')); - foreach (actions_actions_map(actions_get_all_actions()) as $aid => $action) { - $options[$action['type']][$aid] = $action['description']; - } - - if ($type == 'all') { - return $options; - } - else { - return $options[$type]; - } -} Index: modules/actions/actions.schema =================================================================== RCS file: modules/actions/actions.schema diff -N modules/actions/actions.schema --- modules/actions/actions.schema 29 Aug 2007 14:57:49 -0000 1.3 +++ /dev/null 1 Jan 1970 00:00:00 -0000 @@ -1,16 +0,0 @@ - array( - 'hook' => array('type' => 'varchar', 'length' => 32, 'not null' => TRUE, 'default' => ''), - 'op' => array('type' => 'varchar', 'length' => 32, 'not null' => TRUE, 'default' => ''), - 'aid' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'weight' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - ), - 'index keys' => array( - 'hook_op' => array('hook', 'op')) - ); - return $schema; -} Index: modules/comment/comment.module =================================================================== RCS file: /cvs/drupal/drupal/modules/comment/comment.module,v retrieving revision 1.582 diff -u -u -p -r1.582 comment.module --- modules/comment/comment.module 6 Sep 2007 12:21:39 -0000 1.582 +++ modules/comment/comment.module 10 Sep 2007 18:36:35 -0000 @@ -2144,16 +2144,16 @@ function comment_hook_info() { 'comment' => array( 'comment' => array( 'insert' => array( - 'runs when' => t('When a comment has been created'), + 'runs when' => t('After saving a new comment'), ), 'update' => array( - 'runs when' => t('When a comment has been updated'), + 'runs when' => t('After saving an updated comment'), ), 'delete' => array( - 'runs when' => t('When a comment has been deleted') + 'runs when' => t('After deleting a comment') ), 'view' => array( - 'runs when' => t('When a comment is being viewed') + 'runs when' => t('When a comment is being viewed by an authenticated user') ), ), ), @@ -2170,7 +2170,7 @@ function comment_action_info() { 'type' => 'comment', 'configurable' => FALSE, 'hooks' => array( - 'comment' => array('insert', 'update', 'view'), + 'comment' => array('insert', 'update'), ) ), 'comment_unpublish_by_keyword_action' => array( @@ -2209,7 +2209,7 @@ function comment_unpublish_by_keyword_ac $form['keywords'] = array( '#title' => t('Keywords'), '#type' => 'textarea', - '#description' => t('The comment will be unpublished if it contains any of the character sequences above. Use a comma-separated list of character sequences. Example: funny, bungee jumping, "Company, Inc.".'), + '#description' => t('The comment will be unpublished if it contains any of the character sequences above. Use a comma-separated list of character sequences. Example: funny, bungee jumping, "Company, Inc.". Character sequences are case-sensitive.'), '#default_value' => isset($context['keywords']) ? drupal_implode_tags($context['keywords']) : '', ); return $form; Index: modules/node/node.module =================================================================== RCS file: /cvs/drupal/drupal/modules/node/node.module,v retrieving revision 1.880 diff -u -u -p -r1.880 node.module --- modules/node/node.module 9 Sep 2007 20:16:09 -0000 1.880 +++ modules/node/node.module 10 Sep 2007 18:36:35 -0000 @@ -2308,16 +2308,16 @@ function node_hook_info() { 'node' => array( 'nodeapi' => array( 'presave' => array( - 'runs when' => t('When content is about to be saved'), + 'runs when' => t('When either saving a new post or updating an existing post'), ), 'insert' => array( - 'runs when' => t('When content has been created'), + 'runs when' => t('After saving a new post'), ), 'update' => array( - 'runs when' => t('When content has been updated'), + 'runs when' => t('After saving an updated post'), ), 'delete' => array( - 'runs when' => t('When content has been deleted') + 'runs when' => t('After deleting a post') ), 'view' => array( 'runs when' => t('When content is viewed by an authenticated user') @@ -2337,8 +2337,8 @@ function node_action_info() { 'description' => t('Publish post'), 'configurable' => FALSE, 'hooks' => array( - 'nodeapi' => array('presave', 'insert', 'update', 'view'), - 'comment' => array('delete', 'insert', 'update', 'view'), + 'nodeapi' => array('presave'), + 'comment' => array('insert', 'update'), ), ), 'node_unpublish_action' => array( @@ -2346,8 +2346,8 @@ function node_action_info() { 'description' => t('Unpublish post'), 'configurable' => FALSE, 'hooks' => array( - 'nodeapi' => array('presave', 'insert', 'update', 'view'), - 'comment' => array('delete', 'insert', 'update', 'view'), + 'nodeapi' => array('presave'), + 'comment' => array('delete', 'insert', 'update'), ), ), 'node_make_sticky_action' => array( @@ -2355,8 +2355,8 @@ function node_action_info() { 'description' => t('Make post sticky'), 'configurable' => FALSE, 'hooks' => array( - 'nodeapi' => array('presave', 'insert', 'update', 'view'), - 'comment' => array('delete', 'insert', 'update', 'view'), + 'nodeapi' => array('presave'), + 'comment' => array('insert', 'update'), ), ), 'node_make_unsticky_action' => array( @@ -2364,8 +2364,8 @@ function node_action_info() { 'description' => t('Make post unsticky'), 'configurable' => FALSE, 'hooks' => array( - 'nodeapi' => array('presave', 'insert', 'update', 'view'), - 'comment' => array('delete', 'insert', 'update', 'view'), + 'nodeapi' => array('presave'), + 'comment' => array('delete', 'insert', 'update'), ), ), 'node_promote_action' => array( @@ -2373,9 +2373,8 @@ function node_action_info() { 'description' => t('Promote post to front page'), 'configurable' => FALSE, 'hooks' => array( - 'nodeapi' => array('presave', 'insert', 'update', 'view'), - 'comment' => array('delete', 'insert', 'update', 'view'), - 'user' => array('login'), + 'nodeapi' => array('presave'), + 'comment' => array('insert', 'update'), ), ), 'node_unpromote_action' => array( @@ -2383,8 +2382,8 @@ function node_action_info() { 'description' => t('Remove post from front page'), 'configurable' => FALSE, 'hooks' => array( - 'nodeapi' => array('presave', 'insert', 'update', 'view'), - 'comment' => array('delete', 'insert', 'update', 'view'), + 'nodeapi' => array('presave'), + 'comment' => array('delete', 'insert', 'update'), ), ), 'node_assign_owner_action' => array( @@ -2393,8 +2392,8 @@ function node_action_info() { 'configurable' => TRUE, 'hooks' => array( 'any' => TRUE, - 'nodeapi' => array('presave', 'insert', 'update', 'view'), - 'comment' => array('delete', 'insert', 'update', 'view'), + 'nodeapi' => array('presave'), + 'comment' => array('delete', 'insert', 'update'), ), ), 'node_save_action' => array( @@ -2402,9 +2401,7 @@ function node_action_info() { 'description' => t('Save post'), 'configurable' => FALSE, 'hooks' => array( - 'nodeapi' => array('delete', 'insert', 'update', 'view'), - 'comment' => array('delete', 'insert', 'update', 'view'), - 'user' => array('login'), + 'comment' => array('delete', 'insert', 'update'), ), ), 'node_unpublish_by_keyword_action' => array( @@ -2412,8 +2409,7 @@ function node_action_info() { 'description' => t('Unpublish post containing keyword(s)'), 'configurable' => TRUE, 'hooks' => array( - 'nodeapi' => array('presave', 'insert', 'update', 'view'), - 'comment' => array('delete', 'insert', 'update', 'view'), + 'nodeapi' => array('presave', 'insert', 'update'), ), ), ); @@ -2546,7 +2542,7 @@ function node_unpublish_by_keyword_actio $form['keywords'] = array( '#title' => t('Keywords'), '#type' => 'textarea', - '#description' => t('The node will be unpublished if it contains any of the character sequences above. Use a comma-separated list of character sequences. Example: funny, bungee jumping, "Company, Inc.".'), + '#description' => t('The node will be unpublished if it contains any of the character sequences above. Use a comma-separated list of character sequences. Example: funny, bungee jumping, "Company, Inc.". Character sequences are case-sensitive.'), '#default_value' => isset($context['keywords']) ? drupal_implode_tags($context['keywords']) : '', ); return $form; Index: modules/system/system.module =================================================================== RCS file: /cvs/drupal/drupal/modules/system/system.module,v retrieving revision 1.528 diff -u -u -p -r1.528 system.module --- modules/system/system.module 10 Sep 2007 09:28:28 -0000 1.528 +++ modules/system/system.module 10 Sep 2007 18:36:35 -0000 @@ -52,14 +52,16 @@ function system_help($path, $arg) { return $output; case 'admin/build/modules/uninstall': return '

'. t('The uninstall process removes all data related to a module. To uninstall a module, you must first disable it. Not all modules support this feature.') .'

'; - case 'admin/build/actions': - case 'admin/build/actions/manage': - $explanation = t('Actions are functions that Drupal can execute when certain events happen, such as when a post is added or a user logs in.'); - $output = '

'. $explanation .' '. t('A module, such as the actions module, may assign these actions to the specific events that will trigger them.') .'

'; - $output .= '

'. t('This page lists all actions that are available. Simple actions that do not require any configuration are listed automatically. Advanced actions that need to be configured are listed in the dropdown below. To add an advanced action, select the action and click the Configure button. After completing the configuration form, the action will be available for use by Drupal.') .'

'; + case 'admin/settings/actions': + case 'admin/settings/actions/manage': + $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.') .'

'; + $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 can do more than simple actions; for example, send an e-mail to a specified address, or check for certain words within a piece of content. These actions need to be created and configured first before they may be used. To create an advanced action, select the action from the drop-down 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/build/trigger'))) .'

'; + } return $output; - case 'admin/build/actions/config': - return '

'. t('This is where you configure a certain action that will be performed at some time in the future. For example, you might configure an action to send email to your friend Joe. You would modify the description field, below, to read %send to remind you of that. The description you provide will be used to identify this action; for example, when assigning an action to a Drupal event such as a new comment being posted.', array('%send' => t('Send email to Joe'))) .'

'; + case 'admin/settings/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/logs/status': return '

'. t("Here you can find a short overview of your Drupal site's parameters as well as any problems detected with your installation. It is useful to copy/paste this information when you need support.") .'

'; } @@ -273,33 +275,33 @@ function system_menu() { ); // Actions: - $items['admin/build/actions'] = array( + $items['admin/settings/actions'] = array( 'title' => 'Actions', 'description' => 'Manage the actions defined for your site.', 'access arguments' => array('administer actions'), 'page callback' => 'system_actions_manage' ); - $items['admin/build/actions/manage'] = array( + $items['admin/settings/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, ); - $items['admin/build/actions/config'] = array( - 'title' => 'Configure an action', + $items['admin/settings/actions/configure'] = array( + 'title' => 'Configure an advanced action', 'page callback' => 'drupal_get_form', 'page arguments' => array('system_actions_configure'), 'type' => MENU_CALLBACK, ); - $items['admin/build/actions/delete/%actions'] = array( + $items['admin/settings/actions/delete/%actions'] = array( 'title' => 'Delete action', 'description' => 'Delete an action.', 'page callback' => 'drupal_get_form', 'page arguments' => array('system_actions_delete_form', 4), 'type' => MENU_CALLBACK, ); - $items['admin/build/actions/orphan'] = array( + $items['admin/settings/actions/orphan'] = array( 'title' => 'Remove orphans', 'page callback' => 'system_actions_remove_orphans', 'type' => MENU_CALLBACK, @@ -1148,7 +1150,7 @@ function system_actions_manage() { $row = array(); $instances_present = db_fetch_object(db_query("SELECT aid FROM {actions} WHERE parameters != ''")); $header = array( - array('data' => t('Action Type'), 'field' => 'type'), + array('data' => t('Action type'), 'field' => 'type'), array('data' => t('Description'), 'field' => 'description'), array('data' => $instances_present ? t('Operations') : '', 'colspan' => '2') ); @@ -1158,8 +1160,8 @@ function system_actions_manage() { $row[] = array( array('data' => $action->type), array('data' => $action->description), - array('data' => $action->parameters ? l(t('configure'), "admin/build/actions/config/$action->aid") : ''), - array('data' => $action->parameters ? l(t('delete'), "admin/build/actions/delete/$action->aid") : '') + array('data' => $action->parameters ? l(t('configure'), "admin/settings/actions/configure/$action->aid") : ''), + array('data' => $action->parameters ? l(t('delete'), "admin/settings/actions/delete/$action->aid") : '') ); } @@ -1202,14 +1204,14 @@ function system_actions_manage_form($for ); $form['parent']['buttons']['submit'] = array( '#type' => 'submit', - '#value' => t('Configure'), + '#value' => t('Create'), ); return $form; } function system_actions_manage_form_submit($form, &$form_state) { if ($form_state['values']['action']) { - $form_state['redirect'] = 'admin/build/actions/config/'. $form_state['values']['action']; + $form_state['redirect'] = 'admin/settings/actions/configure/'. $form_state['values']['action']; } } @@ -1230,7 +1232,7 @@ function system_actions_manage_form_subm */ function system_actions_configure($form_state, $action = NULL) { if ($action === NULL) { - drupal_goto('admin/build/actions'); + drupal_goto('admin/settings/actions'); } $actions_map = actions_actions_map(actions_list()); @@ -1259,14 +1261,12 @@ function system_actions_configure($form_ $edit['actions_type'] = $actions_map[$action]['type']; } - $form['actions_description'] = array( '#type' => 'textfield', '#title' => t('Description'), '#default_value' => $edit['actions_description'], - '#size' => '70', '#maxlength' => '255', - '#description' => t('A unique description for this configuration of this action. This will be used to describe this action when assigning actions.'), + '#description' => t('A unique description for this advanced action. This description will be displayed in the interface of modules that integrate with actions, such as Trigger module.'), '#weight' => -10 ); $action_form = $function .'_form'; @@ -1318,7 +1318,7 @@ function system_actions_configure_submit actions_save($function, $form_state['values']['actions_type'], $params, $form_state['values']['actions_description'], $aid); drupal_set_message(t('The action has been successfully saved.')); - $form_state['redirect'] = 'admin/build/actions/manage'; + $form_state['redirect'] = 'admin/settings/actions/manage'; } /** @@ -1335,7 +1335,7 @@ function system_actions_delete_form($for ); return confirm_form($form, t('Are you sure you want to delete the action %action?', array('%action' => $action->description)), - 'admin/build/actions/manage', + 'admin/settings/actions/manage', t('This cannot be undone.'), t('Delete'), t('Cancel') ); @@ -1351,7 +1351,7 @@ function system_actions_delete_form_subm $description = check_plain($action->description); watchdog('user', 'Deleted action %aid (%action)', array('%aid' => $aid, '%action' => $description)); drupal_set_message(t('Action %action was deleted', array('%action' => $description))); - $form_state['redirect'] = 'admin/build/actions/manage'; + $form_state['redirect'] = 'admin/settings/actions/manage'; } /** * Post-deletion operations for deleting action orphans. @@ -1368,7 +1368,7 @@ function system_action_delete_orphans_po */ function system_actions_remove_orphans() { actions_synchronize(actions_list(), TRUE); - drupal_goto('admin/build/actions/manage'); + drupal_goto('admin/settings/actions/manage'); } /** @@ -1395,15 +1395,13 @@ function system_send_email_action_form($ '#type' => 'textfield', '#title' => t('Recipient'), '#default_value' => $context['recipient'], - '#size' => '20', '#maxlength' => '254', - '#description' => t('The email address to which the message should be sent OR enter %author if you would like to send an e-mail to the original author of the post.', array('%author' => '%author')), + '#description' => t('The email address to which the message should be sent OR enter %author if you would like to send an e-mail to the author of the original post.', array('%author' => '%author')), ); $form['subject'] = array( '#type' => 'textfield', '#title' => t('Subject'), '#default_value' => $context['subject'], - '#size' => '20', '#maxlength' => '254', '#description' => t('The subject of the message.'), ); Index: modules/taxonomy/taxonomy.module =================================================================== RCS file: /cvs/drupal/drupal/modules/taxonomy/taxonomy.module,v retrieving revision 1.380 diff -u -u -p -r1.380 taxonomy.module --- modules/taxonomy/taxonomy.module 9 Sep 2007 20:16:09 -0000 1.380 +++ modules/taxonomy/taxonomy.module 10 Sep 2007 18:36:35 -0000 @@ -1149,13 +1149,13 @@ function taxonomy_hook_info() { 'taxonomy' => array( 'taxonomy' => array( 'insert' => array( - 'runs when' => t('When a new category has been created'), + 'runs when' => t('After saving a new category to the database'), ), 'update' => array( - 'runs when' => t('When a category has been updated'), + 'runs when' => t('After saving an updated category to the database'), ), 'delete' => array( - 'runs when' => t('When a category has been deleted') + 'runs when' => t('After deleting a category') ), ), ), Index: modules/trigger/trigger.info =================================================================== RCS file: modules/trigger/trigger.info diff -N modules/trigger/trigger.info --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ modules/trigger/trigger.info 10 Sep 2007 18:36:35 -0000 @@ -0,0 +1,6 @@ +; $Id: trigger.info,v 1.1 2007/06/29 18:06:50 dries Exp $ +name = Trigger +description = Enables actions to be fired on certain system events, such as when new content is created. +package = Core - optional +version = VERSION +core = 6.x Index: modules/trigger/trigger.install =================================================================== RCS file: modules/trigger/trigger.install diff -N modules/trigger/trigger.install --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ modules/trigger/trigger.install 10 Sep 2007 18:36:35 -0000 @@ -0,0 +1,21 @@ +'. t('Triggers are system events, such as when new content is added or when a user logs in. Trigger module combines these triggers with actions (functional tasks), such as unpublishing content or e-mailing an administrator. The Actions settings page contains a list of existing actions and provides the ability to create and configure additional actions.', array('@url' => url('admin/settings/actions'))) .'

'; + switch ($path) { + case 'admin/build/trigger/comment': + $output .= $explanation .'

'. t('Below you can assign actions to run when certain comment-related triggers happen. For example, you could promote a post to the front page when a comment is added.') .'

'; + break; + case 'admin/build/trigger/node': + $output .= $explanation .'

'. t('Below you can assign actions to run when certain content-related triggers happen. For example, you could remove a post from the front page when the post is updated.') .'

'; + break; + case 'admin/build/trigger/cron': + $output .= $explanation .'

'. t('Below you can assign actions to run when cron runs. More information on cron is available in the System module help page.', array('@system' => url('admin/help/system'))) .'

'; + break; + case 'admin/build/trigger/taxonomy': + $output .= $explanation .'

'. t('Below you can assign actions to run when certain category-related triggers happen. For example, you could send an e-mail to an administrator when a category is deleted.') .'

'; + break; + case 'admin/build/trigger/user': + $output .= $explanation .'

'. t("Below you can assign actions to run when certain user-related triggers happen. For example, you could send an e-mail to an administrator when a user account is deleted.") .'

'; + break; + case 'admin/help#trigger': + $output .= '

'. t('The Trigger module provides the ability to trigger actions upon system events, such as when new content is added or when a user logs in.', array('@actions' => url('admin/settings/actions'))) .'

'; + $output .= '

'. t('The combination of actions and triggers can perform many useful tasks, such as e-mailing an administrator if a user account is deleted, or automatically unpublishing comments that contain certain words. By default, there are five "contexts" of events (Categories, Comments, Content, Cron, and Users), but more may be added by additional modules.') .'

'; + $output .= '

'. t('For more information please read the configuration and customization handbook Trigger page.', array('@trigger' => 'http://drupal.org/handbook/modules/trigger/')) .'

'; + break; + } + + return $output; +} + +/** + * Implementation of hook_menu(). + */ +function trigger_menu() { + $items['admin/build/trigger'] = array( + 'title' => 'Triggers', + 'description' => 'Tell Drupal when to execute actions.', + 'page callback' => 'trigger_assign', + 'access callback' => 'trigger_access_check', + 'access arguments' => array('node'), + ); + // We don't use a menu wildcard here because these are tabs, + // not invisible items. + $items['admin/build/trigger/node'] = array( + 'title' => 'Content', + 'page callback' => 'trigger_assign', + 'page arguments' => array('node'), + 'access arguments' => array('node'), + 'type' => MENU_LOCAL_TASK, + ); + $items['admin/build/trigger/user'] = array( + 'title' => 'Users', + 'page callback' => 'trigger_assign', + 'page arguments' => array('user'), + 'access arguments' => array('user'), + 'type' => MENU_LOCAL_TASK, + ); + $items['admin/build/trigger/comment'] = array( + 'title' => 'Comments', + 'page callback' => 'trigger_assign', + 'page arguments' => array('comment'), + 'access callback' => 'trigger_access_check', + 'access arguments' => array('comment'), + 'type' => MENU_LOCAL_TASK, + ); + $items['admin/build/trigger/taxonomy'] = array( + 'title' => 'Categories', + 'page callback' => 'trigger_assign', + 'page arguments' => array('taxonomy'), + 'access callback' => 'trigger_access_check', + 'access arguments' => array('taxonomy'), + 'type' => MENU_LOCAL_TASK, + ); + $items['admin/build/trigger/cron'] = array( + 'title' => 'Cron', + 'page callback' => 'trigger_assign', + 'page arguments' => array('cron'), + 'type' => MENU_LOCAL_TASK, + ); + + // We want contributed modules to be able to describe + // their hooks and have actions assignable to them. + $hooks = module_invoke_all('hook_info'); + foreach ($hooks as $module => $hook) { + // We've already done these. + if (in_array($module, array('node', 'comment', 'user', 'system', 'taxonomy'))) { + continue; + } + $info = db_result(db_query("SELECT info FROM {system} WHERE name = '%s'", $module)); + $info = unserialize($info); + $nice_name = $info['name']; + $items["admin/build/trigger/$module"] = array( + 'title' => $nice_name, + 'page callback' => 'trigger_assign', + 'page arguments' => array($module), + 'access arguments' => array($module), + 'type' => MENU_LOCAL_TASK, + ); + } + $items['admin/build/trigger/unassign'] = array( + 'title' => 'Unassign', + 'description' => 'Unassign an action from a trigger.', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('trigger_unassign'), + 'type' => MENU_CALLBACK, + ); + + return $items; +} + +/** + * Access callback for menu system. + */ +function trigger_access_check($module) { + return (module_exists($module) && user_access('administer actions')); +} + +/** + * Get the actions that have already been defined for this + * type-hook-op combination. + * + * @param $type + * One of 'node', 'user', 'comment'. + * @param $hook + * The name of the hook for which actions have been assigned, + * e.g. 'nodeapi'. + * @param $op + * The hook operation for which the actions have been assigned, + * e.g., 'view'. + * @return + * An array of action descriptions keyed by action IDs. + */ +function _trigger_get_hook_actions($hook, $op, $type = NULL) { + $actions = array(); + if ($type) { + $result = db_query("SELECT h.aid, a.description FROM {trigger_assignments} h LEFT JOIN {actions} a on a.aid = h.aid WHERE a.type = '%s' AND h.hook = '%s' AND h.op = '%s' ORDER BY h.weight", $type, $hook, $op); + } + else { + $result = db_query("SELECT h.aid, a.description FROM {trigger_assignments} h LEFT JOIN {actions} a on a.aid = h.aid WHERE h.hook = '%s' AND h.op = '%s' ORDER BY h.weight", $hook, $op); + } + while ($action = db_fetch_object($result)) { + $actions[$action->aid] = $action->description; + } + return $actions; +} + +/** + * Get the aids of actions to be executed for a hook-op combination. + * + * @param $hook + * The name of the hook being fired. + * @param $op + * The name of the operation being executed. Defaults to an empty string + * because some hooks (e.g., hook_cron()) do not have operations. + * @return + * An array of action IDs. + */ +function _trigger_get_hook_aids($hook, $op = '') { + $aids = array(); + $result = db_query("SELECT aa.aid, a.type FROM {trigger_assignments} aa LEFT JOIN {actions} a ON aa.aid = a.aid WHERE aa.hook = '%s' AND aa.op = '%s' ORDER BY weight", $hook, $op); + while ($action = db_fetch_object($result)) { + $aids[$action->aid]['type'] = $action->type; + } + return $aids; +} + +/** + * Create the form definition for assigning an action to a hook-op combination. + * + * @param $form_state + * Information about the current form. + * @param $hook + * The name of the hook, e.g., 'nodeapi'. + * @param $op + * The name of the hook operation, e.g., 'insert'. + * @param $description + * A plain English description of what this hook operation does. + * @return + */ +function trigger_assign_form($form_state, $hook, $op, $description) { + $form['hook'] = array( + '#type' => 'hidden', + '#value' => $hook, + ); + $form['operation'] = array( + '#type' => 'hidden', + '#value' => $op, + ); + // All of these forms use the same #submit function. + $form['#submit'][] = 'trigger_assign_form_submit'; + + $options = array(); + $functions = array(); + // Restrict the options list to actions that declare support for this hook-op combination. + foreach (actions_list() as $func => $metadata) { + if (isset($metadata['hooks']['any']) || (isset($metadata['hooks'][$hook]) && is_array($metadata['hooks'][$hook]) && (in_array($op, $metadata['hooks'][$hook])))) { + $functions[] = $func; + } + } + foreach (actions_actions_map(actions_get_all_actions()) as $aid => $action) { + if (in_array($action['callback'], $functions)) { + $options[$action['type']][$aid] = $action['description']; + } + } + + $form[$op] = array( + '#type' => 'fieldset', + '#title' => t('Trigger: '). $description, + '#theme' => 'trigger_display' + ); + // Retrieve actions that are already assigned to this hook-op combination. + $actions = _trigger_get_hook_actions($hook, $op); + $form[$op]['assigned']['#type'] = 'value'; + $form[$op]['assigned']['#value'] = array(); + foreach ($actions as $aid => $description) { + $form[$op]['assigned']['#value'][$aid] = array( + 'description' => $description, + 'link' => l(t('unassign'), "admin/build/trigger/unassign/$hook/$op/". md5($aid)) + ); + } + + $form[$op]['parent'] = array( + '#prefix' => "
", + '#suffix' => '
', + ); + // List possible actions that may be assigned. + if (count($options) != 0) { + array_unshift($options, t('Choose an action')); + $form[$op]['parent']['aid'] = array( + '#type' => 'select', + '#options' => $options, + ); + $form[$op]['parent']['submit'] = array( + '#type' => 'submit', + '#value' => t('Assign') + ); + } + else { + $form[$op]['none'] = array( + '#value' => t('No available actions for this trigger.') + ); + } + return $form; +} + +function trigger_assign_form_submit($form, $form_state) { + $form_values = $form_state['values']; + + if (!empty($form_values['aid'])) { + $aid = actions_function_lookup($form_values['aid']); + $weight = db_result(db_query("SELECT MAX(weight) FROM {trigger_assignments} WHERE hook = '%s' AND op = '%s'", $form_values['hook'], $form_values['operation'])); + db_query("INSERT INTO {trigger_assignments} values ('%s', '%s', '%s', %d)", $form_values['hook'], $form_values['operation'], $aid, $weight + 1); + } +} + +/** + * Implementation of hook_theme(). + */ +function trigger_theme() { + return array( + 'trigger_display' => array( + 'arguments' => array('element') + ), + ); +} + +/** + * Display actions assigned to this hook-op combination in a table. + * + * @param array $element + * The fieldset including all assigned actions. + * @return + * The rendered form with the table prepended. + */ +function theme_trigger_display($element) { + $header = array(); + $rows = array(); + if (count($element['assigned']['#value'])) { + $header = array(array('data' => t('Name')), array('data' => t('Operation'))); + $rows = array(); + foreach ($element['assigned']['#value'] as $aid => $info) { + $rows[] = array( + $info['description'], + $info['link'] + ); + } + } + + $output = theme('table', $header, $rows) . drupal_render($element); + return $output; +} + +/** + * Implementation of hook_forms(). We reuse code by using the + * same assignment form definition for each node-op combination. + */ +function trigger_forms() { + $hooks = module_invoke_all('hook_info'); + foreach ($hooks as $module => $info) { + foreach ($hooks[$module] as $hook => $ops) { + foreach ($ops as $op => $description) { + $forms['trigger_'. $hook .'_'. $op .'_assign_form'] = array('callback' => 'trigger_assign_form'); + } + } + } + + return $forms; +} + +/** + * Build the form that allows users to assign actions to hooks. + * + * @param $type + * Name of hook. + * @return + * HTML form. + */ +function trigger_assign($type = NULL) { + // If no type is specified we default to node actions, since they + // are the most common. + if (!isset($type)) { + drupal_goto('admin/build/trigger/node'); + } + if ($type == 'node') { + $type = 'nodeapi'; + } + + $output = ''; + $hooks = module_invoke_all('hook_info'); + foreach ($hooks as $module => $hook) { + if (isset($hook[$type])) { + foreach ($hook[$type] as $op => $description) { + $form_id = 'trigger_'. $type .'_'. $op .'_assign_form'; + $output .= drupal_get_form($form_id, $type, $op, $description['runs when']); + } + } + } + return $output; +} + +/** + * Confirm removal of an assigned action. + * + * @param $hook + * @param $op + * @param $aid + * The action ID. + */ +function trigger_unassign($form_state, $hook = NULL, $op = NULL, $aid = NULL) { + if (!($hook && $op && $aid)) { + drupal_goto('admin/build/trigger/assign'); + } + + $form['hook'] = array( + '#type' => 'value', + '#value' => $hook, + ); + $form['operation'] = array( + '#type' => 'value', + '#value' => $op, + ); + $form['aid'] = array( + '#type' => 'value', + '#value' => $aid, + ); + + $action = actions_function_lookup($aid); + $actions = actions_get_all_actions(); + + $destination = 'admin/build/trigger/'. ($hook == 'nodeapi' ? 'node' : $hook); + + return confirm_form($form, + t('Are you sure you want to unassign the action %title?', array('%title' => $actions[$action]['description'])), + $destination, + t('You can assign it again later if you wish.'), + t('Unassign'), t('Cancel') + ); +} + +function trigger_unassign_submit($form, &$form_state) { + $form_values = $form_state['values']; + if ($form_values['confirm'] == 1) { + $aid = actions_function_lookup($form_values['aid']); + db_query("DELETE FROM {trigger_assignments} WHERE hook = '%s' AND op = '%s' AND aid = '%s'", $form_values['hook'], $form_values['operation'], $aid); + $actions = actions_get_all_actions(); + watchdog('actions', 'Action %action has been unassigned.', array('%action' => check_plain($actions[$aid]['description']))); + drupal_set_message(t('Action %action has been unassigned.', array('%action' => $actions[$aid]['description']))); + $hook = $form_values['hook'] == 'nodeapi' ? 'node' : $form_values['hook']; + $form_state['redirect'] = 'admin/build/trigger/'. $hook; + } + else { + drupal_goto('admin/build/trigger'); + } +} + +/** + * When an action is called in a context that does not match its type, + * the object that the action expects must be retrieved. For example, when + * an action that works on users is called during the node hook, the + * user object is not available since the node hook doesn't pass it. + * So here we load the object the action expects. + * + * @param $type + * The type of action that is about to be called. + * @param $node + * The node that was passed via the nodeapi hook. + * @return + * The object expected by the action that is about to be called. + */ +function _trigger_normalize_node_context($type, $node) { + switch ($type) { + // If an action that works on comments is being called in a node context, + // the action is expecting a comment object. But we do not know which comment + // to give it. The first? The most recent? All of them? So comment actions + // in a node context are not supported. + + // An action that works on users is being called in a node context. + // Load the user object of the node's author. + case 'user': + return user_load(array('uid' => $node->uid)); + } +} + +/** + * Implementation of hook_nodeapi(). + */ +function trigger_nodeapi($node, $op, $a3, $a4) { + // Keep objects for reuse so that changes actions make to objects can persist. + static $objects; + // Prevent recursion by tracking which operations have already been called. + static $recursion; + // Support a subset of operations. + if (!in_array($op, array('view', 'update', 'presave', 'insert', 'delete')) || isset($recursion[$op])) { + return; + } + $recursion[$op] = TRUE; + + $aids = _trigger_get_hook_aids('nodeapi', $op); + if (!$aids) { + return; + } + $context = array( + 'hook' => 'nodeapi', + 'op' => $op, + ); + + // We need to get the expected object if the action's type is not 'node'. + // We keep the object in $objects so we can reuse it if we have multiple actions + // that make changes to an object. + foreach ($aids as $aid => $action_info) { + if ($action_info['type'] != 'node') { + if (!isset($objects[$action_info['type']])) { + $objects[$action_info['type']] = _trigger_normalize_node_context($action_info['type'], $node); + } + // Since we know about the node, we pass that info along to the action. + $context['node'] = $node; + $result = actions_do($aid, $objects[$action_info['type']], $context, $a4, $a4); + } + else { + actions_do($aid, $node, $context, $a3, $a4); + } + } +} + +/** + * When an action is called in a context that does not match its type, + * the object that the action expects must be retrieved. For example, when + * an action that works on nodes is called during the comment hook, the + * node object is not available since the comment hook doesn't pass it. + * So here we load the object the action expects. + * + * @param $type + * The type of action that is about to be called. + * @param $comment + * The comment that was passed via the comment hook. + * @return + * The object expected by the action that is about to be called. + */ +function _trigger_normalize_comment_context($type, $comment) { + switch ($type) { + // An action that works with nodes is being called in a comment context. + case 'node': + return node_load(is_array($comment) ? $comment['nid'] : $comment->nid); + + // An action that works on users is being called in a comment context. + case 'user': + return user_load(array('uid' => is_array($comment) ? $comment['uid'] : $comment->uid)); + } +} + +/** + * Implementation of hook_comment(). + */ +function trigger_comment($a1, $op) { + // Keep objects for reuse so that changes actions make to objects can persist. + static $objects; + // We support a subset of operations. + if (!in_array($op, array('insert', 'update', 'delete', 'view'))) { + return; + } + $aids = _trigger_get_hook_aids('comment', $op); + $context = array( + 'hook' => 'comment', + 'op' => $op, + ); + // We need to get the expected object if the action's type is not 'comment'. + // We keep the object in $objects so we can reuse it if we have multiple actions + // that make changes to an object. + foreach ($aids as $aid => $action_info) { + if ($action_info['type'] != 'comment') { + if (!isset($objects[$action_info['type']])) { + $objects[$action_info['type']] = _trigger_normalize_comment_context($action_info['type'], $a1); + } + // Since we know about the comment, we pass it along to the action + // in case it wants to peek at it. + $context['comment'] = (object) $a1; + actions_do($aid, $objects[$action_info['type']], $context); + } + else { + actions_do($aid, (object) $a1, $context); + } + } +} + +/** + * Implementation of hook_cron(). + */ +function trigger_cron() { + $aids = _trigger_get_hook_aids('cron'); + $context = array( + 'hook' => 'cron', + 'op' => '', + ); + // Cron does not act on any specific object. + $object = NULL; + actions_do(array_keys($aids), $object, $context); +} + +/** + * When an action is called in a context that does not match its type, + * the object that the action expects must be retrieved. For example, when + * an action that works on nodes is called during the user hook, the + * node object is not available since the user hook doesn't pass it. + * So here we load the object the action expects. + * + * @param $type + * The type of action that is about to be called. + * @param $account + * The account object that was passed via the user hook. + * @return + * The object expected by the action that is about to be called. + */ +function _trigger_normalize_user_context($type, $account) { + switch ($type) { + // If an action that works on comments is being called in a user context, + // the action is expecting a comment object. But we have no way of + // determining the appropriate comment object to pass. So comment + // actions in a user context are not supported. + + // An action that works with nodes is being called in a user context. + // If a single node is being viewed, return the node. + case 'node': + // If we are viewing an individual node, return the node. + if ((arg(0) == 'node') && is_numeric(arg(1)) && (arg(2) == NULL)) { + return node_load(array('nid' => arg(1))); + } + } +} + +/** + * Implementation of hook_user(). + */ +function trigger_user($op, &$edit, &$account, $category = NULL) { + // Keep objects for reuse so that changes actions make to objects can persist. + static $objects; + // We support a subset of operations. + if (!in_array($op, array('login', 'logout', 'insert', 'update', 'delete', 'view'))) { + return; + } + $aids = _trigger_get_hook_aids('user', $op); + $context = array( + 'hook' => 'user', + 'op' => $op, + 'form_values' => &$edit, + ); + foreach ($aids as $aid => $action_info) { + if ($action_info['type'] != 'user') { + if (!isset($objects[$action_info['type']])) { + $objects[$action_info['type']] = _trigger_normalize_user_context($action_info['type'], $account); + } + $context['account'] = $account; + actions_do($aid, $objects[$action_info['type']], $context); + } + else { + actions_do($aid, $account, $context, $category); + } + } +} + +/** + * Implementation of hook_taxonomy(). + */ +function trigger_taxonomy($op, $type, $array) { + if ($type != 'term') { + return; + } + $aids = _trigger_get_hook_aids('taxonomy', $op); + $context = array( + 'hook' => 'taxonomy', + 'op' => $op + ); + foreach ($aids as $aid => $action_info) { + actions_do($aid, (object) $array, $context); + } +} + +/** + * Often we generate a select field of all actions. This function + * generates the options for that select. + * + * @param $type + * One of 'node', 'user', 'comment'. + * @return + * Array keyed by action ID. + */ +function trigger_options($type = 'all') { + $options = array(t('Choose an action')); + foreach (actions_actions_map(actions_get_all_actions()) as $aid => $action) { + $options[$action['type']][$aid] = $action['description']; + } + + if ($type == 'all') { + return $options; + } + else { + return $options[$type]; + } +} Index: modules/trigger/trigger.schema =================================================================== RCS file: modules/trigger/trigger.schema diff -N modules/trigger/trigger.schema --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ modules/trigger/trigger.schema 10 Sep 2007 18:36:35 -0000 @@ -0,0 +1,16 @@ + array( + 'hook' => array('type' => 'varchar', 'length' => 32, 'not null' => TRUE, 'default' => ''), + 'op' => array('type' => 'varchar', 'length' => 32, 'not null' => TRUE, 'default' => ''), + 'aid' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), + 'weight' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), + ), + 'index keys' => array( + 'hook_op' => array('hook', 'op')) + ); + return $schema; +} Index: modules/user/user.module =================================================================== RCS file: /cvs/drupal/drupal/modules/user/user.module,v retrieving revision 1.845 diff -u -u -p -r1.845 user.module --- modules/user/user.module 10 Sep 2007 13:14:38 -0000 1.845 +++ modules/user/user.module 10 Sep 2007 18:36:35 -0000 @@ -1991,22 +1991,22 @@ function user_hook_info() { 'user' => array( 'user' => array( 'insert' => array( - 'runs when' => t('When a user account has been created'), + 'runs when' => t('After a user account has been created'), ), 'update' => array( - 'runs when' => t('When a user account has been updated'), + 'runs when' => t("After a user's profile has been updated"), ), 'delete' => array( - 'runs when' => t('When a user account has been deleted') + 'runs when' => t('After a user has been deleted') ), 'login' => array( - 'runs when' => t('When a user has logged in') + 'runs when' => t('After a user has logged in') ), 'logout' => array( - 'runs when' => t('When a user has logged out') + 'runs when' => t('After a user has logged out') ), 'view' => array( - 'runs when' => t("When a user's account information is displayed") + 'runs when' => t("When a user's profile is being viewed") ), ), ), @@ -2023,19 +2023,15 @@ function user_action_info() { 'type' => 'user', 'configurable' => FALSE, 'hooks' => array( - 'nodeapi' => array('presave', 'delete', 'insert', 'update', 'view'), - 'comment' => array('view', 'insert', 'update', 'delete'), 'user' => array('logout'), - ), - ), + ) + ), 'user_block_ip_action' => array( 'description' => t('Ban IP address of current user'), 'type' => 'user', 'configurable' => FALSE, 'hooks' => array( - 'nodeapi' => array('presave', 'delete', 'insert', 'update', 'view'), - 'comment' => array('view', 'insert', 'update', 'delete'), - 'user' => array('logout'), + 'user' => array('delete'), ) ), );