Token.php — Advanced Access Manager – Access Governance for WordPress 5.9

advanced-access-manager / Application / Core / Policy / Token.php

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

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

Token.php

157 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	/**
11	* AAM core policy token evaluator
12	*
13	* @package AAM
14	* @author Vasyl Martyniuk <vasyl@vasyltech.com>
15	* @since AAM v5.8.2
16	*/
17	final class AAM_Core_Policy_Token {
18
19	/**
20	* Literal map token's type to the executable method that returns actual value
21	*
22	* @var array
23	*
24	* @access protected
25	* @static
26	*/
27	protected static $map = array(
28	'USER' => 'AAM_Core_Policy_Token::getUserValue',
29	'DATETIME' => 'AAM_Core_Policy_Token::getDateTimeValue',
30	'GET' => 'AAM_Core_Request::get',
31	'POST' => 'AAM_Core_Request::post',
32	'COOKIE' => 'AAM_Core_Request::cookie',
33	'SERVER' => 'AAM_Core_Request::server',
34	'ARGS' => 'AAM_Core_Policy_Token::getArgValue'
35	);
36
37	/**
38	* Evaluate collection of tokens and replace them with values
39	*
40	* @param string $part String with tokens
41	* @param array $tokens Extracted token
42	*
43	* @return string
44	*
45	* @access public
46	* @static
47	*/
48	public static function evaluate($part, array $tokens, array $args = array()) {
49	foreach($tokens as $token) {
50	$val = self::getValue(
51	preg_replace('/^\$\{([^}]+)\}$/', '${1}', $token),
52	$args
53	);
54
55	$part = str_replace(
56	$token,
57	(is_scalar($val) ? $val : json_encode($val)),
58	$part
59	);
60	}
61
62	return $part;
63	}
64
65	/**
66	* Get token value
67	*
68	* @param string $token
69	* @param array $args
70	*
71	* @return mixed
72	*
73	* @access protected
74	* @static
75	*/
76	protected static function getValue($token, $args) {
77	$parts = explode('.', $token);
78
79	if (isset(self::$map[$parts[0]])) {
80	$value = call_user_func(self::$map[$parts[0]], $parts[1], $args);
81	} elseif ($parts[0] === 'CALLBACK' && is_callable($parts[1])) {
82	$value = call_user_func($parts[1], $args);
83	}
84
85	return $value;
86	}
87
88	/**
89	* Get USER's value
90	*
91	* @param string $prop
92	*
93	* @return mixed
94	*
95	* @access protected
96	* @static
97	*/
98	protected static function getUserValue($prop) {
99	$user = AAM::api()->getUser();
100
101	switch(strtolower($prop)) {
102	case 'ip':
103	case 'ipaddress':
104	$value = AAM_Core_Request::server('REMOTE_ADDR');
105	break;
106
107	case 'authenticated':
108	$value = $user->isVisitor() ? false : true;
109	break;
110
111	case 'capabilities':
112	$value = array();
113	foreach($user->allcaps as $cap => $effect) {
114	if (!empty($effect)) {
115	$value[] = $cap;
116	}
117	}
118	break;
119
120	default:
121	$value = $user->{$prop};
122	break;
123	}
124
125	return $value;
126	}
127
128	/**
129	* Get inline argument
130	*
131	* @param string $prop
132	* @param array $args
133	*
134	* @return mixed
135	*
136	* @access protected
137	* @static
138	*/
139	protected static function getArgValue($prop, $args) {
140	return (isset($args[$prop]) ? $args[$prop] : null);
141	}
142
143	/**
144	* Get current datetime value
145	*
146	* @param string $prop
147	*
148	* @return string
149	*
150	* @access protected
151	* @static
152	*/
153	protected static function getDateTimeValue($prop) {
154	return date($prop);
155	}
156
157	}