DbPackages-sqlite.php 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822
  1. <?php
  2. /**
  3. * This file contains database functionality specifically designed for packages (mods) to utilize.
  4. *
  5. * Simple Machines Forum (SMF)
  6. *
  7. * @package SMF
  8. * @author Simple Machines http://www.simplemachines.org
  9. * @copyright 2013 Simple Machines and individual contributors
  10. * @license http://www.simplemachines.org/about/smf/license.php BSD
  11. *
  12. * @version 2.1 Alpha 1
  13. */
  14. if (!defined('SMF'))
  15. die('No direct access...');
  16. /**
  17. * Add the file functions to the $smcFunc array.
  18. */
  19. function db_packages_init()
  20. {
  21. global $smcFunc, $reservedTables, $db_package_log, $db_prefix;
  22. if (!isset($smcFunc['db_create_table']) || $smcFunc['db_create_table'] != 'smf_db_create_table')
  23. {
  24. $smcFunc += array(
  25. 'db_add_column' => 'smf_db_add_column',
  26. 'db_add_index' => 'smf_db_add_index',
  27. 'db_alter_table' => 'smf_db_alter_table',
  28. 'db_calculate_type' => 'smf_db_calculate_type',
  29. 'db_change_column' => 'smf_db_change_column',
  30. 'db_create_table' => 'smf_db_create_table',
  31. 'db_drop_table' => 'smf_db_drop_table',
  32. 'db_table_structure' => 'smf_db_table_structure',
  33. 'db_list_columns' => 'smf_db_list_columns',
  34. 'db_list_indexes' => 'smf_db_list_indexes',
  35. 'db_remove_column' => 'smf_db_remove_column',
  36. 'db_remove_index' => 'smf_db_remove_index',
  37. );
  38. $db_package_log = array();
  39. }
  40. // We setup an array of SMF tables we can't do auto-remove on - in case a mod writer cocks it up!
  41. $reservedTables = array('admin_info_files', 'approval_queue', 'attachments', 'ban_groups', 'ban_items',
  42. 'board_permissions', 'boards', 'calendar', 'calendar_holidays', 'categories', 'collapsed_categories',
  43. 'custom_fields', 'group_moderators', 'log_actions', 'log_activity', 'log_banned', 'log_boards',
  44. 'log_digest', 'log_errors', 'log_floodcontrol', 'log_group_requests', 'log_karma', 'log_mark_read',
  45. 'log_notify', 'log_online', 'log_packages', 'log_polls', 'log_reported', 'log_reported_comments',
  46. 'log_scheduled_tasks', 'log_search_messages', 'log_search_results', 'log_search_subjects',
  47. 'log_search_topics', 'log_topics', 'mail_queue', 'membergroups', 'members', 'message_icons',
  48. 'messages', 'moderators', 'package_servers', 'permission_profiles', 'permissions', 'personal_messages',
  49. 'pm_recipients', 'poll_choices', 'polls', 'scheduled_tasks', 'sessions', 'settings', 'smileys',
  50. 'themes', 'topics');
  51. foreach ($reservedTables as $k => $table_name)
  52. $reservedTables[$k] = strtolower($db_prefix . $table_name);
  53. // We in turn may need the extra stuff.
  54. db_extend('extra');
  55. }
  56. /**
  57. * This function can be used to create a table without worrying about schema
  58. * compatabilities across supported database systems.
  59. * - If the table exists will, by default, do nothing.
  60. * - Builds table with columns as passed to it - at least one column must be sent.
  61. * The columns array should have one sub-array for each column - these sub arrays contain:
  62. * 'name' = Column name
  63. * 'type' = Type of column - values from (smallint, mediumint, int, text, varchar, char, tinytext, mediumtext, largetext)
  64. * 'size' => Size of column (If applicable) - for example 255 for a large varchar, 10 for an int etc.
  65. * If not set SMF will pick a size.
  66. * - 'default' = Default value - do not set if no default required.
  67. * - 'null' => Can it be null (true or false) - if not set default will be false.
  68. * - 'auto' => Set to true to make it an auto incrementing column. Set to a numerical value to set from what
  69. * it should begin counting.
  70. * - Adds indexes as specified within indexes parameter. Each index should be a member of $indexes. Values are:
  71. * - 'name' => Index name (If left empty SMF will generate).
  72. * - 'type' => Type of index. Choose from 'primary', 'unique' or 'index'. If not set will default to 'index'.
  73. * - 'columns' => Array containing columns that form part of key - in the order the index is to be created.
  74. * - parameters: (None yet)
  75. * - if_exists values:
  76. * - 'ignore' will do nothing if the table exists. (And will return true)
  77. * - 'overwrite' will drop any existing table of the same name.
  78. * - 'error' will return false if the table already exists.
  79. *
  80. * @param string $table_name
  81. * @param array $columns in the format specified.
  82. * @param array $indexes default array(), in the format specified.
  83. * @param array $parameters default array()
  84. * @param string $if_exists default 'ignore'
  85. * @param string $error default 'fatal'
  86. */
  87. function smf_db_create_table($table_name, $columns, $indexes = array(), $parameters = array(), $if_exists = 'ignore', $error = 'fatal')
  88. {
  89. global $reservedTables, $smcFunc, $db_package_log, $db_prefix;
  90. // With or without the database name, the full name looks like this.
  91. $real_prefix = preg_match('~^(`?)(.+?)\\1\\.(.*?)$~', $db_prefix, $match) === 1 ? $match[3] : $db_prefix;
  92. $full_table_name = str_replace('{db_prefix}', $real_prefix, $table_name);
  93. $table_name = str_replace('{db_prefix}', $db_prefix, $table_name);
  94. // First - no way do we touch SMF tables.
  95. // Commented out for now. We need to alter SMF tables in order to use this in the upgrade.
  96. /*
  97. if (in_array(strtolower($table_name), $reservedTables))
  98. return false;
  99. */
  100. // Log that we'll want to remove this on uninstall.
  101. $db_package_log[] = array('remove_table', $table_name);
  102. // Does this table exist or not?
  103. $tables = $smcFunc['db_list_tables']();
  104. if (in_array($full_table_name, $tables))
  105. {
  106. // This is a sad day... drop the table? If not, return false (error) by default.
  107. if ($if_exists == 'overwrite')
  108. $smcFunc['db_drop_table']($table_name);
  109. else
  110. return $if_exists == 'ignore';
  111. }
  112. // Righty - let's do the damn thing!
  113. $table_query = 'CREATE TABLE ' . $table_name . "\n" . '(';
  114. $done_primary = false;
  115. foreach ($columns as $column)
  116. {
  117. // Auto increment is special
  118. if (!empty($column['auto']))
  119. {
  120. $table_query .= "\n" . $column['name'] . ' integer PRIMARY KEY,';
  121. $done_primary = true;
  122. continue;
  123. }
  124. elseif (isset($column['default']) && $column['default'] !== null)
  125. $default = 'default \'' . $smcFunc['db_escape_string']($column['default']) . '\'';
  126. else
  127. $default = '';
  128. // Sort out the size... and stuff...
  129. $column['size'] = isset($column['size']) && is_numeric($column['size']) ? $column['size'] : null;
  130. list ($type, $size) = $smcFunc['db_calculate_type']($column['type'], $column['size']);
  131. if ($size !== null)
  132. $type = $type . '(' . $size . ')';
  133. // Now just put it together!
  134. $table_query .= "\n\t" . $column['name'] . ' ' . $type . ' ' . (!empty($column['null']) ? '' : 'NOT NULL') . ' ' . $default . ',';
  135. }
  136. // Loop through the indexes next...
  137. $index_queries = array();
  138. foreach ($indexes as $index)
  139. {
  140. $columns = implode(',', $index['columns']);
  141. // Is it the primary?
  142. if (isset($index['type']) && $index['type'] == 'primary')
  143. {
  144. // If we've done the primary via auto_inc, don't do it again!
  145. if (!$done_primary)
  146. $table_query .= "\n\t" . 'PRIMARY KEY (' . implode(',', $index['columns']) . '),';
  147. }
  148. else
  149. {
  150. if (empty($index['name']))
  151. $index['name'] = implode('_', $index['columns']);
  152. $index_queries[] = 'CREATE ' . (isset($index['type']) && $index['type'] == 'unique' ? 'UNIQUE' : '') . ' INDEX ' . $table_name . '_' . $index['name'] . ' ON ' . $table_name . ' (' . $columns . ')';
  153. }
  154. }
  155. // No trailing commas!
  156. if (substr($table_query, -1) == ',')
  157. $table_query = substr($table_query, 0, -1);
  158. $table_query .= ')';
  159. if (empty($parameters['skip_transaction']))
  160. $smcFunc['db_transaction']('begin');
  161. // Do the table and indexes...
  162. $smcFunc['db_query']('', $table_query,
  163. array(
  164. 'security_override' => true,
  165. )
  166. );
  167. foreach ($index_queries as $query)
  168. $smcFunc['db_query']('', $query,
  169. array(
  170. 'security_override' => true,
  171. )
  172. );
  173. if (empty($parameters['skip_transaction']))
  174. $smcFunc['db_transaction']('commit');
  175. }
  176. /**
  177. * Drop a table.
  178. *
  179. * @param string $table_name
  180. * @param array $parameters default array()
  181. * @param bool $error
  182. * @param string $error default 'fatal'
  183. */
  184. function smf_db_drop_table($table_name, $parameters = array(), $error = 'fatal')
  185. {
  186. global $reservedTables, $smcFunc, $db_prefix;
  187. // Strip out the table name, we might not need it in some cases
  188. $real_prefix = preg_match('~^(`?)(.+?)\\1\\.(.*?)$~', $db_prefix, $match) === 1 ? $match[3] : $db_prefix;
  189. $full_table_name = str_replace('{db_prefix}', $real_prefix, $table_name);
  190. $table_name = str_replace('{db_prefix}', $db_prefix, $table_name);
  191. // God no - dropping one of these = bad.
  192. if (in_array(strtolower($table_name), $reservedTables))
  193. return false;
  194. // Does it exist?
  195. if (in_array($full_table_name, $smcFunc['db_list_tables']()))
  196. {
  197. $query = 'DROP TABLE ' . $table_name;
  198. $smcFunc['db_query']('', $query,
  199. array(
  200. 'security_override' => true,
  201. )
  202. );
  203. return true;
  204. }
  205. // Otherwise do 'nout.
  206. return false;
  207. }
  208. /**
  209. * This function adds a column.
  210. *
  211. * @param string $table_name the name of the table
  212. * @param array $column_info with column information
  213. * @param array $parameters default array()
  214. * @param string $if_exists default 'update'
  215. * @param string $error default 'fatal'
  216. */
  217. function smf_db_add_column($table_name, $column_info, $parameters = array(), $if_exists = 'update', $error = 'fatal')
  218. {
  219. global $smcFunc, $db_package_log, $txt, $db_prefix;
  220. $table_name = str_replace('{db_prefix}', $db_prefix, $table_name);
  221. // Log that we will want to uninstall this!
  222. $db_package_log[] = array('remove_column', $table_name, $column_info['name']);
  223. // Does it exist - if so don't add it again!
  224. $columns = $smcFunc['db_list_columns']($table_name, false);
  225. foreach ($columns as $column)
  226. if ($column == $column_info['name'])
  227. {
  228. // If we're going to overwrite then use change column.
  229. if ($if_exists == 'update')
  230. return $smcFunc['db_change_column']($table_name, $column_info['name'], $column_info);
  231. else
  232. return false;
  233. }
  234. // Alter the table to add the column.
  235. if ($smcFunc['db_alter_table']($table_name, array('add' => array($column_info))) === false)
  236. return false;
  237. return true;
  238. }
  239. /**
  240. * Removes a column.
  241. *
  242. * We can't reliably do this on SQLite - damn!
  243. * @param string $table_name
  244. * @param string $column_name
  245. * @param array $parameters default array()
  246. * @param string $error default 'fatal'
  247. */
  248. function smf_db_remove_column($table_name, $column_name, $parameters = array(), $error = 'fatal')
  249. {
  250. global $smcFunc, $db_prefix;
  251. $table_name = str_replace('{db_prefix}', $db_prefix, $table_name);
  252. if ($smcFunc['db_alter_table']($table_name, array('remove' => array(array('name' => $column_name)))))
  253. return true;
  254. else
  255. return false;
  256. }
  257. /**
  258. * Change a column.
  259. *
  260. * @param string $table_name
  261. * @param $old_column
  262. * @param $column_info
  263. * @param array $parameters default array()
  264. * @param string $error default 'fatal'
  265. */
  266. function smf_db_change_column($table_name, $old_column, $column_info, $parameters = array(), $error = 'fatal')
  267. {
  268. global $smcFunc, $db_prefix;
  269. $table_name = str_replace('{db_prefix}', $db_prefix, $table_name);
  270. if ($smcFunc['db_alter_table']($table_name, array('change' => array(array('name' => $old_column) + $column_info))))
  271. return true;
  272. else
  273. return false;
  274. }
  275. /**
  276. * Add an index.
  277. *
  278. * @param string $table_name
  279. * @param array $index_info
  280. * @param array $parameters default array()
  281. * @param string $if_exists default 'update'
  282. * @param string $error default 'fatal'
  283. */
  284. function smf_db_add_index($table_name, $index_info, $parameters = array(), $if_exists = 'update', $error = 'fatal')
  285. {
  286. global $smcFunc, $db_package_log, $db_prefix;
  287. $table_name = str_replace('{db_prefix}', $db_prefix, $table_name);
  288. // No columns = no index.
  289. if (empty($index_info['columns']))
  290. return false;
  291. $columns = implode(',', $index_info['columns']);
  292. // No name - make it up!
  293. if (empty($index_info['name']))
  294. {
  295. // No need for primary.
  296. if (isset($index_info['type']) && $index_info['type'] == 'primary')
  297. $index_info['name'] = '';
  298. else
  299. $index_info['name'] = implode('_', $index_info['columns']);
  300. }
  301. else
  302. $index_info['name'] = $index_info['name'];
  303. // Log that we are going to want to remove this!
  304. $db_package_log[] = array('remove_index', $table_name, $index_info['name']);
  305. // Let's get all our indexes.
  306. $indexes = $smcFunc['db_list_indexes']($table_name, true);
  307. // Do we already have it?
  308. foreach ($indexes as $index)
  309. {
  310. if ($index['name'] == $index_info['name'] || ($index['type'] == 'primary' && isset($index_info['type']) && $index_info['type'] == 'primary'))
  311. {
  312. // If we want to overwrite simply remove the current one then continue.
  313. if ($if_exists != 'update' || $index['type'] == 'primary')
  314. return false;
  315. else
  316. $smcFunc['db_remove_index']($table_name, $index_info['name']);
  317. }
  318. }
  319. // If we're here we know we don't have the index - so just add it.
  320. if (!empty($index_info['type']) && $index_info['type'] == 'primary')
  321. {
  322. // @todo Doesn't work with PRIMARY KEY yet.
  323. }
  324. else
  325. {
  326. $smcFunc['db_query']('', '
  327. CREATE ' . (isset($index_info['type']) && $index_info['type'] == 'unique' ? 'UNIQUE' : '') . ' INDEX ' . $index_info['name'] . ' ON ' . $table_name . ' (' . $columns . ')',
  328. array(
  329. 'security_override' => true,
  330. )
  331. );
  332. }
  333. }
  334. /**
  335. * Remove an index.
  336. *
  337. * @param string $table_name
  338. * @param string $index_name
  339. * @param array$parameters default array()
  340. * @param string $error default 'fatal'
  341. */
  342. function smf_db_remove_index($table_name, $index_name, $parameters = array(), $error = 'fatal')
  343. {
  344. global $smcFunc, $db_prefix;
  345. $table_name = str_replace('{db_prefix}', $db_prefix, $table_name);
  346. // Better exist!
  347. $indexes = $smcFunc['db_list_indexes']($table_name, true);
  348. foreach ($indexes as $index)
  349. {
  350. // @todo Doesn't do primary key at the moment!
  351. if ($index['type'] != 'primary' && $index['name'] == $index_name)
  352. {
  353. // Drop the bugger...
  354. $smcFunc['db_query']('', '
  355. DROP INDEX ' . $index_name,
  356. array(
  357. 'security_override' => true,
  358. )
  359. );
  360. return true;
  361. }
  362. }
  363. // Not to be found ;(
  364. return false;
  365. }
  366. /**
  367. * Get the schema formatted name for a type.
  368. *
  369. * @param string $type_name
  370. * @param $type_size
  371. * @param $reverse
  372. */
  373. function smf_db_calculate_type($type_name, $type_size = null, $reverse = false)
  374. {
  375. // Let's be sure it's lowercase MySQL likes both, others no.
  376. $type_name = strtolower($type_name);
  377. // Generic => Specific.
  378. if (!$reverse)
  379. {
  380. $types = array(
  381. 'mediumint' => 'int',
  382. 'tinyint' => 'smallint',
  383. 'mediumtext' => 'text',
  384. 'largetext' => 'text',
  385. );
  386. }
  387. else
  388. {
  389. $types = array(
  390. 'integer' => 'int',
  391. );
  392. }
  393. // Got it? Change it!
  394. if (isset($types[$type_name]))
  395. {
  396. if ($type_name == 'tinytext')
  397. $type_size = 255;
  398. $type_name = $types[$type_name];
  399. }
  400. // Numbers don't have a size.
  401. if (strpos($type_name, 'int') !== false)
  402. $type_size = null;
  403. return array($type_name, $type_size);
  404. }
  405. /**
  406. * Get table structure.
  407. *
  408. * @param string $table_name
  409. * @param array $parameters default array()
  410. */
  411. function smf_db_table_structure($table_name, $parameters = array())
  412. {
  413. global $smcFunc, $db_prefix;
  414. $table_name = str_replace('{db_prefix}', $db_prefix, $table_name);
  415. return array(
  416. 'name' => $table_name,
  417. 'columns' => $smcFunc['db_list_columns']($table_name, true),
  418. 'indexes' => $smcFunc['db_list_indexes']($table_name, true),
  419. );
  420. }
  421. /**
  422. * Return column information for a table.
  423. * Harder than it should be, on sqlite!
  424. *
  425. * @param string $table_name
  426. * @param bool $detail
  427. * @param array $parameters default array()
  428. * @return mixed
  429. */
  430. function smf_db_list_columns($table_name, $detail = false, $parameters = array())
  431. {
  432. global $smcFunc, $db_prefix;
  433. $table_name = str_replace('{db_prefix}', $db_prefix, $table_name);
  434. $result = $smcFunc['db_query']('', '
  435. PRAGMA table_info(' . $table_name . ')',
  436. array(
  437. 'security_override' => true,
  438. )
  439. );
  440. $columns = array();
  441. $primaries = array();
  442. while ($row = $smcFunc['db_fetch_assoc']($result))
  443. {
  444. if (!$detail)
  445. {
  446. $columns[] = $row['name'];
  447. }
  448. else
  449. {
  450. // Auto increment is hard to tell really... if there's only one primary it probably is.
  451. if ($row['pk'])
  452. $primaries[] = $row['name'];
  453. // Can we split out the size?
  454. if (preg_match('~(.+?)\s*\((\d+)\)~i', $row['type'], $matches))
  455. {
  456. $type = $matches[1];
  457. $size = $matches[2];
  458. }
  459. else
  460. {
  461. $type = $row['type'];
  462. $size = null;
  463. }
  464. $columns[$row['name']] = array(
  465. 'name' => $row['name'],
  466. 'null' => $row['notnull'] ? false : true,
  467. 'default' => $row['dflt_value'],
  468. 'type' => $type,
  469. 'size' => $size,
  470. 'auto' => false,
  471. );
  472. }
  473. }
  474. $smcFunc['db_free_result']($result);
  475. // Put in our guess at auto_inc.
  476. if (count($primaries) == 1)
  477. $columns[$primaries[0]]['auto'] = true;
  478. return $columns;
  479. }
  480. /**
  481. * Get index information.
  482. *
  483. * @param string $table_name
  484. * @param bool $detail
  485. * @param array $parameters
  486. * @return mixed
  487. */
  488. function smf_db_list_indexes($table_name, $detail = false, $parameters = array())
  489. {
  490. global $smcFunc, $db_prefix;
  491. $table_name = str_replace('{db_prefix}', $db_prefix, $table_name);
  492. $result = $smcFunc['db_query']('', '
  493. PRAGMA index_list(' . $table_name . ')',
  494. array(
  495. 'security_override' => true,
  496. )
  497. );
  498. $indexes = array();
  499. while ($row = $smcFunc['db_fetch_assoc']($result))
  500. {
  501. if (!$detail)
  502. $indexes[] = $row['name'];
  503. else
  504. {
  505. $result2 = $smcFunc['db_query']('', '
  506. PRAGMA index_info(' . $row['name'] . ')',
  507. array(
  508. 'security_override' => true,
  509. )
  510. );
  511. while ($row2 = $smcFunc['db_fetch_assoc']($result2))
  512. {
  513. // What is the type?
  514. if ($row['unique'])
  515. $type = 'unique';
  516. else
  517. $type = 'index';
  518. // This is the first column we've seen?
  519. if (empty($indexes[$row['name']]))
  520. {
  521. $indexes[$row['name']] = array(
  522. 'name' => $row['name'],
  523. 'type' => $type,
  524. 'columns' => array(),
  525. );
  526. }
  527. // Add the column...
  528. $indexes[$row['name']]['columns'][] = $row2['name'];
  529. }
  530. $smcFunc['db_free_result']($result2);
  531. }
  532. }
  533. $smcFunc['db_free_result']($result);
  534. return $indexes;
  535. }
  536. /**
  537. * Alter table on SQLite.
  538. *
  539. * @param string $table_name
  540. * @param array $columns
  541. */
  542. function smf_db_alter_table($table_name, $columns)
  543. {
  544. global $smcFunc, $db_prefix, $db_name, $boarddir;
  545. $db_file = substr($db_name, -3) === '.db' ? $db_name : $db_name . '.db';
  546. $table_name = str_replace('{db_prefix}', $db_prefix, $table_name);
  547. // Let's get the current columns for the table.
  548. $current_columns = $smcFunc['db_list_columns']($table_name, true);
  549. // Let's get a list of columns for the temp table.
  550. $temp_table_columns = array();
  551. // Let's see if we have columns to remove or columns that are being added that already exist.
  552. foreach ($current_columns as $key => $column)
  553. {
  554. $exists = false;
  555. if (isset($columns['remove']))
  556. foreach ($columns['remove'] as $drop)
  557. if ($drop['name'] == $column['name'])
  558. {
  559. $exists = true;
  560. break;
  561. }
  562. if (isset($columns['add']))
  563. foreach ($columns['add'] as $key2 => $add)
  564. if ($add['name'] == $column['name'])
  565. {
  566. unset($columns['add'][$key2]);
  567. break;
  568. }
  569. // Doesn't exist then we 'remove'.
  570. if (!$exists)
  571. $temp_table_columns[] = $column['name'];
  572. }
  573. // If they are equal then that means that the column that we are adding exists or it doesn't exist and we are not looking to change any one of them.
  574. if (count($temp_table_columns) == count($current_columns) && empty($columns['change']) && empty($columns['add']))
  575. return true;
  576. // Drop the temp table.
  577. $smcFunc['db_query']('', '
  578. DROP TABLE {raw:temp_table_name}',
  579. array(
  580. 'temp_table_name' => $table_name . '_tmp',
  581. 'db_error_skip' => true,
  582. )
  583. );
  584. // Let's make a backup of the current database.
  585. // We only want the first backup of a table modification. So if there is a backup file and older than an hour just delete and back up again
  586. $db_backup_file = $boarddir . '/Packages/backups/backup_' . $table_name . '_' . basename($db_file) . md5($table_name . $db_file);
  587. if (file_exists($db_backup_file) && time() - filemtime($db_backup_file) > 3600)
  588. {
  589. @unlink($db_backup_file);
  590. @copy($db_file, $db_backup_file);
  591. }
  592. elseif (!file_exists($db_backup_file))
  593. @copy($db_file, $db_backup_file);
  594. // If we don't have temp tables then everything crapped out. Just exit.
  595. if (empty($temp_table_columns))
  596. return false;
  597. // Start
  598. $smcFunc['db_transaction']('begin');
  599. // Let's create the temporary table.
  600. $createTempTable = $smcFunc['db_query']('', '
  601. CREATE TEMPORARY TABLE {raw:temp_table_name}
  602. (
  603. {raw:columns}
  604. );',
  605. array(
  606. 'temp_table_name' => $table_name . '_tmp',
  607. 'columns' => implode(', ', $temp_table_columns),
  608. 'db_error_skip' => true,
  609. )
  610. ) !== false;
  611. if (!$createTempTable)
  612. return false;
  613. // Insert into temp table.
  614. $smcFunc['db_query']('', '
  615. INSERT INTO {raw:temp_table_name}
  616. ({raw:columns})
  617. SELECT {raw:columns}
  618. FROM {raw:table_name}',
  619. array(
  620. 'table_name' => $table_name,
  621. 'columns' => implode(', ', $temp_table_columns),
  622. 'temp_table_name' => $table_name . '_tmp',
  623. )
  624. );
  625. // Drop the current table.
  626. $dropTable = $smcFunc['db_query']('', '
  627. DROP TABLE {raw:table_name}',
  628. array(
  629. 'table_name' => $table_name,
  630. 'db_error_skip' => true,
  631. )
  632. ) !== false;
  633. // If you can't drop the main table then there is no where to go from here. Just return.
  634. if (!$dropTable)
  635. return false;
  636. // We need to keep track of the structure for the current columns and the new columns.
  637. $new_columns = array();
  638. $column_names = array();
  639. // Let's get the ones that we already have first.
  640. foreach ($current_columns as $name => $column)
  641. {
  642. if (in_array($name, $temp_table_columns))
  643. {
  644. $new_columns[$name] = array(
  645. 'name' => $name,
  646. 'type' => $column['type'],
  647. 'size' => isset($column['size']) ? (int) $column['size'] : null,
  648. 'null' => !empty($column['null']),
  649. 'auto' => isset($column['auto']) ? $column['auto'] : false,
  650. 'default' => isset($column['default']) ? $column['default'] : '',
  651. );
  652. // Lets keep track of the name for the column.
  653. $column_names[$name] = $name;
  654. }
  655. }
  656. // Now the new.
  657. if (!empty($columns['add']))
  658. foreach ($columns['add'] as $add)
  659. {
  660. $new_columns[$add['name']] = array(
  661. 'name' => $add['name'],
  662. 'type' => $add['type'],
  663. 'size' => isset($add['size']) ? (int) $add['size'] : null,
  664. 'null' => !empty($add['null']),
  665. 'auto' => isset($add['auto']) ? $add['auto'] : false,
  666. 'default' => isset($add['default']) ? $add['default'] : '',
  667. );
  668. // Let's keep track of the name for the column.
  669. $column_names[$add['name']] = strstr('int', $add['type']) ? ' 0 AS ' . $add['name'] : ' {string:empty_string} AS ' . $add['name'];
  670. }
  671. // Now to change a column. Not drop but change it.
  672. if (isset($columns['change']))
  673. foreach ($columns['change'] as $change)
  674. if (isset($new_columns[$change['name']]))
  675. $new_columns[$change['name']] = array(
  676. 'name' => $change['name'],
  677. 'type' => $change['type'],
  678. 'size' => isset($change['size']) ? (int) $change['size'] : null,
  679. 'null' => !empty($change['null']),
  680. 'auto' => isset($change['auto']) ? $change['auto'] : false,
  681. 'default' => isset($change['default']) ? $change['default'] : '',
  682. );
  683. // Now let's create the table.
  684. $createTable = $smcFunc['db_create_table']($table_name, $new_columns, array(), array('skip_transaction' => true));
  685. // Did it create correctly?
  686. if ($createTable === false)
  687. return false;
  688. // Back to it's original table.
  689. $insertData = $smcFunc['db_query']('', '
  690. INSERT INTO {raw:table_name}
  691. ({raw:columns})
  692. SELECT ' . implode(', ', $column_names) . '
  693. FROM {raw:temp_table_name}',
  694. array(
  695. 'table_name' => $table_name,
  696. 'columns' => implode(', ', array_keys($new_columns)),
  697. 'columns_select' => implode(', ', $column_names),
  698. 'temp_table_name' => $table_name . '_tmp',
  699. 'empty_string' => '',
  700. )
  701. );
  702. // Did everything insert correctly?
  703. if (!$insertData)
  704. return false;
  705. // Drop the temp table.
  706. $smcFunc['db_query']('', '
  707. DROP TABLE {raw:temp_table_name}',
  708. array(
  709. 'temp_table_name' => $table_name . '_tmp',
  710. 'db_error_skip' => true,
  711. )
  712. );
  713. // Commit or else there is no point in doing the previous steps.
  714. $smcFunc['db_transaction']('commit');
  715. // We got here so we're good. The temp table should be deleted, if not it will be gone later on >:D.
  716. return true;
  717. }
  718. ?>