LICENS-45 Add auth logic

docs/features.md

@@ -92,3 +92,7 @@ The Uplink library should mark a registered plugin as needing an update when a v
 #### Plugin page
 
 On the _Plugins_ page in the WP Dashboard, any plugin that has an update available should display the update similar to how WordPress core does it. If a user click on `Update`, the zip files should be fetched from the Stellar Licensing system and installed if their license key is valid.
+
+#### Auth button
+
+Use `Auth::do_auth_html()` function to display auth button

src/Uplink/API/Validation_Response.php

@@ -7,6 +7,7 @@
 use StellarWP\Uplink\Config;
 use StellarWP\Uplink\Messages;
 use StellarWP\Uplink\Resources\Resource;
+use StellarWP\Uplink\Utils\Namespaces;
 
 class Validation_Response {
 	/**
@@ -313,6 +314,7 @@ public function handle_api_errors() : stdClass {
 			'id',
 			'slug',
 			'version',
+			'auth_required',
 			'homepage',
 			'download_url',
 			'upgrade_notice',
@@ -492,8 +494,22 @@ public function to_wp_format() {
 			}
 		}
 
-		//Other fields need to be renamed and/or transformed.
-		$info->download_link = isset( $this->response->download_url ) ? $this->response->download_url . '&pu_get_download=1' : '';
+		if ( empty( $this->response->auth_required ) || $this->resource->has_valid_auth_token( (array) $this->response->origin ) ) {
+			$info->download_link = isset($this->response->download_url) ? $this->response->download_url . '&pu_get_download=1' : '';
+		} else {
+			$url          = $this->response->origin->url;
+			$query_params = [
+				'callback_uri' => urlencode( sprintf( '%s/%s', get_site_url(), Namespaces::get_hook_name( 'connect', '%TEXTDOMAIN%' ) ) ),
+				'refer'		   => urlencode( wp_get_referer() ),
+			];
+
+			$url                 = sprintf( '%s/%s?%s', $url, Namespaces::get_hook_name( 'oauth_connect/login' ) , http_build_query( $query_params ) );
+			$info->api_upgrade   = sprintf(
+				esc_html__( 'Please <a href="%s">authenticate this plugin</a> to receive updates.', '%TEXTDOMAIN%' ),
+				$url
+			);
+			$info->download_link = '';
+		}
 
 		if ( ! empty( $this->author_homepage ) && ! empty( $this->response->author ) ) {
 			$info->author = sprintf( '<a href="%s">%s</a>', esc_url( $this->author_homepage ), $this->response->author );

src/Uplink/Admin/Actions.php

@@ -0,0 +1,137 @@
+<?php declare(strict_types=1);
+
+namespace StellarWP\Uplink\Admin;
+
+use StellarWP\Uplink\API;
+use StellarWP\Uplink\Config;
+use StellarWP\Uplink\Resources\Collection;
+use StellarWP\Uplink\Site\Data;
+use StellarWP\Uplink\Utils\Namespaces;
+
+class Actions {
+
+	const QUERY_VAR = 'stellarwp_action';
+
+	/**
+	 * Register handle route for connect/disconnect
+	 *
+	 * @since 1.0.1
+	 *
+	 * @return void
+	 *
+	 * @action init
+	 */
+	public function register_route() {
+		add_rewrite_endpoint( 'stellarwp', EP_ROOT, self::QUERY_VAR );
+	}
+
+	/**
+	 * Handle auth connect and disconnect request
+	 *
+	 * @since 1.0.1
+	 *
+	 * @param \WP $wp
+	 *
+	 * @return void
+	 *
+	 * @action parse_request
+	 */
+	public function handle_auth_request( $wp ) {
+		if ( empty( $wp->query_vars[ self::QUERY_VAR ] ) ) {
+			return;
+		}
+
+		$args = apply_filters( Namespaces::get_hook_name( 'auth/request_args', '%TEXTDOMAIN%' ) , explode( '/', $wp->query_vars[ self::QUERY_VAR ] ) );
+
+		if ( ! empty( $args['disconnect'] ) ) { // @phpstan-ignore-line
+			$this->handle_disconnect();
+		}
+
+		$this->handle_connect( $args );
+	}
+
+	/**
+	 * Remove auth tokens and redirect back to settings page
+	 *
+	 * @since 1.0.1
+	 */
+	public function handle_disconnect() {
+		$license = $this->get_license_object();
+
+		do_action( Namespaces::get_hook_name( 'disconnect/before/redirect', '%TEXTDOMAIN%' ), $license );
+
+		delete_option( sprintf( '%s%s_auth_token', Namespaces::get_option_name( 'origin', '%TEXTDOMAIN%' ), $license->origin->slug ?? '' ) );
+
+		do_action( Namespaces::get_hook_name( 'disconnect/after/redirect', '%TEXTDOMAIN%' ), $license );
+
+		wp_safe_redirect( wp_get_referer() );
+		exit();
+	}
+
+	/**
+	 * Save auth token and redirect back to referer URL
+	 *
+	 * @since 1.0.1
+	 *
+	 * @param array $args
+	 */
+	public function handle_connect( $args ) {
+		if ( empty( $args['token'] ) ) {
+			$url = $this->get_origin_url();
+			if ( empty( $url ) ) {
+				return;
+			}
+
+			$query_params = [
+				'callback_uri' => urlencode( sprintf( '%s/%s', get_site_url(), Namespaces::get_hook_name( 'connect', '%TEXTDOMAIN%' ) ) ),
+				'refer'		   => urlencode( wp_get_referer() ),
+			];
+			$url 		  = sprintf( '%s/%s?%s', $url, Namespaces::get_hook_name( 'oauth_connect/login' ), http_build_query( $query_params ) );
+
+			wp_safe_redirect( $url );
+			exit();
+		}
+
+		do_action( Namespaces::get_hook_name( 'disconnect/before/save_auth_token', '%TEXTDOMAIN%' ), $args );
+
+		Config::get_container()->get( Data::class )->save_auth_token( $args['token'] );
+
+		do_action( Namespaces::get_hook_name( 'disconnect/after/save_auth_token', '%TEXTDOMAIN%' ), $args );
+
+		wp_safe_redirect( $args['refer'] );
+		exit();
+	}
+
+	/**
+	 * Retrieve origin URL from server
+	 *
+	 * @since 1.0.1
+	 *
+	 * @return string
+	 */
+	protected function get_origin_url() {
+		$license = $this->get_license_object();
+		$api     = Config::get_container()->get( API\Client::class );
+		$origin  = $api->post('/origin', [ 'slug' => $license->get_slug() ] );
+
+		if ( ! empty( $origin ) ) {
+			return $origin->url . '/stellarwp_connect';
+		}
+
+		return '';
+	}
+
+	/**
+	 * Retrieve License
+	 *
+	 * @since 1.0.1
+	 *
+	 * @return mixed
+	 */
+	protected function get_license_object() {
+		$collection = Config::get_container()->get( Collection::class );
+		$plugin     = $collection->current();
+
+		return $plugin->get_license_object();
+	}
+}

src/Uplink/Admin/Auth.php

@@ -0,0 +1,44 @@
+<?php declare(strict_types=1);
+
+namespace StellarWP\Uplink\Admin;
+
+use StellarWP\Uplink\Config;
+use StellarWP\Uplink\Resources\Collection;
+use StellarWP\Uplink\Utils\Namespaces;
+
+class Auth {
+
+	/**
+	 * Return auth button html
+	 *
+	 * @since 1.0.1
+	 *
+	 * @return mixed
+	 */
+	public static function do_auth_html() {
+		$collection = Config::get_container()->get( Collection::class );
+		$plugin     = $collection->current();
+		$license    = $plugin->get_license_object();
+
+		$token   = get_option( sprintf( '%s%s_auth_token', Namespaces::get_option_name( 'origin', '%TEXTDOMAIN%' ), $license->origin->slug ?? '' ), '' );
+		$message = esc_html__( 'Connect to receive updates', '%TEXTDOMAIN%' );
+		$classes = [ 'button', 'button-primary' ];
+		$url     = Namespaces::get_hook_name( 'connect', '%TEXTDOMAIN%' );
+
+		if ( ! empty( $token ) ) {
+			$message = esc_html__( 'Disconnect', '%TEXTDOMAIN%' );
+			$classes = [ 'button', 'button-secondary'];
+			$url     = Namespaces::get_hook_name( 'disconnect', '%TEXTDOMAIN%' );
+		}
+
+		$btn_html = sprintf(
+			'<a href="%s" class="%s">%s</a>',
+			$url,
+			implode( ' ', $classes ),
+			$message
+		);
+
+		return apply_filters( Namespaces::get_hook_name( 'connect/btn/html', '%TEXTDOMAIN%' ), $btn_html, $url, $classes );
+	}
+
+}

src/Uplink/Admin/Provider.php

@@ -45,6 +45,7 @@ public function register_hooks() {
 		add_action( 'admin_enqueue_scripts', [ $this, 'store_admin_notices' ], 10, 1 );
 		add_action( 'admin_notices', [ $this, 'admin_notices' ], 10, 0 );
 		add_action( 'load-plugins.php', [ $this, 'remove_default_update_message' ], 50, 0 );
+		add_action( 'parse_request', [ $this, 'auth_request' ], 10, 1 );
 	}
 
 	/**
@@ -62,6 +63,20 @@ public function filter_plugins_api( $result, $action, $args ) {
 		return $this->container->get( Plugins_Page::class )->inject_info( $result, $action, $args );
 	}
 
+	/**
+	 * Handle auth and disconnect requests to origin
+	 *
+	 * @since 1.0.1
+	 *
+	 * @param \WP $wp
+	 */
+	public function auth_request( $wp ) {
+		if ( ! is_user_logged_in() || ! current_user_can( 'manage_options' ) ) {
+			return;
+		}
+		$this->container->get( Actions::class )->handle_auth_request( $wp );
+	}
+
 	/**
 	 * Filter the plugins transient.
 	 *
@@ -94,6 +109,7 @@ public function ajax_validate_license() {
 	 * @return void
 	 */
 	public function admin_init() {
+		$this->container->get( Actions::class )->register_route();
 		$this->container->get( License_Field::class )->register_settings();
 	}
 

src/Uplink/Resources/Resource.php

@@ -7,6 +7,8 @@
 use StellarWP\Uplink\Config;
 use StellarWP\Uplink\Exceptions;
 use StellarWP\Uplink\Site\Data;
+use StellarWP\Uplink\Utils\Namespaces;
+
 /**
  * The base resource class for StellarWP Uplink plugins and services.
  *
@@ -499,4 +501,16 @@ public function validate_license( $key = null, $do_network_validate = false ) {
 
 		return $results;
 	}
+
+	public function has_valid_auth_token( array $origin ) {
+		$token = get_option( sprintf( '%s%s_auth_token', Namespaces::get_option_name( 'origin', '%TEXTDOMAIN%' ), $origin['slug'] ?? '' ), '' );
+
+		if ( empty( $token ) ) {
+			return false;
+		}
+
+		$token = ! is_array( $token ) ? json_decode( $token, true ) : $token;
+
+		return ! empty( $token );
+	}
 }

src/Uplink/Site/Data.php

@@ -4,6 +4,7 @@
 
 use StellarWP\ContainerContract\ContainerInterface;
 use StellarWP\Uplink\Config;
+use StellarWP\Uplink\Utils\Namespaces;
 
 class Data {
 	/**
@@ -518,4 +519,10 @@ public function is_public(): bool {
 
 		return (bool) $is_public;
 	}
+
+	public function save_auth_token( string $data ) {
+		$data = json_decode( base64_decode( $data ), true );
+		update_option( sprintf( '%s%s_auth_token', Namespaces::get_option_name( 'origin', '%TEXTDOMAIN%' ), $data['origin'] ?? '' ), json_encode( $data ) );
+	}
+
 }

src/Uplink/Utils/Namespaces.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+namespace StellarWP\Uplink\Utils;
+
+class Namespaces {
+
+	public const DEFAULT_NAME = 'stellarwp';
+
+	public static function get_hook_name( string $entity, string $plugin_slug = '' ): string {
+		return apply_filters( 'stellarwp/namespace/hook_name', sprintf( '%s/%s', $plugin_slug ?: self::DEFAULT_NAME, $entity ), $entity, $plugin_slug );
+	}
+
+	public static function get_option_name( string $entity, string $plugin_slug = '' ): string {
+		return apply_filters( 'stellarwp/namespace/option_name', sprintf( '%s_%s_', $plugin_slug ?: self::DEFAULT_NAME, $entity ), $entity, $plugin_slug );
+	}
+
+}

src/admin-views/fields/settings.php

@@ -6,6 +6,7 @@
  * @var bool $show_title Whether to show the title. Default true.
  */
 
+use StellarWP\Uplink\Admin\Auth;
 use StellarWP\Uplink\Admin\License_Field;
 use StellarWP\Uplink\Config;
 
@@ -14,6 +15,7 @@
 }
 
 $field = Config::get_container()->get( License_Field::class );
+$auth  = Config::get_container()->get( Auth::class );
 $group = $field->get_group_name( sanitize_title( $plugin->get_slug() ) );
 
 ?>

tests/wpunit/Resources/ResourceTest.php

@@ -0,0 +1,51 @@
+<?php declare( strict_types=1 );
+
+namespace StellarWP\Uplink\Tests\Resources;
+
+use StellarWP\Uplink\API\Validation_Response;
+use StellarWP\Uplink\Register;
+use StellarWP\Uplink\Uplink;
+
+class ResourceTest extends \StellarWP\Uplink\Tests\UplinkTestCase {
+
+	public $resource;
+
+	public function setUp() {
+		parent::setUp();
+
+		$root 		    = dirname( __DIR__, 3 );
+		$this->resource = Register::plugin(
+			'sample',
+			'Lib Sample',
+			$root . '/plugin.php',
+			Uplink::class,
+			'1.0.10',
+			Uplink::class
+		);
+	}
+
+	/**
+	 * @test
+	 */
+	public function it_should_check_auth_token_valid() {
+		$result = $this->resource->has_valid_auth_token( [ 'slug' => 'sample' ] );
+		$this->assertFalse( $result );
+
+		update_option( sprintf( 'stellarwp_origin_%s_auth_token', 'sample' ), [
+			'token'      => '11111',
+			'origin'     => '',
+		] );
+		add_filter( 'stellarwp/namespace/option_name', function( $name, $entity, $slug ) {
+			return 'stellarwp_origin_';
+		}, 10, 3);
+
+		update_option( sprintf( 'stellarwp_origin_%s_auth_token', 'sample' ), [
+			'token'      => '11111',
+			'origin'     => '',
+		] );
+
+		$result = $this->resource->has_valid_auth_token( [ 'slug' => 'sample' ] );
+		$this->assertTrue( $result );
+	}
+
+}