Validator.php — Advanced Access Manager – Access Governance for WordPress 5.11

advanced-access-manager / application / Core / Policy / Validator.php

advanced-access-manager / application / Core / Policy Last commit date

Condition.php 6 years ago Factory.php 6 years ago Manager.php 6 years ago Token.php 6 years ago Validator.php 6 years ago

Validator.php

181 lines

1	<?php
2
3	/**
4	* ======================================================================
5	* LICENSE: This file is subject to the terms and conditions defined in *
6	* file 'license.txt', which is part of this source code package. *
7	* ======================================================================
8	*/
9
10	use Composer\Semver\Semver;
11
12	/**
13	* AAM core policy validator
14	*
15	* @package AAM
16	* @author Vasyl Martyniuk <vasyl@vasyltech.com>
17	* @since AAM v5.7.3
18	*/
19	class AAM_Core_Policy_Validator {
20
21	/**
22	* Raw policy text
23	*
24	* @var string
25	*
26	* @access protected
27	*/
28	protected $policy;
29
30	/**
31	* Parsed JSON document
32	*
33	* @var array
34	*
35	* @access protected
36	*/
37	protected $json;
38
39	/**
40	* Collection of errors
41	*
42	* @var array
43	*
44	* @access protected
45	*/
46	protected $errors = array();
47
48	/**
49	* Constructor
50	*
51	* @param string $policy
52	*
53	* @access public
54	*/
55	public function __construct($policy) {
56	$this->policy = trim($policy);
57	$this->json = json_decode($policy, true);
58	}
59
60	/**
61	* Validate the policy
62	*
63	* @return array
64	*
65	* @access public
66	*/
67	public function validate() {
68	$steps = array(
69	'isJSON', // #1. Check if policy is valid JSON
70	'isNotEmpty', // #2. Check if policy is not empty
71	'isValidDependency', // #3. Check if all dependencies are defined properly
72	);
73
74	foreach($steps as $step) {
75	if (call_user_func(array($this, $step)) === false) {
76	break;
77	}
78	}
79
80	return $this->errors;
81	}
82
83	/**
84	* Check if policy is valid JSON
85	*
86	* @return boolean
87	*
88	* @access public
89	*/
90	public function isJSON() {
91	$result = is_array($this->json);
92
93	if ($result === false) {
94	$this->errors[] = __('The policy is not valid JSON object', AAM_KEY);
95	}
96
97	return $result;
98	}
99
100	/**
101	* Check if policy is empty
102	*
103	* @return boolean
104	*
105	* @access public
106	*/
107	public function isNotEmpty() {
108	$result = !empty($this->policy) && !empty($this->json);
109
110	if ($result === false) {
111	$this->errors[] = __('The policy document is empty', AAM_KEY);
112	}
113
114	return $result;
115	}
116
117	public function isValidDependency() {
118	if (!empty($this->json['Dependency'])) {
119	foreach($this->json['Dependency'] as $app => $constraints) {
120	try {
121	$satisfies = Semver::satisfies(
122	$this->getAppVersion(strtolower($app)), $constraints
123	);
124	if ($satisfies === false) {
125	throw new Exception(
126	AAM_Backend_View_Helper::preparePhrase(
127	"The dependency [{$app}] does not satisfy version requirement by the policy",
128	'b'
129	)
130	);
131	}
132	} catch (Exception $e) {
133	$this->errors[] = $e->getMessage();
134	}
135	}
136	}
137	}
138
139	protected function getAppVersion($app) {
140	global $wp_version;
141
142	if ($app === 'wordpress') {
143	$version = $wp_version;
144	} else {
145	$version = $this->getPluginVersion($app);
146	}
147
148	return $version;
149	}
150
151	protected function getPluginVersion($slug) {
152	static $plugins = null;
153
154	if (is_null($plugins)) {
155	if (file_exists(ABSPATH . 'wp-admin/includes/plugin.php')) {
156	require_once ABSPATH . 'wp-admin/includes/plugin.php';
157	}
158
159	$plugins = get_plugins();
160	}
161
162	$version = null;
163
164	foreach($plugins as $plugin => $data) {
165	if (stripos($plugin, $slug . '/') === 0) {
166	$version = $data['Version'];
167	}
168	}
169
170	if (is_null($version)) {
171	throw new Exception(
172	AAM_Backend_View_Helper::preparePhrase(
173	"The plugin [{$slug}] is required by the policy",
174	'b'
175	)
176	);
177	}
178
179	return $version;
180	}
181	}