No Description

Track.php 4.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  1. <?php
  2. namespace MailPoet\Router\Endpoints;
  3. if (!defined('ABSPATH')) exit;
  4. use MailPoet\Config\AccessControl;
  5. use MailPoet\Cron\Workers\StatsNotifications\NewsletterLinkRepository;
  6. use MailPoet\Entities\SendingQueueEntity;
  7. use MailPoet\Newsletter\Links\Links;
  8. use MailPoet\Newsletter\NewslettersRepository;
  9. use MailPoet\Newsletter\Sending\SendingQueuesRepository;
  10. use MailPoet\Statistics\Track\Clicks;
  11. use MailPoet\Statistics\Track\Opens;
  12. use MailPoet\Subscribers\LinkTokens;
  13. use MailPoet\Subscribers\SubscribersRepository;
  14. use MailPoet\WP\Functions as WPFunctions;
  15. class Track {
  16. const ENDPOINT = 'track';
  17. const ACTION_CLICK = 'click';
  18. const ACTION_OPEN = 'open';
  19. public $allowedActions = [
  20. self::ACTION_CLICK,
  21. self::ACTION_OPEN,
  22. ];
  23. public $permissions = [
  24. 'global' => AccessControl::NO_ACCESS_RESTRICTION,
  25. ];
  26. /** @var Clicks */
  27. private $clicks;
  28. /** @var Opens */
  29. private $opens;
  30. /** @var LinkTokens */
  31. private $linkTokens;
  32. /** @var SendingQueuesRepository */
  33. private $sendingQueuesRepository;
  34. /** @var SubscribersRepository */
  35. private $subscribersRepository;
  36. /** @var NewslettersRepository */
  37. private $newslettersRepository;
  38. /** @var NewsletterLinkRepository */
  39. private $newsletterLinkRepository;
  40. /** @var Links */
  41. private $links;
  42. public function __construct(
  43. Clicks $clicks,
  44. Opens $opens,
  45. SendingQueuesRepository $sendingQueuesRepository,
  46. SubscribersRepository $subscribersRepository,
  47. NewslettersRepository $newslettersRepository,
  48. NewsletterLinkRepository $newsletterLinkRepository,
  49. LinkTokens $linkTokens,
  50. Links $links
  51. ) {
  52. $this->clicks = $clicks;
  53. $this->opens = $opens;
  54. $this->linkTokens = $linkTokens;
  55. $this->sendingQueuesRepository = $sendingQueuesRepository;
  56. $this->subscribersRepository = $subscribersRepository;
  57. $this->newslettersRepository = $newslettersRepository;
  58. $this->newsletterLinkRepository = $newsletterLinkRepository;
  59. $this->links = $links;
  60. }
  61. public function click($data) {
  62. return $this->clicks->track($this->_processTrackData($data));
  63. }
  64. public function open($data) {
  65. return $this->opens->track($this->_processTrackData($data));
  66. }
  67. public function _processTrackData($data) {
  68. $data = (object)$this->links->transformUrlDataObject($data);
  69. if (empty($data->queue_id) || // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
  70. empty($data->subscriber_id) || // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
  71. empty($data->subscriber_token) // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
  72. ) {
  73. return false;
  74. }
  75. $data->queue = $this->sendingQueuesRepository->findOneById($data->queue_id);// phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
  76. $data->subscriber = $this->subscribersRepository->findOneById($data->subscriber_id); // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
  77. $data->newsletter = (isset($data->newsletter_id)) ? $this->newslettersRepository->findOneById($data->newsletter_id) : null; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
  78. if (!$data->newsletter && ($data->queue instanceof SendingQueueEntity)) {
  79. $data->newsletter = $data->queue->getNewsletter();
  80. }
  81. if (!empty($data->link_hash)) { // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
  82. $data->link = $this->newsletterLinkRepository->findOneBy([
  83. 'hash' => $data->link_hash, // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
  84. 'queue' => $data->queue_id, // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
  85. ]);
  86. }
  87. $data->userAgent = $_SERVER['HTTP_USER_AGENT'] ?? null;
  88. return $this->_validateTrackData($data);
  89. }
  90. public function _validateTrackData($data) {
  91. if (!$data->subscriber || !$data->queue || !$data->newsletter) return false;
  92. $subscriberTokenMatch = $this->linkTokens->verifyToken($data->subscriber, $data->subscriber_token); // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
  93. if (!$subscriberTokenMatch) {
  94. $this->terminate(403);
  95. }
  96. // return if this is a WP user previewing the newsletter
  97. if ($data->subscriber->isWPUser() && $data->preview) {
  98. return $data;
  99. }
  100. // check if the newsletter was sent to the subscriber
  101. return ($this->sendingQueuesRepository->isSubscriberProcessed($data->queue, $data->subscriber)) ?
  102. $data :
  103. false;
  104. }
  105. public function terminate($code) {
  106. WPFunctions::get()->statusHeader($code);
  107. WPFunctions::get()->getTemplatePart((string)$code);
  108. exit;
  109. }
  110. }