Commit realizado el 12:13:52 08-04-2024
This commit is contained in:
Pagina Web Monito
@@ -0,0 +1,122 @@
|
||||
<?php
|
||||
|
||||
namespace WPMailSMTP\UsageTracking;
|
||||
|
||||
use WPMailSMTP\Tasks\Task;
|
||||
use WPMailSMTP\Tasks\Tasks;
|
||||
|
||||
/**
|
||||
* Class SendUsageTask.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*/
|
||||
class SendUsageTask extends Task {
|
||||
|
||||
/**
|
||||
* Action name for this task.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*/
|
||||
const ACTION = 'wp_mail_smtp_send_usage_data';
|
||||
|
||||
/**
|
||||
* Server URL to send requests to.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*/
|
||||
const TRACK_URL = 'https://wpmailsmtpusage.com/v1/smtptrack';
|
||||
|
||||
/**
|
||||
* Option name to store the timestamp of the last run.
|
||||
*
|
||||
* @since 2.5.0
|
||||
*/
|
||||
const LAST_RUN = 'wp_mail_smtp_send_usage_last_run';
|
||||
|
||||
/**
|
||||
* Class constructor.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*/
|
||||
public function __construct() {
|
||||
|
||||
parent::__construct( self::ACTION );
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize the task with all the proper checks.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*/
|
||||
public function init() {
|
||||
|
||||
// Register the action handler.
|
||||
add_action( self::ACTION, [ $this, 'process' ] );
|
||||
|
||||
// Add new if none exists.
|
||||
if ( Tasks::is_scheduled( self::ACTION ) !== false ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->recurring( $this->generate_start_date(), WEEK_IN_SECONDS )
|
||||
->register();
|
||||
}
|
||||
|
||||
/**
|
||||
* Randomly pick a timestamp
|
||||
* which is not more than 1 week in the future
|
||||
* starting from next sunday.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
private function generate_start_date() {
|
||||
|
||||
$tracking = [];
|
||||
|
||||
$tracking['days'] = wp_rand( 0, 6 ) * DAY_IN_SECONDS;
|
||||
$tracking['hours'] = wp_rand( 0, 23 ) * HOUR_IN_SECONDS;
|
||||
$tracking['minutes'] = wp_rand( 0, 59 ) * MINUTE_IN_SECONDS;
|
||||
$tracking['seconds'] = wp_rand( 0, 59 );
|
||||
|
||||
return strtotime( 'next sunday' ) + array_sum( $tracking );
|
||||
}
|
||||
|
||||
/**
|
||||
* Send the actual data in a POST request.
|
||||
* This will be executed in a separate process via Action Scheduler.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*/
|
||||
public function process() {
|
||||
|
||||
$last_run = get_option( self::LAST_RUN );
|
||||
|
||||
// Make sure we do not run it more than once a day.
|
||||
if (
|
||||
$last_run !== false &&
|
||||
( time() - $last_run ) < DAY_IN_SECONDS
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Send data to the usage tracking API.
|
||||
$ut = new UsageTracking();
|
||||
|
||||
wp_remote_post(
|
||||
self::TRACK_URL,
|
||||
[
|
||||
'timeout' => 5,
|
||||
'redirection' => 5,
|
||||
'httpversion' => '1.1',
|
||||
'blocking' => true,
|
||||
'body' => $ut->get_data(),
|
||||
'user-agent' => $ut->get_user_agent(),
|
||||
]
|
||||
);
|
||||
|
||||
// Update the last run option to the current timestamp.
|
||||
update_option( self::LAST_RUN, time() );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,372 @@
|
||||
<?php
|
||||
|
||||
namespace WPMailSMTP\UsageTracking;
|
||||
|
||||
use WPMailSMTP\Admin\DomainChecker;
|
||||
use WPMailSMTP\Admin\SetupWizard;
|
||||
use WPMailSMTP\Conflicts;
|
||||
use WPMailSMTP\Debug;
|
||||
use WPMailSMTP\Helpers\Helpers;
|
||||
use WPMailSMTP\Options;
|
||||
use WPMailSMTP\WP;
|
||||
|
||||
/**
|
||||
* Usage Tracker functionality to understand what's going on on client's sites.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*/
|
||||
class UsageTracking {
|
||||
|
||||
/**
|
||||
* The slug that will be used to save the option of Usage Tracker.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*/
|
||||
const SETTINGS_SLUG = 'usage-tracking-enabled';
|
||||
|
||||
/**
|
||||
* Server URL to send failed Setup Wizard data to.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*/
|
||||
const FAILED_SETUP_WIZARD_DATA_URL = 'https://wpmailsmtpusage.com/v1/smtp-failed-wizard';
|
||||
|
||||
/**
|
||||
* Whether Usage Tracking is enabled.
|
||||
* Needs to check with a fresh copy of options in order to provide accurate results.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function is_enabled() {
|
||||
|
||||
return (bool) apply_filters(
|
||||
'wp_mail_smtp_usage_tracking_is_enabled',
|
||||
Options::init()->get( 'general', self::SETTINGS_SLUG )
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load usage tracking functionality.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*/
|
||||
public function load() {
|
||||
|
||||
// Check if loading the usage tracking functionality is allowed.
|
||||
if ( ! (bool) apply_filters( 'wp_mail_smtp_usage_tracking_load_allowed', true ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Deregister the action if option is disabled.
|
||||
add_action(
|
||||
'wp_mail_smtp_options_set_after',
|
||||
function () {
|
||||
|
||||
if ( ! $this->is_enabled() ) {
|
||||
( new SendUsageTask() )->cancel();
|
||||
}
|
||||
}
|
||||
);
|
||||
|
||||
// Register the action handler only if enabled.
|
||||
if ( $this->is_enabled() ) {
|
||||
add_filter(
|
||||
'wp_mail_smtp_tasks_get_tasks',
|
||||
static function ( $tasks ) {
|
||||
$tasks[] = SendUsageTask::class;
|
||||
|
||||
return $tasks;
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the User Agent string that will be sent to the API.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_user_agent() {
|
||||
|
||||
return Helpers::get_default_user_agent();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get data for sending to the server.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function get_data() {
|
||||
|
||||
global $wpdb;
|
||||
|
||||
$theme_data = wp_get_theme();
|
||||
$options = Options::init();
|
||||
$mailer = wp_mail_smtp()->get_providers()->get_mailer(
|
||||
$options->get( 'mail', 'mailer' ),
|
||||
wp_mail_smtp()->get_processor()->get_phpmailer()
|
||||
);
|
||||
$setup_wizard_stats = SetupWizard::get_stats();
|
||||
|
||||
$data = array_merge(
|
||||
$this->get_required_data(),
|
||||
$this->get_additional_data(),
|
||||
[
|
||||
// Generic data (environment).
|
||||
'mysql_version' => $wpdb->db_version(),
|
||||
'server_version' => isset( $_SERVER['SERVER_SOFTWARE'] ) ? sanitize_text_field( wp_unslash( $_SERVER['SERVER_SOFTWARE'] ) ) : '',
|
||||
'is_ssl' => is_ssl(),
|
||||
'is_multisite' => is_multisite(),
|
||||
'sites_count' => $this->get_sites_total(),
|
||||
'theme_name' => $theme_data->name,
|
||||
'theme_version' => $theme_data->version,
|
||||
'locale' => get_locale(),
|
||||
'timezone_offset' => $this->get_timezone_offset(),
|
||||
// WP Mail SMTP - specific data.
|
||||
'wp_mail_smtp_version' => WPMS_PLUGIN_VER,
|
||||
'wp_mail_smtp_activated' => get_option( 'wp_mail_smtp_activated_time', 0 ),
|
||||
'wp_mail_smtp_mailer' => $options->get( 'mail', 'mailer' ),
|
||||
'wp_mail_smtp_from_email_force' => (bool) $options->get( 'mail', 'from_email_force' ),
|
||||
'wp_mail_smtp_from_name_force' => (bool) $options->get( 'mail', 'from_name_force' ),
|
||||
'wp_mail_smtp_return_path' => (bool) $options->get( 'mail', 'return_path' ),
|
||||
'wp_mail_smtp_do_not_send' => (bool) $options->get( 'general', 'do_not_send' ),
|
||||
'wp_mail_smtp_is_white_labeled' => wp_mail_smtp()->is_white_labeled(),
|
||||
'wp_mail_smtp_is_const_enabled' => (bool) $options->is_const_enabled(),
|
||||
'wp_mail_smtp_conflicts_is_detected' => ( new Conflicts() )->is_detected(),
|
||||
'wp_mail_smtp_is_mailer_complete' => empty( $mailer ) ? false : $mailer->is_mailer_complete(),
|
||||
'wp_mail_smtp_setup_wizard_launched_time' => isset( $setup_wizard_stats['launched_time'] ) ? (int) $setup_wizard_stats['launched_time'] : 0,
|
||||
'wp_mail_smtp_setup_wizard_completed_time' => isset( $setup_wizard_stats['completed_time'] ) ? (int) $setup_wizard_stats['completed_time'] : 0,
|
||||
'wp_mail_smtp_setup_wizard_completed_successfully' => ! empty( $setup_wizard_stats['was_successful'] ),
|
||||
'wp_mail_smtp_source' => sanitize_title( get_option( 'wp_mail_smtp_source', '' ) ),
|
||||
]
|
||||
);
|
||||
|
||||
if ( 'smtp' === $options->get( 'mail', 'mailer' ) ) {
|
||||
$data['wp_mail_smtp_other_smtp_host'] = $options->get( 'smtp', 'host' );
|
||||
$data['wp_mail_smtp_other_smtp_encryption'] = $options->get( 'smtp', 'encryption' );
|
||||
$data['wp_mail_smtp_other_smtp_port'] = $options->get( 'smtp', 'port' );
|
||||
$data['wp_mail_smtp_other_smtp_auth'] = (bool) $options->get( 'smtp', 'auth' );
|
||||
$data['wp_mail_smtp_other_smtp_autotls'] = (bool) $options->get( 'smtp', 'autotls' );
|
||||
}
|
||||
|
||||
if ( is_multisite() ) {
|
||||
$data['wp_mail_smtp_multisite_network_wide'] = WP::use_global_plugin_settings();
|
||||
}
|
||||
|
||||
return apply_filters( 'wp_mail_smtp_usage_tracking_get_data', $data );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the required request data.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
private function get_required_data() {
|
||||
|
||||
return [
|
||||
'url' => home_url(),
|
||||
'php_version' => PHP_MAJOR_VERSION . '.' . PHP_MINOR_VERSION,
|
||||
'wp_version' => get_bloginfo( 'version' ),
|
||||
'active_plugins' => $this->get_active_plugins(),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the additional data required by the usage tracking API.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
private function get_additional_data() {
|
||||
|
||||
$activated_dates = get_option( 'wp_mail_smtp_activated', [] );
|
||||
|
||||
return [
|
||||
'wp_mail_smtp_license_key' => wp_mail_smtp()->get_license_key(),
|
||||
'wp_mail_smtp_license_type' => wp_mail_smtp()->get_license_type(),
|
||||
'wp_mail_smtp_is_pro' => wp_mail_smtp()->is_pro(),
|
||||
'wp_mail_smtp_lite_installed_date' => $this->get_installed( $activated_dates, 'lite' ),
|
||||
'wp_mail_smtp_pro_installed_date' => $this->get_installed( $activated_dates, 'pro' ),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get timezone offset.
|
||||
* We use `wp_timezone_string()` when it's available (WP 5.3+),
|
||||
* otherwise fallback to the same code, copy-pasted.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function get_timezone_offset() {
|
||||
|
||||
// It was added in WordPress 5.3.
|
||||
if ( function_exists( 'wp_timezone_string' ) ) {
|
||||
return wp_timezone_string();
|
||||
}
|
||||
|
||||
/*
|
||||
* The code below is basically a copy-paste from that function.
|
||||
*/
|
||||
|
||||
$timezone_string = get_option( 'timezone_string' );
|
||||
|
||||
if ( $timezone_string ) {
|
||||
return $timezone_string;
|
||||
}
|
||||
|
||||
$offset = (float) get_option( 'gmt_offset' );
|
||||
$hours = (int) $offset;
|
||||
$minutes = ( $offset - $hours );
|
||||
|
||||
$sign = ( $offset < 0 ) ? '-' : '+';
|
||||
$abs_hour = abs( $hours );
|
||||
$abs_mins = abs( $minutes * 60 );
|
||||
|
||||
return sprintf( '%s%02d:%02d', $sign, $abs_hour, $abs_mins );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the list of active plugins.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
private function get_active_plugins() {
|
||||
|
||||
if ( ! function_exists( 'get_plugins' ) ) {
|
||||
include ABSPATH . '/wp-admin/includes/plugin.php';
|
||||
}
|
||||
|
||||
$active_plugins = [];
|
||||
|
||||
foreach ( get_mu_plugins() as $path => $plugin ) {
|
||||
$active_plugins[ $path ] = isset( $plugin['Version'] ) ? $plugin['Version'] : 'Not Set';
|
||||
}
|
||||
|
||||
foreach ( get_plugins() as $path => $plugin ) {
|
||||
if ( is_plugin_active( $path ) ) {
|
||||
$active_plugins[ $path ] = isset( $plugin['Version'] ) ? $plugin['Version'] : 'Not Set';
|
||||
}
|
||||
}
|
||||
|
||||
return $active_plugins;
|
||||
}
|
||||
|
||||
/**
|
||||
* Installed date.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @param array $activated_dates Input array with dates.
|
||||
* @param string $key Input key what you want to get.
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
private function get_installed( $activated_dates, $key ) {
|
||||
|
||||
if ( ! empty( $activated_dates[ $key ] ) ) {
|
||||
return $activated_dates[ $key ];
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Total number of sites.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
private function get_sites_total() {
|
||||
|
||||
return function_exists( 'get_blog_count' ) ? (int) get_blog_count() : 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Send failed Setup Wizard usage tracking data, if usage tracking is enabled.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
* @param null|DomainChecker $domain_checker The optional DomainChecker object.
|
||||
*/
|
||||
public function send_failed_setup_wizard_usage_tracking_data( $domain_checker = null ) {
|
||||
|
||||
if ( ! $this->is_enabled() ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$options = Options::init();
|
||||
|
||||
$data = array_merge(
|
||||
$this->get_required_data(),
|
||||
$this->get_additional_data(),
|
||||
[
|
||||
'wp_mail_smtp_mailer' => $options->get( 'mail', 'mailer' ),
|
||||
'wp_mail_smtp_mail_error' => Debug::get_last(),
|
||||
],
|
||||
$this->get_domain_checker_results( $domain_checker )
|
||||
);
|
||||
|
||||
wp_remote_post(
|
||||
self::FAILED_SETUP_WIZARD_DATA_URL,
|
||||
[
|
||||
'timeout' => 5,
|
||||
'redirection' => 5,
|
||||
'httpversion' => '1.1',
|
||||
'blocking' => true,
|
||||
'body' => $data,
|
||||
'user-agent' => $this->get_user_agent(),
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reformat the domain checker results, so it can be submitted to the usage tracking API.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*
|
||||
* @param DomainChecker|null $domain_checker The Domain Checker object.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
private function get_domain_checker_results( $domain_checker ) {
|
||||
|
||||
if ( ! is_a( $domain_checker, DomainChecker::class ) ) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$data = [];
|
||||
$results = $domain_checker->get_results();
|
||||
|
||||
$data['wp_mail_smtp_domain_checker_success'] = isset( $results['success'] ) ? (bool) $results['success'] : false;
|
||||
$data['wp_mail_smtp_domain_checker_message'] = isset( $results['message'] ) ? $results['message'] : '';
|
||||
|
||||
// Return early if checks are not available.
|
||||
if ( empty( $results['checks'] ) || ! is_array( $results['checks'] ) ) {
|
||||
return $data;
|
||||
}
|
||||
|
||||
foreach ( $results['checks'] as $check ) {
|
||||
if ( empty( $check['type'] ) || empty( $check['state'] ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$data[ 'wp_mail_smtp_domain_checker_check_' . $check['type'] ] = $check['state'];
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user