summaryrefslogtreecommitdiffstats
path: root/lib/private/AppFramework/OCS/V2Response.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/AppFramework/OCS/V2Response.php')
-rw-r--r--lib/private/AppFramework/OCS/V2Response.php76
1 files changed, 76 insertions, 0 deletions
diff --git a/lib/private/AppFramework/OCS/V2Response.php b/lib/private/AppFramework/OCS/V2Response.php
new file mode 100644
index 00000000000..7e98efe867d
--- /dev/null
+++ b/lib/private/AppFramework/OCS/V2Response.php
@@ -0,0 +1,76 @@
+<?php
+/**
+ * @copyright 2016 Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OC\AppFramework\OCS;
+
+use OCP\AppFramework\Http;
+use OCP\API;
+
+class V2Response extends BaseResponse {
+
+ /**
+ * The V2 endpoint just passes on status codes.
+ * Of course we have to map the OCS specific codes to proper HTTP status codes
+ *
+ * @return int
+ */
+ public function getStatus() {
+
+ $status = parent::getStatus();
+ if ($status === API::RESPOND_UNAUTHORISED) {
+ return Http::STATUS_UNAUTHORIZED;
+ } else if ($status === API::RESPOND_NOT_FOUND) {
+ return Http::STATUS_NOT_FOUND;
+ } else if ($status === API::RESPOND_SERVER_ERROR || $status === API::RESPOND_UNKNOWN_ERROR) {
+ return Http::STATUS_INTERNAL_SERVER_ERROR;
+ } else if ($status < 200 || $status > 600) {
+ return Http::STATUS_BAD_REQUEST;
+ }
+
+ return $status;
+ }
+
+ /**
+ * Construct the meta part of the response
+ * And then late the base class render
+ *
+ * @return string
+ */
+ public function render() {
+ $status = parent::getStatus();
+
+ $meta = [
+ 'status' => $status >= 200 && $status < 300 ? 'ok' : 'failure',
+ 'statuscode' => $this->getOCSStatus(),
+ 'message' => $status >= 200 && $status < 300 ? 'OK' : $this->statusMessage,
+ ];
+
+ if ($this->itemsCount !== null) {
+ $meta['totalitems'] = $this->itemsCount;
+ }
+ if ($this->itemsPerPage !== null) {
+ $meta['itemsperpage'] = $this->itemsPerPage;
+ }
+
+ return $this->renderResult($meta);
+ }
+}