oauth2_login.api.php in OAuth2 Login 8

The programing interface provided by the module oauth2_login.

File

oauth2_login.api.php

<?php

/**
 * @file
 * The programing interface provided by the module oauth2_login.
 */

/**
 * Login with OAuth2.
 */
function oauth2_login($destination = NULL, $destination_error = NULL) {
  if ($destination === NULL) {
    $destination = drupal_get_destination();
    $destination = $destination['destination'];
  }
  if ($destination_error === NULL) {
    $destination_error = 'user/login';
  }
  $enabled = variable_get('oauth2_login_enabled', FALSE);
  if (!$enabled) {
    drupal_goto('user', [
      'query' => drupal_get_destination(),
    ]);
  }
  else {
    drupal_goto('hybridauth/window/DrupalOAuth2', [
      'query' => [
        'destination' => $destination,
        'destination_error' => $destination_error,
      ],
    ]);
  }
}

/**
 * Implements hook_oauth2_login_enabled().
 *
 * This hook is called when the configuration on
 * admin/config/people/oauth2_login is saved.  It gives a chance to
 * the other modules to change their configuration depending on
 * whether oauth2 login is enabled or disabled. The example below
 * enables/disables the menu link for user/login and user/oauth2_login.
 */
function hook_oauth2_login_enabled($enabled) {

  // Enable or disable the link 'user/login'.
  db_update('menu_links')
    ->fields([
    'hidden' => $enabled ? 1 : 0,
  ])
    ->condition('menu_name', 'user-menu')
    ->condition('link_path', 'user/login')
    ->condition('router_path', 'user/login')
    ->condition('plid', 0)
    ->condition('module', 'menu')
    ->execute();

  // Disable or enable the link 'user/oauth2_login'.
  db_update('menu_links')
    ->fields([
    'hidden' => $enabled ? 0 : 1,
  ])
    ->condition('menu_name', 'user-menu')
    ->condition('link_path', 'user/oauth2_login')
    ->condition('router_path', 'user/oauth2_login')
    ->condition('plid', 0)
    ->condition('module', 'system')
    ->execute();

  // Clear the cache and rebuild the menu.
  menu_cache_clear('user-menu');
}

/**
 * Return oauth2 settings.
 */
function oauth2_login_get_oauth2_settings() {
  $server_url = variable_get('oauth2_login_oauth2_server');
  $oauth2_settings = [
    'auth_flow' => 'server-side',
    'authorization_endpoint' => $server_url . '/oauth2/authorize',
    'token_endpoint' => $server_url . '/oauth2/token',
    'client_id' => variable_get('oauth2_login_client_id'),
    'client_secret' => variable_get('oauth2_login_client_secret'),
    'redirect_uri' => url('oauth2/authorized', [
      'absolute' => TRUE,
    ]),
    'scope' => 'user_profile',
  ];
  return $oauth2_settings;
}

/**
 * Get an access_token, or NULL if there is no valid token.
 *
 * The token returned may be a cached one or a refreshed token.
 * If the refresh_token has also expired, a redirection to the
 * oauth2 server will be made, in order to re-authenticate.
 * However the redirection will be skipped if the parameter
 * $redirect is FALSE, and NULL will be returned as access_token.
 */
function oauth2_login_get_access_token($redirect = TRUE) {
  $oauth2_settings = oauth2_login_get_oauth2_settings();
  $oauth2 = new OAuth2\Client($oauth2_settings);
  $access_token = $oauth2
    ->getAccessToken($redirect);
  return $access_token;
}

Functions

Name	Description
hook_oauth2_login_enabled	Implements hook_oauth2_login_enabled().
oauth2_login	Login with OAuth2.
oauth2_login_get_access_token	Get an access_token, or NULL if there is no valid token.
oauth2_login_get_oauth2_settings	Return oauth2 settings.