<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Admin\API\Reports\SqlQuery class file.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

namespace Automattic\WooCommerce\Admin\API\Reports;

[5] Fix | Delete

[6] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[7] Fix | Delete

exit;

[8] Fix | Delete

}

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Admin\API\Reports\SqlQuery: Common parent for manipulating SQL query clauses.

[12] Fix | Delete

*/

[13] Fix | Delete

class SqlQuery {

[14] Fix | Delete

/**

[15] Fix | Delete

* List of SQL clauses.

[16] Fix | Delete

*

[17] Fix | Delete

* @var array

[18] Fix | Delete

*/

[19] Fix | Delete

private $sql_clauses = array(

[20] Fix | Delete

'select' => array(),

[21] Fix | Delete

'from' => array(),

[22] Fix | Delete

'left_join' => array(),

[23] Fix | Delete

'join' => array(),

[24] Fix | Delete

'right_join' => array(),

[25] Fix | Delete

'where' => array(),

[26] Fix | Delete

'where_time' => array(),

[27] Fix | Delete

'group_by' => array(),

[28] Fix | Delete

'having' => array(),

[29] Fix | Delete

'limit' => array(),

[30] Fix | Delete

'order_by' => array(),

[31] Fix | Delete

'union' => array(),

[32] Fix | Delete

);

[33] Fix | Delete

/**

[34] Fix | Delete

* SQL clause merge filters.

[35] Fix | Delete

*

[36] Fix | Delete

* @var array

[37] Fix | Delete

*/

[38] Fix | Delete

private $sql_filters = array(

[39] Fix | Delete

'where' => array(

[40] Fix | Delete

'where',

[41] Fix | Delete

'where_time',

[42] Fix | Delete

),

[43] Fix | Delete

'join' => array(

[44] Fix | Delete

'right_join',

[45] Fix | Delete

'join',

[46] Fix | Delete

'left_join',

[47] Fix | Delete

),

[48] Fix | Delete

);

[49] Fix | Delete

/**

[50] Fix | Delete

* Data store context used to pass to filters.

[51] Fix | Delete

*

[52] Fix | Delete

* @var string

[53] Fix | Delete

*/

[54] Fix | Delete

protected $context;

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Constructor.

[58] Fix | Delete

*

[59] Fix | Delete

* @param string $context Optional context passed to filters. Default empty string.

[60] Fix | Delete

*/

[61] Fix | Delete

public function __construct( $context = '' ) {

[62] Fix | Delete

$this->context = $context;

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Add a SQL clause to be included when get_data is called.

[67] Fix | Delete

*

[68] Fix | Delete

* @param string $type Clause type.

[69] Fix | Delete

* @param string $clause SQL clause.

[70] Fix | Delete

*/

[71] Fix | Delete

public function add_sql_clause( $type, $clause ) {

[72] Fix | Delete

if ( isset( $this->sql_clauses[ $type ] ) && ! empty( $clause ) ) {

[73] Fix | Delete

$this->sql_clauses[ $type ][] = $clause;

[74] Fix | Delete

}

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

/**

[78] Fix | Delete

* Get SQL clause by type.

[79] Fix | Delete

*

[80] Fix | Delete

* @param string $type Clause type.

[81] Fix | Delete

* @param string $handling Whether to filter the return value (filtered|unfiltered). Default unfiltered.

[82] Fix | Delete

*

[83] Fix | Delete

* @return string SQL clause.

[84] Fix | Delete

*/

[85] Fix | Delete

protected function get_sql_clause( $type, $handling = 'unfiltered' ) {

[86] Fix | Delete

if ( ! isset( $this->sql_clauses[ $type ] ) ) {

[87] Fix | Delete

return '';

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Default to bypassing filters for clause retrieval internal to data stores.

[92] Fix | Delete

* The filters are applied when the full SQL statement is retrieved.

[93] Fix | Delete

*/

[94] Fix | Delete

if ( 'unfiltered' === $handling ) {

[95] Fix | Delete

return implode( ' ', $this->sql_clauses[ $type ] );

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

if ( isset( $this->sql_filters[ $type ] ) ) {

[99] Fix | Delete

$clauses = array();

[100] Fix | Delete

foreach ( $this->sql_filters[ $type ] as $subset ) {

[101] Fix | Delete

$clauses = array_merge( $clauses, $this->sql_clauses[ $subset ] );

[102] Fix | Delete

}

[103] Fix | Delete

} else {

[104] Fix | Delete

$clauses = $this->sql_clauses[ $type ];

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* Filter SQL clauses by type and context.

[109] Fix | Delete

*

[110] Fix | Delete

* @param array $clauses The original arguments for the request.

[111] Fix | Delete

* @param string $context The data store context.

[112] Fix | Delete

*/

[113] Fix | Delete

$clauses = apply_filters( "woocommerce_analytics_clauses_{$type}", $clauses, $this->context );

[114] Fix | Delete

/**

[115] Fix | Delete

* Filter SQL clauses by type and context.

[116] Fix | Delete

*

[117] Fix | Delete

* @param array $clauses The original arguments for the request.

[118] Fix | Delete

*/

[119] Fix | Delete

$clauses = apply_filters( "woocommerce_analytics_clauses_{$type}_{$this->context}", $clauses );

[120] Fix | Delete

return implode( ' ', $clauses );

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Clear SQL clauses by type.

[125] Fix | Delete

*

[126] Fix | Delete

* @param string|array $types Clause type.

[127] Fix | Delete

*/

[128] Fix | Delete

protected function clear_sql_clause( $types ) {

[129] Fix | Delete

foreach ( (array) $types as $type ) {

[130] Fix | Delete

if ( isset( $this->sql_clauses[ $type ] ) ) {

[131] Fix | Delete

$this->sql_clauses[ $type ] = array();

[132] Fix | Delete

}

[133] Fix | Delete

}

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

/**

[137] Fix | Delete

* Replace strings within SQL clauses by type.

[138] Fix | Delete

*

[139] Fix | Delete

* @param string $type Clause type.

[140] Fix | Delete

* @param string $search String to search for.

[141] Fix | Delete

* @param string $replace Replacement string.

[142] Fix | Delete

*/

[143] Fix | Delete

protected function str_replace_clause( $type, $search, $replace ) {

[144] Fix | Delete

if ( isset( $this->sql_clauses[ $type ] ) ) {

[145] Fix | Delete

foreach ( $this->sql_clauses[ $type ] as $key => $sql ) {

[146] Fix | Delete

$this->sql_clauses[ $type ][ $key ] = str_replace( $search, $replace, $sql );

[147] Fix | Delete

}

[148] Fix | Delete

}

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

/**

[152] Fix | Delete

* Get the full SQL statement.

[153] Fix | Delete

*

[154] Fix | Delete

* @return string

[155] Fix | Delete

*/

[156] Fix | Delete

public function get_query_statement() {

[157] Fix | Delete

$join = $this->get_sql_clause( 'join', 'filtered' );

[158] Fix | Delete

$where = $this->get_sql_clause( 'where', 'filtered' );

[159] Fix | Delete

$group_by = $this->get_sql_clause( 'group_by', 'filtered' );

[160] Fix | Delete

$having = $this->get_sql_clause( 'having', 'filtered' );

[161] Fix | Delete

$order_by = $this->get_sql_clause( 'order_by', 'filtered' );

[162] Fix | Delete

$union = $this->get_sql_clause( 'union', 'filtered' );

[163] Fix | Delete

[164] Fix | Delete

$statement = '';

[165] Fix | Delete

[166] Fix | Delete

$statement .= "

[167] Fix | Delete

SELECT

[168] Fix | Delete

{$this->get_sql_clause( 'select', 'filtered' )}

[169] Fix | Delete

FROM

[170] Fix | Delete

{$this->get_sql_clause( 'from', 'filtered' )}

[171] Fix | Delete

{$join}

[172] Fix | Delete

WHERE

[173] Fix | Delete

1=1

[174] Fix | Delete

{$where}

[175] Fix | Delete

";

[176] Fix | Delete

[177] Fix | Delete

if ( ! empty( $group_by ) ) {

[178] Fix | Delete

$statement .= "

[179] Fix | Delete

GROUP BY

[180] Fix | Delete

{$group_by}

[181] Fix | Delete

";

[182] Fix | Delete

if ( ! empty( $having ) ) {

[183] Fix | Delete

$statement .= "

[184] Fix | Delete

HAVING

[185] Fix | Delete

1=1

[186] Fix | Delete

{$having}

[187] Fix | Delete

";

[188] Fix | Delete

}

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

if ( ! empty( $union ) ) {

[192] Fix | Delete

$statement .= "

[193] Fix | Delete

UNION

[194] Fix | Delete

{$union}

[195] Fix | Delete

";

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

if ( ! empty( $order_by ) ) {

[199] Fix | Delete

$statement .= "

[200] Fix | Delete

ORDER BY

[201] Fix | Delete

{$order_by}

[202] Fix | Delete

";

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

return $statement . $this->get_sql_clause( 'limit', 'filtered' );

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

/**

[209] Fix | Delete

* Reinitialize the clause array.

[210] Fix | Delete

*/

[211] Fix | Delete

public function clear_all_clauses() {

[212] Fix | Delete

$this->sql_clauses = array(

[213] Fix | Delete

'select' => array(),

[214] Fix | Delete

'from' => array(),

[215] Fix | Delete

'left_join' => array(),

[216] Fix | Delete

'join' => array(),

[217] Fix | Delete

'right_join' => array(),

[218] Fix | Delete

'where' => array(),

[219] Fix | Delete

'where_time' => array(),

[220] Fix | Delete

'group_by' => array(),

[221] Fix | Delete

'having' => array(),

[222] Fix | Delete

'limit' => array(),

[223] Fix | Delete

'order_by' => array(),

[224] Fix | Delete

'union' => array(),

[225] Fix | Delete

);

[226] Fix | Delete

}

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete