?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
replace constants with class constants.
[phpbb.git] / phpBB / includes / functions_install.php
blob2c81b73e7f0e8f28ba68a082f77886eeb4449b8a
1 <?php
2 /**
3 *
4 * @package install
5 * @version $Id$
6 * @copyright (c) 2006 phpBB Group
7 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
8 *
9 */
10
11 /**
12 * @ignore
13 */
14 if (!defined('IN_PHPBB'))
15 {
16 exit;
17 }
18
19 /**
20 * Determine if we are able to load a specified PHP module and do so if possible
21 */
22 function can_load_dll($dll)
23 {
24 return ((@ini_get('enable_dl') || strtolower(@ini_get('enable_dl')) == 'on') && (!@ini_get('safe_mode') || strtolower(@ini_get('safe_mode')) == 'off') && @dl($dll . '.' . PHP_SHLIB_SUFFIX)) ? true : false;
25 }
26
27 /**
28 * Returns an array of available DBMS with some data, if a DBMS is specified it will only
29 * return data for that DBMS and will load its extension if necessary.
30 */
31 function get_available_dbms($dbms = false, $return_unavailable = false, $only_20x_options = false)
32 {
33 global $lang;
34 $available_dbms = array(
35 'firebird' => array(
36 'LABEL' => 'FireBird',
37 'SCHEMA' => 'firebird',
38 'MODULE' => 'interbase',
39 'DELIM' => ';;',
40 'COMMENTS' => 'remove_remarks',
41 'DRIVER' => 'firebird',
42 'AVAILABLE' => true,
43 '2.0.x' => false,
44 ),
45 'mysqli' => array(
46 'LABEL' => 'MySQL with MySQLi Extension',
47 'SCHEMA' => 'mysql',
48 'MODULE' => 'mysqli',
49 'DELIM' => ';',
50 'COMMENTS' => 'remove_remarks',
51 'DRIVER' => 'mysqli',
52 'AVAILABLE' => true,
53 '2.0.x' => true,
54 ),
55 'mysql' => array(
56 'LABEL' => 'MySQL',
57 'SCHEMA' => 'mysql',
58 'MODULE' => 'mysql',
59 'DELIM' => ';',
60 'COMMENTS' => 'remove_remarks',
61 'DRIVER' => 'mysql',
62 'AVAILABLE' => true,
63 '2.0.x' => true,
64 ),
65 'mssql' => array(
66 'LABEL' => 'MS SQL Server 2000+',
67 'SCHEMA' => 'mssql',
68 'MODULE' => 'mssql',
69 'DELIM' => 'GO',
70 'COMMENTS' => 'remove_comments',
71 'DRIVER' => 'mssql',
72 'AVAILABLE' => true,
73 '2.0.x' => true,
74 ),
75 'mssql_odbc'=> array(
76 'LABEL' => 'MS SQL Server [ ODBC ]',
77 'SCHEMA' => 'mssql',
78 'MODULE' => 'odbc',
79 'DELIM' => 'GO',
80 'COMMENTS' => 'remove_comments',
81 'DRIVER' => 'mssql_odbc',
82 'AVAILABLE' => true,
83 '2.0.x' => true,
84 ),
85 'mssql_2005'=> array(
86 'LABEL' => 'MS SQL Server [ 2005 ]',
87 'SCHEMA' => 'mssql',
88 'MODULE' => 'sqlsrv',
89 'DELIM' => 'GO',
90 'COMMENTS' => 'remove_comments',
91 'DRIVER' => 'mssql_2005',
92 'AVAILABLE' => true,
93 '2.0.x' => true,
94 ),
95 'db2' => array(
96 'LABEL' => 'IBM DB2',
97 'SCHEMA' => 'db2',
98 'MODULE' => 'ibm_db2',
99 'DELIM' => ';',
100 'COMMENTS' => 'remove_comments',
101 'DRIVER' => 'db2',
102 'AVAILABLE' => true,
103 '2.0.x' => false,
104 ),
105 'oracle' => array(
106 'LABEL' => 'Oracle',
107 'SCHEMA' => 'oracle',
108 'MODULE' => 'oci8',
109 'DELIM' => '/',
110 'COMMENTS' => 'remove_comments',
111 'DRIVER' => 'oracle',
112 'AVAILABLE' => true,
113 '2.0.x' => false,
114 ),
115 'postgres' => array(
116 'LABEL' => 'PostgreSQL 7.x/8.x',
117 'SCHEMA' => 'postgres',
118 'MODULE' => 'pgsql',
119 'DELIM' => ';',
120 'COMMENTS' => 'remove_comments',
121 'DRIVER' => 'postgres',
122 'AVAILABLE' => true,
123 '2.0.x' => true,
124 ),
125 'sqlite' => array(
126 'LABEL' => 'SQLite',
127 'SCHEMA' => 'sqlite',
128 'MODULE' => 'sqlite',
129 'DELIM' => ';',
130 'COMMENTS' => 'remove_remarks',
131 'DRIVER' => 'sqlite',
132 'AVAILABLE' => true,
133 '2.0.x' => false,
134 ),
135 );
136
137 if ($dbms)
138 {
139 if (isset($available_dbms[$dbms]))
140 {
141 $available_dbms = array($dbms => $available_dbms[$dbms]);
142 }
143 else
144 {
145 return array();
146 }
147 }
148
149 // now perform some checks whether they are really available
150 foreach ($available_dbms as $db_name => $db_ary)
151 {
152 if ($only_20x_options && !$db_ary['2.0.x'])
153 {
154 if ($return_unavailable)
155 {
156 $available_dbms[$db_name]['AVAILABLE'] = false;
157 }
158 else
159 {
160 unset($available_dbms[$db_name]);
161 }
162 continue;
163 }
164
165 $dll = $db_ary['MODULE'];
166
167 if (!@extension_loaded($dll))
168 {
169 if (!can_load_dll($dll))
170 {
171 if ($return_unavailable)
172 {
173 $available_dbms[$db_name]['AVAILABLE'] = false;
174 }
175 else
176 {
177 unset($available_dbms[$db_name]);
178 }
179 continue;
180 }
181 }
182 $any_db_support = true;
183 }
184
185 if ($return_unavailable)
186 {
187 $available_dbms['ANY_DB_SUPPORT'] = $any_db_support;
188 }
189 return $available_dbms;
190 }
191
192 /**
193 * Generate the drop down of available database options
194 */
195 function dbms_select($default = '', $only_20x_options = false)
196 {
197 global $lang;
198
199 $available_dbms = get_available_dbms(false, false, $only_20x_options);
200 $dbms_options = '';
201 foreach ($available_dbms as $dbms_name => $details)
202 {
203 $selected = ($dbms_name == $default) ? ' selected="selected"' : '';
204 $dbms_options .= '<option value="' . $dbms_name . '"' . $selected .'>' . $lang['DLL_' . strtoupper($dbms_name)] . '</option>';
205 }
206 return $dbms_options;
207 }
208
209 /**
210 * Get tables of a database
211 */
212 function get_tables($db)
213 {
214 switch ($db->dbms_type)
215 {
216 case 'mysql':
217 $sql = 'SHOW TABLES';
218 break;
219
220 case 'sqlite':
221 $sql = 'SELECT name
222 FROM sqlite_master
223 WHERE type = "table"';
224 break;
225
226 case 'mssql':
227 $sql = "SELECT name
228 FROM sysobjects
229 WHERE type='U'";
230 break;
231
232 case 'postgres':
233 $sql = 'SELECT relname
234 FROM pg_stat_user_tables';
235 break;
236
237 case 'firebird':
238 $sql = 'SELECT rdb$relation_name
239 FROM rdb$relations
240 WHERE rdb$view_source is null
241 AND rdb$system_flag = 0';
242 break;
243
244 case 'db2':
245 $sql = "SELECT tabname
246 FROM SYSCAT.TABLES
247 WHERE type = 'T'
248 AND tabschema = 'DB2ADMIN'";
249 $field = 'tabname';
250 break;
251
252 case 'oracle':
253 $sql = 'SELECT table_name
254 FROM USER_TABLES';
255 break;
256 }
257
258 $result = $db->sql_query($sql);
259
260 $tables = array();
261
262 while ($row = $db->sql_fetchrow($result))
263 {
264 $tables[] = current($row);
265 }
266
267 $db->sql_freeresult($result);
268
269 return $tables;
270 }
271
272 /**
273 * Used to test whether we are able to connect to the database the user has specified
274 * and identify any problems (eg there are already tables with the names we want to use
275 * @param array $dbms should be of the format of an element of the array returned by {@link get_available_dbms get_available_dbms()}
276 * necessary extensions should be loaded already
277 */
278 function connect_check_db($error_connect, &$error, $dbms_details, $table_prefix, $dbhost, $dbuser, $dbpasswd, $dbname, $dbport, $prefix_may_exist = false, $load_dbal = true, $unicode_check = true)
279 {
280 global $config, $lang;
281
282 $dbms = $dbms_details['DRIVER'];
283
284 if ($load_dbal)
285 {
286 // Include the DB layer
287 include(PHPBB_ROOT_PATH . 'includes/db/' . $dbms . '.' . PHP_EXT);
288 }
289
290 // Instantiate it and set return on error true
291 $sql_db = 'dbal_' . $dbms;
292 $db = new $sql_db();
293 $db->sql_return_on_error(true);
294
295 // Check that we actually have a database name before going any further.....
296 if ($dbms_details['DRIVER'] != 'sqlite' && $dbms_details['DRIVER'] != 'oracle' && $dbname === '')
297 {
298 $error[] = $lang['INST_ERR_DB_NO_NAME'];
299 return false;
300 }
301
302 // Make sure we don't have a daft user who thinks having the SQLite database in the forum directory is a good idea
303 if ($dbms_details['DRIVER'] == 'sqlite' && stripos(phpbb_realpath($dbhost), phpbb_realpath('../')) === 0)
304 {
305 $error[] = $lang['INST_ERR_DB_FORUM_PATH'];
306 return false;
307 }
308
309 // Check the prefix length to ensure that index names are not too long and does not contain invalid characters
310 switch ($dbms_details['DRIVER'])
311 {
312 case 'mysql':
313 case 'mysqli':
314 if (strspn($table_prefix, '-./\\') !== 0)
315 {
316 $error[] = $lang['INST_ERR_PREFIX_INVALID'];
317 return false;
318 }
319
320 // no break;
321
322 case 'postgres':
323 $prefix_length = 36;
324 break;
325
326 case 'mssql':
327 case 'mssql_odbc':
328 case 'mssql_2005':
329 $prefix_length = 90;
330 break;
331
332 case 'db2':
333 $prefix_length = 108;
334 break;
335
336 case 'sqlite':
337 $prefix_length = 200;
338 break;
339
340 case 'firebird':
341 case 'oracle':
342 $prefix_length = 6;
343 break;
344 }
345
346 if (strlen($table_prefix) > $prefix_length)
347 {
348 $error[] = sprintf($lang['INST_ERR_PREFIX_TOO_LONG'], $prefix_length);
349 return false;
350 }
351
352 // Try and connect ...
353 if (is_array($db->sql_connect($dbhost, $dbuser, $dbpasswd, $dbname, $dbport, false, true)))
354 {
355 $db_error = $db->sql_error();
356 $error[] = $lang['INST_ERR_DB_CONNECT'] . '<br />' . (($db_error['message']) ? $db_error['message'] : $lang['INST_ERR_DB_NO_ERROR']);
357 }
358 else
359 {
360 // Likely matches for an existing phpBB installation
361 if (!$prefix_may_exist)
362 {
363 $temp_prefix = strtolower($table_prefix);
364 $table_ary = array($temp_prefix . 'attachments', $temp_prefix . 'config', $temp_prefix . 'sessions', $temp_prefix . 'topics', $temp_prefix . 'users');
365
366 $tables = get_tables($db);
367 $tables = array_map('strtolower', $tables);
368 $table_intersect = array_intersect($tables, $table_ary);
369
370 if (sizeof($table_intersect))
371 {
372 $error[] = $lang['INST_ERR_PREFIX'];
373 }
374 }
375
376 // Make sure that the user has selected a sensible DBAL for the DBMS actually installed
377 switch ($dbms_details['DRIVER'])
378 {
379 case 'mysql':
380 if (version_compare(mysql_get_server_info($db->db_connect_id), '4.1.3', '<'))
381 {
382 $error[] = $lang['INST_ERR_DB_NO_MYSQL'];
383 }
384 break;
385
386 case 'mysqli':
387 if (version_compare(mysqli_get_server_info($db->db_connect_id), '4.1.3', '<'))
388 {
389 $error[] = $lang['INST_ERR_DB_NO_MYSQLI'];
390 }
391 break;
392
393 case 'sqlite':
394 if (version_compare(sqlite_libversion(), '2.8.2', '<'))
395 {
396 $error[] = $lang['INST_ERR_DB_NO_SQLITE'];
397 }
398 break;
399
400 case 'firebird':
401 // check the version of FB, use some hackery if we can't get access to the server info
402 if ($db->service_handle !== false && strtolower($dbuser) == 'sysdba')
403 {
404 $val = @ibase_server_info($db->service_handle, IBASE_SVC_SERVER_VERSION);
405 preg_match('#V([\d.]+)#', $val, $match);
406 if ($match[1] < 2)
407 {
408 $error[] = $lang['INST_ERR_DB_NO_FIREBIRD'];
409 }
410 $db_info = @ibase_db_info($db->service_handle, $dbname, IBASE_STS_HDR_PAGES);
411
412 preg_match('/^\\s*Page size\\s*(\\d+)/m', $db_info, $regs);
413 $page_size = intval($regs[1]);
414 if ($page_size < 8192)
415 {
416 $error[] = $lang['INST_ERR_DB_NO_FIREBIRD_PS'];
417 }
418 }
419 else
420 {
421 $sql = "SELECT *
422 FROM RDB$FUNCTIONS
423 WHERE RDB$SYSTEM_FLAG IS NULL
424 AND RDB$FUNCTION_NAME = 'CHAR_LENGTH'";
425 $result = $db->sql_query($sql);
426 $row = $db->sql_fetchrow($result);
427 $db->sql_freeresult($result);
428
429 // if its a UDF, its too old
430 if ($row)
431 {
432 $error[] = $lang['INST_ERR_DB_NO_FIREBIRD'];
433 }
434 else
435 {
436 $sql = "SELECT FIRST 0 char_length('')
437 FROM RDB\$DATABASE";
438 $result = $db->sql_query($sql);
439 if (!$result) // This can only fail if char_length is not defined
440 {
441 $error[] = $lang['INST_ERR_DB_NO_FIREBIRD'];
442 }
443 $db->sql_freeresult($result);
444 }
445
446 // Setup the stuff for our random table
447 $char_array = array_merge(range('A', 'Z'), range('0', '9'));
448 $char_len = mt_rand(7, 9);
449 $char_array_len = sizeof($char_array) - 1;
450
451 $final = '';
452
453 for ($i = 0; $i < $char_len; $i++)
454 {
455 $final .= $char_array[mt_rand(0, $char_array_len)];
456 }
457
458 // Create some random table
459 $sql = 'CREATE TABLE ' . $final . " (
460 FIELD1 VARCHAR(255) CHARACTER SET UTF8 DEFAULT '' NOT NULL COLLATE UNICODE,
461 FIELD2 INTEGER DEFAULT 0 NOT NULL);";
462 $db->sql_query($sql);
463
464 // Create an index that should fail if the page size is less than 8192
465 $sql = 'CREATE INDEX ' . $final . ' ON ' . $final . '(FIELD1, FIELD2);';
466 $db->sql_query($sql);
467
468 if (ibase_errmsg() !== false)
469 {
470 $error[] = $lang['INST_ERR_DB_NO_FIREBIRD_PS'];
471 }
472
473 // Kill the old table
474 $db->sql_query('DROP TABLE ' . $final . ';');
475
476 unset($final);
477 }
478 break;
479
480 case 'oracle':
481 if ($unicode_check)
482 {
483 $sql = "SELECT *
484 FROM NLS_DATABASE_PARAMETERS
485 WHERE PARAMETER = 'NLS_RDBMS_VERSION'
486 OR PARAMETER = 'NLS_CHARACTERSET'";
487 $result = $db->sql_query($sql);
488
489 while ($row = $db->sql_fetchrow($result))
490 {
491 $stats[$row['parameter']] = $row['value'];
492 }
493 $db->sql_freeresult($result);
494
495 if (version_compare($stats['NLS_RDBMS_VERSION'], '9.2', '<'))
496 {
497 $error[] = $lang['INST_ERR_DB_NO_ORACLE'];
498 }
499
500 if ($stats['NLS_CHARACTERSET'] !== 'AL32UTF8')
501 {
502 $error[] = $lang['INST_ERR_DB_NO_ORACLE_NLS'];
503 }
504 }
505 break;
506
507 case 'postgres':
508 if ($unicode_check)
509 {
510 $sql = "SHOW server_encoding;";
511 $result = $db->sql_query($sql);
512 $row = $db->sql_fetchrow($result);
513 $db->sql_freeresult($result);
514
515 if ($row['server_encoding'] !== 'UNICODE' && $row['server_encoding'] !== 'UTF8')
516 {
517 $error[] = $lang['INST_ERR_DB_NO_POSTGRES'];
518 }
519 }
520 break;
521 }
522
523 }
524
525 if ($error_connect && (!isset($error) || !sizeof($error)))
526 {
527 return true;
528 }
529 return false;
530 }
531
532 /**
533 * remove_remarks will strip the sql comment lines out of an uploaded sql file
534 */
535 function remove_remarks(&$sql)
536 {
537 $sql = preg_replace('/\n{2,}/', "\n", preg_replace('/^#.*$/m', "\n", $sql));
538 }
539
540 /**
541 * split_sql_file will split an uploaded sql file into single sql statements.
542 * Note: expects trim() to have already been run on $sql.
543 */
544 function split_sql_file($sql, $delimiter)
545 {
546 $sql = str_replace("\r" , '', $sql);
547 $data = preg_split('/' . preg_quote($delimiter, '/') . '$/m', $sql);
548
549 $data = array_map('trim', $data);
550
551 // The empty case
552 $end_data = end($data);
553
554 if (empty($end_data))
555 {
556 unset($data[key($data)]);
557 }
558
559 return $data;
560 }
561
562 /**
563 * For replacing {L_*} strings with preg_replace_callback
564 */
565 function adjust_language_keys_callback($matches)
566 {
567 if (!empty($matches[1]))
568 {
569 global $lang, $db;
570
571 return (!empty($lang[$matches[1]])) ? $db->sql_escape($lang[$matches[1]]) : $db->sql_escape($matches[1]);
572 }
573 }
574
575 ?>
phpbb is a php-based BBS (buletin board system)