FormEditor.php — MailPoet – Newsletters, Email Marketing, and Automation 5.37.0

mailpoet / lib / AdminPages / Pages / FormEditor.php

mailpoet / lib / AdminPages / Pages Last commit date

AbstractAutomationEmbed.php 7 months ago Automation.php 2 years ago AutomationAnalytics.php 3 months ago AutomationEditor.php 3 months ago AutomationFlowEmbed.php 7 months ago AutomationPreviewEmbed.php 3 months ago AutomationTemplates.php 2 years ago CustomFields.php 3 months ago DynamicSegments.php 3 months ago ExperimentalFeatures.php 3 years ago FormEditor.php 2 days ago Forms.php 3 months ago Help.php 2 days ago Homepage.php 2 years ago Landingpage.php 2 years ago Logs.php 2 months ago NewsletterEditor.php 2 days ago Newsletters.php 3 months ago Settings.php 6 months ago StaticSegments.php 3 months ago Subscribers.php 1 week ago SubscribersExport.php 3 years ago SubscribersImport.php 3 months ago Tags.php 4 months ago Upgrade.php 1 year ago WelcomeWizard.php 3 months ago WooCommerceSetup.php 3 months ago index.php 3 years ago

FormEditor.php

435 lines

1	<?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing
2
3	namespace MailPoet\AdminPages\Pages;
4
5	if (!defined('ABSPATH')) exit;
6
7
8	use MailPoet\AdminPages\AssetsController;
9	use MailPoet\AdminPages\PageRenderer;
10	use MailPoet\API\JSON\ResponseBuilders\CustomFieldsResponseBuilder;
11	use MailPoet\Config\Localizer;
12	use MailPoet\CustomFields\CustomFieldsRepository;
13	use MailPoet\Entities\FormEntity;
14	use MailPoet\Entities\SegmentEntity;
15	use MailPoet\Form\Block;
16	use MailPoet\Form\FormsRepository;
17	use MailPoet\Form\Renderer as FormRenderer;
18	use MailPoet\Form\Templates\TemplateRepository;
19	use MailPoet\Form\Templates\Templates\Template10BelowPages;
20	use MailPoet\Form\Templates\Templates\Template10FixedBar;
21	use MailPoet\Form\Templates\Templates\Template10Popup;
22	use MailPoet\Form\Templates\Templates\Template10SlideIn;
23	use MailPoet\Form\Templates\Templates\Template10Widget;
24	use MailPoet\Form\Templates\Templates\Template11BelowPages;
25	use MailPoet\Form\Templates\Templates\Template11FixedBar;
26	use MailPoet\Form\Templates\Templates\Template11Popup;
27	use MailPoet\Form\Templates\Templates\Template11SlideIn;
28	use MailPoet\Form\Templates\Templates\Template11Widget;
29	use MailPoet\Form\Templates\Templates\Template12BelowPages;
30	use MailPoet\Form\Templates\Templates\Template12FixedBar;
31	use MailPoet\Form\Templates\Templates\Template12Popup;
32	use MailPoet\Form\Templates\Templates\Template12SlideIn;
33	use MailPoet\Form\Templates\Templates\Template12Widget;
34	use MailPoet\Form\Templates\Templates\Template13BelowPages;
35	use MailPoet\Form\Templates\Templates\Template13FixedBar;
36	use MailPoet\Form\Templates\Templates\Template13Popup;
37	use MailPoet\Form\Templates\Templates\Template13SlideIn;
38	use MailPoet\Form\Templates\Templates\Template13Widget;
39	use MailPoet\Form\Templates\Templates\Template14BelowPages;
40	use MailPoet\Form\Templates\Templates\Template14FixedBar;
41	use MailPoet\Form\Templates\Templates\Template14Popup;
42	use MailPoet\Form\Templates\Templates\Template14SlideIn;
43	use MailPoet\Form\Templates\Templates\Template14Widget;
44	use MailPoet\Form\Templates\Templates\Template17BelowPages;
45	use MailPoet\Form\Templates\Templates\Template17FixedBar;
46	use MailPoet\Form\Templates\Templates\Template17Popup;
47	use MailPoet\Form\Templates\Templates\Template17SlideIn;
48	use MailPoet\Form\Templates\Templates\Template17Widget;
49	use MailPoet\Form\Templates\Templates\Template18BelowPages;
50	use MailPoet\Form\Templates\Templates\Template18FixedBar;
51	use MailPoet\Form\Templates\Templates\Template18Popup;
52	use MailPoet\Form\Templates\Templates\Template18SlideIn;
53	use MailPoet\Form\Templates\Templates\Template18Widget;
54	use MailPoet\Form\Templates\Templates\Template1BelowPages;
55	use MailPoet\Form\Templates\Templates\Template1FixedBar;
56	use MailPoet\Form\Templates\Templates\Template1Popup;
57	use MailPoet\Form\Templates\Templates\Template1SlideIn;
58	use MailPoet\Form\Templates\Templates\Template1Widget;
59	use MailPoet\Form\Templates\Templates\Template3BelowPages;
60	use MailPoet\Form\Templates\Templates\Template3FixedBar;
61	use MailPoet\Form\Templates\Templates\Template3Popup;
62	use MailPoet\Form\Templates\Templates\Template3SlideIn;
63	use MailPoet\Form\Templates\Templates\Template3Widget;
64	use MailPoet\Form\Templates\Templates\Template4BelowPages;
65	use MailPoet\Form\Templates\Templates\Template4FixedBar;
66	use MailPoet\Form\Templates\Templates\Template4Popup;
67	use MailPoet\Form\Templates\Templates\Template4SlideIn;
68	use MailPoet\Form\Templates\Templates\Template4Widget;
69	use MailPoet\Form\Templates\Templates\Template6BelowPages;
70	use MailPoet\Form\Templates\Templates\Template6FixedBar;
71	use MailPoet\Form\Templates\Templates\Template6Popup;
72	use MailPoet\Form\Templates\Templates\Template6SlideIn;
73	use MailPoet\Form\Templates\Templates\Template6Widget;
74	use MailPoet\Form\Templates\Templates\Template7BelowPages;
75	use MailPoet\Form\Templates\Templates\Template7FixedBar;
76	use MailPoet\Form\Templates\Templates\Template7Popup;
77	use MailPoet\Form\Templates\Templates\Template7SlideIn;
78	use MailPoet\Form\Templates\Templates\Template7Widget;
79	use MailPoet\Form\Util\CustomFonts;
80	use MailPoet\Form\Util\Export;
81	use MailPoet\NotFoundException;
82	use MailPoet\Router\Endpoints\FormPreview;
83	use MailPoet\Router\Router;
84	use MailPoet\Segments\SegmentsSimpleListRepository;
85	use MailPoet\Settings\Pages;
86	use MailPoet\Settings\UserFlagsController;
87	use MailPoet\Subscribers\TrackingConsentCapture;
88	use MailPoet\WP\AutocompletePostListLoader as WPPostListLoader;
89	use MailPoet\WP\Functions as WPFunctions;
90
91	class FormEditor {
92	/** @var PageRenderer */
93	private $pageRenderer;
94
95	/** @var CustomFieldsRepository */
96	private $customFieldsRepository;
97
98	/** @var CustomFieldsResponseBuilder */
99	private $customFieldsResponseBuilder;
100
101	/** @var FormRenderer */
102	private $formRenderer;
103
104	/** @var Block\Date */
105	private $dateBlock;
106
107	/** @var WPFunctions */
108	private $wp;
109
110	/** @var Localizer */
111	private $localizer;
112
113	/** @var TemplateRepository */
114	private $templatesRepository;
115
116	/** @var UserFlagsController */
117	private $userFlags;
118
119	/** @var WPPostListLoader */
120	private $wpPostListLoader;
121
122	/** @var SegmentsSimpleListRepository */
123	private $segmentsListRepository;
124
125	/** @var FormsRepository */
126	private $formsRepository;
127
128	private $activeTemplates = [
129	FormEntity::DISPLAY_TYPE_POPUP => [
130	Template1Popup::ID,
131	Template3Popup::ID,
132	Template4Popup::ID,
133	Template6Popup::ID,
134	Template7Popup::ID,
135	Template10Popup::ID,
136	Template11Popup::ID,
137	Template12Popup::ID,
138	Template13Popup::ID,
139	Template14Popup::ID,
140	Template17Popup::ID,
141	Template18Popup::ID,
142	],
143	FormEntity::DISPLAY_TYPE_SLIDE_IN => [
144	Template1SlideIn::ID,
145	Template3SlideIn::ID,
146	Template4SlideIn::ID,
147	Template6SlideIn::ID,
148	Template7SlideIn::ID,
149	Template10SlideIn::ID,
150	Template11SlideIn::ID,
151	Template12SlideIn::ID,
152	Template13SlideIn::ID,
153	Template14SlideIn::ID,
154	Template17SlideIn::ID,
155	Template18SlideIn::ID,
156	],
157	FormEntity::DISPLAY_TYPE_FIXED_BAR => [
158	Template1FixedBar::ID,
159	Template3FixedBar::ID,
160	Template4FixedBar::ID,
161	Template6FixedBar::ID,
162	Template7FixedBar::ID,
163	Template10FixedBar::ID,
164	Template11FixedBar::ID,
165	Template12FixedBar::ID,
166	Template13FixedBar::ID,
167	Template14FixedBar::ID,
168	Template17FixedBar::ID,
169	Template18FixedBar::ID,
170	],
171	FormEntity::DISPLAY_TYPE_BELOW_POST => [
172	Template1BelowPages::ID,
173	Template3BelowPages::ID,
174	Template4BelowPages::ID,
175	Template6BelowPages::ID,
176	Template7BelowPages::ID,
177	Template10BelowPages::ID,
178	Template11BelowPages::ID,
179	Template12BelowPages::ID,
180	Template13BelowPages::ID,
181	Template14BelowPages::ID,
182	Template17BelowPages::ID,
183	Template18BelowPages::ID,
184	],
185	FormEntity::DISPLAY_TYPE_OTHERS => [
186	Template1Widget::ID,
187	Template3Widget::ID,
188	Template4Widget::ID,
189	Template6Widget::ID,
190	Template7Widget::ID,
191	Template10Widget::ID,
192	Template11Widget::ID,
193	Template12Widget::ID,
194	Template13Widget::ID,
195	Template14Widget::ID,
196	Template17Widget::ID,
197	Template18Widget::ID,
198	],
199	];
200
201	/** @var AssetsController */
202	private $assetsController;
203
204	/** @var TrackingConsentCapture */
205	private $trackingConsentCapture;
206
207	public function __construct(
208	AssetsController $assetsController,
209	PageRenderer $pageRenderer,
210	CustomFieldsRepository $customFieldsRepository,
211	CustomFieldsResponseBuilder $customFieldsResponseBuilder,
212	FormRenderer $formRenderer,
213	Block\Date $dateBlock,
214	WPFunctions $wp,
215	Localizer $localizer,
216	UserFlagsController $userFlags,
217	WPPostListLoader $wpPostListLoader,
218	TemplateRepository $templateRepository,
219	FormsRepository $formsRepository,
220	SegmentsSimpleListRepository $segmentsListRepository,
221	TrackingConsentCapture $trackingConsentCapture
222	) {
223	$this->assetsController = $assetsController;
224	$this->pageRenderer = $pageRenderer;
225	$this->customFieldsRepository = $customFieldsRepository;
226	$this->customFieldsResponseBuilder = $customFieldsResponseBuilder;
227	$this->formRenderer = $formRenderer;
228	$this->dateBlock = $dateBlock;
229	$this->wp = $wp;
230	$this->localizer = $localizer;
231	$this->templatesRepository = $templateRepository;
232	$this->userFlags = $userFlags;
233	$this->wpPostListLoader = $wpPostListLoader;
234	$this->segmentsListRepository = $segmentsListRepository;
235	$this->formsRepository = $formsRepository;
236	$this->trackingConsentCapture = $trackingConsentCapture;
237	}
238
239	public function render() {
240	if (!isset($_GET['id']) && !isset($_GET['action']) && !isset($_GET['template_id'])) {
241	$this->renderTemplateSelection();
242	return;
243	}
244	if (is_string($_GET['template_id'] ?? null)) {
245	$template = $this->templatesRepository->getFormTemplate(sanitize_text_field(wp_unslash($_GET['template_id'])));
246	$form = $template->toFormEntity();
247	} else {
248	// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- is_numeric guard plus int cast is the sanitization
249	$idParam = $_GET['id'] ?? null;
250	$form = $this->getFormData(is_numeric($idParam) ? (int)$idParam : 0);
251	}
252	$customFields = $this->customFieldsRepository->findAllActive();
253	if (!$form instanceof FormEntity) {
254	throw new NotFoundException('Form does not exist');
255	}
256	$dateTypes = $this->dateBlock->getDateTypes();
257	$data = [
258	'form' => $form->toArray(),
259	'form_exports' => [
260	'php' => Export::get('php'),
261	'iframe' => Export::get('iframe'),
262	'shortcode' => Export::get('shortcode'),
263	],
264	'segments' => $this->segmentsListRepository->getListWithSubscribedSubscribersCounts([SegmentEntity::TYPE_DEFAULT]),
265	'styles' => $this->formRenderer->getCustomStyles($form),
266	'date_types' => array_map(function ($label, $value) {
267	return [
268	'label' => $label,
269	'value' => $value,
270	];
271	}, $dateTypes, array_keys($dateTypes)),
272	'date_formats' => $this->dateBlock->getDateFormats(),
273	'month_names' => $this->dateBlock->getMonthNames(),
274	'custom_fields' => $this->customFieldsResponseBuilder->buildBatch($customFields),
275	'editor_tutorial_seen' => $this->userFlags->get('form_editor_tutorial_seen'),
276	'preview_page_url' => $this->getPreviewPageUrl(),
277	'custom_fonts' => CustomFonts::FONTS,
278	'editor_color_palette' => $this->getEditorColorPalette(),
279	'translations' => $this->getGutenbergScriptsTranslations(),
280	'posts' => $this->wpPostListLoader->getPosts(),
281	'pages' => $this->wpPostListLoader->getPages(),
282	'categories' => $this->wpPostListLoader->getCategories(),
283	'tags' => $this->wpPostListLoader->getTags(),
284	'products' => $this->wpPostListLoader->getProducts(),
285	'product_categories' => $this->wpPostListLoader->getWooCommerceCategories(),
286	'product_tags' => $this->wpPostListLoader->getWooCommerceTags(),
287	'is_administrator' => $this->wp->currentUserCan('administrator'),
288	'tracking_consent_capture_enabled' => $this->trackingConsentCapture->isCaptureEnabled(),
289	'theme_support_widgets' => $this->wp->wpGetThemeSupport('widgets'),
290	'theme_support_fse' => $this->wp->wpGetTheme()->is_block_theme(),
291	];
292	$this->wp->wpEnqueueMedia();
293	$this->assetsController->setupFormEditorDependencies();
294	$this->pageRenderer->displayPage('form/editor.html', $data);
295	}
296
297	private function getEditorColorPalette(): array {
298	$palette = $this->normalizeColorPalette(
299	$this->wp->wpGetGlobalSettings(['color', 'palette', 'theme'])
300	);
301	if ($palette) {
302	return $palette;
303	}
304	return $this->normalizeColorPalette(
305	$this->wp->wpGetThemeSupport('editor-color-palette')
306	);
307	}
308
309	private function normalizeColorPalette($palette): array {
310	if (!is_array($palette)) {
311	return [];
312	}
313	if (
314	isset($palette[0])
315	&& is_array($palette[0])
316	&& !isset($palette[0]['color'])
317	) {
318	$palette = $palette[0];
319	}
320
321	$normalizedPalette = [];
322	foreach ($palette as $color) {
323	if (!is_array($color)) {
324	continue;
325	}
326	$name = isset($color['name']) && is_scalar($color['name'])
327	? $this->wp->sanitizeTextField((string)$color['name'])
328	: '';
329	$slug = isset($color['slug']) && is_scalar($color['slug'])
330	? $this->wp->sanitizeKey((string)$color['slug'])
331	: '';
332	$colorValue = isset($color['color']) && is_scalar($color['color'])
333	? $this->wp->sanitizeTextField((string)$color['color'])
334	: '';
335	if (!$name \|\| !$slug \|\| !$colorValue) {
336	continue;
337	}
338	$normalizedPalette[] = [
339	'name' => $name,
340	'slug' => $slug,
341	'color' => $colorValue,
342	];
343	}
344	return $normalizedPalette;
345	}
346
347	public function renderTemplateSelection() {
348	$templatesData = [];
349	foreach ($this->activeTemplates as $formType => $templateIds) {
350	$templateForms = $this->templatesRepository->getFormTemplates($this->activeTemplates[$formType]);
351	$templatesData[$formType] = [];
352	foreach ($templateForms as $templateId => $form) {
353	$templatesData[$formType][] = [
354	'id' => $templateId,
355	'name' => $form->getName(),
356	'thumbnail' => $form->getThumbnailUrl(),
357	];
358	}
359	}
360	$data = [
361	'templates' => $templatesData,
362	];
363	$this->assetsController->setupFormEditorDependencies();
364	$this->pageRenderer->displayPage('form/template_selection.html', $data);
365	}
366
367	private function getPreviewPageUrl() {
368	$mailpoetPage = Pages::getMailPoetPage(Pages::PAGE_SUBSCRIPTIONS);
369	if (!$mailpoetPage) {
370	return null;
371	}
372	$url = $this->wp->getPermalink($mailpoetPage);
373	$params = [
374	Router::NAME,
375	'endpoint=' . FormPreview::ENDPOINT,
376	'action=' . FormPreview::ACTION_VIEW,
377	];
378	$url .= (parse_url($url, PHP_URL_QUERY) ? '&' : '?') . join('&', $params);
379	return $url;
380	}
381
382	/**
383	* JS Translations are distributed and loaded per script. We can't use wp_set_script_translations
384	* because translation filename is determined based on script filename and path.
385	* This function loads JSON files with Gutenberg script's translations distributed within WordPress.
386	* Implemented based on load_script_textdomain function
387	* @see https://developer.wordpress.org/reference/functions/load_script_textdomain/
388	* @return string[]
389	*/
390	private function getGutenbergScriptsTranslations() {
391	$locale = $this->localizer->locale();
392	if (!$locale) {
393	return [];
394	}
395	// List of scripts - relative path to translations directory (default: wp-content/languages)
396	$translationsToLoad = [
397	'wp-includes/js/dist/blocks.js',
398	'wp-includes/js/dist/components.js',
399	'wp-includes/js/dist/block-editor.js',
400	'wp-includes/js/dist/block-library.js',
401	'wp-includes/js/dist/editor.js',
402	'wp-includes/js/dist/media-utils.js',
403	'wp-includes/js/dist/format-library.js',
404	'wp-includes/js/dist/edit-post.js',
405	];
406
407	$translations = [];
408	foreach ($translationsToLoad as $translation) {
409	$file = WP_LANG_DIR . '/' . $locale . '-' . md5($translation) . '.json';
410	if (!file_exists($file)) {
411	continue;
412	}
413	$translationsData = file_get_contents($file);
414	if ($translationsData) {
415	$translations[] = $translationsData;
416	}
417	}
418	return $translations;
419	}
420
421	private function getFormData(int $id): ?FormEntity {
422	$form = $this->formsRepository->findOneById($id);
423	if (!$form instanceof FormEntity) {
424	return null;
425	}
426	$form->setStyles($this->formRenderer->getCustomStyles($form));
427	// Use empty settings in case they are corrupted or missing
428	if (!is_array($form->getSettings())) {
429	$initialFormTemplate = $this->templatesRepository->getFormTemplate(TemplateRepository::INITIAL_FORM_TEMPLATE);
430	$form->setSettings($initialFormTemplate->getSettings());
431	}
432	return $form;
433	}
434	}
435