backend_outputter.inc

<?php
require_once SQ_LIB_PATH.'/html_form/html_form.inc';

// just normal messages, eg update confirmations
define('SQ_BO_MSG_NOTICE',  1);
// warnings, you entered something a bit a-miss and the system fixed it up for you
define('SQ_BO_MSG_WARNING', 2);
// something is just plain wrong, fix immediately
define('SQ_BO_MSG_ERROR',   4);


class Backend_Outputter
{

    // any messages to be displayed to the user
    var $_messages = Array();

    // an link to redirect to when we print, any messages will be carried over to the next page
    var $_redirect = '';
    var $_redirect_target = '';

    // an array of fns to be called when the page loads
    var $_on_load_calls = Array();

    // an array assets that are going to be refreshed in the flash menu
    var $_refreshing_assets = Array();

    // the form action
    var $_action  = '';

    // form GET vars that the backend outputter will endevour to ensure are on each screen
    var $_persistant_get_vars = Array();

    // the anchor the form will be submitted to
    var $_anchor  = '';

    // the page heading
    var $_page_title = '';
    var $_heading  = '';
    var $_heading_icon = '';
    var $_sub_heading = '';

    // stylesheet files to include
    var $_css_includes = Array();

    // javascript files to include
    var $_js_includes = Array();

    // an array of fns to be called when the form is submitted
    var $_on_submit_calls = Array();

    // hidden fields for the form Array([field name] => [value])
    var $_hidden_fields = Array();

    // edit screens
    var $_screens = Array();
    var $_static_screens = Array();

    // the contents of the page split into sections
    var $_contents = Array();

    // used to make sure that each img gets a unique name
    var $_img_button_count = 0;

    // all the preload images names on the page and their preloaded images
    // Array(name => img);
    var $_preload_imgs = Array();

    var $_files_path;

    var $_raw_opened = FALSE;

    var $_section_stack = Array();
    var $_current_field = NULL;

    var $_section_count = 0;
    var $_field_count   = 0;

    var $_charset = '';

    var $_buffering = TRUE;

    var $_is_open_section = FALSE;

    var $_is_open_field = FALSE;

    var $_current_field_type = '';

    var $_current_field_note = '';

    var $_nb_section_count = 0;


    function Backend_Outputter()
    {

        // if there are some messages from the previous page we had better add them in
        if (!empty($_SESSION['backend_outputter_msgs'])) {
            $this->_messages = $_SESSION['backend_outputter_msgs'];
            $_SESSION['backend_outputter_msgs'] = Array();
        }

        $this->_files_path = sq_web_path('lib').'/web';
        $this->_action = $_SERVER['PHP_SELF'];

        // register that we want to listen to link update events
        $em = $GLOBALS['SQ_SYSTEM']->getEventManager();

        $em->addEventListener($this, Array(
                                        'CreateLink',
                                        'DeleteLink',
                                        'AssetUpdate',
                                        'AssetTypeUpdate',
                                        'BackendMessage',
                                        'AssetStatusUpdate',
                                     )
                            );

    }//end constructor


    function setBuffering($buffer=TRUE)
    {
        $this->_buffering = (bool) $buffer;
        return TRUE;

    }//end setBuffering()


    function setRedirect($link, $target='self')
    {
        // ensure that any persistant GET vars are appended to the redirect URL
        $link_extras = '';
        foreach ($this->_persistant_get_vars as $name => $value) {
            $link_extras .= '&'.rawurlencode($name).'='.rawurlencode($value);
        }
        $link_extras = trim($link_extras, ' &');
        if (!empty($link_extras)) {
            $link .= ((strstr($link, '?')) ? '&' : '?').$link_extras;
        }

        $this->_redirect = trim($link);
        $this->_redirect_target = trim($target);

    }//end setRedirect()


    function addOnLoad($call)
    {
        $this->_on_load_calls[] = $call;

    }//end addOnLoad()


    function addFormActionGetVar($name, $value, $persistant=FALSE)
    {
        if (FALSE === strpos($this->_action, '?')) {
            $url = $this->_action;
            $query = '';
        } else {
            list($url, $query) = explode('?', $this->_action);
        }
        $this->_action = replace_query_string_vars(Array($name => rawurlencode($value)), $url, $query);
        if ($persistant) {
            $this->_persistant_get_vars[$name] = $value;
        }

    }//end addFormActionGetVar()


    function getCurrentLocation()
    {
        return $this->_action;

    }//end getCurrentLocation()


    function setFormAnchor($anchor)
    {
        $anchor = trim($anchor);
        $this->_anchor = ($anchor) ? '//'.rawurlencode($anchor) : '';

    }//end setFormAnchor()


    function setPageTitle($title)
    {
      $this->_page_title = trim($title);

    }//end setPageTitle()


    function setHeading($heading, $icon='')
    {
        $this->_heading = trim($heading);
        $this->_heading_icon = $icon;

    }//end setHeading()


    function setSubHeading($heading, $icon='')
    {
        $this->_sub_heading = trim($heading);

    }//end setSubHeading()


    function addMessage($type, $msg)
    {
        $msg = trim($msg);
        // if the type is valid and there is a message
        if (strlen($msg)) {
            $this->_messages[] = Array('type' => $type, 'msg' => $msg);
        }

    }//end addMessage()


    function addCssInclude($file)
    {
        if (in_array($file, $this->_css_includes)) return;
        $this->_css_includes[] = $file;

    }//end addCssInclude()


    function addJsInclude($file)
    {
        if (in_array($file, $this->_js_includes)) return;
        $this->_js_includes[] = $file;

    }//end addJsInclude()


    function addOnSubmit($call)
    {
        $this->_on_submit_calls[] = $call;

    }//end addOnSubmit()


    function addHiddenField($name, $value='')
    {
        $this->_hidden_fields[$name] = $value;

    }//end addHiddenField()


    function addScreen($url, $name)
    {
        if (empty($url)) return;
        if (in_array($name, $this->_screens)) {
            trigger_localised_error('SYS0202', E_USER_ERROR, $name);
        }
        $this->_screens[$url] = $name;

    }//end addScreen()


    function addStaticScreen($url, $name)
    {
        if (empty($url)) return;
        if (in_array($name, $this->_static_screens)) {
            trigger_localised_error('SYS0207', E_USER_ERROR, $name);
        }
        $this->_static_screens[$url] = $name;

    }//end addStaticScreen()


    function addPreloadImg($file)
    {
        $this->_preload_imgs[] = $file;

    }//end addPreloadImg()


    function setCharset($charset)
    {
        $this->_charset = $charset;

    }//end setCharset()


    function openRaw()
    {
        $init_arr = Array(
                        'area_type' => 'section',
                        'type'      => 'raw',
                        'contents'  => '',
                    );

        $ret_val = $this->_openSection($init_arr);
        ob_start();
        $this->_raw_opened = TRUE;
        return $ret_val;

    }//end openRaw()


    function closeRaw()
    {
        if (!$this->_raw_opened) return;
        $stack_i = count($this->_section_stack) - 1;
        $this->_section_stack[$stack_i]['contents'] = ob_get_contents();
        ob_end_clean();
        $this->_raw_opened = FALSE;
        $this->_closeSection();

    }//end closeRaw()


    function openSection($heading='', $icon='')
    {
        $init_arr = Array(
                        'area_type' => 'section',
                        'type'      => 'normal',
                        'heading'   => $heading,
                        'icon'      => $icon,
                        'areas'     => Array(),
                    );
        return $this->_openSection($init_arr);

    }//end openSection()


    function closeSection()
    {
        if (!is_null($this->_current_field)) {
            $this->closeField();
        }

        if ($this->_buffering) {
            $this->_closeSection();
        } else {
            $this->_nbCloseSection();
            $this->_nb_section_count--;
            if ($this->_nb_section_count == 0) {
                $this->_is_open_section = FALSE;
            }
        }

    }//end closeSection()


    function _openSection($init_arr)
    {
        if ($this->_is_open_field) $this->closeField();

        if ($this->_buffering) {
            if (!is_null($this->_current_field)) {
                $this->closeField();
            }
            if ($this->_raw_opened) $this->closeRaw();

            $this->_section_count++;
            $init_arr['section_count'] = $this->_section_count;

            // Nothing in the stack ? we are in the top level
            if (empty($this->_section_stack)) {
                $j = count($this->_contents);
                $this->_contents[$j] = $init_arr;
                $this->_section_stack[] =& $this->_contents[$j];
            } else {
                $i = count($this->_section_stack) - 1;
                $j = count($this->_section_stack[$i]['areas']);
                $this->_section_stack[$i]['areas'][$j] = $init_arr;
                $this->_section_stack[] =& $this->_section_stack[$i]['areas'][$j];
            }

            return 'section_'.$this->_section_count;

        } else {
            $this->_nbOpenSection($init_arr);
        }

    }//end _openSection()


    function _nbOpenSection($init_arr)
    {
        if ($this->_nb_section_count > 0) echo '<tr><td>';

        $this->_nb_section_count++;

        ?>
        <a name="section_<?php echo $this->_nb_section_count; ?>"></a>
        <table class="sq-backend-section-table">
        <?php
        if (isset($init_arr['heading']) && $init_arr['heading']) {
            if ($this->_is_open_section) {
                // printing a nested section - needs to look a little different
                ?>
                <tr>
                    <td class="sq-backend-section-subheading"><?php echo $init_arr['heading'];?></td>
                </tr>
                <?php
            } else {
                $this->_is_open_section = TRUE;
                // printing a top level section
                ?>
                <tr class="sq-backend-section-heading-container">
                    <td>
                        <table border="0" cellspacing="0" cellpadding="0">
                            <tr>
                                <td class="sq-backend-section-heading"><?php echo $init_arr['heading'];?></td>
                                <td><img src="<?php echo $this->filesPath('images/section_icon.gif');?>" width="27" height="21" /></td>
                            </tr>
                        </table>
                    </td>
                </tr>
                <?php
            }//endif
        }//endif

        ?>
            <tr>
                <td>
                    <table class="sq-backend-section-table-inner">
        <?php


    }//end _nbOpenSection()


    function _closeSection()
    {
        if ($this->_buffering) {
            array_pop($this->_section_stack);
        } else {
            $this->_nbCloseSection();
        }

    }//end _closeSection()


    function _nbCloseSection()
    {
        if ($this->_nb_section_count > 0) echo '</td></tr>';

        ?>
                    </table>
                </td>
            </tr>
        </table>
        <?php

    }//end _nbCloseSection()


    function openField($name, $format='', $note='', $hidden=FALSE, $id_name='')
    {
        if ($this->_buffering) {
            if (!is_null($this->_current_field)) {
                $this->closeField();
            }
            if (empty($this->_section_stack)) $this->openSection();
            if (!trim($name)) $name = '&nbsp;';

            $this->_field_count++;

            $stack_i = count($this->_section_stack) - 1;
            $i = count($this->_section_stack[$stack_i]['areas']);
            $this->_section_stack[$stack_i]['areas'][$i] = Array(
                                                            'area_type'     => 'field',
                                                            'type'          => 'normal',
                                                            'field_count'   => $this->_field_count,
                                                            'name'          => $name,
                                                            'format'        => $format,
                                                            'note'          => $note,
                                                            'contents'      => '',
                                                            'hidden'        => $hidden,
                                                            'id_name'       => $id_name,
                                                           );

            $this->_current_field =& $this->_section_stack[$stack_i]['areas'][$i];
            ob_start();

            return 'field_'.$this->_field_count;

        } else {
            // we are not buffering
            $this->_nbOpenField($name, $format, $note, $hidden);
        }

    }//end openField()


    function _nbOpenField($name, $format='', $note='', $hidden=FALSE)
    {
        if ($this->_is_open_field) $this->closeField();
        $this->_is_open_field = TRUE;

        // store the format and note of the current field for future reference
        $this->_current_field_type = $format;
        $this->_current_field_note = $note;

        switch ($format) {
            case 'new_line' :
                ?>
                <tr <?php if ($hidden) echo 'style="display: none"'; ?>>
                    <td class="sq-backend-field sq-backend-field-newline" colspan="2">
                        <a name="field_<?php echo $this->_field_count; ?>"></a>
                        <?php echo $name;?>
                    </td>
                </tr>
                <tr <?php if ($hidden) echo 'style="display: none"'; ?>>
                    <td class="sq-backend-data sq-backend-data-newline" colspan="2">
                <?php
            break;

            case 'commit' :
                ?>
                <tr <?php if ($hidden) echo 'style="display: none"'; ?>>
                    <td class="sq-backend-data" style="text-align: right;" colspan="2">
                <?php
            break;

            case 'blank' :
                // a blank field to be used just for formatting
            break;

            default :
                ?>
                <tr <?php if ($hidden) echo 'style="display: none"'; ?>>
                    <td class="sq-backend-field">
                        <a name="field_<?php echo $this->_field_count; ?>"></a>
                        <?php echo $name;?>
                    </td>
                    <td class="sq-backend-data">
                <?php
        }//end switch

    }//end _nbOpenField()


    function closeField()
    {

        if ($this->_buffering) {
            if (is_null($this->_current_field)) return;
            $this->_current_field['contents'] = ob_get_contents();
            ob_end_clean();
            // unset the reference before setting to null, so we don't blow away the field's array
            unset($this->_current_field);
            $this->_current_field = NULL;
        } else {
            $this->_nbCloseField();
        }

    }//end closeField()


    function _nbCloseField()
    {
        $this->_is_open_field = FALSE;

        // We need to end the field that we started
        // Because they all start differently, we have to end what we started
        switch ($this->_current_field_type) {

            case 'blank' :
                // a blank field to be used just for formatting
            break;

            default :
                if ($this->_current_field_note) {
                    $this->note($this->_current_field_note);
                }
                ?>
                    </td>
                </tr>
                <?php
        }//end switch

    }//end _nbCloseField()


    function filesPath($file='')
    {
        if ($file && substr($file, 0, 1) != '/') {
            $file = '/'.$file;
        }
        return $this->_files_path.$file;

    }//end filesPath()


    function paint()
    {
        if ($this->_raw_opened) $this->closeRaw();
        // close all sections
        while (!empty($this->_section_stack)) {
            $this->closeSection();
        }

        if ($this->_redirect) {
            // save the messages so they come through on the next page
            $_SESSION['backend_outputter_msgs'] = $this->_messages;
            $this->addOnLoad($this->_redirect_target.'.location = "'.addslashes($this->_redirect).'";');
        }

        $this->_paintHeader();

        if (!$this->_redirect) {
            for ($i = 0; $i < count($this->_contents); $i++) {
                $this->_paintSection($this->_contents[$i]);
            }
        }

        $this->_paintFooter();

    }//end paint()


    function getAsString()
    {
        ob_start();
            $this->paint();
            $str = ob_get_contents();
        ob_end_clean();

        return $str;

    }//end getAsString()


    function _paintHeader()
    {
        if (!headers_sent()) {
            if ($this->_charset) {
                header('Content-type: text/html; charset='.$this->_charset);
            } else {
                header('Content-type: text/html; charset='.SQ_CONF_DEFAULT_CHARACTER_SET);
            }
        }
        ?>
        <html>
        <head>
            <title><?php echo htmlspecialchars(str_replace('&nbsp;', ' ', $this->_page_title)); ?></title>
            <?php
            $this->addCssInclude($this->filesPath('css/edit.css'));
            if (!empty($_REQUEST['print_view'])) {
                $this->addCssInclude($this->filesPath('css/print.css'));
                $this->addOnLoad('pagePrint()');
            }

            foreach ($this->_css_includes as $file) {
                $this->_paintCssInclude($file);
            }

            // Add IE6-specific styles if main frame AND "lock commit button to frame" preference turned on
            if ((array_get_index($_GET, 'SQ_BACKEND_PAGE') == 'main') && SQ_IN_BACKEND && $GLOBALS['SQ_SYSTEM']->getUserPrefs('user', 'SQ_USER_COMMIT_BUTTON_POS')) {

                // Bug #3096 - Printing incorrectly in IE
                // Associated with the CSS involved with hanging the Commit Button to the bottom of the page
                // If print_view is not enabled show the commit button code
                if (!isset($_REQUEST['print_view'])) {
                ?>
                <!--[if gte IE 6]>
                    <link href="<?php echo $this->filesPath('css/edit_ie6.css') ?>" type="text/css" rel="stylesheet" />
                <![endif]-->
                <?php
                }//end if
            }

            // first add the js translation files
            foreach ($GLOBALS['SQ_SYSTEM']->lm->getJavascriptIncludes() as $js_include) {
                $this->addJsInclude($js_include);
            }

            // now other general stuff
            $this->addJsInclude(sq_web_path('lib').'/html_form/html_form.js');
            $this->addJsInclude(sq_web_path('lib').'/js/general.js');
            $this->addJsInclude(sq_web_path('lib').'/js/backend_search.js');
            $this->addJsInclude(sq_web_path('lib').'/js/debug.js');
            $this->addJsInclude(sq_web_path('lib').'/js/edit.js');
            $this->addJsInclude(sq_web_path('lib').'/js/state.js');
            $this->addJsInclude(sq_web_path('lib').'/js/tooltip.js');
            $this->addOnLoad('fixIcons(\''.sq_web_path('lib').'/web/images/blank.gif\');');

            // and paint them all out
            foreach ($this->_js_includes as $file) {
                $this->_paintJsInclude($file);
            }
            ?>
            <script type="text/javascript"><!--
            //<![CDATA[
                var SQ_DOCUMENT_LOADED = false;
                function page_on_load()
                {
                    <?php
                    if (isset($_SESSION['backend_outputter_msgs'])) {
                        $this->_messages = array_merge($this->_messages, $_SESSION['backend_outputter_msgs']);
                        $_SESSION['backend_outputter_msgs'] = Array();
                    }
                    if (count($this->_messages)) {
                        require_once 'XML/Tree.php';
                        require_once SQ_INCLUDE_PATH.'/general_occasional.inc';
                        $msgs = new XML_Tree();
                        $msgs_root = $msgs->addRoot('messages');
                        foreach ($this->_messages as $data) {
                            $msg_body = '<p>'.htmlentities(nl2br($data['msg']), ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET).'</p>';
                            $msg_body .= '<span style="color: #333333">'.$GLOBALS['SQ_SYSTEM']->datetime().'<span>';
                            $msgs_root->addChild('message', $msg_body, Array('type' => get_bit_names('SQ_BO_MSG_', $data['type'])));
                        }
                        ?>
                        if (parent.frames["sq_sidenav"] && parent.frames["sq_sidenav"].add_messages) {
                            parent.frames["sq_sidenav"].add_messages("<?php echo str_replace(Array("\r\n", "\n", "\r"), "\\n", addslashes($msgs->get())); ?>");
                        }
                        <?php
                    }//end if messages
                    ?>

                    if (window.self.name == 'sq_main') {
                        tooltip.print();
                    }

                    <?php
                    foreach ($this->_on_load_calls as $call) {
                        echo "\n".$call;
                    }
                    ?>

                    // let everyone know the document is loaded
                    SQ_DOCUMENT_LOADED = true;

                    // if IE
                    if (document.all) {
                        if (document.getElementById('sq-commit-button-div')) {
                            commit_div = document.getElementById('sq-commit-button-div');
                            if (commit_div.currentStyle && (commit_div.currentStyle.position == 'absolute')) {
                                document.body.style.paddingBottom = (commit_div.clientHeight + 2) + "px";
                            }
                        }
                    } else {
                        if (document.getElementById('sq-commit-button-div')) {
                            document.getElementById('sq-commit-button-spacer').style.height = (document.getElementById('sq-commit-button-div').clientHeight + 2) + "px";
                        }
                    }

                    // Remember state
                    resetChanges();
                    document.forms[0]['state'].value = saveState();

                }//end page_on_load()


                function page_on_unload()
                {
                    if (parent.frames['sq_sidenav'] && window.self.name == 'sq_main' && parent.frames['sq_sidenav'].asset_finder_onunload) {
                        parent.frames['sq_sidenav'].asset_finder_onunload();
                    }

                }//end page_on_unload()


                var SQ_FORM_SUBMITTED = false;
                var SQ_FORM_ERROR_CONTAINED = false;
                function form_on_submit()
                {
                    if (SQ_FORM_SUBMITTED) {
                        alert(js_translate('form_already_submitted'));
                        return;
                    }

                    <?php
                    foreach ($this->_on_submit_calls as $call) {
                        echo $call.";\n";
                    }
                    ?>

                    // if the form contains errors and we don't want to submit, handle at here.
                    if (SQ_FORM_ERROR_CONTAINED) {
                        alert(js_translate('form_contains_error'));
                        return;
                    }

                    // basically if they get this far then we can submit
                    SQ_FORM_SUBMITTED = true;

                    // If we are submitting the header frame, we are probably
                    // submitting the search... so add "search in progress"
                    // screen
                    if (self.name == 'sq_header') {
                        // Only pop-up the "search in progress" box if there's something to search on
                        if (self.document.getElementById("asset_search").value != '') {
                            top.frames["sq_main"].document.getElementById("sq-search-wait-popup").style.display = "block";
                        }

                        screenMenu = top.frames["sq_main"].document.getElementById("sq_screen_menu");
                        screenMenuFiller = top.frames["sq_main"].document.getElementById("sq_screen_menu_filler");

                        if (screenMenu) {
                            if (window.navigator.userAgent.indexOf('MSIE') > 0) {
                                screenMenuFiller.style.width = screenMenu.offsetWidth;
                                screenMenuFiller.style.height = screenMenu.offsetHeight;
                                screenMenuFiller.style.display = "block";
                                screenMenu.style.display = "none";
                            }
                            screenMenu.style.MozOpacity = "0";
                        }

                        if (reload_timeout) {
                            clearTimeout(reload_timeout);
                        }
                    }

                    // disable all submit buttons
                    disable_buttons();

                    // Update the form state
                    makeChanges();

                    return true;

                }//end form_on_submit()

            <?php
            foreach ($this->_preload_imgs as $file) {
                ?>
                preload_image('<?php echo $file;?>');
                <?php
            }//end foreach
            ?>

            //]]> -->
            </script>
        </head>
        <body onload="page_on_load();" onunload="page_on_unload();">
        <div id="sq-search-wait-popup"><div id="sq-search-wait-popup-titlebar"><div id="sq-search-wait-popup-close">[ <a href="#" onclick="document.getElementById('sq-search-wait-popup').style.display = 'none'; return false;">x</a> ]</div><span id="sq-search-wait-popup-title">Search in Progress</span></div>
            <div id="sq-search-wait-popup-details">Your search is being processed, please wait...</div>
        </div>
        <form style="display: inline" action="<?php echo $this->_action.$this->_anchor;?>" id="main_form" name="main_form" method="post" enctype="multipart/form-data" onclick="changesMade();" onkeypress="changesMade();" onsubmit="return form_on_submit();">
        <?php
            if (!empty($_REQUEST['print_view'])) {
                ?>
                <div id="matrix-print-logo">
                </div>
                <?php
            }
        ?>
        <div id="sq-content">
        <?php
        hidden_field('process_form', '1');
        hidden_field('changes', '0');
        hidden_field('state', '');
        hidden_field('allowconfirm', !defined('SQ_CONF_CONFIRM_SAVE_CHANGES') ? '1' : SQ_CONF_CONFIRM_SAVE_CHANGES);
        // insert nonce token
        hidden_field('token', get_unique_token());
        
        foreach ($this->_hidden_fields as $name => $value) {
            hidden_field($name, $value);
        }

        if ($this->_heading || count($this->_screens) || count($this->_static_screens)) {
            ?>
            <table class="sq-backend-main-headings">
                <tr>
                    <?php
                    if ($this->_heading_icon) {
                        ?>
                        <td class="sq-backend-heading-icon"><?php echo $this->_heading_icon; ?></td>
                        <?php
                    }
                    ?>
                    <td class="sq-backend-main-heading">
                        <?php
                            echo $this->_heading;
                            if ($this->_sub_heading) {
                                echo '<br /><span class="sq-backend-sub-heading">'.$this->_sub_heading.'</span>';
                            }
                        ?>
                    </td>
                <?php
                if (empty($_REQUEST['print_view'])) {
                    ?>
                    <td class="sq-backend-screen-menu">
                        <div id="sq_screen_menu_filler" style="display: none"></div>
                        <div id="sq_screen_menu">
                            <?php
                            $this->printContextSwitcher();
                            $this->printScreenMenu();
                            sq_print_icon(sq_web_path('lib').'/web/images/icons/printer.png', 16, 16, translate('print_this_page'), NULL, 'onclick="showPrintPopup()" class="clickable" style="margin-bottom: -2px; margin-right: 4px"');
                            ?>
                        </div>
                    </td>
                    <?php
                }
                ?>
                </tr>
            </table>
            <?php

            if (isset($_SESSION['sq_nav_history']) && empty($_REQUEST['print_view'])) {
                ?>
                <table class="sq-backend-nav-history-container">
                    <tr>
                        <td class="sq-backend-nav-history-title">
                            <?php sq_print_icon($this->filesPath('images/icons/history.png'), 20, 20, 'Navigation History'); ?>
                            <?php echo translate('back_to'); ?>:
                        </td>
                        <td class="sq-backend-nav-history">
                            <?php
                            $nav_count = count($_SESSION['sq_nav_history']);
                            if ($nav_count < 5) {
                                $start = 0;
                            } else {
                                $start = $nav_count - 5;
                            }

                            for ($i = $start; $i < $nav_count; $i++) {
                                if (!isset($_SESSION['sq_nav_history'][$i])) continue;
                                $nav_details = $_SESSION['sq_nav_history'][$i];

                                $nav_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($nav_details['assetid'], '', TRUE);
                                if (is_null($nav_asset)) {
                                    array_splice($_SESSION['sq_nav_history'], $i, 1);
                                    continue;
                                }
                                ?>
                                <a href="<?php echo $nav_asset->getBackendHref($nav_details['screen']); ?>&sq_nav_goback=<?php echo $i; ?>">
                                    <?php
                                    sq_print_icon($GLOBALS['SQ_SYSTEM']->am->getAssetIconURL($nav_asset->type()), 16, 16, htmlspecialchars($nav_asset->short_name));
                                    echo htmlspecialchars($nav_asset->short_name, ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET);
                                    ?>
                                    <span> [<?php echo ($i + 1); ?>]</span>
                                </a>
                                <?php
                                if ($i < ($nav_count -1)) {
                                    ?> <span class="divider">+</span> &nbsp;<?php
                                }

                                $GLOBALS['SQ_SYSTEM']->am->forgetAsset($nav_asset);
                                unset($nav_asset);
                            }
                        ?>
                        </td>
                    </tr>
                </table>
                <?php
            }//end if

        }//end if

    }//end _paintHeader()


    function _paintSection($section, $depth=0)
    {
        if ($section['type'] == 'raw') {
            echo $section['contents'];
        } else {
            ?>
            <a name="section_<?php echo $section['section_count']; ?>"></a>
            <table class="sq-backend-section-table" id="backend_section_<?php echo $section['section_count']; ?>">
            <?php
            if ($section['heading'] != '') {
                if ($depth > 0) {
                    // printing a nested section - needs to look a little different
                    ?>
                    <tr>
                        <td class="sq-backend-section-subheading"><?php echo $section['heading'];?></td>
                    </tr>
                    <?php
                } else {
                    // printing a top level section
                    ?>
                    <tr class="sq-backend-section-heading-container">
                        <td>
                            <table border="0" cellspacing="0" cellpadding="0">
                                <tr>
                                    <td class="sq-backend-section-heading"><?php echo $section['heading'];?></td>
                                    <td><img src="<?php echo $this->filesPath('images/section_icon.gif');?>" width="27" height="21" alt="" /></td>
                                </tr>
                            </table>
                        </td>
                    </tr>
                    <?php
                }
            }//endif
            ?>
            <tr>
                <td>
                    <table class="sq-backend-section-table-inner" cellspacing="0" cellpadding="0" border="0">
            <?php
            for ($j = 0; $j < count($section['areas']); $j++) {
                switch ($section['areas'][$j]['area_type']) {
                    case 'section' :
                        ?>
                            <tr>
                                <td colspan="2">
                                    <?php
                                    $this->_paintSection($section['areas'][$j], $depth + 1);
                                    ?>
                                </td>
                            </tr>
                        <?php
                    break;

                    case 'field' :
                        $field = $section['areas'][$j];
                        switch ($field['format']) {
                            case 'new_line' :
                                ?>
                                    <tr <?php
                                        if ($field['hidden']) echo 'style="display: none"';
                                        if ($field['id_name']) {
                                            echo 'id="'.$field['id_name'].'"';
                                        }
                                    ?>>
                                        <td class="sq-backend-field sq-backend-field-newline" colspan="2">
                                            <a name="field_<?php echo $field['field_count']; ?>"></a>
                                            <?php echo $field['name'];?>
                                        </td>
                                    </tr>
                                    <tr <?php if ($field['hidden']) echo 'style="display: none"'; ?>>
                                        <td class="sq-backend-data sq-backend-data-newline" colspan="2">
                                            <?php
                                            echo $field['contents'];
                                            if ($field['note']) $this->note($field['note']);
                                            ?>
                                        </td>
                                    </tr>
                                <?php
                            break;

                            case 'commit' :
                                ?>
                                <tr <?php
                                    if ($field['hidden']) echo 'style="display: none"';
                                    if ($field['id_name']) {
                                        echo 'id="'.$field['id_name'].'"';
                                    }
                                ?>>
                                    <td class="sq-backend-data sq-backend-commit" colspan="2">
                                        <?php
                                        echo $field['contents'];
                                        if ($field['note']) $this->note($field['note']);
                                        ?>
                                    </td>
                                </tr>
                                <?php
                            break;

                            case 'blank' :
                                // a blank field to be used just for formatting
                            break;

                            default :
                            ?>
                                <tr <?php
                                    if ($field['hidden']) echo 'style="display: none"';
                                ?> <?php
                                    if ($field['id_name']) {
                                        echo 'id="'.$field['id_name'].'"';
                                    }
                                ?>>
                                    <td class="sq-backend-field">
                                        <a name="field_<?php echo $field['field_count']; ?>"></a>
                                        <?php echo $field['name'];?>
                                    </td>
                                    <td class="sq-backend-data">
                                        <?php
                                        echo $field['contents'];
                                        if ($field['note']) $this->note($field['note']);
                                        ?>
                                    </td>
                                </tr>
                            <?php
                        }//end switch

                    break;

                    default :
                        trigger_localised_error('SYS0257', E_USER_ERROR, $section['areas'][$j]['area_type']);

                }//end switch area type

            }//end for

            if (isset($section['note'])) {
                $this->_nbSectionNote($section['note']);
            }

            ?>
                        </table>
                    </td>
                </tr>
            </table>
            <?php

        }//end else

    }//end _paintSection()


    function _paintFooter()
    {
        ?>
        </div>
        </form>
        </body>
        </html>
        <?php

    }//end _paintFooter()


    function _paintCssInclude($file)
    {
        ?>
            <link rel="stylesheet" type="text/css" href="<?php echo $file;?>" />
        <?php

    }//end _paintCssInclude()


    function _paintJsInclude($file)
    {
        ?>
            <script type="text/javascript" src="<?php echo $file;?>"></script>
        <?php

    }//end _paintJsInclude()


    function note($str)
    {
        echo '<div class="sq-backend-smallprint">'.$str.'</div>';

    }//end note()


    function sectionNote($str='')
    {
        if ($this->_buffering) {
            $stack_i = count($this->_section_stack) - 1;
            $this->_section_stack[$stack_i]['note'] = $str;

        } else {
            // we are not buffering
            $this->_nbSectionNote($str);
        }

    }//end sectionNote()


    function _nbSectionNote($str)
    {
        ?>
                </td>
            </tr>
            <tr>
                <td colspan="2">
                    <div class="sq-backend-section-note"><strong><?php echo translate('note'); ?>: </strong><?php echo $str ?></div>
        <?php

    }//end _nbSectionNote()


    function commitButton($value='', $release_lock=TRUE, $include_section=TRUE)
    {
        // value is empty, use default caption
        if (empty($value)) {
            $value = !defined('SQ_CONF_COMMIT_BUTTON_TEXT') ? 'Commit' : SQ_CONF_COMMIT_BUTTON_TEXT;
        }
        $release_lock = (int) $release_lock;
        if ($include_section) {
            // Lock commit button to bottom of frame if the preference is turned on AND we're in backend
            if (SQ_IN_BACKEND && $GLOBALS['SQ_SYSTEM']->getUserPrefs('user', 'SQ_USER_COMMIT_BUTTON_POS')) {
                $this->openRaw();
                ?></div><div id="sq-commit-button-spacer"></div><div id="sq-commit-button-div"><div id="sq-commit-button-div-inside"><?php
            } else {
                $this->openSection(' ');
                $this->openField('', 'commit');
            }
        }
        hidden_field('sq_lock_release', $release_lock);
        normal_button('sq_commit_button', $value, 'if (submit_form) { submit_form(this.form); } else { this.form.submit(); this.disabled = \'disabled\'; } ', 'accesskey="s"');
        if ($include_section) {
            if (SQ_IN_BACKEND && $GLOBALS['SQ_SYSTEM']->getUserPrefs('user', 'SQ_USER_COMMIT_BUTTON_POS')) {
                ?></div></div>
                <div>
                <?php
                $this->closeRaw();
            } else {
                $this->closeField();
                $this->closeSection();
            }
        }

    }//end commitButton()


    function printScreenMenu()
    {
        if (empty($this->_screens) && empty($this->_static_screens)) {
            echo '&nbsp;';
        } else {
            if (!empty($this->_screens)) {
                $this->_screens = array_reverse($this->_screens);
                $this->_screens['#'] = '------';
                foreach (array_reverse($this->_static_screens) as $url => $code) {
                    $this->_screens[$url] = $code;
                }
                $this->_screens = array_reverse($this->_screens);
            } else {
                $this->_screens = $this->_static_screens;
            }
            combo_box('screen_menu', $this->_screens, FALSE, $this->_action, 1, 'id="screen_menu" onchange="self.location = this.value"');
            echo '&nbsp;';
            normal_button('screen_menu_go', ' '.translate('go').' ', 'self.location = get_form_element_value("screen_menu");');
            echo '&nbsp;';
        }

    }//end printScreenMenu()


    public function printContextSwitcher()
    {
        $contexts = $GLOBALS['SQ_SYSTEM']->getAllContexts();
        $current_context = $GLOBALS['SQ_SYSTEM']->getContextId();
        if (count($contexts) > 1) {
            ?>
            <span id="sq_context_switcher_current">
                Context: <strong><?php echo $contexts[$current_context]['name'] ?></strong> [ <a href="#" onclick="this.parentNode.nextSibling.style.display = 'inline'; this.parentNode.style.display = 'none'; return false;">Change</a> ]
            </span><span id="sq_context_switcher_change">Change Context: <?php
                $this->printSimpleContextSwitcher();
            ?></span> <?php
        }

    }//end printContextSwitcher()


    public function printSimpleContextSwitcher()
    {
        $current_location = $this->getCurrentLocation();
        list($current_loc_base, $current_loc_query) = explode('?', $current_location);
        $default_url = NULL;

        $contexts = $GLOBALS['SQ_SYSTEM']->getAllContexts();
        $current_context = $GLOBALS['SQ_SYSTEM']->getContextId();
        if (count($contexts) > 1) {

            $context_list = Array();
            foreach ($contexts as $context_item_id => $context_item) {
                $url = replace_query_string_vars(Array('SQ_ACTION' => 'set_backend_context', 'SQ_CONTEXT_NAME' => rawurlencode($context_item['name'])), $current_loc_base, $current_loc_query);
                if ((int)$current_context === (int)$context_item_id) {
                    $default_url = $url;
                }

                $context_list[$url] = $context_item['name'];
            }
            combo_box('sq_context_switcher', $context_list, FALSE, Array($default_url), 1, ' onchange="self.location = this.value;"');
        }


    }//end printSimpleContextSwitcher()


    function onBackendMessage(&$broadcaster, $event_data=Array())
    {
        $this->addMessage($event_data['type'], $event_data['message']);

    }//end onBackendMessage()


    function onCreateLink(&$broadcaster, $event_data=Array())
    {
        if (!is_null($broadcaster) && isset($broadcaster->id)) {
            if (!in_array($broadcaster->id, $this->_refreshing_assets)) {
                $this->addOnLoad('if (parent.frames["sq_sidenav"] && parent.frames["sq_sidenav"].reload_asset) parent.frames["sq_sidenav"].reload_asset("'.$broadcaster->id.'");');
                $this->_refreshing_assets[] = $broadcaster->id;
            }
        }//end if

    }//end onCreateLink()


    function onDeleteLink(&$broadcaster, $event_data=Array())
    {
        if (!($broadcaster instanceof Asset)) return;
        if (!in_array($broadcaster->id, $this->_refreshing_assets)) {
            $this->addOnLoad('if (parent.frames["sq_sidenav"] && parent.frames["sq_sidenav"].reload_asset) parent.frames["sq_sidenav"].reload_asset("'.$broadcaster->id.'");');
            $this->_refreshing_assets[] = $broadcaster->id;
        }

    }//end onDeleteLink()


    function onAssetUpdate(&$broadcaster, $event_data=Array())
    {
        if (!($broadcaster instanceof Asset)) return;
        if (!in_array($broadcaster->id, $this->_refreshing_assets)) {
            $this->addOnLoad('if (parent.frames["sq_sidenav"] && parent.frames["sq_sidenav"].reload_asset) parent.frames["sq_sidenav"].reload_asset("'.$broadcaster->id.'");');
            $this->_refreshing_assets[] = $broadcaster->id;
        }

    }//end onAssetUpdate()


    function onAssetTypeUpdate(&$broadcaster, $event_data=Array())
    {
        if (!($broadcaster instanceof Asset)) return;
        if (!in_array($broadcaster->id, $this->_refreshing_assets)) {
            if ($event_data['old_type'] != $event_data['new_type']) {
                $this->addOnLoad('if (parent.frames["sq_sidenav"] && parent.frames["sq_sidenav"].reload_asset) parent.frames["sq_sidenav"].reload_asset("'.$broadcaster->id.'");');
                $this->_refreshing_assets[] = $broadcaster->id;
            }
        }

    }//end onAssetTypeUpdate()


    function onAssetStatusUpdate(&$broadcaster, $event_data=Array())
    {
        if (!($broadcaster instanceof Asset)) return;
        if (!in_array($broadcaster->id, $this->_refreshing_assets)) {
            if ($event_data['old_status'] != $event_data['new_status']) {
                $this->addOnLoad('if (parent.frames["sq_sidenav"] && parent.frames["sq_sidenav"].reload_asset) parent.frames["sq_sidenav"].reload_asset("'.$broadcaster->id.'");');
                $this->_refreshing_assets[] = $broadcaster->id;
            }
        }

    }//end onAssetStatusUpdate()


    function getCurrentSectionNumber()
    {
        return $this->_section_count;

    }//end getCurrentSectionNumber()


}//end class

?>