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
Forms.php
315 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 Exception; |
| 9 | use MailPoet\API\JSON\Endpoint as APIEndpoint; |
| 10 | use MailPoet\API\JSON\Error; |
| 11 | use MailPoet\API\JSON\Error as APIError; |
| 12 | use MailPoet\API\JSON\Response; |
| 13 | use MailPoet\API\JSON\ResponseBuilders\FormsResponseBuilder; |
| 14 | use MailPoet\Config\AccessControl; |
| 15 | use MailPoet\Entities\FormEntity; |
| 16 | use MailPoet\Form\ApiDataSanitizer; |
| 17 | use MailPoet\Form\DisplayFormInWPContent; |
| 18 | use MailPoet\Form\FormSaveController; |
| 19 | use MailPoet\Form\FormsRepository; |
| 20 | use MailPoet\Form\PreviewPage; |
| 21 | use MailPoet\Form\Templates\TemplateRepository; |
| 22 | use MailPoet\Settings\UserFlagsController; |
| 23 | use MailPoet\Tags\TagRepository; |
| 24 | use MailPoet\WP\Emoji; |
| 25 | use MailPoet\WP\Functions as WPFunctions; |
| 26 | |
| 27 | class Forms extends APIEndpoint { |
| 28 | public $permissions = [ |
| 29 | 'global' => AccessControl::PERMISSION_MANAGE_FORMS, |
| 30 | ]; |
| 31 | |
| 32 | /** @var UserFlagsController */ |
| 33 | private $userFlags; |
| 34 | |
| 35 | /** @var FormsResponseBuilder */ |
| 36 | private $formsResponseBuilder; |
| 37 | |
| 38 | /** @var WPFunctions */ |
| 39 | private $wp; |
| 40 | |
| 41 | /** @var FormsRepository */ |
| 42 | private $formsRepository; |
| 43 | |
| 44 | /** @var TemplateRepository */ |
| 45 | private $templateRepository; |
| 46 | |
| 47 | /** @var Emoji */ |
| 48 | private $emoji; |
| 49 | |
| 50 | /** @var ApiDataSanitizer */ |
| 51 | private $dataSanitizer; |
| 52 | |
| 53 | /** @var TagRepository */ |
| 54 | private $tagRepository; |
| 55 | |
| 56 | /** @var FormSaveController */ |
| 57 | private $formSaveController; |
| 58 | |
| 59 | public function __construct( |
| 60 | UserFlagsController $userFlags, |
| 61 | FormsRepository $formsRepository, |
| 62 | TemplateRepository $templateRepository, |
| 63 | FormsResponseBuilder $formsResponseBuilder, |
| 64 | WPFunctions $wp, |
| 65 | Emoji $emoji, |
| 66 | ApiDataSanitizer $dataSanitizer, |
| 67 | TagRepository $tagRepository, |
| 68 | FormSaveController $formSaveController |
| 69 | ) { |
| 70 | $this->userFlags = $userFlags; |
| 71 | $this->wp = $wp; |
| 72 | $this->formsRepository = $formsRepository; |
| 73 | $this->templateRepository = $templateRepository; |
| 74 | $this->formsResponseBuilder = $formsResponseBuilder; |
| 75 | $this->emoji = $emoji; |
| 76 | $this->dataSanitizer = $dataSanitizer; |
| 77 | $this->tagRepository = $tagRepository; |
| 78 | $this->formSaveController = $formSaveController; |
| 79 | } |
| 80 | |
| 81 | public function get($data = []) { |
| 82 | $id = (isset($data['id']) ? (int)$data['id'] : false); |
| 83 | $form = $this->formsRepository->findOneById($id); |
| 84 | if ($form instanceof FormEntity) { |
| 85 | return $this->successResponse($this->formsResponseBuilder->build($form)); |
| 86 | } |
| 87 | return $this->errorResponse([ |
| 88 | APIError::NOT_FOUND => __('This form does not exist.', 'mailpoet'), |
| 89 | ]); |
| 90 | } |
| 91 | |
| 92 | public function setStatus($data = []) { |
| 93 | $status = (isset($data['status']) ? $data['status'] : null); |
| 94 | |
| 95 | if (!$status) { |
| 96 | return $this->badRequest([ |
| 97 | APIError::BAD_REQUEST => __('You need to specify a status.', 'mailpoet'), |
| 98 | ]); |
| 99 | } |
| 100 | |
| 101 | $id = (isset($data['id'])) ? (int)$data['id'] : false; |
| 102 | $form = $this->formsRepository->findOneById($id); |
| 103 | |
| 104 | if (!$form instanceof FormEntity) { |
| 105 | return $this->errorResponse([ |
| 106 | APIError::NOT_FOUND => __('This form does not exist.', 'mailpoet'), |
| 107 | ]); |
| 108 | } |
| 109 | |
| 110 | if (!in_array($status, [FormEntity::STATUS_ENABLED, FormEntity::STATUS_DISABLED])) { |
| 111 | return $this->badRequest([ |
| 112 | APIError::BAD_REQUEST => |
| 113 | sprintf( |
| 114 | // translators: %1$s is a comma-separated list of allowed values, %2$s the status the user specified. |
| 115 | __('Invalid status. Allowed values are (%1$s), you specified %2$s', 'mailpoet'), |
| 116 | join(', ', [FormEntity::STATUS_ENABLED, FormEntity::STATUS_DISABLED]), |
| 117 | $status |
| 118 | ), |
| 119 | ]); |
| 120 | } |
| 121 | |
| 122 | $form->setStatus($status); |
| 123 | $this->formsRepository->flush(); |
| 124 | |
| 125 | if ($status === FormEntity::STATUS_ENABLED) { |
| 126 | $this->wp->deleteTransient(DisplayFormInWPContent::NO_FORM_TRANSIENT_KEY); |
| 127 | } |
| 128 | |
| 129 | $form = $this->formsRepository->findOneById($id); |
| 130 | if (!$form instanceof FormEntity) return $this->errorResponse(); |
| 131 | return $this->successResponse( |
| 132 | $form->toArray() |
| 133 | ); |
| 134 | } |
| 135 | |
| 136 | public function previewEditor($data = []) { |
| 137 | // We want to allow preview for unsaved forms |
| 138 | $formId = $data['id'] ?? 0; |
| 139 | $this->wp->setTransient(PreviewPage::PREVIEW_DATA_TRANSIENT_PREFIX . $formId, $data, PreviewPage::PREVIEW_DATA_EXPIRATION); |
| 140 | return $this->successResponse(); |
| 141 | } |
| 142 | |
| 143 | public function saveEditor($data = []) { |
| 144 | $formId = (isset($data['id']) ? (int)$data['id'] : 0); |
| 145 | $initialForm = $this->getFormTemplateData(TemplateRepository::INITIAL_FORM_TEMPLATE); |
| 146 | $name = ($data['name'] ?? __('New form', 'mailpoet')); |
| 147 | $body = ($data['body'] ?? $initialForm['body']); |
| 148 | $body = $this->dataSanitizer->sanitizeBody($body); |
| 149 | $settings = ($data['settings'] ?? $initialForm['settings']); |
| 150 | $styles = ($data['styles'] ?? $initialForm['styles']); |
| 151 | $status = ($data['status'] ?? FormEntity::STATUS_ENABLED); |
| 152 | |
| 153 | // check if the form is used as a widget |
| 154 | $isWidget = false; |
| 155 | $widgets = $this->wp->getOption('widget_mailpoet_form'); |
| 156 | if (!empty($widgets)) { |
| 157 | foreach ($widgets as $widget) { |
| 158 | if (isset($widget['form']) && (int)$widget['form'] === $formId) { |
| 159 | $isWidget = true; |
| 160 | break; |
| 161 | } |
| 162 | } |
| 163 | } |
| 164 | |
| 165 | // Reset no form cache |
| 166 | $this->wp->deleteTransient(DisplayFormInWPContent::NO_FORM_TRANSIENT_KEY); |
| 167 | |
| 168 | // check if the user gets to pick his own lists |
| 169 | // or if it's selected by the admin |
| 170 | $formEntity = new FormEntity($name); |
| 171 | $formEntity->setBody($body); |
| 172 | $listSelection = $formEntity->getSegmentBlocksSegmentIds(); |
| 173 | |
| 174 | // check list selection |
| 175 | if (count($listSelection)) { |
| 176 | $settings['segments_selected_by'] = 'user'; |
| 177 | $settings['segments'] = $listSelection; |
| 178 | } else { |
| 179 | $settings['segments_selected_by'] = 'admin'; |
| 180 | } |
| 181 | |
| 182 | // check tags and create them if they don't exist |
| 183 | if (isset($settings['tags'])) { |
| 184 | $this->createTagsIfDoNotExist($settings['tags']); |
| 185 | } |
| 186 | |
| 187 | // Check Custom HTML block permissions |
| 188 | $customHtmlBlocks = $formEntity->getBlocksByTypes([FormEntity::HTML_BLOCK_TYPE]); |
| 189 | if (count($customHtmlBlocks) && !$this->wp->currentUserCan('administrator')) { |
| 190 | return $this->errorResponse([ |
| 191 | Error::FORBIDDEN => __('Only administrator can edit forms containing Custom HTML block.', 'mailpoet'), |
| 192 | ], [], Response::STATUS_FORBIDDEN); |
| 193 | } |
| 194 | |
| 195 | if ($body !== null) { |
| 196 | $body = $this->emoji->sanitizeEmojisInFormBody($body); |
| 197 | } |
| 198 | |
| 199 | $form = $this->getForm($data); |
| 200 | |
| 201 | if (!$form instanceof FormEntity) { |
| 202 | $form = new FormEntity($name); |
| 203 | } |
| 204 | $form->setName($name); |
| 205 | $form->setBody($body); |
| 206 | $form->setSettings($settings); |
| 207 | $form->setStyles($styles); |
| 208 | $form->setStatus($status); |
| 209 | $this->formsRepository->persist($form); |
| 210 | |
| 211 | try { |
| 212 | $this->formsRepository->flush(); |
| 213 | } catch (\Exception $e) { |
| 214 | return $this->badRequest(); |
| 215 | } |
| 216 | |
| 217 | if (isset($data['editor_version']) && $data['editor_version'] === "2") { |
| 218 | $this->userFlags->set('display_new_form_editor_nps_survey', true); |
| 219 | } |
| 220 | |
| 221 | $form = $this->getForm(['id' => $form->getId()]); |
| 222 | if(!$form instanceof FormEntity) return $this->errorResponse(); |
| 223 | return $this->successResponse( |
| 224 | $this->formsResponseBuilder->build($form), |
| 225 | ['is_widget' => $isWidget] |
| 226 | ); |
| 227 | } |
| 228 | |
| 229 | public function restore($data = []) { |
| 230 | $form = $this->getForm($data); |
| 231 | |
| 232 | if ($form instanceof FormEntity) { |
| 233 | $this->formsRepository->restore($form); |
| 234 | return $this->successResponse( |
| 235 | $form->toArray(), |
| 236 | ['count' => 1] |
| 237 | ); |
| 238 | } else { |
| 239 | return $this->errorResponse([ |
| 240 | APIError::NOT_FOUND => __('This form does not exist.', 'mailpoet'), |
| 241 | ]); |
| 242 | } |
| 243 | } |
| 244 | |
| 245 | public function trash($data = []) { |
| 246 | $form = $this->getForm($data); |
| 247 | |
| 248 | if ($form instanceof FormEntity) { |
| 249 | $this->formsRepository->trash($form); |
| 250 | return $this->successResponse( |
| 251 | $form->toArray(), |
| 252 | ['count' => 1] |
| 253 | ); |
| 254 | } else { |
| 255 | return $this->errorResponse([ |
| 256 | APIError::NOT_FOUND => __('This form does not exist.', 'mailpoet'), |
| 257 | ]); |
| 258 | } |
| 259 | } |
| 260 | |
| 261 | public function delete($data = []) { |
| 262 | $form = $this->getForm($data); |
| 263 | |
| 264 | if ($form instanceof FormEntity) { |
| 265 | $this->formsRepository->delete($form); |
| 266 | |
| 267 | return $this->successResponse(null, ['count' => 1]); |
| 268 | } else { |
| 269 | return $this->errorResponse([ |
| 270 | APIError::NOT_FOUND => __('This form does not exist.', 'mailpoet'), |
| 271 | ]); |
| 272 | } |
| 273 | } |
| 274 | |
| 275 | public function duplicate($data = []) { |
| 276 | $form = $this->getForm($data); |
| 277 | |
| 278 | if ($form instanceof FormEntity) { |
| 279 | try { |
| 280 | $duplicate = $this->formSaveController->duplicate($form); |
| 281 | } catch (Exception $e) { |
| 282 | return $this->errorResponse([ |
| 283 | APIError::UNKNOWN => __('Duplicating form failed.', 'mailpoet'), |
| 284 | ], [], Response::STATUS_UNKNOWN); |
| 285 | } |
| 286 | return $this->successResponse( |
| 287 | $this->formsResponseBuilder->build($duplicate), |
| 288 | ['count' => 1] |
| 289 | ); |
| 290 | } else { |
| 291 | return $this->errorResponse([ |
| 292 | APIError::NOT_FOUND => __('This form does not exist.', 'mailpoet'), |
| 293 | ]); |
| 294 | } |
| 295 | } |
| 296 | |
| 297 | private function getForm(array $data): ?FormEntity { |
| 298 | return isset($data['id']) |
| 299 | ? $this->formsRepository->findOneById((int)$data['id']) |
| 300 | : null; |
| 301 | } |
| 302 | |
| 303 | private function getFormTemplateData(string $templateId): array { |
| 304 | $formTemplate = $this->templateRepository->getFormTemplate($templateId); |
| 305 | $form = $formTemplate->toFormEntity(); |
| 306 | return $form->toArray(); |
| 307 | } |
| 308 | |
| 309 | private function createTagsIfDoNotExist(array $tagNames): void { |
| 310 | foreach ($tagNames as $tagName) { |
| 311 | $this->tagRepository->createOrUpdate(['name' => $tagName]); |
| 312 | } |
| 313 | } |
| 314 | } |
| 315 |