nextcloud / server

lib/private/legacy/api.php

Indentation +182 added lines, -182 removed lines

@@ -37,186 +37,186 @@
 
 class OC_API {
 
-	/**
-	 * api actions
-	 */
-	protected static $actions = array();
-
-	/**
-	 * registers an api call
-	 * @param string $method the http method
-	 * @param string $url the url to match
-	 * @param callable $action the function to run
-	 * @param string $app the id of the app registering the call
-	 * @param int $authLevel the level of authentication required for the call
-	 * @param array $defaults
-	 * @param array $requirements
-	 */
-	public static function register($method, $url, $action, $app,
-				$authLevel = API::USER_AUTH,
-				$defaults = array(),
-				$requirements = array()) {
-		$name = strtolower($method).$url;
-		$name = str_replace(array('/', '{', '}'), '_', $name);
-		if(!isset(self::$actions[$name])) {
-			$oldCollection = OC::$server->getRouter()->getCurrentCollection();
-			OC::$server->getRouter()->useCollection('ocs');
-			OC::$server->getRouter()->create($name, $url)
-				->method($method)
-				->defaults($defaults)
-				->requirements($requirements)
-				->action('OC_API', 'call');
-			self::$actions[$name] = array();
-			OC::$server->getRouter()->useCollection($oldCollection);
-		}
-		self::$actions[$name][] = array('app' => $app, 'action' => $action, 'authlevel' => $authLevel);
-	}
-
-	/**
-	 * respond to a call
-	 * @param \OC\OCS\Result $result
-	 * @param string $format the format xml|json
-	 */
-	public static function respond($result, $format='xml') {
-		$request = \OC::$server->getRequest();
-
-		// Send 401 headers if unauthorised
-		if($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
-			// If request comes from JS return dummy auth request
-			if($request->getHeader('X-Requested-With') === 'XMLHttpRequest') {
-				header('WWW-Authenticate: DummyBasic realm="Authorisation Required"');
-			} else {
-				header('WWW-Authenticate: Basic realm="Authorisation Required"');
-			}
-			header('HTTP/1.0 401 Unauthorized');
-		}
-
-		foreach($result->getHeaders() as $name => $value) {
-			header($name . ': ' . $value);
-		}
-
-		$meta = $result->getMeta();
-		$data = $result->getData();
-		if (self::isV2($request)) {
-			$statusCode = self::mapStatusCodes($result->getStatusCode());
-			if (!is_null($statusCode)) {
-				$meta['statuscode'] = $statusCode;
-				OC_Response::setStatus($statusCode);
-			}
-		}
-
-		self::setContentType($format);
-		$body = self::renderResult($format, $meta, $data);
-		echo $body;
-	}
-
-	/**
-	 * @param XMLWriter $writer
-	 */
-	private static function toXML($array, $writer) {
-		foreach($array as $k => $v) {
-			if ($k[0] === '@') {
-				$writer->writeAttribute(substr($k, 1), $v);
-				continue;
-			} else if (is_numeric($k)) {
-				$k = 'element';
-			}
-			if(is_array($v)) {
-				$writer->startElement($k);
-				self::toXML($v, $writer);
-				$writer->endElement();
-			} else {
-				$writer->writeElement($k, $v);
-			}
-		}
-	}
-
-	/**
-	 * @return string
-	 */
-	public static function requestedFormat() {
-		$formats = array('json', 'xml');
-
-		$format = !empty($_GET['format']) && in_array($_GET['format'], $formats) ? $_GET['format'] : 'xml';
-		return $format;
-	}
-
-	/**
-	 * Based on the requested format the response content type is set
-	 * @param string $format
-	 */
-	public static function setContentType($format = null) {
-		$format = is_null($format) ? self::requestedFormat() : $format;
-		if ($format === 'xml') {
-			header('Content-type: text/xml; charset=UTF-8');
-			return;
-		}
-
-		if ($format === 'json') {
-			header('Content-Type: application/json; charset=utf-8');
-			return;
-		}
-
-		header('Content-Type: application/octet-stream; charset=utf-8');
-	}
-
-	/**
-	 * @param \OCP\IRequest $request
-	 * @return bool
-	 */
-	protected static function isV2(\OCP\IRequest $request) {
-		$script = $request->getScriptName();
-
-		return substr($script, -11) === '/ocs/v2.php';
-	}
-
-	/**
-	 * @param integer $sc
-	 * @return int
-	 */
-	public static function mapStatusCodes($sc) {
-		switch ($sc) {
-			case API::RESPOND_NOT_FOUND:
-				return Http::STATUS_NOT_FOUND;
-			case API::RESPOND_SERVER_ERROR:
-				return Http::STATUS_INTERNAL_SERVER_ERROR;
-			case API::RESPOND_UNKNOWN_ERROR:
-				return Http::STATUS_INTERNAL_SERVER_ERROR;
-			case API::RESPOND_UNAUTHORISED:
-				// already handled for v1
-				return null;
-			case 100:
-				return Http::STATUS_OK;
-		}
-		// any 2xx, 4xx and 5xx will be used as is
-		if ($sc >= 200 && $sc < 600) {
-			return $sc;
-		}
-
-		return Http::STATUS_BAD_REQUEST;
-	}
-
-	/**
-	 * @param string $format
-	 * @return string
-	 */
-	public static function renderResult($format, $meta, $data) {
-		$response = array(
-			'ocs' => array(
-				'meta' => $meta,
-				'data' => $data,
-			),
-		);
-		if ($format == 'json') {
-			return OC_JSON::encode($response);
-		}
-
-		$writer = new XMLWriter();
-		$writer->openMemory();
-		$writer->setIndent(true);
-		$writer->startDocument();
-		self::toXML($response, $writer);
-		$writer->endDocument();
-		return $writer->outputMemory(true);
-	}
+    /**
+     * api actions
+     */
+    protected static $actions = array();
+
+    /**
+     * registers an api call
+     * @param string $method the http method
+     * @param string $url the url to match
+     * @param callable $action the function to run
+     * @param string $app the id of the app registering the call
+     * @param int $authLevel the level of authentication required for the call
+     * @param array $defaults
+     * @param array $requirements
+     */
+    public static function register($method, $url, $action, $app,
+                $authLevel = API::USER_AUTH,
+                $defaults = array(),
+                $requirements = array()) {
+        $name = strtolower($method).$url;
+        $name = str_replace(array('/', '{', '}'), '_', $name);
+        if(!isset(self::$actions[$name])) {
+            $oldCollection = OC::$server->getRouter()->getCurrentCollection();
+            OC::$server->getRouter()->useCollection('ocs');
+            OC::$server->getRouter()->create($name, $url)
+                ->method($method)
+                ->defaults($defaults)
+                ->requirements($requirements)
+                ->action('OC_API', 'call');
+            self::$actions[$name] = array();
+            OC::$server->getRouter()->useCollection($oldCollection);
+        }
+        self::$actions[$name][] = array('app' => $app, 'action' => $action, 'authlevel' => $authLevel);
+    }
+
+    /**
+     * respond to a call
+     * @param \OC\OCS\Result $result
+     * @param string $format the format xml|json
+     */
+    public static function respond($result, $format='xml') {
+        $request = \OC::$server->getRequest();
+
+        // Send 401 headers if unauthorised
+        if($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
+            // If request comes from JS return dummy auth request
+            if($request->getHeader('X-Requested-With') === 'XMLHttpRequest') {
+                header('WWW-Authenticate: DummyBasic realm="Authorisation Required"');
+            } else {
+                header('WWW-Authenticate: Basic realm="Authorisation Required"');
+            }
+            header('HTTP/1.0 401 Unauthorized');
+        }
+
+        foreach($result->getHeaders() as $name => $value) {
+            header($name . ': ' . $value);
+        }
+
+        $meta = $result->getMeta();
+        $data = $result->getData();
+        if (self::isV2($request)) {
+            $statusCode = self::mapStatusCodes($result->getStatusCode());
+            if (!is_null($statusCode)) {
+                $meta['statuscode'] = $statusCode;
+                OC_Response::setStatus($statusCode);
+            }
+        }
+
+        self::setContentType($format);
+        $body = self::renderResult($format, $meta, $data);
+        echo $body;
+    }
+
+    /**
+     * @param XMLWriter $writer
+     */
+    private static function toXML($array, $writer) {
+        foreach($array as $k => $v) {
+            if ($k[0] === '@') {
+                $writer->writeAttribute(substr($k, 1), $v);
+                continue;
+            } else if (is_numeric($k)) {
+                $k = 'element';
+            }
+            if(is_array($v)) {
+                $writer->startElement($k);
+                self::toXML($v, $writer);
+                $writer->endElement();
+            } else {
+                $writer->writeElement($k, $v);
+            }
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public static function requestedFormat() {
+        $formats = array('json', 'xml');
+
+        $format = !empty($_GET['format']) && in_array($_GET['format'], $formats) ? $_GET['format'] : 'xml';
+        return $format;
+    }
+
+    /**
+     * Based on the requested format the response content type is set
+     * @param string $format
+     */
+    public static function setContentType($format = null) {
+        $format = is_null($format) ? self::requestedFormat() : $format;
+        if ($format === 'xml') {
+            header('Content-type: text/xml; charset=UTF-8');
+            return;
+        }
+
+        if ($format === 'json') {
+            header('Content-Type: application/json; charset=utf-8');
+            return;
+        }
+
+        header('Content-Type: application/octet-stream; charset=utf-8');
+    }
+
+    /**
+     * @param \OCP\IRequest $request
+     * @return bool
+     */
+    protected static function isV2(\OCP\IRequest $request) {
+        $script = $request->getScriptName();
+
+        return substr($script, -11) === '/ocs/v2.php';
+    }
+
+    /**
+     * @param integer $sc
+     * @return int
+     */
+    public static function mapStatusCodes($sc) {
+        switch ($sc) {
+            case API::RESPOND_NOT_FOUND:
+                return Http::STATUS_NOT_FOUND;
+            case API::RESPOND_SERVER_ERROR:
+                return Http::STATUS_INTERNAL_SERVER_ERROR;
+            case API::RESPOND_UNKNOWN_ERROR:
+                return Http::STATUS_INTERNAL_SERVER_ERROR;
+            case API::RESPOND_UNAUTHORISED:
+                // already handled for v1
+                return null;
+            case 100:
+                return Http::STATUS_OK;
+        }
+        // any 2xx, 4xx and 5xx will be used as is
+        if ($sc >= 200 && $sc < 600) {
+            return $sc;
+        }
+
+        return Http::STATUS_BAD_REQUEST;
+    }
+
+    /**
+     * @param string $format
+     * @return string
+     */
+    public static function renderResult($format, $meta, $data) {
+        $response = array(
+            'ocs' => array(
+                'meta' => $meta,
+                'data' => $data,
+            ),
+        );
+        if ($format == 'json') {
+            return OC_JSON::encode($response);
+        }
+
+        $writer = new XMLWriter();
+        $writer->openMemory();
+        $writer->setIndent(true);
+        $writer->startDocument();
+        self::toXML($response, $writer);
+        $writer->endDocument();
+        return $writer->outputMemory(true);
+    }
 }

Spacing +8 added lines, -8 removed lines

@@ -58,7 +58,7 @@ 
 				$requirements = array()) {
 		$name = strtolower($method).$url;
 		$name = str_replace(array('/', '{', '}'), '_', $name);
-		if(!isset(self::$actions[$name])) {
+		if (!isset(self::$actions[$name])) {
 			$oldCollection = OC::$server->getRouter()->getCurrentCollection();
 			OC::$server->getRouter()->useCollection('ocs');
 			OC::$server->getRouter()->create($name, $url)
@@ -77,13 +77,13 @@ 
 	 * @param \OC\OCS\Result $result
 	 * @param string $format the format xml|json
 	 */
-	public static function respond($result, $format='xml') {
+	public static function respond($result, $format = 'xml') {
 		$request = \OC::$server->getRequest();
 
 		// Send 401 headers if unauthorised
-		if($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
+		if ($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
 			// If request comes from JS return dummy auth request
-			if($request->getHeader('X-Requested-With') === 'XMLHttpRequest') {
+			if ($request->getHeader('X-Requested-With') === 'XMLHttpRequest') {
 				header('WWW-Authenticate: DummyBasic realm="Authorisation Required"');
 			} else {
 				header('WWW-Authenticate: Basic realm="Authorisation Required"');
@@ -91,8 +91,8 @@ 
 			header('HTTP/1.0 401 Unauthorized');
 		}
 
-		foreach($result->getHeaders() as $name => $value) {
-			header($name . ': ' . $value);
+		foreach ($result->getHeaders() as $name => $value) {
+			header($name.': '.$value);
 		}
 
 		$meta = $result->getMeta();
@@ -114,14 +114,14 @@ 
 	 * @param XMLWriter $writer
 	 */
 	private static function toXML($array, $writer) {
-		foreach($array as $k => $v) {
+		foreach ($array as $k => $v) {
 			if ($k[0] === '@') {
 				$writer->writeAttribute(substr($k, 1), $v);
 				continue;
 			} else if (is_numeric($k)) {
 				$k = 'element';
 			}
-			if(is_array($v)) {
+			if (is_array($v)) {
 				$writer->startElement($k);
 				self::toXML($v, $writer);
 				$writer->endElement();