Analytics.php
1 month ago
AutomatedLatestContent.php
3 months ago
AutomaticEmails.php
3 years ago
Captcha.php
2 days ago
Coupons.php
2 years ago
CustomFields.php
3 months ago
DynamicProducts.php
1 year ago
DynamicSegments.php
3 months ago
FeatureFlags.php
3 years ago
Forms.php
3 months ago
Help.php
1 year ago
ImportExport.php
3 months ago
Mailer.php
2 weeks ago
NewsletterLinks.php
2 days ago
NewsletterTemplates.php
3 months ago
Newsletters.php
3 months ago
Premium.php
1 year ago
RedirectResponse.php
2 days ago
Segments.php
1 month ago
SendingQueue.php
3 months ago
Services.php
7 months ago
Settings.php
3 months ago
Setup.php
1 year ago
StatisticsExport.php
4 months ago
SubscriberStats.php
3 months ago
Subscribers.php
3 months ago
Tags.php
3 years ago
UserFlags.php
2 years ago
WoocommerceProductVariations.php
3 months ago
WoocommerceSettings.php
3 years ago
index.php
3 years ago
NewsletterLinks.php
176 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\Config\AccessControl; |
| 10 | use MailPoet\Cron\Workers\StatsNotifications\NewsletterLinkRepository; |
| 11 | use MailPoet\EmailEditor\Integrations\MailPoet\PersonalizationTagManager; |
| 12 | use MailPoet\EmailEditor\Integrations\MailPoet\PersonalizationTags\PersonalizationTagLinkResolver; |
| 13 | use MailPoet\Entities\NewsletterEntity; |
| 14 | use MailPoet\Entities\NewsletterOptionFieldEntity; |
| 15 | use MailPoet\Newsletter\Links\Links as NewsletterLinksService; |
| 16 | use MailPoet\Newsletter\NewslettersRepository; |
| 17 | |
| 18 | class NewsletterLinks extends APIEndpoint { |
| 19 | |
| 20 | public $permissions = [ |
| 21 | 'global' => AccessControl::PERMISSION_MANAGE_SEGMENTS, |
| 22 | ]; |
| 23 | |
| 24 | private const AUTOMATION_EMAIL_TYPES = [ |
| 25 | NewsletterEntity::TYPE_AUTOMATION, |
| 26 | NewsletterEntity::TYPE_AUTOMATION_TRANSACTIONAL, |
| 27 | ]; |
| 28 | |
| 29 | /** @var NewsletterLinkRepository */ |
| 30 | private $newsletterLinkRepository; |
| 31 | |
| 32 | /** @var NewslettersRepository */ |
| 33 | private $newslettersRepository; |
| 34 | |
| 35 | /** @var NewsletterLinksService */ |
| 36 | private $newsletterLinks; |
| 37 | |
| 38 | private PersonalizationTagLinkResolver $linkResolver; |
| 39 | private PersonalizationTagManager $personalizationTagManager; |
| 40 | |
| 41 | public function __construct( |
| 42 | NewsletterLinkRepository $newsletterLinkRepository, |
| 43 | NewslettersRepository $newslettersRepository, |
| 44 | NewsletterLinksService $newsletterLinks, |
| 45 | PersonalizationTagLinkResolver $linkResolver, |
| 46 | PersonalizationTagManager $personalizationTagManager |
| 47 | ) { |
| 48 | $this->newsletterLinkRepository = $newsletterLinkRepository; |
| 49 | $this->newslettersRepository = $newslettersRepository; |
| 50 | $this->newsletterLinks = $newsletterLinks; |
| 51 | $this->linkResolver = $linkResolver; |
| 52 | $this->personalizationTagManager = $personalizationTagManager; |
| 53 | } |
| 54 | |
| 55 | public function get($data = []) { |
| 56 | $newsletterId = (int)($data['newsletterId'] ?? 0); |
| 57 | $newsletter = $this->newslettersRepository->findOneById($newsletterId); |
| 58 | if (!$newsletter instanceof NewsletterEntity) { |
| 59 | return $this->successResponse([]); |
| 60 | } |
| 61 | |
| 62 | if (in_array($newsletter->getType(), self::AUTOMATION_EMAIL_TYPES, true)) { |
| 63 | return $this->successResponse($this->getAutomationLinks($newsletter)); |
| 64 | } |
| 65 | |
| 66 | $links = $this->newsletterLinkRepository->findBy(['newsletter' => $newsletterId]); |
| 67 | $response = []; |
| 68 | foreach ($links as $link) { |
| 69 | $response[] = [ |
| 70 | 'id' => $link->getId(), |
| 71 | 'url' => $this->getLabel($link->getUrl()), |
| 72 | ]; |
| 73 | } |
| 74 | return $this->successResponse($response); |
| 75 | } |
| 76 | |
| 77 | private function getAutomationLinks(NewsletterEntity $newsletter): array { |
| 78 | $newsletterId = $newsletter->getId(); |
| 79 | if (!$newsletterId) { |
| 80 | return []; |
| 81 | } |
| 82 | |
| 83 | // Subject-dependent tags (e.g. order tags) are registered per automation; needed for their labels |
| 84 | $automationId = $newsletter->getOptionValue(NewsletterOptionFieldEntity::NAME_AUTOMATION_ID); |
| 85 | if (is_numeric($automationId)) { |
| 86 | $this->personalizationTagManager->extendPersonalizationTagsByAutomationSubjects((int)$automationId); |
| 87 | } |
| 88 | |
| 89 | $urls = []; |
| 90 | foreach ($this->newsletterLinkRepository->findUrlsByNewsletterId($newsletterId) as $url) { |
| 91 | $this->addUrl($urls, $url); |
| 92 | } |
| 93 | foreach ($this->extractUrlsFromNewsletterBody($newsletter) as $url) { |
| 94 | $this->addUrl($urls, $url); |
| 95 | } |
| 96 | |
| 97 | return array_map(function(string $url): array { |
| 98 | return [ |
| 99 | 'id' => $url, |
| 100 | 'url' => $this->getLabel($url), |
| 101 | ]; |
| 102 | }, array_values($urls)); |
| 103 | } |
| 104 | |
| 105 | /** |
| 106 | * Links stored as personalization tag tokens are shown under the tag's name. |
| 107 | */ |
| 108 | private function getLabel(string $url): string { |
| 109 | return $this->linkResolver->getDisplayName($url) ?? $url; |
| 110 | } |
| 111 | |
| 112 | /** |
| 113 | * @return string[] |
| 114 | */ |
| 115 | private function extractUrlsFromNewsletterBody(NewsletterEntity $newsletter): array { |
| 116 | $body = $newsletter->getBody(); |
| 117 | if (!is_array($body)) { |
| 118 | return []; |
| 119 | } |
| 120 | |
| 121 | $urls = []; |
| 122 | $this->collectUrlsFromBody($body['content'] ?? $body, $urls); |
| 123 | return array_values($urls); |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * @param mixed $bodyPart |
| 128 | * @param array<string, string> $urls |
| 129 | */ |
| 130 | private function collectUrlsFromBody($bodyPart, array &$urls): void { |
| 131 | if (!is_array($bodyPart)) { |
| 132 | return; |
| 133 | } |
| 134 | |
| 135 | foreach ($bodyPart as $key => $value) { |
| 136 | if (is_string($value)) { |
| 137 | if (in_array($key, ['url', 'link'], true)) { |
| 138 | $this->addUrl($urls, $value); |
| 139 | } |
| 140 | // Links::extract parses HTML and scans for shortcodes; skip when neither marker is present |
| 141 | // to avoid running a DOM parse on every plain-text leaf of the body tree. |
| 142 | if (strpos($value, '<') !== false || strpos($value, '[') !== false) { |
| 143 | foreach ($this->newsletterLinks->extract($value) as $link) { |
| 144 | $this->addUrl($urls, $link['link'] ?? ''); |
| 145 | } |
| 146 | } |
| 147 | } |
| 148 | |
| 149 | if (is_array($value)) { |
| 150 | $this->collectUrlsFromBody($value, $urls); |
| 151 | } |
| 152 | } |
| 153 | } |
| 154 | |
| 155 | /** |
| 156 | * @param array<string, string> $urls |
| 157 | */ |
| 158 | private function addUrl(array &$urls, string $url): void { |
| 159 | $url = trim($url); |
| 160 | if (!$this->isSelectableUrl($url)) { |
| 161 | return; |
| 162 | } |
| 163 | $urls[$url] = $url; |
| 164 | } |
| 165 | |
| 166 | private function isSelectableUrl(string $url): bool { |
| 167 | if ($url === '') { |
| 168 | return false; |
| 169 | } |
| 170 | // strpos returns false when '[' is absent and 0 when it's the first char; !== 0 covers both |
| 171 | // "no leading bracket" cases. Allow [link:…] shortcodes and personalization tag tokens through; |
| 172 | // reject other tokens like [postLink]. |
| 173 | return strpos($url, '[') !== 0 || strpos($url, '[link:') === 0 || $this->linkResolver->isTokenUrl($url); |
| 174 | } |
| 175 | } |
| 176 |