0
|
1 |
<?php |
|
2 |
/** |
|
3 |
* WordPress DB Class |
|
4 |
* |
|
5 |
* Original code from {@link http://php.justinvincent.com Justin Vincent (justin@visunet.ie)} |
|
6 |
* |
|
7 |
* @package WordPress |
|
8 |
* @subpackage Database |
|
9 |
* @since 0.71 |
|
10 |
*/ |
|
11 |
|
|
12 |
/** |
|
13 |
* @since 0.71 |
|
14 |
*/ |
|
15 |
define( 'EZSQL_VERSION', 'WP1.25' ); |
|
16 |
|
|
17 |
/** |
|
18 |
* @since 0.71 |
|
19 |
*/ |
5
|
20 |
define( 'OBJECT', 'OBJECT' ); |
|
21 |
define( 'object', 'OBJECT' ); // Back compat. |
0
|
22 |
|
|
23 |
/** |
|
24 |
* @since 2.5.0 |
|
25 |
*/ |
|
26 |
define( 'OBJECT_K', 'OBJECT_K' ); |
|
27 |
|
|
28 |
/** |
|
29 |
* @since 0.71 |
|
30 |
*/ |
|
31 |
define( 'ARRAY_A', 'ARRAY_A' ); |
|
32 |
|
|
33 |
/** |
|
34 |
* @since 0.71 |
|
35 |
*/ |
|
36 |
define( 'ARRAY_N', 'ARRAY_N' ); |
|
37 |
|
|
38 |
/** |
|
39 |
* WordPress Database Access Abstraction Object |
|
40 |
* |
|
41 |
* It is possible to replace this class with your own |
|
42 |
* by setting the $wpdb global variable in wp-content/db.php |
|
43 |
* file to your class. The wpdb class will still be included, |
|
44 |
* so you can extend it or simply use your own. |
|
45 |
* |
5
|
46 |
* @link https://codex.wordpress.org/Function_Reference/wpdb_Class |
0
|
47 |
* |
|
48 |
* @package WordPress |
|
49 |
* @subpackage Database |
|
50 |
* @since 0.71 |
|
51 |
*/ |
|
52 |
class wpdb { |
|
53 |
|
|
54 |
/** |
5
|
55 |
* Whether to show SQL/DB errors. |
|
56 |
* |
|
57 |
* Default behavior is to show errors if both WP_DEBUG and WP_DEBUG_DISPLAY |
|
58 |
* evaluated to true. |
0
|
59 |
* |
|
60 |
* @since 0.71 |
|
61 |
* @access private |
|
62 |
* @var bool |
|
63 |
*/ |
|
64 |
var $show_errors = false; |
|
65 |
|
|
66 |
/** |
|
67 |
* Whether to suppress errors during the DB bootstrapping. |
|
68 |
* |
|
69 |
* @access private |
|
70 |
* @since 2.5.0 |
|
71 |
* @var bool |
|
72 |
*/ |
|
73 |
var $suppress_errors = false; |
|
74 |
|
|
75 |
/** |
|
76 |
* The last error during query. |
|
77 |
* |
|
78 |
* @since 2.5.0 |
|
79 |
* @var string |
|
80 |
*/ |
5
|
81 |
public $last_error = ''; |
0
|
82 |
|
|
83 |
/** |
|
84 |
* Amount of queries made |
|
85 |
* |
|
86 |
* @since 1.2.0 |
|
87 |
* @access private |
|
88 |
* @var int |
|
89 |
*/ |
|
90 |
var $num_queries = 0; |
|
91 |
|
|
92 |
/** |
|
93 |
* Count of rows returned by previous query |
|
94 |
* |
|
95 |
* @since 0.71 |
|
96 |
* @access private |
|
97 |
* @var int |
|
98 |
*/ |
|
99 |
var $num_rows = 0; |
|
100 |
|
|
101 |
/** |
|
102 |
* Count of affected rows by previous query |
|
103 |
* |
|
104 |
* @since 0.71 |
|
105 |
* @access private |
|
106 |
* @var int |
|
107 |
*/ |
|
108 |
var $rows_affected = 0; |
|
109 |
|
|
110 |
/** |
|
111 |
* The ID generated for an AUTO_INCREMENT column by the previous query (usually INSERT). |
|
112 |
* |
|
113 |
* @since 0.71 |
|
114 |
* @access public |
|
115 |
* @var int |
|
116 |
*/ |
|
117 |
var $insert_id = 0; |
|
118 |
|
|
119 |
/** |
|
120 |
* Last query made |
|
121 |
* |
|
122 |
* @since 0.71 |
|
123 |
* @access private |
|
124 |
* @var array |
|
125 |
*/ |
|
126 |
var $last_query; |
|
127 |
|
|
128 |
/** |
|
129 |
* Results of the last query made |
|
130 |
* |
|
131 |
* @since 0.71 |
|
132 |
* @access private |
|
133 |
* @var array|null |
|
134 |
*/ |
|
135 |
var $last_result; |
|
136 |
|
|
137 |
/** |
|
138 |
* MySQL result, which is either a resource or boolean. |
|
139 |
* |
|
140 |
* @since 0.71 |
|
141 |
* @access protected |
|
142 |
* @var mixed |
|
143 |
*/ |
|
144 |
protected $result; |
|
145 |
|
|
146 |
/** |
5
|
147 |
* Cached column info, for sanity checking data before inserting |
|
148 |
* |
|
149 |
* @since 4.2.0 |
|
150 |
* @access protected |
|
151 |
* @var array |
|
152 |
*/ |
|
153 |
protected $col_meta = array(); |
|
154 |
|
|
155 |
/** |
|
156 |
* Calculated character sets on tables |
|
157 |
* |
|
158 |
* @since 4.2.0 |
|
159 |
* @access protected |
|
160 |
* @var array |
|
161 |
*/ |
|
162 |
protected $table_charset = array(); |
|
163 |
|
|
164 |
/** |
|
165 |
* Whether text fields in the current query need to be sanity checked. |
|
166 |
* |
|
167 |
* @since 4.2.0 |
|
168 |
* @access protected |
|
169 |
* @var bool |
|
170 |
*/ |
|
171 |
protected $check_current_query = true; |
|
172 |
|
|
173 |
/** |
|
174 |
* Flag to ensure we don't run into recursion problems when checking the collation. |
|
175 |
* |
|
176 |
* @since 4.2.0 |
|
177 |
* @access private |
|
178 |
* @see wpdb::check_safe_collation() |
|
179 |
* @var boolean |
|
180 |
*/ |
|
181 |
private $checking_collation = false; |
|
182 |
|
|
183 |
/** |
0
|
184 |
* Saved info on the table column |
|
185 |
* |
|
186 |
* @since 0.71 |
|
187 |
* @access protected |
|
188 |
* @var array |
|
189 |
*/ |
|
190 |
protected $col_info; |
|
191 |
|
|
192 |
/** |
|
193 |
* Saved queries that were executed |
|
194 |
* |
|
195 |
* @since 1.5.0 |
|
196 |
* @access private |
|
197 |
* @var array |
|
198 |
*/ |
|
199 |
var $queries; |
|
200 |
|
|
201 |
/** |
5
|
202 |
* The number of times to retry reconnecting before dying. |
|
203 |
* |
|
204 |
* @since 3.9.0 |
|
205 |
* @access protected |
|
206 |
* @see wpdb::check_connection() |
|
207 |
* @var int |
|
208 |
*/ |
|
209 |
protected $reconnect_retries = 5; |
|
210 |
|
|
211 |
/** |
0
|
212 |
* WordPress table prefix |
|
213 |
* |
|
214 |
* You can set this to have multiple WordPress installations |
|
215 |
* in a single database. The second reason is for possible |
|
216 |
* security precautions. |
|
217 |
* |
|
218 |
* @since 2.5.0 |
|
219 |
* @access private |
|
220 |
* @var string |
|
221 |
*/ |
|
222 |
var $prefix = ''; |
|
223 |
|
|
224 |
/** |
5
|
225 |
* WordPress base table prefix. |
|
226 |
* |
|
227 |
* @since 3.0.0 |
|
228 |
* @access public |
|
229 |
* @var string |
|
230 |
*/ |
|
231 |
public $base_prefix; |
|
232 |
|
|
233 |
/** |
0
|
234 |
* Whether the database queries are ready to start executing. |
|
235 |
* |
|
236 |
* @since 2.3.2 |
|
237 |
* @access private |
|
238 |
* @var bool |
|
239 |
*/ |
|
240 |
var $ready = false; |
|
241 |
|
|
242 |
/** |
5
|
243 |
* Blog ID. |
0
|
244 |
* |
|
245 |
* @since 3.0.0 |
|
246 |
* @access public |
|
247 |
* @var int |
|
248 |
*/ |
5
|
249 |
public $blogid = 0; |
0
|
250 |
|
|
251 |
/** |
5
|
252 |
* Site ID. |
0
|
253 |
* |
|
254 |
* @since 3.0.0 |
|
255 |
* @access public |
|
256 |
* @var int |
|
257 |
*/ |
5
|
258 |
public $siteid = 0; |
0
|
259 |
|
|
260 |
/** |
|
261 |
* List of WordPress per-blog tables |
|
262 |
* |
|
263 |
* @since 2.5.0 |
|
264 |
* @access private |
|
265 |
* @see wpdb::tables() |
|
266 |
* @var array |
|
267 |
*/ |
|
268 |
var $tables = array( 'posts', 'comments', 'links', 'options', 'postmeta', |
|
269 |
'terms', 'term_taxonomy', 'term_relationships', 'commentmeta' ); |
|
270 |
|
|
271 |
/** |
|
272 |
* List of deprecated WordPress tables |
|
273 |
* |
|
274 |
* categories, post2cat, and link2cat were deprecated in 2.3.0, db version 5539 |
|
275 |
* |
|
276 |
* @since 2.9.0 |
|
277 |
* @access private |
|
278 |
* @see wpdb::tables() |
|
279 |
* @var array |
|
280 |
*/ |
|
281 |
var $old_tables = array( 'categories', 'post2cat', 'link2cat' ); |
|
282 |
|
|
283 |
/** |
|
284 |
* List of WordPress global tables |
|
285 |
* |
|
286 |
* @since 3.0.0 |
|
287 |
* @access private |
|
288 |
* @see wpdb::tables() |
|
289 |
* @var array |
|
290 |
*/ |
|
291 |
var $global_tables = array( 'users', 'usermeta' ); |
|
292 |
|
|
293 |
/** |
|
294 |
* List of Multisite global tables |
|
295 |
* |
|
296 |
* @since 3.0.0 |
|
297 |
* @access private |
|
298 |
* @see wpdb::tables() |
|
299 |
* @var array |
|
300 |
*/ |
|
301 |
var $ms_global_tables = array( 'blogs', 'signups', 'site', 'sitemeta', |
|
302 |
'sitecategories', 'registration_log', 'blog_versions' ); |
|
303 |
|
|
304 |
/** |
|
305 |
* WordPress Comments table |
|
306 |
* |
|
307 |
* @since 1.5.0 |
|
308 |
* @access public |
|
309 |
* @var string |
|
310 |
*/ |
5
|
311 |
public $comments; |
0
|
312 |
|
|
313 |
/** |
|
314 |
* WordPress Comment Metadata table |
|
315 |
* |
|
316 |
* @since 2.9.0 |
|
317 |
* @access public |
|
318 |
* @var string |
|
319 |
*/ |
5
|
320 |
public $commentmeta; |
0
|
321 |
|
|
322 |
/** |
|
323 |
* WordPress Links table |
|
324 |
* |
|
325 |
* @since 1.5.0 |
|
326 |
* @access public |
|
327 |
* @var string |
|
328 |
*/ |
5
|
329 |
public $links; |
0
|
330 |
|
|
331 |
/** |
|
332 |
* WordPress Options table |
|
333 |
* |
|
334 |
* @since 1.5.0 |
|
335 |
* @access public |
|
336 |
* @var string |
|
337 |
*/ |
5
|
338 |
public $options; |
0
|
339 |
|
|
340 |
/** |
|
341 |
* WordPress Post Metadata table |
|
342 |
* |
|
343 |
* @since 1.5.0 |
|
344 |
* @access public |
|
345 |
* @var string |
|
346 |
*/ |
5
|
347 |
public $postmeta; |
0
|
348 |
|
|
349 |
/** |
|
350 |
* WordPress Posts table |
|
351 |
* |
|
352 |
* @since 1.5.0 |
|
353 |
* @access public |
|
354 |
* @var string |
|
355 |
*/ |
5
|
356 |
public $posts; |
0
|
357 |
|
|
358 |
/** |
|
359 |
* WordPress Terms table |
|
360 |
* |
|
361 |
* @since 2.3.0 |
|
362 |
* @access public |
|
363 |
* @var string |
|
364 |
*/ |
5
|
365 |
public $terms; |
0
|
366 |
|
|
367 |
/** |
|
368 |
* WordPress Term Relationships table |
|
369 |
* |
|
370 |
* @since 2.3.0 |
|
371 |
* @access public |
|
372 |
* @var string |
|
373 |
*/ |
5
|
374 |
public $term_relationships; |
0
|
375 |
|
|
376 |
/** |
|
377 |
* WordPress Term Taxonomy table |
|
378 |
* |
|
379 |
* @since 2.3.0 |
|
380 |
* @access public |
|
381 |
* @var string |
|
382 |
*/ |
5
|
383 |
public $term_taxonomy; |
0
|
384 |
|
|
385 |
/* |
|
386 |
* Global and Multisite tables |
|
387 |
*/ |
|
388 |
|
|
389 |
/** |
|
390 |
* WordPress User Metadata table |
|
391 |
* |
|
392 |
* @since 2.3.0 |
|
393 |
* @access public |
|
394 |
* @var string |
|
395 |
*/ |
5
|
396 |
public $usermeta; |
0
|
397 |
|
|
398 |
/** |
|
399 |
* WordPress Users table |
|
400 |
* |
|
401 |
* @since 1.5.0 |
|
402 |
* @access public |
|
403 |
* @var string |
|
404 |
*/ |
5
|
405 |
public $users; |
0
|
406 |
|
|
407 |
/** |
|
408 |
* Multisite Blogs table |
|
409 |
* |
|
410 |
* @since 3.0.0 |
|
411 |
* @access public |
|
412 |
* @var string |
|
413 |
*/ |
5
|
414 |
public $blogs; |
0
|
415 |
|
|
416 |
/** |
|
417 |
* Multisite Blog Versions table |
|
418 |
* |
|
419 |
* @since 3.0.0 |
|
420 |
* @access public |
|
421 |
* @var string |
|
422 |
*/ |
5
|
423 |
public $blog_versions; |
0
|
424 |
|
|
425 |
/** |
|
426 |
* Multisite Registration Log table |
|
427 |
* |
|
428 |
* @since 3.0.0 |
|
429 |
* @access public |
|
430 |
* @var string |
|
431 |
*/ |
5
|
432 |
public $registration_log; |
0
|
433 |
|
|
434 |
/** |
|
435 |
* Multisite Signups table |
|
436 |
* |
|
437 |
* @since 3.0.0 |
|
438 |
* @access public |
|
439 |
* @var string |
|
440 |
*/ |
5
|
441 |
public $signups; |
0
|
442 |
|
|
443 |
/** |
|
444 |
* Multisite Sites table |
|
445 |
* |
|
446 |
* @since 3.0.0 |
|
447 |
* @access public |
|
448 |
* @var string |
|
449 |
*/ |
5
|
450 |
public $site; |
0
|
451 |
|
|
452 |
/** |
|
453 |
* Multisite Sitewide Terms table |
|
454 |
* |
|
455 |
* @since 3.0.0 |
|
456 |
* @access public |
|
457 |
* @var string |
|
458 |
*/ |
5
|
459 |
public $sitecategories; |
0
|
460 |
|
|
461 |
/** |
|
462 |
* Multisite Site Metadata table |
|
463 |
* |
|
464 |
* @since 3.0.0 |
|
465 |
* @access public |
|
466 |
* @var string |
|
467 |
*/ |
5
|
468 |
public $sitemeta; |
0
|
469 |
|
|
470 |
/** |
|
471 |
* Format specifiers for DB columns. Columns not listed here default to %s. Initialized during WP load. |
|
472 |
* |
|
473 |
* Keys are column names, values are format types: 'ID' => '%d' |
|
474 |
* |
|
475 |
* @since 2.8.0 |
|
476 |
* @see wpdb::prepare() |
|
477 |
* @see wpdb::insert() |
|
478 |
* @see wpdb::update() |
|
479 |
* @see wpdb::delete() |
|
480 |
* @see wp_set_wpdb_vars() |
|
481 |
* @access public |
|
482 |
* @var array |
|
483 |
*/ |
5
|
484 |
public $field_types = array(); |
0
|
485 |
|
|
486 |
/** |
|
487 |
* Database table columns charset |
|
488 |
* |
|
489 |
* @since 2.2.0 |
|
490 |
* @access public |
|
491 |
* @var string |
|
492 |
*/ |
5
|
493 |
public $charset; |
0
|
494 |
|
|
495 |
/** |
|
496 |
* Database table columns collate |
|
497 |
* |
|
498 |
* @since 2.2.0 |
|
499 |
* @access public |
|
500 |
* @var string |
|
501 |
*/ |
5
|
502 |
public $collate; |
0
|
503 |
|
|
504 |
/** |
|
505 |
* Database Username |
|
506 |
* |
|
507 |
* @since 2.9.0 |
|
508 |
* @access protected |
|
509 |
* @var string |
|
510 |
*/ |
|
511 |
protected $dbuser; |
|
512 |
|
|
513 |
/** |
|
514 |
* Database Password |
|
515 |
* |
|
516 |
* @since 3.1.0 |
|
517 |
* @access protected |
|
518 |
* @var string |
|
519 |
*/ |
|
520 |
protected $dbpassword; |
|
521 |
|
|
522 |
/** |
|
523 |
* Database Name |
|
524 |
* |
|
525 |
* @since 3.1.0 |
|
526 |
* @access protected |
|
527 |
* @var string |
|
528 |
*/ |
|
529 |
protected $dbname; |
|
530 |
|
|
531 |
/** |
|
532 |
* Database Host |
|
533 |
* |
|
534 |
* @since 3.1.0 |
|
535 |
* @access protected |
|
536 |
* @var string |
|
537 |
*/ |
|
538 |
protected $dbhost; |
|
539 |
|
|
540 |
/** |
|
541 |
* Database Handle |
|
542 |
* |
|
543 |
* @since 0.71 |
|
544 |
* @access protected |
|
545 |
* @var string |
|
546 |
*/ |
|
547 |
protected $dbh; |
|
548 |
|
|
549 |
/** |
|
550 |
* A textual description of the last query/get_row/get_var call |
|
551 |
* |
|
552 |
* @since 3.0.0 |
|
553 |
* @access public |
|
554 |
* @var string |
|
555 |
*/ |
5
|
556 |
public $func_call; |
0
|
557 |
|
|
558 |
/** |
|
559 |
* Whether MySQL is used as the database engine. |
|
560 |
* |
|
561 |
* Set in WPDB::db_connect() to true, by default. This is used when checking |
|
562 |
* against the required MySQL version for WordPress. Normally, a replacement |
|
563 |
* database drop-in (db.php) will skip these checks, but setting this to true |
|
564 |
* will force the checks to occur. |
|
565 |
* |
|
566 |
* @since 3.3.0 |
|
567 |
* @access public |
|
568 |
* @var bool |
|
569 |
*/ |
|
570 |
public $is_mysql = null; |
|
571 |
|
|
572 |
/** |
5
|
573 |
* A list of incompatible SQL modes. |
|
574 |
* |
|
575 |
* @since 3.9.0 |
|
576 |
* @access protected |
|
577 |
* @var array |
|
578 |
*/ |
|
579 |
protected $incompatible_modes = array( 'NO_ZERO_DATE', 'ONLY_FULL_GROUP_BY', |
|
580 |
'STRICT_TRANS_TABLES', 'STRICT_ALL_TABLES', 'TRADITIONAL' ); |
|
581 |
|
|
582 |
/** |
|
583 |
* Whether to use mysqli over mysql. |
|
584 |
* |
|
585 |
* @since 3.9.0 |
|
586 |
* @access private |
|
587 |
* @var bool |
|
588 |
*/ |
|
589 |
private $use_mysqli = false; |
|
590 |
|
|
591 |
/** |
|
592 |
* Whether we've managed to successfully connect at some point |
|
593 |
* |
|
594 |
* @since 3.9.0 |
|
595 |
* @access private |
|
596 |
* @var bool |
|
597 |
*/ |
|
598 |
private $has_connected = false; |
|
599 |
|
|
600 |
/** |
0
|
601 |
* Connects to the database server and selects a database |
|
602 |
* |
|
603 |
* PHP5 style constructor for compatibility with PHP5. Does |
|
604 |
* the actual setting up of the class properties and connection |
|
605 |
* to the database. |
|
606 |
* |
5
|
607 |
* @link https://core.trac.wordpress.org/ticket/3354 |
0
|
608 |
* @since 2.0.8 |
|
609 |
* |
|
610 |
* @param string $dbuser MySQL database user |
|
611 |
* @param string $dbpassword MySQL database password |
|
612 |
* @param string $dbname MySQL database name |
|
613 |
* @param string $dbhost MySQL database host |
|
614 |
*/ |
5
|
615 |
public function __construct( $dbuser, $dbpassword, $dbname, $dbhost ) { |
0
|
616 |
register_shutdown_function( array( $this, '__destruct' ) ); |
|
617 |
|
|
618 |
if ( WP_DEBUG && WP_DEBUG_DISPLAY ) |
|
619 |
$this->show_errors(); |
|
620 |
|
5
|
621 |
/* Use ext/mysqli if it exists and: |
|
622 |
* - WP_USE_EXT_MYSQL is defined as false, or |
|
623 |
* - We are a development version of WordPress, or |
|
624 |
* - We are running PHP 5.5 or greater, or |
|
625 |
* - ext/mysql is not loaded. |
|
626 |
*/ |
|
627 |
if ( function_exists( 'mysqli_connect' ) ) { |
|
628 |
if ( defined( 'WP_USE_EXT_MYSQL' ) ) { |
|
629 |
$this->use_mysqli = ! WP_USE_EXT_MYSQL; |
|
630 |
} elseif ( version_compare( phpversion(), '5.5', '>=' ) || ! function_exists( 'mysql_connect' ) ) { |
|
631 |
$this->use_mysqli = true; |
|
632 |
} elseif ( false !== strpos( $GLOBALS['wp_version'], '-' ) ) { |
|
633 |
$this->use_mysqli = true; |
|
634 |
} |
|
635 |
} |
0
|
636 |
|
|
637 |
$this->dbuser = $dbuser; |
|
638 |
$this->dbpassword = $dbpassword; |
|
639 |
$this->dbname = $dbname; |
|
640 |
$this->dbhost = $dbhost; |
|
641 |
|
5
|
642 |
// wp-config.php creation will manually connect when ready. |
|
643 |
if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
644 |
return; |
|
645 |
} |
|
646 |
|
0
|
647 |
$this->db_connect(); |
|
648 |
} |
|
649 |
|
|
650 |
/** |
|
651 |
* PHP5 style destructor and will run when database object is destroyed. |
|
652 |
* |
|
653 |
* @see wpdb::__construct() |
|
654 |
* @since 2.0.8 |
|
655 |
* @return bool true |
|
656 |
*/ |
5
|
657 |
public function __destruct() { |
0
|
658 |
return true; |
|
659 |
} |
|
660 |
|
|
661 |
/** |
|
662 |
* PHP5 style magic getter, used to lazy-load expensive data. |
|
663 |
* |
|
664 |
* @since 3.5.0 |
|
665 |
* |
|
666 |
* @param string $name The private member to get, and optionally process |
|
667 |
* @return mixed The private member |
|
668 |
*/ |
5
|
669 |
public function __get( $name ) { |
|
670 |
if ( 'col_info' === $name ) |
0
|
671 |
$this->load_col_info(); |
|
672 |
|
|
673 |
return $this->$name; |
|
674 |
} |
|
675 |
|
|
676 |
/** |
5
|
677 |
* Magic function, for backwards compatibility. |
0
|
678 |
* |
|
679 |
* @since 3.5.0 |
|
680 |
* |
|
681 |
* @param string $name The private member to set |
|
682 |
* @param mixed $value The value to set |
|
683 |
*/ |
5
|
684 |
public function __set( $name, $value ) { |
|
685 |
$protected_members = array( |
|
686 |
'col_meta', |
|
687 |
'table_charset', |
|
688 |
'check_current_query', |
|
689 |
); |
|
690 |
if ( in_array( $name, $protected_members, true ) ) { |
|
691 |
return; |
|
692 |
} |
0
|
693 |
$this->$name = $value; |
|
694 |
} |
|
695 |
|
|
696 |
/** |
5
|
697 |
* Magic function, for backwards compatibility. |
0
|
698 |
* |
|
699 |
* @since 3.5.0 |
|
700 |
* |
|
701 |
* @param string $name The private member to check |
|
702 |
* |
|
703 |
* @return bool If the member is set or not |
|
704 |
*/ |
5
|
705 |
public function __isset( $name ) { |
0
|
706 |
return isset( $this->$name ); |
|
707 |
} |
|
708 |
|
|
709 |
/** |
5
|
710 |
* Magic function, for backwards compatibility. |
0
|
711 |
* |
|
712 |
* @since 3.5.0 |
|
713 |
* |
|
714 |
* @param string $name The private member to unset |
|
715 |
*/ |
5
|
716 |
public function __unset( $name ) { |
0
|
717 |
unset( $this->$name ); |
|
718 |
} |
|
719 |
|
|
720 |
/** |
|
721 |
* Set $this->charset and $this->collate |
|
722 |
* |
|
723 |
* @since 3.1.0 |
|
724 |
*/ |
5
|
725 |
public function init_charset() { |
0
|
726 |
if ( function_exists('is_multisite') && is_multisite() ) { |
|
727 |
$this->charset = 'utf8'; |
5
|
728 |
if ( defined( 'DB_COLLATE' ) && DB_COLLATE ) { |
0
|
729 |
$this->collate = DB_COLLATE; |
5
|
730 |
} else { |
0
|
731 |
$this->collate = 'utf8_general_ci'; |
5
|
732 |
} |
0
|
733 |
} elseif ( defined( 'DB_COLLATE' ) ) { |
|
734 |
$this->collate = DB_COLLATE; |
|
735 |
} |
|
736 |
|
5
|
737 |
if ( defined( 'DB_CHARSET' ) ) { |
0
|
738 |
$this->charset = DB_CHARSET; |
5
|
739 |
} |
|
740 |
|
|
741 |
if ( ( $this->use_mysqli && ! ( $this->dbh instanceof mysqli ) ) |
|
742 |
|| ( empty( $this->dbh ) || ! ( $this->dbh instanceof mysqli ) ) ) { |
|
743 |
return; |
|
744 |
} |
|
745 |
|
|
746 |
if ( 'utf8' === $this->charset && $this->has_cap( 'utf8mb4' ) ) { |
|
747 |
$this->charset = 'utf8mb4'; |
|
748 |
} |
|
749 |
|
|
750 |
if ( 'utf8mb4' === $this->charset && ( ! $this->collate || stripos( $this->collate, 'utf8_' ) === 0 ) ) { |
|
751 |
$this->collate = 'utf8mb4_unicode_ci'; |
|
752 |
} |
0
|
753 |
} |
|
754 |
|
|
755 |
/** |
|
756 |
* Sets the connection's character set. |
|
757 |
* |
|
758 |
* @since 3.1.0 |
|
759 |
* |
|
760 |
* @param resource $dbh The resource given by mysql_connect |
5
|
761 |
* @param string $charset Optional. The character set. Default null. |
|
762 |
* @param string $collate Optional. The collation. Default null. |
0
|
763 |
*/ |
5
|
764 |
public function set_charset( $dbh, $charset = null, $collate = null ) { |
0
|
765 |
if ( ! isset( $charset ) ) |
|
766 |
$charset = $this->charset; |
|
767 |
if ( ! isset( $collate ) ) |
|
768 |
$collate = $this->collate; |
|
769 |
if ( $this->has_cap( 'collation' ) && ! empty( $charset ) ) { |
5
|
770 |
if ( $this->use_mysqli ) { |
|
771 |
if ( function_exists( 'mysqli_set_charset' ) && $this->has_cap( 'set_charset' ) ) { |
|
772 |
mysqli_set_charset( $dbh, $charset ); |
|
773 |
} else { |
|
774 |
$query = $this->prepare( 'SET NAMES %s', $charset ); |
|
775 |
if ( ! empty( $collate ) ) |
|
776 |
$query .= $this->prepare( ' COLLATE %s', $collate ); |
|
777 |
mysqli_query( $dbh, $query ); |
|
778 |
} |
|
779 |
} else { |
|
780 |
if ( function_exists( 'mysql_set_charset' ) && $this->has_cap( 'set_charset' ) ) { |
|
781 |
mysql_set_charset( $charset, $dbh ); |
|
782 |
} else { |
|
783 |
$query = $this->prepare( 'SET NAMES %s', $charset ); |
|
784 |
if ( ! empty( $collate ) ) |
|
785 |
$query .= $this->prepare( ' COLLATE %s', $collate ); |
|
786 |
mysql_query( $query, $dbh ); |
|
787 |
} |
|
788 |
} |
|
789 |
} |
|
790 |
} |
|
791 |
|
|
792 |
/** |
|
793 |
* Change the current SQL mode, and ensure its WordPress compatibility. |
|
794 |
* |
|
795 |
* If no modes are passed, it will ensure the current MySQL server |
|
796 |
* modes are compatible. |
|
797 |
* |
|
798 |
* @since 3.9.0 |
|
799 |
* |
|
800 |
* @param array $modes Optional. A list of SQL modes to set. |
|
801 |
*/ |
|
802 |
public function set_sql_mode( $modes = array() ) { |
|
803 |
if ( empty( $modes ) ) { |
|
804 |
if ( $this->use_mysqli ) { |
|
805 |
$res = mysqli_query( $this->dbh, 'SELECT @@SESSION.sql_mode' ); |
0
|
806 |
} else { |
5
|
807 |
$res = mysql_query( 'SELECT @@SESSION.sql_mode', $this->dbh ); |
|
808 |
} |
|
809 |
|
|
810 |
if ( empty( $res ) ) { |
|
811 |
return; |
|
812 |
} |
|
813 |
|
|
814 |
if ( $this->use_mysqli ) { |
|
815 |
$modes_array = mysqli_fetch_array( $res ); |
|
816 |
if ( empty( $modes_array[0] ) ) { |
|
817 |
return; |
|
818 |
} |
|
819 |
$modes_str = $modes_array[0]; |
|
820 |
} else { |
|
821 |
$modes_str = mysql_result( $res, 0 ); |
|
822 |
} |
|
823 |
|
|
824 |
if ( empty( $modes_str ) ) { |
|
825 |
return; |
0
|
826 |
} |
5
|
827 |
|
|
828 |
$modes = explode( ',', $modes_str ); |
|
829 |
} |
|
830 |
|
|
831 |
$modes = array_change_key_case( $modes, CASE_UPPER ); |
|
832 |
|
|
833 |
/** |
|
834 |
* Filter the list of incompatible SQL modes to exclude. |
|
835 |
* |
|
836 |
* @since 3.9.0 |
|
837 |
* |
|
838 |
* @param array $incompatible_modes An array of incompatible modes. |
|
839 |
*/ |
|
840 |
$incompatible_modes = (array) apply_filters( 'incompatible_sql_modes', $this->incompatible_modes ); |
|
841 |
|
|
842 |
foreach( $modes as $i => $mode ) { |
|
843 |
if ( in_array( $mode, $incompatible_modes ) ) { |
|
844 |
unset( $modes[ $i ] ); |
|
845 |
} |
|
846 |
} |
|
847 |
|
|
848 |
$modes_str = implode( ',', $modes ); |
|
849 |
|
|
850 |
if ( $this->use_mysqli ) { |
|
851 |
mysqli_query( $this->dbh, "SET SESSION sql_mode='$modes_str'" ); |
|
852 |
} else { |
|
853 |
mysql_query( "SET SESSION sql_mode='$modes_str'", $this->dbh ); |
0
|
854 |
} |
|
855 |
} |
|
856 |
|
|
857 |
/** |
|
858 |
* Sets the table prefix for the WordPress tables. |
|
859 |
* |
|
860 |
* @since 2.5.0 |
|
861 |
* |
|
862 |
* @param string $prefix Alphanumeric name for the new prefix. |
|
863 |
* @param bool $set_table_names Optional. Whether the table names, e.g. wpdb::$posts, should be updated or not. |
|
864 |
* @return string|WP_Error Old prefix or WP_Error on error |
|
865 |
*/ |
5
|
866 |
public function set_prefix( $prefix, $set_table_names = true ) { |
0
|
867 |
|
|
868 |
if ( preg_match( '|[^a-z0-9_]|i', $prefix ) ) |
|
869 |
return new WP_Error('invalid_db_prefix', 'Invalid database prefix' ); |
|
870 |
|
|
871 |
$old_prefix = is_multisite() ? '' : $prefix; |
|
872 |
|
|
873 |
if ( isset( $this->base_prefix ) ) |
|
874 |
$old_prefix = $this->base_prefix; |
|
875 |
|
|
876 |
$this->base_prefix = $prefix; |
|
877 |
|
|
878 |
if ( $set_table_names ) { |
|
879 |
foreach ( $this->tables( 'global' ) as $table => $prefixed_table ) |
|
880 |
$this->$table = $prefixed_table; |
|
881 |
|
|
882 |
if ( is_multisite() && empty( $this->blogid ) ) |
|
883 |
return $old_prefix; |
|
884 |
|
|
885 |
$this->prefix = $this->get_blog_prefix(); |
|
886 |
|
|
887 |
foreach ( $this->tables( 'blog' ) as $table => $prefixed_table ) |
|
888 |
$this->$table = $prefixed_table; |
|
889 |
|
|
890 |
foreach ( $this->tables( 'old' ) as $table => $prefixed_table ) |
|
891 |
$this->$table = $prefixed_table; |
|
892 |
} |
|
893 |
return $old_prefix; |
|
894 |
} |
|
895 |
|
|
896 |
/** |
|
897 |
* Sets blog id. |
|
898 |
* |
|
899 |
* @since 3.0.0 |
|
900 |
* @access public |
|
901 |
* @param int $blog_id |
|
902 |
* @param int $site_id Optional. |
5
|
903 |
* @return int previous blog id |
0
|
904 |
*/ |
5
|
905 |
public function set_blog_id( $blog_id, $site_id = 0 ) { |
0
|
906 |
if ( ! empty( $site_id ) ) |
|
907 |
$this->siteid = $site_id; |
|
908 |
|
|
909 |
$old_blog_id = $this->blogid; |
|
910 |
$this->blogid = $blog_id; |
|
911 |
|
|
912 |
$this->prefix = $this->get_blog_prefix(); |
|
913 |
|
|
914 |
foreach ( $this->tables( 'blog' ) as $table => $prefixed_table ) |
|
915 |
$this->$table = $prefixed_table; |
|
916 |
|
|
917 |
foreach ( $this->tables( 'old' ) as $table => $prefixed_table ) |
|
918 |
$this->$table = $prefixed_table; |
|
919 |
|
|
920 |
return $old_blog_id; |
|
921 |
} |
|
922 |
|
|
923 |
/** |
|
924 |
* Gets blog prefix. |
|
925 |
* |
|
926 |
* @since 3.0.0 |
|
927 |
* @param int $blog_id Optional. |
|
928 |
* @return string Blog prefix. |
|
929 |
*/ |
5
|
930 |
public function get_blog_prefix( $blog_id = null ) { |
0
|
931 |
if ( is_multisite() ) { |
|
932 |
if ( null === $blog_id ) |
|
933 |
$blog_id = $this->blogid; |
|
934 |
$blog_id = (int) $blog_id; |
|
935 |
if ( defined( 'MULTISITE' ) && ( 0 == $blog_id || 1 == $blog_id ) ) |
|
936 |
return $this->base_prefix; |
|
937 |
else |
|
938 |
return $this->base_prefix . $blog_id . '_'; |
|
939 |
} else { |
|
940 |
return $this->base_prefix; |
|
941 |
} |
|
942 |
} |
|
943 |
|
|
944 |
/** |
|
945 |
* Returns an array of WordPress tables. |
|
946 |
* |
|
947 |
* Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to |
|
948 |
* override the WordPress users and usermeta tables that would otherwise |
|
949 |
* be determined by the prefix. |
|
950 |
* |
|
951 |
* The scope argument can take one of the following: |
|
952 |
* |
|
953 |
* 'all' - returns 'all' and 'global' tables. No old tables are returned. |
|
954 |
* 'blog' - returns the blog-level tables for the queried blog. |
|
955 |
* 'global' - returns the global tables for the installation, returning multisite tables only if running multisite. |
|
956 |
* 'ms_global' - returns the multisite global tables, regardless if current installation is multisite. |
|
957 |
* 'old' - returns tables which are deprecated. |
|
958 |
* |
|
959 |
* @since 3.0.0 |
|
960 |
* @uses wpdb::$tables |
|
961 |
* @uses wpdb::$old_tables |
|
962 |
* @uses wpdb::$global_tables |
|
963 |
* @uses wpdb::$ms_global_tables |
|
964 |
* |
|
965 |
* @param string $scope Optional. Can be all, global, ms_global, blog, or old tables. Defaults to all. |
|
966 |
* @param bool $prefix Optional. Whether to include table prefixes. Default true. If blog |
|
967 |
* prefix is requested, then the custom users and usermeta tables will be mapped. |
|
968 |
* @param int $blog_id Optional. The blog_id to prefix. Defaults to wpdb::$blogid. Used only when prefix is requested. |
|
969 |
* @return array Table names. When a prefix is requested, the key is the unprefixed table name. |
|
970 |
*/ |
5
|
971 |
public function tables( $scope = 'all', $prefix = true, $blog_id = 0 ) { |
0
|
972 |
switch ( $scope ) { |
|
973 |
case 'all' : |
|
974 |
$tables = array_merge( $this->global_tables, $this->tables ); |
|
975 |
if ( is_multisite() ) |
|
976 |
$tables = array_merge( $tables, $this->ms_global_tables ); |
|
977 |
break; |
|
978 |
case 'blog' : |
|
979 |
$tables = $this->tables; |
|
980 |
break; |
|
981 |
case 'global' : |
|
982 |
$tables = $this->global_tables; |
|
983 |
if ( is_multisite() ) |
|
984 |
$tables = array_merge( $tables, $this->ms_global_tables ); |
|
985 |
break; |
|
986 |
case 'ms_global' : |
|
987 |
$tables = $this->ms_global_tables; |
|
988 |
break; |
|
989 |
case 'old' : |
|
990 |
$tables = $this->old_tables; |
|
991 |
break; |
|
992 |
default : |
|
993 |
return array(); |
|
994 |
} |
|
995 |
|
|
996 |
if ( $prefix ) { |
|
997 |
if ( ! $blog_id ) |
|
998 |
$blog_id = $this->blogid; |
|
999 |
$blog_prefix = $this->get_blog_prefix( $blog_id ); |
|
1000 |
$base_prefix = $this->base_prefix; |
|
1001 |
$global_tables = array_merge( $this->global_tables, $this->ms_global_tables ); |
|
1002 |
foreach ( $tables as $k => $table ) { |
|
1003 |
if ( in_array( $table, $global_tables ) ) |
|
1004 |
$tables[ $table ] = $base_prefix . $table; |
|
1005 |
else |
|
1006 |
$tables[ $table ] = $blog_prefix . $table; |
|
1007 |
unset( $tables[ $k ] ); |
|
1008 |
} |
|
1009 |
|
|
1010 |
if ( isset( $tables['users'] ) && defined( 'CUSTOM_USER_TABLE' ) ) |
|
1011 |
$tables['users'] = CUSTOM_USER_TABLE; |
|
1012 |
|
|
1013 |
if ( isset( $tables['usermeta'] ) && defined( 'CUSTOM_USER_META_TABLE' ) ) |
|
1014 |
$tables['usermeta'] = CUSTOM_USER_META_TABLE; |
|
1015 |
} |
|
1016 |
|
|
1017 |
return $tables; |
|
1018 |
} |
|
1019 |
|
|
1020 |
/** |
|
1021 |
* Selects a database using the current database connection. |
|
1022 |
* |
|
1023 |
* The database name will be changed based on the current database |
|
1024 |
* connection. On failure, the execution will bail and display an DB error. |
|
1025 |
* |
|
1026 |
* @since 0.71 |
|
1027 |
* |
|
1028 |
* @param string $db MySQL database name |
|
1029 |
* @param resource $dbh Optional link identifier. |
|
1030 |
* @return null Always null. |
|
1031 |
*/ |
5
|
1032 |
public function select( $db, $dbh = null ) { |
0
|
1033 |
if ( is_null($dbh) ) |
|
1034 |
$dbh = $this->dbh; |
|
1035 |
|
5
|
1036 |
if ( $this->use_mysqli ) { |
|
1037 |
$success = @mysqli_select_db( $dbh, $db ); |
|
1038 |
} else { |
|
1039 |
$success = @mysql_select_db( $db, $dbh ); |
|
1040 |
} |
|
1041 |
if ( ! $success ) { |
0
|
1042 |
$this->ready = false; |
5
|
1043 |
if ( ! did_action( 'template_redirect' ) ) { |
|
1044 |
wp_load_translations_early(); |
|
1045 |
$this->bail( sprintf( __( '<h1>Can’t select database</h1> |
0
|
1046 |
<p>We were able to connect to the database server (which means your username and password is okay) but not able to select the <code>%1$s</code> database.</p> |
|
1047 |
<ul> |
|
1048 |
<li>Are you sure it exists?</li> |
|
1049 |
<li>Does the user <code>%2$s</code> have permission to use the <code>%1$s</code> database?</li> |
|
1050 |
<li>On some systems the name of your database is prefixed with your username, so it would be like <code>username_%1$s</code>. Could that be the problem?</li> |
|
1051 |
</ul> |
5
|
1052 |
<p>If you don\'t know how to set up a database you should <strong>contact your host</strong>. If all else fails you may find help at the <a href="https://wordpress.org/support/">WordPress Support Forums</a>.</p>' ), htmlspecialchars( $db, ENT_QUOTES ), htmlspecialchars( $this->dbuser, ENT_QUOTES ) ), 'db_select_fail' ); |
|
1053 |
} |
0
|
1054 |
return; |
|
1055 |
} |
|
1056 |
} |
|
1057 |
|
|
1058 |
/** |
|
1059 |
* Do not use, deprecated. |
|
1060 |
* |
|
1061 |
* Use esc_sql() or wpdb::prepare() instead. |
|
1062 |
* |
|
1063 |
* @since 2.8.0 |
|
1064 |
* @deprecated 3.6.0 |
|
1065 |
* @see wpdb::prepare |
|
1066 |
* @see esc_sql() |
|
1067 |
* @access private |
|
1068 |
* |
|
1069 |
* @param string $string |
|
1070 |
* @return string |
|
1071 |
*/ |
|
1072 |
function _weak_escape( $string ) { |
|
1073 |
if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) ) |
|
1074 |
_deprecated_function( __METHOD__, '3.6', 'wpdb::prepare() or esc_sql()' ); |
|
1075 |
return addslashes( $string ); |
|
1076 |
} |
|
1077 |
|
|
1078 |
/** |
5
|
1079 |
* Real escape, using mysqli_real_escape_string() or mysql_real_escape_string() |
0
|
1080 |
* |
5
|
1081 |
* @see mysqli_real_escape_string() |
0
|
1082 |
* @see mysql_real_escape_string() |
|
1083 |
* @since 2.8.0 |
|
1084 |
* @access private |
|
1085 |
* |
|
1086 |
* @param string $string to escape |
|
1087 |
* @return string escaped |
|
1088 |
*/ |
|
1089 |
function _real_escape( $string ) { |
5
|
1090 |
if ( $this->dbh ) { |
|
1091 |
if ( $this->use_mysqli ) { |
|
1092 |
return mysqli_real_escape_string( $this->dbh, $string ); |
|
1093 |
} else { |
|
1094 |
return mysql_real_escape_string( $string, $this->dbh ); |
|
1095 |
} |
|
1096 |
} |
0
|
1097 |
|
|
1098 |
$class = get_class( $this ); |
5
|
1099 |
if ( function_exists( '__' ) ) { |
|
1100 |
_doing_it_wrong( $class, sprintf( __( '%s must set a database connection for use with escaping.' ), $class ), E_USER_NOTICE ); |
|
1101 |
} else { |
|
1102 |
_doing_it_wrong( $class, sprintf( '%s must set a database connection for use with escaping.', $class ), E_USER_NOTICE ); |
|
1103 |
} |
0
|
1104 |
return addslashes( $string ); |
|
1105 |
} |
|
1106 |
|
|
1107 |
/** |
|
1108 |
* Escape data. Works on arrays. |
|
1109 |
* |
|
1110 |
* @uses wpdb::_real_escape() |
|
1111 |
* @since 2.8.0 |
|
1112 |
* @access private |
|
1113 |
* |
|
1114 |
* @param string|array $data |
|
1115 |
* @return string|array escaped |
|
1116 |
*/ |
|
1117 |
function _escape( $data ) { |
|
1118 |
if ( is_array( $data ) ) { |
|
1119 |
foreach ( $data as $k => $v ) { |
|
1120 |
if ( is_array($v) ) |
|
1121 |
$data[$k] = $this->_escape( $v ); |
|
1122 |
else |
|
1123 |
$data[$k] = $this->_real_escape( $v ); |
|
1124 |
} |
|
1125 |
} else { |
|
1126 |
$data = $this->_real_escape( $data ); |
|
1127 |
} |
|
1128 |
|
|
1129 |
return $data; |
|
1130 |
} |
|
1131 |
|
|
1132 |
/** |
|
1133 |
* Do not use, deprecated. |
|
1134 |
* |
|
1135 |
* Use esc_sql() or wpdb::prepare() instead. |
|
1136 |
* |
|
1137 |
* @since 0.71 |
|
1138 |
* @deprecated 3.6.0 |
|
1139 |
* @see wpdb::prepare() |
|
1140 |
* @see esc_sql() |
|
1141 |
* |
|
1142 |
* @param mixed $data |
|
1143 |
* @return mixed |
|
1144 |
*/ |
5
|
1145 |
public function escape( $data ) { |
0
|
1146 |
if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) ) |
|
1147 |
_deprecated_function( __METHOD__, '3.6', 'wpdb::prepare() or esc_sql()' ); |
|
1148 |
if ( is_array( $data ) ) { |
|
1149 |
foreach ( $data as $k => $v ) { |
|
1150 |
if ( is_array( $v ) ) |
|
1151 |
$data[$k] = $this->escape( $v, 'recursive' ); |
|
1152 |
else |
|
1153 |
$data[$k] = $this->_weak_escape( $v, 'internal' ); |
|
1154 |
} |
|
1155 |
} else { |
|
1156 |
$data = $this->_weak_escape( $data, 'internal' ); |
|
1157 |
} |
|
1158 |
|
|
1159 |
return $data; |
|
1160 |
} |
|
1161 |
|
|
1162 |
/** |
|
1163 |
* Escapes content by reference for insertion into the database, for security |
|
1164 |
* |
|
1165 |
* @uses wpdb::_real_escape() |
|
1166 |
* @since 2.3.0 |
|
1167 |
* @param string $string to escape |
|
1168 |
* @return void |
|
1169 |
*/ |
5
|
1170 |
public function escape_by_ref( &$string ) { |
0
|
1171 |
if ( ! is_float( $string ) ) |
|
1172 |
$string = $this->_real_escape( $string ); |
|
1173 |
} |
|
1174 |
|
|
1175 |
/** |
|
1176 |
* Prepares a SQL query for safe execution. Uses sprintf()-like syntax. |
|
1177 |
* |
|
1178 |
* The following directives can be used in the query format string: |
|
1179 |
* %d (integer) |
|
1180 |
* %f (float) |
|
1181 |
* %s (string) |
|
1182 |
* %% (literal percentage sign - no argument needed) |
|
1183 |
* |
|
1184 |
* All of %d, %f, and %s are to be left unquoted in the query string and they need an argument passed for them. |
|
1185 |
* Literals (%) as parts of the query must be properly written as %%. |
|
1186 |
* |
|
1187 |
* This function only supports a small subset of the sprintf syntax; it only supports %d (integer), %f (float), and %s (string). |
|
1188 |
* Does not support sign, padding, alignment, width or precision specifiers. |
|
1189 |
* Does not support argument numbering/swapping. |
|
1190 |
* |
|
1191 |
* May be called like {@link http://php.net/sprintf sprintf()} or like {@link http://php.net/vsprintf vsprintf()}. |
|
1192 |
* |
|
1193 |
* Both %d and %s should be left unquoted in the query string. |
|
1194 |
* |
5
|
1195 |
* wpdb::prepare( "SELECT * FROM `table` WHERE `column` = %s AND `field` = %d", 'foo', 1337 ) |
|
1196 |
* wpdb::prepare( "SELECT DATE_FORMAT(`field`, '%%c') FROM `table` WHERE `column` = %s", 'foo' ); |
0
|
1197 |
* |
|
1198 |
* @link http://php.net/sprintf Description of syntax. |
|
1199 |
* @since 2.3.0 |
|
1200 |
* |
|
1201 |
* @param string $query Query statement with sprintf()-like placeholders |
|
1202 |
* @param array|mixed $args The array of variables to substitute into the query's placeholders if being called like |
|
1203 |
* {@link http://php.net/vsprintf vsprintf()}, or the first variable to substitute into the query's placeholders if |
|
1204 |
* being called like {@link http://php.net/sprintf sprintf()}. |
|
1205 |
* @param mixed $args,... further variables to substitute into the query's placeholders if being called like |
|
1206 |
* {@link http://php.net/sprintf sprintf()}. |
|
1207 |
* @return null|false|string Sanitized query string, null if there is no query, false if there is an error and string |
|
1208 |
* if there was something to prepare |
|
1209 |
*/ |
5
|
1210 |
public function prepare( $query, $args ) { |
0
|
1211 |
if ( is_null( $query ) ) |
|
1212 |
return; |
|
1213 |
|
5
|
1214 |
// This is not meant to be foolproof -- but it will catch obviously incorrect usage. |
|
1215 |
if ( strpos( $query, '%' ) === false ) { |
|
1216 |
_doing_it_wrong( 'wpdb::prepare', sprintf( __( 'The query argument of %s must have a placeholder.' ), 'wpdb::prepare()' ), '3.9' ); |
|
1217 |
} |
|
1218 |
|
0
|
1219 |
$args = func_get_args(); |
|
1220 |
array_shift( $args ); |
|
1221 |
// If args were passed as an array (as in vsprintf), move them up |
|
1222 |
if ( isset( $args[0] ) && is_array($args[0]) ) |
|
1223 |
$args = $args[0]; |
|
1224 |
$query = str_replace( "'%s'", '%s', $query ); // in case someone mistakenly already singlequoted it |
|
1225 |
$query = str_replace( '"%s"', '%s', $query ); // doublequote unquoting |
|
1226 |
$query = preg_replace( '|(?<!%)%f|' , '%F', $query ); // Force floats to be locale unaware |
|
1227 |
$query = preg_replace( '|(?<!%)%s|', "'%s'", $query ); // quote the strings, avoiding escaped strings like %%s |
|
1228 |
array_walk( $args, array( $this, 'escape_by_ref' ) ); |
|
1229 |
return @vsprintf( $query, $args ); |
|
1230 |
} |
|
1231 |
|
|
1232 |
/** |
5
|
1233 |
* First half of escaping for LIKE special characters % and _ before preparing for MySQL. |
|
1234 |
* |
|
1235 |
* Use this only before wpdb::prepare() or esc_sql(). Reversing the order is very bad for security. |
|
1236 |
* |
|
1237 |
* Example Prepared Statement: |
|
1238 |
* $wild = '%'; |
|
1239 |
* $find = 'only 43% of planets'; |
|
1240 |
* $like = $wild . $wpdb->esc_like( $find ) . $wild; |
|
1241 |
* $sql = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_content LIKE %s", $like ); |
|
1242 |
* |
|
1243 |
* Example Escape Chain: |
|
1244 |
* $sql = esc_sql( $wpdb->esc_like( $input ) ); |
|
1245 |
* |
|
1246 |
* @since 4.0.0 |
|
1247 |
* @access public |
|
1248 |
* |
|
1249 |
* @param string $text The raw text to be escaped. The input typed by the user should have no |
|
1250 |
* extra or deleted slashes. |
|
1251 |
* @return string Text in the form of a LIKE phrase. The output is not SQL safe. Call $wpdb::prepare() |
|
1252 |
* or real_escape next. |
|
1253 |
*/ |
|
1254 |
public function esc_like( $text ) { |
|
1255 |
return addcslashes( $text, '_%\\' ); |
|
1256 |
} |
|
1257 |
|
|
1258 |
/** |
0
|
1259 |
* Print SQL/DB error. |
|
1260 |
* |
|
1261 |
* @since 0.71 |
|
1262 |
* @global array $EZSQL_ERROR Stores error information of query and error string |
|
1263 |
* |
|
1264 |
* @param string $str The error to display |
5
|
1265 |
* @return false|null False if the showing of errors is disabled. |
0
|
1266 |
*/ |
5
|
1267 |
public function print_error( $str = '' ) { |
0
|
1268 |
global $EZSQL_ERROR; |
|
1269 |
|
5
|
1270 |
if ( !$str ) { |
|
1271 |
if ( $this->use_mysqli ) { |
|
1272 |
$str = mysqli_error( $this->dbh ); |
|
1273 |
} else { |
|
1274 |
$str = mysql_error( $this->dbh ); |
|
1275 |
} |
|
1276 |
} |
0
|
1277 |
$EZSQL_ERROR[] = array( 'query' => $this->last_query, 'error_str' => $str ); |
|
1278 |
|
|
1279 |
if ( $this->suppress_errors ) |
|
1280 |
return false; |
|
1281 |
|
|
1282 |
wp_load_translations_early(); |
|
1283 |
|
|
1284 |
if ( $caller = $this->get_caller() ) |
|
1285 |
$error_str = sprintf( __( 'WordPress database error %1$s for query %2$s made by %3$s' ), $str, $this->last_query, $caller ); |
|
1286 |
else |
|
1287 |
$error_str = sprintf( __( 'WordPress database error %1$s for query %2$s' ), $str, $this->last_query ); |
|
1288 |
|
|
1289 |
error_log( $error_str ); |
|
1290 |
|
|
1291 |
// Are we showing errors? |
|
1292 |
if ( ! $this->show_errors ) |
|
1293 |
return false; |
|
1294 |
|
|
1295 |
// If there is an error then take note of it |
|
1296 |
if ( is_multisite() ) { |
|
1297 |
$msg = "WordPress database error: [$str]\n{$this->last_query}\n"; |
|
1298 |
if ( defined( 'ERRORLOGFILE' ) ) |
|
1299 |
error_log( $msg, 3, ERRORLOGFILE ); |
|
1300 |
if ( defined( 'DIEONDBERROR' ) ) |
|
1301 |
wp_die( $msg ); |
|
1302 |
} else { |
|
1303 |
$str = htmlspecialchars( $str, ENT_QUOTES ); |
|
1304 |
$query = htmlspecialchars( $this->last_query, ENT_QUOTES ); |
|
1305 |
|
|
1306 |
print "<div id='error'> |
|
1307 |
<p class='wpdberror'><strong>WordPress database error:</strong> [$str]<br /> |
|
1308 |
<code>$query</code></p> |
|
1309 |
</div>"; |
|
1310 |
} |
|
1311 |
} |
|
1312 |
|
|
1313 |
/** |
|
1314 |
* Enables showing of database errors. |
|
1315 |
* |
|
1316 |
* This function should be used only to enable showing of errors. |
|
1317 |
* wpdb::hide_errors() should be used instead for hiding of errors. However, |
|
1318 |
* this function can be used to enable and disable showing of database |
|
1319 |
* errors. |
|
1320 |
* |
|
1321 |
* @since 0.71 |
|
1322 |
* @see wpdb::hide_errors() |
|
1323 |
* |
|
1324 |
* @param bool $show Whether to show or hide errors |
|
1325 |
* @return bool Old value for showing errors. |
|
1326 |
*/ |
5
|
1327 |
public function show_errors( $show = true ) { |
0
|
1328 |
$errors = $this->show_errors; |
|
1329 |
$this->show_errors = $show; |
|
1330 |
return $errors; |
|
1331 |
} |
|
1332 |
|
|
1333 |
/** |
|
1334 |
* Disables showing of database errors. |
|
1335 |
* |
|
1336 |
* By default database errors are not shown. |
|
1337 |
* |
|
1338 |
* @since 0.71 |
|
1339 |
* @see wpdb::show_errors() |
|
1340 |
* |
|
1341 |
* @return bool Whether showing of errors was active |
|
1342 |
*/ |
5
|
1343 |
public function hide_errors() { |
0
|
1344 |
$show = $this->show_errors; |
|
1345 |
$this->show_errors = false; |
|
1346 |
return $show; |
|
1347 |
} |
|
1348 |
|
|
1349 |
/** |
|
1350 |
* Whether to suppress database errors. |
|
1351 |
* |
|
1352 |
* By default database errors are suppressed, with a simple |
|
1353 |
* call to this function they can be enabled. |
|
1354 |
* |
|
1355 |
* @since 2.5.0 |
|
1356 |
* @see wpdb::hide_errors() |
|
1357 |
* @param bool $suppress Optional. New value. Defaults to true. |
|
1358 |
* @return bool Old value |
|
1359 |
*/ |
5
|
1360 |
public function suppress_errors( $suppress = true ) { |
0
|
1361 |
$errors = $this->suppress_errors; |
|
1362 |
$this->suppress_errors = (bool) $suppress; |
|
1363 |
return $errors; |
|
1364 |
} |
|
1365 |
|
|
1366 |
/** |
|
1367 |
* Kill cached query results. |
|
1368 |
* |
|
1369 |
* @since 0.71 |
|
1370 |
* @return void |
|
1371 |
*/ |
5
|
1372 |
public function flush() { |
0
|
1373 |
$this->last_result = array(); |
|
1374 |
$this->col_info = null; |
|
1375 |
$this->last_query = null; |
|
1376 |
$this->rows_affected = $this->num_rows = 0; |
|
1377 |
$this->last_error = ''; |
|
1378 |
|
5
|
1379 |
if ( $this->use_mysqli && $this->result instanceof mysqli_result ) { |
|
1380 |
mysqli_free_result( $this->result ); |
|
1381 |
$this->result = null; |
|
1382 |
|
|
1383 |
// Sanity check before using the handle |
|
1384 |
if ( empty( $this->dbh ) || !( $this->dbh instanceof mysqli ) ) { |
|
1385 |
return; |
|
1386 |
} |
|
1387 |
|
|
1388 |
// Clear out any results from a multi-query |
|
1389 |
while ( mysqli_more_results( $this->dbh ) ) { |
|
1390 |
mysqli_next_result( $this->dbh ); |
|
1391 |
} |
|
1392 |
} elseif ( is_resource( $this->result ) ) { |
0
|
1393 |
mysql_free_result( $this->result ); |
5
|
1394 |
} |
0
|
1395 |
} |
|
1396 |
|
|
1397 |
/** |
5
|
1398 |
* Connect to and select database. |
|
1399 |
* |
|
1400 |
* If $allow_bail is false, the lack of database connection will need |
|
1401 |
* to be handled manually. |
0
|
1402 |
* |
|
1403 |
* @since 3.0.0 |
5
|
1404 |
* @since 3.9.0 $allow_bail parameter added. |
|
1405 |
* |
|
1406 |
* @param bool $allow_bail Optional. Allows the function to bail. Default true. |
|
1407 |
* @return null|bool True with a successful connection, false on failure. |
0
|
1408 |
*/ |
5
|
1409 |
public function db_connect( $allow_bail = true ) { |
0
|
1410 |
|
|
1411 |
$this->is_mysql = true; |
|
1412 |
|
5
|
1413 |
/* |
|
1414 |
* Deprecated in 3.9+ when using MySQLi. No equivalent |
|
1415 |
* $new_link parameter exists for mysqli_* functions. |
|
1416 |
*/ |
0
|
1417 |
$new_link = defined( 'MYSQL_NEW_LINK' ) ? MYSQL_NEW_LINK : true; |
|
1418 |
$client_flags = defined( 'MYSQL_CLIENT_FLAGS' ) ? MYSQL_CLIENT_FLAGS : 0; |
|
1419 |
|
5
|
1420 |
if ( $this->use_mysqli ) { |
|
1421 |
$this->dbh = mysqli_init(); |
|
1422 |
|
|
1423 |
// mysqli_real_connect doesn't support the host param including a port or socket |
|
1424 |
// like mysql_connect does. This duplicates how mysql_connect detects a port and/or socket file. |
|
1425 |
$port = null; |
|
1426 |
$socket = null; |
|
1427 |
$host = $this->dbhost; |
|
1428 |
$port_or_socket = strstr( $host, ':' ); |
|
1429 |
if ( ! empty( $port_or_socket ) ) { |
|
1430 |
$host = substr( $host, 0, strpos( $host, ':' ) ); |
|
1431 |
$port_or_socket = substr( $port_or_socket, 1 ); |
|
1432 |
if ( 0 !== strpos( $port_or_socket, '/' ) ) { |
|
1433 |
$port = intval( $port_or_socket ); |
|
1434 |
$maybe_socket = strstr( $port_or_socket, ':' ); |
|
1435 |
if ( ! empty( $maybe_socket ) ) { |
|
1436 |
$socket = substr( $maybe_socket, 1 ); |
|
1437 |
} |
|
1438 |
} else { |
|
1439 |
$socket = $port_or_socket; |
|
1440 |
} |
|
1441 |
} |
|
1442 |
|
|
1443 |
if ( WP_DEBUG ) { |
|
1444 |
mysqli_real_connect( $this->dbh, $host, $this->dbuser, $this->dbpassword, null, $port, $socket, $client_flags ); |
|
1445 |
} else { |
|
1446 |
@mysqli_real_connect( $this->dbh, $host, $this->dbuser, $this->dbpassword, null, $port, $socket, $client_flags ); |
|
1447 |
} |
|
1448 |
|
|
1449 |
if ( $this->dbh->connect_errno ) { |
|
1450 |
$this->dbh = null; |
|
1451 |
|
|
1452 |
/* It's possible ext/mysqli is misconfigured. Fall back to ext/mysql if: |
|
1453 |
* - We haven't previously connected, and |
|
1454 |
* - WP_USE_EXT_MYSQL isn't set to false, and |
|
1455 |
* - ext/mysql is loaded. |
|
1456 |
*/ |
|
1457 |
$attempt_fallback = true; |
|
1458 |
|
|
1459 |
if ( $this->has_connected ) { |
|
1460 |
$attempt_fallback = false; |
|
1461 |
} elseif ( defined( 'WP_USE_EXT_MYSQL' ) && ! WP_USE_EXT_MYSQL ) { |
|
1462 |
$attempt_fallback = false; |
|
1463 |
} elseif ( ! function_exists( 'mysql_connect' ) ) { |
|
1464 |
$attempt_fallback = false; |
|
1465 |
} |
|
1466 |
|
|
1467 |
if ( $attempt_fallback ) { |
|
1468 |
$this->use_mysqli = false; |
|
1469 |
$this->db_connect(); |
|
1470 |
} |
|
1471 |
} |
0
|
1472 |
} else { |
5
|
1473 |
if ( WP_DEBUG ) { |
|
1474 |
$this->dbh = mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags ); |
|
1475 |
} else { |
|
1476 |
$this->dbh = @mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags ); |
|
1477 |
} |
0
|
1478 |
} |
|
1479 |
|
5
|
1480 |
if ( ! $this->dbh && $allow_bail ) { |
0
|
1481 |
wp_load_translations_early(); |
5
|
1482 |
|
|
1483 |
// Load custom DB error template, if present. |
|
1484 |
if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) { |
|
1485 |
require_once( WP_CONTENT_DIR . '/db-error.php' ); |
|
1486 |
die(); |
|
1487 |
} |
|
1488 |
|
0
|
1489 |
$this->bail( sprintf( __( " |
|
1490 |
<h1>Error establishing a database connection</h1> |
|
1491 |
<p>This either means that the username and password information in your <code>wp-config.php</code> file is incorrect or we can't contact the database server at <code>%s</code>. This could mean your host's database server is down.</p> |
|
1492 |
<ul> |
|
1493 |
<li>Are you sure you have the correct username and password?</li> |
|
1494 |
<li>Are you sure that you have typed the correct hostname?</li> |
|
1495 |
<li>Are you sure that the database server is running?</li> |
|
1496 |
</ul> |
5
|
1497 |
<p>If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href='https://wordpress.org/support/'>WordPress Support Forums</a>.</p> |
0
|
1498 |
" ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' ); |
|
1499 |
|
5
|
1500 |
return false; |
|
1501 |
} elseif ( $this->dbh ) { |
|
1502 |
if ( ! $this->has_connected ) { |
|
1503 |
$this->init_charset(); |
|
1504 |
} |
|
1505 |
|
|
1506 |
$this->has_connected = true; |
|
1507 |
|
|
1508 |
$this->set_charset( $this->dbh ); |
|
1509 |
|
|
1510 |
$this->ready = true; |
|
1511 |
$this->set_sql_mode(); |
|
1512 |
$this->select( $this->dbname, $this->dbh ); |
|
1513 |
|
|
1514 |
return true; |
|
1515 |
} |
|
1516 |
|
|
1517 |
return false; |
|
1518 |
} |
|
1519 |
|
|
1520 |
/** |
|
1521 |
* Check that the connection to the database is still up. If not, try to reconnect. |
|
1522 |
* |
|
1523 |
* If this function is unable to reconnect, it will forcibly die, or if after the |
|
1524 |
* the template_redirect hook has been fired, return false instead. |
|
1525 |
* |
|
1526 |
* If $allow_bail is false, the lack of database connection will need |
|
1527 |
* to be handled manually. |
|
1528 |
* |
|
1529 |
* @since 3.9.0 |
|
1530 |
* |
|
1531 |
* @param bool $allow_bail Optional. Allows the function to bail. Default true. |
|
1532 |
* @return bool|null True if the connection is up. |
|
1533 |
*/ |
|
1534 |
public function check_connection( $allow_bail = true ) { |
|
1535 |
if ( $this->use_mysqli ) { |
|
1536 |
if ( @mysqli_ping( $this->dbh ) ) { |
|
1537 |
return true; |
|
1538 |
} |
|
1539 |
} else { |
|
1540 |
if ( @mysql_ping( $this->dbh ) ) { |
|
1541 |
return true; |
|
1542 |
} |
0
|
1543 |
} |
|
1544 |
|
5
|
1545 |
$error_reporting = false; |
|
1546 |
|
|
1547 |
// Disable warnings, as we don't want to see a multitude of "unable to connect" messages |
|
1548 |
if ( WP_DEBUG ) { |
|
1549 |
$error_reporting = error_reporting(); |
|
1550 |
error_reporting( $error_reporting & ~E_WARNING ); |
|
1551 |
} |
|
1552 |
|
|
1553 |
for ( $tries = 1; $tries <= $this->reconnect_retries; $tries++ ) { |
|
1554 |
// On the last try, re-enable warnings. We want to see a single instance of the |
|
1555 |
// "unable to connect" message on the bail() screen, if it appears. |
|
1556 |
if ( $this->reconnect_retries === $tries && WP_DEBUG ) { |
|
1557 |
error_reporting( $error_reporting ); |
|
1558 |
} |
|
1559 |
|
|
1560 |
if ( $this->db_connect( false ) ) { |
|
1561 |
if ( $error_reporting ) { |
|
1562 |
error_reporting( $error_reporting ); |
|
1563 |
} |
|
1564 |
|
|
1565 |
return true; |
|
1566 |
} |
|
1567 |
|
|
1568 |
sleep( 1 ); |
|
1569 |
} |
|
1570 |
|
|
1571 |
// If template_redirect has already happened, it's too late for wp_die()/dead_db(). |
|
1572 |
// Let's just return and hope for the best. |
|
1573 |
if ( did_action( 'template_redirect' ) ) { |
|
1574 |
return false; |
|
1575 |
} |
|
1576 |
|
|
1577 |
if ( ! $allow_bail ) { |
|
1578 |
return false; |
|
1579 |
} |
|
1580 |
|
|
1581 |
// We weren't able to reconnect, so we better bail. |
|
1582 |
$this->bail( sprintf( ( " |
|
1583 |
<h1>Error reconnecting to the database</h1> |
|
1584 |
<p>This means that we lost contact with the database server at <code>%s</code>. This could mean your host's database server is down.</p> |
|
1585 |
<ul> |
|
1586 |
<li>Are you sure that the database server is running?</li> |
|
1587 |
<li>Are you sure that the database server is not under particularly heavy load?</li> |
|
1588 |
</ul> |
|
1589 |
<p>If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href='https://wordpress.org/support/'>WordPress Support Forums</a>.</p> |
|
1590 |
" ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' ); |
|
1591 |
|
|
1592 |
// Call dead_db() if bail didn't die, because this database is no more. It has ceased to be (at least temporarily). |
|
1593 |
dead_db(); |
0
|
1594 |
} |
|
1595 |
|
|
1596 |
/** |
|
1597 |
* Perform a MySQL database query, using current database connection. |
|
1598 |
* |
|
1599 |
* More information can be found on the codex page. |
|
1600 |
* |
|
1601 |
* @since 0.71 |
|
1602 |
* |
|
1603 |
* @param string $query Database query |
|
1604 |
* @return int|false Number of rows affected/selected or false on error |
|
1605 |
*/ |
5
|
1606 |
public function query( $query ) { |
|
1607 |
if ( ! $this->ready ) { |
|
1608 |
$this->check_current_query = true; |
0
|
1609 |
return false; |
5
|
1610 |
} |
|
1611 |
|
0
|
1612 |
/** |
|
1613 |
* Filter the database query. |
|
1614 |
* |
5
|
1615 |
* Some queries are made before the plugins have been loaded, |
|
1616 |
* and thus cannot be filtered with this method. |
0
|
1617 |
* |
|
1618 |
* @since 2.1.0 |
5
|
1619 |
* |
0
|
1620 |
* @param string $query Database query. |
|
1621 |
*/ |
|
1622 |
$query = apply_filters( 'query', $query ); |
|
1623 |
|
|
1624 |
$this->flush(); |
|
1625 |
|
|
1626 |
// Log how the function was called |
|
1627 |
$this->func_call = "\$db->query(\"$query\")"; |
|
1628 |
|
5
|
1629 |
// If we're writing to the database, make sure the query will write safely. |
|
1630 |
if ( $this->check_current_query && ! $this->check_ascii( $query ) ) { |
|
1631 |
$stripped_query = $this->strip_invalid_text_from_query( $query ); |
|
1632 |
// strip_invalid_text_from_query() can perform queries, so we need |
|
1633 |
// to flush again, just to make sure everything is clear. |
|
1634 |
$this->flush(); |
|
1635 |
if ( $stripped_query !== $query ) { |
|
1636 |
$this->insert_id = 0; |
|
1637 |
return false; |
|
1638 |
} |
|
1639 |
} |
|
1640 |
|
|
1641 |
$this->check_current_query = true; |
|
1642 |
|
0
|
1643 |
// Keep track of the last query for debug.. |
|
1644 |
$this->last_query = $query; |
|
1645 |
|
5
|
1646 |
$this->_do_query( $query ); |
|
1647 |
|
|
1648 |
// MySQL server has gone away, try to reconnect |
|
1649 |
$mysql_errno = 0; |
|
1650 |
if ( ! empty( $this->dbh ) ) { |
|
1651 |
if ( $this->use_mysqli ) { |
|
1652 |
$mysql_errno = mysqli_errno( $this->dbh ); |
|
1653 |
} else { |
|
1654 |
$mysql_errno = mysql_errno( $this->dbh ); |
|
1655 |
} |
|
1656 |
} |
|
1657 |
|
|
1658 |
if ( empty( $this->dbh ) || 2006 == $mysql_errno ) { |
|
1659 |
if ( $this->check_connection() ) { |
|
1660 |
$this->_do_query( $query ); |
|
1661 |
} else { |
|
1662 |
$this->insert_id = 0; |
|
1663 |
return false; |
|
1664 |
} |
|
1665 |
} |
0
|
1666 |
|
|
1667 |
// If there is an error then take note of it.. |
5
|
1668 |
if ( $this->use_mysqli ) { |
|
1669 |
$this->last_error = mysqli_error( $this->dbh ); |
|
1670 |
} else { |
|
1671 |
$this->last_error = mysql_error( $this->dbh ); |
|
1672 |
} |
|
1673 |
|
|
1674 |
if ( $this->last_error ) { |
0
|
1675 |
// Clear insert_id on a subsequent failed insert. |
|
1676 |
if ( $this->insert_id && preg_match( '/^\s*(insert|replace)\s/i', $query ) ) |
|
1677 |
$this->insert_id = 0; |
|
1678 |
|
|
1679 |
$this->print_error(); |
|
1680 |
return false; |
|
1681 |
} |
|
1682 |
|
|
1683 |
if ( preg_match( '/^\s*(create|alter|truncate|drop)\s/i', $query ) ) { |
|
1684 |
$return_val = $this->result; |
|
1685 |
} elseif ( preg_match( '/^\s*(insert|delete|update|replace)\s/i', $query ) ) { |
5
|
1686 |
if ( $this->use_mysqli ) { |
|
1687 |
$this->rows_affected = mysqli_affected_rows( $this->dbh ); |
|
1688 |
} else { |
|
1689 |
$this->rows_affected = mysql_affected_rows( $this->dbh ); |
|
1690 |
} |
0
|
1691 |
// Take note of the insert_id |
|
1692 |
if ( preg_match( '/^\s*(insert|replace)\s/i', $query ) ) { |
5
|
1693 |
if ( $this->use_mysqli ) { |
|
1694 |
$this->insert_id = mysqli_insert_id( $this->dbh ); |
|
1695 |
} else { |
|
1696 |
$this->insert_id = mysql_insert_id( $this->dbh ); |
|
1697 |
} |
0
|
1698 |
} |
|
1699 |
// Return number of rows affected |
|
1700 |
$return_val = $this->rows_affected; |
|
1701 |
} else { |
|
1702 |
$num_rows = 0; |
5
|
1703 |
if ( $this->use_mysqli && $this->result instanceof mysqli_result ) { |
|
1704 |
while ( $row = @mysqli_fetch_object( $this->result ) ) { |
|
1705 |
$this->last_result[$num_rows] = $row; |
|
1706 |
$num_rows++; |
|
1707 |
} |
|
1708 |
} elseif ( is_resource( $this->result ) ) { |
|
1709 |
while ( $row = @mysql_fetch_object( $this->result ) ) { |
|
1710 |
$this->last_result[$num_rows] = $row; |
|
1711 |
$num_rows++; |
|
1712 |
} |
0
|
1713 |
} |
|
1714 |
|
|
1715 |
// Log number of rows the query returned |
|
1716 |
// and return number of rows selected |
|
1717 |
$this->num_rows = $num_rows; |
|
1718 |
$return_val = $num_rows; |
|
1719 |
} |
|
1720 |
|
|
1721 |
return $return_val; |
|
1722 |
} |
|
1723 |
|
|
1724 |
/** |
5
|
1725 |
* Internal function to perform the mysql_query() call. |
|
1726 |
* |
|
1727 |
* @since 3.9.0 |
|
1728 |
* |
|
1729 |
* @access private |
|
1730 |
* @see wpdb::query() |
|
1731 |
* |
|
1732 |
* @param string $query The query to run. |
|
1733 |
*/ |
|
1734 |
private function _do_query( $query ) { |
|
1735 |
if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) { |
|
1736 |
$this->timer_start(); |
|
1737 |
} |
|
1738 |
|
|
1739 |
if ( $this->use_mysqli ) { |
|
1740 |
$this->result = @mysqli_query( $this->dbh, $query ); |
|
1741 |
} else { |
|
1742 |
$this->result = @mysql_query( $query, $this->dbh ); |
|
1743 |
} |
|
1744 |
$this->num_queries++; |
|
1745 |
|
|
1746 |
if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) { |
|
1747 |
$this->queries[] = array( $query, $this->timer_stop(), $this->get_caller() ); |
|
1748 |
} |
|
1749 |
} |
|
1750 |
|
|
1751 |
/** |
0
|
1752 |
* Insert a row into a table. |
|
1753 |
* |
5
|
1754 |
* wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 'bar' ) ) |
|
1755 |
* wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) ) |
0
|
1756 |
* |
|
1757 |
* @since 2.5.0 |
|
1758 |
* @see wpdb::prepare() |
|
1759 |
* @see wpdb::$field_types |
|
1760 |
* @see wp_set_wpdb_vars() |
|
1761 |
* |
|
1762 |
* @param string $table table name |
|
1763 |
* @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped). |
|
1764 |
* @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data. |
|
1765 |
* A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types. |
|
1766 |
* @return int|false The number of rows inserted, or false on error. |
|
1767 |
*/ |
5
|
1768 |
public function insert( $table, $data, $format = null ) { |
0
|
1769 |
return $this->_insert_replace_helper( $table, $data, $format, 'INSERT' ); |
|
1770 |
} |
|
1771 |
|
|
1772 |
/** |
|
1773 |
* Replace a row into a table. |
|
1774 |
* |
5
|
1775 |
* wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 'bar' ) ) |
|
1776 |
* wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) ) |
0
|
1777 |
* |
|
1778 |
* @since 3.0.0 |
|
1779 |
* @see wpdb::prepare() |
|
1780 |
* @see wpdb::$field_types |
|
1781 |
* @see wp_set_wpdb_vars() |
|
1782 |
* |
|
1783 |
* @param string $table table name |
|
1784 |
* @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped). |
|
1785 |
* @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data. |
|
1786 |
* A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types. |
|
1787 |
* @return int|false The number of rows affected, or false on error. |
|
1788 |
*/ |
5
|
1789 |
public function replace( $table, $data, $format = null ) { |
0
|
1790 |
return $this->_insert_replace_helper( $table, $data, $format, 'REPLACE' ); |
|
1791 |
} |
|
1792 |
|
|
1793 |
/** |
|
1794 |
* Helper function for insert and replace. |
|
1795 |
* |
|
1796 |
* Runs an insert or replace query based on $type argument. |
|
1797 |
* |
|
1798 |
* @access private |
|
1799 |
* @since 3.0.0 |
|
1800 |
* @see wpdb::prepare() |
|
1801 |
* @see wpdb::$field_types |
|
1802 |
* @see wp_set_wpdb_vars() |
|
1803 |
* |
|
1804 |
* @param string $table table name |
|
1805 |
* @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped). |
|
1806 |
* @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data. |
|
1807 |
* A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types. |
|
1808 |
* @param string $type Optional. What type of operation is this? INSERT or REPLACE. Defaults to INSERT. |
|
1809 |
* @return int|false The number of rows affected, or false on error. |
|
1810 |
*/ |
|
1811 |
function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) { |
5
|
1812 |
$this->insert_id = 0; |
|
1813 |
|
|
1814 |
if ( ! in_array( strtoupper( $type ), array( 'REPLACE', 'INSERT' ) ) ) { |
|
1815 |
return false; |
|
1816 |
} |
|
1817 |
|
|
1818 |
$data = $this->process_fields( $table, $data, $format ); |
|
1819 |
if ( false === $data ) { |
0
|
1820 |
return false; |
5
|
1821 |
} |
|
1822 |
|
|
1823 |
$formats = $values = array(); |
|
1824 |
foreach ( $data as $value ) { |
|
1825 |
$formats[] = $value['format']; |
|
1826 |
$values[] = $value['value']; |
0
|
1827 |
} |
5
|
1828 |
|
|
1829 |
$fields = '`' . implode( '`, `', array_keys( $data ) ) . '`'; |
|
1830 |
$formats = implode( ', ', $formats ); |
|
1831 |
|
|
1832 |
$sql = "$type INTO `$table` ($fields) VALUES ($formats)"; |
|
1833 |
|
|
1834 |
$this->check_current_query = false; |
|
1835 |
return $this->query( $this->prepare( $sql, $values ) ); |
0
|
1836 |
} |
|
1837 |
|
|
1838 |
/** |
|
1839 |
* Update a row in the table |
|
1840 |
* |
5
|
1841 |
* wpdb::update( 'table', array( 'column' => 'foo', 'field' => 'bar' ), array( 'ID' => 1 ) ) |
|
1842 |
* wpdb::update( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( 'ID' => 1 ), array( '%s', '%d' ), array( '%d' ) ) |
0
|
1843 |
* |
|
1844 |
* @since 2.5.0 |
|
1845 |
* @see wpdb::prepare() |
|
1846 |
* @see wpdb::$field_types |
|
1847 |
* @see wp_set_wpdb_vars() |
|
1848 |
* |
|
1849 |
* @param string $table table name |
|
1850 |
* @param array $data Data to update (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped). |
|
1851 |
* @param array $where A named array of WHERE clauses (in column => value pairs). Multiple clauses will be joined with ANDs. Both $where columns and $where values should be "raw". |
|
1852 |
* @param array|string $format Optional. An array of formats to be mapped to each of the values in $data. If string, that format will be used for all of the values in $data. |
|
1853 |
* A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types. |
|
1854 |
* @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where. If string, that format will be used for all of the items in $where. A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $where will be treated as strings. |
|
1855 |
* @return int|false The number of rows updated, or false on error. |
|
1856 |
*/ |
5
|
1857 |
public function update( $table, $data, $where, $format = null, $where_format = null ) { |
|
1858 |
if ( ! is_array( $data ) || ! is_array( $where ) ) { |
0
|
1859 |
return false; |
5
|
1860 |
} |
|
1861 |
|
|
1862 |
$data = $this->process_fields( $table, $data, $format ); |
|
1863 |
if ( false === $data ) { |
|
1864 |
return false; |
|
1865 |
} |
|
1866 |
$where = $this->process_fields( $table, $where, $where_format ); |
|
1867 |
if ( false === $where ) { |
|
1868 |
return false; |
0
|
1869 |
} |
|
1870 |
|
5
|
1871 |
$fields = $conditions = $values = array(); |
|
1872 |
foreach ( $data as $field => $value ) { |
|
1873 |
$fields[] = "`$field` = " . $value['format']; |
|
1874 |
$values[] = $value['value']; |
|
1875 |
} |
|
1876 |
foreach ( $where as $field => $value ) { |
|
1877 |
$conditions[] = "`$field` = " . $value['format']; |
|
1878 |
$values[] = $value['value']; |
0
|
1879 |
} |
|
1880 |
|
5
|
1881 |
$fields = implode( ', ', $fields ); |
|
1882 |
$conditions = implode( ' AND ', $conditions ); |
|
1883 |
|
|
1884 |
$sql = "UPDATE `$table` SET $fields WHERE $conditions"; |
|
1885 |
|
|
1886 |
$this->check_current_query = false; |
|
1887 |
return $this->query( $this->prepare( $sql, $values ) ); |
0
|
1888 |
} |
|
1889 |
|
|
1890 |
/** |
|
1891 |
* Delete a row in the table |
|
1892 |
* |
5
|
1893 |
* wpdb::delete( 'table', array( 'ID' => 1 ) ) |
|
1894 |
* wpdb::delete( 'table', array( 'ID' => 1 ), array( '%d' ) ) |
0
|
1895 |
* |
|
1896 |
* @since 3.4.0 |
|
1897 |
* @see wpdb::prepare() |
|
1898 |
* @see wpdb::$field_types |
|
1899 |
* @see wp_set_wpdb_vars() |
|
1900 |
* |
|
1901 |
* @param string $table table name |
|
1902 |
* @param array $where A named array of WHERE clauses (in column => value pairs). Multiple clauses will be joined with ANDs. Both $where columns and $where values should be "raw". |
|
1903 |
* @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where. If string, that format will be used for all of the items in $where. A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $where will be treated as strings unless otherwise specified in wpdb::$field_types. |
|
1904 |
* @return int|false The number of rows updated, or false on error. |
|
1905 |
*/ |
5
|
1906 |
public function delete( $table, $where, $where_format = null ) { |
|
1907 |
if ( ! is_array( $where ) ) { |
|
1908 |
return false; |
|
1909 |
} |
|
1910 |
|
|
1911 |
$where = $this->process_fields( $table, $where, $where_format ); |
|
1912 |
if ( false === $where ) { |
|
1913 |
return false; |
|
1914 |
} |
|
1915 |
|
|
1916 |
$conditions = $values = array(); |
|
1917 |
foreach ( $where as $field => $value ) { |
|
1918 |
$conditions[] = "`$field` = " . $value['format']; |
|
1919 |
$values[] = $value['value']; |
|
1920 |
} |
|
1921 |
|
|
1922 |
$conditions = implode( ' AND ', $conditions ); |
|
1923 |
|
|
1924 |
$sql = "DELETE FROM `$table` WHERE $conditions"; |
|
1925 |
|
|
1926 |
$this->check_current_query = false; |
|
1927 |
return $this->query( $this->prepare( $sql, $values ) ); |
|
1928 |
} |
|
1929 |
|
|
1930 |
/** |
|
1931 |
* Processes arrays of field/value pairs and field formats. |
|
1932 |
* |
|
1933 |
* This is a helper method for wpdb's CRUD methods, which take field/value |
|
1934 |
* pairs for inserts, updates, and where clauses. This method first pairs |
|
1935 |
* each value with a format. Then it determines the charset of that field, |
|
1936 |
* using that to determine if any invalid text would be stripped. If text is |
|
1937 |
* stripped, then field processing is rejected and the query fails. |
|
1938 |
* |
|
1939 |
* @since 4.2.0 |
|
1940 |
* @access protected |
|
1941 |
* |
|
1942 |
* @param string $table Table name. |
|
1943 |
* @param array $data Field/value pair. |
|
1944 |
* @param mixed $format Format for each field. |
|
1945 |
* @return array|bool Returns an array of fields that contain paired values |
|
1946 |
* and formats. Returns false for invalid values. |
|
1947 |
*/ |
|
1948 |
protected function process_fields( $table, $data, $format ) { |
|
1949 |
$data = $this->process_field_formats( $data, $format ); |
|
1950 |
if ( false === $data ) { |
0
|
1951 |
return false; |
5
|
1952 |
} |
|
1953 |
|
|
1954 |
$data = $this->process_field_charsets( $data, $table ); |
|
1955 |
if ( false === $data ) { |
|
1956 |
return false; |
|
1957 |
} |
|
1958 |
|
|
1959 |
$data = $this->process_field_lengths( $data, $table ); |
|
1960 |
if ( false === $data ) { |
|
1961 |
return false; |
|
1962 |
} |
|
1963 |
|
|
1964 |
$converted_data = $this->strip_invalid_text( $data ); |
|
1965 |
|
|
1966 |
if ( $data !== $converted_data ) { |
|
1967 |
return false; |
|
1968 |
} |
|
1969 |
|
|
1970 |
return $data; |
|
1971 |
} |
|
1972 |
|
|
1973 |
/** |
|
1974 |
* Prepares arrays of value/format pairs as passed to wpdb CRUD methods. |
|
1975 |
* |
|
1976 |
* @since 4.2.0 |
|
1977 |
* @access protected |
|
1978 |
* |
|
1979 |
* @param array $data Array of fields to values. |
|
1980 |
* @param mixed $format Formats to be mapped to the values in $data. |
|
1981 |
* @return array Array, keyed by field names with values being an array |
|
1982 |
* of 'value' and 'format' keys. |
|
1983 |
*/ |
|
1984 |
protected function process_field_formats( $data, $format ) { |
|
1985 |
$formats = $original_formats = (array) $format; |
|
1986 |
|
|
1987 |
foreach ( $data as $field => $value ) { |
|
1988 |
$value = array( |
|
1989 |
'value' => $value, |
|
1990 |
'format' => '%s', |
|
1991 |
); |
|
1992 |
|
|
1993 |
if ( ! empty( $format ) ) { |
|
1994 |
$value['format'] = array_shift( $formats ); |
|
1995 |
if ( ! $value['format'] ) { |
|
1996 |
$value['format'] = reset( $original_formats ); |
|
1997 |
} |
0
|
1998 |
} elseif ( isset( $this->field_types[ $field ] ) ) { |
5
|
1999 |
$value['format'] = $this->field_types[ $field ]; |
|
2000 |
} |
|
2001 |
|
|
2002 |
$data[ $field ] = $value; |
|
2003 |
} |
|
2004 |
|
|
2005 |
return $data; |
|
2006 |
} |
|
2007 |
|
|
2008 |
/** |
|
2009 |
* Adds field charsets to field/value/format arrays generated by |
|
2010 |
* the wpdb::process_field_formats() method. |
|
2011 |
* |
|
2012 |
* @since 4.2.0 |
|
2013 |
* @access protected |
|
2014 |
* |
|
2015 |
* @param array $data As it comes from the wpdb::process_field_formats() method. |
|
2016 |
* @param string $table Table name. |
|
2017 |
* @return The same array as $data with additional 'charset' keys. |
|
2018 |
*/ |
|
2019 |
protected function process_field_charsets( $data, $table ) { |
|
2020 |
foreach ( $data as $field => $value ) { |
|
2021 |
if ( '%d' === $value['format'] || '%f' === $value['format'] ) { |
|
2022 |
// We can skip this field if we know it isn't a string. |
|
2023 |
// This checks %d/%f versus ! %s because it's sprintf() could take more. |
|
2024 |
$value['charset'] = false; |
0
|
2025 |
} else { |
5
|
2026 |
$value['charset'] = $this->get_col_charset( $table, $field ); |
|
2027 |
if ( is_wp_error( $value['charset'] ) ) { |
|
2028 |
return false; |
|
2029 |
} |
0
|
2030 |
} |
|
2031 |
|
5
|
2032 |
$data[ $field ] = $value; |
0
|
2033 |
} |
|
2034 |
|
5
|
2035 |
return $data; |
0
|
2036 |
} |
|
2037 |
|
5
|
2038 |
/** |
|
2039 |
* For string fields, record the maximum string length that field can safely save. |
|
2040 |
* |
|
2041 |
* @since 4.2.1 |
|
2042 |
* @access protected |
|
2043 |
* |
|
2044 |
* @param array $data As it comes from the wpdb::process_field_charsets() method. |
|
2045 |
* @param string $table Table name. |
|
2046 |
* @return array|False The same array as $data with additional 'length' keys, or false if |
|
2047 |
* any of the values were too long for their corresponding field. |
|
2048 |
*/ |
|
2049 |
protected function process_field_lengths( $data, $table ) { |
|
2050 |
foreach ( $data as $field => $value ) { |
|
2051 |
if ( '%d' === $value['format'] || '%f' === $value['format'] ) { |
|
2052 |
// We can skip this field if we know it isn't a string. |
|
2053 |
// This checks %d/%f versus ! %s because it's sprintf() could take more. |
|
2054 |
$value['length'] = false; |
|
2055 |
} else { |
|
2056 |
$value['length'] = $this->get_col_length( $table, $field ); |
|
2057 |
if ( is_wp_error( $value['length'] ) ) { |
|
2058 |
return false; |
|
2059 |
} |
|
2060 |
} |
|
2061 |
|
|
2062 |
$data[ $field ] = $value; |
|
2063 |
} |
|
2064 |
|
|
2065 |
return $data; |
|
2066 |
} |
0
|
2067 |
|
|
2068 |
/** |
|
2069 |
* Retrieve one variable from the database. |
|
2070 |
* |
|
2071 |
* Executes a SQL query and returns the value from the SQL result. |
|
2072 |
* If the SQL result contains more than one column and/or more than one row, this function returns the value in the column and row specified. |
|
2073 |
* If $query is null, this function returns the value in the specified column and row from the previous SQL result. |
|
2074 |
* |
|
2075 |
* @since 0.71 |
|
2076 |
* |
|
2077 |
* @param string|null $query Optional. SQL query. Defaults to null, use the result from the previous query. |
|
2078 |
* @param int $x Optional. Column of value to return. Indexed from 0. |
|
2079 |
* @param int $y Optional. Row of value to return. Indexed from 0. |
|
2080 |
* @return string|null Database query result (as string), or null on failure |
|
2081 |
*/ |
5
|
2082 |
public function get_var( $query = null, $x = 0, $y = 0 ) { |
0
|
2083 |
$this->func_call = "\$db->get_var(\"$query\", $x, $y)"; |
5
|
2084 |
|
|
2085 |
if ( $this->check_safe_collation( $query ) ) { |
|
2086 |
$this->check_current_query = false; |
|
2087 |
} |
|
2088 |
|
|
2089 |
if ( $query ) { |
0
|
2090 |
$this->query( $query ); |
5
|
2091 |
} |
0
|
2092 |
|
|
2093 |
// Extract var out of cached results based x,y vals |
|
2094 |
if ( !empty( $this->last_result[$y] ) ) { |
|
2095 |
$values = array_values( get_object_vars( $this->last_result[$y] ) ); |
|
2096 |
} |
|
2097 |
|
|
2098 |
// If there is a value return it else return null |
|
2099 |
return ( isset( $values[$x] ) && $values[$x] !== '' ) ? $values[$x] : null; |
|
2100 |
} |
|
2101 |
|
|
2102 |
/** |
|
2103 |
* Retrieve one row from the database. |
|
2104 |
* |
|
2105 |
* Executes a SQL query and returns the row from the SQL result. |
|
2106 |
* |
|
2107 |
* @since 0.71 |
|
2108 |
* |
|
2109 |
* @param string|null $query SQL query. |
|
2110 |
* @param string $output Optional. one of ARRAY_A | ARRAY_N | OBJECT constants. Return an associative array (column => value, ...), |
|
2111 |
* a numerically indexed array (0 => value, ...) or an object ( ->column = value ), respectively. |
|
2112 |
* @param int $y Optional. Row to return. Indexed from 0. |
|
2113 |
* @return mixed Database query result in format specified by $output or null on failure |
|
2114 |
*/ |
5
|
2115 |
public function get_row( $query = null, $output = OBJECT, $y = 0 ) { |
0
|
2116 |
$this->func_call = "\$db->get_row(\"$query\",$output,$y)"; |
5
|
2117 |
|
|
2118 |
if ( $this->check_safe_collation( $query ) ) { |
|
2119 |
$this->check_current_query = false; |
|
2120 |
} |
|
2121 |
|
|
2122 |
if ( $query ) { |
0
|
2123 |
$this->query( $query ); |
5
|
2124 |
} else { |
0
|
2125 |
return null; |
5
|
2126 |
} |
0
|
2127 |
|
|
2128 |
if ( !isset( $this->last_result[$y] ) ) |
|
2129 |
return null; |
|
2130 |
|
|
2131 |
if ( $output == OBJECT ) { |
|
2132 |
return $this->last_result[$y] ? $this->last_result[$y] : null; |
|
2133 |
} elseif ( $output == ARRAY_A ) { |
|
2134 |
return $this->last_result[$y] ? get_object_vars( $this->last_result[$y] ) : null; |
|
2135 |
} elseif ( $output == ARRAY_N ) { |
|
2136 |
return $this->last_result[$y] ? array_values( get_object_vars( $this->last_result[$y] ) ) : null; |
5
|
2137 |
} elseif ( strtoupper( $output ) === OBJECT ) { |
|
2138 |
// Back compat for OBJECT being previously case insensitive. |
|
2139 |
return $this->last_result[$y] ? $this->last_result[$y] : null; |
0
|
2140 |
} else { |
|
2141 |
$this->print_error( " \$db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N" ); |
|
2142 |
} |
|
2143 |
} |
|
2144 |
|
|
2145 |
/** |
|
2146 |
* Retrieve one column from the database. |
|
2147 |
* |
|
2148 |
* Executes a SQL query and returns the column from the SQL result. |
|
2149 |
* If the SQL result contains more than one column, this function returns the column specified. |
|
2150 |
* If $query is null, this function returns the specified column from the previous SQL result. |
|
2151 |
* |
|
2152 |
* @since 0.71 |
|
2153 |
* |
|
2154 |
* @param string|null $query Optional. SQL query. Defaults to previous query. |
|
2155 |
* @param int $x Optional. Column to return. Indexed from 0. |
|
2156 |
* @return array Database query result. Array indexed from 0 by SQL result row number. |
|
2157 |
*/ |
5
|
2158 |
public function get_col( $query = null , $x = 0 ) { |
|
2159 |
if ( $this->check_safe_collation( $query ) ) { |
|
2160 |
$this->check_current_query = false; |
|
2161 |
} |
|
2162 |
|
|
2163 |
if ( $query ) { |
0
|
2164 |
$this->query( $query ); |
5
|
2165 |
} |
0
|
2166 |
|
|
2167 |
$new_array = array(); |
|
2168 |
// Extract the column values |
|
2169 |
for ( $i = 0, $j = count( $this->last_result ); $i < $j; $i++ ) { |
|
2170 |
$new_array[$i] = $this->get_var( null, $x, $i ); |
|
2171 |
} |
|
2172 |
return $new_array; |
|
2173 |
} |
|
2174 |
|
|
2175 |
/** |
|
2176 |
* Retrieve an entire SQL result set from the database (i.e., many rows) |
|
2177 |
* |
|
2178 |
* Executes a SQL query and returns the entire SQL result. |
|
2179 |
* |
|
2180 |
* @since 0.71 |
|
2181 |
* |
|
2182 |
* @param string $query SQL query. |
|
2183 |
* @param string $output Optional. Any of ARRAY_A | ARRAY_N | OBJECT | OBJECT_K constants. With one of the first three, return an array of rows indexed from 0 by SQL result row number. |
|
2184 |
* Each row is an associative array (column => value, ...), a numerically indexed array (0 => value, ...), or an object. ( ->column = value ), respectively. |
|
2185 |
* With OBJECT_K, return an associative array of row objects keyed by the value of each row's first column's value. Duplicate keys are discarded. |
|
2186 |
* @return mixed Database query results |
|
2187 |
*/ |
5
|
2188 |
public function get_results( $query = null, $output = OBJECT ) { |
0
|
2189 |
$this->func_call = "\$db->get_results(\"$query\", $output)"; |
|
2190 |
|
5
|
2191 |
if ( $this->check_safe_collation( $query ) ) { |
|
2192 |
$this->check_current_query = false; |
|
2193 |
} |
|
2194 |
|
|
2195 |
if ( $query ) { |
0
|
2196 |
$this->query( $query ); |
5
|
2197 |
} else { |
0
|
2198 |
return null; |
5
|
2199 |
} |
0
|
2200 |
|
|
2201 |
$new_array = array(); |
|
2202 |
if ( $output == OBJECT ) { |
|
2203 |
// Return an integer-keyed array of row objects |
|
2204 |
return $this->last_result; |
|
2205 |
} elseif ( $output == OBJECT_K ) { |
|
2206 |
// Return an array of row objects with keys from column 1 |
|
2207 |
// (Duplicates are discarded) |
|
2208 |
foreach ( $this->last_result as $row ) { |
|
2209 |
$var_by_ref = get_object_vars( $row ); |
|
2210 |
$key = array_shift( $var_by_ref ); |
|
2211 |
if ( ! isset( $new_array[ $key ] ) ) |
|
2212 |
$new_array[ $key ] = $row; |
|
2213 |
} |
|
2214 |
return $new_array; |
|
2215 |
} elseif ( $output == ARRAY_A || $output == ARRAY_N ) { |
|
2216 |
// Return an integer-keyed array of... |
|
2217 |
if ( $this->last_result ) { |
|
2218 |
foreach( (array) $this->last_result as $row ) { |
|
2219 |
if ( $output == ARRAY_N ) { |
|
2220 |
// ...integer-keyed row arrays |
|
2221 |
$new_array[] = array_values( get_object_vars( $row ) ); |
|
2222 |
} else { |
|
2223 |
// ...column name-keyed row arrays |
|
2224 |
$new_array[] = get_object_vars( $row ); |
|
2225 |
} |
|
2226 |
} |
|
2227 |
} |
|
2228 |
return $new_array; |
5
|
2229 |
} elseif ( strtoupper( $output ) === OBJECT ) { |
|
2230 |
// Back compat for OBJECT being previously case insensitive. |
|
2231 |
return $this->last_result; |
0
|
2232 |
} |
|
2233 |
return null; |
|
2234 |
} |
|
2235 |
|
|
2236 |
/** |
5
|
2237 |
* Retrieves the character set for the given table. |
|
2238 |
* |
|
2239 |
* @since 4.2.0 |
|
2240 |
* @access protected |
|
2241 |
* |
|
2242 |
* @param string $table Table name. |
|
2243 |
* @return string|WP_Error Table character set, WP_Error object if it couldn't be found. |
|
2244 |
*/ |
|
2245 |
protected function get_table_charset( $table ) { |
|
2246 |
$tablekey = strtolower( $table ); |
|
2247 |
|
|
2248 |
/** |
|
2249 |
* Filter the table charset value before the DB is checked. |
|
2250 |
* |
|
2251 |
* Passing a non-null value to the filter will effectively short-circuit |
|
2252 |
* checking the DB for the charset, returning that value instead. |
|
2253 |
* |
|
2254 |
* @since 4.2.0 |
|
2255 |
* |
|
2256 |
* @param string $charset The character set to use. Default null. |
|
2257 |
* @param string $table The name of the table being checked. |
|
2258 |
*/ |
|
2259 |
$charset = apply_filters( 'pre_get_table_charset', null, $table ); |
|
2260 |
if ( null !== $charset ) { |
|
2261 |
return $charset; |
|
2262 |
} |
|
2263 |
|
|
2264 |
if ( isset( $this->table_charset[ $tablekey ] ) ) { |
|
2265 |
return $this->table_charset[ $tablekey ]; |
|
2266 |
} |
|
2267 |
|
|
2268 |
$charsets = $columns = array(); |
|
2269 |
|
|
2270 |
$table_parts = explode( '.', $table ); |
|
2271 |
$table = '`' . implode( '`.`', $table_parts ) . '`'; |
|
2272 |
$results = $this->get_results( "SHOW FULL COLUMNS FROM $table" ); |
|
2273 |
if ( ! $results ) { |
|
2274 |
return new WP_Error( 'wpdb_get_table_charset_failure' ); |
|
2275 |
} |
|
2276 |
|
|
2277 |
foreach ( $results as $column ) { |
|
2278 |
$columns[ strtolower( $column->Field ) ] = $column; |
|
2279 |
} |
|
2280 |
|
|
2281 |
$this->col_meta[ $tablekey ] = $columns; |
|
2282 |
|
|
2283 |
foreach ( $columns as $column ) { |
|
2284 |
if ( ! empty( $column->Collation ) ) { |
|
2285 |
list( $charset ) = explode( '_', $column->Collation ); |
|
2286 |
|
|
2287 |
// If the current connection can't support utf8mb4 characters, let's only send 3-byte utf8 characters. |
|
2288 |
if ( 'utf8mb4' === $charset && ! $this->has_cap( 'utf8mb4' ) ) { |
|
2289 |
$charset = 'utf8'; |
|
2290 |
} |
|
2291 |
|
|
2292 |
$charsets[ strtolower( $charset ) ] = true; |
|
2293 |
} |
|
2294 |
|
|
2295 |
list( $type ) = explode( '(', $column->Type ); |
|
2296 |
|
|
2297 |
// A binary/blob means the whole query gets treated like this. |
|
2298 |
if ( in_array( strtoupper( $type ), array( 'BINARY', 'VARBINARY', 'TINYBLOB', 'MEDIUMBLOB', 'BLOB', 'LONGBLOB' ) ) ) { |
|
2299 |
$this->table_charset[ $tablekey ] = 'binary'; |
|
2300 |
return 'binary'; |
|
2301 |
} |
|
2302 |
} |
|
2303 |
|
|
2304 |
// utf8mb3 is an alias for utf8. |
|
2305 |
if ( isset( $charsets['utf8mb3'] ) ) { |
|
2306 |
$charsets['utf8'] = true; |
|
2307 |
unset( $charsets['utf8mb3'] ); |
|
2308 |
} |
|
2309 |
|
|
2310 |
// Check if we have more than one charset in play. |
|
2311 |
$count = count( $charsets ); |
|
2312 |
if ( 1 === $count ) { |
|
2313 |
$charset = key( $charsets ); |
|
2314 |
} elseif ( 0 === $count ) { |
|
2315 |
// No charsets, assume this table can store whatever. |
|
2316 |
$charset = false; |
|
2317 |
} else { |
|
2318 |
// More than one charset. Remove latin1 if present and recalculate. |
|
2319 |
unset( $charsets['latin1'] ); |
|
2320 |
$count = count( $charsets ); |
|
2321 |
if ( 1 === $count ) { |
|
2322 |
// Only one charset (besides latin1). |
|
2323 |
$charset = key( $charsets ); |
|
2324 |
} elseif ( 2 === $count && isset( $charsets['utf8'], $charsets['utf8mb4'] ) ) { |
|
2325 |
// Two charsets, but they're utf8 and utf8mb4, use utf8. |
|
2326 |
$charset = 'utf8'; |
|
2327 |
} else { |
|
2328 |
// Two mixed character sets. ascii. |
|
2329 |
$charset = 'ascii'; |
|
2330 |
} |
|
2331 |
} |
|
2332 |
|
|
2333 |
$this->table_charset[ $tablekey ] = $charset; |
|
2334 |
return $charset; |
|
2335 |
} |
|
2336 |
|
|
2337 |
/** |
|
2338 |
* Retrieves the character set for the given column. |
|
2339 |
* |
|
2340 |
* @since 4.2.0 |
|
2341 |
* @access public |
|
2342 |
* |
|
2343 |
* @param string $table Table name. |
|
2344 |
* @param string $column Column name. |
|
2345 |
* @return mixed Column character set as a string. False if the column has no |
|
2346 |
* character set. WP_Error object if there was an error. |
|
2347 |
*/ |
|
2348 |
public function get_col_charset( $table, $column ) { |
|
2349 |
$tablekey = strtolower( $table ); |
|
2350 |
$columnkey = strtolower( $column ); |
|
2351 |
|
|
2352 |
/** |
|
2353 |
* Filter the column charset value before the DB is checked. |
|
2354 |
* |
|
2355 |
* Passing a non-null value to the filter will short-circuit |
|
2356 |
* checking the DB for the charset, returning that value instead. |
|
2357 |
* |
|
2358 |
* @since 4.2.0 |
|
2359 |
* |
|
2360 |
* @param string $charset The character set to use. Default null. |
|
2361 |
* @param string $table The name of the table being checked. |
|
2362 |
* @param string $column The name of the column being checked. |
|
2363 |
*/ |
|
2364 |
$charset = apply_filters( 'pre_get_col_charset', null, $table, $column ); |
|
2365 |
if ( null !== $charset ) { |
|
2366 |
return $charset; |
|
2367 |
} |
|
2368 |
|
|
2369 |
// Skip this entirely if this isn't a MySQL database. |
|
2370 |
if ( false === $this->is_mysql ) { |
|
2371 |
return false; |
|
2372 |
} |
|
2373 |
|
|
2374 |
if ( empty( $this->table_charset[ $tablekey ] ) ) { |
|
2375 |
// This primes column information for us. |
|
2376 |
$table_charset = $this->get_table_charset( $table ); |
|
2377 |
if ( is_wp_error( $table_charset ) ) { |
|
2378 |
return $table_charset; |
|
2379 |
} |
|
2380 |
} |
|
2381 |
|
|
2382 |
// If still no column information, return the table charset. |
|
2383 |
if ( empty( $this->col_meta[ $tablekey ] ) ) { |
|
2384 |
return $this->table_charset[ $tablekey ]; |
|
2385 |
} |
|
2386 |
|
|
2387 |
// If this column doesn't exist, return the table charset. |
|
2388 |
if ( empty( $this->col_meta[ $tablekey ][ $columnkey ] ) ) { |
|
2389 |
return $this->table_charset[ $tablekey ]; |
|
2390 |
} |
|
2391 |
|
|
2392 |
// Return false when it's not a string column. |
|
2393 |
if ( empty( $this->col_meta[ $tablekey ][ $columnkey ]->Collation ) ) { |
|
2394 |
return false; |
|
2395 |
} |
|
2396 |
|
|
2397 |
list( $charset ) = explode( '_', $this->col_meta[ $tablekey ][ $columnkey ]->Collation ); |
|
2398 |
return $charset; |
|
2399 |
} |
|
2400 |
|
|
2401 |
/** |
|
2402 |
* Retrieve the maximum string length allowed in a given column. |
|
2403 |
* The length may either be specified as a byte length or a character length. |
|
2404 |
* |
|
2405 |
* @since 4.2.1 |
|
2406 |
* @access public |
|
2407 |
* |
|
2408 |
* @param string $table Table name. |
|
2409 |
* @param string $column Column name. |
|
2410 |
* @return mixed array( 'length' => (int), 'type' => 'byte' | 'char' ) |
|
2411 |
* false if the column has no length (for example, numeric column) |
|
2412 |
* WP_Error object if there was an error. |
|
2413 |
*/ |
|
2414 |
public function get_col_length( $table, $column ) { |
|
2415 |
$tablekey = strtolower( $table ); |
|
2416 |
$columnkey = strtolower( $column ); |
|
2417 |
|
|
2418 |
// Skip this entirely if this isn't a MySQL database. |
|
2419 |
if ( false === $this->is_mysql ) { |
|
2420 |
return false; |
|
2421 |
} |
|
2422 |
|
|
2423 |
if ( empty( $this->col_meta[ $tablekey ] ) ) { |
|
2424 |
// This primes column information for us. |
|
2425 |
$table_charset = $this->get_table_charset( $table ); |
|
2426 |
if ( is_wp_error( $table_charset ) ) { |
|
2427 |
return $table_charset; |
|
2428 |
} |
|
2429 |
} |
|
2430 |
|
|
2431 |
if ( empty( $this->col_meta[ $tablekey ][ $columnkey ] ) ) { |
|
2432 |
return false; |
|
2433 |
} |
|
2434 |
|
|
2435 |
$typeinfo = explode( '(', $this->col_meta[ $tablekey ][ $columnkey ]->Type ); |
|
2436 |
|
|
2437 |
$type = strtolower( $typeinfo[0] ); |
|
2438 |
if ( ! empty( $typeinfo[1] ) ) { |
|
2439 |
$length = trim( $typeinfo[1], ')' ); |
|
2440 |
} else { |
|
2441 |
$length = false; |
|
2442 |
} |
|
2443 |
|
|
2444 |
switch( $type ) { |
|
2445 |
case 'char': |
|
2446 |
case 'varchar': |
|
2447 |
return array( |
|
2448 |
'type' => 'char', |
|
2449 |
'length' => (int) $length, |
|
2450 |
); |
|
2451 |
break; |
|
2452 |
case 'binary': |
|
2453 |
case 'varbinary': |
|
2454 |
return array( |
|
2455 |
'type' => 'byte', |
|
2456 |
'length' => (int) $length, |
|
2457 |
); |
|
2458 |
break; |
|
2459 |
case 'tinyblob': |
|
2460 |
case 'tinytext': |
|
2461 |
return array( |
|
2462 |
'type' => 'byte', |
|
2463 |
'length' => 255, // 2^8 - 1 |
|
2464 |
); |
|
2465 |
break; |
|
2466 |
case 'blob': |
|
2467 |
case 'text': |
|
2468 |
return array( |
|
2469 |
'type' => 'byte', |
|
2470 |
'length' => 65535, // 2^16 - 1 |
|
2471 |
); |
|
2472 |
break; |
|
2473 |
case 'mediumblob': |
|
2474 |
case 'mediumtext': |
|
2475 |
return array( |
|
2476 |
'type' => 'byte', |
|
2477 |
'length' => 16777215, // 2^24 - 1 |
|
2478 |
); |
|
2479 |
break; |
|
2480 |
case 'longblob': |
|
2481 |
case 'longtext': |
|
2482 |
return array( |
|
2483 |
'type' => 'byte', |
|
2484 |
'length' => 4294967295, // 2^32 - 1 |
|
2485 |
); |
|
2486 |
break; |
|
2487 |
default: |
|
2488 |
return false; |
|
2489 |
} |
|
2490 |
|
|
2491 |
return false; |
|
2492 |
} |
|
2493 |
|
|
2494 |
/** |
|
2495 |
* Check if a string is ASCII. |
|
2496 |
* |
|
2497 |
* The negative regex is faster for non-ASCII strings, as it allows |
|
2498 |
* the search to finish as soon as it encounters a non-ASCII character. |
|
2499 |
* |
|
2500 |
* @since 4.2.0 |
|
2501 |
* @access protected |
|
2502 |
* |
|
2503 |
* @param string $string String to check. |
|
2504 |
* @return bool True if ASCII, false if not. |
|
2505 |
*/ |
|
2506 |
protected function check_ascii( $string ) { |
|
2507 |
if ( function_exists( 'mb_check_encoding' ) ) { |
|
2508 |
if ( mb_check_encoding( $string, 'ASCII' ) ) { |
|
2509 |
return true; |
|
2510 |
} |
|
2511 |
} elseif ( ! preg_match( '/[^\x00-\x7F]/', $string ) ) { |
|
2512 |
return true; |
|
2513 |
} |
|
2514 |
|
|
2515 |
return false; |
|
2516 |
} |
|
2517 |
|
|
2518 |
/** |
|
2519 |
* Check if the query is accessing a collation considered safe on the current version of MySQL. |
|
2520 |
* |
|
2521 |
* @since 4.2.0 |
|
2522 |
* @access protected |
|
2523 |
* |
|
2524 |
* @param string $query The query to check. |
|
2525 |
* @return bool True if the collation is safe, false if it isn't. |
|
2526 |
*/ |
|
2527 |
protected function check_safe_collation( $query ) { |
|
2528 |
if ( $this->checking_collation ) { |
|
2529 |
return true; |
|
2530 |
} |
|
2531 |
|
|
2532 |
// We don't need to check the collation for queries that don't read data. |
|
2533 |
$query = ltrim( $query, "\r\n\t (" ); |
|
2534 |
if ( preg_match( '/^(?:SHOW|DESCRIBE|DESC|EXPLAIN|CREATE)\s/i', $query ) ) { |
|
2535 |
return true; |
|
2536 |
} |
|
2537 |
|
|
2538 |
// All-ASCII queries don't need extra checking. |
|
2539 |
if ( $this->check_ascii( $query ) ) { |
|
2540 |
return true; |
|
2541 |
} |
|
2542 |
|
|
2543 |
$table = $this->get_table_from_query( $query ); |
|
2544 |
if ( ! $table ) { |
|
2545 |
return false; |
|
2546 |
} |
|
2547 |
|
|
2548 |
$this->checking_collation = true; |
|
2549 |
$collation = $this->get_table_charset( $table ); |
|
2550 |
$this->checking_collation = false; |
|
2551 |
|
|
2552 |
// Tables with no collation, or latin1 only, don't need extra checking. |
|
2553 |
if ( false === $collation || 'latin1' === $collation ) { |
|
2554 |
return true; |
|
2555 |
} |
|
2556 |
|
|
2557 |
$table = strtolower( $table ); |
|
2558 |
if ( empty( $this->col_meta[ $table ] ) ) { |
|
2559 |
return false; |
|
2560 |
} |
|
2561 |
|
|
2562 |
// If any of the columns don't have one of these collations, it needs more sanity checking. |
|
2563 |
foreach( $this->col_meta[ $table ] as $col ) { |
|
2564 |
if ( empty( $col->Collation ) ) { |
|
2565 |
continue; |
|
2566 |
} |
|
2567 |
|
|
2568 |
if ( ! in_array( $col->Collation, array( 'utf8_general_ci', 'utf8_bin', 'utf8mb4_general_ci', 'utf8mb4_bin' ), true ) ) { |
|
2569 |
return false; |
|
2570 |
} |
|
2571 |
} |
|
2572 |
|
|
2573 |
return true; |
|
2574 |
} |
|
2575 |
|
|
2576 |
/** |
|
2577 |
* Strips any invalid characters based on value/charset pairs. |
|
2578 |
* |
|
2579 |
* @since 4.2.0 |
|
2580 |
* @access protected |
|
2581 |
* |
|
2582 |
* @param array $data Array of value arrays. Each value array has the keys |
|
2583 |
* 'value' and 'charset'. An optional 'ascii' key can be |
|
2584 |
* set to false to avoid redundant ASCII checks. |
|
2585 |
* @return array|WP_Error The $data parameter, with invalid characters removed from |
|
2586 |
* each value. This works as a passthrough: any additional keys |
|
2587 |
* such as 'field' are retained in each value array. If we cannot |
|
2588 |
* remove invalid characters, a WP_Error object is returned. |
|
2589 |
*/ |
|
2590 |
protected function strip_invalid_text( $data ) { |
|
2591 |
$db_check_string = false; |
|
2592 |
|
|
2593 |
foreach ( $data as &$value ) { |
|
2594 |
$charset = $value['charset']; |
|
2595 |
|
|
2596 |
if ( is_array( $value['length'] ) ) { |
|
2597 |
$length = $value['length']['length']; |
|
2598 |
} else { |
|
2599 |
$length = false; |
|
2600 |
} |
|
2601 |
|
|
2602 |
// There's no charset to work with. |
|
2603 |
if ( false === $charset ) { |
|
2604 |
continue; |
|
2605 |
} |
|
2606 |
|
|
2607 |
// Column isn't a string. |
|
2608 |
if ( ! is_string( $value['value'] ) ) { |
|
2609 |
continue; |
|
2610 |
} |
|
2611 |
|
|
2612 |
$truncate_by_byte_length = 'byte' === $value['length']['type']; |
|
2613 |
|
|
2614 |
$needs_validation = true; |
|
2615 |
if ( |
|
2616 |
// latin1 can store any byte sequence |
|
2617 |
'latin1' === $charset |
|
2618 |
|| |
|
2619 |
// ASCII is always OK. |
|
2620 |
( ! isset( $value['ascii'] ) && $this->check_ascii( $value['value'] ) ) |
|
2621 |
) { |
|
2622 |
$truncate_by_byte_length = true; |
|
2623 |
$needs_validation = false; |
|
2624 |
} |
|
2625 |
|
|
2626 |
if ( $truncate_by_byte_length ) { |
|
2627 |
mbstring_binary_safe_encoding(); |
|
2628 |
if ( false !== $length && strlen( $value['value'] ) > $length ) { |
|
2629 |
$value['value'] = substr( $value['value'], 0, $length ); |
|
2630 |
} |
|
2631 |
reset_mbstring_encoding(); |
|
2632 |
|
|
2633 |
if ( ! $needs_validation ) { |
|
2634 |
continue; |
|
2635 |
} |
|
2636 |
} |
|
2637 |
|
|
2638 |
// utf8 can be handled by regex, which is a bunch faster than a DB lookup. |
|
2639 |
if ( ( 'utf8' === $charset || 'utf8mb3' === $charset || 'utf8mb4' === $charset ) && function_exists( 'mb_strlen' ) ) { |
|
2640 |
$regex = '/ |
|
2641 |
( |
|
2642 |
(?: [\x00-\x7F] # single-byte sequences 0xxxxxxx |
|
2643 |
| [\xC2-\xDF][\x80-\xBF] # double-byte sequences 110xxxxx 10xxxxxx |
|
2644 |
| \xE0[\xA0-\xBF][\x80-\xBF] # triple-byte sequences 1110xxxx 10xxxxxx * 2 |
|
2645 |
| [\xE1-\xEC][\x80-\xBF]{2} |
|
2646 |
| \xED[\x80-\x9F][\x80-\xBF] |
|
2647 |
| [\xEE-\xEF][\x80-\xBF]{2}'; |
|
2648 |
|
|
2649 |
if ( 'utf8mb4' === $charset ) { |
|
2650 |
$regex .= ' |
|
2651 |
| \xF0[\x90-\xBF][\x80-\xBF]{2} # four-byte sequences 11110xxx 10xxxxxx * 3 |
|
2652 |
| [\xF1-\xF3][\x80-\xBF]{3} |
|
2653 |
| \xF4[\x80-\x8F][\x80-\xBF]{2} |
|
2654 |
'; |
|
2655 |
} |
|
2656 |
|
|
2657 |
$regex .= '){1,40} # ...one or more times |
|
2658 |
) |
|
2659 |
| . # anything else |
|
2660 |
/x'; |
|
2661 |
$value['value'] = preg_replace( $regex, '$1', $value['value'] ); |
|
2662 |
|
|
2663 |
|
|
2664 |
if ( false !== $length && mb_strlen( $value['value'], 'UTF-8' ) > $length ) { |
|
2665 |
$value['value'] = mb_substr( $value['value'], 0, $length, 'UTF-8' ); |
|
2666 |
} |
|
2667 |
continue; |
|
2668 |
} |
|
2669 |
|
|
2670 |
// We couldn't use any local conversions, send it to the DB. |
|
2671 |
$value['db'] = $db_check_string = true; |
|
2672 |
} |
|
2673 |
unset( $value ); // Remove by reference. |
|
2674 |
|
|
2675 |
if ( $db_check_string ) { |
|
2676 |
$queries = array(); |
|
2677 |
foreach ( $data as $col => $value ) { |
|
2678 |
if ( ! empty( $value['db'] ) ) { |
|
2679 |
if ( ! isset( $queries[ $value['charset'] ] ) ) { |
|
2680 |
$queries[ $value['charset'] ] = array(); |
|
2681 |
} |
|
2682 |
|
|
2683 |
// We're going to need to truncate by characters or bytes, depending on the length value we have. |
|
2684 |
if ( 'byte' === $value['length']['type'] ) { |
|
2685 |
// Split the CONVERT() calls by charset, so we can make sure the connection is right |
|
2686 |
$queries[ $value['charset'] ][ $col ] = $this->prepare( "CONVERT( LEFT( CONVERT( %s USING binary ), %d ) USING {$value['charset']} )", $value['value'], $value['length']['length'] ); |
|
2687 |
} else { |
|
2688 |
$queries[ $value['charset'] ][ $col ] = $this->prepare( "LEFT( CONVERT( %s USING {$value['charset']} ), %d )", $value['value'], $value['length']['length'] ); |
|
2689 |
} |
|
2690 |
|
|
2691 |
unset( $data[ $col ]['db'] ); |
|
2692 |
} |
|
2693 |
} |
|
2694 |
|
|
2695 |
$connection_charset = $this->charset; |
|
2696 |
foreach ( $queries as $charset => $query ) { |
|
2697 |
if ( ! $query ) { |
|
2698 |
continue; |
|
2699 |
} |
|
2700 |
|
|
2701 |
// Change the charset to match the string(s) we're converting |
|
2702 |
if ( $charset !== $connection_charset ) { |
|
2703 |
$connection_charset = $charset; |
|
2704 |
$this->set_charset( $this->dbh, $charset ); |
|
2705 |
} |
|
2706 |
|
|
2707 |
$this->check_current_query = false; |
|
2708 |
|
|
2709 |
$sql = array(); |
|
2710 |
foreach ( $query as $column => $column_query ) { |
|
2711 |
$sql[] = $column_query . " AS x_$column"; |
|
2712 |
} |
|
2713 |
|
|
2714 |
$row = $this->get_row( "SELECT " . implode( ', ', $sql ), ARRAY_A ); |
|
2715 |
if ( ! $row ) { |
|
2716 |
$this->set_charset( $this->dbh, $connection_charset ); |
|
2717 |
return new WP_Error( 'wpdb_strip_invalid_text_failure' ); |
|
2718 |
} |
|
2719 |
|
|
2720 |
foreach ( array_keys( $query ) as $column ) { |
|
2721 |
$data[ $column ]['value'] = $row["x_$column"]; |
|
2722 |
} |
|
2723 |
} |
|
2724 |
|
|
2725 |
// Don't forget to change the charset back! |
|
2726 |
if ( $connection_charset !== $this->charset ) { |
|
2727 |
$this->set_charset( $this->dbh ); |
|
2728 |
} |
|
2729 |
} |
|
2730 |
|
|
2731 |
return $data; |
|
2732 |
} |
|
2733 |
|
|
2734 |
/** |
|
2735 |
* Strips any invalid characters from the query. |
|
2736 |
* |
|
2737 |
* @since 4.2.0 |
|
2738 |
* @access protected |
|
2739 |
* |
|
2740 |
* @param string $query Query to convert. |
|
2741 |
* @return string|WP_Error The converted query, or a WP_Error object if the conversion fails. |
|
2742 |
*/ |
|
2743 |
protected function strip_invalid_text_from_query( $query ) { |
|
2744 |
// We don't need to check the collation for queries that don't read data. |
|
2745 |
$trimmed_query = ltrim( $query, "\r\n\t (" ); |
|
2746 |
if ( preg_match( '/^(?:SHOW|DESCRIBE|DESC|EXPLAIN|CREATE)\s/i', $trimmed_query ) ) { |
|
2747 |
return $query; |
|
2748 |
} |
|
2749 |
|
|
2750 |
$table = $this->get_table_from_query( $query ); |
|
2751 |
if ( $table ) { |
|
2752 |
$charset = $this->get_table_charset( $table ); |
|
2753 |
if ( is_wp_error( $charset ) ) { |
|
2754 |
return $charset; |
|
2755 |
} |
|
2756 |
|
|
2757 |
// We can't reliably strip text from tables containing binary/blob columns |
|
2758 |
if ( 'binary' === $charset ) { |
|
2759 |
return $query; |
|
2760 |
} |
|
2761 |
} else { |
|
2762 |
$charset = $this->charset; |
|
2763 |
} |
|
2764 |
|
|
2765 |
$data = array( |
|
2766 |
'value' => $query, |
|
2767 |
'charset' => $charset, |
|
2768 |
'ascii' => false, |
|
2769 |
'length' => false, |
|
2770 |
); |
|
2771 |
|
|
2772 |
$data = $this->strip_invalid_text( array( $data ) ); |
|
2773 |
if ( is_wp_error( $data ) ) { |
|
2774 |
return $data; |
|
2775 |
} |
|
2776 |
|
|
2777 |
return $data[0]['value']; |
|
2778 |
} |
|
2779 |
|
|
2780 |
/** |
|
2781 |
* Strips any invalid characters from the string for a given table and column. |
|
2782 |
* |
|
2783 |
* @since 4.2.0 |
|
2784 |
* @access public |
|
2785 |
* |
|
2786 |
* @param string $table Table name. |
|
2787 |
* @param string $column Column name. |
|
2788 |
* @param string $value The text to check. |
|
2789 |
* @return string|WP_Error The converted string, or a WP_Error object if the conversion fails. |
|
2790 |
*/ |
|
2791 |
public function strip_invalid_text_for_column( $table, $column, $value ) { |
|
2792 |
if ( ! is_string( $value ) ) { |
|
2793 |
return $value; |
|
2794 |
} |
|
2795 |
|
|
2796 |
$charset = $this->get_col_charset( $table, $column ); |
|
2797 |
if ( ! $charset ) { |
|
2798 |
// Not a string column. |
|
2799 |
return $value; |
|
2800 |
} elseif ( is_wp_error( $charset ) ) { |
|
2801 |
// Bail on real errors. |
|
2802 |
return $charset; |
|
2803 |
} |
|
2804 |
|
|
2805 |
$data = array( |
|
2806 |
$column => array( |
|
2807 |
'value' => $value, |
|
2808 |
'charset' => $charset, |
|
2809 |
'length' => $this->get_col_length( $table, $column ), |
|
2810 |
) |
|
2811 |
); |
|
2812 |
|
|
2813 |
$data = $this->strip_invalid_text( $data ); |
|
2814 |
if ( is_wp_error( $data ) ) { |
|
2815 |
return $data; |
|
2816 |
} |
|
2817 |
|
|
2818 |
return $data[ $column ]['value']; |
|
2819 |
} |
|
2820 |
|
|
2821 |
/** |
|
2822 |
* Find the first table name referenced in a query. |
|
2823 |
* |
|
2824 |
* @since 4.2.0 |
|
2825 |
* @access protected |
|
2826 |
* |
|
2827 |
* @param string $query The query to search. |
|
2828 |
* @return string|false $table The table name found, or false if a table couldn't be found. |
|
2829 |
*/ |
|
2830 |
protected function get_table_from_query( $query ) { |
|
2831 |
// Remove characters that can legally trail the table name. |
|
2832 |
$query = rtrim( $query, ';/-#' ); |
|
2833 |
|
|
2834 |
// Allow (select...) union [...] style queries. Use the first query's table name. |
|
2835 |
$query = ltrim( $query, "\r\n\t (" ); |
|
2836 |
|
|
2837 |
/* |
|
2838 |
* Strip everything between parentheses except nested selects and use only 1,000 |
|
2839 |
* chars of the query. |
|
2840 |
*/ |
|
2841 |
$query = preg_replace( '/\((?!\s*select)[^(]*?\)/is', '()', substr( $query, 0, 1000 ) ); |
|
2842 |
|
|
2843 |
// Quickly match most common queries. |
|
2844 |
if ( preg_match( '/^\s*(?:' |
|
2845 |
. 'SELECT.*?\s+FROM' |
|
2846 |
. '|INSERT(?:\s+LOW_PRIORITY|\s+DELAYED|\s+HIGH_PRIORITY)?(?:\s+IGNORE)?(?:\s+INTO)?' |
|
2847 |
. '|REPLACE(?:\s+LOW_PRIORITY|\s+DELAYED)?(?:\s+INTO)?' |
|
2848 |
. '|UPDATE(?:\s+LOW_PRIORITY)?(?:\s+IGNORE)?' |
|
2849 |
. '|DELETE(?:\s+LOW_PRIORITY|\s+QUICK|\s+IGNORE)*(?:\s+FROM)?' |
|
2850 |
. ')\s+((?:[0-9a-zA-Z$_.`]|[\xC2-\xDF][\x80-\xBF])+)/is', $query, $maybe ) ) { |
|
2851 |
return str_replace( '`', '', $maybe[1] ); |
|
2852 |
} |
|
2853 |
|
|
2854 |
// SHOW TABLE STATUS and SHOW TABLES |
|
2855 |
if ( preg_match( '/^\s*(?:' |
|
2856 |
. 'SHOW\s+TABLE\s+STATUS.+(?:LIKE\s+|WHERE\s+Name\s*=\s*)' |
|
2857 |
. '|SHOW\s+(?:FULL\s+)?TABLES.+(?:LIKE\s+|WHERE\s+Name\s*=\s*)' |
|
2858 |
. ')\W((?:[0-9a-zA-Z$_.`]|[\xC2-\xDF][\x80-\xBF])+)\W/is', $query, $maybe ) ) { |
|
2859 |
return str_replace( '`', '', $maybe[1] ); |
|
2860 |
} |
|
2861 |
|
|
2862 |
// Big pattern for the rest of the table-related queries. |
|
2863 |
if ( preg_match( '/^\s*(?:' |
|
2864 |
. '(?:EXPLAIN\s+(?:EXTENDED\s+)?)?SELECT.*?\s+FROM' |
|
2865 |
. '|DESCRIBE|DESC|EXPLAIN|HANDLER' |
|
2866 |
. '|(?:LOCK|UNLOCK)\s+TABLE(?:S)?' |
|
2867 |
. '|(?:RENAME|OPTIMIZE|BACKUP|RESTORE|CHECK|CHECKSUM|ANALYZE|REPAIR).*\s+TABLE' |
|
2868 |
. '|TRUNCATE(?:\s+TABLE)?' |
|
2869 |
. '|CREATE(?:\s+TEMPORARY)?\s+TABLE(?:\s+IF\s+NOT\s+EXISTS)?' |
|
2870 |
. '|ALTER(?:\s+IGNORE)?\s+TABLE' |
|
2871 |
. '|DROP\s+TABLE(?:\s+IF\s+EXISTS)?' |
|
2872 |
. '|CREATE(?:\s+\w+)?\s+INDEX.*\s+ON' |
|
2873 |
. '|DROP\s+INDEX.*\s+ON' |
|
2874 |
. '|LOAD\s+DATA.*INFILE.*INTO\s+TABLE' |
|
2875 |
. '|(?:GRANT|REVOKE).*ON\s+TABLE' |
|
2876 |
. '|SHOW\s+(?:.*FROM|.*TABLE)' |
|
2877 |
. ')\s+\(*\s*((?:[0-9a-zA-Z$_.`]|[\xC2-\xDF][\x80-\xBF])+)\s*\)*/is', $query, $maybe ) ) { |
|
2878 |
return str_replace( '`', '', $maybe[1] ); |
|
2879 |
} |
|
2880 |
|
|
2881 |
return false; |
|
2882 |
} |
|
2883 |
|
|
2884 |
/** |
0
|
2885 |
* Load the column metadata from the last query. |
|
2886 |
* |
|
2887 |
* @since 3.5.0 |
|
2888 |
* |
|
2889 |
* @access protected |
|
2890 |
*/ |
|
2891 |
protected function load_col_info() { |
|
2892 |
if ( $this->col_info ) |
|
2893 |
return; |
|
2894 |
|
5
|
2895 |
if ( $this->use_mysqli ) { |
|
2896 |
for ( $i = 0; $i < @mysqli_num_fields( $this->result ); $i++ ) { |
|
2897 |
$this->col_info[ $i ] = @mysqli_fetch_field( $this->result ); |
|
2898 |
} |
|
2899 |
} else { |
|
2900 |
for ( $i = 0; $i < @mysql_num_fields( $this->result ); $i++ ) { |
|
2901 |
$this->col_info[ $i ] = @mysql_fetch_field( $this->result, $i ); |
|
2902 |
} |
0
|
2903 |
} |
|
2904 |
} |
|
2905 |
|
|
2906 |
/** |
|
2907 |
* Retrieve column metadata from the last query. |
|
2908 |
* |
|
2909 |
* @since 0.71 |
|
2910 |
* |
|
2911 |
* @param string $info_type Optional. Type one of name, table, def, max_length, not_null, primary_key, multiple_key, unique_key, numeric, blob, type, unsigned, zerofill |
|
2912 |
* @param int $col_offset Optional. 0: col name. 1: which table the col's in. 2: col's max length. 3: if the col is numeric. 4: col's type |
|
2913 |
* @return mixed Column Results |
|
2914 |
*/ |
5
|
2915 |
public function get_col_info( $info_type = 'name', $col_offset = -1 ) { |
0
|
2916 |
$this->load_col_info(); |
|
2917 |
|
|
2918 |
if ( $this->col_info ) { |
|
2919 |
if ( $col_offset == -1 ) { |
|
2920 |
$i = 0; |
|
2921 |
$new_array = array(); |
|
2922 |
foreach( (array) $this->col_info as $col ) { |
|
2923 |
$new_array[$i] = $col->{$info_type}; |
|
2924 |
$i++; |
|
2925 |
} |
|
2926 |
return $new_array; |
|
2927 |
} else { |
|
2928 |
return $this->col_info[$col_offset]->{$info_type}; |
|
2929 |
} |
|
2930 |
} |
|
2931 |
} |
|
2932 |
|
|
2933 |
/** |
|
2934 |
* Starts the timer, for debugging purposes. |
|
2935 |
* |
|
2936 |
* @since 1.5.0 |
|
2937 |
* |
5
|
2938 |
* @return bool |
0
|
2939 |
*/ |
5
|
2940 |
public function timer_start() { |
0
|
2941 |
$this->time_start = microtime( true ); |
|
2942 |
return true; |
|
2943 |
} |
|
2944 |
|
|
2945 |
/** |
|
2946 |
* Stops the debugging timer. |
|
2947 |
* |
|
2948 |
* @since 1.5.0 |
|
2949 |
* |
|
2950 |
* @return float Total time spent on the query, in seconds |
|
2951 |
*/ |
5
|
2952 |
public function timer_stop() { |
0
|
2953 |
return ( microtime( true ) - $this->time_start ); |
|
2954 |
} |
|
2955 |
|
|
2956 |
/** |
|
2957 |
* Wraps errors in a nice header and footer and dies. |
|
2958 |
* |
|
2959 |
* Will not die if wpdb::$show_errors is false. |
|
2960 |
* |
|
2961 |
* @since 1.5.0 |
|
2962 |
* |
|
2963 |
* @param string $message The Error message |
|
2964 |
* @param string $error_code Optional. A Computer readable string to identify the error. |
|
2965 |
* @return false|void |
|
2966 |
*/ |
5
|
2967 |
public function bail( $message, $error_code = '500' ) { |
0
|
2968 |
if ( !$this->show_errors ) { |
|
2969 |
if ( class_exists( 'WP_Error' ) ) |
|
2970 |
$this->error = new WP_Error($error_code, $message); |
|
2971 |
else |
|
2972 |
$this->error = $message; |
|
2973 |
return false; |
|
2974 |
} |
|
2975 |
wp_die($message); |
|
2976 |
} |
|
2977 |
|
|
2978 |
/** |
|
2979 |
* Whether MySQL database is at least the required minimum version. |
|
2980 |
* |
|
2981 |
* @since 2.5.0 |
|
2982 |
* @uses $wp_version |
|
2983 |
* @uses $required_mysql_version |
|
2984 |
* |
|
2985 |
* @return WP_Error |
|
2986 |
*/ |
5
|
2987 |
public function check_database_version() { |
0
|
2988 |
global $wp_version, $required_mysql_version; |
|
2989 |
// Make sure the server has the required MySQL version |
|
2990 |
if ( version_compare($this->db_version(), $required_mysql_version, '<') ) |
|
2991 |
return new WP_Error('database_version', sprintf( __( '<strong>ERROR</strong>: WordPress %1$s requires MySQL %2$s or higher' ), $wp_version, $required_mysql_version )); |
|
2992 |
} |
|
2993 |
|
|
2994 |
/** |
|
2995 |
* Whether the database supports collation. |
|
2996 |
* |
|
2997 |
* Called when WordPress is generating the table scheme. |
|
2998 |
* |
|
2999 |
* @since 2.5.0 |
|
3000 |
* @deprecated 3.5.0 |
|
3001 |
* @deprecated Use wpdb::has_cap( 'collation' ) |
|
3002 |
* |
|
3003 |
* @return bool True if collation is supported, false if version does not |
|
3004 |
*/ |
5
|
3005 |
public function supports_collation() { |
0
|
3006 |
_deprecated_function( __FUNCTION__, '3.5', 'wpdb::has_cap( \'collation\' )' ); |
|
3007 |
return $this->has_cap( 'collation' ); |
|
3008 |
} |
|
3009 |
|
|
3010 |
/** |
|
3011 |
* The database character collate. |
|
3012 |
* |
|
3013 |
* @since 3.5.0 |
|
3014 |
* |
|
3015 |
* @return string The database character collate. |
|
3016 |
*/ |
|
3017 |
public function get_charset_collate() { |
|
3018 |
$charset_collate = ''; |
|
3019 |
|
|
3020 |
if ( ! empty( $this->charset ) ) |
|
3021 |
$charset_collate = "DEFAULT CHARACTER SET $this->charset"; |
|
3022 |
if ( ! empty( $this->collate ) ) |
|
3023 |
$charset_collate .= " COLLATE $this->collate"; |
|
3024 |
|
|
3025 |
return $charset_collate; |
|
3026 |
} |
|
3027 |
|
|
3028 |
/** |
|
3029 |
* Determine if a database supports a particular feature. |
|
3030 |
* |
|
3031 |
* @since 2.7.0 |
5
|
3032 |
* @since 4.1.0 Support was added for the 'utf8mb4' feature. |
|
3033 |
* |
0
|
3034 |
* @see wpdb::db_version() |
|
3035 |
* |
5
|
3036 |
* @param string $db_cap The feature to check for. Accepts 'collation', |
|
3037 |
* 'group_concat', 'subqueries', 'set_charset', |
|
3038 |
* or 'utf8mb4'. |
|
3039 |
* @return bool Whether the database feature is supported, false otherwise. |
0
|
3040 |
*/ |
5
|
3041 |
public function has_cap( $db_cap ) { |
0
|
3042 |
$version = $this->db_version(); |
|
3043 |
|
|
3044 |
switch ( strtolower( $db_cap ) ) { |
|
3045 |
case 'collation' : // @since 2.5.0 |
|
3046 |
case 'group_concat' : // @since 2.7.0 |
|
3047 |
case 'subqueries' : // @since 2.7.0 |
|
3048 |
return version_compare( $version, '4.1', '>=' ); |
|
3049 |
case 'set_charset' : |
|
3050 |
return version_compare( $version, '5.0.7', '>=' ); |
5
|
3051 |
case 'utf8mb4' : // @since 4.1.0 |
|
3052 |
if ( version_compare( $version, '5.5.3', '<' ) ) { |
|
3053 |
return false; |
|
3054 |
} |
|
3055 |
if ( $this->use_mysqli ) { |
|
3056 |
$client_version = mysqli_get_client_info(); |
|
3057 |
} else { |
|
3058 |
$client_version = mysql_get_client_info(); |
|
3059 |
} |
|
3060 |
|
|
3061 |
/* |
|
3062 |
* libmysql has supported utf8mb4 since 5.5.3, same as the MySQL server. |
|
3063 |
* mysqlnd has supported utf8mb4 since 5.0.9. |
|
3064 |
*/ |
|
3065 |
if ( false !== strpos( $client_version, 'mysqlnd' ) ) { |
|
3066 |
$client_version = preg_replace( '/^\D+([\d.]+).*/', '$1', $client_version ); |
|
3067 |
return version_compare( $client_version, '5.0.9', '>=' ); |
|
3068 |
} else { |
|
3069 |
return version_compare( $client_version, '5.5.3', '>=' ); |
|
3070 |
} |
|
3071 |
} |
0
|
3072 |
|
|
3073 |
return false; |
|
3074 |
} |
|
3075 |
|
|
3076 |
/** |
|
3077 |
* Retrieve the name of the function that called wpdb. |
|
3078 |
* |
|
3079 |
* Searches up the list of functions until it reaches |
|
3080 |
* the one that would most logically had called this method. |
|
3081 |
* |
|
3082 |
* @since 2.5.0 |
|
3083 |
* |
|
3084 |
* @return string The name of the calling function |
|
3085 |
*/ |
5
|
3086 |
public function get_caller() { |
0
|
3087 |
return wp_debug_backtrace_summary( __CLASS__ ); |
|
3088 |
} |
|
3089 |
|
|
3090 |
/** |
|
3091 |
* The database version number. |
|
3092 |
* |
|
3093 |
* @since 2.7.0 |
|
3094 |
* |
5
|
3095 |
* @return null|string Null on failure, version number on success. |
0
|
3096 |
*/ |
5
|
3097 |
public function db_version() { |
|
3098 |
if ( $this->use_mysqli ) { |
|
3099 |
$server_info = mysqli_get_server_info( $this->dbh ); |
|
3100 |
} else { |
|
3101 |
$server_info = mysql_get_server_info( $this->dbh ); |
|
3102 |
} |
|
3103 |
return preg_replace( '/[^0-9.].*/', '', $server_info ); |
0
|
3104 |
} |
|
3105 |
} |