Cavemanon/piratepoet
7
Fork 0
Code Pull Requests Actions Releases 16 Activity

Use constants for exception codes

Browse Source 
[MAILPOET-2107]
This commit is contained in:
Pavel Dohnal
2019-06-06 09:05:27 +02:00
committed by M. Shull
parent 8ee1ead0a6
commit f17e7251c3
3 changed files with 62 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
lib/API/MP/v1/API.php
View File

@ -93,11 +93,11 @@ class API {
$custom_field = CustomField::createOrUpdate($this->custom_fields_data_sanitizer->sanitize($data)); $custom_field = CustomField::createOrUpdate($this->custom_fields_data_sanitizer->sanitize($data));
$errors = $custom_field->getErrors(); $errors = $custom_field->getErrors();
if (!empty($errors)) { if (!empty($errors)) {
throw new APIException('Failed to save a new subscriber field ' . join(', ', $errors), 1); throw new APIException('Failed to save a new subscriber field ' . join(', ', $errors), APIException::FAILED_TO_SAVE_SUBSCRIBER_FIELD);
} }
$custom_field = CustomField::findOne($custom_field->id); $custom_field = CustomField::findOne($custom_field->id);
if (!$custom_field instanceof CustomField) { if (!$custom_field instanceof CustomField) {
throw new APIException('Failed to create a new subscriber field', 1); throw new APIException('Failed to create a new subscriber field', APIException::FAILED_TO_SAVE_SUBSCRIBER_FIELD);
} }
return $custom_field->asArray(); return $custom_field->asArray();
} catch (\InvalidArgumentException $e) { } catch (\InvalidArgumentException $e) {
@ -115,33 +115,33 @@ class API {
$skip_subscriber_notification = (isset($options['skip_subscriber_notification']) && $options['skip_subscriber_notification'] === true) ? true : false; $skip_subscriber_notification = (isset($options['skip_subscriber_notification']) && $options['skip_subscriber_notification'] === true) ? true : false;
if (empty($list_ids)) { if (empty($list_ids)) {
throw new APIException(__('At least one segment ID is required.', 'mailpoet'), 3); throw new APIException(__('At least one segment ID is required.', 'mailpoet'), APIException::SEGMENT_REQUIRED);
} }
// throw exception when subscriber does not exist // throw exception when subscriber does not exist
$subscriber = Subscriber::findOne($subscriber_id); $subscriber = Subscriber::findOne($subscriber_id);
if (!$subscriber) { if (!$subscriber) {
throw new APIException(__('This subscriber does not exist.', 'mailpoet'), 4); throw new APIException(__('This subscriber does not exist.', 'mailpoet'), APIException::SUBSCRIBER_NOT_EXISTS);
} }
// throw exception when none of the segments exist // throw exception when none of the segments exist
$found_segments = Segment::whereIn('id', $list_ids)->findMany(); $found_segments = Segment::whereIn('id', $list_ids)->findMany();
if (!$found_segments) { if (!$found_segments) {
$exception = WPFunctions::get()->_n('This list does not exist.', 'These lists do not exist.', count($list_ids), 'mailpoet'); $exception = WPFunctions::get()->_n('This list does not exist.', 'These lists do not exist.', count($list_ids), 'mailpoet');
throw new APIException($exception, 5); throw new APIException($exception, APIException::LIST_NOT_EXISTS);
} }
// throw exception when trying to subscribe to WP Users or WooCommerce Customers segments // throw exception when trying to subscribe to WP Users or WooCommerce Customers segments
$found_segments_ids = []; $found_segments_ids = [];
foreach ($found_segments as $found_segment) { foreach ($found_segments as $found_segment) {
if ($found_segment->type === Segment::TYPE_WP_USERS) { if ($found_segment->type === Segment::TYPE_WP_USERS) {
throw new APIException(__(sprintf("Can't subscribe to a WordPress Users list with ID %d.", $found_segment->id), 'mailpoet'), 6); throw new APIException(__(sprintf("Can't subscribe to a WordPress Users list with ID %d.", $found_segment->id), 'mailpoet'), APIException::SUBSCRIBING_TO_WP_LIST_NOT_ALLOWED);
} }
if ($found_segment->type === Segment::TYPE_WC_USERS) { if ($found_segment->type === Segment::TYPE_WC_USERS) {
throw new APIException(__(sprintf("Can't subscribe to a WooCommerce Customers list with ID %d.", $found_segment->id), 'mailpoet'), 7); throw new APIException(__(sprintf("Can't subscribe to a WooCommerce Customers list with ID %d.", $found_segment->id), 'mailpoet'), APIException::SUBSCRIBING_TO_WC_LIST_NOT_ALLOWED);
} }
if ($found_segment->type !== Segment::TYPE_DEFAULT) { if ($found_segment->type !== Segment::TYPE_DEFAULT) {
throw new APIException(__(sprintf("Can't subscribe to a list with ID %d.", $found_segment->id), 'mailpoet'), 8); throw new APIException(__(sprintf("Can't subscribe to a list with ID %d.", $found_segment->id), 'mailpoet'), APIException::SUBSCRIBING_TO_LIST_NOT_ALLOWED);
} }
$found_segments_ids[] = $found_segment->id; $found_segments_ids[] = $found_segment->id;
} }
@ -153,7 +153,7 @@ class API {
WPFunctions::get()->_n('List with ID %s does not exist.', 'Lists with IDs %s do not exist.', count($missing_ids), 'mailpoet'), WPFunctions::get()->_n('List with ID %s does not exist.', 'Lists with IDs %s do not exist.', count($missing_ids), 'mailpoet'),
implode(', ', $missing_ids) implode(', ', $missing_ids)
); );
throw new APIException(sprintf($exception, implode(', ', $missing_ids)), 5); throw new APIException(sprintf($exception, implode(', ', $missing_ids)), APIException::LIST_NOT_EXISTS);
} }
SubscriberSegment::subscribeToSegments($subscriber, $found_segments_ids); SubscriberSegment::subscribeToSegments($subscriber, $found_segments_ids);
@ -173,7 +173,7 @@ class API {
if (!$result && $subscriber->getErrors()) { if (!$result && $subscriber->getErrors()) {
throw new APIException( throw new APIException(
WPFunctions::get()->__(sprintf('Subscriber added to lists, but confirmation email failed to send: %s', strtolower(implode(', ', $subscriber->getErrors()))), 'mailpoet'), WPFunctions::get()->__(sprintf('Subscriber added to lists, but confirmation email failed to send: %s', strtolower(implode(', ', $subscriber->getErrors()))), 'mailpoet'),
10); APIException::CONFIRMATION_FAILED_TO_SEND);
} }
} }
@ -190,30 +190,30 @@ class API {
function unsubscribeFromLists($subscriber_id, array $list_ids) { function unsubscribeFromLists($subscriber_id, array $list_ids) {
if (empty($list_ids)) { if (empty($list_ids)) {
throw new APIException(__('At least one segment ID is required.', 'mailpoet'), 3); throw new APIException(__('At least one segment ID is required.', 'mailpoet'), APIException::SEGMENT_REQUIRED);
} }
// throw exception when subscriber does not exist // throw exception when subscriber does not exist
$subscriber = Subscriber::findOne($subscriber_id); $subscriber = Subscriber::findOne($subscriber_id);
if (!$subscriber) { if (!$subscriber) {
throw new APIException(__('This subscriber does not exist.', 'mailpoet'), 4); throw new APIException(__('This subscriber does not exist.', 'mailpoet'), APIException::SUBSCRIBER_NOT_EXISTS);
} }
// throw exception when none of the segments exist // throw exception when none of the segments exist
$found_segments = Segment::whereIn('id', $list_ids)->findMany(); $found_segments = Segment::whereIn('id', $list_ids)->findMany();
if (!$found_segments) { if (!$found_segments) {
$exception = WPFunctions::get()->_n('This list does not exist.', 'These lists do not exist.', count($list_ids), 'mailpoet'); $exception = WPFunctions::get()->_n('This list does not exist.', 'These lists do not exist.', count($list_ids), 'mailpoet');
throw new APIException($exception, 5); throw new APIException($exception, APIException::LIST_NOT_EXISTS);
} }
// throw exception when trying to subscribe to WP Users or WooCommerce Customers segments // throw exception when trying to subscribe to WP Users or WooCommerce Customers segments
$found_segments_ids = []; $found_segments_ids = [];
foreach ($found_segments as $segment) { foreach ($found_segments as $segment) {
if ($segment->type === Segment::TYPE_WP_USERS) { if ($segment->type === Segment::TYPE_WP_USERS) {
throw new APIException(__(sprintf("Can't unsubscribe from a WordPress Users list with ID %d.", $segment->id), 'mailpoet'), 6); throw new APIException(__(sprintf("Can't unsubscribe from a WordPress Users list with ID %d.", $segment->id), 'mailpoet'), APIException::SUBSCRIBING_TO_WP_LIST_NOT_ALLOWED);
} }
if ($segment->type === Segment::TYPE_WC_USERS) { if ($segment->type === Segment::TYPE_WC_USERS) {
throw new APIException(__(sprintf("Can't unsubscribe from a WooCommerce Customers list with ID %d.", $segment->id), 'mailpoet'), 7); throw new APIException(__(sprintf("Can't unsubscribe from a WooCommerce Customers list with ID %d.", $segment->id), 'mailpoet'), APIException::SUBSCRIBING_TO_WC_LIST_NOT_ALLOWED);
} }
$found_segments_ids[] = $segment->id; $found_segments_ids[] = $segment->id;
} }
@ -225,7 +225,7 @@ class API {
WPFunctions::get()->_n('List with ID %s does not exist.', 'Lists with IDs %s do not exist.', count($missing_ids), 'mailpoet'), WPFunctions::get()->_n('List with ID %s does not exist.', 'Lists with IDs %s do not exist.', count($missing_ids), 'mailpoet'),
implode(', ', $missing_ids) implode(', ', $missing_ids)
); );
throw new APIException($exception, 5); throw new APIException($exception, APIException::LIST_NOT_EXISTS);
} }
SubscriberSegment::unsubscribeFromSegments($subscriber, $found_segments_ids); SubscriberSegment::unsubscribeFromSegments($subscriber, $found_segments_ids);
@ -246,7 +246,7 @@ class API {
if (empty($subscriber['email'])) { if (empty($subscriber['email'])) {
throw new APIException( throw new APIException(
WPFunctions::get()->__('Subscriber email address is required.', 'mailpoet'), WPFunctions::get()->__('Subscriber email address is required.', 'mailpoet'),
11 APIException::EMAIL_ADDRESS_REQUIRED
); );
} }
@ -254,7 +254,7 @@ class API {
if (Subscriber::findOne($subscriber['email'])) { if (Subscriber::findOne($subscriber['email'])) {
throw new APIException( throw new APIException(
WPFunctions::get()->__('This subscriber already exists.', 'mailpoet'), WPFunctions::get()->__('This subscriber already exists.', 'mailpoet'),
12 APIException::SUBSCRIBER_EXISTS
); );
} }
@ -277,7 +277,7 @@ class API {
if ($new_subscriber->getErrors() !== false) { if ($new_subscriber->getErrors() !== false) {
throw new APIException( throw new APIException(
WPFunctions::get()->__(sprintf('Failed to add subscriber: %s', strtolower(implode(', ', $new_subscriber->getErrors()))), 'mailpoet'), WPFunctions::get()->__(sprintf('Failed to add subscriber: %s', strtolower(implode(', ', $new_subscriber->getErrors()))), 'mailpoet'),
13 APIException::FAILED_TO_SAVE_SUBSCRIBER
); );
} }
if (!empty($custom_fields)) { if (!empty($custom_fields)) {
@ -310,7 +310,7 @@ class API {
if (empty($list['name'])) { if (empty($list['name'])) {
throw new APIException( throw new APIException(
WPFunctions::get()->__('List name is required.', 'mailpoet'), WPFunctions::get()->__('List name is required.', 'mailpoet'),
14 APIException::LIST_NAME_REQUIRED
); );
} }
@ -318,7 +318,7 @@ class API {
if (Segment::where('name', $list['name'])->findOne()) { if (Segment::where('name', $list['name'])->findOne()) {
throw new APIException( throw new APIException(
WPFunctions::get()->__('This list already exists.', 'mailpoet'), WPFunctions::get()->__('This list already exists.', 'mailpoet'),
15 APIException::LIST_EXISTS
); );
} }
@ -332,14 +332,14 @@ class API {
if ($new_list->getErrors() !== false) { if ($new_list->getErrors() !== false) {
throw new APIException( throw new APIException(
WPFunctions::get()->__(sprintf('Failed to add list: %s', strtolower(implode(', ', $new_list->getErrors()))), 'mailpoet'), WPFunctions::get()->__(sprintf('Failed to add list: %s', strtolower(implode(', ', $new_list->getErrors()))), 'mailpoet'),
16 APIException::FAILED_TO_SAVE_LIST
); );
} }
// reload list to get the saved created|updated|delete dates/other fields // reload list to get the saved created|updated|delete dates/other fields
$new_list = Segment::findOne($new_list->id); $new_list = Segment::findOne($new_list->id);
if (!$new_list instanceof Segment) { if (!$new_list instanceof Segment) {
throw new APIException(WPFunctions::get()->__('Failed to add list', 'mailpoet'), 16); throw new APIException(WPFunctions::get()->__('Failed to add list', 'mailpoet'), APIException::FAILED_TO_SAVE_LIST);
} }
return $new_list->asArray(); return $new_list->asArray();
@ -349,7 +349,7 @@ class API {
$subscriber = Subscriber::findOne($subscriber_email); $subscriber = Subscriber::findOne($subscriber_email);
// throw exception when subscriber does not exist // throw exception when subscriber does not exist
if (!$subscriber) { if (!$subscriber) {
throw new APIException(__('This subscriber does not exist.', 'mailpoet'), 4); throw new APIException(__('This subscriber does not exist.', 'mailpoet'), APIException::SUBSCRIBER_NOT_EXISTS);
} }
return $subscriber->withCustomFields()->withSubscriptions()->asArray(); return $subscriber->withCustomFields()->withSubscriptions()->asArray();
} }
@ -365,7 +365,7 @@ class API {
if ($queue instanceof Sending && $queue->getErrors()) { if ($queue instanceof Sending && $queue->getErrors()) {
throw new APIException( throw new APIException(
WPFunctions::get()->__(sprintf('Subscriber added, but welcome email failed to send: %s', strtolower(implode(', ', $queue->getErrors()))), 'mailpoet'), WPFunctions::get()->__(sprintf('Subscriber added, but welcome email failed to send: %s', strtolower(implode(', ', $queue->getErrors()))), 'mailpoet'),
17 APIException::WELCOME_FAILED_TO_SEND
); );
} }
} }

15
lib/API/MP/v1/APIException.php
View File

@ -4,4 +4,19 @@ namespace MailPoet\API\MP\v1;
if (!defined('ABSPATH')) exit; if (!defined('ABSPATH')) exit;
class APIException extends \Exception { class APIException extends \Exception {
const FAILED_TO_SAVE_SUBSCRIBER_FIELD = 1;
const SEGMENT_REQUIRED = 3;
const SUBSCRIBER_NOT_EXISTS = 4;
const LIST_NOT_EXISTS = 5;
const SUBSCRIBING_TO_WP_LIST_NOT_ALLOWED = 6;
const SUBSCRIBING_TO_WC_LIST_NOT_ALLOWED = 7;
const SUBSCRIBING_TO_LIST_NOT_ALLOWED = 8;
const CONFIRMATION_FAILED_TO_SEND = 10;
const EMAIL_ADDRESS_REQUIRED = 11;
const SUBSCRIBER_EXISTS = 12;
const FAILED_TO_SAVE_SUBSCRIBER = 13;
const LIST_NAME_REQUIRED = 14;
const LIST_EXISTS = 15;
const FAILED_TO_SAVE_LIST = 16;
const WELCOME_FAILED_TO_SEND = 17;
} }

33
lib/CustomFields/ApiDataSanitizer.php
View File

@ -7,6 +7,17 @@ use MailPoet\Models\CustomField;
class ApiDataSanitizer { class ApiDataSanitizer {
const ERROR_MANDATORY_ARGUMENT_MISSING = 1001;
const ERROR_MANDATORY_ARGUMENT_WRONG_TYPE = 1002;
const ERROR_PARAMS_WRONG_TYPE = 1003;
const ERROR_INVALID_TYPE = 1004;
const ERROR_INVALID_VALIDATE = 1005;
const ERROR_CHECKBOX_WRONG_VALUES_COUNT = 1006;
const ERROR_INVALID_DATE_FORMAT = 1007;
const ERROR_INVALID_DATE_TYPE = 1008;
const ERROR_NO_VALUES = 1009;
const ERROR_NO_VALUE = 1010;
function sanitize(array $data = []) { function sanitize(array $data = []) {
$this->checkMandatoryStringParameter($data, 'name'); $this->checkMandatoryStringParameter($data, 'name');
$this->checkMandatoryStringParameter($data, 'type'); $this->checkMandatoryStringParameter($data, 'type');
@ -20,16 +31,16 @@ class ApiDataSanitizer {
private function checkMandatoryStringParameter(array $data, $parameter_name) { private function checkMandatoryStringParameter(array $data, $parameter_name) {
if (empty($data[$parameter_name])) { if (empty($data[$parameter_name])) {
throw new InvalidArgumentException(sprintf(__('Mandatory argument "%s" is missing', 'mailpoet'), $parameter_name), 1001); throw new InvalidArgumentException(sprintf(__('Mandatory argument "%s" is missing', 'mailpoet'), $parameter_name), self::ERROR_MANDATORY_ARGUMENT_MISSING);
} }
if (!is_string($data[$parameter_name])) { if (!is_string($data[$parameter_name])) {
throw new InvalidArgumentException(sprintf(__('Mandatory argument "%s" has to be string', 'mailpoet'), $parameter_name), 1002); throw new InvalidArgumentException(sprintf(__('Mandatory argument "%s" has to be string', 'mailpoet'), $parameter_name), self::ERROR_MANDATORY_ARGUMENT_WRONG_TYPE);
} }
} }
private function checkParamsType($data) { private function checkParamsType($data) {
if (isset($data['params']) && !is_array($data['params'])) { if (isset($data['params']) && !is_array($data['params'])) {
throw new InvalidArgumentException(sprintf(__('Params has to be array', 'mailpoet')), 1003); throw new InvalidArgumentException(sprintf(__('Params has to be array', 'mailpoet')), self::ERROR_PARAMS_WRONG_TYPE);
} }
} }
@ -74,7 +85,7 @@ class ApiDataSanitizer {
return $this->getExtraParamsForDate($data['params']); return $this->getExtraParamsForDate($data['params']);
} }
throw new InvalidArgumentException(sprintf(__('Invalid type "%s"', 'mailpoet'), $type), 1004); throw new InvalidArgumentException(sprintf(__('Invalid type "%s"', 'mailpoet'), $type), self::ERROR_INVALID_TYPE);
} }
private function getExtraParamsForText($params) { private function getExtraParamsForText($params) {
@ -83,14 +94,14 @@ class ApiDataSanitizer {
if (in_array($validate, ['number', 'alphanum', 'phone'], true)) { if (in_array($validate, ['number', 'alphanum', 'phone'], true)) {
return ['validate' => $validate]; return ['validate' => $validate];
} }
throw new InvalidArgumentException(__('Validate parameter is not valid', 'mailpoet'), 1005); throw new InvalidArgumentException(__('Validate parameter is not valid', 'mailpoet'), self::ERROR_INVALID_VALIDATE);
} }
return []; return [];
} }
private function getExtraParamsForCheckbox($params) { private function getExtraParamsForCheckbox($params) {
if (empty($params['values']) || count($params['values']) > 1) { if (empty($params['values']) || count($params['values']) > 1) {
throw new InvalidArgumentException(__('You need to pass exactly one value for checkbox', 'mailpoet'), 1006); throw new InvalidArgumentException(__('You need to pass exactly one value for checkbox', 'mailpoet'), self::ERROR_CHECKBOX_WRONG_VALUES_COUNT);
} }
$value = reset($params['values']); $value = reset($params['values']);
return ['values' => [$this->sanitizeValue($value)]]; return ['values' => [$this->sanitizeValue($value)]];
@ -109,13 +120,13 @@ class ApiDataSanitizer {
switch ($date_type) { switch ($date_type) {
case 'year_month_day': case 'year_month_day':
if (!in_array($input_date_format, ['MM/DD/YYYY', 'DD/MM/YYYY', 'YYYY/MM/DD'], true)) { if (!in_array($input_date_format, ['MM/DD/YYYY', 'DD/MM/YYYY', 'YYYY/MM/DD'], true)) {
throw new InvalidArgumentException(__('Invalid date_format for year_month_day', 'mailpoet'), 1007); throw new InvalidArgumentException(__('Invalid date_format for year_month_day', 'mailpoet'), self::ERROR_INVALID_DATE_FORMAT);
} }
$date_format = $input_date_format; $date_format = $input_date_format;
break; break;
case 'year_month': case 'year_month':
if (!in_array($input_date_format, ['YYYY/MM', 'MM/YY'], true)) { if (!in_array($input_date_format, ['YYYY/MM', 'MM/YY'], true)) {
throw new InvalidArgumentException(__('Invalid date_format for year_month', 'mailpoet'), 1007); throw new InvalidArgumentException(__('Invalid date_format for year_month', 'mailpoet'), self::ERROR_INVALID_DATE_FORMAT);
} }
$date_format = $input_date_format; $date_format = $input_date_format;
break; break;
@ -129,7 +140,7 @@ class ApiDataSanitizer {
$date_format = 'DD'; $date_format = 'DD';
break; break;
default: default:
throw new InvalidArgumentException(__('Invalid value for date_type', 'mailpoet'), 1008); throw new InvalidArgumentException(__('Invalid value for date_type', 'mailpoet'), self::ERROR_INVALID_DATE_TYPE);
} }
return [ return [
'date_type' => $date_type, 'date_type' => $date_type,
@ -139,7 +150,7 @@ class ApiDataSanitizer {
private function getExtraParamsForSelect($params) { private function getExtraParamsForSelect($params) {
if (empty($params['values'])) { if (empty($params['values'])) {
throw new InvalidArgumentException(__('You need to pass some values for this type', 'mailpoet'), 1009); throw new InvalidArgumentException(__('You need to pass some values for this type', 'mailpoet'), self::ERROR_NO_VALUES);
} }
$values = []; $values = [];
foreach ($params['values'] as $value) { foreach ($params['values'] as $value) {
@ -150,7 +161,7 @@ class ApiDataSanitizer {
private function sanitizeValue($value) { private function sanitizeValue($value) {
if (empty($value['value'])) { if (empty($value['value'])) {
throw new InvalidArgumentException(__('Value cannot be empty', 'mailpoet'), 1010); throw new InvalidArgumentException(__('Value cannot be empty', 'mailpoet'), self::ERROR_NO_VALUE);
} }
$result = ['value' => $value['value']]; $result = ['value' => $value['value']];
if (isset($value['is_checked']) && $value['is_checked']) { if (isset($value['is_checked']) && $value['is_checked']) {