caoym / phpboot

src/Application.php

<?php
namespace PhpBoot;

use DI\Container;
use DI\FactoryInterface;
use Doctrine\Common\Cache\ApcCache;
use Doctrine\Common\Cache\Cache;
use Doctrine\Common\Cache\FilesystemCache;
use FastRoute\DataGenerator\GroupCountBased as GroupCountBasedDataGenerator;
use FastRoute\Dispatcher\GroupCountBased as GroupCountBasedDispatcher;
use FastRoute\Dispatcher;
use FastRoute\RouteCollector;
use FastRoute\RouteParser\Std;
use Invoker\Exception\InvocationException;
use Invoker\Exception\NotCallableException;
use Invoker\Exception\NotEnoughParametersException;
use PhpBoot\Controller\ControllerContainerBuilder;
use PhpBoot\Cache\CheckableCache;
use PhpBoot\Cache\ClassModifiedChecker;
use PhpBoot\Controller\ControllerContainer;
use PhpBoot\Controller\ExceptionRenderer;
use PhpBoot\Controller\HookInterface;
use PhpBoot\Controller\Route;
use PhpBoot\DB\DB;
use PhpBoot\DI\DIContainerBuilder;
use PhpBoot\DI\Traits\EnableDIAnnotations;
use PhpBoot\Lock\LocalAutoLock;
use PhpBoot\Utils\Logger;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\ContainerInterface;
use Psr\Container\NotFoundExceptionInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\ParameterBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

class Application implements ContainerInterface, FactoryInterface, \DI\InvokerInterface
{
    use EnableDIAnnotations;

    /**
     * @param string|array
     * .php file
     * ```
     * return
     * [
     *      'App.name'  => 'App', //The App's name, default is "App", use by \Monolog\Logger as the logging channel
     *      'App.uriPrefix' => '/',  // The prefix of api uri path, default is "/"
     *
     *       //DB.* are the params for PDO::__construct, @see http://php.net/manual/en/pdo.construct.php
     *      'DB.connection' => 'mysql:dbname=default;host=localhost',
     *      'DB.username' => 'root',
     *      'DB.password' => 'root',
     *      'DB.options' => [],
     *
     *
     *      LoggerInterface::class => \DI\object(\Monolog\Logger::class)
     *          ->constructor(\DI\get('App.name')),
     *      // 注意, 系统缓存, 只使用 apc、文件缓存等本地缓存, 不要使用 redis 等分布式缓存
     *      Cache::class => \DI\object(FilesystemCache::class)
     *          ->constructorParameter('directory', sys_get_temp_dir())
     * ];
     * ```
     * or just the array
     * @return self
     */
    static public function createByDefault($conf = [])
    {
        $builder = new DIContainerBuilder();

        $default = [

            'App.name' => 'App',
            'App.uriPrefix' => '/',

            'DB.connection' => 'mysql:dbname=default;host=localhost',
            'DB.username' => 'root',
            'DB.password' => 'root',
            'DB.options' => [],

            Application::class => \DI\object()
                ->method('setUriPrefix', \DI\get('App.uriPrefix')),

            DB::class => \DI\factory([DB::class, 'connect'])
                ->parameter('dsn', \DI\get('DB.connection'))
                ->parameter('username', \DI\get('DB.username'))
                ->parameter('password', \DI\get('DB.password'))
                ->parameter('options', \DI\get('DB.options')),

            LoggerInterface::class => \DI\object(\Monolog\Logger::class)
                ->constructor(\DI\get('App.name')),

            Request::class => \DI\factory([Application::class, 'createRequestFromGlobals']),
        ];
        if(function_exists('apc_fetch')){
            $default += [
                Cache::class => \DI\object(ApcCache::class)
            ];
        }else{
            $default += [
                Cache::class => \DI\object(FilesystemCache::class)
                    ->constructorParameter('directory', sys_get_temp_dir())
            ];
        }


        $builder->addDefinitions($default);
        $builder->addDefinitions($conf);

        $container = $builder->build();

        Logger::setDefaultLogger($container->get(LoggerInterface::class));

        $app = $container->make(self::class);
        return $app;
    }

    /**
     * @return Cache
     */
    public function getCache()
    {
        return $this->cache;
    }

    /**
     * @param Cache $localCache
     */
    public function setCache(Cache $localCache)
    {
        $this->cache = $localCache;
    }

    /**
     * load routes from class
     *
     * @param string $className
     * @param string[] $hooks hook class names
     * @return void
     */
    public function loadRoutesFromClass($className, $hooks=[])
    {
        $cache = new CheckableCache($this->cache);

        $key = 'loadRoutesFromClass:' . md5(__CLASS__ . ':' . $className);
        $routes = $cache->get($key, $this);

        $controller = null;
        if ($routes == $this) { //not cached
            $routes = [];
            $controller = $this->controllerContainerBuilder->build($className);
            foreach ($controller->getRoutes() as $actionName => $route) {
                $routes[] = [$route->getMethod(), $route->getUri(), $actionName];
            }
            $cache->set($key, $routes, 0, new ClassModifiedChecker($className));
        }
        foreach ($routes as $route) {
            list($method, $uri, $actionName) = $route;
            $this->routes[] = [
                $method,
                $uri,
                function (Application $app, Request $request) use ($cache, $className, $actionName, $controller) {

                    $key = 'loadRoutesFromClass:route:' . md5(__CLASS__ . ':' . $className . ':' . $actionName);

                    $routeInstance = $cache->get($key, $this);
                    if ($routeInstance == $this) {
                        if (!$controller) {
                            $controller = $app->controllerContainerBuilder->build($className);

Consider using a different name than the imported variable $controller, or did you forget to import by reference?

                        }
                        $routeInstance = $controller->getRoute($actionName) or
                        abort(new NotFoundHttpException("action $actionName not found"));
                        $cache->set($key, $routeInstance, 0, new ClassModifiedChecker($className));
                    }
                    return ControllerContainer::dispatch($this, $className, $actionName, $routeInstance, $request);
                },
                $hooks
            ];
        }
        $this->controllers[] = $className;
    }

    /**
     * load routes from path
     *
     * 被加载的文件必须以: 类名.php的形式命名
     * @param string $fromPath
     * @param string $namespace
     * @param string[] $hooks
     * @return void
     */
    public function loadRoutesFromPath($fromPath, $namespace = '', $hooks=[])
    {
        $dir = @dir($fromPath) or abort("dir $fromPath not exist");

        $getEach = function () use ($dir) {
            $name = $dir->read();
            if (!$name) {
                return $name;
            }
            return $name;
        };

        while (!!($entry = $getEach())) {
            if ($entry == '.' || $entry == '..') {
                continue;
            }
            $path = $fromPath . '/' . str_replace('\\', '/', $entry);
            if (is_file($path) && substr_compare($entry, '.php', strlen($entry) - 4, 4, true) == 0) {
                $class_name = $namespace . '\\' . substr($entry, 0, strlen($entry) - 4);
                $this->loadRoutesFromClass($class_name, $hooks);
            } else {
                //\Log::debug($path.' ignored');
            }
        }
    }

    /**
     * Add route
     * @param string $method
     * @param string $uri
     * @param callable $handler function(Application $app, Request $request):Response
     * @param string[] $hooks
     */
    public function addRoute($method, $uri, callable $handler, $hooks=[])
    {
        $this->routes[] = [$method, $uri, $handler, $hooks];
    }

    /**
     * @return ControllerContainer[]
     */
    public function getControllers()
    {
        $controllers = [];
        foreach ($this->controllers as $name) {
            $controllers[] = $this->controllerContainerBuilder->build($name);
        }
        return $controllers;
    }

    /**
     * @param Request|null $request
     * @param bool $send
     * @return Response
     */
    public function dispatch(Request $request = null, $send = true)
    {
        //  TODO 把 Route里的异常处理 ExceptionRenderer 移到这里更妥?
        $renderer = $this->get(ExceptionRenderer::class);
        try{
            if ($request == null) {
                $request = $this->make(Request::class);
            }
            $uri = $request->getRequestUri();
            if (false !== $pos = strpos($uri, '?')) {
                $uri = substr($uri, 0, $pos);
            }
            $uri = rawurldecode($uri);

            $next = function (Request $request)use($uri){
                $dispatcher = $this->getDispatcher();
                $res = $dispatcher->dispatch($request->getMethod(), $uri);
                if ($res[0] == Dispatcher::FOUND) {

                    if (count($res[2])) {
                        $request->attributes->add($res[2]);
                    }
                    list($handler, $hooks) = $res[1];
                    $next = function (Request $request)use($handler){
                        return $handler($this, $request);
                    };
                    foreach (array_reverse($hooks) as $hookName){
                        $next = function($request)use($hookName, $next){
                            $hook = $this->get($hookName);
                            /**@var $hook HookInterface*/
                            return $hook->handle($request, $next);
                        };
                    }
                    return $next($request);

                }elseif ($res[0] == Dispatcher::NOT_FOUND) {
                    \PhpBoot\abort(new NotFoundHttpException(), [$request->getMethod(), $uri]);
                } elseif ($res[0] == Dispatcher::METHOD_NOT_ALLOWED) {
                    \PhpBoot\abort(new MethodNotAllowedHttpException($res[1]), [$request->getMethod(), $uri]);
                } else {
                    \PhpBoot\abort("unknown dispatch return {$res[0]}");
                }
            };

            foreach (array_reverse($this->getGlobalHooks()) as $hookName){
                $next = function($request)use($hookName, $next){
                    $hook = $this->get($hookName);
                    /**@var $hook HookInterface*/
                    return $hook->handle($request, $next);
                };
            }
            $response = $next($request);

            /** @var Response $response */
            if ($send) {
                $response->send();
            }
            return $response;

        }catch (\Exception $e){
            $renderer->render($e);
        }

    }

    /**
     * @return GroupCountBasedDispatcher
     */
    private function getDispatcher()
    {
        $routeCollector = new RouteCollector(new Std(), new GroupCountBasedDataGenerator());
        foreach ($this->routes as $route) {
            list($method, $uri, $handler, $hooks) = $route;
            $uri = $this->getFullUri($uri);
            $routeCollector->addRoute($method, $uri, [$handler, $hooks]);
        }
        return new GroupCountBasedDispatcher($routeCollector->getData());
    }

    /**
     * Finds an entry of the container by its identifier and returns it.
     *
     * @param string $id Identifier of the entry to look for.
     *
     * @throws NotFoundExceptionInterface  No entry was found for **this** identifier.
     * @throws ContainerExceptionInterface Error while retrieving the entry.
     *
     * @return mixed Entry.
     */
    public function get($id)
    {
        return $this->container->get($id);
    }

    /**
     * Returns true if the container can return an entry for the given identifier.
     * Returns false otherwise.
     *
     * `has($id)` returning true does not mean that `get($id)` will not throw an exception.
     * It does however mean that `get($id)` will not throw a `NotFoundExceptionInterface`.
     *
     * @param string $id Identifier of the entry to look for.
     *
     * @return bool
     */
    public function has($id)
    {
        return $this->container->has($id);
    }

    /**
     * Call the given function using the given parameters.
     *
     * @param callable $callable Function to call.
     * @param array $parameters Parameters to use.
     *
     * @return mixed Result of the function.
     *
     * @throws InvocationException Base exception class for all the sub-exceptions below.
     * @throws NotCallableException
     * @throws NotEnoughParametersException
     */
    public function call($callable, array $parameters = array())
    {
        return $this->container->call($callable, $parameters);
    }

    public function make($name, array $parameters = [])
    {
        return $this->container->make($name, $parameters);
    }

    /**
     * @param \string[] $globalHooks
     */
    public function setGlobalHooks($globalHooks)
    {
        $this->globalHooks = $globalHooks;

It seems like $globalHooks of type array<integer,object<string>> is incompatible with the declared type array<integer,string> of property $globalHooks.

    }

    /**
     * @return \string[]
     */
    public function getGlobalHooks()
    {
        return $this->globalHooks;
    }

    public static function createRequestFromGlobals()
    {
        $request = Request::createFromGlobals();
        if (0 === strpos($request->headers->get('CONTENT_TYPE'), 'application/json')
            && in_array(strtoupper($request->server->get('REQUEST_METHOD', 'GET')), array('POST', 'PUT', 'DELETE', 'PATCH'))
        ) {
            $data = json_decode($request->getContent(), true);
            $request->request = new ParameterBag($data);
        }

        return $request;
    }

    public function getFullUri($uri)
    {
        return rtrim($this->getUriPrefix(), '/').'/'.ltrim($uri, '/');
    }
    /**
     * @return string
     */
    public function getUriPrefix()
    {
        return $this->uriPrefix;
    }

    /**
     * @param string $uriPrefix
     */
    public function setUriPrefix($uriPrefix)
    {
        $this->uriPrefix = $uriPrefix;
    }
    /**
     * @var string
     */
    protected $uriPrefix = '/';
    /**
     * @inject
     * @var Container
     */
    protected $container;

    /**
     * @inject
     * @var ControllerContainerBuilder
     */
    protected $controllerContainerBuilder;

    /**
     * @inject
     * @var Cache
     */
    protected $cache;

    /**
     * [
     *      [method, uri, handler, hooks]
     * ]
     * @var array
     */
    protected $routes = [];

    /**
     * @var string[]
     */
    protected $controllers = [];

    /**
     * @var string[]
     */
    protected $globalHooks = [];

}