This commit is contained in:
emmymayo
2025-02-05 23:15:46 +01:00
commit 7269c99357
16995 changed files with 3389680 additions and 0 deletions
@@ -0,0 +1,113 @@
<?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing
namespace MailPoet\Analytics;
if (!defined('ABSPATH')) exit;
use MailPoet\Settings\SettingsController;
use MailPoet\Util\Security;
use MailPoet\WP\Functions as WPFunctions;
use MailPoetVendor\Carbon\Carbon;
class Analytics {
const SETTINGS_LAST_SENT_KEY = 'analytics_last_sent';
const SEND_AFTER_DAYS = 7;
const ANALYTICS_FILTER = 'mailpoet_analytics';
/** @var Reporter */
private $reporter;
/** @var SettingsController */
private $settings;
/** @var WPFunctions */
private $wp;
public function __construct(
Reporter $reporter,
SettingsController $settingsController
) {
$this->reporter = $reporter;
$this->settings = $settingsController;
$this->wp = new WPFunctions;
}
/** @return array|null */
public function generateAnalytics() {
if ($this->shouldSend()) {
$data = $this->getAnalyticsData();
$this->recordDataSent();
return $data;
}
return null;
}
public function getAnalyticsData() {
return $this->wp->applyFilters(self::ANALYTICS_FILTER, $this->reporter->getData());
}
/** @return bool */
public function isEnabled() {
$analyticsSettings = $this->settings->get('analytics', []);
return !empty($analyticsSettings['enabled']) === true;
}
public function setPublicId($newPublicId) {
$currentPublicId = $this->settings->get('public_id');
if ($currentPublicId !== $newPublicId) {
$this->settings->set('public_id', $newPublicId);
$this->settings->set('new_public_id', 'true');
// Force user data to be resent
$this->settings->delete(Analytics::SETTINGS_LAST_SENT_KEY);
}
}
/** @return string */
public function getPublicId() {
$publicId = $this->settings->get('public_id', '');
if (empty($publicId)) {
// The previous implementation used md5, so this is just to ensure consistency
$randomId = md5(Security::generateRandomString(32));
$this->settings->set('public_id', $randomId);
$this->settings->set('new_public_id', 'true');
return $randomId;
}
return $publicId;
}
/**
* Returns true if a the public_id was added and update new_public_id to false
* @return bool
*/
public function isPublicIdNew() {
$newPublicId = $this->settings->get('new_public_id');
if ($newPublicId === 'true') {
$this->settings->set('new_public_id', 'false');
return true;
}
return false;
}
public function shouldSend() {
if (!$this->isEnabled()) {
return false;
}
$nextSend = $this->getNextSendDate();
return $nextSend->isPast();
}
public function getNextSendDate(): Carbon {
$lastSent = $this->settings->get(Analytics::SETTINGS_LAST_SENT_KEY);
if (!$lastSent) {
return Carbon::now()->subMinute();
}
return Carbon::createFromTimestamp(strtotime($lastSent))->addDays(self::SEND_AFTER_DAYS);
}
public function recordDataSent() {
$this->settings->set(Analytics::SETTINGS_LAST_SENT_KEY, Carbon::now());
}
}
@@ -0,0 +1,446 @@
<?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing
namespace MailPoet\Analytics;
if (!defined('ABSPATH')) exit;
use MailPoet\Automation\Engine\Data\Automation;
use MailPoet\Automation\Engine\Data\Step;
use MailPoet\Automation\Engine\Storage\AutomationStorage;
use MailPoet\Captcha\CaptchaConstants;
use MailPoet\Config\ServicesChecker;
use MailPoet\Cron\CronTrigger;
use MailPoet\Entities\DynamicSegmentFilterData;
use MailPoet\Listing\ListingDefinition;
use MailPoet\Newsletter\NewslettersRepository;
use MailPoet\Segments\DynamicSegments\DynamicSegmentFilterRepository;
use MailPoet\Segments\DynamicSegments\Filters\AutomationsEvents;
use MailPoet\Segments\DynamicSegments\Filters\EmailAction;
use MailPoet\Segments\DynamicSegments\Filters\EmailActionClickAny;
use MailPoet\Segments\DynamicSegments\Filters\EmailOpensAbsoluteCountAction;
use MailPoet\Segments\DynamicSegments\Filters\EmailsReceived;
use MailPoet\Segments\DynamicSegments\Filters\MailPoetCustomFields;
use MailPoet\Segments\DynamicSegments\Filters\NumberOfClicks;
use MailPoet\Segments\DynamicSegments\Filters\SubscriberDateField;
use MailPoet\Segments\DynamicSegments\Filters\SubscriberScore;
use MailPoet\Segments\DynamicSegments\Filters\SubscriberSegment;
use MailPoet\Segments\DynamicSegments\Filters\SubscriberSubscribedViaForm;
use MailPoet\Segments\DynamicSegments\Filters\SubscriberTag;
use MailPoet\Segments\DynamicSegments\Filters\SubscriberTextField;
use MailPoet\Segments\DynamicSegments\Filters\UserRole;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceAverageSpent;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceCategory;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceCountry;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceCustomerTextField;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceFirstOrder;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceMembership;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceNumberOfOrders;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceNumberOfReviews;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceProduct;
use MailPoet\Segments\DynamicSegments\Filters\WooCommercePurchaseDate;
use MailPoet\Segments\DynamicSegments\Filters\WooCommercePurchasedWithAttribute;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceSingleOrderValue;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceSubscription;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceTag;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceTotalSpent;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceUsedCouponCode;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceUsedPaymentMethod;
use MailPoet\Segments\DynamicSegments\Filters\WooCommerceUsedShippingMethod;
use MailPoet\Segments\SegmentsRepository;
use MailPoet\Services\AuthorizedEmailsController;
use MailPoet\Settings\Pages;
use MailPoet\Settings\SettingsController;
use MailPoet\Settings\TrackingConfig;
use MailPoet\Subscribers\ConfirmationEmailCustomizer;
use MailPoet\Subscribers\NewSubscriberNotificationMailer;
use MailPoet\Subscribers\SubscriberListingRepository;
use MailPoet\Tags\TagRepository;
use MailPoet\Util\License\Features\Subscribers as SubscribersFeature;
use MailPoet\WooCommerce\Helper as WooCommerceHelper;
use MailPoet\WooCommerce\Subscription;
use MailPoet\WP\Functions as WPFunctions;
use MailPoet\WPCOM\DotcomHelperFunctions;
use MailPoetVendor\Carbon\Carbon;
class Reporter {
/** @var NewslettersRepository */
private $newslettersRepository;
/** @var SegmentsRepository */
private $segmentsRepository;
/** @var DynamicSegmentFilterRepository */
private $dynamicSegmentFilterRepository;
/** @var TagRepository */
private $tagRepository;
/** @var ServicesChecker */
private $servicesChecker;
/** @var SettingsController */
private $settings;
/** @var WooCommerceHelper */
private $woocommerceHelper;
/** @var WPFunctions */
private $wp;
/** @var SubscribersFeature */
private $subscribersFeature;
/** @var TrackingConfig */
private $trackingConfig;
/** @var SubscriberListingRepository */
private $subscriberListingRepository;
/** @var AutomationStorage */
private $automationStorage;
/*** @var UnsubscribeReporter */
private $unsubscribeReporter;
/*** @var DotcomHelperFunctions */
private $dotcomHelperFunctions;
/*** @var ReporterCampaignData */
private $reporterCampaignData;
public function __construct(
NewslettersRepository $newslettersRepository,
SegmentsRepository $segmentsRepository,
DynamicSegmentFilterRepository $dynamicSegmentFilterRepository,
TagRepository $tagRepository,
ServicesChecker $servicesChecker,
SettingsController $settings,
WooCommerceHelper $woocommerceHelper,
WPFunctions $wp,
SubscribersFeature $subscribersFeature,
TrackingConfig $trackingConfig,
SubscriberListingRepository $subscriberListingRepository,
AutomationStorage $automationStorage,
UnsubscribeReporter $unsubscribeReporter,
DotcomHelperFunctions $dotcomHelperFunctions,
ReporterCampaignData $reporterCampaignData
) {
$this->newslettersRepository = $newslettersRepository;
$this->segmentsRepository = $segmentsRepository;
$this->dynamicSegmentFilterRepository = $dynamicSegmentFilterRepository;
$this->tagRepository = $tagRepository;
$this->servicesChecker = $servicesChecker;
$this->settings = $settings;
$this->woocommerceHelper = $woocommerceHelper;
$this->wp = $wp;
$this->subscribersFeature = $subscribersFeature;
$this->trackingConfig = $trackingConfig;
$this->subscriberListingRepository = $subscriberListingRepository;
$this->automationStorage = $automationStorage;
$this->unsubscribeReporter = $unsubscribeReporter;
$this->dotcomHelperFunctions = $dotcomHelperFunctions;
$this->reporterCampaignData = $reporterCampaignData;
}
public function getData() {
global $wpdb, $wp_version, $woocommerce; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
$mta = $this->settings->get('mta', []);
$newsletters = $this->newslettersRepository->getAnalytics();
$isCronTriggerMethodWP = $this->settings->get('cron_trigger.method') === CronTrigger::METHOD_WORDPRESS;
$bounceAddress = $this->settings->get('bounce.address');
$segments = $this->segmentsRepository->getCountsPerType();
$hasWc = $this->woocommerceHelper->isWooCommerceActive();
$inactiveSubscribersMonths = (int)round((int)$this->settings->get('deactivate_subscriber_after_inactive_days') / 30);
$inactiveSubscribersStatus = $inactiveSubscribersMonths === 0 ? 'never' : "$inactiveSubscribersMonths months";
$result = [
'PHP version' => PHP_VERSION,
'MySQL version' => $wpdb->db_version(),
'WordPress version' => $wp_version, // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
'Multisite environment' => $this->wp->isMultisite() ? 'yes' : 'no',
'RTL' => $this->wp->isRtl() ? 'yes' : 'no',
'WP_MEMORY_LIMIT' => WP_MEMORY_LIMIT,
'WP_MAX_MEMORY_LIMIT' => WP_MAX_MEMORY_LIMIT,
'PHP memory_limit' => ini_get('memory_limit'),
'PHP max_execution_time' => ini_get('max_execution_time'),
'MailPoet Free version' => MAILPOET_VERSION,
'MailPoet Premium version' => (defined('MAILPOET_PREMIUM_VERSION')) ? MAILPOET_PREMIUM_VERSION : 'N/A',
'Total number of subscribers' => $this->subscribersFeature->getSubscribersCount(),
'Sending Method' => $mta['method'] ?? null,
"Send all site's emails with" => $this->settings->get('send_transactional_emails') ? 'current sending method' : 'default WordPress sending method',
'Date of plugin installation' => $this->settings->get('installed_at'),
'Subscribe in comments' => (boolean)$this->settings->get('subscribe.on_comment.enabled', false),
'Subscribe in registration form' => (boolean)$this->settings->get('subscribe.on_register.enabled', false),
'Manage Subscription page > MailPoet page' => (boolean)Pages::isMailpoetPage(intval($this->settings->get('subscription.pages.manage'))),
'Unsubscribe page > MailPoet page' => (boolean)Pages::isMailpoetPage(intval($this->settings->get('subscription.pages.unsubscribe'))),
'Sign-up confirmation' => (boolean)$this->settings->get('signup_confirmation.enabled', false),
'Sign-up confirmation: Confirmation page > MailPoet page' => (boolean)Pages::isMailpoetPage(intval($this->settings->get('subscription.pages.confirmation'))),
'Bounce email address' => !empty($bounceAddress),
'Newsletter task scheduler (cron)' => $isCronTriggerMethodWP ? 'visitors' : 'script',
'Open and click tracking' => $this->trackingConfig->isEmailTrackingEnabled(),
'Tracking level' => $this->settings->get('tracking.level', TrackingConfig::LEVEL_FULL),
'Premium key valid' => $this->servicesChecker->isPremiumKeyValid(),
'New subscriber notifications' => NewSubscriberNotificationMailer::isDisabled($this->settings->get(NewSubscriberNotificationMailer::SETTINGS_KEY)),
'Number of active post notifications' => $newsletters['notifications_count'],
'Number of active welcome emails' => $newsletters['welcome_newsletters_count'],
'Total number of standard newsletters sent' => $newsletters['sent_newsletters_count'],
'Total number of block editor gutenberg newsletters' => $newsletters['total_gutenberg_newsletter_count'],
'Number of block editor gutenberg newsletters sent' => $newsletters['sent_gutenberg_newsletter_count'],
'Number of segments' => isset($segments['dynamic']) ? (int)$segments['dynamic'] : 0,
'Number of lists' => isset($segments['default']) ? (int)$segments['default'] : 0,
'Number of subscriber tags' => $this->tagRepository->countBy([]),
'Site is using block theme' => $this->wp->wpIsBlockTheme(),
'Stop sending to inactive subscribers' => $inactiveSubscribersStatus,
'CAPTCHA setting' => $this->settings->get(CaptchaConstants::TYPE_SETTING_NAME, '') ?: 'disabled',
'Is CAPTCHA on register forms enabled' => $this->settings->get(CaptchaConstants::ON_REGISTER_FORMS_SETTING_NAME, false) ? 'yes' : 'no',
'users_can_register' => $this->wp->getOption('users_can_register') ? 'yes' : 'no',
'Is WooCommerce account creation on "My account" enabled' => $this->wp->getOption('woocommerce_enable_myaccount_registration') ?? 'no',
'Plugin > MailPoet Premium' => $this->wp->isPluginActive('mailpoet-premium/mailpoet-premium.php'),
'Plugin > bounce add-on' => $this->wp->isPluginActive('mailpoet-bounce-handler/mailpoet-bounce-handler.php'),
'Plugin > Bloom' => $this->wp->isPluginActive('bloom-for-publishers/bloom.php'),
'Plugin > WP Holler' => $this->wp->isPluginActive('holler-box/holler-box.php'),
'Plugin > WP-SMTP' => $this->wp->isPluginActive('wp-mail-smtp/wp_mail_smtp.php'),
'Plugin > WooCommerce' => $hasWc,
'Plugin > WooCommerce Subscription' => $this->wp->isPluginActive('woocommerce-subscriptions/woocommerce-subscriptions.php'),
'Plugin > WooCommerce Follow Up Emails' => $this->wp->isPluginActive('woocommerce-follow-up-emails/woocommerce-follow-up-emails.php'),
'Plugin > WooCommerce Email Customizer' => $this->wp->isPluginActive('woocommerce-email-customizer/woocommerce-email-customizer.php'),
'Plugin > WooCommerce Memberships' => $this->wp->isPluginActive('woocommerce-memberships/woocommerce-memberships.php'),
'Plugin > WooCommerce MailChimp' => $this->wp->isPluginActive('woocommerce-mailchimp/woocommerce-mailchimp.php'),
'Plugin > MailChimp for WooCommerce' => $this->wp->isPluginActive('mailchimp-for-woocommerce/mailchimp-woocommerce.php'),
'Plugin > The Event Calendar' => $this->wp->isPluginActive('the-events-calendar/the-events-calendar.php'),
'Plugin > Gravity Forms' => $this->wp->isPluginActive('gravityforms/gravityforms.php'),
'Plugin > Ninja Forms' => $this->wp->isPluginActive('ninja-forms/ninja-forms.php'),
'Plugin > WPForms' => $this->wp->isPluginActive('wpforms-lite/wpforms.php'),
'Plugin > Formidable Forms' => $this->wp->isPluginActive('formidable/formidable.php'),
'Plugin > Contact Form 7' => $this->wp->isPluginActive('contact-form-7/wp-contact-form-7.php'),
'Plugin > Easy Digital Downloads' => $this->wp->isPluginActive('easy-digital-downloads/easy-digital-downloads.php'),
'Plugin > WooCommerce Multi-Currency' => $this->wp->isPluginActive('woocommerce-multi-currency/woocommerce-multi-currency.php'),
'Plugin > Multi Currency for WooCommerce' => $this->wp->isPluginActive('woo-multi-currency/woo-multi-currency.php'),
'Web host' => $this->settings->get('mta_group') == 'website' ? $this->settings->get('web_host') : null,
// Dynamic segment filters tracking -- start. If you extend segments tracking, please extend mapping in analytics.js
'Segment > number of machine-opens' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_EMAIL, EmailOpensAbsoluteCountAction::MACHINE_TYPE),
'Segment > number of opens' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_EMAIL, EmailOpensAbsoluteCountAction::TYPE),
'Segment > number of orders' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceNumberOfOrders::ACTION_NUMBER_OF_ORDERS),
'Segment > clicked' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_EMAIL, EmailAction::ACTION_CLICKED),
'Segment > clicked any email' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_EMAIL, EmailActionClickAny::TYPE),
'Segment > score' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberScore::TYPE),
'Segment > subscribed to list' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberSegment::TYPE),
'Segment > opened' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_EMAIL, EmailAction::ACTION_OPENED),
'Segment > machine-opened' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_EMAIL, EmailAction::ACTION_MACHINE_OPENED),
'Segment > is active member of' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE_MEMBERSHIP, WooCommerceMembership::ACTION_MEMBER_OF),
'Segment > has an active subscription' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE_SUBSCRIPTION, WooCommerceSubscription::ACTION_HAS_ACTIVE),
'Segment > is in country' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceCountry::ACTION_CUSTOMER_COUNTRY),
'Segment > MailPoet custom field' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, MailPoetCustomFields::TYPE),
'Segment > purchased in category' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceCategory::ACTION_CATEGORY),
'Segment > purchased product' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceProduct::ACTION_PRODUCT),
'Segment > purchased with tag' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceTag::ACTION),
'Segment > subscribed date' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberDateField::SUBSCRIBED_DATE),
'Segment > total spent' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceTotalSpent::ACTION_TOTAL_SPENT),
'Segment > first order' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceFirstOrder::ACTION),
'Segment > WordPress user role' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, UserRole::TYPE),
'Segment > subscriber tags' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberTag::TYPE),
'Segment > number of emails received' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_EMAIL, EmailsReceived::ACTION),
'Segment > purchase date' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommercePurchaseDate::ACTION),
'Segment > average order value' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceAverageSpent::ACTION),
'Segment > single order value' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceSingleOrderValue::ACTION_SINGLE_ORDER_VALUE),
'Segment > last engagement date' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberDateField::LAST_ENGAGEMENT_DATE),
'Segment > last click date' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberDateField::LAST_CLICK_DATE),
'Segment > last purchase date' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberDateField::LAST_PURCHASE_DATE),
'Segment > last open date' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberDateField::LAST_OPEN_DATE),
'Segment > last page view date' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberDateField::LAST_PAGE_VIEW_DATE),
'Segment > last sending date' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberDateField::LAST_SENDING_DATE),
'Segment > first name' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberTextField::FIRST_NAME),
'Segment > last name' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberTextField::LAST_NAME),
'Segment > email' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberTextField::EMAIL),
'Segment > city' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceCustomerTextField::CITY),
'Segment > postal code' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceCustomerTextField::POSTAL_CODE),
'Segment > purchased with attribute' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommercePurchasedWithAttribute::ACTION),
'Segment > used payment method' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceUsedPaymentMethod::ACTION),
'Segment > used shipping method' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceUsedShippingMethod::ACTION),
'Segment > number of reviews' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceNumberOfReviews::ACTION),
'Segment > used coupon code' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_WOOCOMMERCE, WooCommerceUsedCouponCode::ACTION),
'Segment > entered automation' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_AUTOMATIONS, AutomationsEvents::ENTERED_ACTION),
'Segment > exited automation' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_AUTOMATIONS, AutomationsEvents::EXITED_ACTION),
'Segment > was sent' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_EMAIL, EmailAction::ACTION_WAS_SENT),
'Segment > subscribed via form' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_USER_ROLE, SubscriberSubscribedViaForm::TYPE),
'Segment > number of clicks' => $this->isFilterTypeActive(DynamicSegmentFilterData::TYPE_EMAIL, NumberOfClicks::ACTION),
// Dynamic segment filters tracking -- end. If you extend segments tracking, please extend mapping in analytics.js
'Number of segments with multiple conditions' => $this->segmentsRepository->getSegmentCountWithMultipleFilters(),
'Support tier' => $this->subscribersFeature->hasPremiumSupport() ? 'premium' : 'free',
'Unauthorized email notice shown' => !empty($this->settings->get(AuthorizedEmailsController::AUTHORIZED_EMAIL_ADDRESSES_ERROR_SETTING)),
'Sign-up confirmation: Confirmation Template > using html email editor template' => (boolean)$this->settings->get(ConfirmationEmailCustomizer::SETTING_ENABLE_EMAIL_CUSTOMIZER, false),
'Is WordPress.com' => $this->dotcomHelperFunctions->isDotcom() ? 'yes' : 'no',
'WordPress.com plan' => $this->dotcomHelperFunctions->getDotcomPlan(),
];
$result = array_merge(
$result,
$this->subscriberProperties(),
$this->automationProperties(),
$this->reporterCampaignData->getCampaignAnalyticsProperties(),
$this->unsubscribeReporter->getProperties()
);
if ($hasWc) {
$result['WooCommerce version'] = $woocommerce->version;
$result['Number of WooCommerce subscribers'] = isset($segments['woocommerce_users']) ? (int)$segments['woocommerce_users'] : 0;
$result['WooCommerce: opt-in on checkout is active'] = $this->settings->get(Subscription::OPTIN_ENABLED_SETTING_NAME) ?: false;
$result['WooCommerce: opt-in on checkout position'] = $this->settings->get(Subscription::OPTIN_POSITION_SETTING_NAME) ?: '';
$result['WooCommerce: set old customers as subscribed'] = $this->settings->get('mailpoet_subscribe_old_woocommerce_customers.enabled') ?: false;
$result['WooCommerce email customizer is active'] = $this->settings->get('woocommerce.use_mailpoet_editor') ?: false;
$result['Number of active WooCommerce first purchase emails'] = $newsletters['first_purchase_emails_count'];
$result['Number of active WooCommerce purchased this product emails'] = $newsletters['product_purchased_emails_count'];
$result['Number of active purchased in this category'] = $newsletters['product_purchased_in_category_emails_count'];
$result['Number of active abandoned cart'] = $newsletters['abandoned_cart_emails_count'];
$result['Installed via WooCommerce onboarding wizard'] = $this->woocommerceHelper->wasMailPoetInstalledViaWooCommerceOnboardingWizard();
}
return $result;
}
private function automationProperties(): array {
$automations = $this->automationStorage->getAutomations();
$activeAutomations = array_filter(
$automations,
function(Automation $automation): bool {
return $automation->getStatus() === Automation::STATUS_ACTIVE;
}
);
$activeAutomationCount = count($activeAutomations);
$draftAutomations = array_filter(
$automations,
function(Automation $automation): bool {
return $automation->getStatus() === Automation::STATUS_DRAFT;
}
);
$automationsWithCustomTrigger = array_filter(
$activeAutomations,
function(Automation $automation): bool {
return $automation->getTrigger('mailpoet:custom-trigger') !== null;
}
);
$automationsWithWordPressUserSubscribesTrigger = array_filter(
$activeAutomations,
function(Automation $automation): bool {
return $automation->getTrigger('mailpoet:wp-user-registered') !== null;
}
);
$automationsWithSomeoneSubscribesTrigger = array_filter(
$activeAutomations,
function(Automation $automation): bool {
return $automation->getTrigger('mailpoet:someone-subscribes') !== null;
}
);
$automationsWithOrderStatusChangedTrigger = array_filter(
$activeAutomations,
function(Automation $automation): bool {
return $automation->getTrigger('woocommerce:order-status-changed') !== null;
}
);
$automationsWithAbandonedCartTrigger = array_filter(
$activeAutomations,
function(Automation $automation): bool {
return $automation->getTrigger('woocommerce:abandoned-cart') !== null;
}
);
$totalSteps = 0;
$minSteps = null;
$maxSteps = 0;
foreach ($activeAutomations as $automation) {
$steps = array_filter(
$automation->getSteps(),
function(Step $step): bool {
return $step->getType() === Step::TYPE_ACTION;
}
);
$stepCount = count($steps);
$minSteps = $minSteps !== null ? min($stepCount, $minSteps) : $stepCount;
$maxSteps = max($maxSteps, $stepCount);
$totalSteps += $stepCount;
}
$averageSteps = $activeAutomationCount > 0 ? $totalSteps / $activeAutomationCount : 0;
$customTriggerHooks = array_unique(array_values(array_map(
function(Automation $automation): string {
$trigger = $automation->getTrigger('mailpoet:custom-trigger');
return $trigger ? (string)$trigger->getArgs()['hook'] : '';
},
$automationsWithCustomTrigger
)));
$customActionHooks = array_unique(array_values(array_map(
function(Automation $automation): array {
$customActionSteps = array_filter(
$automation->getSteps(),
function(Step $step): bool {
return $step->getKey() === 'mailpoet:custom-action';
}
);
if (!$customActionSteps) {
return [];
}
return array_map(
function(Step $step): string {
return (string)$step->getArgs()['hook'];
},
$customActionSteps
);
},
$activeAutomations
)));
$customActionHooks = array_values(array_filter(array_merge(...$customActionHooks)));
return [
'Automation > Number of active automations' => $activeAutomationCount,
'Automation > Number of draft automations' => count($draftAutomations),
'Automation > Number of "WordPress user registers" active automations' => count($automationsWithWordPressUserSubscribesTrigger),
'Automation > Number of "Someone subscribes" active automations ' => count($automationsWithSomeoneSubscribesTrigger),
'Automation > Number of "Order status changed" active automations ' => count($automationsWithOrderStatusChangedTrigger),
'Automation > Number of "Subscriber abandons cart" active automations' => count($automationsWithAbandonedCartTrigger),
'Automation > Number of steps in shortest active automation' => $minSteps,
'Automation > Number of steps in longest active automation' => $maxSteps,
'Automation > Average number of steps in active automations' => $averageSteps,
'Automation > Custom Trigger Hooks' => $customTriggerHooks,
'Automation > Custom Action Hooks' => $customActionHooks,
];
}
private function subscriberProperties(): array {
$definition = new ListingDefinition();
$groups = $this->subscriberListingRepository->getGroups($definition);
$properties = [];
foreach ($groups as $group) {
$properties['Subscribers > ' . $group['name']] = (int)$group['count'];
}
return $properties;
}
public function getTrackingData() {
$newsletters = $this->newslettersRepository->getAnalytics();
$segments = $this->segmentsRepository->getCountsPerType();
$mta = $this->settings->get('mta', []);
$installedAt = new Carbon($this->settings->get('installed_at'));
return [
'installedAtIso' => $installedAt->format(Carbon::ISO8601),
'newslettersSent' => $newsletters['sent_newsletters_count'],
'welcomeEmails' => $newsletters['welcome_newsletters_count'],
'postnotificationEmails' => $newsletters['notifications_count'],
'woocommerceEmails' => $newsletters['automatic_emails_count'],
'subscribers' => $this->subscribersFeature->getSubscribersCount(),
'lists' => isset($segments['default']) ? (int)$segments['default'] : 0,
'sendingMethod' => isset($mta['method']) ? $mta['method'] : null,
'woocommerceIsInstalled' => $this->woocommerceHelper->isWooCommerceActive(),
];
}
private function isFilterTypeActive(string $filterType, string $action): bool {
if ($this->dynamicSegmentFilterRepository->findOnyByFilterTypeAndAction($filterType, $action)) {
return true;
}
return false;
}
}
@@ -0,0 +1,469 @@
<?php declare(strict_types = 1);
namespace MailPoet\Analytics;
if (!defined('ABSPATH')) exit;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Newsletter\Sending\SendingQueuesRepository;
use MailPoet\UnexpectedValueException;
class ReporterCampaignData {
const STANDARD_7_DAYS = 'Number of standard newsletters sent in last 7 days';
const STANDARD_30_DAYS = 'Number of standard newsletters sent in last 30 days';
const STANDARD_3_MONTHS = 'Number of standard newsletters sent in last 3 months';
const STANDARD_SEGMENT_7_DAYS = 'Number of standard newsletters sent to segment in last 7 days';
const STANDARD_SEGMENT_30_DAYS = 'Number of standard newsletters sent to segment in last 30 days';
const STANDARD_SEGMENT_3_MONTHS = 'Number of standard newsletters sent to segment in last 3 months';
const STANDARD_FILTERED_SEGMENT_7_DAYS = 'Number of standard newsletters filtered by segment in last 7 days';
const STANDARD_FILTERED_SEGMENT_30_DAYS = 'Number of standard newsletters filtered by segment in last 30 days';
const STANDARD_FILTERED_SEGMENT_3_MONTHS = 'Number of standard newsletters filtered by segment in last 3 months';
const AUTOMATION_7_DAYS = 'Number of automations campaigns sent in the last 7 days';
const AUTOMATION_30_DAYS = 'Number of automations campaigns sent in the last 30 days';
const AUTOMATION_3_MONTHS = 'Number of automations campaigns sent in the last 3 months';
const RE_ENGAGEMENT_7_DAYS = 'Number of re-engagement campaigns sent in the last 7 days';
const RE_ENGAGEMENT_30_DAYS = 'Number of re-engagement campaigns sent in the last 30 days';
const RE_ENGAGEMENT_3_MONTHS = 'Number of re-engagement campaigns sent in the last 3 months';
const RE_ENGAGEMENT_SEGMENT_7_DAYS = 'Number of re-engagement campaigns sent to segment in the last 7 days';
const RE_ENGAGEMENT_SEGMENT_30_DAYS = 'Number of re-engagement campaigns sent to segment in the last 30 days';
const RE_ENGAGEMENT_SEGMENT_3_MONTHS = 'Number of re-engagement campaigns sent to segment in the last 3 months';
const RE_ENGAGEMENT_FILTERED_SEGMENT_7_DAYS = 'Number of re-engagement campaigns filtered by segment in the last 7 days';
const RE_ENGAGEMENT_FILTERED_SEGMENT_30_DAYS = 'Number of re-engagement campaigns filtered by segment in the last 30 days';
const RE_ENGAGEMENT_FILTERED_SEGMENT_3_MONTHS = 'Number of re-engagement campaigns filtered by segment in the last 3 months';
const POST_NOTIFICATION_7_DAYS = 'Number of post notification campaigns sent in the last 7 days';
const POST_NOTIFICATION_30_DAYS = 'Number of post notification campaigns sent in the last 30 days';
const POST_NOTIFICATION_3_MONTHS = 'Number of post notification campaigns sent in the last 3 months';
const POST_NOTIFICATION_SEGMENT_7_DAYS = 'Number of post notification campaigns sent to segment in the last 7 days';
const POST_NOTIFICATION_SEGMENT_30_DAYS = 'Number of post notification campaigns sent to segment in the last 30 days';
const POST_NOTIFICATION_SEGMENT_3_MONTHS = 'Number of post notification campaigns sent to segment in the last 3 months';
const POST_NOTIFICATION_FILTERED_SEGMENT_7_DAYS = 'Number of post notification campaigns filtered by segment in the last 7 days';
const POST_NOTIFICATION_FILTERED_SEGMENT_30_DAYS = 'Number of post notification campaigns filtered by segment in the last 30 days';
const POST_NOTIFICATION_FILTERED_SEGMENT_3_MONTHS = 'Number of post notification campaigns filtered by segment in the last 3 months';
const LEGACY_WELCOME_7_DAYS = 'Number of legacy welcome email campaigns sent in the last 7 days';
const LEGACY_WELCOME_30_DAYS = 'Number of legacy welcome email campaigns sent in the last 30 days';
const LEGACY_WELCOME_3_MONTHS = 'Number of legacy welcome email campaigns sent in the last 3 months';
const LEGACY_ABANDONED_CART_7_DAYS = 'Number of legacy abandoned cart campaigns sent in the last 7 days';
const LEGACY_ABANDONED_CART_30_DAYS = 'Number of legacy abandoned cart campaigns sent in the last 30 days';
const LEGACY_ABANDONED_CART_3_MONTHS = 'Number of legacy abandoned cart campaigns sent in the last 3 months';
const LEGACY_FIRST_PURCHASE_7_DAYS = 'Number of legacy first purchase campaigns sent in the last 7 days';
const LEGACY_FIRST_PURCHASE_30_DAYS = 'Number of legacy first purchase campaigns sent in the last 30 days';
const LEGACY_FIRST_PURCHASE_3_MONTHS = 'Number of legacy first purchase campaigns sent in the last 3 months';
const LEGACY_PURCHASED_IN_CATEGORY_7_DAYS = 'Number of legacy purchased in category campaigns sent in the last 7 days';
const LEGACY_PURCHASED_IN_CATEGORY_30_DAYS = 'Number of legacy purchased in category campaigns sent in the last 30 days';
const LEGACY_PURCHASED_IN_CATEGORY_3_MONTHS = 'Number of legacy purchased in category campaigns sent in the last 3 months';
const LEGACY_PURCHASED_PRODUCT_7_DAYS = 'Number of legacy purchased product campaigns sent in the last 7 days';
const LEGACY_PURCHASED_PRODUCT_30_DAYS = 'Number of legacy purchased product campaigns sent in the last 30 days';
const LEGACY_PURCHASED_PRODUCT_3_MONTHS = 'Number of legacy purchased product campaigns sent in the last 3 months';
const TOTAL_CAMPAIGNS_7_DAYS = 'Number of campaigns sent in the last 7 days';
const TOTAL_CAMPAIGNS_30_DAYS = 'Number of campaigns sent in the last 30 days';
const TOTAL_CAMPAIGNS_3_MONTHS = 'Number of campaigns sent in the last 3 months';
const TOTAL_CAMPAIGNS_SEGMENT_7_DAYS = 'Number of campaigns sent to segment in the last 7 days';
const TOTAL_CAMPAIGNS_SEGMENT_30_DAYS = 'Number of campaigns sent to segment in the last 30 days';
const TOTAL_CAMPAIGNS_SEGMENT_3_MONTHS = 'Number of campaigns sent to segment in the last 3 months';
const TOTAL_CAMPAIGNS_FILTERED_SEGMENT_7_DAYS = 'Number of campaigns filtered by segment in the last 7 days';
const TOTAL_CAMPAIGNS_FILTERED_SEGMENT_30_DAYS = 'Number of campaigns filtered by segment in the last 30 days';
const TOTAL_CAMPAIGNS_FILTERED_SEGMENT_3_MONTHS = 'Number of campaigns filtered by segment in the last 3 months';
/** @var SendingQueuesRepository */
private $sendingQueuesRepository;
public function __construct(
SendingQueuesRepository $sendingQueuesRepository
) {
$this->sendingQueuesRepository = $sendingQueuesRepository;
}
public function getCampaignAnalyticsProperties(): array {
$returnData = [
self::STANDARD_7_DAYS => 0,
self::STANDARD_30_DAYS => 0,
self::STANDARD_3_MONTHS => 0,
self::STANDARD_SEGMENT_7_DAYS => 0,
self::STANDARD_SEGMENT_30_DAYS => 0,
self::STANDARD_SEGMENT_3_MONTHS => 0,
self::STANDARD_FILTERED_SEGMENT_7_DAYS => 0,
self::STANDARD_FILTERED_SEGMENT_30_DAYS => 0,
self::STANDARD_FILTERED_SEGMENT_3_MONTHS => 0,
self::AUTOMATION_7_DAYS => 0,
self::AUTOMATION_30_DAYS => 0,
self::AUTOMATION_3_MONTHS => 0,
self::RE_ENGAGEMENT_7_DAYS => 0,
self::RE_ENGAGEMENT_30_DAYS => 0,
self::RE_ENGAGEMENT_3_MONTHS => 0,
self::RE_ENGAGEMENT_SEGMENT_7_DAYS => 0,
self::RE_ENGAGEMENT_SEGMENT_30_DAYS => 0,
self::RE_ENGAGEMENT_SEGMENT_3_MONTHS => 0,
self::RE_ENGAGEMENT_FILTERED_SEGMENT_7_DAYS => 0,
self::RE_ENGAGEMENT_FILTERED_SEGMENT_30_DAYS => 0,
self::RE_ENGAGEMENT_FILTERED_SEGMENT_3_MONTHS => 0,
self::POST_NOTIFICATION_7_DAYS => 0,
self::POST_NOTIFICATION_30_DAYS => 0,
self::POST_NOTIFICATION_3_MONTHS => 0,
self::POST_NOTIFICATION_SEGMENT_7_DAYS => 0,
self::POST_NOTIFICATION_SEGMENT_30_DAYS => 0,
self::POST_NOTIFICATION_SEGMENT_3_MONTHS => 0,
self::POST_NOTIFICATION_FILTERED_SEGMENT_7_DAYS => 0,
self::POST_NOTIFICATION_FILTERED_SEGMENT_30_DAYS => 0,
self::POST_NOTIFICATION_FILTERED_SEGMENT_3_MONTHS => 0,
// Legacy
self::LEGACY_WELCOME_7_DAYS => 0,
self::LEGACY_WELCOME_30_DAYS => 0,
self::LEGACY_WELCOME_3_MONTHS => 0,
self::LEGACY_ABANDONED_CART_7_DAYS => 0,
self::LEGACY_ABANDONED_CART_30_DAYS => 0,
self::LEGACY_ABANDONED_CART_3_MONTHS => 0,
self::LEGACY_FIRST_PURCHASE_7_DAYS => 0,
self::LEGACY_FIRST_PURCHASE_30_DAYS => 0,
self::LEGACY_FIRST_PURCHASE_3_MONTHS => 0,
self::LEGACY_PURCHASED_IN_CATEGORY_7_DAYS => 0,
self::LEGACY_PURCHASED_IN_CATEGORY_30_DAYS => 0,
self::LEGACY_PURCHASED_IN_CATEGORY_3_MONTHS => 0,
self::LEGACY_PURCHASED_PRODUCT_7_DAYS => 0,
self::LEGACY_PURCHASED_PRODUCT_30_DAYS => 0,
self::LEGACY_PURCHASED_PRODUCT_3_MONTHS => 0,
// Totals
self::TOTAL_CAMPAIGNS_7_DAYS => 0,
self::TOTAL_CAMPAIGNS_30_DAYS => 0,
self::TOTAL_CAMPAIGNS_3_MONTHS => 0,
self::TOTAL_CAMPAIGNS_SEGMENT_7_DAYS => 0,
self::TOTAL_CAMPAIGNS_SEGMENT_30_DAYS => 0,
self::TOTAL_CAMPAIGNS_SEGMENT_3_MONTHS => 0,
self::TOTAL_CAMPAIGNS_FILTERED_SEGMENT_7_DAYS => 0,
self::TOTAL_CAMPAIGNS_FILTERED_SEGMENT_30_DAYS => 0,
self::TOTAL_CAMPAIGNS_FILTERED_SEGMENT_3_MONTHS => 0,
];
$processedResults = $this->getProcessedCampaignAnalytics();
foreach ($processedResults as $campaignId => $processedResult) {
$isNewerThan7DaysAgo = $processedResult['sentLast7Days'] ?? false;
$isNewerThan30DaysAgo = $processedResult['sentLast30Days'] ?? false;
$isNewerThan3MonthsAgo = $processedResult['sentLast3Months'] ?? false;
$newsletterType = $processedResult['newsletterType'];
$wasSentToDynamicSegment = $processedResult['sentToSegment'] ?? false;
$wasFilteredBySegment = $processedResult['filteredBySegment'] ?? false;
// Totals
if ($isNewerThan7DaysAgo) {
$returnData[self::TOTAL_CAMPAIGNS_7_DAYS]++;
$returnData[self::TOTAL_CAMPAIGNS_30_DAYS]++;
$returnData[self::TOTAL_CAMPAIGNS_3_MONTHS]++;
if ($wasSentToDynamicSegment) {
$returnData[self::TOTAL_CAMPAIGNS_SEGMENT_7_DAYS]++;
$returnData[self::TOTAL_CAMPAIGNS_SEGMENT_30_DAYS]++;
$returnData[self::TOTAL_CAMPAIGNS_SEGMENT_3_MONTHS]++;
}
if ($wasFilteredBySegment) {
$returnData[self::TOTAL_CAMPAIGNS_FILTERED_SEGMENT_7_DAYS]++;
$returnData[self::TOTAL_CAMPAIGNS_FILTERED_SEGMENT_30_DAYS]++;
$returnData[self::TOTAL_CAMPAIGNS_FILTERED_SEGMENT_3_MONTHS]++;
}
} elseif ($isNewerThan30DaysAgo) {
$returnData[self::TOTAL_CAMPAIGNS_30_DAYS]++;
$returnData[self::TOTAL_CAMPAIGNS_3_MONTHS]++;
if ($wasSentToDynamicSegment) {
$returnData[self::TOTAL_CAMPAIGNS_SEGMENT_30_DAYS]++;
$returnData[self::TOTAL_CAMPAIGNS_SEGMENT_3_MONTHS]++;
}
if ($wasFilteredBySegment) {
$returnData[self::TOTAL_CAMPAIGNS_FILTERED_SEGMENT_30_DAYS]++;
$returnData[self::TOTAL_CAMPAIGNS_FILTERED_SEGMENT_3_MONTHS]++;
}
} elseif ($isNewerThan3MonthsAgo) {
$returnData[self::TOTAL_CAMPAIGNS_3_MONTHS]++;
if ($wasSentToDynamicSegment) {
$returnData[self::TOTAL_CAMPAIGNS_SEGMENT_3_MONTHS]++;
}
if ($wasFilteredBySegment) {
$returnData[self::TOTAL_CAMPAIGNS_FILTERED_SEGMENT_3_MONTHS]++;
}
}
switch ($newsletterType) {
case NewsletterEntity::TYPE_STANDARD:
if ($isNewerThan7DaysAgo) {
$returnData[self::STANDARD_7_DAYS]++;
$returnData[self::STANDARD_30_DAYS]++;
$returnData[self::STANDARD_3_MONTHS]++;
if ($wasFilteredBySegment) {
$returnData[self::STANDARD_FILTERED_SEGMENT_7_DAYS]++;
$returnData[self::STANDARD_FILTERED_SEGMENT_30_DAYS]++;
$returnData[self::STANDARD_FILTERED_SEGMENT_3_MONTHS]++;
}
if ($wasSentToDynamicSegment) {
$returnData[self::STANDARD_SEGMENT_7_DAYS]++;
$returnData[self::STANDARD_SEGMENT_30_DAYS]++;
$returnData[self::STANDARD_SEGMENT_3_MONTHS]++;
}
} elseif ($isNewerThan30DaysAgo) {
$returnData[self::STANDARD_30_DAYS]++;
$returnData[self::STANDARD_3_MONTHS]++;
if ($wasFilteredBySegment) {
$returnData[self::STANDARD_FILTERED_SEGMENT_30_DAYS]++;
$returnData[self::STANDARD_FILTERED_SEGMENT_3_MONTHS]++;
}
if ($wasSentToDynamicSegment) {
$returnData[self::STANDARD_SEGMENT_30_DAYS]++;
$returnData[self::STANDARD_SEGMENT_3_MONTHS]++;
}
} elseif ($isNewerThan3MonthsAgo) {
$returnData[self::STANDARD_3_MONTHS]++;
if ($wasFilteredBySegment) {
$returnData[self::STANDARD_FILTERED_SEGMENT_3_MONTHS]++;
}
if ($wasSentToDynamicSegment) {
$returnData[self::STANDARD_SEGMENT_3_MONTHS]++;
}
}
break;
case NewsletterEntity::TYPE_NOTIFICATION_HISTORY:
if ($isNewerThan7DaysAgo) {
$returnData[self::POST_NOTIFICATION_7_DAYS]++;
$returnData[self::POST_NOTIFICATION_30_DAYS]++;
$returnData[self::POST_NOTIFICATION_3_MONTHS]++;
if ($wasSentToDynamicSegment) {
$returnData[self::POST_NOTIFICATION_SEGMENT_7_DAYS]++;
$returnData[self::POST_NOTIFICATION_SEGMENT_30_DAYS]++;
$returnData[self::POST_NOTIFICATION_SEGMENT_3_MONTHS]++;
}
if ($wasFilteredBySegment) {
$returnData[self::POST_NOTIFICATION_FILTERED_SEGMENT_7_DAYS]++;
$returnData[self::POST_NOTIFICATION_FILTERED_SEGMENT_30_DAYS]++;
$returnData[self::POST_NOTIFICATION_FILTERED_SEGMENT_3_MONTHS]++;
}
} elseif ($isNewerThan30DaysAgo) {
$returnData[self::POST_NOTIFICATION_30_DAYS]++;
$returnData[self::POST_NOTIFICATION_3_MONTHS]++;
if ($wasSentToDynamicSegment) {
$returnData[self::POST_NOTIFICATION_SEGMENT_30_DAYS]++;
$returnData[self::POST_NOTIFICATION_SEGMENT_3_MONTHS]++;
}
if ($wasFilteredBySegment) {
$returnData[self::POST_NOTIFICATION_FILTERED_SEGMENT_30_DAYS]++;
$returnData[self::POST_NOTIFICATION_FILTERED_SEGMENT_3_MONTHS]++;
}
} elseif ($isNewerThan3MonthsAgo) {
$returnData[self::POST_NOTIFICATION_3_MONTHS]++;
if ($wasSentToDynamicSegment) {
$returnData[self::POST_NOTIFICATION_SEGMENT_3_MONTHS]++;
}
if ($wasFilteredBySegment) {
$returnData[self::POST_NOTIFICATION_FILTERED_SEGMENT_3_MONTHS]++;
}
}
break;
case NewsletterEntity::TYPE_RE_ENGAGEMENT:
if ($isNewerThan7DaysAgo) {
$returnData[self::RE_ENGAGEMENT_7_DAYS]++;
$returnData[self::RE_ENGAGEMENT_30_DAYS]++;
$returnData[self::RE_ENGAGEMENT_3_MONTHS]++;
if ($wasSentToDynamicSegment) {
$returnData[self::RE_ENGAGEMENT_SEGMENT_7_DAYS]++;
$returnData[self::RE_ENGAGEMENT_SEGMENT_30_DAYS]++;
$returnData[self::RE_ENGAGEMENT_SEGMENT_3_MONTHS]++;
}
if ($wasFilteredBySegment) {
$returnData[self::RE_ENGAGEMENT_FILTERED_SEGMENT_7_DAYS]++;
$returnData[self::RE_ENGAGEMENT_FILTERED_SEGMENT_30_DAYS]++;
$returnData[self::RE_ENGAGEMENT_FILTERED_SEGMENT_3_MONTHS]++;
}
} elseif ($isNewerThan30DaysAgo) {
$returnData[self::RE_ENGAGEMENT_30_DAYS]++;
$returnData[self::RE_ENGAGEMENT_3_MONTHS]++;
if ($wasSentToDynamicSegment) {
$returnData[self::RE_ENGAGEMENT_SEGMENT_30_DAYS]++;
$returnData[self::RE_ENGAGEMENT_SEGMENT_3_MONTHS]++;
}
if ($wasFilteredBySegment) {
$returnData[self::RE_ENGAGEMENT_FILTERED_SEGMENT_30_DAYS]++;
$returnData[self::RE_ENGAGEMENT_FILTERED_SEGMENT_3_MONTHS]++;
}
} elseif ($isNewerThan3MonthsAgo) {
$returnData[self::RE_ENGAGEMENT_3_MONTHS]++;
if ($wasSentToDynamicSegment) {
$returnData[self::RE_ENGAGEMENT_SEGMENT_3_MONTHS]++;
}
if ($wasFilteredBySegment) {
$returnData[self::RE_ENGAGEMENT_FILTERED_SEGMENT_3_MONTHS]++;
}
}
break;
case NewsletterEntity::TYPE_WELCOME:
if ($isNewerThan7DaysAgo) {
$returnData[self::LEGACY_WELCOME_7_DAYS]++;
$returnData[self::LEGACY_WELCOME_30_DAYS]++;
$returnData[self::LEGACY_WELCOME_3_MONTHS]++;
} elseif ($isNewerThan30DaysAgo) {
$returnData[self::LEGACY_WELCOME_30_DAYS]++;
$returnData[self::LEGACY_WELCOME_3_MONTHS]++;
} elseif ($isNewerThan3MonthsAgo) {
$returnData[self::LEGACY_WELCOME_3_MONTHS]++;
}
break;
case NewsletterEntity::TYPE_AUTOMATION:
if ($isNewerThan7DaysAgo) {
$returnData[self::AUTOMATION_7_DAYS]++;
$returnData[self::AUTOMATION_30_DAYS]++;
$returnData[self::AUTOMATION_3_MONTHS]++;
} elseif ($isNewerThan30DaysAgo) {
$returnData[self::AUTOMATION_30_DAYS]++;
$returnData[self::AUTOMATION_3_MONTHS]++;
} elseif ($isNewerThan3MonthsAgo) {
$returnData[self::AUTOMATION_3_MONTHS]++;
}
break;
// Legacy automatic emails.
case 'purchasedProduct':
if ($isNewerThan7DaysAgo) {
$returnData[self::LEGACY_PURCHASED_PRODUCT_7_DAYS]++;
$returnData[self::LEGACY_PURCHASED_PRODUCT_30_DAYS]++;
$returnData[self::LEGACY_PURCHASED_PRODUCT_3_MONTHS]++;
} elseif ($isNewerThan30DaysAgo) {
$returnData[self::LEGACY_PURCHASED_PRODUCT_30_DAYS]++;
$returnData[self::LEGACY_PURCHASED_PRODUCT_3_MONTHS]++;
} elseif ($isNewerThan3MonthsAgo) {
$returnData[self::LEGACY_PURCHASED_PRODUCT_3_MONTHS]++;
}
break;
case 'purchasedInCategory':
if ($isNewerThan7DaysAgo) {
$returnData[self::LEGACY_PURCHASED_IN_CATEGORY_7_DAYS]++;
$returnData[self::LEGACY_PURCHASED_IN_CATEGORY_30_DAYS]++;
$returnData[self::LEGACY_PURCHASED_IN_CATEGORY_3_MONTHS]++;
} elseif ($isNewerThan30DaysAgo) {
$returnData[self::LEGACY_PURCHASED_IN_CATEGORY_30_DAYS]++;
$returnData[self::LEGACY_PURCHASED_IN_CATEGORY_3_MONTHS]++;
} elseif ($isNewerThan3MonthsAgo) {
$returnData[self::LEGACY_PURCHASED_IN_CATEGORY_3_MONTHS]++;
}
break;
case 'abandonedCart':
if ($isNewerThan7DaysAgo) {
$returnData[self::LEGACY_ABANDONED_CART_7_DAYS]++;
$returnData[self::LEGACY_ABANDONED_CART_30_DAYS]++;
$returnData[self::LEGACY_ABANDONED_CART_3_MONTHS]++;
} elseif ($isNewerThan30DaysAgo) {
$returnData[self::LEGACY_ABANDONED_CART_30_DAYS]++;
$returnData[self::LEGACY_ABANDONED_CART_3_MONTHS]++;
} elseif ($isNewerThan3MonthsAgo) {
$returnData[self::LEGACY_ABANDONED_CART_3_MONTHS]++;
}
break;
case 'firstPurchase':
if ($isNewerThan7DaysAgo) {
$returnData[self::LEGACY_FIRST_PURCHASE_7_DAYS]++;
$returnData[self::LEGACY_FIRST_PURCHASE_30_DAYS]++;
$returnData[self::LEGACY_FIRST_PURCHASE_3_MONTHS]++;
} elseif ($isNewerThan30DaysAgo) {
$returnData[self::LEGACY_FIRST_PURCHASE_30_DAYS]++;
$returnData[self::LEGACY_FIRST_PURCHASE_3_MONTHS]++;
} elseif ($isNewerThan3MonthsAgo) {
$returnData[self::LEGACY_FIRST_PURCHASE_3_MONTHS]++;
}
break;
}
}
return $returnData;
}
public function getProcessedCampaignAnalytics(): array {
$rawData = $this->sendingQueuesRepository->getCampaignAnalyticsQuery()->getArrayResult();
$processedResults = [];
foreach ($rawData as $sendingInfo) {
$meta = $sendingInfo['sendingQueueMeta'];
$campaignId = $meta['campaignId'] ?? null;
if (!is_string($campaignId)) {
continue;
}
if (!isset($processedResults[$campaignId])) {
$newsletterType = $sendingInfo['newsletterType'];
$processedData = [
'campaignId' => $campaignId,
'newsletterType' => $newsletterType,
'automaticSubType' => null,
'sentToSegment' => (bool)$sendingInfo['sentToSegment'],
'sentLast7Days' => (bool)$sendingInfo['sentLast7Days'],
'sentLast30Days' => (bool)$sendingInfo['sentLast30Days'],
'sentLast3Months' => (bool)$sendingInfo['sentLast3Months'],
'filteredBySegment' => !!($meta['filterSegment'] ?? null),
];
$processedResults[$campaignId] = $processedData;
if ($newsletterType === NewsletterEntity::TYPE_AUTOMATIC) {
try {
// Although we could determine the subtype by joining the appropriate newsletter option field, using
// the meta should be just as reliable, and we need the meta anyway, so this keeps our query simpler.
$subType = $this->getLegacyAutomaticEmailSubtypeFromMeta($meta);
$processedResults[$campaignId]['newsletterType'] = $subType;
} catch (UnexpectedValueException $e) {
// Ignore this error, the `automatic` email type won't be counted
}
}
} else {
if ($sendingInfo['sentLast7Days']) {
$processedResults[$campaignId]['sentLast7Days'] = true;
}
if ($sendingInfo['sentLast30Days']) {
$processedResults[$campaignId]['sentLast30Days'] = true;
}
if ($sendingInfo['sentLast3Months']) {
$processedResults[$campaignId]['sentLast3Months'] = true;
}
if ($sendingInfo['sentToSegment']) {
$processedResults[$campaignId]['sentToSegment'] = true;
}
}
}
return $processedResults;
}
private function getLegacyAutomaticEmailSubtypeFromMeta(array $meta): string {
if (array_key_exists('orderedProducts', $meta)) {
return 'purchasedProduct';
}
if (array_key_exists('orderedProductCategories', $meta)) {
return 'purchasedInCategory';
}
if (array_key_exists('cart_product_ids', $meta)) {
return 'abandonedCart';
}
if (array_key_exists('order_amount', $meta) && array_key_exists('order_date', $meta) && array_key_exists('order_id', $meta)) {
return 'firstPurchase';
}
throw new UnexpectedValueException('Unknown automatic email type based on meta data');
}
}
@@ -0,0 +1,48 @@
<?php declare(strict_types = 1);
namespace MailPoet\Analytics;
if (!defined('ABSPATH')) exit;
use MailPoet\Entities\StatisticsUnsubscribeEntity;
use MailPoet\Statistics\StatisticsUnsubscribesRepository;
class UnsubscribeReporter {
public const TOTAL = 'Unsubscribe > Total in last 6 months';
public const COUNT_PER_METHOD_PATTERN = 'Unsubscribe > Count in last 6 months with method: %s';
/*** @var StatisticsUnsubscribesRepository */
private $statisticsUnsubscribesRepository;
public function __construct(
StatisticsUnsubscribesRepository $statisticsUnsubscribesRepository
) {
$this->statisticsUnsubscribesRepository = $statisticsUnsubscribesRepository;
}
public function getProperties(): array {
$properties = [
self::TOTAL => $this->statisticsUnsubscribesRepository->getTotalForMonths(6),
];
foreach ($this->statisticsUnsubscribesRepository->getCountPerMethodForMonths(6) as $methodStats) {
$properties[sprintf(self::COUNT_PER_METHOD_PATTERN, $this->getMethodName($methodStats['method']))] = $methodStats['count'];
}
return $properties;
}
private function getMethodName(?string $methodKey): string {
if ($methodKey === StatisticsUnsubscribeEntity::METHOD_ONE_CLICK) {
return '1 Click';
}
if ($methodKey === StatisticsUnsubscribeEntity::METHOD_LINK) {
return 'Link';
}
return 'Unknown';
}
}
@@ -0,0 +1 @@
<?php