From fa6a790859cbb84989354d9afc869df2ba24e994 Mon Sep 17 00:00:00 2001
From: Roeland Jago Douma <roeland@famdouma.nl>
Date: Sun, 1 Nov 2020 14:11:33 +0100
Subject: [PATCH] Remove deprecated OCSResponse
Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
---
lib/composer/composer/autoload_classmap.php | 1 -
lib/composer/composer/autoload_static.php | 1 -
lib/public/AppFramework/Http/OCSResponse.php | 95 -------------------
.../lib/AppFramework/Http/OCSResponseTest.php | 64 -------------
4 files changed, 161 deletions(-)
delete mode 100644 lib/public/AppFramework/Http/OCSResponse.php
delete mode 100644 tests/lib/AppFramework/Http/OCSResponseTest.php
diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index a966ad04f5f..aa2b5100b79 100644
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -49,7 +49,6 @@ return array(
'OCP\\AppFramework\\Http\\IOutput' => $baseDir . '/lib/public/AppFramework/Http/IOutput.php',
'OCP\\AppFramework\\Http\\JSONResponse' => $baseDir . '/lib/public/AppFramework/Http/JSONResponse.php',
'OCP\\AppFramework\\Http\\NotFoundResponse' => $baseDir . '/lib/public/AppFramework/Http/NotFoundResponse.php',
- 'OCP\\AppFramework\\Http\\OCSResponse' => $baseDir . '/lib/public/AppFramework/Http/OCSResponse.php',
'OCP\\AppFramework\\Http\\RedirectResponse' => $baseDir . '/lib/public/AppFramework/Http/RedirectResponse.php',
'OCP\\AppFramework\\Http\\RedirectToDefaultAppResponse' => $baseDir . '/lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php',
'OCP\\AppFramework\\Http\\Response' => $baseDir . '/lib/public/AppFramework/Http/Response.php',
diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index 92692d2188c..2eef38f5d89 100644
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -78,7 +78,6 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
'OCP\\AppFramework\\Http\\IOutput' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/IOutput.php',
'OCP\\AppFramework\\Http\\JSONResponse' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/JSONResponse.php',
'OCP\\AppFramework\\Http\\NotFoundResponse' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/NotFoundResponse.php',
- 'OCP\\AppFramework\\Http\\OCSResponse' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/OCSResponse.php',
'OCP\\AppFramework\\Http\\RedirectResponse' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/RedirectResponse.php',
'OCP\\AppFramework\\Http\\RedirectToDefaultAppResponse' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php',
'OCP\\AppFramework\\Http\\Response' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/Response.php',
diff --git a/lib/public/AppFramework/Http/OCSResponse.php b/lib/public/AppFramework/Http/OCSResponse.php
deleted file mode 100644
index 7823ca472f1..00000000000
--- a/lib/public/AppFramework/Http/OCSResponse.php
+++ /dev/null
@@ -1,95 +0,0 @@
-<?php
-/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Bernhard Posselt <dev@bernhard-posselt.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * 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, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
-
-/**
- * Public interface of ownCloud for apps to use.
- * AppFramework\HTTP\JSONResponse class
- */
-
-namespace OCP\AppFramework\Http;
-
-/**
- * A renderer for OCS responses
- * @since 8.1.0
- * @deprecated 9.2.0 To implement an OCS endpoint extend the OCSController
- */
-class OCSResponse extends Response {
- private $data;
- private $format;
- private $statuscode;
- private $message;
- private $itemscount;
- private $itemsperpage;
-
- /**
- * generates the xml or json response for the API call from an multidimenional data array.
- * @param string $format
- * @param int $statuscode
- * @param string $message
- * @param array $data
- * @param int|string $itemscount
- * @param int|string $itemsperpage
- * @since 8.1.0
- * @deprecated 9.2.0 To implement an OCS endpoint extend the OCSController
- */
- public function __construct($format, $statuscode, $message,
- $data = [], $itemscount = '',
- $itemsperpage = '') {
- parent::__construct();
-
- $this->format = $format;
- $this->statuscode = $statuscode;
- $this->message = $message;
- $this->data = $data;
- $this->itemscount = $itemscount;
- $this->itemsperpage = $itemsperpage;
-
- // set the correct header based on the format parameter
- if ($format === 'json') {
- $this->addHeader(
- 'Content-Type', 'application/json; charset=utf-8'
- );
- } else {
- $this->addHeader(
- 'Content-Type', 'application/xml; charset=utf-8'
- );
- }
- }
-
- /**
- * @return string
- * @since 8.1.0
- * @deprecated 9.2.0 To implement an OCS endpoint extend the OCSController
- * @suppress PhanDeprecatedClass
- */
- public function render() {
- $r = new \OC\OCS\Result($this->data, $this->statuscode, $this->message);
- $r->setTotalItems($this->itemscount);
- $r->setItemsPerPage($this->itemsperpage);
-
- return \OC_API::renderResult($this->format, $r->getMeta(), $r->getData());
- }
-}
diff --git a/tests/lib/AppFramework/Http/OCSResponseTest.php b/tests/lib/AppFramework/Http/OCSResponseTest.php
deleted file mode 100644
index e33f1399b84..00000000000
--- a/tests/lib/AppFramework/Http/OCSResponseTest.php
+++ /dev/null
@@ -1,64 +0,0 @@
-<?php
-
-/**
- * ownCloud - App Framework
- *
- * @author Bernhard Posselt
- * @copyright 2015 Bernhard Posselt <dev@bernhard-posselt.com>
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or any later version.
- *
- * This library 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 library. If not, see <http://www.gnu.org/licenses/>.
- *
- */
-
-namespace Test\AppFramework\Http;
-
-use OCP\AppFramework\Http\OCSResponse;
-
-class OCSResponseTest extends \Test\TestCase {
- public function testHeadersJSON() {
- $response = new OCSResponse('json', 1, 2, 3);
- $type = $response->getHeaders()['Content-Type'];
- $this->assertEquals('application/json; charset=utf-8', $type);
- }
-
-
- public function testHeadersXML() {
- $response = new OCSResponse('xml', 1, 2, 3);
- $type = $response->getHeaders()['Content-Type'];
- $this->assertEquals('application/xml; charset=utf-8', $type);
- }
-
-
- public function testRender() {
- $response = new OCSResponse(
- 'xml', 2, 'message', ['test' => 'hi'], 3, 4
- );
- $out = $response->render();
- $expected = "<?xml version=\"1.0\"?>\n" .
- "<ocs>\n" .
- " <meta>\n" .
- " <status>failure</status>\n" .
- " <statuscode>2</statuscode>\n" .
- " <message>message</message>\n" .
- " <totalitems>3</totalitems>\n" .
- " <itemsperpage>4</itemsperpage>\n" .
- " </meta>\n" .
- " <data>\n" .
- " <test>hi</test>\n" .
- " </data>\n" .
- "</ocs>\n";
-
- $this->assertEquals($expected, $out);
- }
-}
--
GitLab