AjaxRequestHandler.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Http;

class AjaxRequestHandler {

    protected $ajaxId = NULL;

    protected $errorMessage = NULL;

    protected $isError = FALSE;

    protected $content = array();

    protected $contentFormat = 'plain';

    protected $charset = 'utf-8';

    protected $requestCharset = 'utf-8';

    protected $javascriptCallbackWrap = '
        <script type="text/javascript">
            /*<![CDATA[*/
            response = |;
            /*]]>*/
        </script>
    ';

    public function __construct($ajaxId) {
        // Get charset from current AJAX request (which is expected to be utf-8)
        preg_match('/;\\s*charset\\s*=\\s*([a-zA-Z0-9_-]*)/i', $_SERVER['CONTENT_TYPE'], $contenttype);
        $charset = $GLOBALS['LANG']->csConvObj->parse_charset($contenttype[1]);
        if ($charset && $charset != $this->requestCharset) {
            $this->requestCharset = $charset;
        }
        // If the AJAX request does not have the same encoding like the backend
        // we need to convert the POST and GET parameters in the right charset
        if ($this->charset != $this->requestCharset) {
            $GLOBALS['LANG']->csConvObj->convArray($_POST, $this->requestCharset, $this->charset);
            $GLOBALS['LANG']->csConvObj->convArray($_GET, $this->requestCharset, $this->charset);
        }
        $this->ajaxId = $ajaxId;
    }

    public function getAjaxID() {
        return $this->ajaxId;
    }

    public function setContent($content) {
        $oldcontent = FALSE;
        if (is_array($content)) {
            $oldcontent = $this->content;
            $this->content = $content;
        }
        return $oldcontent;
    }

    public function addContent($key, $content) {
        $oldcontent = FALSE;
        if (array_key_exists($key, $this->content)) {
            $oldcontent = $this->content[$key];
        }
        if (!isset($content) || empty($content)) {
            unset($this->content[$key]);
        } elseif (!isset($key) || empty($key)) {
            $this->content[] = $content;
        } else {
            $this->content[$key] = $content;
        }
        return $oldcontent;
    }

    public function getContent($key = '') {
        return $key && array_key_exists($key, $this->content) ? $this->content[$key] : $this->content;
    }

    public function setContentFormat($format) {
        if (\TYPO3\CMS\Core\Utility\GeneralUtility::inArray(array('plain', 'xml', 'json', 'jsonhead', 'jsonbody', 'javascript'), $format)) {
            $this->contentFormat = $format;
        }
    }

    public function setJavascriptCallbackWrap($javascriptCallbackWrap) {
        $this->javascriptCallbackWrap = $javascriptCallbackWrap;
    }

    public function setError($errorMsg = '') {
        $this->errorMessage = $errorMsg;
        $this->isError = TRUE;
    }

    public function isError() {
        return $this->isError;
    }

    public function render() {
        if ($this->isError) {
            $this->renderAsError();
            die;
        }
        switch ($this->contentFormat) {
            case 'jsonhead':

            case 'jsonbody':

            case 'json':
                $this->renderAsJSON();
                break;
            case 'javascript':
                $this->renderAsJavascript();
                break;
            case 'xml':
                $this->renderAsXML();
                break;
            default:
                $this->renderAsPlain();
        }
        die;
    }

    protected function renderAsError() {
        header(\TYPO3\CMS\Core\Utility\HttpUtility::HTTP_STATUS_500 . ' (AJAX)');
        header('Content-type: text/xml; charset=' . $this->charset);
        header('X-JSON: false');
        die('<t3err>' . htmlspecialchars($this->errorMessage) . '</t3err>');
    }

    protected function renderAsPlain() {
        header('Content-type: text/html; charset=' . $this->charset);
        header('X-JSON: true');
        echo implode('', $this->content);
    }

    protected function renderAsXML() {
        header('Content-type: text/xml; charset=' . $this->charset);
        header('X-JSON: true');
        echo implode('', $this->content);
    }

    protected function renderAsJSON() {
        // If the backend does not run in UTF-8 then we need to convert it to unicode as
        // the json_encode method will return empty otherwise
        if ($this->charset != $this->requestCharset) {
            $GLOBALS['LANG']->csConvObj->convArray($this->content, $this->charset, $this->requestCharset);
        }
        $content = json_encode($this->content);
        header('Content-type: application/json; charset=' . $this->requestCharset);
        header('X-JSON: ' . ($this->contentFormat != 'jsonbody' ? $content : TRUE));
        // Bring content in xhr.responseText except when in "json head only" mode
        if ($this->contentFormat != 'jsonhead') {
            echo $content;
        }
    }

    protected function renderAsJavascript() {
        // If the backend does not run in UTF-8 then we need to convert it to unicode as
        // the json_encode method will return empty otherwise
        if ($this->charset != $this->requestCharset) {
            $GLOBALS['LANG']->csConvObj->convArray($this->content, $this->charset, $this->requestCharset);
        }
        $content = str_replace('|', json_encode($this->content), $this->javascriptCallbackWrap);
        header('Content-type: text/html; charset=' . $this->requestCharset);
        echo $content;
    }

}