f79d369c4221481508c08f84cf817e6efddbf99d
[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 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 /**
711 * REPLACE query wrapper
712 * Oracle simulates this with a DELETE followed by INSERT
713 * $row is the row to insert, an associative array
714 * $uniqueIndexes is an array of indexes. Each element may be either a
715 * field name or an array of field names
716 *
717 * It may be more efficient to leave off unique indexes which are unlikely to collide.
718 * However if you do this, you run the risk of encountering errors which wouldn't have
719 * occurred in MySQL.
720 *
721 * @param $table String: table name
722 * @param $uniqueIndexes Array: array of indexes. Each element may be
723 * either a field name or an array of field names
724 * @param $rows Array: rows to insert to $table
725 * @param $fname String: function name, you can use __METHOD__ here
726 */
727 function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabaseOracle::replace' ) {
728 $table = $this->tableName( $table );
729
730 if ( count( $rows ) == 0 ) {
731 return;
732 }
733
734 # Single row case
735 if ( !is_array( reset( $rows ) ) ) {
736 $rows = array( $rows );
737 }
738
739 $sequenceData = $this->getSequenceData( $table );
740
741 foreach ( $rows as $row ) {
742 # Delete rows which collide
743 if ( $uniqueIndexes ) {
744 $deleteConds = array();
745 foreach ( $uniqueIndexes as $key=>$index ) {
746 if ( is_array( $index ) ) {
747 $deleteConds2 = array();
748 foreach ( $index as $col ) {
749 $deleteConds2[$col] = $row[$col];
750 }
751 $deleteConds[$key] = $this->makeList( $deleteConds2, LIST_AND );
752 } else {
753 $deleteConds[$index] = $row[$index];
754 }
755 }
756 $deleteConds = array( $this->makeList( $deleteConds, LIST_OR ) );
757 $this->delete( $table, $deleteConds, $fname );
758 }
759
760
761 if ( $sequenceData !== false && !isset( $row[$sequenceData['column']] ) ) {
762 $row[$sequenceData['column']] = $this->nextSequenceValue( $sequenceData['sequence'] );
763 }
764
765 # Now insert the row
766 $this->insert( $table, $row, $fname );
767 }
768 }
769
770 # DELETE where the condition is a join
771 function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'DatabaseOracle::deleteJoin' ) {
772 if ( !$conds ) {
773 throw new DBUnexpectedError( $this, 'DatabaseOracle::deleteJoin() called with empty $conds' );
774 }
775
776 $delTable = $this->tableName( $delTable );
777 $joinTable = $this->tableName( $joinTable );
778 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
779 if ( $conds != '*' ) {
780 $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND );
781 }
782 $sql .= ')';
783
784 $this->query( $sql, $fname );
785 }
786
787 # Returns the size of a text field, or -1 for "unlimited"
788 function textFieldSize( $table, $field ) {
789 $fieldInfoData = $this->fieldInfo( $table, $field );
790 return $fieldInfoData->maxLength();
791 }
792
793 function limitResult( $sql, $limit, $offset = false ) {
794 if ( $offset === false ) {
795 $offset = 0;
796 }
797 return "SELECT * FROM ($sql) WHERE rownum >= (1 + $offset) AND rownum < (1 + $limit + $offset)";
798 }
799
800 function encodeBlob( $b ) {
801 return new Blob( $b );
802 }
803
804 function decodeBlob( $b ) {
805 if ( $b instanceof Blob ) {
806 $b = $b->fetch();
807 }
808 return $b;
809 }
810
811 function unionQueries( $sqls, $all ) {
812 $glue = ' UNION ALL ';
813 return 'SELECT * ' . ( $all ? '':'/* UNION_UNIQUE */ ' ) . 'FROM (' . implode( $glue, $sqls ) . ')' ;
814 }
815
816 function wasDeadlock() {
817 return $this->lastErrno() == 'OCI-00060';
818 }
819
820 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'DatabaseOracle::duplicateTableStructure' ) {
821 $temporary = $temporary ? 'TRUE' : 'FALSE';
822
823 $newName = strtoupper( $newName );
824 $oldName = strtoupper( $oldName );
825
826 $tabName = substr( $newName, strlen( $this->mTablePrefix ) );
827 $oldPrefix = substr( $oldName, 0, strlen( $oldName ) - strlen( $tabName ) );
828 $newPrefix = strtoupper( $this->mTablePrefix );
829
830 return $this->doQuery( "BEGIN DUPLICATE_TABLE( '$tabName', '$oldPrefix', '$newPrefix', $temporary ); END;" );
831 }
832
833 function listTables( $prefix = null, $fname = 'DatabaseOracle::listTables' ) {
834 $listWhere = '';
835 if (!empty($prefix)) {
836 $listWhere = ' AND table_name LIKE \''.strtoupper($prefix).'%\'';
837 }
838
839 $owner = strtoupper( $this->mDBname );
840 $result = $this->doQuery( "SELECT table_name FROM all_tables WHERE owner='$owner' AND table_name NOT LIKE '%!_IDX\$_' ESCAPE '!' $listWhere" );
841
842 // dirty code ... i know
843 $endArray = array();
844 $endArray[] = $prefix.'MWUSER';
845 $endArray[] = $prefix.'PAGE';
846 $endArray[] = $prefix.'IMAGE';
847 $fixedOrderTabs = $endArray;
848 while (($row = $result->fetchRow()) !== false) {
849 if (!in_array($row['table_name'], $fixedOrderTabs))
850 $endArray[] = $row['table_name'];
851 }
852
853 return $endArray;
854 }
855
856 public function dropTable( $tableName, $fName = 'DatabaseOracle::dropTable' ) {
857 $tableName = $this->tableName($tableName);
858 if( !$this->tableExists( $tableName ) ) {
859 return false;
860 }
861
862 return $this->doQuery( "DROP TABLE $tableName CASCADE CONSTRAINTS PURGE" );
863 }
864
865 function timestamp( $ts = 0 ) {
866 return wfTimestamp( TS_ORACLE, $ts );
867 }
868
869 /**
870 * Return aggregated value function call
871 */
872 function aggregateValue ( $valuedata, $valuename = 'value' ) {
873 return $valuedata;
874 }
875
876 function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
877 # Ignore errors during error handling to avoid infinite
878 # recursion
879 $ignore = $this->ignoreErrors( true );
880 ++$this->mErrorCount;
881
882 if ( $ignore || $tempIgnore ) {
883 wfDebug( "SQL ERROR (ignored): $error\n" );
884 $this->ignoreErrors( $ignore );
885 } else {
886 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
887 }
888 }
889
890 /**
891 * @return string wikitext of a link to the server software's web site
892 */
893 public static function getSoftwareLink() {
894 return '[http://www.oracle.com/ Oracle]';
895 }
896
897 /**
898 * @return string Version information from the database
899 */
900 function getServerVersion() {
901 //better version number, fallback on driver
902 $rset = $this->doQuery( 'SELECT version FROM product_component_version WHERE UPPER(product) LIKE \'ORACLE DATABASE%\'' );
903 if ( !( $row = $rset->fetchRow() ) ) {
904 return oci_server_version( $this->mConn );
905 }
906 return $row['version'];
907 }
908
909 /**
910 * Query whether a given index exists
911 */
912 function indexExists( $table, $index, $fname = 'DatabaseOracle::indexExists' ) {
913 $table = $this->tableName( $table );
914 $table = strtoupper( $this->removeIdentifierQuotes( $table ) );
915 $index = strtoupper( $index );
916 $owner = strtoupper( $this->mDBname );
917 $SQL = "SELECT 1 FROM all_indexes WHERE owner='$owner' AND index_name='{$table}_{$index}'";
918 $res = $this->doQuery( $SQL );
919 if ( $res ) {
920 $count = $res->numRows();
921 $res->free();
922 } else {
923 $count = 0;
924 }
925 return $count != 0;
926 }
927
928 /**
929 * Query whether a given table exists (in the given schema, or the default mw one if not given)
930 */
931 function tableExists( $table ) {
932 $table = $this->tableName( $table );
933 $table = $this->addQuotes( strtoupper( $this->removeIdentifierQuotes( $table ) ) );
934 $owner = $this->addQuotes( strtoupper( $this->mDBname ) );
935 $SQL = "SELECT 1 FROM all_tables WHERE owner=$owner AND table_name=$table";
936 $res = $this->doQuery( $SQL );
937 if ( $res ) {
938 $count = $res->numRows();
939 $res->free();
940 } else {
941 $count = 0;
942 }
943 return $count;
944 }
945
946 /**
947 * Function translates mysql_fetch_field() functionality on ORACLE.
948 * Caching is present for reducing query time.
949 * For internal calls. Use fieldInfo for normal usage.
950 * Returns false if the field doesn't exist
951 *
952 * @param $table Array
953 * @param $field String
954 * @return ORAField|ORAResult
955 */
956 private function fieldInfoMulti( $table, $field ) {
957 $field = strtoupper( $field );
958 if ( is_array( $table ) ) {
959 $table = array_map( array( &$this, 'tableNameInternal' ), $table );
960 $tableWhere = 'IN (';
961 foreach( $table as &$singleTable ) {
962 $singleTable = $this->removeIdentifierQuotes($singleTable);
963 if ( isset( $this->mFieldInfoCache["$singleTable.$field"] ) ) {
964 return $this->mFieldInfoCache["$singleTable.$field"];
965 }
966 $tableWhere .= '\'' . $singleTable . '\',';
967 }
968 $tableWhere = rtrim( $tableWhere, ',' ) . ')';
969 } else {
970 $table = $this->removeIdentifierQuotes( $this->tableNameInternal( $table ) );
971 if ( isset( $this->mFieldInfoCache["$table.$field"] ) ) {
972 return $this->mFieldInfoCache["$table.$field"];
973 }
974 $tableWhere = '= \''.$table.'\'';
975 }
976
977 $fieldInfoStmt = oci_parse( $this->mConn, 'SELECT * FROM wiki_field_info_full WHERE table_name '.$tableWhere.' and column_name = \''.$field.'\'' );
978 if ( oci_execute( $fieldInfoStmt, $this->execFlags() ) === false ) {
979 $e = oci_error( $fieldInfoStmt );
980 $this->reportQueryError( $e['message'], $e['code'], 'fieldInfo QUERY', __METHOD__ );
981 return false;
982 }
983 $res = new ORAResult( $this, $fieldInfoStmt );
984 if ( $res->numRows() == 0 ) {
985 if ( is_array( $table ) ) {
986 foreach( $table as &$singleTable ) {
987 $this->mFieldInfoCache["$singleTable.$field"] = false;
988 }
989 } else {
990 $this->mFieldInfoCache["$table.$field"] = false;
991 }
992 $fieldInfoTemp = null;
993 } else {
994 $fieldInfoTemp = new ORAField( $res->fetchRow() );
995 $table = $fieldInfoTemp->tableName();
996 $this->mFieldInfoCache["$table.$field"] = $fieldInfoTemp;
997 }
998 $res->free();
999 return $fieldInfoTemp;
1000 }
1001
1002 /**
1003 * @throws DBUnexpectedError
1004 * @param $table
1005 * @param $field
1006 * @return ORAField
1007 */
1008 function fieldInfo( $table, $field ) {
1009 if ( is_array( $table ) ) {
1010 throw new DBUnexpectedError( $this, 'DatabaseOracle::fieldInfo called with table array!' );
1011 }
1012 return $this->fieldInfoMulti ($table, $field);
1013 }
1014
1015 function begin( $fname = 'DatabaseOracle::begin' ) {
1016 $this->mTrxLevel = 1;
1017 $this->doQuery( 'SET CONSTRAINTS ALL DEFERRED' );
1018 }
1019
1020 function commit( $fname = 'DatabaseOracle::commit' ) {
1021 if ( $this->mTrxLevel ) {
1022 $ret = oci_commit( $this->mConn );
1023 if ( !$ret ) {
1024 throw new DBUnexpectedError( $this, $this->lastError() );
1025 }
1026 $this->mTrxLevel = 0;
1027 $this->doQuery( 'SET CONSTRAINTS ALL IMMEDIATE' );
1028 }
1029 }
1030
1031 function rollback( $fname = 'DatabaseOracle::rollback' ) {
1032 if ( $this->mTrxLevel ) {
1033 oci_rollback( $this->mConn );
1034 $this->mTrxLevel = 0;
1035 $this->doQuery( 'SET CONSTRAINTS ALL IMMEDIATE' );
1036 }
1037 }
1038
1039 /* Not even sure why this is used in the main codebase... */
1040 function limitResultForUpdate( $sql, $num ) {
1041 return $sql;
1042 }
1043
1044 /* defines must comply with ^define\s*([^\s=]*)\s*=\s?'\{\$([^\}]*)\}'; */
1045 function sourceStream( $fp, $lineCallback = false, $resultCallback = false, $fname = 'DatabaseOracle::sourceStream' ) {
1046 $cmd = '';
1047 $done = false;
1048 $dollarquote = false;
1049
1050 $replacements = array();
1051
1052 while ( ! feof( $fp ) ) {
1053 if ( $lineCallback ) {
1054 call_user_func( $lineCallback );
1055 }
1056 $line = trim( fgets( $fp, 1024 ) );
1057 $sl = strlen( $line ) - 1;
1058
1059 if ( $sl < 0 ) {
1060 continue;
1061 }
1062 if ( '-' == $line { 0 } && '-' == $line { 1 } ) {
1063 continue;
1064 }
1065
1066 // Allow dollar quoting for function declarations
1067 if ( substr( $line, 0, 8 ) == '/*$mw$*/' ) {
1068 if ( $dollarquote ) {
1069 $dollarquote = false;
1070 $line = str_replace( '/*$mw$*/', '', $line ); // remove dollarquotes
1071 $done = true;
1072 } else {
1073 $dollarquote = true;
1074 }
1075 } elseif ( !$dollarquote ) {
1076 if ( ';' == $line { $sl } && ( $sl < 2 || ';' != $line { $sl - 1 } ) ) {
1077 $done = true;
1078 $line = substr( $line, 0, $sl );
1079 }
1080 }
1081
1082 if ( $cmd != '' ) {
1083 $cmd .= ' ';
1084 }
1085 $cmd .= "$line\n";
1086
1087 if ( $done ) {
1088 $cmd = str_replace( ';;', ";", $cmd );
1089 if ( strtolower( substr( $cmd, 0, 6 ) ) == 'define' ) {
1090 if ( preg_match( '/^define\s*([^\s=]*)\s*=\s*\'\{\$([^\}]*)\}\'/', $cmd, $defines ) ) {
1091 $replacements[$defines[2]] = $defines[1];
1092 }
1093 } else {
1094 foreach ( $replacements as $mwVar => $scVar ) {
1095 $cmd = str_replace( '&' . $scVar . '.', '`{$' . $mwVar . '}`', $cmd );
1096 }
1097
1098 $cmd = $this->replaceVars( $cmd );
1099 $res = $this->doQuery( $cmd );
1100 if ( $resultCallback ) {
1101 call_user_func( $resultCallback, $res, $this );
1102 }
1103
1104 if ( false === $res ) {
1105 $err = $this->lastError();
1106 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
1107 }
1108 }
1109
1110 $cmd = '';
1111 $done = false;
1112 }
1113 }
1114 return true;
1115 }
1116
1117 function selectDB( $db ) {
1118 $this->mDBname = $db;
1119 if ( $db == null || $db == $this->mUser ) {
1120 return true;
1121 }
1122 $sql = 'ALTER SESSION SET CURRENT_SCHEMA=' . strtoupper($db);
1123 $stmt = oci_parse( $this->mConn, $sql );
1124 wfSuppressWarnings();
1125 $success = oci_execute( $stmt );
1126 wfRestoreWarnings();
1127 if ( !$success ) {
1128 $e = oci_error( $stmt );
1129 if ( $e['code'] != '1435' ) {
1130 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1131 }
1132 return false;
1133 }
1134 return true;
1135 }
1136
1137 function strencode( $s ) {
1138 return str_replace( "'", "''", $s );
1139 }
1140
1141 function addQuotes( $s ) {
1142 global $wgContLang;
1143 if ( isset( $wgContLang->mLoaded ) && $wgContLang->mLoaded ) {
1144 $s = $wgContLang->checkTitleEncoding( $s );
1145 }
1146 return "'" . $this->strencode( $s ) . "'";
1147 }
1148
1149 public function addIdentifierQuotes( $s ) {
1150 if ( !$this->getFlag( DBO_DDLMODE ) ) {
1151 $s = '/*Q*/' . $s;
1152 }
1153 return $s;
1154 }
1155
1156 public function removeIdentifierQuotes( $s ) {
1157 return strpos($s, '/*Q*/') === FALSE ? $s : substr($s, 5);
1158 }
1159
1160 public function isQuotedIdentifier( $s ) {
1161 return strpos($s, '/*Q*/') !== FALSE;
1162 }
1163
1164 private function wrapFieldForWhere( $table, &$col, &$val ) {
1165 global $wgContLang;
1166
1167 $col_info = $this->fieldInfoMulti( $table, $col );
1168 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
1169 if ( $col_type == 'CLOB' ) {
1170 $col = 'TO_CHAR(' . $col . ')';
1171 $val = $wgContLang->checkTitleEncoding( $val );
1172 } elseif ( $col_type == 'VARCHAR2' && !mb_check_encoding( $val ) ) {
1173 $val = $wgContLang->checkTitleEncoding( $val );
1174 }
1175 }
1176
1177 private function wrapConditionsForWhere ( $table, $conds, $parentCol = null ) {
1178 $conds2 = array();
1179 foreach ( $conds as $col => $val ) {
1180 if ( is_array( $val ) ) {
1181 $conds2[$col] = $this->wrapConditionsForWhere ( $table, $val, $col );
1182 } else {
1183 if ( is_numeric( $col ) && $parentCol != null ) {
1184 $this->wrapFieldForWhere ( $table, $parentCol, $val );
1185 } else {
1186 $this->wrapFieldForWhere ( $table, $col, $val );
1187 }
1188 $conds2[$col] = $val;
1189 }
1190 }
1191 return $conds2;
1192 }
1193
1194 function selectRow( $table, $vars, $conds, $fname = 'DatabaseOracle::selectRow', $options = array(), $join_conds = array() ) {
1195 if ( is_array($conds) ) {
1196 $conds = $this->wrapConditionsForWhere( $table, $conds );
1197 }
1198 return parent::selectRow( $table, $vars, $conds, $fname, $options, $join_conds );
1199 }
1200
1201 /**
1202 * Returns an optional USE INDEX clause to go after the table, and a
1203 * string to go at the end of the query
1204 *
1205 * @private
1206 *
1207 * @param $options Array: an associative array of options to be turned into
1208 * an SQL query, valid keys are listed in the function.
1209 * @return array
1210 */
1211 function makeSelectOptions( $options ) {
1212 $preLimitTail = $postLimitTail = '';
1213 $startOpts = '';
1214
1215 $noKeyOptions = array();
1216 foreach ( $options as $key => $option ) {
1217 if ( is_numeric( $key ) ) {
1218 $noKeyOptions[$option] = true;
1219 }
1220 }
1221
1222 if ( isset( $options['GROUP BY'] ) ) {
1223 $preLimitTail .= " GROUP BY {$options['GROUP BY']}";
1224 }
1225 if ( isset( $options['ORDER BY'] ) ) {
1226 $preLimitTail .= " ORDER BY {$options['ORDER BY']}";
1227 }
1228
1229 # if ( isset( $noKeyOptions['FOR UPDATE'] ) ) $tailOpts .= ' FOR UPDATE';
1230 # if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) $tailOpts .= ' LOCK IN SHARE MODE';
1231 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1232 $startOpts .= 'DISTINCT';
1233 }
1234
1235 if ( isset( $options['USE INDEX'] ) && ! is_array( $options['USE INDEX'] ) ) {
1236 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1237 } else {
1238 $useIndex = '';
1239 }
1240
1241 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1242 }
1243
1244 public function delete( $table, $conds, $fname = 'DatabaseOracle::delete' ) {
1245 if ( is_array($conds) ) {
1246 $conds = $this->wrapConditionsForWhere( $table, $conds );
1247 }
1248 return parent::delete( $table, $conds, $fname );
1249 }
1250
1251 function update( $table, $values, $conds, $fname = 'DatabaseOracle::update', $options = array() ) {
1252 global $wgContLang;
1253
1254 $table = $this->tableName( $table );
1255 $opts = $this->makeUpdateOptions( $options );
1256 $sql = "UPDATE $opts $table SET ";
1257
1258 $first = true;
1259 foreach ( $values as $col => &$val ) {
1260 $sqlSet = $this->fieldBindStatement( $table, $col, $val, true );
1261
1262 if ( !$first ) {
1263 $sqlSet = ', ' . $sqlSet;
1264 } else {
1265 $first = false;
1266 }
1267 $sql .= $sqlSet;
1268 }
1269
1270 if ( $conds != '*' ) {
1271 $conds = $this->wrapConditionsForWhere( $table, $conds );
1272 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
1273 }
1274
1275 if ( ( $this->mLastResult = $stmt = oci_parse( $this->mConn, $sql ) ) === false ) {
1276 $e = oci_error( $this->mConn );
1277 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1278 return false;
1279 }
1280 foreach ( $values as $col => &$val ) {
1281 $col_info = $this->fieldInfoMulti( $table, $col );
1282 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
1283
1284 if ( $val === null ) {
1285 // do nothing ... null was inserted in statement creation
1286 } elseif ( $col_type != 'BLOB' && $col_type != 'CLOB' ) {
1287 if ( is_object( $val ) ) {
1288 $val = $val->getData();
1289 }
1290
1291 if ( preg_match( '/^timestamp.*/i', $col_type ) == 1 && strtolower( $val ) == 'infinity' ) {
1292 $val = '31-12-2030 12:00:00.000000';
1293 }
1294
1295 $val = ( $wgContLang != null ) ? $wgContLang->checkTitleEncoding( $val ) : $val;
1296 if ( oci_bind_by_name( $stmt, ":$col", $val ) === false ) {
1297 $e = oci_error( $stmt );
1298 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1299 return false;
1300 }
1301 } else {
1302 if ( ( $lob[$col] = oci_new_descriptor( $this->mConn, OCI_D_LOB ) ) === false ) {
1303 $e = oci_error( $stmt );
1304 throw new DBUnexpectedError( $this, "Cannot create LOB descriptor: " . $e['message'] );
1305 }
1306
1307 if ( $col_type == 'BLOB' ) {
1308 $lob[$col]->writeTemporary( $val );
1309 oci_bind_by_name( $stmt, ":$col", $lob[$col], - 1, SQLT_BLOB );
1310 } else {
1311 $lob[$col]->writeTemporary( $val );
1312 oci_bind_by_name( $stmt, ":$col", $lob[$col], - 1, OCI_B_CLOB );
1313 }
1314 }
1315 }
1316
1317 wfSuppressWarnings();
1318
1319 if ( oci_execute( $stmt, $this->execFlags() ) === false ) {
1320 $e = oci_error( $stmt );
1321 if ( !$this->ignore_DUP_VAL_ON_INDEX || $e['code'] != '1' ) {
1322 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1323 return false;
1324 } else {
1325 $this->mAffectedRows = oci_num_rows( $stmt );
1326 }
1327 } else {
1328 $this->mAffectedRows = oci_num_rows( $stmt );
1329 }
1330
1331 wfRestoreWarnings();
1332
1333 if ( isset( $lob ) ) {
1334 foreach ( $lob as $lob_v ) {
1335 $lob_v->free();
1336 }
1337 }
1338
1339 if ( !$this->mTrxLevel ) {
1340 oci_commit( $this->mConn );
1341 }
1342
1343 oci_free_statement( $stmt );
1344 }
1345
1346 function bitNot( $field ) {
1347 // expecting bit-fields smaller than 4bytes
1348 return 'BITNOT(' . $field . ')';
1349 }
1350
1351 function bitAnd( $fieldLeft, $fieldRight ) {
1352 return 'BITAND(' . $fieldLeft . ', ' . $fieldRight . ')';
1353 }
1354
1355 function bitOr( $fieldLeft, $fieldRight ) {
1356 return 'BITOR(' . $fieldLeft . ', ' . $fieldRight . ')';
1357 }
1358
1359 function setFakeMaster( $enabled = true ) { }
1360
1361 function getDBname() {
1362 return $this->mDBname;
1363 }
1364
1365 function getServer() {
1366 return $this->mServer;
1367 }
1368
1369 public function getSearchEngine() {
1370 return 'SearchOracle';
1371 }
1372 } // end DatabaseOracle class