WordPress 4.2
[autoinstalls/wordpress.git] / wp-includes / date.php
1 <?php
2 /**
3  * Class for generating SQL clauses that filter a primary query according to date.
4  *
5  * `WP_Date_Query` is a helper that allows primary query classes, such as {@see WP_Query},
6  * to filter their results by date columns, by generating `WHERE` subclauses to be attached
7  * to the primary SQL query string.
8  *
9  * Attempting to filter by an invalid date value (eg month=13) will generate SQL that will
10  * return no results. In these cases, a _doing_it_wrong() error notice is also thrown.
11  * See {@link WP_Date_Query::validate_date_values()}.
12  *
13  * @link https://codex.wordpress.org/Function_Reference/WP_Query Codex page.
14  *
15  * @since 3.7.0
16  */
17 class WP_Date_Query {
18         /**
19          * Array of date queries.
20          *
21          * See {@see WP_Date_Query::__construct()} for information on date query arguments.
22          *
23          * @since 3.7.0
24          * @access public
25          * @var array
26          */
27         public $queries = array();
28
29         /**
30          * The default relation between top-level queries. Can be either 'AND' or 'OR'.
31          *
32          * @since 3.7.0
33          * @access public
34          * @var string
35          */
36         public $relation = 'AND';
37
38         /**
39          * The column to query against. Can be changed via the query arguments.
40          *
41          * @since 3.7.0
42          * @access public
43          * @var string
44          */
45         public $column = 'post_date';
46
47         /**
48          * The value comparison operator. Can be changed via the query arguments.
49          *
50          * @since 3.7.0
51          * @access public
52          * @var array
53          */
54         public $compare = '=';
55
56         /**
57          * Supported time-related parameter keys.
58          *
59          * @since 4.1.0
60          * @access public
61          * @var array
62          */
63         public $time_keys = array( 'after', 'before', 'year', 'month', 'monthnum', 'week', 'w', 'dayofyear', 'day', 'dayofweek', 'dayofweek_iso', 'hour', 'minute', 'second' );
64
65         /**
66          * Constructor.
67          *
68          * Time-related parameters that normally require integer values ('year', 'month', 'week', 'dayofyear', 'day',
69          * 'dayofweek', 'dayofweek_iso', 'hour', 'minute', 'second') accept arrays of integers for some values of
70          * 'compare'. When 'compare' is 'IN' or 'NOT IN', arrays are accepted; when 'compare' is 'BETWEEN' or 'NOT
71          * BETWEEN', arrays of two valid values are required. See individual argument descriptions for accepted values.
72          *
73          * @since 3.7.0
74          * @since 4.0.0 The $inclusive logic was updated to include all times within the date range.
75          * @since 4.1.0 Introduced 'dayofweek_iso' time type parameter.
76          * @access public
77          *
78          * @param array $date_query {
79          *     Array of date query clauses.
80          *
81          *     @type array {
82          *         @type string $column   Optional. The column to query against. If undefined, inherits the value of
83          *                                the `$default_column` parameter. Accepts 'post_date', 'post_date_gmt',
84          *                                'post_modified','post_modified_gmt', 'comment_date', 'comment_date_gmt'.
85          *                                Default 'post_date'.
86          *         @type string $compare  Optional. The comparison operator. Accepts '=', '!=', '>', '>=', '<', '<=',
87          *                                'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'. Default '='.
88          *         @type string $relation Optional. The boolean relationship between the date queries. Accepts 'OR' or 'AND'.
89          *                                Default 'OR'.
90          *         @type array {
91          *             Optional. An array of first-order clause parameters, or another fully-formed date query.
92          *
93          *             @type string|array $before {
94          *                 Optional. Date to retrieve posts before. Accepts `strtotime()`-compatible string,
95          *                 or array of 'year', 'month', 'day' values.
96          *
97          *                 @type string $year  The four-digit year. Default empty. Accepts any four-digit year.
98          *                 @type string $month Optional when passing array.The month of the year.
99          *                                     Default (string:empty)|(array:1). Accepts numbers 1-12.
100          *                 @type string $day   Optional when passing array.The day of the month.
101          *                                     Default (string:empty)|(array:1). Accepts numbers 1-31.
102          *             }
103          *             @type string|array $after {
104          *                 Optional. Date to retrieve posts after. Accepts `strtotime()`-compatible string,
105          *                 or array of 'year', 'month', 'day' values.
106          *
107          *                 @type string $year  The four-digit year. Accepts any four-digit year. Default empty.
108          *                 @type string $month Optional when passing array. The month of the year. Accepts numbers 1-12.
109          *                                     Default (string:empty)|(array:12).
110          *                 @type string $day   Optional when passing array.The day of the month. Accepts numbers 1-31.
111          *                                     Default (string:empty)|(array:last day of month).
112          *             }
113          *             @type string       $column        Optional. Used to add a clause comparing a column other than the
114          *                                               column specified in the top-level `$column` parameter. Accepts
115          *                                               'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt',
116          *                                               'comment_date', 'comment_date_gmt'. Default is the value of
117          *                                               top-level `$column`.
118          *             @type string       $compare       Optional. The comparison operator. Accepts '=', '!=', '>', '>=',
119          *                                               '<', '<=', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'. 'IN',
120          *                                               'NOT IN', 'BETWEEN', and 'NOT BETWEEN'. Comparisons support
121          *                                               arrays in some time-related parameters. Default '='.
122          *             @type bool         $inclusive     Optional. Include results from dates specified in 'before' or
123          *                                               'after'. Default false.
124          *             @type int|array    $year          Optional. The four-digit year number. Accepts any four-digit year
125          *                                               or an array of years if `$compare` supports it. Default empty.
126          *             @type int|array    $month         Optional. The two-digit month number. Accepts numbers 1-12 or an
127          *                                               array of valid numbers if `$compare` supports it. Default empty.
128          *             @type int|array    $week          Optional. The week number of the year. Accepts numbers 0-53 or an
129          *                                               array of valid numbers if `$compare` supports it. Default empty.
130          *             @type int|array    $dayofyear     Optional. The day number of the year. Accepts numbers 1-366 or an
131          *                                               array of valid numbers if `$compare` supports it.
132          *             @type int|array    $day           Optional. The day of the month. Accepts numbers 1-31 or an array
133          *                                               of valid numbers if `$compare` supports it. Default empty.
134          *             @type int|array    $dayofweek     Optional. The day number of the week. Accepts numbers 1-7 (1 is
135          *                                               Sunday) or an array of valid numbers if `$compare` supports it.
136          *                                               Default empty.
137          *             @type int|array    $dayofweek_iso Optional. The day number of the week (ISO). Accepts numbers 1-7
138          *                                               (1 is Monday) or an array of valid numbers if `$compare` supports it.
139          *                                               Default empty.
140          *             @type int|array    $hour          Optional. The hour of the day. Accepts numbers 0-23 or an array
141          *                                               of valid numbers if `$compare` supports it. Default empty.
142          *             @type int|array    $minute        Optional. The minute of the hour. Accepts numbers 0-60 or an array
143          *                                               of valid numbers if `$compare` supports it. Default empty.
144          *             @type int|array    $second        Optional. The second of the minute. Accepts numbers 0-60 or an
145          *                                               array of valid numbers if `$compare` supports it. Default empty.
146          *         }
147          *     }
148          * }
149          * @param array $default_column Optional. Default column to query against. Default 'post_date'.
150          *                              Accepts 'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt',
151          *                              'comment_date', 'comment_date_gmt'.
152          */
153         public function __construct( $date_query, $default_column = 'post_date' ) {
154
155                 if ( isset( $date_query['relation'] ) && 'OR' === strtoupper( $date_query['relation'] ) ) {
156                         $this->relation = 'OR';
157                 } else {
158                         $this->relation = 'AND';
159                 }
160
161                 if ( ! is_array( $date_query ) ) {
162                         return;
163                 }
164
165                 // Support for passing time-based keys in the top level of the $date_query array.
166                 if ( ! isset( $date_query[0] ) && ! empty( $date_query ) ) {
167                         $date_query = array( $date_query );
168                 }
169
170                 if ( empty( $date_query ) ) {
171                         return;
172                 }
173
174                 if ( ! empty( $date_query['column'] ) ) {
175                         $date_query['column'] = esc_sql( $date_query['column'] );
176                 } else {
177                         $date_query['column'] = esc_sql( $default_column );
178                 }
179
180                 $this->column = $this->validate_column( $this->column );
181
182                 $this->compare = $this->get_compare( $date_query );
183
184                 $this->queries = $this->sanitize_query( $date_query );
185         }
186
187         /**
188          * Recursive-friendly query sanitizer.
189          *
190          * Ensures that each query-level clause has a 'relation' key, and that
191          * each first-order clause contains all the necessary keys from
192          * `$defaults`.
193          *
194          * @since 4.1.0
195          * @access public
196          *
197          * @param array $queries
198          * @param array $parent_query
199          *
200          * @return array Sanitized queries.
201          */
202         public function sanitize_query( $queries, $parent_query = null ) {
203                 $cleaned_query = array();
204
205                 $defaults = array(
206                         'column'   => 'post_date',
207                         'compare'  => '=',
208                         'relation' => 'AND',
209                 );
210
211                 // Numeric keys should always have array values.
212                 foreach ( $queries as $qkey => $qvalue ) {
213                         if ( is_numeric( $qkey ) && ! is_array( $qvalue ) ) {
214                                 unset( $queries[ $qkey ] );
215                         }
216                 }
217
218                 // Each query should have a value for each default key. Inherit from the parent when possible.
219                 foreach ( $defaults as $dkey => $dvalue ) {
220                         if ( isset( $queries[ $dkey ] ) ) {
221                                 continue;
222                         }
223
224                         if ( isset( $parent_query[ $dkey ] ) ) {
225                                 $queries[ $dkey ] = $parent_query[ $dkey ];
226                         } else {
227                                 $queries[ $dkey ] = $dvalue;
228                         }
229                 }
230
231                 // Validate the dates passed in the query.
232                 if ( $this->is_first_order_clause( $queries ) ) {
233                         $this->validate_date_values( $queries );
234                 }
235
236                 foreach ( $queries as $key => $q ) {
237                         if ( ! is_array( $q ) || in_array( $key, $this->time_keys, true ) ) {
238                                 // This is a first-order query. Trust the values and sanitize when building SQL.
239                                 $cleaned_query[ $key ] = $q;
240                         } else {
241                                 // Any array without a time key is another query, so we recurse.
242                                 $cleaned_query[] = $this->sanitize_query( $q, $queries );
243                         }
244                 }
245
246                 return $cleaned_query;
247         }
248
249         /**
250          * Determine whether this is a first-order clause.
251          *
252          * Checks to see if the current clause has any time-related keys.
253          * If so, it's first-order.
254          *
255          * @param  array $query Query clause.
256          * @return bool True if this is a first-order clause.
257          */
258         protected function is_first_order_clause( $query ) {
259                 $time_keys = array_intersect( $this->time_keys, array_keys( $query ) );
260                 return ! empty( $time_keys );
261         }
262
263         /**
264          * Determines and validates what comparison operator to use.
265          *
266          * @since 3.7.0
267          * @access public
268          *
269          * @param array $query A date query or a date subquery.
270          * @return string The comparison operator.
271          */
272         public function get_compare( $query ) {
273                 if ( ! empty( $query['compare'] ) && in_array( $query['compare'], array( '=', '!=', '>', '>=', '<', '<=', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) )
274                         return strtoupper( $query['compare'] );
275
276                 return $this->compare;
277         }
278
279         /**
280          * Validates the given date_query values and triggers errors if something is not valid.
281          *
282          * Note that date queries with invalid date ranges are allowed to
283          * continue (though of course no items will be found for impossible dates).
284          * This method only generates debug notices for these cases.
285          *
286          * @since  4.1.0
287          * @access public
288          *
289          * @param  array $date_query The date_query array.
290          * @return bool  True if all values in the query are valid, false if one or more fail.
291          */
292         public function validate_date_values( $date_query = array() ) {
293                 if ( empty( $date_query ) ) {
294                         return false;
295                 }
296
297                 $valid = true;
298
299                 /*
300                  * Validate 'before' and 'after' up front, then let the
301                  * validation routine continue to be sure that all invalid
302                  * values generate errors too.
303                  */
304                 if ( array_key_exists( 'before', $date_query ) && is_array( $date_query['before'] ) ){
305                         $valid = $this->validate_date_values( $date_query['before'] );
306                 }
307
308                 if ( array_key_exists( 'after', $date_query ) && is_array( $date_query['after'] ) ){
309                         $valid = $this->validate_date_values( $date_query['after'] );
310                 }
311
312                 // Array containing all min-max checks.
313                 $min_max_checks = array();
314
315                 // Days per year.
316                 if ( array_key_exists( 'year', $date_query ) ) {
317                         /*
318                          * If a year exists in the date query, we can use it to get the days.
319                          * If multiple years are provided (as in a BETWEEN), use the first one.
320                          */
321                         if ( is_array( $date_query['year'] ) ) {
322                                 $_year = reset( $date_query['year'] );
323                         } else {
324                                 $_year = $date_query['year'];
325                         }
326
327                         $max_days_of_year = date( 'z', mktime( 0, 0, 0, 12, 31, $_year ) ) + 1;
328                 } else {
329                         // otherwise we use the max of 366 (leap-year)
330                         $max_days_of_year = 366;
331                 }
332
333                 $min_max_checks['dayofyear'] = array(
334                         'min' => 1,
335                         'max' => $max_days_of_year
336                 );
337
338                 // Days per week.
339                 $min_max_checks['dayofweek'] = array(
340                         'min' => 1,
341                         'max' => 7
342                 );
343
344                 // Days per week.
345                 $min_max_checks['dayofweek_iso'] = array(
346                         'min' => 1,
347                         'max' => 7
348                 );
349
350                 // Months per year.
351                 $min_max_checks['month'] = array(
352                         'min' => 1,
353                         'max' => 12
354                 );
355
356                 // Weeks per year.
357                 if ( isset( $_year ) ) {
358                         // If we have a specific year, use it to calculate number of weeks.
359                         $date = new DateTime();
360                         $date->setISODate( $_year, 53 );
361                         $week_count = $date->format( "W" ) === "53" ? 53 : 52;
362
363                 } else {
364                         // Otherwise set the week-count to a maximum of 53.
365                         $week_count = 53;
366                 }
367
368                 $min_max_checks['week'] = array(
369                         'min' => 1,
370                         'max' => $week_count
371                 );
372
373                 // Days per month.
374                 $min_max_checks['day'] = array(
375                         'min' => 1,
376                         'max' => 31
377                 );
378
379                 // Hours per day.
380                 $min_max_checks['hour'] = array(
381                         'min' => 0,
382                         'max' => 23
383                 );
384
385                 // Minutes per hour.
386                 $min_max_checks['minute'] = array(
387                         'min' => 0,
388                         'max' => 59
389                 );
390
391                 // Seconds per minute.
392                 $min_max_checks['second'] = array(
393                         'min' => 0,
394                         'max' => 59
395                 );
396
397                 // Concatenate and throw a notice for each invalid value.
398                 foreach ( $min_max_checks as $key => $check ) {
399                         if ( ! array_key_exists( $key, $date_query ) ) {
400                                 continue;
401                         }
402
403                         // Throw a notice for each failing value.
404                         foreach ( (array) $date_query[ $key ] as $_value ) {
405                                 $is_between = $_value >= $check['min'] && $_value <= $check['max'];
406
407                                 if ( ! is_numeric( $_value ) || ! $is_between ) {
408                                         $error = sprintf(
409                                                 /* translators: Date query invalid date message: 1: invalid value, 2: type of value, 3: minimum valid value, 4: maximum valid value */
410                                                 __( 'Invalid value %1$s for %2$s. Expected value should be between %3$s and %4$s.' ),
411                                                 '<code>' . esc_html( $_value ) . '</code>',
412                                                 '<code>' . esc_html( $key ) . '</code>',
413                                                 '<code>' . esc_html( $check['min'] ) . '</code>',
414                                                 '<code>' . esc_html( $check['max'] ) . '</code>'
415                                         );
416
417                                         _doing_it_wrong( __CLASS__, $error, '4.1.0' );
418
419                                         $valid = false;
420                                 }
421                         }
422                 }
423
424                 // If we already have invalid date messages, don't bother running through checkdate().
425                 if ( ! $valid ) {
426                         return $valid;
427                 }
428
429                 $day_month_year_error_msg = '';
430
431                 $day_exists   = array_key_exists( 'day', $date_query ) && is_numeric( $date_query['day'] );
432                 $month_exists = array_key_exists( 'month', $date_query ) && is_numeric( $date_query['month'] );
433                 $year_exists  = array_key_exists( 'year', $date_query ) && is_numeric( $date_query['year'] );
434
435                 if ( $day_exists && $month_exists && $year_exists ) {
436                         // 1. Checking day, month, year combination.
437                         if ( ! wp_checkdate( $date_query['month'], $date_query['day'], $date_query['year'], sprintf( '%s-%s-%s', $date_query['year'], $date_query['month'], $date_query['day'] ) ) ) {
438                                 /* translators: 1: year, 2: month, 3: day of month */
439                                 $day_month_year_error_msg = sprintf(
440                                         __( 'The following values do not describe a valid date: year %1$s, month %2$s, day %3$s.' ),
441                                         '<code>' . esc_html( $date_query['year'] ) . '</code>',
442                                         '<code>' . esc_html( $date_query['month'] ) . '</code>',
443                                         '<code>' . esc_html( $date_query['day'] ) . '</code>'
444                                 );
445
446                                 $valid = false;
447                         }
448
449                 } elseif ( $day_exists && $month_exists ) {
450                         /*
451                          * 2. checking day, month combination
452                          * We use 2012 because, as a leap year, it's the most permissive.
453                          */
454                         if ( ! wp_checkdate( $date_query['month'], $date_query['day'], 2012, sprintf( '2012-%s-%s', $date_query['month'], $date_query['day'] ) ) ) {
455                                 /* translators: 1: month, 2: day of month */
456                                 $day_month_year_error_msg = sprintf(
457                                         __( 'The following values do not describe a valid date: month %1$s, day %2$s.' ),
458                                         '<code>' . esc_html( $date_query['month'] ) . '</code>',
459                                         '<code>' . esc_html( $date_query['day'] ) . '</code>'
460                                 );
461
462                                 $valid = false;
463                         }
464                 }
465
466                 if ( ! empty( $day_month_year_error_msg ) ) {
467                         _doing_it_wrong( __CLASS__, $day_month_year_error_msg, '4.1.0' );
468                 }
469
470                 return $valid;
471         }
472
473         /**
474          * Validates a column name parameter.
475          *
476          * Column names without a table prefix (like 'post_date') are checked against a whitelist of
477          * known tables, and then, if found, have a table prefix (such as 'wp_posts.') prepended.
478          * Prefixed column names (such as 'wp_posts.post_date') bypass this whitelist check,
479          * and are only sanitized to remove illegal characters.
480          *
481          * @since 3.7.0
482          * @access public
483          *
484          * @param string $column The user-supplied column name.
485          * @return string A validated column name value.
486          */
487         public function validate_column( $column ) {
488                 global $wpdb;
489
490                 $valid_columns = array(
491                         'post_date', 'post_date_gmt', 'post_modified',
492                         'post_modified_gmt', 'comment_date', 'comment_date_gmt',
493                         'user_registered',
494                 );
495
496                 // Attempt to detect a table prefix.
497                 if ( false === strpos( $column, '.' ) ) {
498                         /**
499                          * Filter the list of valid date query columns.
500                          *
501                          * @since 3.7.0
502                          * @since 4.1.0 Added 'user_registered' to the default recognized columns.
503                          *
504                          * @param array $valid_columns An array of valid date query columns. Defaults
505                          *                             are 'post_date', 'post_date_gmt', 'post_modified',
506                          *                             'post_modified_gmt', 'comment_date', 'comment_date_gmt',
507                          *                                 'user_registered'
508                          */
509                         if ( ! in_array( $column, apply_filters( 'date_query_valid_columns', $valid_columns ) ) ) {
510                                 $column = 'post_date';
511                         }
512
513                         $known_columns = array(
514                                 $wpdb->posts => array(
515                                         'post_date',
516                                         'post_date_gmt',
517                                         'post_modified',
518                                         'post_modified_gmt',
519                                 ),
520                                 $wpdb->comments => array(
521                                         'comment_date',
522                                         'comment_date_gmt',
523                                 ),
524                                 $wpdb->users => array(
525                                         'user_registered',
526                                 ),
527                         );
528
529                         // If it's a known column name, add the appropriate table prefix.
530                         foreach ( $known_columns as $table_name => $table_columns ) {
531                                 if ( in_array( $column, $table_columns ) ) {
532                                         $column = $table_name . '.' . $column;
533                                         break;
534                                 }
535                         }
536
537                 }
538
539                 // Remove unsafe characters.
540                 return preg_replace( '/[^a-zA-Z0-9_$\.]/', '', $column );
541         }
542
543         /**
544          * Generate WHERE clause to be appended to a main query.
545          *
546          * @since 3.7.0
547          * @access public
548          *
549          * @return string MySQL WHERE clause.
550          */
551         public function get_sql() {
552                 $sql = $this->get_sql_clauses();
553
554                 $where = $sql['where'];
555
556                 /**
557                  * Filter the date query WHERE clause.
558                  *
559                  * @since 3.7.0
560                  *
561                  * @param string        $where WHERE clause of the date query.
562                  * @param WP_Date_Query $this  The WP_Date_Query instance.
563                  */
564                 return apply_filters( 'get_date_sql', $where, $this );
565         }
566
567         /**
568          * Generate SQL clauses to be appended to a main query.
569          *
570          * Called by the public {@see WP_Date_Query::get_sql()}, this method
571          * is abstracted out to maintain parity with the other Query classes.
572          *
573          * @since 4.1.0
574          * @access protected
575          *
576          * @return array {
577          *     Array containing JOIN and WHERE SQL clauses to append to the main query.
578          *
579          *     @type string $join  SQL fragment to append to the main JOIN clause.
580          *     @type string $where SQL fragment to append to the main WHERE clause.
581          * }
582          */
583         protected function get_sql_clauses() {
584                 $sql = $this->get_sql_for_query( $this->queries );
585
586                 if ( ! empty( $sql['where'] ) ) {
587                         $sql['where'] = ' AND ' . $sql['where'];
588                 }
589
590                 return $sql;
591         }
592
593         /**
594          * Generate SQL clauses for a single query array.
595          *
596          * If nested subqueries are found, this method recurses the tree to
597          * produce the properly nested SQL.
598          *
599          * @since 4.1.0
600          * @access protected
601          *
602          * @param array $query Query to parse.
603          * @param int   $depth Optional. Number of tree levels deep we currently are.
604          *                     Used to calculate indentation. Default 0.
605          * @return array {
606          *     Array containing JOIN and WHERE SQL clauses to append to a single query array.
607          *
608          *     @type string $join  SQL fragment to append to the main JOIN clause.
609          *     @type string $where SQL fragment to append to the main WHERE clause.
610          * }
611          */
612         protected function get_sql_for_query( $query, $depth = 0 ) {
613                 $sql_chunks = array(
614                         'join'  => array(),
615                         'where' => array(),
616                 );
617
618                 $sql = array(
619                         'join'  => '',
620                         'where' => '',
621                 );
622
623                 $indent = '';
624                 for ( $i = 0; $i < $depth; $i++ ) {
625                         $indent .= "  ";
626                 }
627
628                 foreach ( $query as $key => $clause ) {
629                         if ( 'relation' === $key ) {
630                                 $relation = $query['relation'];
631                         } elseif ( is_array( $clause ) ) {
632
633                                 // This is a first-order clause.
634                                 if ( $this->is_first_order_clause( $clause ) ) {
635                                         $clause_sql = $this->get_sql_for_clause( $clause, $query );
636
637                                         $where_count = count( $clause_sql['where'] );
638                                         if ( ! $where_count ) {
639                                                 $sql_chunks['where'][] = '';
640                                         } elseif ( 1 === $where_count ) {
641                                                 $sql_chunks['where'][] = $clause_sql['where'][0];
642                                         } else {
643                                                 $sql_chunks['where'][] = '( ' . implode( ' AND ', $clause_sql['where'] ) . ' )';
644                                         }
645
646                                         $sql_chunks['join'] = array_merge( $sql_chunks['join'], $clause_sql['join'] );
647                                 // This is a subquery, so we recurse.
648                                 } else {
649                                         $clause_sql = $this->get_sql_for_query( $clause, $depth + 1 );
650
651                                         $sql_chunks['where'][] = $clause_sql['where'];
652                                         $sql_chunks['join'][]  = $clause_sql['join'];
653                                 }
654                         }
655                 }
656
657                 // Filter to remove empties.
658                 $sql_chunks['join']  = array_filter( $sql_chunks['join'] );
659                 $sql_chunks['where'] = array_filter( $sql_chunks['where'] );
660
661                 if ( empty( $relation ) ) {
662                         $relation = 'AND';
663                 }
664
665                 // Filter duplicate JOIN clauses and combine into a single string.
666                 if ( ! empty( $sql_chunks['join'] ) ) {
667                         $sql['join'] = implode( ' ', array_unique( $sql_chunks['join'] ) );
668                 }
669
670                 // Generate a single WHERE clause with proper brackets and indentation.
671                 if ( ! empty( $sql_chunks['where'] ) ) {
672                         $sql['where'] = '( ' . "\n  " . $indent . implode( ' ' . "\n  " . $indent . $relation . ' ' . "\n  " . $indent, $sql_chunks['where'] ) . "\n" . $indent . ')';
673                 }
674
675                 return $sql;
676         }
677
678         /**
679          * Turns a single date clause into pieces for a WHERE clause.
680          *
681          * A wrapper for get_sql_for_clause(), included here for backward
682          * compatibility while retaining the naming convention across Query classes.
683          *
684          * @since  3.7.0
685          * @access protected
686          *
687          * @param  array $query Date query arguments.
688          * @return array {
689          *     Array containing JOIN and WHERE SQL clauses to append to the main query.
690          *
691          *     @type string $join  SQL fragment to append to the main JOIN clause.
692          *     @type string $where SQL fragment to append to the main WHERE clause.
693          * }
694          */
695         protected function get_sql_for_subquery( $query ) {
696                 return $this->get_sql_for_clause( $query, '' );
697         }
698
699         /**
700          * Turns a first-order date query into SQL for a WHERE clause.
701          *
702          * @since  4.1.0
703          * @access protected
704          *
705          * @param  array $query        Date query clause.
706          * @param  array $parent_query Parent query of the current date query.
707          * @return array {
708          *     Array containing JOIN and WHERE SQL clauses to append to the main query.
709          *
710          *     @type string $join  SQL fragment to append to the main JOIN clause.
711          *     @type string $where SQL fragment to append to the main WHERE clause.
712          * }
713          */
714         protected function get_sql_for_clause( $query, $parent_query ) {
715                 global $wpdb;
716
717                 // The sub-parts of a $where part.
718                 $where_parts = array();
719
720                 $column = ( ! empty( $query['column'] ) ) ? esc_sql( $query['column'] ) : $this->column;
721
722                 $column = $this->validate_column( $column );
723
724                 $compare = $this->get_compare( $query );
725
726                 $inclusive = ! empty( $query['inclusive'] );
727
728                 // Assign greater- and less-than values.
729                 $lt = '<';
730                 $gt = '>';
731
732                 if ( $inclusive ) {
733                         $lt .= '=';
734                         $gt .= '=';
735                 }
736
737                 // Range queries.
738                 if ( ! empty( $query['after'] ) )
739                         $where_parts[] = $wpdb->prepare( "$column $gt %s", $this->build_mysql_datetime( $query['after'], ! $inclusive ) );
740
741                 if ( ! empty( $query['before'] ) )
742                         $where_parts[] = $wpdb->prepare( "$column $lt %s", $this->build_mysql_datetime( $query['before'], $inclusive ) );
743
744                 // Specific value queries.
745
746                 if ( isset( $query['year'] ) && $value = $this->build_value( $compare, $query['year'] ) )
747                         $where_parts[] = "YEAR( $column ) $compare $value";
748
749                 if ( isset( $query['month'] ) && $value = $this->build_value( $compare, $query['month'] ) ) {
750                         $where_parts[] = "MONTH( $column ) $compare $value";
751                 } elseif ( isset( $query['monthnum'] ) && $value = $this->build_value( $compare, $query['monthnum'] ) ) {
752                         $where_parts[] = "MONTH( $column ) $compare $value";
753                 }
754                 if ( isset( $query['week'] ) && false !== ( $value = $this->build_value( $compare, $query['week'] ) ) ) {
755                         $where_parts[] = _wp_mysql_week( $column ) . " $compare $value";
756                 } elseif ( isset( $query['w'] ) && false !== ( $value = $this->build_value( $compare, $query['w'] ) ) ) {
757                         $where_parts[] = _wp_mysql_week( $column ) . " $compare $value";
758                 }
759                 if ( isset( $query['dayofyear'] ) && $value = $this->build_value( $compare, $query['dayofyear'] ) )
760                         $where_parts[] = "DAYOFYEAR( $column ) $compare $value";
761
762                 if ( isset( $query['day'] ) && $value = $this->build_value( $compare, $query['day'] ) )
763                         $where_parts[] = "DAYOFMONTH( $column ) $compare $value";
764
765                 if ( isset( $query['dayofweek'] ) && $value = $this->build_value( $compare, $query['dayofweek'] ) )
766                         $where_parts[] = "DAYOFWEEK( $column ) $compare $value";
767
768                 if ( isset( $query['dayofweek_iso'] ) && $value = $this->build_value( $compare, $query['dayofweek_iso'] ) )
769                         $where_parts[] = "WEEKDAY( $column ) + 1 $compare $value";
770
771                 if ( isset( $query['hour'] ) || isset( $query['minute'] ) || isset( $query['second'] ) ) {
772                         // Avoid notices.
773                         foreach ( array( 'hour', 'minute', 'second' ) as $unit ) {
774                                 if ( ! isset( $query[ $unit ] ) ) {
775                                         $query[ $unit ] = null;
776                                 }
777                         }
778
779                         if ( $time_query = $this->build_time_query( $column, $compare, $query['hour'], $query['minute'], $query['second'] ) ) {
780                                 $where_parts[] = $time_query;
781                         }
782                 }
783
784                 /*
785                  * Return an array of 'join' and 'where' for compatibility
786                  * with other query classes.
787                  */
788                 return array(
789                         'where' => $where_parts,
790                         'join'  => array(),
791                 );
792         }
793
794         /**
795          * Builds and validates a value string based on the comparison operator.
796          *
797          * @since 3.7.0
798          * @access public
799          *
800          * @param string $compare The compare operator to use
801          * @param string|array $value The value
802          * @return string|false|int The value to be used in SQL or false on error.
803          */
804         public function build_value( $compare, $value ) {
805                 if ( ! isset( $value ) )
806                         return false;
807
808                 switch ( $compare ) {
809                         case 'IN':
810                         case 'NOT IN':
811                                 $value = (array) $value;
812
813                                 // Remove non-numeric values.
814                                 $value = array_filter( $value, 'is_numeric' );
815
816                                 if ( empty( $value ) ) {
817                                         return false;
818                                 }
819
820                                 return '(' . implode( ',', array_map( 'intval', $value ) ) . ')';
821
822                         case 'BETWEEN':
823                         case 'NOT BETWEEN':
824                                 if ( ! is_array( $value ) || 2 != count( $value ) ) {
825                                         $value = array( $value, $value );
826                                 } else {
827                                         $value = array_values( $value );
828                                 }
829
830                                 // If either value is non-numeric, bail.
831                                 foreach ( $value as $v ) {
832                                         if ( ! is_numeric( $v ) ) {
833                                                 return false;
834                                         }
835                                 }
836
837                                 $value = array_map( 'intval', $value );
838
839                                 return $value[0] . ' AND ' . $value[1];
840
841                         default;
842                                 if ( ! is_numeric( $value ) ) {
843                                         return false;
844                                 }
845
846                                 return (int) $value;
847                 }
848         }
849
850         /**
851          * Builds a MySQL format date/time based on some query parameters.
852          *
853          * You can pass an array of values (year, month, etc.) with missing parameter values being defaulted to
854          * either the maximum or minimum values (controlled by the $default_to parameter). Alternatively you can
855          * pass a string that that will be run through strtotime().
856          *
857          * @since 3.7.0
858          * @access public
859          *
860          * @param string|array $datetime       An array of parameters or a strotime() string
861          * @param bool         $default_to_max Whether to round up incomplete dates. Supported by values
862          *                                     of $datetime that are arrays, or string values that are a
863          *                                     subset of MySQL date format ('Y', 'Y-m', 'Y-m-d', 'Y-m-d H:i').
864          *                                     Default: false.
865          * @return string|false A MySQL format date/time or false on failure
866          */
867         public function build_mysql_datetime( $datetime, $default_to_max = false ) {
868                 $now = current_time( 'timestamp' );
869
870                 if ( ! is_array( $datetime ) ) {
871
872                         /*
873                          * Try to parse some common date formats, so we can detect
874                          * the level of precision and support the 'inclusive' parameter.
875                          */
876                         if ( preg_match( '/^(\d{4})$/', $datetime, $matches ) ) {
877                                 // Y
878                                 $datetime = array(
879                                         'year' => intval( $matches[1] ),
880                                 );
881
882                         } elseif ( preg_match( '/^(\d{4})\-(\d{2})$/', $datetime, $matches ) ) {
883                                 // Y-m
884                                 $datetime = array(
885                                         'year'  => intval( $matches[1] ),
886                                         'month' => intval( $matches[2] ),
887                                 );
888
889                         } elseif ( preg_match( '/^(\d{4})\-(\d{2})\-(\d{2})$/', $datetime, $matches ) ) {
890                                 // Y-m-d
891                                 $datetime = array(
892                                         'year'  => intval( $matches[1] ),
893                                         'month' => intval( $matches[2] ),
894                                         'day'   => intval( $matches[3] ),
895                                 );
896
897                         } elseif ( preg_match( '/^(\d{4})\-(\d{2})\-(\d{2}) (\d{2}):(\d{2})$/', $datetime, $matches ) ) {
898                                 // Y-m-d H:i
899                                 $datetime = array(
900                                         'year'   => intval( $matches[1] ),
901                                         'month'  => intval( $matches[2] ),
902                                         'day'    => intval( $matches[3] ),
903                                         'hour'   => intval( $matches[4] ),
904                                         'minute' => intval( $matches[5] ),
905                                 );
906                         }
907
908                         // If no match is found, we don't support default_to_max.
909                         if ( ! is_array( $datetime ) ) {
910                                 // @todo Timezone issues here possibly
911                                 return gmdate( 'Y-m-d H:i:s', strtotime( $datetime, $now ) );
912                         }
913                 }
914
915                 $datetime = array_map( 'absint', $datetime );
916
917                 if ( ! isset( $datetime['year'] ) )
918                         $datetime['year'] = gmdate( 'Y', $now );
919
920                 if ( ! isset( $datetime['month'] ) )
921                         $datetime['month'] = ( $default_to_max ) ? 12 : 1;
922
923                 if ( ! isset( $datetime['day'] ) )
924                         $datetime['day'] = ( $default_to_max ) ? (int) date( 't', mktime( 0, 0, 0, $datetime['month'], 1, $datetime['year'] ) ) : 1;
925
926                 if ( ! isset( $datetime['hour'] ) )
927                         $datetime['hour'] = ( $default_to_max ) ? 23 : 0;
928
929                 if ( ! isset( $datetime['minute'] ) )
930                         $datetime['minute'] = ( $default_to_max ) ? 59 : 0;
931
932                 if ( ! isset( $datetime['second'] ) )
933                         $datetime['second'] = ( $default_to_max ) ? 59 : 0;
934
935                 return sprintf( '%04d-%02d-%02d %02d:%02d:%02d', $datetime['year'], $datetime['month'], $datetime['day'], $datetime['hour'], $datetime['minute'], $datetime['second'] );
936         }
937
938         /**
939          * Builds a query string for comparing time values (hour, minute, second).
940          *
941          * If just hour, minute, or second is set than a normal comparison will be done.
942          * However if multiple values are passed, a pseudo-decimal time will be created
943          * in order to be able to accurately compare against.
944          *
945          * @since 3.7.0
946          * @access public
947          *
948          * @param string $column The column to query against. Needs to be pre-validated!
949          * @param string $compare The comparison operator. Needs to be pre-validated!
950          * @param int|null $hour Optional. An hour value (0-23).
951          * @param int|null $minute Optional. A minute value (0-59).
952          * @param int|null $second Optional. A second value (0-59).
953          * @return string|false A query part or false on failure.
954          */
955         public function build_time_query( $column, $compare, $hour = null, $minute = null, $second = null ) {
956                 global $wpdb;
957
958                 // Have to have at least one
959                 if ( ! isset( $hour ) && ! isset( $minute ) && ! isset( $second ) )
960                         return false;
961
962                 // Complex combined queries aren't supported for multi-value queries
963                 if ( in_array( $compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
964                         $return = array();
965
966                         if ( isset( $hour ) && false !== ( $value = $this->build_value( $compare, $hour ) ) )
967                                 $return[] = "HOUR( $column ) $compare $value";
968
969                         if ( isset( $minute ) && false !== ( $value = $this->build_value( $compare, $minute ) ) )
970                                 $return[] = "MINUTE( $column ) $compare $value";
971
972                         if ( isset( $second ) && false !== ( $value = $this->build_value( $compare, $second ) ) )
973                                 $return[] = "SECOND( $column ) $compare $value";
974
975                         return implode( ' AND ', $return );
976                 }
977
978                 // Cases where just one unit is set
979                 if ( isset( $hour ) && ! isset( $minute ) && ! isset( $second ) && false !== ( $value = $this->build_value( $compare, $hour ) ) ) {
980                         return "HOUR( $column ) $compare $value";
981                 } elseif ( ! isset( $hour ) && isset( $minute ) && ! isset( $second ) && false !== ( $value = $this->build_value( $compare, $minute ) ) ) {
982                         return "MINUTE( $column ) $compare $value";
983                 } elseif ( ! isset( $hour ) && ! isset( $minute ) && isset( $second ) && false !== ( $value = $this->build_value( $compare, $second ) ) ) {
984                         return "SECOND( $column ) $compare $value";
985                 }
986
987                 // Single units were already handled. Since hour & second isn't allowed, minute must to be set.
988                 if ( ! isset( $minute ) )
989                         return false;
990
991                 $format = $time = '';
992
993                 // Hour
994                 if ( $hour ) {
995                         $format .= '%H.';
996                         $time   .= sprintf( '%02d', $hour ) . '.';
997                 } else {
998                         $format .= '0.';
999                         $time   .= '0.';
1000                 }
1001
1002                 // Minute
1003                 $format .= '%i';
1004                 $time   .= sprintf( '%02d', $minute );
1005
1006                 if ( isset( $second ) ) {
1007                         $format .= '%s';
1008                         $time   .= sprintf( '%02d', $second );
1009                 }
1010
1011                 return $wpdb->prepare( "DATE_FORMAT( $column, %s ) $compare %f", $format, $time );
1012         }
1013 }