432 lines
12 KiB
PHP
432 lines
12 KiB
PHP
<?php
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Awesome Motive Deactivation Survey.
|
|
*
|
|
* This prompts the user for more details when they deactivate the plugin.
|
|
*
|
|
* @version 2.0.0
|
|
* @package AwesomeMotive
|
|
* @author Jared Atchison and Chris Christoff and Tom McFarlin
|
|
* @license GPL-2.0+
|
|
* @copyright Copyright (c) 2018 - 2024
|
|
*/
|
|
|
|
/**
|
|
* This class is used to prompt users for feedback when they deactivate
|
|
* a plugin.
|
|
*
|
|
* NOTE
|
|
* - Review the README for more information on how to use this class.
|
|
* - Prefix this class with something unique to the property in which it runs.
|
|
*/
|
|
class UserFeedback_AM_Deactivation_Survey {
|
|
/**
|
|
* The API URL we are calling.
|
|
*
|
|
* If `AWESOMEMOTIVE_DEV_MODE` is set to true then
|
|
*
|
|
* @since 1.5.0
|
|
* @var string
|
|
*/
|
|
public $api_url;
|
|
|
|
/**
|
|
* Name for this plugin.
|
|
*
|
|
* @since 1.5.0
|
|
* @var string
|
|
*/
|
|
public $name;
|
|
|
|
/**
|
|
* Unique slug for this plugin.
|
|
*
|
|
* @since 1.5.0
|
|
* @var string
|
|
*/
|
|
public $plugin;
|
|
|
|
/**
|
|
* Primary class constructor.
|
|
*
|
|
* @since 1.5.0
|
|
* @param string $name Plugin name.
|
|
* @param string $plugin Plugin slug.
|
|
* @param string $url Endpoint for this instance of the survey.
|
|
*/
|
|
public function __construct( $url, $name = '', $plugin = '' ) {
|
|
$this->name = $name;
|
|
$this->plugin = $plugin;
|
|
$this->api_url = filter_var( $url, FILTER_VALIDATE_URL );
|
|
|
|
if ( empty( $this->api_url ) ) {
|
|
return;
|
|
}
|
|
|
|
// Don't run deactivation survey on dev sites.
|
|
if ( $this->is_dev_url() ) {
|
|
return;
|
|
}
|
|
|
|
add_action( 'admin_print_scripts', array( $this, 'js' ), 20 );
|
|
add_action( 'admin_print_scripts', array( $this, 'css' ) );
|
|
add_action( 'admin_footer', array( $this, 'modal' ) );
|
|
}
|
|
|
|
/**
|
|
* Checks if current site is a development one.
|
|
*
|
|
* @since 1.2.0
|
|
* @return bool
|
|
*/
|
|
public function is_dev_url() {
|
|
// If it is an AM dev site, return false, so we can see them on our dev sites.
|
|
if ( defined( 'AWESOMEMOTIVE_DEV_MODE' ) && AWESOMEMOTIVE_DEV_MODE ) {
|
|
return false;
|
|
}
|
|
|
|
$url = network_site_url( '/' );
|
|
$is_local_url = false;
|
|
|
|
// Trim it up.
|
|
$url = strtolower( trim( $url ) );
|
|
|
|
// Need to get the host...so let's add the scheme so we can use parse_url.
|
|
if ( false === strpos( $url, 'http://' ) && false === strpos( $url, 'https://' ) ) {
|
|
$url = 'http://' . $url;
|
|
}
|
|
$url_parts = wp_parse_url( $url );
|
|
$host = ! empty( $url_parts['host'] ) ? $url_parts['host'] : false;
|
|
|
|
if ( ! empty( $url ) && ! empty( $host ) ) {
|
|
if ( false !== ip2long( $host ) ) {
|
|
if ( ! filter_var( $host, FILTER_VALIDATE_IP, FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE ) ) {
|
|
$is_local_url = true;
|
|
}
|
|
} elseif ( 'localhost' === $host ) {
|
|
$is_local_url = true;
|
|
}
|
|
|
|
$tlds_to_check = array( '.dev', '.local', ':8888' );
|
|
foreach ( $tlds_to_check as $tld ) {
|
|
if ( false !== strpos( $host, $tld ) ) {
|
|
$is_local_url = true;
|
|
continue;
|
|
}
|
|
}
|
|
|
|
if ( substr_count( $host, '.' ) > 1 ) {
|
|
$subdomains_to_check = array( 'dev.', '*.staging.', 'beta.', 'test.' );
|
|
foreach ( $subdomains_to_check as $subdomain ) {
|
|
$subdomain = str_replace( '.', '(.)', $subdomain );
|
|
$subdomain = str_replace( array( '*', '(.)' ), '(.*)', $subdomain );
|
|
if ( preg_match( '/^(' . $subdomain . ')/', $host ) ) {
|
|
$is_local_url = true;
|
|
continue;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $is_local_url;
|
|
} // end is_dev_url()
|
|
|
|
/**
|
|
* Checks if current admin screen is the plugins page.
|
|
*
|
|
* @since 1.0.0
|
|
* @return bool
|
|
*/
|
|
public function is_plugin_page() {
|
|
$screen =
|
|
function_exists( 'get_current_screen' ) ? get_current_screen() : false;
|
|
if ( empty( $screen ) ) {
|
|
return false;
|
|
}
|
|
return (
|
|
! empty( $screen->id ) &&
|
|
in_array(
|
|
$screen->id,
|
|
array( 'plugins', 'plugins-network' ),
|
|
true
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Survey javascript.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
public function js() {
|
|
|
|
if ( ! $this->is_plugin_page() ) {
|
|
return;
|
|
}
|
|
|
|
?>
|
|
<script type="text/javascript">
|
|
(function($) {
|
|
$(function() {
|
|
var $deactivateLink = $('#the-list').find('[data-slug="<?php echo esc_js( $this->plugin ); ?>"] span.deactivate a'),
|
|
$overlay = $('#am-deactivate-survey-<?php echo esc_js( $this->plugin ); ?>'),
|
|
$form = $overlay.find('form'),
|
|
$closeButton = $overlay.find('#am-deactivate-survey-close'),
|
|
formOpen = false;
|
|
|
|
/* For backwards compatibility, we'll need to check to see if
|
|
* we're able to get the deactivation link in the traditional
|
|
* way.
|
|
*
|
|
* If not, we'll do it this way.
|
|
*/
|
|
if (0 === $deactivateLink.length) {
|
|
$deactivateLink = $('#deactivate-<?php echo esc_js( $this->plugin ); ?>');
|
|
}
|
|
|
|
// Plugin listing table deactivate link.
|
|
$deactivateLink.on('click', function(event) {
|
|
event.preventDefault();
|
|
$overlay.css('display', 'table');
|
|
formOpen = true;
|
|
$form.find('.am-deactivate-survey-option:first-of-type input[type=radio]').focus();
|
|
});
|
|
// Close deactivation modal
|
|
$closeButton.on('click', function(event) {
|
|
event.preventDefault();
|
|
$overlay.hide();
|
|
formOpen = false;
|
|
$deactivateLink.focus();
|
|
});
|
|
// Survey radio option selected.
|
|
$form.on('change', 'input[type=radio]', function(event) {
|
|
event.preventDefault();
|
|
$form.find('input[type=text], .error').hide();
|
|
$form.find('.am-deactivate-survey-option').removeClass('selected');
|
|
$(this).closest('.am-deactivate-survey-option').addClass('selected').find('input[type=text]').show();
|
|
});
|
|
// Survey Skip & Deactivate.
|
|
$form.on('click', '.am-deactivate-survey-deactivate', function(event) {
|
|
event.preventDefault();
|
|
location.href = $deactivateLink.attr('href');
|
|
});
|
|
// Survey submit.
|
|
$form.submit(function(event) {
|
|
event.preventDefault();
|
|
if (! $form.find('input[type=radio]:checked').val()) {
|
|
// Clear any existing error messages before adding new one
|
|
$form.find('.am-deactivate-survey-footer .error').remove();
|
|
$form.find('.am-deactivate-survey-footer').prepend('<span class="error"><?php echo esc_js( __( 'Please select an option', 'userfeedback-lite' ) ); ?></span>');
|
|
return;
|
|
}
|
|
|
|
var $submitButton = $form.find('.am-deactivate-survey-submit');
|
|
|
|
// Disable the submit button to prevent multiple clicks
|
|
if ($submitButton.prop('disabled')) {
|
|
return;
|
|
}
|
|
|
|
$submitButton.prop('disabled', true);
|
|
$submitButton.css('opacity', '0.6');
|
|
|
|
var data = {
|
|
code: $form.find('.selected input[type=radio]').val(),
|
|
reason: $form.find('.selected .am-deactivate-survey-option-reason').text(),
|
|
details: $form.find('.selected input[type=text]').val(),
|
|
site: '<?php echo esc_url( home_url() ); ?>',
|
|
plugin: '<?php echo sanitize_key( $this->name ); ?>'
|
|
}
|
|
|
|
var submitSurvey = $.post(
|
|
'<?php echo esc_url( $this->api_url ); ?>',
|
|
data
|
|
);
|
|
submitSurvey.always(function() {
|
|
location.href = $deactivateLink.attr('href');
|
|
});
|
|
});
|
|
// Exit key closes survey when open.
|
|
$(document).keyup(function(event) {
|
|
if (27 === event.keyCode && formOpen) {
|
|
$overlay.hide();
|
|
formOpen = false;
|
|
$deactivateLink.focus();
|
|
}
|
|
});
|
|
});
|
|
})(jQuery);
|
|
</script>
|
|
<?php
|
|
} // end js()
|
|
|
|
/**
|
|
* Survey CSS.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
public function css() {
|
|
|
|
if ( ! $this->is_plugin_page() ) {
|
|
return;
|
|
}
|
|
?>
|
|
<style type="text/css">
|
|
.am-deactivate-survey-modal {
|
|
display: none;
|
|
table-layout: fixed;
|
|
position: fixed;
|
|
z-index: 9999;
|
|
width: 100%;
|
|
height: 100%;
|
|
text-align: center;
|
|
font-size: 14px;
|
|
top: 0;
|
|
left: 0;
|
|
background: rgba(0,0,0,0.8);
|
|
}
|
|
.am-deactivate-survey-wrap {
|
|
display: table-cell;
|
|
vertical-align: middle;
|
|
}
|
|
.am-deactivate-survey {
|
|
background-color: #fff;
|
|
max-width: 550px;
|
|
margin: 0 auto;
|
|
padding: 30px;
|
|
text-align: left;
|
|
position: relative;
|
|
}
|
|
#am-deactivate-survey-close {
|
|
position: absolute;
|
|
top: 15px;
|
|
right: 15px;
|
|
cursor: pointer;
|
|
}
|
|
.am-deactivate-survey .error {
|
|
display: block;
|
|
color: red;
|
|
margin: 0 0 10px 0;
|
|
}
|
|
.am-deactivate-survey-title {
|
|
display: block;
|
|
font-size: 18px;
|
|
font-weight: 700;
|
|
text-transform: uppercase;
|
|
border-bottom: 1px solid #ddd;
|
|
padding: 0 0 18px 0;
|
|
margin: 0 0 18px 0;
|
|
}
|
|
.am-deactivate-survey-title span {
|
|
color: #999;
|
|
margin-right: 10px;
|
|
}
|
|
.am-deactivate-survey-desc {
|
|
display: block;
|
|
font-weight: 600;
|
|
margin: 0 0 18px 0;
|
|
}
|
|
.am-deactivate-survey-option {
|
|
margin: 0 0 10px 0;
|
|
}
|
|
.am-deactivate-survey-option-input {
|
|
margin-right: 10px !important;
|
|
}
|
|
.am-deactivate-survey-option-details {
|
|
display: none;
|
|
width: 90%;
|
|
margin: 10px 0 0 30px;
|
|
}
|
|
.am-deactivate-survey-footer {
|
|
margin-top: 18px;
|
|
}
|
|
.am-deactivate-survey-deactivate {
|
|
float: right;
|
|
font-size: 13px;
|
|
color: #ccc;
|
|
text-decoration: none;
|
|
padding-top: 7px;
|
|
}
|
|
</style>
|
|
<?php
|
|
} // end css()
|
|
|
|
/**
|
|
* Survey modal.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
public function modal() {
|
|
|
|
if ( ! $this->is_plugin_page() ) {
|
|
return;
|
|
}
|
|
|
|
$options = array(
|
|
1 => array(
|
|
'title' => esc_html__( 'I no longer need the plugin', 'userfeedback-lite' ),
|
|
),
|
|
2 => array(
|
|
'title' => esc_html__( 'I\'m switching to a different plugin', 'userfeedback-lite' ),
|
|
'details' => esc_html__( 'Please share which plugin', 'userfeedback-lite' ),
|
|
),
|
|
3 => array(
|
|
'title' => esc_html__( 'I couldn\'t get the plugin to work', 'userfeedback-lite' ),
|
|
'details' => esc_html__( 'We\'re sorry to hear. Can you let us know what didn\'t work?', 'userfeedback-lite' ),
|
|
),
|
|
4 => array(
|
|
'title' => esc_html__( 'It\'s a temporary deactivation', 'userfeedback-lite' ),
|
|
),
|
|
5 => array(
|
|
'title' => esc_html__( 'Other', 'userfeedback-lite' ),
|
|
'details' => esc_html__( 'Please share the reason', 'userfeedback-lite' ),
|
|
),
|
|
);
|
|
?>
|
|
<div class="am-deactivate-survey-modal" id="am-deactivate-survey-<?php echo esc_attr( $this->plugin ); ?>">
|
|
<div class="am-deactivate-survey-wrap">
|
|
<form class="am-deactivate-survey" method="post">
|
|
<span id="am-deactivate-survey-close">
|
|
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
<path d="M18 6L6 18" stroke="#C4C4C4" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
|
|
<path d="M6 6L18 18" stroke="#C4C4C4" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
|
|
</svg>
|
|
</span>
|
|
<span class="am-deactivate-survey-title"><span class="dashicons dashicons-testimonial"></span><?php echo ' ' . esc_html__( 'Quick Feedback', 'userfeedback-lite' ); ?></span>
|
|
<span class="am-deactivate-survey-desc"><?php
|
|
// translators: %s is the plugin name.
|
|
printf( esc_html__( 'If you have a moment, please share why you are deactivating %s:', 'userfeedback-lite' ), esc_html( $this->name ) );
|
|
?></span>
|
|
<div class="am-deactivate-survey-options">
|
|
<?php foreach ( $options as $id => $option ) : ?>
|
|
<div class="am-deactivate-survey-option">
|
|
<label for="am-deactivate-survey-option-<?php echo esc_attr( $this->plugin ); ?>-<?php echo esc_attr( $id ); ?>" class="am-deactivate-survey-option-label">
|
|
<input id="am-deactivate-survey-option-<?php echo esc_attr( $this->plugin ); ?>-<?php echo esc_attr( $id ); ?>" class="am-deactivate-survey-option-input" type="radio" name="code" value="<?php echo esc_attr( $id ); ?>" />
|
|
<span class="am-deactivate-survey-option-reason"><?php echo esc_html( $option['title'] ); ?></span>
|
|
</label>
|
|
<?php if ( ! empty( $option['details'] ) ) : ?>
|
|
<input class="am-deactivate-survey-option-details" type="text" placeholder="<?php echo esc_attr( $option['details'] ); ?>" />
|
|
<?php endif; ?>
|
|
</div>
|
|
<?php endforeach; ?>
|
|
</div>
|
|
<div class="am-deactivate-survey-footer">
|
|
<button type="submit" class="am-deactivate-survey-submit button button-primary button-large"><?php
|
|
// translators: %s is an ampersand symbol.
|
|
printf( esc_html__( 'Submit %s Deactivate', 'userfeedback-lite' ), '&' );
|
|
?></button>
|
|
<a href="#" class="am-deactivate-survey-deactivate"><?php
|
|
// translators: %s is an ampersand symbol.
|
|
printf( esc_html__( 'Skip %s Deactivate', 'userfeedback-lite' ), '&' );
|
|
?></a>
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<?php
|
|
} // end modal()
|
|
}
|