Merge "DatabaseMssql: Don't duplicate body of makeList()"
[mediawiki.git] / includes / db / DatabaseOracle.php
blobe1502069cc08993f9aed6ba1b0e5713a537cfbde
1 <?php
2 /**
3 * This is the Oracle database abstraction layer.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
20 * @file
21 * @ingroup Database
24 /**
25 * The oci8 extension is fairly weak and doesn't support oci_num_rows, among
26 * other things. We use a wrapper class to handle that and other
27 * Oracle-specific bits, like converting column names back to lowercase.
28 * @ingroup Database
30 class ORAResult {
31 private $rows;
32 private $cursor;
33 private $nrows;
35 private $columns = array();
37 private function array_unique_md( $array_in ) {
38 $array_out = array();
39 $array_hashes = array();
41 foreach ( $array_in as $item ) {
42 $hash = md5( serialize( $item ) );
43 if ( !isset( $array_hashes[$hash] ) ) {
44 $array_hashes[$hash] = $hash;
45 $array_out[] = $item;
49 return $array_out;
52 /**
53 * @param DatabaseBase $db
54 * @param resource $stmt A valid OCI statement identifier
55 * @param bool $unique
57 function __construct( &$db, $stmt, $unique = false ) {
58 $this->db =& $db;
60 $this->nrows = oci_fetch_all( $stmt, $this->rows, 0, -1, OCI_FETCHSTATEMENT_BY_ROW | OCI_NUM );
61 if ( $this->nrows === false ) {
62 $e = oci_error( $stmt );
63 $db->reportQueryError( $e['message'], $e['code'], '', __METHOD__ );
64 $this->free();
66 return;
69 if ( $unique ) {
70 $this->rows = $this->array_unique_md( $this->rows );
71 $this->nrows = count( $this->rows );
74 if ( $this->nrows > 0 ) {
75 foreach ( $this->rows[0] as $k => $v ) {
76 $this->columns[$k] = strtolower( oci_field_name( $stmt, $k + 1 ) );
80 $this->cursor = 0;
81 oci_free_statement( $stmt );
84 public function free() {
85 unset( $this->db );
88 public function seek( $row ) {
89 $this->cursor = min( $row, $this->nrows );
92 public function numRows() {
93 return $this->nrows;
96 public function numFields() {
97 return count( $this->columns );
100 public function fetchObject() {
101 if ( $this->cursor >= $this->nrows ) {
102 return false;
104 $row = $this->rows[$this->cursor++];
105 $ret = new stdClass();
106 foreach ( $row as $k => $v ) {
107 $lc = $this->columns[$k];
108 $ret->$lc = $v;
111 return $ret;
114 public function fetchRow() {
115 if ( $this->cursor >= $this->nrows ) {
116 return false;
119 $row = $this->rows[$this->cursor++];
120 $ret = array();
121 foreach ( $row as $k => $v ) {
122 $lc = $this->columns[$k];
123 $ret[$lc] = $v;
124 $ret[$k] = $v;
127 return $ret;
132 * Utility class.
133 * @ingroup Database
135 class ORAField implements Field {
136 private $name, $tablename, $default, $max_length, $nullable,
137 $is_pk, $is_unique, $is_multiple, $is_key, $type;
139 function __construct( $info ) {
140 $this->name = $info['column_name'];
141 $this->tablename = $info['table_name'];
142 $this->default = $info['data_default'];
143 $this->max_length = $info['data_length'];
144 $this->nullable = $info['not_null'];
145 $this->is_pk = isset( $info['prim'] ) && $info['prim'] == 1 ? 1 : 0;
146 $this->is_unique = isset( $info['uniq'] ) && $info['uniq'] == 1 ? 1 : 0;
147 $this->is_multiple = isset( $info['nonuniq'] ) && $info['nonuniq'] == 1 ? 1 : 0;
148 $this->is_key = ( $this->is_pk || $this->is_unique || $this->is_multiple );
149 $this->type = $info['data_type'];
152 function name() {
153 return $this->name;
156 function tableName() {
157 return $this->tablename;
160 function defaultValue() {
161 return $this->default;
164 function maxLength() {
165 return $this->max_length;
168 function isNullable() {
169 return $this->nullable;
172 function isKey() {
173 return $this->is_key;
176 function isMultipleKey() {
177 return $this->is_multiple;
180 function type() {
181 return $this->type;
186 * @ingroup Database
188 class DatabaseOracle extends DatabaseBase {
189 /** @var resource */
190 protected $mLastResult = null;
192 /** @var int The number of rows affected as an integer */
193 protected $mAffectedRows;
195 /** @var int */
196 private $mInsertId = null;
198 /** @var bool */
199 private $ignoreDupValOnIndex = false;
201 /** @var bool|array */
202 private $sequenceData = null;
204 /** @var string Character set for Oracle database */
205 private $defaultCharset = 'AL32UTF8';
207 /** @var array */
208 private $mFieldInfoCache = array();
210 function __construct( $p = null ) {
211 global $wgDBprefix;
213 if ( !is_array( $p ) ) { // legacy calling pattern
214 wfDeprecated( __METHOD__ . " method called without parameter array.", "1.22" );
215 $args = func_get_args();
216 $p = array(
217 'host' => isset( $args[0] ) ? $args[0] : false,
218 'user' => isset( $args[1] ) ? $args[1] : false,
219 'password' => isset( $args[2] ) ? $args[2] : false,
220 'dbname' => isset( $args[3] ) ? $args[3] : false,
221 'flags' => isset( $args[4] ) ? $args[4] : 0,
222 'tablePrefix' => isset( $args[5] ) ? $args[5] : 'get from global',
223 'schema' => 'get from global',
224 'foreign' => isset( $args[6] ) ? $args[6] : false
227 if ( $p['tablePrefix'] == 'get from global' ) {
228 $p['tablePrefix'] = $wgDBprefix;
230 $p['tablePrefix'] = strtoupper( $p['tablePrefix'] );
231 parent::__construct( $p );
232 Hooks::run( 'DatabaseOraclePostInit', array( $this ) );
235 function __destruct() {
236 if ( $this->mOpened ) {
237 wfSuppressWarnings();
238 $this->close();
239 wfRestoreWarnings();
243 function getType() {
244 return 'oracle';
247 function cascadingDeletes() {
248 return true;
251 function cleanupTriggers() {
252 return true;
255 function strictIPs() {
256 return true;
259 function realTimestamps() {
260 return true;
263 function implicitGroupby() {
264 return false;
267 function implicitOrderby() {
268 return false;
271 function searchableIPs() {
272 return true;
276 * Usually aborts on failure
277 * @param string $server
278 * @param string $user
279 * @param string $password
280 * @param string $dbName
281 * @throws DBConnectionError
282 * @return DatabaseBase|null
284 function open( $server, $user, $password, $dbName ) {
285 global $wgDBOracleDRCP;
286 if ( !function_exists( 'oci_connect' ) ) {
287 throw new DBConnectionError(
288 $this,
289 "Oracle functions missing, have you compiled PHP with the --with-oci8 option?\n " .
290 "(Note: if you recently installed PHP, you may need to restart your webserver\n " .
291 "and database)\n" );
294 $this->close();
295 $this->mUser = $user;
296 $this->mPassword = $password;
297 // changed internal variables functions
298 // mServer now holds the TNS endpoint
299 // mDBname is schema name if different from username
300 if ( !$server ) {
301 // backward compatibillity (server used to be null and TNS was supplied in dbname)
302 $this->mServer = $dbName;
303 $this->mDBname = $user;
304 } else {
305 $this->mServer = $server;
306 if ( !$dbName ) {
307 $this->mDBname = $user;
308 } else {
309 $this->mDBname = $dbName;
313 if ( !strlen( $user ) ) { # e.g. the class is being loaded
314 return null;
317 if ( $wgDBOracleDRCP ) {
318 $this->setFlag( DBO_PERSISTENT );
321 $session_mode = $this->mFlags & DBO_SYSDBA ? OCI_SYSDBA : OCI_DEFAULT;
323 wfSuppressWarnings();
324 if ( $this->mFlags & DBO_PERSISTENT ) {
325 $this->mConn = oci_pconnect(
326 $this->mUser,
327 $this->mPassword,
328 $this->mServer,
329 $this->defaultCharset,
330 $session_mode
332 } elseif ( $this->mFlags & DBO_DEFAULT ) {
333 $this->mConn = oci_new_connect(
334 $this->mUser,
335 $this->mPassword,
336 $this->mServer,
337 $this->defaultCharset,
338 $session_mode
340 } else {
341 $this->mConn = oci_connect(
342 $this->mUser,
343 $this->mPassword,
344 $this->mServer,
345 $this->defaultCharset,
346 $session_mode
349 wfRestoreWarnings();
351 if ( $this->mUser != $this->mDBname ) {
352 //change current schema in session
353 $this->selectDB( $this->mDBname );
356 if ( !$this->mConn ) {
357 throw new DBConnectionError( $this, $this->lastError() );
360 $this->mOpened = true;
362 # removed putenv calls because they interfere with the system globaly
363 $this->doQuery( 'ALTER SESSION SET NLS_TIMESTAMP_FORMAT=\'DD-MM-YYYY HH24:MI:SS.FF6\'' );
364 $this->doQuery( 'ALTER SESSION SET NLS_TIMESTAMP_TZ_FORMAT=\'DD-MM-YYYY HH24:MI:SS.FF6\'' );
365 $this->doQuery( 'ALTER SESSION SET NLS_NUMERIC_CHARACTERS=\'.,\'' );
367 return $this->mConn;
371 * Closes a database connection, if it is open
372 * Returns success, true if already closed
373 * @return bool
375 protected function closeConnection() {
376 return oci_close( $this->mConn );
379 function execFlags() {
380 return $this->mTrxLevel ? OCI_NO_AUTO_COMMIT : OCI_COMMIT_ON_SUCCESS;
383 protected function doQuery( $sql ) {
384 wfDebug( "SQL: [$sql]\n" );
385 if ( !StringUtils::isUtf8( $sql ) ) {
386 throw new MWException( "SQL encoding is invalid\n$sql" );
389 // handle some oracle specifics
390 // remove AS column/table/subquery namings
391 if ( !$this->getFlag( DBO_DDLMODE ) ) {
392 $sql = preg_replace( '/ as /i', ' ', $sql );
395 // Oracle has issues with UNION clause if the statement includes LOB fields
396 // So we do a UNION ALL and then filter the results array with array_unique
397 $union_unique = ( preg_match( '/\/\* UNION_UNIQUE \*\/ /', $sql ) != 0 );
398 // EXPLAIN syntax in Oracle is EXPLAIN PLAN FOR and it return nothing
399 // you have to select data from plan table after explain
400 $explain_id = MWTimestamp::getLocalInstance()->format( 'dmYHis' );
402 $sql = preg_replace(
403 '/^EXPLAIN /',
404 'EXPLAIN PLAN SET STATEMENT_ID = \'' . $explain_id . '\' FOR',
405 $sql,
407 $explain_count
410 wfSuppressWarnings();
412 if ( ( $this->mLastResult = $stmt = oci_parse( $this->mConn, $sql ) ) === false ) {
413 $e = oci_error( $this->mConn );
414 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
416 return false;
419 if ( !oci_execute( $stmt, $this->execFlags() ) ) {
420 $e = oci_error( $stmt );
421 if ( !$this->ignoreDupValOnIndex || $e['code'] != '1' ) {
422 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
424 return false;
428 wfRestoreWarnings();
430 if ( $explain_count > 0 ) {
431 return $this->doQuery( 'SELECT id, cardinality "ROWS" FROM plan_table ' .
432 'WHERE statement_id = \'' . $explain_id . '\'' );
433 } elseif ( oci_statement_type( $stmt ) == 'SELECT' ) {
434 return new ORAResult( $this, $stmt, $union_unique );
435 } else {
436 $this->mAffectedRows = oci_num_rows( $stmt );
438 return true;
442 function queryIgnore( $sql, $fname = '' ) {
443 return $this->query( $sql, $fname, true );
447 * Frees resources associated with the LOB descriptor
448 * @param ResultWrapper|resource $res
450 function freeResult( $res ) {
451 if ( $res instanceof ResultWrapper ) {
452 $res = $res->result;
455 $res->free();
459 * @param ResultWrapper|stdClass $res
460 * @return mixed
462 function fetchObject( $res ) {
463 if ( $res instanceof ResultWrapper ) {
464 $res = $res->result;
467 return $res->fetchObject();
470 function fetchRow( $res ) {
471 if ( $res instanceof ResultWrapper ) {
472 $res = $res->result;
475 return $res->fetchRow();
478 function numRows( $res ) {
479 if ( $res instanceof ResultWrapper ) {
480 $res = $res->result;
483 return $res->numRows();
486 function numFields( $res ) {
487 if ( $res instanceof ResultWrapper ) {
488 $res = $res->result;
491 return $res->numFields();
494 function fieldName( $stmt, $n ) {
495 return oci_field_name( $stmt, $n );
499 * This must be called after nextSequenceVal
500 * @return null|int
502 function insertId() {
503 return $this->mInsertId;
507 * @param mixed $res
508 * @param int $row
510 function dataSeek( $res, $row ) {
511 if ( $res instanceof ORAResult ) {
512 $res->seek( $row );
513 } else {
514 $res->result->seek( $row );
518 function lastError() {
519 if ( $this->mConn === false ) {
520 $e = oci_error();
521 } else {
522 $e = oci_error( $this->mConn );
525 return $e['message'];
528 function lastErrno() {
529 if ( $this->mConn === false ) {
530 $e = oci_error();
531 } else {
532 $e = oci_error( $this->mConn );
535 return $e['code'];
538 function affectedRows() {
539 return $this->mAffectedRows;
543 * Returns information about an index
544 * If errors are explicitly ignored, returns NULL on failure
545 * @param string $table
546 * @param string $index
547 * @param string $fname
548 * @return bool
550 function indexInfo( $table, $index, $fname = __METHOD__ ) {
551 return false;
554 function indexUnique( $table, $index, $fname = __METHOD__ ) {
555 return false;
558 function insert( $table, $a, $fname = __METHOD__, $options = array() ) {
559 if ( !count( $a ) ) {
560 return true;
563 if ( !is_array( $options ) ) {
564 $options = array( $options );
567 if ( in_array( 'IGNORE', $options ) ) {
568 $this->ignoreDupValOnIndex = true;
571 if ( !is_array( reset( $a ) ) ) {
572 $a = array( $a );
575 foreach ( $a as &$row ) {
576 $this->insertOneRow( $table, $row, $fname );
578 $retVal = true;
580 if ( in_array( 'IGNORE', $options ) ) {
581 $this->ignoreDupValOnIndex = false;
584 return $retVal;
587 private function fieldBindStatement( $table, $col, &$val, $includeCol = false ) {
588 $col_info = $this->fieldInfoMulti( $table, $col );
589 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
591 $bind = '';
592 if ( is_numeric( $col ) ) {
593 $bind = $val;
594 $val = null;
596 return $bind;
597 } elseif ( $includeCol ) {
598 $bind = "$col = ";
601 if ( $val == '' && $val !== 0 && $col_type != 'BLOB' && $col_type != 'CLOB' ) {
602 $val = null;
605 if ( $val === 'NULL' ) {
606 $val = null;
609 if ( $val === null ) {
610 if ( $col_info != false && $col_info->isNullable() == 0 && $col_info->defaultValue() != null ) {
611 $bind .= 'DEFAULT';
612 } else {
613 $bind .= 'NULL';
615 } else {
616 $bind .= ':' . $col;
619 return $bind;
623 * @param string $table
624 * @param array $row
625 * @param string $fname
626 * @return bool
627 * @throws DBUnexpectedError
629 private function insertOneRow( $table, $row, $fname ) {
630 global $wgContLang;
632 $table = $this->tableName( $table );
633 // "INSERT INTO tables (a, b, c)"
634 $sql = "INSERT INTO " . $table . " (" . join( ',', array_keys( $row ) ) . ')';
635 $sql .= " VALUES (";
637 // for each value, append ":key"
638 $first = true;
639 foreach ( $row as $col => &$val ) {
640 if ( !$first ) {
641 $sql .= ', ';
642 } else {
643 $first = false;
645 if ( $this->isQuotedIdentifier( $val ) ) {
646 $sql .= $this->removeIdentifierQuotes( $val );
647 unset( $row[$col] );
648 } else {
649 $sql .= $this->fieldBindStatement( $table, $col, $val );
652 $sql .= ')';
654 if ( ( $this->mLastResult = $stmt = oci_parse( $this->mConn, $sql ) ) === false ) {
655 $e = oci_error( $this->mConn );
656 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
658 return false;
660 foreach ( $row as $col => &$val ) {
661 $col_info = $this->fieldInfoMulti( $table, $col );
662 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
664 if ( $val === null ) {
665 // do nothing ... null was inserted in statement creation
666 } elseif ( $col_type != 'BLOB' && $col_type != 'CLOB' ) {
667 if ( is_object( $val ) ) {
668 $val = $val->fetch();
671 // backward compatibility
672 if ( preg_match( '/^timestamp.*/i', $col_type ) == 1 && strtolower( $val ) == 'infinity' ) {
673 $val = $this->getInfinity();
676 $val = ( $wgContLang != null ) ? $wgContLang->checkTitleEncoding( $val ) : $val;
677 if ( oci_bind_by_name( $stmt, ":$col", $val, -1, SQLT_CHR ) === false ) {
678 $e = oci_error( $stmt );
679 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
681 return false;
683 } else {
684 /** @var OCI_Lob[] $lob */
685 if ( ( $lob[$col] = oci_new_descriptor( $this->mConn, OCI_D_LOB ) ) === false ) {
686 $e = oci_error( $stmt );
687 throw new DBUnexpectedError( $this, "Cannot create LOB descriptor: " . $e['message'] );
690 if ( is_object( $val ) ) {
691 $val = $val->fetch();
694 if ( $col_type == 'BLOB' ) {
695 $lob[$col]->writeTemporary( $val, OCI_TEMP_BLOB );
696 oci_bind_by_name( $stmt, ":$col", $lob[$col], -1, OCI_B_BLOB );
697 } else {
698 $lob[$col]->writeTemporary( $val, OCI_TEMP_CLOB );
699 oci_bind_by_name( $stmt, ":$col", $lob[$col], -1, OCI_B_CLOB );
704 wfSuppressWarnings();
706 if ( oci_execute( $stmt, $this->execFlags() ) === false ) {
707 $e = oci_error( $stmt );
708 if ( !$this->ignoreDupValOnIndex || $e['code'] != '1' ) {
709 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
711 return false;
712 } else {
713 $this->mAffectedRows = oci_num_rows( $stmt );
715 } else {
716 $this->mAffectedRows = oci_num_rows( $stmt );
719 wfRestoreWarnings();
721 if ( isset( $lob ) ) {
722 foreach ( $lob as $lob_v ) {
723 $lob_v->free();
727 if ( !$this->mTrxLevel ) {
728 oci_commit( $this->mConn );
731 return oci_free_statement( $stmt );
734 function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = __METHOD__,
735 $insertOptions = array(), $selectOptions = array()
737 $destTable = $this->tableName( $destTable );
738 if ( !is_array( $selectOptions ) ) {
739 $selectOptions = array( $selectOptions );
741 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
742 if ( is_array( $srcTable ) ) {
743 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
744 } else {
745 $srcTable = $this->tableName( $srcTable );
748 if ( ( $sequenceData = $this->getSequenceData( $destTable ) ) !== false &&
749 !isset( $varMap[$sequenceData['column']] )
751 $varMap[$sequenceData['column']] = 'GET_SEQUENCE_VALUE(\'' . $sequenceData['sequence'] . '\')';
754 // count-alias subselect fields to avoid abigious definition errors
755 $i = 0;
756 foreach ( $varMap as &$val ) {
757 $val = $val . ' field' . ( $i++ );
760 $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
761 " SELECT $startOpts " . implode( ',', $varMap ) .
762 " FROM $srcTable $useIndex ";
763 if ( $conds != '*' ) {
764 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
766 $sql .= " $tailOpts";
768 if ( in_array( 'IGNORE', $insertOptions ) ) {
769 $this->ignoreDupValOnIndex = true;
772 $retval = $this->query( $sql, $fname );
774 if ( in_array( 'IGNORE', $insertOptions ) ) {
775 $this->ignoreDupValOnIndex = false;
778 return $retval;
781 public function upsert( $table, array $rows, array $uniqueIndexes, array $set,
782 $fname = __METHOD__
784 if ( !count( $rows ) ) {
785 return true; // nothing to do
788 if ( !is_array( reset( $rows ) ) ) {
789 $rows = array( $rows );
792 $sequenceData = $this->getSequenceData( $table );
793 if ( $sequenceData !== false ) {
794 // add sequence column to each list of columns, when not set
795 foreach ( $rows as &$row ) {
796 if ( !isset( $row[$sequenceData['column']] ) ) {
797 $row[$sequenceData['column']] =
798 $this->addIdentifierQuotes( 'GET_SEQUENCE_VALUE(\'' .
799 $sequenceData['sequence'] . '\')' );
804 return parent::upsert( $table, $rows, $uniqueIndexes, $set, $fname );
807 function tableName( $name, $format = 'quoted' ) {
809 Replace reserved words with better ones
810 Using uppercase because that's the only way Oracle can handle
811 quoted tablenames
813 switch ( $name ) {
814 case 'user':
815 $name = 'MWUSER';
816 break;
817 case 'text':
818 $name = 'PAGECONTENT';
819 break;
822 return strtoupper( parent::tableName( $name, $format ) );
825 function tableNameInternal( $name ) {
826 $name = $this->tableName( $name );
828 return preg_replace( '/.*\.(.*)/', '$1', $name );
832 * Return the next in a sequence, save the value for retrieval via insertId()
834 * @param string $seqName
835 * @return null|int
837 function nextSequenceValue( $seqName ) {
838 $res = $this->query( "SELECT $seqName.nextval FROM dual" );
839 $row = $this->fetchRow( $res );
840 $this->mInsertId = $row[0];
842 return $this->mInsertId;
846 * Return sequence_name if table has a sequence
848 * @param string $table
849 * @return bool
851 private function getSequenceData( $table ) {
852 if ( $this->sequenceData == null ) {
853 $result = $this->doQuery( "SELECT lower(asq.sequence_name),
854 lower(atc.table_name),
855 lower(atc.column_name)
856 FROM all_sequences asq, all_tab_columns atc
857 WHERE decode(
858 atc.table_name,
859 '{$this->mTablePrefix}MWUSER',
860 '{$this->mTablePrefix}USER',
861 atc.table_name
862 ) || '_' ||
863 atc.column_name || '_SEQ' = '{$this->mTablePrefix}' || asq.sequence_name
864 AND asq.sequence_owner = upper('{$this->mDBname}')
865 AND atc.owner = upper('{$this->mDBname}')" );
867 while ( ( $row = $result->fetchRow() ) !== false ) {
868 $this->sequenceData[$row[1]] = array(
869 'sequence' => $row[0],
870 'column' => $row[2]
874 $table = strtolower( $this->removeIdentifierQuotes( $this->tableName( $table ) ) );
876 return ( isset( $this->sequenceData[$table] ) ) ? $this->sequenceData[$table] : false;
880 * Returns the size of a text field, or -1 for "unlimited"
882 * @param string $table
883 * @param string $field
884 * @return mixed
886 function textFieldSize( $table, $field ) {
887 $fieldInfoData = $this->fieldInfo( $table, $field );
889 return $fieldInfoData->maxLength();
892 function limitResult( $sql, $limit, $offset = false ) {
893 if ( $offset === false ) {
894 $offset = 0;
897 return "SELECT * FROM ($sql) WHERE rownum >= (1 + $offset) AND rownum < (1 + $limit + $offset)";
900 function encodeBlob( $b ) {
901 return new Blob( $b );
904 function decodeBlob( $b ) {
905 if ( $b instanceof Blob ) {
906 $b = $b->fetch();
909 return $b;
912 function unionQueries( $sqls, $all ) {
913 $glue = ' UNION ALL ';
915 return 'SELECT * ' . ( $all ? '' : '/* UNION_UNIQUE */ ' ) .
916 'FROM (' . implode( $glue, $sqls ) . ')';
919 function wasDeadlock() {
920 return $this->lastErrno() == 'OCI-00060';
923 function duplicateTableStructure( $oldName, $newName, $temporary = false,
924 $fname = __METHOD__
926 $temporary = $temporary ? 'TRUE' : 'FALSE';
928 $newName = strtoupper( $newName );
929 $oldName = strtoupper( $oldName );
931 $tabName = substr( $newName, strlen( $this->mTablePrefix ) );
932 $oldPrefix = substr( $oldName, 0, strlen( $oldName ) - strlen( $tabName ) );
933 $newPrefix = strtoupper( $this->mTablePrefix );
935 return $this->doQuery( "BEGIN DUPLICATE_TABLE( '$tabName', " .
936 "'$oldPrefix', '$newPrefix', $temporary ); END;" );
939 function listTables( $prefix = null, $fname = __METHOD__ ) {
940 $listWhere = '';
941 if ( !empty( $prefix ) ) {
942 $listWhere = ' AND table_name LIKE \'' . strtoupper( $prefix ) . '%\'';
945 $owner = strtoupper( $this->mDBname );
946 $result = $this->doQuery( "SELECT table_name FROM all_tables " .
947 "WHERE owner='$owner' AND table_name NOT LIKE '%!_IDX\$_' ESCAPE '!' $listWhere" );
949 // dirty code ... i know
950 $endArray = array();
951 $endArray[] = strtoupper( $prefix . 'MWUSER' );
952 $endArray[] = strtoupper( $prefix . 'PAGE' );
953 $endArray[] = strtoupper( $prefix . 'IMAGE' );
954 $fixedOrderTabs = $endArray;
955 while ( ( $row = $result->fetchRow() ) !== false ) {
956 if ( !in_array( $row['table_name'], $fixedOrderTabs ) ) {
957 $endArray[] = $row['table_name'];
961 return $endArray;
964 public function dropTable( $tableName, $fName = __METHOD__ ) {
965 $tableName = $this->tableName( $tableName );
966 if ( !$this->tableExists( $tableName ) ) {
967 return false;
970 return $this->doQuery( "DROP TABLE $tableName CASCADE CONSTRAINTS PURGE" );
973 function timestamp( $ts = 0 ) {
974 return wfTimestamp( TS_ORACLE, $ts );
978 * Return aggregated value function call
980 * @param array $valuedata
981 * @param string $valuename
982 * @return mixed
984 public function aggregateValue( $valuedata, $valuename = 'value' ) {
985 return $valuedata;
988 function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
989 # Ignore errors during error handling to avoid infinite
990 # recursion
991 $ignore = $this->ignoreErrors( true );
992 ++$this->mErrorCount;
994 if ( $ignore || $tempIgnore ) {
995 wfDebug( "SQL ERROR (ignored): $error\n" );
996 $this->ignoreErrors( $ignore );
997 } else {
998 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
1003 * @return string Wikitext of a link to the server software's web site
1005 public function getSoftwareLink() {
1006 return '[{{int:version-db-oracle-url}} Oracle]';
1010 * @return string Version information from the database
1012 function getServerVersion() {
1013 //better version number, fallback on driver
1014 $rset = $this->doQuery(
1015 'SELECT version FROM product_component_version ' .
1016 'WHERE UPPER(product) LIKE \'ORACLE DATABASE%\''
1018 if ( !( $row = $rset->fetchRow() ) ) {
1019 return oci_server_version( $this->mConn );
1022 return $row['version'];
1026 * Query whether a given index exists
1027 * @param string $table
1028 * @param string $index
1029 * @param string $fname
1030 * @return bool
1032 function indexExists( $table, $index, $fname = __METHOD__ ) {
1033 $table = $this->tableName( $table );
1034 $table = strtoupper( $this->removeIdentifierQuotes( $table ) );
1035 $index = strtoupper( $index );
1036 $owner = strtoupper( $this->mDBname );
1037 $sql = "SELECT 1 FROM all_indexes WHERE owner='$owner' AND index_name='{$table}_{$index}'";
1038 $res = $this->doQuery( $sql );
1039 if ( $res ) {
1040 $count = $res->numRows();
1041 $res->free();
1042 } else {
1043 $count = 0;
1046 return $count != 0;
1050 * Query whether a given table exists (in the given schema, or the default mw one if not given)
1051 * @param string $table
1052 * @param string $fname
1053 * @return bool
1055 function tableExists( $table, $fname = __METHOD__ ) {
1056 $table = $this->tableName( $table );
1057 $table = $this->addQuotes( strtoupper( $this->removeIdentifierQuotes( $table ) ) );
1058 $owner = $this->addQuotes( strtoupper( $this->mDBname ) );
1059 $sql = "SELECT 1 FROM all_tables WHERE owner=$owner AND table_name=$table";
1060 $res = $this->doQuery( $sql );
1061 if ( $res && $res->numRows() > 0 ) {
1062 $exists = true;
1063 } else {
1064 $exists = false;
1067 $res->free();
1069 return $exists;
1073 * Function translates mysql_fetch_field() functionality on ORACLE.
1074 * Caching is present for reducing query time.
1075 * For internal calls. Use fieldInfo for normal usage.
1076 * Returns false if the field doesn't exist
1078 * @param array|string $table
1079 * @param string $field
1080 * @return ORAField|ORAResult
1082 private function fieldInfoMulti( $table, $field ) {
1083 $field = strtoupper( $field );
1084 if ( is_array( $table ) ) {
1085 $table = array_map( array( &$this, 'tableNameInternal' ), $table );
1086 $tableWhere = 'IN (';
1087 foreach ( $table as &$singleTable ) {
1088 $singleTable = $this->removeIdentifierQuotes( $singleTable );
1089 if ( isset( $this->mFieldInfoCache["$singleTable.$field"] ) ) {
1090 return $this->mFieldInfoCache["$singleTable.$field"];
1092 $tableWhere .= '\'' . $singleTable . '\',';
1094 $tableWhere = rtrim( $tableWhere, ',' ) . ')';
1095 } else {
1096 $table = $this->removeIdentifierQuotes( $this->tableNameInternal( $table ) );
1097 if ( isset( $this->mFieldInfoCache["$table.$field"] ) ) {
1098 return $this->mFieldInfoCache["$table.$field"];
1100 $tableWhere = '= \'' . $table . '\'';
1103 $fieldInfoStmt = oci_parse(
1104 $this->mConn,
1105 'SELECT * FROM wiki_field_info_full WHERE table_name ' .
1106 $tableWhere . ' and column_name = \'' . $field . '\''
1108 if ( oci_execute( $fieldInfoStmt, $this->execFlags() ) === false ) {
1109 $e = oci_error( $fieldInfoStmt );
1110 $this->reportQueryError( $e['message'], $e['code'], 'fieldInfo QUERY', __METHOD__ );
1112 return false;
1114 $res = new ORAResult( $this, $fieldInfoStmt );
1115 if ( $res->numRows() == 0 ) {
1116 if ( is_array( $table ) ) {
1117 foreach ( $table as &$singleTable ) {
1118 $this->mFieldInfoCache["$singleTable.$field"] = false;
1120 } else {
1121 $this->mFieldInfoCache["$table.$field"] = false;
1123 $fieldInfoTemp = null;
1124 } else {
1125 $fieldInfoTemp = new ORAField( $res->fetchRow() );
1126 $table = $fieldInfoTemp->tableName();
1127 $this->mFieldInfoCache["$table.$field"] = $fieldInfoTemp;
1129 $res->free();
1131 return $fieldInfoTemp;
1135 * @throws DBUnexpectedError
1136 * @param string $table
1137 * @param string $field
1138 * @return ORAField
1140 function fieldInfo( $table, $field ) {
1141 if ( is_array( $table ) ) {
1142 throw new DBUnexpectedError( $this, 'DatabaseOracle::fieldInfo called with table array!' );
1145 return $this->fieldInfoMulti( $table, $field );
1148 protected function doBegin( $fname = __METHOD__ ) {
1149 $this->mTrxLevel = 1;
1150 $this->doQuery( 'SET CONSTRAINTS ALL DEFERRED' );
1153 protected function doCommit( $fname = __METHOD__ ) {
1154 if ( $this->mTrxLevel ) {
1155 $ret = oci_commit( $this->mConn );
1156 if ( !$ret ) {
1157 throw new DBUnexpectedError( $this, $this->lastError() );
1159 $this->mTrxLevel = 0;
1160 $this->doQuery( 'SET CONSTRAINTS ALL IMMEDIATE' );
1164 protected function doRollback( $fname = __METHOD__ ) {
1165 if ( $this->mTrxLevel ) {
1166 oci_rollback( $this->mConn );
1167 $this->mTrxLevel = 0;
1168 $this->doQuery( 'SET CONSTRAINTS ALL IMMEDIATE' );
1173 * defines must comply with ^define\s*([^\s=]*)\s*=\s?'\{\$([^\}]*)\}';
1175 * @param resource $fp
1176 * @param bool|string $lineCallback
1177 * @param bool|callable $resultCallback
1178 * @param string $fname
1179 * @param bool|callable $inputCallback
1180 * @return bool|string
1182 function sourceStream( $fp, $lineCallback = false, $resultCallback = false,
1183 $fname = __METHOD__, $inputCallback = false ) {
1184 $cmd = '';
1185 $done = false;
1186 $dollarquote = false;
1188 $replacements = array();
1190 while ( !feof( $fp ) ) {
1191 if ( $lineCallback ) {
1192 call_user_func( $lineCallback );
1194 $line = trim( fgets( $fp, 1024 ) );
1195 $sl = strlen( $line ) - 1;
1197 if ( $sl < 0 ) {
1198 continue;
1200 if ( '-' == $line[0] && '-' == $line[1] ) {
1201 continue;
1204 // Allow dollar quoting for function declarations
1205 if ( substr( $line, 0, 8 ) == '/*$mw$*/' ) {
1206 if ( $dollarquote ) {
1207 $dollarquote = false;
1208 $line = str_replace( '/*$mw$*/', '', $line ); // remove dollarquotes
1209 $done = true;
1210 } else {
1211 $dollarquote = true;
1213 } elseif ( !$dollarquote ) {
1214 if ( ';' == $line[$sl] && ( $sl < 2 || ';' != $line[$sl - 1] ) ) {
1215 $done = true;
1216 $line = substr( $line, 0, $sl );
1220 if ( $cmd != '' ) {
1221 $cmd .= ' ';
1223 $cmd .= "$line\n";
1225 if ( $done ) {
1226 $cmd = str_replace( ';;', ";", $cmd );
1227 if ( strtolower( substr( $cmd, 0, 6 ) ) == 'define' ) {
1228 if ( preg_match( '/^define\s*([^\s=]*)\s*=\s*\'\{\$([^\}]*)\}\'/', $cmd, $defines ) ) {
1229 $replacements[$defines[2]] = $defines[1];
1231 } else {
1232 foreach ( $replacements as $mwVar => $scVar ) {
1233 $cmd = str_replace( '&' . $scVar . '.', '`{$' . $mwVar . '}`', $cmd );
1236 $cmd = $this->replaceVars( $cmd );
1237 if ( $inputCallback ) {
1238 call_user_func( $inputCallback, $cmd );
1240 $res = $this->doQuery( $cmd );
1241 if ( $resultCallback ) {
1242 call_user_func( $resultCallback, $res, $this );
1245 if ( false === $res ) {
1246 $err = $this->lastError();
1248 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
1252 $cmd = '';
1253 $done = false;
1257 return true;
1260 function selectDB( $db ) {
1261 $this->mDBname = $db;
1262 if ( $db == null || $db == $this->mUser ) {
1263 return true;
1265 $sql = 'ALTER SESSION SET CURRENT_SCHEMA=' . strtoupper( $db );
1266 $stmt = oci_parse( $this->mConn, $sql );
1267 wfSuppressWarnings();
1268 $success = oci_execute( $stmt );
1269 wfRestoreWarnings();
1270 if ( !$success ) {
1271 $e = oci_error( $stmt );
1272 if ( $e['code'] != '1435' ) {
1273 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1276 return false;
1279 return true;
1282 function strencode( $s ) {
1283 return str_replace( "'", "''", $s );
1286 function addQuotes( $s ) {
1287 global $wgContLang;
1288 if ( isset( $wgContLang->mLoaded ) && $wgContLang->mLoaded ) {
1289 $s = $wgContLang->checkTitleEncoding( $s );
1292 return "'" . $this->strencode( $s ) . "'";
1295 public function addIdentifierQuotes( $s ) {
1296 if ( !$this->getFlag( DBO_DDLMODE ) ) {
1297 $s = '/*Q*/' . $s;
1300 return $s;
1303 public function removeIdentifierQuotes( $s ) {
1304 return strpos( $s, '/*Q*/' ) === false ? $s : substr( $s, 5 );
1307 public function isQuotedIdentifier( $s ) {
1308 return strpos( $s, '/*Q*/' ) !== false;
1311 private function wrapFieldForWhere( $table, &$col, &$val ) {
1312 global $wgContLang;
1314 $col_info = $this->fieldInfoMulti( $table, $col );
1315 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
1316 if ( $col_type == 'CLOB' ) {
1317 $col = 'TO_CHAR(' . $col . ')';
1318 $val = $wgContLang->checkTitleEncoding( $val );
1319 } elseif ( $col_type == 'VARCHAR2' ) {
1320 $val = $wgContLang->checkTitleEncoding( $val );
1324 private function wrapConditionsForWhere( $table, $conds, $parentCol = null ) {
1325 $conds2 = array();
1326 foreach ( $conds as $col => $val ) {
1327 if ( is_array( $val ) ) {
1328 $conds2[$col] = $this->wrapConditionsForWhere( $table, $val, $col );
1329 } else {
1330 if ( is_numeric( $col ) && $parentCol != null ) {
1331 $this->wrapFieldForWhere( $table, $parentCol, $val );
1332 } else {
1333 $this->wrapFieldForWhere( $table, $col, $val );
1335 $conds2[$col] = $val;
1339 return $conds2;
1342 function selectRow( $table, $vars, $conds, $fname = __METHOD__,
1343 $options = array(), $join_conds = array()
1345 if ( is_array( $conds ) ) {
1346 $conds = $this->wrapConditionsForWhere( $table, $conds );
1349 return parent::selectRow( $table, $vars, $conds, $fname, $options, $join_conds );
1353 * Returns an optional USE INDEX clause to go after the table, and a
1354 * string to go at the end of the query
1356 * @param array $options An associative array of options to be turned into
1357 * an SQL query, valid keys are listed in the function.
1358 * @return array
1360 function makeSelectOptions( $options ) {
1361 $preLimitTail = $postLimitTail = '';
1362 $startOpts = '';
1364 $noKeyOptions = array();
1365 foreach ( $options as $key => $option ) {
1366 if ( is_numeric( $key ) ) {
1367 $noKeyOptions[$option] = true;
1371 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1373 $preLimitTail .= $this->makeOrderBy( $options );
1375 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1376 $postLimitTail .= ' FOR UPDATE';
1379 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1380 $startOpts .= 'DISTINCT';
1383 if ( isset( $options['USE INDEX'] ) && !is_array( $options['USE INDEX'] ) ) {
1384 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1385 } else {
1386 $useIndex = '';
1389 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1392 public function delete( $table, $conds, $fname = __METHOD__ ) {
1393 if ( is_array( $conds ) ) {
1394 $conds = $this->wrapConditionsForWhere( $table, $conds );
1396 // a hack for deleting pages, users and images (which have non-nullable FKs)
1397 // all deletions on these tables have transactions so final failure rollbacks these updates
1398 $table = $this->tableName( $table );
1399 if ( $table == $this->tableName( 'user' ) ) {
1400 $this->update( 'archive', array( 'ar_user' => 0 ),
1401 array( 'ar_user' => $conds['user_id'] ), $fname );
1402 $this->update( 'ipblocks', array( 'ipb_user' => 0 ),
1403 array( 'ipb_user' => $conds['user_id'] ), $fname );
1404 $this->update( 'image', array( 'img_user' => 0 ),
1405 array( 'img_user' => $conds['user_id'] ), $fname );
1406 $this->update( 'oldimage', array( 'oi_user' => 0 ),
1407 array( 'oi_user' => $conds['user_id'] ), $fname );
1408 $this->update( 'filearchive', array( 'fa_deleted_user' => 0 ),
1409 array( 'fa_deleted_user' => $conds['user_id'] ), $fname );
1410 $this->update( 'filearchive', array( 'fa_user' => 0 ),
1411 array( 'fa_user' => $conds['user_id'] ), $fname );
1412 $this->update( 'uploadstash', array( 'us_user' => 0 ),
1413 array( 'us_user' => $conds['user_id'] ), $fname );
1414 $this->update( 'recentchanges', array( 'rc_user' => 0 ),
1415 array( 'rc_user' => $conds['user_id'] ), $fname );
1416 $this->update( 'logging', array( 'log_user' => 0 ),
1417 array( 'log_user' => $conds['user_id'] ), $fname );
1418 } elseif ( $table == $this->tableName( 'image' ) ) {
1419 $this->update( 'oldimage', array( 'oi_name' => 0 ),
1420 array( 'oi_name' => $conds['img_name'] ), $fname );
1423 return parent::delete( $table, $conds, $fname );
1427 * @param string $table
1428 * @param array $values
1429 * @param array $conds
1430 * @param string $fname
1431 * @param array $options
1432 * @return bool
1433 * @throws DBUnexpectedError
1435 function update( $table, $values, $conds, $fname = __METHOD__, $options = array() ) {
1436 global $wgContLang;
1438 $table = $this->tableName( $table );
1439 $opts = $this->makeUpdateOptions( $options );
1440 $sql = "UPDATE $opts $table SET ";
1442 $first = true;
1443 foreach ( $values as $col => &$val ) {
1444 $sqlSet = $this->fieldBindStatement( $table, $col, $val, true );
1446 if ( !$first ) {
1447 $sqlSet = ', ' . $sqlSet;
1448 } else {
1449 $first = false;
1451 $sql .= $sqlSet;
1454 if ( $conds !== array() && $conds !== '*' ) {
1455 $conds = $this->wrapConditionsForWhere( $table, $conds );
1456 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
1459 if ( ( $this->mLastResult = $stmt = oci_parse( $this->mConn, $sql ) ) === false ) {
1460 $e = oci_error( $this->mConn );
1461 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1463 return false;
1465 foreach ( $values as $col => &$val ) {
1466 $col_info = $this->fieldInfoMulti( $table, $col );
1467 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
1469 if ( $val === null ) {
1470 // do nothing ... null was inserted in statement creation
1471 } elseif ( $col_type != 'BLOB' && $col_type != 'CLOB' ) {
1472 if ( is_object( $val ) ) {
1473 $val = $val->getData();
1476 if ( preg_match( '/^timestamp.*/i', $col_type ) == 1 && strtolower( $val ) == 'infinity' ) {
1477 $val = '31-12-2030 12:00:00.000000';
1480 $val = ( $wgContLang != null ) ? $wgContLang->checkTitleEncoding( $val ) : $val;
1481 if ( oci_bind_by_name( $stmt, ":$col", $val ) === false ) {
1482 $e = oci_error( $stmt );
1483 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1485 return false;
1487 } else {
1488 /** @var OCI_Lob[] $lob */
1489 if ( ( $lob[$col] = oci_new_descriptor( $this->mConn, OCI_D_LOB ) ) === false ) {
1490 $e = oci_error( $stmt );
1491 throw new DBUnexpectedError( $this, "Cannot create LOB descriptor: " . $e['message'] );
1494 if ( is_object( $val ) ) {
1495 $val = $val->getData();
1498 if ( $col_type == 'BLOB' ) {
1499 $lob[$col]->writeTemporary( $val );
1500 oci_bind_by_name( $stmt, ":$col", $lob[$col], -1, SQLT_BLOB );
1501 } else {
1502 $lob[$col]->writeTemporary( $val );
1503 oci_bind_by_name( $stmt, ":$col", $lob[$col], -1, OCI_B_CLOB );
1508 wfSuppressWarnings();
1510 if ( oci_execute( $stmt, $this->execFlags() ) === false ) {
1511 $e = oci_error( $stmt );
1512 if ( !$this->ignoreDupValOnIndex || $e['code'] != '1' ) {
1513 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1515 return false;
1516 } else {
1517 $this->mAffectedRows = oci_num_rows( $stmt );
1519 } else {
1520 $this->mAffectedRows = oci_num_rows( $stmt );
1523 wfRestoreWarnings();
1525 if ( isset( $lob ) ) {
1526 foreach ( $lob as $lob_v ) {
1527 $lob_v->free();
1531 if ( !$this->mTrxLevel ) {
1532 oci_commit( $this->mConn );
1535 return oci_free_statement( $stmt );
1538 function bitNot( $field ) {
1539 // expecting bit-fields smaller than 4bytes
1540 return 'BITNOT(' . $field . ')';
1543 function bitAnd( $fieldLeft, $fieldRight ) {
1544 return 'BITAND(' . $fieldLeft . ', ' . $fieldRight . ')';
1547 function bitOr( $fieldLeft, $fieldRight ) {
1548 return 'BITOR(' . $fieldLeft . ', ' . $fieldRight . ')';
1551 function getDBname() {
1552 return $this->mDBname;
1555 function getServer() {
1556 return $this->mServer;
1559 public function buildGroupConcatField(
1560 $delim, $table, $field, $conds = '', $join_conds = array()
1562 $fld = "LISTAGG($field," . $this->addQuotes( $delim ) . ") WITHIN GROUP (ORDER BY $field)";
1564 return '(' . $this->selectSQLText( $table, $fld, $conds, null, array(), $join_conds ) . ')';
1567 public function getSearchEngine() {
1568 return 'SearchOracle';
1571 public function getInfinity() {
1572 return '31-12-2030 12:00:00.000000';