/
database_api.php
1342 lines (1192 loc) · 42.7 KB
/
database_api.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
# MantisBT - A PHP based bugtracking system
# MantisBT is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# MantisBT is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with MantisBT. If not, see <http://www.gnu.org/licenses/>.
/**
* Database API
*
* @package CoreAPI
* @subpackage DatabaseAPI
* @copyright Copyright 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
* @copyright Copyright 2002 MantisBT Team - mantisbt-dev@lists.sourceforge.net
* @link http://www.mantisbt.org
*
* @uses config_api.php
* @uses constant_inc.php
* @uses error_api.php
* @uses logging_api.php
* @uses utility_api.php
* @uses adodb/adodb.inc.php
*/
require_api( 'config_api.php' );
require_api( 'constant_inc.php' );
require_api( 'error_api.php' );
require_api( 'logging_api.php' );
require_api( 'utility_api.php' );
# An array in which all executed queries are stored. This is used for profiling
# @global array $g_queries_array
$g_queries_array = array();
# Stores whether a database connection was successfully opened.
# @global bool $g_db_connected
$g_db_connected = false;
# Store whether to log queries ( used for show_queries_count/query list)
# @global bool $g_db_log_queries
$g_db_log_queries = ( 0 != ( config_get_global( 'log_level' ) & LOG_DATABASE ) );
# set adodb to associative fetch mode with lowercase column names
# @global bool $ADODB_FETCH_MODE
global $ADODB_FETCH_MODE;
$ADODB_FETCH_MODE = ADODB_FETCH_ASSOC;
define( 'ADODB_ASSOC_CASE', ADODB_ASSOC_CASE_LOWER );
# Stores the functional database type based on db driver
$g_db_functional_type = db_get_type( config_get_global( 'db_type' ) );
/**
* Mantis Database Parameters Count class
* Stores the current parameter count, provides method to generate parameters
* and a simple stack mechanism to enable the caller to build multiple queries
* concurrently on RDBMS using positional parameters (e.g. PostgreSQL)
*/
class MantisDbParam {
/**
* Current parameter count
*/
public $count = 0;
/**
* Parameter count stack
*/
private $stack = array();
/**
* Generate a string to insert a parameter into a database query string
* @return string 'wildcard' matching a parameter in correct ordered format for the current database.
*/
public function assign() {
global $g_db;
return $g_db->Param( $this->count++ );
}
/**
* Pushes current parameter count onto stack and resets its value to 0
* @return void
*/
public function push() {
$this->stack[] = $this->count;
$this->count = 0;
}
/**
* Pops the previous value of param count from the stack
* This function is called by {@see db_query()} and should not need
* to be executed directly
* @return void
*/
public function pop() {
global $g_db;
$this->count = (int)array_pop( $this->stack );
if( db_is_pgsql() ) {
# Manually reset the ADOdb param number to the value we just popped
$g_db->_pnum = $this->count;
}
}
}
# Tracks the query parameter count
# @global object $g_db_param
$g_db_param = new MantisDbParam();
/**
* Open a connection to the database.
* @param string $p_dsn Database connection string ( specified instead of other params).
* @param string $p_hostname Database server hostname.
* @param string $p_username Database server username.
* @param string $p_password Database server password.
* @param string $p_database_name Database name.
* @param boolean $p_pconnect Use a Persistent connection to database.
* @return boolean indicating if the connection was successful
*/
function db_connect( $p_dsn, $p_hostname = null, $p_username = null, $p_password = null, $p_database_name = null, $p_pconnect = false ) {
global $g_db_connected, $g_db, $g_db_functional_type;
$t_db_type = config_get_global( 'db_type' );
$g_db_functional_type = db_get_type( $t_db_type );
if( $g_db_functional_type == DB_TYPE_UNDEFINED ) {
error_parameters( 0, 'Database type is not supported by MantisBT, check $g_db_type in config_inc.php' );
trigger_error( ERROR_DB_CONNECT_FAILED, ERROR );
}
if( !db_check_database_support( $t_db_type ) ) {
error_parameters( 0, 'PHP Support for database is not enabled' );
trigger_error( ERROR_DB_CONNECT_FAILED, ERROR );
}
if( empty( $p_dsn ) ) {
$g_db = ADONewConnection( $t_db_type );
if( $p_pconnect ) {
$t_result = $g_db->PConnect( $p_hostname, $p_username, $p_password, $p_database_name );
} else {
$t_result = $g_db->Connect( $p_hostname, $p_username, $p_password, $p_database_name );
}
} else {
$g_db = ADONewConnection( $p_dsn );
$t_result = $g_db->IsConnected();
}
if( $t_result ) {
# For MySQL, the charset for the connection needs to be specified.
if( db_is_mysql() ) {
# @todo Is there a way to translate any charset name to MySQL format? e.g. remote the dashes?
# @todo Is this needed for other databases?
db_query( 'SET NAMES UTF8' );
}
} else {
db_error();
trigger_error( ERROR_DB_CONNECT_FAILED, ERROR );
return false;
}
$g_db_connected = true;
return true;
}
/**
* Returns whether a connection to the database exists
* @global stores database connection state
* @return boolean indicating if the a database connection has been made
*/
function db_is_connected() {
global $g_db_connected;
return $g_db_connected;
}
/**
* Returns whether php support for a database is enabled
* @param string $p_db_type Database type.
* @return boolean indicating if php current supports the given database type
*/
function db_check_database_support( $p_db_type ) {
switch( $p_db_type ) {
case 'mysqli':
$t_support = function_exists( 'mysqli_connect' );
break;
case 'pgsql':
$t_support = function_exists( 'pg_connect' );
break;
case 'mssqlnative':
$t_support = function_exists( 'sqlsrv_connect' );
break;
case 'oci8':
$t_support = function_exists( 'OCILogon' );
break;
case 'odbc_mssql':
$t_support = function_exists( 'odbc_connect' );
break;
default:
$t_support = false;
}
return $t_support;
}
/**
* Maps a db driver type to the functional databse type
* @param string $p_driver_type Database driver name
* @return int Database type
*/
function db_get_type( $p_driver_type ) {
switch( $p_driver_type ) {
case 'mysqli':
return DB_TYPE_MYSQL;
case 'pgsql':
return DB_TYPE_PGSQL;
case 'mssqlnative':
case 'odbc_mssql':
return DB_TYPE_MSSQL;
case 'oci8':
return DB_TYPE_ORACLE;
default:
return DB_TYPE_UNDEFINED;
}
}
/**
* Checks if the database driver is MySQL
* @return boolean true if mysql
*/
function db_is_mysql() {
global $g_db_functional_type;
return( DB_TYPE_MYSQL == $g_db_functional_type );
}
/**
* Checks if the database driver is PostgreSQL
* @return boolean true if postgres
*/
function db_is_pgsql() {
global $g_db_functional_type;
return( DB_TYPE_PGSQL == $g_db_functional_type );
}
/**
* Checks if the database driver is MS SQL
* @return boolean true if mssql
*/
function db_is_mssql() {
global $g_db_functional_type;
return( DB_TYPE_MSSQL == $g_db_functional_type );
}
/**
* Checks if the database driver is Oracle (oci8)
* @return boolean true if oracle
*/
function db_is_oracle() {
global $g_db_functional_type;
return( DB_TYPE_ORACLE == $g_db_functional_type );
}
/**
* Validates that the given identifier's length is OK for the database platform
* Triggers an error if the identifier is too long
* @param string $p_identifier Identifier to check.
* @return void
*/
function db_check_identifier_size( $p_identifier ) {
# Oracle does not support long object names (30 chars max)
if( db_is_oracle() && 30 < strlen( $p_identifier ) ) {
error_parameters( $p_identifier );
trigger_error( ERROR_DB_IDENTIFIER_TOO_LONG, ERROR );
}
}
/**
* function alias for db_query() for legacy support of plugins
* @deprecated db_query should be used in preference to this function. This function may be removed in 2.0
*/
function db_query_bound() {
error_parameters( __FUNCTION__ . '()', 'db_query()' );
trigger_error( ERROR_DEPRECATED_SUPERSEDED, DEPRECATED );
return call_user_func_array( 'db_query', func_get_args() );
}
/**
* execute query, requires connection to be opened
* An error will be triggered if there is a problem executing the query.
* This will pop the database parameter stack {@see MantisDbParam} after a
* successful execution, unless specified otherwise
*
* @global array of previous executed queries for profiling
* @global adodb database connection object
* @global boolean indicating whether queries array is populated
* @param string $p_query Parameterlised Query string to execute.
* @param array $p_arr_parms Array of parameters matching $p_query.
* @param integer $p_limit Number of results to return.
* @param integer $p_offset Offset query results for paging.
* @param boolean $p_pop_param Set to false to leave the parameters on the stack
* @return IteratorAggregate|boolean adodb result set or false if the query failed.
*/
function db_query( $p_query, array $p_arr_parms = null, $p_limit = -1, $p_offset = -1, $p_pop_param = true ) {
global $g_queries_array, $g_db, $g_db_log_queries, $g_db_param;
$t_db_type = config_get_global( 'db_type' );
static $s_check_params;
if( $s_check_params === null ) {
$s_check_params = ( db_is_pgsql() || $t_db_type == 'odbc_mssql' || $t_db_type == 'mssqlnative' );
}
$t_start = microtime( true );
# This ensures that we don't get an error from ADOdb if $p_arr_parms == null,
# as Execute() expects either an array or false if there are no parameters -
# null actually gets treated as array( 0 => null )
if( is_null( $p_arr_parms ) ) {
$p_arr_parms = array();
}
if( !empty( $p_arr_parms ) && $s_check_params ) {
$t_params = count( $p_arr_parms );
for( $i = 0;$i < $t_params;$i++ ) {
if( $p_arr_parms[$i] === false ) {
$p_arr_parms[$i] = 0;
} elseif( $p_arr_parms[$i] === true && $t_db_type == 'mssqlnative' ) {
$p_arr_parms[$i] = 1;
}
}
}
static $s_prefix;
static $s_suffix;
if( $s_prefix === null ) {
# Determine table prefix and suffixes including trailing and leading '_'
$s_prefix = trim( config_get_global( 'db_table_prefix' ) );
$s_suffix = trim( config_get_global( 'db_table_suffix' ) );
if( !empty( $s_prefix ) && '_' != substr( $s_prefix, -1 ) ) {
$s_prefix .= '_';
}
if( !empty( $s_suffix ) && '_' != substr( $s_suffix, 0, 1 ) ) {
$s_suffix = '_' . $s_suffix;
}
}
$p_query = strtr($p_query, array(
'{' => $s_prefix,
'}' => $s_suffix,
) );
# Pushing params to safeguard the ADOdb parameter count (required for pgsql)
$g_db_param->push();
if( db_is_oracle() ) {
$p_query = db_oracle_adapt_query_syntax( $p_query, $p_arr_parms );
}
if( ( $p_limit != -1 ) || ( $p_offset != -1 ) ) {
$t_result = $g_db->SelectLimit( $p_query, $p_limit, $p_offset, $p_arr_parms );
} else {
$t_result = $g_db->Execute( $p_query, $p_arr_parms );
}
# Restore ADOdb parameter count
$g_db_param->pop();
$t_elapsed = number_format( microtime( true ) - $t_start, 4 );
if( ON == $g_db_log_queries ) {
$t_query_text = db_format_query_log_msg( $p_query, $p_arr_parms );
log_event( LOG_DATABASE, array( $t_query_text, $t_elapsed ) );
} else {
# If not logging the queries the actual text is not needed
$t_query_text = '';
}
array_push( $g_queries_array, array( $t_query_text, $t_elapsed ) );
# Restore param stack: only pop if asked to AND the query has params
if( $p_pop_param && !empty( $p_arr_parms ) ) {
$g_db_param->pop();
}
if( !$t_result ) {
db_error( $p_query );
trigger_error( ERROR_DB_QUERY_FAILED, ERROR );
return false;
} else {
return $t_result;
}
}
/**
* Generate a string to insert a parameter into a database query string
* @return string 'wildcard' matching a parameter in correct ordered format for the current database.
*/
function db_param() {
global $g_db_param;
return $g_db_param->assign();
}
/**
* Pushes current parameter count onto stack and resets its value
* Allows the caller to build multiple queries concurrently on RDBMS using
* positional parameters (e.g. PostgreSQL)
* @return void
*/
function db_param_push() {
global $g_db_param;
$g_db_param->push();
}
/**
* Pops the previous parameter count from the stack
* It is generally not necessary to call this, because the param count is popped
* automatically whenever a query is executed via db_query(). There are some
* corner cases when doing it manually makes sense, e.g. when a query is built
* but not executed.
* @return void
*/
function db_param_pop() {
global $g_db_param;
$g_db_param->pop();
}
/**
* Retrieve number of rows returned for a specific database query
* @param IteratorAggregate $p_result Database Query Record Set to retrieve record count for.
* @return integer Record Count
*/
function db_num_rows( IteratorAggregate $p_result ) {
return $p_result->RecordCount();
}
/**
* Retrieve number of rows affected by a specific database query
* @return integer Affected Rows
*/
function db_affected_rows() {
global $g_db;
return $g_db->Affected_Rows();
}
/**
* Retrieve the next row returned from a specific database query
* @param IteratorAggregate &$p_result Database Query Record Set to retrieve next result for.
* @return array Database result
*/
function db_fetch_array( IteratorAggregate &$p_result ) {
global $g_db_functional_type;
if( $p_result->EOF ) {
return false;
}
# Retrieve the fields from the recordset
$t_row = $p_result->fields;
# Additional handling for specific RDBMS
switch( $g_db_functional_type ) {
case DB_TYPE_PGSQL:
# pgsql's boolean fields are stored as 't' or 'f' and must be converted
static $s_current_result = null, $s_convert_needed;
if( $s_current_result != $p_result ) {
# Processing a new query
$s_current_result = $p_result;
$s_convert_needed = false;
} elseif( !$s_convert_needed ) {
# No conversion needed, return the row as-is
$p_result->MoveNext();
return $t_row;
}
foreach( $p_result->FieldTypesArray() as $t_field ) {
switch( $t_field->type ) {
case 'bool':
switch( $t_row[$t_field->name] ) {
case 'f':
$t_row[$t_field->name] = false;
break;
case 't':
$t_row[$t_field->name] = true;
break;
}
$s_convert_needed = true;
break;
}
}
break;
case DB_TYPE_ORACLE:
# oci8 returns null values for empty strings, convert them back
foreach( $t_row as &$t_value ) {
if( !isset( $t_value ) ) {
$t_value = '';
}
}
break;
}
$p_result->MoveNext();
return $t_row;
}
/**
* Retrieve a specific field from a database query result
* @param boolean|IteratorAggregate $p_result Database Query Record Set to retrieve the field from.
* @param integer $p_row_index Row to retrieve, zero-based (optional).
* @param integer $p_col_index Column to retrieve, zero-based (optional).
* @return mixed Database result
*/
function db_result( $p_result, $p_row_index = 0, $p_col_index = 0 ) {
if( $p_result && ( db_num_rows( $p_result ) > 0 ) ) {
$p_result->Move( $p_row_index );
$t_row = db_fetch_array( $p_result );
# Make the array numerically indexed. This is required to retrieve the
# column ($p_index2), since we use ADODB_FETCH_ASSOC fetch mode.
$t_result = array_values( $t_row );
return $t_result[$p_col_index];
}
return false;
}
/**
* return the last inserted id for a specific database table
* @param string $p_table A valid database table name.
* @param string $p_field A valid field name (default 'id').
* @return integer last successful insert id
*/
function db_insert_id( $p_table = null, $p_field = 'id' ) {
global $g_db, $g_db_functional_type;
if( isset( $p_table ) ) {
switch( $g_db_functional_type ) {
case DB_TYPE_ORACLE:
$t_query = 'SELECT seq_' . $p_table . '.CURRVAL FROM DUAL';
break;
case DB_TYPE_PGSQL:
$t_query = 'SELECT currval(\'' . $p_table . '_' . $p_field . '_seq\')';
break;
case DB_TYPE_MSSQL:
$t_query = 'SELECT IDENT_CURRENT(\'' . $p_table . '\')';
break;
}
if( isset( $t_query ) ) {
$t_result = db_query( $t_query );
return (int)db_result( $t_result );
}
}
return $g_db->Insert_ID();
}
/**
* Check if the specified table exists.
* @param string $p_table_name A valid database table name.
* @return boolean indicating whether the table exists
*/
function db_table_exists( $p_table_name ) {
if( is_blank( $p_table_name ) ) {
return false;
}
$t_tables = db_get_table_list();
if( !is_array( $t_tables ) ) {
return false;
}
# Can't use in_array() since it is case sensitive
$t_table_name = mb_strtolower( $p_table_name );
foreach( $t_tables as $t_current_table ) {
if( mb_strtolower( $t_current_table ) == $t_table_name ) {
return true;
}
}
return false;
}
/**
* Check if the specified table index exists.
* @param string $p_table_name A valid database table name.
* @param string $p_index_name A valid database index name.
* @return boolean indicating whether the index exists
*/
function db_index_exists( $p_table_name, $p_index_name ) {
global $g_db;
if( is_blank( $p_index_name ) || is_blank( $p_table_name ) ) {
return false;
}
$t_indexes = $g_db->MetaIndexes( $p_table_name );
if( $t_indexes === false ) {
# no index found
return false;
}
if( !empty( $t_indexes ) ) {
# Can't use in_array() since it is case sensitive
$t_index_name = mb_strtolower( $p_index_name );
foreach( $t_indexes as $t_current_index_name => $t_current_index_obj ) {
if( mb_strtolower( $t_current_index_name ) == $t_index_name ) {
return true;
}
}
}
return false;
}
/**
* Check if the specified field exists in a given table
* @param string $p_field_name A database field name.
* @param string $p_table_name A valid database table name.
* @return boolean indicating whether the field exists
*/
function db_field_exists( $p_field_name, $p_table_name ) {
$t_columns = db_field_names( $p_table_name );
# ADOdb oci8 driver works with uppercase column names, and as of 5.19 does
# not provide a way to force them to lowercase
if( db_is_oracle() ) {
$p_field_name = strtoupper( $p_field_name );
}
return in_array( $p_field_name, $t_columns );
}
/**
* Retrieve list of fields for a given table
* @param string $p_table_name A valid database table name.
* @return array array of fields on table
*/
function db_field_names( $p_table_name ) {
global $g_db;
$t_columns = $g_db->MetaColumnNames( $p_table_name );
return is_array( $t_columns ) ? $t_columns : array();
}
/**
* Returns the last error number. The error number is reset after every call to Execute(). If 0 is returned, no error occurred.
* @return int last error number
* @todo Use/Behaviour of this function should be reviewed before 1.2.0 final
*/
function db_error_num() {
global $g_db;
return $g_db->ErrorNo();
}
/**
* Returns the last status or error message. Returns the last status or error message. The error message is reset when Execute() is called.
* This can return a string even if no error occurs. In general you do not need to call this function unless an ADOdb function returns false on an error.
* @return string last error string
* @todo Use/Behaviour of this function should be reviewed before 1.2.0 final
*/
function db_error_msg() {
global $g_db;
return $g_db->ErrorMsg();
}
/**
* send both the error number and error message and query (optional) as parameters for a triggered error
* @param string $p_query Query that generated the error.
* @return void
* @todo Use/Behaviour of this function should be reviewed before 1.2.0 final
*/
function db_error( $p_query = null ) {
if( null !== $p_query ) {
error_parameters( db_error_num(), db_error_msg(), $p_query );
} else {
error_parameters( db_error_num(), db_error_msg() );
}
}
/**
* close the connection.
* Not really necessary most of the time since a connection is automatically closed when a page finishes loading.
* @return void
*/
function db_close() {
global $g_db;
$g_db->Close();
}
/**
* prepare a string before DB insertion
* @param string $p_string Unprepared string.
* @return string prepared database query string
* @deprecated db_query should be used in preference to this function. This function may be removed in 1.2.0 final
*/
function db_prepare_string( $p_string ) {
global $g_db;
$t_db_type = config_get_global( 'db_type' );
switch( $t_db_type ) {
case 'mssqlnative':
case 'odbc_mssql':
return addslashes( $p_string );
case 'mysqli':
$t_escaped = $g_db->qstr( $p_string, false );
return mb_substr( $t_escaped, 1, mb_strlen( $t_escaped ) - 2 );
case 'pgsql':
return pg_escape_string( $p_string );
case 'oci8':
return $p_string;
default:
error_parameters( 'db_type', $t_db_type );
trigger_error( ERROR_CONFIG_OPT_INVALID, ERROR );
}
}
/**
* Prepare a binary string before DB insertion
* Use of this function is required for some DB types, to properly encode
* BLOB fields prior to calling db_query()
* @param string $p_string Raw binary data.
* @return string prepared database query string
*/
function db_prepare_binary_string( $p_string ) {
global $g_db;
$t_db_type = config_get_global( 'db_type' );
switch( $t_db_type ) {
case 'odbc_mssql':
$t_content = unpack( 'H*hex', $p_string );
return '0x' . $t_content['hex'];
break;
case 'pgsql':
return $g_db->BlobEncode( $p_string );
break;
case 'mssqlnative':
case 'oci8':
# Fall through, mssqlnative, oci8 store raw data in BLOB
default:
return $p_string;
break;
}
}
/**
* prepare a int for database insertion.
* @param integer $p_int Integer.
* @return integer integer
* @deprecated db_query should be used in preference to this function. This function may be removed in 1.2.0 final
* @todo Use/Behaviour of this function should be reviewed before 1.2.0 final
*/
function db_prepare_int( $p_int ) {
return (int)$p_int;
}
/**
* prepare a double for database insertion.
* @param float $p_double Double.
* @return double double
* @deprecated db_query should be used in preference to this function. This function may be removed in 1.2.0 final
* @todo Use/Behaviour of this function should be reviewed before 1.2.0 final
*/
function db_prepare_double( $p_double ) {
return (double)$p_double;
}
/**
* prepare a boolean for database insertion.
* @param boolean $p_bool Boolean value.
* @return integer integer representing boolean
* @deprecated db_query should be used in preference to this function. This function may be removed in 1.2.0 final
* @todo Use/Behaviour of this function should be reviewed before 1.2.0 final
*/
function db_prepare_bool( $p_bool ) {
global $g_db;
if( db_is_pgsql() ) {
return $g_db->qstr( $p_bool );
} else {
return (int)(bool)$p_bool;
}
}
/**
* return current time as Unix timestamp
* @return integer Unix timestamp of the current date and time
*/
function db_now() {
return time();
}
/**
* convert minutes to a time format [h]h:mm
* @param integer $p_min Integer representing number of minutes.
* @return string representing formatted duration string in hh:mm format.
*/
function db_minutes_to_hhmm( $p_min = 0 ) {
return sprintf( '%02d:%02d', $p_min / 60, $p_min % 60 );
}
/**
* A helper function that generates a case-sensitive or case-insensitive like phrase based on the current db type.
* The field name and value are assumed to be safe to insert in a query (i.e. already cleaned).
* @param string $p_field_name The name of the field to filter on.
* @param boolean $p_case_sensitive True: case sensitive, false: case insensitive.
* @return string returns (field LIKE 'value') OR (field ILIKE 'value')
*/
function db_helper_like( $p_field_name, $p_case_sensitive = false ) {
$t_like_keyword = ' LIKE ';
if( $p_case_sensitive === false ) {
if( db_is_pgsql() ) {
$t_like_keyword = ' ILIKE ';
}
}
return '(' . $p_field_name . $t_like_keyword . db_param() . ')';
}
/**
* Compare two dates against a certain number of days
* 'val_or_col' parameters will be used "as is" in the query component,
* allowing use of a column name. To compare against a specific date,
* it is recommended to pass db_param() instead of a date constant.
* @param string $p_val_or_col_1 Value or Column to compare.
* @param string $p_operator SQL comparison operator.
* @param string $p_val_or_col_2 Value or Column to compare.
* @param integer $p_num_secs Number of seconds to compare against
* @return string Database query component to compare dates
* @todo Check if there is a way to do that using ADODB rather than implementing it here.
*/
function db_helper_compare_time( $p_val_or_col_1, $p_operator, $p_val_or_col_2, $p_num_secs ) {
if( $p_num_secs == 0 ) {
return "($p_val_or_col_1 $p_operator $p_val_or_col_2)";
} elseif( $p_num_secs > 0 ) {
return "($p_val_or_col_1 $p_operator $p_val_or_col_2 + $p_num_secs)";
} else {
# Invert comparison to avoid issues with unsigned integers on MySQL
return "($p_val_or_col_1 - $p_num_secs $p_operator $p_val_or_col_2)";
}
}
/**
* count queries
* @return integer
*/
function db_count_queries() {
global $g_queries_array;
return count( $g_queries_array );
}
/**
* count unique queries
* @return integer
*/
function db_count_unique_queries() {
global $g_queries_array;
$t_unique_queries = 0;
$t_shown_queries = array();
foreach( $g_queries_array as $t_val_array ) {
if( !in_array( $t_val_array[0], $t_shown_queries ) ) {
$t_unique_queries++;
array_push( $t_shown_queries, $t_val_array[0] );
}
}
return $t_unique_queries;
}
/**
* get total time for queries
* @return integer
*/
function db_time_queries() {
global $g_queries_array;
$t_count = count( $g_queries_array );
$t_total = 0;
for( $i = 0;$i < $t_count;$i++ ) {
$t_total += $g_queries_array[$i][1];
}
return $t_total;
}
/**
* get database table name
*
* @param string $p_name Can either be specified as 'XXX' (e.g. 'bug'), or
* using the legacy style 'mantis_XXX_table'; in the
* latter case, a deprecation warning will be issued.
* @return string containing full database table name (with prefix and suffix)
*/
function db_get_table( $p_name ) {
if( preg_match( '/^mantis_(.*)_table$/', $p_name, $t_matches ) ) {
$t_table = $t_matches[1];
error_parameters(
__FUNCTION__ . "( '$p_name' )",
__FUNCTION__ . "( '$t_table' )"
);
trigger_error( ERROR_DEPRECATED_SUPERSEDED, DEPRECATED );
} else {
$t_table = $p_name;
}
# Determine table prefix including trailing '_'
$t_prefix = trim( config_get_global( 'db_table_prefix' ) );
if( !empty( $t_prefix ) && '_' != substr( $t_prefix, -1 ) ) {
$t_prefix .= '_';
}
# Determine table suffix including leading '_'
$t_suffix = trim( config_get_global( 'db_table_suffix' ) );
if( !empty( $t_suffix ) && '_' != substr( $t_suffix, 0, 1 ) ) {
$t_suffix = '_' . $t_suffix;
}
# Physical table name
$t_table = $t_prefix . $t_table . $t_suffix;
db_check_identifier_size( $t_table );
return $t_table;
}
/**
* get list database tables
* @return array containing table names
*/
function db_get_table_list() {
global $g_db;
$t_tables = $g_db->MetaTables( 'TABLE' );
return $t_tables;
}
/**
* Updates a BLOB column
*
* This function is only needed for oci8; it will do nothing and return
* false if used with another RDBMS.
*
* @param string $p_table Table name.
* @param string $p_column The BLOB column to update.
* @param string $p_val Data to store into the BLOB.
* @param string $p_where Where clause to identify which record to update
* if null, defaults to the last record inserted in $p_table.
* @return boolean
*/
function db_update_blob( $p_table, $p_column, $p_val, $p_where = null ) {
global $g_db, $g_db_log_queries, $g_queries_array;
if( !db_is_oracle() ) {
return false;
}
if( null == $p_where ) {
$p_where = 'id=' . db_insert_id( $p_table );
}
if( ON == $g_db_log_queries ) {
$t_start = microtime( true );
$t_backtrace = debug_backtrace();
$t_caller = basename( $t_backtrace[0]['file'] );
$t_caller .= ':' . $t_backtrace[0]['line'];
# Is this called from another function?
if( isset( $t_backtrace[1] ) ) {
$t_caller .= ' ' . $t_backtrace[1]['function'] . '()';
} else {
# or from a script directly?
$t_caller .= ' ' . $_SERVER['SCRIPT_NAME'];
}
}
$t_result = $g_db->UpdateBlob( $p_table, $p_column, $p_val, $p_where );
if( $g_db_log_queries ) {
$t_elapsed = number_format( microtime( true ) - $t_start, 4 );
$t_log_data = array(
'Update BLOB in ' . $p_table . '.' . $p_column . ' where ' . $p_where,
$t_elapsed,
$t_caller
);
log_event( LOG_DATABASE, var_export( $t_log_data, true ) );
array_push( $g_queries_array, $t_log_data );
}
if( !$t_result ) {
db_error();
trigger_error( ERROR_DB_QUERY_FAILED, ERROR );
return false;