only get the title string if action is not empty
[lhc/web/wiklou.git] / includes / DatabaseFunctions.php
index ebd9b79..c1452c7 100644 (file)
-<?
-include_once( "FulltextStoplist.php" );
-include_once( "CacheManager.php" );
+<?php
 
-define( "DB_READ", -1 );
-define( "DB_WRITE", -2 );
-define( "DB_LAST", -3 );
+# Backwards compatibility wrapper for Database.php
 
-$wgLastDatabaseQuery = "";
+# I imagine this file will eventually become a backwards
+# compatibility wrapper around a load balancer object, and
+# the load balancer will finally call Database, which will
+# represent a single connection
 
-function wfGetDB( $altuser = "", $altpassword = "", $altserver = "", $altdb = "" )
-{
-       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()) );
-       }
+# NB: This file follows a connect on demand scheme. Do 
+# not access the $wgDatabase variable directly unless
+# you intend to set it. Use wfGetDB().
 
-       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();
-               }
-       }
-       # 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() );
-               }
-       }
-       
-       /* Don't cache error pages!  They cause no end of trouble... */
-       header( "Cache-control: none" );
-       header( "Pragma: nocache" );
-       echo $text;
-       exit;
-}
+include_once( "Database.php" );
 
+# Query the database
 # $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
+# Usually aborts on failure
+# If errors are explicitly ignored, returns success
 function wfQuery( $sql, $db, $fname = "" )
 {
-       global $wgLastDatabaseQuery, $wgOut, $wgDebugDumpSql;
-
-        # 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 ); 
+       global $wgDatabase, $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, 
+               $wgDebugDumpSql, $wgBufferSQLResults, $wgIgnoreSQLErrors;
        
-       wfProfileIn( $profName );
-
        if ( !is_numeric( $db ) ) {
                # Someone has tried to call this the old way
                $wgOut->fatalError( wfMsgNoDB( "wrong_wfQuery_params", $db, $sql ) );
        }
-       
-       $wgLastDatabaseQuery = $sql;
-       
-       if( $wgDebugDumpSql ) {
-               $sqlx = substr( $sql, 0, 500 );
-               $sqlx = wordwrap(strtr($sqlx,"\t\n","  "));
-               wfDebug( "SQL: $sqlx\n" );
-       }
 
-       $conn = wfGetDB();
-       $ret = mysql_query( $sql, $conn );
+       $db =&  wfGetDB();
+       return $db->query( $sql, $fname );
+}
 
-       if ( false === $ret ) {
-               $wgOut->databaseError( $fname );
-               exit;
+# Connect on demand
+function &wfGetDB()
+{
+       global $wgDatabase, $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, 
+               $wgDebugDumpSql, $wgBufferSQLResults, $wgIgnoreSQLErrors;
+       if ( !$wgDatabase ) {
+               $wgDatabase = Database::newFromParams( $wgDBserver, $wgDBuser, $wgDBpassword, 
+                       $wgDBname, false, $wgDebugDumpSql, $wgBufferSQLResults, $wgIgnoreSQLErrors );
        }
-       wfProfileOut( $profName );
-       return $ret;
+       return $wgDatabase;
 }
+       
+# 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 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()
+function wfBufferSQLResults( $newstate )
 {
-       global $wgLastDatabaseQuery;
-       return $wgLastDatabaseQuery;
+       $db =& wfGetDB();
+       return $db->setBufferResults( $newstate );
 }
 
-function wfSetSQL( $table, $var, $value, $cond )
+# 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 )
 {
-       $sql = "UPDATE $table SET $var = '" .
-         wfStrencode( $value ) . "' WHERE ($cond)";
-       wfQuery( $sql, DB_WRITE, "wfSetSQL" );
+       $db =& wfGetDB();
+       return $db->setIgnoreErrors( $newstate );
 }
 
-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 );
-       }
-       return $ret;
+function wfFreeResult( $res ) 
+{ 
+       $db =& wfGetDB();
+       $db->freeResult( $res ); 
 }
 
-function wfStrencode( $s )
-{
-       return addslashes( $s );
+function wfFetchObject( $res ) 
+{ 
+       $db =& wfGetDB();
+       return $db->fetchObject( $res ); 
 }
 
-# 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 ) );
+function wfNumRows( $res ) 
+{ 
+       $db =& wfGetDB();
+       return $db->numRows( $res ); 
 }
 
-function wfUnix2Timestamp( $unixtime ) {
-       return gmdate( "YmdHis", $unixtime );
+function wfNumFields( $res ) 
+{ 
+       $db =& wfGetDB();
+       return $db->numFields( $res ); 
 }
 
-function wfTimestampNow() {
-       # return NOW
-       return gmdate( "YmdHis" );
+function wfFieldName( $res, $n ) 
+{ 
+       $db =& wfGetDB();
+       return $db->fieldName( $res, $n ); 
 }
 
-# Sorting hack for MySQL 3, which doesn't use index sorts for DESC
-function wfInvertTimestamp( $ts ) {
-       return strtr(
-               $ts,
-               "0123456789",
-               "9876543210"
-       );
+function wfInsertId() 
+{ 
+       $db =& wfGetDB();
+       return $db->insertId(); 
+}
+function wfDataSeek( $res, $row ) 
+{ 
+       $db =& wfGetDB();
+       return $db->dataSeek( $res, $row ); 
 }
 
-# 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 )
+function wfLastErrno()  
+{ 
+       $db =& wfGetDB();
+       return $db->lastErrno(); 
+}
+
+function wfLastError()  
+{ 
+       $db =& wfGetDB();
+       return $db->lastError(); 
+}
+
+function wfAffectedRows()
+{ 
+       $db =& wfGetDB();
+       return $db->affectedRows(); 
+}
+
+function wfLastDBquery()
+{
+       $db =& wfGetDB();
+       return $db->lastQuery();
+}
+
+function wfSetSQL( $table, $var, $value, $cond )
+{
+       $db =& wfGetDB();
+       return $db->set( $table, $var, $value, $cond );
+}
+
+function wfGetSQL( $table, $var, $cond )
 {
-        # This could be done faster with some arrays and a single preg_replace,
-        # but this show more clearly what's going on. Which may be a good thing.
-        $sql = preg_replace ( "/([\'\"])([^\\\\]|\\\\\\\\)*?\\1/", "\\1X\\1", $sql);
-        $sql = preg_replace ( "/-?\d+/" , "N", $sql);
-        $sql = preg_replace ( "/\s+/", " ", $sql);
-        return $sql;
+       $db =& wfGetDB();
+       return $db->get( $table, $var, $cond );
 }
 
 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;
-               }
-       }
-       return $found;
+       $db =& wfGetDB();
+       return $db->fieldExists( $table, $field );
 }
 
 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;
-               }
-       }
-       return $found;
+       $db =& wfGetDB();
+       return $db->indexExists( $table, $index );
 }
+
+function wfInsertArray( $table, $array ) 
+{
+       $db =& wfGetDB();
+       return $db->insertArray( $table, $array );
+}
+
+function wfGetArray( $table, $vars, $conds, $fname = "wfGetArray" )
+{
+       $db =& wfGetDB();
+       return $db->getArray( $table, $vars, $conds, $fname );
+}
+
+function wfUpdateArray( $table, $values, $conds, $fname = "wfUpdateArray" )
+{
+       $db =& wfGetDB();
+       $db->updateArray( $table, $values, $conds, $fname );
+}
+
 ?>