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
Newsletters.php
343 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\API\JSON\Response; |
| 11 | use MailPoet\API\JSON\ResponseBuilders\NewslettersResponseBuilder; |
| 12 | use MailPoet\Config\AccessControl; |
| 13 | use MailPoet\Doctrine\Validator\ValidationException; |
| 14 | use MailPoet\Entities\NewsletterEntity; |
| 15 | use MailPoet\Newsletter\NewsletterDeleteController; |
| 16 | use MailPoet\Newsletter\NewsletterResendController; |
| 17 | use MailPoet\Newsletter\NewsletterSaveController; |
| 18 | use MailPoet\Newsletter\NewslettersRepository; |
| 19 | use MailPoet\Newsletter\Preview\SendPreviewController; |
| 20 | use MailPoet\Newsletter\Preview\SendPreviewException; |
| 21 | use MailPoet\Newsletter\Url as NewsletterUrl; |
| 22 | use MailPoet\Subscribers\ConfirmationEmailCustomizer; |
| 23 | use MailPoet\UnexpectedValueException; |
| 24 | use MailPoet\WP\Emoji; |
| 25 | use MailPoet\WP\Functions as WPFunctions; |
| 26 | |
| 27 | class Newsletters extends APIEndpoint { |
| 28 | |
| 29 | /** @var WPFunctions */ |
| 30 | private $wp; |
| 31 | |
| 32 | public $permissions = [ |
| 33 | 'global' => AccessControl::PERMISSION_MANAGE_EMAILS, |
| 34 | ]; |
| 35 | |
| 36 | /** @var NewslettersRepository */ |
| 37 | private $newslettersRepository; |
| 38 | |
| 39 | /** @var NewslettersResponseBuilder */ |
| 40 | private $newslettersResponseBuilder; |
| 41 | |
| 42 | /** @var Emoji */ |
| 43 | private $emoji; |
| 44 | |
| 45 | /** @var SendPreviewController */ |
| 46 | private $sendPreviewController; |
| 47 | |
| 48 | /** @var NewsletterSaveController */ |
| 49 | private $newsletterSaveController; |
| 50 | |
| 51 | private NewsletterDeleteController $newsletterDeleteController; |
| 52 | |
| 53 | /** @var NewsletterResendController */ |
| 54 | private $newsletterResendController; |
| 55 | |
| 56 | /** @var NewsletterUrl */ |
| 57 | private $newsletterUrl; |
| 58 | |
| 59 | /** @var ConfirmationEmailCustomizer */ |
| 60 | private $confirmationEmailCustomizer; |
| 61 | |
| 62 | public function __construct( |
| 63 | WPFunctions $wp, |
| 64 | NewslettersRepository $newslettersRepository, |
| 65 | NewslettersResponseBuilder $newslettersResponseBuilder, |
| 66 | Emoji $emoji, |
| 67 | SendPreviewController $sendPreviewController, |
| 68 | NewsletterSaveController $newsletterSaveController, |
| 69 | NewsletterDeleteController $newsletterDeleteController, |
| 70 | NewsletterResendController $newsletterResendController, |
| 71 | NewsletterUrl $newsletterUrl, |
| 72 | ConfirmationEmailCustomizer $confirmationEmailCustomizer |
| 73 | ) { |
| 74 | $this->wp = $wp; |
| 75 | $this->newslettersRepository = $newslettersRepository; |
| 76 | $this->newslettersResponseBuilder = $newslettersResponseBuilder; |
| 77 | $this->emoji = $emoji; |
| 78 | $this->sendPreviewController = $sendPreviewController; |
| 79 | $this->newsletterSaveController = $newsletterSaveController; |
| 80 | $this->newsletterDeleteController = $newsletterDeleteController; |
| 81 | $this->newsletterResendController = $newsletterResendController; |
| 82 | $this->newsletterUrl = $newsletterUrl; |
| 83 | $this->confirmationEmailCustomizer = $confirmationEmailCustomizer; |
| 84 | } |
| 85 | |
| 86 | public function get($data = []) { |
| 87 | $newsletter = $this->getNewsletter($data); |
| 88 | if (!$newsletter) { |
| 89 | return $this->errorResponse([ |
| 90 | APIError::NOT_FOUND => __('This email does not exist.', 'mailpoet'), |
| 91 | ]); |
| 92 | } |
| 93 | |
| 94 | $response = $this->newslettersResponseBuilder->build($newsletter, [ |
| 95 | NewslettersResponseBuilder::RELATION_SEGMENTS, |
| 96 | NewslettersResponseBuilder::RELATION_OPTIONS, |
| 97 | NewslettersResponseBuilder::RELATION_QUEUE, |
| 98 | ]); |
| 99 | $response = $this->wp->applyFilters('mailpoet_api_newsletters_get_after', $response); |
| 100 | return $this->successResponse($response, ['preview_url' => $this->getViewInBrowserUrl($newsletter)]); |
| 101 | } |
| 102 | |
| 103 | public function getWithStats($data = []) { |
| 104 | $newsletter = $this->getNewsletter($data); |
| 105 | if (!$newsletter) { |
| 106 | return $this->errorResponse([ |
| 107 | APIError::NOT_FOUND => __('This email does not exist.', 'mailpoet'), |
| 108 | ]); |
| 109 | } |
| 110 | |
| 111 | $response = $this->newslettersResponseBuilder->build($newsletter, [ |
| 112 | NewslettersResponseBuilder::RELATION_SEGMENTS, |
| 113 | NewslettersResponseBuilder::RELATION_OPTIONS, |
| 114 | NewslettersResponseBuilder::RELATION_QUEUE, |
| 115 | NewslettersResponseBuilder::RELATION_TOTAL_SENT, |
| 116 | NewslettersResponseBuilder::RELATION_STATISTICS, |
| 117 | ]); |
| 118 | $response = $this->wp->applyFilters('mailpoet_api_newsletters_get_after', $response); |
| 119 | if (!is_array($response)) { |
| 120 | $response = []; |
| 121 | } |
| 122 | $response['preview_url'] = $this->getViewInBrowserUrl($newsletter); |
| 123 | return $this->successResponse($response); |
| 124 | } |
| 125 | |
| 126 | public function save($data = []) { |
| 127 | $data = $this->wp->applyFilters('mailpoet_api_newsletters_save_before', $data); |
| 128 | if (!is_array($data)) { |
| 129 | $data = []; |
| 130 | } |
| 131 | $newsletter = $this->newsletterSaveController->save($data); |
| 132 | $response = $this->newslettersResponseBuilder->build($newsletter, [ |
| 133 | NewslettersResponseBuilder::RELATION_SEGMENTS, |
| 134 | ]); |
| 135 | $previewUrl = $this->getViewInBrowserUrl($newsletter); |
| 136 | $response = $this->wp->applyFilters('mailpoet_api_newsletters_save_after', $response); |
| 137 | return $this->successResponse($response, ['preview_url' => $previewUrl]); |
| 138 | } |
| 139 | |
| 140 | public function updateShareVisibility($data = []) { |
| 141 | if (!is_array($data) || !isset($data['share_visibility']) || !is_string($data['share_visibility'])) { |
| 142 | return $this->badRequest([ |
| 143 | APIError::BAD_REQUEST => __('You need to specify a sharing visibility.', 'mailpoet'), |
| 144 | ]); |
| 145 | } |
| 146 | |
| 147 | $newsletter = $this->getNewsletter($data); |
| 148 | if (!$newsletter) { |
| 149 | return $this->errorResponse([ |
| 150 | APIError::NOT_FOUND => __('This email does not exist.', 'mailpoet'), |
| 151 | ]); |
| 152 | } |
| 153 | |
| 154 | $newsletter = $this->newsletterSaveController->updateShareVisibility($newsletter, $data['share_visibility']); |
| 155 | $response = $this->newslettersResponseBuilder->build($newsletter); |
| 156 | return $this->successResponse($response); |
| 157 | } |
| 158 | |
| 159 | public function restore($data = []) { |
| 160 | $newsletter = $this->getNewsletter($data); |
| 161 | if ($newsletter instanceof NewsletterEntity) { |
| 162 | $this->newslettersRepository->bulkRestore([$newsletter->getId()]); |
| 163 | $this->newslettersRepository->refresh($newsletter); |
| 164 | return $this->successResponse( |
| 165 | $this->newslettersResponseBuilder->build($newsletter), |
| 166 | ['count' => 1] |
| 167 | ); |
| 168 | } else { |
| 169 | return $this->errorResponse([ |
| 170 | APIError::NOT_FOUND => __('This email does not exist.', 'mailpoet'), |
| 171 | ]); |
| 172 | } |
| 173 | } |
| 174 | |
| 175 | public function trash($data = []) { |
| 176 | $newsletter = $this->getNewsletter($data); |
| 177 | if ($newsletter instanceof NewsletterEntity) { |
| 178 | $this->newslettersRepository->bulkTrash([$newsletter->getId()]); |
| 179 | $this->newslettersRepository->refresh($newsletter); |
| 180 | return $this->successResponse( |
| 181 | $this->newslettersResponseBuilder->build($newsletter), |
| 182 | ['count' => 1] |
| 183 | ); |
| 184 | } else { |
| 185 | return $this->errorResponse([ |
| 186 | APIError::NOT_FOUND => __('This email does not exist.', 'mailpoet'), |
| 187 | ]); |
| 188 | } |
| 189 | } |
| 190 | |
| 191 | public function delete($data = []) { |
| 192 | $newsletter = $this->getNewsletter($data); |
| 193 | if ($newsletter instanceof NewsletterEntity) { |
| 194 | $this->wp->doAction('mailpoet_api_newsletters_delete_before', [$newsletter->getId()]); |
| 195 | $this->newsletterDeleteController->bulkDelete([(int)$newsletter->getId()]); |
| 196 | $this->wp->doAction('mailpoet_api_newsletters_delete_after', [$newsletter->getId()]); |
| 197 | return $this->successResponse(null, ['count' => 1]); |
| 198 | } else { |
| 199 | return $this->errorResponse([ |
| 200 | APIError::NOT_FOUND => __('This email does not exist.', 'mailpoet'), |
| 201 | ]); |
| 202 | } |
| 203 | } |
| 204 | |
| 205 | public function showPreview($data = []) { |
| 206 | if (empty($data['body'])) { |
| 207 | return $this->badRequest([ |
| 208 | APIError::BAD_REQUEST => __('Newsletter data is missing.', 'mailpoet'), |
| 209 | ]); |
| 210 | } |
| 211 | |
| 212 | $newsletter = $this->getNewsletter($data); |
| 213 | if (!$newsletter) { |
| 214 | return $this->errorResponse([ |
| 215 | APIError::NOT_FOUND => __('This email does not exist.', 'mailpoet'), |
| 216 | ]); |
| 217 | } |
| 218 | |
| 219 | $newslettersTableName = $this->newslettersRepository->getTableName(); |
| 220 | $newsletter->setBody( |
| 221 | json_decode($this->emoji->encodeForUTF8Column($newslettersTableName, 'body', $data['body']), true) |
| 222 | ); |
| 223 | $this->newslettersRepository->flush(); |
| 224 | |
| 225 | $response = $this->newslettersResponseBuilder->build($newsletter); |
| 226 | return $this->successResponse($response, ['preview_url' => $this->getViewInBrowserUrl($newsletter)]); |
| 227 | } |
| 228 | |
| 229 | public function sendPreview($data = []) { |
| 230 | if (empty($data['subscriber'])) { |
| 231 | return $this->badRequest([ |
| 232 | APIError::BAD_REQUEST => __('Please specify receiver information.', 'mailpoet'), |
| 233 | ]); |
| 234 | } |
| 235 | |
| 236 | $newsletter = $this->getNewsletter($data); |
| 237 | if (!$newsletter) { |
| 238 | return $this->errorResponse([ |
| 239 | APIError::NOT_FOUND => __('This email does not exist.', 'mailpoet'), |
| 240 | ]); |
| 241 | } |
| 242 | |
| 243 | try { |
| 244 | $this->sendPreviewController->sendPreview($newsletter, $data['subscriber']); |
| 245 | } catch (SendPreviewException $e) { |
| 246 | return $this->errorResponse([APIError::BAD_REQUEST => $e->getMessage()]); |
| 247 | } catch (\Throwable $e) { |
| 248 | return $this->errorResponse([$e->getCode() => $e->getMessage()]); |
| 249 | } |
| 250 | return $this->successResponse($this->newslettersResponseBuilder->build($newsletter)); |
| 251 | } |
| 252 | |
| 253 | public function create($data = []) { |
| 254 | try { |
| 255 | $newsletter = $this->newsletterSaveController->save($data); |
| 256 | } catch (ValidationException $exception) { |
| 257 | return $this->badRequest(['Please specify a type.']); |
| 258 | } |
| 259 | $response = $this->newslettersResponseBuilder->build($newsletter); |
| 260 | return $this->successResponse($response); |
| 261 | } |
| 262 | |
| 263 | public function resendToNonOpeners($data = []) { |
| 264 | $newsletter = $this->getNewsletter($data); |
| 265 | if (!$newsletter) { |
| 266 | return $this->errorResponse([ |
| 267 | APIError::NOT_FOUND => __('This email does not exist.', 'mailpoet'), |
| 268 | ]); |
| 269 | } |
| 270 | $subject = isset($data['subject']) ? (string)$data['subject'] : ''; |
| 271 | try { |
| 272 | $duplicate = $this->newsletterResendController->resendToNonOpeners($newsletter, $subject); |
| 273 | } catch (UnexpectedValueException $e) { |
| 274 | return $this->badRequest([ |
| 275 | APIError::BAD_REQUEST => $e->getMessage(), |
| 276 | ]); |
| 277 | } |
| 278 | return $this->successResponse( |
| 279 | $this->newslettersResponseBuilder->build($duplicate), |
| 280 | ['count' => 1] |
| 281 | ); |
| 282 | } |
| 283 | |
| 284 | private function getNewsletter(array $data) { |
| 285 | return isset($data['id']) |
| 286 | ? $this->newslettersRepository->findOneById((int)$data['id']) |
| 287 | : null; |
| 288 | } |
| 289 | |
| 290 | private function getViewInBrowserUrl(NewsletterEntity $newsletter): string { |
| 291 | $url = $this->newsletterUrl->getViewInBrowserUrl($newsletter); |
| 292 | // strip protocol to avoid mix content error |
| 293 | return preg_replace('/^https?:/i', '', $url); |
| 294 | } |
| 295 | |
| 296 | /** |
| 297 | * Get all confirmation email newsletters for use in form editor. |
| 298 | * @return Response |
| 299 | */ |
| 300 | public function getConfirmationEmails() { |
| 301 | $newsletters = $this->newslettersRepository->findBy([ |
| 302 | 'type' => NewsletterEntity::TYPE_CONFIRMATION_EMAIL_CUSTOMIZER, |
| 303 | 'deletedAt' => null, |
| 304 | ]); |
| 305 | |
| 306 | $result = []; |
| 307 | foreach ($newsletters as $newsletter) { |
| 308 | $id = $newsletter->getId(); |
| 309 | if ($id === null) { |
| 310 | continue; |
| 311 | } |
| 312 | $result[] = [ |
| 313 | 'id' => $id, |
| 314 | 'subject' => $newsletter->getSubject() ?: __('(no subject)', 'mailpoet'), |
| 315 | ]; |
| 316 | } |
| 317 | |
| 318 | return $this->successResponse($result); |
| 319 | } |
| 320 | |
| 321 | /** |
| 322 | * Create a new confirmation email from the global default template. |
| 323 | * @return Response |
| 324 | */ |
| 325 | public function createConfirmationEmail() { |
| 326 | // Get the global default confirmation email as a base |
| 327 | $defaultNewsletter = $this->confirmationEmailCustomizer->getNewsletter(); |
| 328 | |
| 329 | $newsletterData = [ |
| 330 | 'type' => NewsletterEntity::TYPE_CONFIRMATION_EMAIL_CUSTOMIZER, |
| 331 | 'subject' => $defaultNewsletter->getSubject(), |
| 332 | 'body' => json_encode($defaultNewsletter->getBody()), |
| 333 | ]; |
| 334 | |
| 335 | $newsletter = $this->newsletterSaveController->save($newsletterData); |
| 336 | |
| 337 | return $this->successResponse([ |
| 338 | 'id' => $newsletter->getId(), |
| 339 | 'subject' => $newsletter->getSubject(), |
| 340 | ]); |
| 341 | } |
| 342 | } |
| 343 |