Mini Shell
<?php
/**
* Adds a section with Upgrade nudges to the Status Report page
*
* @package jetpack
*/
use Automattic\Jetpack\Connection\Manager;
use Automattic\Jetpack\Jetpack_CRM_Data;
use Automattic\Jetpack\Plugins_Installer;
use Automattic\Jetpack\Redirect;
use Automattic\Jetpack\Tracking;
/**
* Class that adds a new section to the Stats Report page
*/
class Jetpack_Stats_Upgrade_Nudges {
/**
* Indicates whether the class initialized or not
*
* @var bool
*/
private static $initialized = false;
/**
* Initialize the class by registering the action
*
* @return void
*/
public static function init() {
if ( ! self::$initialized ) {
self::$initialized = true;
add_action( 'jetpack_admin_pages_wrap_ui_after_callback', array( __CLASS__, 'render' ) );
}
}
/**
* Unsets the collapse nudges setting.
*/
public static function unset_nudges_setting() {
$stats_options = get_option( 'stats_options' );
if ( $stats_options ) {
unset( $stats_options['collapse_nudges'] );
update_option( 'stats_options', $stats_options );
}
}
/**
* Determines whether Backup is active
*
* @return boolean
*/
private static function is_backup_active() {
$rewind_data = Jetpack_Core_Json_Api_Endpoints::rewind_data();
return is_object( $rewind_data ) && isset( $rewind_data->state ) && 'unavailable' !== $rewind_data->state;
}
/**
* Checks if a plugin is installed.
*
* @param string $plugin_file The plugin filename.
* @return boolean
*/
private static function is_plugin_installed( $plugin_file ) {
$plugins = Plugins_Installer::get_plugins();
return isset( $plugins[ $plugin_file ] );
}
/**
* Checks if a plugin is active.
*
* @param string $plugin_file The plugin filename.
* @return boolean
*/
private static function is_plugin_active( $plugin_file ) {
$plugins = Plugins_Installer::get_plugins();
return isset( $plugins[ $plugin_file ] ) && isset( $plugins[ $plugin_file ]['active'] ) && $plugins[ $plugin_file ]['active'];
}
/**
* Determines whether Scan is active
*
* @return boolean
*/
private static function is_scan_active() {
$scan_data = Jetpack_Core_Json_Api_Endpoints::scan_state();
return is_object( $scan_data ) && isset( $scan_data->state ) && 'unavailable' !== $scan_data->state;
}
/**
* Determines whether Search module is active
*
* @return boolean
*/
private static function is_search_active() {
return Jetpack::is_module_active( 'search' );
}
/**
* Determines whether the Site is on a Security Plan. It will also return true if site has backup, scan and akismet.
*
* @return boolean
*/
private static function has_security_plan() {
$plan_data = Jetpack_Plan::get();
if ( is_array( $plan_data ) && isset( $plan_data['product_slug'] ) ) {
$has_plan = wp_startswith( $plan_data['product_slug'], 'jetpack_security' );
return (
$has_plan || (
self::is_backup_active() &&
self::is_scan_active() &&
self::is_akismet_active()
)
);
}
return false;
}
/**
* Determines whether the Site is on the Complete Plan.
*
* @return boolean
*/
private static function has_complete_plan() {
$plan_data = Jetpack_Plan::get();
if ( is_array( $plan_data ) && isset( $plan_data['product_slug'] ) ) {
return wp_startswith( $plan_data['product_slug'], 'jetpack_complete' );
}
return false;
}
/**
* Determines whether the Site has a specific product.
*
* @param string $target_product_slug The product slug we are looking for.
*
* @return boolean
*/
private static function has_product( $target_product_slug ) {
$site_products_slugs = array_column( Jetpack_Plan::get_products(), 'product_slug' );
foreach ( $site_products_slugs as $product_slug ) {
if ( wp_startswith( $product_slug, $target_product_slug ) ) {
return true;
}
}
return false;
}
/**
* Determines whether Akismet is active
*
* @return boolean
*/
private static function is_akismet_active() {
return Jetpack::is_akismet_active();
}
/**
* Outputs the header of the Upgrade Secion
*
* @return void
*/
private static function print_header() {
if ( self::has_security_plan() ) {
// translators: %s is the Site Name.
$title = __( 'Performance and growth tools for %s', 'jetpack' );
} else {
// translators: %s is the Site Name.
$title = __( 'Security, performance, and growth tools for %s', 'jetpack' );
}
$title = sprintf( $title, get_bloginfo( 'site_name' ) );
$aria_expanded = 'true';
$postbox_closed = '';
$stats_options = get_option( 'stats_options' );
if ( isset( $stats_options['collapse_nudges'] ) && $stats_options['collapse_nudges'] ) {
$aria_expanded = 'false';
$postbox_closed = ' closed';
}
?>
<div id="jp-stats-report-upgrade-wrap">
<div class="meta-box-sortables">
<div class="postbox<?php echo esc_attr( $postbox_closed ); ?>">
<div class="dops-card dops-section-header is-compact jp-stats-report-upgrade-header">
<div class="dops-section-header__label">
<span class="dops-section-header__label-text">
<?php echo esc_html( $title ); ?>
</span>
</div>
<div class="dops-section-header__actions handle-actions hide-if-no-js">
<button type="button" id="stats_nudges_toggle" class="handlediv" aria-expanded="<?php echo esc_attr( $aria_expanded ); ?>">
<span class="screen-reader-text">Toggle Upgrade Nudges</span>
<span class="toggle-indicator" aria-hidden="true"></span>
</button>
</div>
</div>
<div class="inside">
<?php
}
/**
* Outputs the footer of the Upgrade Section
*
* @return void
*/
private static function print_footer() {
?>
</div>
</div>
</div>
</div>
<?php
}
/**
* Outputs the custom css rules of the Upgrade Section
*
* @return void
*/
private static function print_styles() {
?>
<style>
.dops-section-header.dops-card.jp-stats-report-upgrade-header {
font-weight: bold;
box-shadow: none;
flex-wrap: nowrap;
}
#jp-stats-report-upgrade-wrap .dops-section-header__label-text {
white-space: normal;
}
#stats_nudges_toggle {
height: 100%;
}
.dops-banner.dops-card.is-product.jp-stats-report-upgrade-item {
margin-bottom: 0px;
border-left: 0px;
box-shadow: none;
border-top: 1px solid #c3c4c7;
padding: 12px 24px;
}
.dops-banner.dops-card.jp-stats-report-upgrade-item.jp-stats-report-upgrade-subitem {
margin-left: 72px;
padding-left: 0px;
}
.jp-stats-report-upgrade-item .dops-banner__action {
margin-right: 0px;
}
#jp-stats-report-upgrade-wrap .dops-card::after {
content: "";
}
.jp-stats-report-upgrade-item .dops-banner__title p {
margin: 5px 0 0 0;
font-weight: normal;
}
#jp-stats-report-upgrade-wrap .postbox {
background-color: white;
border: 1px solid #c3c4c7;
margin-bottom: 0;
}
#jp-stats-report-upgrade-wrap .postbox .inside {
padding: 0;
}
</style>
<?php
}
/**
* Add a script which handles collapse/expansion of the nudge UI.
*/
private static function print_script() {
?>
<script>
(function(window, document, undefined){
window.onload = set_up_click_handler;
const stats_wrap = document.getElementById( 'jp-stats-wrap' );
stats_wrap.addEventListener( 'stats-loaded', function () {
const stat_chart = document.getElementById( 'statchart' );
if ( stat_chart === null ) {
document.getElementById( 'stats_nudges_toggle' ).style.display = 'none';
}
});
function set_up_click_handler(){
document.getElementById( 'stats_nudges_toggle' ).onclick = function () {
const collapseValue = 'true' === this.getAttribute( 'aria-expanded' );
fetch( '/wp-json/jetpack/v4/settings', {
method: 'post',
body: JSON.stringify( { collapse_nudges: collapseValue } ),
headers: {
'X-WP-Nonce': "<?php echo esc_js( wp_create_nonce( 'wp_rest' ) ); ?>",
'Content-type': 'application/json' }
} );
};
}
})(window, document, undefined);
</script>
<?php
}
/**
* Gets the upgrade Redirect link
*
* @param string $source The source of the redirect link.
* @return string
*/
private static function get_upgrade_link( $source ) {
$args = array();
if ( ! ( new Manager( 'jetpack' ) )->has_connected_owner() ) {
$args['query'] = 'unlinked=1';
}
return Redirect::get_url( $source, $args );
}
/**
* Gets the product description link.
*
* @param string $product_key The product key of the product we wish to display.
* @return string
*/
private static function get_product_description_link( $product_key ) {
return Jetpack::admin_url( array( 'page' => sprintf( 'jetpack#/product/%s', $product_key ) ) );
}
/**
* Tracks an event in Tracks
*
* @param string $event_name The event name.
* @return void
*/
private static function track_event( $event_name ) {
$connection_manager = new Manager( 'jetpack' );
$tracking = new Tracking( 'jetpack', $connection_manager );
$tracking->record_user_event(
$event_name,
array(
'has_connected_owner' => $connection_manager->has_connected_owner(),
)
);
}
/**
* Outputs one Upgrade item
*
* @param string $title The title of the item.
* @param string $text The description of the item.
* @param string $icon The path of the icon, relative to Jetpack images folder.
* @param string $link The link of the button.
* @param string $tracks_id The id used to identify the tracks events. Automatically prefixed with "jetpack_stats_nudges_{view|click|learn_more}_".
* @param string $learn_more_link The target of the "Learn more" link.
* @param boolean $subitem Whether it is a subitem or not.
* @param string $button_label The button label.
* @return void
*/
private static function print_item( $title, $text, $icon, $link, $tracks_id, $learn_more_link, $subitem = false, $button_label = null ) {
$additional_classes = $subitem ? 'jp-stats-report-upgrade-subitem' : '';
$button_class = $subitem ? 'is-secondary' : 'is-primary';
$icon_url = plugins_url( '', JETPACK__PLUGIN_FILE ) . '/images/products/' . $icon;
$button_label = $button_label === null ? __( 'Upgrade', 'jetpack' ) : $button_label;
$view_event = "stats_nudges_view_$tracks_id";
$click_event = "stats_nudges_click_$tracks_id";
$learn_more_event = "stats_nudges_learn_more_$tracks_id";
self::track_event( $view_event );
?>
<div class="dops-card dops-banner has-call-to-action is-product jp-stats-report-upgrade-item <?php echo esc_attr( $additional_classes ); ?>">
<div class="dops-banner__icon-plan">
<img src="<?php echo esc_attr( $icon_url ); ?>" alt="" width="32" height="32">
</div>
<div class="dops-banner__content">
<div class="dops-banner__info">
<div class="dops-banner__title">
<?php echo esc_html( $title ); ?>
<p>
<?php echo esc_html( $text ); ?>
<a href="<?php echo esc_attr( $learn_more_link ); ?>" class="jptracks" target="_blank" rel="noopener noreferrer" data-jptracks-name="<?php echo esc_attr( $learn_more_event ); ?>">
<?php esc_html_e( 'Learn more', 'jetpack' ); ?>
</a>
</p>
</div>
</div>
<div class="dops-banner__action">
<a href="<?php echo esc_attr( $link ); ?>" type="button" class="jptracks dops-button is-compact <?php echo esc_attr( $button_class ); ?>" data-jptracks-name="<?php echo esc_attr( $click_event ); ?>">
<?php echo esc_html( $button_label ); ?>
</a>
</div>
</div>
</div>
<?php
}
/**
* Prints the Security item
*
* @return void
*/
private static function print_security() {
$link = self::get_product_description_link( 'security' );
$learn_link = self::get_upgrade_link( 'stats-nudges-security-learn' );
$text = __( 'Comprehensive protection for your site, including Backup, Scan, and Anti-spam.', 'jetpack' );
self::print_item( _x( 'Security', 'Jetpack product name', 'jetpack' ), $text, 'product-jetpack-security-bundle.svg', $link, 'security', $learn_link );
}
/**
* Prints the Backup item
*
* @return void
*/
private static function print_backup() {
$link = self::get_product_description_link( 'backup' );
$learn_link = self::get_upgrade_link( 'stats-nudges-backup-learn' );
$text = __( 'Save every change and get back online quickly with one-click restores.', 'jetpack' );
self::print_item( __( 'VaultPress Backup', 'jetpack' ), $text, 'product-jetpack-backup.svg', $link, 'backup', $learn_link, true );
}
/**
* Prints the Scan item
*
* @since 10.1
* @since 10.3 The scan nudge has been removed, but leaving this here in case we reverse course.
*
* @todo Remove this function is not used ~6 months.
*
* @return void
*/
private static function print_scan() {
$link = self::get_product_description_link( 'scan' );
$learn_link = self::get_upgrade_link( 'stats-nudges-scan-learn' );
$text = __( 'Stay ahead of security threats with automated scanning and one-click fixes.', 'jetpack' );
self::print_item( __( 'Scan', 'jetpack' ), $text, 'product-jetpack-scan.svg', $link, 'scan', $learn_link, true );
}
/**
* Prints the Akismet item
*
* @since 10.1
* @since 10.3 The anti-spam nudge has been removed, but leaving this here in case we reverse course.
*
* @todo Remove this function is not used ~6 months.
*
* @return void
*/
private static function print_akismet() {
$link = self::get_product_description_link( 'akismet' );
$learn_link = self::get_upgrade_link( 'stats-nudges-akismet-learn' );
$text = __( 'Automatically clear spam from comments and forms.', 'jetpack' );
self::print_item( __( 'Akismet Anti-spam', 'jetpack' ), $text, 'product-jetpack-anti-spam.svg', $link, 'akismet', $learn_link, true );
}
/**
* Prints the Search item
*
* @return void
*/
private static function print_search() {
$link = self::get_product_description_link( 'search' );
$learn_link = self::get_upgrade_link( 'stats-nudges-search-learn' );
$text = __( 'Help your site visitors instantly find what they\'re looking for so they read and buy more.', 'jetpack' );
self::print_item( __( 'Search', 'jetpack' ), $text, 'product-jetpack-search.svg', $link, 'search', $learn_link );
}
/**
* Prints the VideoPress item
*
* @return void
*/
private static function print_videopress() {
$link = self::get_product_description_link( 'videopress' );
$learn_link = self::get_upgrade_link( 'stats-nudges-videopress-learn' );
$text = __( 'Engage your visitors with high-quality, ad-free videos built specifically for WordPress.', 'jetpack' );
self::print_item( __( 'VideoPress', 'jetpack' ), $text, 'product-jetpack-videopress.svg', $link, 'videopress', $learn_link );
}
/**
* Prints the Boost item
*
* @param bool $print Whether to print the item output or just check whether it would be printed or not.
*
* @return bool
*/
private static function get_boost_output( $print = true ) {
$plugin_file = 'jetpack-boost/jetpack-boost.php';
$plugin_slug = 'jetpack-boost';
if ( self::is_plugin_active( $plugin_file ) ) {
return false;
} elseif ( self::is_plugin_installed( $plugin_file ) ) {
$label = __( 'Activate Boost', 'jetpack' );
$link = wp_nonce_url( 'plugins.php?action=activate&plugin=' . rawurlencode( $plugin_file ) . '&plugin_status=all&paged=1', 'activate-plugin_' . $plugin_file );
} else {
$label = __( 'Install Boost', 'jetpack' );
$link = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $plugin_slug ), 'install-plugin_' . $plugin_slug );
}
if ( $print ) {
$learn_link = self::get_upgrade_link( 'stats-nudges-boost-learn' );
$text = __( 'Improve your site\'s performance and SEO in a few clicks with the free Jetpack Boost plugin.', 'jetpack' );
self::print_item( __( 'Boost', 'jetpack' ), $text, 'product-jetpack-boost.svg', $link, 'boost', $learn_link, false, $label );
}
return true;
}
/**
* Prints the CRM item
*
* @param bool $print Whether to print the item output or just check whether it would be printed or not.
*
* @since 10.1
*
* @return bool
*/
private static function get_crm_output( $print = true ) {
$plugin_file = Jetpack_CRM_Data::JETPACK_CRM_PLUGIN_SLUG;
$plugin_slug = substr( $plugin_file, 0, strpos( $plugin_file, '/' ) );
if ( self::is_plugin_active( $plugin_file ) ) {
return false;
} elseif ( self::is_plugin_installed( $plugin_file ) ) {
$link = wp_nonce_url( 'plugins.php?action=activate&plugin=' . rawurlencode( $plugin_file ) . '&plugin_status=all&paged=1', 'activate-plugin_' . $plugin_file );
$label = __( 'Activate CRM', 'jetpack' );
} else {
$link = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $plugin_slug ), 'install-plugin_' . $plugin_slug );
$label = __( 'Install CRM', 'jetpack' );
}
if ( $print ) {
$learn_link = self::get_upgrade_link( 'stats-nudges-crm-learn' );
$text = __( 'Sell more and get more leads with the free Jetpack CRM plugin built specifically for WordPress.', 'jetpack' );
self::print_item( __( 'CRM', 'jetpack' ), $text, 'product-jetpack-crm.svg', $link, 'crm', $learn_link, false, $label );
}
return true;
}
/**
* Outputs the section to the Stats Report page
*
* @param string $callback The callback passed to the jetpack admin page.
* @return void
*/
public static function render( $callback ) {
/** This filter is documented in _inc/lib/admin-pages/class.jetpack-react-page.php */
if ( 'stats_reports_page' !== $callback || ! apply_filters( 'jetpack_show_promotions', true ) || ! current_user_can( 'manage_options' ) ) {
return;
}
if ( self::has_complete_plan() ) {
return;
}
if (
self::has_security_plan() &&
self::is_backup_active() &&
self::is_search_active() &&
! self::get_boost_output( false ) &&
! self::get_crm_output( false )
) {
return;
}
self::print_styles();
self::print_script();
self::print_header();
if ( ! self::has_security_plan() ) {
self::print_security();
if ( ! self::is_backup_active() ) {
self::print_backup();
}
}
if ( ! self::is_search_active() ) {
self::print_search();
}
if ( ! self::has_product( 'jetpack_videopress' ) ) {
self::print_videopress();
}
self::get_boost_output();
self::get_crm_output();
self::print_footer();
}
}
Zerion Mini Shell 1.0