1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license  https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Application;

/**
 * Trait as partial class for `\MvcCore\Application`:
 * - Dispatching application http request/response (`\MvcCore\Application::Dispatch();`):
 *   - Completing request and response.
 *   - Calling pre/post handlers.
 *   - Controller/action dispatching.
 *   - Error handling and error responses.
 */
trait Dispatching {

    /***************************************************************************
     *               `\MvcCore\Application` - Normal Dispatching               *
     **************************************************************************/

    /**
     * @inheritDocs
     * @return \MvcCore\Application
     */
    public function Dispatch () {
        /** @var $this \MvcCore\Application */
        try {
            // all 3 getters triggers creation:
            $this->GetEnvironment();
            $this->GetRequest();
            $this->GetResponse();
            $debugClass = $this->debugClass;
            $debugClass::Init();
        } catch (\Exception $e) { // backward compatibility
            $this->DispatchException($e);
            return $this->Terminate();
        } catch (\Throwable $e) {
            $this->DispatchException($e);
            return $this->Terminate();
        }
        if (!$this->ProcessCustomHandlers($this->preRouteHandlers))     return $this->Terminate();
        if (!$this->RouteRequest())                                     return $this->Terminate();
        if (!$this->ProcessCustomHandlers($this->postRouteHandlers))    return $this->Terminate();
        if (!$this->DispatchRequest())                                  return $this->Terminate();
        // Post-dispatch handlers processing moved to: `$this->Terminate();` to process them every time.
        // if (!$this->processCustomHandlers($this->postDispatchHandlers))  return $this->Terminate();
        return $this->Terminate();
    }

    /**
     * @inheritDocs
     * @return void
     */
    public function SessionStart () {
        /** @var $this \MvcCore\Application */
        /** @var $sessionClass \MvcCore\Session */
        $sessionClass = $this->sessionClass;
        $sessionClass::Start();
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function RouteRequest () {
        /** @var $this \MvcCore\Application */
        $router = $this->GetRouter()->SetRequest($this->GetRequest());
        try {
            /**
             * `Route()` method could throws those exceptions:
             * @throws \LogicException Route configuration property is missing.
             * @throws \InvalidArgumentException Wrong route pattern format.
             */
            $result = $router->Route();
        } catch (\Exception $e) { // backward compatibility
            $this->DispatchException($e);
            $result = FALSE;
        } catch (\Throwable $e) {
            $this->DispatchException($e);
            $result = FALSE;
        }
        return $result;
    }

    /**
     * @inheritDocs
     * @param \callable[] $handlers
     * @return bool
     */
    public function ProcessCustomHandlers (& $handlers = []) {
        /** @var $this \MvcCore\Application */
        if (!$handlers || $this->request->IsInternalRequest() === TRUE) return TRUE;
        $result = TRUE;
        foreach ($handlers as $handlerRecord) {
            list ($closureCalling, $handler) = $handlerRecord;
            $subResult = NULL;
            try {
                if ($closureCalling) {
                    $subResult = $handler($this->request, $this->response);
                } else {
                    $subResult = call_user_func($handler, $this->request, $this->response);
                }
                if ($subResult === FALSE) {
                    $result = FALSE;
                    break;
                }
            } catch (\Exception $e) { // backward compatibility
                $this->DispatchException($e);
                $result = FALSE;
                break;
            } catch (\Throwable $e) {
                $this->DispatchException($e);
                $result = FALSE;
                break;
            }
        }
        return $result;
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function DispatchRequest () {
        /** @var $this \MvcCore\Application */
        /** @var $route \MvcCore\Route */
        $route = $this->router->GetCurrentRoute();
        if ($route === NULL) return $this->DispatchException('No route for request', 404);
        list ($ctrlPc, $actionPc) = [$route->GetController(), $route->GetAction()];
        $actionName = $actionPc . 'Action';
        $viewClass = $this->viewClass;
        $viewScriptFullPath = $viewClass::GetViewScriptFullPath(
            $viewClass::GetScriptsDir(),
            $this->request->GetControllerName() . '/' . $this->request->GetActionName()
        );
        if ($ctrlPc == 'Controller') {
            $controllerName = $this->controllerClass;
        } else if ($this->controller !== NULL) {
            $controllerName = '\\'.get_class($this->controller);
        } else {
            // `App_Controllers_<$ctrlPc>`
            $controllerName = $this->CompleteControllerName($ctrlPc);
            if (!class_exists($controllerName)) {
                // if controller doesn't exists - check if at least view exists
                if (file_exists($viewScriptFullPath)) {
                    // if view exists - change controller name to core controller, if not let it go to exception
                    $controllerName = $this->controllerClass;
                } else {
                    return $this->DispatchException("Controller class `{$controllerName}` doesn't exist.", 404);
                }
            }
        }
        return $this->DispatchControllerAction(
            $controllerName,
            $actionName,
            $viewScriptFullPath,
            function ($e) {
                return $this->DispatchException($e);
            }
        );
    }

    /**
     * @inheritDocs
     * @param string $ctrlClassFullName
     * @param string $actionNamePc
     * @param string $viewScriptFullPath
     * @param callable $exceptionCallback
     * @return bool
     */
    public function DispatchControllerAction (
        $ctrlClassFullName,
        $actionNamePc,
        $viewScriptFullPath,
        callable $exceptionCallback
    ) {
        /** @var $this \MvcCore\Application */
        if ($this->controller === NULL) {
            $controller = NULL;
            try {
                $controller = $ctrlClassFullName::CreateInstance();
            } catch (\Exception $e) { // backward compatibility
                return $this->DispatchException($e->getMessage(), 404);
            } catch (\Throwable $e) {
                return $this->DispatchException($e->getMessage(), 404);
            }
            $this->controller = $controller;
        }
        /** @var $ctrl \MvcCore\Controller */
        $ctrl = $this->controller;
        /** @var $this \MvcCore\Application */
        $ctrl
            ->SetApplication($this)
            ->SetEnvironment($this->environment)
            ->SetRequest($this->request)
            ->SetResponse($this->response)
            ->SetRouter($this->router);
        if (!method_exists($this->controller, $actionNamePc) && $ctrlClassFullName !== $this->controllerClass) {
            if (!file_exists($viewScriptFullPath)) {
                $appRoot = $this->request->GetAppRoot();
                $viewScriptPath = mb_strpos($viewScriptFullPath, $appRoot) === FALSE
                    ? $viewScriptFullPath
                    : mb_substr($viewScriptFullPath, mb_strlen($appRoot));
                $ctrlClassFullName = $this->request->GetControllerName();
                return $this->DispatchException(
                    "Controller class `{$ctrlClassFullName}` "
                    ."has not method `{$actionNamePc}` \n"
                    ."or view doesn't exist: `{$viewScriptPath}`.",
                    404
                );
            }
        }
        if (!$this->ProcessCustomHandlers($this->preDispatchHandlers)) return FALSE;
        try {
            $this->controller->Dispatch($actionNamePc);
        } catch (\Exception $e) { // backward compatibility
            return $exceptionCallback($e);
        } catch (\Throwable $e) {
            return $exceptionCallback($e);
        }
        return TRUE;
    }

    /**
     * @inheritDocs
     * @param string $controllerActionOrRouteName   Should be `"Controller:Action"` combination or just any route name as custom specific string.
     * @param array  $params                        Optional, array with params, key is param name, value is param value.
     * @return string
     */
    public function Url ($controllerActionOrRouteName = 'Index:Index', $params = []) {
        /** @var $this \MvcCore\Application */
        return $this->router->Url($controllerActionOrRouteName, $params);
    }

    /**
     * @inheritDocs
     * @return \MvcCore\Application
     */
    public function Terminate () {
        /** @var $this \MvcCore\Application */
        if ($this->terminated) return $this;
        /** @var $this->response \MvcCore\Response */
        $this->ProcessCustomHandlers($this->postDispatchHandlers);
        if (!$this->response->IsSentHeaders()) {
            // headers (if still possible) and echo
            $sessionClass = $this->sessionClass;
            if ($sessionClass::GetStarted()) {
                $sessionClass::SendCookie();
                $sessionClass::Close();
            }
            $this->response->SendHeaders();
        }
        if (
            !$this->response->IsSentBody() &&
            !$this->request->GetMethod() !== \MvcCore\IRequest::METHOD_HEAD
        )
            $this->response->SendBody();
        // exit; // Why to force exit? What if we want to do something more?
        $this->terminated = TRUE;
        if ($this->controller) {
            $ctrlType = new \ReflectionClass($this->controller);
            $dispatchStateProperty = $ctrlType->getProperty('dispatchState');
            $dispatchStateProperty->setAccessible(TRUE);
            $dispatchStateProperty->setValue(
                $this->controller, \MvcCore\IController::DISPATCH_STATE_TERMINATED
            );
        }
        $this->ProcessCustomHandlers($this->postTerminateHandlers);
        return $this;
    }


    /***************************************************************************
     *           `\MvcCore\Application` - Request Error Dispatching            *
     **************************************************************************/

    /**
     * @inheritDocs
     * @param \Throwable|string $exceptionOrMessage
     * @param int|NULL $code
     * @return bool
     */
    public function DispatchException ($exceptionOrMessage, $code = NULL) {
        /** @var $this \MvcCore\Application */
        if (class_exists('\Packager_Php')) return FALSE; // packing process
        $exception = NULL;
        if ($exceptionOrMessage instanceof \Throwable) {
            $exception = $exceptionOrMessage;
        } else {
            try {
                if ($code === NULL) throw new \Exception($exceptionOrMessage);
                throw new \ErrorException($exceptionOrMessage, $code);
            } catch (\Exception $e) { // backward compatibility
                $exception = $e;
            } catch (\Throwable $e) {
                $exception = $e;
            }
        }
        $debugClass = $this->debugClass;
        if ($exception->getCode() == 404) {
            $debugClass::Log($exception->getMessage().": ".$this->request->GetFullUrl(), \MvcCore\IDebug::INFO);
            return $this->RenderNotFound($exception->getMessage());
        } else if ($this->environment->IsDevelopment()) {
            $debugClass::Exception($exception);
            return FALSE;
        } else {
            $debugClass::Log($exception, \MvcCore\IDebug::EXCEPTION);
            return $this->RenderError($exception);
        }
    }

    /**
     * @inheritDocs
     * @param \Throwable $e
     * @return bool
     */
    public function RenderError ($e) {
        /** @var $this \MvcCore\Application */
        $defaultCtrlFullName = $this->GetDefaultControllerIfHasAction(
            $this->defaultControllerErrorActionName
        );
        $exceptionMessage = $e->getMessage();
        if (!$this->GetRequest()->IsCli() && $defaultCtrlFullName) {
            $debugClass = $this->debugClass;
            $viewClass = $this->viewClass;
            $this->router->SetOrCreateDefaultRouteAsCurrent(
                \MvcCore\IRouter::DEFAULT_ROUTE_NAME_ERROR,
                $this->defaultControllerName,
                $this->defaultControllerErrorActionName,
                TRUE
            );
            $exceptionCode = $e->getCode();
            $exceptionCode = $exceptionCode > 0 ? $exceptionCode : 500;
            $newParams = array_merge($this->request->GetParams(FALSE), [
                'code'      => $exceptionCode,
                'message'   => $exceptionMessage,
            ]);
            $this->request->SetParams($newParams);
            $this->response->SetCode($exceptionCode);
            $this->controller = NULL;
            $this->DispatchControllerAction(
                $defaultCtrlFullName,
                $this->defaultControllerErrorActionName . "Action",
                $viewClass::GetViewScriptFullPath(
                    $viewClass::GetScriptsDir(),
                    $this->request->GetControllerName() . '/' . $this->request->GetActionName()
                ),
                function (\Throwable $e2) use ($exceptionMessage, $debugClass) {
                    $this->router->RemoveRoute(\MvcCore\IRouter::DEFAULT_ROUTE_NAME_NOT_FOUND);
                    if ($this->environment->IsDevelopment()) {
                        $debugClass::Exception($e2);
                    } else {
                        $debugClass::Log($e2, \MvcCore\IDebug::EXCEPTION);
                        $this->RenderError500PlainText($exceptionMessage . PHP_EOL . PHP_EOL . $e2->getMessage());
                    }
                }
            );
            return FALSE;
        } else {
            return $this->RenderError500PlainText($exceptionMessage);
        }
    }

    /**
     * @inheritDocs
     * @param \Throwable $e
     * @return bool
     */
    public function RenderNotFound ($exceptionMessage = '') {
        /** @var $this \MvcCore\Application */
        if (!$exceptionMessage) $exceptionMessage = 'Page not found.';
        $defaultCtrlFullName = $this->GetDefaultControllerIfHasAction(
            $this->defaultControllerNotFoundActionName
        );
        if (!$this->GetRequest()->IsCli() && $defaultCtrlFullName) {
            $debugClass = $this->debugClass;
            $viewClass = $this->viewClass;
            $this->router->SetOrCreateDefaultRouteAsCurrent(
                \MvcCore\IRouter::DEFAULT_ROUTE_NAME_NOT_FOUND,
                $this->defaultControllerName,
                $this->defaultControllerNotFoundActionName,
                TRUE
            );
            $newParams = array_merge($this->request->GetParams(FALSE), [
                'code'      => 404,
                'message'   => $exceptionMessage,
            ]);
            $this->request->SetParams($newParams);
            $this->response->SetCode(404);
            $this->controller = NULL;
            $this->DispatchControllerAction(
                $defaultCtrlFullName,
                $this->defaultControllerNotFoundActionName . "Action",
                $viewClass::GetViewScriptFullPath(
                    $viewClass::GetScriptsDir(),
                    $this->request->GetControllerName() . '/' . $this->request->GetActionName()
                ),
                function (\Throwable $e) use ($exceptionMessage, $debugClass) {
                    $this->router->RemoveRoute(\MvcCore\IRouter::DEFAULT_ROUTE_NAME_NOT_FOUND);
                    if ($this->environment->IsDevelopment()) {
                        $debugClass::Exception($e);
                    } else {
                        $debugClass::Log($e, \MvcCore\IDebug::EXCEPTION);
                        $this->RenderError404PlainText($exceptionMessage);
                    }
                }
            );
            return FALSE;
        } else {
            return $this->RenderError404PlainText($exceptionMessage);
        }
    }

    /**
     * @inheritDocs
     * @param string $text
     * @return bool
     */
    public function RenderError500PlainText ($text = '') {
        /** @var $this \MvcCore\Application */
        $htmlResponse = FALSE;
        $responseClass = $this->responseClass;
        if (!$this->environment->IsDevelopment()) {
            $text = 'Error 500: Internal Server Error.'.PHP_EOL;
        } else {
            $obContent = ob_get_clean();
            if (mb_strlen($obContent) > 0)
                $htmlResponse = mb_strpos($obContent, '<') !== FALSE && mb_strpos($obContent, '>') !== FALSE;
            if ($htmlResponse) {
                $text = '<pre><big>Error 500</big>: '.PHP_EOL.PHP_EOL.$text.'</pre>'.$obContent;
            } else {
                $text = 'Error 500: '.PHP_EOL.PHP_EOL.$text.PHP_EOL.$obContent;
            }
        }
        $this->response = $responseClass::CreateInstance(
            \MvcCore\IResponse::INTERNAL_SERVER_ERROR,
            ['Content-Type' => $htmlResponse ? 'text/html' : 'text/plain'],
            $text
        );
        return FALSE;
    }

    /**
     * @inheritDocs
     * @param string $text
     * @return bool
     */
    public function RenderError404PlainText ($text = '') {
        /** @var $this \MvcCore\Application */
        $htmlResponse = FALSE;
        $responseClass = $this->responseClass;
        if (!$this->environment->IsDevelopment()) {
            $text = 'Error 404: Page not found.'.PHP_EOL;
        } else {
            $obContent = ob_get_clean();
            if (mb_strlen($obContent) > 0)
                $htmlResponse = mb_strpos($obContent, '<') !== FALSE && mb_strpos($obContent, '>') !== FALSE;
            if ($htmlResponse) {
                $text = '<pre><big>Error 404</big>: '.PHP_EOL.PHP_EOL.$text.'</pre>'.$obContent;
            } else {
                $text = 'Error 404: '.PHP_EOL.PHP_EOL.$text.PHP_EOL.$obContent;
            }
        }
        $this->response = $responseClass::CreateInstance(
            \MvcCore\IResponse::NOT_FOUND,
            ['Content-Type' => $htmlResponse ? 'text/html' : 'text/plain'],
            $text
        );
        return FALSE;
    }
}