Service.php

Go to the documentation of this file.

<?php

namespace Elgg\Ajax;

use Elgg\Amd\Config;
use Elgg\Http\Request;
use Elgg\PluginHooksService;
use Elgg\Services\AjaxResponse;
use Elgg\SystemMessagesService;
use RuntimeException;
use Symfony\Component\HttpFoundation\JsonResponse;

class Service {

    private $hooks;

    private $msgs;

    private $request;

    private $amd_config;

    private $response_sent = false;

    private $allowed_views = [];

    public function __construct(PluginHooksService $hooks, SystemMessagesService $msgs, Request $request, Config $amdConfig) {
        $this->hooks = $hooks;
        $this->msgs = $msgs;
        $this->request = $request;
        $this->amd_config = $amdConfig;

        $message_filter = [$this, 'prepareResponse'];
        $this->hooks->registerHandler(AjaxResponse::RESPONSE_HOOK, 'all', $message_filter, 999);
    }

    public function isAjax2Request() {
        $version = $this->request->headers->get('X-Elgg-Ajax-API');
        return ($version === '2');
    }

    public function isReady() {
        return !$this->response_sent && $this->isAjax2Request();
    }

    public function decodeJson($string) {
        if (!is_string($string)) {
            return $string;
        }
        $object = json_decode($string);
        return ($object === null) ? $string : $object;
    }

    public function respondFromOutput($output, $hook_type = '', $try_decode = true) {
        if ($try_decode) {
            $output = $this->decodeJson($output);
        }

        $api_response = new Response();
        if (is_object($output) && isset($output->value)) {
            $api_response->setData($output);
        } else if (is_array($output) && isset($output['value'])) {
            $api_response->setData((object) $output);
        } else {
            $api_response->setData((object) ['value' => $output]);
        }
        $api_response = $this->filterApiResponse($api_response, $hook_type);
        $response = $this->buildHttpResponse($api_response);

        $this->response_sent = true;
        return _elgg_services()->responseFactory->send($response);
    }

    public function respondFromApiResponse(AjaxResponse $api_response, $hook_type = '') {
        $api_response = $this->filterApiResponse($api_response, $hook_type);
        $response = $this->buildHttpResponse($api_response);

        $this->response_sent = true;
        return _elgg_services()->responseFactory->send($response);
    }

    public function respondWithError($msg = '', $status = 400) {
        $response = new JsonResponse(['error' => $msg], $status);
        
        // clear already set system messages as we respond directly with an error as message body
        $this->msgs->dumpRegister();

        $this->response_sent = true;
        return _elgg_services()->responseFactory->send($response);
    }

    private function filterApiResponse(AjaxResponse $api_response, $hook_type = '') {
        $api_response->setTtl($this->request->getParam('elgg_response_ttl', 0, false));

        if ($hook_type) {
            $hook = AjaxResponse::RESPONSE_HOOK;
            $api_response = $this->hooks->trigger($hook, $hook_type, null, $api_response);
            if (!$api_response instanceof AjaxResponse) {
                throw new RuntimeException("The value returned by hook [$hook, $hook_type] was not an ApiResponse");
            }
        }

        return $api_response;
    }

    private function buildHttpResponse(AjaxResponse $api_response, $allow_removing_headers = null) {
        if ($api_response->isCancelled()) {
            return new JsonResponse(['error' => "The response was cancelled"], 400);
        }

        $response = _elgg_services()->responseFactory->prepareJsonResponse($api_response->getData());

        $ttl = $api_response->getTtl();
        if ($ttl > 0) {
            // Required to remove headers set by PHP session
            if ($allow_removing_headers) {
                header_remove('Expires');
                header_remove('Pragma');
                header_remove('Cache-Control');
            }

            // JsonRequest sets a default Cache-Control header we don't want
            $response->headers->remove('Cache-Control');

            $response->setClientTtl($ttl);

            // if we don't set Expires, Apache will add a far-off max-age and Expires for us.
            $response->headers->set('Expires', gmdate('D, d M Y H:i:s \G\M\T', time() + $ttl));
        }

        return $response;
    }

    public function prepareResponse($hook, $type, $response, $params) {
        if (!$response instanceof AjaxResponse) {
            return;
        }

        if ($this->request->getParam('elgg_fetch_messages', true)) {
            $response->getData()->_elgg_msgs = (object) $this->msgs->dumpRegister();
        }

        if ($this->request->getParam('elgg_fetch_deps', true)) {
            $response->getData()->_elgg_deps = (array) $this->amd_config->getDependencies();
        }

        return $response;
    }

    public function registerView($view) {
        $this->allowed_views[$view] = true;
    }

    public function unregisterView($view) {
        unset($this->allowed_views[$view]);
    }

    public function getViews() {
        return array_keys($this->allowed_views);
    }
    
}