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
StatisticsExport.php
239 lines
| 1 | <?php declare(strict_types = 1); |
| 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\API\JSON\Response; |
| 11 | use MailPoet\Config\AccessControl; |
| 12 | use MailPoet\Cron\Workers\StatisticsExport as StatisticsExportWorker; |
| 13 | use MailPoet\Entities\ScheduledTaskEntity; |
| 14 | use MailPoet\Logging\LoggerFactory; |
| 15 | use MailPoet\Newsletter\NewslettersRepository; |
| 16 | use MailPoet\Newsletter\Sending\ScheduledTasksRepository; |
| 17 | use MailPoet\Newsletter\Statistics\Export\StatisticsExporter; |
| 18 | use MailPoet\Util\License\Features\CapabilitiesManager; |
| 19 | use MailPoet\WP\Functions as WPFunctions; |
| 20 | use MailPoetVendor\Carbon\Carbon; |
| 21 | |
| 22 | class StatisticsExport extends APIEndpoint { |
| 23 | public $permissions = [ |
| 24 | 'global' => AccessControl::PERMISSION_MANAGE_EMAILS, |
| 25 | ]; |
| 26 | |
| 27 | /** @var NewslettersRepository */ |
| 28 | private $newslettersRepository; |
| 29 | |
| 30 | /** @var StatisticsExporter */ |
| 31 | private $exporter; |
| 32 | |
| 33 | /** @var LoggerFactory */ |
| 34 | private $loggerFactory; |
| 35 | |
| 36 | /** @var ScheduledTasksRepository */ |
| 37 | private $scheduledTasksRepository; |
| 38 | |
| 39 | /** @var CapabilitiesManager */ |
| 40 | private $capabilitiesManager; |
| 41 | |
| 42 | /** @var WPFunctions */ |
| 43 | private $wp; |
| 44 | |
| 45 | public function __construct( |
| 46 | NewslettersRepository $newslettersRepository, |
| 47 | StatisticsExporter $exporter, |
| 48 | LoggerFactory $loggerFactory, |
| 49 | ScheduledTasksRepository $scheduledTasksRepository, |
| 50 | CapabilitiesManager $capabilitiesManager, |
| 51 | WPFunctions $wp |
| 52 | ) { |
| 53 | $this->newslettersRepository = $newslettersRepository; |
| 54 | $this->exporter = $exporter; |
| 55 | $this->loggerFactory = $loggerFactory; |
| 56 | $this->scheduledTasksRepository = $scheduledTasksRepository; |
| 57 | $this->capabilitiesManager = $capabilitiesManager; |
| 58 | $this->wp = $wp; |
| 59 | } |
| 60 | |
| 61 | public function exportCampaign($data = []) { |
| 62 | $newsletterId = isset($data['id']) ? (int)$data['id'] : 0; |
| 63 | if ($newsletterId <= 0) { |
| 64 | return $this->badRequest([ |
| 65 | APIError::BAD_REQUEST => __('Missing newsletter id.', 'mailpoet'), |
| 66 | ]); |
| 67 | } |
| 68 | |
| 69 | $format = $this->resolveFormat($data); |
| 70 | if ($format === null) { |
| 71 | return $this->unsupportedFormatResponse(); |
| 72 | } |
| 73 | |
| 74 | $newsletter = $this->newslettersRepository->findOneById($newsletterId); |
| 75 | if (!$newsletter) { |
| 76 | return $this->newsletterNotFoundResponse(); |
| 77 | } |
| 78 | |
| 79 | try { |
| 80 | $result = $this->exporter->exportSingleAggregate($newsletter, $format); |
| 81 | } catch (\Throwable $e) { |
| 82 | if (function_exists('error_log')) { |
| 83 | // phpcs:disable QITStandard.PHP.DebugCode.DebugFunctionFound |
| 84 | error_log((string)$e); // phpcs:ignore Squiz.PHP.DiscouragedFunctions |
| 85 | // phpcs:enable QITStandard.PHP.DebugCode.DebugFunctionFound |
| 86 | } |
| 87 | $this->loggerFactory->getLogger(LoggerFactory::TOPIC_API)->warning('Campaign statistics export failed.', [ |
| 88 | 'exceptionMessage' => $e->getMessage(), |
| 89 | 'exceptionTrace' => $e->getTraceAsString(), |
| 90 | ]); |
| 91 | return $this->errorResponse([ |
| 92 | APIError::UNKNOWN => __('Could not generate the export. Please try again.', 'mailpoet'), |
| 93 | ], [], Response::STATUS_BAD_REQUEST); |
| 94 | } |
| 95 | |
| 96 | return $this->successResponse($result); |
| 97 | } |
| 98 | |
| 99 | public function exportRecipients($data = []) { |
| 100 | $newsletterId = isset($data['id']) ? (int)$data['id'] : 0; |
| 101 | if ($newsletterId <= 0) { |
| 102 | return $this->badRequest([ |
| 103 | APIError::BAD_REQUEST => __('Missing newsletter id.', 'mailpoet'), |
| 104 | ]); |
| 105 | } |
| 106 | |
| 107 | $format = $this->resolveFormat($data); |
| 108 | if ($format === null) { |
| 109 | return $this->unsupportedFormatResponse(); |
| 110 | } |
| 111 | |
| 112 | if ($this->isDetailedAnalyticsRestricted()) { |
| 113 | return $this->errorResponse([ |
| 114 | APIError::FORBIDDEN => __('Per-recipient export requires a MailPoet plan with detailed analytics.', 'mailpoet'), |
| 115 | ], [], Response::STATUS_FORBIDDEN); |
| 116 | } |
| 117 | |
| 118 | $newsletter = $this->newslettersRepository->findOneById($newsletterId); |
| 119 | if (!$newsletter) { |
| 120 | return $this->newsletterNotFoundResponse(); |
| 121 | } |
| 122 | |
| 123 | $task = new ScheduledTaskEntity(); |
| 124 | $task->setType(StatisticsExportWorker::TASK_TYPE); |
| 125 | $task->setStatus(ScheduledTaskEntity::STATUS_SCHEDULED); |
| 126 | $task->setScheduledAt(Carbon::now()->millisecond(0)); |
| 127 | $task->setPriority(ScheduledTaskEntity::PRIORITY_HIGH); |
| 128 | $task->setMeta([ |
| 129 | 'job_type' => StatisticsExportWorker::JOB_TYPE_RECIPIENTS, |
| 130 | 'newsletter_id' => $newsletter->getId(), |
| 131 | 'format' => $format, |
| 132 | 'requested_by' => (int)$this->wp->getCurrentUserId(), |
| 133 | ]); |
| 134 | $this->scheduledTasksRepository->persist($task); |
| 135 | $this->scheduledTasksRepository->flush(); |
| 136 | |
| 137 | return $this->successResponse($this->buildStatusPayload($task)); |
| 138 | } |
| 139 | |
| 140 | public function getStatus($data = []) { |
| 141 | $taskId = isset($data['task_id']) ? (int)$data['task_id'] : 0; |
| 142 | if ($taskId <= 0) { |
| 143 | return $this->badRequest([ |
| 144 | APIError::BAD_REQUEST => __('Missing task id.', 'mailpoet'), |
| 145 | ]); |
| 146 | } |
| 147 | |
| 148 | if ($this->isDetailedAnalyticsRestricted()) { |
| 149 | return $this->errorResponse([ |
| 150 | APIError::FORBIDDEN => __('Per-recipient export requires a MailPoet plan with detailed analytics.', 'mailpoet'), |
| 151 | ], [], Response::STATUS_FORBIDDEN); |
| 152 | } |
| 153 | |
| 154 | $task = $this->scheduledTasksRepository->findOneById($taskId); |
| 155 | if (!$task instanceof ScheduledTaskEntity || $task->getType() !== StatisticsExportWorker::TASK_TYPE) { |
| 156 | return $this->errorResponse([ |
| 157 | APIError::NOT_FOUND => __('Export task not found.', 'mailpoet'), |
| 158 | ], [], Response::STATUS_NOT_FOUND); |
| 159 | } |
| 160 | |
| 161 | $meta = $task->getMeta() ?? []; |
| 162 | $jobType = isset($meta['job_type']) ? (string)$meta['job_type'] : ''; |
| 163 | $allowedJobTypes = [ |
| 164 | StatisticsExportWorker::JOB_TYPE_RECIPIENTS, |
| 165 | StatisticsExportWorker::JOB_TYPE_BULK, |
| 166 | ]; |
| 167 | if (!in_array($jobType, $allowedJobTypes, true)) { |
| 168 | return $this->errorResponse([ |
| 169 | APIError::NOT_FOUND => __('Export task not found.', 'mailpoet'), |
| 170 | ], [], Response::STATUS_NOT_FOUND); |
| 171 | } |
| 172 | |
| 173 | $requestedBy = isset($meta['requested_by']) ? (int)$meta['requested_by'] : 0; |
| 174 | if ($requestedBy !== (int)$this->wp->getCurrentUserId()) { |
| 175 | return $this->errorResponse([ |
| 176 | APIError::NOT_FOUND => __('Export task not found.', 'mailpoet'), |
| 177 | ], [], Response::STATUS_NOT_FOUND); |
| 178 | } |
| 179 | |
| 180 | return $this->successResponse($this->buildStatusPayload($task)); |
| 181 | } |
| 182 | |
| 183 | private function isDetailedAnalyticsRestricted(): bool { |
| 184 | $capability = $this->capabilitiesManager->getCapability('detailedAnalytics'); |
| 185 | return $capability === null || $capability->isRestricted; |
| 186 | } |
| 187 | |
| 188 | private function resolveFormat(array $data): ?string { |
| 189 | $format = isset($data['format']) && is_string($data['format']) |
| 190 | ? strtolower($data['format']) |
| 191 | : StatisticsExporter::FORMAT_CSV; |
| 192 | if ($format !== StatisticsExporter::FORMAT_CSV && $format !== StatisticsExporter::FORMAT_XLSX) { |
| 193 | return null; |
| 194 | } |
| 195 | return $format; |
| 196 | } |
| 197 | |
| 198 | private function unsupportedFormatResponse() { |
| 199 | return $this->badRequest([ |
| 200 | APIError::BAD_REQUEST => __('Unsupported export format. Use csv or xlsx.', 'mailpoet'), |
| 201 | ]); |
| 202 | } |
| 203 | |
| 204 | private function newsletterNotFoundResponse() { |
| 205 | return $this->errorResponse([ |
| 206 | APIError::NOT_FOUND => __('This email does not exist.', 'mailpoet'), |
| 207 | ], [], Response::STATUS_NOT_FOUND); |
| 208 | } |
| 209 | |
| 210 | /** |
| 211 | * @return array{ |
| 212 | * taskId: int, |
| 213 | * status: string, |
| 214 | * exportFileURL?: string, |
| 215 | * totalExported?: int, |
| 216 | * error?: string, |
| 217 | * } |
| 218 | */ |
| 219 | private function buildStatusPayload(ScheduledTaskEntity $task): array { |
| 220 | $meta = $task->getMeta() ?? []; |
| 221 | $status = $task->getStatus() ?? ScheduledTaskEntity::VIRTUAL_STATUS_RUNNING; |
| 222 | |
| 223 | $payload = [ |
| 224 | 'taskId' => (int)$task->getId(), |
| 225 | 'status' => $status, |
| 226 | ]; |
| 227 | if (isset($meta['export_file_url'])) { |
| 228 | $payload['exportFileURL'] = (string)$meta['export_file_url']; |
| 229 | } |
| 230 | if (isset($meta['total_exported'])) { |
| 231 | $payload['totalExported'] = (int)$meta['total_exported']; |
| 232 | } |
| 233 | if (isset($meta['error'])) { |
| 234 | $payload['error'] = (string)$meta['error']; |
| 235 | } |
| 236 | return $payload; |
| 237 | } |
| 238 | } |
| 239 |