From 04d6d5ca99ebfd1cebb8ce06618fb3811fc1a8aa Mon Sep 17 00:00:00 2001 From: Charles Date: Thu, 9 Jan 2020 10:55:03 +0100 Subject: phpmyadmin working --- srcs/phpmyadmin/libraries/classes/Index.php | 901 ++++++++++++++++++++++++++++ 1 file changed, 901 insertions(+) create mode 100644 srcs/phpmyadmin/libraries/classes/Index.php (limited to 'srcs/phpmyadmin/libraries/classes/Index.php') diff --git a/srcs/phpmyadmin/libraries/classes/Index.php b/srcs/phpmyadmin/libraries/classes/Index.php new file mode 100644 index 0000000..8232ae3 --- /dev/null +++ b/srcs/phpmyadmin/libraries/classes/Index.php @@ -0,0 +1,901 @@ +set($params); + } + + /** + * Creates(if not already created) and returns the corresponding Index object + * + * @param string $schema database name + * @param string $table table name + * @param string $index_name index name + * + * @return Index corresponding Index object + */ + public static function singleton($schema, $table, $index_name = '') + { + Index::_loadIndexes($table, $schema); + if (! isset(Index::$_registry[$schema][$table][$index_name])) { + $index = new Index(); + if (strlen($index_name) > 0) { + $index->setName($index_name); + Index::$_registry[$schema][$table][$index->getName()] = $index; + } + return $index; + } + + return Index::$_registry[$schema][$table][$index_name]; + } + + /** + * returns an array with all indexes from the given table + * + * @param string $table table + * @param string $schema schema + * + * @return Index[] array of indexes + */ + public static function getFromTable($table, $schema) + { + Index::_loadIndexes($table, $schema); + + if (isset(Index::$_registry[$schema][$table])) { + return Index::$_registry[$schema][$table]; + } + + return []; + } + + /** + * Returns an array with all indexes from the given table of the requested types + * + * @param string $table table + * @param string $schema schema + * @param int $choices choices + * + * @return Index[] array of indexes + */ + public static function getFromTableByChoice($table, $schema, $choices = 31) + { + $indexes = []; + foreach (self::getFromTable($table, $schema) as $index) { + if (($choices & Index::PRIMARY) + && $index->getChoice() == 'PRIMARY' + ) { + $indexes[] = $index; + } + if (($choices & Index::UNIQUE) + && $index->getChoice() == 'UNIQUE' + ) { + $indexes[] = $index; + } + if (($choices & Index::INDEX) + && $index->getChoice() == 'INDEX' + ) { + $indexes[] = $index; + } + if (($choices & Index::SPATIAL) + && $index->getChoice() == 'SPATIAL' + ) { + $indexes[] = $index; + } + if (($choices & Index::FULLTEXT) + && $index->getChoice() == 'FULLTEXT' + ) { + $indexes[] = $index; + } + } + return $indexes; + } + + /** + * return primary if set, false otherwise + * + * @param string $table table + * @param string $schema schema + * + * @return mixed primary index or false if no one exists + */ + public static function getPrimary($table, $schema) + { + Index::_loadIndexes($table, $schema); + + if (isset(Index::$_registry[$schema][$table]['PRIMARY'])) { + return Index::$_registry[$schema][$table]['PRIMARY']; + } + + return false; + } + + /** + * Load index data for table + * + * @param string $table table + * @param string $schema schema + * + * @return boolean whether loading was successful + */ + private static function _loadIndexes($table, $schema) + { + if (isset(Index::$_registry[$schema][$table])) { + return true; + } + + $_raw_indexes = $GLOBALS['dbi']->getTableIndexes($schema, $table); + foreach ($_raw_indexes as $_each_index) { + $_each_index['Schema'] = $schema; + $keyName = $_each_index['Key_name']; + if (! isset(Index::$_registry[$schema][$table][$keyName])) { + $key = new Index($_each_index); + Index::$_registry[$schema][$table][$keyName] = $key; + } else { + $key = Index::$_registry[$schema][$table][$keyName]; + } + + $key->addColumn($_each_index); + } + + return true; + } + + /** + * Add column to index + * + * @param array $params column params + * + * @return void + */ + public function addColumn(array $params) + { + if (isset($params['Column_name']) + && strlen($params['Column_name']) > 0 + ) { + $this->_columns[$params['Column_name']] = new IndexColumn($params); + } + } + + /** + * Adds a list of columns to the index + * + * @param array $columns array containing details about the columns + * + * @return void + */ + public function addColumns(array $columns) + { + $_columns = []; + + if (isset($columns['names'])) { + // coming from form + // $columns[names][] + // $columns[sub_parts][] + foreach ($columns['names'] as $key => $name) { + $sub_part = isset($columns['sub_parts'][$key]) + ? $columns['sub_parts'][$key] : ''; + $_columns[] = [ + 'Column_name' => $name, + 'Sub_part' => $sub_part, + ]; + } + } else { + // coming from SHOW INDEXES + // $columns[][name] + // $columns[][sub_part] + // ... + $_columns = $columns; + } + + foreach ($_columns as $column) { + $this->addColumn($column); + } + } + + /** + * Returns true if $column indexed in this index + * + * @param string $column the column + * + * @return boolean true if $column indexed in this index + */ + public function hasColumn($column) + { + return isset($this->_columns[$column]); + } + + /** + * Sets index details + * + * @param array $params index details + * + * @return void + */ + public function set(array $params) + { + if (isset($params['columns'])) { + $this->addColumns($params['columns']); + } + if (isset($params['Schema'])) { + $this->_schema = $params['Schema']; + } + if (isset($params['Table'])) { + $this->_table = $params['Table']; + } + if (isset($params['Key_name'])) { + $this->_name = $params['Key_name']; + } + if (isset($params['Index_type'])) { + $this->_type = $params['Index_type']; + } + if (isset($params['Comment'])) { + $this->_remarks = $params['Comment']; + } + if (isset($params['Index_comment'])) { + $this->_comment = $params['Index_comment']; + } + if (isset($params['Non_unique'])) { + $this->_non_unique = $params['Non_unique']; + } + if (isset($params['Packed'])) { + $this->_packed = $params['Packed']; + } + if (isset($params['Index_choice'])) { + $this->_choice = $params['Index_choice']; + } elseif ('PRIMARY' == $this->_name) { + $this->_choice = 'PRIMARY'; + } elseif ('FULLTEXT' == $this->_type) { + $this->_choice = 'FULLTEXT'; + $this->_type = ''; + } elseif ('SPATIAL' == $this->_type) { + $this->_choice = 'SPATIAL'; + $this->_type = ''; + } elseif ('0' == $this->_non_unique) { + $this->_choice = 'UNIQUE'; + } else { + $this->_choice = 'INDEX'; + } + if (isset($params['Key_block_size'])) { + $this->_key_block_size = $params['Key_block_size']; + } + if (isset($params['Parser'])) { + $this->_parser = $params['Parser']; + } + } + + /** + * Returns the number of columns of the index + * + * @return integer the number of the columns + */ + public function getColumnCount() + { + return count($this->_columns); + } + + /** + * Returns the index comment + * + * @return string index comment + */ + public function getComment() + { + return $this->_comment; + } + + /** + * Returns index remarks + * + * @return string index remarks + */ + public function getRemarks() + { + return $this->_remarks; + } + + /** + * Return the key block size + * + * @return int + */ + public function getKeyBlockSize() + { + return $this->_key_block_size; + } + + /** + * Return the parser + * + * @return string + */ + public function getParser() + { + return $this->_parser; + } + + /** + * Returns concatenated remarks and comment + * + * @return string concatenated remarks and comment + */ + public function getComments() + { + $comments = $this->getRemarks(); + if (strlen($comments) > 0) { + $comments .= "\n"; + } + $comments .= $this->getComment(); + + return $comments; + } + + /** + * Returns index type (BTREE, HASH, RTREE) + * + * @return string index type + */ + public function getType() + { + return $this->_type; + } + + /** + * Returns index choice (PRIMARY, UNIQUE, INDEX, SPATIAL, FULLTEXT) + * + * @return string index choice + */ + public function getChoice() + { + return $this->_choice; + } + + /** + * Return a list of all index choices + * + * @return string[] index choices + */ + public static function getIndexChoices() + { + return [ + 'PRIMARY', + 'INDEX', + 'UNIQUE', + 'SPATIAL', + 'FULLTEXT', + ]; + } + + /** + * Returns a lit of all index types + * + * @return string[] index types + */ + public static function getIndexTypes() + { + return [ + 'BTREE', + 'HASH', + ]; + } + + /** + * Returns HTML for the index choice selector + * + * @param boolean $edit_table whether this is table editing + * + * @return string HTML for the index choice selector + */ + public function generateIndexChoiceSelector($edit_table) + { + $html_options = ''; + + return $html_options; + } + + /** + * Returns HTML for the index type selector + * + * @return string HTML for the index type selector + */ + public function generateIndexTypeSelector() + { + $types = ["" => "--"]; + foreach (Index::getIndexTypes() as $type) { + $types[$type] = $type; + } + + return Util::getDropdown( + "index[Index_type]", + $types, + $this->_type, + "select_index_type" + ); + } + + /** + * Returns how the index is packed + * + * @return string how the index is packed + */ + public function getPacked() + { + return $this->_packed; + } + + /** + * Returns 'No' if the index is not packed, + * how the index is packed if packed + * + * @return string + */ + public function isPacked() + { + if (null === $this->_packed) { + return __('No'); + } + + return htmlspecialchars($this->_packed); + } + + /** + * Returns integer 0 if the index cannot contain duplicates, 1 if it can + * + * @return integer 0 if the index cannot contain duplicates, 1 if it can + */ + public function getNonUnique() + { + return $this->_non_unique; + } + + /** + * Returns whether the index is a 'Unique' index + * + * @param boolean $as_text whether to output should be in text + * + * @return mixed whether the index is a 'Unique' index + */ + public function isUnique($as_text = false) + { + if ($as_text) { + $r = [ + '0' => __('Yes'), + '1' => __('No'), + ]; + } else { + $r = [ + '0' => true, + '1' => false, + ]; + } + + return $r[$this->_non_unique]; + } + + /** + * Returns the name of the index + * + * @return string the name of the index + */ + public function getName() + { + return $this->_name; + } + + /** + * Sets the name of the index + * + * @param string $name index name + * + * @return void + */ + public function setName($name) + { + $this->_name = (string) $name; + } + + /** + * Returns the columns of the index + * + * @return IndexColumn[] the columns of the index + */ + public function getColumns() + { + return $this->_columns; + } + + /** + * Get HTML for display indexes + * + * @return string + */ + public static function getHtmlForDisplayIndexes() + { + $html_output = '
'; + $html_output .= self::getHtmlForIndexes( + $GLOBALS['table'], + $GLOBALS['db'] + ); + $html_output .= '
'; + $html_output .= Url::getHiddenInputs( + $GLOBALS['db'], + $GLOBALS['table'] + ); + $html_output .= sprintf( + __('Create an index on  %s columns'), + '' + ); + $html_output .= '' + . ''; + + $html_output .= '
' + . '
' + . '
'; + + return $html_output; + } + + /** + * Show index data + * + * @param string $table The table name + * @param string $schema The schema name + * @param boolean $print_mode Whether the output is for the print mode + * + * @return string HTML for showing index + * + * @access public + */ + public static function getHtmlForIndexes($table, $schema, $print_mode = false) + { + $indexes = Index::getFromTable($table, $schema); + + $no_indexes_class = count($indexes) > 0 ? ' hide' : ''; + $no_indexes = "
"; + $no_indexes .= Message::notice(__('No index defined!'))->getDisplay(); + $no_indexes .= '
'; + + if (! $print_mode) { + $r = '
'; + $r .= '' . __('Indexes'); + $r .= Util::showMySQLDocu('optimizing-database-structure'); + + $r .= ''; + $r .= $no_indexes; + if (count($indexes) < 1) { + $r .= '
'; + return $r; + } + $r .= Index::findDuplicates($table, $schema); + } else { + $r = '

' . __('Indexes') . '

'; + $r .= $no_indexes; + if (count($indexes) < 1) { + return $r; + } + } + $r .= '
'; + $r .= ''; + $r .= ''; + $r .= ''; + if (! $print_mode) { + $r .= ''; + } + $r .= ''; + $r .= ''; + $r .= ''; + $r .= ''; + $r .= ''; + $r .= ''; + $r .= ''; + $r .= ''; + $r .= ''; + $r .= ''; + $r .= ''; + + foreach ($indexes as $index) { + $row_span = ' rowspan="' . $index->getColumnCount() . '" '; + $r .= ''; + $r .= ''; + + if (! $print_mode) { + $this_params = $GLOBALS['url_params']; + $this_params['index'] = $index->getName(); + $r .= '' . "\n"; + $this_params = $GLOBALS['url_params']; + if ($index->getName() == 'PRIMARY') { + $this_params['sql_query'] = 'ALTER TABLE ' + . Util::backquote($table) + . ' DROP PRIMARY KEY;'; + $this_params['message_to_show'] + = __('The primary key has been dropped.'); + $js_msg = Sanitize::jsFormat($this_params['sql_query'], false); + } else { + $this_params['sql_query'] = 'ALTER TABLE ' + . Util::backquote($table) . ' DROP INDEX ' + . Util::backquote($index->getName()) . ';'; + $this_params['message_to_show'] = sprintf( + __('Index %s has been dropped.'), + htmlspecialchars($index->getName()) + ); + $js_msg = Sanitize::jsFormat($this_params['sql_query'], false); + } + + $r .= '' . "\n"; + } + + if (! $print_mode) { + $r .= ''; + } else { + $r .= ''; + } + $r .= ''; + $r .= ''; + $r .= ''; + + foreach ($index->getColumns() as $column) { + if ($column->getSeqInIndex() > 1) { + $r .= ''; + } + $r .= ''; + $r .= ''; + $r .= ''; + $r .= ''; + + if ($column->getSeqInIndex() == 1 + ) { + $r .= ''; + } + $r .= ''; + } // end foreach $index['Sequences'] + $r .= ''; + } // end while + $r .= '
' . __('Action') . '' . __('Keyname') . '' . __('Type') . '' . __('Unique') . '' . __('Packed') . '' . __('Column') . '' . __('Cardinality') . '' . __('Collation') . '' . __('Null') . '' . __('Comment') . '
' + . ' ' . Util::getIcon('b_edit', __('Edit')) . '' + . ''; + $r .= ''; + $r .= Util::linkOrButton( + 'sql.php' . Url::getCommon($this_params), + Util::getIcon('b_drop', __('Drop')), + ['class' => 'drop_primary_key_index_anchor ajax'] + ); + $r .= '' + . htmlspecialchars($index->getName()) + . '' + . htmlspecialchars($index->getName()) + . ''; + $type = $index->getType(); + if (! empty($type)) { + $r .= htmlspecialchars($type); + } else { + $r .= htmlspecialchars($index->getChoice()); + } + $r .= '' . $index->isUnique(true) . '' . $index->isPacked() . '
' . htmlspecialchars($column->getName()); + if ($column->getSubPart()) { + $r .= ' (' . htmlspecialchars($column->getSubPart()) . ')'; + } + $r .= '' + . htmlspecialchars((string) $column->getCardinality()) + . '' + . htmlspecialchars((string) $column->getCollation()) + . '' + . htmlspecialchars($column->getNull(true)) + . '' + . htmlspecialchars($index->getComments()) . '
'; + $r .= '
'; + if (! $print_mode) { + $r .= ''; + } + + return $r; + } + + /** + * Gets the properties in an array for comparison purposes + * + * @return array an array containing the properties of the index + */ + public function getCompareData() + { + $data = [ + // 'Non_unique' => $this->_non_unique, + 'Packed' => $this->_packed, + 'Index_choice' => $this->_choice, + ]; + + foreach ($this->_columns as $column) { + $data['columns'][] = $column->getCompareData(); + } + + return $data; + } + + /** + * Function to check over array of indexes and look for common problems + * + * @param string $table table name + * @param string $schema schema name + * + * @return string Output HTML + * @access public + */ + public static function findDuplicates($table, $schema) + { + $indexes = Index::getFromTable($table, $schema); + + $output = ''; + + // count($indexes) < 2: + // there is no need to check if there less than two indexes + if (count($indexes) < 2) { + return $output; + } + + // remove last index from stack and ... + while ($while_index = array_pop($indexes)) { + // ... compare with every remaining index in stack + foreach ($indexes as $each_index) { + if ($each_index->getCompareData() !== $while_index->getCompareData() + ) { + continue; + } + + // did not find any difference + // so it makes no sense to have this two equal indexes + + $message = Message::notice( + __( + 'The indexes %1$s and %2$s seem to be equal and one of them ' + . 'could possibly be removed.' + ) + ); + $message->addParam($each_index->getName()); + $message->addParam($while_index->getName()); + $output .= $message->getDisplay(); + + // there is no need to check any further indexes if we have already + // found that this one has a duplicate + continue 2; + } + } + return $output; + } +} -- cgit