navigation.php

<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
 * the navigation frame - displays server, db and table selection tree
 *
 * @package PhpMyAdmin
 */

/**
 * Gets a core script and starts output buffering work
 */
require_once 'libraries/common.inc.php';

/**
 * finish and cleanup navigation.php script execution,
 * only to be used in navigation.php
 *
 * @access private
 *
 * @return void
 */
function PMA_exitNavigationFrame()
{
    exit;
}

require_once 'libraries/Util.class.php';
require_once 'libraries/RecentTable.class.php';

/**
 * Check if it is an ajax request to reload the recent tables list.
 */
if ($GLOBALS['is_ajax_request'] && $_REQUEST['recent_table']) {
    $response = PMA_Response::getInstance();
    $response->addJSON(
        'options',
        PMA_RecentTable::getInstance()->getHtmlSelectOption()
    );
    exit;
}

// keep the offset of the db list in session before closing it
if (! isset($_SESSION['tmp_user_values']['navi_limit_offset'])) {
    $_SESSION['tmp_user_values']['navi_limit_offset'] = 0;
}
if (! isset($_SESSION['tmp_user_values']['table_limit_offset'])
    || $_SESSION['tmp_user_values']['table_limit_offset_db'] != $db
) {
    $_SESSION['tmp_user_values']['table_limit_offset'] = 0;
    $_SESSION['tmp_user_values']['table_limit_offset_db'] = $db;
}
if (isset($_REQUEST['pos'])) {
    if (isset($_REQUEST['tpos'])) {
        $_SESSION['tmp_user_values']['table_limit_offset'] = (int) $_REQUEST['pos'];
    } else {
        $_SESSION['tmp_user_values']['navi_limit_offset'] = (int) $_REQUEST['pos'];
    }
}
$pos = $_SESSION['tmp_user_values']['navi_limit_offset'];
$tpos = $_SESSION['tmp_user_values']['table_limit_offset'];
// free the session file, for the other frames to be loaded
// but only if debugging is not enabled
if (empty($_SESSION['debug'])) {
    session_write_close();
}

/*
 * selects the database if there is only one on current server
 */
if ($GLOBALS['server'] && ! strlen($GLOBALS['db'])) {
    $GLOBALS['db'] = $GLOBALS['pma']->databases->getSingleItem();
}

$db_start = $GLOBALS['db'];

/**
 * the relation settings
 */
$cfgRelation = PMA_getRelationsParam();

$response = PMA_Response::getInstance();
$response->getFooter()->setMinimal();
$header   = $response->getHeader();
$header->disableMenu();
$header->setBodyId('body_leftFrame');
$scripts = $header->getScripts();
$scripts->addFile('navigation.js');
$scripts->addCode(
    '// INIT PMA_setFrameSize
    var onloadCnt = 0;
    var onLoadHandler = window.onload;
    var resizeHandler = window.onresize;
    window.document.onresize  = resizeHandler;
    window.onload = function() {
        if (onloadCnt == 0) {
            if (typeof(onLoadHandler) == "function") {
                onLoadHandler();
            }
            if (typeof(PMA_setFrameSize) != "undefined"
                && typeof(PMA_setFrameSize) == "function"
            ) {
                PMA_setFrameSize();
            }
            onloadCnt++;
        }
    };
    window.onresize = function() {
        if (typeof(resizeHandler) == "function") {
            resizeHandler();
        }
        if (typeof(PMA_saveFrameSize) != "undefined"
            && typeof(PMA_saveFrameSize) == "function"
        ) {
            PMA_saveFrameSize();
        }
    };'
);

require 'libraries/navigation_header.inc.php';

// display recently used tables
if ($GLOBALS['cfg']['LeftRecentTable'] > 0) {
    echo '<div id="recentTableList">' . "\n"
        .'<form method="post" action="index.php" target="_parent">' . "\n"
        .PMA_generate_common_hidden_inputs() . "\n"
        .PMA_RecentTable::getInstance()->getHtmlSelect()
        .'</form>' . "\n"
        .'</div>' . "\n";
}

if (! $GLOBALS['server']) {
    // no server selected
    PMA_exitNavigationFrame();
} elseif (! count($GLOBALS['pma']->databases)) {
    // no database available, so we break here
    echo '<p>' . __('No databases') . '</p>';
    PMA_exitNavigationFrame();
} elseif ($GLOBALS['cfg']['LeftFrameLight']
    && count($GLOBALS['pma']->databases) > 1
) {
    $list = $cfg['DisplayDatabasesList'];
    if ($list === 'auto') {
        if (empty($GLOBALS['db'])) {
            $list = true;
        } else {
            $list = false;
        }
    }
    if (!$list) {
        // more than one database available and LeftFrameLight is true
        // display db selectbox
        //
        // Light mode -> beginning of the select combo for databases
        // Note: When javascript is active, the frameset will be changed from
        // within navigation.php. With no JS (<noscript>) the whole frameset will
        // be rebuilt with the new target frame.
    ?>

    <div id="databaseList">
    <form method="post" action="index.php" target="_parent" id="left">
    <?php
        echo PMA_generate_common_hidden_inputs() . "\n";
        echo $GLOBALS['pma']->databases->getHtmlSelectGrouped(true, $_SESSION['tmp_user_values']['navi_limit_offset'], $GLOBALS['cfg']['MaxDbList']) . "\n"
            .'</form>' . "\n"
            . '</div>' . "\n";
    } else {

        if (count($GLOBALS['pma']->databases) >= $GLOBALS['cfg']['LeftDisplayDatabaseFilterMinimum']) {
            ?>
            <span id="NavDbFilter">
                <input type="text" class="gray" name="fast_db_filter" id="fast_db_filter" title="<?php echo __('Filter databases by name'); ?>" value="<?php echo __('Filter databases by name'); ?>" />
                <span id="clear_fast_db_filter" title="<?php echo __('Clear'); ?>">X</span>
            </span>
            <?php
        }

        echo $GLOBALS['pma']->databases->getHtmlListGrouped(true, $_SESSION['tmp_user_values']['navi_limit_offset'], $GLOBALS['cfg']['MaxDbList']) . "\n";
    }

    $_url_params = array('pos' => $pos);
    echo PMA_Util::getListNavigator(
        count($GLOBALS['pma']->databases), $pos, $_url_params, 'navigation.php',
        'frame_navigation', $GLOBALS['cfg']['MaxDbList']
    );
}
?>

<div id="left_tableList">
<?php
// Don't display expansible/collapsible database info if:
// 1. $GLOBALS['server'] == 0 (no server selected)
//    This is the case when there are multiple servers and
//    '$GLOBALS['cfg']['ServerDefault'] = 0' is set.
//    In that case, we want the welcome screen to appear with no database
//     info displayed.
// 2. there is only one database available (ie either only one database exists
//    or $GLOBALS['cfg']['Servers']['only_db'] is defined and is not an array)
//    In this case, the database should not be collapsible/expandable

$img_plus = PMA_Util::getImage('b_plus.png', '+', array('id' => 'el%dImg'));
$img_minus = PMA_Util::getImage('b_minus.png', '-', array('id' => 'el%dImg'));

$href_left = '<a onclick="if (toggle(\'%d\')) return false;"'
    .' href="navigation.php?%s" target="_self">';

$element_counter = 0;


if ($GLOBALS['cfg']['LeftFrameLight'] && strlen($GLOBALS['db'])) {
    $table_list = PMA_Util::getTableList(
        $GLOBALS['db'],
        null,
        $tpos,
        $cfg['MaxTableList']
    );
    $table_count = PMA_getTableCount($GLOBALS['db']);

    // show selected databasename as link to DefaultTabDatabase-page
    // with table count in ()
    $common_url_query = PMA_generate_common_url($GLOBALS['db']);

    $db_tooltip = '';

    if ($GLOBALS['cfg']['ShowTooltip']
        && $GLOBALS['cfgRelation']['commwork']
    ) {
        $_db_tooltip = PMA_getDbComment($GLOBALS['db']);
        if ($_db_tooltip) {
            $db_tooltip = $_db_tooltip;
        }
    }

    $disp_name  = $GLOBALS['db'];
    if ($db_tooltip && $GLOBALS['cfg']['ShowTooltipAliasDB']) {
        $disp_name      = $db_tooltip;
        $disp_name_cut  = $db_tooltip;
        $db_tooltip     = $GLOBALS['db'];
    }

    if ($table_count >= $GLOBALS['cfg']['LeftDisplayTableFilterMinimum']) {
        ?>
        <span id="NavFilter">
            <input type="text" class="gray" name="fast_filter" id="fast_filter" title="<?php echo __('Filter tables by name'); ?>" value="<?php echo __('Filter tables by name'); ?>" />
            <span id="clear_fast_filter" title="<?php echo __('Clear'); ?>">X</span>
        </span>
        <?php
    }

    /**
     * This helps reducing the navi panel size; in the right panel,
     * user can find a navigator to page thru all tables.
     *
     */
    if (! empty($table_list)) {
        // upper table list paginator
        if (count($table_list) <= $GLOBALS['cfg']['MaxTableList']
            && $table_count > $GLOBALS['cfg']['MaxTableList']
        ) {
            $_url_params = array(
              'tpos' => 'true',
              'pos' => $tpos,
              'db' => $GLOBALS['db']
            );
            echo PMA_Util::getListNavigator(
                $table_count, $tpos, $_url_params, 'navigation.php',
                'frame_navigation', $GLOBALS['cfg']['MaxTableList']
            );
        }
        PMA_displayTableList($table_list, true, '', $GLOBALS['db']);
        // lower table list paginator
        if (count($table_list) <= $GLOBALS['cfg']['MaxTableList']
            && $table_count > $GLOBALS['cfg']['MaxTableList']
        ) {
            echo PMA_Util::getListNavigator(
                $table_count, $tpos, $_url_params, 'navigation.php',
                'frame_navigation', $GLOBALS['cfg']['MaxTableList']
            );
        }
    } else {
        echo __('No tables found in database.');
    }
    unset($table_list);
    if (!PMA_is_system_schema($db)) {
        $class = '';
        $GLOBALS['cfg']['AjaxEnable'] ? $class="ajax" : '';
        echo '<ul id="newtable"><li><a target="frame_content" href="tbl_create.php'
            . PMA_generate_common_url(array('db' => $GLOBALS['db']))
            . '"  class="'.$class .'" >'
            . PMA_Util::getImage(
                'b_snewtbl.png',
                _pgettext('short form', 'Create table'),
                array('id' => "icon_newtable")
            )
            . _pgettext('short form', 'Create table')
            . '</a></li></ul>';
    }
} elseif ($GLOBALS['cfg']['LeftFrameLight']) {
    /* No need to tell user to select database if we're showing complete list */
    if (!$list) {
        echo '<p>' . __('Please select a database') . '</p>';
    }
} else {
    echo '<div id="databaseList">' . "\n";
    $_url_params = array('pos' => $pos);
    echo PMA_Util::getListNavigator(
        count($GLOBALS['pma']->databases), $pos, $_url_params, 'navigation.php',
        'frame_navigation', $GLOBALS['cfg']['MaxDbList']
    );
    echo '</div>' . "\n";

    $common_url_query = PMA_generate_common_url();
    PMA_displayDbList(
        $GLOBALS['pma']->databases->getGroupedDetails(
            $_SESSION['tmp_user_values']['navi_limit_offset'],
            $GLOBALS['cfg']['MaxDbList']
        ),
        $_SESSION['tmp_user_values']['navi_limit_offset'],
        $GLOBALS['cfg']['MaxDbList']
    );
}

/**
 * displays collapsable db list
 *
 * @param array   $ext_dblist extended db list
 * @param integer $offset
 * @param integer $count
 *
 * @return void
 *
 * @global integer $element_counter
 * @global string $img_minus
 * @global string $img_plus
 * @global string $href_left
 * @global string $db_start
 * @global string $common_url_query
 */
function PMA_displayDbList($ext_dblist, $offset, $count)
{
    global $element_counter, $img_minus, $img_plus, $href_left,
        $db_start, $common_url_query;

    // get table list, for all databases
    // doing this in one step takes advantage of
    // a single query with information_schema!
    $tables_full = PMA_DBI_get_tables_full(
        $GLOBALS['pma']->databases->getLimitedItems($offset, $count)
    );

    $url_dbgroup = '';
    echo '<ul id="leftdatabaselist">';
    $close_db_group = false;
    foreach ($ext_dblist as $group => $db_group) {
        if (count($GLOBALS['pma']->databases) > 1) {
            if ($close_db_group) {
                $url_dbgroup = '';
                echo '</ul>';
                echo '</li>';
                $close_db_group = false;
            }
            if (count($db_group) > 1) {
                $close_db_group = true;
                $url_dbgroup = '&amp;dbgroup=' . urlencode($group);
                $common_url_query = PMA_generate_common_url() . $url_dbgroup;
                $element_counter++;
                echo '<li class="dbgroup">';
                if ((! empty($_REQUEST['dbgroup']) && $_REQUEST['dbgroup'] == $group)
                    || $db_start == $group
                    || strpos($db_start, $group) === 0
                ) {
                    // display + only if this db(group) is not preselected
                    printf($href_left, $element_counter, PMA_generate_common_url());
                    printf($img_minus, $element_counter);
                } else {
                    printf($href_left, $element_counter, $common_url_query);
                    printf($img_plus, $element_counter);
                }
                echo '</a> ' . $group . "\n";
                if ((! empty($_REQUEST['dbgroup']) && $_REQUEST['dbgroup'] == $group)
                    || $db_start == $group
                    || strpos($db_start, $group) === 0
                ) {
                    echo '<ul id="subel' . $element_counter . '">' . "\n";
                } else {
                    echo '<ul id="subel' . $element_counter . '"'
                        .' style="display: none">' . "\n";
                }
            }
        }
        foreach ($db_group as $db) {
            $common_url_query = PMA_generate_common_url($db['name']) . $url_dbgroup;

            $element_counter++;
            // Displays the database name
            echo '<li>' . "\n";

            if (count($GLOBALS['pma']->databases) > 1) {
                // only with more than one db we need collapse ...
                if ($db_start != $db['name'] || $db['num_tables'] < 1) {
                    // display + only if this db is not preselected
                    // or table count is 0
                    printf($href_left, $element_counter, $common_url_query);
                    printf($img_plus, $element_counter);
                } else {
                    printf(
                        $href_left, $element_counter,
                        PMA_generate_common_url() . $url_dbgroup
                    );
                    printf($img_minus, $element_counter);
                }
                echo '</a>';

                // ... and we need to refresh both frames on db selection
                ?>
                <a class="item"
                    id="<?php echo htmlspecialchars($db['name']); ?>"
                    href="index.php?<?php echo $common_url_query; ?>"
                    target="_parent"
                    title="<?php echo htmlspecialchars($db['comment']); ?>"
                    onclick="
                        if (! toggle('<?php echo $element_counter; ?>', true))
                            window.parent.goTo('navigation.php?<?php echo $common_url_query; ?>');
                        window.parent.goTo('<?php echo $GLOBALS['cfg']['DefaultTabDatabase']
                            . '?' . $common_url_query; ?>', 'main');
                        return false;">
                    <?php
                    // Might be unset if CountTables directive is false
                    if (isset($db['num_tables'])) {
                        if ($GLOBALS['text_dir'] === 'rtl') {
                            echo ' <bdo dir="ltr">(' . $db['num_tables'] . ')</bdo> ';
                        }
                    }
                    echo htmlspecialchars($db['disp_name']);
                    if (isset($db['num_tables'])) {
                        if ($GLOBALS['text_dir'] === 'ltr') {
                            echo ' <bdo dir="ltr">(' . $db['num_tables'] . ')</bdo> ';
                        }
                    }
                    ?>
                </a>
                <?php
            } else {
                // with only 1 db available we dont need to refresh navi frame
                // on db selection, only phpmain
                ?>
                <a href="<?php echo $GLOBALS['cfg']['DefaultTabDatabase']
                    . '?' . $common_url_query; ?>"
                    id="<?php echo htmlspecialchars($db['name']); ?>"
                    title="<?php echo htmlspecialchars($db['comment']); ?>">
                    <?php
                    if (isset($db['num_tables'])) {
                        if ($GLOBALS['text_dir'] === 'rtl') {
                            echo ' <bdo dir="ltr">(' . $db['num_tables'] . ')</bdo> ';
                        }
                    }
                    echo htmlspecialchars($db['disp_name']);
                    if (isset($db['num_tables'])) {
                        if ($GLOBALS['text_dir'] === 'ltr') {
                            echo ' <bdo dir="ltr">(' . $db['num_tables'] . ')</bdo> ';
                        }
                    }
                    ?>
                </a>
                <?php
            }
            if (($GLOBALS['cfg']['Server']['CountTables'] === false)
                || $db['num_tables']
            ) {
                if (isset($tables_full[$db['name']])) {
                    $tables = PMA_Util::getTableList(
                        $db['name'],
                        $tables_full[$db['name']]
                    );
                } elseif (isset($tables_full[strtolower($db['name'])])) {
                    // on windows with lower_case_table_names = 1
                    // MySQL returns
                    // with SHOW DATABASES or information_schema.SCHEMATA: `Test`
                    // but information_schema.TABLES gives `test`
                    // bug #1436171
                    // sf.net/tracker/?func=detail&aid=1436171&group_id=23067&atid=377408
                    $tables = PMA_Util::getTableList(
                        $db['name'],
                        $tables_full[strtolower($db['name'])]
                    );
                } else {
                    $tables = PMA_Util::getTableList($db['name']);
                }
                $child_visible
                    = (bool) (count($GLOBALS['pma']->databases) === 1 || $db_start == $db['name']);
                PMA_displayTableList($tables, $child_visible, '', $db['name']);
            } elseif ($GLOBALS['cfg']['LeftFrameLight']) {
                // no tables and LeftFrameLight:
                // display message no tables in selected db
                echo '<p>' . __('Please select a database') . '</p>' . "\n";
            }
            echo '</li>' . "\n";
        } // end foreach db
    } // end foreach group

    if ($close_db_group) {
        $url_dbgroup = '';
        echo '</ul>';
        echo '</li>';
        $close_db_group = false;
    }

    echo '</ul>' . "\n";
}

/**
 * display unordered list of tables
 * calls itself recursively if table in given list
 * is a list itself
 *
 * @param array   $tables         array of tables/tablegroups
 * @param boolean $visible        whether the list is visible or not
 * @param string  $tab_group_full full tab group name
 * @param string  $table_db       db of this table
 *
 * @return void
 *
 * @global  integer the element counter
 * @global  string  html code for '-' image
 * @global  string  html code for '+' image
 * @global  string  html code for self link
 */
function PMA_displayTableList(
    $tables, $visible = false,
    $tab_group_full = '', $table_db = ''
) {
    if (! is_array($tables) || count($tables) === 0) {
        return;
    }

    global $element_counter, $img_minus, $img_plus, $href_left;
    $sep = $GLOBALS['cfg']['LeftFrameTableSeparator'];

    if ($visible) {
        echo '<ul id="subel' . $element_counter . '">';
    } else {
        echo '<ul id="subel' . $element_counter . '" style="display: none">';
    }
    foreach ($tables as $group => $table) {
        // only allow grouping if the group has more than 1 table
        if (isset($table['is' . $sep . 'group'])
            && $table['tab' . $sep . 'count'] > 1
        ) {
            $common_url_query = $GLOBALS['common_url_query']
                . '&amp;tbl_group=' . urlencode($tab_group_full . $group);

            $element_counter++;
            echo '<li>' . "\n";
            if ($visible
                && ((isset($_REQUEST['tbl_group'])
                && (strpos($_REQUEST['tbl_group'], $group) === 0
                || strpos($_REQUEST['tbl_group'], $sep . $group) !== false))
                || strpos($GLOBALS['table'], $group) === 0)
            ) {
                printf(
                    $href_left,
                    $element_counter,
                    $GLOBALS['common_url_query'] . '&amp;tbl_group=' . $tab_group_full
                );
                printf($img_minus, $element_counter);
            } else {
                printf($href_left, $element_counter, $common_url_query);
                printf($img_plus, $element_counter);
            }
            echo '</a>';
            ?>
            <a href="index.php?<?php echo $common_url_query; ?>"
                target="_parent"
                onclick="
                    if (! toggle('<?php echo $element_counter; ?>', true))
                        window.parent.goTo('navigation.php?<?php echo $common_url_query; ?>');
                    window.parent.goTo('<?php echo $GLOBALS['cfg']['DefaultTabDatabase']
                        . '?' . $common_url_query; ?>', 'main');
                    return false;">
                <?php
                if ($GLOBALS['text_dir'] === 'rtl') {
                    echo ' <bdo dir="ltr">(' . $table['tab' . $sep . 'count'] . ')</bdo> ';
                }
                echo htmlspecialchars(substr($group, 0, strlen($group) - strlen($sep)));
                if ($GLOBALS['text_dir'] === 'ltr') {
                    echo ' <bdo dir="ltr">(' . $table['tab' . $sep . 'count'] . ')</bdo> ';
                }
                ?>
            </a>
            <?php

            unset($table['is' . $sep . 'group']);
            unset($table['tab' . $sep . 'group']);
            unset($table['tab' . $sep . 'count']);

            if ($visible
                && ((isset($_REQUEST['tbl_group'])
                && (strpos($_REQUEST['tbl_group'], $group) === 0
                || strpos($_REQUEST['tbl_group'], $sep . $group) !== false))
                || strpos($GLOBALS['table'], $group) === 0)
            ) {
                PMA_displayTableList(
                    $table, true, $tab_group_full . $group, $table_db
                );
            } else {
                PMA_displayTableList($table, false, '', $table_db);
            }
            echo '</li>' . "\n";
        } elseif (is_array($table)) {
            // the table was not grouped because it is the only one with its prefix
            while (isset($table['is' . $sep . 'group'])) {
                // get the array with the actual table information
                foreach ($table as $value) {
                    if (is_array($value)) {
                        $table = $value;
                    }
                }
            }
            $link_title = PMA_Util::getTitleForTarget(
                $GLOBALS['cfg']['LeftDefaultTabTable']
            );
            // quick access icon next to each table name
            echo '<li>' . "\n";
            echo '<a target="frame_content" class="tableicon" title="'
                . htmlspecialchars($link_title)
                . ': ' . htmlspecialchars($table['Comment'])
                .' ('
                . PMA_Util::formatNumber($table['Rows'], 0)
                . ' ' . __('Rows') . ')"'
                .' id="quick_' . htmlspecialchars($table_db . '.' . $table['Name']) . '"'
                .' href="' . $GLOBALS['cfg']['LeftDefaultTabTable'] . '?'
                . $GLOBALS['common_url_query']
                .'&amp;table=' . urlencode($table['Name'])
                .'&amp;goto=' . $GLOBALS['cfg']['LeftDefaultTabTable']
                . '" >';
            $attr = array(
                'id' => 'icon_' . htmlspecialchars($table_db . '.' . $table['Name'])
            );
            if (PMA_Table::isView($table_db, $table['Name'])) {
                echo PMA_Util::getImage(
                    's_views.png',
                    htmlspecialchars($link_title),
                    $attr
                );
            } else {
                echo PMA_Util::getImage(
                    'b_browse.png',
                    htmlspecialchars($link_title),
                    $attr
                );
            }
            echo '</a>';

            // link for the table name itself
            $href = $GLOBALS['cfg']['DefaultTabTable'] . '?'
                .$GLOBALS['common_url_query'] . '&amp;table='
                .urlencode($table['Name']) . '&amp;pos=0';
            echo '<a target="frame_content" href="' . $href . '" title="'
                . htmlspecialchars(
                    PMA_Util::getTitleForTarget(
                        $GLOBALS['cfg']['DefaultTabTable']
                    )
                    . ': ' . $table['Comment']
                    .' ('
                    . PMA_Util::formatNumber(
                        $table['Rows'], 0
                    )
                    . ' ' . __('Rows') . ')'
                )
                .'" id="' . htmlspecialchars($table_db . '.' . $table['Name']) . '">'
                // preserve spaces in table name
                . str_replace(' ', '&nbsp;', htmlspecialchars($table['disp_name']))
                . '</a>';
            echo '</li>' . "\n";
        }
    }
    echo '</ul>';
}

echo '</div>' . "\n";

PMA_exitNavigationFrame();
?>