';
} // end for
$this->_new_row_count = $new_row_count;
return $html_output;
}
/**
* Provides SELECT clause for building SQL query
*
* @return string Select clause
*/
private function _getSelectClause()
{
$select_clause = '';
$select_clauses = array();
for (
$column_index = 0;
$column_index < $this->_criteria_column_count;
$column_index++
) {
if (! empty($this->_formColumns[$column_index])
&& isset($this->_formShows[$column_index])
&& $this->_formShows[$column_index] == 'on'
) {
$select = $this->_formColumns[$column_index];
if (! empty($this->_formAliases[$column_index])) {
$select .= " AS "
. Util::backquote($this->_formAliases[$column_index]);
}
$select_clauses[] = $select;
}
} // end for
if (!empty($select_clauses)) {
$select_clause = 'SELECT '
. htmlspecialchars(implode(", ", $select_clauses)) . "\n";
}
return $select_clause;
}
/**
* Provides WHERE clause for building SQL query
*
* @return string Where clause
*/
private function _getWhereClause()
{
$where_clause = '';
$criteria_cnt = 0;
for (
$column_index = 0;
$column_index < $this->_criteria_column_count;
$column_index++
) {
if (! empty($this->_formColumns[$column_index])
&& ! empty($this->_formCriterions[$column_index])
&& $column_index
&& isset($last_where)
&& isset($this->_formAndOrCols)
) {
$where_clause .= ' '
. mb_strtoupper($this->_formAndOrCols[$last_where])
. ' ';
}
if (! empty($this->_formColumns[$column_index])
&& ! empty($this->_formCriterions[$column_index])
) {
$where_clause .= '(' . $this->_formColumns[$column_index] . ' '
. $this->_formCriterions[$column_index] . ')';
$last_where = $column_index;
$criteria_cnt++;
}
} // end for
if ($criteria_cnt > 1) {
$where_clause = '(' . $where_clause . ')';
}
// OR rows ${'cur' . $or}[$column_index]
if (! isset($this->_formAndOrRows)) {
$this->_formAndOrRows = array();
}
for (
$row_index = 0;
$row_index <= $this->_criteria_row_count;
$row_index++
) {
$criteria_cnt = 0;
$qry_orwhere = '';
$last_orwhere = '';
for (
$column_index = 0;
$column_index < $this->_criteria_column_count;
$column_index++
) {
if (! empty($this->_formColumns[$column_index])
&& ! empty($_POST['Or' . $row_index][$column_index])
&& $column_index
) {
$qry_orwhere .= ' '
. mb_strtoupper(
$this->_formAndOrCols[$last_orwhere]
)
. ' ';
}
if (! empty($this->_formColumns[$column_index])
&& ! empty($_POST['Or' . $row_index][$column_index])
) {
$qry_orwhere .= '(' . $this->_formColumns[$column_index]
. ' '
. $_POST['Or' . $row_index][$column_index]
. ')';
$last_orwhere = $column_index;
$criteria_cnt++;
}
} // end for
if ($criteria_cnt > 1) {
$qry_orwhere = '(' . $qry_orwhere . ')';
}
if (! empty($qry_orwhere)) {
$where_clause .= "\n"
. mb_strtoupper(
isset($this->_formAndOrRows[$row_index])
? $this->_formAndOrRows[$row_index] . ' '
: ''
)
. $qry_orwhere;
} // end if
} // end for
if (! empty($where_clause) && $where_clause != '()') {
$where_clause = 'WHERE ' . htmlspecialchars($where_clause) . "\n";
} // end if
return $where_clause;
}
/**
* Provides ORDER BY clause for building SQL query
*
* @return string Order By clause
*/
private function _getOrderByClause()
{
$orderby_clause = '';
$orderby_clauses = array();
// Create copy of instance variables
$columns = $this->_formColumns;
$sort = $this->_formSorts;
$sortOrder = $this->_formSortOrders;
if (!empty($sortOrder)
&& count($sortOrder) == count($sort)
&& count($sortOrder) == count($columns)
) {
// Sort all three arrays based on sort order
array_multisort($sortOrder, $sort, $columns);
}
for (
$column_index = 0;
$column_index < $this->_criteria_column_count;
$column_index++
) {
// if all columns are chosen with * selector,
// then sorting isn't available
// Fix for Bug #570698
if (empty($columns[$column_index])
&& empty($sort[$column_index])
) {
continue;
}
if (mb_substr($columns[$column_index], -2) == '.*') {
continue;
}
if (! empty($sort[$column_index])) {
$orderby_clauses[] = $columns[$column_index] . ' '
. $sort[$column_index];
}
} // end for
if (!empty($orderby_clauses)) {
$orderby_clause = 'ORDER BY '
. htmlspecialchars(implode(", ", $orderby_clauses)) . "\n";
}
return $orderby_clause;
}
/**
* Provides UNIQUE columns and INDEX columns present in criteria tables
*
* @param array $search_tables Tables involved in the search
* @param array $search_columns Columns involved in the search
* @param array $where_clause_columns Columns having criteria where clause
*
* @return array having UNIQUE and INDEX columns
*/
private function _getIndexes(array $search_tables, array $search_columns,
array $where_clause_columns
) {
$unique_columns = array();
$index_columns = array();
foreach ($search_tables as $table) {
$indexes = $GLOBALS['dbi']->getTableIndexes($this->_db, $table);
foreach ($indexes as $index) {
$column = $table . '.' . $index['Column_name'];
if (isset($search_columns[$column])) {
if ($index['Non_unique'] == 0) {
if (isset($where_clause_columns[$column])) {
$unique_columns[$column] = 'Y';
} else {
$unique_columns[$column] = 'N';
}
} else {
if (isset($where_clause_columns[$column])) {
$index_columns[$column] = 'Y';
} else {
$index_columns[$column] = 'N';
}
}
}
} // end while (each index of a table)
} // end while (each table)
return array(
'unique' => $unique_columns,
'index' => $index_columns
);
}
/**
* Provides UNIQUE columns and INDEX columns present in criteria tables
*
* @param array $search_tables Tables involved in the search
* @param array $search_columns Columns involved in the search
* @param array $where_clause_columns Columns having criteria where clause
*
* @return array having UNIQUE and INDEX columns
*/
private function _getLeftJoinColumnCandidates(array $search_tables, array $search_columns,
array $where_clause_columns
) {
$GLOBALS['dbi']->selectDb($this->_db);
// Get unique columns and index columns
$indexes = $this->_getIndexes(
$search_tables, $search_columns, $where_clause_columns
);
$unique_columns = $indexes['unique'];
$index_columns = $indexes['index'];
list($candidate_columns, $needsort)
= $this->_getLeftJoinColumnCandidatesBest(
$search_tables,
$where_clause_columns,
$unique_columns,
$index_columns
);
// If we came up with $unique_columns (very good) or $index_columns (still
// good) as $candidate_columns we want to check if we have any 'Y' there
// (that would mean that they were also found in the whereclauses
// which would be great). if yes, we take only those
if ($needsort != 1) {
return $candidate_columns;
}
$very_good = array();
$still_good = array();
foreach ($candidate_columns as $column => $is_where) {
$table = explode('.', $column);
$table = $table[0];
if ($is_where == 'Y') {
$very_good[$column] = $table;
} else {
$still_good[$column] = $table;
}
}
if (count($very_good) > 0) {
$candidate_columns = $very_good;
// Candidates restricted in index+where
} else {
$candidate_columns = $still_good;
// None of the candidates where in a where-clause
}
return $candidate_columns;
}
/**
* Provides the main table to form the LEFT JOIN clause
*
* @param array $search_tables Tables involved in the search
* @param array $search_columns Columns involved in the search
* @param array $where_clause_columns Columns having criteria where clause
* @param array $where_clause_tables Tables having criteria where clause
*
* @return string table name
*/
private function _getMasterTable(array $search_tables, array $search_columns,
array $where_clause_columns, array $where_clause_tables
) {
if (count($where_clause_tables) == 1) {
// If there is exactly one column that has a decent where-clause
// we will just use this
$master = key($where_clause_tables);
return $master;
}
// Now let's find out which of the tables has an index
// (When the control user is the same as the normal user
// because he is using one of his databases as pmadb,
// the last db selected is not always the one where we need to work)
$candidate_columns = $this->_getLeftJoinColumnCandidates(
$search_tables, $search_columns, $where_clause_columns
);
// Generally, we need to display all the rows of foreign (referenced)
// table, whether they have any matching row in child table or not.
// So we select candidate tables which are foreign tables.
$foreign_tables = array();
foreach ($candidate_columns as $one_table) {
$foreigners = $this->relation->getForeigners($this->_db, $one_table);
foreach ($foreigners as $key => $foreigner) {
if ($key != 'foreign_keys_data') {
if (in_array($foreigner['foreign_table'], $candidate_columns)) {
$foreign_tables[$foreigner['foreign_table']]
= $foreigner['foreign_table'];
}
continue;
}
foreach ($foreigner as $one_key) {
if (in_array($one_key['ref_table_name'], $candidate_columns)) {
$foreign_tables[$one_key['ref_table_name']]
= $one_key['ref_table_name'];
}
}
}
}
if (count($foreign_tables)) {
$candidate_columns = $foreign_tables;
}
// If our array of candidates has more than one member we'll just
// find the smallest table.
// Of course the actual query would be faster if we check for
// the Criteria which gives the smallest result set in its table,
// but it would take too much time to check this
if (!(count($candidate_columns) > 1)) {
// Only one single candidate
return reset($candidate_columns);
}
// Of course we only want to check each table once
$checked_tables = $candidate_columns;
$tsize = array();
$maxsize = -1;
$result = '';
foreach ($candidate_columns as $table) {
if ($checked_tables[$table] != 1) {
$_table = new Table($table, $this->_db);
$tsize[$table] = $_table->countRecords();
$checked_tables[$table] = 1;
}
if ($tsize[$table] > $maxsize) {
$maxsize = $tsize[$table];
$result = $table;
}
}
// Return largest table
return $result;
}
/**
* Provides columns and tables that have valid where clause criteria
*
* @return array
*/
private function _getWhereClauseTablesAndColumns()
{
$where_clause_columns = array();
$where_clause_tables = array();
// Now we need all tables that we have in the where clause
for (
$column_index = 0, $nb = count($this->_criteria);
$column_index < $nb;
$column_index++
) {
$current_table = explode('.', $_POST['criteriaColumn'][$column_index]);
if (empty($current_table[0]) || empty($current_table[1])) {
continue;
} // end if
$table = str_replace('`', '', $current_table[0]);
$column = str_replace('`', '', $current_table[1]);
$column = $table . '.' . $column;
// Now we know that our array has the same numbers as $criteria
// we can check which of our columns has a where clause
if (! empty($this->_criteria[$column_index])) {
if (mb_substr($this->_criteria[$column_index], 0, 1) == '='
|| stristr($this->_criteria[$column_index], 'is')
) {
$where_clause_columns[$column] = $column;
$where_clause_tables[$table] = $table;
}
} // end if
} // end for
return array(
'where_clause_tables' => $where_clause_tables,
'where_clause_columns' => $where_clause_columns
);
}
/**
* Provides FROM clause for building SQL query
*
* @param array $formColumns List of selected columns in the form
*
* @return string FROM clause
*/
private function _getFromClause(array $formColumns)
{
$from_clause = '';
if (empty($formColumns)) {
return $from_clause;
}
// Initialize some variables
$search_tables = $search_columns = array();
// We only start this if we have fields, otherwise it would be dumb
foreach ($formColumns as $value) {
$parts = explode('.', $value);
if (! empty($parts[0]) && ! empty($parts[1])) {
$table = str_replace('`', '', $parts[0]);
$search_tables[$table] = $table;
$search_columns[] = $table . '.' . str_replace(
'`', '', $parts[1]
);
}
} // end while
// Create LEFT JOINS out of Relations
$from_clause = $this->_getJoinForFromClause(
$search_tables, $search_columns
);
// In case relations are not defined, just generate the FROM clause
// from the list of tables, however we don't generate any JOIN
if (empty($from_clause)) {
// Create cartesian product
$from_clause = implode(
", ", array_map(array('PhpMyAdmin\Util', 'backquote'), $search_tables)
);
}
return $from_clause;
}
/**
* Formulates the WHERE clause by JOINing tables
*
* @param array $searchTables Tables involved in the search
* @param array $searchColumns Columns involved in the search
*
* @return string table name
*/
private function _getJoinForFromClause(array $searchTables, array $searchColumns)
{
// $relations[master_table][foreign_table] => clause
$relations = array();
// Fill $relations with inter table relationship data
foreach ($searchTables as $oneTable) {
$this->_loadRelationsForTable($relations, $oneTable);
}
// Get tables and columns with valid where clauses
$validWhereClauses = $this->_getWhereClauseTablesAndColumns();
$whereClauseTables = $validWhereClauses['where_clause_tables'];
$whereClauseColumns = $validWhereClauses['where_clause_columns'];
// Get master table
$master = $this->_getMasterTable(
$searchTables, $searchColumns,
$whereClauseColumns, $whereClauseTables
);
// Will include master tables and all tables that can be combined into
// a cluster by their relation
$finalized = array();
if (strlen($master) > 0) {
// Add master tables
$finalized[$master] = '';
}
// Fill the $finalized array with JOIN clauses for each table
$this->_fillJoinClauses($finalized, $relations, $searchTables);
// JOIN clause
$join = '';
// Tables that can not be combined with the table cluster
// which includes master table
$unfinalized = array_diff($searchTables, array_keys($finalized));
if (count($unfinalized) > 0) {
// We need to look for intermediary tables to JOIN unfinalized tables
// Heuristic to chose intermediary tables is to look for tables
// having relationships with unfinalized tables
foreach ($unfinalized as $oneTable) {
$references = $this->relation->getChildReferences($this->_db, $oneTable);
foreach ($references as $column => $columnReferences) {
foreach ($columnReferences as $reference) {
// Only from this schema
if ($reference['table_schema'] != $this->_db) {
continue;
}
$table = $reference['table_name'];
$this->_loadRelationsForTable($relations, $table);
// Make copies
$tempFinalized = $finalized;
$tempSearchTables = $searchTables;
$tempSearchTables[] = $table;
// Try joining with the added table
$this->_fillJoinClauses(
$tempFinalized, $relations, $tempSearchTables
);
$tempUnfinalized = array_diff(
$tempSearchTables, array_keys($tempFinalized)
);
// Take greedy approach.
// If the unfinalized count drops we keep the new table
// and switch temporary varibles with the original ones
if (count($tempUnfinalized) < count($unfinalized)) {
$finalized = $tempFinalized;
$searchTables = $tempSearchTables;
}
// We are done if no unfinalized tables anymore
if (count($tempUnfinalized) == 0) {
break 3;
}
}
}
}
$unfinalized = array_diff($searchTables, array_keys($finalized));
// If there are still unfinalized tables
if (count($unfinalized) > 0) {
// Add these tables as cartesian product before joined tables
$join .= implode(
', ', array_map(array('PhpMyAdmin\Util', 'backquote'), $unfinalized)
);
}
}
$first = true;
// Add joined tables
foreach ($finalized as $table => $clause) {
if ($first) {
if (! empty($join)) {
$join .= ", ";
}
$join .= Util::backquote($table);
$first = false;
} else {
$join .= "\n LEFT JOIN " . Util::backquote(
$table
) . " ON " . $clause;
}
}
return $join;
}
/**
* Loads relations for a given table into the $relations array
*
* @param array &$relations array of relations
* @param string $oneTable the table
*
* @return void
*/
private function _loadRelationsForTable(array &$relations, $oneTable)
{
$relations[$oneTable] = array();
$foreigners = $this->relation->getForeigners($GLOBALS['db'], $oneTable);
foreach ($foreigners as $field => $foreigner) {
// Foreign keys data
if ($field == 'foreign_keys_data') {
foreach ($foreigner as $oneKey) {
$clauses = array();
// There may be multiple column relations
foreach ($oneKey['index_list'] as $index => $oneField) {
$clauses[]
= Util::backquote($oneTable) . "."
. Util::backquote($oneField) . " = "
. Util::backquote($oneKey['ref_table_name']) . "."
. Util::backquote($oneKey['ref_index_list'][$index]);
}
// Combine multiple column relations with AND
$relations[$oneTable][$oneKey['ref_table_name']]
= implode(" AND ", $clauses);
}
} else { // Internal relations
$relations[$oneTable][$foreigner['foreign_table']]
= Util::backquote($oneTable) . "."
. Util::backquote($field) . " = "
. Util::backquote($foreigner['foreign_table']) . "."
. Util::backquote($foreigner['foreign_field']);
}
}
}
/**
* Fills the $finalized arrays with JOIN clauses for each of the tables
*
* @param array &$finalized JOIN clauses for each table
* @param array $relations Relations among tables
* @param array $searchTables Tables involved in the search
*
* @return void
*/
private function _fillJoinClauses(array &$finalized, array $relations, array $searchTables)
{
while (true) {
$added = false;
foreach ($searchTables as $masterTable) {
$foreignData = $relations[$masterTable];
foreach ($foreignData as $foreignTable => $clause) {
if (! isset($finalized[$masterTable])
&& isset($finalized[$foreignTable])
) {
$finalized[$masterTable] = $clause;
$added = true;
} elseif (! isset($finalized[$foreignTable])
&& isset($finalized[$masterTable])
&& in_array($foreignTable, $searchTables)
) {
$finalized[$foreignTable] = $clause;
$added = true;
}
if ($added) {
// We are done if all tables are in $finalized
if (count($finalized) == count($searchTables)) {
return;
}
}
}
}
// If no new tables were added during this iteration, break;
if (! $added) {
return;
}
}
}
/**
* Provides the generated SQL query
*
* @param array $formColumns List of selected columns in the form
*
* @return string SQL query
*/
private function _getSQLQuery(array $formColumns)
{
$sql_query = '';
// get SELECT clause
$sql_query .= $this->_getSelectClause();
// get FROM clause
$from_clause = $this->_getFromClause($formColumns);
if (! empty($from_clause)) {
$sql_query .= 'FROM ' . htmlspecialchars($from_clause) . "\n";
}
// get WHERE clause
$sql_query .= $this->_getWhereClause();
// get ORDER BY clause
$sql_query .= $this->_getOrderByClause();
return $sql_query;
}
/**
* Provides the generated QBE form
*
* @return string QBE form
*/
public function getSelectionForm()
{
$html_output = '';
$html_output .= '';
return $html_output;
}
/**
* Get fields to display
*
* @return string
*/
private function _getSavedSearchesField()
{
$html_output = __('Saved bookmarked search:');
$html_output .= ' ';
$html_output .= '';
$html_output .= '';
$html_output .= '';
if (null !== $currentSearchId) {
$html_output .= '';
$html_output .= '';
}
return $html_output;
}
/**
* Initialize _criteria_column_count
*
* @return int Previous number of columns
*/
private function _initializeCriteriasCount()
{
// sets column count
$criteriaColumnCount = Core::ifSetOr(
$_POST['criteriaColumnCount'],
3,
'numeric'
);
$criteriaColumnAdd = Core::ifSetOr(
$_POST['criteriaColumnAdd'],
0,
'numeric'
);
$this->_criteria_column_count = max(
$criteriaColumnCount + $criteriaColumnAdd,
0
);
// sets row count
$rows = Core::ifSetOr($_POST['rows'], 0, 'numeric');
$criteriaRowAdd = Core::ifSetOr($_POST['criteriaRowAdd'], 0, 'numeric');
$this->_criteria_row_count = min(
100,
max($rows + $criteriaRowAdd, 0)
);
return $criteriaColumnCount;
}
/**
* Get best
*
* @param array $search_tables Tables involved in the search
* @param array $where_clause_columns Columns with where clause
* @param array $unique_columns Unique columns
* @param array $index_columns Indexed columns
*
* @return array
*/
private function _getLeftJoinColumnCandidatesBest(
array $search_tables, array $where_clause_columns, array $unique_columns, array $index_columns
) {
// now we want to find the best.
if (isset($unique_columns) && count($unique_columns) > 0) {
$candidate_columns = $unique_columns;
$needsort = 1;
return array($candidate_columns, $needsort);
} elseif (isset($index_columns) && count($index_columns) > 0) {
$candidate_columns = $index_columns;
$needsort = 1;
return array($candidate_columns, $needsort);
} elseif (isset($where_clause_columns) && count($where_clause_columns) > 0) {
$candidate_columns = $where_clause_columns;
$needsort = 0;
return array($candidate_columns, $needsort);
}
$candidate_columns = $search_tables;
$needsort = 0;
return array($candidate_columns, $needsort);
}
}