diff --git a/cosign.api.php b/cosign.api.php new file mode 100644 index 0000000..e80753b --- /dev/null +++ b/cosign.api.php @@ -0,0 +1,112 @@ + $local_user->name))); + +} + +/** + * Control behavior when Cosign remote user does not match local Drupal user. + * + * When a user is logged into Cosign remotely and also logged into Drupal + * locally, it is possible for the remote user and the local user to mis-match. + * When this happens, by default the local Drupal user is logged out before + * proceeding to log in the corresponding local Drupal user to the remote Cosign + * user. The default behavior can be modified to allow the local user to remain + * a mis-match of the remote user by utilizing this hook. + * + * Take note that the last module to invoke this hook according to its weight is + * the one whose return value will dictate whether or not the user is logged out + * on mis-match. + * + * @param $local_user + * Drupal user object for local Drupal user who is presently logged in. + * @param $remote_user + * Drupal user object for remote Cosign user who is presently logged in to + * Cosign. + * + * @return + * Boolean TRUE to proceed with default behavior to log user out, FALSE to + * allow local user to remain logged in despite remote user mismatch. + */ +function hook_cosign_remote_local_mismatch($local_user, $remote_user) { + + drupal_set_message(t('Warning: You are impersonating another user. You are %remote, you are impersonating %local.', array('%remote' => $remote_user->name, '%local' => $local_user->name))); + + return FALSE; + +} + +/** + * Add behavior when new local Drupal user is created by Cosign module. + * + * When a user is logged into Cosign remotely but no corresponding local Drupal + * user exists and Cosign module creates a new local Drupal user automatically, + * this hook is invoked to allow the opportunity to add additional + * functionality. Note: the cosign_autocreate variable option must be checked + * in the Cosign module configuration for this hook to fire. If not, a new user + * is not created. + * + * @param $new_user + * Drupal user object for new Drupal user who was just created. + */ +function hook_cosign_user_created($new_user) { + + drupal_set_message(t('A new user was just created for you.')); + +} + +/** + * Add behavior when new local Drupal user is not created by Cosign module. + * + * When a user is logged into Cosign remotely but no corresponding local Drupal + * user exists and Cosign module is not configured to create a new local Drupal + * user, this hook is invoked to allow the opportunity to add additional + * functionality. Note: the cosign_autocreate variable option must not be + * checked in the Cosign module configuration for this hook to fire. If not, a + * new user will be created. + * + * @param $remote_username + * Username of the logged in remote Cosign user. + */ +function hook_cosign_user_not_created($remote_username) { + + drupal_set_message(t('A new user was not able to be created for you.')); + +} + +/** + * Add behavior when no remote user is logged in via Cosign module. + * + * When no remote user is detected, this hook is invoked. + */ +function hook_cosign_no_remote_user() { + + drupal_set_message(t('No remote Cosign user is logged in.')); + +} + +/** + * @} End of "addtogroup hooks". + */ diff --git a/cosign.module b/cosign.module index f74c80e..300f9a2 100644 --- a/cosign.module +++ b/cosign.module @@ -71,16 +71,49 @@ function cosign_route() { if ($user->uid) { - $account = user_load_by_name($cosign_name); + $remote = user_load_by_name($cosign_name); - if (!empty($account->uid) && $user->uid == $account->uid) { - // Do nothing: user already logged in Drupal with session data matching + if (!empty($remote->uid) && $user->uid == $remote->uid) { + + // Already logged in hook invocation. + module_invoke_all('cosign_remote_local_match', $remote); + + // Do nothing: user already logged in Drupal with session data matching. return TRUE; + } else { - // log user out and proceed - cosign_drupal_logout(); + + $logout = TRUE; + + if (!empty($remote->uid)) { + + // Remote user and session mis-match hook invocation. + $results = module_invoke_all('cosign_remote_local_mismatch', $user, $remote); + + $logout = $results[count($results) - 1]; + + } + + if ($logout) { + + // Log user out and proceed. + cosign_drupal_logout(); + + } + else { + + // Another module using the cosign api is hijacking the ordinary + // behavior here. Instead of logging out the drupal user and + // proceeding to log in the drupal user corresponding to the remote + // user, we do nothing and leave the behavior up to the module using + // hook_cosign_remote_local_mismatch(). + return TRUE; + + } + } + } // Retrieve user credentials @@ -113,8 +146,17 @@ function cosign_route() { user_save($user, $edit); drupal_session_regenerate(); + + // New Drupal user created hook invocation. + module_invoke_all('cosign_user_created', $new_user); + } else { + + // No Drupal user exists and none can be created automatically because + // that setting is off hook invocation. + module_invoke_all('cosign_user_not_created', $cosign_name); + watchdog('cosign', 'User attempted login but does not have a Drupal account and the auto-create user configuration setting is turned off: @remote_user', array('@remote_user' => $cosign_name), WATCHDOG_NOTICE); drupal_set_message(variable_get('cosign_invalid_login_message', t('We were not able to log you in because you do not have an account on this site yet.')), 'status'); @@ -124,14 +166,18 @@ function cosign_route() { } else { // Log the user in. - $account = user_load_by_name($cosign_name); + $remote = user_load_by_name($cosign_name); - $form_state['uid'] = $account->uid; + $form_state['uid'] = $remote->uid; user_login_submit(array(), $form_state); } } else { + + // Remote user is empty hook invocation. + module_invoke_all('cosign_no_remote_user'); + // remote_user is empty, if user is still logged in, log user out if ($user->uid && variable_get('cosign_autologout', 1)) { cosign_drupal_logout();