page_rest_resource.inc

<?php 
require_once SQ_CORE_PACKAGE_PATH.'/page/page.inc';


class Page_REST_Resource extends Page
{
    protected $_res = Array();

    // These are the headers to be sent if send_headers is true. 
    // Only those with values found in the first response will be forwarded.
    private $_response_headers = Array(
        'Content-Type',
        'Content-Length',
        'Last-Modified',
        'Cache-Control',
        'Expires',
    );

    // For storing extra param replacements for use in the HTTP request attribute.
    protected $_extra_replacements = Array();


    function __construct($assetid=0)
    {
        $this->_ser_attrs = TRUE; 
        parent::__construct($assetid);

    }//end constructor


    public function printFrontend()
    {
        $this->_process();
        return parent::printFrontend();

    }//end printFrontend()
     

    public function printBody()
    {
        // Run the request(s).
        $this->_process();

        // let the user decide if they want Matrix to do keyword replacements on the response. See  bug
        // #5701 Minor Enhancement : Allow REST resources assets to stop replacing keywords in response
        $GLOBALS['SQ_SYSTEM']->setGlobalDefine('SQ_REPLACE_MYSOURCE_LEVEL_KEYWORDS', $this->attr('allow_global_replace'));

        if (!empty($this->_res['responses'])) {
            if ($this->attr('send_headers')) {
                foreach ($this->_response_headers as $h) {
                    if (isset($this->_res['response']['headers'][$h])) {
                        header("$h: " . $this->_res['response']['headers'][$h]);
                    }
                }
            }

            // Send the response. If there are multiple responses, send them all. This might
            // seem odd, but occasionally you might be building a document from multiple fragments.
            foreach ($this->_res['responses'] as &$resp) {
                if ($resp['info']['http_code'] >= 400) {
                    echo $this->attr('error_response');
                } else {
                    echo $resp['body'];
                }
            }
        }

    }//end printBody()


    protected function _process()
    {
        // Only run the requests if we are being forced to, or if they have not yet been run.
        if (($this->attr('allow_multiple_runs')) || (empty($this->_res['responses']))) {
            // Run the request(s).
            $http_attr = $this->getAttribute('http_request');
            $http_attr->setKeywordReplacements($this->_extra_replacements);

            // all the available keywords need to be passed to the attribute to have keyword set in the attribute to be replaced
            $available_keywords = parent::getAvailableKeywords();
            foreach ($available_keywords as $keyword => $val) {
                $available_keywords[$keyword] = $this->getKeywordReplacement($keyword);
            }

            $mm = $GLOBALS['SQ_SYSTEM']->getMetadataManager();
            $metadata_fields = $mm->getMetadata($this->id);
            foreach($metadata_fields as $schema_fieldid => $field_data) {
                foreach ($field_data as $item) {
                    $available_keywords['asset_metadata_'.$item['name']] = $item['value'];
                }
            }

            $http_attr->setKeywordReplacements($available_keywords);

            $this->_res =& $http_attr->run();

            // trigger the event with this REST asset as a triggering asset and a response received
            $GLOBALS['SQ_SYSTEM']->broadcastTriggerEvent('trigger_event_rest_response_received', $this, $this->_res);
        }

    }//end _process()
    

    public function getAssetRestContentsKeywordReplacement()
    {
        ob_start();
        $this->printBody();

        return ob_get_clean();

    }//end getAssetContentsKeywordReplacement()


    public function getKeywordReplacement($keyword)
    {
        if (substr($keyword, 0, strlen('asset_rest_contents'))  == 'asset_rest_contents') {

            $params = substr($keyword, strlen('asset_rest_contents') + 1);
            $params = explode('_', $params);

            $i = 1;
            foreach ($params as $p) {
                $this->_extra_replacements["rest_param_$i"] = $p;
            }

            return $this->getAssetRestContentsKeywordReplacement();

        } else if (substr($keyword, 0, strlen('rest')) == 'rest') {
            // If the keyword starts with REST, dig in the data for a replacement.
            return $this->getKeywordReplacementFromArray($this->_res, substr($keyword, strlen('rest_')));

        }

        return parent::getKeywordReplacement($keyword);

    }//end getKewordReplacement()


    public function getKeywordReplacementFromArray($array, $keyword)
    {
        // If $keyword is a 1st level index of this array, then great..
        if (isset($array[$keyword])) return $array[$keyword];

        // Otherwise, split the keyword into parts, and try the first part, recursing if there's a match.
        $parts = explode('_', $keyword);
        $part = array_shift($parts);
    
        if (isset($array[$part])) {
            return $this->getKeywordReplacementFromArray($array[$part], join($parts, '_'));
        }

    }//end getKeywordReplacementFromArray()

}
?>