AutomationRunLogStorage.php
1 year ago
AutomationRunStorage.php
2 months ago
AutomationStatisticsStorage.php
1 month ago
AutomationStorage.php
2 months ago
index.php
3 years ago
AutomationStatisticsStorage.php
353 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Automation\Engine\Storage; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Automation\Engine\Data\Automation; |
| 9 | use MailPoet\Automation\Engine\Data\AutomationRun; |
| 10 | use MailPoet\Automation\Engine\Data\AutomationStatistics; |
| 11 | |
| 12 | class AutomationStatisticsStorage { |
| 13 | /** @var string */ |
| 14 | private $table; |
| 15 | |
| 16 | public function __construct() { |
| 17 | global $wpdb; |
| 18 | $this->table = $wpdb->prefix . 'mailpoet_automation_runs'; |
| 19 | } |
| 20 | |
| 21 | /** @return AutomationStatistics[] */ |
| 22 | public function getAutomationStatisticsForAutomations(Automation ...$automations): array { |
| 23 | if (empty($automations)) { |
| 24 | return []; |
| 25 | } |
| 26 | $automationIds = array_map( |
| 27 | function(Automation $automation): int { |
| 28 | return $automation->getId(); |
| 29 | }, |
| 30 | $automations |
| 31 | ); |
| 32 | |
| 33 | $data = $this->getStatistics($automationIds); |
| 34 | $statistics = []; |
| 35 | foreach ($automationIds as $id) { |
| 36 | $emailStats = $this->getEmailStatistics($id); |
| 37 | $statistics[$id] = new AutomationStatistics( |
| 38 | $id, |
| 39 | (int)($data[$id]['total'] ?? 0), |
| 40 | (int)($data[$id]['running'] ?? 0), |
| 41 | null, |
| 42 | $emailStats['sent'], |
| 43 | $emailStats['opened'], |
| 44 | $emailStats['clicked'], |
| 45 | $emailStats['orders'], |
| 46 | $emailStats['revenue'] |
| 47 | ); |
| 48 | } |
| 49 | return $statistics; |
| 50 | } |
| 51 | |
| 52 | public function getAutomationStats(int $automationId, ?int $versionId = null, ?\DateTimeImmutable $after = null, ?\DateTimeImmutable $before = null): AutomationStatistics { |
| 53 | $data = $this->getStatistics([$automationId], $versionId, $after, $before); |
| 54 | $emailStats = $this->getEmailStatistics($automationId, $versionId, $after, $before); |
| 55 | |
| 56 | return new AutomationStatistics( |
| 57 | $automationId, |
| 58 | (int)($data[$automationId]['total'] ?? 0), |
| 59 | (int)($data[$automationId]['running'] ?? 0), |
| 60 | $versionId, |
| 61 | $emailStats['sent'], |
| 62 | $emailStats['opened'], |
| 63 | $emailStats['clicked'], |
| 64 | $emailStats['orders'], |
| 65 | $emailStats['revenue'] |
| 66 | ); |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * @param int[] $automationIds |
| 71 | * @return array<int, array{id: int, total: int, running: int}> |
| 72 | */ |
| 73 | private function getStatistics(array $automationIds, ?int $versionId = null, ?\DateTimeImmutable $after = null, ?\DateTimeImmutable $before = null): array { |
| 74 | global $wpdb; |
| 75 | $totalSubquery = $this->getStatsQuery($automationIds, $versionId, $after, $before); |
| 76 | $runningSubquery = $this->getStatsQuery($automationIds, $versionId, $after, $before, AutomationRun::STATUS_RUNNING); |
| 77 | |
| 78 | $results = (array)$wpdb->get_results( |
| 79 | ' |
| 80 | SELECT t.id, t.count AS total, r.count AS running |
| 81 | FROM (' . $totalSubquery /* phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- The subquery was already prepared. */ . ') t |
| 82 | LEFT JOIN (' . $runningSubquery /* phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- The subquery was already prepared. */ . ') r ON t.id = r.id |
| 83 | ', |
| 84 | ARRAY_A |
| 85 | ); |
| 86 | |
| 87 | /** @var array{id: int, total: int, running: int} $results */ |
| 88 | return array_combine(array_column($results, 'id'), $results) ?: []; |
| 89 | } |
| 90 | |
| 91 | private function getStatsQuery(array $automationIds, ?int $versionId = null, ?\DateTimeImmutable $after = null, ?\DateTimeImmutable $before = null, ?string $status = null): string { |
| 92 | global $wpdb; |
| 93 | |
| 94 | $versionCondition = $versionId ? 'AND version_id = %d' : ''; |
| 95 | $statusCondition = $status ? 'AND status = %s' : ''; |
| 96 | $dateCondition = $after !== null && $before !== null ? 'AND created_at BETWEEN %s AND %s' : ''; |
| 97 | |
| 98 | $coditions = "$versionCondition $statusCondition $dateCondition"; |
| 99 | $query = $wpdb->prepare( |
| 100 | ' |
| 101 | SELECT automation_id AS id, COUNT(*) AS count |
| 102 | FROM %i |
| 103 | WHERE automation_id IN (' . implode(',', array_fill(0, count($automationIds), '%d')) . ') |
| 104 | ' . $coditions . /* phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- The conditions use placeholders. */ ' |
| 105 | GROUP BY automation_id |
| 106 | ', |
| 107 | array_merge( |
| 108 | [$this->table], |
| 109 | $automationIds, |
| 110 | $versionId ? [$versionId] : [], |
| 111 | $status ? [$status] : [], |
| 112 | $after !== null && $before !== null ? [$after->format('Y-m-d H:i:s'), $before->format('Y-m-d H:i:s')] : [] |
| 113 | ) |
| 114 | ); |
| 115 | return strval($query); |
| 116 | } |
| 117 | |
| 118 | private function getAutomationEmailIds(int $automationId, ?int $versionId = null): array { |
| 119 | global $wpdb; |
| 120 | |
| 121 | $versionsTable = $wpdb->prefix . 'mailpoet_automation_versions'; |
| 122 | |
| 123 | if ($versionId) { |
| 124 | $query = $wpdb->prepare( |
| 125 | ' |
| 126 | SELECT steps |
| 127 | FROM %i |
| 128 | WHERE automation_id = %d |
| 129 | AND id = %d |
| 130 | ', |
| 131 | [$versionsTable, $automationId, $versionId] |
| 132 | ); |
| 133 | } else { |
| 134 | $query = $wpdb->prepare( |
| 135 | ' |
| 136 | SELECT steps |
| 137 | FROM %i |
| 138 | WHERE automation_id = %d |
| 139 | ', |
| 140 | [$versionsTable, $automationId] |
| 141 | ); |
| 142 | } |
| 143 | |
| 144 | $results = $wpdb->get_results($query, ARRAY_A); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Query is prepared above. |
| 145 | $emailIds = []; |
| 146 | |
| 147 | foreach ($results as $result) { |
| 148 | $steps = json_decode($result['steps'], true); |
| 149 | if (!is_array($steps)) { |
| 150 | continue; |
| 151 | } |
| 152 | |
| 153 | foreach ($steps as $step) { |
| 154 | if ( |
| 155 | is_array($step) |
| 156 | && isset($step['key'], $step['args']) |
| 157 | && $step['key'] === 'mailpoet:send-email' |
| 158 | && is_array($step['args']) |
| 159 | && isset($step['args']['email_id']) |
| 160 | && is_numeric($step['args']['email_id']) |
| 161 | ) { |
| 162 | $emailIds[] = (int)$step['args']['email_id']; |
| 163 | } |
| 164 | } |
| 165 | } |
| 166 | |
| 167 | return array_unique($emailIds); |
| 168 | } |
| 169 | |
| 170 | private function queryEmailStatistics(array $emailIds, ?\DateTimeImmutable $after = null, ?\DateTimeImmutable $before = null): array { |
| 171 | if (empty($emailIds)) { |
| 172 | return ['sent' => 0, 'opened' => 0, 'clicked' => 0, 'orders' => 0, 'revenue' => 0.0]; |
| 173 | } |
| 174 | |
| 175 | $dateCondition = ''; |
| 176 | $dateParams = []; |
| 177 | if ($after && $before) { |
| 178 | $dateCondition = 'AND created_at BETWEEN %s AND %s'; |
| 179 | $dateParams = [$after->format('Y-m-d H:i:s'), $before->format('Y-m-d H:i:s')]; |
| 180 | } elseif ($after && $before === null) { |
| 181 | $dateCondition = 'AND created_at >= %s'; |
| 182 | $dateParams = [$after->format('Y-m-d H:i:s')]; |
| 183 | } elseif ($after === null && $before) { |
| 184 | $dateCondition = 'AND created_at <= %s'; |
| 185 | $dateParams = [$before->format('Y-m-d H:i:s')]; |
| 186 | } |
| 187 | |
| 188 | $sentCounts = $this->getEmailSentCounts($emailIds, $dateCondition, $dateParams); |
| 189 | $openCounts = $this->getEmailOpenCounts($emailIds, $dateCondition, $dateParams); |
| 190 | $clickCounts = $this->getEmailClickCounts($emailIds, $dateCondition, $dateParams); |
| 191 | $revenueData = $this->getEmailRevenueCounts($emailIds, $dateCondition, $dateParams); |
| 192 | |
| 193 | // Sum all the per-email results |
| 194 | $totalSent = array_sum($sentCounts); |
| 195 | $totalOpened = array_sum($openCounts); |
| 196 | $totalClicked = array_sum($clickCounts); |
| 197 | $totalOrders = array_sum(array_column($revenueData, 'orders')); |
| 198 | $totalRevenue = array_sum(array_column($revenueData, 'revenue')); |
| 199 | |
| 200 | return [ |
| 201 | 'sent' => $totalSent, |
| 202 | 'opened' => $totalOpened, |
| 203 | 'clicked' => $totalClicked, |
| 204 | 'orders' => $totalOrders, |
| 205 | 'revenue' => $totalRevenue, |
| 206 | ]; |
| 207 | } |
| 208 | |
| 209 | private function getEmailSentCounts(array $emailIds, string $dateCondition, array $dateParams): array { |
| 210 | global $wpdb; |
| 211 | |
| 212 | if (empty($emailIds)) { |
| 213 | return []; |
| 214 | } |
| 215 | |
| 216 | // phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber, WordPress.DB.PreparedSQL.NotPrepared -- The number of replacements is dynamic. |
| 217 | $results = $wpdb->get_results( |
| 218 | $wpdb->prepare( |
| 219 | ' |
| 220 | SELECT sq.newsletter_id, SUM(sq.count_processed) as total |
| 221 | FROM %i sq |
| 222 | JOIN %i st ON sq.task_id = st.id |
| 223 | WHERE sq.newsletter_id IN (' . implode(',', array_fill(0, count($emailIds), '%d')) . ') |
| 224 | AND st.status = %s |
| 225 | ' . ($dateCondition ? str_replace('created_at', 'sq.created_at', $dateCondition) : '') . /* phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- The condition uses placeholders. */ ' |
| 226 | GROUP BY sq.newsletter_id |
| 227 | ', |
| 228 | array_merge( |
| 229 | [$wpdb->prefix . 'mailpoet_sending_queues', $wpdb->prefix . 'mailpoet_scheduled_tasks'], |
| 230 | $emailIds, |
| 231 | ['completed'], |
| 232 | $dateParams |
| 233 | ) |
| 234 | ), |
| 235 | ARRAY_A |
| 236 | ); |
| 237 | $counts = []; |
| 238 | foreach ($results as $result) { |
| 239 | $counts[(int)$result['newsletter_id']] = (int)$result['total']; |
| 240 | } |
| 241 | return $counts; |
| 242 | } |
| 243 | |
| 244 | private function getEmailOpenCounts(array $emailIds, string $dateCondition, array $dateParams): array { |
| 245 | global $wpdb; |
| 246 | |
| 247 | if (empty($emailIds)) { |
| 248 | return []; |
| 249 | } |
| 250 | |
| 251 | $query = $wpdb->prepare(' |
| 252 | SELECT newsletter_id, COUNT(DISTINCT subscriber_id) as total |
| 253 | FROM %i |
| 254 | WHERE newsletter_id IN (' . implode(',', array_fill(0, count($emailIds), '%d')) . ') |
| 255 | AND ((user_agent_type = %d) OR (user_agent_type IS NULL)) |
| 256 | ' . $dateCondition /* phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- The date condition uses placeholders. */ . ' |
| 257 | GROUP BY newsletter_id |
| 258 | ', array_merge( |
| 259 | [$wpdb->prefix . 'mailpoet_statistics_opens'], |
| 260 | $emailIds, |
| 261 | [0], // USER_AGENT_TYPE_HUMAN = 0 |
| 262 | $dateParams |
| 263 | )); |
| 264 | $results = $wpdb->get_results($query, ARRAY_A); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Query is prepared above. |
| 265 | $counts = []; |
| 266 | foreach ($results as $result) { |
| 267 | $counts[(int)$result['newsletter_id']] = (int)$result['total']; |
| 268 | } |
| 269 | return $counts; |
| 270 | } |
| 271 | |
| 272 | private function getEmailClickCounts(array $emailIds, string $dateCondition, array $dateParams): array { |
| 273 | global $wpdb; |
| 274 | |
| 275 | if (empty($emailIds)) { |
| 276 | return []; |
| 277 | } |
| 278 | |
| 279 | // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Dynamic placeholders are used with prepare(). |
| 280 | $query = $wpdb->prepare(' |
| 281 | SELECT newsletter_id, COUNT(DISTINCT subscriber_id) as total |
| 282 | FROM %i |
| 283 | WHERE newsletter_id IN (' . implode(',', array_fill(0, count($emailIds), '%d')) . ') |
| 284 | AND ((user_agent_type = %d) OR (user_agent_type IS NULL)) |
| 285 | ' . $dateCondition /* phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- The date condition uses placeholders. */ . ' |
| 286 | GROUP BY newsletter_id |
| 287 | ', array_merge( |
| 288 | [$wpdb->prefix . 'mailpoet_statistics_clicks'], |
| 289 | $emailIds, |
| 290 | [0], // USER_AGENT_TYPE_HUMAN = 0 |
| 291 | $dateParams |
| 292 | )); |
| 293 | $results = $wpdb->get_results($query, ARRAY_A); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Query is prepared above. |
| 294 | $counts = []; |
| 295 | foreach ($results as $result) { |
| 296 | $counts[(int)$result['newsletter_id']] = (int)$result['total']; |
| 297 | } |
| 298 | return $counts; |
| 299 | } |
| 300 | |
| 301 | private function getEmailRevenueCounts(array $emailIds, string $dateCondition, array $dateParams): array { |
| 302 | global $wpdb; |
| 303 | |
| 304 | // Check if WooCommerce is active before querying |
| 305 | if (!function_exists('get_woocommerce_currency')) { |
| 306 | return []; |
| 307 | } |
| 308 | |
| 309 | if (empty($emailIds)) { |
| 310 | return []; |
| 311 | } |
| 312 | |
| 313 | $currency = get_woocommerce_currency(); |
| 314 | |
| 315 | // Use the same purchase states as overview (defaults to ['completed'] but could be filtered) |
| 316 | $purchaseStates = ['completed']; // Default value matching WCHelper::getPurchaseStates() |
| 317 | if (function_exists('apply_filters')) { |
| 318 | $purchaseStates = apply_filters('mailpoet_purchase_order_states', $purchaseStates); |
| 319 | } |
| 320 | |
| 321 | // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Dynamic placeholders are used with prepare(). |
| 322 | $query = $wpdb->prepare(' |
| 323 | SELECT newsletter_id, COUNT(id) as orders, SUM(order_price_total) as revenue |
| 324 | FROM %i |
| 325 | WHERE newsletter_id IN (' . implode(',', array_fill(0, count($emailIds), '%d')) . ') |
| 326 | AND status IN (' . implode(',', array_fill(0, count($purchaseStates), '%s')) . ') |
| 327 | AND order_currency = %s |
| 328 | ' . $dateCondition . /* phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- The date condition uses placeholders. */ ' |
| 329 | GROUP BY newsletter_id |
| 330 | ', array_merge( |
| 331 | [$wpdb->prefix . 'mailpoet_statistics_woocommerce_purchases'], |
| 332 | $emailIds, |
| 333 | $purchaseStates, |
| 334 | [$currency], |
| 335 | $dateParams |
| 336 | )); |
| 337 | $results = $wpdb->get_results($query, ARRAY_A); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Query is prepared above. |
| 338 | $revenueData = []; |
| 339 | foreach ($results as $result) { |
| 340 | $revenueData[(int)$result['newsletter_id']] = [ |
| 341 | 'orders' => (int)$result['orders'], |
| 342 | 'revenue' => (float)$result['revenue'], |
| 343 | ]; |
| 344 | } |
| 345 | return $revenueData; |
| 346 | } |
| 347 | |
| 348 | private function getEmailStatistics(int $automationId, ?int $versionId = null, ?\DateTimeImmutable $after = null, ?\DateTimeImmutable $before = null): array { |
| 349 | $emailIds = $this->getAutomationEmailIds($automationId, $versionId); |
| 350 | return $this->queryEmailStatistics($emailIds, $after, $before); |
| 351 | } |
| 352 | } |
| 353 |