Merge "Consistently follow conventions for documenting parameters"
[lhc/web/wiklou.git] / includes / db / DatabaseMysql.php
1 <?php
2 /**
3 * This is the MySQL database abstraction layer.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup Database
22 */
23
24 /**
25 * Database abstraction object for PHP extension mysql.
26 *
27 * @ingroup Database
28 * @see Database
29 */
30 class DatabaseMysql extends DatabaseMysqlBase {
31
32 /**
33 * @param $sql string
34 * @return resource
35 */
36 protected function doQuery( $sql ) {
37 if ( $this->bufferResults() ) {
38 $ret = mysql_query( $sql, $this->mConn );
39 } else {
40 $ret = mysql_unbuffered_query( $sql, $this->mConn );
41 }
42 return $ret;
43 }
44
45 protected function mysqlConnect( $realServer ) {
46 # Load mysql.so if we don't have it
47 wfDl( 'mysql' );
48
49 # Fail now
50 # Otherwise we get a suppressed fatal error, which is very hard to track down
51 if ( !function_exists( 'mysql_connect' ) ) {
52 throw new DBConnectionError( $this, "MySQL functions missing, have you compiled PHP with the --with-mysql option?\n" );
53 }
54
55 $connFlags = 0;
56 if ( $this->mFlags & DBO_SSL ) {
57 $connFlags |= MYSQL_CLIENT_SSL;
58 }
59 if ( $this->mFlags & DBO_COMPRESS ) {
60 $connFlags |= MYSQL_CLIENT_COMPRESS;
61 }
62
63 if ( ini_get( 'mysql.connect_timeout' ) <= 3 ) {
64 $numAttempts = 2;
65 } else {
66 $numAttempts = 1;
67 }
68
69 $conn = false;
70
71 for ( $i = 0; $i < $numAttempts && !$conn; $i++ ) {
72 if ( $i > 1 ) {
73 usleep( 1000 );
74 }
75 if ( $this->mFlags & DBO_PERSISTENT ) {
76 $conn = mysql_pconnect( $realServer, $this->mUser, $this->mPassword, $connFlags );
77 } else {
78 # Create a new connection...
79 $conn = mysql_connect( $realServer, $this->mUser, $this->mPassword, true, $connFlags );
80 }
81 }
82
83 return $conn;
84 }
85
86 /**
87 * @return bool
88 */
89 protected function closeConnection() {
90 return mysql_close( $this->mConn );
91 }
92
93 /**
94 * @return int
95 */
96 function insertId() {
97 return mysql_insert_id( $this->mConn );
98 }
99
100 /**
101 * @return int
102 */
103 function lastErrno() {
104 if ( $this->mConn ) {
105 return mysql_errno( $this->mConn );
106 } else {
107 return mysql_errno();
108 }
109 }
110
111 /**
112 * @return int
113 */
114 function affectedRows() {
115 return mysql_affected_rows( $this->mConn );
116 }
117
118 /**
119 * @param $db
120 * @return bool
121 */
122 function selectDB( $db ) {
123 $this->mDBname = $db;
124 return mysql_select_db( $db, $this->mConn );
125 }
126
127 /**
128 * @return string
129 */
130 function getServerVersion() {
131 return mysql_get_server_info( $this->mConn );
132 }
133
134 protected function mysqlFreeResult( $res ) {
135 return mysql_free_result( $res );
136 }
137
138 protected function mysqlFetchObject( $res ) {
139 return mysql_fetch_object( $res );
140 }
141
142 protected function mysqlFetchArray( $res ) {
143 return mysql_fetch_array( $res );
144 }
145
146 protected function mysqlNumRows( $res ) {
147 return mysql_num_rows( $res );
148 }
149
150 protected function mysqlNumFields( $res ) {
151 return mysql_num_fields( $res );
152 }
153
154 protected function mysqlFetchField( $res, $n ) {
155 return mysql_fetch_field( $res, $n );
156 }
157
158 protected function mysqlFieldName( $res, $n ) {
159 return mysql_field_name( $res, $n );
160 }
161
162 protected function mysqlDataSeek( $res, $row ) {
163 return mysql_data_seek( $res, $row );
164 }
165
166 protected function mysqlError( $conn = null ) {
167 return ( $conn !== null ) ? mysql_error( $conn ) : mysql_error(); // avoid warning
168 }
169
170 protected function mysqlRealEscapeString( $s ) {
171 return mysql_real_escape_string( $s, $this->mConn );
172 }
173
174 protected function mysqlPing() {
175 return mysql_ping( $this->mConn );
176 }
177 }