The masquerade module adds a link on a user's profile page that allows permitted users to masquerade as that user. Upon masquerading, the link to 'switch back' to the original user will appear in the menu. While masquerading, the option to masquerade as another user will not appear. All masquerading transactions are logged, and $user->masquerading will be set; this could be displayed via theme.
In the masquerade settings a list of roles are presented; any checked role is considered an 'administrator' and requires the second level 'masquerade as admin' permission to masquerade as. User #1 is automatically considered an administrator, regardless of roles.
"); + return t('The masquerade module adds a link on a user\'s profile page that allows permitted users to masquerade as that user. Upon masquerading, the link to "switch back" to the original user will appear in the menu. While masquerading, the option to masquerade as another user will not appear. All masquerading transactions are logged, and $user->masquerading will be set; this could be displayed via theme.
In the masquerade settings a list of roles are presented; any checked role is considered an "administrator" and requires the second level "masquerade as admin" permission to masquerade as. User #1 is automatically considered an administrator, regardless of roles.
'); case 'admin/settings/masquerade': return t('Only the users with masquerade as admin permission, will be able to masquerade as the users who belong to the roles selected below. User #1 is automatically considered an administrator, regardless of roles.'); } @@ -21,6 +21,8 @@ /** * Implementation of hook_perm(). + * + * @return array */ function masquerade_perm() { return array('masquerade as user', 'masquerade as admin'); @@ -46,102 +48,116 @@ /** * Implementation of hook_menu(). */ -function masquerade_menu($may_cache) { +function masquerade_menu() { $items = array(); - if ($may_cache) { - $default_test_user = user_load(array('name' => variable_get('masquerade_test_user', ''))); - $items[] = array('path' => 'masquerade/switch', - 'title' => t('Switch user'), - 'callback' => 'masquerade_switch_user', - 'access' => !$GLOBALS['masquerading'] && (user_access('masquerade as user') || user_access('masquerade as admin')), - 'type' => MENU_CALLBACK, - ); - if ($default_test_user->uid) { - $items[] = array('path' => 'masquerade/switch/'. $default_test_user->uid, - 'title' => t('Masquerade as @testuser', array('@testuser' => $default_test_user->name)), - 'access' => !$GLOBALS['masquerading'] && (user_access('masquerade as user') || user_access('masquerade as admin')), - 'type' => MENU_NORMAL_ITEM, - ); - } - $items[] = array('path' => 'masquerade/unswitch', - 'title' => t('Switch back'), - 'callback' => 'masquerade_switch_back', - 'access' => $GLOBALS['masquerading'], - 'type' => MENU_NORMAL_ITEM, - ); - $items[] = array('path' => 'masquerade/autocomplete', - 'title' => t('Masquerade autocomplete'), - 'callback' => 'masquerade_autocomplete', - 'access' => $GLOBALS['masquerading'] || (user_access('masquerade as user') || user_access('masquerade as admin')), - 'type' => MENU_CALLBACK, - ); - $items[] = array('path' => 'admin/settings/masquerade', - 'title' => t('Masquerade'), - 'description' => t('Masquerade module allows administrators to masquerade as other users.'), - 'callback' => 'drupal_get_form', - 'callback arguments' => 'masquerade_settings', - 'type' => MENU_NORMAL_ITEM, - ); - } + $items['masquerade/switch/%'] = array( + 'title' => 'Masquerading', + 'page callback' => 'masquerade_switch_user', + 'page arguments' => array(2), + 'access callback' => 'masquerade_access', + 'access arguments' => array('switch'), + 'type' => MENU_NORMAL_ITEM, + ); + $items['masquerade/unswitch'] = array( + 'title' => 'Switch back', + 'page callback' => 'masquerade_switch_back', + 'access callback' => 'masquerade_access', + 'access arguments' => array('unswitch'), + 'type' => MENU_NORMAL_ITEM, + ); + $items['masquerade/autocomplete'] = array( + 'title' => 'Masquerade autocomplete', + 'page callback' => 'masquerade_autocomplete', + 'access callback' => 'masquerade_access', + 'access arguments' => array('autocomplete'), + 'type' => MENU_CALLBACK, + ); + $items['admin/settings/masquerade'] = array( + 'title' => 'Masquerade', + 'description' => 'Masquerade module allows administrators to masquerade as other users.', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('masquerade_admin_settings'), + 'access callback' => 'user_access', + 'access arguments' => array('administer permissions'), + 'type' => MENU_NORMAL_ITEM, + ); return $items; } +function masquerade_access($type) { + switch($type) { + case 'unswitch': + return $GLOBALS['masquerading']; + case 'autocomplete': + return $GLOBALS['masquerading'] || (user_access('masquerade as user') || user_access('masquerade as admin')); + break; + case 'switch': + return empty($GLOBALS['masquerading']) && (user_access('masquerade as user') || user_access('masquerade as admin')); + break; + } +} + /** * Implementation of hook_settings(). */ -function masquerade_settings() { +function masquerade_admin_settings() { // create a list of roles; all selected roles are considered administrative. $rids = array(); $result = db_query("SELECT r.rid, r.name FROM {role} r ORDER BY r.name"); while ($obj = db_fetch_object($result)) { $rids[$obj->rid] = $obj->name; } - $test_user = user_load(array('name' => variable_get('masquerade_test_user', ''))); $form['masquerade_admin_roles'] = array( '#type' => 'checkboxes', - '#title' => t("Roles that are considered 'administrator' for masquerading."), + '#title' => t('Roles that are considered "administrator" for masquerading'), '#options' => $rids, '#default_value' => variable_get('masquerade_admin_roles', array()), ); + + $test_name = _masquerade_test_user(); $form['masquerade_test_user'] = array( '#type' => 'textfield', '#title' => t('Default test user'), '#autocomplete_path' => 'masquerade/autocomplete', - '#default_value' => check_plain($test_user->name), + '#default_value' => check_plain($test_name->name), '#description' => t('Enter the username of an account you wish to switch easily between. The name must be an exisiting user.'), ); - $form['masquerade_version_information'] = array( - '#value' => masquerade_version(), - ); - $form['#validate'] = array( - 'masquerade_settings_validate' => array(), - ); return system_settings_form($form); } -function masquerade_settings_validate($form_id, $form_value) { - $test_user = user_load(array('name' => $form_value['masquerade_test_user'])); +function masquerade_admin_settings_validate($form, &$form_state) { + unset($form); + $test_user = user_load(array('name' => $form_state['values']['masquerade_test_user'])); if (!$test_user) { form_set_error('masquerade_test_user', t('No such user exists. Please enter a valid username.')); } } +function _masquerade_test_user() { + $test_user->uid = 0; + $test_user->name = ''; + + $test_user = user_load(array('name' => variable_get('masquerade_test_user', $test_user->name))); + + return $test_user; +} + /** * Implementation of hook_user(). */ function masquerade_user($op, &$edit, &$edit_user, $category = NULL) { switch ($op) { - + case 'logout': if ($edit_user->masquerading) { global $user; cache_clear_all($user->uid, 'cache_menu', true); $real_user = user_load(array('uid' => $user->masquerading)); - watchdog('masquerade', t("User %user no longer masquerading as %masq_as.", array('%user' => $real_user->name, '%masq_as' => $user->name))); + watchdog('masquerade', "User %user no longer masquerading as %masq_as.", array('%user' => $real_user->name, '%masq_as' => $user->name), WATCHDOG_INFO); db_query("DELETE FROM {masquerade} WHERE sid = '%s' AND uid_as = %d", session_id(), $edit_user->uid); } break; @@ -149,17 +165,17 @@ case 'view': // check if user qualifies as admin $roles = array_keys(array_filter(variable_get('masquerade_admin_roles', array()))); - $perm = $edit_user->uid == 1 || array_intersect(array_keys($edit_user->roles), $roles) ? + $perm = $edit_user->uid == 1 || array_intersect(array_keys($edit_user->roles), $roles) ? 'masquerade as admin' : 'masquerade as user'; global $user; - if (user_access($perm) && !$edit_user->masquerading && $user->uid != $edit_user->uid) { - $items[] = array( - 'value' => l(t('Masquerade as !user', array('!user' => $edit_user->name)), 'masquerade/switch/'. $edit_user->uid, array('destination' => $_GET['q'])), - 'class' => 'masquerade', + if (user_access($perm) && empty($edit_user->masquerading) && $user->uid != $edit_user->uid) { + $edit_user->content['Masquerade'] = array( + '#value' => l(t('Masquerade as !user', array('!user' => $edit_user->name)), 'masquerade/switch/'. $edit_user->uid, array('destination' => $_GET['q'])), + '#weight' => 10 ); - return array(t('Masquerade') => $items); +// return array(t('Masquerade') => $items); } break; } @@ -174,15 +190,16 @@ $blocks[0]['info'] = t('Masquerade'); return $blocks; case 'view': - if ($GLOBALS['masquerading'] || (user_access('masquerade as user') || user_access('masquerade as admin'))) { - switch($delta) { - case 0: - $block['subject'] = t('Masquerade'); - $block['content'] = drupal_get_form('_masquerade_block_1', $form); - break; + if (masquerade_access('autocomplete')) { + switch($delta) { + case 0: + $block['subject'] = t('Masquerade'); + $block['content'] = drupal_get_form('_masquerade_block_1'); + break; + } + return $block; } - return $block; - } + break; } } @@ -190,31 +207,29 @@ * Masquerade block form. */ function _masquerade_block_1($record) { - $attributes = $GLOBALS['masquerading'] ? array('disabled' => 'disabled') : array(); if ($GLOBALS['masquerading']) { global $user; $quick_switch_link[] = l(t('Switch back'), 'masquerade/unswitch', array()); $markup_value = t('You are masquerading as:$RCSfile: masquerade.module,v $ version: $Revision: 1.15.2.3 $, $Date: 2007/05/03 11:25:43 $
'); -}