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
|
<?php
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCP\AppFramework;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\Response;
use OCP\IRequest;
/**
* Base class to inherit your controllers from that are used for RESTful APIs
* @since 8.1.0
*/
abstract class OCSController extends ApiController {
/**
* @since 22.0.0
*/
public const RESPOND_UNAUTHORISED = 997;
/**
* @since 22.0.0
*/
public const RESPOND_SERVER_ERROR = 996;
/**
* @since 22.0.0
*/
public const RESPOND_NOT_FOUND = 998;
/**
* @since 22.0.0
*/
public const RESPOND_UNKNOWN_ERROR = 999;
/** @var int */
private $ocsVersion;
/**
* constructor of the controller
* @param string $appName the name of the app
* @param IRequest $request an instance of the request
* @param string $corsMethods comma separated string of HTTP verbs which
* should be allowed for websites or webapps when calling your API, defaults to
* 'PUT, POST, GET, DELETE, PATCH'
* @param string $corsAllowedHeaders comma separated string of HTTP headers
* which should be allowed for websites or webapps when calling your API,
* defaults to 'Authorization, Content-Type, Accept'
* @param int $corsMaxAge number in seconds how long a preflighted OPTIONS
* request should be cached, defaults to 1728000 seconds
* @since 8.1.0
*/
public function __construct($appName,
IRequest $request,
$corsMethods = 'PUT, POST, GET, DELETE, PATCH',
$corsAllowedHeaders = 'Authorization, Content-Type, Accept, OCS-APIRequest',
$corsMaxAge = 1728000) {
parent::__construct($appName, $request, $corsMethods,
$corsAllowedHeaders, $corsMaxAge);
$this->registerResponder('json', function ($data) {
return $this->buildOCSResponse('json', $data);
});
$this->registerResponder('xml', function ($data) {
return $this->buildOCSResponse('xml', $data);
});
}
/**
* @param int $version
* @since 11.0.0
* @internal
*/
public function setOCSVersion($version) {
$this->ocsVersion = $version;
}
/**
* Since the OCS endpoints default to XML we need to find out the format
* again
* @param mixed $response the value that was returned from a controller and
* is not a Response instance
* @param string $format the format for which a formatter has been registered
* @throws \DomainException if format does not match a registered formatter
* @return Response
* @since 9.1.0
*/
public function buildResponse($response, $format = 'xml') {
return parent::buildResponse($response, $format);
}
/**
* Unwrap data and build ocs response
* @param string $format json or xml
* @param DataResponse $data the data which should be transformed
* @since 8.1.0
* @return \OC\AppFramework\OCS\BaseResponse
*/
private function buildOCSResponse($format, DataResponse $data) {
if ($this->ocsVersion === 1) {
return new \OC\AppFramework\OCS\V1Response($data, $format);
}
return new \OC\AppFramework\OCS\V2Response($data, $format);
}
}
|
