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
|
<?php
/**
* SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\AppFramework\OCS;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\Response;
/**
* @psalm-import-type DataResponseType from DataResponse
* @template S of Http::STATUS_*
* @template-covariant T of DataResponseType
* @template H of array<string, mixed>
* @template-extends Response<Http::STATUS_*, array<string, mixed>>
*/
abstract class BaseResponse extends Response {
/** @var array */
protected $data;
/** @var string */
protected $format;
/** @var ?string */
protected $statusMessage;
/** @var ?int */
protected $itemsCount;
/** @var ?int */
protected $itemsPerPage;
/**
* BaseResponse constructor.
*
* @param DataResponse<S, T, H> $dataResponse
* @param string $format
* @param string|null $statusMessage
* @param int|null $itemsCount
* @param int|null $itemsPerPage
*/
public function __construct(DataResponse $dataResponse,
$format = 'xml',
$statusMessage = null,
$itemsCount = null,
$itemsPerPage = null) {
parent::__construct();
$this->format = $format;
$this->statusMessage = $statusMessage;
$this->itemsCount = $itemsCount;
$this->itemsPerPage = $itemsPerPage;
$this->data = $dataResponse->getData();
$this->setHeaders($dataResponse->getHeaders());
$this->setStatus($dataResponse->getStatus());
$this->setETag($dataResponse->getETag());
$this->setLastModified($dataResponse->getLastModified());
$this->setCookies($dataResponse->getCookies());
if ($dataResponse->isThrottled()) {
$throttleMetadata = $dataResponse->getThrottleMetadata();
$this->throttle($throttleMetadata);
}
if ($format === 'json') {
$this->addHeader(
'Content-Type', 'application/json; charset=utf-8'
);
} else {
$this->addHeader(
'Content-Type', 'application/xml; charset=utf-8'
);
}
}
/**
* @param array<string,string|int> $meta
* @return string
*/
protected function renderResult(array $meta): string {
$status = $this->getStatus();
if ($status === Http::STATUS_NO_CONTENT ||
$status === Http::STATUS_NOT_MODIFIED ||
($status >= 100 && $status <= 199)) {
// Those status codes are not supposed to have a body:
// https://stackoverflow.com/q/8628725
return '';
}
$response = [
'ocs' => [
'meta' => $meta,
'data' => $this->data,
],
];
if ($this->format === 'json') {
return $this->toJson($response);
}
$writer = new \XMLWriter();
$writer->openMemory();
$writer->setIndent(true);
$writer->startDocument();
$this->toXML($response, $writer);
$writer->endDocument();
return $writer->outputMemory(true);
}
/**
* @psalm-taint-escape has_quotes
* @psalm-taint-escape html
*/
protected function toJson(array $array): string {
return \json_encode($array, \JSON_HEX_TAG);
}
protected function toXML(array $array, \XMLWriter $writer): void {
foreach ($array as $k => $v) {
if ($k === '@attributes' && is_array($v)) {
foreach ($v as $k2 => $v2) {
$writer->writeAttribute($k2, $v2);
}
continue;
}
if (\is_string($k) && str_starts_with($k, '@')) {
$writer->writeAttribute(substr($k, 1), $v);
continue;
}
if (\is_numeric($k)) {
$k = 'element';
}
if ($v instanceof \stdClass) {
$v = [];
}
if ($k === '$comment') {
$writer->writeComment($v);
} elseif (\is_array($v)) {
$writer->startElement($k);
$this->toXML($v, $writer);
$writer->endElement();
} elseif ($v instanceof \JsonSerializable) {
$writer->startElement($k);
$this->toXML($v->jsonSerialize(), $writer);
$writer->endElement();
} elseif ($v === null) {
$writer->writeElement($k);
} else {
$writer->writeElement($k, (string)$v);
}
}
}
public function getOCSStatus() {
return parent::getStatus();
}
}
|
