anisogamete

Back Back Up Advanced Editor

<?php

/**
 * This serves as a collection of common methods for getting, fetching,
 * and storing client keys and secrets.
 *
 * Unlinke other classes, this is not immediately instantiated on plugin load.
 * Instead it is created on a need-only basis.
 *
 * Since all of the actual handshakes take place on the warfareplugins.com server,
 * SWP application keys and secrets live in those files.
 * The server is also where we keep the network-specific SDKs.
 *
 * This class only tells us if we have access for a network, and if not,
 * which link we should use to request access.
 *
 */
class SWP_Auth_Helper {

/**
	 * The network this controller interfaces.
	 * @var string $network
	 *
	 */
	public $network = '';

/**
	 * Alias of $network.
	 * @var string $key
	 *
	 */
	public $key = '';

/**
	 * Whether or not we have registered credentials for this network.
	 * @var bool $has_credentials;
	 *
	 */
	public $has_credentials = false;

/**
	 * The Social Warfare API key.
	 *
	 * This must be manually set on a per-network basis in the
	 * SWFW_Follow_Network __construct() method.
	 *
	 * @var string $client_secret;
	 *
	 */
	protected $client_key = '';

/**
	 * The Social Warfare API secret.
	 *
	 * This must be manually set on a per-network basis in the
	 * SWFW_Follow_Network __construct() method.
	 *
	 * @var string $client_secret;
	 *
	 */
	protected $client_secret = '';

/**
	 * The user's API key.
	 * @var string $consumer_key;
	 *
	 */
	protected $consumer_key = '';

/**
	 * The user's API secret.
	 * @var string $access_secret;
	 *
	 */
	protected $access_secret = '';

public function __construct( $network_key ) {
		if ( empty( $network_key ) ) {
			error_log('Please provide a network_key when constructing an SWP_Auth_Controller.');
			return;
		}

$this->network = $network_key;
		$this->key = $network_key;
		$this->establish_credentials();
	}

/**
	 * Provides the SWP API key, if it exists.
	 *
	 * @since 3.5.0 | 03 JAN 2018 | Created.
	 * @param void
	 * @return mixed String if the key exists, else false.
	 *
	 */
	public function get_access_token() {

return $this->has_credentials ? $this->access_token : false;
	}

/**
	 * The has_valid_token() method will return a true or false response as to
	 * the current "validity" status of an access token. If we do not have an
	 * access token or if it is expired, it will return false.
	 *
	 * @since  4.0.2 | 23 JUL 2020 | Created
	 * @param  void
	 * @return boolean True if valid. False if invalid or missing.
	 *
	 */
	public function has_valid_token() {

// If we don't have an access token at all.
		if ( false == $this->get_access_token() ) {
			return false;
		}

// If the access token is expired.
		if( 'expired' == $this->get_access_token() ) {
			return false;
		}

// If we have an access token and it's good.
		return true;
	}

/**
	 * Provides the SWP API secret, if it exists.
	 *
	 * @since 3.5.0 | 03 JAN 2018 | Created.
	 * @param void
	 * @return mixed String if the key exists, else false.
	 *
	 */
	public function get_access_secret() {
		return $this->has_credentials ? $this->access_secret : false;
	}

/**
	 * Fetches stored client credentials.
	 *
	 * A returned value of `false` indicates that the user needs to
	 * go through the authentication process. Retun value of `true`
	 * means we can proceed with th request.
	 *
	 * @since 3.5.0 | 03 JAN 2018 | Created.
	 * @param void
	 * @return bool True iff the credentials exist, else false.
	 *
	 * @TODO Some networks may only have a key and no secret.
	 * Right now both are required, so find a way to distinguish the two.
	 *
	 */
	public function establish_credentials() {
		$access_token = SWP_Credential_Helper::get_token( $this->network );

if ( false === $access_token || empty( $access_token ) ) {
			return false;
		}

$access_secret = SWP_Credential_Helper::get_token( $this->network, 'access_secret' );
		if ( !empty( $access_secret ) ) {
			$this->access_secret = $access_secret;
		}

$this->access_token = $access_token;
		return $this->has_credentials = true;
	}

public function add_to_authorizations( $network_keys ) {
		// return $network_keys;
		return array_merge( $network_keys, array( $this->network ) );
	}

/**
	 * Prepares a Log In url for the requested network.
	 *
	 * @since 3.5.0 | 03 JAN 2018 | Created.
	 * @param void
	 * @return string The URL which handles the oAuth handshakes.
	 *
	 */
	public function get_authorization_link() {
		$request_url = 'https://warfareplugins.com/authorizations/' . $this->network . '/request_token.php';
		return add_query_arg('return_address', admin_url('?page=social-warfare'), $request_url);
	}

/**
	 * Provides a URL to revoke access to connected apps.
	 *
	 * Requires that the user already be logged in to the network.
	 *
	 * @since 3.5.0 | 15 JAN 2019 | Created.
	 * @param void
	 * @return string The URL which handles the revoke access action.
	 *
	 */
	public function get_revoke_access_url() {
		switch( $this->network ) {

case 'facebook' :
				return 'https://www.facebook.com/settings?tab=applications';

case 'instagram' :
				return 'https://www.instagram.com/accounts/manage_access/';

case 'pinterest' :
				return 'https://www.pinterest.com/settings#apps';

case 'twitter' :
				return 'https://twitter.com/settings/sessions';

case 'tumblr' :
				return 'https://www.tumblr.com/settings/apps';

case 'vimeo' :
				return 'https://vimeo.com/settings/apps';

default:
				return false;
		}
	}

public function get_auth_button_text() {
		switch ( $this->network ) {
			case 'facebook' :
				return '<i class="sw swp_facebook_icon"></i> Continue with Facebook';

default :
				return '<i class="sw swp_'.$this->key.'_icon"></i> Login with ' . ucfirst( $this->key );
		}
	}
}