owncloud/core

<?php
/**
 * @author Bernhard Posselt <dev@bernhard-posselt.com>
 * @author Lukas Reschke <lukas@statuscode.ch>
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @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/>
 *
 */

namespace OC\AppFramework;

use OC\AppFramework\Http\Dispatcher;
use OC\AppFramework\DependencyInjection\DIContainer;
use OCP\AppFramework\QueryException;
use OCP\AppFramework\Http\ICallbackResponse;

/**
 * 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 {
    /**
     * 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\\') {
        // first try to parse the app's appinfo/info.xml <namespace> tag
        $appInfo = \OC_App::getAppInfo($appId);
        if (isset($appInfo['namespace'])) {
            return $topNamespace . \trim($appInfo['namespace']);
        }

        // if the tag is not found, fall back to uppercasing the first letter
        return $topNamespace . \ucfirst($appId);
    }

    /**
     * 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.
     * @param array $urlParams list of URL parameters (optional)
     */
    public static function main($controllerName, $methodName, DIContainer $container, array $urlParams = null) {
        if ($urlParams !== null) {
            $container['OCP\\IRequest']->setUrlParameters($urlParams);
        } elseif (isset($container['urlParams']) && $container['urlParams'] !== null) {
            $container['OCP\\IRequest']->setUrlParameters($container['urlParams']);
        }
        $appName = $container['AppName'];

        // first try $controllerName then go for \OCA\AppName\Controller\$controllerName
        try {
            $controller = $container->query($controllerName);
        } catch (QueryException $e) {
            $appNameSpace = self::buildAppNamespace($appName);
            $controllerName = $appNameSpace . '\\Controller\\' . $controllerName;
            try {
                $controller = $container->query($controllerName);
            } catch (QueryException $e2) {
                // the reason we got here could also be because of the first exception above,
                // so combine the message from both
                throw new QueryException($e2->getMessage() . ' or error resolving constructor arguments: ' . $e->getMessage());
            }
        }

        // initialize the dispatcher and run all the middleware before the controller
        /** @var Dispatcher $dispatcher */
        $dispatcher = $container['Dispatcher'];

        list(
            $httpHeaders,
            $responseHeaders,
            $responseCookies,
            $output,
            $response
        ) = $dispatcher->dispatch($controller, $methodName);

        $io = $container['OCP\\AppFramework\\Http\\IOutput'];

        if ($httpHeaders !== null) {
            $io->setHeader($httpHeaders);
        }

        foreach ($responseHeaders as $name => $value) {
            $io->setHeader($name . ': ' . $value);
        }

        foreach ($responseCookies as $name => $value) {
            $expireDate = null;
            if ($value['expireDate'] instanceof \DateTime) {
                $expireDate = $value['expireDate']->getTimestamp();
            }
            $io->setCookie(
                $name,
                $value['value'],
                $expireDate,
                $container->getServer()->getWebRoot(),
                null,
                $container->getServer()->getRequest()->getServerProtocol() === 'https',
                true
            );
        }

        if ($response instanceof ICallbackResponse) {
            $response->callback($io);
        } elseif ($output !== null) {
            $io->setHeader('Content-Length: ' . \strlen($output));
            $io->setOutput($output);
        }
    }

    /**
     * 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;
    }
}