<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* CustomMetaDataStore class file.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

namespace Automattic\WooCommerce\Internal\DataStores;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Implements functions similar to WP's add_metadata(), get_metadata(), and friends using a custom table.

[8] Fix | Delete

*

[9] Fix | Delete

* @see WC_Data_Store_WP For an implementation using WP's metadata functions and tables.

[10] Fix | Delete

*/

[11] Fix | Delete

abstract class CustomMetaDataStore {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Returns the name of the table used for storage.

[15] Fix | Delete

*

[16] Fix | Delete

* @return string

[17] Fix | Delete

*/

[18] Fix | Delete

abstract protected function get_table_name();

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Returns the name of the field/column used for identifiying metadata entries.

[22] Fix | Delete

*

[23] Fix | Delete

* @return string

[24] Fix | Delete

*/

[25] Fix | Delete

protected function get_meta_id_field() {

[26] Fix | Delete

return 'id';

[27] Fix | Delete

}

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Returns the name of the field/column used for associating meta with objects.

[31] Fix | Delete

*

[32] Fix | Delete

* @return string

[33] Fix | Delete

*/

[34] Fix | Delete

protected function get_object_id_field() {

[35] Fix | Delete

return 'object_id';

[36] Fix | Delete

}

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Describes the structure of the metadata table.

[40] Fix | Delete

*

[41] Fix | Delete

* @return array Array elements: table, object_id_field, meta_id_field.

[42] Fix | Delete

*/

[43] Fix | Delete

protected function get_db_info() {

[44] Fix | Delete

return array(

[45] Fix | Delete

'table' => $this->get_table_name(),

[46] Fix | Delete

'meta_id_field' => $this->get_meta_id_field(),

[47] Fix | Delete

'object_id_field' => $this->get_object_id_field(),

[48] Fix | Delete

);

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Returns an array of meta for an object.

[53] Fix | Delete

*

[54] Fix | Delete

* @param \WC_Data $object WC_Data object.

[55] Fix | Delete

* @return array

[56] Fix | Delete

*/

[57] Fix | Delete

public function read_meta( &$object ) {

[58] Fix | Delete

$object_id = $object->get_id();

[59] Fix | Delete

$raw_meta_data = $this->get_meta_data_for_object_ids( array( $object_id ) );

[60] Fix | Delete

[61] Fix | Delete

return isset( $raw_meta_data[ $object_id ] ) ? (array) $raw_meta_data[ $object_id ] : array();

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

/**

[65] Fix | Delete

* Deletes meta based on meta ID.

[66] Fix | Delete

*

[67] Fix | Delete

* @param \WC_Data $object WC_Data object.

[68] Fix | Delete

* @param \stdClass $meta (containing at least ->id).

[69] Fix | Delete

*

[70] Fix | Delete

* @return bool

[71] Fix | Delete

*/

[72] Fix | Delete

public function delete_meta( &$object, $meta ) : bool {

[73] Fix | Delete

global $wpdb;

[74] Fix | Delete

[75] Fix | Delete

if ( ! isset( $meta->id ) ) {

[76] Fix | Delete

return false;

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

$db_info = $this->get_db_info();

[80] Fix | Delete

$meta_id = absint( $meta->id );

[81] Fix | Delete

[82] Fix | Delete

return (bool) $wpdb->delete(

[83] Fix | Delete

$db_info['table'],

[84] Fix | Delete

array(

[85] Fix | Delete

$db_info['meta_id_field'] => $meta_id,

[86] Fix | Delete

$db_info['object_id_field'] => $object->get_id(),

[87] Fix | Delete

),

[88] Fix | Delete

'%d'

[89] Fix | Delete

);

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

/**

[93] Fix | Delete

* Add new piece of meta.

[94] Fix | Delete

*

[95] Fix | Delete

* @param WC_Data $object WC_Data object.

[96] Fix | Delete

* @param stdClass $meta (containing ->key and ->value).

[97] Fix | Delete

*

[98] Fix | Delete

* @return int|false meta ID

[99] Fix | Delete

*/

[100] Fix | Delete

public function add_meta( &$object, $meta ) {

[101] Fix | Delete

global $wpdb;

[102] Fix | Delete

[103] Fix | Delete

$db_info = $this->get_db_info();

[104] Fix | Delete

[105] Fix | Delete

$object_id = $object->get_id();

[106] Fix | Delete

if ( ! $object_id ) {

[107] Fix | Delete

return false;

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

$meta_key = wp_unslash( wp_slash( $meta->key ) );

[111] Fix | Delete

$meta_value = maybe_serialize( is_string( $meta->value ) ? wp_unslash( wp_slash( $meta->value ) ) : $meta->value );

[112] Fix | Delete

[113] Fix | Delete

// phpcs:disable WordPress.DB.SlowDBQuery.slow_db_query_meta_value,WordPress.DB.SlowDBQuery.slow_db_query_meta_key

[114] Fix | Delete

$result = $wpdb->insert(

[115] Fix | Delete

$db_info['table'],

[116] Fix | Delete

array(

[117] Fix | Delete

$db_info['object_id_field'] => $object_id,

[118] Fix | Delete

'meta_key' => $meta_key,

[119] Fix | Delete

'meta_value' => $meta_value,

[120] Fix | Delete

)

[121] Fix | Delete

);

[122] Fix | Delete

// phpcs:enable WordPress.DB.SlowDBQuery.slow_db_query_meta_value,WordPress.DB.SlowDBQuery.slow_db_query_meta_key

[123] Fix | Delete

[124] Fix | Delete

return $result ? (int) $wpdb->insert_id : false;

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

/**

[128] Fix | Delete

* Update meta.

[129] Fix | Delete

*

[130] Fix | Delete

* @param \WC_Data $object WC_Data object.

[131] Fix | Delete

* @param \stdClass $meta (containing ->id, ->key and ->value).

[132] Fix | Delete

*

[133] Fix | Delete

* @return bool

[134] Fix | Delete

*/

[135] Fix | Delete

public function update_meta( &$object, $meta ) : bool {

[136] Fix | Delete

global $wpdb;

[137] Fix | Delete

[138] Fix | Delete

if ( ! isset( $meta->id ) || empty( $meta->key ) || ! $object->get_id() ) {

[139] Fix | Delete

return false;

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

// phpcs:disable WordPress.DB.SlowDBQuery.slow_db_query_meta_value,WordPress.DB.SlowDBQuery.slow_db_query_meta_key

[143] Fix | Delete

$data = array(

[144] Fix | Delete

'meta_key' => $meta->key,

[145] Fix | Delete

'meta_value' => maybe_serialize( $meta->value ),

[146] Fix | Delete

);

[147] Fix | Delete

// phpcs:enable WordPress.DB.SlowDBQuery.slow_db_query_meta_value,WordPress.DB.SlowDBQuery.slow_db_query_meta_key

[148] Fix | Delete

[149] Fix | Delete

$result = $wpdb->update(

[150] Fix | Delete

$this->get_table_name(),

[151] Fix | Delete

$data,

[152] Fix | Delete

array(

[153] Fix | Delete

$this->get_meta_id_field() => $meta->id,

[154] Fix | Delete

$this->get_object_id_field() => $object->get_id(),

[155] Fix | Delete

),

[156] Fix | Delete

'%s',

[157] Fix | Delete

'%d'

[158] Fix | Delete

);

[159] Fix | Delete

[160] Fix | Delete

return 1 === $result;

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

/**

[164] Fix | Delete

* Retrieves metadata by meta ID.

[165] Fix | Delete

*

[166] Fix | Delete

* @param int $meta_id Meta ID.

[167] Fix | Delete

* @return object|bool Metadata object or FALSE if not found.

[168] Fix | Delete

*/

[169] Fix | Delete

public function get_metadata_by_id( $meta_id ) {

[170] Fix | Delete

global $wpdb;

[171] Fix | Delete

[172] Fix | Delete

if ( ! is_numeric( $meta_id ) || floor( $meta_id ) != $meta_id ) { // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison

[173] Fix | Delete

return false;

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

$db_info = $this->get_db_info();

[177] Fix | Delete

[178] Fix | Delete

$meta_id = absint( $meta_id );

[179] Fix | Delete

// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared

[180] Fix | Delete

$meta = $wpdb->get_row(

[181] Fix | Delete

$wpdb->prepare(

[182] Fix | Delete

"SELECT {$db_info['meta_id_field']}, meta_key, meta_value, {$db_info['object_id_field']} FROM {$db_info['table']} WHERE {$db_info['meta_id_field']} = %d",

[183] Fix | Delete

$meta_id

[184] Fix | Delete

)

[185] Fix | Delete

);

[186] Fix | Delete

// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared

[187] Fix | Delete

[188] Fix | Delete

if ( empty( $meta ) ) {

[189] Fix | Delete

return false;

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete

if ( isset( $meta->meta_value ) ) {

[193] Fix | Delete

$meta->meta_value = maybe_unserialize( $meta->meta_value );

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

return $meta;

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Retrieves metadata by meta key.

[201] Fix | Delete

*

[202] Fix | Delete

* @param \WC_Data $object Object ID.

[203] Fix | Delete

* @param string $meta_key Meta key.

[204] Fix | Delete

*

[205] Fix | Delete

* @return \stdClass[]|false Metadata object or FALSE if not found.

[206] Fix | Delete

*/

[207] Fix | Delete

public function get_metadata_by_key( &$object, string $meta_key ) {

[208] Fix | Delete

global $wpdb;

[209] Fix | Delete

[210] Fix | Delete

if ( ! $object->get_id() ) {

[211] Fix | Delete

return false;

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete

$db_info = $this->get_db_info();

[215] Fix | Delete

[216] Fix | Delete

// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared

[217] Fix | Delete

$meta = $wpdb->get_results(

[218] Fix | Delete

$wpdb->prepare(

[219] Fix | Delete

"SELECT {$db_info['meta_id_field']}, meta_key, meta_value, {$db_info['object_id_field']} FROM {$db_info['table']} WHERE meta_key = %s AND {$db_info['object_id_field']} = %d",

[220] Fix | Delete

$meta_key,

[221] Fix | Delete

$object->get_id(),

[222] Fix | Delete

)

[223] Fix | Delete

);

[224] Fix | Delete

// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared

[225] Fix | Delete

[226] Fix | Delete

if ( empty( $meta ) ) {

[227] Fix | Delete

return false;

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

foreach ( $meta as $row ) {

[231] Fix | Delete

if ( isset( $row->meta_value ) ) {

[232] Fix | Delete

$row->meta_value = maybe_unserialize( $row->meta_value );

[233] Fix | Delete

}

[234] Fix | Delete

}

[235] Fix | Delete

[236] Fix | Delete

return $meta;

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete

/**

[240] Fix | Delete

* Returns distinct meta keys in use.

[241] Fix | Delete

*

[242] Fix | Delete

* @since 8.8.0

[243] Fix | Delete

*

[244] Fix | Delete

* @param int $limit Maximum number of meta keys to return. Defaults to 100.

[245] Fix | Delete

* @return string[]

[246] Fix | Delete

*/

[247] Fix | Delete

public function get_meta_keys( int $limit = 100 ): array {

[248] Fix | Delete

global $wpdb;

[249] Fix | Delete

[250] Fix | Delete

return $wpdb->get_col(

[251] Fix | Delete

$wpdb->prepare(

[252] Fix | Delete

"SELECT DISTINCT meta_key FROM %i WHERE meta_key != '' AND meta_key NOT BETWEEN '_' AND '_z' AND meta_key NOT LIKE %s ORDER BY meta_key ASC LIMIT %d",

[253] Fix | Delete

$this->get_db_info()['table'],

[254] Fix | Delete

$wpdb->esc_like( '_' ) . '%',

[255] Fix | Delete

$limit

[256] Fix | Delete

)

[257] Fix | Delete

);

[258] Fix | Delete

}

[259] Fix | Delete

[260] Fix | Delete

/**

[261] Fix | Delete

* Return order meta data for multiple IDs.

[262] Fix | Delete

*

[263] Fix | Delete

* @param array $object_ids List of object IDs.

[264] Fix | Delete

*

[265] Fix | Delete

* @return \stdClass[][] An array, keyed by object_ids, containing array of raw meta data records for each object. Objects with no meta data will have an empty array.

[266] Fix | Delete

*/

[267] Fix | Delete

public function get_meta_data_for_object_ids( array $object_ids ): array {

[268] Fix | Delete

global $wpdb;

[269] Fix | Delete

[270] Fix | Delete

if ( empty( $object_ids ) ) {

[271] Fix | Delete

return array();

[272] Fix | Delete

}

[273] Fix | Delete

[274] Fix | Delete

$id_placeholder = implode( ', ', array_fill( 0, count( $object_ids ), '%d' ) );

[275] Fix | Delete

$meta_table = $this->get_table_name();

[276] Fix | Delete

$object_id_column = $this->get_object_id_field();

[277] Fix | Delete

[278] Fix | Delete

// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare -- $object_id_column and $meta_table is hardcoded. IDs are prepared above.

[279] Fix | Delete

$meta_rows = $wpdb->get_results(

[280] Fix | Delete

$wpdb->prepare(

[281] Fix | Delete

"SELECT id, $object_id_column as object_id, meta_key, meta_value FROM $meta_table WHERE $object_id_column in ( $id_placeholder )",

[282] Fix | Delete

$object_ids

[283] Fix | Delete

)

[284] Fix | Delete

);

[285] Fix | Delete

// phpcs:enable

[286] Fix | Delete

[287] Fix | Delete

$meta_data = array_fill_keys( $object_ids, array() );

[288] Fix | Delete

foreach ( $meta_rows as $meta_row ) {

[289] Fix | Delete

if ( ! isset( $meta_data[ $meta_row->object_id ] ) ) {

[290] Fix | Delete

$meta_data[ $meta_row->object_id ] = array();

[291] Fix | Delete

}

[292] Fix | Delete

$meta_data[ $meta_row->object_id ][] = (object) array(

[293] Fix | Delete

'meta_id' => $meta_row->id,

[294] Fix | Delete

'meta_key' => $meta_row->meta_key, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key

[295] Fix | Delete

'meta_value' => $meta_row->meta_value, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value

[296] Fix | Delete

);

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

return $meta_data;

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete