Analytics.php
3 years ago
AutomatedLatestContent.php
2 months ago
AutomaticEmails.php
3 years ago
Captcha.php
1 year ago
Coupons.php
2 years ago
CustomFields.php
2 months ago
DynamicProducts.php
1 year ago
DynamicSegments.php
2 months ago
FeatureFlags.php
3 years ago
Forms.php
2 months ago
Help.php
1 year ago
ImportExport.php
2 months ago
Mailer.php
1 year ago
NewsletterLinks.php
2 months ago
NewsletterTemplates.php
2 months ago
Newsletters.php
2 months ago
Premium.php
10 months ago
RedirectResponse.php
1 year ago
Segments.php
2 months ago
SendingQueue.php
2 months ago
Services.php
6 months ago
Settings.php
2 months ago
Setup.php
1 year ago
StatisticsExport.php
3 months ago
SubscriberStats.php
1 month ago
Subscribers.php
2 months ago
Tags.php
3 years ago
UserFlags.php
2 years ago
WoocommerceProductVariations.php
2 months ago
WoocommerceSettings.php
3 years ago
index.php
3 years ago
SubscriberStats.php
384 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\API\JSON\v1; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\API\JSON\Endpoint as APIEndpoint; |
| 9 | use MailPoet\API\JSON\Error as APIError; |
| 10 | use MailPoet\Config\AccessControl; |
| 11 | use MailPoet\Entities\CustomFieldEntity; |
| 12 | use MailPoet\Entities\StatisticsUnsubscribeEntity; |
| 13 | use MailPoet\Entities\SubscriberEntity; |
| 14 | use MailPoet\Statistics\StatisticsUnsubscribesRepository; |
| 15 | use MailPoet\Statistics\UnsubscribeReasonTracker; |
| 16 | use MailPoet\Subscribers\Source; |
| 17 | use MailPoet\Subscribers\Statistics\SubscriberStatistics; |
| 18 | use MailPoet\Subscribers\Statistics\SubscriberStatisticsRepository; |
| 19 | use MailPoet\Subscribers\SubscribersRepository; |
| 20 | use MailPoet\WooCommerce\Helper; |
| 21 | use MailPoet\WP\Functions as WPFunctions; |
| 22 | use MailPoetVendor\Carbon\Carbon; |
| 23 | |
| 24 | class SubscriberStats extends APIEndpoint { |
| 25 | public $permissions = [ |
| 26 | 'global' => AccessControl::PERMISSION_MANAGE_SUBSCRIBERS, |
| 27 | ]; |
| 28 | |
| 29 | /** @var SubscribersRepository */ |
| 30 | private $subscribersRepository; |
| 31 | |
| 32 | /** @var SubscriberStatisticsRepository */ |
| 33 | private $subscribersStatisticsRepository; |
| 34 | |
| 35 | /** @var Helper */ |
| 36 | private $wooCommerceHelper; |
| 37 | |
| 38 | /** @var WPFunctions */ |
| 39 | private $wp; |
| 40 | |
| 41 | /** @var StatisticsUnsubscribesRepository */ |
| 42 | private $statisticsUnsubscribesRepository; |
| 43 | |
| 44 | /** @var UnsubscribeReasonTracker */ |
| 45 | private $unsubscribeReasonTracker; |
| 46 | |
| 47 | public function __construct( |
| 48 | SubscribersRepository $subscribersRepository, |
| 49 | SubscriberStatisticsRepository $subscribersStatisticsRepository, |
| 50 | Helper $wooCommerceHelper, |
| 51 | WPFunctions $wp, |
| 52 | StatisticsUnsubscribesRepository $statisticsUnsubscribesRepository, |
| 53 | UnsubscribeReasonTracker $unsubscribeReasonTracker |
| 54 | ) { |
| 55 | $this->subscribersRepository = $subscribersRepository; |
| 56 | $this->subscribersStatisticsRepository = $subscribersStatisticsRepository; |
| 57 | $this->wooCommerceHelper = $wooCommerceHelper; |
| 58 | $this->wp = $wp; |
| 59 | $this->statisticsUnsubscribesRepository = $statisticsUnsubscribesRepository; |
| 60 | $this->unsubscribeReasonTracker = $unsubscribeReasonTracker; |
| 61 | } |
| 62 | |
| 63 | public function get($data) { |
| 64 | $subscriber = isset($data['subscriber_id']) |
| 65 | ? $this->subscribersRepository->findOneById((int)$data['subscriber_id']) |
| 66 | : null; |
| 67 | if (!$subscriber instanceof SubscriberEntity) { |
| 68 | return $this->errorResponse([ |
| 69 | APIError::NOT_FOUND => __('This subscriber does not exist.', 'mailpoet'), |
| 70 | ]); |
| 71 | } |
| 72 | $isWooActive = $this->wooCommerceHelper->isWooCommerceActive(); |
| 73 | $isWoocommerceUser = (bool)$subscriber->getIsWoocommerceUser(); |
| 74 | $dateFormat = 'Y-m-d H:i:s'; |
| 75 | $subscribedAt = $subscriber->getLastSubscribedAt() ?: $subscriber->getCreatedAt(); |
| 76 | $response = [ |
| 77 | 'email' => $subscriber->getEmail(), |
| 78 | 'engagement_score' => $subscriber->getEngagementScore(), |
| 79 | 'engagement_score_type' => $this->subscribersStatisticsRepository->getEngagementScoreType($subscriber), |
| 80 | 'is_woo_active' => $isWooActive, |
| 81 | 'is_woocommerce_user' => $isWoocommerceUser, |
| 82 | 'avatar_url' => $this->wp->getAvatarUrl($subscriber->getEmail(), ['size' => 96]) ?: null, |
| 83 | 'subscribed_at' => $subscribedAt instanceof \DateTimeInterface ? $subscribedAt->format($dateFormat) : null, |
| 84 | 'source_label' => $this->getSourceLabel($subscriber->getSource()), |
| 85 | ]; |
| 86 | |
| 87 | $statsMapper = function(SubscriberStatistics $statistics, string $key, string $timeframe) { |
| 88 | return [ |
| 89 | 'key' => $key, |
| 90 | 'timeframe' => $timeframe, |
| 91 | 'total_sent' => $statistics->getTotalSentCount(), |
| 92 | 'open' => $statistics->getOpenCount(), |
| 93 | 'machine_open' => $statistics->getMachineOpenCount(), |
| 94 | 'click' => $statistics->getClickCount(), |
| 95 | 'woocommerce' => $statistics->getWooCommerceRevenue() ? $statistics->getWooCommerceRevenue()->asArray() : null, |
| 96 | ]; |
| 97 | }; |
| 98 | |
| 99 | $now = Carbon::now(); |
| 100 | $periods = [ |
| 101 | [ |
| 102 | 'key' => '7_days', |
| 103 | 'label' => __('7 days', 'mailpoet'), |
| 104 | 'start' => $now->copy()->subDays(7), |
| 105 | ], |
| 106 | [ |
| 107 | 'key' => '30_days', |
| 108 | 'label' => __('30 days', 'mailpoet'), |
| 109 | 'start' => $now->copy()->subDays(30), |
| 110 | ], |
| 111 | [ |
| 112 | 'key' => '3_months', |
| 113 | 'label' => __('3 months', 'mailpoet'), |
| 114 | 'start' => $now->copy()->subMonths(3), |
| 115 | ], |
| 116 | [ |
| 117 | 'key' => '12_months', |
| 118 | 'label' => __('12 months', 'mailpoet'), |
| 119 | 'start' => $now->copy()->subMonths(12), |
| 120 | ], |
| 121 | [ |
| 122 | 'key' => 'lifetime', |
| 123 | 'label' => __('Lifetime', 'mailpoet'), |
| 124 | 'start' => null, |
| 125 | ], |
| 126 | ]; |
| 127 | |
| 128 | $lifetimeStats = $this->subscribersStatisticsRepository->getStatistics($subscriber); |
| 129 | $response['periodic_stats'] = []; |
| 130 | foreach ($periods as $period) { |
| 131 | $periodStats = $period['key'] === 'lifetime' |
| 132 | ? $lifetimeStats |
| 133 | : $this->subscribersStatisticsRepository->getStatistics($subscriber, $period['start']); |
| 134 | $response['periodic_stats'][] = $statsMapper($periodStats, $period['key'], $period['label']); |
| 135 | } |
| 136 | |
| 137 | $response['profile'] = $this->getProfile($subscriber, $isWooActive); |
| 138 | |
| 139 | if ($isWooActive && $isWoocommerceUser) { |
| 140 | $lifetimeRevenue = $lifetimeStats->getWooCommerceRevenue(); |
| 141 | if ($lifetimeRevenue !== null) { |
| 142 | $response['woocommerce_overview'] = [ |
| 143 | 'orders_count' => $lifetimeRevenue->getOrdersCount(), |
| 144 | 'total_revenue_formatted' => $lifetimeRevenue->getFormattedValue(), |
| 145 | 'average_order_value_formatted' => $lifetimeRevenue->getFormattedAverageValue(), |
| 146 | 'orders_url' => $this->getCustomerOrdersUrl($subscriber), |
| 147 | ]; |
| 148 | } |
| 149 | } |
| 150 | |
| 151 | $lastEngagement = $subscriber->getLastEngagementAt(); |
| 152 | if ($lastEngagement instanceof \DateTimeInterface) { |
| 153 | $response['last_engagement'] = $lastEngagement->format($dateFormat); |
| 154 | } |
| 155 | $lastClick = $subscriber->getLastClickAt(); |
| 156 | if ($lastClick instanceof \DateTimeInterface) { |
| 157 | $response['last_click'] = $lastClick->format($dateFormat); |
| 158 | } |
| 159 | $lastOpen = $subscriber->getLastOpenAt(); |
| 160 | if ($lastOpen instanceof \DateTimeInterface) { |
| 161 | $response['last_open'] = $lastOpen->format($dateFormat); |
| 162 | } |
| 163 | $lastPageView = $subscriber->getLastPageViewAt(); |
| 164 | if ($lastPageView instanceof \DateTimeInterface) { |
| 165 | $response['last_page_view'] = $lastPageView->format($dateFormat); |
| 166 | } |
| 167 | $lastPurchase = $subscriber->getLastPurchaseAt(); |
| 168 | if ($lastPurchase instanceof \DateTimeInterface) { |
| 169 | $response['last_purchase'] = $lastPurchase->format($dateFormat); |
| 170 | } |
| 171 | $lastSending = $subscriber->getLastSendingAt(); |
| 172 | if ($lastSending instanceof \DateTimeInterface) { |
| 173 | $response['last_sending'] = $lastSending->format($dateFormat); |
| 174 | } |
| 175 | return $this->successResponse($response); |
| 176 | } |
| 177 | |
| 178 | private function getSourceLabel(?string $source): ?string { |
| 179 | switch ($source) { |
| 180 | case Source::FORM: |
| 181 | return __('MailPoet subscription form', 'mailpoet'); |
| 182 | case Source::IMPORTED: |
| 183 | return __('import', 'mailpoet'); |
| 184 | case Source::ADMINISTRATOR: |
| 185 | return __('admin', 'mailpoet'); |
| 186 | case Source::API: |
| 187 | return __('API', 'mailpoet'); |
| 188 | case Source::WORDPRESS_USER: |
| 189 | return __('WordPress user sync', 'mailpoet'); |
| 190 | case Source::WORDPRESS_USER_DELETED: |
| 191 | return __('WordPress user (deleted)', 'mailpoet'); |
| 192 | case Source::WOOCOMMERCE_USER: |
| 193 | return __('WooCommerce customer sync', 'mailpoet'); |
| 194 | case Source::WOOCOMMERCE_CHECKOUT: |
| 195 | return __('WooCommerce checkout', 'mailpoet'); |
| 196 | default: |
| 197 | return null; |
| 198 | } |
| 199 | } |
| 200 | |
| 201 | private function getProfile(SubscriberEntity $subscriber, bool $isWooActive): array { |
| 202 | return [ |
| 203 | 'status' => $subscriber->getStatus(), |
| 204 | 'first_name' => $subscriber->getFirstName(), |
| 205 | 'last_name' => $subscriber->getLastName(), |
| 206 | 'email' => $subscriber->getEmail(), |
| 207 | 'shipping_address' => $isWooActive ? $this->getShippingAddress($subscriber) : [], |
| 208 | 'tags' => $this->getTags($subscriber), |
| 209 | 'segments' => $this->getSegments($subscriber), |
| 210 | 'custom_fields' => $this->getCustomFields($subscriber), |
| 211 | 'unsubscribe_reason' => $this->getProfileUnsubscribeReason($subscriber), |
| 212 | ]; |
| 213 | } |
| 214 | |
| 215 | private function getProfileUnsubscribeReason(SubscriberEntity $subscriber): ?string { |
| 216 | $latest = $this->statisticsUnsubscribesRepository->findLatestForSubscriber($subscriber); |
| 217 | if (!$latest instanceof StatisticsUnsubscribeEntity) { |
| 218 | return null; |
| 219 | } |
| 220 | $reason = $latest->getReason(); |
| 221 | $reasonText = $latest->getReasonText(); |
| 222 | $trimmedText = $reasonText !== null ? trim($reasonText) : ''; |
| 223 | if ($trimmedText !== '') { |
| 224 | return $trimmedText; |
| 225 | } |
| 226 | $labels = $this->unsubscribeReasonTracker->getReasonLabels(); |
| 227 | if ($reason !== null && isset($labels[$reason])) { |
| 228 | return $labels[$reason]; |
| 229 | } |
| 230 | return __('No reason provided', 'mailpoet'); |
| 231 | } |
| 232 | |
| 233 | private function getTags(SubscriberEntity $subscriber): array { |
| 234 | $result = []; |
| 235 | foreach ($subscriber->getSubscriberTags() as $subscriberTag) { |
| 236 | $tag = $subscriberTag->getTag(); |
| 237 | if (!$tag) { |
| 238 | continue; |
| 239 | } |
| 240 | $result[] = [ |
| 241 | 'id' => (string)$subscriberTag->getId(), |
| 242 | 'subscriber_id' => (string)$subscriber->getId(), |
| 243 | 'tag_id' => (string)$tag->getId(), |
| 244 | 'name' => $tag->getName(), |
| 245 | ]; |
| 246 | } |
| 247 | return $result; |
| 248 | } |
| 249 | |
| 250 | private function getSegments(SubscriberEntity $subscriber): array { |
| 251 | $result = []; |
| 252 | foreach ($subscriber->getSubscriberSegments(SubscriberEntity::STATUS_SUBSCRIBED) as $subscriberSegment) { |
| 253 | $segment = $subscriberSegment->getSegment(); |
| 254 | if (!$segment) { |
| 255 | continue; |
| 256 | } |
| 257 | $result[] = [ |
| 258 | 'id' => (string)$segment->getId(), |
| 259 | 'name' => $segment->getName(), |
| 260 | ]; |
| 261 | } |
| 262 | return $result; |
| 263 | } |
| 264 | |
| 265 | private function getCustomFields(SubscriberEntity $subscriber): array { |
| 266 | $result = []; |
| 267 | foreach ($subscriber->getSubscriberCustomFields() as $subscriberCustomField) { |
| 268 | $customField = $subscriberCustomField->getCustomField(); |
| 269 | if (!$customField instanceof CustomFieldEntity) { |
| 270 | continue; |
| 271 | } |
| 272 | $value = $subscriberCustomField->getValue(); |
| 273 | if ($value === '') { |
| 274 | continue; |
| 275 | } |
| 276 | $result[] = [ |
| 277 | 'id' => (string)$customField->getId(), |
| 278 | 'name' => $customField->getName(), |
| 279 | 'value' => $value, |
| 280 | ]; |
| 281 | } |
| 282 | return $result; |
| 283 | } |
| 284 | |
| 285 | private function getShippingAddress(SubscriberEntity $subscriber): array { |
| 286 | $address = []; |
| 287 | $customer = null; |
| 288 | $wpUserId = $subscriber->getWpUserId(); |
| 289 | if ($wpUserId) { |
| 290 | $customer = $this->wooCommerceHelper->wcGetCustomer((int)$wpUserId); |
| 291 | if ($customer) { |
| 292 | $address = $this->getShippingAddressParts($customer); |
| 293 | } |
| 294 | } |
| 295 | |
| 296 | if (!$address && ($subscriber->getIsWoocommerceUser() || $customer)) { |
| 297 | $order = $this->getLatestWooCommerceOrderByEmail($subscriber->getEmail()); |
| 298 | if ($order) { |
| 299 | $address = $this->getShippingAddressParts($order); |
| 300 | } |
| 301 | } |
| 302 | |
| 303 | return $this->formatShippingAddress($address); |
| 304 | } |
| 305 | |
| 306 | private function getLatestWooCommerceOrderByEmail(string $email) { |
| 307 | $orders = $this->wooCommerceHelper->wcGetOrders([ |
| 308 | 'billing_email' => $email, |
| 309 | 'limit' => 1, |
| 310 | 'orderby' => 'date', |
| 311 | 'order' => 'DESC', |
| 312 | ]); |
| 313 | return $orders[0] ?? null; |
| 314 | } |
| 315 | |
| 316 | private function getShippingAddressParts($source): array { |
| 317 | $address = []; |
| 318 | $hasAddress = false; |
| 319 | foreach (['first_name', 'last_name', 'company', 'address_1', 'address_2', 'city', 'state', 'postcode', 'country'] as $field) { |
| 320 | $method = 'get_shipping_' . $field; |
| 321 | $address[$field] = method_exists($source, $method) ? trim((string)$source->$method()) : ''; |
| 322 | if (in_array($field, ['address_1', 'address_2', 'city', 'postcode'], true) && $address[$field] !== '') { |
| 323 | $hasAddress = true; |
| 324 | } |
| 325 | } |
| 326 | if (!$hasAddress) { |
| 327 | return []; |
| 328 | } |
| 329 | return array_filter($address, function($value) { |
| 330 | return $value !== ''; |
| 331 | }); |
| 332 | } |
| 333 | |
| 334 | private function formatShippingAddress(array $address): array { |
| 335 | if (!$address) { |
| 336 | return []; |
| 337 | } |
| 338 | |
| 339 | $formatted = ''; |
| 340 | try { |
| 341 | $formatted = (string)$this->wooCommerceHelper->WC()->countries->get_formatted_address($address); |
| 342 | } catch (\Throwable $e) { |
| 343 | $formatted = ''; |
| 344 | } |
| 345 | |
| 346 | if ($formatted !== '') { |
| 347 | $formatted = str_replace(['<br/>', '<br />', '<br>'], "\n", $formatted); |
| 348 | return array_values(array_filter( |
| 349 | array_map('trim', explode("\n", strip_tags($formatted))) |
| 350 | )); |
| 351 | } |
| 352 | |
| 353 | $lines = [ |
| 354 | trim(implode(' ', array_filter([ |
| 355 | $address['first_name'] ?? '', |
| 356 | $address['last_name'] ?? '', |
| 357 | ]))), |
| 358 | $address['company'] ?? '', |
| 359 | $address['address_1'] ?? '', |
| 360 | $address['address_2'] ?? '', |
| 361 | trim(implode(' ', array_filter([ |
| 362 | $address['city'] ?? '', |
| 363 | $address['state'] ?? '', |
| 364 | $address['postcode'] ?? '', |
| 365 | ]))), |
| 366 | $address['country'] ?? '', |
| 367 | ]; |
| 368 | return array_values(array_filter(array_map('trim', $lines))); |
| 369 | } |
| 370 | |
| 371 | private function getCustomerOrdersUrl(SubscriberEntity $subscriber): string { |
| 372 | $path = $this->wooCommerceHelper->isWooCommerceCustomOrdersTableEnabled() |
| 373 | ? 'admin.php?page=wc-orders' |
| 374 | : 'edit.php?post_type=shop_order'; |
| 375 | $wpUserId = $subscriber->getWpUserId(); |
| 376 | if ($wpUserId) { |
| 377 | $path .= '&_customer_user=' . (int)$wpUserId; |
| 378 | } else { |
| 379 | $path .= '&s=' . rawurlencode($subscriber->getEmail()); |
| 380 | } |
| 381 | return $this->wp->adminUrl($path); |
| 382 | } |
| 383 | } |
| 384 |