2013-08-17 09:16:48 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2016-07-21 15:07:57 +00:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
2015-06-25 09:43:55 +00:00
|
|
|
* @author Andreas Fischer <bantu@owncloud.com>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Bernhard Posselt <dev@bernhard-posselt.com>
|
2016-05-26 17:56:05 +00:00
|
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
2013-08-17 09:16:48 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* @license AGPL-3.0
|
2013-08-17 09:16:48 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00: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 09:16:48 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2013-08-17 09:16:48 +00:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-03-26 10:44:34 +00:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2013-08-17 09:16:48 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00: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 09:16:48 +00:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
|
|
|
|
2013-08-17 09:16:48 +00:00
|
|
|
namespace OC\AppFramework;
|
|
|
|
|
2015-09-02 14:49:34 +00:00
|
|
|
use OC\AppFramework\Http\Dispatcher;
|
2015-01-22 19:26:46 +00:00
|
|
|
use OC_App;
|
|
|
|
use OC\AppFramework\DependencyInjection\DIContainer;
|
2016-08-31 21:07:48 +00:00
|
|
|
use OCP\AppFramework\Http;
|
2015-01-22 19:26:46 +00:00
|
|
|
use OCP\AppFramework\QueryException;
|
|
|
|
use OCP\AppFramework\Http\ICallbackResponse;
|
2013-08-17 09:16:48 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Entry point for every request in your app. You can consider this as your
|
|
|
|
* public static void main() method
|
|
|
|
*
|
|
|
|
* Handles all the dependency injection, controllers and output flow
|
|
|
|
*/
|
|
|
|
class App {
|
|
|
|
|
2016-09-02 07:03:09 +00:00
|
|
|
/** @var string[] */
|
|
|
|
private static $nameSpaceCache = [];
|
2013-08-17 09:16:48 +00:00
|
|
|
|
2014-12-13 18:28:20 +00:00
|
|
|
/**
|
|
|
|
* Turns an app id into a namespace by either reading the appinfo.xml's
|
|
|
|
* namespace tag or uppercasing the appid's first letter
|
|
|
|
* @param string $appId the app id
|
|
|
|
* @param string $topNamespace the namespace which should be prepended to
|
|
|
|
* the transformed app id, defaults to OCA\
|
|
|
|
* @return string the starting namespace for the app
|
|
|
|
*/
|
|
|
|
public static function buildAppNamespace($appId, $topNamespace='OCA\\') {
|
2016-09-02 07:03:09 +00:00
|
|
|
// Hit the cache!
|
|
|
|
if (isset(self::$nameSpaceCache[$appId])) {
|
|
|
|
return $topNamespace . self::$nameSpaceCache[$appId];
|
|
|
|
}
|
|
|
|
|
2016-09-23 19:47:47 +00:00
|
|
|
$appInfo = \OC_App::getAppInfo($appId);
|
|
|
|
if (isset($appInfo['namespace'])) {
|
|
|
|
return $topNamespace . trim($appInfo['namespace']);
|
2014-12-13 18:28:20 +00:00
|
|
|
}
|
2016-09-23 19:47:47 +00:00
|
|
|
|
2014-12-13 18:28:20 +00:00
|
|
|
// if the tag is not found, fall back to uppercasing the first letter
|
2016-09-02 07:03:09 +00:00
|
|
|
self::$nameSpaceCache[$appId] = ucfirst($appId);
|
|
|
|
return $topNamespace . self::$nameSpaceCache[$appId];
|
2014-12-13 18:28:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2013-08-17 09:16:48 +00:00
|
|
|
/**
|
|
|
|
* Shortcut for calling a controller method and printing the result
|
|
|
|
* @param string $controllerName the name of the controller under which it is
|
|
|
|
* stored in the DI container
|
|
|
|
* @param string $methodName the method that you want to call
|
|
|
|
* @param DIContainer $container an instance of a pimple container.
|
2013-11-27 09:55:06 +00:00
|
|
|
* @param array $urlParams list of URL parameters (optional)
|
2013-08-17 09:16:48 +00:00
|
|
|
*/
|
2013-11-25 10:36:33 +00:00
|
|
|
public static function main($controllerName, $methodName, DIContainer $container, array $urlParams = null) {
|
|
|
|
if (!is_null($urlParams)) {
|
2015-01-15 13:19:56 +00:00
|
|
|
$container['OCP\\IRequest']->setUrlParameters($urlParams);
|
|
|
|
} else if (isset($container['urlParams']) && !is_null($container['urlParams'])) {
|
|
|
|
$container['OCP\\IRequest']->setUrlParameters($container['urlParams']);
|
2013-11-25 10:36:33 +00:00
|
|
|
}
|
2014-12-13 18:28:20 +00:00
|
|
|
$appName = $container['AppName'];
|
|
|
|
|
|
|
|
// first try $controllerName then go for \OCA\AppName\Controller\$controllerName
|
|
|
|
try {
|
|
|
|
$controller = $container->query($controllerName);
|
|
|
|
} catch(QueryException $e) {
|
2016-08-08 18:38:10 +00:00
|
|
|
if ($appName === 'core') {
|
|
|
|
$appNameSpace = 'OC\\Core';
|
|
|
|
} else if ($appName === 'settings') {
|
|
|
|
$appNameSpace = 'OC\\Settings';
|
|
|
|
} else {
|
|
|
|
$appNameSpace = self::buildAppNamespace($appName);
|
|
|
|
}
|
2014-12-13 18:28:20 +00:00
|
|
|
$controllerName = $appNameSpace . '\\Controller\\' . $controllerName;
|
|
|
|
$controller = $container->query($controllerName);
|
|
|
|
}
|
2013-08-17 09:16:48 +00:00
|
|
|
|
|
|
|
// initialize the dispatcher and run all the middleware before the controller
|
2015-09-02 14:49:34 +00:00
|
|
|
/** @var Dispatcher $dispatcher */
|
2013-08-17 09:16:48 +00:00
|
|
|
$dispatcher = $container['Dispatcher'];
|
|
|
|
|
2015-01-22 19:26:46 +00:00
|
|
|
list(
|
|
|
|
$httpHeaders,
|
|
|
|
$responseHeaders,
|
|
|
|
$responseCookies,
|
|
|
|
$output,
|
|
|
|
$response
|
|
|
|
) = $dispatcher->dispatch($controller, $methodName);
|
|
|
|
|
|
|
|
$io = $container['OCP\\AppFramework\\Http\\IOutput'];
|
2013-08-17 09:16:48 +00:00
|
|
|
|
|
|
|
if(!is_null($httpHeaders)) {
|
2015-01-22 19:26:46 +00:00
|
|
|
$io->setHeader($httpHeaders);
|
2013-08-17 09:16:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
foreach($responseHeaders as $name => $value) {
|
2015-01-22 19:26:46 +00:00
|
|
|
$io->setHeader($name . ': ' . $value);
|
2013-08-17 09:16:48 +00:00
|
|
|
}
|
|
|
|
|
2014-11-27 13:19:00 +00:00
|
|
|
foreach($responseCookies as $name => $value) {
|
|
|
|
$expireDate = null;
|
|
|
|
if($value['expireDate'] instanceof \DateTime) {
|
|
|
|
$expireDate = $value['expireDate']->getTimestamp();
|
|
|
|
}
|
2015-01-22 19:26:46 +00:00
|
|
|
$io->setCookie(
|
|
|
|
$name,
|
|
|
|
$value['value'],
|
|
|
|
$expireDate,
|
|
|
|
$container->getServer()->getWebRoot(),
|
|
|
|
null,
|
2015-01-19 10:56:04 +00:00
|
|
|
$container->getServer()->getRequest()->getServerProtocol() === 'https',
|
2015-01-22 19:26:46 +00:00
|
|
|
true
|
|
|
|
);
|
2014-11-27 13:19:00 +00:00
|
|
|
}
|
|
|
|
|
2016-08-31 21:07:48 +00:00
|
|
|
/*
|
|
|
|
* Status 204 does not have a body and no Content Length
|
|
|
|
* Status 304 does not have a body and does not need a Content Length
|
|
|
|
* https://tools.ietf.org/html/rfc7230#section-3.3
|
|
|
|
* https://tools.ietf.org/html/rfc7230#section-3.3.2
|
|
|
|
*/
|
|
|
|
if ($httpHeaders !== Http::STATUS_NO_CONTENT && $httpHeaders !== Http::STATUS_NOT_MODIFIED) {
|
|
|
|
if ($response instanceof ICallbackResponse) {
|
|
|
|
$response->callback($io);
|
|
|
|
} else if (!is_null($output)) {
|
|
|
|
$io->setHeader('Content-Length: ' . strlen($output));
|
|
|
|
$io->setOutput($output);
|
|
|
|
}
|
2013-08-17 09:16:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Shortcut for calling a controller method and printing the result.
|
|
|
|
* Similar to App:main except that no headers will be sent.
|
|
|
|
* This should be used for example when registering sections via
|
|
|
|
* \OC\AppFramework\Core\API::registerAdmin()
|
|
|
|
*
|
|
|
|
* @param string $controllerName the name of the controller under which it is
|
|
|
|
* stored in the DI container
|
|
|
|
* @param string $methodName the method that you want to call
|
|
|
|
* @param array $urlParams an array with variables extracted from the routes
|
|
|
|
* @param DIContainer $container an instance of a pimple container.
|
|
|
|
*/
|
|
|
|
public static function part($controllerName, $methodName, array $urlParams,
|
|
|
|
DIContainer $container){
|
|
|
|
|
|
|
|
$container['urlParams'] = $urlParams;
|
|
|
|
$controller = $container[$controllerName];
|
|
|
|
|
|
|
|
$dispatcher = $container['Dispatcher'];
|
|
|
|
|
|
|
|
list(, , $output) = $dispatcher->dispatch($controller, $methodName);
|
|
|
|
return $output;
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|