-<?
-include_once( "FulltextStoplist.php" );
-include_once( "CacheManager.php" );
+<?php
+/**
+ * Legacy database functions, for compatibility with pre-1.3 code
+ * NOTE: this file is no longer loaded by default.
+ * @file
+ * @ingroup Database
+ */
+
+/**
+ * Usually aborts on failure
+ * If errors are explicitly ignored, returns success
+ * @param $sql String: SQL query
+ * @param $db Mixed: database handler
+ * @param $fname String: name of the php function calling
+ */
+function wfQuery( $sql, $db, $fname = '' ) {
+ if ( !is_numeric( $db ) ) {
+ # Someone has tried to call this the old way
+ throw new FatalError( wfMsgNoDB( 'wrong_wfQuery_params', $db, $sql ) );
+ }
+ $c = wfGetDB( $db );
+ if ( $c !== false ) {
+ return $c->query( $sql, $fname );
+ } else {
+ return false;
+ }
+}
-define( "DB_READ", -1 );
-define( "DB_WRITE", -2 );
-define( "DB_LAST", -3 );
+/**
+ *
+ * @param $sql String: SQL query
+ * @param $dbi
+ * @param $fname String: name of the php function calling
+ * @return Array: first row from the database
+ */
+function wfSingleQuery( $sql, $dbi, $fname = '' ) {
+ $db = wfGetDB( $dbi );
+ $res = $db->query($sql, $fname );
+ $row = $db->fetchRow( $res );
+ $ret = $row[0];
+ $db->freeResult( $res );
+ return $ret;
+}
-$wgLastDatabaseQuery = "";
+/**
+ * Turns on (false) or off (true) the automatic generation and sending
+ * of a "we're sorry, but there has been a database error" page on
+ * database errors. Default is on (false). When turned off, the
+ * code should use wfLastErrno() and wfLastError() to handle the
+ * situation as appropriate.
+ *
+ * @param $newstate
+ * @param $dbi
+ * @return Returns the previous state.
+ */
+function wfIgnoreSQLErrors( $newstate, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->ignoreErrors( $newstate );
+ } else {
+ return null;
+ }
+}
-/* private */ $wgBufferSQLResults = true;
-/* private */ $wgIgnoreSQLErrors = false;
+/**#@+
+ * @param $res Database result handler
+ * @param $dbi
+*/
-function wfGetDB( $altuser = "", $altpassword = "", $altserver = "", $altdb = "" )
+/**
+ * Free a database result
+ * @return Bool: whether result is sucessful or not.
+ */
+function wfFreeResult( $res, $dbi = DB_LAST )
{
- global $wgDBserver, $wgDBuser, $wgDBpassword;
- global $wgDBname, $wgDBconnection, $wgEmergencyContact;
-
- $noconn = wfMsgNoDB( "noconnect", $wgDBserver );
- $nodb = wfMsgNoDB( "nodb", $wgDBname );
-
- $helpme = "\n<p>If this error persists after reloading and clearing " .
- "your browser cache, please notify the <a href=\"mailto:" .
- $wgEmergencyContact . "\">Wikipedia developers</a>.</p>";
-
- if ( $altuser != "" ) {
- $serve = ($altserver ? $altserver : $wgDBserver );
- $db = ($altdb ? $altdb : $wgDBname );
- $wgDBconnection = mysql_connect( $serve, $altuser, $altpassword )
- or die( "bad sql user" );
- mysql_select_db( $db, $wgDBconnection ) or die(
- htmlspecialchars(mysql_error()) );
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ $db->freeResult( $res );
+ return true;
+ } else {
+ return false;
}
+}
- if ( ! $wgDBconnection ) {
- @$wgDBconnection = mysql_pconnect( $wgDBserver, $wgDBuser, $wgDBpassword )
- or wfEmergencyAbort();
-
- if( !mysql_select_db( $wgDBname, $wgDBconnection ) ) {
- /* Persistent connections may become stuck in an unusable state */
- wfDebug( "Persistent connection is broken?\n", true );
-
- @$wgDBconnection = mysql_connect( $wgDBserver, $wgDBuser, $wgDBpassword )
- or wfEmergencyAbort();
-
- @mysql_select_db( $wgDBname, $wgDBconnection )
- or wfEmergencyAbort();
- }
+/**
+ * Get an object from a database result
+ * @return object|false object we requested
+ */
+function wfFetchObject( $res, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->fetchObject( $res, $dbi = DB_LAST );
+ } else {
+ return false;
}
- # mysql_ping( $wgDBconnection );
- return $wgDBconnection;
}
-/* Call this function if we couldn't contact the database...
- We'll try to use the cache to display something in the meantime */
-function wfEmergencyAbort( $msg = "" ) {
- global $wgTitle, $wgUseFileCache, $title, $wgOutputEncoding;
-
- header( "Content-type: text/html; charset=$wgOutputEncoding" );
- if($msg == "") $msg = wfMsgNoDB( "noconnect" );
- $text = $msg;
-
- if($wgUseFileCache) {
- if($wgTitle) {
- $t =& $wgTitle;
- } else {
- if($title) {
- $t = Title::newFromURL( $title );
- } else {
- $t = Title::newFromText( wfMsgNoDB( "mainpage" ) );
- }
- }
-
- $cache = new CacheManager( $t );
- if( $cache->isFileCached() ) {
- $msg = "<p style='color: red'><b>$msg<br>\n" .
- wfMsgNoDB( "cachederror" ) . "</b></p>\n";
-
- $tag = "<div id='article'>";
- $text = str_replace(
- $tag,
- $tag . $msg,
- $cache->fetchPageText() );
- }
+/**
+ * Get a row from a database result
+ * @return object|false row we requested
+ */
+function wfFetchRow( $res, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->fetchRow ( $res, $dbi = DB_LAST );
+ } else {
+ return false;
}
-
- /* Don't cache error pages! They cause no end of trouble... */
- header( "Cache-control: none" );
- header( "Pragma: nocache" );
- echo $text;
- wfAbruptExit();
}
-# $db: DB_READ = -1 read from slave (or only server)
-# DB_WRITE = -2 write to master (or only server)
-# 0,1,2,... query a database with a specific index
-# Replication is not actually implemented just yet
-function wfQuery( $sql, $db, $fname = "" )
-{
- global $wgLastDatabaseQuery, $wgOut, $wgDebugDumpSql, $wgBufferSQLResults,
- $wgIgnoreSQLErrors, $wgProfiling;
+/**
+ * Get a number of rows from a database result
+ * @return integer|false number of rows
+ */
+function wfNumRows( $res, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->numRows( $res, $dbi = DB_LAST );
+ } else {
+ return false;
+ }
+}
- if ( $wgProfiling ) {
- # wfGeneralizeSQL will probably cut down the query to reasonable
- # logging size most of the time. The substr is really just a sanity check.
- $profName = "wfQuery: " . substr( wfGeneralizeSQL( $sql ), 0, 255 );
- wfProfileIn( $profName );
+/**
+ * Get the number of fields from a database result
+ * @return integer|false number of fields
+ */
+function wfNumFields( $res, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->numFields( $res );
+ } else {
+ return false;
}
+}
- if ( !is_numeric( $db ) ) {
- # Someone has tried to call this the old way
- $wgOut->fatalError( wfMsgNoDB( "wrong_wfQuery_params", $db, $sql ) );
+/**
+ * Return name of a field in a result
+ * @param $res Mixed: Ressource link see Database::fieldName()
+ * @param $n Integer: id of the field
+ * @param $dbi Default DB_LAST
+ * @return string|false name of field
+ */
+function wfFieldName( $res, $n, $dbi = DB_LAST )
+{
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->fieldName( $res, $n, $dbi = DB_LAST );
+ } else {
+ return false;
}
-
- $wgLastDatabaseQuery = $sql;
-
- if( $wgDebugDumpSql ) {
- $sqlx = substr( $sql, 0, 500 );
- $sqlx = wordwrap(strtr($sqlx,"\t\n"," "));
- wfDebug( "SQL: $sqlx\n" );
+}
+/**#@-*/
+
+/**
+ * @todo document function
+ * @see Database::insertId()
+ */
+function wfInsertId( $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->insertId();
+ } else {
+ return false;
}
+}
- $conn = wfGetDB();
- if( $wgBufferSQLResults ) {
- $ret = mysql_query( $sql, $conn );
+/**
+ * @todo document function
+ * @see Database::dataSeek()
+ */
+function wfDataSeek( $res, $row, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->dataSeek( $res, $row );
} else {
- $ret = mysql_unbuffered_query( $sql, $conn );
+ return false;
}
+}
- if ( false === $ret ) {
- if( $wgIgnoreSQLErrors ) {
- wfDebug("SQL ERROR (ignored): " . mysql_error( $conn ) . "\n");
- } else {
- wfDebug("SQL ERROR: " . mysql_error( $conn ) . "\n");
- $wgOut->databaseError( $fname ); // calls wfAbruptExit()
- }
- }
-
- if ( $wgProfiling ) {
- wfProfileOut( $profName );
+/**
+ * Get the last error number
+ * @see Database::lastErrno()
+ */
+function wfLastErrno( $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->lastErrno();
+ } else {
+ return false;
}
- return $ret;
}
-# Turns buffering of SQL result sets on (true) or off (false). Default is
-# "on" and it should not be changed without good reasons.
-# Returns the previous state.
-
-function wfBufferSQLResults( $newstate ){
- global $wgBufferSQLResults;
- $oldstate = $wgBufferSQLResults;
- $wgBufferSQLResults = $newstate;
- return $oldstate;
+/**
+ * Get the last error
+ * @see Database::lastError()
+ */
+function wfLastError( $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->lastError();
+ } else {
+ return false;
+ }
}
-# Turns on (false) or off (true) the automatic generation and sending
-# of a "we're sorry, but there has been a database error" page on
-# database errors. Default is on (false). When turned off, the
-# code should use wfLastErrno() and wfLastError() to handle the
-# situation as appropriate.
-# Returns the previous state.
-
-function wfIgnoreSQLErrors( $newstate ){
- global $wgIgnoreSQLErrors;
- $oldstate = $wgIgnoreSQLErrors;
- $wgIgnoreSQLErrors = $newstate;
- return $oldstate;
+/**
+ * Get the number of affected rows
+ * @see Database::affectedRows()
+ */
+function wfAffectedRows( $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->affectedRows();
+ } else {
+ return false;
+ }
}
-function wfFreeResult( $res ) { mysql_free_result( $res ); }
-function wfFetchObject( $res ) { return mysql_fetch_object( $res ); }
-function wfNumRows( $res ) { return mysql_num_rows( $res ); }
-function wfNumFields( $res ) { return mysql_num_fields( $res ); }
-function wfFieldName( $res, $n ) { return mysql_field_name( $res, $n ); }
-function wfInsertId() { return mysql_insert_id( wfGetDB() ); }
-function wfDataSeek( $res, $row ) { return mysql_data_seek( $res, $row ); }
-function wfLastErrno() { return mysql_errno(); }
-function wfLastError() { return mysql_error(); }
-function wfAffectedRows() { return mysql_affected_rows( wfGetDB() ); }
-
-function wfLastDBquery()
-{
- global $wgLastDatabaseQuery;
- return $wgLastDatabaseQuery;
+/**
+ * Get the last query ran
+ * @see Database::lastQuery
+ */
+function wfLastDBquery( $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->lastQuery();
+ } else {
+ return false;
+ }
}
-function wfSetSQL( $table, $var, $value, $cond )
+/**
+ * @see Database::Set()
+ * @todo document function
+ * @param $table
+ * @param $var
+ * @param $value
+ * @param $cond
+ * @param $dbi Default DB_MASTER
+ */
+function wfSetSQL( $table, $var, $value, $cond, $dbi = DB_MASTER )
{
- $sql = "UPDATE $table SET $var = '" .
- wfStrencode( $value ) . "' WHERE ($cond)";
- wfQuery( $sql, DB_WRITE, "wfSetSQL" );
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->set( $table, $var, $value, $cond );
+ } else {
+ return false;
+ }
}
-function wfGetSQL( $table, $var, $cond )
-{
- $sql = "SELECT $var FROM $table WHERE ($cond)";
- $result = wfQuery( $sql, DB_READ, "wfGetSQL" );
- $ret = "";
- if ( mysql_num_rows( $result ) > 0 ) {
- $s = mysql_fetch_object( $result );
- $ret = $s->$var;
- mysql_free_result( $result );
+/**
+ * Simple select wrapper, return one field
+ * @see Database::selectField()
+ * @param $table
+ * @param $var
+ * @param $cond Default ''
+ * @param $dbi Default DB_LAST
+ */
+function wfGetSQL( $table, $var, $cond='', $dbi = DB_LAST )
+{
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->selectField( $table, $var, $cond );
+ } else {
+ return false;
}
- return $ret;
}
-function wfStrencode( $s )
-{
- return addslashes( $s );
+/**
+ * Does a given field exist on the specified table?
+ * @see Database::fieldExists()
+ * @param $table
+ * @param $field
+ * @param $dbi Default DB_LAST
+ * @return Result of Database::fieldExists() or false.
+ */
+function wfFieldExists( $table, $field, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->fieldExists( $table, $field );
+ } else {
+ return false;
+ }
}
-# Ideally we'd be using actual time fields in the db
-function wfTimestamp2Unix( $ts ) {
- return gmmktime( ( (int)substr( $ts, 8, 2) ),
- (int)substr( $ts, 10, 2 ), (int)substr( $ts, 12, 2 ),
- (int)substr( $ts, 4, 2 ), (int)substr( $ts, 6, 2 ),
- (int)substr( $ts, 0, 4 ) );
+/**
+ * Does the requested index exist on the specified table?
+ * @see Database::indexExists()
+ * @param $table String
+ * @param $index
+ * @param $dbi Default DB_LAST
+ * @return Result of Database::indexExists() or false.
+ */
+function wfIndexExists( $table, $index, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->indexExists( $table, $index );
+ } else {
+ return false;
+ }
}
-function wfUnix2Timestamp( $unixtime ) {
- return gmdate( "YmdHis", $unixtime );
+/**
+ * @see Database::insert()
+ * @todo document function
+ * @param $table String
+ * @param $array Array
+ * @param $fname String, default 'wfInsertArray'.
+ * @param $dbi Default DB_MASTER
+ * @return result of Database::insert() or false.
+ */
+function wfInsertArray( $table, $array, $fname = 'wfInsertArray', $dbi = DB_MASTER ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->insert( $table, $array, $fname );
+ } else {
+ return false;
+ }
}
-function wfTimestampNow() {
- # return NOW
- return gmdate( "YmdHis" );
+/**
+ * @see Database::getArray()
+ * @todo document function
+ * @param $table String
+ * @param $vars
+ * @param $conds
+ * @param $fname String, default 'wfGetArray'.
+ * @param $dbi Default DB_LAST
+ * @return result of Database::getArray() or false.
+ */
+function wfGetArray( $table, $vars, $conds, $fname = 'wfGetArray', $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->getArray( $table, $vars, $conds, $fname );
+ } else {
+ return false;
+ }
}
-# Sorting hack for MySQL 3, which doesn't use index sorts for DESC
-function wfInvertTimestamp( $ts ) {
- return strtr(
- $ts,
- "0123456789",
- "9876543210"
- );
+/**
+ * @see Database::update()
+ * @param $table String
+ * @param $values
+ * @param $conds
+ * @param $fname String, default 'wfUpdateArray'
+ * @param $dbi Default DB_MASTER
+ * @return Result of Database::update()) or false;
+ * @todo document function
+ */
+function wfUpdateArray( $table, $values, $conds, $fname = 'wfUpdateArray', $dbi = DB_MASTER ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ $db->update( $table, $values, $conds, $fname );
+ return true;
+ } else {
+ return false;
+ }
}
-# Removes most variables from an SQL query and replaces them with X or N for numbers.
-# It's only slightly flawed. Don't use for anything important.
-function wfGeneralizeSQL( $sql )
-{
- # This does the same as the regexp below would do, but in such a way
- # as to avoid crashing php on some large strings.
- # $sql = preg_replace ( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql);
-
- $sql = str_replace ( "\\\\", "", $sql);
- $sql = str_replace ( "\\'", "", $sql);
- $sql = str_replace ( "\\\"", "", $sql);
- $sql = preg_replace ("/'.*'/s", "'X'", $sql);
- $sql = preg_replace ('/".*"/s', "'X'", $sql);
-
- # All newlines, tabs, etc replaced by single space
- $sql = preg_replace ( "/\s+/", " ", $sql);
-
- # All numbers => N
- $sql = preg_replace ('/-?[0-9]+/s', "N", $sql);
+/**
+ * Get fully usable table name
+ * @see Database::tableName()
+ */
+function wfTableName( $name, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->tableName( $name );
+ } else {
+ return false;
+ }
+}
- return $sql;
+/**
+ * @todo document function
+ * @see Database::strencode()
+ */
+function wfStrencode( $s, $dbi = DB_LAST ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->strencode( $s );
+ } else {
+ return false;
+ }
}
-function wfFieldExists( $table, $field )
-{
- $fname = "wfFieldExists";
- $res = wfQuery( "DESCRIBE $table", DB_READ, $fname );
- $found = false;
-
- while ( $row = wfFetchObject( $res ) ) {
- if ( $row->Field == $field ) {
- $found = true;
- break;
- }
+/**
+ * @todo document function
+ * @see Database::nextSequenceValue()
+ */
+function wfNextSequenceValue( $seqName, $dbi = DB_MASTER ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->nextSequenceValue( $seqName );
+ } else {
+ return false;
}
- return $found;
}
-function wfIndexExists( $table, $index )
-{
- global $wgDBname;
- $fname = "wfIndexExists";
- $sql = "SHOW INDEXES FROM $table";
- $res = wfQuery( $sql, DB_READ, $fname );
- $found = false;
- while ( $row = wfFetchObject( $res ) ) {
- if ( $row->Key_name == $index ) {
- $found = true;
- break;
- }
+/**
+ * @todo document function
+ * @see Database::useIndexClause()
+ */
+function wfUseIndexClause( $index, $dbi = DB_SLAVE ) {
+ $db = wfGetDB( $dbi );
+ if ( $db !== false ) {
+ return $db->useIndexClause( $index );
+ } else {
+ return false;
}
- return $found;
}
-?>