No Description

Renderer.php 8.1KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286
  1. <?php
  2. namespace MailPoet\Newsletter\Renderer;
  3. if (!defined('ABSPATH')) exit;
  4. use MailPoet\Config\Env;
  5. use MailPoet\Entities\NewsletterEntity;
  6. use MailPoet\InvalidStateException;
  7. use MailPoet\Models\Newsletter;
  8. use MailPoet\Newsletter\NewslettersRepository;
  9. use MailPoet\Newsletter\Renderer\EscapeHelper as EHelper;
  10. use MailPoet\RuntimeException;
  11. use MailPoet\Services\Bridge;
  12. use MailPoet\Tasks\Sending as SendingTask;
  13. use MailPoet\Util\License\License;
  14. use MailPoet\Util\pQuery\DomNode;
  15. use MailPoet\WP\Functions as WPFunctions;
  16. class Renderer {
  17. const NEWSLETTER_TEMPLATE = 'Template.html';
  18. const FILTER_POST_PROCESS = 'mailpoet_rendering_post_process';
  19. /** @var Blocks\Renderer */
  20. private $blocksRenderer;
  21. /** @var Columns\Renderer */
  22. private $columnsRenderer;
  23. /** @var Preprocessor */
  24. private $preprocessor;
  25. /** @var \MailPoetVendor\CSS */
  26. private $cSSInliner;
  27. /** @var Bridge */
  28. private $bridge;
  29. /** @var License */
  30. private $license;
  31. /** @var NewslettersRepository */
  32. private $newslettersRepository;
  33. public function __construct(
  34. Blocks\Renderer $blocksRenderer,
  35. Columns\Renderer $columnsRenderer,
  36. Preprocessor $preprocessor,
  37. \MailPoetVendor\CSS $cSSInliner,
  38. Bridge $bridge,
  39. NewslettersRepository $newslettersRepository,
  40. License $license
  41. ) {
  42. $this->blocksRenderer = $blocksRenderer;
  43. $this->columnsRenderer = $columnsRenderer;
  44. $this->preprocessor = $preprocessor;
  45. $this->cSSInliner = $cSSInliner;
  46. $this->bridge = $bridge;
  47. $this->license = $license;
  48. $this->newslettersRepository = $newslettersRepository;
  49. }
  50. /**
  51. * This is only temporary, when all calls are refactored to doctrine and only entity is passed we don't need this
  52. * @param \MailPoet\Models\Newsletter|NewsletterEntity $newsletter
  53. * @return NewsletterEntity|null
  54. */
  55. private function getNewsletter($newsletter) {
  56. if ($newsletter instanceof Newsletter) {
  57. return $this->newslettersRepository->findOneById($newsletter->id);
  58. }
  59. if (!$newsletter instanceof NewsletterEntity) {
  60. throw new InvalidStateException();
  61. }
  62. return $newsletter;
  63. }
  64. public function render($newsletter, SendingTask $sendingTask = null, $type = false) {
  65. return $this->_render($newsletter, $sendingTask, $type);
  66. }
  67. public function renderAsPreview($newsletter, $type = false, ?string $subject = null) {
  68. return $this->_render($newsletter, null, $type, true, $subject);
  69. }
  70. private function _render($newsletter, SendingTask $sendingTask = null, $type = false, $preview = false, $subject = null) {
  71. $newsletter = $this->getNewsletter($newsletter);
  72. if (!$newsletter instanceof NewsletterEntity) {
  73. throw new RuntimeException('Newsletter was not found');
  74. }
  75. $body = (is_array($newsletter->getBody()))
  76. ? $newsletter->getBody()
  77. : [];
  78. $content = (array_key_exists('content', $body))
  79. ? $body['content']
  80. : [];
  81. $styles = (array_key_exists('globalStyles', $body))
  82. ? $body['globalStyles']
  83. : [];
  84. if (
  85. !$this->license->hasLicense()
  86. && !$this->bridge->isMailpoetSendingServiceEnabled()
  87. && !$preview
  88. ) {
  89. $content = $this->addMailpoetLogoContentBlock($content, $styles);
  90. }
  91. $content = $this->preprocessor->process($newsletter, $content, $preview, $sendingTask);
  92. $renderedBody = $this->renderBody($newsletter, $content);
  93. $renderedStyles = $this->renderStyles($styles);
  94. $customFontsLinks = StylesHelper::getCustomFontsLinks($styles);
  95. $template = $this->injectContentIntoTemplate(
  96. (string)file_get_contents(dirname(__FILE__) . '/' . self::NEWSLETTER_TEMPLATE),
  97. [
  98. htmlspecialchars($subject ?: $newsletter->getSubject()),
  99. $renderedStyles,
  100. $customFontsLinks,
  101. EHelper::escapeHtmlText($newsletter->getPreheader()),
  102. $renderedBody,
  103. ]
  104. );
  105. if ($template === null) {
  106. $template = '';
  107. }
  108. $templateDom = $this->inlineCSSStyles($template);
  109. $template = $this->postProcessTemplate($templateDom);
  110. $renderedNewsletter = [
  111. 'html' => $template,
  112. 'text' => $this->renderTextVersion($template),
  113. ];
  114. return ($type && !empty($renderedNewsletter[$type])) ?
  115. $renderedNewsletter[$type] :
  116. $renderedNewsletter;
  117. }
  118. /**
  119. * @param NewsletterEntity $newsletter
  120. * @param array $content
  121. * @return string
  122. */
  123. private function renderBody(NewsletterEntity $newsletter, array $content) {
  124. $blocks = (array_key_exists('blocks', $content))
  125. ? $content['blocks']
  126. : [];
  127. $renderedContent = [];
  128. foreach ($blocks as $contentBlock) {
  129. $columnsData = $this->blocksRenderer->render($newsletter, $contentBlock);
  130. $renderedContent[] = $this->columnsRenderer->render(
  131. $contentBlock,
  132. $columnsData
  133. );
  134. }
  135. return implode('', $renderedContent);
  136. }
  137. /**
  138. * @param array $styles
  139. * @return string
  140. */
  141. private function renderStyles(array $styles) {
  142. $css = '';
  143. foreach ($styles as $selector => $style) {
  144. switch ($selector) {
  145. case 'text':
  146. $selector = 'td.mailpoet_paragraph, td.mailpoet_blockquote, li.mailpoet_paragraph';
  147. break;
  148. case 'body':
  149. $selector = 'body, .mailpoet-wrapper';
  150. break;
  151. case 'link':
  152. $selector = '.mailpoet-wrapper a';
  153. break;
  154. case 'wrapper':
  155. $selector = '.mailpoet_content-wrapper';
  156. break;
  157. }
  158. if (!is_array($style)) {
  159. continue;
  160. }
  161. $css .= StylesHelper::setStyle($style, $selector);
  162. }
  163. return $css;
  164. }
  165. /**
  166. * @param string $template
  167. * @param string[] $content
  168. * @return string|null
  169. */
  170. private function injectContentIntoTemplate($template, $content) {
  171. return preg_replace_callback('/{{\w+}}/', function($matches) use (&$content) {
  172. return array_shift($content);
  173. }, $template);
  174. }
  175. /**
  176. * @param string $template
  177. * @return DomNode
  178. */
  179. private function inlineCSSStyles($template) {
  180. return $this->cSSInliner->inlineCSS($template);
  181. }
  182. /**
  183. * @param string $template
  184. * @return string
  185. */
  186. private function renderTextVersion($template) {
  187. $template = (mb_detect_encoding($template, 'UTF-8', true)) ? $template : utf8_encode($template);
  188. return @\Html2Text\Html2Text::convert($template);
  189. }
  190. /**
  191. * @param DomNode $templateDom
  192. * @return string
  193. */
  194. private function postProcessTemplate(DomNode $templateDom) {
  195. // replace spaces in image tag URLs
  196. foreach ($templateDom->query('img') as $image) {
  197. $image->src = str_replace(' ', '%20', $image->src);
  198. }
  199. // because tburry/pquery contains a bug and replaces the opening non mso condition incorrectly we have to replace the opening tag with correct value
  200. $template = $templateDom->__toString();
  201. $template = str_replace('<!--[if !mso]><![endif]-->', '<!--[if !mso]><!-- -->', $template);
  202. $template = WPFunctions::get()->applyFilters(
  203. self::FILTER_POST_PROCESS,
  204. $template
  205. );
  206. return $template;
  207. }
  208. /**
  209. * @param array $content
  210. * @param array $styles
  211. * @return array
  212. */
  213. private function addMailpoetLogoContentBlock(array $content, array $styles) {
  214. if (empty($content['blocks'])) return $content;
  215. $content['blocks'][] = [
  216. 'type' => 'container',
  217. 'orientation' => 'horizontal',
  218. 'styles' => [
  219. 'block' => [
  220. 'backgroundColor' => (!empty($styles['body']['backgroundColor'])) ?
  221. $styles['body']['backgroundColor'] :
  222. 'transparent',
  223. ],
  224. ],
  225. 'blocks' => [
  226. [
  227. 'type' => 'container',
  228. 'orientation' => 'vertical',
  229. 'styles' => [
  230. ],
  231. 'blocks' => [
  232. [
  233. 'type' => 'image',
  234. 'link' => 'http://www.mailpoet.com',
  235. 'src' => Env::$assetsUrl . '/img/mailpoet_logo_newsletter.png',
  236. 'fullWidth' => false,
  237. 'alt' => 'MailPoet',
  238. 'width' => '108px',
  239. 'height' => '65px',
  240. 'styles' => [
  241. 'block' => [
  242. 'textAlign' => 'center',
  243. ],
  244. ],
  245. ],
  246. ],
  247. ],
  248. ],
  249. ];
  250. return $content;
  251. }
  252. }