Admin
1 week ago
Commands
2 years ago
Db
3 weeks ago
Ecommerce
1 week ago
Report
1 week ago
Site
1 week ago
TrackingCode
1 week ago
Updater
4 years ago
User
1 week ago
Workarounds
2 years ago
WpStatistics
1 week ago
views
1 week ago
AIBotTracking.php
1 week ago
API.php
3 weeks ago
Access.php
1 week ago
AjaxTracker.php
5 months ago
Annotations.php
1 week ago
Bootstrap.php
11 months ago
Capabilities.php
1 week ago
Compatibility.php
1 week ago
Email.php
1 week ago
ErrorNotice.php
1 week ago
Feature.php
3 months ago
Installer.php
1 week ago
Logger.php
1 year ago
MinimumRequirementsNotice.php
1 month ago
OptOut.php
2 months ago
Paths.php
1 week ago
PluginActionLinks.php
3 months ago
PluginAdminOverrides.php
1 week ago
PluginInit.php
1 week ago
PrivacyBadge.php
4 years ago
RedirectOnActivation.php
3 months ago
Referral.php
3 months ago
Roles.php
3 months ago
ScheduledTasks.php
1 week ago
Settings.php
1 week ago
Site.php
3 years ago
TrackingCode.php
1 week ago
Uninstaller.php
6 months ago
Updater.php
1 week ago
User.php
3 weeks ago
Roles.php
149 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Matomo - free/libre analytics platform |
| 4 | * |
| 5 | * @link https://matomo.org |
| 6 | * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 7 | * @package matomo |
| 8 | */ |
| 9 | |
| 10 | namespace WpMatomo; |
| 11 | |
| 12 | if ( ! defined( 'ABSPATH' ) ) { |
| 13 | exit; // if accessed directly |
| 14 | } |
| 15 | |
| 16 | class Roles extends Feature { |
| 17 | const OPTION_SETUP_NAME = 'roles-setup'; |
| 18 | const ROLE_PREFIX = 'matomo_'; |
| 19 | const ROLE_VIEW = 'matomo_view_role'; |
| 20 | const ROLE_WRITE = 'matomo_write_role'; |
| 21 | const ROLE_ADMIN = 'matomo_admin_role'; |
| 22 | const ROLE_SUPERUSER = 'matomo_superuser_role'; |
| 23 | |
| 24 | /** |
| 25 | * @var Settings |
| 26 | */ |
| 27 | private $settings; |
| 28 | |
| 29 | public function __construct( $settings ) { |
| 30 | $this->settings = $settings; |
| 31 | } |
| 32 | |
| 33 | public function register_hooks() { |
| 34 | add_action( 'init', [ $this, 'add_roles' ] ); |
| 35 | add_action( 'matomo_update', [ $this, 'on_update' ] ); |
| 36 | } |
| 37 | |
| 38 | /** |
| 39 | * Adds role capabilities to Matomo roles in case they changed |
| 40 | * between Matomo for WordPress versions. |
| 41 | * |
| 42 | * Note: at the moment we don't remove capabilities that shouldn't |
| 43 | * be there, in case a user has used another WP plugin to customize them. |
| 44 | * |
| 45 | * @return void |
| 46 | */ |
| 47 | public function on_update() { |
| 48 | if ( ! $this->has_set_up_roles() ) { |
| 49 | $this->add_roles(); |
| 50 | return; |
| 51 | } |
| 52 | |
| 53 | $roles = $this->get_matomo_roles(); |
| 54 | foreach ( $roles as $role_name => $config ) { |
| 55 | foreach ( $config['capabilities'] as $capability => $ignore ) { |
| 56 | wp_roles()->add_cap( $role_name, $capability ); |
| 57 | } |
| 58 | } |
| 59 | } |
| 60 | |
| 61 | public function get_available_roles_for_configuration() { |
| 62 | global $wp_roles; |
| 63 | $is_network_enabled = $this->settings->is_network_enabled(); |
| 64 | $roles = []; |
| 65 | |
| 66 | foreach ( $wp_roles->role_names as $role_name => $name ) { |
| 67 | if ( ! $is_network_enabled && 'administrator' === $role_name ) { |
| 68 | // when multi site, then we consider "administrator" just a regular role and not a super user |
| 69 | // when not multi site, administrator is automatically the super user |
| 70 | continue; |
| 71 | } |
| 72 | |
| 73 | if ( $this->is_matomo_role( $role_name ) ) { |
| 74 | // a matomo capability which we don't want to change |
| 75 | continue; |
| 76 | } |
| 77 | |
| 78 | $roles[ $role_name ] = $name; |
| 79 | } |
| 80 | |
| 81 | return $roles; |
| 82 | } |
| 83 | |
| 84 | public function is_matomo_role( $role_name ) { |
| 85 | return strpos( $role_name, self::ROLE_PREFIX ) === 0; |
| 86 | } |
| 87 | |
| 88 | public function get_matomo_roles() { |
| 89 | return [ |
| 90 | self::ROLE_VIEW => [ |
| 91 | 'name' => 'Matomo View', |
| 92 | 'capabilities' => [ |
| 93 | Capabilities::KEY_VIEW => true, |
| 94 | 'read' => true, |
| 95 | 'view_admin_dashboard' => true, |
| 96 | ], |
| 97 | ], |
| 98 | self::ROLE_WRITE => [ |
| 99 | 'name' => 'Matomo Write', |
| 100 | 'capabilities' => [ |
| 101 | Capabilities::KEY_WRITE => true, |
| 102 | 'read' => true, |
| 103 | 'view_admin_dashboard' => true, |
| 104 | ], |
| 105 | ], |
| 106 | self::ROLE_ADMIN => [ |
| 107 | 'name' => 'Matomo Admin', |
| 108 | 'capabilities' => [ |
| 109 | Capabilities::KEY_ADMIN => true, |
| 110 | 'read' => true, |
| 111 | 'view_admin_dashboard' => true, |
| 112 | ], |
| 113 | ], |
| 114 | self::ROLE_SUPERUSER => [ |
| 115 | 'name' => 'Matomo Super User', |
| 116 | 'capabilities' => [ |
| 117 | Capabilities::KEY_SUPERUSER => true, |
| 118 | 'read' => true, |
| 119 | 'view_admin_dashboard' => true, |
| 120 | ], |
| 121 | ], |
| 122 | ]; |
| 123 | } |
| 124 | |
| 125 | public function add_roles( $force = false ) { |
| 126 | if ( ! $this->has_set_up_roles() || $force ) { |
| 127 | foreach ( $this->get_matomo_roles() as $role_name => $config ) { |
| 128 | add_role( $role_name, $config['name'], $config['capabilities'] ); |
| 129 | } |
| 130 | $this->mark_roles_set_up(); |
| 131 | } |
| 132 | } |
| 133 | |
| 134 | private function mark_roles_set_up() { |
| 135 | update_option( Settings::OPTION_PREFIX . self::OPTION_SETUP_NAME, 1, 1 ); |
| 136 | } |
| 137 | |
| 138 | private function has_set_up_roles() { |
| 139 | return (bool) get_option( Settings::OPTION_PREFIX . self::OPTION_SETUP_NAME ); |
| 140 | } |
| 141 | |
| 142 | public function uninstall() { |
| 143 | foreach ( $this->get_matomo_roles() as $role_name => $role ) { |
| 144 | remove_role( $role_name ); |
| 145 | } |
| 146 | Uninstaller::uninstall_options( Settings::OPTION_PREFIX . self::OPTION_SETUP_NAME ); |
| 147 | } |
| 148 | } |
| 149 |