<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* @package Freemius

[2] Fix | Delete

* @copyright Copyright (c) 2015, Freemius, Inc.

[3] Fix | Delete

* @license https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3

[4] Fix | Delete

* @since 2.6.0

[5] Fix | Delete

*/

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

exit;

[9] Fix | Delete

}

[10] Fix | Delete

[11] Fix | Delete

interface FS_I_Garbage_Collector {

[12] Fix | Delete

function clean();

[13] Fix | Delete

}

[14] Fix | Delete

[15] Fix | Delete

class FS_Product_Garbage_Collector implements FS_I_Garbage_Collector {

[16] Fix | Delete

/**

[17] Fix | Delete

* @var FS_Options

[18] Fix | Delete

*/

[19] Fix | Delete

private $_accounts;

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* @var string[]

[23] Fix | Delete

*/

[24] Fix | Delete

private $_options_names;

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* @var string

[28] Fix | Delete

*/

[29] Fix | Delete

private $_type;

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* @var string

[33] Fix | Delete

*/

[34] Fix | Delete

private $_plural_type;

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* @var array<string, int> Map of product slugs to their last load timestamp, only for products that are not active.

[38] Fix | Delete

*/

[39] Fix | Delete

private $_gc_timestamp;

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* @var array<string, array<string, mixed>> Map of product slugs to their data, as stored by the primary storage of `Freemius` class.

[43] Fix | Delete

*/

[44] Fix | Delete

private $_storage_data;

[45] Fix | Delete

[46] Fix | Delete

function __construct( FS_Options $_accounts, $option_names, $type ) {

[47] Fix | Delete

$this->_accounts = $_accounts;

[48] Fix | Delete

$this->_options_names = $option_names;

[49] Fix | Delete

$this->_type = $type;

[50] Fix | Delete

$this->_plural_type = ( $type . 's' );

[51] Fix | Delete

}

[52] Fix | Delete

[53] Fix | Delete

function clean() {

[54] Fix | Delete

$this->_gc_timestamp = $this->_accounts->get_option( 'gc_timestamp', array() );

[55] Fix | Delete

$this->_storage_data = $this->_accounts->get_option( $this->_type . '_data', array() );

[56] Fix | Delete

[57] Fix | Delete

$options = $this->load_options();

[58] Fix | Delete

$has_updated_option = false;

[59] Fix | Delete

[60] Fix | Delete

$products_to_clean = $this->get_products_to_clean();

[61] Fix | Delete

[62] Fix | Delete

foreach( $products_to_clean as $product ) {

[63] Fix | Delete

$slug = $product->slug;

[64] Fix | Delete

[65] Fix | Delete

// Clear the product's data.

[66] Fix | Delete

foreach( $options as $option_name => $option ) {

[67] Fix | Delete

$updated = false;

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* We expect to deal with only array like options here.

[71] Fix | Delete

* @todo - Refactor this to create dedicated GC classes for every option, then we can make the code mode predictable.

[72] Fix | Delete

* For example, depending on data integrity of `plugins` we can still miss something entirely in the `plugin_data` or vice-versa.

[73] Fix | Delete

* A better algorithm is to iterate over all options individually in separate classes and check against primary storage to see if those can be garbage collected.

[74] Fix | Delete

* But given the chance of data integrity issue is very low, we let this run for now and gather feedback.

[75] Fix | Delete

*/

[76] Fix | Delete

if ( ! is_array( $option ) ) {

[77] Fix | Delete

continue;

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

if ( array_key_exists( $slug, $option ) ) {

[81] Fix | Delete

unset( $option[ $slug ] );

[82] Fix | Delete

$updated = true;

[83] Fix | Delete

} else if ( array_key_exists( "{$slug}:{$this->_type}", $option ) ) { /* admin_notices */

[84] Fix | Delete

unset( $option[ "{$slug}:{$this->_type}" ] );

[85] Fix | Delete

$updated = true;

[86] Fix | Delete

} else if ( isset( $product->id ) && array_key_exists( $product->id, $option ) ) { /* all_licenses */

[87] Fix | Delete

unset( $option[ $product->id ] );

[88] Fix | Delete

$updated = true;

[89] Fix | Delete

} else if ( isset( $product->file ) && array_key_exists( $product->file, $option ) ) { /* file_slug_map */

[90] Fix | Delete

unset( $option[ $product->file ] );

[91] Fix | Delete

$updated = true;

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

if ( $updated ) {

[95] Fix | Delete

$this->_accounts->set_option( $option_name, $option );

[96] Fix | Delete

[97] Fix | Delete

$options[ $option_name ] = $option;

[98] Fix | Delete

[99] Fix | Delete

$has_updated_option = true;

[100] Fix | Delete

}

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

// Clear the product's data from the primary storage.

[104] Fix | Delete

if ( isset( $this->_storage_data[ $slug ] ) ) {

[105] Fix | Delete

unset( $this->_storage_data[ $slug ] );

[106] Fix | Delete

$has_updated_option = true;

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

// Clear from GC timestamp.

[110] Fix | Delete

// @todo - This perhaps needs a separate garbage collector for all expired products. But the chance of left-over is very slim.

[111] Fix | Delete

if ( isset( $this->_gc_timestamp[ $slug ] ) ) {

[112] Fix | Delete

unset( $this->_gc_timestamp[ $slug ] );

[113] Fix | Delete

$has_updated_option = true;

[114] Fix | Delete

}

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

$this->_accounts->set_option( 'gc_timestamp', $this->_gc_timestamp );

[118] Fix | Delete

$this->_accounts->set_option( $this->_type . '_data', $this->_storage_data );

[119] Fix | Delete

[120] Fix | Delete

return $has_updated_option;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

private function get_all_option_names() {

[124] Fix | Delete

return array_merge(

[125] Fix | Delete

array(

[126] Fix | Delete

'admin_notices',

[127] Fix | Delete

'updates',

[128] Fix | Delete

'all_licenses',

[129] Fix | Delete

'addons',

[130] Fix | Delete

'id_slug_type_path_map',

[131] Fix | Delete

'file_slug_map',

[132] Fix | Delete

),

[133] Fix | Delete

$this->_options_names

[134] Fix | Delete

);

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

private function get_products() {

[138] Fix | Delete

$products = $this->_accounts->get_option( $this->_plural_type, array() );

[139] Fix | Delete

[140] Fix | Delete

// Fill any missing product found in the primary storage.

[141] Fix | Delete

// @todo - This wouldn't be needed if we use dedicated GC design for every options. The options themselves would provide such information.

[142] Fix | Delete

foreach( $this->_storage_data as $slug => $product_data ) {

[143] Fix | Delete

if ( ! isset( $products[ $slug ] ) ) {

[144] Fix | Delete

$products[ $slug ] = (object) $product_data;

[145] Fix | Delete

}

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

$this->update_gc_timestamp( $products );

[149] Fix | Delete

[150] Fix | Delete

return $products;

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

private function get_products_to_clean() {

[154] Fix | Delete

$products_to_clean = array();

[155] Fix | Delete

[156] Fix | Delete

$products = $this->get_products();

[157] Fix | Delete

[158] Fix | Delete

foreach ( $products as $slug => $product_data ) {

[159] Fix | Delete

if ( ! is_object( $product_data ) ) {

[160] Fix | Delete

continue;

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

if ( $this->is_product_active( $slug ) ) {

[164] Fix | Delete

continue;

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete

$is_addon = ( ! empty( $product_data->parent_plugin_id ) );

[168] Fix | Delete

[169] Fix | Delete

if ( ! $is_addon ) {

[170] Fix | Delete

$products_to_clean[] = $product_data;

[171] Fix | Delete

} else {

[172] Fix | Delete

/**

[173] Fix | Delete

* If add-on, add to the beginning of the array so that add-ons are removed before their parent. This is to prevent an unexpected issue when an add-on exists but its parent was already removed.

[174] Fix | Delete

*/

[175] Fix | Delete

array_unshift( $products_to_clean, $product_data );

[176] Fix | Delete

}

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

return $products_to_clean;

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

/**

[183] Fix | Delete

* @param string $slug

[184] Fix | Delete

*

[185] Fix | Delete

* @return bool

[186] Fix | Delete

*/

[187] Fix | Delete

private function is_product_active( $slug ) {

[188] Fix | Delete

$instances = Freemius::_get_all_instances();

[189] Fix | Delete

[190] Fix | Delete

foreach ( $instances as $instance ) {

[191] Fix | Delete

if ( $instance->get_slug() === $slug ) {

[192] Fix | Delete

return true;

[193] Fix | Delete

}

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

$expiration_time = fs_get_optional_constant( 'WP_FS__GARBAGE_COLLECTOR_EXPIRATION_TIME_SECS', ( WP_FS__TIME_WEEK_IN_SEC * 4 ) );

[197] Fix | Delete

[198] Fix | Delete

if ( $this->get_last_load_timestamp( $slug ) > ( time() - $expiration_time ) ) {

[199] Fix | Delete

// Last activation was within the last 4 weeks.

[200] Fix | Delete

return true;

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

return false;

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

private function load_options() {

[207] Fix | Delete

$options = array();

[208] Fix | Delete

$option_names = $this->get_all_option_names();

[209] Fix | Delete

[210] Fix | Delete

foreach ( $option_names as $option_name ) {

[211] Fix | Delete

$options[ $option_name ] = $this->_accounts->get_option( $option_name, array() );

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete

return $options;

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

/**

[218] Fix | Delete

* Updates the garbage collector timestamp, only if it was not already set by the product's primary storage.

[219] Fix | Delete

*

[220] Fix | Delete

* @param array $products

[221] Fix | Delete

*

[222] Fix | Delete

* @return void

[223] Fix | Delete

*/

[224] Fix | Delete

private function update_gc_timestamp( $products ) {

[225] Fix | Delete

foreach ($products as $slug => $product_data) {

[226] Fix | Delete

if ( ! is_object( $product_data ) && ! is_array( $product_data ) ) {

[227] Fix | Delete

continue;

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

[231] Fix | Delete

// If the product is active, we don't need to update the gc_timestamp.

[232] Fix | Delete

if ( isset( $this->_storage_data[ $slug ]['last_load_timestamp'] ) ) {

[233] Fix | Delete

continue;

[234] Fix | Delete

}

[235] Fix | Delete

[236] Fix | Delete

// First try to check if the product is present in the primary storage. If so update that.

[237] Fix | Delete

if ( isset( $this->_storage_data[ $slug ] ) ) {

[238] Fix | Delete

$this->_storage_data[ $slug ]['last_load_timestamp'] = time();

[239] Fix | Delete

} else if ( ! isset( $this->_gc_timestamp[ $slug ] ) ) {

[240] Fix | Delete

// If not, fallback to the gc_timestamp, but we don't want to update it more than once.

[241] Fix | Delete

$this->_gc_timestamp[ $slug ] = time();

[242] Fix | Delete

}

[243] Fix | Delete

}

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

private function get_last_load_timestamp( $slug ) {

[247] Fix | Delete

if ( isset( $this->_storage_data[ $slug ]['last_load_timestamp'] ) ) {

[248] Fix | Delete

return $this->_storage_data[ $slug ]['last_load_timestamp'];

[249] Fix | Delete

}

[250] Fix | Delete

[251] Fix | Delete

return isset( $this->_gc_timestamp[ $slug ] ) ?

[252] Fix | Delete

$this->_gc_timestamp[ $slug ] :

[253] Fix | Delete

// This should never happen, but if it does, let's assume the product is not expired.

[254] Fix | Delete

time();

[255] Fix | Delete

}

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

class FS_User_Garbage_Collector implements FS_I_Garbage_Collector {

[259] Fix | Delete

private $_accounts;

[260] Fix | Delete

[261] Fix | Delete

private $_types;

[262] Fix | Delete

[263] Fix | Delete

function __construct( FS_Options $_accounts, array $types ) {

[264] Fix | Delete

$this->_accounts = $_accounts;

[265] Fix | Delete

$this->_types = $types;

[266] Fix | Delete

}

[267] Fix | Delete

[268] Fix | Delete

function clean() {

[269] Fix | Delete

$users = Freemius::get_all_users();

[270] Fix | Delete

[271] Fix | Delete

$user_has_install_map = $this->get_user_has_install_map();

[272] Fix | Delete

[273] Fix | Delete

if ( count( $users ) === count( $user_has_install_map ) ) {

[274] Fix | Delete

return false;

[275] Fix | Delete

}

[276] Fix | Delete

[277] Fix | Delete

$products_user_id_license_ids_map = $this->_accounts->get_option( 'user_id_license_ids_map', array() );

[278] Fix | Delete

[279] Fix | Delete

$has_updated_option = false;

[280] Fix | Delete

[281] Fix | Delete

foreach ( $users as $user_id => $user ) {

[282] Fix | Delete

if ( ! isset( $user_has_install_map[ $user_id ] ) ) {

[283] Fix | Delete

unset( $users[ $user_id ] );

[284] Fix | Delete

[285] Fix | Delete

foreach( $products_user_id_license_ids_map as $product_id => $user_id_license_ids_map ) {

[286] Fix | Delete

unset( $user_id_license_ids_map[ $user_id ] );

[287] Fix | Delete

[288] Fix | Delete

if ( empty( $user_id_license_ids_map ) ) {

[289] Fix | Delete

unset( $products_user_id_license_ids_map[ $product_id ] );

[290] Fix | Delete

} else {

[291] Fix | Delete

$products_user_id_license_ids_map[ $product_id ] = $user_id_license_ids_map;

[292] Fix | Delete

}

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete

$this->_accounts->set_option( 'users', $users );

[296] Fix | Delete

$this->_accounts->set_option( 'user_id_license_ids_map', $products_user_id_license_ids_map );

[297] Fix | Delete

[298] Fix | Delete

$has_updated_option = true;

[299] Fix | Delete

}

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

return $has_updated_option;

[303] Fix | Delete

}

[304] Fix | Delete

[305] Fix | Delete

private function get_user_has_install_map() {

[306] Fix | Delete

$user_has_install_map = array();

[307] Fix | Delete

[308] Fix | Delete

foreach ( $this->_types as $product_type ) {

[309] Fix | Delete

$option_name = ( WP_FS__MODULE_TYPE_PLUGIN !== $product_type ) ?

[310] Fix | Delete

"{$product_type}_sites" :

[311] Fix | Delete

'sites';

[312] Fix | Delete

[313] Fix | Delete

$installs = $this->_accounts->get_option( $option_name, array() );

[314] Fix | Delete

[315] Fix | Delete

foreach ( $installs as $install ) {

[316] Fix | Delete

$user_has_install_map[ $install->user_id ] = true;

[317] Fix | Delete

}

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

return $user_has_install_map;

[321] Fix | Delete

}

[322] Fix | Delete

}

[323] Fix | Delete

[324] Fix | Delete

// Main entry-level class.

[325] Fix | Delete

class FS_Garbage_Collector implements FS_I_Garbage_Collector {

[326] Fix | Delete

/**

[327] Fix | Delete

* @var FS_Garbage_Collector

[328] Fix | Delete

* @since 2.6.0

[329] Fix | Delete

*/

[330] Fix | Delete

private static $_instance;

[331] Fix | Delete

[332] Fix | Delete

/**

[333] Fix | Delete

* @return FS_Garbage_Collector

[334] Fix | Delete

*/

[335] Fix | Delete

static function instance() {

[336] Fix | Delete

if ( ! isset( self::$_instance ) ) {

[337] Fix | Delete

self::$_instance = new self();

[338] Fix | Delete

}

[339] Fix | Delete

[340] Fix | Delete

return self::$_instance;

[341] Fix | Delete

}

[342] Fix | Delete

[343] Fix | Delete

#endregion

[344] Fix | Delete

[345] Fix | Delete

private function __construct() {

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

function clean() {

[349] Fix | Delete

$_accounts = FS_Options::instance( WP_FS__ACCOUNTS_OPTION_NAME, true );

[350] Fix | Delete

[351] Fix | Delete

$products_cleaners = $this->get_product_cleaners( $_accounts );

[352] Fix | Delete

[353] Fix | Delete

$has_cleaned = false;

[354] Fix | Delete

[355] Fix | Delete

foreach ( $products_cleaners as $products_cleaner ) {

[356] Fix | Delete

if ( $products_cleaner->clean() ) {

[357] Fix | Delete

$has_cleaned = true;

[358] Fix | Delete

}

[359] Fix | Delete

}

[360] Fix | Delete

[361] Fix | Delete

if ( $has_cleaned ) {

[362] Fix | Delete

$user_cleaner = new FS_User_Garbage_Collector(

[363] Fix | Delete

$_accounts,

[364] Fix | Delete

array_keys( $products_cleaners )

[365] Fix | Delete

);

[366] Fix | Delete

[367] Fix | Delete

$user_cleaner->clean();

[368] Fix | Delete

}

[369] Fix | Delete

[370] Fix | Delete

// @todo - We need a garbage collector for `all_plugins` and `active_plugins` (and variants of themes).

[371] Fix | Delete

[372] Fix | Delete

// Always store regardless of whether there were cleaned products or not since during the process, the logic may set the last load timestamp of some products.

[373] Fix | Delete

$_accounts->store();

[374] Fix | Delete

}

[375] Fix | Delete

[376] Fix | Delete

/**

[377] Fix | Delete

* @param FS_Options $_accounts

[378] Fix | Delete

*

[379] Fix | Delete

* @return FS_I_Garbage_Collector[]

[380] Fix | Delete

*/

[381] Fix | Delete

private function get_product_cleaners( FS_Options $_accounts ) {

[382] Fix | Delete

/**

[383] Fix | Delete

* @var FS_I_Garbage_Collector[] $products_cleaners

[384] Fix | Delete

*/

[385] Fix | Delete

$products_cleaners = array();

[386] Fix | Delete

[387] Fix | Delete

$products_cleaners[ WP_FS__MODULE_TYPE_PLUGIN ] = new FS_Product_Garbage_Collector(

[388] Fix | Delete

$_accounts,

[389] Fix | Delete

array(

[390] Fix | Delete

'sites',

[391] Fix | Delete

'plans',

[392] Fix | Delete

'plugins',

[393] Fix | Delete

),

[394] Fix | Delete

WP_FS__MODULE_TYPE_PLUGIN

[395] Fix | Delete

);

[396] Fix | Delete

[397] Fix | Delete

$products_cleaners[ WP_FS__MODULE_TYPE_THEME ] = new FS_Product_Garbage_Collector(

[398] Fix | Delete

$_accounts,

[399] Fix | Delete

array(

[400] Fix | Delete

'theme_sites',

[401] Fix | Delete

'theme_plans',

[402] Fix | Delete

'themes',

[403] Fix | Delete

),

[404] Fix | Delete

WP_FS__MODULE_TYPE_THEME

[405] Fix | Delete

);

[406] Fix | Delete

[407] Fix | Delete

return $products_cleaners;

[408] Fix | Delete

}

[409] Fix | Delete

}

[410] Fix | Delete