' . __( 'There was an error connecting to Google:', 'zero-bs-crm' ) . '
'
. '
' . $e->getMessage() . '
',
'',
'',
true // exit
);
}
}
}
/*
* Retrieve a callback url with provider affixed
*/
public function get_callback_url( $provider ){
global $zbs;
if ( $this->legitimate_provider( $provider ) ){
// load listener if it's not already loaded
$zbs->load_listener();
return $zbs->listener->get_callback_url( 'oauth' ) . '&jpcrm_oauth_provider=' . urlencode( $provider );
}
return false;
}
/*
* Checks if a provider is on the list
*/
public function legitimate_provider( $provider ){
if ( !empty( $provider ) && in_array( $provider, array_keys( $this->providers ) ) ){
return true;
}
return false;
}
/*
* Retrieves a provider detail, (e.g. google's 'url_authorize')
*/
public function get_provider_detail( $provider, $attribute_key ){
if ( isset( $this->providers[ $provider ] ) && isset( $this->providers[ $provider ][ $attribute_key ] ) ){
return $this->providers[ $provider ][ $attribute_key ];
}
return false;
}
/*
* Returns provider summary details
*/
public function get_provider( $provider ){
if ( isset( $this->providers[ $provider ] ) ){
return $this->providers[ $provider ];
}
}
/**
* Returns providers array
*/
public function get_providers() {
return $this->providers;
}
/*
* get config/token for a provider
*
* @param string $provider_key - e.g. 'google_mail'
*/
public function get_provider_config( $provider_key, $return_token_string_only=false, $refresh_token_if_expired=true ){
global $zbs;
// basic check
if ( !$this->legitimate_provider( $provider_key ) ){
return false;
}
// retrieve token configs as they are
$existing_token_configs = $zbs->settings->get( 'oauth_tokens', false );
// retrieve
if ( is_array( $existing_token_configs ) && isset( $existing_token_configs[ $provider_key ] ) ){
// get current
$token_config = $existing_token_configs[ $provider_key ];
$token_config['expires'] = (int)$token_config['expires'];
// if expired and $refresh_token_if_expired, regen
if ( $refresh_token_if_expired && !empty( $token_config['token'] ) && isset( $token_config['expires'] ) && $token_config['expires'] < time() ){
$this->debug_message( 'Found token which has expired! ' );
// refresh token
$refreshed_token_config = $this->refresh_token( $provider_key, $token_config );
if ( is_array( $refreshed_token_config ) ){
// success
$token_config = $refreshed_token_config;
} else {
// failed refreshing token
return false;
}
}
// if only the token itself, return that
if ( $return_token_string_only ){
return $token_config['token'];
}
// else return the whole token info array
return $token_config;
}
// no such token
return false;
}
/*
* Update config/token for a provider
*
* @param string $provider - e.g. 'google_mail'
* @param array $args
*/
public function update_provider_config( $provider, $args=array() ){
global $zbs;
// ============ LOAD ARGS =============
$default_args = array(
'id' => '',
'secret' => '',
'token' => '',
'refresh_token' => '',
'expires' => '',
'meta' => array()
); foreach ($default_args as $argK => $argV){ $$argK = $argV; if (is_array($args) && isset($args[$argK])) { if (is_array($args[$argK])){ $newData = $$argK; if (!is_array($newData)) $newData = array(); foreach ($args[$argK] as $subK => $subV){ $newData[$subK] = $subV; }$$argK = $newData;} else { $$argK = $args[$argK]; } } }
// ============ / LOAD ARGS =============
// basic check
if ( !$this->legitimate_provider( $provider ) ){
return false;
}
// retrieve tokens as they are
$existing_token_configs = $zbs->settings->get( 'oauth_tokens', false );
// check is an array
if ( !is_array( $existing_token_configs ) ) {
$existing_token_configs = array();
}
// hard override
$existing_token_configs[ $provider ] = array(
// credentials
'id' => $id,
'secret' => $secret,
// token
'token' => $token,
'expires' => $expires,
'refresh_token' => $refresh_token,
'last_updated_by' => zeroBSCRM_user(),
'last_updated' => time(),
// optional, per provider extras
'meta' => $meta
);
// update
$zbs->settings->update( 'oauth_tokens', $existing_token_configs );
}
/*
* Delete config/token for a provider
*
* @param string $provider - e.g. 'google_mail'
*/
public function delete_provider_config( $provider ){
global $zbs;
// retrieve tokens as they are
$existing_token_configs = $zbs->settings->get( 'oauth_tokens', false );
// if exists
if ( isset( $existing_token_configs[ $provider ] ) ){
// direct unset
unset( $existing_token_configs[ $provider ] );
// update
$zbs->settings->update( 'oauth_tokens', $existing_token_configs );
return true;
}
return false;
}
/*
* Refreshes a user token and returns
*
* @param string $provider_key - e.g. `google_mail`
* @param array|bool $provider_config - either the config (if already available), or false (and this function will load it)
*
* @return array - updated token config
*/
public function refresh_token( $provider_key, $provider_config=false ){
// if no config, load it
if ( !is_array( $provider_config ) ){
// note false for third parameter `refresh_token_if_expired` - this is to avoid an infinite loop
$provider_config = $this->get_provider_config( $provider_key, false, false );
}
// got refresh token?
if ( !isset( $provider_config['refresh_token'] ) || empty( $provider_config['refresh_token'] ) ){
return false;
}
// make sure our dependencies are installed
$this->ensure_packages_installed();
// if we have a specific function for this provider, defer to that:
if ( method_exists( $this, 'refresh_token_' . $provider_key ) ){
return call_user_func_array( array( $this, 'refresh_token_' . $provider_key ), array( $provider_config ) );
}
// otherwise, generic...
$this->debug_message( 'Refreshing access token...' );
// build args
$args = array(
'id' => $provider_config['id'],
'secret' => $provider_config['secret'],
'redirect_uri' => $this->get_callback_url( $provider_key ),
'urlAuthorize' => $this->get_provider_detail( $provider_key, 'url_authorize' ),
'urlAccessToken' => $this->get_provider_detail( $provider_key, 'url_access_token' ),
'urlResourceOwnerDetails' => $this->get_provider_detail( $provider_key, 'url_resource_owner_details' )
);
// retrieve provider
$provider = $this->provider( $provider_key, $args );
try {
// generate new token (generic)
// https://oauth2-client.thephpleague.com/usage/#refreshing-a-token
$new_token = $provider->getAccessToken('refresh_token', [
'refresh_token' => $provider_config['refresh_token']
]);
// success?
if ( !empty( $new_token->getToken() ) ){
$this->debug_message( 'Success!' );
$new_refresh_token = $new_token->getRefreshToken();
// when a new refresh token isn't set, keep the old one
if ( empty( $new_refresh_token ) ){
$new_refresh_token = $provider_config['refresh_token'];
}
// save it
$config = $this->get_provider_config( $provider_key, false, false );
$config['token'] = $new_token->getToken();
$config['refresh_token'] = $new_refresh_token;
$config['expires'] = $new_token->getExpires();
$this->update_provider_config( $provider_key, $config );
// return it
return $config;
}
} catch ( \League\OAuth2\Client\Provider\Exception\IdentityProviderException $e ){
$this->debug_message( 'Error refreshing token: ' . $e->getMessage() );
switch ( $e->getMessage() ){
case 'invalid_request':
default:
// Something wrong with the request
$this->debug_message( '
' . print_r( $e->getResponseBody(), 1 ) . '
' );
// clear tokens
$config = $this->get_provider_config( $provider_key, false, false );
$config['token'] = '';
$config['expires'] = '';
$config['refresh_token'] = '';
$this->update_provider_config( $provider_key, $config );
break;
}
}
return false;
}
/*
* Refreshes a Google mail user token and returns refreshed provider config
*
* @param array|bool $provider_config - either the config (if already available), or false (and this function will load it)
*
* @return array - updated token config
*/
public function refresh_token_google_mail( $provider_config=false ){
// if no config, load it
if ( !is_array( $provider_config ) ){
// note false for third parameter `refresh_token_if_expired` - this is to avoid an infinite loop
$provider_config = $this->get_provider_config( 'google_mail', false, false );
}
// got refresh token?
if ( !isset( $provider_config['refresh_token'] ) || empty( $provider_config['refresh_token'] ) ){
return false;
}
// make sure our dependencies are installed
$this->ensure_packages_installed();
// build arguments
$args = array(
'id' => $provider_config['id'],
'secret' => $provider_config['secret']
);
// retrieve provider
$provider = $this->provider_google_mail( $args );
// grant type
$grant = new RefreshToken();
$this->debug_message( 'Refreshing Google Token...' );
try {
$new_token = $provider->getAccessToken( $grant, [ 'refresh_token' => $provider_config['refresh_token'] ] );
$new_refresh_token = $new_token->getRefreshToken();
// when a new refresh token isn't set, keep the old one
if ( empty( $new_refresh_token ) ){
$new_refresh_token = $provider_config['refresh_token'];
}
$this->debug_message( 'Success!' );
// save it
$config = $this->get_provider_config( 'google_mail', false, false );
$config['token'] = $new_token->getToken();
$config['refresh_token'] = $new_refresh_token;
$config['expires'] = $new_token->getExpires();
$this->update_provider_config( 'google_mail', $config );
return $config;
} catch ( \League\OAuth2\Client\Provider\Exception\IdentityProviderException $e ){
$this->debug_message( 'Error refreshing Google token: ' . $e->getMessage() );
$this->debug_message( '
' . print_r( $e->getResponseBody(), 1 ) . '
' );
// clear expired/faulty token
$config = $this->get_provider_config( 'google_mail', false, false );
$config['token'] = '';
$config['expires'] = '';
$config['refresh_token'] = '';
$this->update_provider_config( 'google_mail', $config );
}
return false;
}
/*
* Returns a connection status (bool) for provider from a provider key or config
* Note: Could be hardened by using oauth to re-verify valid token
*
* @param string $provider - e.g. 'google_mail'
* @param array|bool $provider_config - if passed, validity of config is checked
*/
public function connection_status( $provider, $provider_config=false ){
// load if not provided
if ( !is_array( $provider_config ) ){
$provider_config = $this->get_provider_config( $provider );
}
// got config?
if ( is_array( $provider_config ) && !empty( $provider_config['id'] ) && !empty( $provider_config['secret'] ) ){
if (
isset( $provider_config['refresh_token'] ) && !empty( $provider_config['refresh_token'] )
&&
isset( $provider_config['expires'] ) && !empty( $provider_config['expires'] )
){
return true;
}
}
return false;
}
/*
* Returns a connection status string for provider
*
* @param string $provider - e.g. 'google_mail'
* @param bool $shorthand - if true will return 'connected' instead of longform html status
*/
public function connection_status_string( $provider, $shorthand=false ){
$status = __( 'Not yet configured', 'zero-bs-crm' );
$short_status = 'no-config';
$provider_config = $this->get_provider_config( $provider );
// got config?
if ( is_array( $provider_config ) && !empty( $provider_config['id'] ) && !empty( $provider_config['secret'] ) ){
$status = __( 'Not yet connected', 'zero-bs-crm' );
$short_status = 'config-no-connect';
if (
isset( $provider_config['refresh_token'] ) && !empty( $provider_config['refresh_token'] )
&&
isset( $provider_config['expires'] ) && !empty( $provider_config['expires'] )
){
$short_status = 'seems-connected';
// some providers can give specific user info to enrich the status string:
switch ( $provider ){
case 'google_mail':
$username = __( 'Generic User', 'zero-bs-crm' );
if ( isset( $provider_config['meta'] ) && is_array( $provider_config['meta'] ) ){
if ( isset( $provider_config['meta']['name'] ) ){
$username = $provider_config['meta']['name'];
}
if ( isset( $provider_config['meta']['email'] ) ){
if ( !empty( $username ) ){
$username .= ' ';
}
$username .= '(' . $provider_config['meta']['email'] . ')';
}
}
$status = '' . sprintf( __( 'Connected as %s', 'zero-bs-crm' ), $username ) . '';
break;
default:
$status = '' . __( 'Connected', 'zero-bs-crm' ) . '';
break;
}
}
}
if ( $shorthand ){
return $short_status;
}
return $status;
}
/*
* Wrapper for outputting messages, abstracted in case we want to phase into a stack system
* There are surely better ways...
*/
private function display_alert( $msg_class='', $msg_header='', $msg_html='', $icon_class='', $id='', $singular=false, $refresh_parent = false ){
// if $singular we're just showing the error as a single page (as used in OAuth flow)
if ( $singular ){
?>
debug ){
echo $message;
}
}
/**
* Returns an authorized Google API client.
*
* @param string $provider_key - key of OAuth provider to use
*
* @return Client the authorized client object
*/
// adapted from class-v3-zerobscrm-googlecontact.php
function get_google_client( $provider_key ){
// make sure our dependencies are installed
$this->ensure_packages_installed();
// retrieve config
$provider_config = $this->get_provider_config( $provider_key );
if ( is_array( $provider_config ) && ! empty( $provider_config['token'] ) ) {
//modified from: https://developers.google.com/people/quickstart/php since we will always be getting 'offline' access so does not need to re-ask user
$client = new \Google_Client();
$client->setAccessType('offline');
$client->setClientId( $provider_config['id'] );
$client->setClientSecret( $provider_config['secret'] );
$client->setAccessToken( $provider_config['token'] );
$client->setScopes('https://www.googleapis.com/auth/gmail.send');
return $client;
}
return false;
}
}