StatisticsExporter.php
258 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Newsletter\Statistics\Export; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\NewsletterEntity; |
| 9 | use MailPoet\Newsletter\Statistics\NewsletterStatistics; |
| 10 | use MailPoet\Newsletter\Statistics\NewsletterStatisticsRepository; |
| 11 | use MailPoet\Newsletter\Statistics\WooCommerceRevenue; |
| 12 | use MailPoet\Router\Endpoints\ExportDownload; |
| 13 | use MailPoet\WP\Functions as WPFunctions; |
| 14 | use MailPoetVendor\XLSXWriter; |
| 15 | |
| 16 | class StatisticsExporter { |
| 17 | public const FORMAT_CSV = 'csv'; |
| 18 | public const FORMAT_XLSX = 'xlsx'; |
| 19 | |
| 20 | public const FILE_PREFIX = 'MailPoet_stats_export_'; |
| 21 | /** |
| 22 | * Filter applied to populate per-recipient rows when exporting recipients. |
| 23 | * The free plugin ships an empty implementation; the premium plugin |
| 24 | * registers a callback that returns the per-recipient data. |
| 25 | * |
| 26 | * Filter signature: (array $rows, NewsletterEntity $newsletter): array |
| 27 | */ |
| 28 | public const FILTER_RECIPIENT_ROWS = 'mailpoet_statistics_export_recipient_rows'; |
| 29 | |
| 30 | /** @var NewsletterStatisticsRepository */ |
| 31 | private $statisticsRepository; |
| 32 | |
| 33 | /** @var WPFunctions */ |
| 34 | private $wp; |
| 35 | |
| 36 | public function __construct( |
| 37 | NewsletterStatisticsRepository $statisticsRepository, |
| 38 | WPFunctions $wp |
| 39 | ) { |
| 40 | $this->statisticsRepository = $statisticsRepository; |
| 41 | $this->wp = $wp; |
| 42 | } |
| 43 | |
| 44 | /** |
| 45 | * Export aggregate stats for a single newsletter to CSV or XLSX. |
| 46 | * |
| 47 | * @return array{exportFileURL: string, totalExported: int} |
| 48 | */ |
| 49 | public function exportSingleAggregate(NewsletterEntity $newsletter, string $format): array { |
| 50 | $format = $this->normalizeFormat($format); |
| 51 | $headers = $this->getAggregateHeaders(); |
| 52 | $stats = $this->statisticsRepository->getStatistics($newsletter); |
| 53 | $row = $this->buildAggregateRow($newsletter, $stats); |
| 54 | |
| 55 | $this->ensureExportDirectory(); |
| 56 | $file = ExportDownload::createExportFile(self::FILE_PREFIX, $format); |
| 57 | $this->writeFile($file['path'], $headers, [$row], $format); |
| 58 | |
| 59 | return [ |
| 60 | 'exportFileURL' => $this->getExportFileUrl($file['token'], $format), |
| 61 | 'totalExported' => 1, |
| 62 | ]; |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * Export aggregate stats for multiple newsletters to CSV or XLSX (one |
| 67 | * row per newsletter). Used by the bulk export action on the listing. |
| 68 | * |
| 69 | * @param NewsletterEntity[] $newsletters |
| 70 | * @return array{exportFileURL: string, totalExported: int} |
| 71 | */ |
| 72 | public function exportBulkAggregate(array $newsletters, string $format): array { |
| 73 | $format = $this->normalizeFormat($format); |
| 74 | $headers = $this->getAggregateHeaders(); |
| 75 | |
| 76 | $rows = []; |
| 77 | foreach ($newsletters as $newsletter) { |
| 78 | if (!$newsletter instanceof NewsletterEntity) { |
| 79 | continue; |
| 80 | } |
| 81 | $stats = $this->statisticsRepository->getStatistics($newsletter); |
| 82 | $rows[] = $this->buildAggregateRow($newsletter, $stats); |
| 83 | } |
| 84 | |
| 85 | $this->ensureExportDirectory(); |
| 86 | $file = ExportDownload::createExportFile(self::FILE_PREFIX, $format); |
| 87 | $this->writeFile($file['path'], $headers, $rows, $format); |
| 88 | |
| 89 | return [ |
| 90 | 'exportFileURL' => $this->getExportFileUrl($file['token'], $format), |
| 91 | 'totalExported' => count($rows), |
| 92 | ]; |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * Export per-recipient stats for a newsletter to CSV or XLSX. Rows are |
| 97 | * populated via the FILTER_RECIPIENT_ROWS filter — the free plugin returns |
| 98 | * no rows, premium populates them. |
| 99 | * |
| 100 | * @return array{exportFileURL: string, totalExported: int} |
| 101 | */ |
| 102 | public function exportRecipients(NewsletterEntity $newsletter, string $format): array { |
| 103 | $format = $this->normalizeFormat($format); |
| 104 | $headers = $this->getRecipientHeaders(); |
| 105 | |
| 106 | /** @var array<array<int|string|float|null>> $rows */ |
| 107 | $rows = (array)$this->wp->applyFilters(self::FILTER_RECIPIENT_ROWS, [], $newsletter); |
| 108 | |
| 109 | $this->ensureExportDirectory(); |
| 110 | $file = ExportDownload::createExportFile(self::FILE_PREFIX, $format); |
| 111 | $this->writeFile($file['path'], $headers, $rows, $format); |
| 112 | |
| 113 | return [ |
| 114 | 'exportFileURL' => $this->getExportFileUrl($file['token'], $format), |
| 115 | 'totalExported' => count($rows), |
| 116 | ]; |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * @return string[] |
| 121 | */ |
| 122 | public function getRecipientHeaders(): array { |
| 123 | return [ |
| 124 | __('Subscriber ID', 'mailpoet'), |
| 125 | __('Email', 'mailpoet'), |
| 126 | __('First name', 'mailpoet'), |
| 127 | __('Last name', 'mailpoet'), |
| 128 | __('Status', 'mailpoet'), |
| 129 | __('Opened', 'mailpoet'), |
| 130 | __('First open at', 'mailpoet'), |
| 131 | __('Open count', 'mailpoet'), |
| 132 | __('Machine opened', 'mailpoet'), |
| 133 | __('Clicked', 'mailpoet'), |
| 134 | __('Click count', 'mailpoet'), |
| 135 | __('Bounced', 'mailpoet'), |
| 136 | __('Unsubscribed', 'mailpoet'), |
| 137 | ]; |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * @return string[] |
| 142 | */ |
| 143 | public function getAggregateHeaders(): array { |
| 144 | return [ |
| 145 | __('Newsletter ID', 'mailpoet'), |
| 146 | __('Subject', 'mailpoet'), |
| 147 | __('Campaign name', 'mailpoet'), |
| 148 | __('Sent at', 'mailpoet'), |
| 149 | __('Total sent', 'mailpoet'), |
| 150 | __('Unique opens', 'mailpoet'), |
| 151 | __('Machine opens', 'mailpoet'), |
| 152 | __('Unique clicks', 'mailpoet'), |
| 153 | __('Bounces', 'mailpoet'), |
| 154 | __('Unsubscribes', 'mailpoet'), |
| 155 | __('Revenue', 'mailpoet'), |
| 156 | __('Currency', 'mailpoet'), |
| 157 | __('Orders', 'mailpoet'), |
| 158 | ]; |
| 159 | } |
| 160 | |
| 161 | /** |
| 162 | * Build one aggregate row for a newsletter, in the same column order as |
| 163 | * `getAggregateHeaders()`. Public so it can be reused by bulk export in phase 3. |
| 164 | * |
| 165 | * @return array<int|string|float|null> |
| 166 | */ |
| 167 | public function buildAggregateRow(NewsletterEntity $newsletter, NewsletterStatistics $stats): array { |
| 168 | $sentAt = $newsletter->getSentAt(); |
| 169 | $revenue = $stats->getWooCommerceRevenue(); |
| 170 | |
| 171 | return [ |
| 172 | (int)$newsletter->getId(), |
| 173 | (string)$newsletter->getSubject(), |
| 174 | (string)($newsletter->getCampaignName() ?? ''), |
| 175 | $sentAt ? $sentAt->format('Y-m-d H:i:s') : '', |
| 176 | $stats->getTotalSentCount(), |
| 177 | $stats->getOpenCount(), |
| 178 | $stats->getMachineOpenCount(), |
| 179 | $stats->getClickCount(), |
| 180 | $stats->getBounceCount(), |
| 181 | $stats->getUnsubscribeCount(), |
| 182 | $revenue instanceof WooCommerceRevenue ? $revenue->getValue() : '', |
| 183 | $revenue instanceof WooCommerceRevenue ? $revenue->getCurrency() : '', |
| 184 | $revenue instanceof WooCommerceRevenue ? $revenue->getOrdersCount() : '', |
| 185 | ]; |
| 186 | } |
| 187 | |
| 188 | /** |
| 189 | * @param string[] $headers |
| 190 | * @param array<array<int|string|float|null>> $rows |
| 191 | */ |
| 192 | private function writeFile(string $filePath, array $headers, array $rows, string $format): void { |
| 193 | if ($format === self::FORMAT_XLSX) { |
| 194 | $this->writeXlsx($filePath, $headers, $rows); |
| 195 | return; |
| 196 | } |
| 197 | $this->writeCsv($filePath, $headers, $rows); |
| 198 | } |
| 199 | |
| 200 | /** |
| 201 | * @param string[] $headers |
| 202 | * @param array<array<int|string|float|null>> $rows |
| 203 | */ |
| 204 | private function writeCsv(string $filePath, array $headers, array $rows): void { |
| 205 | $handle = fopen($filePath, 'w'); |
| 206 | if ($handle === false) { |
| 207 | throw new \RuntimeException('Failed opening file for export.'); |
| 208 | } |
| 209 | |
| 210 | // UTF-8 BOM so Excel auto-detects encoding (matches Subscribers/ImportExport/Export/Export.php) |
| 211 | fwrite($handle, chr(0xEF) . chr(0xBB) . chr(0xBF)); |
| 212 | $this->writeCsvLine($handle, $headers); |
| 213 | foreach ($rows as $row) { |
| 214 | $this->writeCsvLine($handle, $row); |
| 215 | } |
| 216 | fclose($handle); |
| 217 | } |
| 218 | |
| 219 | /** |
| 220 | * @param resource $handle |
| 221 | * @param array<int|string|float|null> $row |
| 222 | */ |
| 223 | private function writeCsvLine($handle, array $row): void { |
| 224 | // phpcs:ignore WordPressVIPMinimum.Functions.RestrictedFunctions.file_ops_fputcsv -- Export handles are created under Env::$tempPath, which is MailPoet's WordPress temp directory. |
| 225 | fputcsv($handle, array_map('strval', $row), ',', '"', ''); |
| 226 | } |
| 227 | |
| 228 | /** |
| 229 | * @param string[] $headers |
| 230 | * @param array<array<int|string|float|null>> $rows |
| 231 | */ |
| 232 | private function writeXlsx(string $filePath, array $headers, array $rows): void { |
| 233 | $writer = new XLSXWriter(); |
| 234 | $sheetName = __('Statistics', 'mailpoet'); |
| 235 | $writer->writeSheetHeader($sheetName, array_fill_keys($headers, 'string')); |
| 236 | foreach ($rows as $row) { |
| 237 | $writer->writeSheetRow($sheetName, $row); |
| 238 | } |
| 239 | $writer->writeToFile($filePath); |
| 240 | } |
| 241 | |
| 242 | private function ensureExportDirectory(): void { |
| 243 | ExportDownload::ensureExportDirectory($this->wp); |
| 244 | } |
| 245 | |
| 246 | private function getExportFileUrl(string $token, string $format): string { |
| 247 | return ExportDownload::buildStatisticsExportUrl($token, $format, $this->wp->homeUrl()); |
| 248 | } |
| 249 | |
| 250 | private function normalizeFormat(string $format): string { |
| 251 | $format = strtolower($format); |
| 252 | if ($format !== self::FORMAT_CSV && $format !== self::FORMAT_XLSX) { |
| 253 | throw new \InvalidArgumentException(sprintf('Unsupported export format "%s".', $format)); |
| 254 | } |
| 255 | return $format; |
| 256 | } |
| 257 | } |
| 258 |