nextcloud / server

lib/public/AppFramework/Http/OCSResponse.php

Spacing +2 added lines, -2 removed lines

@@ -55,8 +55,8 @@
 	 * @deprecated 9.2.0 To implement an OCS endpoint extend the OCSController
 	 */
 	public function __construct($format, $statuscode, $message,
-								$data=[], $itemscount='',
-								$itemsperpage='') {
+								$data = [], $itemscount = '',
+								$itemsperpage = '') {
 		$this->format = $format;
 		$this->statuscode = $statuscode;
 		$this->message = $message;

Indentation +49 added lines, -49 removed lines

@@ -36,59 +36,59 @@
  */
 class OCSResponse extends Response {
 
-	private $data;
-	private $format;
-	private $statuscode;
-	private $message;
-	private $itemscount;
-	private $itemsperpage;
+    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='') {
-		$this->format = $format;
-		$this->statuscode = $statuscode;
-		$this->message = $message;
-		$this->data = $data;
-		$this->itemscount = $itemscount;
-		$this->itemsperpage = $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='') {
+        $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'
-			);
-		}
-	}
+        // 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 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());
-	}
+        return \OC_API::renderResult($this->format, $r->getMeta(), $r->getData());
+    }
 
 
 }

lib/public/AppFramework/Http/RedirectResponse.php

Indentation +21 added lines, -21 removed lines

@@ -36,27 +36,27 @@
  */
 class RedirectResponse extends Response {
 
-	private $redirectURL;
-
-	/**
-	 * Creates a response that redirects to a url
-	 * @param string $redirectURL the url to redirect to
-	 * @since 7.0.0
-	 */
-	public function __construct($redirectURL) {
-		$this->redirectURL = $redirectURL;
-		$this->setStatus(Http::STATUS_SEE_OTHER);
-		$this->addHeader('Location', $redirectURL);
-	}
-
-
-	/**
-	 * @return string the url to redirect
-	 * @since 7.0.0
-	 */
-	public function getRedirectURL() {
-		return $this->redirectURL;
-	}
+    private $redirectURL;
+
+    /**
+     * Creates a response that redirects to a url
+     * @param string $redirectURL the url to redirect to
+     * @since 7.0.0
+     */
+    public function __construct($redirectURL) {
+        $this->redirectURL = $redirectURL;
+        $this->setStatus(Http::STATUS_SEE_OTHER);
+        $this->addHeader('Location', $redirectURL);
+    }
+
+
+    /**
+     * @return string the url to redirect
+     * @since 7.0.0
+     */
+    public function getRedirectURL() {
+        return $this->redirectURL;
+    }
 
 
 }

lib/public/AppFramework/Http/JSONResponse.php

Indentation +49 added lines, -49 removed lines

@@ -39,63 +39,63 @@
  */
 class JSONResponse extends Response {
 
-	/**
-	 * response data
-	 * @var array|object
-	 */
-	protected $data;
+    /**
+     * response data
+     * @var array|object
+     */
+    protected $data;
 
 
-	/**
-	 * constructor of JSONResponse
-	 * @param array|object $data the object or array that should be transformed
-	 * @param int $statusCode the Http status code, defaults to 200
-	 * @since 6.0.0
-	 */
-	public function __construct($data=array(), $statusCode=Http::STATUS_OK) {
-		$this->data = $data;
-		$this->setStatus($statusCode);
-		$this->addHeader('Content-Type', 'application/json; charset=utf-8');
-	}
+    /**
+     * constructor of JSONResponse
+     * @param array|object $data the object or array that should be transformed
+     * @param int $statusCode the Http status code, defaults to 200
+     * @since 6.0.0
+     */
+    public function __construct($data=array(), $statusCode=Http::STATUS_OK) {
+        $this->data = $data;
+        $this->setStatus($statusCode);
+        $this->addHeader('Content-Type', 'application/json; charset=utf-8');
+    }
 
 
-	/**
-	 * Returns the rendered json
-	 * @return string the rendered json
-	 * @since 6.0.0
-	 * @throws \Exception If data could not get encoded
-	 */
-	public function render() {
-		$response = json_encode($this->data, JSON_HEX_TAG);
-		if($response === false) {
-			throw new \Exception(sprintf('Could not json_encode due to invalid ' .
-				'non UTF-8 characters in the array: %s', var_export($this->data, true)));
-		}
+    /**
+     * Returns the rendered json
+     * @return string the rendered json
+     * @since 6.0.0
+     * @throws \Exception If data could not get encoded
+     */
+    public function render() {
+        $response = json_encode($this->data, JSON_HEX_TAG);
+        if($response === false) {
+            throw new \Exception(sprintf('Could not json_encode due to invalid ' .
+                'non UTF-8 characters in the array: %s', var_export($this->data, true)));
+        }
 
-		return $response;
-	}
+        return $response;
+    }
 
-	/**
-	 * Sets values in the data json array
-	 * @param array|object $data an array or object which will be transformed
-	 *                             to JSON
-	 * @return JSONResponse Reference to this object
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function setData($data){
-		$this->data = $data;
+    /**
+     * Sets values in the data json array
+     * @param array|object $data an array or object which will be transformed
+     *                             to JSON
+     * @return JSONResponse Reference to this object
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function setData($data){
+        $this->data = $data;
 
-		return $this;
-	}
+        return $this;
+    }
 
 
-	/**
-	 * Used to get the set parameters
-	 * @return array the data
-	 * @since 6.0.0
-	 */
-	public function getData(){
-		return $this->data;
-	}
+    /**
+     * Used to get the set parameters
+     * @return array the data
+     * @since 6.0.0
+     */
+    public function getData(){
+        return $this->data;
+    }
 
 }

Spacing +5 added lines, -5 removed lines

@@ -52,7 +52,7 @@ 
 	 * @param int $statusCode the Http status code, defaults to 200
 	 * @since 6.0.0
 	 */
-	public function __construct($data=array(), $statusCode=Http::STATUS_OK) {
+	public function __construct($data = array(), $statusCode = Http::STATUS_OK) {
 		$this->data = $data;
 		$this->setStatus($statusCode);
 		$this->addHeader('Content-Type', 'application/json; charset=utf-8');
@@ -67,8 +67,8 @@ 
 	 */
 	public function render() {
 		$response = json_encode($this->data, JSON_HEX_TAG);
-		if($response === false) {
-			throw new \Exception(sprintf('Could not json_encode due to invalid ' .
+		if ($response === false) {
+			throw new \Exception(sprintf('Could not json_encode due to invalid '.
 				'non UTF-8 characters in the array: %s', var_export($this->data, true)));
 		}
 
@@ -82,7 +82,7 @@ 
 	 * @return JSONResponse Reference to this object
 	 * @since 6.0.0 - return value was added in 7.0.0
 	 */
-	public function setData($data){
+	public function setData($data) {
 		$this->data = $data;
 
 		return $this;
@@ -94,7 +94,7 @@ 
 	 * @return array the data
 	 * @since 6.0.0
 	 */
-	public function getData(){
+	public function getData() {
 		return $this->data;
 	}
 

lib/public/AppFramework/Http/DataResponse.php

Indentation +35 added lines, -35 removed lines

@@ -37,48 +37,48 @@
  */
 class DataResponse extends Response {
 
-	/**
-	 * response data
-	 * @var array|object
-	 */
-	protected $data;
+    /**
+     * response data
+     * @var array|object
+     */
+    protected $data;
 
 
-	/**
-	 * @param array|object $data the object or array that should be transformed
-	 * @param int $statusCode the Http status code, defaults to 200
-	 * @param array $headers additional key value based headers
-	 * @since 8.0.0
-	 */
-	public function __construct($data=array(), $statusCode=Http::STATUS_OK,
-	                            array $headers=array()) {
-		$this->data = $data;
-		$this->setStatus($statusCode);
-		$this->setHeaders(array_merge($this->getHeaders(), $headers));
-	}
+    /**
+     * @param array|object $data the object or array that should be transformed
+     * @param int $statusCode the Http status code, defaults to 200
+     * @param array $headers additional key value based headers
+     * @since 8.0.0
+     */
+    public function __construct($data=array(), $statusCode=Http::STATUS_OK,
+                                array $headers=array()) {
+        $this->data = $data;
+        $this->setStatus($statusCode);
+        $this->setHeaders(array_merge($this->getHeaders(), $headers));
+    }
 
 
-	/**
-	 * Sets values in the data json array
-	 * @param array|object $data an array or object which will be transformed
-	 * @return DataResponse Reference to this object
-	 * @since 8.0.0
-	 */
-	public function setData($data){
-		$this->data = $data;
+    /**
+     * Sets values in the data json array
+     * @param array|object $data an array or object which will be transformed
+     * @return DataResponse Reference to this object
+     * @since 8.0.0
+     */
+    public function setData($data){
+        $this->data = $data;
 
-		return $this;
-	}
+        return $this;
+    }
 
 
-	/**
-	 * Used to get the set parameters
-	 * @return array the data
-	 * @since 8.0.0
-	 */
-	public function getData(){
-		return $this->data;
-	}
+    /**
+     * Used to get the set parameters
+     * @return array the data
+     * @since 8.0.0
+     */
+    public function getData(){
+        return $this->data;
+    }
 
 
 }

Spacing +4 added lines, -4 removed lines

@@ -50,8 +50,8 @@ 
 	 * @param array $headers additional key value based headers
 	 * @since 8.0.0
 	 */
-	public function __construct($data=array(), $statusCode=Http::STATUS_OK,
-	                            array $headers=array()) {
+	public function __construct($data = array(), $statusCode = Http::STATUS_OK,
+	                            array $headers = array()) {
 		$this->data = $data;
 		$this->setStatus($statusCode);
 		$this->setHeaders(array_merge($this->getHeaders(), $headers));
@@ -64,7 +64,7 @@ 
 	 * @return DataResponse Reference to this object
 	 * @since 8.0.0
 	 */
-	public function setData($data){
+	public function setData($data) {
 		$this->data = $data;
 
 		return $this;
@@ -76,7 +76,7 @@ 
 	 * @return array the data
 	 * @since 8.0.0
 	 */
-	public function getData(){
+	public function getData() {
 		return $this->data;
 	}
 

lib/public/AppFramework/Http/Response.php

Spacing +9 added lines, -9 removed lines

@@ -91,8 +91,8 @@ 
 	 */
 	public function cacheFor($cacheSeconds) {
 
-		if($cacheSeconds > 0) {
-			$this->addHeader('Cache-Control', 'max-age=' . $cacheSeconds . ', must-revalidate');
+		if ($cacheSeconds > 0) {
+			$this->addHeader('Cache-Control', 'max-age='.$cacheSeconds.', must-revalidate');
 		} else {
 			$this->addHeader('Cache-Control', 'no-cache, no-store, must-revalidate');
 		}
@@ -146,7 +146,7 @@ 
 	 * @since 8.0.0
 	 */
 	public function invalidateCookies(array $cookieNames) {
-		foreach($cookieNames as $cookieName) {
+		foreach ($cookieNames as $cookieName) {
 			$this->invalidateCookie($cookieName);
 		}
 		return $this;
@@ -170,11 +170,11 @@ 
 	 * @since 6.0.0 - return value was added in 7.0.0
 	 */
 	public function addHeader($name, $value) {
-		$name = trim($name);  // always remove leading and trailing whitespace
+		$name = trim($name); // always remove leading and trailing whitespace
 		                      // to be able to reliably check for security
 		                      // headers
 
-		if(is_null($value)) {
+		if (is_null($value)) {
 			unset($this->headers[$name]);
 		} else {
 			$this->headers[$name] = $value;
@@ -205,19 +205,19 @@ 
 	public function getHeaders() {
 		$mergeWith = [];
 
-		if($this->lastModified) {
+		if ($this->lastModified) {
 			$mergeWith['Last-Modified'] =
 				$this->lastModified->format(\DateTime::RFC2822);
 		}
 
 		// Build Content-Security-Policy and use default if none has been specified
-		if(is_null($this->contentSecurityPolicy)) {
+		if (is_null($this->contentSecurityPolicy)) {
 			$this->setContentSecurityPolicy(new ContentSecurityPolicy());
 		}
 		$this->headers['Content-Security-Policy'] = $this->contentSecurityPolicy->buildPolicy();
 
-		if($this->ETag) {
-			$mergeWith['ETag'] = '"' . $this->ETag . '"';
+		if ($this->ETag) {
+			$mergeWith['ETag'] = '"'.$this->ETag.'"';
 		}
 
 		return array_merge($mergeWith, $this->headers);

Doc Comments +1 added lines, -1 removed lines

@@ -261,7 +261,7 @@
 
 	/**
 	 * Get the currently used Content-Security-Policy
-	 * @return EmptyContentSecurityPolicy|null Used Content-Security-Policy or null if
+	 * @return ContentSecurityPolicy|null Used Content-Security-Policy or null if
 	 *                                    none specified.
 	 * @since 8.1.0
 	 */

Indentation +314 added lines, -314 removed lines

@@ -44,318 +44,318 @@
  */
 class Response {
 
-	/**
-	 * Headers - defaults to ['Cache-Control' => 'no-cache, no-store, must-revalidate']
-	 * @var array
-	 */
-	private $headers = array(
-		'Cache-Control' => 'no-cache, no-store, must-revalidate'
-	);
-
-
-	/**
-	 * Cookies that will be need to be constructed as header
-	 * @var array
-	 */
-	private $cookies = array();
-
-
-	/**
-	 * HTTP status code - defaults to STATUS OK
-	 * @var int
-	 */
-	private $status = Http::STATUS_OK;
-
-
-	/**
-	 * Last modified date
-	 * @var \DateTime
-	 */
-	private $lastModified;
-
-
-	/**
-	 * ETag
-	 * @var string
-	 */
-	private $ETag;
-
-	/** @var ContentSecurityPolicy|null Used Content-Security-Policy */
-	private $contentSecurityPolicy = null;
-
-	/** @var bool */
-	private $throttled = false;
-	/** @var array */
-	private $throttleMetadata = [];
-
-	/**
-	 * Caches the response
-	 * @param int $cacheSeconds the amount of seconds that should be cached
-	 * if 0 then caching will be disabled
-	 * @return $this
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function cacheFor($cacheSeconds) {
-
-		if($cacheSeconds > 0) {
-			$this->addHeader('Cache-Control', 'max-age=' . $cacheSeconds . ', must-revalidate');
-		} else {
-			$this->addHeader('Cache-Control', 'no-cache, no-store, must-revalidate');
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Adds a new cookie to the response
-	 * @param string $name The name of the cookie
-	 * @param string $value The value of the cookie
-	 * @param \DateTime|null $expireDate Date on that the cookie should expire, if set
-	 * 									to null cookie will be considered as session
-	 * 									cookie.
-	 * @return $this
-	 * @since 8.0.0
-	 */
-	public function addCookie($name, $value, \DateTime $expireDate = null) {
-		$this->cookies[$name] = array('value' => $value, 'expireDate' => $expireDate);
-		return $this;
-	}
-
-
-	/**
-	 * Set the specified cookies
-	 * @param array $cookies array('foo' => array('value' => 'bar', 'expire' => null))
-	 * @return $this
-	 * @since 8.0.0
-	 */
-	public function setCookies(array $cookies) {
-		$this->cookies = $cookies;
-		return $this;
-	}
-
-
-	/**
-	 * Invalidates the specified cookie
-	 * @param string $name
-	 * @return $this
-	 * @since 8.0.0
-	 */
-	public function invalidateCookie($name) {
-		$this->addCookie($name, 'expired', new \DateTime('1971-01-01 00:00'));
-		return $this;
-	}
-
-	/**
-	 * Invalidates the specified cookies
-	 * @param array $cookieNames array('foo', 'bar')
-	 * @return $this
-	 * @since 8.0.0
-	 */
-	public function invalidateCookies(array $cookieNames) {
-		foreach($cookieNames as $cookieName) {
-			$this->invalidateCookie($cookieName);
-		}
-		return $this;
-	}
-
-	/**
-	 * Returns the cookies
-	 * @return array
-	 * @since 8.0.0
-	 */
-	public function getCookies() {
-		return $this->cookies;
-	}
-
-	/**
-	 * Adds a new header to the response that will be called before the render
-	 * function
-	 * @param string $name The name of the HTTP header
-	 * @param string $value The value, null will delete it
-	 * @return $this
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function addHeader($name, $value) {
-		$name = trim($name);  // always remove leading and trailing whitespace
-		                      // to be able to reliably check for security
-		                      // headers
-
-		if(is_null($value)) {
-			unset($this->headers[$name]);
-		} else {
-			$this->headers[$name] = $value;
-		}
-
-		return $this;
-	}
-
-
-	/**
-	 * Set the headers
-	 * @param array $headers value header pairs
-	 * @return $this
-	 * @since 8.0.0
-	 */
-	public function setHeaders(array $headers) {
-		$this->headers = $headers;
-
-		return $this;
-	}
-
-
-	/**
-	 * Returns the set headers
-	 * @return array the headers
-	 * @since 6.0.0
-	 */
-	public function getHeaders() {
-		$mergeWith = [];
-
-		if($this->lastModified) {
-			$mergeWith['Last-Modified'] =
-				$this->lastModified->format(\DateTime::RFC2822);
-		}
-
-		// Build Content-Security-Policy and use default if none has been specified
-		if(is_null($this->contentSecurityPolicy)) {
-			$this->setContentSecurityPolicy(new ContentSecurityPolicy());
-		}
-		$this->headers['Content-Security-Policy'] = $this->contentSecurityPolicy->buildPolicy();
-
-		if($this->ETag) {
-			$mergeWith['ETag'] = '"' . $this->ETag . '"';
-		}
-
-		return array_merge($mergeWith, $this->headers);
-	}
-
-
-	/**
-	 * By default renders no output
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public function render() {
-		return '';
-	}
-
-
-	/**
-	 * Set response status
-	 * @param int $status a HTTP status code, see also the STATUS constants
-	 * @return Response Reference to this object
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function setStatus($status) {
-		$this->status = $status;
-
-		return $this;
-	}
-
-	/**
-	 * Set a Content-Security-Policy
-	 * @param EmptyContentSecurityPolicy $csp Policy to set for the response object
-	 * @return $this
-	 * @since 8.1.0
-	 */
-	public function setContentSecurityPolicy(EmptyContentSecurityPolicy $csp) {
-		$this->contentSecurityPolicy = $csp;
-		return $this;
-	}
-
-	/**
-	 * Get the currently used Content-Security-Policy
-	 * @return EmptyContentSecurityPolicy|null Used Content-Security-Policy or null if
-	 *                                    none specified.
-	 * @since 8.1.0
-	 */
-	public function getContentSecurityPolicy() {
-		return $this->contentSecurityPolicy;
-	}
-
-
-	/**
-	 * Get response status
-	 * @since 6.0.0
-	 */
-	public function getStatus() {
-		return $this->status;
-	}
-
-
-	/**
-	 * Get the ETag
-	 * @return string the etag
-	 * @since 6.0.0
-	 */
-	public function getETag() {
-		return $this->ETag;
-	}
-
-
-	/**
-	 * Get "last modified" date
-	 * @return \DateTime RFC2822 formatted last modified date
-	 * @since 6.0.0
-	 */
-	public function getLastModified() {
-		return $this->lastModified;
-	}
-
-
-	/**
-	 * Set the ETag
-	 * @param string $ETag
-	 * @return Response Reference to this object
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function setETag($ETag) {
-		$this->ETag = $ETag;
-
-		return $this;
-	}
-
-
-	/**
-	 * Set "last modified" date
-	 * @param \DateTime $lastModified
-	 * @return Response Reference to this object
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function setLastModified($lastModified) {
-		$this->lastModified = $lastModified;
-
-		return $this;
-	}
-
-	/**
-	 * Marks the response as to throttle. Will be throttled when the
-	 * @BruteForceProtection annotation is added.
-	 *
-	 * @param array $metadata
-	 * @since 12.0.0
-	 */
-	public function throttle(array $metadata = []) {
-		$this->throttled = true;
-		$this->throttleMetadata = $metadata;
-	}
-
-	/**
-	 * Returns the throttle metadata, defaults to empty array
-	 *
-	 * @return array
-	 * @since 13.0.0
-	 */
-	public function getThrottleMetadata() {
-		return $this->throttleMetadata;
-	}
-
-	/**
-	 * Whether the current response is throttled.
-	 *
-	 * @since 12.0.0
-	 */
-	public function isThrottled() {
-		return $this->throttled;
-	}
+    /**
+     * Headers - defaults to ['Cache-Control' => 'no-cache, no-store, must-revalidate']
+     * @var array
+     */
+    private $headers = array(
+        'Cache-Control' => 'no-cache, no-store, must-revalidate'
+    );
+
+
+    /**
+     * Cookies that will be need to be constructed as header
+     * @var array
+     */
+    private $cookies = array();
+
+
+    /**
+     * HTTP status code - defaults to STATUS OK
+     * @var int
+     */
+    private $status = Http::STATUS_OK;
+
+
+    /**
+     * Last modified date
+     * @var \DateTime
+     */
+    private $lastModified;
+
+
+    /**
+     * ETag
+     * @var string
+     */
+    private $ETag;
+
+    /** @var ContentSecurityPolicy|null Used Content-Security-Policy */
+    private $contentSecurityPolicy = null;
+
+    /** @var bool */
+    private $throttled = false;
+    /** @var array */
+    private $throttleMetadata = [];
+
+    /**
+     * Caches the response
+     * @param int $cacheSeconds the amount of seconds that should be cached
+     * if 0 then caching will be disabled
+     * @return $this
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function cacheFor($cacheSeconds) {
+
+        if($cacheSeconds > 0) {
+            $this->addHeader('Cache-Control', 'max-age=' . $cacheSeconds . ', must-revalidate');
+        } else {
+            $this->addHeader('Cache-Control', 'no-cache, no-store, must-revalidate');
+        }
+
+        return $this;
+    }
+
+    /**
+     * Adds a new cookie to the response
+     * @param string $name The name of the cookie
+     * @param string $value The value of the cookie
+     * @param \DateTime|null $expireDate Date on that the cookie should expire, if set
+     * 									to null cookie will be considered as session
+     * 									cookie.
+     * @return $this
+     * @since 8.0.0
+     */
+    public function addCookie($name, $value, \DateTime $expireDate = null) {
+        $this->cookies[$name] = array('value' => $value, 'expireDate' => $expireDate);
+        return $this;
+    }
+
+
+    /**
+     * Set the specified cookies
+     * @param array $cookies array('foo' => array('value' => 'bar', 'expire' => null))
+     * @return $this
+     * @since 8.0.0
+     */
+    public function setCookies(array $cookies) {
+        $this->cookies = $cookies;
+        return $this;
+    }
+
+
+    /**
+     * Invalidates the specified cookie
+     * @param string $name
+     * @return $this
+     * @since 8.0.0
+     */
+    public function invalidateCookie($name) {
+        $this->addCookie($name, 'expired', new \DateTime('1971-01-01 00:00'));
+        return $this;
+    }
+
+    /**
+     * Invalidates the specified cookies
+     * @param array $cookieNames array('foo', 'bar')
+     * @return $this
+     * @since 8.0.0
+     */
+    public function invalidateCookies(array $cookieNames) {
+        foreach($cookieNames as $cookieName) {
+            $this->invalidateCookie($cookieName);
+        }
+        return $this;
+    }
+
+    /**
+     * Returns the cookies
+     * @return array
+     * @since 8.0.0
+     */
+    public function getCookies() {
+        return $this->cookies;
+    }
+
+    /**
+     * Adds a new header to the response that will be called before the render
+     * function
+     * @param string $name The name of the HTTP header
+     * @param string $value The value, null will delete it
+     * @return $this
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function addHeader($name, $value) {
+        $name = trim($name);  // always remove leading and trailing whitespace
+                                // to be able to reliably check for security
+                                // headers
+
+        if(is_null($value)) {
+            unset($this->headers[$name]);
+        } else {
+            $this->headers[$name] = $value;
+        }
+
+        return $this;
+    }
+
+
+    /**
+     * Set the headers
+     * @param array $headers value header pairs
+     * @return $this
+     * @since 8.0.0
+     */
+    public function setHeaders(array $headers) {
+        $this->headers = $headers;
+
+        return $this;
+    }
+
+
+    /**
+     * Returns the set headers
+     * @return array the headers
+     * @since 6.0.0
+     */
+    public function getHeaders() {
+        $mergeWith = [];
+
+        if($this->lastModified) {
+            $mergeWith['Last-Modified'] =
+                $this->lastModified->format(\DateTime::RFC2822);
+        }
+
+        // Build Content-Security-Policy and use default if none has been specified
+        if(is_null($this->contentSecurityPolicy)) {
+            $this->setContentSecurityPolicy(new ContentSecurityPolicy());
+        }
+        $this->headers['Content-Security-Policy'] = $this->contentSecurityPolicy->buildPolicy();
+
+        if($this->ETag) {
+            $mergeWith['ETag'] = '"' . $this->ETag . '"';
+        }
+
+        return array_merge($mergeWith, $this->headers);
+    }
+
+
+    /**
+     * By default renders no output
+     * @return string
+     * @since 6.0.0
+     */
+    public function render() {
+        return '';
+    }
+
+
+    /**
+     * Set response status
+     * @param int $status a HTTP status code, see also the STATUS constants
+     * @return Response Reference to this object
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function setStatus($status) {
+        $this->status = $status;
+
+        return $this;
+    }
+
+    /**
+     * Set a Content-Security-Policy
+     * @param EmptyContentSecurityPolicy $csp Policy to set for the response object
+     * @return $this
+     * @since 8.1.0
+     */
+    public function setContentSecurityPolicy(EmptyContentSecurityPolicy $csp) {
+        $this->contentSecurityPolicy = $csp;
+        return $this;
+    }
+
+    /**
+     * Get the currently used Content-Security-Policy
+     * @return EmptyContentSecurityPolicy|null Used Content-Security-Policy or null if
+     *                                    none specified.
+     * @since 8.1.0
+     */
+    public function getContentSecurityPolicy() {
+        return $this->contentSecurityPolicy;
+    }
+
+
+    /**
+     * Get response status
+     * @since 6.0.0
+     */
+    public function getStatus() {
+        return $this->status;
+    }
+
+
+    /**
+     * Get the ETag
+     * @return string the etag
+     * @since 6.0.0
+     */
+    public function getETag() {
+        return $this->ETag;
+    }
+
+
+    /**
+     * Get "last modified" date
+     * @return \DateTime RFC2822 formatted last modified date
+     * @since 6.0.0
+     */
+    public function getLastModified() {
+        return $this->lastModified;
+    }
+
+
+    /**
+     * Set the ETag
+     * @param string $ETag
+     * @return Response Reference to this object
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function setETag($ETag) {
+        $this->ETag = $ETag;
+
+        return $this;
+    }
+
+
+    /**
+     * Set "last modified" date
+     * @param \DateTime $lastModified
+     * @return Response Reference to this object
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function setLastModified($lastModified) {
+        $this->lastModified = $lastModified;
+
+        return $this;
+    }
+
+    /**
+     * Marks the response as to throttle. Will be throttled when the
+     * @BruteForceProtection annotation is added.
+     *
+     * @param array $metadata
+     * @since 12.0.0
+     */
+    public function throttle(array $metadata = []) {
+        $this->throttled = true;
+        $this->throttleMetadata = $metadata;
+    }
+
+    /**
+     * Returns the throttle metadata, defaults to empty array
+     *
+     * @return array
+     * @since 13.0.0
+     */
+    public function getThrottleMetadata() {
+        return $this->throttleMetadata;
+    }
+
+    /**
+     * Whether the current response is throttled.
+     *
+     * @since 12.0.0
+     */
+    public function isThrottled() {
+        return $this->throttled;
+    }
 }

lib/public/AppFramework/Http/DataDownloadResponse.php

Indentation +29 added lines, -29 removed lines

@@ -29,36 +29,36 @@
  * @since 8.0.0
  */
 class DataDownloadResponse extends DownloadResponse {
-	/**
-	 * @var string
-	 */
-	private $data;
+    /**
+     * @var string
+     */
+    private $data;
 
-	/**
-	 * Creates a response that prompts the user to download the text
-	 * @param string $data text to be downloaded
-	 * @param string $filename the name that the downloaded file should have
-	 * @param string $contentType the mimetype that the downloaded file should have
-	 * @since 8.0.0
-	 */
-	public function __construct($data, $filename, $contentType) {
-		$this->data = $data;
-		parent::__construct($filename, $contentType);
-	}
+    /**
+     * Creates a response that prompts the user to download the text
+     * @param string $data text to be downloaded
+     * @param string $filename the name that the downloaded file should have
+     * @param string $contentType the mimetype that the downloaded file should have
+     * @since 8.0.0
+     */
+    public function __construct($data, $filename, $contentType) {
+        $this->data = $data;
+        parent::__construct($filename, $contentType);
+    }
 
-	/**
-	 * @param string $data
-	 * @since 8.0.0
-	 */
-	public function setData($data) {
-		$this->data = $data;
-	}
+    /**
+     * @param string $data
+     * @since 8.0.0
+     */
+    public function setData($data) {
+        $this->data = $data;
+    }
 
-	/**
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function render() {
-		return $this->data;
-	}
+    /**
+     * @return string
+     * @since 8.0.0
+     */
+    public function render() {
+        return $this->data;
+    }
 }

lib/public/AppFramework/Http/FileDisplayResponse.php

Indentation +31 added lines, -31 removed lines

@@ -32,38 +32,38 @@
  */
 class FileDisplayResponse extends Response implements ICallbackResponse {
 
-	/** @var \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile */
-	private $file;
+    /** @var \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile */
+    private $file;
 
-	/**
-	 * FileDisplayResponse constructor.
-	 *
-	 * @param \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile $file
-	 * @param int $statusCode
-	 * @param array $headers
-	 * @since 11.0.0
-	 */
-	public function __construct($file, $statusCode=Http::STATUS_OK,
-								$headers=[]) {
-		$this->file = $file;
-		$this->setStatus($statusCode);
-		$this->setHeaders(array_merge($this->getHeaders(), $headers));
-		$this->addHeader('Content-Disposition', 'inline; filename="' . rawurldecode($file->getName()) . '"');
+    /**
+     * FileDisplayResponse constructor.
+     *
+     * @param \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile $file
+     * @param int $statusCode
+     * @param array $headers
+     * @since 11.0.0
+     */
+    public function __construct($file, $statusCode=Http::STATUS_OK,
+                                $headers=[]) {
+        $this->file = $file;
+        $this->setStatus($statusCode);
+        $this->setHeaders(array_merge($this->getHeaders(), $headers));
+        $this->addHeader('Content-Disposition', 'inline; filename="' . rawurldecode($file->getName()) . '"');
 
-		$this->setETag($file->getEtag());
-		$lastModified = new \DateTime();
-		$lastModified->setTimestamp($file->getMTime());
-		$this->setLastModified($lastModified);
-	}
+        $this->setETag($file->getEtag());
+        $lastModified = new \DateTime();
+        $lastModified->setTimestamp($file->getMTime());
+        $this->setLastModified($lastModified);
+    }
 
-	/**
-	 * @param IOutput $output
-	 * @since 11.0.0
-	 */
-	public function callback(IOutput $output) {
-		if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
-			$output->setHeader('Content-Length: ' . $this->file->getSize());
-			$output->setOutput($this->file->getContent());
-		}
-	}
+    /**
+     * @param IOutput $output
+     * @since 11.0.0
+     */
+    public function callback(IOutput $output) {
+        if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
+            $output->setHeader('Content-Length: ' . $this->file->getSize());
+            $output->setOutput($this->file->getContent());
+        }
+    }
 }

Spacing +4 added lines, -4 removed lines

@@ -43,12 +43,12 @@ 
 	 * @param array $headers
 	 * @since 11.0.0
 	 */
-	public function __construct($file, $statusCode=Http::STATUS_OK,
-								$headers=[]) {
+	public function __construct($file, $statusCode = Http::STATUS_OK,
+								$headers = []) {
 		$this->file = $file;
 		$this->setStatus($statusCode);
 		$this->setHeaders(array_merge($this->getHeaders(), $headers));
-		$this->addHeader('Content-Disposition', 'inline; filename="' . rawurldecode($file->getName()) . '"');
+		$this->addHeader('Content-Disposition', 'inline; filename="'.rawurldecode($file->getName()).'"');
 
 		$this->setETag($file->getEtag());
 		$lastModified = new \DateTime();
@@ -62,7 +62,7 @@ 
 	 */
 	public function callback(IOutput $output) {
 		if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
-			$output->setHeader('Content-Length: ' . $this->file->getSize());
+			$output->setHeader('Content-Length: '.$this->file->getSize());
 			$output->setOutput($this->file->getContent());
 		}
 	}

lib/public/AppFramework/Http/NotFoundResponse.php

Indentation +14 added lines, -14 removed lines

@@ -32,19 +32,19 @@
  */
 class NotFoundResponse extends Response {
 
-	/**
-	 * @since 8.1.0
-	 */
-	public function __construct() {
-		$this->setStatus(404);
-	}
+    /**
+     * @since 8.1.0
+     */
+    public function __construct() {
+        $this->setStatus(404);
+    }
 
-	/**
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function render() {
-		$template = new Template('core', '404', 'guest');
-		return $template->fetchPage();
-	}
+    /**
+     * @return string
+     * @since 8.1.0
+     */
+    public function render() {
+        $template = new Template('core', '404', 'guest');
+        return $template->fetchPage();
+    }
 }

lib/public/AppFramework/Http/TemplateResponse.php

Spacing +9 added lines, -9 removed lines

@@ -70,8 +70,8 @@ 
 	 * @param string $renderAs how the page should be rendered, defaults to user
 	 * @since 6.0.0 - parameters $params and $renderAs were added in 7.0.0
 	 */
-	public function __construct($appName, $templateName, array $params=array(),
-	                            $renderAs='user') {
+	public function __construct($appName, $templateName, array $params = array(),
+	                            $renderAs = 'user') {
 		$this->templateName = $templateName;
 		$this->appName = $appName;
 		$this->params = $params;
@@ -86,7 +86,7 @@ 
 	 * @return TemplateResponse Reference to this object
 	 * @since 6.0.0 - return value was added in 7.0.0
 	 */
-	public function setParams(array $params){
+	public function setParams(array $params) {
 		$this->params = $params;
 
 		return $this;
@@ -98,7 +98,7 @@ 
 	 * @return array the params
 	 * @since 6.0.0
 	 */
-	public function getParams(){
+	public function getParams() {
 		return $this->params;
 	}
 
@@ -108,7 +108,7 @@ 
 	 * @return string the name of the used template
 	 * @since 6.0.0
 	 */
-	public function getTemplateName(){
+	public function getTemplateName() {
 		return $this->templateName;
 	}
 
@@ -122,7 +122,7 @@ 
 	 * @return TemplateResponse Reference to this object
 	 * @since 6.0.0 - return value was added in 7.0.0
 	 */
-	public function renderAs($renderAs){
+	public function renderAs($renderAs) {
 		$this->renderAs = $renderAs;
 
 		return $this;
@@ -134,7 +134,7 @@ 
 	 * @return string the renderAs value
 	 * @since 6.0.0
 	 */
-	public function getRenderAs(){
+	public function getRenderAs() {
 		return $this->renderAs;
 	}
 
@@ -144,13 +144,13 @@ 
 	 * @return string the rendered html
 	 * @since 6.0.0
 	 */
-	public function render(){
+	public function render() {
 		// \OCP\Template needs an empty string instead of 'blank' for an unwrapped response
 		$renderAs = $this->renderAs === 'blank' ? '' : $this->renderAs;
 
 		$template = new \OCP\Template($this->appName, $this->templateName, $renderAs);
 
-		foreach($this->params as $key => $value){
+		foreach ($this->params as $key => $value) {
 			$template->assign($key, $value);
 		}
 

Indentation +119 added lines, -119 removed lines

@@ -37,124 +37,124 @@
  */
 class TemplateResponse extends Response {
 
-	/**
-	 * name of the template
-	 * @var string
-	 */
-	protected $templateName;
-
-	/**
-	 * parameters
-	 * @var array
-	 */
-	protected $params;
-
-	/**
-	 * rendering type (admin, user, blank)
-	 * @var string
-	 */
-	protected $renderAs;
-
-	/**
-	 * app name
-	 * @var string
-	 */
-	protected $appName;
-
-	/**
-	 * constructor of TemplateResponse
-	 * @param string $appName the name of the app to load the template from
-	 * @param string $templateName the name of the template
-	 * @param array $params an array of parameters which should be passed to the
-	 * template
-	 * @param string $renderAs how the page should be rendered, defaults to user
-	 * @since 6.0.0 - parameters $params and $renderAs were added in 7.0.0
-	 */
-	public function __construct($appName, $templateName, array $params=array(),
-	                            $renderAs='user') {
-		$this->templateName = $templateName;
-		$this->appName = $appName;
-		$this->params = $params;
-		$this->renderAs = $renderAs;
-	}
-
-
-	/**
-	 * Sets template parameters
-	 * @param array $params an array with key => value structure which sets template
-	 *                      variables
-	 * @return TemplateResponse Reference to this object
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function setParams(array $params){
-		$this->params = $params;
-
-		return $this;
-	}
-
-
-	/**
-	 * Used for accessing the set parameters
-	 * @return array the params
-	 * @since 6.0.0
-	 */
-	public function getParams(){
-		return $this->params;
-	}
-
-
-	/**
-	 * Used for accessing the name of the set template
-	 * @return string the name of the used template
-	 * @since 6.0.0
-	 */
-	public function getTemplateName(){
-		return $this->templateName;
-	}
-
-
-	/**
-	 * Sets the template page
-	 * @param string $renderAs admin, user or blank. Admin also prints the admin
-	 *                         settings header and footer, user renders the normal
-	 *                         normal page including footer and header and blank
-	 *                         just renders the plain template
-	 * @return TemplateResponse Reference to this object
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function renderAs($renderAs){
-		$this->renderAs = $renderAs;
-
-		return $this;
-	}
-
-
-	/**
-	 * Returns the set renderAs
-	 * @return string the renderAs value
-	 * @since 6.0.0
-	 */
-	public function getRenderAs(){
-		return $this->renderAs;
-	}
-
-
-	/**
-	 * Returns the rendered html
-	 * @return string the rendered html
-	 * @since 6.0.0
-	 */
-	public function render(){
-		// \OCP\Template needs an empty string instead of 'blank' for an unwrapped response
-		$renderAs = $this->renderAs === 'blank' ? '' : $this->renderAs;
-
-		$template = new \OCP\Template($this->appName, $this->templateName, $renderAs);
-
-		foreach($this->params as $key => $value){
-			$template->assign($key, $value);
-		}
-
-		return $template->fetchPage($this->params);
-	}
+    /**
+     * name of the template
+     * @var string
+     */
+    protected $templateName;
+
+    /**
+     * parameters
+     * @var array
+     */
+    protected $params;
+
+    /**
+     * rendering type (admin, user, blank)
+     * @var string
+     */
+    protected $renderAs;
+
+    /**
+     * app name
+     * @var string
+     */
+    protected $appName;
+
+    /**
+     * constructor of TemplateResponse
+     * @param string $appName the name of the app to load the template from
+     * @param string $templateName the name of the template
+     * @param array $params an array of parameters which should be passed to the
+     * template
+     * @param string $renderAs how the page should be rendered, defaults to user
+     * @since 6.0.0 - parameters $params and $renderAs were added in 7.0.0
+     */
+    public function __construct($appName, $templateName, array $params=array(),
+                                $renderAs='user') {
+        $this->templateName = $templateName;
+        $this->appName = $appName;
+        $this->params = $params;
+        $this->renderAs = $renderAs;
+    }
+
+
+    /**
+     * Sets template parameters
+     * @param array $params an array with key => value structure which sets template
+     *                      variables
+     * @return TemplateResponse Reference to this object
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function setParams(array $params){
+        $this->params = $params;
+
+        return $this;
+    }
+
+
+    /**
+     * Used for accessing the set parameters
+     * @return array the params
+     * @since 6.0.0
+     */
+    public function getParams(){
+        return $this->params;
+    }
+
+
+    /**
+     * Used for accessing the name of the set template
+     * @return string the name of the used template
+     * @since 6.0.0
+     */
+    public function getTemplateName(){
+        return $this->templateName;
+    }
+
+
+    /**
+     * Sets the template page
+     * @param string $renderAs admin, user or blank. Admin also prints the admin
+     *                         settings header and footer, user renders the normal
+     *                         normal page including footer and header and blank
+     *                         just renders the plain template
+     * @return TemplateResponse Reference to this object
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function renderAs($renderAs){
+        $this->renderAs = $renderAs;
+
+        return $this;
+    }
+
+
+    /**
+     * Returns the set renderAs
+     * @return string the renderAs value
+     * @since 6.0.0
+     */
+    public function getRenderAs(){
+        return $this->renderAs;
+    }
+
+
+    /**
+     * Returns the rendered html
+     * @return string the rendered html
+     * @since 6.0.0
+     */
+    public function render(){
+        // \OCP\Template needs an empty string instead of 'blank' for an unwrapped response
+        $renderAs = $this->renderAs === 'blank' ? '' : $this->renderAs;
+
+        $template = new \OCP\Template($this->appName, $this->templateName, $renderAs);
+
+        foreach($this->params as $key => $value){
+            $template->assign($key, $value);
+        }
+
+        return $template->fetchPage($this->params);
+    }
 
 }