* fixed ipblocks.ipb_by_text field, removed default blank not null (fixed install...
[mediawiki.git] / includes / db / DatabaseOracle.php
blobfa7a86f3ae3cde7767b6101f986cbd92dee6f965
1 <?php
2 /**
3 * This is the Oracle database abstraction layer.
5 * @file
6 * @ingroup Database
7 */
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
15 class ORAResult {
16 private $rows;
17 private $cursor;
18 private $nrows;
20 private $columns = array();
22 private function array_unique_md( $array_in ) {
23 $array_out = array();
24 $array_hashes = array();
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;
34 return $array_out;
37 /**
38 * @param $db DatabaseBase
39 * @param $stmt
40 * @param bool $unique
42 function __construct( &$db, $stmt, $unique = false ) {
43 $this->db =& $db;
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;
52 if ( $unique ) {
53 $this->rows = $this->array_unique_md( $this->rows );
54 $this->nrows = count( $this->rows );
57 if ($this->nrows > 0) {
58 foreach ( $this->rows[0] as $k => $v ) {
59 $this->columns[$k] = strtolower( oci_field_name( $stmt, $k + 1 ) );
63 $this->cursor = 0;
64 oci_free_statement( $stmt );
67 public function free() {
68 unset($this->db);
71 public function seek( $row ) {
72 $this->cursor = min( $row, $this->nrows );
75 public function numRows() {
76 return $this->nrows;
79 public function numFields() {
80 return count($this->columns);
83 public function fetchObject() {
84 if ( $this->cursor >= $this->nrows ) {
85 return false;
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;
94 return $ret;
97 public function fetchRow() {
98 if ( $this->cursor >= $this->nrows ) {
99 return false;
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;
109 return $ret;
114 * Utility class.
115 * @ingroup Database
117 class ORAField implements Field {
118 private $name, $tablename, $default, $max_length, $nullable,
119 $is_pk, $is_unique, $is_multiple, $is_key, $type;
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'];
134 function name() {
135 return $this->name;
138 function tableName() {
139 return $this->tablename;
142 function defaultValue() {
143 return $this->default;
146 function maxLength() {
147 return $this->max_length;
150 function isNullable() {
151 return $this->nullable;
154 function isKey() {
155 return $this->is_key;
158 function isMultipleKey() {
159 return $this->is_multiple;
162 function type() {
163 return $this->type;
168 * @ingroup Database
170 class DatabaseOracle extends DatabaseBase {
171 var $mInsertId = null;
172 var $mLastResult = null;
173 var $lastResult = null;
174 var $cursor = 0;
175 var $mAffectedRows;
177 var $ignore_DUP_VAL_ON_INDEX = false;
178 var $sequenceData = null;
180 var $defaultCharset = 'AL32UTF8';
182 var $mFieldInfoCache = array();
184 function __construct( $server = false, $user = false, $password = false, $dbName = false,
185 $flags = 0, $tablePrefix = 'get from global' )
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 ) );
193 function __destruct() {
194 if ($this->mOpened) {
195 wfSuppressWarnings();
196 $this->close();
197 wfRestoreWarnings();
201 function getType() {
202 return 'oracle';
205 function cascadingDeletes() {
206 return true;
208 function cleanupTriggers() {
209 return true;
211 function strictIPs() {
212 return true;
214 function realTimestamps() {
215 return true;
217 function implicitGroupby() {
218 return false;
220 function implicitOrderby() {
221 return false;
223 function searchableIPs() {
224 return true;
228 * Usually aborts on failure
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" );
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;
254 if ( !strlen( $user ) ) { # e.g. the class is being loaded
255 return;
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 );
265 wfRestoreWarnings();
267 if ( $this->mUser != $this->mDBname ) {
268 //change current schema in session
269 $this->selectDB( $this->mDBname );
272 if ( !$this->mConn ) {
273 throw new DBConnectionError( $this, $this->lastError() );
276 $this->mOpened = true;
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;
286 * Closes a database connection, if it is open
287 * Returns success, true if already closed
289 function close() {
290 $this->mOpened = false;
291 if ( $this->mConn ) {
292 if ( $this->mTrxLevel ) {
293 $this->commit();
295 return oci_close( $this->mConn );
296 } else {
297 return true;
301 function execFlags() {
302 return $this->mTrxLevel ? OCI_NO_AUTO_COMMIT : OCI_COMMIT_ON_SUCCESS;
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" );
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 );
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' );
324 $sql = preg_replace( '/^EXPLAIN /', 'EXPLAIN PLAN SET STATEMENT_ID = \'' . $explain_id . '\' FOR', $sql, 1, $explain_count );
326 wfSuppressWarnings();
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;
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;
342 wfRestoreWarnings();
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;
354 function queryIgnore( $sql, $fname = '' ) {
355 return $this->query( $sql, $fname, true );
358 function freeResult( $res ) {
359 if ( $res instanceof ResultWrapper ) {
360 $res = $res->result;
363 $res->free();
366 function fetchObject( $res ) {
367 if ( $res instanceof ResultWrapper ) {
368 $res = $res->result;
371 return $res->fetchObject();
374 function fetchRow( $res ) {
375 if ( $res instanceof ResultWrapper ) {
376 $res = $res->result;
379 return $res->fetchRow();
382 function numRows( $res ) {
383 if ( $res instanceof ResultWrapper ) {
384 $res = $res->result;
387 return $res->numRows();
390 function numFields( $res ) {
391 if ( $res instanceof ResultWrapper ) {
392 $res = $res->result;
395 return $res->numFields();
398 function fieldName( $stmt, $n ) {
399 return oci_field_name( $stmt, $n );
403 * This must be called after nextSequenceVal
405 function insertId() {
406 return $this->mInsertId;
409 function dataSeek( $res, $row ) {
410 if ( $res instanceof ORAResult ) {
411 $res->seek( $row );
412 } else {
413 $res->result->seek( $row );
417 function lastError() {
418 if ( $this->mConn === false ) {
419 $e = oci_error();
420 } else {
421 $e = oci_error( $this->mConn );
423 return $e['message'];
426 function lastErrno() {
427 if ( $this->mConn === false ) {
428 $e = oci_error();
429 } else {
430 $e = oci_error( $this->mConn );
432 return $e['code'];
435 function affectedRows() {
436 return $this->mAffectedRows;
440 * Returns information about an index
441 * If errors are explicitly ignored, returns NULL on failure
443 function indexInfo( $table, $index, $fname = 'DatabaseOracle::indexExists' ) {
444 return false;
447 function indexUnique( $table, $index, $fname = 'DatabaseOracle::indexUnique' ) {
448 return false;
451 function insert( $table, $a, $fname = 'DatabaseOracle::insert', $options = array() ) {
452 if ( !count( $a ) ) {
453 return true;
456 if ( !is_array( $options ) ) {
457 $options = array( $options );
460 if ( in_array( 'IGNORE', $options ) ) {
461 $this->ignore_DUP_VAL_ON_INDEX = true;
464 if ( !is_array( reset( $a ) ) ) {
465 $a = array( $a );
468 foreach ( $a as &$row ) {
469 $this->insertOneRow( $table, $row, $fname );
471 $retVal = true;
473 if ( in_array( 'IGNORE', $options ) ) {
474 $this->ignore_DUP_VAL_ON_INDEX = false;
477 return $retVal;
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';
484 $bind = '';
485 if ( is_numeric( $col ) ) {
486 $bind = $val;
487 $val = null;
488 return $bind;
489 } elseif ( $includeCol ) {
490 $bind = "$col = ";
493 if ( $val == '' && $val !== 0 && $col_type != 'BLOB' && $col_type != 'CLOB' ) {
494 $val = null;
497 if ( $val === 'NULL' ) {
498 $val = null;
501 if ( $val === null ) {
502 if ( $col_info != false && $col_info->isNullable() == 0 && $col_info->defaultValue() != null ) {
503 $bind .= 'DEFAULT';
504 } else {
505 $bind .= 'NULL';
507 } else {
508 $bind .= ':' . $col;
511 return $bind;
514 private function insertOneRow( $table, $row, $fname ) {
515 global $wgContLang;
517 $table = $this->tableName( $table );
518 // "INSERT INTO tables (a, b, c)"
519 $sql = "INSERT INTO " . $table . " (" . join( ',', array_keys( $row ) ) . ')';
520 $sql .= " VALUES (";
522 // for each value, append ":key"
523 $first = true;
524 foreach ( $row as $col => &$val ) {
525 if ( !$first ) {
526 $sql .= ', ';
527 } else {
528 $first = false;
531 $sql .= $this->fieldBindStatement( $table, $col, $val );
533 $sql .= ')';
535 if ( ( $this->mLastResult = $stmt = oci_parse( $this->mConn, $sql ) ) === false ) {
536 $e = oci_error( $this->mConn );
537 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
538 return false;
540 foreach ( $row as $col => &$val ) {
541 $col_info = $this->fieldInfoMulti( $table, $col );
542 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
544 if ( $val === null ) {
545 // do nothing ... null was inserted in statement creation
546 } elseif ( $col_type != 'BLOB' && $col_type != 'CLOB' ) {
547 if ( is_object( $val ) ) {
548 $val = $val->fetch();
551 if ( preg_match( '/^timestamp.*/i', $col_type ) == 1 && strtolower( $val ) == 'infinity' ) {
552 $val = '31-12-2030 12:00:00.000000';
555 $val = ( $wgContLang != null ) ? $wgContLang->checkTitleEncoding( $val ) : $val;
556 if ( oci_bind_by_name( $stmt, ":$col", $val, -1, SQLT_CHR ) === false ) {
557 $e = oci_error( $stmt );
558 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
559 return false;
561 } else {
562 if ( ( $lob[$col] = oci_new_descriptor( $this->mConn, OCI_D_LOB ) ) === false ) {
563 $e = oci_error( $stmt );
564 throw new DBUnexpectedError( $this, "Cannot create LOB descriptor: " . $e['message'] );
567 if ( is_object( $val ) ) {
568 $val = $val->fetch();
571 if ( $col_type == 'BLOB' ) {
572 $lob[$col]->writeTemporary( $val, OCI_TEMP_BLOB );
573 oci_bind_by_name( $stmt, ":$col", $lob[$col], - 1, OCI_B_BLOB );
574 } else {
575 $lob[$col]->writeTemporary( $val, OCI_TEMP_CLOB );
576 oci_bind_by_name( $stmt, ":$col", $lob[$col], - 1, OCI_B_CLOB );
581 wfSuppressWarnings();
583 if ( oci_execute( $stmt, $this->execFlags() ) === false ) {
584 $e = oci_error( $stmt );
585 if ( !$this->ignore_DUP_VAL_ON_INDEX || $e['code'] != '1' ) {
586 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
587 return false;
588 } else {
589 $this->mAffectedRows = oci_num_rows( $stmt );
591 } else {
592 $this->mAffectedRows = oci_num_rows( $stmt );
595 wfRestoreWarnings();
597 if ( isset( $lob ) ) {
598 foreach ( $lob as $lob_v ) {
599 $lob_v->free();
603 if ( !$this->mTrxLevel ) {
604 oci_commit( $this->mConn );
607 oci_free_statement( $stmt );
610 function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabaseOracle::insertSelect',
611 $insertOptions = array(), $selectOptions = array() )
613 $destTable = $this->tableName( $destTable );
614 if ( !is_array( $selectOptions ) ) {
615 $selectOptions = array( $selectOptions );
617 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
618 if ( is_array( $srcTable ) ) {
619 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
620 } else {
621 $srcTable = $this->tableName( $srcTable );
624 if ( ( $sequenceData = $this->getSequenceData( $destTable ) ) !== false &&
625 !isset( $varMap[$sequenceData['column']] ) )
627 $varMap[$sequenceData['column']] = 'GET_SEQUENCE_VALUE(\'' . $sequenceData['sequence'] . '\')';
630 // count-alias subselect fields to avoid abigious definition errors
631 $i = 0;
632 foreach ( $varMap as &$val ) {
633 $val = $val . ' field' . ( $i++ );
636 $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
637 " SELECT $startOpts " . implode( ',', $varMap ) .
638 " FROM $srcTable $useIndex ";
639 if ( $conds != '*' ) {
640 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
642 $sql .= " $tailOpts";
644 if ( in_array( 'IGNORE', $insertOptions ) ) {
645 $this->ignore_DUP_VAL_ON_INDEX = true;
648 $retval = $this->query( $sql, $fname );
650 if ( in_array( 'IGNORE', $insertOptions ) ) {
651 $this->ignore_DUP_VAL_ON_INDEX = false;
654 return $retval;
657 function tableName( $name, $format = 'quoted' ) {
659 Replace reserved words with better ones
660 Using uppercase because that's the only way Oracle can handle
661 quoted tablenames
663 switch( $name ) {
664 case 'user':
665 $name = 'MWUSER';
666 break;
667 case 'text':
668 $name = 'PAGECONTENT';
669 break;
672 return parent::tableName( strtoupper( $name ), $format );
675 function tableNameInternal( $name ) {
676 $name = $this->tableName( $name );
677 return preg_replace( '/.*\.(.*)/', '$1', $name);
680 * Return the next in a sequence, save the value for retrieval via insertId()
682 function nextSequenceValue( $seqName ) {
683 $res = $this->query( "SELECT $seqName.nextval FROM dual" );
684 $row = $this->fetchRow( $res );
685 $this->mInsertId = $row[0];
686 return $this->mInsertId;
690 * Return sequence_name if table has a sequence
692 private function getSequenceData( $table ) {
693 if ( $this->sequenceData == null ) {
694 $result = $this->doQuery( "SELECT lower(asq.sequence_name),
695 lower(atc.table_name),
696 lower(atc.column_name)
697 FROM all_sequences asq, all_tab_columns atc
698 WHERE decode(atc.table_name, '{$this->mTablePrefix}MWUSER', '{$this->mTablePrefix}USER', atc.table_name) || '_' ||
699 atc.column_name || '_SEQ' = '{$this->mTablePrefix}' || asq.sequence_name
700 AND asq.sequence_owner = upper('{$this->mDBname}')
701 AND atc.owner = upper('{$this->mDBname}')" );
703 while ( ( $row = $result->fetchRow() ) !== false ) {
704 $this->sequenceData[$row[1]] = array(
705 'sequence' => $row[0],
706 'column' => $row[2]
710 $table = strtolower( $this->removeIdentifierQuotes( $this->tableName( $table ) ) );
711 return ( isset( $this->sequenceData[$table] ) ) ? $this->sequenceData[$table] : false;
714 # Returns the size of a text field, or -1 for "unlimited"
715 function textFieldSize( $table, $field ) {
716 $fieldInfoData = $this->fieldInfo( $table, $field );
717 return $fieldInfoData->maxLength();
720 function limitResult( $sql, $limit, $offset = false ) {
721 if ( $offset === false ) {
722 $offset = 0;
724 return "SELECT * FROM ($sql) WHERE rownum >= (1 + $offset) AND rownum < (1 + $limit + $offset)";
727 function encodeBlob( $b ) {
728 return new Blob( $b );
731 function decodeBlob( $b ) {
732 if ( $b instanceof Blob ) {
733 $b = $b->fetch();
735 return $b;
738 function unionQueries( $sqls, $all ) {
739 $glue = ' UNION ALL ';
740 return 'SELECT * ' . ( $all ? '':'/* UNION_UNIQUE */ ' ) . 'FROM (' . implode( $glue, $sqls ) . ')' ;
743 function wasDeadlock() {
744 return $this->lastErrno() == 'OCI-00060';
747 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'DatabaseOracle::duplicateTableStructure' ) {
748 $temporary = $temporary ? 'TRUE' : 'FALSE';
750 $newName = strtoupper( $newName );
751 $oldName = strtoupper( $oldName );
753 $tabName = substr( $newName, strlen( $this->mTablePrefix ) );
754 $oldPrefix = substr( $oldName, 0, strlen( $oldName ) - strlen( $tabName ) );
755 $newPrefix = strtoupper( $this->mTablePrefix );
757 return $this->doQuery( "BEGIN DUPLICATE_TABLE( '$tabName', '$oldPrefix', '$newPrefix', $temporary ); END;" );
760 function listTables( $prefix = null, $fname = 'DatabaseOracle::listTables' ) {
761 $listWhere = '';
762 if (!empty($prefix)) {
763 $listWhere = ' AND table_name LIKE \''.strtoupper($prefix).'%\'';
766 $owner = strtoupper( $this->mDBname );
767 $result = $this->doQuery( "SELECT table_name FROM all_tables WHERE owner='$owner' AND table_name NOT LIKE '%!_IDX\$_' ESCAPE '!' $listWhere" );
769 // dirty code ... i know
770 $endArray = array();
771 $endArray[] = $prefix.'MWUSER';
772 $endArray[] = $prefix.'PAGE';
773 $endArray[] = $prefix.'IMAGE';
774 $fixedOrderTabs = $endArray;
775 while (($row = $result->fetchRow()) !== false) {
776 if (!in_array($row['table_name'], $fixedOrderTabs))
777 $endArray[] = $row['table_name'];
780 return $endArray;
783 public function dropTable( $tableName, $fName = 'DatabaseOracle::dropTable' ) {
784 $tableName = $this->tableName($tableName);
785 if( !$this->tableExists( $tableName ) ) {
786 return false;
789 return $this->doQuery( "DROP TABLE $tableName CASCADE CONSTRAINTS PURGE" );
792 function timestamp( $ts = 0 ) {
793 return wfTimestamp( TS_ORACLE, $ts );
797 * Return aggregated value function call
799 function aggregateValue ( $valuedata, $valuename = 'value' ) {
800 return $valuedata;
803 function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
804 # Ignore errors during error handling to avoid infinite
805 # recursion
806 $ignore = $this->ignoreErrors( true );
807 ++$this->mErrorCount;
809 if ( $ignore || $tempIgnore ) {
810 wfDebug( "SQL ERROR (ignored): $error\n" );
811 $this->ignoreErrors( $ignore );
812 } else {
813 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
818 * @return string wikitext of a link to the server software's web site
820 public static function getSoftwareLink() {
821 return '[http://www.oracle.com/ Oracle]';
825 * @return string Version information from the database
827 function getServerVersion() {
828 //better version number, fallback on driver
829 $rset = $this->doQuery( 'SELECT version FROM product_component_version WHERE UPPER(product) LIKE \'ORACLE DATABASE%\'' );
830 if ( !( $row = $rset->fetchRow() ) ) {
831 return oci_server_version( $this->mConn );
833 return $row['version'];
837 * Query whether a given index exists
839 function indexExists( $table, $index, $fname = 'DatabaseOracle::indexExists' ) {
840 $table = $this->tableName( $table );
841 $table = strtoupper( $this->removeIdentifierQuotes( $table ) );
842 $index = strtoupper( $index );
843 $owner = strtoupper( $this->mDBname );
844 $SQL = "SELECT 1 FROM all_indexes WHERE owner='$owner' AND index_name='{$table}_{$index}'";
845 $res = $this->doQuery( $SQL );
846 if ( $res ) {
847 $count = $res->numRows();
848 $res->free();
849 } else {
850 $count = 0;
852 return $count != 0;
856 * Query whether a given table exists (in the given schema, or the default mw one if not given)
858 function tableExists( $table ) {
859 $table = $this->tableName( $table );
860 $table = $this->addQuotes( strtoupper( $this->removeIdentifierQuotes( $table ) ) );
861 $owner = $this->addQuotes( strtoupper( $this->mDBname ) );
862 $SQL = "SELECT 1 FROM all_tables WHERE owner=$owner AND table_name=$table";
863 $res = $this->doQuery( $SQL );
864 if ( $res ) {
865 $count = $res->numRows();
866 $res->free();
867 } else {
868 $count = 0;
870 return $count;
874 * Function translates mysql_fetch_field() functionality on ORACLE.
875 * Caching is present for reducing query time.
876 * For internal calls. Use fieldInfo for normal usage.
877 * Returns false if the field doesn't exist
879 * @param $table Array
880 * @param $field String
881 * @return ORAField|ORAResult
883 private function fieldInfoMulti( $table, $field ) {
884 $field = strtoupper( $field );
885 if ( is_array( $table ) ) {
886 $table = array_map( array( &$this, 'tableNameInternal' ), $table );
887 $tableWhere = 'IN (';
888 foreach( $table as &$singleTable ) {
889 $singleTable = $this->removeIdentifierQuotes($singleTable);
890 if ( isset( $this->mFieldInfoCache["$singleTable.$field"] ) ) {
891 return $this->mFieldInfoCache["$singleTable.$field"];
893 $tableWhere .= '\'' . $singleTable . '\',';
895 $tableWhere = rtrim( $tableWhere, ',' ) . ')';
896 } else {
897 $table = $this->removeIdentifierQuotes( $this->tableNameInternal( $table ) );
898 if ( isset( $this->mFieldInfoCache["$table.$field"] ) ) {
899 return $this->mFieldInfoCache["$table.$field"];
901 $tableWhere = '= \''.$table.'\'';
904 $fieldInfoStmt = oci_parse( $this->mConn, 'SELECT * FROM wiki_field_info_full WHERE table_name '.$tableWhere.' and column_name = \''.$field.'\'' );
905 if ( oci_execute( $fieldInfoStmt, $this->execFlags() ) === false ) {
906 $e = oci_error( $fieldInfoStmt );
907 $this->reportQueryError( $e['message'], $e['code'], 'fieldInfo QUERY', __METHOD__ );
908 return false;
910 $res = new ORAResult( $this, $fieldInfoStmt );
911 if ( $res->numRows() == 0 ) {
912 if ( is_array( $table ) ) {
913 foreach( $table as &$singleTable ) {
914 $this->mFieldInfoCache["$singleTable.$field"] = false;
916 } else {
917 $this->mFieldInfoCache["$table.$field"] = false;
919 $fieldInfoTemp = null;
920 } else {
921 $fieldInfoTemp = new ORAField( $res->fetchRow() );
922 $table = $fieldInfoTemp->tableName();
923 $this->mFieldInfoCache["$table.$field"] = $fieldInfoTemp;
925 $res->free();
926 return $fieldInfoTemp;
930 * @throws DBUnexpectedError
931 * @param $table
932 * @param $field
933 * @return ORAField
935 function fieldInfo( $table, $field ) {
936 if ( is_array( $table ) ) {
937 throw new DBUnexpectedError( $this, 'DatabaseOracle::fieldInfo called with table array!' );
939 return $this->fieldInfoMulti ($table, $field);
942 function begin( $fname = 'DatabaseOracle::begin' ) {
943 $this->mTrxLevel = 1;
944 $this->doQuery( 'SET CONSTRAINTS ALL DEFERRED' );
947 function commit( $fname = 'DatabaseOracle::commit' ) {
948 if ( $this->mTrxLevel ) {
949 $ret = oci_commit( $this->mConn );
950 if ( !$ret ) {
951 throw new DBUnexpectedError( $this, $this->lastError() );
953 $this->mTrxLevel = 0;
954 $this->doQuery( 'SET CONSTRAINTS ALL IMMEDIATE' );
958 function rollback( $fname = 'DatabaseOracle::rollback' ) {
959 if ( $this->mTrxLevel ) {
960 oci_rollback( $this->mConn );
961 $this->mTrxLevel = 0;
962 $this->doQuery( 'SET CONSTRAINTS ALL IMMEDIATE' );
966 /* Not even sure why this is used in the main codebase... */
967 function limitResultForUpdate( $sql, $num ) {
968 return $sql;
971 /* defines must comply with ^define\s*([^\s=]*)\s*=\s?'\{\$([^\}]*)\}'; */
972 function sourceStream( $fp, $lineCallback = false, $resultCallback = false, $fname = 'DatabaseOracle::sourceStream' ) {
973 $cmd = '';
974 $done = false;
975 $dollarquote = false;
977 $replacements = array();
979 while ( ! feof( $fp ) ) {
980 if ( $lineCallback ) {
981 call_user_func( $lineCallback );
983 $line = trim( fgets( $fp, 1024 ) );
984 $sl = strlen( $line ) - 1;
986 if ( $sl < 0 ) {
987 continue;
989 if ( '-' == $line { 0 } && '-' == $line { 1 } ) {
990 continue;
993 // Allow dollar quoting for function declarations
994 if ( substr( $line, 0, 8 ) == '/*$mw$*/' ) {
995 if ( $dollarquote ) {
996 $dollarquote = false;
997 $line = str_replace( '/*$mw$*/', '', $line ); // remove dollarquotes
998 $done = true;
999 } else {
1000 $dollarquote = true;
1002 } elseif ( !$dollarquote ) {
1003 if ( ';' == $line { $sl } && ( $sl < 2 || ';' != $line { $sl - 1 } ) ) {
1004 $done = true;
1005 $line = substr( $line, 0, $sl );
1009 if ( $cmd != '' ) {
1010 $cmd .= ' ';
1012 $cmd .= "$line\n";
1014 if ( $done ) {
1015 $cmd = str_replace( ';;', ";", $cmd );
1016 if ( strtolower( substr( $cmd, 0, 6 ) ) == 'define' ) {
1017 if ( preg_match( '/^define\s*([^\s=]*)\s*=\s*\'\{\$([^\}]*)\}\'/', $cmd, $defines ) ) {
1018 $replacements[$defines[2]] = $defines[1];
1020 } else {
1021 foreach ( $replacements as $mwVar => $scVar ) {
1022 $cmd = str_replace( '&' . $scVar . '.', '`{$' . $mwVar . '}`', $cmd );
1025 $cmd = $this->replaceVars( $cmd );
1026 $res = $this->doQuery( $cmd );
1027 if ( $resultCallback ) {
1028 call_user_func( $resultCallback, $res, $this );
1031 if ( false === $res ) {
1032 $err = $this->lastError();
1033 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
1037 $cmd = '';
1038 $done = false;
1041 return true;
1044 function selectDB( $db ) {
1045 $this->mDBname = $db;
1046 if ( $db == null || $db == $this->mUser ) {
1047 return true;
1049 $sql = 'ALTER SESSION SET CURRENT_SCHEMA=' . strtoupper($db);
1050 $stmt = oci_parse( $this->mConn, $sql );
1051 wfSuppressWarnings();
1052 $success = oci_execute( $stmt );
1053 wfRestoreWarnings();
1054 if ( !$success ) {
1055 $e = oci_error( $stmt );
1056 if ( $e['code'] != '1435' ) {
1057 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1059 return false;
1061 return true;
1064 function strencode( $s ) {
1065 return str_replace( "'", "''", $s );
1068 function addQuotes( $s ) {
1069 global $wgContLang;
1070 if ( isset( $wgContLang->mLoaded ) && $wgContLang->mLoaded ) {
1071 $s = $wgContLang->checkTitleEncoding( $s );
1073 return "'" . $this->strencode( $s ) . "'";
1076 public function addIdentifierQuotes( $s ) {
1077 if ( !$this->getFlag( DBO_DDLMODE ) ) {
1078 $s = '/*Q*/' . $s;
1080 return $s;
1083 public function removeIdentifierQuotes( $s ) {
1084 return strpos($s, '/*Q*/') === FALSE ? $s : substr($s, 5);
1087 public function isQuotedIdentifier( $s ) {
1088 return strpos($s, '/*Q*/') !== FALSE;
1091 private function wrapFieldForWhere( $table, &$col, &$val ) {
1092 global $wgContLang;
1094 $col_info = $this->fieldInfoMulti( $table, $col );
1095 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
1096 if ( $col_type == 'CLOB' ) {
1097 $col = 'TO_CHAR(' . $col . ')';
1098 $val = $wgContLang->checkTitleEncoding( $val );
1099 } elseif ( $col_type == 'VARCHAR2' && !mb_check_encoding( $val ) ) {
1100 $val = $wgContLang->checkTitleEncoding( $val );
1104 private function wrapConditionsForWhere ( $table, $conds, $parentCol = null ) {
1105 $conds2 = array();
1106 foreach ( $conds as $col => $val ) {
1107 if ( is_array( $val ) ) {
1108 $conds2[$col] = $this->wrapConditionsForWhere ( $table, $val, $col );
1109 } else {
1110 if ( is_numeric( $col ) && $parentCol != null ) {
1111 $this->wrapFieldForWhere ( $table, $parentCol, $val );
1112 } else {
1113 $this->wrapFieldForWhere ( $table, $col, $val );
1115 $conds2[$col] = $val;
1118 return $conds2;
1121 function selectRow( $table, $vars, $conds, $fname = 'DatabaseOracle::selectRow', $options = array(), $join_conds = array() ) {
1122 if ( is_array($conds) ) {
1123 $conds = $this->wrapConditionsForWhere( $table, $conds );
1125 return parent::selectRow( $table, $vars, $conds, $fname, $options, $join_conds );
1129 * Returns an optional USE INDEX clause to go after the table, and a
1130 * string to go at the end of the query
1132 * @private
1134 * @param $options Array: an associative array of options to be turned into
1135 * an SQL query, valid keys are listed in the function.
1136 * @return array
1138 function makeSelectOptions( $options ) {
1139 $preLimitTail = $postLimitTail = '';
1140 $startOpts = '';
1142 $noKeyOptions = array();
1143 foreach ( $options as $key => $option ) {
1144 if ( is_numeric( $key ) ) {
1145 $noKeyOptions[$option] = true;
1149 if ( isset( $options['GROUP BY'] ) ) {
1150 $preLimitTail .= " GROUP BY {$options['GROUP BY']}";
1152 if ( isset( $options['ORDER BY'] ) ) {
1153 $preLimitTail .= " ORDER BY {$options['ORDER BY']}";
1156 # if ( isset( $noKeyOptions['FOR UPDATE'] ) ) $tailOpts .= ' FOR UPDATE';
1157 # if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) $tailOpts .= ' LOCK IN SHARE MODE';
1158 if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1159 $startOpts .= 'DISTINCT';
1162 if ( isset( $options['USE INDEX'] ) && ! is_array( $options['USE INDEX'] ) ) {
1163 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1164 } else {
1165 $useIndex = '';
1168 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1171 public function delete( $table, $conds, $fname = 'DatabaseOracle::delete' ) {
1172 if ( is_array($conds) ) {
1173 $conds = $this->wrapConditionsForWhere( $table, $conds );
1175 // a hack for deleting pages, users and images (which have non-nullable FKs)
1176 // all deletions on these tables have transactions so final failure rollbacks these updates
1177 $table = $this->tableName( $table );
1178 if ( $table == $this->tableName( 'page' ) ) {
1179 $this->update( 'recentchanges', array( 'rc_cur_id' => 0 ), array( 'rc_cur_id' => $conds['page_id'] ), $fname );
1180 } elseif ( $table == $this->tableName( 'user' ) ) {
1181 $this->update( 'archive', array( 'ar_user' => 0 ), array( 'ar_user' => $conds['user_id'] ), $fname );
1182 $this->update( 'ipblocks', array( 'ipb_user' => 0 ), array( 'ipb_user' => $conds['user_id'] ), $fname );
1183 $this->update( 'image', array( 'img_user' => 0 ), array( 'img_user' => $conds['user_id'] ), $fname );
1184 $this->update( 'oldimage', array( 'oi_user' => 0 ), array( 'oi_user' => $conds['user_id'] ), $fname );
1185 $this->update( 'filearchive', array( 'fa_deleted_user' => 0 ), array( 'fa_deleted_user' => $conds['user_id'] ), $fname );
1186 $this->update( 'filearchive', array( 'fa_user' => 0 ), array( 'fa_user' => $conds['user_id'] ), $fname );
1187 $this->update( 'uploadstash', array( 'us_user' => 0 ), array( 'us_user' => $conds['user_id'] ), $fname );
1188 $this->update( 'recentchanges', array( 'rc_user' => 0 ), array( 'rc_user' => $conds['user_id'] ), $fname );
1189 $this->update( 'logging', array( 'log_user' => 0 ), array( 'log_user' => $conds['user_id'] ), $fname );
1190 } elseif ( $table == $this->tableName( 'image' ) ) {
1191 $this->update( 'oldimage', array( 'oi_name' => 0 ), array( 'oi_name' => $conds['img_name'] ), $fname );
1193 return parent::delete( $table, $conds, $fname );
1196 function update( $table, $values, $conds, $fname = 'DatabaseOracle::update', $options = array() ) {
1197 global $wgContLang;
1199 $table = $this->tableName( $table );
1200 $opts = $this->makeUpdateOptions( $options );
1201 $sql = "UPDATE $opts $table SET ";
1203 $first = true;
1204 foreach ( $values as $col => &$val ) {
1205 $sqlSet = $this->fieldBindStatement( $table, $col, $val, true );
1207 if ( !$first ) {
1208 $sqlSet = ', ' . $sqlSet;
1209 } else {
1210 $first = false;
1212 $sql .= $sqlSet;
1215 if ( $conds !== array() && $conds !== '*' ) {
1216 $conds = $this->wrapConditionsForWhere( $table, $conds );
1217 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
1220 if ( ( $this->mLastResult = $stmt = oci_parse( $this->mConn, $sql ) ) === false ) {
1221 $e = oci_error( $this->mConn );
1222 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1223 return false;
1225 foreach ( $values as $col => &$val ) {
1226 $col_info = $this->fieldInfoMulti( $table, $col );
1227 $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
1229 if ( $val === null ) {
1230 // do nothing ... null was inserted in statement creation
1231 } elseif ( $col_type != 'BLOB' && $col_type != 'CLOB' ) {
1232 if ( is_object( $val ) ) {
1233 $val = $val->getData();
1236 if ( preg_match( '/^timestamp.*/i', $col_type ) == 1 && strtolower( $val ) == 'infinity' ) {
1237 $val = '31-12-2030 12:00:00.000000';
1240 $val = ( $wgContLang != null ) ? $wgContLang->checkTitleEncoding( $val ) : $val;
1241 if ( oci_bind_by_name( $stmt, ":$col", $val ) === false ) {
1242 $e = oci_error( $stmt );
1243 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1244 return false;
1246 } else {
1247 if ( ( $lob[$col] = oci_new_descriptor( $this->mConn, OCI_D_LOB ) ) === false ) {
1248 $e = oci_error( $stmt );
1249 throw new DBUnexpectedError( $this, "Cannot create LOB descriptor: " . $e['message'] );
1252 if ( $col_type == 'BLOB' ) {
1253 $lob[$col]->writeTemporary( $val );
1254 oci_bind_by_name( $stmt, ":$col", $lob[$col], - 1, SQLT_BLOB );
1255 } else {
1256 $lob[$col]->writeTemporary( $val );
1257 oci_bind_by_name( $stmt, ":$col", $lob[$col], - 1, OCI_B_CLOB );
1262 wfSuppressWarnings();
1264 if ( oci_execute( $stmt, $this->execFlags() ) === false ) {
1265 $e = oci_error( $stmt );
1266 if ( !$this->ignore_DUP_VAL_ON_INDEX || $e['code'] != '1' ) {
1267 $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1268 return false;
1269 } else {
1270 $this->mAffectedRows = oci_num_rows( $stmt );
1272 } else {
1273 $this->mAffectedRows = oci_num_rows( $stmt );
1276 wfRestoreWarnings();
1278 if ( isset( $lob ) ) {
1279 foreach ( $lob as $lob_v ) {
1280 $lob_v->free();
1284 if ( !$this->mTrxLevel ) {
1285 oci_commit( $this->mConn );
1288 oci_free_statement( $stmt );
1291 function bitNot( $field ) {
1292 // expecting bit-fields smaller than 4bytes
1293 return 'BITNOT(' . $field . ')';
1296 function bitAnd( $fieldLeft, $fieldRight ) {
1297 return 'BITAND(' . $fieldLeft . ', ' . $fieldRight . ')';
1300 function bitOr( $fieldLeft, $fieldRight ) {
1301 return 'BITOR(' . $fieldLeft . ', ' . $fieldRight . ')';
1304 function setFakeMaster( $enabled = true ) {
1307 function getDBname() {
1308 return $this->mDBname;
1311 function getServer() {
1312 return $this->mServer;
1315 public function getSearchEngine() {
1316 return 'SearchOracle';
1318 } // end DatabaseOracle class