Skip to content
Snippets Groups Projects
Commit 7084c414 authored by dyszczo's avatar dyszczo
Browse files

version 3.0. Some classes moved to wp-builder. Activation and installation nag... 

version 3.0. Some classes moved to wp-builder. Activation and installation nag when repository plugin is required
parent b006b922
No related branches found
No related tags found
1 merge request!13Feature/repository plugins
Show whitespace changes
Inline Side-by-side
Showing
with 604 additions and 656 deletions
CHANGELOG.md
+ 7
− 0
View file @ 7084c414
## [3.0.0] - 2019-09-17
### Changed
- Plugin classes moved to wp-builder
### Added
- Factory can create checker from requirement array
- Support for update suggestion when required plugin not found
## [2.4.0] - 2019-06-04
### Added
- Plugin name in plugin info
......
composer.json
+ 1
− 1
View file @ 7084c414
......@@ -7,7 +7,7 @@
}
],
"require": {
"php": ">=5.2"
"php": ">=5.3"
},
"require-dev": {
"php": ">=5.5",
......
src/Basic_Requirement_Checker.php
+ 495
− 396
View file @ 7084c414
<?php
if ( ! interface_exists( 'WPDesk_Translatable' ) ) {
require_once 'Translatable.php';
}
if ( ! interface_exists( 'WPDesk_Requirement_Checker' ) ) {
require_once 'Requirement_Checker.php';
}
......@@ -11,13 +7,16 @@ if ( ! interface_exists( 'WPDesk_Requirement_Checker' ) ) {
if ( ! class_exists( 'WPDesk_Basic_Requirement_Checker' ) ) {
/**
* Checks requirements for plugin
* have to be compatible with PHP 5.2.x
* have to be compatible with PHP 5.3.x
*/
class WPDesk_Basic_Requirement_Checker implements WPDesk_Translatable, WPDesk_Requirement_Checker
{
class WPDesk_Basic_Requirement_Checker implements WPDesk_Requirement_Checker {
const EXTENSION_NAME_OPENSSL = 'openssl';
const HOOK_ADMIN_NOTICES_ACTION = 'admin_notices';
const PLUGIN_INFO_KEY_NICE_NAME = 'nice_name';
const PLUGIN_INFO_KEY_NAME = 'name';
const PLUGIN_INFO_KEY_REPOSITORY_URL = 'repository_url';
/** @var string */
private $plugin_name;
/** @var string */
......@@ -31,13 +30,13 @@ if (! class_exists('WPDesk_Basic_Requirement_Checker') ) {
/** @var int|null */
private $min_openssl_version = null;
/** @var array */
private $plugin_require;
protected $plugin_require;
/** @var array */
private $module_require;
/** @var array */
private $setting_require;
/** @var array */
private $notices;
protected $notices;
/** @var @string */
private $text_domain;
......@@ -107,18 +106,37 @@ if (! class_exists('WPDesk_Basic_Requirement_Checker') ) {
}
/**
* @param string $plugin_name
* @param string $plugin_name Name in wp format dir/file.php
* @param string $nice_plugin_name Nice plugin name for better looks in notice
*
* @return $this
*/
public function add_plugin_require( $plugin_name, $nice_plugin_name = null ) {
if ( $nice_plugin_name === null ) {
$this->plugin_require[ $plugin_name ] = $plugin_name;
} else {
$this->plugin_require[ $plugin_name ] = $nice_plugin_name;
$this->plugin_require[ $plugin_name ] = array(
self::PLUGIN_INFO_KEY_NAME => $plugin_name,
self::PLUGIN_INFO_KEY_NICE_NAME => $nice_plugin_name === null ? $plugin_name : $nice_plugin_name
);
return $this;
}
/**
* Add plugin to require list. Plugin is from repository so we can ask for installation.
*
* @param string $plugin_name Name in wp format dir/file.php
* @param string $version Required version of the plugin.
* @param string $nice_plugin_name Nice plugin name for better looks in notice
*
* @return $this
*/
public function add_plugin_repository_require( $plugin_name, $version, $nice_plugin_name = null ) {
$this->plugin_require[ $plugin_name ] = array(
self::PLUGIN_INFO_KEY_NAME => $plugin_name,
'version' => $version,
'repository_url' => 'http://downloads.wordpress.org/plugin/' . dirname( $plugin_name ) . '.latest-stable.zip',
self::PLUGIN_INFO_KEY_NICE_NAME => $nice_plugin_name === null ? $plugin_name : $nice_plugin_name
);
return $this;
}
......@@ -248,9 +266,9 @@ if (! class_exists('WPDesk_Basic_Requirement_Checker') ) {
*
* @param int $required_version Version in hex. Version 9.6 is 0x000906000
*
* @return bool
* @see https://www.openssl.org/docs/man1.1.0/crypto/OPENSSL_VERSION_NUMBER.html
*
* @return bool
*/
public static function is_open_ssl_at_least( $required_version ) {
return defined( 'OPENSSL_VERSION_NUMBER' ) && OPENSSL_VERSION_NUMBER > (int) $required_version;
......@@ -263,11 +281,19 @@ if (! class_exists('WPDesk_Basic_Requirement_Checker') ) {
*/
private function append_plugin_require_notices( $notices ) {
if ( count( $this->plugin_require ) > 0 ) {
foreach ( $this->plugin_require as $plugin_name => $nice_plugin_name ) {
if ( ! self::is_wp_plugin_active( $plugin_name ) ) {
$notices[] = $this->prepare_notice_message( sprintf( __( 'The &#8220;%s&#8221; plugin cannot run without %s active. Please install and activate %s plugin.',
foreach ( $this->plugin_require as $plugin_name => $plugin_info ) {
$notice = null;
if ( isset( $plugin_info['repository_url'] ) ) {
$notice = $this->prepare_plugin_repository_require_notice( $plugin_info );
} elseif ( ! self::is_wp_plugin_active( $plugin_name ) ) {
$notice = $this->prepare_notice_message( sprintf( __( 'The &#8220;%s&#8221; plugin cannot run without %s active. Please install and activate %s plugin.',
$this->get_text_domain() ), esc_html( $this->plugin_name ),
esc_html( basename( $nice_plugin_name ) ), esc_html( basename( $nice_plugin_name ) ) ) );
esc_html( basename( $plugin_info[ self::PLUGIN_INFO_KEY_NICE_NAME ] ) ),
esc_html( basename( $plugin_info[ self::PLUGIN_INFO_KEY_NICE_NAME ] ) ) ) );
}
if ( $notice !== null ) {
$notices[] = $notice;
}
}
}
......@@ -276,7 +302,68 @@ if (! class_exists('WPDesk_Basic_Requirement_Checker') ) {
}
/**
* Checks if plugin is active. Needs to be enabled in deferred way.
* Prepares WP install url and injects info about plugin to the WP update engine.
*
* @param array $plugin_info
*
* @return string
*/
private function prepare_plugin_repository_install_url( $plugin_info ) {
$slug = basename( $plugin_info[ self::PLUGIN_INFO_KEY_NAME ] );
$install_url = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $slug ),
'install-plugin_' . $slug );
add_filter( 'plugins_api', function ( $api, $action, $args ) use ( $plugin_info ) {
if ( 'plugin_information' !== $action ||
false !== $api ||
! isset( $args->slug ) ||
'wpdesk-helper' !== $args->slug
) {
return $api;
}
$api = new stdClass();
$api->name = $plugin_info['nice_name']; // self in closures requires 5.4
$api->version = $plugin_info['version']; // self in closures requires 5.4
$api->download_link = esc_url( $plugin_info['repository_url'] ); // self in closures requires 5.4
return $api;
}, 10, 3 );
return $install_url;
}
/**
* @param array $plugin_info Internal required plugin info data.
*
* @return string|null Return null if no notice is needed.
*/
private function prepare_plugin_repository_require_notice( $plugin_info ) {
$name = $plugin_info[ self::PLUGIN_INFO_KEY_NAME ];
$nice_name = $plugin_info[ self::PLUGIN_INFO_KEY_NICE_NAME ];
if ( ! self::is_wp_plugin_installed( $name ) ) {
$install_url = $this->prepare_plugin_repository_install_url( $plugin_info );
return sprintf( wp_kses( __( 'The &#8220;%s&#8221; plugin requires free %s plugin. <a href="%s">Install %s →</a>',
$this->get_text_domain() ), array( 'a' => array( 'href' => array() ) ) ),
$this->plugin_name, $nice_name, esc_url( $install_url ), $nice_name );
}
if ( ! self::is_wp_plugin_active( $name ) ) {
$activate_url = 'plugins.php?action=activate&plugin=' . urlencode( $plugin_info[ self::PLUGIN_INFO_KEY_NAME ] ) . '&plugin_status=all&paged=1&s&_wpnonce=' . urlencode( wp_create_nonce( 'activate-plugin_' . $name ) );
return sprintf( wp_kses( __( 'The &#8220;%s&#8221; plugin activating %s plugin. <a href="%s">Activate %s →</a>',
$this->get_text_domain() ), array( 'a' => array( 'href' => array() ) ) ),
$this->plugin_name, $nice_name, esc_url( admin_url( $activate_url ) ), $nice_name );
}
return null;
}
/**
* Checks if plugin is active. Needs to be used in deferred way.
*
* @param string $plugin_file
*
......@@ -292,6 +379,17 @@ if (! class_exists('WPDesk_Basic_Requirement_Checker') ) {
return in_array( $plugin_file, $active_plugins ) || array_key_exists( $plugin_file, $active_plugins );
}
/**
* Checks if plugin is installed. Needs to be enabled in deferred way.
*
* @param string $plugin_file
*
* @return bool
*/
public static function is_wp_plugin_installed( $plugin_file ) {
return array_key_exists( $plugin_file, get_plugins() );
}
/**
* @param array $notices
*
......@@ -330,7 +428,8 @@ if (! class_exists('WPDesk_Basic_Requirement_Checker') ) {
foreach ( $this->setting_require as $setting => $value ) {
if ( ! self::is_setting_set( $setting, $value ) ) {
$notices[] = $this->prepare_notice_message( sprintf( __( 'The &#8220;%s&#8221; plugin cannot run without %s php setting set to %s. Please contact your host and ask them to set %s.',
$this->get_text_domain() ), esc_html( $this->plugin_name ), esc_html( basename( $setting ) ),
$this->get_text_domain() ), esc_html( $this->plugin_name ),
esc_html( basename( $setting ) ),
esc_html( basename( $value ) ), esc_html( basename( $setting ) ) ) );
}
}
......@@ -377,9 +476,9 @@ if (! class_exists('WPDesk_Basic_Requirement_Checker') ) {
}
/**
* @return void
* @internal Do not use as public. Public only for wp action.
*
* @return void
*/
public function handle_deactivate_action() {
if ( isset( $this->plugin_file ) ) {
......@@ -390,9 +489,9 @@ if (! class_exists('WPDesk_Basic_Requirement_Checker') ) {
/**
* Should be called as WordPress action
*
* @return void
* @internal Do not use as public. Public only for wp action.
*
* @return void
*/
public function handle_render_notices_action() {
foreach ( $this->notices as $notice ) {
......
src/Basic_Requirement_Checker_Factory.php
+ 53
− 16
View file @ 7084c414
......@@ -4,19 +4,56 @@ if ( ! class_exists('Basic_Requirement_Checker')) {
require_once 'Basic_Requirement_Checker.php';
}
class WPDesk_Basic_Requirement_Checker_Factory
{
/**
* @param $plugin_file
* @param $plugin_name
* @param $text_domain
* @param $php_version
* @param $wp_version
* Falicitates createion of requirement checker
*/
class WPDesk_Basic_Requirement_Checker_Factory {
/**
* Creates a simplest possible version of requirement checker.
*
* @param string $plugin_file
* @param string $plugin_name
* @param string $text_domain
* @param string $php_version
* @param string $wp_version
*
* @return WPDesk_Requirement_Checker
*/
public function create_requirement_checker($plugin_file, $plugin_name, $text_domain)
{
public function create_requirement_checker( $plugin_file, $plugin_name, $text_domain ) {
return new WPDesk_Basic_Requirement_Checker( $plugin_file, $plugin_name, $text_domain, null, null );
}
/**
* Creates a requirement checker according to given requirements array info.
*
* @param string $plugin_file
* @param string $plugin_name
* @param string $plugin_text_domain
* @param array $requirements
*
* @return WPDesk_Requirement_Checker
*/
public function create_from_requirement_array( $plugin_file, $plugin_name, $plugin_text_domain, $requirements ) {
$requirements_checker = new WPDesk_Basic_Requirement_Checker(
$plugin_file,
$plugin_name,
$plugin_text_domain,
$requirements['php'],
$requirements['wp']
);
if ( isset( $requirements['plugins'] ) ) {
foreach ( $requirements['plugins'] as $requirement ) {
$requirements_checker->add_plugin_require( $requirement['name'], $requirement['nice_name'] );
}
}
if ( isset( $requirements['modules'] ) ) {
foreach ( $requirements['modules'] as $requirement ) {
$requirements_checker->add_php_module_require( $requirement['name'], $requirement['nice_name'] );
}
}
return $requirements_checker;
}
}
src/Buildable.php deleted 100644 → 0
+ 0
− 11
View file @ b006b922
<?php
/**
* Have info about what class should be built by WPDesk_Builder
*
* have to be compatible with PHP 5.2.x
*/
interface WPDesk_Buildable {
/** @return string */
public function get_class_name();
}
\ No newline at end of file
src/Plugin/Has_Plugin_Info.php deleted 100644 → 0
+ 0
− 29
View file @ b006b922
<?php
if ( ! interface_exists( 'WPDesk_Translatable' ) ) {
require_once __DIR__ . '/../Translatable.php';
}
/**
* Have MUST HAVE info for plugin instantion
*
* have to be compatible with PHP 5.2.x
*/
interface WPDesk_Has_Plugin_Info extends WPDesk_Translatable {
/**
* @return string
*/
public function get_plugin_file_name();
/**
* @return string
*/
public function get_plugin_dir();
/**
* @return string
*/
public function get_version();
}
\ No newline at end of file
src/Plugin/Plugin_Info.php deleted 100644 → 0
+ 0
− 171
View file @ b006b922
<?php
if ( ! interface_exists( 'WPDesk_Translatable' ) ) {
require_once __DIR__ . '/../Translatable.php';
}
if ( ! class_exists( 'WPDesk_Buildable' ) ) {
require_once __DIR__ . '/../Buildable.php';
}
if ( ! class_exists( 'WPDesk_Has_Plugin_Info' ) ) {
require_once 'Has_Plugin_Info.php';
}
/**
* Structure with core info about plugin
*
* have to be compatible with PHP 5.2.x
*/
class WPDesk_Plugin_Info implements WPDesk_Translatable, WPDesk_Buildable, WPDesk_Has_Plugin_Info {
/** @var string */
private $plugin_file_name;
/** @var string */
private $plugin_dir;
/** @var string */
private $plugin_url;
/** @var string */
private $class_name;
/** @var string */
private $version;
/** @var string */
private $product_id;
/** @var string */
private $plugin_name;
/** @var \DateTimeInterface */
private $release_date;
/** string */
private $text_domain;
/**
* @return string
*/
public function get_plugin_file_name() {
return $this->plugin_file_name;
}
/**
* @param string $plugin_name
*/
public function set_plugin_file_name( $plugin_name ) {
$this->plugin_file_name = $plugin_name;
}
/**
* @return string
*/
public function get_plugin_dir() {
return $this->plugin_dir;
}
/**
* @param string $plugin_dir
*/
public function set_plugin_dir( $plugin_dir ) {
$this->plugin_dir = $plugin_dir;
}
/**
* @return string
*/
public function get_plugin_url() {
return $this->plugin_url;
}
/**
* @param string $plugin_url
*/
public function set_plugin_url( $plugin_url ) {
$this->plugin_url = $plugin_url;
}
/**
* @return string
*/
public function get_version() {
return $this->version;
}
/**
* @param string $version
*/
public function set_version( $version ) {
$this->version = $version;
}
/**
* @return string
*/
public function get_product_id() {
return $this->product_id;
}
/**
* @param string $product_id
*/
public function set_product_id( $product_id ) {
$this->product_id = $product_id;
}
/**
* @return string
*/
public function get_plugin_name() {
return $this->plugin_name;
}
/**
* @param string $plugin_name
*/
public function set_plugin_name( $plugin_name ) {
$this->plugin_name = $plugin_name;
}
/**
* @return DateTimeInterface
*/
public function get_release_date() {
return $this->release_date;
}
/**
* @param \DateTimeInterface $release_date
*/
public function set_release_date( $release_date ) {
$this->release_date = $release_date;
}
/**
* @return string
*/
public function get_class_name() {
return $this->class_name;
}
/**
* @param string $class_name
*/
public function set_class_name( $class_name ) {
$this->class_name = $class_name;
}
/**
* @return string
*/
public function get_text_domain() {
return $this->text_domain;
}
/**
* @param $value
*/
public function set_text_domain( $value ) {
$this->text_domain = $value;
}
}
\ No newline at end of file
src/Translable.php deleted 100644 → 0
+ 0
− 9
View file @ b006b922
<?php
/**
* @deprecated Have typo so better use WPDesk_Translatable
*/
interface WPDesk_Translable {
/** @return string */
public function get_text_domain();
}
\ No newline at end of file
src/Translatable.php deleted 100644 → 0
+ 0
− 15
View file @ b006b922
<?php
if ( ! interface_exists( 'WPDesk_Translable' ) ) {
require_once 'Translable.php';
}
/**
* Have info about textdomain - how to translate texts
*
* have to be compatible with PHP 5.2.x
*/
interface WPDesk_Translatable extends WPDesk_Translable {
/** @return string */
public function get_text_domain();
}
\ No newline at end of file
tests/unit/Test_Basic_Requirement_Checker.php
+ 48
− 8
View file @ 7084c414
......@@ -27,7 +27,7 @@ class Test_Basic_Requirement_Checker extends PHPUnit\Framework\TestCase {
}
public function test_php_version_check() {
$known_PHP_versions = [ '7.3', '7.2', '7.1', '7.0', '5.6', '5.5', '5.4', '5.3', '5.2' ];
$known_PHP_versions = array( '7.3', '7.2', '7.1', '7.0', '5.6', '5.5', '5.4', '5.3', '5.2' );
$requirements = $this->create_requirements_for_php_wp(
self::ALWAYS_VALID_PHP_VERSION,
......@@ -55,7 +55,7 @@ class Test_Basic_Requirement_Checker extends PHPUnit\Framework\TestCase {
*
* @return WPDesk_Basic_Requirement_Checker
*/
public function create_requirements_for_php_wp( $php, $wp ) {
private function create_requirements_for_php_wp( $php, $wp ) {
return new WPDesk_Basic_Requirement_Checker( self::RANDOM_PLUGIN_FILE, self::RANDOM_PLUGIN_NAME,
self::RANDOM_PLUGIN_TEXTDOMAIN, $php, $wp );
}
......@@ -98,15 +98,15 @@ class Test_Basic_Requirement_Checker extends PHPUnit\Framework\TestCase {
$not_existing_plugin_name = 'Not exist';
WP_Mock::wpFunction( 'get_option' )
->withArgs( [ 'active_plugins', [] ] )
->andReturn( [ $exising_plugin_name ] );
->withArgs( array( 'active_plugins', array() ) )
->andReturn( array( $exising_plugin_name ) );
WP_Mock::wpFunction( 'is_multisite' )
->andReturn( $multisite );
WP_Mock::wpFunction( 'get_site_option' )
->withArgs( [ 'active_sitewide_plugins', [] ] )
->andReturn( [ $exising_multisite_plugin_name ] );
->withArgs( array( 'active_sitewide_plugins', array() ) )
->andReturn( array( $exising_multisite_plugin_name ) );
$requirements = $this->create_requirements_for_php_wp( self::ALWAYS_VALID_PHP_VERSION,
......@@ -155,7 +155,7 @@ class Test_Basic_Requirement_Checker extends PHPUnit\Framework\TestCase {
self::ALWAYS_VALID_WP_VERSION );
WP_Mock::expectActionAdded( WPDesk_Basic_Requirement_Checker::HOOK_ADMIN_NOTICES_ACTION,
[ $requirements, 'handle_render_notices_action'] );
array( $requirements, 'handle_render_notices_action' ) );
$this->assertFalse( $requirements->are_requirements_met() );
$requirements->disable_plugin();
......@@ -164,4 +164,44 @@ class Test_Basic_Requirement_Checker extends PHPUnit\Framework\TestCase {
$this->expectOutputRegex( '/cannot run on PHP/' );
$requirements->handle_render_notices_action();
}
public function test_add_plugin_repository_require_checks_for_activation_and_installs() {
$random_version = "1.0";
$activated_plugin_name = 'WooCommerce';
$not_activated_plugin_name = "some_other";
$not_installed_plugin_name = "not_installed";
$installed_plugin_names = array( $activated_plugin_name, $not_activated_plugin_name );
WP_Mock::wpFunction( 'get_plugins' )
->andReturn( array_flip( $installed_plugin_names ) );
WP_Mock::wpFunction( 'get_option' )
->withArgs( array( 'active_plugins', array() ) )
->andReturn( array( $activated_plugin_name ) );
WP_Mock::passthruFunction( 'self_admin_url' );
WP_Mock::passthruFunction( 'wp_kses' );
WP_Mock::passthruFunction( 'wp_nonce_url' );
WP_Mock::passthruFunction( 'wp_create_nonce' );
WP_Mock::passthruFunction( 'admin_url' );
$requirements = $this->create_requirements_for_php_wp( self::ALWAYS_VALID_PHP_VERSION,
self::ALWAYS_VALID_WP_VERSION );
$requirements->add_plugin_repository_require( $activated_plugin_name, $random_version );
$this->assertTrue( $requirements->are_requirements_met(), "Should be met for activated plugin" );
$requirements->add_plugin_repository_require( $not_activated_plugin_name, $random_version );
$this->assertFalse( $requirements->are_requirements_met(), "Should NOT be met for only installed plugin" );
$this->expectOutputRegex( "/Activate $not_activated_plugin_name/" );
$requirements->handle_render_notices_action();
$requirements->add_plugin_repository_require( $not_installed_plugin_name, $random_version );
$this->expectOutputRegex( "/Install $not_installed_plugin_name/" );
$this->assertFalse( $requirements->are_requirements_met(),
"Should NOT be met - uninstalled and unactive plugins are required" );
$requirements->handle_render_notices_action();
}
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment