287 lines
8.5 KiB
PHP
287 lines
8.5 KiB
PHP
<?php
|
|
|
|
namespace MailPoet\API\JSON\v1;
|
|
|
|
use MailPoet\API\JSON\Endpoint as APIEndpoint;
|
|
use MailPoet\API\JSON\Error as APIError;
|
|
use MailPoet\Config\AccessControl;
|
|
use MailPoet\Form\Util\FieldNameObfuscator;
|
|
use MailPoet\Listing;
|
|
use MailPoet\Models\Form;
|
|
use MailPoet\Models\Setting;
|
|
use MailPoet\Models\StatisticsForms;
|
|
use MailPoet\Models\Subscriber;
|
|
use MailPoet\Newsletter\Scheduler\Scheduler;
|
|
use MailPoet\Segments\BulkAction;
|
|
use MailPoet\Segments\SubscribersListings;
|
|
use MailPoet\Subscribers\RequiredCustomFieldValidator;
|
|
use MailPoet\Subscribers\Source;
|
|
use MailPoet\Subscription\Throttling as SubscriptionThrottling;
|
|
use MailPoet\WP\Hooks;
|
|
|
|
if(!defined('ABSPATH')) exit;
|
|
|
|
class Subscribers extends APIEndpoint {
|
|
const SUBSCRIPTION_LIMIT_COOLDOWN = 60;
|
|
|
|
public $permissions = array(
|
|
'global' => AccessControl::PERMISSION_MANAGE_SUBSCRIBERS,
|
|
'methods' => array('subscribe' => AccessControl::NO_ACCESS_RESTRICTION)
|
|
);
|
|
|
|
/** @var Listing\BulkActionController */
|
|
private $bulk_action_controller;
|
|
|
|
public function __construct(Listing\BulkActionController $bulk_action_controller) {
|
|
$this->bulk_action_controller = $bulk_action_controller;
|
|
}
|
|
|
|
function get($data = array()) {
|
|
$id = (isset($data['id']) ? (int)$data['id'] : false);
|
|
$subscriber = Subscriber::findOne($id);
|
|
if($subscriber === false) {
|
|
return $this->errorResponse(array(
|
|
APIError::NOT_FOUND => __('This subscriber does not exist.', 'mailpoet')
|
|
));
|
|
} else {
|
|
return $this->successResponse(
|
|
$subscriber
|
|
->withCustomFields()
|
|
->withSubscriptions()
|
|
->asArray()
|
|
);
|
|
}
|
|
}
|
|
|
|
function listing($data = array()) {
|
|
|
|
if(!isset($data['filter']['segment'])) {
|
|
$listing = new Listing\Handler();
|
|
|
|
$listing_data = $listing->get('\MailPoet\Models\Subscriber', $data);
|
|
} else {
|
|
$listings = new SubscribersListings();
|
|
$listing_data = $listings->getListingsInSegment($data);
|
|
}
|
|
|
|
$data = array();
|
|
foreach($listing_data['items'] as $subscriber) {
|
|
$data[] = $subscriber
|
|
->withSubscriptions()
|
|
->asArray();
|
|
}
|
|
|
|
$listing_data['filters']['segment'] = Hooks::applyFilters(
|
|
'mailpoet_subscribers_listings_filters_segments',
|
|
$listing_data['filters']['segment']
|
|
);
|
|
return $this->successResponse($data, array(
|
|
'count' => $listing_data['count'],
|
|
'filters' => $listing_data['filters'],
|
|
'groups' => $listing_data['groups']
|
|
));
|
|
}
|
|
|
|
function subscribe($data = array()) {
|
|
$form_id = (isset($data['form_id']) ? (int)$data['form_id'] : false);
|
|
$form = Form::findOne($form_id);
|
|
unset($data['form_id']);
|
|
|
|
$recaptcha = Setting::getValue('re_captcha');
|
|
|
|
if(!$form) {
|
|
return $this->badRequest(array(
|
|
APIError::BAD_REQUEST => __('Please specify a valid form ID.', 'mailpoet')
|
|
));
|
|
}
|
|
if(!empty($data['email'])) {
|
|
return $this->badRequest(array(
|
|
APIError::BAD_REQUEST => __('Please leave the first field empty.', 'mailpoet')
|
|
));
|
|
}
|
|
|
|
if(!empty($recaptcha['enabled']) && empty($data['recaptcha'])) {
|
|
return $this->badRequest(array(
|
|
APIError::BAD_REQUEST => __('Please check the CAPTCHA.', 'mailpoet')
|
|
));
|
|
}
|
|
|
|
if(!empty($recaptcha['enabled'])) {
|
|
$res = empty($data['recaptcha']) ? $data['recaptcha-no-js'] : $data['recaptcha'];
|
|
$res = wp_remote_post('https://www.google.com/recaptcha/api/siteverify', array(
|
|
'body' => array(
|
|
'secret' => $recaptcha['secret_token'],
|
|
'response' => $res
|
|
)
|
|
));
|
|
if(is_wp_error($res)) {
|
|
return $this->badRequest(array(
|
|
APIError::BAD_REQUEST => __('Error while validating the CAPTCHA.', 'mailpoet')
|
|
));
|
|
}
|
|
$res = json_decode(wp_remote_retrieve_body($res));
|
|
if(empty($res->success)) {
|
|
return $this->badRequest(array(
|
|
APIError::BAD_REQUEST => __('Error while validating the CAPTCHA.', 'mailpoet')
|
|
));
|
|
}
|
|
}
|
|
|
|
$data = $this->deobfuscateFormPayload($data);
|
|
|
|
try {
|
|
$validator = new RequiredCustomFieldValidator();
|
|
$validator->validate($data);
|
|
} catch (\Exception $e) {
|
|
return $this->badRequest([APIError::BAD_REQUEST => $e->getMessage()]);
|
|
}
|
|
|
|
$segment_ids = (!empty($data['segments'])
|
|
? (array)$data['segments']
|
|
: array()
|
|
);
|
|
$segment_ids = $form->filterSegments($segment_ids);
|
|
unset($data['segments']);
|
|
|
|
if(empty($segment_ids)) {
|
|
return $this->badRequest(array(
|
|
APIError::BAD_REQUEST => __('Please select a list.', 'mailpoet')
|
|
));
|
|
}
|
|
|
|
// only accept fields defined in the form
|
|
$form_fields = $form->getFieldList();
|
|
$data = array_intersect_key($data, array_flip($form_fields));
|
|
|
|
// make sure we don't allow too many subscriptions with the same ip address
|
|
$timeout = SubscriptionThrottling::throttle();
|
|
|
|
if($timeout > 0) {
|
|
throw new \Exception(sprintf(__('You need to wait %d seconds before subscribing again.', 'mailpoet'), $timeout));
|
|
}
|
|
|
|
$subscriber = Subscriber::subscribe($data, $segment_ids);
|
|
$errors = $subscriber->getErrors();
|
|
|
|
if($errors !== false) {
|
|
return $this->badRequest($errors);
|
|
} else {
|
|
$meta = array();
|
|
|
|
if($form !== false) {
|
|
// record form statistics
|
|
StatisticsForms::record($form->id, $subscriber->id);
|
|
|
|
$form = $form->asArray();
|
|
|
|
if(!empty($form['settings']['on_success'])) {
|
|
if($form['settings']['on_success'] === 'page') {
|
|
// redirect to a page on a success, pass the page url in the meta
|
|
$meta['redirect_url'] = get_permalink($form['settings']['success_page']);
|
|
} else if($form['settings']['on_success'] === 'url') {
|
|
$meta['redirect_url'] = $form['settings']['success_url'];
|
|
}
|
|
}
|
|
}
|
|
|
|
return $this->successResponse(
|
|
array(),
|
|
$meta
|
|
);
|
|
}
|
|
}
|
|
|
|
private function deobfuscateFormPayload($data) {
|
|
$obfuscator = new FieldNameObfuscator();
|
|
return $obfuscator->deobfuscateFormPayload($data);
|
|
}
|
|
|
|
function save($data = array()) {
|
|
if(empty($data['segments'])) {
|
|
$data['segments'] = array();
|
|
}
|
|
$subscriber = Subscriber::createOrUpdate($data);
|
|
$errors = $subscriber->getErrors();
|
|
|
|
if(!empty($errors)) {
|
|
return $this->badRequest($errors);
|
|
}
|
|
|
|
if($subscriber->isNew()) {
|
|
$subscriber = Source::setSource($subscriber, Source::ADMINISTRATOR);
|
|
$subscriber->save();
|
|
}
|
|
|
|
if(!empty($data['segments'])) {
|
|
Scheduler::scheduleSubscriberWelcomeNotification($subscriber->id, $data['segments']);
|
|
}
|
|
|
|
return $this->successResponse(
|
|
Subscriber::findOne($subscriber->id)->asArray()
|
|
);
|
|
}
|
|
|
|
function restore($data = array()) {
|
|
$id = (isset($data['id']) ? (int)$data['id'] : false);
|
|
$subscriber = Subscriber::findOne($id);
|
|
if($subscriber === false) {
|
|
return $this->errorResponse(array(
|
|
APIError::NOT_FOUND => __('This subscriber does not exist.', 'mailpoet')
|
|
));
|
|
} else {
|
|
$subscriber->restore();
|
|
return $this->successResponse(
|
|
Subscriber::findOne($subscriber->id)->asArray(),
|
|
array('count' => 1)
|
|
);
|
|
}
|
|
}
|
|
|
|
function trash($data = array()) {
|
|
$id = (isset($data['id']) ? (int)$data['id'] : false);
|
|
$subscriber = Subscriber::findOne($id);
|
|
if($subscriber === false) {
|
|
return $this->errorResponse(array(
|
|
APIError::NOT_FOUND => __('This subscriber does not exist.', 'mailpoet')
|
|
));
|
|
} else {
|
|
$subscriber->trash();
|
|
return $this->successResponse(
|
|
Subscriber::findOne($subscriber->id)->asArray(),
|
|
array('count' => 1)
|
|
);
|
|
}
|
|
}
|
|
|
|
function delete($data = array()) {
|
|
$id = (isset($data['id']) ? (int)$data['id'] : false);
|
|
$subscriber = Subscriber::findOne($id);
|
|
if($subscriber === false) {
|
|
return $this->errorResponse(array(
|
|
APIError::NOT_FOUND => __('This subscriber does not exist.', 'mailpoet')
|
|
));
|
|
} else {
|
|
$subscriber->delete();
|
|
return $this->successResponse(null, array('count' => 1));
|
|
}
|
|
}
|
|
|
|
function bulkAction($data = array()) {
|
|
try {
|
|
if(!isset($data['listing']['filter']['segment'])) {
|
|
return $this->successResponse(
|
|
null,
|
|
$this->bulk_action_controller->apply('\MailPoet\Models\Subscriber', $data)
|
|
);
|
|
} else {
|
|
$bulk_action = new BulkAction($data);
|
|
return $this->successResponse(null, $bulk_action->apply());
|
|
}
|
|
} catch(\Exception $e) {
|
|
return $this->errorResponse(array(
|
|
$e->getCode() => $e->getMessage()
|
|
));
|
|
}
|
|
}
|
|
}
|