MediaWiki  master
DatabaseOracle.php
Go to the documentation of this file.
1 <?php
30 class ORAResult {
31  private $rows;
32  private $cursor;
33  private $nrows;
34 
35  private $columns = [];
36 
37  private function array_unique_md( $array_in ) {
38  $array_out = [];
39  $array_hashes = [];
40 
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;
46  }
47  }
48 
49  return $array_out;
50  }
51 
57  function __construct( &$db, $stmt, $unique = false ) {
58  $this->db =& $db;
59 
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();
65 
66  return;
67  }
68 
69  if ( $unique ) {
70  $this->rows = $this->array_unique_md( $this->rows );
71  $this->nrows = count( $this->rows );
72  }
73 
74  if ( $this->nrows > 0 ) {
75  foreach ( $this->rows[0] as $k => $v ) {
76  $this->columns[$k] = strtolower( oci_field_name( $stmt, $k + 1 ) );
77  }
78  }
79 
80  $this->cursor = 0;
81  oci_free_statement( $stmt );
82  }
83 
84  public function free() {
85  unset( $this->db );
86  }
87 
88  public function seek( $row ) {
89  $this->cursor = min( $row, $this->nrows );
90  }
91 
92  public function numRows() {
93  return $this->nrows;
94  }
95 
96  public function numFields() {
97  return count( $this->columns );
98  }
99 
100  public function fetchObject() {
101  if ( $this->cursor >= $this->nrows ) {
102  return false;
103  }
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;
109  }
110 
111  return $ret;
112  }
113 
114  public function fetchRow() {
115  if ( $this->cursor >= $this->nrows ) {
116  return false;
117  }
118 
119  $row = $this->rows[$this->cursor++];
120  $ret = [];
121  foreach ( $row as $k => $v ) {
122  $lc = $this->columns[$k];
123  $ret[$lc] = $v;
124  $ret[$k] = $v;
125  }
126 
127  return $ret;
128  }
129 }
130 
135 class ORAField implements Field {
138 
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'];
150  }
151 
152  function name() {
153  return $this->name;
154  }
155 
156  function tableName() {
157  return $this->tablename;
158  }
159 
160  function defaultValue() {
161  return $this->default;
162  }
163 
164  function maxLength() {
165  return $this->max_length;
166  }
167 
168  function isNullable() {
169  return $this->nullable;
170  }
171 
172  function isKey() {
173  return $this->is_key;
174  }
175 
176  function isMultipleKey() {
177  return $this->is_multiple;
178  }
179 
180  function type() {
181  return $this->type;
182  }
183 }
184 
188 class DatabaseOracle extends Database {
190  protected $mLastResult = null;
191 
193  protected $mAffectedRows;
194 
196  private $mInsertId = null;
197 
199  private $ignoreDupValOnIndex = false;
200 
202  private $sequenceData = null;
203 
205  private $defaultCharset = 'AL32UTF8';
206 
208  private $mFieldInfoCache = [];
209 
210  function __construct( array $p ) {
212 
213  if ( $p['tablePrefix'] == 'get from global' ) {
214  $p['tablePrefix'] = $wgDBprefix;
215  }
216  $p['tablePrefix'] = strtoupper( $p['tablePrefix'] );
217  parent::__construct( $p );
218  Hooks::run( 'DatabaseOraclePostInit', [ $this ] );
219  }
220 
221  function __destruct() {
222  if ( $this->mOpened ) {
223  MediaWiki\suppressWarnings();
224  $this->close();
225  MediaWiki\restoreWarnings();
226  }
227  }
228 
229  function getType() {
230  return 'oracle';
231  }
232 
233  function cascadingDeletes() {
234  return true;
235  }
236 
237  function cleanupTriggers() {
238  return true;
239  }
240 
241  function strictIPs() {
242  return true;
243  }
244 
245  function realTimestamps() {
246  return true;
247  }
248 
249  function implicitGroupby() {
250  return false;
251  }
252 
253  function implicitOrderby() {
254  return false;
255  }
256 
257  function searchableIPs() {
258  return true;
259  }
260 
270  function open( $server, $user, $password, $dbName ) {
272  if ( !function_exists( 'oci_connect' ) ) {
273  throw new DBConnectionError(
274  $this,
275  "Oracle functions missing, have you compiled PHP with the --with-oci8 option?\n " .
276  "(Note: if you recently installed PHP, you may need to restart your webserver\n " .
277  "and database)\n" );
278  }
279 
280  $this->close();
281  $this->mUser = $user;
282  $this->mPassword = $password;
283  // changed internal variables functions
284  // mServer now holds the TNS endpoint
285  // mDBname is schema name if different from username
286  if ( !$server ) {
287  // backward compatibillity (server used to be null and TNS was supplied in dbname)
288  $this->mServer = $dbName;
289  $this->mDBname = $user;
290  } else {
291  $this->mServer = $server;
292  if ( !$dbName ) {
293  $this->mDBname = $user;
294  } else {
295  $this->mDBname = $dbName;
296  }
297  }
298 
299  if ( !strlen( $user ) ) { # e.g. the class is being loaded
300  return null;
301  }
302 
303  if ( $wgDBOracleDRCP ) {
304  $this->setFlag( DBO_PERSISTENT );
305  }
306 
307  $session_mode = $this->mFlags & DBO_SYSDBA ? OCI_SYSDBA : OCI_DEFAULT;
308 
309  MediaWiki\suppressWarnings();
310  if ( $this->mFlags & DBO_PERSISTENT ) {
311  $this->mConn = oci_pconnect(
312  $this->mUser,
313  $this->mPassword,
314  $this->mServer,
315  $this->defaultCharset,
316  $session_mode
317  );
318  } elseif ( $this->mFlags & DBO_DEFAULT ) {
319  $this->mConn = oci_new_connect(
320  $this->mUser,
321  $this->mPassword,
322  $this->mServer,
323  $this->defaultCharset,
324  $session_mode
325  );
326  } else {
327  $this->mConn = oci_connect(
328  $this->mUser,
329  $this->mPassword,
330  $this->mServer,
331  $this->defaultCharset,
332  $session_mode
333  );
334  }
335  MediaWiki\restoreWarnings();
336 
337  if ( $this->mUser != $this->mDBname ) {
338  // change current schema in session
339  $this->selectDB( $this->mDBname );
340  }
341 
342  if ( !$this->mConn ) {
343  throw new DBConnectionError( $this, $this->lastError() );
344  }
345 
346  $this->mOpened = true;
347 
348  # removed putenv calls because they interfere with the system globaly
349  $this->doQuery( 'ALTER SESSION SET NLS_TIMESTAMP_FORMAT=\'DD-MM-YYYY HH24:MI:SS.FF6\'' );
350  $this->doQuery( 'ALTER SESSION SET NLS_TIMESTAMP_TZ_FORMAT=\'DD-MM-YYYY HH24:MI:SS.FF6\'' );
351  $this->doQuery( 'ALTER SESSION SET NLS_NUMERIC_CHARACTERS=\'.,\'' );
352 
353  return $this->mConn;
354  }
355 
361  protected function closeConnection() {
362  return oci_close( $this->mConn );
363  }
364 
365  function execFlags() {
366  return $this->mTrxLevel ? OCI_NO_AUTO_COMMIT : OCI_COMMIT_ON_SUCCESS;
367  }
368 
369  protected function doQuery( $sql ) {
370  wfDebug( "SQL: [$sql]\n" );
371  if ( !StringUtils::isUtf8( $sql ) ) {
372  throw new MWException( "SQL encoding is invalid\n$sql" );
373  }
374 
375  // handle some oracle specifics
376  // remove AS column/table/subquery namings
377  if ( !$this->getFlag( DBO_DDLMODE ) ) {
378  $sql = preg_replace( '/ as /i', ' ', $sql );
379  }
380 
381  // Oracle has issues with UNION clause if the statement includes LOB fields
382  // So we do a UNION ALL and then filter the results array with array_unique
383  $union_unique = ( preg_match( '/\/\* UNION_UNIQUE \*\/ /', $sql ) != 0 );
384  // EXPLAIN syntax in Oracle is EXPLAIN PLAN FOR and it return nothing
385  // you have to select data from plan table after explain
386  $explain_id = MWTimestamp::getLocalInstance()->format( 'dmYHis' );
387 
388  $sql = preg_replace(
389  '/^EXPLAIN /',
390  'EXPLAIN PLAN SET STATEMENT_ID = \'' . $explain_id . '\' FOR',
391  $sql,
392  1,
393  $explain_count
394  );
395 
396  MediaWiki\suppressWarnings();
397 
398  $this->mLastResult = $stmt = oci_parse( $this->mConn, $sql );
399  if ( $stmt === false ) {
400  $e = oci_error( $this->mConn );
401  $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
402 
403  return false;
404  }
405 
406  if ( !oci_execute( $stmt, $this->execFlags() ) ) {
407  $e = oci_error( $stmt );
408  if ( !$this->ignoreDupValOnIndex || $e['code'] != '1' ) {
409  $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
410 
411  return false;
412  }
413  }
414 
415  MediaWiki\restoreWarnings();
416 
417  if ( $explain_count > 0 ) {
418  return $this->doQuery( 'SELECT id, cardinality "ROWS" FROM plan_table ' .
419  'WHERE statement_id = \'' . $explain_id . '\'' );
420  } elseif ( oci_statement_type( $stmt ) == 'SELECT' ) {
421  return new ORAResult( $this, $stmt, $union_unique );
422  } else {
423  $this->mAffectedRows = oci_num_rows( $stmt );
424 
425  return true;
426  }
427  }
428 
429  function queryIgnore( $sql, $fname = '' ) {
430  return $this->query( $sql, $fname, true );
431  }
432 
437  function freeResult( $res ) {
438  if ( $res instanceof ResultWrapper ) {
439  $res = $res->result;
440  }
441 
442  $res->free();
443  }
444 
449  function fetchObject( $res ) {
450  if ( $res instanceof ResultWrapper ) {
451  $res = $res->result;
452  }
453 
454  return $res->fetchObject();
455  }
456 
461  function fetchRow( $res ) {
462  if ( $res instanceof ResultWrapper ) {
463  $res = $res->result;
464  }
465 
466  return $res->fetchRow();
467  }
468 
473  function numRows( $res ) {
474  if ( $res instanceof ResultWrapper ) {
475  $res = $res->result;
476  }
477 
478  return $res->numRows();
479  }
480 
485  function numFields( $res ) {
486  if ( $res instanceof ResultWrapper ) {
487  $res = $res->result;
488  }
489 
490  return $res->numFields();
491  }
492 
493  function fieldName( $stmt, $n ) {
494  return oci_field_name( $stmt, $n );
495  }
496 
501  function insertId() {
502  return $this->mInsertId;
503  }
504 
509  function dataSeek( $res, $row ) {
510  if ( $res instanceof ORAResult ) {
511  $res->seek( $row );
512  } else {
513  $res->result->seek( $row );
514  }
515  }
516 
517  function lastError() {
518  if ( $this->mConn === false ) {
519  $e = oci_error();
520  } else {
521  $e = oci_error( $this->mConn );
522  }
523 
524  return $e['message'];
525  }
526 
527  function lastErrno() {
528  if ( $this->mConn === false ) {
529  $e = oci_error();
530  } else {
531  $e = oci_error( $this->mConn );
532  }
533 
534  return $e['code'];
535  }
536 
537  function affectedRows() {
538  return $this->mAffectedRows;
539  }
540 
549  function indexInfo( $table, $index, $fname = __METHOD__ ) {
550  return false;
551  }
552 
553  function indexUnique( $table, $index, $fname = __METHOD__ ) {
554  return false;
555  }
556 
557  function insert( $table, $a, $fname = __METHOD__, $options = [] ) {
558  if ( !count( $a ) ) {
559  return true;
560  }
561 
562  if ( !is_array( $options ) ) {
563  $options = [ $options ];
564  }
565 
566  if ( in_array( 'IGNORE', $options ) ) {
567  $this->ignoreDupValOnIndex = true;
568  }
569 
570  if ( !is_array( reset( $a ) ) ) {
571  $a = [ $a ];
572  }
573 
574  foreach ( $a as &$row ) {
575  $this->insertOneRow( $table, $row, $fname );
576  }
577  $retVal = true;
578 
579  if ( in_array( 'IGNORE', $options ) ) {
580  $this->ignoreDupValOnIndex = false;
581  }
582 
583  return $retVal;
584  }
585 
586  private function fieldBindStatement( $table, $col, &$val, $includeCol = false ) {
587  $col_info = $this->fieldInfoMulti( $table, $col );
588  $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
589 
590  $bind = '';
591  if ( is_numeric( $col ) ) {
592  $bind = $val;
593  $val = null;
594 
595  return $bind;
596  } elseif ( $includeCol ) {
597  $bind = "$col = ";
598  }
599 
600  if ( $val == '' && $val !== 0 && $col_type != 'BLOB' && $col_type != 'CLOB' ) {
601  $val = null;
602  }
603 
604  if ( $val === 'NULL' ) {
605  $val = null;
606  }
607 
608  if ( $val === null ) {
609  if ( $col_info != false && $col_info->isNullable() == 0 && $col_info->defaultValue() != null ) {
610  $bind .= 'DEFAULT';
611  } else {
612  $bind .= 'NULL';
613  }
614  } else {
615  $bind .= ':' . $col;
616  }
617 
618  return $bind;
619  }
620 
628  private function insertOneRow( $table, $row, $fname ) {
630 
631  $table = $this->tableName( $table );
632  // "INSERT INTO tables (a, b, c)"
633  $sql = "INSERT INTO " . $table . " (" . implode( ',', array_keys( $row ) ) . ')';
634  $sql .= " VALUES (";
635 
636  // for each value, append ":key"
637  $first = true;
638  foreach ( $row as $col => &$val ) {
639  if ( !$first ) {
640  $sql .= ', ';
641  } else {
642  $first = false;
643  }
644  if ( $this->isQuotedIdentifier( $val ) ) {
645  $sql .= $this->removeIdentifierQuotes( $val );
646  unset( $row[$col] );
647  } else {
648  $sql .= $this->fieldBindStatement( $table, $col, $val );
649  }
650  }
651  $sql .= ')';
652 
653  $this->mLastResult = $stmt = oci_parse( $this->mConn, $sql );
654  if ( $stmt === false ) {
655  $e = oci_error( $this->mConn );
656  $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
657 
658  return false;
659  }
660  foreach ( $row as $col => &$val ) {
661  $col_info = $this->fieldInfoMulti( $table, $col );
662  $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
663 
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();
669  }
670 
671  // backward compatibility
672  if ( preg_match( '/^timestamp.*/i', $col_type ) == 1 && strtolower( $val ) == 'infinity' ) {
673  $val = $this->getInfinity();
674  }
675 
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__ );
680 
681  return false;
682  }
683  } else {
685  $lob[$col] = oci_new_descriptor( $this->mConn, OCI_D_LOB );
686  if ( $lob[$col] === false ) {
687  $e = oci_error( $stmt );
688  throw new DBUnexpectedError( $this, "Cannot create LOB descriptor: " . $e['message'] );
689  }
690 
691  if ( is_object( $val ) ) {
692  $val = $val->fetch();
693  }
694 
695  if ( $col_type == 'BLOB' ) {
696  $lob[$col]->writeTemporary( $val, OCI_TEMP_BLOB );
697  oci_bind_by_name( $stmt, ":$col", $lob[$col], -1, OCI_B_BLOB );
698  } else {
699  $lob[$col]->writeTemporary( $val, OCI_TEMP_CLOB );
700  oci_bind_by_name( $stmt, ":$col", $lob[$col], -1, OCI_B_CLOB );
701  }
702  }
703  }
704 
705  MediaWiki\suppressWarnings();
706 
707  if ( oci_execute( $stmt, $this->execFlags() ) === false ) {
708  $e = oci_error( $stmt );
709  if ( !$this->ignoreDupValOnIndex || $e['code'] != '1' ) {
710  $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
711 
712  return false;
713  } else {
714  $this->mAffectedRows = oci_num_rows( $stmt );
715  }
716  } else {
717  $this->mAffectedRows = oci_num_rows( $stmt );
718  }
719 
720  MediaWiki\restoreWarnings();
721 
722  if ( isset( $lob ) ) {
723  foreach ( $lob as $lob_v ) {
724  $lob_v->free();
725  }
726  }
727 
728  if ( !$this->mTrxLevel ) {
729  oci_commit( $this->mConn );
730  }
731 
732  return oci_free_statement( $stmt );
733  }
734 
735  function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = __METHOD__,
736  $insertOptions = [], $selectOptions = []
737  ) {
738  $destTable = $this->tableName( $destTable );
739  if ( !is_array( $selectOptions ) ) {
740  $selectOptions = [ $selectOptions ];
741  }
742  list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
743  if ( is_array( $srcTable ) ) {
744  $srcTable = implode( ',', array_map( [ &$this, 'tableName' ], $srcTable ) );
745  } else {
746  $srcTable = $this->tableName( $srcTable );
747  }
748 
749  $sequenceData = $this->getSequenceData( $destTable );
750  if ( $sequenceData !== false &&
751  !isset( $varMap[$sequenceData['column']] )
752  ) {
753  $varMap[$sequenceData['column']] = 'GET_SEQUENCE_VALUE(\'' . $sequenceData['sequence'] . '\')';
754  }
755 
756  // count-alias subselect fields to avoid abigious definition errors
757  $i = 0;
758  foreach ( $varMap as &$val ) {
759  $val = $val . ' field' . ( $i++ );
760  }
761 
762  $sql = "INSERT INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
763  " SELECT $startOpts " . implode( ',', $varMap ) .
764  " FROM $srcTable $useIndex ";
765  if ( $conds != '*' ) {
766  $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
767  }
768  $sql .= " $tailOpts";
769 
770  if ( in_array( 'IGNORE', $insertOptions ) ) {
771  $this->ignoreDupValOnIndex = true;
772  }
773 
774  $retval = $this->query( $sql, $fname );
775 
776  if ( in_array( 'IGNORE', $insertOptions ) ) {
777  $this->ignoreDupValOnIndex = false;
778  }
779 
780  return $retval;
781  }
782 
783  public function upsert( $table, array $rows, array $uniqueIndexes, array $set,
784  $fname = __METHOD__
785  ) {
786  if ( !count( $rows ) ) {
787  return true; // nothing to do
788  }
789 
790  if ( !is_array( reset( $rows ) ) ) {
791  $rows = [ $rows ];
792  }
793 
794  $sequenceData = $this->getSequenceData( $table );
795  if ( $sequenceData !== false ) {
796  // add sequence column to each list of columns, when not set
797  foreach ( $rows as &$row ) {
798  if ( !isset( $row[$sequenceData['column']] ) ) {
799  $row[$sequenceData['column']] =
800  $this->addIdentifierQuotes( 'GET_SEQUENCE_VALUE(\'' .
801  $sequenceData['sequence'] . '\')' );
802  }
803  }
804  }
805 
806  return parent::upsert( $table, $rows, $uniqueIndexes, $set, $fname );
807  }
808 
809  function tableName( $name, $format = 'quoted' ) {
810  /*
811  Replace reserved words with better ones
812  Using uppercase because that's the only way Oracle can handle
813  quoted tablenames
814  */
815  switch ( $name ) {
816  case 'user':
817  $name = 'MWUSER';
818  break;
819  case 'text':
820  $name = 'PAGECONTENT';
821  break;
822  }
823 
824  return strtoupper( parent::tableName( $name, $format ) );
825  }
826 
827  function tableNameInternal( $name ) {
828  $name = $this->tableName( $name );
829 
830  return preg_replace( '/.*\.(.*)/', '$1', $name );
831  }
832 
839  function nextSequenceValue( $seqName ) {
840  $res = $this->query( "SELECT $seqName.nextval FROM dual" );
841  $row = $this->fetchRow( $res );
842  $this->mInsertId = $row[0];
843 
844  return $this->mInsertId;
845  }
846 
853  private function getSequenceData( $table ) {
854  if ( $this->sequenceData == null ) {
855  $result = $this->doQuery( "SELECT lower(asq.sequence_name),
856  lower(atc.table_name),
857  lower(atc.column_name)
858  FROM all_sequences asq, all_tab_columns atc
859  WHERE decode(
860  atc.table_name,
861  '{$this->mTablePrefix}MWUSER',
862  '{$this->mTablePrefix}USER',
863  atc.table_name
864  ) || '_' ||
865  atc.column_name || '_SEQ' = '{$this->mTablePrefix}' || asq.sequence_name
866  AND asq.sequence_owner = upper('{$this->mDBname}')
867  AND atc.owner = upper('{$this->mDBname}')" );
868 
869  while ( ( $row = $result->fetchRow() ) !== false ) {
870  $this->sequenceData[$row[1]] = [
871  'sequence' => $row[0],
872  'column' => $row[2]
873  ];
874  }
875  }
876  $table = strtolower( $this->removeIdentifierQuotes( $this->tableName( $table ) ) );
877 
878  return ( isset( $this->sequenceData[$table] ) ) ? $this->sequenceData[$table] : false;
879  }
880 
888  function textFieldSize( $table, $field ) {
889  $fieldInfoData = $this->fieldInfo( $table, $field );
890 
891  return $fieldInfoData->maxLength();
892  }
893 
894  function limitResult( $sql, $limit, $offset = false ) {
895  if ( $offset === false ) {
896  $offset = 0;
897  }
898 
899  return "SELECT * FROM ($sql) WHERE rownum >= (1 + $offset) AND rownum < (1 + $limit + $offset)";
900  }
901 
902  function encodeBlob( $b ) {
903  return new Blob( $b );
904  }
905 
906  function decodeBlob( $b ) {
907  if ( $b instanceof Blob ) {
908  $b = $b->fetch();
909  }
910 
911  return $b;
912  }
913 
914  function unionQueries( $sqls, $all ) {
915  $glue = ' UNION ALL ';
916 
917  return 'SELECT * ' . ( $all ? '' : '/* UNION_UNIQUE */ ' ) .
918  'FROM (' . implode( $glue, $sqls ) . ')';
919  }
920 
921  function wasDeadlock() {
922  return $this->lastErrno() == 'OCI-00060';
923  }
924 
925  function duplicateTableStructure( $oldName, $newName, $temporary = false,
926  $fname = __METHOD__
927  ) {
928  $temporary = $temporary ? 'TRUE' : 'FALSE';
929 
930  $newName = strtoupper( $newName );
931  $oldName = strtoupper( $oldName );
932 
933  $tabName = substr( $newName, strlen( $this->mTablePrefix ) );
934  $oldPrefix = substr( $oldName, 0, strlen( $oldName ) - strlen( $tabName ) );
935  $newPrefix = strtoupper( $this->mTablePrefix );
936 
937  return $this->doQuery( "BEGIN DUPLICATE_TABLE( '$tabName', " .
938  "'$oldPrefix', '$newPrefix', $temporary ); END;" );
939  }
940 
941  function listTables( $prefix = null, $fname = __METHOD__ ) {
942  $listWhere = '';
943  if ( !empty( $prefix ) ) {
944  $listWhere = ' AND table_name LIKE \'' . strtoupper( $prefix ) . '%\'';
945  }
946 
947  $owner = strtoupper( $this->mDBname );
948  $result = $this->doQuery( "SELECT table_name FROM all_tables " .
949  "WHERE owner='$owner' AND table_name NOT LIKE '%!_IDX\$_' ESCAPE '!' $listWhere" );
950 
951  // dirty code ... i know
952  $endArray = [];
953  $endArray[] = strtoupper( $prefix . 'MWUSER' );
954  $endArray[] = strtoupper( $prefix . 'PAGE' );
955  $endArray[] = strtoupper( $prefix . 'IMAGE' );
956  $fixedOrderTabs = $endArray;
957  while ( ( $row = $result->fetchRow() ) !== false ) {
958  if ( !in_array( $row['table_name'], $fixedOrderTabs ) ) {
959  $endArray[] = $row['table_name'];
960  }
961  }
962 
963  return $endArray;
964  }
965 
966  public function dropTable( $tableName, $fName = __METHOD__ ) {
967  $tableName = $this->tableName( $tableName );
968  if ( !$this->tableExists( $tableName ) ) {
969  return false;
970  }
971 
972  return $this->doQuery( "DROP TABLE $tableName CASCADE CONSTRAINTS PURGE" );
973  }
974 
975  function timestamp( $ts = 0 ) {
976  return wfTimestamp( TS_ORACLE, $ts );
977  }
978 
986  public function aggregateValue( $valuedata, $valuename = 'value' ) {
987  return $valuedata;
988  }
989 
993  public function getSoftwareLink() {
994  return '[{{int:version-db-oracle-url}} Oracle]';
995  }
996 
1000  function getServerVersion() {
1001  // better version number, fallback on driver
1002  $rset = $this->doQuery(
1003  'SELECT version FROM product_component_version ' .
1004  'WHERE UPPER(product) LIKE \'ORACLE DATABASE%\''
1005  );
1006  $row = $rset->fetchRow();
1007  if ( !$row ) {
1008  return oci_server_version( $this->mConn );
1009  }
1010 
1011  return $row['version'];
1012  }
1013 
1021  function indexExists( $table, $index, $fname = __METHOD__ ) {
1022  $table = $this->tableName( $table );
1023  $table = strtoupper( $this->removeIdentifierQuotes( $table ) );
1024  $index = strtoupper( $index );
1025  $owner = strtoupper( $this->mDBname );
1026  $sql = "SELECT 1 FROM all_indexes WHERE owner='$owner' AND index_name='{$table}_{$index}'";
1027  $res = $this->doQuery( $sql );
1028  if ( $res ) {
1029  $count = $res->numRows();
1030  $res->free();
1031  } else {
1032  $count = 0;
1033  }
1034 
1035  return $count != 0;
1036  }
1037 
1044  function tableExists( $table, $fname = __METHOD__ ) {
1045  $table = $this->tableName( $table );
1046  $table = $this->addQuotes( strtoupper( $this->removeIdentifierQuotes( $table ) ) );
1047  $owner = $this->addQuotes( strtoupper( $this->mDBname ) );
1048  $sql = "SELECT 1 FROM all_tables WHERE owner=$owner AND table_name=$table";
1049  $res = $this->doQuery( $sql );
1050  if ( $res && $res->numRows() > 0 ) {
1051  $exists = true;
1052  } else {
1053  $exists = false;
1054  }
1055 
1056  $res->free();
1057 
1058  return $exists;
1059  }
1060 
1071  private function fieldInfoMulti( $table, $field ) {
1072  $field = strtoupper( $field );
1073  if ( is_array( $table ) ) {
1074  $table = array_map( [ &$this, 'tableNameInternal' ], $table );
1075  $tableWhere = 'IN (';
1076  foreach ( $table as &$singleTable ) {
1077  $singleTable = $this->removeIdentifierQuotes( $singleTable );
1078  if ( isset( $this->mFieldInfoCache["$singleTable.$field"] ) ) {
1079  return $this->mFieldInfoCache["$singleTable.$field"];
1080  }
1081  $tableWhere .= '\'' . $singleTable . '\',';
1082  }
1083  $tableWhere = rtrim( $tableWhere, ',' ) . ')';
1084  } else {
1085  $table = $this->removeIdentifierQuotes( $this->tableNameInternal( $table ) );
1086  if ( isset( $this->mFieldInfoCache["$table.$field"] ) ) {
1087  return $this->mFieldInfoCache["$table.$field"];
1088  }
1089  $tableWhere = '= \'' . $table . '\'';
1090  }
1091 
1092  $fieldInfoStmt = oci_parse(
1093  $this->mConn,
1094  'SELECT * FROM wiki_field_info_full WHERE table_name ' .
1095  $tableWhere . ' and column_name = \'' . $field . '\''
1096  );
1097  if ( oci_execute( $fieldInfoStmt, $this->execFlags() ) === false ) {
1098  $e = oci_error( $fieldInfoStmt );
1099  $this->reportQueryError( $e['message'], $e['code'], 'fieldInfo QUERY', __METHOD__ );
1100 
1101  return false;
1102  }
1103  $res = new ORAResult( $this, $fieldInfoStmt );
1104  if ( $res->numRows() == 0 ) {
1105  if ( is_array( $table ) ) {
1106  foreach ( $table as &$singleTable ) {
1107  $this->mFieldInfoCache["$singleTable.$field"] = false;
1108  }
1109  } else {
1110  $this->mFieldInfoCache["$table.$field"] = false;
1111  }
1112  $fieldInfoTemp = null;
1113  } else {
1114  $fieldInfoTemp = new ORAField( $res->fetchRow() );
1115  $table = $fieldInfoTemp->tableName();
1116  $this->mFieldInfoCache["$table.$field"] = $fieldInfoTemp;
1117  }
1118  $res->free();
1119 
1120  return $fieldInfoTemp;
1121  }
1122 
1129  function fieldInfo( $table, $field ) {
1130  if ( is_array( $table ) ) {
1131  throw new DBUnexpectedError( $this, 'DatabaseOracle::fieldInfo called with table array!' );
1132  }
1133 
1134  return $this->fieldInfoMulti( $table, $field );
1135  }
1136 
1137  protected function doBegin( $fname = __METHOD__ ) {
1138  $this->mTrxLevel = 1;
1139  $this->doQuery( 'SET CONSTRAINTS ALL DEFERRED' );
1140  }
1141 
1142  protected function doCommit( $fname = __METHOD__ ) {
1143  if ( $this->mTrxLevel ) {
1144  $ret = oci_commit( $this->mConn );
1145  if ( !$ret ) {
1146  throw new DBUnexpectedError( $this, $this->lastError() );
1147  }
1148  $this->mTrxLevel = 0;
1149  $this->doQuery( 'SET CONSTRAINTS ALL IMMEDIATE' );
1150  }
1151  }
1152 
1153  protected function doRollback( $fname = __METHOD__ ) {
1154  if ( $this->mTrxLevel ) {
1155  oci_rollback( $this->mConn );
1156  $this->mTrxLevel = 0;
1157  $this->doQuery( 'SET CONSTRAINTS ALL IMMEDIATE' );
1158  }
1159  }
1160 
1171  function sourceStream( $fp, $lineCallback = false, $resultCallback = false,
1172  $fname = __METHOD__, $inputCallback = false ) {
1173  $cmd = '';
1174  $done = false;
1175  $dollarquote = false;
1176 
1177  $replacements = [];
1178 
1179  while ( !feof( $fp ) ) {
1180  if ( $lineCallback ) {
1181  call_user_func( $lineCallback );
1182  }
1183  $line = trim( fgets( $fp, 1024 ) );
1184  $sl = strlen( $line ) - 1;
1185 
1186  if ( $sl < 0 ) {
1187  continue;
1188  }
1189  if ( '-' == $line[0] && '-' == $line[1] ) {
1190  continue;
1191  }
1192 
1193  // Allow dollar quoting for function declarations
1194  if ( substr( $line, 0, 8 ) == '/*$mw$*/' ) {
1195  if ( $dollarquote ) {
1196  $dollarquote = false;
1197  $line = str_replace( '/*$mw$*/', '', $line ); // remove dollarquotes
1198  $done = true;
1199  } else {
1200  $dollarquote = true;
1201  }
1202  } elseif ( !$dollarquote ) {
1203  if ( ';' == $line[$sl] && ( $sl < 2 || ';' != $line[$sl - 1] ) ) {
1204  $done = true;
1205  $line = substr( $line, 0, $sl );
1206  }
1207  }
1208 
1209  if ( $cmd != '' ) {
1210  $cmd .= ' ';
1211  }
1212  $cmd .= "$line\n";
1213 
1214  if ( $done ) {
1215  $cmd = str_replace( ';;', ";", $cmd );
1216  if ( strtolower( substr( $cmd, 0, 6 ) ) == 'define' ) {
1217  if ( preg_match( '/^define\s*([^\s=]*)\s*=\s*\'\{\$([^\}]*)\}\'/', $cmd, $defines ) ) {
1218  $replacements[$defines[2]] = $defines[1];
1219  }
1220  } else {
1221  foreach ( $replacements as $mwVar => $scVar ) {
1222  $cmd = str_replace( '&' . $scVar . '.', '`{$' . $mwVar . '}`', $cmd );
1223  }
1224 
1225  $cmd = $this->replaceVars( $cmd );
1226  if ( $inputCallback ) {
1227  call_user_func( $inputCallback, $cmd );
1228  }
1229  $res = $this->doQuery( $cmd );
1230  if ( $resultCallback ) {
1231  call_user_func( $resultCallback, $res, $this );
1232  }
1233 
1234  if ( false === $res ) {
1235  $err = $this->lastError();
1236 
1237  return "Query \"{$cmd}\" failed with error code \"$err\".\n";
1238  }
1239  }
1240 
1241  $cmd = '';
1242  $done = false;
1243  }
1244  }
1245 
1246  return true;
1247  }
1248 
1249  function selectDB( $db ) {
1250  $this->mDBname = $db;
1251  if ( $db == null || $db == $this->mUser ) {
1252  return true;
1253  }
1254  $sql = 'ALTER SESSION SET CURRENT_SCHEMA=' . strtoupper( $db );
1255  $stmt = oci_parse( $this->mConn, $sql );
1256  MediaWiki\suppressWarnings();
1257  $success = oci_execute( $stmt );
1258  MediaWiki\restoreWarnings();
1259  if ( !$success ) {
1260  $e = oci_error( $stmt );
1261  if ( $e['code'] != '1435' ) {
1262  $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1263  }
1264 
1265  return false;
1266  }
1267 
1268  return true;
1269  }
1270 
1271  function strencode( $s ) {
1272  return str_replace( "'", "''", $s );
1273  }
1274 
1275  function addQuotes( $s ) {
1277  if ( isset( $wgContLang->mLoaded ) && $wgContLang->mLoaded ) {
1278  $s = $wgContLang->checkTitleEncoding( $s );
1279  }
1280 
1281  return "'" . $this->strencode( $s ) . "'";
1282  }
1283 
1284  public function addIdentifierQuotes( $s ) {
1285  if ( !$this->getFlag( DBO_DDLMODE ) ) {
1286  $s = '/*Q*/' . $s;
1287  }
1288 
1289  return $s;
1290  }
1291 
1292  public function removeIdentifierQuotes( $s ) {
1293  return strpos( $s, '/*Q*/' ) === false ? $s : substr( $s, 5 );
1294  }
1295 
1296  public function isQuotedIdentifier( $s ) {
1297  return strpos( $s, '/*Q*/' ) !== false;
1298  }
1299 
1300  private function wrapFieldForWhere( $table, &$col, &$val ) {
1302 
1303  $col_info = $this->fieldInfoMulti( $table, $col );
1304  $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
1305  if ( $col_type == 'CLOB' ) {
1306  $col = 'TO_CHAR(' . $col . ')';
1307  $val = $wgContLang->checkTitleEncoding( $val );
1308  } elseif ( $col_type == 'VARCHAR2' ) {
1309  $val = $wgContLang->checkTitleEncoding( $val );
1310  }
1311  }
1312 
1313  private function wrapConditionsForWhere( $table, $conds, $parentCol = null ) {
1314  $conds2 = [];
1315  foreach ( $conds as $col => $val ) {
1316  if ( is_array( $val ) ) {
1317  $conds2[$col] = $this->wrapConditionsForWhere( $table, $val, $col );
1318  } else {
1319  if ( is_numeric( $col ) && $parentCol != null ) {
1320  $this->wrapFieldForWhere( $table, $parentCol, $val );
1321  } else {
1322  $this->wrapFieldForWhere( $table, $col, $val );
1323  }
1324  $conds2[$col] = $val;
1325  }
1326  }
1327 
1328  return $conds2;
1329  }
1330 
1331  function selectRow( $table, $vars, $conds, $fname = __METHOD__,
1332  $options = [], $join_conds = []
1333  ) {
1334  if ( is_array( $conds ) ) {
1335  $conds = $this->wrapConditionsForWhere( $table, $conds );
1336  }
1337 
1338  return parent::selectRow( $table, $vars, $conds, $fname, $options, $join_conds );
1339  }
1340 
1350  $preLimitTail = $postLimitTail = '';
1351  $startOpts = '';
1352 
1353  $noKeyOptions = [];
1354  foreach ( $options as $key => $option ) {
1355  if ( is_numeric( $key ) ) {
1356  $noKeyOptions[$option] = true;
1357  }
1358  }
1359 
1360  $preLimitTail .= $this->makeGroupByWithHaving( $options );
1361 
1362  $preLimitTail .= $this->makeOrderBy( $options );
1363 
1364  if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1365  $postLimitTail .= ' FOR UPDATE';
1366  }
1367 
1368  if ( isset( $noKeyOptions['DISTINCT'] ) || isset( $noKeyOptions['DISTINCTROW'] ) ) {
1369  $startOpts .= 'DISTINCT';
1370  }
1371 
1372  if ( isset( $options['USE INDEX'] ) && !is_array( $options['USE INDEX'] ) ) {
1373  $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1374  } else {
1375  $useIndex = '';
1376  }
1377 
1378  return [ $startOpts, $useIndex, $preLimitTail, $postLimitTail ];
1379  }
1380 
1381  public function delete( $table, $conds, $fname = __METHOD__ ) {
1382  if ( is_array( $conds ) ) {
1383  $conds = $this->wrapConditionsForWhere( $table, $conds );
1384  }
1385  // a hack for deleting pages, users and images (which have non-nullable FKs)
1386  // all deletions on these tables have transactions so final failure rollbacks these updates
1387  $table = $this->tableName( $table );
1388  if ( $table == $this->tableName( 'user' ) ) {
1389  $this->update( 'archive', [ 'ar_user' => 0 ],
1390  [ 'ar_user' => $conds['user_id'] ], $fname );
1391  $this->update( 'ipblocks', [ 'ipb_user' => 0 ],
1392  [ 'ipb_user' => $conds['user_id'] ], $fname );
1393  $this->update( 'image', [ 'img_user' => 0 ],
1394  [ 'img_user' => $conds['user_id'] ], $fname );
1395  $this->update( 'oldimage', [ 'oi_user' => 0 ],
1396  [ 'oi_user' => $conds['user_id'] ], $fname );
1397  $this->update( 'filearchive', [ 'fa_deleted_user' => 0 ],
1398  [ 'fa_deleted_user' => $conds['user_id'] ], $fname );
1399  $this->update( 'filearchive', [ 'fa_user' => 0 ],
1400  [ 'fa_user' => $conds['user_id'] ], $fname );
1401  $this->update( 'uploadstash', [ 'us_user' => 0 ],
1402  [ 'us_user' => $conds['user_id'] ], $fname );
1403  $this->update( 'recentchanges', [ 'rc_user' => 0 ],
1404  [ 'rc_user' => $conds['user_id'] ], $fname );
1405  $this->update( 'logging', [ 'log_user' => 0 ],
1406  [ 'log_user' => $conds['user_id'] ], $fname );
1407  } elseif ( $table == $this->tableName( 'image' ) ) {
1408  $this->update( 'oldimage', [ 'oi_name' => 0 ],
1409  [ 'oi_name' => $conds['img_name'] ], $fname );
1410  }
1411 
1412  return parent::delete( $table, $conds, $fname );
1413  }
1414 
1424  function update( $table, $values, $conds, $fname = __METHOD__, $options = [] ) {
1426 
1427  $table = $this->tableName( $table );
1428  $opts = $this->makeUpdateOptions( $options );
1429  $sql = "UPDATE $opts $table SET ";
1430 
1431  $first = true;
1432  foreach ( $values as $col => &$val ) {
1433  $sqlSet = $this->fieldBindStatement( $table, $col, $val, true );
1434 
1435  if ( !$first ) {
1436  $sqlSet = ', ' . $sqlSet;
1437  } else {
1438  $first = false;
1439  }
1440  $sql .= $sqlSet;
1441  }
1442 
1443  if ( $conds !== [] && $conds !== '*' ) {
1444  $conds = $this->wrapConditionsForWhere( $table, $conds );
1445  $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND );
1446  }
1447 
1448  $this->mLastResult = $stmt = oci_parse( $this->mConn, $sql );
1449  if ( $stmt === false ) {
1450  $e = oci_error( $this->mConn );
1451  $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1452 
1453  return false;
1454  }
1455  foreach ( $values as $col => &$val ) {
1456  $col_info = $this->fieldInfoMulti( $table, $col );
1457  $col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
1458 
1459  if ( $val === null ) {
1460  // do nothing ... null was inserted in statement creation
1461  } elseif ( $col_type != 'BLOB' && $col_type != 'CLOB' ) {
1462  if ( is_object( $val ) ) {
1463  $val = $val->getData();
1464  }
1465 
1466  if ( preg_match( '/^timestamp.*/i', $col_type ) == 1 && strtolower( $val ) == 'infinity' ) {
1467  $val = '31-12-2030 12:00:00.000000';
1468  }
1469 
1470  $val = ( $wgContLang != null ) ? $wgContLang->checkTitleEncoding( $val ) : $val;
1471  if ( oci_bind_by_name( $stmt, ":$col", $val ) === false ) {
1472  $e = oci_error( $stmt );
1473  $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1474 
1475  return false;
1476  }
1477  } else {
1479  $lob[$col] = oci_new_descriptor( $this->mConn, OCI_D_LOB );
1480  if ( $lob[$col] === false ) {
1481  $e = oci_error( $stmt );
1482  throw new DBUnexpectedError( $this, "Cannot create LOB descriptor: " . $e['message'] );
1483  }
1484 
1485  if ( is_object( $val ) ) {
1486  $val = $val->getData();
1487  }
1488 
1489  if ( $col_type == 'BLOB' ) {
1490  $lob[$col]->writeTemporary( $val );
1491  oci_bind_by_name( $stmt, ":$col", $lob[$col], -1, SQLT_BLOB );
1492  } else {
1493  $lob[$col]->writeTemporary( $val );
1494  oci_bind_by_name( $stmt, ":$col", $lob[$col], -1, OCI_B_CLOB );
1495  }
1496  }
1497  }
1498 
1499  MediaWiki\suppressWarnings();
1500 
1501  if ( oci_execute( $stmt, $this->execFlags() ) === false ) {
1502  $e = oci_error( $stmt );
1503  if ( !$this->ignoreDupValOnIndex || $e['code'] != '1' ) {
1504  $this->reportQueryError( $e['message'], $e['code'], $sql, __METHOD__ );
1505 
1506  return false;
1507  } else {
1508  $this->mAffectedRows = oci_num_rows( $stmt );
1509  }
1510  } else {
1511  $this->mAffectedRows = oci_num_rows( $stmt );
1512  }
1513 
1514  MediaWiki\restoreWarnings();
1515 
1516  if ( isset( $lob ) ) {
1517  foreach ( $lob as $lob_v ) {
1518  $lob_v->free();
1519  }
1520  }
1521 
1522  if ( !$this->mTrxLevel ) {
1523  oci_commit( $this->mConn );
1524  }
1525 
1526  return oci_free_statement( $stmt );
1527  }
1528 
1529  function bitNot( $field ) {
1530  // expecting bit-fields smaller than 4bytes
1531  return 'BITNOT(' . $field . ')';
1532  }
1533 
1534  function bitAnd( $fieldLeft, $fieldRight ) {
1535  return 'BITAND(' . $fieldLeft . ', ' . $fieldRight . ')';
1536  }
1537 
1538  function bitOr( $fieldLeft, $fieldRight ) {
1539  return 'BITOR(' . $fieldLeft . ', ' . $fieldRight . ')';
1540  }
1541 
1542  function getDBname() {
1543  return $this->mDBname;
1544  }
1545 
1546  function getServer() {
1547  return $this->mServer;
1548  }
1549 
1550  public function buildGroupConcatField(
1551  $delim, $table, $field, $conds = '', $join_conds = []
1552  ) {
1553  $fld = "LISTAGG($field," . $this->addQuotes( $delim ) . ") WITHIN GROUP (ORDER BY $field)";
1554 
1555  return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
1556  }
1557 
1558  public function getSearchEngine() {
1559  return 'SearchOracle';
1560  }
1561 
1562  public function getInfinity() {
1563  return '31-12-2030 12:00:00.000000';
1564  }
1565 }
doRollback($fname=__METHOD__)
#define the
table suitable for use with IDatabase::select()
isNullable()
Whether this field can store NULL values.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
the array() calling protocol came about after MediaWiki 1.4rc1.
Utility classThis allows us to distinguish a blob from a normal string and an array of strings...
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to and or sell copies of the and to permit persons to whom the Software is furnished to do subject to the following WITHOUT WARRANTY OF ANY EXPRESS OR INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES OR OTHER WHETHER IN AN ACTION OF TORT OR ARISING FROM
Definition: LICENSE.txt:10
$success
queryIgnore($sql, $fname= '')
fieldBindStatement($table, $col, &$val, $includeCol=false)
sourceStream($fp, $lineCallback=false, $resultCallback=false, $fname=__METHOD__, $inputCallback=false)
defines must comply with ^define\s*([^\s=]*)\s*=\s?'\{\$([^\}]*)\}';
implicitOrderby()
Returns true if this database does an implicit order by when the column has an index For example: SEL...
name()
Field name.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:1980
const DBO_PERSISTENT
Definition: Defines.php:35
insert($table, $a, $fname=__METHOD__, $options=[])
INSERT wrapper, inserts an array into a table.
insertId()
This must be called after nextSequenceVal.
getSequenceData($table)
Return sequence_name if table has a sequence.
indexUnique($table, $index, $fname=__METHOD__)
resource $mConn
Database connection.
Definition: Database.php:52
freeResult($res)
Frees resources associated with the LOB descriptor.
__construct(array $p)
open($server, $user, $password, $dbName)
Usually aborts on failure.
string $defaultCharset
Character set for Oracle database.
implicitGroupby()
Returns true if this database does an implicit sort when doing GROUP BY.
Base for all database-specific classes representing information about database fields.
closeConnection()
Closes a database connection, if it is open Returns success, true if already closed.
resource $mLastResult
array_unique_md($array_in)
fieldInfoMulti($table, $field)
Function translates mysql_fetch_field() functionality on ORACLE.
const DBO_SYSDBA
Definition: Defines.php:36
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
type()
Database type.
duplicateTableStructure($oldName, $newName, $temporary=false, $fname=__METHOD__)
insertSelect($destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
INSERT SELECT wrapper.
in this case you re responsible for computing and outputting the entire conflict i e
Definition: hooks.txt:1256
textFieldSize($table, $field)
Returns the size of a text field, or -1 for "unlimited".
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for tableName() and addQuotes().You will need both of them.------------------------------------------------------------------------Basic query optimisation------------------------------------------------------------------------MediaWiki developers who need to write DB queries should have some understanding of databases and the performance issues associated with them.Patches containing unacceptably slow features will not be accepted.Unindexed queries are generally not welcome in MediaWiki
__construct(&$db, $stmt, $unique=false)
close()
Closes a database connection.
Definition: Database.php:698
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1814
static getLocalInstance($ts=false)
Get a timestamp instance in the server local timezone ($wgLocaltimezone)
insertOneRow($table, $row, $fname)
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wrapConditionsForWhere($table, $conds, $parentCol=null)
affectedRows()
Get the number of rows affected by the last write query.
__construct($info)
bitOr($fieldLeft, $fieldRight)
fieldName($stmt, $n)
Get a field name in a result object.
Some quick notes on the file repository architecture Functionality is
Definition: README:3
int $mAffectedRows
The number of rows affected as an integer.
const LIST_AND
Definition: Defines.php:194
wrapFieldForWhere($table, &$col, &$val)
tableNameInternal($name)
update($table, $values, $conds, $fname=__METHOD__, $options=[])
dataSeek($res, $row)
makeSelectOptions($options)
Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the quer...
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1020
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned after processing after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a message
Definition: hooks.txt:1972
$res
Definition: database.txt:21
MediaWiki exception.
Definition: MWException.php:26
doCommit($fname=__METHOD__)
const TS_ORACLE
Oracle format time.
getFlag($flag)
Returns a boolean whether the flag $flag is set for this connection.
Definition: Database.php:420
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1816
getServer()
Get the server hostname or IP address.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
limitResult($sql, $limit, $offset=false)
fieldInfo($table, $field)
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
encodeBlob($b)
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strin...
setFlag($flag)
Set a flag for this connection.
Definition: Database.php:412
getInfinity()
Find out when 'infinity' is.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
getDBname()
Get the current DB name.
tableExists($table, $fname=__METHOD__)
Query whether a given table exists (in the given schema, or the default mw one if not given) ...
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and local administrators to define code that will be run at certain points in the mainline code
Definition: hooks.txt:23
getType()
Get the type of the DBMS, as it appears in $wgDBtype.
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined...
Definition: Setup.php:36
listTables($prefix=null, $fname=__METHOD__)
List all tables on the database.
const DBO_DDLMODE
Definition: Defines.php:37
lastError()
Get a description of the last error.
Utility class.
unionQueries($sqls, $all)
Construct a UNION query This is used for providing overload point for other DB abstractions not compa...
$line
Definition: cdb.php:59
$wgDBprefix
Table name prefix.
const DBO_DEFAULT
Definition: Defines.php:34
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1020
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
nextSequenceValue($seqName)
Return the next in a sequence, save the value for retrieval via insertId()
aggregateValue($valuedata, $valuename= 'value')
Return aggregated value function call.
timestamp($ts=0)
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting ...
addQuotes($s)
Adds quotes and backslashes.
$count
lastErrno()
Get the last error number.
doBegin($fname=__METHOD__)
decodeBlob($b)
Some DBMSs return a special placeholder object representing blob fields in result objects...
Result wrapper for grabbing data queried by someone else.
serialize()
Definition: ApiMessage.php:94
The oci8 extension is fairly weak and doesn't support oci_num_rows, among other things.
buildGroupConcatField($delim, $table, $field, $conds= '', $join_conds=[])
Build a GROUP_CONCAT or equivalent statement for a query.
$wgDBOracleDRCP
Set true to enable Oracle DCRP (supported from 11gR1 onward)
wasDeadlock()
Determines if the last failure was due to a deadlock STUB.
selectRow($table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
Single row SELECT wrapper.
selectDB($db)
Change the current database.
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition: hooks.txt:2044
For a write query
Definition: database.txt:26
indexInfo($table, $index, $fname=__METHOD__)
Returns information about an index If errors are explicitly ignored, returns NULL on failure...
indexExists($table, $index, $fname=__METHOD__)
Query whether a given index exists.
bitAnd($fieldLeft, $fieldRight)
dropTable($tableName, $fName=__METHOD__)
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:310
tableName()
Name of table this field belongs to.