<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WC Admin Note Traits

[2] Fix | Delete

*

[3] Fix | Delete

* WC Admin Note Traits class that houses shared functionality across notes.

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce\Admin\Notes;

[7] Fix | Delete

[8] Fix | Delete

use Automattic\WooCommerce\Admin\WCAdminHelper;

[9] Fix | Delete

[10] Fix | Delete

defined( 'ABSPATH' ) || exit;

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* NoteTraits class.

[14] Fix | Delete

*/

[15] Fix | Delete

trait NoteTraits {

[16] Fix | Delete

/**

[17] Fix | Delete

* Test how long WooCommerce Admin has been active.

[18] Fix | Delete

*

[19] Fix | Delete

* @param int $seconds Time in seconds to check.

[20] Fix | Delete

* @return bool Whether or not WooCommerce admin has been active for $seconds.

[21] Fix | Delete

*/

[22] Fix | Delete

private static function wc_admin_active_for( $seconds ) {

[23] Fix | Delete

return WCAdminHelper::is_wc_admin_active_for( $seconds );

[24] Fix | Delete

}

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Test if WooCommerce Admin has been active within a pre-defined range.

[28] Fix | Delete

*

[29] Fix | Delete

* @param string $range range available in WC_ADMIN_STORE_AGE_RANGES.

[30] Fix | Delete

* @param int $custom_start custom start in range.

[31] Fix | Delete

* @return bool Whether or not WooCommerce admin has been active within the range.

[32] Fix | Delete

*/

[33] Fix | Delete

private static function is_wc_admin_active_in_date_range( $range, $custom_start = null ) {

[34] Fix | Delete

return WCAdminHelper::is_wc_admin_active_in_date_range( $range, $custom_start );

[35] Fix | Delete

}

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Check if the note has been previously added.

[39] Fix | Delete

*

[40] Fix | Delete

* @return bool

[41] Fix | Delete

* @throws NotesUnavailableException Throws exception when notes are unavailable.

[42] Fix | Delete

*/

[43] Fix | Delete

public static function note_exists(): bool {

[44] Fix | Delete

/**

[45] Fix | Delete

* Data store instance.

[46] Fix | Delete

*

[47] Fix | Delete

* @var DataStore $data_store

[48] Fix | Delete

*/

[49] Fix | Delete

$data_store = Notes::load_data_store();

[50] Fix | Delete

$note_ids = $data_store->get_notes_with_name( self::NOTE_NAME );

[51] Fix | Delete

return ! empty( $note_ids );

[52] Fix | Delete

}

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Checks if a note can and should be added.

[56] Fix | Delete

*

[57] Fix | Delete

* @return bool

[58] Fix | Delete

* @throws NotesUnavailableException Throws exception when notes are unavailable.

[59] Fix | Delete

*/

[60] Fix | Delete

public static function can_be_added(): bool {

[61] Fix | Delete

$note = self::get_note();

[62] Fix | Delete

[63] Fix | Delete

if ( ! $note instanceof Note && ! $note instanceof WC_Admin_Note ) {

[64] Fix | Delete

return false;

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

if ( self::note_exists() ) {

[68] Fix | Delete

return false;

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

if (

[72] Fix | Delete

'no' === get_option( 'woocommerce_show_marketplace_suggestions', 'yes' ) &&

[73] Fix | Delete

Note::E_WC_ADMIN_NOTE_MARKETING === $note->get_type()

[74] Fix | Delete

) {

[75] Fix | Delete

return false;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

return true;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Add the note if it passes predefined conditions.

[83] Fix | Delete

*

[84] Fix | Delete

* @return void

[85] Fix | Delete

* @throws NotesUnavailableException Throws exception when notes are unavailable.

[86] Fix | Delete

*/

[87] Fix | Delete

public static function possibly_add_note(): void {

[88] Fix | Delete

$note = self::get_note();

[89] Fix | Delete

[90] Fix | Delete

if ( ! self::can_be_added() ) {

[91] Fix | Delete

return;

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

if ( $note instanceof Note || $note instanceof WC_Admin_Note ) {

[95] Fix | Delete

$note->save();

[96] Fix | Delete

}

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Alias this method for backwards compatibility.

[101] Fix | Delete

*

[102] Fix | Delete

* @return void

[103] Fix | Delete

* @throws NotesUnavailableException Throws exception when notes are unavailable.

[104] Fix | Delete

*/

[105] Fix | Delete

public static function add_note(): void {

[106] Fix | Delete

self::possibly_add_note();

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

/**

[110] Fix | Delete

* Should this note exist? (Default implementation is generous. Override as needed.)

[111] Fix | Delete

*/

[112] Fix | Delete

public static function is_applicable() {

[113] Fix | Delete

return true;

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Delete this note if it is not applicable, unless has been soft-deleted or actioned already.

[118] Fix | Delete

*

[119] Fix | Delete

* @return void

[120] Fix | Delete

*/

[121] Fix | Delete

public static function delete_if_not_applicable(): void {

[122] Fix | Delete

if ( ! self::is_applicable() ) {

[123] Fix | Delete

/**

[124] Fix | Delete

* Data store instance.

[125] Fix | Delete

*

[126] Fix | Delete

* @var DataStore $data_store

[127] Fix | Delete

*/

[128] Fix | Delete

$data_store = Notes::load_data_store();

[129] Fix | Delete

$note_ids = $data_store->get_notes_with_name( self::NOTE_NAME );

[130] Fix | Delete

[131] Fix | Delete

if ( ! empty( $note_ids ) ) {

[132] Fix | Delete

$note = Notes::get_note( $note_ids[0] );

[133] Fix | Delete

[134] Fix | Delete

if ( $note instanceof Note && ! $note->get_is_deleted() && ( Note::E_WC_ADMIN_NOTE_ACTIONED !== $note->get_status() ) ) {

[135] Fix | Delete

self::possibly_delete_note();

[136] Fix | Delete

}

[137] Fix | Delete

}

[138] Fix | Delete

}

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Possibly delete the note, if it exists in the database. Note that this

[143] Fix | Delete

* is a hard delete, for where it doesn't make sense to soft delete or

[144] Fix | Delete

* action the note.

[145] Fix | Delete

*

[146] Fix | Delete

* @return void

[147] Fix | Delete

* @throws NotesUnavailableException Throws exception when notes are unavailable.

[148] Fix | Delete

*/

[149] Fix | Delete

public static function possibly_delete_note(): void {

[150] Fix | Delete

/**

[151] Fix | Delete

* Data store instance.

[152] Fix | Delete

*

[153] Fix | Delete

* @var DataStore $data_store

[154] Fix | Delete

*/

[155] Fix | Delete

$data_store = Notes::load_data_store();

[156] Fix | Delete

$note_ids = $data_store->get_notes_with_name( self::NOTE_NAME );

[157] Fix | Delete

[158] Fix | Delete

foreach ( $note_ids as $note_id ) {

[159] Fix | Delete

$note = Notes::get_note( $note_id );

[160] Fix | Delete

[161] Fix | Delete

if ( $note instanceof Note ) {

[162] Fix | Delete

$data_store->delete( $note );

[163] Fix | Delete

}

[164] Fix | Delete

}

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete

[168] Fix | Delete

/**

[169] Fix | Delete

* Update the note if it passes predefined conditions.

[170] Fix | Delete

*

[171] Fix | Delete

* @return void

[172] Fix | Delete

* @throws NotesUnavailableException Throws exception when notes are unavailable.

[173] Fix | Delete

*/

[174] Fix | Delete

public static function possibly_update_note(): void {

[175] Fix | Delete

$note_in_db = Notes::get_note_by_name( self::NOTE_NAME );

[176] Fix | Delete

if ( ! $note_in_db instanceof Note ) {

[177] Fix | Delete

return;

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

// Backwards compatibility for checking if the note class has a get_note method.

[181] Fix | Delete

/**

[182] Fix | Delete

* Backwards compatibility check.

[183] Fix | Delete

*

[184] Fix | Delete

* @phpstan-ignore-next-line

[185] Fix | Delete

*/

[186] Fix | Delete

if ( ! method_exists( self::class, 'get_note' ) ) {

[187] Fix | Delete

return;

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

$note = self::get_note();

[191] Fix | Delete

if ( ! $note instanceof Note && ! $note instanceof WC_Admin_Note ) {

[192] Fix | Delete

return;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

$need_save = in_array(

[196] Fix | Delete

true,

[197] Fix | Delete

array(

[198] Fix | Delete

self::update_note_field_if_changed( $note_in_db, $note, 'title' ),

[199] Fix | Delete

self::update_note_field_if_changed( $note_in_db, $note, 'content' ),

[200] Fix | Delete

self::update_note_field_if_changed( $note_in_db, $note, 'content_data' ),

[201] Fix | Delete

self::update_note_field_if_changed( $note_in_db, $note, 'type' ),

[202] Fix | Delete

self::update_note_field_if_changed( $note_in_db, $note, 'locale' ),

[203] Fix | Delete

self::update_note_field_if_changed( $note_in_db, $note, 'source' ),

[204] Fix | Delete

self::update_note_field_if_changed( $note_in_db, $note, 'actions' ),

[205] Fix | Delete

),

[206] Fix | Delete

true

[207] Fix | Delete

);

[208] Fix | Delete

[209] Fix | Delete

if ( $need_save ) {

[210] Fix | Delete

$note_in_db->save();

[211] Fix | Delete

}

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete

[215] Fix | Delete

/**

[216] Fix | Delete

* Get if the note has been actioned.

[217] Fix | Delete

*

[218] Fix | Delete

* @return bool

[219] Fix | Delete

* @throws NotesUnavailableException Throws exception when notes are unavailable.

[220] Fix | Delete

*/

[221] Fix | Delete

public static function has_note_been_actioned(): bool {

[222] Fix | Delete

/**

[223] Fix | Delete

* Data store instance.

[224] Fix | Delete

*

[225] Fix | Delete

* @var DataStore $data_store

[226] Fix | Delete

*/

[227] Fix | Delete

$data_store = Notes::load_data_store();

[228] Fix | Delete

$note_ids = $data_store->get_notes_with_name( self::NOTE_NAME );

[229] Fix | Delete

[230] Fix | Delete

if ( ! empty( $note_ids ) ) {

[231] Fix | Delete

$note = Notes::get_note( $note_ids[0] );

[232] Fix | Delete

[233] Fix | Delete

if ( $note instanceof Note && Note::E_WC_ADMIN_NOTE_ACTIONED === $note->get_status() ) {

[234] Fix | Delete

return true;

[235] Fix | Delete

}

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

return false;

[239] Fix | Delete

}

[240] Fix | Delete

[241] Fix | Delete

/**

[242] Fix | Delete

* Update a note field of note1 if it's different from note2 with getter and setter.

[243] Fix | Delete

*

[244] Fix | Delete

* @param Note|WC_Admin_Note $note1 Note to update.

[245] Fix | Delete

* @param Note|WC_Admin_Note $note2 Note to compare against.

[246] Fix | Delete

* @param string $field_name Field to update.

[247] Fix | Delete

* @return bool True if the field was updated.

[248] Fix | Delete

*/

[249] Fix | Delete

private static function update_note_field_if_changed( $note1, $note2, string $field_name ): bool {

[250] Fix | Delete

// We need to serialize the stdObject to compare it.

[251] Fix | Delete

/**

[252] Fix | Delete

* Getter method for note1.

[253] Fix | Delete

*

[254] Fix | Delete

* @var callable $getter1

[255] Fix | Delete

*/

[256] Fix | Delete

$getter1 = array( $note1, 'get_' . $field_name );

[257] Fix | Delete

/**

[258] Fix | Delete

* Getter method for note2.

[259] Fix | Delete

*

[260] Fix | Delete

* @var callable $getter2

[261] Fix | Delete

*/

[262] Fix | Delete

$getter2 = array( $note2, 'get_' . $field_name );

[263] Fix | Delete

$note1_field_value = self::possibly_convert_object_to_array(

[264] Fix | Delete

call_user_func( $getter1 )

[265] Fix | Delete

);

[266] Fix | Delete

$note2_field_value = self::possibly_convert_object_to_array(

[267] Fix | Delete

call_user_func( $getter2 )

[268] Fix | Delete

);

[269] Fix | Delete

[270] Fix | Delete

if ( 'actions' === $field_name ) {

[271] Fix | Delete

// We need to individually compare the action fields because action object from db is different from action object of note.

[272] Fix | Delete

// For example, action object from db has "id".

[273] Fix | Delete

$diff = array_udiff(

[274] Fix | Delete

(array) $note1_field_value,

[275] Fix | Delete

(array) $note2_field_value,

[276] Fix | Delete

function ( $action1, $action2 ): int {

[277] Fix | Delete

/**

[278] Fix | Delete

* First action object.

[279] Fix | Delete

*

[280] Fix | Delete

* @var object{name?: string, label?: string, query?: string} $action1

[281] Fix | Delete

*/

[282] Fix | Delete

/**

[283] Fix | Delete

* Second action object.

[284] Fix | Delete

*

[285] Fix | Delete

* @var object{name?: string, label?: string, query?: string} $action2

[286] Fix | Delete

*/

[287] Fix | Delete

if (

[288] Fix | Delete

isset(

[289] Fix | Delete

$action1->name,

[290] Fix | Delete

$action2->name,

[291] Fix | Delete

$action1->label,

[292] Fix | Delete

$action2->label,

[293] Fix | Delete

$action1->query,

[294] Fix | Delete

$action2->query

[295] Fix | Delete

) &&

[296] Fix | Delete

$action1->name === $action2->name &&

[297] Fix | Delete

$action1->label === $action2->label &&

[298] Fix | Delete

$action1->query === $action2->query

[299] Fix | Delete

) {

[300] Fix | Delete

return 0;

[301] Fix | Delete

}

[302] Fix | Delete

return -1;

[303] Fix | Delete

}

[304] Fix | Delete

);

[305] Fix | Delete

$need_update = count( $diff ) > 0;

[306] Fix | Delete

} else {

[307] Fix | Delete

$need_update = $note1_field_value !== $note2_field_value;

[308] Fix | Delete

}

[309] Fix | Delete

[310] Fix | Delete

if ( $need_update ) {

[311] Fix | Delete

/**

[312] Fix | Delete

* Getter method for note2 field.

[313] Fix | Delete

*

[314] Fix | Delete

* @var callable $getter2_again

[315] Fix | Delete

*/

[316] Fix | Delete

$getter2_again = array( $note2, 'get_' . $field_name );

[317] Fix | Delete

/**

[318] Fix | Delete

* Setter method for note1 field.

[319] Fix | Delete

*

[320] Fix | Delete

* @var callable $setter1

[321] Fix | Delete

*/

[322] Fix | Delete

$setter1 = array( $note1, 'set_' . $field_name );

[323] Fix | Delete

// Get note2 field again because it may have been changed during the comparison.

[324] Fix | Delete

call_user_func( $setter1, call_user_func( $getter2_again ) );

[325] Fix | Delete

return true;

[326] Fix | Delete

}

[327] Fix | Delete

return false;

[328] Fix | Delete

}

[329] Fix | Delete

[330] Fix | Delete

/**

[331] Fix | Delete

* Convert a value to array if it's a stdClass.

[332] Fix | Delete

*

[333] Fix | Delete

* @param mixed $obj variable to convert.

[334] Fix | Delete

* @return mixed

[335] Fix | Delete

*/

[336] Fix | Delete

private static function possibly_convert_object_to_array( $obj ) {

[337] Fix | Delete

if ( $obj instanceof \stdClass ) {

[338] Fix | Delete

return (array) $obj;

[339] Fix | Delete

}

[340] Fix | Delete

return $obj;

[341] Fix | Delete

}

[342] Fix | Delete

}

[343] Fix | Delete

[344] Fix | Delete