You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
403 lines
9.0 KiB
403 lines
9.0 KiB
<?php |
|
/** |
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
|
* |
|
* @author Bernhard Posselt <dev@bernhard-posselt.com> |
|
* @author Christoph Wurst <christoph@owncloud.com> |
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de> |
|
* @author Lukas Reschke <lukas@statuscode.ch> |
|
* @author Morris Jobke <hey@morrisjobke.de> |
|
* @author Roeland Jago Douma <roeland@famdouma.nl> |
|
* @author Thomas Müller <thomas.mueller@tmit.eu> |
|
* @author Thomas Tanghus <thomas@tanghus.net> |
|
* |
|
* @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 <http://www.gnu.org/licenses/> |
|
* |
|
*/ |
|
|
|
/** |
|
* Public interface of ownCloud for apps to use. |
|
* AppFramework\HTTP\Response class |
|
*/ |
|
|
|
namespace OCP\AppFramework\Http; |
|
|
|
use OCP\AppFramework\Http; |
|
use OCP\AppFramework\Utility\ITimeFactory; |
|
|
|
/** |
|
* Base class for responses. Also used to just send headers. |
|
* |
|
* It handles headers, HTTP status code, last modified and ETag. |
|
* @since 6.0.0 |
|
*/ |
|
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 FeaturePolicy */ |
|
private $featurePolicy; |
|
|
|
/** @var bool */ |
|
private $throttled = false; |
|
/** @var array */ |
|
private $throttleMetadata = []; |
|
|
|
/** |
|
* @since 17.0.0 |
|
*/ |
|
public function __construct() { |
|
} |
|
|
|
/** |
|
* 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(int $cacheSeconds) { |
|
if($cacheSeconds > 0) { |
|
$this->addHeader('Cache-Control', 'max-age=' . $cacheSeconds . ', must-revalidate'); |
|
|
|
// Old scool prama caching |
|
$this->addHeader('Pragma', 'public'); |
|
|
|
// Set expires header |
|
$expires = new \DateTime(); |
|
/** @var ITimeFactory $time */ |
|
$time = \OC::$server->query(ITimeFactory::class); |
|
$expires->setTimestamp($time->getTime()); |
|
$expires->add(new \DateInterval('PT'.$cacheSeconds.'S')); |
|
$this->addHeader('Expires', $expires->format(\DateTime::RFC2822)); |
|
} else { |
|
$this->addHeader('Cache-Control', 'no-cache, no-store, must-revalidate'); |
|
unset($this->headers['Expires'], $this->headers['Pragma']); |
|
} |
|
|
|
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); |
|
} |
|
|
|
$this->headers['Content-Security-Policy'] = $this->getContentSecurityPolicy()->buildPolicy(); |
|
$this->headers['Feature-Policy'] = $this->getFeaturePolicy()->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() { |
|
if ($this->contentSecurityPolicy === null) { |
|
$this->setContentSecurityPolicy(new EmptyContentSecurityPolicy()); |
|
} |
|
return $this->contentSecurityPolicy; |
|
} |
|
|
|
|
|
/** |
|
* @since 17.0.0 |
|
*/ |
|
public function getFeaturePolicy(): EmptyFeaturePolicy { |
|
if ($this->featurePolicy === null) { |
|
$this->setFeaturePolicy(new EmptyFeaturePolicy()); |
|
} |
|
return $this->featurePolicy; |
|
} |
|
|
|
/** |
|
* @since 17.0.0 |
|
*/ |
|
public function setFeaturePolicy(EmptyFeaturePolicy $featurePolicy): self { |
|
$this->featurePolicy = $featurePolicy; |
|
|
|
return $this; |
|
} |
|
|
|
|
|
|
|
/** |
|
* 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; |
|
} |
|
}
|
|
|