From 87e10f9e6a0907adf20538f09159274e6b9ca429 Mon Sep 17 00:00:00 2001 From: Roeland Jago Douma Date: Thu, 21 Sep 2017 17:56:00 +0200 Subject: [PATCH 1/3] OC_OCS_Response is deprecated Signed-off-by: Roeland Jago Douma --- apps/files_external/lib/Lib/Api.php | 4 ++-- lib/private/legacy/api.php | 14 +++++++------- lib/public/AppFramework/Http/OCSResponse.php | 2 +- ocs/v1.php | 8 ++++---- tests/lib/APITest.php | 8 ++++---- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/apps/files_external/lib/Lib/Api.php b/apps/files_external/lib/Lib/Api.php index 6b10443bbd..547285a231 100644 --- a/apps/files_external/lib/Lib/Api.php +++ b/apps/files_external/lib/Lib/Api.php @@ -72,7 +72,7 @@ class Api { * Returns the mount points visible for this user. * * @param array $params - * @return \OC_OCS_Result share information + * @return \OC\OCS\Result share information */ public static function getUserMounts($params) { $entries = array(); @@ -83,6 +83,6 @@ class Api { $entries[] = self::formatMount($mountPoint, $mount); } - return new \OC_OCS_Result($entries); + return new \OC\OCS\Result($entries); } } diff --git a/lib/private/legacy/api.php b/lib/private/legacy/api.php index f65275bf1d..7fe84b73c4 100644 --- a/lib/private/legacy/api.php +++ b/lib/private/legacy/api.php @@ -129,7 +129,7 @@ class OC_API { if(!self::isAuthorised($action)) { $responses[] = array( 'app' => $action['app'], - 'response' => new OC_OCS_Result(null, API::RESPOND_UNAUTHORISED, 'Unauthorised'), + 'response' => new \OC\OCS\Result(null, API::RESPOND_UNAUTHORISED, 'Unauthorised'), 'shipped' => $appManager->isShipped($action['app']), ); continue; @@ -137,7 +137,7 @@ class OC_API { if(!is_callable($action['action'])) { $responses[] = array( 'app' => $action['app'], - 'response' => new OC_OCS_Result(null, API::RESPOND_NOT_FOUND, 'Api method not found'), + 'response' => new \OC\OCS\Result(null, API::RESPOND_NOT_FOUND, 'Api method not found'), 'shipped' => $appManager->isShipped($action['app']), ); continue; @@ -161,7 +161,7 @@ class OC_API { /** * merge the returned result objects into one response * @param array $responses - * @return OC_OCS_Result + * @return \OC\OCS\Result */ public static function mergeResponses($responses) { // Sort into shipped and third-party @@ -205,7 +205,7 @@ class OC_API { $code = $picked['response']->getStatusCode(); $meta = $picked['response']->getMeta(); $headers = $picked['response']->getHeaders(); - $response = new OC_OCS_Result($data, $code, $meta['message'], $headers); + $response = new \OC\OCS\Result($data, $code, $meta['message'], $headers); return $response; } elseif(!empty($shipped['succeeded'])) { $responses = array_merge($shipped['succeeded'], $thirdparty['succeeded']); @@ -219,7 +219,7 @@ class OC_API { $code = $picked['response']->getStatusCode(); $meta = $picked['response']->getMeta(); $headers = $picked['response']->getHeaders(); - $response = new OC_OCS_Result($data, $code, $meta['message'], $headers); + $response = new \OC\OCS\Result($data, $code, $meta['message'], $headers); return $response; } else { $responses = $thirdparty['succeeded']; @@ -251,7 +251,7 @@ class OC_API { } } - return new OC_OCS_Result($data, $statusCode, $statusMessage, $header); + return new \OC\OCS\Result($data, $statusCode, $statusMessage, $header); } /** @@ -351,7 +351,7 @@ class OC_API { /** * respond to a call - * @param OC_OCS_Result $result + * @param \OC\OCS\Result $result * @param string $format the format xml|json */ public static function respond($result, $format='xml') { diff --git a/lib/public/AppFramework/Http/OCSResponse.php b/lib/public/AppFramework/Http/OCSResponse.php index 8614e76805..ee1207f121 100644 --- a/lib/public/AppFramework/Http/OCSResponse.php +++ b/lib/public/AppFramework/Http/OCSResponse.php @@ -83,7 +83,7 @@ class OCSResponse extends Response { * @suppress PhanDeprecatedClass */ public function render() { - $r = new \OC_OCS_Result($this->data, $this->statuscode, $this->message); + $r = new \OC\OCS\Result($this->data, $this->statuscode, $this->message); $r->setTotalItems($this->itemscount); $r->setItemsPerPage($this->itemsperpage); diff --git a/ocs/v1.php b/ocs/v1.php index 80df64f4ed..857dc0fd14 100644 --- a/ocs/v1.php +++ b/ocs/v1.php @@ -36,7 +36,7 @@ if (\OCP\Util::needUpgrade() // since the behavior of apps or remotes are unpredictable during // an upgrade, return a 503 directly OC_Response::setStatus(OC_Response::STATUS_SERVICE_UNAVAILABLE); - $response = new OC_OCS_Result(null, OC_Response::STATUS_SERVICE_UNAVAILABLE, 'Service unavailable'); + $response = new \OC\OCS\Result(null, OC_Response::STATUS_SERVICE_UNAVAILABLE, 'Service unavailable'); OC_API::respond($response, OC_API::requestedFormat()); exit; } @@ -81,14 +81,14 @@ try { $format = \OC::$server->getRequest()->getParam('format', 'xml'); $txt='Invalid query, please check the syntax. API specifications are here:' .' http://www.freedesktop.org/wiki/Specifications/open-collaboration-services. DEBUG OUTPUT:'."\n"; - OC_API::respond(new OC_OCS_Result(null, \OCP\API::RESPOND_NOT_FOUND, $txt), $format); + OC_API::respond(new \OC\OCS\Result(null, \OCP\API::RESPOND_NOT_FOUND, $txt), $format); } catch (MethodNotAllowedException $e) { OC_API::setContentType(); OC_Response::setStatus(405); } catch (\OC\OCS\Exception $ex) { OC_API::respond($ex->getResult(), OC_API::requestedFormat()); } catch (\OC\User\LoginException $e) { - OC_API::respond(new OC_OCS_Result(null, \OCP\API::RESPOND_UNAUTHORISED, 'Unauthorised')); + OC_API::respond(new \OC\OCS\Result(null, \OCP\API::RESPOND_UNAUTHORISED, 'Unauthorised')); } catch (\Exception $e) { \OC::$server->getLogger()->logException($e); OC_API::setContentType(); @@ -96,6 +96,6 @@ try { $format = \OC::$server->getRequest()->getParam('format', 'xml'); $txt='Invalid query, please check the syntax. API specifications are here:' .' http://www.freedesktop.org/wiki/Specifications/open-collaboration-services. DEBUG OUTPUT:'."\n"; - OC_API::respond(new OC_OCS_Result(null, \OCP\API::RESPOND_NOT_FOUND, $txt), $format); + OC_API::respond(new \OC\OCS\Result(null, \OCP\API::RESPOND_NOT_FOUND, $txt), $format); } diff --git a/tests/lib/APITest.php b/tests/lib/APITest.php index d3ab6db9e4..c2a25d1306 100644 --- a/tests/lib/APITest.php +++ b/tests/lib/APITest.php @@ -16,7 +16,7 @@ class APITest extends \Test\TestCase { * @param string $message */ function buildResponse($shipped, $data, $code, $message=null) { - $resp = new \OC_OCS_Result($data, $code, $message); + $resp = new \OC\OCS\Result($data, $code, $message); $resp->addHeader('KEY', 'VALUE'); return [ 'shipped' => $shipped, @@ -28,13 +28,13 @@ class APITest extends \Test\TestCase { // Validate details of the result /** - * @param \OC_OCS_Result $result + * @param \OC\OCS\Result $result */ function checkResult($result, $success) { // Check response is of correct type - $this->assertInstanceOf('OC_OCS_Result', $result); + $this->assertInstanceOf(\OC\OCS\Result::class, $result); // Check if it succeeded - /** @var $result \OC_OCS_Result */ + /** @var $result \OC\OCS\Result */ $this->assertEquals($success, $result->succeeded()); } From 2207fdcd8c0965ea72c8dc812ef182f33f6f9c05 Mon Sep 17 00:00:00 2001 From: Roeland Jago Douma Date: Thu, 21 Sep 2017 17:56:56 +0200 Subject: [PATCH 2/3] Remove private legacy OC_OCS_Response Signed-off-by: Roeland Jago Douma --- lib/private/legacy/ocs/result.php | 28 ---------------------------- 1 file changed, 28 deletions(-) delete mode 100644 lib/private/legacy/ocs/result.php diff --git a/lib/private/legacy/ocs/result.php b/lib/private/legacy/ocs/result.php deleted file mode 100644 index fd90e56c60..0000000000 --- a/lib/private/legacy/ocs/result.php +++ /dev/null @@ -1,28 +0,0 @@ - - * @author Thomas Müller - * - * @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 - * - */ - -/** - * @deprecated Since 9.1.0 use \OC\OCS\Result - */ -class OC_OCS_Result extends \OC\OCS\Result { -} From 7eba0a2720ec7cece503c4d6e3859b208fd312cb Mon Sep 17 00:00:00 2001 From: Morris Jobke Date: Thu, 21 Sep 2017 20:10:36 +0200 Subject: [PATCH 3/3] Fix comment Signed-off-by: Morris Jobke --- apps/files_sharing/tests/Controller/ShareAPIControllerTest.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/files_sharing/tests/Controller/ShareAPIControllerTest.php b/apps/files_sharing/tests/Controller/ShareAPIControllerTest.php index fc6e457284..45134df36b 100644 --- a/apps/files_sharing/tests/Controller/ShareAPIControllerTest.php +++ b/apps/files_sharing/tests/Controller/ShareAPIControllerTest.php @@ -220,7 +220,7 @@ class ShareAPIControllerTest extends TestCase { ->with('ocinternal:42') ->will($this->throwException(new \OC\Share20\Exception\ShareNotFound())); - $expected = new \OC_OCS_Result(null, 404, 'wrong share ID, share doesn\'t exist.'); + $expected = new \OC\OCS\Result(null, 404, 'wrong share ID, share doesn\'t exist.'); $this->assertEquals($expected, $this->ocs->getShare(42)); } */