Merge pull request #480 from nextcloud/fix_ocs_response_format

AppFramework default response for OCS is xml
nextcloud · Jul 21, 2016 · 562e63c · 562e63c
2 parents 8ec019e + e42f2f2
commit 562e63c
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 6 deletions.
diff --git a/lib/private/AppFramework/Http/Dispatcher.php b/lib/private/AppFramework/Http/Dispatcher.php
@@ -167,10 +167,14 @@ private function executeController($controller, $methodName) {
 			// if none is given try the first Accept header
 			if($format === null) {
 				$headers = $this->request->getHeader('Accept');
-				$format = $controller->getResponderByHTTPHeader($headers);
+				$format = $controller->getResponderByHTTPHeader($headers, null);
 			}
 
-			$response = $controller->buildResponse($response, $format);
+			if ($format !== null) {
+				$response = $controller->buildResponse($response, $format);
+			} else {
+				$response = $controller->buildResponse($response);
+			}
 		}
 
 		return $response;

diff --git a/lib/private/AppFramework/Middleware/OCSMiddleware.php b/lib/private/AppFramework/Middleware/OCSMiddleware.php
@@ -72,7 +72,7 @@ private function getFormat($controller) {
 		// if none is given try the first Accept header
 		if($format === null) {
 			$headers = $this->request->getHeader('Accept');
-			$format = $controller->getResponderByHTTPHeader($headers);
+			$format = $controller->getResponderByHTTPHeader($headers, 'xml');
 		}
 
 		return $format;

diff --git a/lib/public/AppFramework/Controller.php b/lib/public/AppFramework/Controller.php
@@ -104,8 +104,9 @@ public function __construct($appName,
 	 * @param string $acceptHeader
 	 * @return string the responder type
 	 * @since 7.0.0
+	 * @since 9.1.0 Added default parameter
 	 */
-	public function getResponderByHTTPHeader($acceptHeader) {
+	public function getResponderByHTTPHeader($acceptHeader, $default='json') {
 		$headers = explode(',', $acceptHeader);
 
 		// return the first matching responder
@@ -119,8 +120,8 @@ public function getResponderByHTTPHeader($acceptHeader) {
 			}
 		}
 
-		// no matching header defaults to json
-		return 'json';
+		// no matching header return default
+		return $default;
 	}
 
 

diff --git a/lib/public/AppFramework/OCSController.php b/lib/public/AppFramework/OCSController.php
@@ -31,6 +31,7 @@
 
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\Http\OCSResponse;
+use OCP\AppFramework\Http\Response;
 use OCP\IRequest;
 
 
@@ -69,6 +70,19 @@ public function __construct($appName,
 		});
 	}
 
+	/**
+	 * 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