diff --git a/helpers/group.entity.inc b/helpers/group.entity.inc index fe89916..eb4045b 100644 --- a/helpers/group.entity.inc +++ b/helpers/group.entity.inc @@ -93,7 +93,7 @@ function group_load_by_type($type) { * @param string $type * (optional) Filters the results by a group type. * - * @return array + * @return Group[] * An array of Group entities, keyed by their group ids. */ function group_load_by_member($uid, $type = NULL) { diff --git a/helpers/group.inc b/helpers/group.inc index 25777a4..9bb3ba6 100644 --- a/helpers/group.inc +++ b/helpers/group.inc @@ -95,19 +95,19 @@ function group_get_entity_group_ids($entity_type, $entity_id) { } /** - * Retrieves the group id from an autocomplete result. + * Retrieves the group ids from an autocomplete result. * * @param string $result * The result returned by a group autocomplete field. * - * @return int|false - * The group id (gid) of the result or FALSE on failure. + * @return int[]|FALSE + * The group ids of the result or FALSE on failure. * * @see group_autocomplete() * @see group_autocomplete_by_type() */ function group_autocomplete_result_gid($result) { - if (preg_match('/(\d+)\)$/', $result, $matches)) { + if (preg_match_all('/\(GID\: (\d+)\)/', $result, $matches)) { return $matches[1]; } diff --git a/modules/gnode/gnode.admin.inc b/modules/gnode/gnode.admin.inc index 1387628..91a280e 100644 --- a/modules/gnode/gnode.admin.inc +++ b/modules/gnode/gnode.admin.inc @@ -11,6 +11,41 @@ * @see gnode_menu(). */ function gnode_settings($form, &$form_state) { + $form['gnode_group_choice_admin_element'] = array( + '#type' => 'radios', + '#title' => t('Admin group selection mode'), + '#default_value' => variable_get('gnode_group_choice_admin_element', 'autocomplete'), + '#description' => t('Choose the type of form element administrators use to select which groups a node should be in.'), + '#options' => array( + 'select' => t('Select dropdown'), + 'autocomplete' => t('Autocomplete'), + 'checkbox' => t('Checkboxes or radios'), + ), + ); + + $form['gnode_group_choice_standard_element'] = array( + '#type' => 'radios', + '#title' => t('Standard user group selection mode'), + '#default_value' => variable_get('gnode_group_choice_standard_element', 'select'), + '#description' => t('Choose the type of form element standard users use to select which groups a node should be in.'), + '#options' => array( + 'select' => t('Select dropdown'), + 'autocomplete' => t('Autocomplete'), + 'checkbox' => t('Checkboxes or radios'), + ), + ); + + $form['group_node_multiple_groups'] = array( + '#type' => 'radios', + '#title' => t('Nodes in multiple groups'), + '#default_value' => variable_get('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE), + '#description' => t('Choose if a node can only be in one group or can be in multiple groups. Nodes in multiple groups can be updated and deleted by users with the necessary permissions in any of the groups it is in. After changing this session you must clear the site cache. It is not recommended that you go from multiple to single on a site which has nodes in multiple groups without testing.'), + '#options' => array( + GROUP_NODE_SINGLE_GROUPS_MODE => t('A node can only be in a single group.'), + GROUP_NODE_MULTIPLE_GROUPS_MODE => t('A node can be placed into multiple groups.'), + ), + ); + $form['group_node_mode'] = array( '#type' => 'radios', '#title' => t('Group node access mode'), @@ -32,11 +67,19 @@ function gnode_settings($form, &$form_state) { * * @see gnode_settings(). */ -function gnode_settings_form_submit(&$form, &$form_submit) { - $selected_group_mode = $form_submit['values']['group_node_mode']; +function gnode_settings_form_submit(&$form, &$form_state) { + $access_mode = $form_state['values']['group_node_mode']; + $multiple_mode = $form_state['values']['group_node_multiple_groups']; // If the access mode has changed then node access needs rebuilding. - if ($selected_group_mode !== _gnode_get_mode()) { + if ($access_mode !== _gnode_get_mode()) { node_access_needs_rebuild(TRUE); } + + // Show a warning about caches needing to be cleared. + if ($multiple_mode !== variable_get('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE)) { + drupal_set_message(t('The site cache should be cleared now because the nodes in multiple groups setting has changed. !link', array( + '!link' => l(t('Go to performance settings'), 'admin/config/development/performance'), + )), 'warning'); + } } diff --git a/modules/gnode/gnode.info b/modules/gnode/gnode.info index d4862a2..46284dc 100644 --- a/modules/gnode/gnode.info +++ b/modules/gnode/gnode.info @@ -4,6 +4,8 @@ core = 7.x package = Group files[] = tests/gnode.test +files[] = tests/gnode.multiple.test +files[] = tests/gnode.interface.test dependencies[] = group dependencies[] = node diff --git a/modules/gnode/gnode.install b/modules/gnode/gnode.install index a4e9642..10a320c 100644 --- a/modules/gnode/gnode.install +++ b/modules/gnode/gnode.install @@ -13,3 +13,12 @@ function gnode_install() { ->condition('name', 'gnode') ->execute(); } + +/** + * Implements hook_uninstall(). + */ +function gnode_uninstall() { + variable_del('gnode_group_choice_admin_element'); + variable_del('gnode_group_choice_standard_element'); + variable_del('group_node_multiple_groups'); +} diff --git a/modules/gnode/gnode.module b/modules/gnode/gnode.module index be70bea..40f75ed 100644 --- a/modules/gnode/gnode.module +++ b/modules/gnode/gnode.module @@ -21,6 +21,16 @@ define('GROUP_NODE_SAFE_MODE', 'GROUP_NODE_SAFE_MODE'); define('GROUP_NODE_COMPLIANCE_MODE', 'GROUP_NODE_COMPLIANCE_MODE'); /** + * Mode which only allows a node to be in one group. + */ +define('GROUP_NODE_SINGLE_GROUPS_MODE', 'GROUP_NODE_SINGLE_GROUPS_MODE'); + +/** + * Mode which allows a node to be in multiple group. + */ +define('GROUP_NODE_MULTIPLE_GROUPS_MODE', 'GROUP_NODE_MULTIPLE_GROUPS_MODE'); + +/** * Load our router functions without polluting the .module file. */ require_once 'gnode.router.inc'; @@ -42,11 +52,22 @@ function _gnode_get_mode() { } /** + * Determine if gnode is in multiple mode. + * + * @return bool + * TRUE if a node can be placed within multiple groups. + * FALSE if a node can only be placed in a single group. + */ +function _gnode_is_multiple() { + $multiple_mode = variable_get('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); + return $multiple_mode === GROUP_NODE_MULTIPLE_GROUPS_MODE; +} + +/** * Implements hook_entity_info_alter(). */ function gnode_entity_info_alter(&$entity_info) { - // Nodes can only have one group parent. - $entity_info['node']['group entity'] = 'single'; + $entity_info['node']['group entity'] = _gnode_is_multiple() ? 'multiple' : 'single'; } /** @@ -269,6 +290,36 @@ function gnode_global_node_create_access($type, $account = NULL) { } /** + * Get a list of all the group ids a node is within. + * + * This normalises the group parameter on a node as this can be either a single + * value if gnode module is configured so that nodes can have only one parent or + * an array of values if a node can have multiple parents. + * + * @param $node + * + * @return int[] + */ +function gnode_node_group_ids($node) { + if (empty($node->group)) { + return array(); + } + + return is_array($node->group) ? $node->group : array($node->group); +} + +/** + * Get a list of all group entities a node is within. + * + * @param $node + * + * @return Group[] + */ +function gnode_node_groups($node) { + return group_load_multiple(gnode_node_group_ids($node)); +} + +/** * Implements hook_node_access(). * * Because the grant system for node access can quickly become very taxing on @@ -294,36 +345,43 @@ function gnode_node_access($node, $op, $account) { } // Make sure we are dealing with a group node. - elseif (!empty($node->group)) { - $group = group_load($node->group); + if (empty($node->group)) { + return NODE_ACCESS_IGNORE; + } - // If the user can bypass group access, he is allowed access. - if (user_access('bypass group access', $account)) { + // If the user can bypass group access, he is allowed access. + if (user_access('bypass group access', $account)) { + return NODE_ACCESS_ALLOW; + } + + // Check access within all of the node's groups. + foreach (gnode_node_groups($node) as $group) { + if (group_access('administer group', $group, $account)) { return NODE_ACCESS_ALLOW; } - $has_access = group_access('administer group', $group, $account); - switch ($op) { case "view": - $has_access = $has_access || group_access("view $node->type node", $group, $account); + if (group_access("view $node->type node", $group, $account)) { + return NODE_ACCESS_ALLOW; + } break; case "update": case "delete": - $has_access = $has_access || group_access("$op any $node->type node", $group, $account); + if (group_access("$op any $node->type node", $group, $account)) { + return NODE_ACCESS_ALLOW; + } - if ($account->uid == $node->uid) { - $has_access = $has_access || group_access("$op own $node->type node", $group, $account); + if ($account->uid == $node->uid && group_access("$op own $node->type node", $group, $account)) { + return NODE_ACCESS_ALLOW; } break; } - - return $has_access ? NODE_ACCESS_ALLOW : NODE_ACCESS_DENY; } - return NODE_ACCESS_IGNORE; + return NODE_ACCESS_DENY; } /** @@ -389,33 +447,19 @@ function gnode_node_add(Group $group, $node_type) { */ function gnode_form_node_form_alter(&$form, $form_state) { $node = $form_state['node']; - $gid = !empty($node->group) ? $node->group : 0; + + $groups = gnode_node_groups($node); + $gids = array_keys($groups); $can_bypass_access = user_access('bypass group access'); - // If the user can't bypass group access and we already have a nid or gid, we - // are either on a node edit form or a Group Node add form. In such a case, - // we do not show anything. - if (!$can_bypass_access) { - // Fix the group if the node was already set to one. - if (!empty($gid)) { - $form['gid'] = array( - '#type' => 'value', - '#value' => $gid, - '#parents' => array('group_settings', 'gid'), - ); - - return; - } - // Do nothing if we are on an ungrouped node's edit form. - elseif (!empty($node->nid)) { - return; - } + // If the user can't bypass group access, the node has an ID and does not + // belong to any groups, we are on an ungrouped node's edit form and do not + // show anything. + if (!$can_bypass_access && empty($groups) && !empty($node->nid)) { + return; } - $global_node_create_access = gnode_global_node_create_access($node->type); - $group_access_warning = t("By selecting a group, the node will inherit the group's access control."); - // Otherwise add a vertical tab for group selection. $form['group_settings'] = array( '#type' => 'fieldset', @@ -433,59 +477,184 @@ function gnode_form_node_form_alter(&$form, $form_state) { '#weight' => -50, ); - // Show a select of all the groups the author can create the node in. - if (!$can_bypass_access) { - $options = array(); - foreach (group_load_multiple(gnode_group_node_create_gids($node->type)) as $group) { - $options[$group->gid] = $group->label() . " (GID: $group->gid)"; + // Keep track of the groups the node was in already. + $form['group_settings']['existing_gids'] = array( + '#type' => 'value', + '#value' => $gids, + '#parent' => array('group_settings'), + ); + + // Find out which form API element we should be using. + $element_type = $can_bypass_access + ? variable_get('gnode_group_choice_admin_element', 'autocomplete') + : variable_get('gnode_group_choice_standard_element', 'select'); + + // Use a helper function to generate the form element. + $element_function = "_gnode_generate_node_form_group_{$element_type}_element"; + $element = function_exists($element_function) ? $element_function($node) : array(); + + // If the user is not able to change the group for this node, we do not show + // the group selection vertical tab. + if (empty($element) || !is_array($element)) { + $form['group_settings']['#access'] = FALSE; + return; + } + + // Add the group select form element to the form. + $form['group_settings'] += $element; +} + +/** + * Helper function to generate a form node element for selecting the group. + * + * @param $node + * The node whose edit form is being generated. + * + * @return array + * Form API select element. + */ +function _gnode_generate_node_form_group_select_element($node) { + $options = array(); + + // Show all of the groups the user can create a node in if it's a new node or + // just the groups the user can administer if it's not. + foreach (group_load_multiple(gnode_group_node_create_gids($node->type)) as $group) { + if (empty($node->nid) || group_access('administer group', $group)) { + $options[$group->gid] = $group->label(); } + } + + // Bail early if the user has no options available to him. + if (empty($options)) { + return array(); + } + + // Check if the user can create nodes outside of a group. + $global_node_create_access = gnode_global_node_create_access($node->type); + + // If there is only one option and the user cannot create content outside of + // the group then the group control should be selected and disabled. + $disabled = (count($options) === 1 && !$global_node_create_access); + + // Retrieve the current group IDs from the node. + $default_gids = gnode_node_group_ids($node); - $description = $global_node_create_access - ? t('Optionally select the group to attach this node to.') - : t('Because you are not allowed to create this content outside of a group, you are required to select one here.'); + if (!$global_node_create_access && empty($default_gids) && count($options) === 1) { + $default_gids = array(key($gids)); + } + + $description = $global_node_create_access + ? t('Optionally select the group to attach this node to.') + : t('Because you are not allowed to create this content outside of a group, you are required to select one here.'); - $form['group_settings']['gid'] = array( + return array( + 'gid' => array( '#type' => 'select', '#title' => t('Parent group'), - '#description' => $description . '
' . $group_access_warning, + '#description' => $description . '
' . _gnode_get_group_access_warning(), '#options' => $options, '#required' => !$global_node_create_access, + '#multiple' => _gnode_is_multiple(), + '#default_value' => $default_gids, '#empty_value' => '', - ); + '#disabled' => $disabled, + ), + ); +} + +/** + * Function to generate a form node element for checkbox selection of the group. + * + * @param $node + * The node whose edit form is being generated + * + * @return array + * Form API select element. + */ +function _gnode_generate_node_form_group_checkbox_element($node) { + $element = _gnode_generate_node_form_group_select_element($node); + + if (empty($element)) { + return $element; } - // Show an autocomplete field to select the group with. + if (_gnode_is_multiple()) { + // If nodes can be in many groups then use checkboxes. + $element['gid']['#type'] = 'checkboxes'; + } else { - $group_name = ''; - - if ($gid) { - // Retrieve the default value for the autocomplete field. - $title = group_load($gid)->title; - $group_name = "$title (GID: $gid)"; + // If nodes can be in only one group then use radio buttons. + $element['gid']['#type'] = 'radios'; + + // If not required add a none option. + if (empty($element['gid']['#required'])) { + $element['gid']['#options'] = array(0 => t('None')) + $element['gid']['#options']; + if (empty($element['gid']['#default_value'])) { + $element['gid']['#default_value'] = array('0'); + } } - $description = $global_node_create_access - ? t('Enter the name of the group to attach this node to. Leave blank for no group.') - : t('Because you are not allowed to create this content outside of a group, you are required to enter the name of one here.'); - - // There is a special use case where a user may edit global nodes, but - // not create them and also may bypass group access. In such a case, he - // could move an ungrouped node to a group, or leave it ungrouped. - if (!empty($node->nid) && empty($gid) && !$global_node_create_access) { - $description = t('This node is not attached to a group. In order to keep it that way, leave this field blank. Alternatively, you may enter the name of the group to attach this node to.'); - $description .= '
' . t('Warning: Because you are not allowed to create this content outside of a group, you will not be able to move it back to the sitewide scope.'); - $global_node_create_access = TRUE; - } + // Set the default value to be a single value. + $element['gid']['#default_value'] = reset($element['gid']['#default_value']); + } + + return $element; +} + +/** + * Helper function to generate a form node auto complete element. + * + * @param $node + * The node whose edit form is being generated + * + * @return array + * Form API select element. + */ +function _gnode_generate_node_form_group_autocomplete_element($node) { + $global_node_create_access = gnode_global_node_create_access($node->type); + $groups = gnode_node_groups($node); + + $group_names = array(); + + foreach ($groups as $gid => $group) { + // Retrieve the default value for the auto complete field. + $title = $group->label(); + $group_names[] = "$title (GID: $gid)"; + } + + $group_name = implode(', ', $group_names); + + $description = $global_node_create_access + ? t('Enter the name of the group to attach this node to. Leave blank for no group.') + : t('Because you are not allowed to create this content outside of a group, you are required to enter the name of one here.'); - $form['group_settings']['group'] = array( + // There is a special use case where a user may edit global nodes, but not + // create them and also may bypass group access. In such a case, he could move + // an ungrouped node to a group, or leave it ungrouped. + if (!empty($node->nid) && empty($gids) && !$global_node_create_access) { + $description = t('This node is not attached to a group. In order to keep it that way, leave this field blank. Alternatively, you may enter the name of the group to attach this node to.'); + $description .= '
' . t('Warning') . ': ' . t('Because you are not allowed to create this content outside of a group, you will not be able to move it back to the site wide scope.'); + $global_node_create_access = TRUE; + } + + return array( + 'group_autocomplete' => array( '#type' => 'textfield', '#title' => t('Parent group'), '#autocomplete_path' => 'group/autocomplete', '#default_value' => $group_name, - '#description' => $description . '
' . $group_access_warning, + '#description' => $description . '
' . _gnode_get_group_access_warning(), '#required' => !$global_node_create_access, - ); - } + '#multiple' => _gnode_is_multiple(), + ), + ); +} + +/** + * Retrieve the warning about node inheriting access control of the group. + */ +function _gnode_get_group_access_warning() { + return '' . t("By selecting a group, the node will inherit the group's access control.") . ''; } /** @@ -499,14 +668,14 @@ function gnode_node_validate($node, $form, &$form_state) { // If the user was presented with an autocomplete, we need to map the selected // group name to a group id in the form state so the submit handler can rely // on it being set. - if (!empty($form_state['values']['group_settings']['group'])) { + if (!empty($form_state['values']['group_settings']['group_autocomplete'])) { // Retrieve the group id from the name suffix. - if ($gid = group_autocomplete_result_gid($form_state['values']['group_settings']['group'])) { - $form_state['values']['group_settings']['gid'] = $gid; + if ($gids = group_autocomplete_result_gid($form_state['values']['group_settings']['group_autocomplete'])) { + $form_state['values']['group_settings']['gid'] = $gids; } // Throw an error if the gid could not be retrieved. else { - form_set_error('group_settings][group', t('Group name not found')); + form_set_error('group_settings][group_autocomplete', t('Group name not found')); } } } @@ -514,13 +683,86 @@ function gnode_node_validate($node, $form, &$form_state) { /** * Implements hook_node_submit(). * + * 1. Bypass group access users can set any groups for this node. + * 2. If it is a new node, the user can add the node to any group they have + * create access to. + * 3. If it is an existing node, the user can change the groups a node is in + * only for groups they are an administrator of. + * 4. If the user cannot globally create nodes of this type then they must + * select at least one of their groups. + * * @see gnode_form_node_form_alter() */ function gnode_node_submit($node, $form, &$form_state) { - if (!empty($form_state['values']['group_settings']['gid'])) { - $node->group = $form_state['values']['group_settings']['gid']; + if (!empty($form_state['values']['group_settings'])) { + $can_bypass_access = user_access('bypass group access'); + + $specified_gids = array(); + if (!empty($form_state['values']['group_settings']['gid'])) { + $specified_gids = $form_state['values']['group_settings']['gid']; + + // If we are in single mode and the result isn't an array, we cast it as + // if it were coming from a multiple option form element. + if (!is_array($specified_gids)) { + $specified_gids = array($specified_gids => $specified_gids); + } + } + + // If the user cannot bypass group access then they cannot change the groups + // the node is in for groups they are not the administrator of. The previous + // groups for this node were stored on the form. + if (!$can_bypass_access && !empty($node->nid)) { + $existing_gids = $form_state['values']['group_settings']['existing_gids']; + + foreach (group_load_multiple($existing_gids) as $existing_group) { + if (!isset($specified_gids[$existing_group->gid])) { + // The user is trying to take the node out a group. They can only do + // this if they are admin of this group. + if (!group_access('administer group', $existing_group)) { + // The user is not an administrator so keep the node in this group. + $specified_gids[] = $existing_group->gid; + } + } + } + + // The user cannot remove the node from all their groups. + $removed_group_ids = array_diff($existing_gids, $specified_gids); + + if (!empty($removed_group_ids)) { + // There has been a group removed, check that at least one remaining group + // the user is administer of. + $found_group = FALSE; + foreach (group_load_multiple($specified_gids) as $specified_group) { + if (group_access('administer group', $specified_group)) { + // The user is an administrator so the specified list is valid. + $found_group = TRUE; + break; + } + } + + if (!$found_group) { + // The user has taken the node out of all their groups so reset it back to how it was. + drupal_set_message(t('You cannot remove this content from all groups you are an administrator of.'), 'warning'); + $specified_gids = $existing_gids; + } + } + } + + $specified_gids = array_filter($specified_gids, '_gnode_specified_groups_result_clean'); + $node->group = _gnode_is_multiple() ? $specified_gids : reset($specified_gids); } elseif (isset($node->group)) { unset($node->group); } } + +/** + * Array filter for results of the node form submission. + * + * We only want real group ids in the result. + * + * @see gnode_node_submit(). + */ +function _gnode_specified_groups_result_clean($value) { + return !empty($value) && is_numeric($value); +} diff --git a/modules/gnode/modes/gnode.compliance.inc b/modules/gnode/modes/gnode.compliance.inc index 9a4eb78..de3b34d 100644 --- a/modules/gnode/modes/gnode.compliance.inc +++ b/modules/gnode/modes/gnode.compliance.inc @@ -201,10 +201,10 @@ function gnode_node_access_records($node) { return $grants; } - if (!empty($node->group)) { + foreach (gnode_node_group_ids($node) as $gid) { if ($node->status) { $grants[] = array( - 'gid' => $node->group, + 'gid' => $gid, 'grant_view' => 1, 'grant_update' => 1, 'grant_delete' => 1, @@ -220,7 +220,7 @@ function gnode_node_access_records($node) { 'grant_update' => 1, 'grant_delete' => 1, 'priority' => 0, - 'realm' => "gnode_author:{$node->group}:{$node->type}", + 'realm' => "gnode_author:{$gid}:{$node->type}", ); } diff --git a/modules/gnode/tests/gnode.interface.test b/modules/gnode/tests/gnode.interface.test new file mode 100644 index 0000000..71a0718 --- /dev/null +++ b/modules/gnode/tests/gnode.interface.test @@ -0,0 +1,438 @@ +gid == $array1_group->gid) { + continue 2; + } + } + $not_in_array2[] = $array1_group; + } + + return $not_in_array2; + } + + /** + * @param Group $group + */ + abstract protected function assertNodeFormHasGroupOption($group); + + /** + * @param Group $group + */ + abstract protected function assertNodeFormNoGroupOption($group); + + /** + * @param array $edit + * @param Group $group + */ + abstract protected function selectGroupOnEditForm(&$edit, $group); + + /** + * @param array $edit + * @param Group $group + */ + abstract protected function deselectGroupOnEditForm(&$edit, $group); + + /** + * Assert the state of a node edit form given a specific user. + * + * This assertion calls abstract functions which are implemented on extended + * versions of this test class to allow different interfaces to be tested. + * + * @param stdClass $node + * The node to edit. + * @param Group[] $groups_to_select + * On the node edit form, which groups should the user choose. + * @param array $admin_groups + * Which available groups do we expect the user to be an admin of. + * @param array $non_admin_groups + * Which available groups is the user not an admin of. + * @param array $groups_after_save + * After saving the node form, which groups do we expect the node to be in. + * + * @throws \Exception + */ + public function assertUserCanEditNodeInGroup($node, $groups_to_select = array(), $admin_groups = array(), $non_admin_groups = array(), $groups_after_save = array()) { + $this->assertNodeOperationAccess($node->nid, 'edit', 200); + + $node_edit_url = '/node/' . $node->nid . '/edit'; + $this->drupalGet($node_edit_url); + + if (count($admin_groups) > 1) { + // Check user can see group selection options if there is more than 1 option. + foreach ($admin_groups as $admin_group) { + $this->assertNodeFormHasGroupOption($admin_group); + } + } + + foreach ($non_admin_groups as $non_admin_group) { + // Check user is not presented with options to set the group to one + // they are not a member of. + $this->assertNodeFormNoGroupOption($non_admin_group); + } + + $edit = array( + 'title' => 'test-title', + 'body[und][0][value]' => 'test-body', + 'body[und][0][format]' => 'filtered_html', + ); + + if (count($admin_groups) > 1) { + foreach ($groups_to_select as $group_to_select) { + // Select a group for the node to be in. + $this->selectGroupOnEditForm($edit, $group_to_select); + } + + foreach ($this->groupArrayDiff($admin_groups, $groups_to_select) as $unselected_groups) { + // Deselect a group for the node to be in. + $this->deselectGroupOnEditForm($edit, $unselected_groups); + } + } + + $this->verbose(print_r($edit, TRUE)); + $this->drupalPost($node_edit_url, $edit, t('Save')); + + $node = node_load($node->nid, NULL, TRUE); + + $expected_gids = array(); + foreach ($groups_after_save as $group_after_save) { + $expected_gids[] = $group_after_save->gid; + } + + $node_groups = empty($node->group) ? array() : $node->group; + $this->assertEqual($node_groups, $expected_gids); + } + + /** + * Test a group admins ability to edit a node when it is in several groups. + * + * There is one node, 3 groups and 3 administrators. + * User 1 is admin of group 1 + * User 2 is admin of group 2 + * User 3 is admin of groups 1 and 2. + * + * The node starts in group 1. User 1 can edit the node, user 2 cannot edit the node. + * User 3 can move the node into group 2 and out of group 1. + * User 2 can edit the node now and user 1 cannot. + * User 3 can move the node into group 1 and group 2. + * User 1 and user 2 can edit the node and it remains in both groups. + */ + public function testMultipleGroupParentEditAccess() { + $group_type = $this->createGroupType('example_group_type'); + $group_1 = $this->createGroup('group_1', 'example_group_type'); + $group_2 = $this->createGroup('group_2', 'example_group_type'); + $group_3 = $this->createGroup('group_3', 'example_group_type'); + + $node = $this->createNodeInGroup($group_1->gid); + + $admin_user_group_1 = $this->drupalCreateUser(array('access content')); + $admin_user_group_2 = $this->drupalCreateUser(array('access content')); + $admin_user_group_1_and_2 = $this->drupalCreateUser(array('access content')); + + $group_role = $this->createRole('content_admin', 'example_group_type'); + $group_role->grantPermissions(array('administer group', 'update any page node', 'create page node')); + + $role_details = array( + 'roles' => array('content_admin'), + 'added_on' => REQUEST_TIME, + 'added_by' => 1, + ); + + $group_1->addMember($admin_user_group_1->uid, $role_details); + $group_2->addMember($admin_user_group_2->uid, $role_details); + $group_1->addMember($admin_user_group_1_and_2->uid, $role_details); + $group_2->addMember($admin_user_group_1_and_2->uid, $role_details); + + // Check user 1 can edit the node as it is in group 1. + $this->drupalLogin($admin_user_group_1); + $this->assertUserCanEditNodeInGroup($node, array($group_1), array($group_1), array($group_2, $group_3), array($group_1)); + + // Check user 2 cannot edit the node in group 1. + $this->drupalLogin($admin_user_group_2); + $this->assertNodeOperationAccess($node->nid, 'edit', 403); + + // Check user 1_and_2 can move the node to group 2. + $this->drupalLogin($admin_user_group_1_and_2); + $this->assertUserCanEditNodeInGroup($node, array($group_2), array($group_1, $group_2), array($group_3), array($group_2)); + + // Now the node is only in group 2, check if user 1 can no longer edit. + $this->drupalLogin($admin_user_group_1); + $this->assertNodeOperationAccess($node->nid, 'edit', 403); + + // Now check that user 2 now can edit. + $this->drupalLogin($admin_user_group_2); + $this->assertUserCanEditNodeInGroup($node, array($group_2), array($group_2), array($group_1, $group_3), array($group_2)); + + // Now have user 1_and_2 put the node in both groups. + $this->drupalLogin($admin_user_group_1_and_2); + $this->assertUserCanEditNodeInGroup($node, array($group_1, $group_2), array($group_1, $group_2), array($group_3), array($group_1, $group_2)); + + // Check if user 1 can edit and it stays in both groups. + $this->drupalLogin($admin_user_group_1); + $this->assertUserCanEditNodeInGroup($node, array($group_1), array($group_1), array($group_2, $group_3), array($group_1, $group_2)); + + // Check if user 2 can edit and it stays in both groups. + $this->drupalLogin($admin_user_group_2); + $this->assertUserCanEditNodeInGroup($node, array($group_2), array($group_2), array($group_1, $group_3), array($group_1, $group_2)); + } + + /** + * Test that group administrators cannot take a node out of all their groups. + */ + public function testAdminsCannotRemoveNodeFromGroups() { + $group_type = $this->createGroupType('example_group_type'); + $group_1 = $this->createGroup('group_1', 'example_group_type'); + $group_2 = $this->createGroup('group_2', 'example_group_type'); + + $node = $this->createNodeInGroup($group_1->gid); + + $admin_user = $this->drupalCreateUser(array('access content')); + + $group_role = $this->createRole('content_admin', 'example_group_type'); + $group_role->grantPermissions(array('administer group', 'update any page node', 'create page node')); + + $role_details = array( + 'roles' => array('content_admin'), + 'added_on' => REQUEST_TIME, + 'added_by' => 1, + ); + + $group_1->addMember($admin_user->uid, $role_details); + $group_2->addMember($admin_user->uid, $role_details); + + // Check admin user cannot remove node from all groups. + $this->drupalLogin($admin_user); + $this->assertUserCanEditNodeInGroup($node, array(), array($group_1, $group_2), array(), array($group_1)); + } + + /** + * Test that site administrators with 'bypass group access' can remove a node from all groups. + */ + public function testAdminsWithBypassGroupAccessCanRemoveNodeFromAllGroups() { + $group_type = $this->createGroupType('example_group_type'); + $group_1 = $this->createGroup('group_1', 'example_group_type'); + $group_2 = $this->createGroup('group_2', 'example_group_type'); + + $node = $this->createNodeInGroup($group_1->gid); + $admin_user = $this->drupalCreateUser(array('access content', 'edit any page content', 'bypass group access')); + + // Check admin user can remove node from all groups. + $this->drupalLogin($admin_user); + $this->assertUserCanEditNodeInGroup($node, array(), array($group_1, $group_2), array(), array()); + } + +} + +class GNodeMultipleEditInterfaceWithCheckboxTests extends GNodeMultipleEditInterfaceTest { + + /** + * Drupal SimpleTest method: return metadata about the test. + */ + public static function getInfo() { + return array( + 'name' => t('Group gnode - node edit tests with multiple parent groups when group selection on a node uses checkboxes'), + 'description' => t('Test node edit interface for a group administrator who can set which groups a node can be in using checkboxes.'), + 'group' => t('Group'), + ); + } + + /** + * Test setup instructions. + */ + public function setUp() { + parent::setUp('node', 'entity', 'group', 'gnode'); + variable_set('group_node_mode', GROUP_NODE_SAFE_MODE); + variable_set('group_node_multiple_groups', GROUP_NODE_MULTIPLE_GROUPS_MODE); + variable_set('gnode_group_choice_standard_element', 'checkbox'); + node_access_rebuild(); + } + + /** + * {@InheritDoc} + */ + protected function assertNodeFormHasGroupOption($group) { + $this->assertFieldByName("group_settings[gid][{$group->gid}]"); + } + + /** + * {@InheritDoc} + */ + protected function assertNodeFormNoGroupOption($group) { + $this->assertNoFieldByName("group_settings[gid][{$group->gid}]"); + } + + /** + * {@InheritDoc} + */ + protected function selectGroupOnEditForm(&$edit, $group) { + $edit["group_settings[gid][{$group->gid}]"] = TRUE; + } + + /** + * {@InheritDoc} + */ + protected function deselectGroupOnEditForm(&$edit, $group) { + $edit["group_settings[gid][{$group->gid}]"] = FALSE; + } + +} + +class GNodeMultipleEditInterfaceWithSelectTests extends GNodeMultipleEditInterfaceTest { + + /** + * Drupal SimpleTest method: return metadata about the test. + */ + public static function getInfo() { + return array( + 'name' => t('Group gnode - node edit tests with multiple parent groups when group selection on a node uses select'), + 'description' => t('Test node edit interface for a group administrator who can set which groups a node can be in using select.'), + 'group' => t('Group'), + ); + } + + /** + * Test setup instructions. + */ + public function setUp() { + parent::setUp('node', 'entity', 'group', 'gnode'); + variable_set('group_node_mode', GROUP_NODE_SAFE_MODE); + variable_set('group_node_multiple_groups', GROUP_NODE_MULTIPLE_GROUPS_MODE); + variable_set('gnode_group_choice_standard_element', 'select'); + node_access_rebuild(); + } + + /** + * {@InheritDoc} + */ + protected function assertNodeFormHasGroupOption($group) { + $this->assertFieldByXPath("//select[@id='edit-group-settings-gid']/option[@value='{$group->gid}']", $group->label(), 'Should find option to add to group ' . $group->gid); + } + + /** + * {@InheritDoc} + */ + protected function assertNodeFormNoGroupOption($group) { + $this->assertNoFieldByXPath("//select[@id='edit-group-settings-gid']/option[@value='{$group->gid}']", NULL, 'Should not find option to add to group ' . $group->gid); + } + + /** + * {@InheritDoc} + */ + protected function selectGroupOnEditForm(&$edit, $group) { + if (!isset($edit['group_settings[gid][]'])) { + $edit['group_settings[gid][]'] = array(); + } + + $edit['group_settings[gid][]'][] = $group->gid; + } + + /** + * {@InheritDoc} + */ + protected function deselectGroupOnEditForm(&$edit, $group) { + if (!empty($edit['group_settings[gid][]'])) { + foreach ($edit['group_settings[gid][]'] as $key => $gid) { + if ($gid == $group->gid) { + unset($edit['group_settings[gid][]'][$key]); + break; + } + } + } + } + +} + + +class GNodeMultipleEditInterfaceWithAutoCompleteTests extends GNodeMultipleEditInterfaceTest { + + /** + * Drupal SimpleTest method: return metadata about the test. + */ + public static function getInfo() { + return array( + 'name' => t('Group gnode - node edit tests with multiple parent groups when group selection on a node uses auto complete'), + 'description' => t('Test node edit interface for a group administrator who can set which groups a node can be in using auto complete.'), + 'group' => t('Group'), + ); + } + + /** + * Test setup instructions. + */ + public function setUp() { + parent::setUp('node', 'entity', 'group', 'gnode'); + variable_set('group_node_mode', GROUP_NODE_SAFE_MODE); + variable_set('group_node_multiple_groups', GROUP_NODE_MULTIPLE_GROUPS_MODE); + variable_set('gnode_group_choice_standard_element', 'autocomplete'); + node_access_rebuild(); + } + + /** + * {@InheritDoc} + */ + protected function assertNodeFormHasGroupOption($group) { + // When working with auto complete form element there is no specific + // form element for an individual group. + } + + /** + * {@InheritDoc} + */ + protected function assertNodeFormNoGroupOption($group) { + // When working with auto complete form element there is no specific + // form element for an individual group. + } + + /** + * {@InheritDoc} + */ + protected function selectGroupOnEditForm(&$edit, $group) { + $auto_complete_string = $group->label() . ' (GID: ' . $group->gid . ')'; + if (empty($edit['group_settings[group_autocomplete]'])) { + $edit['group_settings[group_autocomplete]'] = $auto_complete_string; + } + else { + $edit['group_settings[group_autocomplete]'] .= ',' . $auto_complete_string; + } + } + + /** + * {@InheritDoc} + */ + protected function deselectGroupOnEditForm(&$edit, $group) { + if (!isset($edit['group_settings[group_autocomplete]'])) { + $edit['group_settings[group_autocomplete]'] = ''; + } + + $auto_complete_string = $group->label() . ' (GID: ' . $group->gid . ')'; + $edit['group_settings[group_autocomplete]'] = str_replace(',' . $auto_complete_string, '', $edit['group_settings[group_autocomplete]']); + $edit['group_settings[group_autocomplete]'] = str_replace($auto_complete_string, '', $edit['group_settings[group_autocomplete]']); + } +} diff --git a/modules/gnode/tests/gnode.multiple.test b/modules/gnode/tests/gnode.multiple.test new file mode 100644 index 0000000..e43a936 --- /dev/null +++ b/modules/gnode/tests/gnode.multiple.test @@ -0,0 +1,103 @@ +createGroupType('example1'); + $group_type2 = $this->createGroupType('example2'); + + // Create two groups, one of each type. + $group1 = $this->createGroup('example1', 'example1'); + $group2 = $this->createGroup('example2', 'example2'); + + // Make a node and put it into both groups. + $node = $this->createNodeInGroup($group1->internalIdentifier()); + $this->setNodeGroups($node, array($group1->internalIdentifier(), $group2->internalIdentifier())); + + // Sanity check that with no special permissions the anonymous user cannot + // view the node. + $this->assertNodeOperationAccess($node->nid, 'view', 403, 'Group node is not accessible by anonymous without view permissions'); + $this->assertNodesOnListingPage(array(), 'Group node is not visible on listing pages to anonymous without view permissions.'); + + // Set anonymous permissions on just one of the two group types. + $group_type2->anonymous_permissions = array('view page node'); + $group_type2->save(); + + // Check that the node is now accessible. + $this->assertNodeOperationAccess($node->nid, 'view', 200, 'Group node is accessible by anonymous with view permissions'); + $this->assertNodesOnListingPage(array($node->nid), 'Group node is visible on listing pages to anonymous with view permissions.'); + + // Now remove the node from the group for which anonymous has access. + $this->setNodeGroups($node, array($group1->internalIdentifier())); + + // We no longer expect this node to be accessible. + $this->assertNodeOperationAccess($node->nid, 'view', 403, 'Group node is not accessible by anonymous without view permissions'); + $this->assertNodesOnListingPage(array(), 'Group node is not visible on listing pages to anonymous without view permissions.'); + } +} + +/** + * This class runs all the tests in Compliance mode. + */ +class GNodeComplianceModeMultipleNodeTests extends GNodeMultipleViewAccessTests { + + /** + * Drupal SimpleTest method: return metadata about the test. + */ + public static function getInfo() { + return array( + 'name' => t('Group gnode compliance mode view tests with multiple groups'), + 'description' => t('Executes node access test suite for gnode module in compliance mode when a node is in multiple groups.'), + 'group' => t('Group'), + ); + } + + /** + * Test setup instructions. + */ + public function setUp() { + parent::setUp('node', 'entity', 'group', 'gnode'); + variable_set('group_node_mode', GROUP_NODE_COMPLIANCE_MODE); + variable_set('group_node_multiple_groups', GROUP_NODE_MULTIPLE_GROUPS_MODE); + node_access_rebuild(); + } +} + +/** + * This class runs all the tests in Safe mode. + */ +class GNodeSafeModeMultipleNodeTests extends GNodeMultipleViewAccessTests { + + /** + * Drupal SimpleTest method: return metadata about the test. + */ + public static function getInfo() { + return array( + 'name' => t('Group gnode safe mode view tests with multiple groups'), + 'description' => t('Executes node access test suite for gnode module in safe mode when a node is in multiple groups.'), + 'group' => t('Group'), + ); + } + + /** + * Test setup instructions. + */ + public function setUp() { + parent::setUp('node', 'entity', 'group', 'gnode'); + variable_set('group_node_mode', GROUP_NODE_SAFE_MODE); + variable_set('group_node_multiple_groups', GROUP_NODE_MULTIPLE_GROUPS_MODE); + node_access_rebuild(); + } +} diff --git a/modules/gnode/tests/gnode.test b/modules/gnode/tests/gnode.test index b47e440..3dd91d9 100644 --- a/modules/gnode/tests/gnode.test +++ b/modules/gnode/tests/gnode.test @@ -179,22 +179,36 @@ abstract class GNodeWebTestBase extends DrupalWebTestCase { 'uid' => $uid, 'status' => $status, 'promote' => 1, - 'group' => $gid, + 'group' => _gnode_is_multiple() ? array($gid) : $gid, ) ); } /** - * Remove a node from it's group. + * Set the groups a node is in. * * @param $node + * The node object + * @pram int[] $gids + * A list of group ids the node should be in. + * * @throws \Exception */ - public function removeNodeFromGroup($node) { - $node->group = NULL; + public function setNodeGroups($node, $gids = array()) { + $node->group = _gnode_is_multiple() ? $gids : reset($gids); node_save($node); } + /** + * Remove a node from its groups. + * + * @param $node + * @throws \Exception + */ + public function removeNodeFromGroup($node) { + $this->setNodeGroups($node, array()); + } + } /** @@ -986,6 +1000,7 @@ class GNodeSafeModeViewTests extends GNodeViewAccessTests { public function setUp() { parent::setUp('node', 'entity', 'group', 'gnode'); variable_set('group_node_mode', 'GROUP_NODE_SAFE_MODE'); + variable_set('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); node_access_rebuild(); } @@ -1013,6 +1028,7 @@ class GNodeSafeModeEditTests extends GNodeEditAccessTests { public function setUp() { parent::setUp('node', 'entity', 'group', 'gnode'); variable_set('group_node_mode', 'GROUP_NODE_SAFE_MODE'); + variable_set('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); node_access_rebuild(); } @@ -1040,6 +1056,7 @@ class GNodeSafeModeDeleteTests extends GNodeDeleteAccessTests { public function setUp() { parent::setUp('node', 'entity', 'group', 'gnode'); variable_set('group_node_mode', 'GROUP_NODE_SAFE_MODE'); + variable_set('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); node_access_rebuild(); } @@ -1067,6 +1084,7 @@ class GNodeSafeModeCreateTests extends GNodeCreateAccessTests { public function setUp() { parent::setUp('node', 'entity', 'group', 'gnode'); variable_set('group_node_mode', 'GROUP_NODE_SAFE_MODE'); + variable_set('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); node_access_rebuild(); } @@ -1094,6 +1112,7 @@ class GNodeSafeModeBypassTests extends GNodeBypassAccessTests { public function setUp() { parent::setUp('node', 'entity', 'group', 'gnode'); variable_set('group_node_mode', 'GROUP_NODE_SAFE_MODE'); + variable_set('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); node_access_rebuild(); } @@ -1121,6 +1140,7 @@ class GNodeComplianceModeViewTests extends GNodeViewAccessTests { public function setUp() { parent::setUp('node', 'entity', 'group', 'gnode'); variable_set('group_node_mode', 'GROUP_NODE_COMPLIANCE_MODE'); + variable_set('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); node_access_rebuild(); $this->assert(count(module_implements('node_grants')) > 0, 'The number of modules which implement hook_node_grants is greater than 0.'); } @@ -1148,6 +1168,7 @@ class GNodeComplianceModeEditTests extends GNodeEditAccessTests { public function setUp() { parent::setUp('node', 'entity', 'group', 'gnode'); variable_set('group_node_mode', 'GROUP_NODE_COMPLIANCE_MODE'); + variable_set('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); node_access_rebuild(); $this->assert(count(module_implements('node_grants')) > 0, 'The number of modules which implement hook_node_grants is greater than 0.'); } @@ -1175,6 +1196,7 @@ class GNodeComplianceModeDeleteTests extends GNodeDeleteAccessTests { public function setUp() { parent::setUp('node', 'entity', 'group', 'gnode'); variable_set('group_node_mode', 'GROUP_NODE_COMPLIANCE_MODE'); + variable_set('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); node_access_rebuild(); $this->assert(count(module_implements('node_grants')) > 0, 'The number of modules which implement hook_node_grants is greater than 0.'); } @@ -1202,6 +1224,7 @@ class GNodeComplianceModeCreateTests extends GNodeCreateAccessTests { public function setUp() { parent::setUp('node', 'entity', 'group', 'gnode'); variable_set('group_node_mode', 'GROUP_NODE_COMPLIANCE_MODE'); + variable_set('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); node_access_rebuild(); $this->assert(count(module_implements('node_grants')) > 0, 'The number of modules which implement hook_node_grants is greater than 0.'); } @@ -1229,6 +1252,7 @@ class GNodeComplianceModeBypassTests extends GNodeBypassAccessTests { public function setUp() { parent::setUp('node', 'entity', 'group', 'gnode'); variable_set('group_node_mode', 'GROUP_NODE_COMPLIANCE_MODE'); + variable_set('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); node_access_rebuild(); $this->assert(count(module_implements('node_grants')) > 0, 'The number of modules which implement hook_node_grants is greater than 0.'); } @@ -1263,6 +1287,7 @@ class GNodeComplianceModeViewWithAnotherModuleTests extends GNodeWebTestBase { public function setUp() { parent::setUp('node', 'node_access_test', 'entity', 'group', 'gnode'); variable_set('group_node_mode', 'GROUP_NODE_COMPLIANCE_MODE'); + variable_set('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); node_access_rebuild(); $this->assert(count(module_implements('node_grants')) > 0, 'The number of modules which implement hook_node_grants is greater than 0.'); } @@ -1384,6 +1409,7 @@ class GNodeSafeModeViewWithAnotherModuleTests extends GNodeWebTestBase { public function setUp() { parent::setUp('node', 'node_access_test', 'entity', 'group', 'gnode'); variable_set('group_node_mode', 'GROUP_NODE_SAFE_MODE'); + variable_set('group_node_multiple_groups', GROUP_NODE_SINGLE_GROUPS_MODE); node_access_rebuild(); } @@ -1473,4 +1499,4 @@ class GNodeSafeModeViewWithAnotherModuleTests extends GNodeWebTestBase { user_role_revoke_permissions($role->rid, array('node test view')); $this->assertNodeOperationAccess($node->nid, 'view', 403, 'Node not in group is not accessible by member without group view permissions and without other module grant'); } -} \ No newline at end of file +} diff --git a/pages/group.inc b/pages/group.inc index 84c89c0..5765985 100644 --- a/pages/group.inc +++ b/pages/group.inc @@ -34,6 +34,9 @@ function group_autocomplete($search = '') { function group_autocomplete_by_type(GroupType $group_type = NULL, $search = '') { $matches = array(); + $tags = drupal_explode_tags($search); + $search = trim(array_pop($tags)); + if ($search) { $query = db_select('groups', 'g'); $query->addField('g', 'gid'); @@ -45,8 +48,9 @@ function group_autocomplete_by_type(GroupType $group_type = NULL, $search = '') $query->condition('type', $group_type->name); } + $prefix = count($tags) ? implode(', ', $tags) . ', ' : ''; foreach ($query->execute()->fetchAllKeyed() as $gid => $title) { - $title = check_plain($title); + $title = check_plain($prefix . $title); $match = "$title (GID: $gid)"; $matches[$match] = $match;