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: 

<?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\Controller;

trait Rendering {

    /**
     * @inheritDocs
     * @return string
     */
    public function __toString () {
        /** @var $this \MvcCore\Controller */
        return $this->Render();
    }

    /**
     * @inheritDocs
     * @param string $controllerOrActionNameDashed
     * @param string $actionNameDashed
     * @return string
     */
    public function Render ($controllerOrActionNameDashed = NULL, $actionNameDashed = NULL) {
        /** @var $this \MvcCore\Controller */
        if ($this->dispatchState < \MvcCore\IController::DISPATCH_STATE_INITIALIZED)
            $this->Init();
        if ($this->dispatchState < \MvcCore\IController::DISPATCH_STATE_PRE_DISPATCHED)
            $this->PreDispatch();
        if ($this->dispatchState < \MvcCore\IController::DISPATCH_STATE_RENDERED && $this->viewEnabled) {
            $topMostParentCtrl = $this->parentController === NULL;
            // if this is child controller - set up view store with parent controller view store
            if (!$topMostParentCtrl)
                $this->view->SetUpStore($this->parentController->GetView(), FALSE);
            // set up child controllers into view if any of them is named by string index
            foreach ($this->childControllers as $ctrlKey => $childCtrl) {
                if (!is_numeric($ctrlKey) && !isset($this->view->{$ctrlKey}))
                    $this->view->{$ctrlKey} = $childCtrl;
            }
            // render this view or view with layout by render mode:
            if (($this->renderMode & \MvcCore\IView::RENDER_WITH_OB_FROM_ACTION_TO_LAYOUT) != 0) {
                $this->renderWithObFromActionToLayout(
                    $controllerOrActionNameDashed,
                    $actionNameDashed,
                    $topMostParentCtrl
                );
                return '';
            } else /*if (($this->renderMode & \MvcCore\IView::RENDER_WITHOUT_OB_CONTINUOUSLY) != 0)*/ {
                $sessionClass = $this->GetApplication()->GetSessionClass();
                if ($sessionClass::GetStarted() && !$this->response->IsSentHeaders()) {
                    $sessionClass::SendCookie();
                    $sessionClass::Close();
                }
                $this->response->SendHeaders();
                if ($this->request->GetMethod() === \MvcCore\IRequest::METHOD_HEAD) {
                    $this->Terminate();
                    return '';
                }
                //if (ob_get_length() !== FALSE) // flush out any previous content
                //  while (ob_get_level() > 0) ob_end_flush();
                $this->renderWithoutObContinuously(
                    $controllerOrActionNameDashed,
                    $actionNameDashed,
                    $topMostParentCtrl
                );
                return '';
            }
        }
        $this->dispatchState = \MvcCore\IController::DISPATCH_STATE_RENDERED;
        $result = '';
        return $result;
    }

    /**
     * @inheritDocs
     * @param string $output
     * @param bool $terminate
     * @return void
     */
    public function HtmlResponse ($output = '', $terminate = TRUE) {
        /** @var $this \MvcCore\Controller */
        if (!$this->response->HasHeader('Content-Type')) {
            $viewClass = $this->application->GetViewClass();
            $contentTypeHeaderValue = strpos(
                $viewClass::GetDoctype(), \MvcCore\IView::DOCTYPE_XHTML
            ) !== FALSE ? 'application/xhtml+xml' : 'text/html' ;
            $this->response->SetHeader('Content-Type', $contentTypeHeaderValue);
        }
        $this->response
            ->SetCode(\MvcCore\IResponse::OK)
            ->SetBody($output);
        if ($terminate) $this->Terminate();
    }

    /**
     * @inheritDocs
     * @param string $output
     * @param bool $terminate
     * @return void
     */
    public function XmlResponse ($output = '', $terminate = TRUE) {
        /** @var $this \MvcCore\Controller */
        $res = $this->response;
        if (!$res->HasHeader('Content-Type'))
            $res->SetHeader('Content-Type', 'application/xml');
        $res->SetBody($output);
        if ($res->GetCode() === NULL)
            $res->SetCode(\MvcCore\IResponse::OK);
        if ($terminate) $this->Terminate();
    }

    /**
     * @inheritDocs
     * @param string $output
     * @param bool $terminate
     * @return void
     */
    public function TextResponse ($output = '', $terminate = TRUE) {
        /** @var $this \MvcCore\Controller */
        $res = $this->response;
        if (!$res->HasHeader('Content-Type'))
            $res->SetHeader('Content-Type', 'text/plain');
        $res->SetBody($output);
        if ($res->GetCode() === NULL)
            $res->SetCode(\MvcCore\IResponse::OK);
        if ($terminate) $this->Terminate();
    }

    /**
     * @inheritDocs
     * @param mixed $data
     * @param bool  $terminate
     * @throws \Exception JSON encoding error.
     * @return void
     */
    public function JsonResponse ($data = NULL, $terminate = TRUE) {
        /** @var $this \MvcCore\Controller */
        $res = $this->response;
        $toolClass = $this->application->GetToolClass();
        $output = $toolClass::EncodeJson($data);
        ob_clean(); // remove any possible warnings to break client's `JSON.parse();`
        if (!$res->HasHeader('Content-Type'))
            $res->SetHeader('Content-Type', 'text/javascript');
        $res
            ->SetHeader('Content-Length', strlen($output))
            ->SetBody($output);
        if ($res->GetCode() === NULL)
            $res->SetCode(\MvcCore\IResponse::OK);
        if ($terminate) $this->Terminate();
    }

    /**
     * @inheritDocs
     * @param mixed $data
     * @param string $callbackParamName
     * @param bool  $terminate
     * @throws \Exception JSON encoding error.
     * @return void
     */
    public function JsonpResponse ($data = NULL, $callbackParamName = 'callback', $terminate = TRUE) {
        /** @var $this \MvcCore\Controller */
        $res = $this->response;
        $toolClass = $this->application->GetToolClass();
        $output = $toolClass::EncodeJson($data);
        ob_clean(); // remove any possible warnings to break client's `JSON.parse();`
        if (!$res->HasHeader('Content-Type'))
            $res->SetHeader('Content-Type', 'text/javascript');
        $callbackParam = $this->GetParam($callbackParamName, 'a-zA-Z0-9\.\-_\$', $callbackParamName, 'string');
        $output = $callbackParam . '(' . $output . ');';
        $res
            ->SetHeader('Content-Length', strlen($output))
            ->SetBody($output);
        if ($res->GetCode() === NULL)
            $res->SetCode(\MvcCore\IResponse::OK);
        if ($terminate) $this->Terminate();
    }

    /**
     * @inheritDocs
     * @param string $exceptionMessage
     * @return void
     */
    public function RenderError ($exceptionMessage = '') {
        /** @var $this \MvcCore\Controller */
        if ($this->application->IsErrorDispatched()) return;
        throw new \ErrorException(
            $exceptionMessage 
                ? $exceptionMessage :
                "Server error: `" . htmlspecialchars($this->request->GetFullUrl()) . "`.",
            500
        );
    }

    /**
     * @inheritDocs
     * @return void
     */
    public function RenderNotFound () {
        /** @var $this \MvcCore\Controller */
        if ($this->application->IsNotFoundDispatched()) return;
        throw new \ErrorException(
            "Page not found: `" . htmlspecialchars($this->request->GetFullUrl()) . "`.", 
            404
        );
    }

    /**
     * @inheritDocs
     * @param string $controllerOrActionNameDashed
     * @param string $actionNameDashed
     * @return string
     */
    public function GetViewScriptPath ($controllerOrActionNameDashed = NULL, $actionNameDashed = NULL) {
        /** @var $this \MvcCore\Controller */
        $currentCtrlIsTopMostParent = $this->parentController === NULL;
        if ($this->viewScriptsPath !== NULL) {
            $resultPathItems = [$this->viewScriptsPath];
            if ($controllerOrActionNameDashed !== NULL) $resultPathItems[] = $controllerOrActionNameDashed;
            if ($actionNameDashed !== NULL) $resultPathItems[] = $actionNameDashed;
            $viewScriptPath = str_replace(['_', '\\'], '/', implode('/', $resultPathItems));
            $viewScriptPath = preg_replace("#//+#", '/', $viewScriptPath);
            return $viewScriptPath;
        }
        if ($actionNameDashed !== NULL) { // if action defined - take first argument controller
            $controllerNameDashed = $controllerOrActionNameDashed;
        } else { // if no action defined - we need to complete controller dashed name
            $toolClass = '';
            if ($currentCtrlIsTopMostParent) { // if controller is tom most one - take routed controller name
                $controllerNameDashed = $this->controllerName;
            } else {
                // if controller is child controller - translate class name
                // without default controllers directory into dashed name
                $ctrlsDefaultNamespace = $this->application->GetAppDir() . '\\'
                    . $this->application->GetControllersDir();
                $currentCtrlClassName = get_class($this);
                if (mb_strpos($currentCtrlClassName, $ctrlsDefaultNamespace) === 0)
                    $currentCtrlClassName = mb_substr($currentCtrlClassName, mb_strlen($ctrlsDefaultNamespace) + 1);
                $currentCtrlClassName = str_replace('\\', '/', $currentCtrlClassName);
                $toolClass = $this->application->GetToolClass();
                $controllerNameDashed = $toolClass::GetDashedFromPascalCase($currentCtrlClassName);
            }
            if ($controllerOrActionNameDashed !== NULL) {
                $actionNameDashed = $controllerOrActionNameDashed;
            } else {
                if ($currentCtrlIsTopMostParent) {// if controller is top most parent - use routed action name
                    $actionNameDashed = $this->actionName;
                } else {// if no action name defined - use default action name from core - usually `index`
                    $defaultCtrlAction = $this->application->GetDefaultControllerAndActionNames();
                    $actionNameDashed = $toolClass::GetDashedFromPascalCase($defaultCtrlAction[1]);
                }
            }
        }
        $controllerPath = str_replace(['_', '\\'], '/', $controllerNameDashed);
        return implode('/', [$controllerPath, $actionNameDashed]);
    }

    /**
     * Default rendering mode.
     * Render action view first into output buffer, then render layout view
     * wrapped around rendered action view string also into output buffer.
     * Then set up rendered content from output buffer into response object
     * and then send HTTP headers and content after all.
     * @param string $controllerOrActionNameDashed
     * @param string $actionNameDashed
     * @param bool   $topMostParentCtrl
     * @return void
     */
    protected function renderWithObFromActionToLayout ($controllerOrActionNameDashed, $actionNameDashed, $topMostParentCtrl) {
        /** @var $this \MvcCore\Controller */
        // complete paths
        $viewScriptPath = $this->GetViewScriptPath($controllerOrActionNameDashed, $actionNameDashed);
        // render action view into string
        $this->view->SetUpRender(
            $this->renderMode, $controllerOrActionNameDashed, $actionNameDashed
        );
        $actionResult = $this->view->RenderScript($viewScriptPath);
        if (!$topMostParentCtrl) {
            $this->dispatchState = \MvcCore\IController::DISPATCH_STATE_RENDERED;
            unset($actionResult, $this->view);
            return;
        }
        // create top most parent layout view, set up and render to outputResult
        $viewClass = $this->application->GetViewClass();
        /** @var $layout \MvcCore\View */
        $layout = $viewClass::CreateInstance()
            ->SetController($this)
            ->SetUpStore($this->view, TRUE)
            ->SetUpRender(
                $this->renderMode, $controllerOrActionNameDashed, $actionNameDashed
            );
        $outputResult = $layout->RenderLayoutAndContent($this->layout, $actionResult);
        unset($layout, $this->view);
        // set up response only
        $this->XmlResponse($outputResult, FALSE);
        unset($outputResult);
        $this->dispatchState = \MvcCore\IController::DISPATCH_STATE_RENDERED;
    }

    /**
     * Special rendering mode to continuously sent larger data to client.
     * Render layout view and render action view together inside it without
     * output buffering. There is not used reponse object body property for
     * this rendering mode. Http headers are sent before view rendering.
     * @param string $controllerOrActionNameDashed
     * @param string $actionNameDashed
     * @param bool   $topMostParentCtrl
     * @return void
     */
    protected function renderWithoutObContinuously ($controllerOrActionNameDashed, $actionNameDashed, $topMostParentCtrl) {
        /** @var $this \MvcCore\Controller */
        if ($topMostParentCtrl) {
            // render layout view and action view inside it:
            $viewClass = $this->application->GetViewClass();
            /** @var $layout \MvcCore\View */
            $layout = $viewClass::CreateInstance()
                ->SetController($this)
                ->SetUpStore($this->view, TRUE)
                ->SetUpRender(
                    $this->renderMode, $controllerOrActionNameDashed, $actionNameDashed
                );
            // render layout continuously with action view inside
            $layout->RenderLayout($this->layout);
            unset($layout, $this->view);
        } else {
            // complete paths
            $viewScriptPath = $this->GetViewScriptPath($controllerOrActionNameDashed, $actionNameDashed);
            // render action view into string
            $this->view->RenderScript($viewScriptPath);
            unset($this->view);
        }
        $this->dispatchState = \MvcCore\IController::DISPATCH_STATE_RENDERED;
    }
}