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

Manage MP3 permissions with WP role capabilities, add Members plugin support [MAILPOET-493]

Browse Source
This commit is contained in:
stoletniy
2017-09-21 14:38:16 +03:00
committed by pavel-mailpoet
parent 9f5fc151b4
commit a4f2d5402c
13 changed files with 283 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
RoboFile.php
View File

@ -90,6 +90,7 @@ class RoboFile extends \Robo\Tasks {
$css_files = array(
'assets/css/src/admin.styl',
'assets/css/src/admin-global.styl',
'assets/css/src/newsletter_editor/newsletter_editor.styl',
'assets/css/src/public.styl',
'assets/css/src/rtl.styl',

15
assets/css/src/admin-global.styl Normal file
View File

@ -0,0 +1,15 @@
@import 'nib'
@require 'icons'
/*
Style for Members plugin
*/
.members-tab-title
.mailpoet-icon-logo
vertical-align: middle;
height: 20px;
width: 20px;
font-size: 20px;
margin-right: 3px;

24
assets/css/src/icons.styl Normal file
View File

@ -0,0 +1,24 @@
icon-font-path ?= "../fonts"
@font-face
font-family 'mailpoet'
src url(icon-font-path + '/mailpoet.ttf?mx0b6n') format('truetype'), url(icon-font-path + '/mailpoet.woff?mx0b6n') format('woff'), url(icon-font-path + '/mailpoet.svg?mx0b6n#mailpoet') format('svg')
font-weight normal
font-style normal
[class^="mailpoet-icon-"], [class*=" mailpoet-icon-"]
font-family 'mailpoet' !important
speak none
font-style normal
font-weight normal
font-variant normal
text-transform none
line-height 1
/* Better Font Rendering =========== */
-webkit-font-smoothing antialiased
-moz-osx-font-smoothing grayscale
.mailpoet-icon-logo
&:before
content "\e900"

11
assets/fonts/mailpoet.svg Normal file
View File

@ -0,0 +1,11 @@
<?xml version="1.0" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" >
<svg xmlns="http://www.w3.org/2000/svg">
<metadata>Generated by IcoMoon</metadata>
<defs>
<font id="mailpoet" horiz-adv-x="1024">
<font-face units-per-em="1024" ascent="960" descent="-64" />
<missing-glyph horiz-adv-x="1024" />
<glyph unicode="&#x20;" horiz-adv-x="0" d="" />
<glyph unicode="&#xe900;" glyph-name="optimised" horiz-adv-x="972" d="M230.188 949.695c-21.982-3.361-41.376-14.741-48.618-28.188l-5.948-11.637 0.517-265.588c0.776-263.779 0.776-265.847 6.206-273.088 11.12-15.258 40.601-22.24 68.79-16.551 16.551 3.621 25.861 9.827 32.584 21.723 3.879 7.499 4.397 23.791 5.689 185.161l1.293 176.628 60.514-161.111c33.102-88.702 63.875-168.612 68.013-177.404 13.707-29.481 35.687-41.376 72.151-39.049 21.206 1.293 39.308 9.827 47.584 22.499 3.361 5.172 35.947 91.806 72.41 192.662s67.237 185.42 68.53 187.49c1.551 2.587 2.587-69.307 2.587-185.937v-190.335l5.948-11.379c8.533-16.809 20.172-21.982 49.652-21.982 27.929 0.259 39.825 4.914 49.911 20.172l6.982 10.603v530.401l-5.689 9.31c-12.671 20.43-50.17 31.033-91.806 25.601-34.394-4.138-53.79-16.292-66.72-41.118-2.587-5.172-35.947-101.89-73.961-214.902s-69.824-206.367-70.6-207.403c-1.034-1.034-32.326 86.115-69.824 193.954-37.757 107.581-71.892 205.075-76.030 216.453-10.086 26.118-25.601 42.929-45.514 48.877-17.326 5.172-46.807 6.982-64.652 4.138zM54.854 243.443c-20.172-3.879-43.963-19.136-51.204-33.619-6.206-11.379-4.914-32.843 2.587-47.841 23.533-46.807 71.634-86.892 126.717-104.736 17.068-5.689 23.274-5.948 120.252-7.499 97.235-1.551 102.926-1.81 116.373-7.241 29.739-11.896 51.204-35.687 61.807-68.013 3.621-11.12 13.964-21.206 25.861-25.344 4.914-1.551 18.361-2.844 29.739-2.844 16.809 0 23.533 1.293 32.584 5.689 11.896 6.206 13.964 9.31 26.895 38.791 11.896 27.671 39.567 49.652 70.858 56.117 8.533 1.81 47.067 2.844 100.856 2.844 99.563 0 113.786 2.068 151.801 20.689 49.652 24.567 96.978 77.84 101.373 113.529 3.104 26.118-17.326 49.394-51.204 58.187-25.601 6.465-41.635-0.517-54.825-24.050-11.12-19.655-29.998-38.015-47.841-46.29l-14.741-6.982-99.563-1.551c-90.77-1.293-101.373-2.068-120.252-6.982-27.154-7.499-58.444-23.016-80.427-40.084l-17.844-13.964-16.809 13.964c-20.689 16.809-51.462 32.584-78.875 39.825-19.136 5.172-28.705 5.948-120.252 7.241l-99.563 1.551-15.775 7.241c-18.102 8.533-32.584 21.982-48.36 45.773-16.034 24.567-26.895 29.998-50.17 25.601z" />
</font></defs></svg>
Side by Side

After

Width:  |  Height:  |  Size: 2.4 KiB

BIN
assets/fonts/mailpoet.ttf Normal file
View File

Binary file not shown.

BIN
assets/fonts/mailpoet.woff Normal file
View File

Binary file not shown.

48
lib/Config/AccessControl.php
View File

@ -8,26 +8,26 @@ if(!defined('ABSPATH')) exit;
require_once(ABSPATH . 'wp-includes/pluggable.php');
class AccessControl {
const PERMISSION_ACCESS_PLUGIN_ADMIN = 'access_plugin_admin';
const PERMISSION_MANAGE_SETTINGS = 'manage_settings';
const PERMISSION_MANAGE_EMAILS = 'manage_emails';
const PERMISSION_MANAGE_SUBSCRIBERS = 'manage_subscribers';
const PERMISSION_MANAGE_FORMS = 'manage_forms';
const PERMISSION_MANAGE_SEGMENTS = 'manage_segments';
const PERMISSION_UPDATE_PLUGIN = 'update_plugin';
const NO_ACCESS_RESTRICTION = 'no_access_restriction';
const PERMISSION_ACCESS_PLUGIN_ADMIN = 'mailpoet_access_plugin_admin';
const PERMISSION_MANAGE_SETTINGS = 'mailpoet_manage_settings';
const PERMISSION_MANAGE_EMAILS = 'mailpoet_manage_emails';
const PERMISSION_MANAGE_SUBSCRIBERS = 'mailpoet_manage_subscribers';
const PERMISSION_MANAGE_FORMS = 'mailpoet_manage_forms';
const PERMISSION_MANAGE_SEGMENTS = 'mailpoet_manage_segments';
const PERMISSION_UPDATE_PLUGIN = 'mailpoet_update_plugin';
const NO_ACCESS_RESTRICTION = 'mailpoet_no_access_restriction';
public $permissions;
public $current_user_roles;
public $user_roles;
public $user_capabilities;
function __construct() {
$this->permissions = $this->getDefaultPermissions();
$this->permissions = self::getDefaultPermissions();
$this->user_roles = $this->getUserRoles();
$this->user_capabilities = $this->getUserCapabilities();
}
private function getDefaultPermissions() {
static function getDefaultPermissions() {
return array(
self::PERMISSION_ACCESS_PLUGIN_ADMIN => WPHooks::applyFilters(
'mailpoet_permission_access_plugin_admin',
@ -76,6 +76,18 @@ class AccessControl {
);
}
static function getPermissionLabels() {
return array(
self::PERMISSION_ACCESS_PLUGIN_ADMIN => __('Access plugin admin', 'mailpoet'),
self::PERMISSION_MANAGE_SETTINGS => __('Manage settings', 'mailpoet'),
self::PERMISSION_MANAGE_EMAILS => __('Manage emails', 'mailpoet'),
self::PERMISSION_MANAGE_SUBSCRIBERS => __('Manage subscribers', 'mailpoet'),
self::PERMISSION_MANAGE_FORMS => __('Manage forms', 'mailpoet'),
self::PERMISSION_MANAGE_SEGMENTS => __('Manage segments', 'mailpoet'),
self::PERMISSION_UPDATE_PLUGIN => __('Update plugin', 'mailpoet'),
);
}
function getUserRoles() {
$user = wp_get_current_user();
return $user->roles;
@ -94,11 +106,13 @@ class AccessControl {
function validatePermission($permission) {
if($permission === self::NO_ACCESS_RESTRICTION) return true;
if(empty($this->permissions[$permission])) return false;
$permitted_roles = array_intersect(
$this->user_roles,
$this->permissions[$permission]
);
return (!empty($permitted_roles));
foreach($this->user_roles as $role) {
if($role_object = get_role($role)) {
if($role_object->has_cap($permission)) {
return true;
}
}
}
return false;
}
}

6
lib/Config/Activator.php
View File

@ -14,10 +14,16 @@ class Activator {
$populator = new Populator();
$populator->up();
Setting::setValue('db_version', Env::$version);
$caps = new Capabilities();
$caps->setupWPCapabilities();
}
function deactivate() {
$migrator = new Migrator();
$migrator->down();
$caps = new Capabilities();
$caps->removeWPCapabilities();
}
}

70
lib/Config/Capabilities.php Normal file
View File

@ -0,0 +1,70 @@
<?php
namespace MailPoet\Config;
use MailPoet\WP\Hooks;
class Capabilities {
const MEMBERS_CAP_GROUP_NAME = 'mailpoet';
function init() {
$this->setupMembersCapabilities();
}
function setupWPCapabilities() {
$permissions = AccessControl::getDefaultPermissions();
$role_objects = array();
foreach($permissions as $name => $roles) {
foreach($roles as $role) {
if(!isset($role_objects[$role])) {
$role_objects[$role] = get_role($role);
}
$role_objects[$role]->add_cap($name);
}
}
}
function removeWPCapabilities() {
$permissions = AccessControl::getDefaultPermissions();
$role_objects = array();
foreach($permissions as $name => $roles) {
foreach($roles as $role) {
if(!isset($role_objects[$role])) {
$role_objects[$role] = get_role($role);
}
$role_objects[$role]->remove_cap($name);
}
}
}
function setupMembersCapabilities() {
wp_enqueue_style('mailpoet-admin-global', Env::$assets_url . '/css/admin-global.css');
Hooks::addAction('members_register_cap_groups', array($this, 'registerMembersCapGroup'));
Hooks::addAction('members_register_caps', array($this, 'registerMembersCapabilities'));
}
function registerMembersCapGroup() {
members_register_cap_group(
self::MEMBERS_CAP_GROUP_NAME,
array(
'label' => __('MailPoet', 'mailpoet'),
'caps' => array(),
'icon' => 'mailpoet-icon-logo',
'priority' => 30
)
);
}
function registerMembersCapabilities() {
$permissions = AccessControl::getPermissionLabels();
foreach($permissions as $name => $label) {
members_register_cap(
$name,
array(
'label' => $label,
'group' => self::MEMBERS_CAP_GROUP_NAME
)
);
}
}
}

6
lib/Config/Initializer.php
View File

@ -125,6 +125,7 @@ class Initializer {
$this->setupUpdater();
$this->setupLocalizer();
$this->setupCapabilities();
$this->setupMenu();
$this->setupShortcodes();
$this->setupImages();
@ -189,6 +190,11 @@ class Initializer {
$localizer->init();
}
function setupCapabilities() {
$caps = new Capabilities();
$caps->init();
}
function setupMenu() {
$menu = new Menu($this->renderer, Env::$assets_url, $this->access_control);
$menu->init();

43
lib/Config/Menu.php
View File

@ -37,7 +37,6 @@ class Menu {
$this->renderer = $renderer;
$this->assets_url = $assets_url;
$this->access_control = $access_control;
$this->user_capability = $this->access_control->getUserFirstCapability();
$subscribers_feature = new SubscribersFeature();
$this->subscribers_over_limit = $subscribers_feature->check();
$this->checkMailPoetAPIKey();
@ -70,7 +69,7 @@ class Menu {
add_menu_page(
'MailPoet',
'MailPoet',
$this->user_capability,
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
self::MAIN_PAGE_SLUG,
null,
$this->assets_url . '/img/menu_icon.png',
@ -78,12 +77,11 @@ class Menu {
);
// Emails page
if($this->access_control->validatePermission(AccessControl::PERMISSION_MANAGE_EMAILS)) {
$newsletters_page = add_submenu_page(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Emails', 'mailpoet')),
__('Emails', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_MANAGE_EMAILS,
self::MAIN_PAGE_SLUG,
array(
$this,
@ -108,22 +106,20 @@ class Menu {
true,
$this->setPageTitle(__('Newsletter', 'mailpoet')),
__('Newsletter Editor', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_MANAGE_EMAILS,
'mailpoet-newsletter-editor',
array(
$this,
'newletterEditor'
)
);
}
// Forms page
if($this->access_control->validatePermission(AccessControl::PERMISSION_MANAGE_FORMS)) {
$forms_page = add_submenu_page(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Forms', 'mailpoet')),
__('Forms', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_MANAGE_FORMS,
'mailpoet-forms',
array(
$this,
@ -148,22 +144,20 @@ class Menu {
true,
$this->setPageTitle(__('Form Editor', 'mailpoet')),
__('Form Editor', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_MANAGE_FORMS,
'mailpoet-form-editor',
array(
$this,
'formEditor'
)
);
}
// Subscribers page
if($this->access_control->validatePermission(AccessControl::PERMISSION_MANAGE_SUBSCRIBERS)) {
$subscribers_page = add_submenu_page(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Subscribers', 'mailpoet')),
__('Subscribers', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_MANAGE_SUBSCRIBERS,
'mailpoet-subscribers',
array(
$this,
@ -188,7 +182,7 @@ class Menu {
'admin.php?page=mailpoet-subscribers',
$this->setPageTitle(__('Import', 'mailpoet')),
__('Import', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_MANAGE_SUBSCRIBERS,
'mailpoet-import',
array(
$this,
@ -201,22 +195,20 @@ class Menu {
true,
$this->setPageTitle(__('Export', 'mailpoet')),
__('Export', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_MANAGE_SUBSCRIBERS,
'mailpoet-export',
array(
$this,
'export'
)
);
}
// Segments page
if($this->access_control->validatePermission(AccessControl::PERMISSION_MANAGE_SEGMENTS)) {
$segments_page = add_submenu_page(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Lists', 'mailpoet')),
__('Lists', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_MANAGE_SEGMENTS,
'mailpoet-segments',
array(
$this,
@ -235,29 +227,26 @@ class Menu {
'option' => 'mailpoet_segments_per_page'
));
});
}
// Settings page
if($this->access_control->validatePermission(AccessControl::PERMISSION_MANAGE_SETTINGS)) {
add_submenu_page(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Settings', 'mailpoet')),
__('Settings', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_MANAGE_SETTINGS,
'mailpoet-settings',
array(
$this,
'settings'
)
);
}
// Help page
add_submenu_page(
self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Help', 'mailpoet')),
__('Help', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
'mailpoet-help',
array(
$this,
@ -271,7 +260,7 @@ class Menu {
License::getLicense() ? true : self::MAIN_PAGE_SLUG,
$this->setPageTitle(__('Premium', 'mailpoet')),
__('Premium', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
'mailpoet-premium',
array(
$this,
@ -284,7 +273,7 @@ class Menu {
true,
$this->setPageTitle(__('Welcome', 'mailpoet')),
__('Welcome', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
'mailpoet-welcome',
array(
$this,
@ -297,7 +286,7 @@ class Menu {
true,
$this->setPageTitle(__('Update', 'mailpoet')),
__('Update', 'mailpoet'),
$this->user_capability,
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
'mailpoet-update',
array(
$this,
@ -310,7 +299,7 @@ class Menu {
true,
$this->setPageTitle(__('Migration', 'mailpoet')),
'',
$this->user_capability,
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
'mailpoet-migration',
array(
$this,
@ -658,7 +647,7 @@ class Menu {
true,
'MailPoet',
'MailPoet',
$access_control->getUserFirstCapability(),
AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN,
$_REQUEST['page'],
array(
__CLASS__,

6
tests/unit/Config/AccessControlTest.php
View File

@ -109,6 +109,12 @@ class AccessControlTest extends \MailPoetTest {
);
}
function testItGetsPermissionLabels() {
$permissions = AccessControl::getDefaultPermissions();
$labels = AccessControl::getPermissionLabels();
expect(count($permissions))->equals(count($labels));
}
function _after() {
WPHooksHelper::releaseAllHooks();
}

96
tests/unit/Config/CapabilitiesTest.php Normal file
View File

@ -0,0 +1,96 @@
<?php
namespace MailPoet\Test\Config;
use AspectMock\Test as Mock;
use Codeception\Util\Stub;
use Helper\WordPressHooks as WPHooksHelper;
use MailPoet\Config\AccessControl;
use MailPoet\Config\Capabilities;
class CapabilitiesTest extends \MailPoetTest {
function _before() {
$this->caps = new Capabilities();
}
function testItInitializes() {
$caps = Stub::makeEmptyExcept(
$this->caps,
'init',
array('setupMembersCapabilities' => Stub::once()),
$this
);
$caps->init();
}
function testItSetsUpWPCapabilities() {
$permissions = AccessControl::getDefaultPermissions();
$this->caps->setupWPCapabilities();
$checked = false;
foreach($permissions as $name => $roles) {
foreach($roles as $role) {
$checked = true;
expect(get_role($role)->has_cap($name))->true();
}
}
expect($checked)->true();
}
function testItRemovesWPCapabilities() {
$permissions = AccessControl::getDefaultPermissions();
$this->caps->removeWPCapabilities();
$checked = false;
foreach($permissions as $name => $roles) {
foreach($roles as $role) {
$checked = true;
expect(get_role($role)->has_cap($name))->false();
}
}
expect($checked)->true();
// Restore capabilities
$this->caps->setupWPCapabilities();
}
function testItSetsUpMembersCapabilities() {
WPHooksHelper::interceptAddAction();
$this->caps->setupMembersCapabilities();
$hook_name = 'members_register_cap_groups';
expect(WPHooksHelper::isActionAdded($hook_name))->true();
expect(is_callable(WPHooksHelper::getActionAdded($hook_name)[0]))->true();
$hook_name = 'members_register_caps';
expect(WPHooksHelper::isActionAdded($hook_name))->true();
expect(is_callable(WPHooksHelper::getActionAdded($hook_name)[0]))->true();
}
function testItRegistersMembersCapGroup() {
if(function_exists('members_register_cap_group')) { // Members plugin active
$this->caps->registerMembersCapGroup();
expect_that(members_cap_group_exists(Capabilities::MEMBERS_CAP_GROUP_NAME));
} else {
$func = Mock::func('MailPoet\Config', 'members_register_cap_group', true);
$this->caps->registerMembersCapGroup();
$func->verifyInvoked([Capabilities::MEMBERS_CAP_GROUP_NAME]);
}
}
function testItRegistersMembersCapabilities() {
$permissions = AccessControl::getPermissionLabels();
$permission_count = count($permissions);
if(function_exists('members_register_cap')) { // Members plugin active
$this->caps->registerMembersCapabilities();
expect(members_get_cap_group(Capabilities::MEMBERS_CAP_GROUP_NAME)->caps)
->count($permission_count);
} else {
$func = Mock::func('MailPoet\Config', 'members_register_cap', true);
$this->caps->registerMembersCapabilities();
$func->verifyInvokedMultipleTimes($permission_count);
}
}
function _after() {
WPHooksHelper::releaseAllHooks();
Mock::clean();
}
}