1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
<?php
/**
*
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Setup\Module\Di\Code\Generator;
use Magento\Framework\App\Area;
use Magento\Framework\App\Cache\Manager;
use Magento\Framework\App\Interception\Cache\CompiledConfig;
use Magento\Framework\Interception\Config\Config as InterceptionConfig;
use Magento\Setup\Module\Di\Code\Reader\Type;
use Magento\Framework\ObjectManager\InterceptableValidator;
class InterceptionConfigurationBuilder
{
/**
* Area code list: global, frontend, etc.
*
* @var array
*/
private $areaCodesList = [];
/**
* @var InterceptionConfig
*/
private $interceptionConfig;
/**
* @var PluginList
*/
private $pluginList;
/**
* @var Type
*/
private $typeReader;
/**
* @var Manager
*/
private $cacheManager;
/**
* @var InterceptableValidator
*/
private $interceptableValidator;
/**
* @param InterceptionConfig $interceptionConfig
* @param PluginList $pluginList
* @param Type $typeReader
* @param Manager $cacheManager
* @param InterceptableValidator $interceptableValidator
*/
public function __construct(
InterceptionConfig $interceptionConfig,
PluginList $pluginList,
Type $typeReader,
Manager $cacheManager,
InterceptableValidator $interceptableValidator
) {
$this->interceptionConfig = $interceptionConfig;
$this->pluginList = $pluginList;
$this->typeReader = $typeReader;
$this->cacheManager = $cacheManager;
$this->interceptableValidator = $interceptableValidator;
}
/**
* Adds area code
*
* @param string $areaCode
* @return void
*/
public function addAreaCode($areaCode)
{
if (empty($this->areaCodesList[$areaCode])) {
$this->areaCodesList[] = $areaCode;
}
}
/**
* Builds interception configuration for all defined classes
*
* @param array $definedClasses
* @return array
*/
public function getInterceptionConfiguration($definedClasses)
{
$interceptedInstances = $this->getInterceptedClasses($definedClasses);
$inheritedConfig = $this->getPluginsList($interceptedInstances);
$mergedAreaPlugins = $this->mergeAreaPlugins($inheritedConfig);
$interceptedMethods = $this->getInterceptedMethods($mergedAreaPlugins);
return $interceptedMethods;
}
/**
* Get intercepted instances from defined class list
*
* @param array $definedClasses
* @return array
*/
private function getInterceptedClasses($definedClasses)
{
$intercepted = [];
foreach ($definedClasses as $definedClass) {
if ($this->interceptionConfig->hasPlugins($definedClass) && $this->typeReader->isConcrete($definedClass)
&& $this->interceptableValidator->validate($definedClass)
) {
$intercepted[] = $definedClass;
}
}
return $intercepted;
}
/**
* Returns plugin list:
* ['concrete class name' => ['plugin name' => [instance => 'instance name', 'order' => 'Order Number']]]
*
* @param array $interceptedInstances
* @return array
*/
private function getPluginsList($interceptedInstances)
{
$this->cacheManager->setEnabled([CompiledConfig::TYPE_IDENTIFIER], true);
$this->pluginList->setInterceptedClasses($interceptedInstances);
$inheritedConfig = [];
foreach ($this->areaCodesList as $areaKey) {
$scopePriority = [Area::AREA_GLOBAL];
$pluginListCloned = clone $this->pluginList;
if ($areaKey != Area::AREA_GLOBAL) {
$scopePriority[] = $areaKey;
$pluginListCloned->setScopePriorityScheme($scopePriority);
}
$key = implode('', $scopePriority);
$inheritedConfig[$key] = $this->filterNullInheritance($pluginListCloned->getPluginsConfig());
}
return $inheritedConfig;
}
/**
* Filters plugin inheritance list for instances without plugins, and abstract/interface
*
* @param array $pluginInheritance
* @return array
*/
private function filterNullInheritance($pluginInheritance)
{
$filteredData = [];
foreach ($pluginInheritance as $instance => $plugins) {
if ($plugins === null || !$this->typeReader->isConcrete($instance)) {
continue;
}
$pluginInstances = [];
foreach ($plugins as $plugin) {
if (in_array($plugin['instance'], $pluginInstances)) {
continue;
}
$pluginInstances[] = $plugin['instance'];
}
$filteredData[$instance] = $pluginInstances;
}
return $filteredData;
}
/**
* Merge plugins in areas
*
* @param array $inheritedConfig
* @return array
*/
private function mergeAreaPlugins($inheritedConfig)
{
$mergedConfig = [];
foreach ($inheritedConfig as $configuration) {
$mergedConfig = array_merge_recursive($mergedConfig, $configuration);
}
foreach ($mergedConfig as &$plugins) {
$plugins = array_unique($plugins);
}
return $mergedConfig;
}
/**
* Returns interception configuration with plugin methods
*
* @param array $interceptionConfiguration
* @return array
*/
private function getInterceptedMethods($interceptionConfiguration)
{
$pluginDefinitionList = new \Magento\Framework\Interception\Definition\Runtime();
foreach ($interceptionConfiguration as &$plugins) {
$pluginsMethods = [];
foreach ($plugins as $plugin) {
$pluginsMethods = array_unique(
array_merge($pluginsMethods, array_keys($pluginDefinitionList->getMethodList($plugin)))
);
}
$plugins = $pluginsMethods;
}
return $interceptionConfiguration;
}
}