430 lines
13 KiB
PHP
430 lines
13 KiB
PHP
<?php
|
||
|
||
/**
|
||
* 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 MonsterInsights_AM_Deactivation_Survey {
|
||
/**
|
||
* The API URL we are calling.
|
||
*
|
||
* If `AWESOMEMOTIVE_DEV_MODE` is set to true then
|
||
*
|
||
* @since 9.4.0
|
||
* @var string
|
||
*/
|
||
public $api_url;
|
||
|
||
/**
|
||
* Name for this plugin.
|
||
*
|
||
* @since 9.4.0
|
||
* @var string
|
||
*/
|
||
public $name;
|
||
|
||
/**
|
||
* Unique slug for this plugin.
|
||
*
|
||
* @since 9.4.0
|
||
* @var string
|
||
*/
|
||
public $plugin;
|
||
|
||
/**
|
||
* Primary class constructor.
|
||
*
|
||
* @since 9.4.0
|
||
* @param string $url Endpoint for this instance of the survey.
|
||
* @param string $name Plugin name.
|
||
* @param string $plugin Plugin slug.
|
||
*/
|
||
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 9.4.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_attr($this->plugin); ?>"] span.deactivate a'),
|
||
$overlay = $('#am-deactivate-survey-<?php echo esc_attr($this->plugin); ?>'),
|
||
$form = $overlay.find('form'),
|
||
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_attr($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();
|
||
});
|
||
// 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();
|
||
|
||
// Check if option 3 is selected
|
||
if ($(this).val() === '3') {
|
||
// Remove existing reason description elements if they exist
|
||
$form.find('.reason-description-container').remove();
|
||
|
||
// Create and append the reason description elements
|
||
var reasonDescriptionHtml = '<div class="reason-description-container">' +
|
||
'<input type="text" id="reason_description" name="reason_description" class="am-deactivate-survey-option-details" placeholder="We\'re sorry to hear. Can you let us know what didn\'t work?" />' +
|
||
'</div>';
|
||
$(this).closest('.am-deactivate-survey-option').append(reasonDescriptionHtml);
|
||
$form.find('#reason_description').show();
|
||
} else {
|
||
// Hide reason description if other option is selected
|
||
$form.find('.reason-description-container').remove();
|
||
}
|
||
});
|
||
// Survey Skip & Deactivate.
|
||
$form.on('click', '.am-deactivate-survey-deactivate', function(event) {
|
||
event.preventDefault();
|
||
location.href = $deactivateLink.attr('href');
|
||
});
|
||
// Survey close button.
|
||
$form.on('click', '.am-deactivate-survey-close', function(event) {
|
||
event.preventDefault();
|
||
$overlay.hide();
|
||
formOpen = false;
|
||
$deactivateLink.focus();
|
||
});
|
||
// Survey submit.
|
||
$form.submit(function(event) {
|
||
event.preventDefault();
|
||
if (! $form.find('input[type=radio]:checked').val()) {
|
||
$form.find('.am-deactivate-survey-footer').prepend('<span class="error"><?php echo esc_js( __( 'Please select an option', 'google-analytics-for-wordpress' ) ); ?></span>');
|
||
return;
|
||
}
|
||
|
||
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 9.4.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;
|
||
width: 30px;
|
||
height: 30px;
|
||
background: none;
|
||
border: none;
|
||
font-size: 18px;
|
||
font-weight: bold;
|
||
color: #999;
|
||
cursor: pointer;
|
||
line-height: 1;
|
||
padding: 0;
|
||
}
|
||
.am-deactivate-survey-close:hover {
|
||
color: #333;
|
||
}
|
||
.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 9.4.0
|
||
*/
|
||
public function modal() {
|
||
|
||
if ( ! $this->is_plugin_page() ) {
|
||
return;
|
||
}
|
||
|
||
$options = array(
|
||
1 => array(
|
||
'title' => esc_html__( 'I no longer need the plugin', 'google-analytics-for-wordpress' ),
|
||
),
|
||
2 => array(
|
||
'title' => esc_html__( 'I\'m switching to a different plugin', 'google-analytics-for-wordpress' ),
|
||
'details' => esc_html__( 'Please share which plugin', 'google-analytics-for-wordpress' ),
|
||
),
|
||
3 => array(
|
||
'title' => esc_html__( 'I couldn\'t get the plugin to work', 'google-analytics-for-wordpress' ),
|
||
),
|
||
4 => array(
|
||
'title' => esc_html__( 'It\'s a temporary deactivation', 'google-analytics-for-wordpress' ),
|
||
),
|
||
5 => array(
|
||
'title' => esc_html__( 'Other', 'google-analytics-for-wordpress' ),
|
||
'details' => esc_html__( 'Please share the reason', 'google-analytics-for-wordpress' ),
|
||
),
|
||
);
|
||
?>
|
||
<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">
|
||
<button type="button" class="am-deactivate-survey-close" aria-label="<?php echo esc_attr__( 'Close', 'google-analytics-for-wordpress' ); ?>">×</button>
|
||
<span class="am-deactivate-survey-title"><span class="dashicons dashicons-testimonial"></span><?php echo ' ' . esc_html__( 'Quick Feedback', 'google-analytics-for-wordpress' ); ?></span>
|
||
<span class="am-deactivate-survey-desc"><?php printf( esc_html__( 'If you have a moment, please share why you are deactivating %s:', 'google-analytics-for-wordpress' ), $this->name ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- false positive ?></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 printf( esc_html__( 'Submit %s Deactivate', 'google-analytics-for-wordpress' ), '&' ); ?></button>
|
||
<a href="#" class="am-deactivate-survey-deactivate"><?php printf( esc_html__( 'Skip %s Deactivate', 'google-analytics-for-wordpress' ), '&' ); ?></a>
|
||
</div>
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<?php
|
||
} // end modal()
|
||
}
|