wysiwyg.inc

<?php
require_once SQ_ATTRIBUTES_PATH.'/text/text.inc';
require_once SQ_FUDGE_PATH.'/wysiwyg/wysiwyg.inc';

class Asset_Attribute_WYSIWYG extends Asset_Attribute_Text
{


    function Asset_Attribute_WYSIWYG($attributeid=0, $value=null)
    {
        $this->Asset_Attribute_Text($attributeid, $value);

        // Get the WYSIWYG style from the global preference as the default settings
        $wysiwyg_style = $GLOBALS['SQ_SYSTEM']->getUserPrefs('content_type_wysiwyg', 'SQ_WYSIWYG_STYLE');
        $size_unit = '';
        if (is_numeric($wysiwyg_style['width']) && isset($wysiwyg_style['units']['width'])) {
            $size_unit = $wysiwyg_style['units']['width'];
        }

        // set default edit parameters
        $this->_edit_params['style']        = $wysiwyg_style['body_type'];
        $this->_edit_params['width']        = $wysiwyg_style['width'].$size_unit;
        $this->_edit_params['height']       = $wysiwyg_style['height'].$size_unit;
        $this->_edit_params['tidy_status']  = 'wait';
        $this->_edit_params['tidy_errors']  = '';

    }//end constructor


    function setEditParams(&$node)
    {
        if (!parent::setEditParams($node)) return false;

        if (isset($node->attributes()->style))  $this->_edit_params['style']  = (string)$node->attributes()->style;
        if (isset($node->attributes()->width))  $this->_edit_params['width']  = (string)$node->attributes()->width;
        if (isset($node->attributes()->height)) $this->_edit_params['height'] = (string)$node->attributes()->height;

        return true;

    }//end setEditParams()


    function &_createEditor($prefix)
    {
        // allowed plugins (shortened to $ap for easier use below)
        $ap = explode('|', $GLOBALS['SQ_SYSTEM']->getUserPrefs('content_type_wysiwyg', 'SQ_WYSIWYG_PLUGINS'));
        // ignore allowed plugins (shortened to $iap for easier use);
        $iap = in_array('all', $ap);

        $wysiwyg = new wysiwyg($prefix, sq_web_path('fudge').'/wysiwyg/');

        $wysiwyg->set_body_type($this->_edit_params['style']);
        $wysiwyg->set_init_onload(false);
        $wysiwyg->set_show_status_bar(false);
        $wysiwyg->set_width($this->_edit_params['width']);
        $wysiwyg->set_height($this->_edit_params['height']);

        // Bug fix #5092 Asset Builder insert link via WYSIWYG removing the dot (.) before the /?a=
        // remove ANY suffix from our URL or ele the regex working on it will result in malformed output
        $base_php_self = str_replace('/'.SQ_CONF_BACKEND_SUFFIX, '', $_SERVER['PHP_SELF']);
        $base_php_self = str_replace('/'.SQ_CONF_LIMBO_SUFFIX, '', $base_php_self);
        $base_php_self = str_replace('/'.SQ_CONF_NOCACHE_SUFFIX, '', $base_php_self);
        $base_php_self = str_replace('/'.SQ_CONF_RECACHE_SUFFIX, '', $base_php_self);
        $base_php_self = rtrim($base_php_self, '/ ');

        $wysiwyg->add_relative_href_check('(http[s]?://'.$_SERVER['HTTP_HOST'].')'.$_SERVER['PHP_SELF'], '$1'.$base_php_self);
        $wysiwyg->add_relative_href_check('http[s]?://'.$_SERVER['HTTP_HOST'].$base_php_self.'/?(\?a=[0-9]+)', './$1');
        $wysiwyg->add_relative_href_check('([^.][^/])(\?a=[0-9]+)', '$1./$2');
        $wysiwyg->add_relative_href_check('http[s]?://'.$_SERVER['HTTP_HOST'].$base_php_self.'/?%([a-zA-Z_\-0-9]+)%', '%$1%');
        $wysiwyg->add_absolute_url_check('\./\?(a=[0-9]+)', 'http://'.$_SERVER['HTTP_HOST'].$base_php_self.'/?$1');

        // get the keyword replacements
        $em = $GLOBALS['SQ_SYSTEM']->getEventManager();
        $keywords = Array();
        $keyword_vars = Array('keywords' => &$keywords);
        $em->broadcastEvent($asset, 'requestKeywords', $keyword_vars);

        $wysiwyg->open_group();
            if ($iap || in_array('format_text', $ap)) {
                $wysiwyg->add_plugin('format_text');
            }
            if ($iap || in_array('replace_text', $ap)) {
                $wysiwyg->add_plugin('replace_text');
            }
            if ($iap || in_array('search_and_replace', $ap)) {
                $wysiwyg->add_plugin('search_and_replace');
            }
            if ($iap || in_array('format_font', $ap)) {
                $wysiwyg->add_plugin('format_font');
            }
            if ($iap || in_array('general', $ap)) {
                $wysiwyg->add_plugin('general');
            }
            if ($iap || in_array('s_script', $ap)) {
                $wysiwyg->add_plugin('s_script');
            }
        $wysiwyg->close_group();

        $wysiwyg->open_group();
            if ($iap || in_array('matrix_apply_style', $ap)) {
                $wysiwyg->add_plugin('matrix_apply_style');
            }
        $wysiwyg->close_group();

        if ($iap || in_array('justify_text', $ap)) {
            $wysiwyg->add_plugin('justify_text');
        }
        if (($iap || in_array('keyword_replace', $ap)) && !empty($keywords)) {
            $wysiwyg->add_plugin('keyword_replace');
            $keyword_replace =& $wysiwyg->get_plugin('keyword_replace');
            $keyword_replace->keyword_tag = '%';
            $keyword_replace->keywords = $keywords;
        }

        // Snippet global keyword dropdown
        // However if in frontend do not include this plugin, as it will output global keywords
        $snippets = $GLOBALS['SQ_SYSTEM']->am->getSnippetKeywords();
        if ((SQ_IN_BACKEND || SQ_IN_LIMBO) && ($iap || in_array('snippet_keyword_replace', $ap)) && !empty($snippets)) {
            $wysiwyg->add_plugin('snippet_keyword_replace');
            $snippet_keyword_replace =& $wysiwyg->get_plugin('snippet_keyword_replace');
            $snippet_keyword_replace->keyword_tag = '%';
            $snippet_keyword_replace->keywords = $snippets;
        }

        if ($iap || in_array('history', $ap)) {
            $wysiwyg->add_plugin('history');
        }
        if ($iap || in_array('indenting', $ap)) {
            $wysiwyg->add_plugin('indenting');
        }
        if ($iap || in_array('listing', $ap)) {
            $wysiwyg->add_plugin('listing');
        }
        if ($iap || in_array('table_editing', $ap)) {
            $wysiwyg->add_plugin('table_editing');
        }
        if ($iap || in_array('select_color', $ap)) {
            $wysiwyg->add_plugin('select_color');
        }

         $wysiwyg->open_group();
                if ($iap || in_array('matrix_insert_link', $ap) || in_array('insert_link', $ap)) {
                    $wysiwyg->add_plugin('matrix_insert_link');
                }
                if ($iap || in_array('matrix_insert_quick_link', $ap)) {
                    $wysiwyg->add_plugin('matrix_insert_quick_link');
                }
                if ($iap || in_array('matrix_insert_anchor', $ap) || in_array('insert_anchor', $ap)) {
                    $wysiwyg->add_plugin('matrix_insert_anchor');
                }
                if ($iap || in_array('matrix_insert_image', $ap) || in_array('insert_image', $ap)) {
                    $wysiwyg->add_plugin('matrix_insert_image');
                }
                if ($iap || in_array('matrix_embed_movie', $ap)) {
                    $wysiwyg->add_plugin('matrix_embed_movie');
                }
                if ($iap || in_array('matrix_embed_youtube', $ap)) {
                    $wysiwyg->add_plugin('matrix_embed_youtube');
                }
        $wysiwyg->close_group();

        $wysiwyg->open_group();
            if ($iap || in_array('matrix_accessibility', $ap)) {
                $wysiwyg->add_plugin('matrix_accessibility');
            }
        $wysiwyg->close_group();

        // html_tidy needs to be last so other plugins can set options
        if ($iap || in_array('html_tidy', $ap)) {
            $wysiwyg->add_plugin('html_tidy');
        }

        if ($iap || in_array('matrix_expand_keywords', $ap)) {
            $wysiwyg->add_plugin('matrix_expand_keywords');
        }

        $wysiwyg->open_group();
            if ($iap || in_array('special_chars', $ap)) {
                $wysiwyg->add_plugin('special_chars');
            }
        $wysiwyg->close_group();

        $wysiwyg->open_group();
            if ($iap || in_array('choose_language', $ap)) {
                $wysiwyg->add_plugin('choose_language');
            }
        $wysiwyg->close_group();

        $wysiwyg->open_group();
            if ($iap || in_array('definition_list', $ap)) {
                $wysiwyg->add_plugin('definition_list');
            }
        $wysiwyg->close_group();

        $wysiwyg->open_group();
            if ($iap || in_array('misc_accessibility', $ap)) {
                $wysiwyg->add_plugin('misc_accessibility');
            }
            if ($iap || in_array('quotation', $ap)) {
                $wysiwyg->add_plugin('quotation');
            }
        $wysiwyg->close_group();

        $wysiwyg->open_group();
            if ($iap || in_array('visual_aid', $ap)) {
                $wysiwyg->add_plugin('visual_aid');
            }
        $wysiwyg->close_group();

        $wysiwyg->open_group();
            if ($iap || in_array('spell_checker', $ap)) {
                $wysiwyg->add_plugin('spell_checker');
            }
            if ($iap || in_array('text_indicator', $ap)) {
                $wysiwyg->add_plugin('text_indicator');
            }
            if ($iap || in_array('view_source', $ap)) {
                $wysiwyg->add_plugin('view_source');
            }
        $wysiwyg->close_group();

        $wysiwyg->set_contents($this->value);

        return $wysiwyg;

    }//end _createEditor()


    function paint($prefix, $read_only=false)
    {
        if ($read_only) {
            echo $this->value;
            return;
        }

        $wysiwyg = $this->_createEditor($prefix);

        if (!(SQ_IN_BACKEND || SQ_IN_LIMBO)) echo '<script type="text/javascript" src="'.sq_web_path('lib').'/js/edit.js"></script>';

        ?>
        <script type="text/javascript">
            var bodycopy_initialised = true;
        </script>
        <div style="border: 1px dashed #C0C0C0;" id="<?php echo $prefix.'_switch_option_div'; ?>">
            <table width="100%">
                <tr>
                    <td align="left">
                        <div style="width: 16px; height: 16px; background: url(<?php echo sq_web_path('lib')?>/web/images/icons/edit_mode.png);background: expression('none');filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='<?php echo sq_web_path('lib')?>/web/images/icons/edit_mode.png', sizingMethod='scale'); font-size:10px; cursor:pointer;"
                onclick="switchEditingMode('<?php echo $prefix; ?>_contents_div','<?php echo $prefix; ?>_wysiwyg_div', editor_<?php echo $prefix; ?>);">
                        </div>
                    </td>
                    <td align="right">
                        <?php echo $this->paintBackendStatusIcons($wysiwyg); ?>
                    </td>
                </tr>
            </table>
        </div>
        <div style="border-left: 1px dashed #C0C0C0; border-right: 1px dashed #C0C0C0; border-bottom: 1px dashed #C0C0C0;">
            <div style="display:none;" id="<?php echo $prefix?>_wysiwyg_div"><?php echo $wysiwyg->paint()?></div>
            <div id="<?php echo $prefix?>_contents_div" onclick="editDiv=document.getElementById('<?php echo $prefix ?>_wysiwyg_div'); if (editDiv.style.display == 'none') {switchEditingMode('<?php echo $prefix ?>_contents_div','<?php echo $prefix ?>_wysiwyg_div', editor_<?php echo $prefix ?>);}"><?php echo $this->value?></div>
        </div>
        <?php

    }//end paint()


    function process($prefix, $owner_id=NULL, $cmp_value=TRUE)
    {
        $wysiwyg = $this->_createEditor($prefix);

        $html = $wysiwyg->process();

        $this->processed = FALSE;
        if ($html !== FALSE && (!$cmp_value || $html !== $this->value) && $this->setValue($html, $owner_id)) {
            $this->processed = TRUE;
        }
        $this->_edit_params['tidy_status'] = isset($wysiwyg->_loaded_plugins['html_tidy']->htmltidy_status) ? $wysiwyg->_loaded_plugins['html_tidy']->htmltidy_status : 'wait';
        $this->_edit_params['tidy_errors'] = isset($wysiwyg->_loaded_plugins['html_tidy']->htmltidy_errors) ? $wysiwyg->_loaded_plugins['html_tidy']->htmltidy_errors : '';

    }//end process()


    function getKeywordValue($format='')
    {
        if (!in_array($format, Array('', 'disableurls', 'disablekeywords', 'disableall'))) {
            return '';
        }

        $output = $this->value;

        if (!in_array($format, Array('disableurls', 'disableall'))) {
            $matches = Array();
            preg_match_all('|\\./\\?a=([0-9]+)([^0-9:])|', $output, $matches);
            $normal_assetids = empty($matches[1]) ? Array() : $matches[1];
            $matches = Array();
            preg_match_all('|\\./\\?a=([0-9]+:[^$]*)\\$|', $output, $matches, PREG_PATTERN_ORDER);
            $shadow_assetids = empty($matches[1]) ? Array() : $matches[1];
            $assetids = array_unique(array_merge($normal_assetids, $shadow_assetids));
            $urls = $GLOBALS['SQ_SYSTEM']->am->getAssetUrl($assetids);
            $output = $this->value;
            foreach ($urls as $id => $url) {
                if (FALSE === strpos($id, ':')) {
                    if (!empty($url)) {
                        $output = str_replace('./?a='.$id, $url, $output);
                    }
                } else {
                    if (!empty($url)) {
                        $output = str_replace('./?a='.$id.'$', $url, $output);
                    } else {
                        $output = str_replace('./?a='.$id.'$', './?a='.$id, $output);
                    }
                }
            }
        }

        if (in_array($format, Array('disablekeywords', 'disableall'))) {
            // Simulate 'disable keywords' from bodycopy_container
            // by encoding %s
            $keywords = retrieve_keywords_replacements($output);
            foreach ($keywords as $keyword) {
                $output = str_replace("%$keyword%", "&#37;{$keyword}&#37;", $output);
            }
        }

        return $output;

    }//end getKeywordValue()


    function setValue(&$value, $owner_id = NULL)
    {
        if (!empty($owner_id)) {
            $live_link_only = $GLOBALS['SQ_SYSTEM']->getUserPrefs('content_type_wysiwyg', 'SQ_LIVE_LINK_ONLY');
            $asset_info = $GLOBALS['SQ_SYSTEM']->am->getAssetInfo($owner_id);
            if ($asset_info[$owner_id]['status'] == SQ_STATUS_LIVE && $live_link_only) {
                require_once SQ_FUDGE_PATH.'/general/www.inc';
                $outcome = check_non_live_link($value, $owner_id);
                if ($outcome !== FALSE) $value = $outcome;
            }
        }

        return parent::setValue($value);

    }//end setValue()


    public function paintBackendStatusIcons($wysiwyg)
    {
        require_once SQ_DATA_PATH.'/private/conf/tools.inc';
        require_once SQ_CORE_PACKAGE_PATH.'/bodycopy/bodycopy/bodycopy_edit_fns.inc';

        // prints the status of the last run of htmltidy tool as a tag icon
        if (!SQ_TOOL_HTML_TIDY_ENABLED || !file_exists(SQ_TOOL_HTML_TIDY_PATH)) {
            // tool is not enabled
            Bodycopy_Edit_Fns::printBodycopyIcon('', 'HTMLTidy Status', translate('wysiwyg_htmltidy_status_disabled'), 'htmltidy_disabled', '[HTMLTidy Status]');
        } else {

            $status = $this->_edit_params['tidy_status'];
            $status_msg = translate('wysiwyg_htmltidy_status_wait');
            $image_filename = 'htmltidy_'.$status;
            switch ($status) {
                case 'pass':
                    $status_msg = translate('wysiwyg_htmltidy_status_pass');
                break;
                case 'fail':
                    $status_msg = translate('wysiwyg_htmltidy_status_fail');
                break;
                case 'wait':
                    $status_msg = translate('wysiwyg_htmltidy_status_wait');
                break;
            }//end switch

            Bodycopy_Edit_Fns::printBodycopyIcon('', 'HTMLTidy Status', $status_msg, $image_filename, '[HTMLTidy Status]');

            $res = (str_replace('
', '<br />', htmlentities($this->_edit_params['tidy_errors'], ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET)));

            $htmltidy_accessibility_filename = 'accessibility_'.(empty($res) ? 'pass' : 'fail');
            Bodycopy_Edit_Fns::printBodycopyIcon('', 'HTMLTidy Accessibility', !empty($res) ? $res : translate('wysiwyg_htmltidy_accessibility_no_warning'), $htmltidy_accessibility_filename, '[HTMLTidy Status]');

        }

    }//end paintBackendStatusIcons()


}//end class

?>