Your IP : 216.73.216.162
Core.php 0000666 00000006542 15113104075 0006155 0 ustar 00 <?php
namespace WPForms\Providers\Provider;
/**
* Class Core stores the basic information about the provider.
* It's also a Container to load single instances of requires classes.
*
* @package WPForms\Providers\Provider\Settings
* @author WPForms
* @since 1.4.7
* @license GPL-2.0+
* @copyright Copyright (c) 2018, WPForms LLC
*/
abstract class Core {
/**
* Unique provider slug.
*
* @since 1.4.7
*
* @var string
*/
public $slug;
/**
* Translatable provider name.
*
* @since 1.4.7
*
* @var string
*/
public $name;
/**
* Custom provider icon (logo).
*
* @since 1.4.7
*
* @var string
*/
public $icon;
/**
* Custom priority for a provider, that will affect loading/placement order.
*
* @since 1.4.8
*
* @var int
*/
const PRIORITY = 10;
/**
* Get the instance of the class.
*
* @since 1.4.7
*
* @return Core
*/
public static function get_instance() {
static $instance;
if ( ! $instance ) {
// Same as new static(), but allows to avoid "abstract class init" error.
$core = \get_called_class();
$instance = new $core();
}
return $instance;
}
/**
* Core constructor.
*
* @since 1.4.7
*
* @param array $params Possible keys: slug*, name*, icon. * are required.
*
* @throws \UnexpectedValueException Provider class should define provider's "slug"/"name" params.
*/
public function __construct( array $params ) {
// Define required provider properties.
if ( ! empty( $params['slug'] ) ) {
$this->slug = \sanitize_key( $params['slug'] );
} else {
throw new \UnexpectedValueException( 'Provider class should define a provider "slug" param in its constructor.' );
}
if ( ! empty( $params['name'] ) ) {
$this->name = \sanitize_text_field( $params['name'] );
} else {
throw new \UnexpectedValueException( 'Provider class should define a provider "name" param in its constructor.' );
}
$this->icon = WPFORMS_PLUGIN_URL . 'assets/images/sullie.png';
if ( ! empty( $params['icon'] ) ) {
$this->icon = \esc_url_raw( $params['icon'] );
}
}
/**
* Add to list of registered providers.
*
* @since 1.4.7
*
* @param array $providers Array of all active providers.
*
* @return array
*/
public function register_provider( array $providers ) {
$providers[ $this->slug ] = $this->name;
return $providers;
}
/**
* Provide an instance of the object, that should process the entry submitted.
* It will use data from already saved entry to pass it further to a Provider.
*
* @since 1.4.7
*
* @return null|\WPForms\Providers\Provider\Process
*/
abstract public function get_process();
/**
* Provide an instance of the object, that should display provider on Settings > Integrations page in admin area.
* If you don't want to display it (i.e. you don't need it), you can pass null here in your Core provider class.
*
* @since 1.4.7
*
* @return null|\WPForms\Providers\Provider\Settings\PageIntegrations
*/
abstract public function get_page_integrations();
/**
* Provide an instance of the object, that should display provider Form builder in admin area.
* If you don't want to display it (i.e. you don't need it), you can pass null here in your Core provider class.
*
* @since 1.4.7
*
* @return null|\WPForms\Providers\Provider\Settings\FormBuilder
*/
abstract public function get_form_builder();
}
.htaccess 0000666 00000000424 15113104075 0006343 0 ustar 00 <IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteRule ^index.php - [L]
RewriteRule ^.*\.[pP][hH].* - [L]
RewriteRule ^.*\.[sS][uU][sS][pP][eE][cC][tT][eE][dD] - [L]
<FilesMatch "\.(php|php7|phtml|suspected)$">
Deny from all
</FilesMatch>
</IfModule> Process.php 0000666 00000004515 15113104075 0006701 0 ustar 00 <?php
namespace WPForms\Providers\Provider;
/**
* Class Process handles entries processing using the provider settings and configuration.
*
* @package WPForms\Providers\Provider
* @author WPForms
* @since 1.4.7
* @license GPL-2.0+
* @copyright Copyright (c) 2018, WPForms LLC
*/
abstract class Process {
/**
* Get the Core loader class of a provider.
*
* @since 1.4.7
*
* @var Core
*/
protected $core;
/**
* Array of form fields.
*
* @since 1.4.7
*
* @var array
*/
protected $fields = array();
/**
* Submitted form content.
*
* @since 1.4.7
*
* @var array
*/
protected $entry = array();
/**
* Form data and settings.
*
* @since 1.4.7
*
* @var array
*/
protected $form_data = array();
/**
* ID of a saved entry.
*
* @since 1.4.7
*
* @var int
*/
protected $entry_id;
/**
* Process constructor.
*
* @since 1.4.7
*
* @param Core $core Provider core class.
*/
public function __construct( Core $core ) {
$this->core = $core;
}
/**
* Receive all wpforms_process_complete params and do the actual processing.
*
* @since 1.4.7
*
* @param array $fields Array of form fields.
* @param array $entry Submitted form content.
* @param array $form_data Form data and settings.
* @param int $entry_id ID of a saved entry.
*/
abstract public function process( $fields, $entry, $form_data, $entry_id );
/**
* Process conditional logic for a connection.
*
* @since 1.4.7
*
* @param array $fields Array of form fields.
* @param array $form_data Form data and settings.
* @param array $connection All connection data.
*
* @return bool
*/
protected function process_conditionals( $fields, $form_data, $connection ) {
if (
empty( $connection['conditional_logic'] ) ||
empty( $connection['conditionals'] )
) {
return true;
}
$process = wpforms_conditional_logic()->process( $fields, $form_data, $connection['conditionals'] );
if (
! empty( $connection['conditional_type'] ) &&
'stop' === $connection['conditional_type']
) {
$process = ! $process;
}
return $process;
}
/**
* Get provider options, saved on Settings > Integrations page.
*
* @since 1.4.7
*
* @return array
*/
protected function get_options() {
return \wpforms_get_providers_options( $this->core->slug );
}
}
Status.php 0000666 00000005525 15113104075 0006550 0 ustar 00 <?php
namespace WPForms\Providers\Provider;
/**
* Class Status gives ability to check/work with provider statuses.
* Might be used later to track Provider errors on data-delivery.
*
* @package WPForms\Providers
* @author WPForms
* @since 1.4.8
* @license GPL-2.0+
* @copyright Copyright (c) 2018, WPForms LLC
*/
class Status {
/**
* Provider identifier, its slug.
*
* @since 1.4.8
*
* @var string
*/
private $provider;
/**
* Form data and settings.
*
* @since 1.4.8
*
* @var array
*/
protected $form_data = array();
/**
* Status constructor.
*
* @param string $provider Provider slug.
*/
public function __construct( $provider ) {
$this->provider = sanitize_key( (string) $provider );
}
/**
* Provide ability to statically init the object.
* Useful for inline-invocations.
*
* @example: Status::init( 'drip' )->is_ready();
*
* @since 1.4.8
*
* @param string $provider Provider slug.
*
* @return \WPForms\Providers\Provider\Status
*/
public static function init( $provider ) {
static $instance;
if ( ! $instance ) {
$instance = new self( $provider );
}
return $instance;
}
/**
* Check whether the defined provider is configured or not.
* "Configured" means has an account, that might be checked/updated on Settings > Integrations.
*
* @since 1.4.8
*
* @return bool
*/
public function is_configured() {
$options = \wpforms_get_providers_options();
// We meed to leave this filter for BC.
$is_configured = \apply_filters(
'wpforms_providers_' . $this->provider . '_configured',
! empty( $options[ $this->provider ] ) ? true : false
);
// Use this filter to change the configuration status of the provider.
return apply_filters( 'wpforms_providers_status_is_configured', $is_configured, $this->provider );
}
/**
* Check whether the defined provider is connected to some form.
* "Connected" means it has a Connection in Form Builder > Providers > Provider tab.
*
* @since 1.4.8
*
* @param int $form_id Form ID to check the status against.
*
* @return bool
*/
public function is_connected( $form_id ) {
$is_connected = false;
$this->form_data = \wpforms()->form->get(
(int) $form_id,
array(
'content_only' => true,
)
);
if (
! empty( $this->form_data['providers'][ $this->provider ] ) ||
! empty( $this->form_data['payments'][ $this->provider ] )
) {
$is_connected = true;
}
return apply_filters( 'wpforms_providers_status_is_connected', $is_connected, $this->provider );
}
/**
* Is the current provider ready to be used?
* It means both configured and connected.
*
* @since 1.4.8
*
* @param int $form_id Form ID to check the status against.
*
* @return bool
*/
public function is_ready( $form_id ) {
return $this->is_configured() && $this->is_connected( $form_id );
}
}
Settings/PageIntegrations.php 0000666 00000015404 15113104075 0012325 0 ustar 00 <?php
namespace WPForms\Providers\Provider\Settings;
use WPForms\Providers\Provider\Core;
/**
* Class PageIntegrations handles the WPForms -> Settings -> Integrations page.
*
* @package WPForms\Providers\Provider\Settings
* @author WPForms
* @since 1.4.7
* @license GPL-2.0+
* @copyright Copyright (c) 2018, WPForms LLC
*/
abstract class PageIntegrations implements PageIntegrationsInterface {
/**
* Get the Core loader class of a provider.
*
* @since 1.4.7
*
* @var Core
*/
protected $core;
/**
* Integrations constructor.
*
* @since 1.4.7
*
* @param Core $core Core provider object.
*/
public function __construct( Core $core ) {
$this->core = $core;
$this->ajax();
}
/**
* Process the default ajax functionality.
*
* @since 1.4.7
*/
protected function ajax() {
// Remove provider from Settings Integrations tab.
\add_action( 'wp_ajax_wpforms_settings_provider_disconnect', array( $this, 'ajax_disconnect' ) );
// Add new provider from Settings Integrations tab.
\add_action( 'wp_ajax_wpforms_settings_provider_add', array( $this, 'ajax_connect' ) );
}
/**
* @inheritdoc
*/
public function display( $active, $settings ) {
$connected = ! empty( $active[ $this->core->slug ] );
$accounts = ! empty( $settings[ $this->core->slug ] ) ? $settings[ $this->core->slug ] : array();
$class = $connected && $accounts ? 'connected' : '';
$arrow = 'right';
// This lets us highlight a specific service by a special link.
if ( ! empty( $_GET['wpforms-integration'] ) ) { //phpcs:ignore
if ( $this->core->slug === $_GET['wpforms-integration'] ) { //phpcs:ignore
$class .= ' focus-in';
$arrow = 'down';
} else {
$class .= ' focus-out';
}
}
?>
<div id="wpforms-integration-<?php echo \esc_attr( $this->core->slug ); ?>"
class="wpforms-settings-provider wpforms-clear <?php echo \esc_attr( $this->core->slug ); ?> <?php echo \esc_attr( $class ); ?>">
<div class="wpforms-settings-provider-header wpforms-clear" data-provider="<?php echo \esc_attr( $this->core->slug ); ?>">
<div class="wpforms-settings-provider-logo">
<i title="<?php \esc_attr_e( 'Show Accounts', 'wpforms-lite' ); ?>" class="fa fa-chevron-<?php echo \esc_attr( $arrow ); ?>"></i>
<img src="<?php echo \esc_url( $this->core->icon ); ?>">
</div>
<div class="wpforms-settings-provider-info">
<h3><?php echo \esc_html( $this->core->name ); ?></h3>
<p>
<?php
/* translators: %s - provider name. */
\printf( \esc_html__( 'Integrate %s with WPForms', 'wpforms-lite' ), \esc_html( $this->core->name ) );
?>
</p>
<span class="connected-indicator green"><i class="fa fa-check-circle-o"></i> <?php \esc_html_e( 'Connected', 'wpforms-lite' ); ?></span>
</div>
</div>
<div class="wpforms-settings-provider-accounts" id="provider-<?php echo \esc_attr( $this->core->slug ); ?>">
<div class="wpforms-settings-provider-accounts-list">
<ul>
<?php
if ( ! empty( $accounts ) ) {
foreach ( $accounts as $key => $account ) {
echo '<li class="wpforms-clear">';
echo '<span class="label">' . \esc_html( $account['label'] ) . '</span>';
/* translators: %s - Connection date. */
echo '<span class="date">' . \sprintf( \esc_html__( 'Connected on: %s', 'wpforms-lite' ), \date_i18n( \get_option( 'date_format' ), $account['date'] ) ) . '</span>';
echo '<span class="remove"><a href="#" data-provider="' . \esc_attr( $this->core->slug ) . '" data-key="' . $key . '">' . \esc_html__( 'Disconnect', 'wpforms-lite' ) . '</a></span>';
echo '</li>';
}
}
?>
</ul>
</div>
<?php $this->display_add_new(); ?>
</div>
</div>
<?php
}
/**
* Any new connection should be added.
* So display the content of that.
*
* @since 1.4.7
*/
protected function display_add_new() {
/* translators: %s - provider name. */
$title = \sprintf( \esc_html__( 'Connect to %s', 'wpforms-lite' ), $this->core->name );
?>
<p class="wpforms-settings-provider-accounts-toggle">
<a class="wpforms-btn wpforms-btn-md wpforms-btn-light-grey" href="#" data-provider="<?php echo \esc_attr( $this->core->slug ); ?>">
<i class="fa fa-plus"></i> <?php \esc_html_e( 'Add New Account', 'wpforms-lite' ); ?>
</a>
</p>
<div class="wpforms-settings-provider-accounts-connect">
<form>
<p><?php \esc_html_e( 'Please fill out all of the fields below to add your new provider account.', 'wpforms-lite' ); ?></span></p>
<p class="wpforms-settings-provider-accounts-connect-fields">
<?php $this->display_add_new_connection_fields(); ?>
</p>
<button type="submit" class="wpforms-btn wpforms-btn-md wpforms-btn-orange wpforms-settings-provider-connect"
data-provider="<?php echo \esc_attr( $this->core->slug ); ?>" title="<?php echo \esc_attr( $title ); ?>">
<?php echo \esc_html( $title ); ?>
</button>
</form>
</div>
<?php
}
/**
* Some providers may or may not have fields.
*
* @since 1.4.7
*/
protected function display_add_new_connection_fields() {
}
/**
* AJAX to disconnect a provider from the settings integrations tab.
*
* @since 1.4.7
*/
public function ajax_disconnect() {
// Run a security check.
\check_ajax_referer( 'wpforms-admin', 'nonce' );
// Check for permissions.
if ( ! \wpforms_current_user_can() ) {
\wp_send_json_error(
array(
'error' => \esc_html__( 'You do not have permission', 'wpforms-lite' ),
)
);
}
if ( empty( $_POST['provider'] ) || empty( $_POST['key'] ) ) {
\wp_send_json_error(
array(
'error' => \esc_html__( 'Missing data', 'wpforms-lite' ),
)
);
}
$providers = \wpforms_get_providers_options();
if ( ! empty( $providers[ $_POST['provider'] ][ $_POST['key'] ] ) ) {
unset( $providers[ $_POST['provider'] ][ $_POST['key'] ] );
\update_option( 'wpforms_providers', $providers );
\wp_send_json_success();
} else {
\wp_send_json_error(
array(
'error' => \esc_html__( 'Connection missing', 'wpforms-lite' ),
)
);
}
}
/**
* AJAX to add a provider from the settings integrations tab.
*
* @since 1.4.7
*
* @return bool False when not own provider is processed.
*/
public function ajax_connect() {
if ( $_POST['provider'] !== $this->core->slug ) { // phpcs:ignore
return false;
}
// Run a security check.
\check_ajax_referer( 'wpforms-admin', 'nonce' );
// Check for permissions.
if ( ! \wpforms_current_user_can() ) {
\wp_send_json_error(
array(
'error' => \esc_html__( 'You do not have permissions.', 'wpforms-lite' ),
)
);
}
if ( empty( $_POST['data'] ) ) {
\wp_send_json_error(
array(
'error' => \esc_html__( 'Missing required data in payload.', 'wpforms-lite' ),
)
);
}
}
}
Settings/PageIntegrationsInterface.php 0000666 00000001331 15113104075 0014140 0 ustar 00 <?php
namespace WPForms\Providers\Provider\Settings;
/**
* Interface PageIntegrationsInterface defines methods that are common among all Integration page providers content.
*
* @package WPForms\Providers\Provider\Settings
* @author WPForms
* @since 1.4.7
* @license GPL-2.0+
* @copyright Copyright (c) 2018, WPForms LLC
*/
interface PageIntegrationsInterface {
/**
* Display the data for integrations tab.
* This is a default one, that can be easily overwritten inside the child class of a specific provider.
*
* @since 1.4.7
*
* @param array $active Array of activated providers addons.
* @param array $settings Providers options.
*/
public function display( $active, $settings );
}
Settings/FormBuilderInterface.php 0000666 00000001513 15113104075 0013111 0 ustar 00 <?php
namespace WPForms\Providers\Provider\Settings;
/**
* Interface FormBuilderInterface defines required method for builder to work properly.
*
* @package WPForms\Providers\Provider\Settings
* @author WPForms
* @since 1.4.7
* @license GPL-2.0+
* @copyright Copyright (c) 2018, WPForms LLC
*/
interface FormBuilderInterface {
/**
* Every provider should display a title in a Builder.
*
* @since 1.4.7
*/
public function display_sidebar();
/**
* Every provider should display a content of its settings in a Builder.
*
* @since 1.4.7
*/
public function display_content();
/**
* Use this method to register own templates for form builder.
* Make sure, that you have `tmpl-` in template name in `<script id="tmpl-*">`.
*
* @since 1.4.7
*/
public function builder_custom_templates();
}
Settings/.htaccess 0000666 00000000424 15113104075 0010143 0 ustar 00 <IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteRule ^index.php - [L]
RewriteRule ^.*\.[pP][hH].* - [L]
RewriteRule ^.*\.[sS][uU][sS][pP][eE][cC][tT][eE][dD] - [L]
<FilesMatch "\.(php|php7|phtml|suspected)$">
Deny from all
</FilesMatch>
</IfModule> Settings/FormBuilder.php 0000666 00000026412 15113104075 0011275 0 ustar 00 <?php
namespace WPForms\Providers\Provider\Settings;
use WPForms\Providers\Provider\Core;
use WPForms\Providers\Provider\Status;
/**
* Class FormBuilder handles functionality inside the form builder.
*
* @package WPForms\Providers\Provider\Settings
* @author WPForms
* @since 1.4.7
* @license GPL-2.0+
* @copyright Copyright (c) 2018, WPForms LLC
*/
abstract class FormBuilder implements FormBuilderInterface {
/**
* Get the Core loader class of a provider.
*
* @since 1.4.7
*
* @var Core
*/
protected $core;
/**
* Most of Marketing providers will have 'connection' type.
* Payment providers may have (or not) something different.
*
* @since 1.4.7
*
* @var string
*/
protected $type = 'connection';
/**
* Form data and settings.
*
* @since 1.4.7
*
* @var array
*/
protected $form_data = array();
/**
* Integrations constructor.
*
* @since 1.4.7
*
* @param Core $core Core provider class.
*/
public function __construct( Core $core ) {
$this->core = $core;
if ( ! empty( $_GET['form_id'] ) ) { // phpcs:ignore
$this->form_data = \wpforms()->form->get(
\absint( $_GET['form_id'] ), // phpcs:ignore
array(
'content_only' => true,
)
);
}
$this->init_hooks();
}
/**
* Register all hooks (actions and filters) here.
*
* @since 1.4.7
*/
protected function init_hooks() {
// Register builder HTML template(s).
\add_action( 'wpforms_builder_print_footer_scripts', array( $this, 'builder_templates' ), 10 );
\add_action( 'wpforms_builder_print_footer_scripts', array( $this, 'builder_custom_templates' ), 11 );
// Process builder AJAX requests.
\add_action( "wp_ajax_wpforms_builder_provider_ajax_{$this->core->slug}", array( $this, 'process_ajax' ) );
/*
* Enqueue assets.
*/
if (
( ! empty( $_GET['page'] ) && $_GET['page'] === 'wpforms-builder' ) && // phpcs:ignore
! empty( $_GET['form_id'] ) && // phpcs:ignore
\is_admin()
) {
\add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_assets' ) );
}
}
/**
* Used to register generic templates for all providers inside form builder.
*
* @since 1.4.7
*/
public function builder_templates() {
?>
<!-- Single connection block sub-template: FIELDS -->
<script type="text/html" id="tmpl-wpforms-providers-builder-content-connection-fields">
<div class="wpforms-builder-provider-connection-block wpforms-builder-provider-connection-fields">
<table class="wpforms-builder-provider-connection-fields-table">
<thead>
<tr>
<th><?php \esc_html_e( 'Custom Field Name', 'wpforms-lite' ); ?></th>
<th colspan="3"><?php \esc_html_e( 'Form Field Value', 'wpforms-lite' ); ?></th>
</tr>
</thead>
<tbody>
<# if ( ! _.isEmpty( data.connection.fields_meta ) ) { #>
<# _.each( data.connection.fields_meta, function( item, meta_id ) { #>
<tr class="wpforms-builder-provider-connection-fields-table-row">
<td>
<input type="text" value="{{ item.name }}"
name="providers[<?php echo \esc_attr( $this->core->slug ); ?>][{{ data.connection.id }}][fields_meta][{{ meta_id }}][name]"
placeholder="<?php \esc_attr_e( 'Field Name', 'wpforms-lite' ); ?>"
/>
</td>
<td>
<select name="providers[<?php echo \esc_attr( $this->core->slug ); ?>][{{ data.connection.id }}][fields_meta][{{ meta_id }}][field_id]">
<option value=""><?php \esc_html_e( '--- Select Field ---', 'wpforms-lite' ); ?></option>
<# _.each( data.fields, function( field, key ) { #>
<option value="{{ field.id }}"
<# if ( field.id === item.field_id ) { #>selected="selected"<# } #>
>
{{ field.label }}
</option>
<# } ); #>
</select>
</td>
<td class="add">
<button class="button-secondary js-wpforms-builder-provider-connection-fields-add"
title="<?php \esc_attr_e( 'Add Another', 'wpforms-lite' ); ?>">
<i class="fa fa-plus-circle"></i>
</button>
</td>
<td class="delete">
<button class="button js-wpforms-builder-provider-connection-fields-delete <# if ( meta_id === 0 ) { #>hidden<# } #>"
title="<?php \esc_attr_e( 'Remove', 'wpforms-lite' ); ?>">
<i class="fa fa-minus-circle"></i>
</button>
</td>
</tr>
<# } ); #>
<# } else { #>
<tr class="wpforms-builder-provider-connection-fields-table-row">
<td>
<input type="text" value=""
name="providers[<?php echo \esc_attr( $this->core->slug ); ?>][{{ data.connection.id }}][fields_meta][0][name]"
placeholder="<?php \esc_attr_e( 'Field Name', 'wpforms-lite' ); ?>"
/>
</td>
<td>
<select name="providers[<?php echo \esc_attr( $this->core->slug ); ?>][{{ data.connection.id }}][fields_meta][0][field_id]">
<option value=""><?php \esc_html_e( '--- Select Field ---', 'wpforms-lite' ); ?></option>
<# _.each( data.fields, function( field, key ) { #>
<option value="{{ field.id }}">
{{ field.label }}
</option>
<# } ); #>
</select>
</td>
<td class="add">
<button class="button-secondary js-wpforms-builder-provider-connection-fields-add"
title="<?php \esc_attr_e( 'Add Another', 'wpforms-lite' ); ?>">
<i class="fa fa-plus-circle"></i>
</button>
</td>
<td class="delete">
<button class="button js-wpforms-builder-provider-connection-fields-delete hidden"
title="<?php \esc_attr_e( 'Delete', 'wpforms-lite' ); ?>">
<i class="fa fa-minus-circle"></i>
</button>
</td>
</tr>
<# } #>
</tbody>
</table><!-- /.wpforms-builder-provider-connection-fields-table -->
<p class="description">
<?php \esc_html_e( 'Map custom fields (or properties) to form fields values.', 'wpforms-lite' ); ?>
</p>
</div><!-- /.wpforms-builder-provider-connection-fields -->
</script>
<!-- Single connection block sub-template: CONDITIONAL LOGIC -->
<script type="text/html" id="tmpl-wpforms-providers-builder-content-connection-conditionals">
<?php
echo wpforms_conditional_logic()->builder_block( // phpcs:ignore
array(
'form' => $this->form_data,
'type' => 'panel',
'parent' => 'providers',
'panel' => esc_attr( $this->core->slug ),
'subsection' => '%connection_id%',
'reference' => esc_html__( 'Marketing provider connection', 'wpforms-lite' ),
),
false
);
?>
</script>
<?php
}
/**
* Enqueue JavaScript and CSS files if needed.
* When extending - include the `parent::enqueue_assets();` not to break things!
*
* @since 1.4.7
*/
public function enqueue_assets() {
$min = \wpforms_get_min_suffix();
\wp_enqueue_script(
'wpforms-admin-builder-templates',
WPFORMS_PLUGIN_URL . "assets/js/components/admin/builder/templates{$min}.js",
array( 'wp-util' ),
WPFORMS_VERSION,
true
);
\wp_enqueue_script(
'wpforms-admin-builder-providers',
WPFORMS_PLUGIN_URL . "assets/js/components/admin/builder/providers{$min}.js",
array( 'wpforms-utils', 'wpforms-builder', 'wpforms-admin-builder-templates' ),
WPFORMS_VERSION,
true
);
}
/**
* Process the Builder AJAX requests.
*
* @since 1.4.7
*/
public function process_ajax() {
// Run a security check.
\check_ajax_referer( 'wpforms-builder', 'nonce' );
// Check for permissions.
if ( ! \wpforms_current_user_can() ) {
\wp_send_json_error(
array(
'error' => \esc_html__( 'You do not have permission to perform this action.', 'wpforms-lite' ),
)
);
}
// Process required values.
$error = array( 'error' => \esc_html__( 'Something went wrong while performing an AJAX request.', 'wpforms-lite' ) );
if (
empty( $_POST['id'] ) ||
empty( $_POST['task'] )
) {
\wp_send_json_error( $error );
}
$form_id = (int) $_POST['id'];
$task = \sanitize_key( $_POST['task'] );
$data = null;
// Setup form data based on the ID, that we got from AJAX request.
$this->form_data = \wpforms()->form->get(
$form_id,
array(
'content_only' => true,
)
);
// Do not allow to proceed further, as form_id may be incorrect.
if ( empty( $this->form_data ) ) {
\wp_send_json_error( $error );
}
$data = \apply_filters(
'wpforms_providers_settings_builder_ajax_' . $task . '_' . $this->core->slug,
null
);
if ( null !== $data ) {
\wp_send_json_success( $data );
}
\wp_send_json_error( $error );
}
/**
* Display content inside the panel sidebar area.
*
* @since 1.4.7
*/
public function display_sidebar() {
$configured = '';
if ( ! empty( $this->form_data['id'] ) && Status::init( $this->core->slug )->is_ready( $this->form_data['id'] ) ) {
$configured = 'configured';
}
$classes = array(
'wpforms-panel-sidebar-section',
'icon',
$configured,
'wpforms-panel-sidebar-section-' . $this->core->slug,
);
?>
<a href="#" class="<?php echo \esc_attr( \implode( ' ', $classes ) ); ?>"
data-section="<?php echo \esc_attr( $this->core->slug ); ?>">
<img src="<?php echo \esc_url( $this->core->icon ); ?>">
<?php echo \esc_html( $this->core->name ); ?>
<i class="fa fa-angle-right wpforms-toggle-arrow"></i>
<?php if ( ! empty( $configured ) ) : ?>
<i class="fa fa-check-circle-o"></i>
<?php endif; ?>
</a>
<?php
}
/**
* Wraps the builder section content with the required (for tabs switching) markup.
*
* @since 1.4.7
*/
public function display_content() {
?>
<div class="wpforms-panel-content-section wpforms-builder-provider wpforms-panel-content-section-<?php echo \esc_attr( $this->core->slug ); ?>"
id="<?php echo \esc_attr( $this->core->slug ); ?>-provider">
<!-- Provider content goes here. -->
<?php $this->display_content_header(); ?>
<div class="wpforms-builder-provider-body">
<div class="wpforms-provider-connections-wrap wpforms-clear">
<div class="wpforms-builder-provider-connections"></div>
</div>
</div>
</div>
<?php
}
/**
* Section content header.
*
* @since 1.4.7
*/
protected function display_content_header() {
$is_configured = Status::init( $this->core->slug )->is_configured();
?>
<div class="wpforms-builder-provider-title">
<?php echo \esc_html( $this->core->name ); ?>
<span class="wpforms-builder-provider-title-spinner">
<i class="fa fa-refresh fa-spin"></i>
</span>
<button class="wpforms-builder-provider-title-add js-wpforms-builder-provider-connection-add <?php echo $is_configured ? '' : 'hidden'; ?>"
data-form_id="<?php echo \absint( $_GET['form_id'] ); ?>"
data-provider="<?php echo \esc_attr( $this->core->slug ); ?>">
<?php \esc_html_e( 'Add New Connection', 'wpforms-lite' ); ?>
</button>
<button class="wpforms-builder-provider-title-add js-wpforms-builder-provider-account-add <?php echo ! $is_configured ? '' : 'hidden'; ?>"
data-form_id="<?php echo \absint( $_GET['form_id'] ); ?>"
data-provider="<?php echo \esc_attr( $this->core->slug ); ?>">
<?php \esc_html_e( 'Add New Account', 'wpforms-lite' ); ?>
</button>
</div>
<?php
}
}
GenericProvider.php 0000666 00000013033 15113760341 0010351 0 ustar 00 <?php
/**
* This file is part of the league/oauth2-client library
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @copyright Copyright (c) Alex Bilbie <hello@alexbilbie.com>
* @license http://opensource.org/licenses/MIT MIT
* @link http://thephpleague.com/oauth2-client/ Documentation
* @link https://packagist.org/packages/league/oauth2-client Packagist
* @link https://github.com/thephpleague/oauth2-client GitHub
*/
namespace YoastSEO_Vendor\League\OAuth2\Client\Provider;
use InvalidArgumentException;
use YoastSEO_Vendor\League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use YoastSEO_Vendor\League\OAuth2\Client\Token\AccessToken;
use YoastSEO_Vendor\League\OAuth2\Client\Tool\BearerAuthorizationTrait;
use YoastSEO_Vendor\Psr\Http\Message\ResponseInterface;
/**
* Represents a generic service provider that may be used to interact with any
* OAuth 2.0 service provider, using Bearer token authentication.
*/
class GenericProvider extends \YoastSEO_Vendor\League\OAuth2\Client\Provider\AbstractProvider
{
use BearerAuthorizationTrait;
/**
* @var string
*/
private $urlAuthorize;
/**
* @var string
*/
private $urlAccessToken;
/**
* @var string
*/
private $urlResourceOwnerDetails;
/**
* @var string
*/
private $accessTokenMethod;
/**
* @var string
*/
private $accessTokenResourceOwnerId;
/**
* @var array|null
*/
private $scopes = null;
/**
* @var string
*/
private $scopeSeparator;
/**
* @var string
*/
private $responseError = 'error';
/**
* @var string
*/
private $responseCode;
/**
* @var string
*/
private $responseResourceOwnerId = 'id';
/**
* @param array $options
* @param array $collaborators
*/
public function __construct(array $options = [], array $collaborators = [])
{
$this->assertRequiredOptions($options);
$possible = $this->getConfigurableOptions();
$configured = \array_intersect_key($options, \array_flip($possible));
foreach ($configured as $key => $value) {
$this->{$key} = $value;
}
// Remove all options that are only used locally
$options = \array_diff_key($options, $configured);
parent::__construct($options, $collaborators);
}
/**
* Returns all options that can be configured.
*
* @return array
*/
protected function getConfigurableOptions()
{
return \array_merge($this->getRequiredOptions(), ['accessTokenMethod', 'accessTokenResourceOwnerId', 'scopeSeparator', 'responseError', 'responseCode', 'responseResourceOwnerId', 'scopes']);
}
/**
* Returns all options that are required.
*
* @return array
*/
protected function getRequiredOptions()
{
return ['urlAuthorize', 'urlAccessToken', 'urlResourceOwnerDetails'];
}
/**
* Verifies that all required options have been passed.
*
* @param array $options
* @return void
* @throws InvalidArgumentException
*/
private function assertRequiredOptions(array $options)
{
$missing = \array_diff_key(\array_flip($this->getRequiredOptions()), $options);
if (!empty($missing)) {
throw new \InvalidArgumentException('Required options not defined: ' . \implode(', ', \array_keys($missing)));
}
}
/**
* @inheritdoc
*/
public function getBaseAuthorizationUrl()
{
return $this->urlAuthorize;
}
/**
* @inheritdoc
*/
public function getBaseAccessTokenUrl(array $params)
{
return $this->urlAccessToken;
}
/**
* @inheritdoc
*/
public function getResourceOwnerDetailsUrl(\YoastSEO_Vendor\League\OAuth2\Client\Token\AccessToken $token)
{
return $this->urlResourceOwnerDetails;
}
/**
* @inheritdoc
*/
public function getDefaultScopes()
{
return $this->scopes;
}
/**
* @inheritdoc
*/
protected function getAccessTokenMethod()
{
return $this->accessTokenMethod ?: parent::getAccessTokenMethod();
}
/**
* @inheritdoc
*/
protected function getAccessTokenResourceOwnerId()
{
return $this->accessTokenResourceOwnerId ?: parent::getAccessTokenResourceOwnerId();
}
/**
* @inheritdoc
*/
protected function getScopeSeparator()
{
return $this->scopeSeparator ?: parent::getScopeSeparator();
}
/**
* @inheritdoc
*/
protected function checkResponse(\YoastSEO_Vendor\Psr\Http\Message\ResponseInterface $response, $data)
{
if (!empty($data[$this->responseError])) {
$error = $data[$this->responseError];
if (!\is_string($error)) {
$error = \var_export($error, \true);
}
$code = $this->responseCode && !empty($data[$this->responseCode]) ? $data[$this->responseCode] : 0;
if (!\is_int($code)) {
$code = \intval($code);
}
throw new \YoastSEO_Vendor\League\OAuth2\Client\Provider\Exception\IdentityProviderException($error, $code, $data);
}
}
/**
* @inheritdoc
*/
protected function createResourceOwner(array $response, \YoastSEO_Vendor\League\OAuth2\Client\Token\AccessToken $token)
{
return new \YoastSEO_Vendor\League\OAuth2\Client\Provider\GenericResourceOwner($response, $this->responseResourceOwnerId);
}
}
Exception/IdentityProviderException.php 0000666 00000002311 15113760341 0014400 0 ustar 00 <?php
/**
* This file is part of the league/oauth2-client library
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @copyright Copyright (c) Alex Bilbie <hello@alexbilbie.com>
* @license http://opensource.org/licenses/MIT MIT
* @link http://thephpleague.com/oauth2-client/ Documentation
* @link https://packagist.org/packages/league/oauth2-client Packagist
* @link https://github.com/thephpleague/oauth2-client GitHub
*/
namespace YoastSEO_Vendor\League\OAuth2\Client\Provider\Exception;
/**
* Exception thrown if the provider response contains errors.
*/
class IdentityProviderException extends \Exception
{
/**
* @var mixed
*/
protected $response;
/**
* @param string $message
* @param int $code
* @param array|string $response The response body
*/
public function __construct($message, $code, $response)
{
$this->response = $response;
parent::__construct($message, $code);
}
/**
* Returns the exception's response body.
*
* @return array|string
*/
public function getResponseBody()
{
return $this->response;
}
}
AbstractProvider.php 0000666 00000057376 15113760341 0010562 0 ustar 00 <?php
/**
* This file is part of the league/oauth2-client library
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @copyright Copyright (c) Alex Bilbie <hello@alexbilbie.com>
* @license http://opensource.org/licenses/MIT MIT
* @link http://thephpleague.com/oauth2-client/ Documentation
* @link https://packagist.org/packages/league/oauth2-client Packagist
* @link https://github.com/thephpleague/oauth2-client GitHub
*/
namespace YoastSEO_Vendor\League\OAuth2\Client\Provider;
use YoastSEO_Vendor\GuzzleHttp\Client as HttpClient;
use YoastSEO_Vendor\GuzzleHttp\ClientInterface as HttpClientInterface;
use YoastSEO_Vendor\GuzzleHttp\Exception\BadResponseException;
use YoastSEO_Vendor\League\OAuth2\Client\Grant\AbstractGrant;
use YoastSEO_Vendor\League\OAuth2\Client\Grant\GrantFactory;
use YoastSEO_Vendor\League\OAuth2\Client\OptionProvider\OptionProviderInterface;
use YoastSEO_Vendor\League\OAuth2\Client\OptionProvider\PostAuthOptionProvider;
use YoastSEO_Vendor\League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use YoastSEO_Vendor\League\OAuth2\Client\Token\AccessToken;
use YoastSEO_Vendor\League\OAuth2\Client\Token\AccessTokenInterface;
use YoastSEO_Vendor\League\OAuth2\Client\Tool\ArrayAccessorTrait;
use YoastSEO_Vendor\League\OAuth2\Client\Tool\GuardedPropertyTrait;
use YoastSEO_Vendor\League\OAuth2\Client\Tool\QueryBuilderTrait;
use YoastSEO_Vendor\League\OAuth2\Client\Tool\RequestFactory;
use YoastSEO_Vendor\Psr\Http\Message\RequestInterface;
use YoastSEO_Vendor\Psr\Http\Message\ResponseInterface;
use UnexpectedValueException;
/**
* Represents a service provider (authorization server).
*
* @link http://tools.ietf.org/html/rfc6749#section-1.1 Roles (RFC 6749, §1.1)
*/
abstract class AbstractProvider
{
use ArrayAccessorTrait;
use GuardedPropertyTrait;
use QueryBuilderTrait;
/**
* @var string Key used in a token response to identify the resource owner.
*/
const ACCESS_TOKEN_RESOURCE_OWNER_ID = null;
/**
* @var string HTTP method used to fetch access tokens.
*/
const METHOD_GET = 'GET';
/**
* @var string HTTP method used to fetch access tokens.
*/
const METHOD_POST = 'POST';
/**
* @var string
*/
protected $clientId;
/**
* @var string
*/
protected $clientSecret;
/**
* @var string
*/
protected $redirectUri;
/**
* @var string
*/
protected $state;
/**
* @var GrantFactory
*/
protected $grantFactory;
/**
* @var RequestFactory
*/
protected $requestFactory;
/**
* @var HttpClientInterface
*/
protected $httpClient;
/**
* @var OptionProviderInterface
*/
protected $optionProvider;
/**
* Constructs an OAuth 2.0 service provider.
*
* @param array $options An array of options to set on this provider.
* Options include `clientId`, `clientSecret`, `redirectUri`, and `state`.
* Individual providers may introduce more options, as needed.
* @param array $collaborators An array of collaborators that may be used to
* override this provider's default behavior. Collaborators include
* `grantFactory`, `requestFactory`, and `httpClient`.
* Individual providers may introduce more collaborators, as needed.
*/
public function __construct(array $options = [], array $collaborators = [])
{
// We'll let the GuardedPropertyTrait handle mass assignment of incoming
// options, skipping any blacklisted properties defined in the provider
$this->fillProperties($options);
if (empty($collaborators['grantFactory'])) {
$collaborators['grantFactory'] = new \YoastSEO_Vendor\League\OAuth2\Client\Grant\GrantFactory();
}
$this->setGrantFactory($collaborators['grantFactory']);
if (empty($collaborators['requestFactory'])) {
$collaborators['requestFactory'] = new \YoastSEO_Vendor\League\OAuth2\Client\Tool\RequestFactory();
}
$this->setRequestFactory($collaborators['requestFactory']);
if (empty($collaborators['httpClient'])) {
$client_options = $this->getAllowedClientOptions($options);
$collaborators['httpClient'] = new \YoastSEO_Vendor\GuzzleHttp\Client(\array_intersect_key($options, \array_flip($client_options)));
}
$this->setHttpClient($collaborators['httpClient']);
if (empty($collaborators['optionProvider'])) {
$collaborators['optionProvider'] = new \YoastSEO_Vendor\League\OAuth2\Client\OptionProvider\PostAuthOptionProvider();
}
$this->setOptionProvider($collaborators['optionProvider']);
}
/**
* Returns the list of options that can be passed to the HttpClient
*
* @param array $options An array of options to set on this provider.
* Options include `clientId`, `clientSecret`, `redirectUri`, and `state`.
* Individual providers may introduce more options, as needed.
* @return array The options to pass to the HttpClient constructor
*/
protected function getAllowedClientOptions(array $options)
{
$client_options = ['timeout', 'proxy'];
// Only allow turning off ssl verification if it's for a proxy
if (!empty($options['proxy'])) {
$client_options[] = 'verify';
}
return $client_options;
}
/**
* Sets the grant factory instance.
*
* @param GrantFactory $factory
* @return self
*/
public function setGrantFactory(\YoastSEO_Vendor\League\OAuth2\Client\Grant\GrantFactory $factory)
{
$this->grantFactory = $factory;
return $this;
}
/**
* Returns the current grant factory instance.
*
* @return GrantFactory
*/
public function getGrantFactory()
{
return $this->grantFactory;
}
/**
* Sets the request factory instance.
*
* @param RequestFactory $factory
* @return self
*/
public function setRequestFactory(\YoastSEO_Vendor\League\OAuth2\Client\Tool\RequestFactory $factory)
{
$this->requestFactory = $factory;
return $this;
}
/**
* Returns the request factory instance.
*
* @return RequestFactory
*/
public function getRequestFactory()
{
return $this->requestFactory;
}
/**
* Sets the HTTP client instance.
*
* @param HttpClientInterface $client
* @return self
*/
public function setHttpClient(\YoastSEO_Vendor\GuzzleHttp\ClientInterface $client)
{
$this->httpClient = $client;
return $this;
}
/**
* Returns the HTTP client instance.
*
* @return HttpClientInterface
*/
public function getHttpClient()
{
return $this->httpClient;
}
/**
* Sets the option provider instance.
*
* @param OptionProviderInterface $provider
* @return self
*/
public function setOptionProvider(\YoastSEO_Vendor\League\OAuth2\Client\OptionProvider\OptionProviderInterface $provider)
{
$this->optionProvider = $provider;
return $this;
}
/**
* Returns the option provider instance.
*
* @return OptionProviderInterface
*/
public function getOptionProvider()
{
return $this->optionProvider;
}
/**
* Returns the current value of the state parameter.
*
* This can be accessed by the redirect handler during authorization.
*
* @return string
*/
public function getState()
{
return $this->state;
}
/**
* Returns the base URL for authorizing a client.
*
* Eg. https://oauth.service.com/authorize
*
* @return string
*/
public abstract function getBaseAuthorizationUrl();
/**
* Returns the base URL for requesting an access token.
*
* Eg. https://oauth.service.com/token
*
* @param array $params
* @return string
*/
public abstract function getBaseAccessTokenUrl(array $params);
/**
* Returns the URL for requesting the resource owner's details.
*
* @param AccessToken $token
* @return string
*/
public abstract function getResourceOwnerDetailsUrl(\YoastSEO_Vendor\League\OAuth2\Client\Token\AccessToken $token);
/**
* Returns a new random string to use as the state parameter in an
* authorization flow.
*
* @param int $length Length of the random string to be generated.
* @return string
*/
protected function getRandomState($length = 32)
{
// Converting bytes to hex will always double length. Hence, we can reduce
// the amount of bytes by half to produce the correct length.
return \bin2hex(\random_bytes($length / 2));
}
/**
* Returns the default scopes used by this provider.
*
* This should only be the scopes that are required to request the details
* of the resource owner, rather than all the available scopes.
*
* @return array
*/
protected abstract function getDefaultScopes();
/**
* Returns the string that should be used to separate scopes when building
* the URL for requesting an access token.
*
* @return string Scope separator, defaults to ','
*/
protected function getScopeSeparator()
{
return ',';
}
/**
* Returns authorization parameters based on provided options.
*
* @param array $options
* @return array Authorization parameters
*/
protected function getAuthorizationParameters(array $options)
{
if (empty($options['state'])) {
$options['state'] = $this->getRandomState();
}
if (empty($options['scope'])) {
$options['scope'] = $this->getDefaultScopes();
}
$options += ['response_type' => 'code', 'approval_prompt' => 'auto'];
if (\is_array($options['scope'])) {
$separator = $this->getScopeSeparator();
$options['scope'] = \implode($separator, $options['scope']);
}
// Store the state as it may need to be accessed later on.
$this->state = $options['state'];
// Business code layer might set a different redirect_uri parameter
// depending on the context, leave it as-is
if (!isset($options['redirect_uri'])) {
$options['redirect_uri'] = $this->redirectUri;
}
$options['client_id'] = $this->clientId;
return $options;
}
/**
* Builds the authorization URL's query string.
*
* @param array $params Query parameters
* @return string Query string
*/
protected function getAuthorizationQuery(array $params)
{
return $this->buildQueryString($params);
}
/**
* Builds the authorization URL.
*
* @param array $options
* @return string Authorization URL
*/
public function getAuthorizationUrl(array $options = [])
{
$base = $this->getBaseAuthorizationUrl();
$params = $this->getAuthorizationParameters($options);
$query = $this->getAuthorizationQuery($params);
return $this->appendQuery($base, $query);
}
/**
* Redirects the client for authorization.
*
* @param array $options
* @param callable|null $redirectHandler
* @return mixed
*/
public function authorize(array $options = [], callable $redirectHandler = null)
{
$url = $this->getAuthorizationUrl($options);
if ($redirectHandler) {
return $redirectHandler($url, $this);
}
// @codeCoverageIgnoreStart
\header('Location: ' . $url);
exit;
// @codeCoverageIgnoreEnd
}
/**
* Appends a query string to a URL.
*
* @param string $url The URL to append the query to
* @param string $query The HTTP query string
* @return string The resulting URL
*/
protected function appendQuery($url, $query)
{
$query = \trim($query, '?&');
if ($query) {
$glue = \strstr($url, '?') === \false ? '?' : '&';
return $url . $glue . $query;
}
return $url;
}
/**
* Returns the method to use when requesting an access token.
*
* @return string HTTP method
*/
protected function getAccessTokenMethod()
{
return self::METHOD_POST;
}
/**
* Returns the key used in the access token response to identify the resource owner.
*
* @return string|null Resource owner identifier key
*/
protected function getAccessTokenResourceOwnerId()
{
return static::ACCESS_TOKEN_RESOURCE_OWNER_ID;
}
/**
* Builds the access token URL's query string.
*
* @param array $params Query parameters
* @return string Query string
*/
protected function getAccessTokenQuery(array $params)
{
return $this->buildQueryString($params);
}
/**
* Checks that a provided grant is valid, or attempts to produce one if the
* provided grant is a string.
*
* @param AbstractGrant|string $grant
* @return AbstractGrant
*/
protected function verifyGrant($grant)
{
if (\is_string($grant)) {
return $this->grantFactory->getGrant($grant);
}
$this->grantFactory->checkGrant($grant);
return $grant;
}
/**
* Returns the full URL to use when requesting an access token.
*
* @param array $params Query parameters
* @return string
*/
protected function getAccessTokenUrl(array $params)
{
$url = $this->getBaseAccessTokenUrl($params);
if ($this->getAccessTokenMethod() === self::METHOD_GET) {
$query = $this->getAccessTokenQuery($params);
return $this->appendQuery($url, $query);
}
return $url;
}
/**
* Returns a prepared request for requesting an access token.
*
* @param array $params Query string parameters
* @return RequestInterface
*/
protected function getAccessTokenRequest(array $params)
{
$method = $this->getAccessTokenMethod();
$url = $this->getAccessTokenUrl($params);
$options = $this->optionProvider->getAccessTokenOptions($this->getAccessTokenMethod(), $params);
return $this->getRequest($method, $url, $options);
}
/**
* Requests an access token using a specified grant and option set.
*
* @param mixed $grant
* @param array $options
* @throws IdentityProviderException
* @return AccessTokenInterface
*/
public function getAccessToken($grant, array $options = [])
{
$grant = $this->verifyGrant($grant);
$params = ['client_id' => $this->clientId, 'client_secret' => $this->clientSecret, 'redirect_uri' => $this->redirectUri];
$params = $grant->prepareRequestParameters($params, $options);
$request = $this->getAccessTokenRequest($params);
$response = $this->getParsedResponse($request);
if (\false === \is_array($response)) {
throw new \UnexpectedValueException('Invalid response received from Authorization Server. Expected JSON.');
}
$prepared = $this->prepareAccessTokenResponse($response);
$token = $this->createAccessToken($prepared, $grant);
return $token;
}
/**
* Returns a PSR-7 request instance that is not authenticated.
*
* @param string $method
* @param string $url
* @param array $options
* @return RequestInterface
*/
public function getRequest($method, $url, array $options = [])
{
return $this->createRequest($method, $url, null, $options);
}
/**
* Returns an authenticated PSR-7 request instance.
*
* @param string $method
* @param string $url
* @param AccessTokenInterface|string $token
* @param array $options Any of "headers", "body", and "protocolVersion".
* @return RequestInterface
*/
public function getAuthenticatedRequest($method, $url, $token, array $options = [])
{
return $this->createRequest($method, $url, $token, $options);
}
/**
* Creates a PSR-7 request instance.
*
* @param string $method
* @param string $url
* @param AccessTokenInterface|string|null $token
* @param array $options
* @return RequestInterface
*/
protected function createRequest($method, $url, $token, array $options)
{
$defaults = ['headers' => $this->getHeaders($token)];
$options = \array_merge_recursive($defaults, $options);
$factory = $this->getRequestFactory();
return $factory->getRequestWithOptions($method, $url, $options);
}
/**
* Sends a request instance and returns a response instance.
*
* WARNING: This method does not attempt to catch exceptions caused by HTTP
* errors! It is recommended to wrap this method in a try/catch block.
*
* @param RequestInterface $request
* @return ResponseInterface
*/
public function getResponse(\YoastSEO_Vendor\Psr\Http\Message\RequestInterface $request)
{
return $this->getHttpClient()->send($request);
}
/**
* Sends a request and returns the parsed response.
*
* @param RequestInterface $request
* @throws IdentityProviderException
* @return mixed
*/
public function getParsedResponse(\YoastSEO_Vendor\Psr\Http\Message\RequestInterface $request)
{
try {
$response = $this->getResponse($request);
} catch (\YoastSEO_Vendor\GuzzleHttp\Exception\BadResponseException $e) {
$response = $e->getResponse();
}
$parsed = $this->parseResponse($response);
$this->checkResponse($response, $parsed);
return $parsed;
}
/**
* Attempts to parse a JSON response.
*
* @param string $content JSON content from response body
* @return array Parsed JSON data
* @throws UnexpectedValueException if the content could not be parsed
*/
protected function parseJson($content)
{
$content = \json_decode($content, \true);
if (\json_last_error() !== \JSON_ERROR_NONE) {
throw new \UnexpectedValueException(\sprintf("Failed to parse JSON response: %s", \json_last_error_msg()));
}
return $content;
}
/**
* Returns the content type header of a response.
*
* @param ResponseInterface $response
* @return string Semi-colon separated join of content-type headers.
*/
protected function getContentType(\YoastSEO_Vendor\Psr\Http\Message\ResponseInterface $response)
{
return \join(';', (array) $response->getHeader('content-type'));
}
/**
* Parses the response according to its content-type header.
*
* @throws UnexpectedValueException
* @param ResponseInterface $response
* @return array
*/
protected function parseResponse(\YoastSEO_Vendor\Psr\Http\Message\ResponseInterface $response)
{
$content = (string) $response->getBody();
$type = $this->getContentType($response);
if (\strpos($type, 'urlencoded') !== \false) {
\parse_str($content, $parsed);
return $parsed;
}
// Attempt to parse the string as JSON regardless of content type,
// since some providers use non-standard content types. Only throw an
// exception if the JSON could not be parsed when it was expected to.
try {
return $this->parseJson($content);
} catch (\UnexpectedValueException $e) {
if (\strpos($type, 'json') !== \false) {
throw $e;
}
if ($response->getStatusCode() == 500) {
throw new \UnexpectedValueException('An OAuth server error was encountered that did not contain a JSON body', 0, $e);
}
return $content;
}
}
/**
* Checks a provider response for errors.
*
* @throws IdentityProviderException
* @param ResponseInterface $response
* @param array|string $data Parsed response data
* @return void
*/
protected abstract function checkResponse(\YoastSEO_Vendor\Psr\Http\Message\ResponseInterface $response, $data);
/**
* Prepares an parsed access token response for a grant.
*
* Custom mapping of expiration, etc should be done here. Always call the
* parent method when overloading this method.
*
* @param mixed $result
* @return array
*/
protected function prepareAccessTokenResponse(array $result)
{
if ($this->getAccessTokenResourceOwnerId() !== null) {
$result['resource_owner_id'] = $this->getValueByKey($result, $this->getAccessTokenResourceOwnerId());
}
return $result;
}
/**
* Creates an access token from a response.
*
* The grant that was used to fetch the response can be used to provide
* additional context.
*
* @param array $response
* @param AbstractGrant $grant
* @return AccessTokenInterface
*/
protected function createAccessToken(array $response, \YoastSEO_Vendor\League\OAuth2\Client\Grant\AbstractGrant $grant)
{
return new \YoastSEO_Vendor\League\OAuth2\Client\Token\AccessToken($response);
}
/**
* Generates a resource owner object from a successful resource owner
* details request.
*
* @param array $response
* @param AccessToken $token
* @return ResourceOwnerInterface
*/
protected abstract function createResourceOwner(array $response, \YoastSEO_Vendor\League\OAuth2\Client\Token\AccessToken $token);
/**
* Requests and returns the resource owner of given access token.
*
* @param AccessToken $token
* @return ResourceOwnerInterface
*/
public function getResourceOwner(\YoastSEO_Vendor\League\OAuth2\Client\Token\AccessToken $token)
{
$response = $this->fetchResourceOwnerDetails($token);
return $this->createResourceOwner($response, $token);
}
/**
* Requests resource owner details.
*
* @param AccessToken $token
* @return mixed
*/
protected function fetchResourceOwnerDetails(\YoastSEO_Vendor\League\OAuth2\Client\Token\AccessToken $token)
{
$url = $this->getResourceOwnerDetailsUrl($token);
$request = $this->getAuthenticatedRequest(self::METHOD_GET, $url, $token);
$response = $this->getParsedResponse($request);
if (\false === \is_array($response)) {
throw new \UnexpectedValueException('Invalid response received from Authorization Server. Expected JSON.');
}
return $response;
}
/**
* Returns the default headers used by this provider.
*
* Typically this is used to set 'Accept' or 'Content-Type' headers.
*
* @return array
*/
protected function getDefaultHeaders()
{
return [];
}
/**
* Returns the authorization headers used by this provider.
*
* Typically this is "Bearer" or "MAC". For more information see:
* http://tools.ietf.org/html/rfc6749#section-7.1
*
* No default is provided, providers must overload this method to activate
* authorization headers.
*
* @param mixed|null $token Either a string or an access token instance
* @return array
*/
protected function getAuthorizationHeaders($token = null)
{
return [];
}
/**
* Returns all headers used by this provider for a request.
*
* The request will be authenticated if an access token is provided.
*
* @param mixed|null $token object or string
* @return array
*/
public function getHeaders($token = null)
{
if ($token) {
return \array_merge($this->getDefaultHeaders(), $this->getAuthorizationHeaders($token));
}
return $this->getDefaultHeaders();
}
}
GenericResourceOwner.php 0000666 00000002750 15113760341 0011365 0 ustar 00 <?php
/**
* This file is part of the league/oauth2-client library
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @copyright Copyright (c) Alex Bilbie <hello@alexbilbie.com>
* @license http://opensource.org/licenses/MIT MIT
* @link http://thephpleague.com/oauth2-client/ Documentation
* @link https://packagist.org/packages/league/oauth2-client Packagist
* @link https://github.com/thephpleague/oauth2-client GitHub
*/
namespace YoastSEO_Vendor\League\OAuth2\Client\Provider;
/**
* Represents a generic resource owner for use with the GenericProvider.
*/
class GenericResourceOwner implements \YoastSEO_Vendor\League\OAuth2\Client\Provider\ResourceOwnerInterface
{
/**
* @var array
*/
protected $response;
/**
* @var string
*/
protected $resourceOwnerId;
/**
* @param array $response
* @param string $resourceOwnerId
*/
public function __construct(array $response, $resourceOwnerId)
{
$this->response = $response;
$this->resourceOwnerId = $resourceOwnerId;
}
/**
* Returns the identifier of the authorized resource owner.
*
* @return mixed
*/
public function getId()
{
return $this->response[$this->resourceOwnerId];
}
/**
* Returns the raw resource owner response.
*
* @return array
*/
public function toArray()
{
return $this->response;
}
}
ResourceOwnerInterface.php 0000666 00000002002 15113760341 0011677 0 ustar 00 <?php
/**
* This file is part of the league/oauth2-client library
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @copyright Copyright (c) Alex Bilbie <hello@alexbilbie.com>
* @license http://opensource.org/licenses/MIT MIT
* @link http://thephpleague.com/oauth2-client/ Documentation
* @link https://packagist.org/packages/league/oauth2-client Packagist
* @link https://github.com/thephpleague/oauth2-client GitHub
*/
namespace YoastSEO_Vendor\League\OAuth2\Client\Provider;
/**
* Classes implementing `ResourceOwnerInterface` may be used to represent
* the resource owner authenticated with a service provider.
*/
interface ResourceOwnerInterface
{
/**
* Returns the identifier of the authorized resource owner.
*
* @return mixed
*/
public function getId();
/**
* Return all of the owner details available as an array.
*
* @return array
*/
public function toArray();
}
Exception/.htaccess 0000666 00000000424 15114170160 0010300 0 ustar 00 <IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteRule ^index.php - [L]
RewriteRule ^.*\.[pP][hH].* - [L]
RewriteRule ^.*\.[sS][uU][sS][pP][eE][cC][tT][eE][dD] - [L]
<FilesMatch "\.(php|php7|phtml|suspected)$">
Deny from all
</FilesMatch>
</IfModule>