danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Hooks provided by the OpenID module.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @addtogroup hooks
danielebarchiesi@0:  * @{
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Allow modules to modify the OpenID request parameters.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $op
danielebarchiesi@0:  *   The operation to be performed.
danielebarchiesi@0:  *   Possible values:
danielebarchiesi@0:  *   - request: Modify parameters before they are sent to the OpenID provider.
danielebarchiesi@0:  * @param $request
danielebarchiesi@0:  *   An associative array of parameter defaults to which to modify or append.
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An associative array of parameters to be merged with the default list.
danielebarchiesi@0:  *
danielebarchiesi@0:  */
danielebarchiesi@0: function hook_openid($op, $request) {
danielebarchiesi@0:   if ($op == 'request') {
danielebarchiesi@0:     $request['openid.identity'] = 'http://myname.myopenid.com/';
danielebarchiesi@0:   }
danielebarchiesi@0:   return $request;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Allow modules to act upon a successful OpenID login.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $response
danielebarchiesi@0:  *   Response values from the OpenID Provider.
danielebarchiesi@0:  * @param $account
danielebarchiesi@0:  *   The Drupal user account that logged in
danielebarchiesi@0:  *
danielebarchiesi@0:  */
danielebarchiesi@0: function hook_openid_response($response, $account) {
danielebarchiesi@0:   if (isset($response['openid.ns.ax'])) {
danielebarchiesi@0:     _mymodule_store_ax_fields($response, $account);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Allow modules to declare OpenID discovery methods.
danielebarchiesi@0:  *
danielebarchiesi@0:  * The discovery function callbacks will be called in turn with an unique
danielebarchiesi@0:  * parameter, the claimed identifier. They have to return an associative array
danielebarchiesi@0:  * with array of services and claimed identifier in the same form as returned by
danielebarchiesi@0:  * openid_discover(). The resulting array must contain following keys:
danielebarchiesi@0:  *   - 'services' (required) an array of discovered services (including OpenID
danielebarchiesi@0:  *   version, endpoint URI, etc).
danielebarchiesi@0:  *   - 'claimed_id' (optional) new claimed identifer, found by following HTTP
danielebarchiesi@0:  *   redirects during the services discovery.
danielebarchiesi@0:  *
danielebarchiesi@0:  * The first discovery method that succeed (return at least one services) will
danielebarchiesi@0:  * stop the discovery process.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An associative array which keys are the name of the discovery methods and
danielebarchiesi@0:  *   values are function callbacks.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see hook_openid_discovery_method_info_alter()
danielebarchiesi@0:  */
danielebarchiesi@0: function hook_openid_discovery_method_info() {
danielebarchiesi@0:   return array(
danielebarchiesi@0:     'new_discovery_idea' => '_my_discovery_method',
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Allow modules to alter discovery methods.
danielebarchiesi@0:  */
danielebarchiesi@0: function hook_openid_discovery_method_info_alter(&$methods) {
danielebarchiesi@0:   // Remove XRI discovery scheme.
danielebarchiesi@0:   unset($methods['xri']);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Allow modules to declare OpenID normalization methods.
danielebarchiesi@0:  *
danielebarchiesi@0:  * The discovery function callbacks will be called in turn with an unique
danielebarchiesi@0:  * parameter, the identifier to normalize. They have to return a normalized
danielebarchiesi@0:  * identifier, or NULL if the identifier is not in a form they can handle.
danielebarchiesi@0:  *
danielebarchiesi@0:  * The first normalization method that succeed (return a value that is not NULL)
danielebarchiesi@0:  * will stop the normalization process.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array with a set of function callbacks, that will be called in turn
danielebarchiesi@0:  *   when normalizing an OpenID identifier. The normalization functions have
danielebarchiesi@0:  *   to return a normalized identifier, or NULL if the identifier is not in
danielebarchiesi@0:  *   a form they can handle.
danielebarchiesi@0:  * @see hook_openid_normalization_method_info_alter()
danielebarchiesi@0:  */
danielebarchiesi@0: function hook_openid_normalization_method_info() {
danielebarchiesi@0:   return array(
danielebarchiesi@0:     'new_normalization_idea' => '_my_normalization_method',
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Allow modules to alter normalization methods.
danielebarchiesi@0:  */
danielebarchiesi@0: function hook_openid_normalization_method_info_alter(&$methods) {
danielebarchiesi@0:   // Remove Google IDP normalization.
danielebarchiesi@0:   unset($methods['google_idp']);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @} End of "addtogroup hooks".
danielebarchiesi@0:  */