nextcloud/lib/public/AppFramework/Controller.php

266 lines
7.2 KiB
PHP
Raw Normal View History

2013-08-17 13:16:48 +04:00
<?php
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2015-03-26 13:44:34 +03:00
* @author Bernhard Posselt <dev@bernhard-posselt.com>
2016-05-26 20:56:05 +03:00
* @author Lukas Reschke <lukas@statuscode.ch>
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Thomas Tanghus <thomas@tanghus.net>
2015-10-26 15:54:55 +03:00
* @author Vincent Petry <pvince81@owncloud.com>
2013-08-17 13:16:48 +04:00
*
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
2013-08-17 13:16:48 +04:00
*
2015-03-26 13:44:34 +03:00
* 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.
2013-08-17 13:16:48 +04:00
*
2015-03-26 13:44:34 +03:00
* This program is distributed in the hope that it will be useful,
2013-08-17 13:16:48 +04:00
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
2013-08-17 13:16:48 +04:00
*
2015-03-26 13:44:34 +03:00
* 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/>
2013-08-17 13:16:48 +04:00
*
*/
/**
* Public interface of ownCloud for apps to use.
* AppFramework\Controller class
*/
namespace OCP\AppFramework;
2013-08-17 13:16:48 +04:00
2013-08-21 03:00:26 +04:00
use OCP\AppFramework\Http\TemplateResponse;
use OCP\AppFramework\Http\JSONResponse;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\Response;
2013-10-07 01:16:40 +04:00
use OCP\IRequest;
2013-08-17 13:16:48 +04:00
/**
* Base class to inherit your controllers from
* @since 6.0.0
2013-08-17 13:16:48 +04:00
*/
abstract class Controller {
/**
* app name
* @var string
* @since 7.0.0
2013-08-17 13:16:48 +04:00
*/
protected $appName;
2013-08-17 13:16:48 +04:00
2013-10-07 01:16:40 +04:00
/**
* current request
2013-10-07 01:16:40 +04:00
* @var \OCP\IRequest
* @since 6.0.0
2013-10-07 01:16:40 +04:00
*/
2013-08-17 13:16:48 +04:00
protected $request;
/**
* @var array
* @since 7.0.0
*/
private $responders;
2013-08-17 13:16:48 +04:00
/**
* constructor of the controller
* @param string $appName the name of the app
2013-10-07 01:16:40 +04:00
* @param IRequest $request an instance of the request
* @since 6.0.0 - parameter $appName was added in 7.0.0 - parameter $app was removed in 7.0.0
2013-08-17 13:16:48 +04:00
*/
2014-05-29 21:14:47 +04:00
public function __construct($appName,
Add public API to give developers the possibility to adjust the global CSP defaults Allows to inject something into the default content policy. This is for example useful when you're injecting Javascript code into a view belonging to another controller and cannot modify its Content-Security-Policy itself. Note that the adjustment is only applied to applications that use AppFramework controllers. To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`, $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`. To test this add something like the following into an `app.php` of any enabled app: ``` $manager = \OC::$server->getContentSecurityPolicyManager(); $policy = new \OCP\AppFramework\Http\ContentSecurityPolicy(false); $policy->addAllowedFrameDomain('asdf'); $policy->addAllowedScriptDomain('yolo.com'); $policy->allowInlineScript(false); $manager->addDefaultPolicy($policy); $policy = new \OCP\AppFramework\Http\ContentSecurityPolicy(false); $policy->addAllowedFontDomain('yolo.com'); $manager->addDefaultPolicy($policy); $policy = new \OCP\AppFramework\Http\ContentSecurityPolicy(false); $policy->addAllowedFrameDomain('banana.com'); $manager->addDefaultPolicy($policy); ``` If you now open the files app the policy should be: ``` Content-Security-Policy:default-src 'none';script-src yolo.com 'self' 'unsafe-eval';style-src 'self' 'unsafe-inline';img-src 'self' data: blob:;font-src yolo.com 'self';connect-src 'self';media-src 'self';frame-src asdf banana.com 'self' ```
2016-01-28 16:33:02 +03:00
IRequest $request) {
$this->appName = $appName;
2013-08-17 13:16:48 +04:00
$this->request = $request;
// default responders
$this->responders = array(
'json' => function ($data) {
if ($data instanceof DataResponse) {
$response = new JSONResponse(
$data->getData(),
$data->getStatus()
);
$dataHeaders = $data->getHeaders();
$headers = $response->getHeaders();
// do not overwrite Content-Type if it already exists
if (isset($dataHeaders['Content-Type'])) {
unset($headers['Content-Type']);
}
$response->setHeaders(array_merge($dataHeaders, $headers));
return $response;
} else {
return new JSONResponse($data);
}
}
);
}
2014-06-11 03:20:09 +04:00
/**
* Parses an HTTP accept header and returns the supported responder type
* @param string $acceptHeader
* @return string the responder type
* @since 7.0.0
* @since 9.1.0 Added default parameter
2014-06-11 03:20:09 +04:00
*/
public function getResponderByHTTPHeader($acceptHeader, $default='json') {
2014-06-11 03:20:09 +04:00
$headers = explode(',', $acceptHeader);
// return the first matching responder
foreach ($headers as $header) {
$header = strtolower(trim($header));
$responder = str_replace('application/', '', $header);
if (array_key_exists($responder, $this->responders)) {
return $responder;
}
}
// no matching header return default
return $default;
2014-06-11 03:20:09 +04:00
}
/**
* Registers a formatter for a type
* @param string $format
* @param \Closure $responder
* @since 7.0.0
*/
protected function registerResponder($format, \Closure $responder) {
$this->responders[$format] = $responder;
}
/**
* Serializes and formats a response
* @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 7.0.0
*/
public function buildResponse($response, $format='json') {
if(array_key_exists($format, $this->responders)) {
$responder = $this->responders[$format];
2014-05-29 21:14:47 +04:00
return $responder($response);
} else {
2014-05-29 21:14:47 +04:00
throw new \DomainException('No responder registered for format ' .
$format . '!');
}
2013-08-17 13:16:48 +04:00
}
/**
* Lets you access post and get parameters by the index
2015-04-19 02:04:59 +03:00
* @deprecated 7.0.0 write your parameters as method arguments instead
2013-08-17 13:16:48 +04:00
* @param string $key the key which you want to access in the URL Parameter
* placeholder, $_POST or $_GET array.
* The priority how they're returned is the following:
* 1. URL parameters
* 2. POST parameters
* 3. GET parameters
* @param string $default If the key is not found, this value will be returned
2013-08-17 13:16:48 +04:00
* @return mixed the content of the array
* @since 6.0.0
2013-08-17 13:16:48 +04:00
*/
public function params($key, $default=null){
2013-08-20 23:05:55 +04:00
return $this->request->getParam($key, $default);
2013-08-17 13:16:48 +04:00
}
/**
* Returns all params that were received, be it from the request
* (as GET or POST) or through the URL by the route
2015-04-19 02:04:59 +03:00
* @deprecated 7.0.0 use $this->request instead
2013-08-17 13:16:48 +04:00
* @return array the array with all parameters
* @since 6.0.0
2013-08-17 13:16:48 +04:00
*/
public function getParams() {
2013-08-20 23:05:55 +04:00
return $this->request->getParams();
2013-08-17 13:16:48 +04:00
}
/**
* Returns the method of the request
2015-04-19 02:04:59 +03:00
* @deprecated 7.0.0 use $this->request instead
2013-08-17 13:16:48 +04:00
* @return string the method of the request (POST, GET, etc)
* @since 6.0.0
2013-08-17 13:16:48 +04:00
*/
public function method() {
2013-08-20 23:05:55 +04:00
return $this->request->getMethod();
2013-08-17 13:16:48 +04:00
}
/**
* Shortcut for accessing an uploaded file through the $_FILES array
2015-04-19 02:04:59 +03:00
* @deprecated 7.0.0 use $this->request instead
2013-08-17 13:16:48 +04:00
* @param string $key the key that will be taken from the $_FILES array
* @return array the file in the $_FILES element
* @since 6.0.0
2013-08-17 13:16:48 +04:00
*/
public function getUploadedFile($key) {
2013-08-20 23:05:55 +04:00
return $this->request->getUploadedFile($key);
2013-08-17 13:16:48 +04:00
}
/**
* Shortcut for getting env variables
2015-04-19 02:04:59 +03:00
* @deprecated 7.0.0 use $this->request instead
2013-08-17 13:16:48 +04:00
* @param string $key the key that will be taken from the $_ENV array
* @return array the value in the $_ENV element
* @since 6.0.0
2013-08-17 13:16:48 +04:00
*/
public function env($key) {
2013-08-20 23:05:55 +04:00
return $this->request->getEnv($key);
2013-08-17 13:16:48 +04:00
}
/**
* Shortcut for getting cookie variables
2015-04-19 02:04:59 +03:00
* @deprecated 7.0.0 use $this->request instead
2013-08-17 13:16:48 +04:00
* @param string $key the key that will be taken from the $_COOKIE array
* @return array the value in the $_COOKIE element
* @since 6.0.0
2013-08-17 13:16:48 +04:00
*/
public function cookie($key) {
2013-08-20 23:05:55 +04:00
return $this->request->getCookie($key);
2013-08-17 13:16:48 +04:00
}
/**
* Shortcut for rendering a template
2015-04-19 02:04:59 +03:00
* @deprecated 7.0.0 return a template response instead
2013-08-17 13:16:48 +04:00
* @param string $templateName the name of the template
* @param array $params the template parameters in key => value structure
* @param string $renderAs user renders a full page, blank only your template
* admin an entry in the admin settings
* @param string[] $headers set additional headers in name/value pairs
2013-08-21 03:00:26 +04:00
* @return \OCP\AppFramework\Http\TemplateResponse containing the page
* @since 6.0.0
2013-08-17 13:16:48 +04:00
*/
public function render($templateName, array $params=array(),
$renderAs='user', array $headers=array()){
$response = new TemplateResponse($this->appName, $templateName);
2013-08-17 13:16:48 +04:00
$response->setParams($params);
$response->renderAs($renderAs);
foreach($headers as $name => $value){
$response->addHeader($name, $value);
}
return $response;
}
}