0x1949 Team - FAZEMRX - MANAGER
Edit File: DbPackages-postgresql.php
<?php /** * This file contains database functionality specifically designed for packages (mods) to utilize. * * Simple Machines Forum (SMF) * * @package SMF * @author Simple Machines https://www.simplemachines.org * @copyright 2023 Simple Machines and individual contributors * @license https://www.simplemachines.org/about/smf/license.php BSD * * @version 2.1.4 */ if (!defined('SMF')) die('No direct access...'); /** * Add the file functions to the $smcFunc array. */ function db_packages_init() { global $smcFunc, $reservedTables, $db_package_log, $db_prefix; if (!isset($smcFunc['db_create_table']) || $smcFunc['db_create_table'] != 'smf_db_create_table') { $smcFunc += array( 'db_add_column' => 'smf_db_add_column', 'db_add_index' => 'smf_db_add_index', 'db_calculate_type' => 'smf_db_calculate_type', 'db_change_column' => 'smf_db_change_column', 'db_create_table' => 'smf_db_create_table', 'db_drop_table' => 'smf_db_drop_table', 'db_table_structure' => 'smf_db_table_structure', 'db_list_columns' => 'smf_db_list_columns', 'db_list_indexes' => 'smf_db_list_indexes', 'db_remove_column' => 'smf_db_remove_column', 'db_remove_index' => 'smf_db_remove_index', ); $db_package_log = array(); } // We setup an array of SMF tables we can't do auto-remove on - in case a mod writer cocks it up! $reservedTables = array( 'admin_info_files', 'approval_queue', 'attachments', 'background_tasks', 'ban_groups', 'ban_items', 'board_permissions', 'board_permissions_view', 'boards', 'calendar', 'calendar_holidays', 'categories', 'custom_fields', 'group_moderators', 'log_actions', 'log_activity', 'log_banned', 'log_boards', 'log_comments', 'log_digest', 'log_errors', 'log_floodcontrol', 'log_group_requests', 'log_mark_read', 'log_member_notices', 'log_notify', 'log_online', 'log_packages', 'log_polls', 'log_reported', 'log_reported_comments', 'log_scheduled_tasks', 'log_search_messages', 'log_search_results', 'log_search_subjects', 'log_search_topics', 'log_spider_hits', 'log_spider_stats', 'log_subscribed', 'log_topics', 'mail_queue', 'member_logins', 'membergroups', 'members', 'mentions', 'message_icons', 'messages', 'moderator_groups', 'moderators', 'package_servers', 'permission_profiles', 'permissions', 'personal_messages', 'pm_labeled_messages', 'pm_labels', 'pm_recipients', 'pm_rules', 'poll_choices', 'polls', 'qanda', 'scheduled_tasks', 'sessions', 'settings', 'smiley_files', 'smileys', 'spiders', 'subscriptions', 'themes', 'topics', 'user_alerts', 'user_alerts_prefs', 'user_drafts', 'user_likes', ); foreach ($reservedTables as $k => $table_name) $reservedTables[$k] = strtolower($db_prefix . $table_name); // We in turn may need the extra stuff. db_extend('extra'); } /** * This function can be used to create a table without worrying about schema * compatibilities across supported database systems. * - If the table exists will, by default, do nothing. * - Builds table with columns as passed to it - at least one column must be sent. * The columns array should have one sub-array for each column - these sub arrays contain: * 'name' = Column name * 'type' = Type of column - values from (smallint, mediumint, int, text, varchar, char, tinytext, mediumtext, largetext) * 'size' => Size of column (If applicable) - for example 255 for a large varchar, 10 for an int etc. * If not set SMF will pick a size. * - 'default' = Default value - do not set if no default required. * - 'not_null' => Can it be null (true or false) - if not set default will be false. * - 'auto' => Set to true to make it an auto incrementing column. Set to a numerical value to set from what * it should begin counting. * - Adds indexes as specified within indexes parameter. Each index should be a member of $indexes. Values are: * - 'name' => Index name (If left empty SMF will generate). * - 'type' => Type of index. Choose from 'primary', 'unique' or 'index'. If not set will default to 'index'. * - 'columns' => Array containing columns that form part of key - in the order the index is to be created. * - parameters: (None yet) * - if_exists values: * - 'ignore' will do nothing if the table exists. (And will return true) * - 'overwrite' will drop any existing table of the same name. * - 'error' will return false if the table already exists. * - 'update' will update the table if the table already exists (no change of ai field and only colums with the same name keep the data) * * @param string $table_name The name of the table to create * @param array $columns An array of column info in the specified format * @param array $indexes An array of index info in the specified format * @param array $parameters Currently not used * @param string $if_exists What to do if the table exists. * @param string $error */ function smf_db_create_table($table_name, $columns, $indexes = array(), $parameters = array(), $if_exists = 'ignore', $error = 'fatal') { global $reservedTables, $smcFunc, $db_package_log, $db_prefix, $db_name; $db_trans = false; $old_table_exists = false; // Strip out the table name, we might not need it in some cases $real_prefix = preg_match('~^("?)(.+?)\\1\\.(.*?)$~', $db_prefix, $match) === 1 ? $match[3] : $db_prefix; $database = !empty($match[2]) ? $match[2] : $db_name; // With or without the database name, the fullname looks like this. $full_table_name = str_replace('{db_prefix}', $real_prefix, $table_name); $short_table_name = str_replace('{db_prefix}', $db_prefix, $table_name); // First - no way do we touch SMF tables. if (in_array(strtolower($short_table_name), $reservedTables)) return false; // Log that we'll want to remove this on uninstall. $db_package_log[] = array('remove_table', $short_table_name); // This... my friends... is a function in a half - let's start by checking if the table exists! $tables = $smcFunc['db_list_tables']($database); if (in_array($full_table_name, $tables)) { // This is a sad day... drop the table? If not, return false (error) by default. if ($if_exists == 'overwrite') $smcFunc['db_drop_table']($table_name); elseif ($if_exists == 'update') { $smcFunc['db_drop_table']($table_name . '_old'); $smcFunc['db_transaction']('begin'); $db_trans = true; $smcFunc['db_query']('', ' ALTER TABLE ' . $short_table_name . ' RENAME TO ' . $short_table_name . '_old', array( 'security_override' => true, ) ); $old_table_exists = true; } else return $if_exists == 'ignore'; } // If we've got this far - good news - no table exists. We can build our own! if (!$db_trans) $smcFunc['db_transaction']('begin'); $table_query = 'CREATE TABLE ' . $short_table_name . "\n" . '('; foreach ($columns as $column) { $column = array_change_key_case($column); // If we have an auto increment do it! if (!empty($column['auto'])) { if (!$old_table_exists) $smcFunc['db_query']('', ' DROP SEQUENCE IF EXISTS ' . $short_table_name . '_seq', array( 'security_override' => true, ) ); if (!$old_table_exists) $smcFunc['db_query']('', ' CREATE SEQUENCE ' . $short_table_name . '_seq', array( 'security_override' => true, ) ); $default = 'default nextval(\'' . $short_table_name . '_seq\')'; } elseif (isset($column['default']) && $column['default'] !== null) $default = 'default \'' . $smcFunc['db_escape_string']($column['default']) . '\''; else $default = ''; // Sort out the size... $column['size'] = isset($column['size']) && is_numeric($column['size']) ? $column['size'] : null; list ($type, $size) = $smcFunc['db_calculate_type']($column['type'], $column['size']); if ($size !== null) $type = $type . '(' . $size . ')'; // backward compatibility if (isset($column['null']) && !isset($column['not_null'])) $column['not_null'] = !$column['null']; // Now just put it together! $table_query .= "\n\t\"" . $column['name'] . '" ' . $type . ' ' . (!empty($column['not_null']) ? 'NOT NULL' : '') . ' ' . $default . ','; } // Loop through the indexes a sec... $index_queries = array(); foreach ($indexes as $index) { // MySQL you can do a "column_name (length)", postgresql does not allow this. Strip it. foreach ($index['columns'] as &$c) $c = preg_replace('~\s+(\(\d+\))~', '', $c); $idx_columns = implode(',', $index['columns']); // Primary goes in the table... if (isset($index['type']) && $index['type'] == 'primary') $table_query .= "\n\t" . 'PRIMARY KEY (' . implode(',', $index['columns']) . '),'; else { if (empty($index['name'])) $index['name'] = trim(implode('_', preg_replace('~(\(\d+\))~', '', $index['columns']))); $index_queries[] = 'CREATE ' . (isset($index['type']) && $index['type'] == 'unique' ? 'UNIQUE' : '') . ' INDEX ' . $short_table_name . '_' . $index['name'] . ' ON ' . $short_table_name . ' (' . $idx_columns . ')'; } } // No trailing commas! if (substr($table_query, -1) == ',') $table_query = substr($table_query, 0, -1); $table_query .= ')'; // Create the table! $smcFunc['db_query']('', $table_query, array( 'security_override' => true, ) ); // Fill the old data if ($old_table_exists) { $same_col = array(); $request = $smcFunc['db_query']('', ' SELECT count(*), column_name FROM information_schema.columns WHERE table_name in ({string:table1},{string:table2}) AND table_schema = {string:schema} GROUP BY column_name HAVING count(*) > 1', array( 'table1' => $short_table_name, 'table2' => $short_table_name . '_old', 'schema' => 'public', ) ); while ($row = $smcFunc['db_fetch_assoc']($request)) { $same_col[] = $row['column_name']; } $smcFunc['db_query']('', ' INSERT INTO ' . $short_table_name . '(' . implode(',', $same_col) . ') SELECT ' . implode(',', $same_col) . ' FROM ' . $short_table_name . '_old', array() ); } // And the indexes... foreach ($index_queries as $query) $smcFunc['db_query']('', $query, array( 'security_override' => true, ) ); // Go, go power rangers! $smcFunc['db_transaction']('commit'); if ($old_table_exists) $smcFunc['db_drop_table']($table_name . '_old'); return true; } /** * Drop a table and its associated sequences. * * @param string $table_name The name of the table to drop * @param array $parameters Not used at the moment * @param string $error * @return boolean Whether or not the operation was successful */ function smf_db_drop_table($table_name, $parameters = array(), $error = 'fatal') { global $reservedTables, $smcFunc, $db_prefix, $db_name; // After stripping away the database name, this is what's left. $real_prefix = preg_match('~^("?)(.+?)\\1\\.(.*?)$~', $db_prefix, $match) === 1 ? $match[3] : $db_prefix; $database = !empty($match[2]) ? $match[2] : $db_name; // Get some aliases. $full_table_name = str_replace('{db_prefix}', $real_prefix, $table_name); $short_table_name = str_replace('{db_prefix}', $db_prefix, $table_name); // God no - dropping one of these = bad. if (in_array(strtolower($table_name), $reservedTables)) return false; // Does it exist? $tables = $smcFunc['db_list_tables']($database); if (in_array($full_table_name, $tables)) { // We can then drop the table. $smcFunc['db_transaction']('begin'); // the table $table_query = 'DROP TABLE ' . $short_table_name; // and the assosciated sequence, if any $sequence_query = 'DROP SEQUENCE IF EXISTS ' . $short_table_name . '_seq'; // drop them $smcFunc['db_query']('', $table_query, array( 'security_override' => true, ) ); $smcFunc['db_query']('', $sequence_query, array( 'security_override' => true, ) ); $smcFunc['db_transaction']('commit'); return true; } // Otherwise do 'nout. return false; } /** * This function adds a column. * * @param string $table_name The name of the table to add the column to * @param array $column_info An array of column info (see {@link smf_db_create_table()}) * @param array $parameters Not used? * @param string $if_exists What to do if the column exists. If 'update', column is updated. * @param string $error * @return boolean Whether or not the operation was successful */ function smf_db_add_column($table_name, $column_info, $parameters = array(), $if_exists = 'update', $error = 'fatal') { global $smcFunc, $db_package_log, $db_prefix; $short_table_name = str_replace('{db_prefix}', $db_prefix, $table_name); $column_info = array_change_key_case($column_info); // Log that we will want to uninstall this! $db_package_log[] = array('remove_column', $short_table_name, $column_info['name']); // Does it exist - if so don't add it again! $columns = $smcFunc['db_list_columns']($table_name, false); foreach ($columns as $column) if ($column == $column_info['name']) { // If we're going to overwrite then use change column. if ($if_exists == 'update') return $smcFunc['db_change_column']($table_name, $column_info['name'], $column_info); else return false; } // Get the specifics... $column_info['size'] = isset($column_info['size']) && is_numeric($column_info['size']) ? $column_info['size'] : null; list ($type, $size) = $smcFunc['db_calculate_type']($column_info['type'], $column_info['size']); if ($size !== null) $type = $type . '(' . $size . ')'; // Now add the thing! $query = ' ALTER TABLE ' . $short_table_name . ' ADD COLUMN ' . $column_info['name'] . ' ' . $type; $smcFunc['db_query']('', $query, array( 'security_override' => true, ) ); // If there's more attributes they need to be done via a change on PostgreSQL. unset($column_info['type'], $column_info['size']); if (count($column_info) != 1) return $smcFunc['db_change_column']($table_name, $column_info['name'], $column_info); else return true; } /** * Removes a column. * * @param string $table_name The name of the table to drop the column from * @param string $column_name The name of the column to drop * @param array $parameters Not used? * @param string $error * @return boolean Whether or not the operation was successful */ function smf_db_remove_column($table_name, $column_name, $parameters = array(), $error = 'fatal') { global $smcFunc, $db_prefix; $short_table_name = str_replace('{db_prefix}', $db_prefix, $table_name); // Does it exist? $columns = $smcFunc['db_list_columns']($table_name, true); foreach ($columns as $column) if (strtolower($column['name']) == strtolower($column_name)) { // If there is an auto we need remove it! if ($column['auto']) $smcFunc['db_query']('', ' DROP SEQUENCE IF EXISTS ' . $short_table_name . '_seq', array( 'security_override' => true, ) ); $smcFunc['db_query']('', ' ALTER TABLE ' . $short_table_name . ' DROP COLUMN ' . $column_name, array( 'security_override' => true, ) ); return true; } // If here we didn't have to work - joy! return false; } /** * Change a column. You only need to specify the column attributes that are changing. * * @param string $table_name The name of the table this column is in * @param string $old_column The name of the column we want to change * @param array $column_info An array of info about the "new" column definition (see {@link smf_db_create_table()}) * Note that $column_info also supports two additional parameters that only make sense when changing columns: * - drop_default - to drop a default that was previously specified * @return bool */ function smf_db_change_column($table_name, $old_column, $column_info) { global $smcFunc, $db_prefix; $short_table_name = str_replace('{db_prefix}', $db_prefix, $table_name); $column_info = array_change_key_case($column_info); // Check it does exist! $columns = $smcFunc['db_list_columns']($table_name, true); $old_info = null; foreach ($columns as $column) if ($column['name'] == $old_column) $old_info = $column; // Nothing? if ($old_info == null) return false; // backward compatibility if (isset($column_info['null']) && !isset($column_info['not_null'])) $column_info['not_null'] = !$column_info['null']; // Get the right bits. if (isset($column_info['drop_default']) && !empty($column_info['drop_default'])) $column_info['drop_default'] = true; else $column_info['drop_default'] = false; if (!isset($column_info['name'])) $column_info['name'] = $old_column; if (!array_key_exists('default', $column_info) && array_key_exists('default', $old_info) && empty($column_info['drop_default'])) $column_info['default'] = $old_info['default']; if (!isset($column_info['not_null'])) $column_info['not_null'] = $old_info['not_null']; if (!isset($column_info['auto'])) $column_info['auto'] = $old_info['auto']; if (!isset($column_info['type'])) $column_info['type'] = $old_info['type']; if (!isset($column_info['size']) || !is_numeric($column_info['size'])) $column_info['size'] = $old_info['size']; if (!isset($column_info['unsigned']) || !in_array($column_info['type'], array('int', 'tinyint', 'smallint', 'mediumint', 'bigint'))) $column_info['unsigned'] = ''; // If truly unspecified, make that clear, otherwise, might be confused with NULL... // (Unspecified = no default whatsoever = column is not nullable with a value of null...) if (($column_info['not_null'] === true) && !$column_info['drop_default'] && array_key_exists('default', $column_info) && is_null($column_info['default'])) unset($column_info['default']); // If you need to drop the default, that needs it's own thing... // Must be done first, in case the default type is inconsistent with the other changes. if ($column_info['drop_default']) { $smcFunc['db_query']('', ' ALTER TABLE ' . $short_table_name . ' ALTER COLUMN ' . $old_column . ' DROP DEFAULT', array( 'security_override' => true, ) ); } // Now we check each bit individually and ALTER as required. if (isset($column_info['name']) && $column_info['name'] != $old_column) { $smcFunc['db_query']('', ' ALTER TABLE ' . $short_table_name . ' RENAME COLUMN ' . $old_column . ' TO ' . $column_info['name'], array( 'security_override' => true, ) ); } // What about a change in type? if (isset($column_info['type']) && ($column_info['type'] != $old_info['type'] || (isset($column_info['size']) && $column_info['size'] != $old_info['size']))) { $column_info['size'] = isset($column_info['size']) && is_numeric($column_info['size']) ? $column_info['size'] : null; list ($type, $size) = $smcFunc['db_calculate_type']($column_info['type'], $column_info['size']); if ($size !== null) $type = $type . '(' . $size . ')'; // The alter is a pain. $smcFunc['db_transaction']('begin'); $smcFunc['db_query']('', ' ALTER TABLE ' . $short_table_name . ' ADD COLUMN ' . $column_info['name'] . '_tempxx ' . $type, array( 'security_override' => true, ) ); $smcFunc['db_query']('', ' UPDATE ' . $short_table_name . ' SET ' . $column_info['name'] . '_tempxx = CAST(' . $column_info['name'] . ' AS ' . $type . ')', array( 'security_override' => true, ) ); $smcFunc['db_query']('', ' ALTER TABLE ' . $short_table_name . ' DROP COLUMN ' . $column_info['name'], array( 'security_override' => true, ) ); $smcFunc['db_query']('', ' ALTER TABLE ' . $short_table_name . ' RENAME COLUMN ' . $column_info['name'] . '_tempxx TO ' . $column_info['name'], array( 'security_override' => true, ) ); $smcFunc['db_transaction']('commit'); } // Different default? // Just go ahead & honor the setting. Type changes above introduce defaults that we might need to override here... if (!$column_info['drop_default'] && array_key_exists('default', $column_info)) { // Fix the default. $default = ''; if (is_null($column_info['default'])) $default = 'NULL'; elseif (isset($column_info['default']) && is_numeric($column_info['default'])) $default = strpos($column_info['default'], '.') ? floatval($column_info['default']) : intval($column_info['default']); else $default = '\'' . $smcFunc['db_escape_string']($column_info['default']) . '\''; $action = 'SET DEFAULT ' . $default; $smcFunc['db_query']('', ' ALTER TABLE ' . $short_table_name . ' ALTER COLUMN ' . $column_info['name'] . ' ' . $action, array( 'security_override' => true, ) ); } // Is it null - or otherwise? // Just go ahead & honor the setting. Type changes above introduce defaults that we might need to override here... if ($column_info['not_null']) $action = 'SET NOT NULL'; else $action = 'DROP NOT NULL'; $smcFunc['db_query']('', ' ALTER TABLE ' . $short_table_name . ' ALTER COLUMN ' . $column_info['name'] . ' ' . $action, array( 'security_override' => true, ) ); return true; } /** * Add an index. * * @param string $table_name The name of the table to add the index to * @param array $index_info An array of index info (see {@link smf_db_create_table()}) * @param array $parameters Not used? * @param string $if_exists What to do if the index exists. If 'update', the definition will be updated. * @param string $error * @return boolean Whether or not the operation was successful */ function smf_db_add_index($table_name, $index_info, $parameters = array(), $if_exists = 'update', $error = 'fatal') { global $smcFunc, $db_package_log, $db_prefix; $parsed_table_name = str_replace('{db_prefix}', $db_prefix, $table_name); $real_table_name = preg_match('~^(`?)(.+?)\\1\\.(.*?)$~', $parsed_table_name, $match) === 1 ? $match[3] : $parsed_table_name; // No columns = no index. if (empty($index_info['columns'])) return false; // MySQL you can do a "column_name (length)", postgresql does not allow this. Strip it. foreach ($index_info['columns'] as &$c) $c = preg_replace('~\s+(\(\d+\))~', '', $c); $columns = implode(',', $index_info['columns']); // No name - make it up! if (empty($index_info['name'])) { // No need for primary. if (isset($index_info['type']) && $index_info['type'] == 'primary') $index_info['name'] = ''; else $index_info['name'] = trim(implode('_', preg_replace('~(\(\d+\))~', '', $index_info['columns']))); } else $index_info['name'] = $index_info['name']; // Log that we are going to want to remove this! $db_package_log[] = array('remove_index', $parsed_table_name, $index_info['name']); // Let's get all our indexes. $indexes = $smcFunc['db_list_indexes']($table_name, true); // Do we already have it? foreach ($indexes as $index) { if ($index['name'] == $index_info['name'] || ($index['type'] == 'primary' && isset($index_info['type']) && $index_info['type'] == 'primary')) { // If we want to overwrite simply remove the current one then continue. if ($if_exists != 'update' || $index['type'] == 'primary') return false; else $smcFunc['db_remove_index']($table_name, $index_info['name']); } } // If we're here we know we don't have the index - so just add it. if (!empty($index_info['type']) && $index_info['type'] == 'primary') { $smcFunc['db_query']('', ' ALTER TABLE ' . $real_table_name . ' ADD PRIMARY KEY (' . $columns . ')', array( 'security_override' => true, ) ); } else { $smcFunc['db_query']('', ' CREATE ' . (isset($index_info['type']) && $index_info['type'] == 'unique' ? 'UNIQUE' : '') . ' INDEX ' . $real_table_name . '_' . $index_info['name'] . ' ON ' . $real_table_name . ' (' . $columns . ')', array( 'security_override' => true, ) ); } } /** * Remove an index. * * @param string $table_name The name of the table to remove the index from * @param string $index_name The name of the index to remove * @param array $parameters Not used? * @param string $error * @return boolean Whether or not the operation was successful */ function smf_db_remove_index($table_name, $index_name, $parameters = array(), $error = 'fatal') { global $smcFunc, $db_prefix; $parsed_table_name = str_replace('{db_prefix}', $db_prefix, $table_name); $real_table_name = preg_match('~^(`?)(.+?)\\1\\.(.*?)$~', $parsed_table_name, $match) === 1 ? $match[3] : $parsed_table_name; // Better exist! $indexes = $smcFunc['db_list_indexes']($table_name, true); // Do not add the table name to the index if it is arleady there. if ($index_name != 'primary' && strpos($index_name, $real_table_name) !== false) $index_name = str_replace($real_table_name . '_', '', $index_name); foreach ($indexes as $index) { // If the name is primary we want the primary key! if ($index['type'] == 'primary' && $index_name == 'primary') { // Dropping primary key is odd... $smcFunc['db_query']('', ' ALTER TABLE ' . $real_table_name . ' DROP CONSTRAINT ' . $index['name'], array( 'security_override' => true, ) ); return true; } if ($index['name'] == $index_name) { // Drop the bugger... $smcFunc['db_query']('', ' DROP INDEX ' . $real_table_name . '_' . $index_name, array( 'security_override' => true, ) ); return true; } } // Not to be found ;( return false; } /** * Get the schema formatted name for a type. * * @param string $type_name The data type (int, varchar, smallint, etc.) * @param int $type_size The size (8, 255, etc.) * @param boolean $reverse If true, returns specific types for a generic type * @return array An array containing the appropriate type and size for this DB type */ function smf_db_calculate_type($type_name, $type_size = null, $reverse = false) { // Let's be sure it's lowercase MySQL likes both, others no. $type_name = strtolower($type_name); // Generic => Specific. if (!$reverse) { $types = array( 'varchar' => 'character varying', 'char' => 'character', 'mediumint' => 'int', 'tinyint' => 'smallint', 'tinytext' => 'character varying', 'mediumtext' => 'text', 'largetext' => 'text', 'inet' => 'inet', 'time' => 'time without time zone', 'datetime' => 'timestamp without time zone', 'timestamp' => 'timestamp without time zone', ); } else { $types = array( 'character varying' => 'varchar', 'character' => 'char', 'integer' => 'int', 'inet' => 'inet', 'time without time zone' => 'time', 'timestamp without time zone' => 'datetime', 'numeric' => 'decimal', ); } // Got it? Change it! if (isset($types[$type_name])) { if ($type_name == 'tinytext') $type_size = 255; $type_name = $types[$type_name]; } // Only char fields got size if (strpos($type_name, 'char') === false) $type_size = null; return array($type_name, $type_size); } /** * Get table structure. * * @param string $table_name The name of the table * @return array An array of table structure - the name, the column info from {@link smf_db_list_columns()} and the index info from {@link smf_db_list_indexes()} */ function smf_db_table_structure($table_name) { global $smcFunc, $db_prefix; $parsed_table_name = str_replace('{db_prefix}', $db_prefix, $table_name); $real_table_name = preg_match('~^(`?)(.+?)\\1\\.(.*?)$~', $parsed_table_name, $match) === 1 ? $match[3] : $parsed_table_name; return array( 'name' => $real_table_name, 'columns' => $smcFunc['db_list_columns']($table_name, true), 'indexes' => $smcFunc['db_list_indexes']($table_name, true), ); } /** * Return column information for a table. * * @param string $table_name The name of the table to get column info for * @param bool $detail Whether or not to return detailed info. If true, returns the column info. If false, just returns the column names. * @param array $parameters Not used? * @return array An array of column names or detailed column info, depending on $detail */ function smf_db_list_columns($table_name, $detail = false, $parameters = array()) { global $smcFunc, $db_prefix, $db_name; $parsed_table_name = str_replace('{db_prefix}', $db_prefix, $table_name); $real_table_name = preg_match('~^(`?)(.+?)\\1\\.(.*?)$~', $parsed_table_name, $match) === 1 ? $match[3] : $parsed_table_name; $database = !empty($match[2]) ? $match[2] : $db_name; $result = $smcFunc['db_query']('', ' SELECT column_name, column_default, is_nullable, data_type, character_maximum_length FROM information_schema.columns WHERE table_schema = {string:schema_public} AND table_name = {string:table_name} ORDER BY ordinal_position', array( 'schema_public' => 'public', 'table_name' => $real_table_name, ) ); $columns = array(); while ($row = $smcFunc['db_fetch_assoc']($result)) { if (!$detail) { $columns[] = $row['column_name']; } else { $auto = false; $default = null; // What is the default? if ($row['column_default'] !== null) { if (preg_match('~nextval\(\'(.+?)\'(.+?)*\)~i', $row['column_default'], $matches) != 0) $auto = true; elseif (substr($row['column_default'], 0, 4) != 'NULL' && trim($row['column_default']) != '') { $pos = strpos($row['column_default'], '::'); $default = trim($pos === false ? $row['column_default'] : substr($row['column_default'], 0, $pos), '\''); } } // Make the type generic. list ($type, $size) = $smcFunc['db_calculate_type']($row['data_type'], $row['character_maximum_length'], true); $columns[$row['column_name']] = array( 'name' => $row['column_name'], 'not_null' => $row['is_nullable'] != 'YES', 'null' => $row['is_nullable'] == 'YES', 'default' => $default, 'type' => $type, 'size' => $size, 'auto' => $auto, ); } } $smcFunc['db_free_result']($result); return $columns; } /** * Get index information. * * @param string $table_name The name of the table to get indexes for * @param bool $detail Whether or not to return detailed info. * @param array $parameters Not used? * @return array An array of index names or a detailed array of index info, depending on $detail */ function smf_db_list_indexes($table_name, $detail = false, $parameters = array()) { global $smcFunc, $db_prefix, $db_name; $parsed_table_name = str_replace('{db_prefix}', $db_prefix, $table_name); $real_table_name = preg_match('~^(`?)(.+?)\\1\\.(.*?)$~', $parsed_table_name, $match) === 1 ? $match[3] : $parsed_table_name; $database = !empty($match[2]) ? $match[2] : $db_name; $result = $smcFunc['db_query']('', ' SELECT CASE WHEN i.indisprimary THEN 1 ELSE 0 END AS is_primary, CASE WHEN i.indisunique THEN 1 ELSE 0 END AS is_unique, c2.relname AS name, pg_get_indexdef(i.indexrelid) AS inddef FROM pg_class AS c, pg_class AS c2, pg_index AS i WHERE c.relname = {string:table_name} AND c.oid = i.indrelid AND i.indexrelid = c2.oid', array( 'table_name' => $real_table_name, ) ); $indexes = array(); while ($row = $smcFunc['db_fetch_assoc']($result)) { // Try get the columns that make it up. if (preg_match('~\(([^\)]+?)\)~i', $row['inddef'], $matches) == 0) continue; $columns = explode(',', $matches[1]); if (empty($columns)) continue; foreach ($columns as $k => $v) $columns[$k] = trim($v); // Fix up the name to be consistent cross databases if (substr($row['name'], -5) == '_pkey' && $row['is_primary'] == 1) $row['name'] = 'PRIMARY'; else $row['name'] = str_replace($real_table_name . '_', '', $row['name']); if (!$detail) $indexes[] = $row['name']; else { $indexes[$row['name']] = array( 'name' => $row['name'], 'type' => $row['is_primary'] ? 'primary' : ($row['is_unique'] ? 'unique' : 'index'), 'columns' => $columns, ); } } $smcFunc['db_free_result']($result); return $indexes; } ?>