| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270 |
- <?php declare(strict_types = 1);
- namespace MailPoet\API\JSON\v1;
- if (!defined('ABSPATH')) exit;
- use InvalidArgumentException;
- use MailPoet\API\JSON\Endpoint as APIEndpoint;
- use MailPoet\API\JSON\Error;
- use MailPoet\API\JSON\Response;
- use MailPoet\API\JSON\ResponseBuilders\DynamicSegmentsResponseBuilder;
- use MailPoet\Config\AccessControl;
- use MailPoet\Doctrine\Validator\ValidationException;
- use MailPoet\Entities\SegmentEntity;
- use MailPoet\Listing\Handler;
- use MailPoet\Newsletter\Segment\NewsletterSegmentRepository;
- use MailPoet\Segments\DynamicSegments\DynamicSegmentsListingRepository;
- use MailPoet\Segments\DynamicSegments\Exceptions\InvalidFilterException;
- use MailPoet\Segments\DynamicSegments\FilterDataMapper;
- use MailPoet\Segments\DynamicSegments\SegmentSaveController;
- use MailPoet\Segments\SegmentsRepository;
- use MailPoet\Segments\SegmentSubscribersRepository;
- use MailPoet\UnexpectedValueException;
- use MailPoet\WP\Functions as WPFunctions;
- class DynamicSegments extends APIEndpoint {
- public $permissions = [
- 'global' => AccessControl::PERMISSION_MANAGE_SEGMENTS,
- ];
- /** @var Handler */
- private $listingHandler;
- /** @var DynamicSegmentsListingRepository */
- private $dynamicSegmentsListingRepository;
- /** @var SegmentsRepository */
- private $segmentsRepository;
- /** @var DynamicSegmentsResponseBuilder */
- private $segmentsResponseBuilder;
- /** @var SegmentSaveController */
- private $saveController;
- /** @var SegmentSubscribersRepository */
- private $segmentSubscribersRepository;
- /** @var FilterDataMapper */
- private $filterDataMapper;
- /** @var NewsletterSegmentRepository */
- private $newsletterSegmentRepository;
- public function __construct(
- Handler $handler,
- DynamicSegmentsListingRepository $dynamicSegmentsListingRepository,
- DynamicSegmentsResponseBuilder $segmentsResponseBuilder,
- SegmentsRepository $segmentsRepository,
- SegmentSubscribersRepository $segmentSubscribersRepository,
- FilterDataMapper $filterDataMapper,
- SegmentSaveController $saveController,
- NewsletterSegmentRepository $newsletterSegmentRepository
- ) {
- $this->listingHandler = $handler;
- $this->dynamicSegmentsListingRepository = $dynamicSegmentsListingRepository;
- $this->segmentsResponseBuilder = $segmentsResponseBuilder;
- $this->segmentsRepository = $segmentsRepository;
- $this->saveController = $saveController;
- $this->segmentSubscribersRepository = $segmentSubscribersRepository;
- $this->filterDataMapper = $filterDataMapper;
- $this->newsletterSegmentRepository = $newsletterSegmentRepository;
- }
- public function get($data = []) {
- if (isset($data['id'])) {
- $id = (int)$data['id'];
- } else {
- return $this->errorResponse([
- Error::BAD_REQUEST => WPFunctions::get()->__('Missing mandatory argument `id`.', 'mailpoet'),
- ]);
- }
- $segment = $this->segmentsRepository->findOneById($id);
- if (!$segment instanceof SegmentEntity) {
- return $this->errorResponse([
- Error::NOT_FOUND => WPFunctions::get()->__('This segment does not exist.', 'mailpoet'),
- ]);
- }
- return $this->successResponse($this->segmentsResponseBuilder->build($segment));
- }
- public function getCount($data = []) {
- try {
- $filterData = $this->filterDataMapper->map($data);
- $count = $this->segmentSubscribersRepository->getDynamicSubscribersCount($filterData);
- return $this->successResponse([
- 'count' => $count,
- ]);
- } catch (InvalidFilterException $e) {
- return $this->errorResponse([
- Error::BAD_REQUEST => $this->getErrorString($e),
- ], [], Response::STATUS_BAD_REQUEST);
- }
- }
- public function save($data) {
- try {
- $segment = $this->saveController->save($data);
- return $this->successResponse($this->segmentsResponseBuilder->build($segment));
- } catch (InvalidFilterException $e) {
- return $this->errorResponse([
- Error::BAD_REQUEST => $this->getErrorString($e),
- ], [], Response::STATUS_BAD_REQUEST);
- } catch (InvalidArgumentException $e) {
- return $this->badRequest([
- Error::BAD_REQUEST => __('Another record already exists. Please specify a different "name".', 'mailpoet'),
- ]);
- } catch (ValidationException $exception) {
- return $this->badRequest([
- Error::BAD_REQUEST => __('Please specify a name.', 'mailpoet'),
- ]);
- }
- }
- private function getErrorString(InvalidFilterException $e) {
- switch ($e->getCode()) {
- case InvalidFilterException::MISSING_TYPE:
- return WPFunctions::get()->__('The segment type is missing.', 'mailpoet');
- case InvalidFilterException::INVALID_TYPE:
- return WPFunctions::get()->__('The segment type is unknown.', 'mailpoet');
- case InvalidFilterException::MISSING_ROLE:
- return WPFunctions::get()->__('Please select a user role.', 'mailpoet');
- case InvalidFilterException::MISSING_ACTION:
- case InvalidFilterException::INVALID_EMAIL_ACTION:
- return WPFunctions::get()->__('Please select an email action.', 'mailpoet');
- case InvalidFilterException::MISSING_NEWSLETTER_ID:
- return WPFunctions::get()->__('Please select an email.', 'mailpoet');
- case InvalidFilterException::MISSING_PRODUCT_ID:
- return WPFunctions::get()->__('Please select a product.', 'mailpoet');
- case InvalidFilterException::MISSING_COUNTRY:
- return WPFunctions::get()->__('Please select a country.', 'mailpoet');
- case InvalidFilterException::MISSING_CATEGORY_ID:
- return WPFunctions::get()->__('Please select a category.', 'mailpoet');
- case InvalidFilterException::MISSING_VALUE:
- return WPFunctions::get()->__('Please fill all required values.', 'mailpoet');
- case InvalidFilterException::MISSING_NUMBER_OF_ORDERS_FIELDS:
- return WPFunctions::get()->__('Please select a type for the comparison, a number of orders and a number of days.', 'mailpoet');
- case InvalidFilterException::MISSING_TOTAL_SPENT_FIELDS:
- return WPFunctions::get()->__('Please select a type for the comparison, an amount and a number of days.', 'mailpoet');
- case InvalidFilterException::MISSING_FILTER:
- return WPFunctions::get()->__('Please add at least one condition for filtering.', 'mailpoet');
- default:
- return WPFunctions::get()->__('An error occurred while saving data.', 'mailpoet');
- }
- }
- public function trash($data = []) {
- if (!isset($data['id'])) {
- return $this->errorResponse([
- Error::BAD_REQUEST => WPFunctions::get()->__('Missing mandatory argument `id`.', 'mailpoet'),
- ]);
- }
- $segment = $this->getSegment($data);
- if ($segment === null) {
- return $this->errorResponse([
- Error::NOT_FOUND => WPFunctions::get()->__('This segment does not exist.', 'mailpoet'),
- ]);
- }
- $activelyUsedNewslettersSubjects = $this->newsletterSegmentRepository->getSubjectsOfActivelyUsedEmailsForSegments([$segment->getId()]);
- if (isset($activelyUsedNewslettersSubjects[$segment->getId()])) {
- return $this->badRequest([
- Error::BAD_REQUEST => str_replace(
- '%$1s',
- "'" . join("', '", $activelyUsedNewslettersSubjects[$segment->getId()] ) . "'",
- _x('Segment cannot be deleted because it’s used for %$1s email', 'Alert shown when trying to delete segment, which is assigned to any automatic emails.', 'mailpoet')
- ),
- ]);
- }
- $this->segmentsRepository->bulkTrash([$segment->getId()], SegmentEntity::TYPE_DYNAMIC);
- return $this->successResponse(
- $this->segmentsResponseBuilder->build($segment),
- ['count' => 1]
- );
- }
- public function restore($data = []) {
- if (!isset($data['id'])) {
- return $this->errorResponse([
- Error::BAD_REQUEST => WPFunctions::get()->__('Missing mandatory argument `id`.', 'mailpoet'),
- ]);
- }
- $segment = $this->getSegment($data);
- if ($segment === null) {
- return $this->errorResponse([
- Error::NOT_FOUND => WPFunctions::get()->__('This segment does not exist.', 'mailpoet'),
- ]);
- }
- $this->segmentsRepository->bulkRestore([$segment->getId()], SegmentEntity::TYPE_DYNAMIC);
- return $this->successResponse(
- $this->segmentsResponseBuilder->build($segment),
- ['count' => 1]
- );
- }
- public function delete($data = []) {
- if (!isset($data['id'])) {
- return $this->errorResponse([
- Error::BAD_REQUEST => WPFunctions::get()->__('Missing mandatory argument `id`.', 'mailpoet'),
- ]);
- }
- $segment = $this->getSegment($data);
- if ($segment === null) {
- return $this->errorResponse([
- Error::NOT_FOUND => WPFunctions::get()->__('This segment does not exist.', 'mailpoet'),
- ]);
- }
- $this->segmentsRepository->bulkDelete([$segment->getId()], SegmentEntity::TYPE_DYNAMIC);
- return $this->successResponse(null, ['count' => 1]);
- }
- public function listing($data = []) {
- $data['params'] = $data['params'] ?? ['segments']; // Dummy param to apply constraints properly
- $definition = $this->listingHandler->getListingDefinition($data);
- $items = $this->dynamicSegmentsListingRepository->getData($definition);
- $count = $this->dynamicSegmentsListingRepository->getCount($definition);
- $filters = $this->dynamicSegmentsListingRepository->getFilters($definition);
- $groups = $this->dynamicSegmentsListingRepository->getGroups($definition);
- $segments = $this->segmentsResponseBuilder->buildForListing($items);
- return $this->successResponse($segments, [
- 'count' => $count,
- 'filters' => $filters,
- 'groups' => $groups,
- ]);
- }
- public function bulkAction($data = []) {
- $definition = $this->listingHandler->getListingDefinition($data['listing']);
- $ids = $this->dynamicSegmentsListingRepository->getActionableIds($definition);
- if ($data['action'] === 'trash') {
- $count = $this->segmentsRepository->bulkTrash($ids, SegmentEntity::TYPE_DYNAMIC);
- } elseif ($data['action'] === 'restore') {
- $count = $this->segmentsRepository->bulkRestore($ids, SegmentEntity::TYPE_DYNAMIC);
- } elseif ($data['action'] === 'delete') {
- $count = $this->segmentsRepository->bulkDelete($ids, SegmentEntity::TYPE_DYNAMIC);
- } else {
- throw UnexpectedValueException::create()
- ->withErrors([Error::BAD_REQUEST => "Invalid bulk action '{$data['action']}' provided."]);
- }
- return $this->successResponse(null, ['count' => $count]);
- }
- private function getSegment(array $data): ?SegmentEntity {
- return isset($data['id'])
- ? $this->segmentsRepository->findOneById((int)$data['id'])
- : null;
- }
- }
|