includes/db/DatabaseOracle.php

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