fea8ec90acb9c4a2275550ac2047552db20fbcd8
[lhc/web/wiklou.git] / includes / db / DatabaseOracle.php
1 <?php
2 /**
3 * This is the Oracle database abstraction layer.
4 *
5 * @file
6 * @ingroup Database
7 */
8
9 /**
10 * The oci8 extension is fairly weak and doesn't support oci_num_rows, among
11 * other things. We use a wrapper class to handle that and other
12 * Oracle-specific bits, like converting column names back to lowercase.
13 * @ingroup Database
14 */
15 class ORAResult {
16 private $rows;
17 private $cursor;
18 private $nrows;
19
20 private $columns = array();
21
22 private function array_unique_md( $array_in ) {
23 $array_out = array();
24 $array_hashes = array();
25
26 foreach ( $array_in as $item ) {
27 $hash = md5( serialize( $item ) );
28 if ( !isset( $array_hashes[$hash] ) ) {
29 $array_hashes[$hash] = $hash;
30 $array_out[] = $item;
31 }
32 }
33
34 return $array_out;
35 }
36
37 /**
38 * @param $db DatabaseBase
39 * @param $stmt
40 * @param bool $unique
41 */
42 function __construct( &$db, $stmt, $unique = false ) {
43 $this->db =& $db;
44
45 if ( ( $this->nrows = oci_fetch_all( $stmt, $this->rows, 0, - 1, OCI_FETCHSTATEMENT_BY_ROW | OCI_NUM ) ) === false ) {
46 $e = oci_error( $stmt );
47 $db->reportQueryError( $e['message'], $e['code'], '', __METHOD__ );
48 $this->free();
49 return;
50 }
51
52 if ( $unique ) {
53 $this->rows = $this->array_unique_md( $this->rows );
54 $this->nrows = count( $this->rows );
55 }
56
57 if ($this->nrows > 0) {
58 foreach ( $this->rows[0] as $k => $v ) {
59 $this->columns[$k] = strtolower( oci_field_name( $stmt, $k + 1 ) );
60 }
61 }
62
63 $this->cursor = 0;
64 oci_free_statement( $stmt );
65 }
66
67 public function free() {
68 unset($this->db);
69 }
70
71 public function seek( $row ) {
72 $this->cursor = min( $row, $this->nrows );
73 }
74
75 public function numRows() {
76 return $this->nrows;
77 }
78
79 public function numFields() {
80 return count($this->columns);
81 }
82
83 public function fetchObject() {
84 if ( $this->cursor >= $this->nrows ) {
85 return false;
86 }
87 $row = $this->rows[$this->cursor++];
88 $ret = new stdClass();
89 foreach ( $row as $k => $v ) {
90 $lc = $this->columns[$k];
91 $ret->$lc = $v;
92 }
93
94 return $ret;
95 }
96
97 public function fetchRow() {
98 if ( $this->cursor >= $this->nrows ) {
99 return false;
100 }
101
102 $row = $this->rows[$this->cursor++];
103 $ret = array();
104 foreach ( $row as $k => $v ) {
105 $lc = $this->columns[$k];
106 $ret[$lc] = $v;
107 $ret[$k] = $v;
108 }
109 return $ret;
110 }
111 }
112
113 /**
114 * Utility class.
115 * @ingroup Database
116 */
117 class ORAField implements Field {
118 private $name, $tablename, $default, $max_length, $nullable,
119 $is_pk, $is_unique, $is_multiple, $is_key, $type;
120
121 function __construct( $info ) {
122 $this->name = $info['column_name'];
123 $this->tablename = $info['table_name'];
124 $this->default = $info['data_default'];
125 $this->max_length = $info['data_length'];
126 $this->nullable = $info['not_null'];
127 $this->is_pk = isset( $info['prim'] ) && $info['prim'] == 1 ? 1 : 0;
128 $this->is_unique = isset( $info['uniq'] ) && $info['uniq'] == 1 ? 1 : 0;
129 $this->is_multiple = isset( $info['nonuniq'] ) && $info['nonuniq'] == 1 ? 1 : 0;
130 $this->is_key = ( $this->is_pk || $this->is_unique || $this->is_multiple );
131 $this->type = $info['data_type'];
132 }
133
134 function name() {
135 return $this->name;
136 }
137
138 function tableName() {
139 return $this->tablename;
140 }
141
142 function defaultValue() {
143 return $this->default;
144 }
145
146 function maxLength() {
147 return $this->max_length;
148 }
149
150 function isNullable() {
151 return $this->nullable;
152 }
153
154 function isKey() {
155 return $this->is_key;
156 }
157
158 function isMultipleKey() {
159 return $this->is_multiple;
160 }
161
162 function type() {
163 return $this->type;
164 }
165 }
166
167 /**
168 * @ingroup Database
169 */
170 class DatabaseOracle extends DatabaseBase {
171 var $mInsertId = null;
172 var $mLastResult = null;
173 var $lastResult = null;
174 var $cursor = 0;
175 var $mAffectedRows;
176
177 var $ignore_DUP_VAL_ON_INDEX = false;
178 var $sequenceData = null;
179
180 var $defaultCharset = 'AL32UTF8';
181
182 var $mFieldInfoCache = array();
183
184 function __construct( $server = false, $user = false, $password = false, $dbName = false,
185 $flags = 0, $tablePrefix = 'get from global' )
186 {
187 global $wgDBprefix;
188 $tablePrefix = $tablePrefix == 'get from global' ? strtoupper( $wgDBprefix ) : strtoupper( $tablePrefix );
189 parent::__construct( $server, $user, $password, $dbName, $flags, $tablePrefix );
190 wfRunHooks( 'DatabaseOraclePostInit', array( $this ) );
191 }
192
193 function __destruct() {
194 if ($this->mOpened) {
195 wfSuppressWarnings();
196 $this->close();
197 wfRestoreWarnings();
198 }
199 }
200
201 function getType() {
202 return 'oracle';
203 }
204
205 function cascadingDeletes() {
206 return true;
207 }
208 function cleanupTriggers() {
209 return true;
210 }
211 function strictIPs() {
212 return true;
213 }
214 function realTimestamps() {
215 return true;
216 }
217 function implicitGroupby() {
218 return false;
219 }
220 function implicitOrderby() {
221 return false;
222 }
223 function searchableIPs() {
224 return true;
225 }
226
227 /**
228 * Usually aborts on failure
229 */
230 function open( $server, $user, $password, $dbName ) {
231 if ( !function_exists( 'oci_connect' ) ) {
232 throw new DBConnectionError( $this, "Oracle functions missing, have you compiled PHP with the --with-oci8 option?\n (Note: if you recently installed PHP, you may need to restart your webserver and database)\n" );
233 }
234
235 $this->close();
236 $this->mUser = $user;
237 $this->mPassword = $password;
238 // changed internal variables functions
239 // mServer now holds the TNS endpoint
240 // mDBname is schema name if different from username
241 if ( !$server ) {
242 // backward compatibillity (server used to be null and TNS was supplied in dbname)
243 $this->mServer = $dbName;
244 $this->mDBname = $user;
245 } else {
246 $this->mServer = $server;
247 if ( !$dbName ) {
248 $this->mDBname = $user;
249 } else {
250 $this->mDBname = $dbName;
251 }
252 }
253
254 if ( !strlen( $user ) ) { # e.g. the class is being loaded
255 return;
256 }
257
258 $session_mode = $this->mFlags & DBO_SYSDBA ? OCI_SYSDBA : OCI_DEFAULT;
259 wfSuppressWarnings();
260 if ( $this->mFlags & DBO_DEFAULT ) {
261 $this->mConn = oci_new_connect( $this->mUser, $this->mPassword, $this->mServer, $this->defaultCharset, $session_mode );
262 } else {
263 $this->mConn = oci_connect( $this->mUser, $this->mPassword, $this->mServer, $this->defaultCharset, $session_mode );
264 }
265 wfRestoreWarnings();
266
267 if ( $this->mUser != $this->mDBname ) {
268 //change current schema in session
269 $this->selectDB( $this->mDBname );
270 }
271
272 if ( !$this->mConn ) {
273 throw new DBConnectionError( $this, $this->lastError() );
274 }
275
276 $this->mOpened = true;
277
278 # removed putenv calls because they interfere with the system globaly
279 $this->doQuery( 'ALTER SESSION SET NLS_TIMESTAMP_FORMAT=\'DD-MM-YYYY HH24:MI:SS.FF6\'' );
280 $this->doQuery( 'ALTER SESSION SET NLS_TIMESTAMP_TZ_FORMAT=\'DD-MM-YYYY HH24:MI:SS.FF6\'' );
281 $this->doQuery( 'ALTER SESSION SET NLS_NUMERIC_CHARACTERS=\'.,\'' );
282 return $this->mConn;
283 }
284
285 /**
286 * Closes a database connection, if it is open
287 * Returns success, true if already closed
288 */
289 function close() {
290 $this->mOpened = false;
291 if ( $this->mConn ) {
292 if ( $this->mTrxLevel ) {
293 $this->commit();
294 }
295 return oci_close( $this->mConn );
296 } else {
297 return true;
298 }
299 }
300
301 function execFlags() {
302 return $this->mTrxLevel ? OCI_NO_AUTO_COMMIT : OCI_COMMIT_ON_SUCCESS;
303 }
304
305 protected function doQuery( $sql ) {
306 wfDebug( "SQL: [$sql]\n" );
307 if ( !mb_check_encoding( $sql ) ) {
308 throw new MWException( "SQL encoding is invalid\n$sql" );
309 }
310
311 // handle some oracle specifics
312 // remove AS column/table/subquery namings
313 if( !$this->getFlag( DBO_DDLMODE ) ) {
314 $sql = preg_replace( '/ as /i', ' ', $sql );
315 }
316
317 // Oracle has issues with UNION clause if the statement includes LOB fields
318 // So we do a UNION ALL and then filter the results array with array_unique
319 $union_unique = ( preg_match( '/\/\* UNION_UNIQUE \*\/ /', $sql ) != 0 );
320 // EXPLAIN syntax in Oracle is EXPLAIN PLAN FOR and it return nothing
321 // you have to select data from plan table after explain
322 $explain_id = date( 'dmYHis' );
323
324 $sql = preg_replace( '/^EXPLAIN /', 'EXPLAIN PLAN SET STATEMENT_ID = \'' . $explain_id . '\' FOR', $sql, 1, $explain_count );
325
326 wfSuppressWarnings();
327
328 if ( ( $this->mLastResult = $stmt = oci_parse( $this->mConn, $sql ) ) === false ) {
329 $e = oci_error( $this->mConn );
330 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
331 return false;
332 }
333
334 if ( !oci_execute( $stmt, $this->execFlags() ) ) {
335 $e = oci_error( $stmt );
336 if ( !$this->ignore_DUP_VAL_ON_INDEX || $e['code'] != '1' ) {
337 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
338 return false;
339 }
340 }
341
342 wfRestoreWarnings();
343
344 if ( $explain_count > 0 ) {
345 return $this->doQuery( 'SELECT id, cardinality "ROWS" FROM plan_table WHERE statement_id = \'' . $explain_id . '\'' );
346 } elseif ( oci_statement_type( $stmt ) == 'SELECT' ) {
347 return new ORAResult( $this, $stmt, $union_unique );
348 } else {
349 $this->mAffectedRows = oci_num_rows( $stmt );
350 return true;
351 }
352 }
353
354 function queryIgnore( $sql, $fname = '' ) {
355 return $this->query( $sql, $fname, true );
356 }
357
358 function freeResult( $res ) {
359 if ( $res instanceof ResultWrapper ) {
360 $res = $res->result;
361 }
362
363 $res->free();
364 }
365
366 function fetchObject( $res ) {
367 if ( $res instanceof ResultWrapper ) {
368 $res = $res->result;
369 }
370
371 return $res->fetchObject();
372 }
373
374 function fetchRow( $res ) {
375 if ( $res instanceof ResultWrapper ) {
376 $res = $res->result;
377 }
378
379 return $res->fetchRow();
380 }
381
382 function numRows( $res ) {
383 if ( $res instanceof ResultWrapper ) {
384 $res = $res->result;
385 }
386
387 return $res->numRows();
388 }
389
390 function numFields( $res ) {
391 if ( $res instanceof ResultWrapper ) {
392 $res = $res->result;
393 }
394
395 return $res->numFields();
396 }
397
398 function fieldName( $stmt, $n ) {
399 return oci_field_name( $stmt, $n );
400 }
401
402 /**
403 * This must be called after nextSequenceVal
404 */
405 function insertId() {
406 return $this->mInsertId;
407 }
408
409 function dataSeek( $res, $row ) {
410 if ( $res instanceof ORAResult ) {
411 $res->seek( $row );
412 } else {
413 $res->result->seek( $row );
414 }
415 }
416
417 function lastError() {
418 if ( $this->mConn === false ) {
419 $e = oci_error();
420 } else {
421 $e = oci_error( $this->mConn );
422 }
423 return $e['message'];
424 }
425
426 function lastErrno() {
427 if ( $this->mConn === false ) {
428 $e = oci_error();
429 } else {
430 $e = oci_error( $this->mConn );
431 }
432 return $e['code'];
433 }
434
435 function affectedRows() {
436 return $this->mAffectedRows;
437 }
438
439 /**
440 * Returns information about an index
441 * If errors are explicitly ignored, returns NULL on failure
442 */
443 function indexInfo( $table, $index, $fname = 'DatabaseOracle::indexExists' ) {
444 return false;
445 }
446
447 function indexUnique( $table, $index, $fname = 'DatabaseOracle::indexUnique' ) {
448 return false;
449 }
450
451 function insert( $table, $a, $fname = 'DatabaseOracle::insert', $options = array() ) {
452 if ( !count( $a ) ) {
453 return true;
454 }
455
456 if ( !is_array( $options ) ) {
457 $options = array( $options );
458 }
459
460 if ( in_array( 'IGNORE', $options ) ) {
461 $this->ignore_DUP_VAL_ON_INDEX = true;
462 }
463
464 if ( !is_array( reset( $a ) ) ) {
465 $a = array( $a );
466 }
467
468 foreach ( $a as &$row ) {
469 $this->insertOneRow( $table, $row, $fname );
470 }
471 $retVal = true;
472
473 if ( in_array( 'IGNORE', $options ) ) {
474 $this->ignore_DUP_VAL_ON_INDEX = false;
475 }
476
477 return $retVal;
478 }
479
480 private function fieldBindStatement ( $table, $col, &$val, $includeCol = false ) {
481 $col_info = $this->fieldInfoMulti( $table, $col );
482 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
483
484 $bind = '';
485 if ( is_numeric( $col ) ) {
486 $bind = $val;
487 $val = null;
488 return $bind;
489 } elseif ( $includeCol ) {
490 $bind = "$col = ";
491 }
492
493 if ( $val == '' && $val !== 0 && $col_type != 'BLOB' && $col_type != 'CLOB' ) {
494 $val = null;
495 }
496
497 if ( $val === null ) {
498 if ( $col_info != false && $col_info->isNullable() == 0 && $col_info->defaultValue() != null ) {
499 $bind .= 'DEFAULT';
500 } else {
501 $bind .= 'NULL';
502 }
503 } else {
504 $bind .= ':' . $col;
505 }
506
507 return $bind;
508 }
509
510 private function insertOneRow( $table, $row, $fname ) {
511 global $wgContLang;
512
513 $table = $this->tableName( $table );
514 // "INSERT INTO tables (a, b, c)"
515 $sql = "INSERT INTO " . $table . " (" . join( ',', array_keys( $row ) ) . ')';
516 $sql .= " VALUES (";
517
518 // for each value, append ":key"
519 $first = true;
520 foreach ( $row as $col => &$val ) {
521 if ( !$first ) {
522 $sql .= ', ';
523 } else {
524 $first = false;
525 }
526
527 $sql .= $this->fieldBindStatement( $table, $col, $val );
528 }
529 $sql .= ')';
530
531 if ( ( $this->mLastResult = $stmt = oci_parse( $this->mConn, $sql ) ) === false ) {
532 $e = oci_error( $this->mConn );
533 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
534 return false;
535 }
536 foreach ( $row as $col => &$val ) {
537 $col_info = $this->fieldInfoMulti( $table, $col );
538 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
539
540 if ( $val === null ) {
541 // do nothing ... null was inserted in statement creation
542 } elseif ( $col_type != 'BLOB' && $col_type != 'CLOB' ) {
543 if ( is_object( $val ) ) {
544 $val = $val->fetch();
545 }
546
547 if ( preg_match( '/^timestamp.*/i', $col_type ) == 1 && strtolower( $val ) == 'infinity' ) {
548 $val = '31-12-2030 12:00:00.000000';
549 }
550
551 $val = ( $wgContLang != null ) ? $wgContLang->checkTitleEncoding( $val ) : $val;
552 if ( oci_bind_by_name( $stmt, ":$col", $val, -1, SQLT_CHR ) === false ) {
553 $e = oci_error( $stmt );
554 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
555 return false;
556 }
557 } else {
558 if ( ( $lob[$col] = oci_new_descriptor( $this->mConn, OCI_D_LOB ) ) === false ) {
559 $e = oci_error( $stmt );
560 throw new DBUnexpectedError( $this, "Cannot create LOB descriptor: " . $e['message'] );
561 }
562
563 if ( is_object( $val ) ) {
564 $val = $val->fetch();
565 }
566
567 if ( $col_type == 'BLOB' ) {
568 $lob[$col]->writeTemporary( $val, OCI_TEMP_BLOB );
569 oci_bind_by_name( $stmt, ":$col", $lob[$col], - 1, OCI_B_BLOB );
570 } else {
571 $lob[$col]->writeTemporary( $val, OCI_TEMP_CLOB );
572 oci_bind_by_name( $stmt, ":$col", $lob[$col], - 1, OCI_B_CLOB );
573 }
574 }
575 }
576
577 wfSuppressWarnings();
578
579 if ( oci_execute( $stmt, $this->execFlags() ) === false ) {
580 $e = oci_error( $stmt );
581 if ( !$this->ignore_DUP_VAL_ON_INDEX || $e['code'] != '1' ) {
582 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
583 return false;
584 } else {
585 $this->mAffectedRows = oci_num_rows( $stmt );
586 }
587 } else {
588 $this->mAffectedRows = oci_num_rows( $stmt );
589 }
590
591 wfRestoreWarnings();
592
593 if ( isset( $lob ) ) {
594 foreach ( $lob as $lob_v ) {
595 $lob_v->free();
596 }
597 }
598
599 if ( !$this->mTrxLevel ) {
600 oci_commit( $this->mConn );
601 }
602
603 oci_free_statement( $stmt );
604 }
605
606 function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabaseOracle::insertSelect',
607 $insertOptions = array(), $selectOptions = array() )
608 {
609 $destTable = $this->tableName( $destTable );
610 if ( !is_array( $selectOptions ) ) {
611 $selectOptions = array( $selectOptions );
612 }
613 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
614 if ( is_array( $srcTable ) ) {
615 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
616 } else {
617 $srcTable = $this->tableName( $srcTable );
618 }
619
620 if ( ( $sequenceData = $this->getSequenceData( $destTable ) ) !== false &&
621 !isset( $varMap[$sequenceData['column']] ) )
622 {
623 $varMap[$sequenceData['column']] = 'GET_SEQUENCE_VALUE(\'' . $sequenceData['sequence'] . '\')';
624 }
625
626 // count-alias subselect fields to avoid abigious definition errors
627 $i = 0;
628 foreach ( $varMap as &$val ) {
629 $val = $val . ' field' . ( $i++ );
630 }
631
632 $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
633 " SELECT $startOpts " . implode( ',', $varMap ) .
634 " FROM $srcTable $useIndex ";
635 if ( $conds != '*' ) {
636 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
637 }
638 $sql .= " $tailOpts";
639
640 if ( in_array( 'IGNORE', $insertOptions ) ) {
641 $this->ignore_DUP_VAL_ON_INDEX = true;
642 }
643
644 $retval = $this->query( $sql, $fname );
645
646 if ( in_array( 'IGNORE', $insertOptions ) ) {
647 $this->ignore_DUP_VAL_ON_INDEX = false;
648 }
649
650 return $retval;
651 }
652
653 function tableName( $name, $quoted = true ) {
654 /*
655 Replace reserved words with better ones
656 Using uppercase because that's the only way Oracle can handle
657 quoted tablenames
658 */
659 switch( $name ) {
660 case 'user':
661 $name = 'MWUSER';
662 break;
663 case 'text':
664 $name = 'PAGECONTENT';
665 break;
666 }
667
668 return parent::tableName( strtoupper( $name ), $quoted );
669 }
670
671 function tableNameInternal( $name ) {
672 $name = $this->tableName( $name );
673 return preg_replace( '/.*\.(.*)/', '$1', $name);
674 }
675 /**
676 * Return the next in a sequence, save the value for retrieval via insertId()
677 */
678 function nextSequenceValue( $seqName ) {
679 $res = $this->query( "SELECT $seqName.nextval FROM dual" );
680 $row = $this->fetchRow( $res );
681 $this->mInsertId = $row[0];
682 return $this->mInsertId;
683 }
684
685 /**
686 * Return sequence_name if table has a sequence
687 */
688 private function getSequenceData( $table ) {
689 if ( $this->sequenceData == null ) {
690 $result = $this->doQuery( "SELECT lower(asq.sequence_name),
691 lower(atc.table_name),
692 lower(atc.column_name)
693 FROM all_sequences asq, all_tab_columns atc
694 WHERE decode(atc.table_name, '{$this->mTablePrefix}MWUSER', '{$this->mTablePrefix}USER', atc.table_name) || '_' ||
695 atc.column_name || '_SEQ' = '{$this->mTablePrefix}' || asq.sequence_name
696 AND asq.sequence_owner = '{$this->mDBname}'
697 AND atc.owner = '{$this->mDBname}'" );
698
699 while ( ( $row = $result->fetchRow() ) !== false ) {
700 $this->sequenceData[$this->tableName( $row[1] )] = array(
701 'sequence' => $row[0],
702 'column' => $row[2]
703 );
704 }
705 }
706 $table = strtolower( $this->removeIdentifierQuotes( $this->tableName( $table ) ) );
707 return ( isset( $this->sequenceData[$table] ) ) ? $this->sequenceData[$table] : false;
708 }
709
710 # Returns the size of a text field, or -1 for "unlimited"
711 function textFieldSize( $table, $field ) {
712 $fieldInfoData = $this->fieldInfo( $table, $field );
713 return $fieldInfoData->maxLength();
714 }
715
716 function limitResult( $sql, $limit, $offset = false ) {
717 if ( $offset === false ) {
718 $offset = 0;
719 }
720 return "SELECT * FROM ($sql) WHERE rownum >= (1 + $offset) AND rownum < (1 + $limit + $offset)";
721 }
722
723 function encodeBlob( $b ) {
724 return new Blob( $b );
725 }
726
727 function decodeBlob( $b ) {
728 if ( $b instanceof Blob ) {
729 $b = $b->fetch();
730 }
731 return $b;
732 }
733
734 function unionQueries( $sqls, $all ) {
735 $glue = ' UNION ALL ';
736 return 'SELECT * ' . ( $all ? '':'/* UNION_UNIQUE */ ' ) . 'FROM (' . implode( $glue, $sqls ) . ')' ;
737 }
738
739 function wasDeadlock() {
740 return $this->lastErrno() == 'OCI-00060';
741 }
742
743 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'DatabaseOracle::duplicateTableStructure' ) {
744 $temporary = $temporary ? 'TRUE' : 'FALSE';
745
746 $newName = strtoupper( $newName );
747 $oldName = strtoupper( $oldName );
748
749 $tabName = substr( $newName, strlen( $this->mTablePrefix ) );
750 $oldPrefix = substr( $oldName, 0, strlen( $oldName ) - strlen( $tabName ) );
751 $newPrefix = strtoupper( $this->mTablePrefix );
752
753 return $this->doQuery( "BEGIN DUPLICATE_TABLE( '$tabName', '$oldPrefix', '$newPrefix', $temporary ); END;" );
754 }
755
756 function listTables( $prefix = null, $fname = 'DatabaseOracle::listTables' ) {
757 $listWhere = '';
758 if (!empty($prefix)) {
759 $listWhere = ' AND table_name LIKE \''.strtoupper($prefix).'%\'';
760 }
761
762 $owner = strtoupper( $this->mDBname );
763 $result = $this->doQuery( "SELECT table_name FROM all_tables WHERE owner='$owner' AND table_name NOT LIKE '%!_IDX\$_' ESCAPE '!' $listWhere" );
764
765 // dirty code ... i know
766 $endArray = array();
767 $endArray[] = $prefix.'MWUSER';
768 $endArray[] = $prefix.'PAGE';
769 $endArray[] = $prefix.'IMAGE';
770 $fixedOrderTabs = $endArray;
771 while (($row = $result->fetchRow()) !== false) {
772 if (!in_array($row['table_name'], $fixedOrderTabs))
773 $endArray[] = $row['table_name'];
774 }
775
776 return $endArray;
777 }
778
779 public function dropTable( $tableName, $fName = 'DatabaseOracle::dropTable' ) {
780 $tableName = $this->tableName($tableName);
781 if( !$this->tableExists( $tableName ) ) {
782 return false;
783 }
784
785 return $this->doQuery( "DROP TABLE $tableName CASCADE CONSTRAINTS PURGE" );
786 }
787
788 function timestamp( $ts = 0 ) {
789 return wfTimestamp( TS_ORACLE, $ts );
790 }
791
792 /**
793 * Return aggregated value function call
794 */
795 function aggregateValue ( $valuedata, $valuename = 'value' ) {
796 return $valuedata;
797 }
798
799 function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
800 # Ignore errors during error handling to avoid infinite
801 # recursion
802 $ignore = $this->ignoreErrors( true );
803 ++$this->mErrorCount;
804
805 if ( $ignore || $tempIgnore ) {
806 wfDebug( "SQL ERROR (ignored): $error\n" );
807 $this->ignoreErrors( $ignore );
808 } else {
809 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
810 }
811 }
812
813 /**
814 * @return string wikitext of a link to the server software's web site
815 */
816 public static function getSoftwareLink() {
817 return '[http://www.oracle.com/ Oracle]';
818 }
819
820 /**
821 * @return string Version information from the database
822 */
823 function getServerVersion() {
824 //better version number, fallback on driver
825 $rset = $this->doQuery( 'SELECT version FROM product_component_version WHERE UPPER(product) LIKE \'ORACLE DATABASE%\'' );
826 if ( !( $row = $rset->fetchRow() ) ) {
827 return oci_server_version( $this->mConn );
828 }
829 return $row['version'];
830 }
831
832 /**
833 * Query whether a given index exists
834 */
835 function indexExists( $table, $index, $fname = 'DatabaseOracle::indexExists' ) {
836 $table = $this->tableName( $table );
837 $table = strtoupper( $this->removeIdentifierQuotes( $table ) );
838 $index = strtoupper( $index );
839 $owner = strtoupper( $this->mDBname );
840 $SQL = "SELECT 1 FROM all_indexes WHERE owner='$owner' AND index_name='{$table}_{$index}'";
841 $res = $this->doQuery( $SQL );
842 if ( $res ) {
843 $count = $res->numRows();
844 $res->free();
845 } else {
846 $count = 0;
847 }
848 return $count != 0;
849 }
850
851 /**
852 * Query whether a given table exists (in the given schema, or the default mw one if not given)
853 */
854 function tableExists( $table ) {
855 $table = $this->tableName( $table );
856 $table = $this->addQuotes( strtoupper( $this->removeIdentifierQuotes( $table ) ) );
857 $owner = $this->addQuotes( strtoupper( $this->mDBname ) );
858 $SQL = "SELECT 1 FROM all_tables WHERE owner=$owner AND table_name=$table";
859 $res = $this->doQuery( $SQL );
860 if ( $res ) {
861 $count = $res->numRows();
862 $res->free();
863 } else {
864 $count = 0;
865 }
866 return $count;
867 }
868
869 /**
870 * Function translates mysql_fetch_field() functionality on ORACLE.
871 * Caching is present for reducing query time.
872 * For internal calls. Use fieldInfo for normal usage.
873 * Returns false if the field doesn't exist
874 *
875 * @param $table Array
876 * @param $field String
877 * @return ORAField|ORAResult
878 */
879 private function fieldInfoMulti( $table, $field ) {
880 $field = strtoupper( $field );
881 if ( is_array( $table ) ) {
882 $table = array_map( array( &$this, 'tableNameInternal' ), $table );
883 $tableWhere = 'IN (';
884 foreach( $table as &$singleTable ) {
885 $singleTable = $this->removeIdentifierQuotes($singleTable);
886 if ( isset( $this->mFieldInfoCache["$singleTable.$field"] ) ) {
887 return $this->mFieldInfoCache["$singleTable.$field"];
888 }
889 $tableWhere .= '\'' . $singleTable . '\',';
890 }
891 $tableWhere = rtrim( $tableWhere, ',' ) . ')';
892 } else {
893 $table = $this->removeIdentifierQuotes( $this->tableNameInternal( $table ) );
894 if ( isset( $this->mFieldInfoCache["$table.$field"] ) ) {
895 return $this->mFieldInfoCache["$table.$field"];
896 }
897 $tableWhere = '= \''.$table.'\'';
898 }
899
900 $fieldInfoStmt = oci_parse( $this->mConn, 'SELECT * FROM wiki_field_info_full WHERE table_name '.$tableWhere.' and column_name = \''.$field.'\'' );
901 if ( oci_execute( $fieldInfoStmt, $this->execFlags() ) === false ) {
902 $e = oci_error( $fieldInfoStmt );
903 $this->reportQueryError( $e['message'], $e['code'], 'fieldInfo QUERY', __METHOD__ );
904 return false;
905 }
906 $res = new ORAResult( $this, $fieldInfoStmt );
907 if ( $res->numRows() == 0 ) {
908 if ( is_array( $table ) ) {
909 foreach( $table as &$singleTable ) {
910 $this->mFieldInfoCache["$singleTable.$field"] = false;
911 }
912 } else {
913 $this->mFieldInfoCache["$table.$field"] = false;
914 }
915 $fieldInfoTemp = null;
916 } else {
917 $fieldInfoTemp = new ORAField( $res->fetchRow() );
918 $table = $fieldInfoTemp->tableName();
919 $this->mFieldInfoCache["$table.$field"] = $fieldInfoTemp;
920 }
921 $res->free();
922 return $fieldInfoTemp;
923 }
924
925 /**
926 * @throws DBUnexpectedError
927 * @param $table
928 * @param $field
929 * @return ORAField
930 */
931 function fieldInfo( $table, $field ) {
932 if ( is_array( $table ) ) {
933 throw new DBUnexpectedError( $this, 'DatabaseOracle::fieldInfo called with table array!' );
934 }
935 return $this->fieldInfoMulti ($table, $field);
936 }
937
938 function begin( $fname = 'DatabaseOracle::begin' ) {
939 $this->mTrxLevel = 1;
940 $this->doQuery( 'SET CONSTRAINTS ALL DEFERRED' );
941 }
942
943 function commit( $fname = 'DatabaseOracle::commit' ) {
944 if ( $this->mTrxLevel ) {
945 $ret = oci_commit( $this->mConn );
946 if ( !$ret ) {
947 throw new DBUnexpectedError( $this, $this->lastError() );
948 }
949 $this->mTrxLevel = 0;
950 $this->doQuery( 'SET CONSTRAINTS ALL IMMEDIATE' );
951 }
952 }
953
954 function rollback( $fname = 'DatabaseOracle::rollback' ) {
955 if ( $this->mTrxLevel ) {
956 oci_rollback( $this->mConn );
957 $this->mTrxLevel = 0;
958 $this->doQuery( 'SET CONSTRAINTS ALL IMMEDIATE' );
959 }
960 }
961
962 /* Not even sure why this is used in the main codebase... */
963 function limitResultForUpdate( $sql, $num ) {
964 return $sql;
965 }
966
967 /* defines must comply with ^define\s*([^\s=]*)\s*=\s?'\{\$([^\}]*)\}'; */
968 function sourceStream( $fp, $lineCallback = false, $resultCallback = false, $fname = 'DatabaseOracle::sourceStream' ) {
969 $cmd = '';
970 $done = false;
971 $dollarquote = false;
972
973 $replacements = array();
974
975 while ( ! feof( $fp ) ) {
976 if ( $lineCallback ) {
977 call_user_func( $lineCallback );
978 }
979 $line = trim( fgets( $fp, 1024 ) );
980 $sl = strlen( $line ) - 1;
981
982 if ( $sl < 0 ) {
983 continue;
984 }
985 if ( '-' == $line { 0 } && '-' == $line { 1 } ) {
986 continue;
987 }
988
989 // Allow dollar quoting for function declarations
990 if ( substr( $line, 0, 8 ) == '/*$mw$*/' ) {
991 if ( $dollarquote ) {
992 $dollarquote = false;
993 $line = str_replace( '/*$mw$*/', '', $line ); // remove dollarquotes
994 $done = true;
995 } else {
996 $dollarquote = true;
997 }
998 } elseif ( !$dollarquote ) {
999 if ( ';' == $line { $sl } && ( $sl < 2 || ';' != $line { $sl - 1 } ) ) {
1000 $done = true;
1001 $line = substr( $line, 0, $sl );
1002 }
1003 }
1004
1005 if ( $cmd != '' ) {
1006 $cmd .= ' ';
1007 }
1008 $cmd .= "$line\n";
1009
1010 if ( $done ) {
1011 $cmd = str_replace( ';;', ";", $cmd );
1012 if ( strtolower( substr( $cmd, 0, 6 ) ) == 'define' ) {
1013 if ( preg_match( '/^define\s*([^\s=]*)\s*=\s*\'\{\$([^\}]*)\}\'/', $cmd, $defines ) ) {
1014 $replacements[$defines[2]] = $defines[1];
1015 }
1016 } else {
1017 foreach ( $replacements as $mwVar => $scVar ) {
1018 $cmd = str_replace( '&' . $scVar . '.', '`{$' . $mwVar . '}`', $cmd );
1019 }
1020
1021 $cmd = $this->replaceVars( $cmd );
1022 $res = $this->doQuery( $cmd );
1023 if ( $resultCallback ) {
1024 call_user_func( $resultCallback, $res, $this );
1025 }
1026
1027 if ( false === $res ) {
1028 $err = $this->lastError();
1029 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
1030 }
1031 }
1032
1033 $cmd = '';
1034 $done = false;
1035 }
1036 }
1037 return true;
1038 }
1039
1040 function selectDB( $db ) {
1041 $this->mDBname = $db;
1042 if ( $db == null || $db == $this->mUser ) {
1043 return true;
1044 }
1045 $sql = 'ALTER SESSION SET CURRENT_SCHEMA=' . strtoupper($db);
1046 $stmt = oci_parse( $this->mConn, $sql );
1047 wfSuppressWarnings();
1048 $success = oci_execute( $stmt );
1049 wfRestoreWarnings();
1050 if ( !$success ) {
1051 $e = oci_error( $stmt );
1052 if ( $e['code'] != '1435' ) {
1053 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1054 }
1055 return false;
1056 }
1057 return true;
1058 }
1059
1060 function strencode( $s ) {
1061 return str_replace( "'", "''", $s );
1062 }
1063
1064 function addQuotes( $s ) {
1065 global $wgContLang;
1066 if ( isset( $wgContLang->mLoaded ) && $wgContLang->mLoaded ) {
1067 $s = $wgContLang->checkTitleEncoding( $s );
1068 }
1069 return "'" . $this->strencode( $s ) . "'";
1070 }
1071
1072 public function addIdentifierQuotes( $s ) {
1073 if ( !$this->getFlag( DBO_DDLMODE ) ) {
1074 $s = '/*Q*/' . $s;
1075 }
1076 return $s;
1077 }
1078
1079 public function removeIdentifierQuotes( $s ) {
1080 return strpos($s, '/*Q*/') === FALSE ? $s : substr($s, 5);
1081 }
1082
1083 public function isQuotedIdentifier( $s ) {
1084 return strpos($s, '/*Q*/') !== FALSE;
1085 }
1086
1087 private function wrapFieldForWhere( $table, &$col, &$val ) {
1088 global $wgContLang;
1089
1090 $col_info = $this->fieldInfoMulti( $table, $col );
1091 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
1092 if ( $col_type == 'CLOB' ) {
1093 $col = 'TO_CHAR(' . $col . ')';
1094 $val = $wgContLang->checkTitleEncoding( $val );
1095 } elseif ( $col_type == 'VARCHAR2' && !mb_check_encoding( $val ) ) {
1096 $val = $wgContLang->checkTitleEncoding( $val );
1097 }
1098 }
1099
1100 private function wrapConditionsForWhere ( $table, $conds, $parentCol = null ) {
1101 $conds2 = array();
1102 foreach ( $conds as $col => $val ) {
1103 if ( is_array( $val ) ) {
1104 $conds2[$col] = $this->wrapConditionsForWhere ( $table, $val, $col );
1105 } else {
1106 if ( is_numeric( $col ) && $parentCol != null ) {
1107 $this->wrapFieldForWhere ( $table, $parentCol, $val );
1108 } else {
1109 $this->wrapFieldForWhere ( $table, $col, $val );
1110 }
1111 $conds2[$col] = $val;
1112 }
1113 }
1114 return $conds2;
1115 }
1116
1117 function selectRow( $table, $vars, $conds, $fname = 'DatabaseOracle::selectRow', $options = array(), $join_conds = array() ) {
1118 if ( is_array($conds) ) {
1119 $conds = $this->wrapConditionsForWhere( $table, $conds );
1120 }
1121 return parent::selectRow( $table, $vars, $conds, $fname, $options, $join_conds );
1122 }
1123
1124 /**
1125 * Returns an optional USE INDEX clause to go after the table, and a
1126 * string to go at the end of the query
1127 *
1128 * @private
1129 *
1130 * @param $options Array: an associative array of options to be turned into
1131 * an SQL query, valid keys are listed in the function.
1132 * @return array
1133 */
1134 function makeSelectOptions( $options ) {
1135 $preLimitTail = $postLimitTail = '';
1136 $startOpts = '';
1137
1138 $noKeyOptions = array();
1139 foreach ( $options as $key => $option ) {
1140 if ( is_numeric( $key ) ) {
1141 $noKeyOptions[$option] = true;
1142 }
1143 }
1144
1145 if ( isset( $options['GROUP BY'] ) ) {
1146 $preLimitTail .= " GROUP BY {$options['GROUP BY']}";
1147 }
1148 if ( isset( $options['ORDER BY'] ) ) {
1149 $preLimitTail .= " ORDER BY {$options['ORDER BY']}";
1150 }
1151
1152 # if ( isset( $noKeyOptions['FOR UPDATE'] ) ) $tailOpts .= ' FOR UPDATE';
1153 # if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) $tailOpts .= ' LOCK IN SHARE MODE';
1154 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1155 $startOpts .= 'DISTINCT';
1156 }
1157
1158 if ( isset( $options['USE INDEX'] ) && ! is_array( $options['USE INDEX'] ) ) {
1159 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1160 } else {
1161 $useIndex = '';
1162 }
1163
1164 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1165 }
1166
1167 public function delete( $table, $conds, $fname = 'DatabaseOracle::delete' ) {
1168 if ( is_array($conds) ) {
1169 $conds = $this->wrapConditionsForWhere( $table, $conds );
1170 }
1171 return parent::delete( $table, $conds, $fname );
1172 }
1173
1174 function update( $table, $values, $conds, $fname = 'DatabaseOracle::update', $options = array() ) {
1175 global $wgContLang;
1176
1177 $table = $this->tableName( $table );
1178 $opts = $this->makeUpdateOptions( $options );
1179 $sql = "UPDATE $opts $table SET ";
1180
1181 $first = true;
1182 foreach ( $values as $col => &$val ) {
1183 $sqlSet = $this->fieldBindStatement( $table, $col, $val, true );
1184
1185 if ( !$first ) {
1186 $sqlSet = ', ' . $sqlSet;
1187 } else {
1188 $first = false;
1189 }
1190 $sql .= $sqlSet;
1191 }
1192
1193 if ( $conds != '*' ) {
1194 $conds = $this->wrapConditionsForWhere( $table, $conds );
1195 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
1196 }
1197
1198 if ( ( $this->mLastResult = $stmt = oci_parse( $this->mConn, $sql ) ) === false ) {
1199 $e = oci_error( $this->mConn );
1200 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1201 return false;
1202 }
1203 foreach ( $values as $col => &$val ) {
1204 $col_info = $this->fieldInfoMulti( $table, $col );
1205 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
1206
1207 if ( $val === null ) {
1208 // do nothing ... null was inserted in statement creation
1209 } elseif ( $col_type != 'BLOB' && $col_type != 'CLOB' ) {
1210 if ( is_object( $val ) ) {
1211 $val = $val->getData();
1212 }
1213
1214 if ( preg_match( '/^timestamp.*/i', $col_type ) == 1 && strtolower( $val ) == 'infinity' ) {
1215 $val = '31-12-2030 12:00:00.000000';
1216 }
1217
1218 $val = ( $wgContLang != null ) ? $wgContLang->checkTitleEncoding( $val ) : $val;
1219 if ( oci_bind_by_name( $stmt, ":$col", $val ) === false ) {
1220 $e = oci_error( $stmt );
1221 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1222 return false;
1223 }
1224 } else {
1225 if ( ( $lob[$col] = oci_new_descriptor( $this->mConn, OCI_D_LOB ) ) === false ) {
1226 $e = oci_error( $stmt );
1227 throw new DBUnexpectedError( $this, "Cannot create LOB descriptor: " . $e['message'] );
1228 }
1229
1230 if ( $col_type == 'BLOB' ) {
1231 $lob[$col]->writeTemporary( $val );
1232 oci_bind_by_name( $stmt, ":$col", $lob[$col], - 1, SQLT_BLOB );
1233 } else {
1234 $lob[$col]->writeTemporary( $val );
1235 oci_bind_by_name( $stmt, ":$col", $lob[$col], - 1, OCI_B_CLOB );
1236 }
1237 }
1238 }
1239
1240 wfSuppressWarnings();
1241
1242 if ( oci_execute( $stmt, $this->execFlags() ) === false ) {
1243 $e = oci_error( $stmt );
1244 if ( !$this->ignore_DUP_VAL_ON_INDEX || $e['code'] != '1' ) {
1245 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1246 return false;
1247 } else {
1248 $this->mAffectedRows = oci_num_rows( $stmt );
1249 }
1250 } else {
1251 $this->mAffectedRows = oci_num_rows( $stmt );
1252 }
1253
1254 wfRestoreWarnings();
1255
1256 if ( isset( $lob ) ) {
1257 foreach ( $lob as $lob_v ) {
1258 $lob_v->free();
1259 }
1260 }
1261
1262 if ( !$this->mTrxLevel ) {
1263 oci_commit( $this->mConn );
1264 }
1265
1266 oci_free_statement( $stmt );
1267 }
1268
1269 function bitNot( $field ) {
1270 // expecting bit-fields smaller than 4bytes
1271 return 'BITNOT(' . $field . ')';
1272 }
1273
1274 function bitAnd( $fieldLeft, $fieldRight ) {
1275 return 'BITAND(' . $fieldLeft . ', ' . $fieldRight . ')';
1276 }
1277
1278 function bitOr( $fieldLeft, $fieldRight ) {
1279 return 'BITOR(' . $fieldLeft . ', ' . $fieldRight . ')';
1280 }
1281
1282 function setFakeMaster( $enabled = true ) { }
1283
1284 function getDBname() {
1285 return $this->mDBname;
1286 }
1287
1288 function getServer() {
1289 return $this->mServer;
1290 }
1291
1292 public function getSearchEngine() {
1293 return 'SearchOracle';
1294 }
1295 } // end DatabaseOracle class