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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Webapi\Model\Config;
/**
* Converter of webapi.xml content into array format.
*/
class Converter implements \Magento\Framework\Config\ConverterInterface
{
/**#@+
* Array keys for config internal representation.
*/
const KEY_SERVICE_CLASS = 'class';
const KEY_URL = 'url';
const KEY_SERVICE_METHOD = 'method';
const KEY_SECURE = 'secure';
const KEY_ROUTES = 'routes';
const KEY_ACL_RESOURCES = 'resources';
const KEY_SERVICE = 'service';
const KEY_SERVICES = 'services';
const KEY_FORCE = 'force';
const KEY_VALUE = 'value';
const KEY_DATA_PARAMETERS = 'parameters';
const KEY_SOURCE = 'source';
const KEY_METHOD = 'method';
const KEY_METHODS = 'methods';
const KEY_DESCRIPTION = 'description';
/**#@-*/
/**
* {@inheritdoc}
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
public function convert($source)
{
$result = [];
/** @var \DOMNodeList $routes */
$routes = $source->getElementsByTagName('route');
/** @var \DOMElement $route */
foreach ($routes as $route) {
if ($route->nodeType != XML_ELEMENT_NODE) {
continue;
}
/** @var \DOMElement $service */
$service = $route->getElementsByTagName('service')->item(0);
$serviceClass = $service->attributes->getNamedItem('class')->nodeValue;
$serviceMethod = $service->attributes->getNamedItem('method')->nodeValue;
$url = trim($route->attributes->getNamedItem('url')->nodeValue);
$version = $this->convertVersion($url);
$serviceClassData = [];
if (isset($result[self::KEY_SERVICES][$serviceClass][$version])) {
$serviceClassData = $result[self::KEY_SERVICES][$serviceClass][$version];
}
$resources = $route->getElementsByTagName('resource');
$resourceReferences = [];
$resourcePermissionSet = [];
/** @var \DOMElement $resource */
foreach ($resources as $resource) {
if ($resource->nodeType != XML_ELEMENT_NODE) {
continue;
}
$ref = $resource->attributes->getNamedItem('ref')->nodeValue;
$resourceReferences[$ref] = true;
// For SOAP
$resourcePermissionSet[] = $ref;
}
if (!isset($serviceClassData[self::KEY_METHODS][$serviceMethod])) {
$serviceClassData[self::KEY_METHODS][$serviceMethod][self::KEY_ACL_RESOURCES] = $resourcePermissionSet;
} else {
$serviceClassData[self::KEY_METHODS][$serviceMethod][self::KEY_ACL_RESOURCES] =
array_unique(
array_merge(
$serviceClassData[self::KEY_METHODS][$serviceMethod][self::KEY_ACL_RESOURCES],
$resourcePermissionSet
)
);
}
$method = $route->attributes->getNamedItem('method')->nodeValue;
$secureNode = $route->attributes->getNamedItem('secure');
$secure = $secureNode ? (bool)trim($secureNode->nodeValue) : false;
$data = $this->convertMethodParameters($route->getElementsByTagName('parameter'));
// We could handle merging here by checking if the route already exists
$result[self::KEY_ROUTES][$url][$method] = [
self::KEY_SECURE => $secure,
self::KEY_SERVICE => [
self::KEY_SERVICE_CLASS => $serviceClass,
self::KEY_SERVICE_METHOD => $serviceMethod,
],
self::KEY_ACL_RESOURCES => $resourceReferences,
self::KEY_DATA_PARAMETERS => $data,
];
$serviceSecure = false;
if (isset($serviceClassData[self::KEY_METHODS][$serviceMethod][self::KEY_SECURE])) {
$serviceSecure = $serviceClassData[self::KEY_METHODS][$serviceMethod][self::KEY_SECURE];
}
$serviceClassData[self::KEY_METHODS][$serviceMethod][self::KEY_SECURE] = $serviceSecure || $secure;
$result[self::KEY_SERVICES][$serviceClass][$version] = $serviceClassData;
}
return $result;
}
/**
* Parses the method parameters into a string array.
*
* @param \DOMNodeList $parameters
* @return array
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
protected function convertMethodParameters($parameters)
{
$data = [];
/** @var \DOMElement $parameter */
foreach ($parameters as $parameter) {
if ($parameter->nodeType != XML_ELEMENT_NODE) {
continue;
}
$name = $parameter->attributes->getNamedItem('name')->nodeValue;
$forceNode = $parameter->attributes->getNamedItem('force');
$force = $forceNode ? (bool)$forceNode->nodeValue : false;
$value = $parameter->nodeValue;
$data[$name] = [
self::KEY_FORCE => $force,
self::KEY_VALUE => ($value === 'null') ? null : $value,
];
$sourceNode = $parameter->attributes->getNamedItem('source');
if ($sourceNode) {
$data[$name][self::KEY_SOURCE] = $sourceNode->nodeValue;
}
$methodNode = $parameter->attributes->getNamedItem('method');
if ($methodNode) {
$data[$name][self::KEY_METHOD] = $methodNode->nodeValue;
}
}
return $data;
}
/**
* Derive the version from the provided URL.
* Assumes the version is the first portion of the URL. For example, '/V1/customers'
*
* @param string $url
* @return string
*/
protected function convertVersion($url)
{
return substr($url, 1, strpos($url, '/', 1)-1);
}
}