nextcloud / server

lib/private/legacy/OC_API.php

Indentation +153 added lines, -153 removed lines

@@ -34,157 +34,157 @@
 
 class OC_API {
 
-	/**
-	 * api actions
-	 */
-	protected static $actions = [];
-
-	/**
-	 * respond to a call
-	 * @param \OC\OCS\Result $result
-	 * @param string $format the format xml|json
-	 * @psalm-taint-escape html
-	 */
-	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"');
-			}
-			http_response_code(401);
-		}
-
-		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;
-				http_response_code($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;
-			} elseif (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 = ['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 = [
-			'ocs' => [
-				'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 = [];
+
+    /**
+     * respond to a call
+     * @param \OC\OCS\Result $result
+     * @param string $format the format xml|json
+     * @psalm-taint-escape html
+     */
+    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"');
+            }
+            http_response_code(401);
+        }
+
+        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;
+                http_response_code($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;
+            } elseif (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 = ['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 = [
+            'ocs' => [
+                '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);
+    }
 }

lib/private/legacy/OC_JSON.php

Indentation +96 added lines, -96 removed lines

@@ -34,108 +34,108 @@
  */
 class OC_JSON {
 
-	/**
-	 * Check if the app is enabled, send json error msg if not
-	 * @param string $app
-	 * @deprecated Use the AppFramework instead. It will automatically check if the app is enabled.
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function checkAppEnabled($app) {
-		if (!\OC::$server->getAppManager()->isEnabledForUser($app)) {
-			$l = \OC::$server->getL10N('lib');
-			self::error([ 'data' => [ 'message' => $l->t('Application is not enabled'), 'error' => 'application_not_enabled' ]]);
-			exit();
-		}
-	}
+    /**
+     * Check if the app is enabled, send json error msg if not
+     * @param string $app
+     * @deprecated Use the AppFramework instead. It will automatically check if the app is enabled.
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function checkAppEnabled($app) {
+        if (!\OC::$server->getAppManager()->isEnabledForUser($app)) {
+            $l = \OC::$server->getL10N('lib');
+            self::error([ 'data' => [ 'message' => $l->t('Application is not enabled'), 'error' => 'application_not_enabled' ]]);
+            exit();
+        }
+    }
 
-	/**
-	 * Check if the user is logged in, send json error msg if not
-	 * @deprecated Use annotation based ACLs from the AppFramework instead
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function checkLoggedIn() {
-		$twoFactorAuthManger = \OC::$server->getTwoFactorAuthManager();
-		if (!\OC::$server->getUserSession()->isLoggedIn()
-			|| $twoFactorAuthManger->needsSecondFactor(\OC::$server->getUserSession()->getUser())) {
-			$l = \OC::$server->getL10N('lib');
-			http_response_code(\OCP\AppFramework\Http::STATUS_UNAUTHORIZED);
-			self::error([ 'data' => [ 'message' => $l->t('Authentication error'), 'error' => 'authentication_error' ]]);
-			exit();
-		}
-	}
+    /**
+     * Check if the user is logged in, send json error msg if not
+     * @deprecated Use annotation based ACLs from the AppFramework instead
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function checkLoggedIn() {
+        $twoFactorAuthManger = \OC::$server->getTwoFactorAuthManager();
+        if (!\OC::$server->getUserSession()->isLoggedIn()
+            || $twoFactorAuthManger->needsSecondFactor(\OC::$server->getUserSession()->getUser())) {
+            $l = \OC::$server->getL10N('lib');
+            http_response_code(\OCP\AppFramework\Http::STATUS_UNAUTHORIZED);
+            self::error([ 'data' => [ 'message' => $l->t('Authentication error'), 'error' => 'authentication_error' ]]);
+            exit();
+        }
+    }
 
-	/**
-	 * Check an ajax get/post call if the request token is valid, send json error msg if not.
-	 * @deprecated Use annotation based CSRF checks from the AppFramework instead
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function callCheck() {
-		if (!\OC::$server->getRequest()->passesStrictCookieCheck()) {
-			header('Location: '.\OC::$WEBROOT);
-			exit();
-		}
+    /**
+     * Check an ajax get/post call if the request token is valid, send json error msg if not.
+     * @deprecated Use annotation based CSRF checks from the AppFramework instead
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function callCheck() {
+        if (!\OC::$server->getRequest()->passesStrictCookieCheck()) {
+            header('Location: '.\OC::$WEBROOT);
+            exit();
+        }
 
-		if (!\OC::$server->getRequest()->passesCSRFCheck()) {
-			$l = \OC::$server->getL10N('lib');
-			self::error([ 'data' => [ 'message' => $l->t('Token expired. Please reload page.'), 'error' => 'token_expired' ]]);
-			exit();
-		}
-	}
+        if (!\OC::$server->getRequest()->passesCSRFCheck()) {
+            $l = \OC::$server->getL10N('lib');
+            self::error([ 'data' => [ 'message' => $l->t('Token expired. Please reload page.'), 'error' => 'token_expired' ]]);
+            exit();
+        }
+    }
 
-	/**
-	 * Check if the user is a admin, send json error msg if not.
-	 * @deprecated Use annotation based ACLs from the AppFramework instead
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function checkAdminUser() {
-		if (!OC_User::isAdminUser(OC_User::getUser())) {
-			$l = \OC::$server->getL10N('lib');
-			self::error([ 'data' => [ 'message' => $l->t('Authentication error'), 'error' => 'authentication_error' ]]);
-			exit();
-		}
-	}
+    /**
+     * Check if the user is a admin, send json error msg if not.
+     * @deprecated Use annotation based ACLs from the AppFramework instead
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function checkAdminUser() {
+        if (!OC_User::isAdminUser(OC_User::getUser())) {
+            $l = \OC::$server->getL10N('lib');
+            self::error([ 'data' => [ 'message' => $l->t('Authentication error'), 'error' => 'authentication_error' ]]);
+            exit();
+        }
+    }
 
-	/**
-	 * Send json error msg
-	 * @deprecated Use a AppFramework JSONResponse instead
-	 * @suppress PhanDeprecatedFunction
-	 * @psalm-taint-escape html
-	 */
-	public static function error($data = []) {
-		$data['status'] = 'error';
-		header('Content-Type: application/json; charset=utf-8');
-		echo self::encode($data);
-	}
+    /**
+     * Send json error msg
+     * @deprecated Use a AppFramework JSONResponse instead
+     * @suppress PhanDeprecatedFunction
+     * @psalm-taint-escape html
+     */
+    public static function error($data = []) {
+        $data['status'] = 'error';
+        header('Content-Type: application/json; charset=utf-8');
+        echo self::encode($data);
+    }
 
-	/**
-	 * Send json success msg
-	 * @deprecated Use a AppFramework JSONResponse instead
-	 * @suppress PhanDeprecatedFunction
-	 * @psalm-taint-escape html
-	 */
-	public static function success($data = []) {
-		$data['status'] = 'success';
-		header('Content-Type: application/json; charset=utf-8');
-		echo self::encode($data);
-	}
+    /**
+     * Send json success msg
+     * @deprecated Use a AppFramework JSONResponse instead
+     * @suppress PhanDeprecatedFunction
+     * @psalm-taint-escape html
+     */
+    public static function success($data = []) {
+        $data['status'] = 'success';
+        header('Content-Type: application/json; charset=utf-8');
+        echo self::encode($data);
+    }
 
-	/**
-	 * Convert OC_L10N_String to string, for use in json encodings
-	 */
-	protected static function to_string(&$value) {
-		if ($value instanceof \OC\L10N\L10NString) {
-			$value = (string)$value;
-		}
-	}
+    /**
+     * Convert OC_L10N_String to string, for use in json encodings
+     */
+    protected static function to_string(&$value) {
+        if ($value instanceof \OC\L10N\L10NString) {
+            $value = (string)$value;
+        }
+    }
 
-	/**
-	 * Encode JSON
-	 * @deprecated Use a AppFramework JSONResponse instead
-	 */
-	public static function encode($data) {
-		if (is_array($data)) {
-			array_walk_recursive($data, ['OC_JSON', 'to_string']);
-		}
-		return json_encode($data, JSON_HEX_TAG);
-	}
+    /**
+     * Encode JSON
+     * @deprecated Use a AppFramework JSONResponse instead
+     */
+    public static function encode($data) {
+        if (is_array($data)) {
+            array_walk_recursive($data, ['OC_JSON', 'to_string']);
+        }
+        return json_encode($data, JSON_HEX_TAG);
+    }
 }