paint_layout_bodycopy.inc

<?php
require_once SQ_CORE_PACKAGE_PATH.'/bodycopy/bodycopy/bodycopy.inc';
require_once 'include/conditions_list.inc';
require_once SQ_FUDGE_PATH.'/general/file_system.inc';

class Paint_Layout_Bodycopy extends Bodycopy
{

    var $asset_to_paint = NULL;

    var $conditions_list = NULL;

    var $keyword_replacements = Array();


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

    }//end constructor


    public function _updated()
    {
        // Use bodycopy's save functionality to store any notice links our containers have,
        // and to store the original content before any substitutions take place
        if (!parent::_updated()) return FALSE;

        $this->_generateContentFile();

        return TRUE;

    }//end _updated()


    protected function _generateContentFile()
    {
        require_once SQ_FUDGE_PATH.'/general/text.inc';
        $php_begin = '<'.'?'.'php ';
        $php_end = ' ?'.'>';
        $content_file = '';
        $required_substitution_keywords = Array();
        $required_substitution_asset_keywords = Array();

        $containers = $this->getContainers();
        foreach (array_keys($containers) as $i) {
            ob_start();
                $container =& $containers[$i]; // need this by reference
                $edit = $container->getEditFns();
                $edit->paint($container, FALSE, TRUE);
                $content = ob_get_contents();
            ob_end_clean();

            $required_keywords = retrieve_keywords_replacements($content);
            $keyword_replacements = Array();
            $additional_keywords = Array();

            // find all the required keywords and replace the condition-block keywords by PHP code
            foreach ($required_keywords as $keyword) {
                if (!isset($keyword_replacements[$keyword])) {
                    $value = NULL;

                    if (preg_match('/^('.SQ_KEYWORD_CONDITION_BEGIN.'|'.SQ_KEYWORD_CONDITION_END.'|'.SQ_KEYWORD_CONDITION_ELSE.')_(.*)$/', $keyword, $condition_parts)) {
                        if (count($condition_parts) == 3) {
                            $test_keyword = $condition_parts[2];
                            switch ($condition_parts[1]) {
                                case SQ_KEYWORD_CONDITION_BEGIN :
                                    $this->_addRequiredKeywordsFromEvaluatedKeyword($test_keyword, $required_substitution_keywords);
                                    $value = 'if (!empty($paint_layout_keywords[\''.$test_keyword.'\']) && trim($paint_layout_keywords[\''.$test_keyword.'\']) != \'\') {';
                                break;
                                case SQ_KEYWORD_CONDITION_ELSE :
                                    $value = '} else {';
                                break;
                                case SQ_KEYWORD_CONDITION_END :
                                    $value = '} // end '.$test_keyword;
                                break;
                            }

                            if (!empty($value)) {
                                $value = $php_begin.$value.$php_end;
                            }
                        }
                    }

                    if (isset($value)) {
                        $keyword_replacements[$keyword] = $value;
                    } else {
                        $required_substitution_asset_keywords[$keyword] = 1;
                    }
                }
            }//end foreach

            // Replace all the conditional keywords in our content with valid PHP code
            replace_keywords($content, $keyword_replacements);

            // Change each ./?a= url to reference the sq_asset_url_list array, which
            // is built from our container's notice links when content is printed.
            $e = '|\./\?a=([0-9:]+)([^0-9])|';
            $with = '<'.'?php echo ((strpos("\\1", ":") !== FALSE) ? "./?a=\\1" : $sq_asset_url_list["\\1"]); ?'.'>\\2';
            $content = preg_replace($e, $with, $content);

            $content_file .= '
                            $container = $GLOBALS["SQ_SYSTEM"]->am->getAsset('.$container->id.',  "'.$container->type().'");
                            if ($container->readAccess()) {
                                '.$php_end.$content.$php_begin.'
                            }//end if read access for container '.$container->id.'
                            ';

        }//end foreach container

        $content_file = $php_begin.$content_file.$php_end;

        // Flatten line endings to a common one, as the sections of content file
        // generated by Matrix and that by the database may have different
        $content_file = str_replace("\r\n","\n", $content_file);
        $content_file = str_replace("\r","\n", $content_file);

        // ...but that ending should really be \r\n; when sent to a browser,
        // text/html MIME-type requires \r\n line endings
        $content_file = str_replace("\n","\r\n", $content_file);

        // save the contents of the bodycopy
        if (!is_dir($this->data_path)) {
            create_directory($this->data_path);
        }
        
        $contextid = (int)$GLOBALS['SQ_SYSTEM']->getContextId();
        $file_name = 'content_file'.(($contextid === 0) ? '' : ('.'.$contextid)).'.php';
        $keyword_name = 'keywords'.(($contextid === 0) ? '' : ('.'.$contextid));
        
        if (!string_to_file($content_file, $this->data_path.'/'.$file_name)) {
            trigger_localised_error('CORE0047', E_USER_WARNING, $this->name);
            return FALSE;
        }

        // Save the substitution keywords we will need to lookup for each asset display
        create_directory($this->data_path);
        if (!string_to_file(serialize(array_merge($required_substitution_keywords, $required_substitution_asset_keywords)), $this->data_path.'/keywords'))  {
            trigger_localised_error('CORE0048', E_USER_WARNING, $this->name);
            return FALSE;
        }
        
        if (!string_to_file(serialize($required_substitution_keywords), $this->data_path.'/conditional_keywords_to_eval')) {
            trigger_localised_error('CORE0048', E_USER_WARNING, $this->name);
            return FALSE;
        }

    }//end _generateContentFile()


    public function paintAsset(Asset $asset)
    {
        /*
         * Possible keywords:
         *
         * SUBSTITUTION_KEYWORDS:
         *
         * 1. any asset keywords
         * 2. %asset_content%
         *
         * CONDITIONAL KEYWORDS:
         *
         * 3. %begin_SUBSTITUTION_KEYWORD% ... %end_SUBSTITUTION_KEYWORD%
         *
         */
        // start performance mode timer
        $GLOBALS['SQ_SYSTEM']->pm->startTimer($this);
        $ret = '';

        $this->asset_to_paint = $asset;

        $contextid = (int)$GLOBALS['SQ_SYSTEM']->getContextId();
        $context_suffix = ($contextid === 0) ? '' : ('.'.$contextid);
        $content_file_name = 'content_file'.$context_suffix.'.php';
        $default_content_file_name = 'content_file.php';
        $content_path = $this->data_path.'/'.$content_file_name;
        if (file_exists($content_path) === FALSE) {
            $content_path = $this->data_path.'/'.$default_content_file_name;
        }

        // Retrieve any assets referenced in this bodycopy, and get their urls for lookup
        if (file_exists($this->data_path.'/.notice_links')) {
            $linked_assets = unserialize(file_to_string($this->data_path.'/.notice_links'));
        } else {
            // nothing cached out from the Bodycopy asset level (ie. not in safe edit) so
            // need to grab our notice links ourselves
            $linked_assets = Array();
            $containers = $this->getContainers();

            foreach ($containers as $container) {
                $links = $GLOBALS['SQ_SYSTEM']->am->getLinks($container->id, SQ_LINK_NOTICE);
                foreach ($links as $link) {
                    $linked_assets[] = $link['minorid'];
                }
            }
            $linked_assets = array_unique($linked_assets);
        }
        $sq_asset_url_list = $GLOBALS['SQ_SYSTEM']->am->getAssetHref($linked_assets);

        // Find stored keyword replacements
        $paint_layout_keywords = Array();
        if (file_exists($this->data_path.'/conditional_keywords_to_eval')) {
            $required_keywords = array_keys(unserialize(file_to_string($this->data_path.'/conditional_keywords_to_eval')));
            $paint_layout_keywords = $this->_getAssetKeywordReplacements($asset, $required_keywords);
        }

        // Read in content file, find keyword replacements, spit out the results
        $content = '';
        if (file_exists($content_path)) {
            ob_start();
                include($content_path);
                $content = ob_get_contents();
                $keywords_in_condition = extract_keywords($content);
                $paint_layout_keywords = array_merge($paint_layout_keywords, $this->_getAssetKeywordReplacements($asset, $keywords_in_condition));
                replace_keywords($content, $paint_layout_keywords);
            ob_end_clean();
        } else {
            $this->setKeywordReplacements($this->_getAssetKeywordReplacements($asset, $this->getKeywords()));
            ob_start();
                $this->printBody();
                $content = ob_get_contents();
            ob_end_clean();
        }
        // end performance mode timer
        $GLOBALS['SQ_SYSTEM']->pm->stopTimer($this);

        return $content;

    }//end paintAsset()


    protected function _addRequiredKeywordsFromEvaluatedKeyword($evaluated_keyword, Array &$required_keywords)
    {
        // if the evaluated keyword is a logical condition, then gets the logical keywords it is relying on
        $condition_list = new Conditions_List($this, 'conditional_keywords');
        foreach ($condition_list->getRequiredKeywords($evaluated_keyword) as $required_keyword) {
            $required_keywords[$required_keyword] = 1;
        }

        // add at least the keyword that will be evaluated
        $required_keywords[$evaluated_keyword] = 1;

    }//end _addRequiredKeywordsFromEvaluatedKeyword()


    protected function _evaluateKeyword($keyword_name)
    {
        if (!isset($this->keyword_replacements[$keyword_name])) {
            return FALSE;
        }

        $value = trim($this->keyword_replacements[$keyword_name]);

        return ($value != '');

    }//end _evaluateKeyword()


    protected function _getKeywordValue($keyword)
    {
        // TODO: must optimise getAssetKeywordReplacements() with a cache
        $ret = $this->_getAssetKeywordReplacements($this->asset_to_paint, Array($keyword));

        $ret = isset($ret[$keyword]) ? $ret[$keyword] : '';

        return $ret;

    }//end _getKeywordValue()


    protected function &_getAssetKeywordReplacements(Asset &$asset, Array $required_keywords)
    {
        $ret = Array();

        foreach ($required_keywords as $required_keyword) {
            $full_keyword = $required_keyword;
            $required_keyword = parse_keyword($required_keyword, $modifiers);
            $context_array = extract_context_modifier($modifiers, 'both');
            $contextid = $context_array['id'];
            
            if ($contextid !== NULL) {
                // Save the required keyword with the context name
                $required_keyword .= '^context:'.$context_array['name'];
                $GLOBALS['SQ_SYSTEM']->changeContext($contextid);
                $contexted_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($asset->id);
            } else {
                $contexted_asset = $asset;
            }

            // 1. asset content
            if ($required_keyword == 'asset_contents') {
                if (!isset($ret['asset_contents'])) {
                    ob_start();
                        $contexted_asset->printBody();
                        $ret['asset_contents'] = ob_get_contents();
                    ob_end_clean();
                }
            } else if (substr($required_keyword, 0, 21) == 'asset_contents_paint_') {
                $paint_layout_name = substr($required_keyword, 21);
            
                // If a paint layout name has been specified, change that to an id
                if (assert_valid_assetid($paint_layout_name, '', TRUE, FALSE)) {
                    $paint_layout_id = $paint_layout_name;
                } else {
                    $paint_layout_id = $GLOBALS['SQ_SYSTEM']->am->getValueFromURL(preg_replace('/^[^:]*:\/\//', '', $asset->getURL()), 'paint_layout::user::'.$paint_layout_name);
                }
            
                if (assert_valid_assetid($paint_layout_id, 'Invalid paint layout specified in bodycopy #' . $this->id . ': ' . $paint_layout_name, FALSE, FALSE)) {
                    $paint_layout = $GLOBALS['SQ_SYSTEM']->am->getAsset($paint_layout_id, 'paint_layout_page');
                    if (!empty($paint_layout)) {
                        // A safeguard to mitigate users from easily creating a loop: check that the
                        // paint layout we're painting with is not the current one. If it is, just print
                        // the contents without painting again.
                        $type_formats = $paint_layout->getFormats();
                        if (!isset($type_formats[$this->id])) {
                            ob_start();
                            $contexted_asset->printBodyWithPaintLayout($paint_layout_id);
                            $ret[$required_keyword] = ob_get_contents();
                            ob_end_clean();
                        } else {
                            ob_start();
                            $contexted_asset->printBody();
                            $ret[$required_keyword] = ob_get_contents();
                            ob_end_clean();
                        }
                    }
                }
            } else {
                $ret[$required_keyword] = $contexted_asset->getKeywordReplacement($required_keyword);
            }//end else

            // If we have keyword modifiers AND
            // the keyword is not starting with 'globals_' which will be taken care at the end of execution of start() in mysource.ini
            if (($full_keyword != $required_keyword)  && (0 !== strpos($required_keyword, 'globals_'))) {
                // Start with the plain keyword without modifier
                $ret[$full_keyword] = $ret[$required_keyword];
                apply_keyword_modifiers($ret[$full_keyword], $modifiers, Array('assetid' => $contexted_asset->id));
            }

            if ($contextid !== NULL) {
                $GLOBALS['SQ_SYSTEM']->am->forgetAsset($contexted_asset);
                $GLOBALS['SQ_SYSTEM']->restoreContext();
            }
            
            unset($contexted_asset);
            
        }//end foreach

        // asset lineage
        if (in_array('asset_lineage', $required_keywords) || in_array('asset_lineage_linked', $required_keywords)) {
            
            preg_match('|^([^:]*)://(.*)|', $asset->getURL(), $matches);
            $url = !empty($matches[1]) ? $matches[1] : NULL;
            $protocol = !empty($matches[2]) ? $matches[2] : NULL;
            $asset_lineage = $GLOBALS['SQ_SYSTEM']->am->getLineageFromURL($url, $protocol);
            
            $ret['asset_lineage'] = '';
            $ret['asset_lineage_linked'] = '';
            $lineage_separator = ' > ';
            $lineage_separator = $this->attr('lineage_separator');

            foreach ($asset_lineage as $asset_lineage_item) {
                if (!empty($ret['asset_lineage'])) {
                    $ret['asset_lineage'] .= $lineage_separator;
                    $ret['asset_lineage_linked'] .= $lineage_separator;
                }
                $ret['asset_lineage'] .= $asset_lineage_item['short_name'];
                $ret['asset_lineage_linked'].='<a href="'.$asset_lineage_item['protocol'].'://'.$asset_lineage_item['url'].'">'.$asset_lineage_item['short_name'].'</a>';
            }
        }

        // 3. Conditions
        // TODO:
        // This will make this harder once the $required_keywords will be really applied by getAssetKeywords()
        // function, because the logical conditions may need other keywords which are not in $required_keywords
        $condition_list = new Conditions_List($this, 'conditional_keywords');
        $ret = array_merge($ret, $condition_list->evaluate($asset, $required_keywords, $ret, Array(FALSE, TRUE)));
        return $ret;

    }//end _getAssetKeywordReplacements()


    public function setAssociatedAssetType($asset_type='')
    {
        $this->setAttrValue('associated_asset_type', $asset_type);

    }//end setAssociatedAssetType()


    public function getAssociatedAssetType()
    {
        return $this->attr('associated_asset_type');

    }//end getAssociatedAssetType()


    public function getKeywordsDescription(Array &$keywords, $asset_type_code='')
    {
        if (is_array($keywords)) {

            // 1. asset content
            $keywords['asset_contents'] = translate('asset_contents');

            // 2. asset keywords (includes attributes)
            if (!empty($asset_type_code)) {
                $GLOBALS['SQ_SYSTEM']->am->includeAsset($asset_type_code);
                $asset = new $asset_type_code();
            } else {
                $asset = new Asset();
            }

            $asset_keywords = $asset->getAvailableKeywords();
            foreach ($asset_keywords as $keyword_name => $description) {
                $keywords[$keyword_name] = (empty($description)) ? ucwords(str_replace('_', ' ', $keyword_name)) : $description;
            }

            unset($asset);

            // lineage
            $keywords['asset_lineage'] = translate('asset_lineage');
            $keywords['asset_lineage_linked'] = translate('asset_lineage_linked');

            // 3. asset metadata
            $keywords['asset_metadata_'] = translate('asset_metadata_x');

            // 4. conditions
            $condition_list = new Conditions_List($this, 'conditional_keywords');
            $condition_names = $condition_list->getConditionsNames();

            foreach ($condition_names as $condition_name) {
                $keywords[$condition_name] = ucwords(str_replace('_', ' ', $condition_name));
                $keywords['begin_'.$condition_name] = translate('core_paint_layout_bodycopy_begin').' '.ucwords(str_replace('_', ' ', $condition_name));
                $keywords['else_'.$condition_name] = translate('core_paint_layout_bodycopy_else').' '.ucwords(str_replace('_', ' ', $condition_name));
                $keywords['end_'.$condition_name] = translate('core_paint_layout_bodycopy_end').' '.ucwords(str_replace('_', ' ', $condition_name));
                $keywords['begin_'.$condition_name.'%<br />%else_'.$condition_name.'%<br />%end_'.$condition_name] = translate('core_paint_layout_bodycopy_full').' '.ucwords(str_replace('_', ' ', $condition_name));
            }

            ksort($keywords);

        }//end if

    }//end getKeywordsDescription()


    public function linksUpdated()
    {
        unset($this->_tmp['containers']);
        parent::linksUpdated();
        if(!$this->_updated()) return FALSE;
        return TRUE;
        
    }// end linksUpdated()


}//end class

?>