<?php
namespace MailPoet\Config;
if (!defined('ABSPATH')) exit;
use MailPoet\AdminPages\Pages\Automation;
use MailPoet\AdminPages\Pages\AutomationEditor;
use MailPoet\AdminPages\Pages\AutomationTemplates;
use MailPoet\AdminPages\Pages\ExperimentalFeatures;
use MailPoet\AdminPages\Pages\FormEditor;
use MailPoet\AdminPages\Pages\Forms;
use MailPoet\AdminPages\Pages\Help;
use MailPoet\AdminPages\Pages\Logs;
use MailPoet\AdminPages\Pages\NewsletterEditor;
use MailPoet\AdminPages\Pages\Newsletters;
use MailPoet\AdminPages\Pages\Segments;
use MailPoet\AdminPages\Pages\Settings;
use MailPoet\AdminPages\Pages\Subscribers;
use MailPoet\AdminPages\Pages\SubscribersExport;
use MailPoet\AdminPages\Pages\SubscribersImport;
use MailPoet\AdminPages\Pages\Upgrade;
use MailPoet\AdminPages\Pages\WelcomeWizard;
use MailPoet\AdminPages\Pages\WooCommerceSetup;
use MailPoet\DI\ContainerWrapper;
use MailPoet\Features\FeaturesController;
use MailPoet\Form\Util\CustomFonts;
use MailPoet\Util\License\License;
use MailPoet\WP\Functions as WPFunctions;
class Menu {
const MAIN_PAGE_SLUG = 'mailpoet-newsletters';
const ICON_BASE64_SVG = 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxNTIuMDIgMTU2LjQiPjx0aXRsZT5NYWlsUG9ldCBpY29uPC90aXRsZT48ZyBpZD0iTGF5ZXJfMiIgZGF0YS1uYW1lPSJMYXllciAyIj48ZyBpZD0iTGF5ZXJfMS0yIiBkYXRhLW5hbWU9IkxheWVyIDEiPjxwYXRoIGZpbGw9ImN1cnJlbnRDb2xvciIgZD0iTTM3LjcxLDg5LjFjMy41LDAsNS45LS44LDcuMi0yLjNhOCw4LDAsMCwwLDItNS40VjM1LjdsMTcsNDUuMWExMi42OCwxMi42OCwwLDAsMCwzLjcsNS40YzEuNiwxLjMsNCwyLDcuMiwyYTEyLjU0LDEyLjU0LDAsMCwwLDUuOS0xLjQsOC40MSw4LjQxLDAsMCwwLDMuOS01bDE4LjEtNTBWODFhOC41Myw4LjUzLDAsMCwwLDIuMSw2LjFjMS40LDEuNCwzLjcsMi4yLDYuOSwyLjIsMy41LDAsNS45LS44LDcuMi0yLjNhOCw4LDAsMCwwLDItNS40VjguN2E3LjQ4LDcuNDgsMCwwLDAtMy4zLTYuNmMtMi4xLTEuNC01LTIuMS04LjYtMi4xYTE5LjMsMTkuMywwLDAsMC05LjQsMiwxMS42MywxMS42MywwLDAsMC01LjEsNi44TDc0LjkxLDY3LjEsNTQuNDEsOC40YTEyLjQsMTIuNCwwLDAsMC00LjUtNi4yYy0yLjEtMS41LTUtMi4yLTguOC0yLjJhMTYuNTEsMTYuNTEsMCwwLDAtOC45LDIuMWMtMi4zLDEuNS0zLjUsMy45LTMuNSw3LjJWODAuOGMwLDIuOC43LDQuOCwyLDYuMkMzMi4yMSw4OC40LDM0LjQxLDg5LjEsMzcuNzEsODkuMVoiLz48cGF0aCBmaWxsPSJjdXJyZW50Q29sb3IiIGQ9Ik0xNDksMTE2LjZsLTIuNC0xLjlhNy40LDcuNCwwLDAsMC05LjQuMywxOS42NSwxOS42NSwwLDAsMS0xMi41LDQuNmgtMjEuNEEzNy4wOCwzNy4wOCwwLDAsMCw3NywxMzAuNWwtMS4xLDEuMi0xLjEtMS4xYTM3LjI1LDM3LjI1LDAsMCwwLTI2LjMtMTAuOUgyN2ExOS41OSwxOS41OSwwLDAsMS0xMi40LTQuNiw3LjI4LDcuMjgsMCwwLDAtOS40LS4zbC0yLjQsMS45QTcuNDMsNy40MywwLDAsMCwwLDEyMi4yYTcuMTQsNy4xNCwwLDAsMCwyLjQsNS43QTM3LjI4LDM3LjI4LDAsMCwwLDI3LDEzNy40aDIxLjZhMTkuNTksMTkuNTksMCwwLDEsMTguOSwxNC40di4yYy4xLjcsMS4yLDQuNCw4LjUsNC40czguNC0zLjcsOC41LTQuNHYtLjJhMTkuNTksMTkuNTksMCwwLDEsMTguOS0xNC40SDEyNWEzNy4yOCwzNy4yOCwwLDAsMCwyNC42LTkuNSw3LjQyLDcuNDIsMCwwLDAsMi40LTUuN0E3Ljg2LDcuODYsMCwwLDAsMTQ5LDExNi42WiIvPjwvZz48L2c+PC9zdmc+';
public $mpApiKeyValid;
public $premiumKeyValid;
/** @var AccessControl */
private $accessControl;
/** @var WPFunctions */
private $wp;
/** @var ServicesChecker */
private $servicesChecker;
/** @var ContainerWrapper */
private $container;
/** @var Router */
private $router;
/** @var FeaturesController */
private $featuresController;
/** @var CustomFonts */
private $customFonts;
public function __construct(
AccessControl $accessControl,
WPFunctions $wp,
ServicesChecker $servicesChecker,
ContainerWrapper $container,
Router $router,
FeaturesController $featuresController,
CustomFonts $customFonts
) {
$this->accessControl = $accessControl;
$this->wp = $wp;
$this->servicesChecker = $servicesChecker;
$this->container = $container;
$this->router = $router;
$this->featuresController = $featuresController;
$this->customFonts = $customFonts;
}
public function init() {
$this->checkPremiumKey();
$this->wp->addAction(
'admin_menu',
[
$this,
'setup',
]
);
}
public function setup() {
if (!$this->accessControl->validatePermission(AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN)) return;
$this->router->checkRedirects();
$this->registerMailPoetMenu();
// @ToDo Remove Beta once Automation is no longer beta.
$this->wp->addAction('admin_head', function () {
echo '<style>
#adminmenu .toplevel_page_mailpoet-newsletters a[href="admin.php?page=mailpoet-automation"] {
display: flex;
gap: 8px;
}
.mailpoet-beta-badge {
background: #F0F0F1;
border-radius: 50px;
padding: 0 12px;
color: #1D2327;
font-weight: normal;
}
</style>';
});
if (!self::isOnMailPoetAdminPage()) {
return;
}
$this->wp->doAction('mailpoet_conflict_resolver_styles');
$this->wp->doAction('mailpoet_conflict_resolver_scripts');
if (
!isset($_REQUEST['page'])
|| sanitize_text_field(wp_unslash($_REQUEST['page'])) !== 'mailpoet-newsletter-editor'
) {
return;
}
// Disable WP emojis to not interfere with the newsletter editor emoji handling
$this->disableWPEmojis();
if (!$this->customFonts->displayCustomFonts()) {
return;
}
$this->wp->addAction('admin_head', function () {
echo '<link href="https://fonts.googleapis.com/css?family='
. 'Arvo:400,400i,700,700i'
. '|Lato:400,400i,700,700i'
. '|Lora:400,400i,700,700i'
. '|Merriweather:400,400i,700,700i'
. '|Merriweather+Sans:400,400i,700,700i'
. '|Noticia+Text:400,400i,700,700i'
. '|Open+Sans:400,400i,700,700i'
. '|Playfair+Display:400,400i,700,700i'
. '|Roboto:400,400i,700,700i'
. '|Source+Sans+Pro:400,400i,700,700i'
. '|Oswald:400,400i,700,700i'
. '|Raleway:400,400i,700,700i'
. '|Permanent+Marker:400,400i,700,700i'
. '|Pacifico:400,400i,700,700i'
. '" rel="stylesheet">';
});
}
private function registerMailPoetMenu() {
// Main page
$this->wp->addMenuPage(
'MailPoet',
'MailPoet',
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
self::MAIN_PAGE_SLUG,
null,
self::ICON_BASE64_SVG,
30
);
// Emails page
$newslettersPage = $this->wp->addSubmenuPage(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Emails', 'mailpoet')),
esc_html__('Emails', 'mailpoet'),
AccessControl::PERMISSION_MANAGE_EMAILS,
self::MAIN_PAGE_SLUG,
[
$this,
'newsletters',
]
);
// add limit per page to screen options
$this->wp->addAction('load-' . $newslettersPage, function() {
$this->wp->addScreenOption('per_page', [
'label' => _x(
'Number of newsletters per page',
'newsletters per page (screen options)',
'mailpoet'
),
'option' => 'mailpoet_newsletters_per_page',
]);
});
// newsletter editor
$this->wp->addSubmenuPage(
true,
$this->setPageTitle(__('Newsletter', 'mailpoet')),
esc_html__('Newsletter Editor', 'mailpoet'),
AccessControl::PERMISSION_MANAGE_EMAILS,
'mailpoet-newsletter-editor',
[
$this,
'newletterEditor',
]
);
$this->registerAutomationMenu();
// Forms page
$formsPage = $this->wp->addSubmenuPage(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Forms', 'mailpoet')),
esc_html__('Forms', 'mailpoet'),
AccessControl::PERMISSION_MANAGE_FORMS,
'mailpoet-forms',
[
$this,
'forms',
]
);
// add limit per page to screen options
$this->wp->addAction('load-' . $formsPage, function() {
$this->wp->addScreenOption('per_page', [
'label' => _x(
'Number of forms per page',
'forms per page (screen options)',
'mailpoet'
),
'option' => 'mailpoet_forms_per_page',
]);
});
// form editor
$formEditorPage = $this->wp->addSubmenuPage(
true,
$this->setPageTitle(__('Form Editor', 'mailpoet')),
esc_html__('Form Editor', 'mailpoet'),
AccessControl::PERMISSION_MANAGE_FORMS,
'mailpoet-form-editor',
[
$this,
'formEditor',
]
);
// add body class for form editor page
$this->wp->addAction('load-' . $formEditorPage, function() {
$this->wp->addFilter('admin_body_class', function ($classes) {
return ltrim($classes . ' block-editor-page');
});
});
// form editor templates
$formTemplateSelectionEditorPage = $this->wp->addSubmenuPage(
true,
$this->setPageTitle(__('Select Form Template', 'mailpoet')),
esc_html__('Select Form Template', 'mailpoet'),
AccessControl::PERMISSION_MANAGE_FORMS,
'mailpoet-form-editor-template-selection',
[
$this,
'formEditorTemplateSelection',
]
);
// add body class for form editor page
$this->wp->addAction('load-' . $formTemplateSelectionEditorPage, function() {
$this->wp->addFilter('admin_body_class', function ($classes) {
return ltrim($classes . ' block-editor-page');
});
});
// Subscribers page
$subscribersPage = $this->wp->addSubmenuPage(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Subscribers', 'mailpoet')),
esc_html__('Subscribers', 'mailpoet'),
AccessControl::PERMISSION_MANAGE_SUBSCRIBERS,
'mailpoet-subscribers',
[
$this,
'subscribers',
]
);
// add limit per page to screen options
$this->wp->addAction('load-' . $subscribersPage, function() {
$this->wp->addScreenOption('per_page', [
'label' => _x(
'Number of subscribers per page',
'subscribers per page (screen options)',
'mailpoet'
),
'option' => 'mailpoet_subscribers_per_page',
]);
});
// import
$this->wp->addSubmenuPage(
'admin.php?page=mailpoet-subscribers',
$this->setPageTitle(__('Import', 'mailpoet')),
esc_html__('Import', 'mailpoet'),
AccessControl::PERMISSION_MANAGE_SUBSCRIBERS,
'mailpoet-import',
[
$this,
'import',
]
);
// export
$this->wp->addSubmenuPage(
true,
$this->setPageTitle(__('Export', 'mailpoet')),
esc_html__('Export', 'mailpoet'),
AccessControl::PERMISSION_MANAGE_SUBSCRIBERS,
'mailpoet-export',
[
$this,
'export',
]
);
// Segments page
$segmentsPage = $this->wp->addSubmenuPage(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Lists', 'mailpoet')),
esc_html__('Lists', 'mailpoet'),
AccessControl::PERMISSION_MANAGE_SEGMENTS,
'mailpoet-segments',
[
$this,
'segments',
]
);
// add limit per page to screen options
$this->wp->addAction('load-' . $segmentsPage, function() {
$this->wp->addScreenOption('per_page', [
'label' => _x(
'Number of segments per page',
'segments per page (screen options)',
'mailpoet'
),
'option' => 'mailpoet_segments_per_page',
]);
});
// Settings page
$this->wp->addSubmenuPage(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Settings', 'mailpoet')),
esc_html__('Settings', 'mailpoet'),
AccessControl::PERMISSION_MANAGE_SETTINGS,
'mailpoet-settings',
[
$this,
'settings',
]
);
// Help page
$this->wp->addSubmenuPage(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Help', 'mailpoet')),
esc_html__('Help', 'mailpoet'),
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
'mailpoet-help',
[
$this,
'help',
]
);
// Upgrade page
// Only show this page in menu if the Premium plugin is not activated
$this->wp->addSubmenuPage(
License::getLicense() ? true : self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Upgrade', 'mailpoet')),
esc_html__('Upgrade', 'mailpoet'),
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
'mailpoet-upgrade',
[
$this,
'upgrade',
]
);
// Welcome wizard page
$this->wp->addSubmenuPage(
true,
$this->setPageTitle(__('Welcome Wizard', 'mailpoet')),
esc_html__('Welcome Wizard', 'mailpoet'),
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
'mailpoet-welcome-wizard',
[
$this,
'welcomeWizard',
]
);
// WooCommerce Setup
$this->wp->addSubmenuPage(
true,
$this->setPageTitle(__('WooCommerce Setup', 'mailpoet')),
esc_html__('WooCommerce Setup', 'mailpoet'),
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
'mailpoet-woocommerce-setup',
[
$this,
'wooCommerceSetup',
]
);
// Experimental page
$this->wp->addSubmenuPage(
true,
$this->setPageTitle(__('Experimental Features', 'mailpoet')),
'',
AccessControl::PERMISSION_MANAGE_FEATURES,
'mailpoet-experimental',
[$this, 'experimentalFeatures']
);
// display loggs page
$this->wp->addSubmenuPage(
true,
$this->setPageTitle(__('Logs', 'mailpoet')),
'',
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
'mailpoet-logs',
[$this, 'logs']
);
}
private function registerAutomationMenu() {
if (!$this->featuresController->isSupported(FeaturesController::AUTOMATION)) {
return;
}
$this->wp->addSubmenuPage(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Automations', 'mailpoet')),
// @ToDo Remove Beta once Automation is no longer beta.
'<span>' . esc_html__('Automations', 'mailpoet') . '</span><span class="mailpoet-beta-badge">Beta</span>',
AccessControl::PERMISSION_MANAGE_EMAILS,
'mailpoet-automation',
[$this, 'automation']
);
// Automation editor
$automationEditorPage = $this->wp->addSubmenuPage(
true,
$this->setPageTitle(__('Automation Editor', 'mailpoet')),
esc_html__('Automation Editor', 'mailpoet'),
AccessControl::PERMISSION_MANAGE_AUTOMATIONS,
'mailpoet-automation-editor',
[$this, 'automationEditor']
);
// Automation templates
$this->wp->addSubmenuPage(
true,
$this->setPageTitle(__('Automation Templates', 'mailpoet')),
esc_html__('Automation Templates', 'mailpoet'),
AccessControl::PERMISSION_MANAGE_AUTOMATIONS,
'mailpoet-automation-templates',
[$this, 'automationTemplates']
);
// add body class for automation editor page
$this->wp->addAction('load-' . $automationEditorPage, function() {
$this->wp->addFilter('admin_body_class', function ($classes) {
return ltrim($classes . ' site-editor-php');
});
});
}
public function disableWPEmojis() {
$this->wp->removeAction('admin_print_scripts', 'print_emoji_detection_script');
$this->wp->removeAction('admin_print_styles', 'print_emoji_styles');
}
public function welcomeWizard() {
$this->container->get(WelcomeWizard::class)->render();
}
public function wooCommerceSetup() {
$this->container->get(WooCommerceSetup::class)->render();
}
public function upgrade() {
$this->container->get(Upgrade::class)->render();
}
public function settings() {
$this->container->get(Settings::class)->render();
}
public function help() {
$this->container->get(Help::class)->render();
}
public function automation() {
$this->container->get(Automation::class)->render();
}
public function automationTemplates() {
$this->container->get(AutomationTemplates::class)->render();
}
public function automationEditor() {
$this->container->get(AutomationEditor::class)->render();
}
public function experimentalFeatures() {
$this->container->get(ExperimentalFeatures::class)->render();
}
public function logs() {
$this->container->get(Logs::class)->render();
}
public function subscribers() {
$this->container->get(Subscribers::class)->render();
}
public function segments() {
$this->container->get(Segments::class)->render();
}
public function forms() {
$this->container->get(Forms::class)->render();
}
public function newsletters() {
$this->container->get(Newsletters::class)->render();
}
public function newletterEditor() {
$this->container->get(NewsletterEditor::class)->render();
}
public function import() {
$this->container->get(SubscribersImport::class)->render();
}
public function export() {
$this->container->get(SubscribersExport::class)->render();
}
public function formEditor() {
$this->container->get(FormEditor::class)->render();
}
public function formEditorTemplateSelection() {
$this->container->get(FormEditor::class)->renderTemplateSelection();
}
public function setPageTitle($title) {
return sprintf(
'%s - %s',
__('MailPoet', 'mailpoet'),
$title
);
}
public static function isOnMailPoetAdminPage(array $exclude = null, $screenId = null) {
if (is_null($screenId)) {
if (empty($_REQUEST['page'])) {
return false;
}
$screenId = sanitize_text_field(wp_unslash($_REQUEST['page']));
}
if (!empty($exclude)) {
foreach ($exclude as $slug) {
if (stripos($screenId, $slug) !== false) {
return false;
}
}
}
return (stripos($screenId, 'mailpoet-') !== false);
}
/**
* This error page is used when the initialization is failed
* to display admin notices only
*/
public static function addErrorPage(AccessControl $accessControl) {
if (!self::isOnMailPoetAdminPage() || !isset($_REQUEST['page'])) {
return false;
}
$page = sanitize_text_field(wp_unslash($_REQUEST['page']));
// Check if page already exists
if (
get_plugin_page_hook($page, '')
|| WPFunctions::get()->getPluginPageHook($page, self::MAIN_PAGE_SLUG)
) {
return false;
}
WPFunctions::get()->addSubmenuPage(
true,
'MailPoet',
'MailPoet',
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
$page,
[
__CLASS__,
'errorPageCallback',
]
);
}
public static function errorPageCallback() {
// Used for displaying admin notices only
}
public function checkPremiumKey(ServicesChecker $checker = null) {
$showNotices = isset($_SERVER['SCRIPT_NAME'])
&& stripos(sanitize_text_field(wp_unslash($_SERVER['SCRIPT_NAME'])), 'plugins.php') !== false;
$checker = $checker ?: $this->servicesChecker;
$this->premiumKeyValid = $checker->isPremiumKeyValid($showNotices);
}
}