{
+ * @key number Add-on ID.
+ * @val object[] The add-on's plans and prices object.
+ * }
+ */
+ function _get_addons_plans_and_pricing_map_by_id() {
+ if ( ! isset( $this->plans_and_pricing_by_addon_id ) ) {
+ $result = $this->get_api_plugin_scope()->get( $this->add_show_pending( "/addons/pricing.json?type=visible" ) );
+
+ $plans_and_pricing_by_addon_id = array();
+ if ( $this->is_api_result_object( $result, 'addons' ) ) {
+ foreach ( $result->addons as $addon ) {
+ $plans_and_pricing_by_addon_id[ $addon->id ] = $addon->plans;
+ }
+ }
+
+ $this->plans_and_pricing_by_addon_id = $plans_and_pricing_by_addon_id;
+ }
+
+ return $this->plans_and_pricing_by_addon_id;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.0
+ *
+ * @param number $addon_id
+ * @param bool $is_installed
+ *
+ * @return array
+ */
+ function _get_addon_info( $addon_id, $is_installed ) {
+ $addon = $this->get_addon( $addon_id );
+
+ if ( ! is_object( $addon ) ) {
+ // Unexpected call.
+ return array();
+ }
+
+ $slug = $addon->slug;
+
+ $addon_storage = FS_Storage::instance( WP_FS__MODULE_TYPE_PLUGIN, $slug );
+
+ if ( ! fs_is_network_admin() ) {
+ // Get blog-level activated installations.
+ $sites = self::maybe_get_entities_account_option( 'sites', array() );
+ } else {
+ $sites = null;
+
+ if ( $this->is_addon_activated( $addon_id ) &&
+ $this->get_addon_instance( $addon_id )->is_network_active()
+ ) {
+ if ( FS_Site::is_valid_id( $addon_storage->network_install_blog_id ) ) {
+ // Get network-level activated installations.
+ $sites = self::maybe_get_entities_account_option(
+ 'sites',
+ array(),
+ $addon_storage->network_install_blog_id
+ );
+ }
+ }
+ }
+
+ $addon_info = array(
+ 'is_connected' => false,
+ 'slug' => $slug,
+ 'title' => $addon->title,
+ 'is_whitelabeled' => $addon_storage->is_whitelabeled
+ );
+
+ if ( ! $is_installed ) {
+ $plans_and_pricing_by_addon_id = $this->_get_addons_plans_and_pricing_map_by_id();
+
+ if ( isset( $plans_and_pricing_by_addon_id[ $addon_id ] ) ) {
+ $has_paid_plan = false;
+ $plans = $plans_and_pricing_by_addon_id[ $addon_id ];
+
+ if ( is_array( $plans ) && count( $plans ) > 0 ) {
+ foreach ( $plans as $plan ) {
+ if ( isset( $plan->pricing ) &&
+ is_array( $plan->pricing ) &&
+ count( $plan->pricing ) > 0
+ ) {
+ $has_paid_plan = true;
+ break;
+ }
+ }
+ }
+
+ $addon_info['has_paid_plan'] = $has_paid_plan;
+ }
+ }
+
+ if ( ! is_array( $sites ) || ! isset( $sites[ $slug ] ) ) {
+ return $addon_info;
+ }
+
+ $site = $sites[ $slug ];
+
+ $addon_info['is_connected'] = (
+ ( $addon->parent_plugin_id == $this->get_id() ) &&
+ is_object( $site ) &&
+ FS_Site::is_valid_id( $site->id ) &&
+ FS_User::is_valid_id( $site->user_id ) &&
+ FS_Plugin_Plan::is_valid_id( $site->plan_id )
+ );
+
+ if ( $addon_info['is_connected'] && $is_installed ) {
+ return $addon_info;
+ }
+
+ $addon_info['site'] = $site;
+
+ $plugins_data = self::maybe_get_entities_account_option( WP_FS__MODULE_TYPE_PLUGIN . 's', array() );
+ if ( isset( $plugins_data[ $slug ] ) ) {
+ $plugin_data = $plugins_data[ $slug ];
+
+ $addon_info['version'] = $plugin_data->version;
+ }
+
+ $all_plans = self::maybe_get_entities_account_option( 'plans', array() );
+ if ( isset( $all_plans[ $slug ] ) ) {
+ $plans = $all_plans[ $slug ];
+
+ foreach ( $plans as $plan ) {
+ if ( $site->plan_id == Freemius::_decrypt( $plan->id ) ) {
+ $addon_info['plan_name'] = Freemius::_decrypt( $plan->name );
+ $addon_info['plan_title'] = Freemius::_decrypt( $plan->title );
+ break;
+ }
+ }
+ }
+
+ $licenses = self::maybe_get_entities_account_option( 'all_licenses', array() );
+ if ( is_array( $licenses ) && isset( $licenses[ $addon_id ] ) ) {
+ foreach ( $licenses[ $addon_id ] as $license ) {
+ if ( $license->id == $site->license_id ) {
+ $addon_info['license'] = $license;
+ break;
+ }
+ }
+ }
+
+ if ( isset( $addon_info['license'] ) ) {
+ if ( isset( $addon_storage->subscriptions ) &&
+ ! empty( $addon_storage->subscriptions )
+ ) {
+ $addon_subscriptions = fs_get_entities( $addon_storage->subscriptions, FS_Subscription::get_class_name() );
+
+ foreach ( $addon_subscriptions as $subscription ) {
+ if ( $subscription->license_id == $site->license_id ) {
+ $addon_info['subscription'] = $subscription;
+ break;
+ }
+ }
+ }
+ }
+
+ return $addon_info;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param number $user_id
+ *
+ * @return FS_User
+ */
+ static function _get_user_by_id( $user_id ) {
+ self::$_static_logger->entrance( "user_id = {$user_id}" );
+
+ $users = self::get_all_users();
+
+ if ( is_array( $users ) ) {
+ if ( isset( $users[ $user_id ] ) &&
+ $users[ $user_id ] instanceof FS_User &&
+ $user_id == $users[ $user_id ]->id
+ ) {
+ return $users[ $user_id ];
+ }
+
+ // If user wasn't found by the key, iterate over all the users collection.
+ foreach ( $users as $user ) {
+ /**
+ * @var FS_User $user
+ */
+ if ( $user_id == $user->id ) {
+ return $user;
+ }
+ }
+ }
+
+ return null;
+ }
+
+ /**
+ * Checks if a Freemius user_id is associated with a super-admin.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param number $user_id
+ *
+ * @return bool
+ */
+ private static function is_super_admin( $user_id ) {
+ $is_super_admin = false;
+
+ $user = self::_get_user_by_id( $user_id );
+
+ if ( $user instanceof FS_User && ! empty( $user->email ) ) {
+ self::require_pluggable_essentials();
+
+ $wp_user = get_user_by( 'email', $user->email );
+
+ if ( $wp_user instanceof WP_User ) {
+ $super_admins = get_super_admins();
+ $is_super_admin = ( is_array( $super_admins ) && in_array( $wp_user->user_login, $super_admins ) );
+ }
+ }
+
+ return $is_super_admin;
+ }
+
+ #----------------------------------------------------------------------------------
+ #region Plans & Licensing
+ #----------------------------------------------------------------------------------
+
+ /**
+ * Check if running premium plugin code.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @return bool
+ */
+ function is_premium() {
+ /**
+ * `$this->_plugin` will be `false` when `is_activation_mode` calls this method directly from the
+ * `register_constructor_hooks` method.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.3
+ */
+ return is_object( $this->_plugin ) ?
+ $this->_plugin->is_premium :
+ false;
+ }
+
+ /**
+ * Get site's plan ID.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.2
+ *
+ * @return number
+ */
+ function get_plan_id() {
+ return $this->_site->plan_id;
+ }
+
+ /**
+ * Get site's plan title.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.2
+ *
+ * @return string
+ */
+ function get_plan_title() {
+ $plan = $this->get_plan();
+
+ return is_object( $plan ) ? $plan->title : 'PLAN_TITLE';
+ }
+
+ /**
+ * Get site's plan name.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return string
+ */
+ function get_plan_name() {
+ $plan = $this->get_plan();
+
+ return is_object( $plan ) ? $plan->name : 'PLAN_NAME';
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @return FS_Plugin_Plan|false
+ */
+ function get_plan() {
+ if ( ! is_object( $this->_site ) ) {
+ return false;
+ }
+
+ return FS_Plugin_Plan::is_valid_id( $this->_site->plan_id ) ?
+ $this->_get_plan_by_id( $this->_site->plan_id ) :
+ false;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.3
+ *
+ * @return bool
+ */
+ function is_trial() {
+ $this->_logger->entrance();
+
+ if ( ! $this->is_registered( true ) || ! is_object( $this->_site ) ) {
+ return false;
+ }
+
+ return $this->_site->is_trial();
+ }
+
+ /**
+ * Check if currently in a trial with payment method (credit card or paypal).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.7
+ *
+ * @return bool
+ */
+ function is_paid_trial() {
+ $this->_logger->entrance();
+
+ if ( ! $this->is_trial() ) {
+ return false;
+ }
+
+ if ( ! $this->has_active_valid_license() ) {
+ return false;
+ }
+
+ if ( $this->_site->trial_plan_id != $this->_license->plan_id ) {
+ return false;
+ }
+
+ /**
+ * @var FS_Subscription $subscription
+ */
+ $subscription = $this->_get_subscription( $this->_license->id );
+
+ return ( is_object( $subscription ) && $subscription->is_active() );
+ }
+
+ /**
+ * Check if trial already utilized.
+ *
+ * @since 1.0.9
+ *
+ * @return bool
+ */
+ function is_trial_utilized() {
+ $this->_logger->entrance();
+
+ if ( ! $this->is_registered() ) {
+ return false;
+ }
+
+ return $this->_site->is_trial_utilized();
+ }
+
+ /**
+ * Get trial plan information (if in trial).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @return bool|FS_Plugin_Plan
+ */
+ function get_trial_plan() {
+ $this->_logger->entrance();
+
+ if ( ! $this->is_trial() ) {
+ return false;
+ }
+
+ // Try to load plan from local cache.
+ $trial_plan = $this->_get_plan_by_id( $this->_site->trial_plan_id );
+
+ if ( ! is_object( $trial_plan ) ) {
+ $trial_plan = $this->_fetch_site_plan( $this->_site->trial_plan_id );
+
+ /**
+ * If managed to fetch the plan, add it to the plans collection.
+ */
+ if ( $trial_plan instanceof FS_Plugin_Plan ) {
+ if ( ! is_array( $this->_plans ) ) {
+ $this->_plans = array();
+ }
+
+ $this->_plans[] = $trial_plan;
+ $this->_store_plans();
+ }
+ }
+
+ if ( $trial_plan instanceof FS_Plugin_Plan ) {
+ return $trial_plan;
+ }
+
+ /**
+ * If for some reason failed to get the trial plan, fallback to a dummy name and title.
+ */
+ $trial_plan = new FS_Plugin_Plan();
+ $trial_plan->id = $this->_site->trial_plan_id;
+ $trial_plan->name = 'pro';
+ $trial_plan->title = 'Pro';
+
+ return $trial_plan;
+ }
+
+ /**
+ * Check if the user has an activate, non-expired license on current plugin's install.
+ *
+ * @since 1.0.9
+ *
+ * @return bool
+ */
+ function is_paying() {
+ $this->_logger->entrance();
+
+ if ( ! $this->is_registered( true ) ) {
+ return false;
+ }
+
+ if ( ! $this->has_paid_plan() ) {
+ return false;
+ }
+
+ return (
+ ! $this->is_trial() &&
+ 'free' !== $this->get_plan_name() &&
+ $this->has_active_valid_license()
+ );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.4
+ *
+ * @return bool
+ */
+ function is_free_plan() {
+ if ( ! $this->is_registered() ) {
+ return true;
+ }
+
+ if ( ! $this->has_paid_plan() ) {
+ return true;
+ }
+
+ return (
+ 'free' === $this->get_plan_name() ||
+ ! $this->has_features_enabled_license()
+ );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @return bool
+ */
+ function _has_premium_license() {
+ $this->_logger->entrance();
+
+ $premium_license = $this->_get_available_premium_license();
+
+ return ( false !== $premium_license );
+ }
+
+ /**
+ * Check if user has any licenses associated with the plugin (including expired or blocking).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.7.3
+ *
+ * @param bool $including_foreign
+ *
+ * @return bool
+ */
+ function has_any_license( $including_foreign = true ) {
+ if ( ! is_array( $this->_licenses ) || 0 === count( $this->_licenses ) ) {
+ return false;
+ }
+
+ if ( $including_foreign ) {
+ return true;
+ }
+
+ foreach ( $this->_licenses as $license ) {
+ if ( $this->_user->id == $license->user_id ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @param bool|null $is_localhost
+ *
+ * @return FS_Plugin_License|false
+ */
+ function _get_available_premium_license( $is_localhost = null ) {
+ $this->_logger->entrance();
+
+ $licenses = $this->get_available_premium_licenses( $is_localhost );
+ if ( ! empty( $licenses ) ) {
+ return $licenses[0];
+ }
+
+ return false;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @param bool|null $is_localhost
+ *
+ * @return FS_Plugin_License[]
+ */
+ function get_available_premium_licenses( $is_localhost = null ) {
+ $this->_logger->entrance();
+
+ $licenses = array();
+ if ( ! $this->has_paid_plan() ) {
+ return $licenses;
+ }
+
+ if ( is_array( $this->_licenses ) ) {
+ foreach ( $this->_licenses as $license ) {
+ if ( ! $license->can_activate( $is_localhost ) ) {
+ continue;
+ }
+
+ $licenses[] = $license;
+ }
+ }
+
+ return $licenses;
+ }
+
+ /**
+ * Sync local plugin plans with remote server.
+ *
+ * IMPORTANT: If for some reason a site is associated with deleted plan, we'll preserve the plan's information and append it as the last plan. This means that if plan is deleted, the is_plan() method will ALWAYS return true for any given argument (it becomes the most inclusive plan).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @return FS_Plugin_Plan[]|object
+ */
+ function _sync_plans() {
+ $plans = $this->_fetch_plugin_plans();
+
+ if ( $this->is_array_instanceof( $plans, 'FS_Plugin_Plan' ) ) {
+ $plans_map = array();
+ foreach ( $plans as $plan ) {
+ $plans_map[ $plan->id ] = true;
+ }
+
+ $plans_ids_to_keep = $this->get_plans_ids_associated_with_installs();
+
+ foreach ( $plans_ids_to_keep as $plan_id ) {
+ if ( isset( $plans_map[ $plan_id ] ) ) {
+ continue;
+ }
+
+ $missing_plan = self::_get_plan_by_id( $plan_id );
+
+ if ( is_object( $missing_plan ) ) {
+ $plans[] = $missing_plan;
+ }
+ }
+
+ $this->_plans = $plans;
+ $this->_store_plans();
+ }
+
+ $this->do_action( 'after_plans_sync', $plans );
+
+ return $this->_plans;
+ }
+
+ /**
+ * Check if specified plan exists locally. If not, fetch it and store it.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param number $plan_id
+ *
+ * @return \FS_Plugin_Plan|object The plan entity or the API error object on failure.
+ */
+ private function sync_plan_if_not_exist( $plan_id ) {
+ $plan = self::_get_plan_by_id( $plan_id );
+
+ if ( is_object( $plan ) ) {
+ // Plan already exists.
+ return $plan;
+ }
+
+ $plan = $this->fetch_plan_by_id( $plan_id );
+
+ if ( $plan instanceof FS_Plugin_Plan ) {
+ $this->_plans[] = $plan;
+ $this->_store_plans();
+
+ return $plan;
+ }
+
+ return $plan;
+ }
+
+ /**
+ * Check if specified license exists locally. If not, fetch it and store it.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param number $license_id
+ * @param string $license_key
+ *
+ * @return \FS_Plugin_Plan|object The plan entity or the API error object on failure.
+ */
+ private function sync_license_if_not_exist( $license_id, $license_key ) {
+ $license = $this->_get_license_by_id( $license_id );
+
+ if ( is_object( $license ) ) {
+ // License already exists.
+ return $license;
+ }
+
+ $license = $this->fetch_license_by_key( $license_id, $license_key );
+
+ if ( $license instanceof FS_Plugin_License ) {
+ $this->_licenses[] = $license;
+
+ $this->set_license( $license );
+
+ $this->_store_licenses();
+
+ return $license;
+ }
+
+ return $license;
+ }
+
+ /**
+ * Get a collection of unique plan IDs that are associated with any installs in the network.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.0
+ *
+ * @return number[]
+ */
+ private function get_plans_ids_associated_with_installs() {
+ if ( ! is_multisite() ) {
+ if ( ! is_object( $this->_site ) ||
+ ! FS_Plugin_Plan::is_valid_id( $this->_site->plan_id )
+ ) {
+ return array();
+ }
+
+ return array( $this->_site->plan_id );
+ }
+
+ $plan_ids = array();
+ $sites = self::get_sites();
+ foreach ( $sites as $site ) {
+ $blog_id = self::get_site_blog_id( $site );
+ $install = $this->get_install_by_blog_id( $blog_id );
+
+ if ( ! is_object( $install ) ||
+ ! FS_Plugin_Plan::is_valid_id( $install->plan_id )
+ ) {
+ continue;
+ }
+
+ $plan_ids[ $install->plan_id ] = true;
+ }
+
+ return array_keys( $plan_ids );
+ }
+
+ /**
+ * Get a collection of unique license IDs that are associated with any installs in the network.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.0
+ *
+ * @return number[]
+ */
+ private function get_license_ids_associated_with_installs() {
+ if ( ! $this->_is_network_active ) {
+ if ( ! is_object( $this->_site ) ||
+ ! FS_Plugin_License::is_valid_id( $this->_site->license_id )
+ ) {
+ return array();
+ }
+
+ return array( $this->_site->license_id );
+ }
+
+ $license_ids = array();
+ $sites = self::get_sites();
+ foreach ( $sites as $site ) {
+ $blog_id = self::get_site_blog_id( $site );
+ $install = $this->get_install_by_blog_id( $blog_id );
+
+ if ( ! is_object( $install ) ||
+ ! FS_Plugin_License::is_valid_id( $install->license_id )
+ ) {
+ continue;
+ }
+
+ $license_ids[ $install->license_id ] = true;
+ }
+
+ return array_keys( $license_ids );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @param number $id
+ *
+ * @return FS_Plugin_Plan|false
+ */
+ function _get_plan_by_id( $id ) {
+ $this->_logger->entrance();
+
+ if ( ! is_array( $this->_plans ) || 0 === count( $this->_plans ) ) {
+ $this->_sync_plans();
+ }
+
+ foreach ( $this->_plans as $plan ) {
+ if ( $id == $plan->id ) {
+ return $plan;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.8.1
+ *
+ * @param string $name
+ *
+ * @return FS_Plugin_Plan|false
+ */
+ private function get_plan_by_name( $name ) {
+ $this->_logger->entrance();
+
+ if ( ! is_array( $this->_plans ) || 0 === count( $this->_plans ) ) {
+ $this->_sync_plans();
+ }
+
+ foreach ( $this->_plans as $plan ) {
+ if ( $name == $plan->name ) {
+ return $plan;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Sync local licenses with remote server.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ *
+ * @param number|bool $site_license_id
+ * @param number|null $blog_id
+ *
+ * @return FS_Plugin_License[]|object
+ */
+ function _sync_licenses( $site_license_id = false, $blog_id = null ) {
+ $this->_logger->entrance();
+
+ $is_network_admin = fs_is_network_admin();
+
+ if ( $is_network_admin && is_null( $blog_id ) ) {
+ $all_licenses = self::get_all_licenses( $this->_module_id );
+ } else {
+ $all_licenses = $this->get_user_licenses( $this->_user->id );
+ }
+
+ $foreign_licenses = $this->get_foreign_licenses_info( $all_licenses, $site_license_id );
+
+ $all_licenses_map = array();
+ foreach ( $all_licenses as $license ) {
+ $all_licenses_map[ $license->id ] = true;
+ }
+
+ $licenses = $this->_fetch_licenses( false, $site_license_id, $foreign_licenses, $blog_id );
+
+ if ( $this->is_array_instanceof( $licenses, 'FS_Plugin_License' ) ) {
+ $licenses_map = array();
+ foreach ( $licenses as $license ) {
+ $licenses_map[ $license->id ] = true;
+ }
+
+// $license_ids_to_keep = $this->get_license_ids_associated_with_installs();
+// foreach ( $license_ids_to_keep as $license_id ) {
+// if ( isset( $licenses_map[ $license_id ] ) ) {
+// continue;
+// }
+//
+// $missing_license = self::_get_license_by_id( $license_id, false );
+// if ( is_object( $missing_license ) ) {
+// $licenses[] = $missing_license;
+// $licenses_map[ $missing_license->id ] = true;
+// }
+// }
+
+ $user_license_ids = $this->get_user_linked_license_ids( $this->_user->id );
+
+ foreach ( $user_license_ids as $key => $license_id ) {
+ if ( ! isset( $licenses_map[ $license_id ] ) ) {
+ // Remove access to licenses that no longer exist.
+ unset( $user_license_ids[ $key ] );
+ }
+ }
+
+ if ( ! empty( $user_license_ids ) ) {
+ foreach ( $licenses_map as $license_id => $value ) {
+ if ( ! isset( $all_licenses_map[ $license_id ] ) ) {
+ // Associate new licenses with the user who triggered the license syncing.
+ $user_license_ids[] = $license_id;
+ }
+ }
+
+ $user_license_ids = array_unique( $user_license_ids );
+ } else {
+ $user_license_ids = array_keys( $licenses_map );
+ }
+
+ if ( ! $is_network_admin || ! is_null( $blog_id ) ) {
+ $user_licenses = array();
+ foreach ( $licenses as $license ) {
+ if ( ! in_array( $license->id, $user_license_ids ) ) {
+ continue;
+ }
+
+ $user_licenses[] = $license;
+ }
+
+ $this->_licenses = $user_licenses;
+ } else {
+ $this->_licenses = $licenses;
+ }
+
+ $this->set_user_linked_license_ids( $this->_user->id, $user_license_ids );
+
+ $this->_store_licenses( true, $this->_module_id, $licenses );
+ }
+
+ // Update current license.
+ if ( is_object( $this->_license ) ) {
+ $license = $this->_get_license_by_id( $this->_license->id );
+
+ if ( is_object( $license ) ) {
+ /**
+ * `$license` can be `false` in case a user change action has just been completed and this method
+ * has synced the `$this->_licenses` collection for the new user. In this case, the
+ * `$this->_licenses` collection may have only the newly activated license that is associated with
+ * the new user. `set_license` will eventually be called in the same request by the logic that
+ * follows outside this method which will detect that the install's license has been updated, and
+ * then `_update_site_license` will be called which in turn will call `set_license`.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.2
+ */
+ $this->set_license( $license );
+ }
+ }
+
+ return $this->_licenses;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @param number $id
+ * @param bool $sync_licenses
+ *
+ * @return FS_Plugin_License|false
+ */
+ function _get_license_by_id( $id, $sync_licenses = true ) {
+ $this->_logger->entrance();
+
+ if ( ! FS_Plugin_License::is_valid_id( $id ) ) {
+ return false;
+ }
+
+ /**
+ * When running from the network level admin and opted-in from the network,
+ * check if the license exists in the network user licenses collection.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ */
+ if ( fs_is_network_admin() &&
+ $this->is_network_registered() &&
+ ( ! is_object( $this->_user ) || $this->_storage->network_user_id != $this->_user->id )
+ ) {
+ $licenses = $this->get_user_licenses( $this->_storage->network_user_id );
+
+ foreach ( $licenses as $license ) {
+ if ( $id == $license->id ) {
+ return $license;
+ }
+ }
+ }
+
+ if ( ! $this->has_any_license() && $sync_licenses ) {
+ $this->_sync_licenses( $id );
+ }
+
+ if ( is_array( $this->_licenses ) ) {
+ foreach ( $this->_licenses as $license ) {
+ if ( $id == $license->id ) {
+ return $license;
+ }
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Get license by ID. Unlike _get_license_by_id(), this method only checks the local storage and return any license, whether it's associated with the current context user/install or not.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param number $id
+ *
+ * @return FS_Plugin_License
+ */
+ private function get_license_by_id( $id ) {
+ $licenses = self::get_all_licenses( $this->_module_id );
+
+ if ( is_array( $licenses ) && ! empty( $licenses ) ) {
+ foreach ( $licenses as $license ) {
+ if ( $id == $license->id ) {
+ return $license;
+ }
+ }
+ }
+
+ return null;
+ }
+
+ /**
+ * Synchronize the site's context license by fetching the license form the API and updating the local data with it.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return \FS_Plugin_License|mixed
+ */
+ private function sync_site_license() {
+ $api = $this->get_api_user_scope();
+
+ $result = $api->get( "/licenses/{$this->_license->id}.json?license_key=" . urlencode( $this->_license->secret_key ), true );
+
+ if ( ! $this->is_api_result_entity( $result ) ) {
+ return $result;
+ }
+
+ $license = $this->_update_site_license( new FS_Plugin_License( $result ) );
+ $this->_store_licenses();
+
+ return $license;
+ }
+
+ /**
+ * Get all user's available licenses for the current module.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param number $user_id
+ *
+ * @return FS_Plugin_License[]
+ */
+ private function get_user_licenses( $user_id ) {
+ $all_licenses = self::get_all_licenses( $this->_module_id );
+ if ( empty( $all_licenses ) ) {
+ return array();
+ }
+
+ $user_license_ids = $this->get_user_linked_license_ids( $user_id );
+ if ( empty( $user_license_ids ) ) {
+ return array();
+ }
+
+ $licenses = array();
+ foreach ( $all_licenses as $license ) {
+ if ( in_array( $license->id, $user_license_ids ) ) {
+ $licenses[] = $license;
+ }
+ }
+
+ return $licenses;
+ }
+
+ /**
+ * Checks if the context license is network activated except on the given blog ID.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int $except_blog_id
+ *
+ * @return bool
+ */
+ private function is_license_network_active( $except_blog_id = 0 ) {
+ $this->_logger->entrance();
+
+ if ( ! is_object( $this->_license ) ) {
+ return false;
+ }
+
+ $sites = self::get_sites();
+
+ if ( $this->_license->total_activations() < ( count( $sites ) - 1 ) ) {
+ // There are more sites than the number of activations, so license cannot be network activated.
+ return false;
+ }
+
+ foreach ( $sites as $site ) {
+ $blog_id = self::get_site_blog_id( $site );
+
+ if ( $except_blog_id == $blog_id ) {
+ // Skip excluded blog.
+ continue;
+ }
+
+ $install = $this->get_install_by_blog_id( $blog_id );
+
+ if ( is_object( $install ) && $install->license_id != $this->_license->id ) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Checks if license can be activated on all the network sites (opted-in or skipped) that are not yet associated with a license. If possible, try to make the activation, if not return false.
+ *
+ * Notice: On success, this method will also update the license activations counters (without updating the license in the storage).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param \FS_User $user
+ * @param \FS_Plugin_License $license
+ *
+ * @return bool
+ */
+ private function try_activate_license_on_network( FS_User $user, FS_Plugin_License $license ) {
+ $this->_logger->entrance();
+
+ $result = $this->can_activate_license_on_network( $license );
+
+ if ( false === $result ) {
+ return false;
+ }
+
+ $installs_without_license = $result['installs'];
+ if ( ! empty( $installs_without_license ) ) {
+ $this->activate_license_on_many_installs( $user, $license->secret_key, $installs_without_license );
+ }
+
+ $disconnected_site_ids = $result['sites'];
+ if ( ! empty( $disconnected_site_ids ) ) {
+ $this->activate_license_on_many_sites( $user, $license->secret_key, $disconnected_site_ids );
+ }
+
+ $this->link_license_2_user( $license->id, $user->id );
+
+ // Sync license after activations.
+ $license->activated += $result['production_count'];
+ $license->activated_local += $result['localhost_count'];
+
+// $this->_store_licenses()
+
+ return true;
+ }
+
+ /**
+ * Checks if the given license can be activated on the whole network.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param \FS_Plugin_License $license
+ *
+ * @return false|array {
+ * @type array[int]FS_Site $installs Blog ID to install map.
+ * @type int[] $sites Non-connected blog IDs.
+ * @type int $production_count Production sites count.
+ * @type int $localhost_count Production sites count.
+ * }
+ */
+ private function can_activate_license_on_network( FS_Plugin_License $license ) {
+ $sites = self::get_sites();
+
+ $production_count = 0;
+ $localhost_count = 0;
+
+ $installs_without_license = array();
+ $disconnected_site_ids = array();
+
+ foreach ( $sites as $site ) {
+ $blog_id = self::get_site_blog_id( $site );
+ $install = $this->get_install_by_blog_id( $blog_id );
+
+ if ( is_object( $install ) ) {
+ if ( FS_Plugin_License::is_valid_id( $install->license_id ) ) {
+ // License already activated on the install.
+ continue;
+ }
+
+ $url = $install->url;
+
+ $installs_without_license[ $blog_id ] = $install;
+ } else {
+ $url = is_object( $site ) ?
+ $site->siteurl :
+ self::get_unfiltered_site_url( $blog_id );
+
+ $disconnected_site_ids[] = $blog_id;
+ }
+
+ if ( FS_Site::is_localhost_by_address( $url ) ) {
+ $localhost_count ++;
+ } else {
+ $production_count ++;
+ }
+ }
+
+ if ( ! $license->can_activate_bulk( $production_count, $localhost_count ) ) {
+ return false;
+ }
+
+ return array(
+ 'installs' => $installs_without_license,
+ 'sites' => $disconnected_site_ids,
+ 'production_count' => $production_count,
+ 'localhost_count' => $localhost_count,
+ );
+ }
+
+ /**
+ * Activate a given license on a collection of installs.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param \FS_User $user
+ * @param string $license_key
+ * @param array $blog_2_install_map {
+ * @key int Blog ID.
+ * @value FS_Site Blog's associated install.
+ * }
+ *
+ * @return mixed|true
+ */
+ private function activate_license_on_many_installs(
+ FS_User $user,
+ $license_key,
+ array $blog_2_install_map
+ ) {
+ $params = array(
+ array( 'license_key' => $this->apply_filters( 'license_key', $license_key ) )
+ );
+
+ $install_2_blog_map = array();
+ foreach ( $blog_2_install_map as $blog_id => $install ) {
+ $params[] = array( 'id' => $install->id, 'url' => $install->url );
+
+ $install_2_blog_map[ $install->id ] = $blog_id;
+ }
+
+ $result = $this->get_api_user_scope_by_user( $user )->call(
+ "plugins/{$this->_plugin->id}/installs.json",
+ 'PUT',
+ $params
+ );
+
+ if ( ! $this->is_api_result_object( $result, 'installs' ) ) {
+ return $result;
+ }
+
+ foreach ( $result->installs as $r_install ) {
+ $install = new FS_Site( $r_install );
+ $install->is_disconnected = false;
+
+ // Update install.
+ $this->_store_site(
+ true,
+ $install_2_blog_map[ $r_install->id ],
+ $install
+ );
+ }
+
+ return true;
+ }
+
+ /**
+ * Activate a given license on a collection of blogs/sites that are not yet opted-in.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.3.1
+ *
+ * @param \FS_User $user
+ * @param string $license_key
+ *
+ * @return true|mixed True if successful, otherwise, the API result.
+ */
+ private function activate_license_on_site( FS_User $user, $license_key ) {
+ return $this->activate_license_on_many_sites( $user, $license_key );
+ }
+
+ /**
+ * Activate a given license on a collection of blogs/sites that are not yet opted-in.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param \FS_User $user
+ * @param string $license_key
+ * @param int[] $site_ids
+ *
+ * @return true|mixed True if successful, otherwise, the API result.
+ */
+ private function activate_license_on_many_sites(
+ FS_User $user,
+ $license_key,
+ array $site_ids = array()
+ ) {
+ $sites = array();
+ foreach ( $site_ids as $site_id ) {
+ $sites[] = $this->get_site_info( array( 'blog_id' => $site_id ) );
+ }
+
+ // Install the plugin.
+ $result = $this->create_installs_with_user(
+ $user,
+ $license_key,
+ false,
+ $sites,
+ false,
+ true
+ );
+
+ if ( ! $this->is_api_result_entity( $result ) &&
+ ! $this->is_api_result_object( $result, 'installs' )
+ ) {
+ return $result;
+ }
+
+ $installs = array();
+
+ if ( $this->is_api_result_entity( $result ) ) {
+ $install = new FS_Site( $result );
+
+ $this->_user = $user;
+
+ $this->_store_site( true, null, $install );
+
+ $this->_site = $install;
+
+ $this->reset_anonymous_mode();
+ } else {
+ foreach ( $result->installs as $install ) {
+ $installs[] = new FS_Site( $install );
+ }
+
+ // Map site addresses to their blog IDs.
+ $address_to_blog_map = $this->get_address_to_blog_map();
+
+ $first_blog_id = null;
+
+ foreach ( $installs as $install ) {
+ $address = trailingslashit( fs_strip_url_protocol( $install->url ) );
+ $blog_id = $address_to_blog_map[ $address ];
+
+ $this->_store_site( true, $blog_id, $install );
+
+ $this->reset_anonymous_mode( $blog_id );
+
+ if ( is_null( $first_blog_id ) ) {
+ $first_blog_id = $blog_id;
+ }
+ }
+
+ if ( ! FS_Site::is_valid_id( $this->_storage->network_install_blog_id ) ) {
+ $this->_storage->network_install_blog_id = $first_blog_id;
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Sync site's license with user licenses.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ *
+ * @param FS_Plugin_License|null $new_license
+ *
+ * @return FS_Plugin_License|null
+ */
+ function _update_site_license( $new_license ) {
+ $this->_logger->entrance();
+
+ /**
+ * In case this call will be removed in the future, the `_sync_licenses()` method needs to be updated
+ * accordingly so that it will also handle the case when an ownership change is done via license
+ * activation.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.2
+ */
+ $this->set_license( $new_license );
+
+ if ( ! is_object( $new_license ) ) {
+ $this->_site->license_id = null;
+ $this->_sync_site_subscription( null );
+
+ return $this->_license;
+ }
+
+ $this->_site->license_id = $this->_license->id;
+
+ if ( ! is_array( $this->_licenses ) ) {
+ $this->_licenses = array();
+ }
+
+ $is_license_found = false;
+ for ( $i = 0, $len = count( $this->_licenses ); $i < $len; $i ++ ) {
+ if ( $new_license->id == $this->_licenses[ $i ]->id ) {
+ $this->_licenses[ $i ] = $new_license;
+
+ $is_license_found = true;
+ break;
+ }
+ }
+
+ // If new license just append.
+ if ( ! $is_license_found ) {
+ $this->_licenses[] = $new_license;
+ }
+
+ $this->_sync_site_subscription( $new_license );
+
+ return $this->_license;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.3.1
+ *
+ * @param \FS_Plugin_License $license
+ */
+ private function set_license( FS_Plugin_License $license = null ) {
+ $this->_license = $license;
+
+ $this->maybe_update_whitelabel_flag( $license );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.1
+ *
+ * @param FS_Plugin_License $license
+ */
+ private function maybe_update_whitelabel_flag( $license ) {
+ $is_whitelabeled = isset( $this->_storage->is_whitelabeled ) ?
+ $this->_storage->is_whitelabeled :
+ false;
+
+ if ( is_object( $license ) ) {
+ $license_user = self::_get_user_by_id( $license->user_id );
+
+ if ( ! is_object( $license_user ) ) {
+ // If foreign license, do not update the `is_whitelabeled` flag.
+ return;
+ }
+
+ if ( $this->is_addon() ) {
+ /**
+ * Store the last license data to the parent's storage since it's needed only when showing the
+ * "Start Debug" dialog which is triggered from the "Account" page. This way, there's no need to
+ * iterate over the add-ons just to get the last license data.
+ */
+ $this->get_parent_instance()->store_last_activated_license_data( $license, $license_user );
+ } else {
+ $this->store_last_activated_license_data( $license );
+ }
+
+ if ( $license->is_whitelabeled ) {
+ // Activated a developer license, data should be hidden.
+ $is_whitelabeled = true;
+ } else if ( $this->is_registered() && $this->_user->id == $license->user_id ) {
+ // The account owner activated a regular license key, no need to hide the data.
+ $is_whitelabeled = false;
+ }
+ }
+
+ $this->_storage->is_whitelabeled = $is_whitelabeled;
+
+ // Reset the whitelabeled status after update.
+ $this->is_whitelabeled = null;
+ if ( $this->is_addon() ) {
+ $parent_fs = $this->get_parent_instance();
+
+ if ( is_object( $parent_fs ) ) {
+ $parent_fs->is_whitelabeled = null;
+ }
+ }
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.1
+ *
+ * @param FS_Plugin_License $license
+ * @param FS_User $license_user
+ */
+ private function store_last_activated_license_data( FS_Plugin_License $license, $license_user = null ) {
+ if ( ! is_object( $license_user ) ) {
+ $this->_storage->last_license_key = md5( $license->secret_key );
+ $this->_storage->last_license_user_id = null;
+ } else {
+ $this->_storage->last_license_user_key = md5( $license_user->secret_key );
+ $this->_storage->last_license_user_id = $license_user->id;
+ }
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.1
+ *
+ * @param bool $ignore_data_debug_mode
+ *
+ * @return bool
+ */
+ function is_whitelabeled_by_flag( $ignore_data_debug_mode = false ) {
+ if ( true !== $this->_storage->is_whitelabeled ) {
+ return false;
+ } else if ( $ignore_data_debug_mode ) {
+ return true;
+ }
+
+ $fs = $this->is_addon() ?
+ $this->get_parent_instance() :
+ $this;
+
+ return ! $fs->is_data_debug_mode();
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.1
+ *
+ * @return number
+ */
+ function get_last_license_user_id() {
+ return ( FS_User::is_valid_id( $this->_storage->last_license_user_id ) ) ?
+ $this->_storage->last_license_user_id :
+ null;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.1
+ *
+ * @param int $blog_id
+ * @param bool $ignore_data_debug_mode
+ *
+ * @return bool
+ */
+ function is_whitelabeled( $ignore_data_debug_mode = false, $blog_id = null ) {
+ if ( ! is_null( $blog_id ) ) {
+ $this->switch_to_blog( $blog_id );
+ }
+
+ if ( ! is_null( $this->is_whitelabeled ) ) {
+ $is_whitelabeled = $this->is_whitelabeled;
+ } else {
+ $is_whitelabeled = false;
+
+ $is_whitelabeled_flag = $this->is_whitelabeled_by_flag( true );
+
+ if ( ! $this->has_addons() ) {
+ $is_whitelabeled = $is_whitelabeled_flag;
+ } else if ( $is_whitelabeled_flag ) {
+ $is_whitelabeled = true;
+ } else {
+ if ( $this->is_registered() || $this->is_premium() ) {
+ $addon_ids = $this->get_updated_account_addons();
+ } else {
+ $addons = self::get_all_addons();
+
+ $plugin_addons = isset( $addons[ $this->_plugin->id ] ) ?
+ $addons[ $this->_plugin->id ] :
+ array();
+
+ $addon_ids = array();
+ foreach ( $plugin_addons as $addon ) {
+ $addon_ids[] = $addon->id;
+ }
+ }
+
+ $installed_addons = $this->get_installed_addons();
+ foreach ( $installed_addons as $fs_addon ) {
+ $addon_ids[] = $fs_addon->get_id();
+ }
+
+ if ( ! empty( $addon_ids ) ) {
+ $addon_ids = array_unique( $addon_ids );
+
+ $is_network_level = (
+ fs_is_network_admin() &&
+ $this->is_network_active()
+ );
+
+ foreach ( $addon_ids as $addon_id ) {
+ $addon = $this->get_addon( $addon_id );
+
+ if ( ! is_object( $addon ) ) {
+ continue;
+ }
+
+ $addon_storage = FS_Storage::instance( WP_FS__MODULE_TYPE_PLUGIN, $addon->slug );
+ $fs_addon = $this->is_addon_activated( $addon_id ) ?
+ self::get_addon_instance( $addon_id ) :
+ null;
+
+ $was_addon_network_activated = false;
+
+ if ( is_object( $fs_addon ) ) {
+ $was_addon_network_activated = $fs_addon->is_network_active();
+ } else if ( $is_network_level ) {
+ $was_addon_network_activated = $addon_storage->get( 'was_plugin_loaded', false, true );
+ }
+
+ $network_delegated_connection = (
+ $was_addon_network_activated &&
+ $addon_storage->get( 'is_delegated_connection', false, true )
+ );
+
+ if (
+ $is_network_level &&
+ ( ! $was_addon_network_activated || $network_delegated_connection )
+ ) {
+ $sites = self::get_sites();
+
+ /**
+ * If in network admin area and the add-on was not network-activated or network-activated
+ * and network-delegated, find any add-on whose is_whitelabeled flag is true.
+ */
+ foreach ( $sites as $site ) {
+ $site_info = $this->get_site_info( $site );
+
+ if ( $addon_storage->get( 'is_whitelabeled', false, $site_info['blog_id'] ) ) {
+ $is_whitelabeled = true;
+ break;
+ }
+ }
+
+ if ( $is_whitelabeled ) {
+ break;
+ }
+ } else {
+ /**
+ * This will be executed when any of the following is met:
+ * 1. Add-on was network-activated, not network-delegated, and in network admin area.
+ * 2. Add-on was network-activated, network-delegated, and in site admin area.
+ * 3. Add-on was not network-activated and in site admin area.
+ */
+ if ( true === $addon_storage->is_whitelabeled ) {
+ $is_whitelabeled = true;
+ break;
+ }
+ }
+ }
+ }
+ }
+
+ $this->is_whitelabeled = $is_whitelabeled;
+
+ if ( ! $is_whitelabeled || ! $this->is_data_debug_mode() ) {
+ $this->_admin_notices->remove_sticky( 'data_debug_mode_enabled' );
+ }
+
+ if ( ! is_null( $blog_id ) ) {
+ $this->restore_current_blog();
+ }
+ }
+
+ return (
+ $is_whitelabeled &&
+ ( $ignore_data_debug_mode || ! $this->is_data_debug_mode() )
+ );
+ }
+
+ /**
+ * Sync site's subscription.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @param FS_Plugin_License|null $license
+ *
+ * @return bool|\FS_Subscription
+ */
+ private function _sync_site_subscription( $license ) {
+ if ( ! is_object( $license ) ) {
+ $this->delete_unused_subscriptions();
+
+ return false;
+ }
+
+ // Load subscription details if not lifetime.
+ $subscription = $license->is_lifetime() ?
+ false :
+ $this->_fetch_site_license_subscription();
+
+ if ( is_object( $subscription ) && ! isset( $subscription->error ) ) {
+ $this->store_subscription( $subscription );
+ } else {
+ $this->delete_unused_subscriptions();
+ }
+
+ return $subscription;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ *
+ * @return bool|\FS_Plugin_License
+ */
+ function _get_license() {
+ if ( ! fs_is_network_admin() || is_object( $this->_license ) ) {
+ return $this->_license;
+ }
+
+ return $this->_get_available_premium_license();
+ }
+
+ /**
+ * @param number $license_id
+ *
+ * @return null|\FS_Subscription
+ */
+ function _get_subscription( $license_id ) {
+ if ( ! isset( $this->_storage->subscriptions ) ||
+ empty( $this->_storage->subscriptions )
+ ) {
+ return null;
+ }
+
+ foreach ( fs_get_entities( $this->_storage->subscriptions, FS_Subscription::get_class_name() ) as $subscription ) {
+ if ( $subscription->license_id == $license_id ) {
+ return $subscription;
+ }
+ }
+
+ return null;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.0
+ *
+ * @param FS_Subscription $subscription
+ */
+ function store_subscription( FS_Subscription $subscription ) {
+ if ( ! isset( $this->_storage->subscriptions ) ) {
+ $this->_storage->subscriptions = array();
+ }
+
+ if ( empty( $this->_storage->subscriptions ) || ! is_multisite() ) {
+ $this->_storage->subscriptions = array( $subscription );
+
+ return;
+ }
+
+ $subscriptions = fs_get_entities( $this->_storage->subscriptions, FS_Subscription::get_class_name() );
+
+ $updated_subscription = false;
+ foreach ( $subscriptions as $key => $existing_subscription ) {
+ if ( $existing_subscription->id == $subscription->id ) {
+ $subscriptions[ $key ] = $subscription;
+ $updated_subscription = true;
+ break;
+ }
+ }
+
+ if ( ! $updated_subscription ) {
+ $subscriptions[] = $subscription;
+ }
+
+ $this->_storage->subscriptions = $subscriptions;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.0
+ */
+ function delete_unused_subscriptions() {
+ if ( ! isset( $this->_storage->subscriptions ) ||
+ empty( $this->_storage->subscriptions ) ||
+ // Clean up only if there are already at least 3 subscriptions.
+ ( count( $this->_storage->subscriptions ) < 3 )
+ ) {
+ return;
+ }
+
+ if ( ! is_multisite() ) {
+ // If not multisite, there should only be 1 subscription, so just clear the array.
+ $this->_storage->subscriptions = array();
+
+ return;
+ }
+
+ $subscriptions_to_keep_by_license_id_map = array();
+ $sites = self::get_sites();
+ foreach ( $sites as $site ) {
+ $blog_id = self::get_site_blog_id( $site );
+ $install = $this->get_install_by_blog_id( $blog_id );
+
+ if ( ! is_object( $install ) ||
+ ! FS_Plugin_License::is_valid_id( $install->license_id )
+ ) {
+ continue;
+ }
+
+ $subscriptions_to_keep_by_license_id_map[ $install->license_id ] = true;
+ }
+
+ if ( empty( $subscriptions_to_keep_by_license_id_map ) ) {
+ $this->_storage->subscriptions = array();
+
+ return;
+ }
+
+ foreach ( $this->_storage->subscriptions as $key => $subscription ) {
+ if ( ! isset( $subscriptions_to_keep_by_license_id_map[ $subscription->license_id ] ) ) {
+ unset( $this->_storage->subscriptions[ $key ] );
+ }
+ }
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.2
+ *
+ * @param string $plan Plan name
+ * @param bool $exact If true, looks for exact plan. If false, also check "higher" plans.
+ *
+ * @return bool
+ */
+ function is_plan( $plan, $exact = false ) {
+ $this->_logger->entrance();
+
+ if ( ! $this->is_registered() ) {
+ return false;
+ }
+
+ $plan = strtolower( $plan );
+
+ $current_plan_name = $this->get_plan_name();
+
+ if ( $current_plan_name === $plan ) {
+ // Exact plan.
+ return true;
+ } else if ( $exact ) {
+ // Required exact, but plans are different.
+ return false;
+ }
+
+ $current_plan_order = - 1;
+ $required_plan_order = PHP_INT_MAX;
+ for ( $i = 0, $len = count( $this->_plans ); $i < $len; $i ++ ) {
+ if ( $plan === $this->_plans[ $i ]->name ) {
+ $required_plan_order = $i;
+ } else if ( $current_plan_name === $this->_plans[ $i ]->name ) {
+ $current_plan_order = $i;
+ }
+ }
+
+ return ( $current_plan_order > $required_plan_order );
+ }
+
+ /**
+ * Check if module has only one plan.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.7
+ *
+ * @param bool $double_check In some cases developers prefer to release their paid offering as premium-only, even though there is a free version. For those cases, looking at the 'is_premium_only' value isn't enough because the result will return false even when the product has only signle paid plan.
+ *
+ * @return bool
+ */
+ function is_single_plan( $double_check = false ) {
+ $this->_logger->entrance();
+
+ if ( ! $this->is_registered() ||
+ ! is_array( $this->_plans ) ||
+ 0 === count( $this->_plans )
+ ) {
+ return true;
+ }
+
+ $has_free_plan = $this->has_free_plan();
+
+ if ( ! $has_free_plan && $double_check ) {
+ foreach ( $this->_plans as $plan ) {
+ if ( $plan->is_free() ) {
+ $has_free_plan = true;
+ break;
+ }
+ }
+ }
+
+ return ( 1 === ( count( $this->_plans ) - ( $has_free_plan ? 1 : 0 ) ) );
+ }
+
+ /**
+ * Check if plan based on trial. If not in trial mode, should return false.
+ *
+ * @since 1.0.9
+ *
+ * @param string $plan Plan name
+ * @param bool $exact If true, looks for exact plan. If false, also check "higher" plans.
+ *
+ * @return bool
+ */
+ function is_trial_plan( $plan, $exact = false ) {
+ $this->_logger->entrance();
+
+ if ( ! $this->is_registered() ) {
+ return false;
+ }
+
+ if ( ! $this->is_trial() ) {
+ return false;
+ }
+
+ $trial_plan = $this->get_trial_plan();
+
+ if ( $trial_plan->name === $plan ) {
+ // Exact plan.
+ return true;
+ } else if ( $exact ) {
+ // Required exact, but plans are different.
+ return false;
+ }
+
+ $current_plan_order = - 1;
+ $required_plan_order = - 1;
+ for ( $i = 0, $len = count( $this->_plans ); $i < $len; $i ++ ) {
+ if ( $plan === $this->_plans[ $i ]->name ) {
+ $required_plan_order = $i;
+ } else if ( $trial_plan->name === $this->_plans[ $i ]->name ) {
+ $current_plan_order = $i;
+ }
+ }
+
+ return ( $current_plan_order > $required_plan_order );
+ }
+
+ /**
+ * Check if plugin has any paid plans.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.7
+ *
+ * @return bool
+ */
+ function has_paid_plan() {
+ return $this->_has_paid_plans ||
+ FS_Plan_Manager::instance()->has_paid_plan( $this->_plans );
+ }
+
+ /**
+ * Check if plugin has any plan with a trail.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @return bool
+ */
+ function has_trial_plan() {
+ /**
+ * @author Vova Feldman(@svovaf)
+ * @since 1.2.1.5
+ *
+ * Allow setting a trial from the SDK without calling the API.
+ * But, if the user did opt-in, continue using the real data from the API.
+ */
+ if ( $this->_trial_days >= 0 ) {
+ return true;
+ }
+
+ return $this->_storage->get( 'has_trial_plan', false );
+ }
+
+ /**
+ * Check if plugin has any free plan, or is it premium only.
+ *
+ * Note: If no plans configured, assume plugin is free.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.7
+ *
+ * @return bool
+ */
+ function has_free_plan() {
+ return ! $this->is_only_premium();
+ }
+
+ /**
+ * Displays a license activation dialog box when the user clicks on the "Activate License"
+ * or "Change License" link on the plugins
+ * page.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 1.1.9
+ */
+ function _add_license_activation_dialog_box() {
+ $vars = array(
+ 'id' => $this->_module_id,
+ );
+
+ fs_require_template( 'forms/license-activation.php', $vars );
+ fs_require_template( 'forms/resend-key.php', $vars );
+ }
+
+ /**
+ * Displays an email address update dialog box when the user clicks on the email address "Edit" button on the "Account" page.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.0
+ */
+ function _add_email_address_update_dialog_box() {
+ $vars = array( 'id' => $this->_module_id );
+
+ fs_require_template( 'forms/email-address-update.php', $vars );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.0
+ */
+ function _add_email_address_update_option() {
+ if ( ! $this->should_handle_user_change() ) {
+ return;
+ }
+
+ // Add email address update AJAX handler.
+ $this->add_ajax_action( 'update_email_address', array( &$this, '_email_address_update_ajax_handler' ) );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.0
+ */
+ function _email_address_update_ajax_handler() {
+ $this->check_ajax_referer( 'update_email_address' );
+
+ $new_email_address = fs_request_get( 'email_address' );
+ $transfer_type = fs_request_get( 'transfer_type' );
+
+ $result = $this->update_email( $new_email_address );
+
+ if ( ! FS_Api::is_api_error( $result ) ) {
+ self::shoot_ajax_success();
+ }
+
+ $error = '';
+
+ if ( FS_Api::is_api_error_object( $result ) ) {
+ switch ( $result->error->code ) {
+ case 'user_exist':
+ case 'account_verification_required':
+ $error = array(
+ 'code' => 'change_ownership',
+ 'url' => $this->get_account_url( 'change_owner', array(
+ 'state' => 'init',
+ 'candidate_email' => $new_email_address,
+ 'transfer_type' => $transfer_type,
+ ) ),
+ );
+
+ break;
+ }
+ }
+
+ if ( empty( $error ) ) {
+ $error = is_object( $result ) ?
+ var_export( $result->error, true ) :
+ $result;
+ }
+
+ self::shoot_ajax_failure( $error );
+ }
+
+ /**
+ * Returns a collection of IDs of installs that are associated with the context product and its add-ons, and activated with foreign licenses.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.2
+ *
+ * @return number[]
+ */
+ function get_installs_ids_with_foreign_licenses() {
+ $installs = array();
+
+ if (
+ is_object( $this->_license ) &&
+ $this->_site->user_id != $this->_license->user_id
+ ) {
+ $installs[] = $this->_site->id;
+ }
+
+ /**
+ * Also try to get foreign licenses for the context product's add-ons.
+ */
+ $installs_by_slug_map = $this->get_parent_and_addons_installs_info();
+
+ foreach ( $installs_by_slug_map as $slug => $install_info ) {
+ if ( $slug == $this->get_slug() ) {
+ continue;
+ }
+
+ $install = $install_info['install'];
+ $license = $install_info['license'];
+
+ if (
+ is_object( $license ) &&
+ $install->user_id != $license->user_id
+ ) {
+ $installs[] = $install->id;
+ }
+ }
+
+ return $installs;
+ }
+
+ /**
+ * Displays the "Change User" dialog box when the user clicks on the "Change User" button on the "Account" page.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.2
+ *
+ * @param number[] $install_ids
+ */
+ function _add_user_change_dialog_box( $install_ids ) {
+ $vars = array(
+ 'id' => $this->_module_id,
+ 'license_owners' => $this->fetch_installs_licenses_owners_data( $install_ids )
+ );
+
+ fs_require_template( 'forms/user-change.php', $vars );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.1
+ */
+ function _add_data_debug_mode_dialog_box() {
+ $vars = array(
+ 'id' => $this->_module_id,
+ );
+
+ fs_require_template( 'forms/data-debug-mode.php', $vars );
+ }
+
+ /**
+ * Displays a subscription cancellation dialog box when the user clicks on the "Deactivate License"
+ * link on the "Account" page or deactivates a plugin and there's an active subscription that is
+ * either associated with a non-lifetime single-site license or non-lifetime multisite license that
+ * is only activated on a single production site.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.1
+ *
+ * @param bool $is_license_deactivation
+ *
+ * @return array
+ */
+ function _get_subscription_cancellation_dialog_box_template_params( $is_license_deactivation = false ) {
+ if ( fs_is_network_admin() ) {
+ // Subscription cancellation dialog box is currently not supported for multisite networks.
+ return array();
+ }
+
+ if ( $this->is_whitelabeled() ) {
+ return array();
+ }
+
+ $license = $this->_get_license();
+
+ /**
+ * If the installation is associated with a non-lifetime license, which is either a single-site or only activated on a single production site (or zero), and connected to an active subscription, suggest the customer to cancel the subscription upon deactivation.
+ *
+ * @author Leo Fajardo (@leorw) (Comment added by Vova Feldman @svovaf)
+ * @since 2.2.1
+ */
+ if ( ! is_object( $license ) ||
+ $license->is_lifetime() ||
+ ( ! $license->is_single_site() && $license->activated > 1 )
+ ) {
+ return array();
+ }
+
+ /**
+ * @var FS_Subscription $subscription
+ */
+ $subscription = $this->_get_subscription( $license->id );
+ if ( ! is_object( $subscription ) || ! $subscription->is_active() ) {
+ return array();
+ }
+
+ return array(
+ 'id' => $this->_module_id,
+ 'license' => $license,
+ 'has_trial' => $this->is_paid_trial(),
+ 'is_license_deactivation' => $is_license_deactivation,
+ );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.2
+ */
+ function _add_premium_version_upgrade_selection_dialog_box() {
+ $modules_update = get_site_transient( $this->is_theme() ? 'update_themes' : 'update_plugins' );
+ if ( ! isset( $modules_update->response[ $this->_plugin_basename ] ) ) {
+ return;
+ }
+
+ $vars = array(
+ 'id' => $this->_module_id,
+ 'new_version' => is_object( $modules_update->response[ $this->_plugin_basename ] ) ?
+ $modules_update->response[ $this->_plugin_basename ]->new_version :
+ $modules_update->response[ $this->_plugin_basename ]['new_version']
+ );
+
+ fs_require_template( 'forms/premium-versions-upgrade-metadata.php', $vars );
+ fs_require_once_template( 'forms/premium-versions-upgrade-handler.php', $vars );
+ }
+
+ /**
+ * Displays the opt-out dialog box when the user clicks on the "Opt Out" link on the "Plugins"
+ * page.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 1.2.1.5
+ */
+ function _add_optout_dialog() {
+ if ( $this->is_theme() ) {
+ $vars = null;
+ fs_require_once_template( '/js/jquery.content-change.php', $vars );
+ }
+
+ $vars = array( 'id' => $this->_module_id );
+ fs_require_template( 'forms/optout.php', $vars );
+ }
+
+ /**
+ * Prepare page to include all required UI and logic for the license activation dialog.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.0
+ */
+ function _add_license_activation() {
+ if ( $this->is_migration() ) {
+ return;
+ }
+
+ if ( ! $this->is_user_admin() ) {
+ // Only admins can activate a license.
+ return;
+ }
+
+ if ( ! $this->has_paid_plan() ) {
+ // Module doesn't have any paid plans.
+ return;
+ }
+
+ if (
+ $this->has_premium_version() &&
+ ! $this->is_premium() &&
+ /**
+ * Also handle the case when an upgrade was made using the free version.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.2
+ */
+ ! is_object( $this->_get_license() )
+ ) {
+ // Only add license activation logic to the premium version, or in case of a serviceware plugin, also in the free version.
+ return;
+ }
+
+ // Add license activation link and AJAX request handler.
+ if ( self::is_plugins_page() ) {
+ $is_network_admin = fs_is_network_admin();
+
+ if (
+ ( $is_network_admin && $this->is_network_active() && ! $this->is_network_delegated_connection() ) ||
+ ( ! $is_network_admin && ( ! $this->is_network_active() || $this->is_delegated_connection() ) )
+ ) {
+ if (
+ $this->is_premium() ||
+ ( $this->has_paid_plan() && ! $this->has_premium_version() )
+ ) {
+ /**
+ * @since 1.2.0 Add license action link only on plugins page.
+ */
+ $this->_add_license_action_link();
+ }
+ }
+ }
+
+ // Add license activation AJAX callback.
+ $this->add_ajax_action( 'activate_license', array( &$this, '_activate_license_ajax_action' ) );
+
+ // Add resend license AJAX callback.
+ $this->add_ajax_action( 'resend_license_key', array( &$this, '_resend_license_key_ajax_action' ) );
+ }
+
+ /**
+ * Prepares page to include all required UI and logic for the "Change User" dialog.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.2
+ */
+ function _add_user_change_option() {
+ if ( ! $this->should_handle_user_change() ) {
+ return;
+ }
+
+ $installs_ids_with_foreign_licenses = $this->get_installs_ids_with_foreign_licenses();
+
+ if ( empty( $installs_ids_with_foreign_licenses ) ) {
+ // Handle user change only when the parent product or one of its add-ons is activated with a foreign license.
+ return;
+ }
+
+ // Add user change AJAX handler.
+ $this->add_ajax_action( 'change_user', array( &$this, '_user_change_ajax_action' ) );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.2
+ */
+ function should_handle_user_change() {
+ if ( ! $this->is_user_admin() ) {
+ // Only admins can change user.
+ return false;
+ }
+
+ if ( $this->is_addon() ) {
+ return false;
+ }
+
+ if ( ! $this->is_registered() ) {
+ return false;
+ }
+
+ if (
+ $this->is_network_active() &&
+ ( fs_is_network_admin() || ! $this->is_site_delegated_connection() )
+ ) {
+ // Handle only on site-level "Account" section for now.
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.2
+ */
+ function _add_premium_version_upgrade_selection() {
+ if ( ! $this->is_user_admin() ) {
+ return;
+ }
+
+ if ( ! $this->is_premium() || $this->has_any_active_valid_license() ) {
+ // This is relevant only to the free versions and premium versions without an active license.
+ return;
+ }
+
+ if ( self::is_updates_page() || ( $this->is_plugin() && self::is_plugins_page() ) ) {
+ $this->_add_premium_version_upgrade_selection_action();
+ }
+ }
+
+ /**
+ * @author Edgar Melkonyan
+ * @since 2.4.1
+ *
+ * @throws Freemius_Exception
+ */
+ function _toggle_whitelabel_mode_ajax_handler() {
+ $this->_logger->entrance();
+
+ $this->check_ajax_referer( 'toggle_whitelabel_mode' );
+
+ if ( ! $this->is_user_admin() ) {
+ // Only for admins.
+ self::shoot_ajax_failure();
+ }
+
+ $license = $this->get_api_user_scope()->call(
+ "/licenses/{$this->_site->license_id}.json",
+ 'put',
+ array( 'is_whitelabeled' => ! $this->_license->is_whitelabeled )
+ );
+
+ if ( ! $this->is_api_result_entity( $license ) ) {
+ self::shoot_ajax_failure(
+ FS_Api::is_api_error_object( $license ) ?
+ $license->error->message :
+ fs_text_inline( "An unknown error has occurred while trying to toggle the license's white-label mode.", 'unknown-error-occurred', $this->get_slug() )
+ );
+ }
+
+ $this->_license->is_whitelabeled = $license->is_whitelabeled;
+ $this->_store_licenses();
+
+ $this->_sync_license();
+
+ if ( ! $license->is_whitelabeled ) {
+ $this->_admin_notices->remove_sticky( 'license_whitelabeled' );
+ } else {
+ $this->_admin_notices->add_sticky(
+ sprintf(
+ $this->get_text_inline(
+ 'Your %s license was flagged as white-labeled to hide sensitive information from the WP Admin (e.g. your email, license key, prices, billing address & invoices). If you ever wish to revert it back, you can easily do it through your %s. If this was a mistake you can also %s.',
+ 'license_whitelabeled'
+ ),
+ "{$this->get_plugin_title()} ",
+ sprintf( '%s ', $this->get_text_inline( 'User Dashboard', 'user-dashboard' ) ),
+ sprintf( '%s ', $this->get_text_inline( 'revert it now', 'revert-it-now' ) )
+ ),
+ 'license_whitelabeled'
+ );
+ }
+
+ self::shoot_ajax_response( array( 'success' => true ) );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.0
+ */
+ function _add_beta_mode_update_handler() {
+ if ( ! $this->is_user_admin() ) {
+ return;
+ }
+
+ if ( ! $this->is_premium() ) {
+ return;
+ }
+
+ $this->add_ajax_action( 'set_beta_mode', array( &$this, '_set_beta_mode_ajax_handler' ) );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.0
+ */
+ function _set_beta_mode_ajax_handler() {
+ $this->_logger->entrance();
+
+ $this->check_ajax_referer( 'set_beta_mode' );
+
+ if ( ! $this->is_user_admin() ) {
+ // Only for admins.
+ self::shoot_ajax_failure();
+ }
+
+ $is_beta = trim( fs_request_get( 'is_beta', '', 'post' ) );
+
+ if ( empty( $is_beta ) || ! in_array( $is_beta, array( 'true', 'false' ) ) ) {
+ self::shoot_ajax_failure();
+ }
+
+ $site = $this->api_site_call(
+ '',
+ 'put',
+ array(
+ 'is_beta' => ( 'true' == $is_beta ),
+ 'fields' => 'is_beta'
+ )
+ );
+
+ if ( ! $this->is_api_result_entity( $site ) ) {
+ self::shoot_ajax_failure(
+ FS_Api::is_api_error_object( $site ) ?
+ $site->error->message :
+ fs_text_inline( "An unknown error has occurred while trying to set the user's beta mode.", 'unknown-error-occurred', $this->get_slug() )
+ );
+ }
+
+ $this->_site->is_beta = $site->is_beta;
+ $this->_store_site();
+
+ self::shoot_ajax_response( array( 'success' => true ) );
+ }
+
+ /**
+ * License activation WP AJAX handler.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 1.1.9
+ *
+ * @uses Freemius::activate_license()
+ */
+ function _activate_license_ajax_action() {
+ $this->_logger->entrance();
+
+ $this->check_ajax_referer( 'activate_license' );
+
+ $license_key = trim( fs_request_get_raw( 'license_key' ) );
+
+ if ( empty( $license_key ) ) {
+ $license_id = trim( fs_request_get_raw( 'license_id' ) );
+
+ if ( FS_Plugin_License::is_valid_id( $license_id ) ) {
+ $license = $this->_get_license_by_id( $license_id, false );
+
+ if ( is_object( $license ) ) {
+ $license_key = $license->secret_key;
+ }
+ }
+ }
+
+ if ( empty( $license_key ) ) {
+ exit;
+ }
+
+ $sites = fs_is_network_admin() ?
+ fs_request_get( 'sites', array(), 'post' ) :
+ array();
+
+ $result = $this->activate_license(
+ $license_key,
+ $sites,
+ fs_request_get_bool( 'is_marketing_allowed', null ),
+ fs_request_get( 'blog_id', null ),
+ fs_request_get( 'module_id', null, 'post' ),
+ fs_request_get( 'user_id', null ),
+ fs_request_get_bool( 'is_extensions_tracking_allowed', null ),
+ fs_request_get_bool( 'is_diagnostic_tracking_allowed', null )
+ );
+
+ if (
+ $result['success'] &&
+ $this->is_bundle_license_auto_activation_enabled()
+ ) {
+ $license = new FS_Plugin_License();
+ $license->secret_key = $license_key;
+
+ $this->maybe_activate_bundle_license( $license, $sites );
+ }
+
+ echo json_encode( $result );
+
+ exit;
+ }
+
+ /**
+ * User change WP AJAX handler.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.2
+ */
+ function _user_change_ajax_action() {
+ $this->_logger->entrance();
+
+ $this->check_ajax_referer( 'change_user' );
+
+ $new_email_address = trim( fs_request_get( 'email_address', '' ) );
+ $new_user_id = fs_request_get( 'user_id' );
+
+ if ( empty( $new_email_address ) && ! FS_User::is_valid_id( $new_user_id ) ) {
+ self::shoot_ajax_failure( fs_text_inline( 'Invalid new user ID or email address.', 'invalid-new-user-id-or-email', $this->get_slug() ) );
+ }
+
+ $params = array();
+
+ if ( ! empty( $new_email_address ) ) {
+ $params['user_email'] = $new_email_address;
+ } else {
+ $params['user_id'] = $new_user_id;
+ }
+
+ $installs_info_by_slug_map = $this->get_parent_and_addons_installs_info();
+ $install_ids = array();
+
+ foreach ( $installs_info_by_slug_map as $slug => $install_info ) {
+ $install_ids[ $slug ] = $install_info['install']->id;
+ }
+
+ $params['install_ids'] = implode( ',', array_values( $install_ids ) );
+
+ $install = $this->get_api_site_scope()->call( $this->add_show_pending( '/' ), 'put', $params );
+
+ if ( FS_Api::is_api_error( $install ) ) {
+ $error = '';
+
+ if ( is_object( $install ) ) {
+ switch ( $install->error->code ) {
+ case 'user_exist':
+ $error = (
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...' .
+ $this->get_text_inline( 'Sorry, we could not complete the email update. Another user with the same email is already registered.', 'user-exist-message' ) . ' ' .
+ sprintf( $this->get_text_inline( 'If you would like to give up the ownership of the %s\'s account to %s click the Change Ownership button.', 'user-exist-message_ownership' ), $this->_module_type, '' . $new_email_address . ' ' ) .
+ sprintf(
+ '%s ➜ %s ',
+ $this->apply_filters( 'update_notice_checkout_url', $url ),
+ $purchase_license_text
+ ),
+ $new_version
+ );
+ }
+
+ /**
+ * Plugin's pricing URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.4
+ *
+ * @param string $billing_cycle Billing cycle
+ *
+ * @param bool $is_trial
+ *
+ * @return string
+ */
+ function pricing_url( $billing_cycle = WP_FS__PERIOD_ANNUALLY, $is_trial = false ) {
+ $this->_logger->entrance();
+
+ $params = array(
+ 'billing_cycle' => $billing_cycle
+ );
+
+ if ( $is_trial ) {
+ $params['trial'] = 'true';
+ }
+
+ $url = $this->is_addon() ?
+ $this->_parent->addon_url( $this->_slug ) :
+ $this->_get_admin_page_url( 'pricing', $params );
+
+ return $this->get_pricing_url_with_filter( $url );
+ }
+
+ /**
+ * Retrieves the filtered pricing URL.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.7.4
+ *
+ * @param string $url
+ *
+ * @return string
+ */
+ private function get_pricing_url_with_filter( $url ) {
+ return $this->apply_filters( 'pricing_url', $url );
+ }
+
+ /**
+ * Checkout page URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ *
+ * @param string $billing_cycle Billing cycle
+ * @param bool $is_trial
+ * @param array $extra (optional) Extra parameters, override other query params.
+ * @param bool|null $network
+ *
+ * @return string
+ */
+ function checkout_url(
+ $billing_cycle = WP_FS__PERIOD_ANNUALLY,
+ $is_trial = false,
+ $extra = array(),
+ $network = null
+ ) {
+ $this->_logger->entrance();
+
+ $params = array(
+ 'checkout' => 'true',
+ 'billing_cycle' => $billing_cycle,
+ );
+
+ if ( $is_trial ) {
+ $params['trial'] = 'true';
+ }
+
+ /**
+ * Params in extra override other params.
+ */
+ $params = array_merge( $params, $extra );
+
+ return $this->apply_filters( 'checkout_url', $this->_get_admin_page_url( 'pricing', $params, $network ) );
+ }
+
+ /**
+ * Add-on checkout URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.7
+ *
+ * @param number $addon_id
+ * @param number $pricing_id
+ * @param string $billing_cycle
+ * @param bool $is_trial
+ * @param bool|null $network
+ *
+ * @return string
+ */
+ function addon_checkout_url(
+ $addon_id,
+ $pricing_id,
+ $billing_cycle = WP_FS__PERIOD_ANNUALLY,
+ $is_trial = false,
+ $network = null
+ ) {
+ return $this->checkout_url( $billing_cycle, $is_trial, array(
+ 'plugin_id' => $addon_id,
+ 'pricing_id' => $pricing_id,
+ ), $network );
+ }
+
+ #endregion
+
+ #endregion ------------------------------------------------------------------
+
+ /**
+ * Check if plugin has any add-ons.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @since 1.1.7.3 Base logic only on the parameter provided by the developer in the init function.
+ *
+ * @return bool
+ */
+ function has_addons() {
+ $this->_logger->entrance();
+
+ return $this->_has_addons;
+ }
+
+ /**
+ * Check if plugin can work in anonymous mode.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @return bool
+ *
+ * @deprecated Please use is_enable_anonymous() instead.
+ */
+ function enable_anonymous() {
+ return $this->_enable_anonymous;
+ }
+
+ /**
+ * Check if plugin can work in anonymous mode.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.9
+ *
+ * @return bool
+ */
+ function is_enable_anonymous() {
+ return $this->_enable_anonymous;
+ }
+
+ /**
+ * Check if plugin is premium only (no free plans).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.9
+ *
+ * @return bool
+ */
+ function is_only_premium() {
+ return $this->_is_premium_only;
+ }
+
+ /**
+ * Checks if the plugin's type is "plugin". The other type is "theme".
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 1.2.2
+ *
+ * @return bool
+ */
+ function is_plugin() {
+ return ( WP_FS__MODULE_TYPE_PLUGIN === $this->_module_type );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 1.2.2
+ *
+ * @return string
+ */
+ function get_module_type() {
+ if ( ! isset( $this->_module_type ) ) {
+ $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map', array() );
+ $this->_module_type = $id_slug_type_path_map[ $this->_module_id ]['type'];
+ }
+
+ return $this->_module_type;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 1.2.2
+ *
+ * @return string
+ */
+ function get_plugin_main_file_path() {
+ return $this->_plugin_main_file_path;
+ }
+
+ /**
+ * Check if module has a premium code version.
+ *
+ * Serviceware module might be freemium without any
+ * premium code version, where the paid features
+ * are all part of the service.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.6
+ *
+ * @return bool
+ */
+ function has_premium_version() {
+ return $this->_has_premium_version;
+ }
+
+ /**
+ * Check if feature supported with current site's plan.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ *
+ * @todo IMPLEMENT
+ *
+ * @param number $feature_id
+ *
+ * @throws Exception
+ */
+ function is_feature_supported( $feature_id ) {
+ throw new Exception( 'not implemented' );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ *
+ * @return bool Is running in SSL/HTTPS
+ */
+ function is_ssl() {
+ return WP_FS__IS_HTTPS;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @return bool Is running in AJAX call.
+ *
+ * @link http://wordpress.stackexchange.com/questions/70676/how-to-check-if-i-am-in-admin-ajax
+ */
+ static function is_ajax() {
+ return ( defined( 'DOING_AJAX' ) && DOING_AJAX );
+ }
+
+ /**
+ * Check if it's an AJAX call targeted for the current module.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.0
+ *
+ * @param array|string $actions Collection of AJAX actions.
+ *
+ * @return bool
+ */
+ function is_ajax_action( $actions ) {
+ // Verify it's an ajax call.
+ if ( ! self::is_ajax() ) {
+ return false;
+ }
+
+ // Verify the call is relevant for the plugin.
+ if ( $this->_module_id != fs_request_get( 'module_id' ) ) {
+ return false;
+ }
+
+ // Verify it's one of the specified actions.
+ if ( is_string( $actions ) ) {
+ $actions = explode( ',', $actions );
+ }
+
+ if ( is_array( $actions ) && 0 < count( $actions ) ) {
+ $ajax_action = fs_request_get( 'action' );
+
+ foreach ( $actions as $action ) {
+ if ( $ajax_action === $this->get_action_tag( $action ) ) {
+ return true;
+ }
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Check if it's an AJAX call targeted for current request.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.0
+ *
+ * @param array|string $actions Collection of AJAX actions.
+ * @param number|null $module_id
+ *
+ * @return bool
+ */
+ static function is_ajax_action_static( $actions, $module_id = null ) {
+ // Verify it's an ajax call.
+ if ( ! self::is_ajax() ) {
+ return false;
+ }
+
+
+ if ( ! empty( $module_id ) ) {
+ // Verify the call is relevant for the plugin.
+ if ( $module_id != fs_request_get( 'module_id' ) ) {
+ return false;
+ }
+ }
+
+ // Verify it's one of the specified actions.
+ if ( is_string( $actions ) ) {
+ $actions = explode( ',', $actions );
+ }
+
+ if ( is_array( $actions ) && 0 < count( $actions ) ) {
+ $ajax_action = fs_request_get( 'action' );
+
+ foreach ( $actions as $action ) {
+ if ( $ajax_action === self::get_ajax_action_static( $action, $module_id ) ) {
+ return true;
+ }
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.7
+ *
+ * @return bool
+ */
+ static function is_cron() {
+ return ( defined( 'DOING_CRON' ) && DOING_CRON );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.0
+ *
+ * @return bool
+ */
+ static function is_admin_post() {
+ return ( 'admin-post.php' === self::get_current_page() );
+ }
+
+ /**
+ * Check if a real user is visiting the admin dashboard.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.7
+ *
+ * @return bool
+ */
+ function is_user_in_admin() {
+ return (
+ is_admin() &&
+ ! self::is_ajax() &&
+ ! self::is_cron() &&
+ ! self::is_admin_post()
+ );
+ }
+
+ /**
+ * Check if a real user is in the customizer view.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return bool
+ */
+ static function is_customizer() {
+ return is_customize_preview();
+ }
+
+ /**
+ * Check if running in HTTPS and if site's plan matching the specified plan.
+ *
+ * @param string $plan
+ * @param bool $exact
+ *
+ * @return bool
+ */
+ function is_ssl_and_plan( $plan, $exact = false ) {
+ return ( $this->is_ssl() && $this->is_plan( $plan, $exact ) );
+ }
+
+ /**
+ * Construct plugin's settings page URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.4
+ *
+ * @param string $page
+ * @param array $params
+ * @param bool|null $network
+ *
+ * @return string
+ */
+ function _get_admin_page_url( $page = '', $params = array(), $network = null ) {
+ if ( is_null( $network ) ) {
+ $network = (
+ $this->_is_network_active &&
+ ( fs_is_network_admin() || ! $this->is_delegated_connection() )
+ );
+ }
+
+ if ( 0 < count( $params ) ) {
+ foreach ( $params as $k => $v ) {
+ $params[ $k ] = urlencode( $v );
+ }
+ }
+
+ $page_param = $this->_menu->get_slug( $page );
+
+ if ( empty( $page ) &&
+ // Show the opt-in as an overlay for free wp.org themes or themes without any settings page.
+ $this->show_opt_in_on_themes_page()
+ ) {
+ $params[ $this->get_unique_affix() . '_show_optin' ] = 'true';
+
+ return add_query_arg(
+ $params,
+ $this->admin_url( 'themes.php', 'admin', $network )
+ );
+ }
+
+ if ( ! $this->has_settings_menu() ) {
+ if ( ! empty( $page ) ) {
+ // Module doesn't have a setting page, but since the request is for
+ // a specific Freemius page, use the admin.php path.
+ return add_query_arg( array_merge( $params, array(
+ 'page' => $page_param,
+ ) ), $this->admin_url( 'admin.php', 'admin', $network ) );
+ } else {
+ if ( $this->is_activation_mode() ) {
+ /**
+ * @author Vova Feldman
+ * @since 1.2.1.6
+ *
+ * If plugin doesn't have a settings page, create one for the opt-in screen.
+ */
+ return add_query_arg( array_merge( $params, array(
+ 'page' => $this->_slug,
+ ) ), $this->admin_url( 'admin.php', 'admin', $network ) );
+ } else {
+ // Plugin without a settings page.
+ return add_query_arg(
+ $params,
+ $this->admin_url( 'plugins.php', 'admin', $network )
+ );
+ }
+ }
+ }
+
+ // Module has a submenu settings page.
+ if ( ! $this->_menu->is_top_level() ) {
+ $parent_slug = $this->_menu->get_parent_slug();
+ $menu_file = ( false !== strpos( $parent_slug, '.php' ) ) ?
+ $parent_slug :
+ 'admin.php';
+
+ return add_query_arg( array_merge( $params, array(
+ 'page' => $page_param,
+ ) ), $this->admin_url( $menu_file, 'admin', $network ) );
+ }
+
+ // Module has a top level CPT settings page.
+ if ( $this->_menu->is_cpt() ) {
+ if ( empty( $page ) && $this->is_activation_mode() ) {
+ return add_query_arg( array_merge( $params, array(
+ 'page' => $page_param
+ ) ), $this->admin_url( 'admin.php', 'admin', $network ) );
+ } else {
+ if ( ! empty( $page ) ) {
+ $params['page'] = $page_param;
+ }
+
+ return add_query_arg(
+ $params,
+ $this->admin_url( $this->_menu->get_raw_slug(), 'admin', $network )
+ );
+ }
+ }
+
+ // Module has a custom top level settings page.
+ return add_query_arg( array_merge( $params, array(
+ 'page' => $page_param,
+ ) ), $this->admin_url( 'admin.php', 'admin', $network ) );
+ }
+
+ #--------------------------------------------------------------------------------
+ #region Multisite
+ #--------------------------------------------------------------------------------
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.0
+ *
+ * @return bool
+ */
+ function is_network_active() {
+ return $this->_is_network_active;
+ }
+
+ /**
+ * Delegate activation for the given sites in the network (or all sites if `null`) to site admins.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.0
+ *
+ * @param bool|int[] $all_or_blog_ids
+ */
+ private function delegate_connection( $all_or_blog_ids = true ) {
+ $this->_logger->entrance();
+
+ $this->_admin_notices->remove_sticky( 'connect_account' );
+
+ if ( true === $all_or_blog_ids ) {
+ // All sites delegation.
+ $this->_storage->store( 'is_delegated_connection', true, true );
+ } else {
+ // Specified sites delegation.
+ foreach ( $all_or_blog_ids as $blog_id ) {
+ $this->delegate_site_connection( $blog_id );
+ }
+ }
+
+ $this->network_upgrade_mode_completed();
+ }
+
+ /**
+ * Delegate specific network site conncetion to the site admin.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int $blog_id
+ */
+ private function delegate_site_connection( $blog_id ) {
+ $this->_storage->store( 'is_delegated_connection', true, $blog_id );
+ }
+
+ /**
+ * Check if super-admin delegated the connection of ALL sites to the site admins.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return bool
+ */
+ function is_network_delegated_connection() {
+ if ( ! $this->_is_network_active ) {
+ return false;
+ }
+
+ return $this->_storage->get( 'is_delegated_connection', false, true );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.0
+ *
+ * @param int $blog_id
+ *
+ * @return bool
+ */
+ function is_site_delegated_connection( $blog_id = 0 ) {
+ if ( ! $this->_is_network_active ) {
+ return false;
+ }
+
+ if ( 0 == $blog_id ) {
+ $blog_id = get_current_blog_id();
+ }
+
+ return $this->_storage->get( 'is_delegated_connection', false, $blog_id );
+ }
+
+ /**
+ * Check if delegated the connection. When running within the network admin,
+ * and haven't specified the blog ID, checks if network level delegated. If running
+ * within a site admin or specified a blog ID, check if delegated the connection for
+ * the current context site.
+ *
+ * If executed outside the the admin, check if delegated the connection
+ * for the current context site OR the whole network.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int $blog_id If set, checks if network delegated or blog specific delegated.
+ *
+ * @return bool
+ */
+ function is_delegated_connection( $blog_id = 0 ) {
+ if ( ! $this->_is_network_active ) {
+ return false;
+ }
+
+ if ( fs_is_network_admin() && 0 == $blog_id ) {
+ return $this->is_network_delegated_connection();
+ }
+
+ return (
+ $this->is_network_delegated_connection() ||
+ $this->is_site_delegated_connection( $blog_id )
+ );
+ }
+
+ /**
+ * Check if the current module is active for the site.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int $blog_id
+ *
+ * @return bool
+ */
+ function is_active_for_site( $blog_id ) {
+ if ( ! is_multisite() ) {
+ // Not a multisite and this code is executed, means that the plugin is active.
+ return true;
+ }
+
+ if ( $this->is_theme() ) {
+ // All themes are site level activated.
+ return true;
+ }
+
+ if ( $this->_is_network_active ) {
+ // Plugin was network activated so it's active.
+ return true;
+ }
+
+ return in_array( $this->_plugin_basename, (array) get_blog_option( $blog_id, 'active_plugins', array() ) );
+ }
+
+ /**
+ * @todo Implement pagination when accessing the subsites collection.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.0
+ *
+ * @param int $limit Default to 1,000
+ * @param int $offset Default to 0
+ *
+ * @return array Active & public sites collection.
+ */
+ static function get_sites( $limit = 1000, $offset = 0 ) {
+ if ( ! is_multisite() ) {
+ return array();
+ }
+
+ /**
+ * For consistency with get_blog_list() which only return active public sites.
+ *
+ * @author Vova Feldman (@svovaf)
+ */
+ $args = array(
+ /**
+ * Commented out in order to handle the migration of site options whether the site is public or not.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.1
+ */
+ // 'public' => 1,
+ 'archived' => 0,
+ 'mature' => 0,
+ 'spam' => 0,
+ 'deleted' => 0,
+ 'number' => $limit,
+ 'offset' => $offset,
+ );
+
+ return get_sites( $args );
+ }
+
+ /**
+ * Checks if a given blog is active.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param $blog_id
+ *
+ * @return bool
+ */
+ private static function is_site_active( $blog_id ) {
+ global $wpdb;
+
+ $blog_info = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->blogs} WHERE blog_id = %d", $blog_id ) );
+
+ if ( ! is_object( $blog_info ) ) {
+ return false;
+ }
+
+ return (
+ true == $blog_info->public &&
+ false == $blog_info->archived &&
+ false == $blog_info->mature &&
+ false == $blog_info->spam &&
+ false == $blog_info->deleted
+ );
+ }
+
+ /**
+ * Get a mapping between the site addresses to their blog IDs.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return array {
+ * @key string Site address without protocol with a trailing slash.
+ * @value int Site's blog ID.
+ * }
+ */
+ private function get_address_to_blog_map() {
+ $sites = self::get_sites();
+
+ // Map site addresses to their blog IDs.
+ $address_to_blog_map = array();
+ foreach ( $sites as $site ) {
+ $blog_id = self::get_site_blog_id( $site );
+ $address = self::get_unfiltered_site_url( $blog_id, true, true );
+ $address_to_blog_map[ $address ] = $blog_id;
+ }
+
+ return $address_to_blog_map;
+ }
+
+ /**
+ * Get a mapping between the site addresses to their blog IDs.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return array {
+ * @key int Site's blog ID.
+ * @value FS_Site Associated install.
+ * }
+ */
+ function get_blog_install_map() {
+ $sites = self::get_sites();
+
+ // Map site blog ID to its install.
+ $install_map = array();
+
+ foreach ( $sites as $site ) {
+ $blog_id = self::get_site_blog_id( $site );
+ $install = $this->get_install_by_blog_id( $blog_id );
+
+ if ( is_object( $install ) ) {
+ $install_map[ $blog_id ] = $install;
+ }
+ }
+
+ return $install_map;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.5.1
+ *
+ * @param bool|null $is_delegated When `true`, returns only connection delegated blog IDs. When `false`, only non-delegated blog IDs.
+ *
+ * @return int[]
+ */
+ private function get_blog_ids( $is_delegated = null ) {
+ $blog_ids = array();
+
+ $sites = self::get_sites();
+ foreach ( $sites as $site ) {
+ $blog_id = self::get_site_blog_id( $site );
+
+ if (
+ is_null( $is_delegated ) ||
+ $is_delegated === $this->is_site_delegated_connection( $blog_id )
+ ) {
+ $blog_ids[] = $blog_id;
+ }
+ }
+
+ return $blog_ids;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.5.1
+ *
+ * @return int[]
+ */
+ private function get_non_delegated_blog_ids() {
+ return $this->get_blog_ids( false );
+ }
+
+ /**
+ * Gets a map of module IDs that the given user has opted-in to.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.1.0
+ *
+ * @param number $fs_user_id
+ *
+ * @return array {
+ * @key number $plugin_id
+ * @value bool Always true.
+ * }
+ */
+ private static function get_user_opted_in_module_ids_map( $fs_user_id ) {
+ self::$_static_logger->entrance();
+
+ if ( ! is_multisite() ) {
+ $installs = array_merge(
+ self::get_all_sites( WP_FS__MODULE_TYPE_PLUGIN ),
+ self::get_all_sites( WP_FS__MODULE_TYPE_THEME )
+ );
+ } else {
+ $sites = self::get_sites();
+
+ $installs = array();
+ foreach ( $sites as $site ) {
+ $blog_id = self::get_site_blog_id( $site );
+
+ $installs = array_merge(
+ $installs,
+ self::get_all_sites( WP_FS__MODULE_TYPE_PLUGIN, $blog_id ),
+ self::get_all_sites( WP_FS__MODULE_TYPE_THEME, $blog_id )
+ );
+ }
+ }
+
+ $module_ids_map = array();
+ foreach ( $installs as $install ) {
+ if ( is_object( $install ) &&
+ FS_Site::is_valid_id( $install->id ) &&
+ FS_User::is_valid_id( $install->user_id ) &&
+ ( $install->user_id == $fs_user_id )
+ ) {
+ $module_ids_map[ $install->plugin_id ] = true;
+ }
+ }
+
+ return $module_ids_map;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ *
+ * @return null|array {
+ * 'install' => FS_Site Module's install,
+ * 'blog_id' => string The associated blog ID.
+ * }
+ */
+ function find_first_install() {
+ $sites = self::get_sites();
+
+ foreach ( $sites as $site ) {
+ $blog_id = self::get_site_blog_id( $site );
+ $install = $this->get_install_by_blog_id( $blog_id );
+
+ if ( is_object( $install ) ) {
+ return array(
+ 'install' => $install,
+ 'blog_id' => $blog_id
+ );
+ }
+ }
+
+ return null;
+ }
+
+ /**
+ * Switches the Freemius site level context to a specified blog.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int $blog_id
+ * @param FS_Site $install
+ * @param bool $flush
+ *
+ * @return bool Since 2.3.1 returns if a switch was made.
+ */
+ function switch_to_blog( $blog_id, FS_Site $install = null, $flush = false ) {
+ if ( ! is_numeric( $blog_id ) ) {
+ return false;
+ }
+
+ if ( ! $flush && $blog_id == $this->_context_is_network_or_blog_id ) {
+ return false;
+ }
+
+ switch_to_blog( $blog_id );
+ $this->_context_is_network_or_blog_id = $blog_id;
+
+ self::$_accounts->set_site_blog_context( $blog_id );
+ $this->_storage->set_site_blog_context( $blog_id );
+ $this->_storage->set_network_active( $this->_is_network_active, $this->is_delegated_connection( $blog_id ) );
+
+ $this->_site = is_object( $install ) ?
+ $install :
+ $this->get_install_by_blog_id( $blog_id );
+
+ $this->_user = false;
+ $this->_licenses = false;
+ $this->_license = null;
+ $this->is_whitelabeled = null;
+
+ if ( is_object( $this->_site ) ) {
+ // Try to fetch user from install.
+ $this->_user = self::_get_user_by_id( $this->_site->user_id );
+
+ if ( ! is_object( $this->_user ) &&
+ FS_User::is_valid_id( $this->_storage->prev_user_id )
+ ) {
+ // Try to fetch previously saved user.
+ $this->_user = self::_get_user_by_id( $this->_storage->prev_user_id );
+
+ if ( ! is_object( $this->_user ) ) {
+ // Fallback to network's user.
+ $this->_user = $this->get_network_user();
+ }
+ }
+
+ $all_plugin_licenses = self::get_all_licenses( $this->_module_id );
+
+ if ( ! empty( $all_plugin_licenses ) ) {
+ if ( ! FS_Plugin_License::is_valid_id( $this->_site->license_id ) ) {
+ $this->_license = null;
+ } else {
+ $license_found = false;
+ foreach ( $all_plugin_licenses as $license ) {
+ if ( $license->id == $this->_site->license_id ) {
+ // License found.
+ $this->_license = $license;
+ $license_found = true;
+ break;
+ }
+ }
+
+ if ( $license_found ) {
+ $this->link_license_2_user( $this->_license->id, $this->_user->id );
+ }
+ }
+
+ $this->_licenses = $this->get_user_licenses( $this->_user->id );
+ }
+ }
+
+ unset( $this->_site_api );
+ unset( $this->_user_api );
+
+ return true;
+ }
+
+ /**
+ * Restore the blog context to the blog that originally loaded the module.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ */
+ function restore_current_blog() {
+ $this->switch_to_blog( $this->_blog_id );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param array|WP_Site $site
+ *
+ * @return int
+ */
+ static function get_site_blog_id( &$site ) {
+ return ( $site instanceof WP_Site ) ?
+ $site->blog_id :
+ ( is_object( $site ) && isset( $site->userblog_id ) ?
+ $site->userblog_id :
+ $site['blog_id'] );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.5.1
+ *
+ * @param WP_Site[]|array[] $sites
+ *
+ * @return int[]
+ */
+ static function get_sites_blog_ids( $sites ) {
+ $blog_ids = array();
+ foreach ( $sites as $site ) {
+ $blog_ids[] = self::get_site_blog_id( $site );
+ }
+
+ return $blog_ids;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.0
+ *
+ * @param array|WP_Site|null $site
+ * @param bool $load_registration Since 2.5.1 When set to `true` the method will attempt to return the subsite's registration date, regardless of the `$site` type and value. In most calls, the registration date will be returned anyway, even when the value is `false`. This param is purely for performance optimization.
+ *
+ * @return array
+ */
+ function get_site_info( $site = null, $load_registration = false ) {
+ $this->_logger->entrance();
+
+ $switched = false;
+
+ $registration_date = null;
+
+ if ( is_null( $site ) ) {
+ $url = self::get_unfiltered_site_url();
+ $name = get_bloginfo( 'name' );
+ $blog_id = null;
+ } else {
+ $blog_id = self::get_site_blog_id( $site );
+
+ if ( get_current_blog_id() != $blog_id ) {
+ switch_to_blog( $blog_id );
+ $switched = true;
+ }
+
+ if ( $site instanceof WP_Site ) {
+ $url = $site->siteurl;
+ $name = $site->blogname;
+ $registration_date = $site->registered;
+ } else {
+ $url = self::get_unfiltered_site_url( $blog_id );
+ $name = get_bloginfo( 'name' );
+ }
+ }
+
+ if ( empty( $registration_date ) && $load_registration ) {
+ $blog_details = get_blog_details( $blog_id, false );
+
+ if ( is_object( $blog_details ) && isset( $blog_details->registered ) ) {
+ $registration_date = $blog_details->registered;
+ }
+ }
+
+ $info = array(
+ 'uid' => $this->get_anonymous_id( $blog_id ),
+ 'url' => $url,
+ );
+
+ // Add these diagnostic information only if user allowed to track.
+ if ( FS_Permission_Manager::instance( $this )->is_diagnostic_tracking_allowed() ) {
+ $info = array_merge( $info, array(
+ 'title' => $name,
+ 'language' => self::get_sanitized_language(),
+ ) );
+ }
+
+ if ( is_numeric( $blog_id ) ) {
+ $info['blog_id'] = $blog_id;
+ }
+
+ if ( ! empty( $registration_date ) ) {
+ $info[ 'registration_date' ] = $registration_date;
+ }
+
+ if ( $switched ) {
+ restore_current_blog();
+ }
+
+ return $info;
+ }
+
+ /**
+ * Load the module's install based on the blog ID.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int|null $blog_id
+ *
+ * @return FS_Site
+ */
+ function get_install_by_blog_id( $blog_id = null ) {
+ $installs = self::get_all_sites( $this->_module_type, $blog_id );
+ $install = isset( $installs[ $this->_slug ] ) ? $installs[ $this->_slug ] : null;
+
+ if ( is_object( $install ) &&
+ is_numeric( $install->id ) &&
+ is_numeric( $install->user_id ) &&
+ FS_Plugin_Plan::is_valid_id( $install->plan_id )
+ ) {
+ // Load site.
+ $install = clone $install;
+ }
+
+ return $install;
+ }
+
+ /**
+ * Check if module is installed on a specified site.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int|null $blog_id
+ *
+ * @return bool
+ */
+ function is_installed_on_site( $blog_id = null ) {
+ $installs = self::get_all_sites( $this->_module_type, $blog_id );
+ $install = isset( $installs[ $this->_slug ] ) ? $installs[ $this->_slug ] : null;
+
+ return (
+ is_object( $install ) &&
+ is_numeric( $install->id ) &&
+ is_numeric( $install->user_id ) &&
+ FS_Plugin_Plan::is_valid_id( $install->plan_id )
+ );
+ }
+
+ /**
+ * Check if super-admin connected at least one site via the network opt-in.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return bool
+ */
+ function is_network_registered() {
+ if ( ! $this->_is_network_active ) {
+ return false;
+ }
+
+ return FS_User::is_valid_id( $this->_storage->network_user_id );
+ }
+
+ /**
+ * Returns the main user associated with the network.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return FS_User
+ */
+ function get_network_user() {
+ if ( ! $this->_is_network_active ) {
+ return null;
+ }
+
+ return FS_User::is_valid_id( $this->_storage->network_user_id ) ?
+ self::_get_user_by_id( $this->_storage->network_user_id ) :
+ null;
+ }
+
+ /**
+ * Returns the current context user or the network's main user.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return FS_User
+ */
+ function get_current_or_network_user() {
+ return ( $this->_user instanceof FS_User ) ?
+ $this->_user :
+ $this->get_network_user();
+ }
+
+ /**
+ * Returns the main install associated with the network.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return FS_Site
+ */
+ function get_network_install() {
+ if ( ! $this->_is_network_active ) {
+ return null;
+ }
+
+ return FS_Site::is_valid_id( $this->_storage->network_install_blog_id ) ?
+ $this->get_install_by_blog_id( $this->_storage->network_install_blog_id ) :
+ null;
+ }
+
+ /**
+ * Returns the blog ID that is associated with the main install.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.0
+ *
+ * @return int|null
+ */
+ function get_network_install_blog_id() {
+ if ( ! $this->_is_network_active ) {
+ return null;
+ }
+
+ return FS_Site::is_valid_id( $this->_storage->network_install_blog_id ) ?
+ $this->_storage->network_install_blog_id :
+ null;
+ }
+
+ /**
+ * Returns the current context install or the network's main install.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return FS_Site
+ */
+ function get_current_or_network_install() {
+ return ( $this->_site instanceof FS_Site ) ?
+ $this->_site :
+ $this->get_network_install();
+ }
+
+ /**
+ * Check if executing a site level action from the network level admin.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return false|int If yes, return the requested blog ID.
+ */
+ private function is_network_level_site_specific_action() {
+ if ( ! $this->_is_network_active ) {
+ return false;
+ }
+
+ if ( ! fs_is_network_admin() ) {
+ return false;
+ }
+
+ $blog_id = fs_request_get( 'blog_id', '' );
+
+ return is_numeric( $blog_id ) ? $blog_id : false;
+ }
+
+ /**
+ * Check if executing an action from the network level admin.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return bool
+ */
+ private function is_network_level_action() {
+ return ( $this->_is_network_active && fs_is_network_admin() );
+ }
+
+ /**
+ * Needs to be executed after site deactivation, archive, deletion, or flag as spam.
+ * The logic updates the network level user and blog, and reschedule the crons if the cron executing site matching the site that is no longer publicly active.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int $context_blog_id
+ */
+ private function update_multisite_data_after_site_deactivation( $context_blog_id = 0 ) {
+ $this->_logger->entrance();
+
+ if ( $this->_is_network_active ) {
+ if ( $context_blog_id == $this->_storage->network_install_blog_id ) {
+ $installs_map = $this->get_blog_install_map();
+
+ foreach ( $installs_map as $blog_id => $install ) {
+ /**
+ * @var FS_Site $install
+ */
+ if ( $context_blog_id == $blog_id ) {
+ continue;
+ }
+
+ if ( $install->user_id != $this->_storage->network_user_id ) {
+ continue;
+ }
+
+ // Switch reference to a blog that is opted-in and belong to the same super-admin.
+ $this->_storage->network_install_blog_id = $blog_id;
+ break;
+ }
+ }
+ }
+
+ if ( ! $this->is_registered() ) {
+ return;
+ }
+
+ if ( $this->is_sync_cron_scheduled() &&
+ $context_blog_id == $this->get_sync_cron_blog_id()
+ ) {
+ $this->schedule_sync_cron( WP_FS__SCRIPT_START_TIME, true, $context_blog_id );
+ }
+
+ if ( $this->is_install_sync_scheduled() &&
+ $context_blog_id == $this->get_install_sync_cron_blog_id()
+ ) {
+ $this->schedule_install_sync( $context_blog_id );
+ }
+ }
+
+ /**
+ * Executed after site deactivation, archive, or flag as spam.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int $context_blog_id
+ */
+ public function _after_site_deactivated_callback( $context_blog_id = 0 ) {
+ $this->_logger->entrance();
+
+ $install = $this->get_install_by_blog_id( $context_blog_id );
+
+ if ( ! is_object( $install ) ) {
+ // Site not connected.
+ return;
+ }
+
+ $this->update_multisite_data_after_site_deactivation( $context_blog_id );
+
+ if ( ! $this->is_registered() ) {
+ return;
+ }
+
+ $current_blog_id = get_current_blog_id();
+
+ $this->switch_to_blog( $context_blog_id );
+
+ // Send deactivation event.
+ $this->sync_install( array(
+ 'is_active' => false,
+ ) );
+
+ $this->switch_to_blog( $current_blog_id );
+ }
+
+ /**
+ * Executed after site deletion.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int $context_blog_id
+ * @param bool $drop True if site's database tables should be dropped. Default is false.
+ */
+ public function _after_site_deleted_callback( $context_blog_id = 0, $drop = false ) {
+ $this->_logger->entrance();
+
+ $install = $this->get_install_by_blog_id( $context_blog_id );
+
+ if ( ! is_object( $install ) ) {
+ // Site not connected.
+ return;
+ }
+
+ $this->update_multisite_data_after_site_deactivation( $context_blog_id );
+
+ if ( ! $this->is_registered() ) {
+ return;
+ }
+
+ $current_blog_id = get_current_blog_id();
+
+ $this->switch_to_blog( $context_blog_id );
+
+ if ( $drop ) {
+ // Delete install if dropping site DB.
+ $this->delete_account_event();
+ } else {
+ // Send deactivation event.
+ $this->sync_install( array(
+ 'is_active' => false,
+ ) );
+ }
+
+ $this->switch_to_blog( $current_blog_id );
+ }
+
+ /**
+ * Executed after site deletion, called from wp_delete_site
+ *
+ * @author Dario Curvino (@dudo)
+ * @since 2.5.0
+ *
+ * @param WP_Site $old_site
+ */
+ public function _after_wpsite_deleted_callback( WP_Site $old_site ) {
+ $this->_logger->entrance();
+
+ $this->_after_site_deleted_callback( $old_site->blog_id, true );
+ }
+
+ /**
+ * Executed after site re-activation.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int $context_blog_id
+ */
+ public function _after_site_reactivated_callback( $context_blog_id = 0 ) {
+ $this->_logger->entrance();
+
+ $install = $this->get_install_by_blog_id( $context_blog_id );
+
+ if ( ! is_object( $install ) ) {
+ // Site not connected.
+ return;
+ }
+
+ if ( ! self::is_site_active( $context_blog_id ) ) {
+ // Site not yet active (can be in spam mode, archived, deleted...).
+ return;
+ }
+
+ $current_blog_id = get_current_blog_id();
+
+ $this->switch_to_blog( $context_blog_id );
+
+ // Send re-activation event.
+ $this->sync_install( array(
+ 'is_active' => true,
+ ) );
+
+ $this->switch_to_blog( $current_blog_id );
+ }
+
+ #endregion Multisite
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ *
+ * @param string $path
+ * @param string $scheme
+ * @param bool $network
+ *
+ * @return string
+ */
+ private function admin_url( $path = '', $scheme = 'admin', $network = true ) {
+ return ( $this->_is_network_active && $network ) ?
+ network_admin_url( $path, $scheme ) :
+ admin_url( $path, $scheme );
+ }
+
+ /**
+ * Check if currently in a specified admin page.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @param string $page
+ *
+ * @return bool
+ */
+ function is_admin_page( $page ) {
+ return ( $this->_menu->get_slug( $page ) === fs_request_get( 'page', '', 'get' ) );
+ }
+
+ /**
+ * Check if currently in the product's main admin page.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.3.1
+ *
+ * @return bool
+ */
+ function is_main_admin_page() {
+ return $this->is_admin_page( '' );
+ }
+
+ /**
+ * Get module's main admin setting page URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return string
+ */
+ function main_menu_url() {
+ return $this->_menu->main_menu_url();
+ }
+
+ /**
+ * Check if currently on the theme's setting page or
+ * on any of the Freemius added pages (via tabs).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return bool
+ *
+ * @deprecated Please use is_product_settings_page() instead;
+ */
+ function is_theme_settings_page() {
+ return $this->is_product_settings_page();
+ }
+
+ /**
+ * Check if currently on the product's main setting page or on any of the Freemius added pages (via tabs).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return bool
+ */
+ function is_product_settings_page() {
+ $page = fs_request_get( 'page', '', 'get' );
+ $menu_slug = $this->_menu->get_slug();
+
+ if ( $page === $menu_slug ) {
+ return true;
+ }
+
+ return fs_starts_with(
+ // e.g., {$menu_slug}-account, {$menu_slug}-affiliation, etc.
+ $page,
+ ( $menu_slug . '-' )
+ );
+ }
+
+ /**
+ * Plugin's account page + sync license URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.9.1
+ *
+ * @param bool|number $plugin_id
+ * @param bool $add_action_nonce
+ * @param array $params
+ *
+ * @return string
+ */
+ function _get_sync_license_url( $plugin_id = false, $add_action_nonce = true, $params = array() ) {
+ if ( is_numeric( $plugin_id ) ) {
+ $params['plugin_id'] = $plugin_id;
+ }
+
+ return $this->get_account_url(
+ $this->get_unique_affix() . '_sync_license',
+ $params,
+ $add_action_nonce
+ );
+ }
+
+ /**
+ * Plugin's account URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.4
+ *
+ * @param bool|string $action
+ * @param array $params
+ *
+ * @param bool $add_action_nonce
+ *
+ * @return string
+ */
+ function get_account_url( $action = false, $params = array(), $add_action_nonce = true ) {
+ if ( is_string( $action ) ) {
+ $params['fs_action'] = $action;
+ }
+
+ self::require_pluggable_essentials();
+
+ return ( $add_action_nonce && is_string( $action ) ) ?
+ fs_nonce_url( $this->_get_admin_page_url( 'account', $params ), $action ) :
+ $this->_get_admin_page_url( 'account', $params );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.0
+ *
+ * @param string $tab
+ * @param bool $action
+ * @param array $params
+ * @param bool $add_action_nonce
+ *
+ * @return string
+ *
+ * @uses get_account_url()
+ */
+ function get_account_tab_url( $tab, $action = false, $params = array(), $add_action_nonce = true ) {
+ $params['tab'] = $tab;
+
+ return $this->get_account_url( $action, $params, $add_action_nonce );
+ }
+
+ /**
+ * Plugin's account URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.4
+ *
+ * @param bool|string $topic
+ * @param bool|string $message
+ * @param bool|string $summary Since 2.5.1.
+ *
+ * @return string
+ */
+ function contact_url( $topic = false, $message = false, $summary = false ) {
+ $params = array();
+ if ( is_string( $topic ) ) {
+ $params['topic'] = $topic;
+ }
+ if ( is_string( $message ) ) {
+ $params['message'] = $message;
+ }
+
+ if ( is_string( $summary ) ) {
+ $params['summary'] = $summary;
+ }
+
+ if ( $this->is_addon() ) {
+ $params['addon_id'] = $this->get_id();
+
+ return $this->get_parent_instance()->_get_admin_page_url( 'contact', $params );
+ } else {
+ return $this->_get_admin_page_url( 'contact', $params );
+ }
+ }
+
+ /**
+ * Add-on direct info URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.0
+ *
+ * @param string $slug
+ *
+ * @return string
+ */
+ function addon_url( $slug ) {
+ return $this->_get_admin_page_url( 'addons', array(
+ 'slug' => $slug
+ ) );
+ }
+
+ /**
+ * Add-ons URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.4.5
+ *
+ * @return string
+ */
+ function get_addons_url() {
+ return $this->_get_admin_page_url( 'addons' );
+ }
+
+ /* Logger
+ ------------------------------------------------------------------------------------------------------------------*/
+ /**
+ * @param string $id
+ * @param bool $prefix_slug
+ *
+ * @return FS_Logger
+ */
+ function get_logger( $id = '', $prefix_slug = true ) {
+ return FS_Logger::get_logger( ( $prefix_slug ? $this->_slug : '' ) . ( ( ! $prefix_slug || empty( $id ) ) ? '' : '_' ) . $id );
+ }
+
+ /**
+ * Note: This method is used externally so don't delete it.
+ *
+ * @param $id
+ * @param bool $load_options
+ * @param bool $prefix_slug
+ *
+ * @return FS_Option_Manager
+ */
+ function get_options_manager( $id, $load_options = false, $prefix_slug = true ) {
+ return FS_Option_Manager::get_manager( ( $prefix_slug ? $this->_slug : '' ) . ( ( ! $prefix_slug || empty( $id ) ) ? '' : '_' ) . $id, $load_options );
+ }
+
+ /* Security
+ ------------------------------------------------------------------------------------------------------------------*/
+ private static function _encrypt( $str ) {
+ if ( is_null( $str ) ) {
+ return null;
+ }
+
+ /**
+ * The encrypt/decrypt functions are used to protect
+ * the user from messing up with some of the sensitive
+ * data stored for the module as a JSON in the database.
+ *
+ * I used the same suggested hack by the theme review team.
+ * For more details, look at the function `Base64UrlDecode()`
+ * in `./sdk/FreemiusBase.php`.
+ *
+ * @todo Remove this hack once the base64 error is removed from the Theme Check.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2
+ */
+ $fn = 'base64' . '_encode';
+
+ return $fn( $str );
+ }
+
+ static function _decrypt( $str ) {
+ if ( is_null( $str ) ) {
+ return null;
+ }
+
+ /**
+ * The encrypt/decrypt functions are used to protect
+ * the user from messing up with some of the sensitive
+ * data stored for the module as a JSON in the database.
+ *
+ * I used the same suggested hack by the theme review team.
+ * For more details, look at the function `Base64UrlDecode()`
+ * in `./sdk/FreemiusBase.php`.
+ *
+ * @todo Remove this hack once the base64 error is removed from the Theme Check.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2
+ */
+ $fn = 'base64' . '_decode';
+
+ return $fn( $str );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @param FS_Entity $entity
+ *
+ * @return FS_Entity Return an encrypted clone entity.
+ */
+ private static function _encrypt_entity( FS_Entity $entity ) {
+ $clone = clone $entity;
+ $props = get_object_vars( $entity );
+
+ foreach ( $props as $key => $val ) {
+ $clone->{$key} = self::_encrypt( $val );
+ }
+
+ return $clone;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @param FS_Entity $entity
+ *
+ * @return FS_Entity Return an decrypted clone entity.
+ */
+ private static function decrypt_entity( FS_Entity $entity ) {
+ $clone = clone $entity;
+ $props = get_object_vars( $entity );
+
+ foreach ( $props as $key => $val ) {
+ $clone->{$key} = self::_decrypt( $val );
+ }
+
+ return $clone;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.7
+ *
+ * @param string $email
+ *
+ * @return FS_User|false
+ */
+ public static function _get_user_by_email( $email ) {
+ self::$_static_logger->entrance();
+
+ $email = trim( strtolower( $email ) );
+
+ $users = self::get_all_users();
+
+ if ( is_array( $users ) ) {
+ foreach ( $users as $user ) {
+ if ( $email === trim( strtolower( $user->email ) ) ) {
+ return $user;
+ }
+ }
+ }
+
+ return false;
+ }
+
+ #----------------------------------------------------------------------------------
+ #region Account (Loading, Updates & Activation)
+ #----------------------------------------------------------------------------------
+
+ /***
+ * Load account information (user + site).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ */
+ private function _load_account() {
+ $this->_logger->entrance();
+
+ $this->do_action( 'before_account_load' );
+
+ $users = self::get_all_users();
+ $plans = self::get_all_plans( $this->_module_type );
+
+ if ( $this->_logger->is_on() && is_admin() ) {
+ $this->_logger->log( 'users = ' . var_export( $users, true ) );
+ $this->_logger->log( 'plans = ' . var_export( $plans, true ) );
+ }
+
+ $site = fs_is_network_admin() ?
+ $this->get_network_install() :
+ $this->get_install_by_blog_id();
+
+ if ( fs_is_network_admin() &&
+ $this->is_network_active() &&
+ ! is_object( $site ) &&
+ FS_Site::is_valid_id( $this->_storage->network_install_blog_id )
+ ) {
+ $first_install = $this->find_first_install();
+
+ if ( is_null( $first_install ) ) {
+ unset( $this->_storage->network_install_blog_id );
+ } else {
+ $site = $first_install['install'];
+ $this->_storage->network_install_blog_id = $first_install['blog_id'];
+ }
+ }
+
+ if ( is_object( $site ) &&
+ is_numeric( $site->id ) &&
+ is_numeric( $site->user_id ) &&
+ FS_Plugin_Plan::is_valid_id( $site->plan_id )
+ ) {
+ // Load site.
+ $this->_site = $site;
+ }
+
+ $user = null;
+ if ( fs_is_network_admin() && $this->_is_network_active ) {
+ $user = $this->get_network_user();
+ }
+
+ if ( is_object( $user ) ) {
+ $this->_user = clone $user;
+ } else if ( $this->_site ) {
+ $user = self::_get_user_by_id( $this->_site->user_id );
+
+ if ( ! is_object( $user ) && FS_User::is_valid_id( $this->_storage->prev_user_id ) ) {
+ /**
+ * Try to load the previous owner. This recovery is used for the following use-case:
+ * 1. Opt-in
+ * 2. Cloning site1 to site2
+ * 3. Ownership switch in site1 (same applies for site2)
+ * 4. Install data sync on site2
+ * 5. Now site2's install is associated with the new owner which does not exists locally.
+ */
+ $user = self::_get_user_by_id( $this->_storage->prev_user_id );
+ }
+
+ if ( ! is_object( $user ) ) {
+ /**
+ * This is a special fault tolerance mechanism to handle a scenario that the user data is missing.
+ */
+ if (
+ ! isset( $this->_storage->user_recovery_from_install_last_attempt_timestamp ) ||
+ time() > ( $this->_storage->user_recovery_from_install_last_attempt_timestamp + FS_Clone_Manager::CLONE_RESOLUTION_MAX_EXECUTION_TIME )
+ ) {
+ $user = $this->sync_user_by_current_install();
+ } else {
+ return;
+ }
+
+ if ( is_object( $user ) ) {
+ $this->_storage->user_was_recovered_from_install = true;
+ } else {
+ $this->_storage->user_recovery_from_install_attempts = isset( $this->_storage->user_recovery_from_install_attempts ) ?
+ ( $this->_storage->user_recovery_from_install_attempts + 1 ) :
+ 1;
+
+ if ( $this->_storage->user_recovery_from_install_attempts >= 3 ) {
+ $this->delete_current_install( false );
+ } else {
+ $this->_storage->user_recovery_from_install_last_attempt_timestamp = time();
+
+ return;
+ }
+ }
+ }
+
+ $this->_user = ( $user instanceof FS_User ) ?
+ clone $user :
+ null;
+ }
+
+ if ( is_object( $this->_user ) ) {
+ // Load licenses.
+ $this->_licenses = $this->get_user_licenses( $this->_user->id );
+ }
+
+ if ( is_object( $this->_site ) ) {
+ // Load plans.
+ $this->_plans = isset( $plans[ $this->_slug ] ) ?
+ $plans[ $this->_slug ] :
+ array();
+
+ if ( ! is_array( $this->_plans ) || empty( $this->_plans ) ) {
+ $this->_sync_plans();
+ } else {
+ for ( $i = 0, $len = count( $this->_plans ); $i < $len; $i ++ ) {
+ if ( $this->_plans[ $i ] instanceof FS_Plugin_Plan ) {
+ $this->_plans[ $i ] = self::decrypt_entity( $this->_plans[ $i ] );
+ } else {
+ unset( $this->_plans[ $i ] );
+ }
+ }
+ }
+
+ $this->_license = $this->_get_license_by_id( $this->_site->license_id );
+
+ if ( $this->_site->version != $this->get_plugin_version() ) {
+ // If stored install version is different than current installed plugin version,
+ // then update plugin version event.
+ $this->update_plugin_version_event();
+ }
+ }
+
+ if ( true === $this->_storage->require_license_activation &&
+ ! fs_request_get_bool( 'require_license', true )
+ ) {
+ $this->_storage->require_license_activation = false;
+ }
+
+ if ( $this->is_theme() ) {
+ $this->_register_account_hooks();
+ }
+
+ if ( $this->is_user_in_admin() && $this->is_clone() ) {
+ if ( empty( FS_Clone_Manager::instance()->get_clone_identification_timestamp() ) ) {
+ FS_Clone_Manager::instance()->store_clone_identification_timestamp();
+ }
+
+ FS_Clone_Manager::instance()->maybe_update_clone_resolution_support_flag( $this->_storage->sdk_last_version );
+ $this->send_pending_clone_update_once();
+ }
+ }
+
+ /**
+ * Special user recovery mechanism.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param number|null $site_user_id
+ *
+ * @return \FS_User|mixed
+ */
+ private function sync_user_by_current_install( $site_user_id = null ) {
+ $site_user_id = FS_Site::is_valid_id( $site_user_id ) ?
+ $site_user_id :
+ $this->_site->user_id;
+
+ $api = $this->get_api_site_scope();
+
+ $uid = $this->get_anonymous_id();
+ $request_path = "/users/{$site_user_id}.json?uid={$uid}";
+
+ $result = $api->get( $request_path, false, WP_FS__TIME_10_MIN_IN_SEC );
+
+ if ( $this->is_api_result_entity( $result ) ) {
+ $user = new FS_User( $result );
+ $this->_user = $user;
+ $this->_store_user();
+
+ return $user;
+ }
+
+ $error_code = FS_Api::get_error_code( $result );
+
+ if ( in_array( $error_code, array( 'invalid_unique_id', 'user_cannot_be_recovered' ) ) ) {
+ /**
+ * Those API errors will continue coming and are not recoverable with the
+ * current site's data. Therefore, extend the API call's cached result to 7 days.
+ */
+ $api->update_cache_expiration( $request_path, WP_FS__TIME_WEEK_IN_SEC );
+ }
+
+ return $result;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ *
+ * @param FS_User $user
+ * @param FS_Site $site
+ * @param bool|array $plans
+ */
+ private function _set_account( FS_User $user, FS_Site $site, $plans = false ) {
+ $site->user_id = $user->id;
+
+ $this->_site = $site;
+ $this->_user = $user;
+ if ( false !== $plans ) {
+ $this->_plans = $plans;
+ }
+
+ $this->send_install_update();
+
+ $this->_store_account();
+
+ }
+
+ /**
+ * Get a sanitized array with the WordPress version, SDK version, and PHP version.
+ * Each version is trimmed after the 16th char.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.2.1
+ *
+ * @return array
+ */
+ private function get_versions() {
+ $versions = array();
+ $versions['sdk_version'] = $this->version;
+
+ // Collect these diagnostic information only if it's allowed.
+ if ( FS_Permission_Manager::instance( $this )->is_diagnostic_tracking_allowed() ) {
+ $versions['platform_version'] = get_bloginfo( 'version' );
+ $versions['programming_language_version'] = phpversion();
+ }
+
+ foreach ( $versions as $k => $version ) {
+ $versions[ $k ] = self::get_api_sanitized_property( $k, $version );
+ }
+
+ return $versions;
+ }
+
+ /**
+ * Get sanitized site language.
+ *
+ * @param string $language
+ * @param int $max_len
+ *
+ * @since 2.5.1
+ * @author Vova Feldman (@svovaf)
+ *
+ * @return string
+ */
+ private static function get_sanitized_language( $language = '', $max_len = self::LANGUAGE_MAX_CHARS ) {
+ if ( empty( $language ) ) {
+ $language = get_bloginfo( 'language' );
+ }
+
+ return substr( $language, 0, $max_len );
+ }
+
+ /**
+ * Get core version stripped from pre-release and build.
+ *
+ * @since 2.5.1
+ * @author Vova Feldman (@svovaf)
+ *
+ * @param string $version
+ * @param int $parts
+ * @param int $max_len
+ * @param bool $include_pre_release
+ *
+ * @return string
+ */
+ private static function get_core_version(
+ $version,
+ $parts = 3,
+ $max_len = self::VERSION_MAX_CHARS,
+ $include_pre_release = false
+ ) {
+ if ( empty( $version ) ) {
+ // Version is empty.
+ return '';
+ }
+
+ if ( is_numeric( $version ) ) {
+ $is_float_version = is_float( $version );
+
+ $version = (string) $version;
+
+ /**
+ * Casting a whole float number to a string cuts the decimal point. This part make sure to add the missing decimal part to the version.
+ */
+ if ( $is_float_version && false === strpos( $version, '.' ) ) {
+ $version .= '.0';
+ }
+ }
+
+ if ( ! is_string( $version ) ) {
+ return '';
+ }
+
+ if ( $parts < 1 ) {
+ return '';
+ }
+
+ $pre_release_regex = $include_pre_release ?
+ '(\-(alpha|beta|RC)([0-9]+)?)?' :
+ '';
+
+ if ( 0 === preg_match( '/^([0-9]+(\.[0-9]+){0,' . ( $parts - 1 ) . '}' . $pre_release_regex . ')/i', $version, $matches ) ) {
+ // Version is not starting with a digit.
+ return '';
+ }
+
+ return substr( $matches[1], 0, $max_len );
+ }
+
+ /**
+ * @param string $prop
+ * @param mixed $val
+ *
+ * @return mixed
+ *@author Vova Feldman (@svovaf)
+ *
+ * @since 2.5.1
+ */
+ private static function get_api_sanitized_property( $prop, $val ) {
+ if ( ! is_string( $val ) || empty( $val ) ) {
+ return $val;
+ }
+
+ switch ( $prop ) {
+ case 'programming_language_version':
+ // Get core PHP version, which can have up to 3 parts (ignore pre-releases).
+ return self::get_core_version( $val );
+ case 'platform_version':
+ // Get the exact WordPress version, which can have up to 3 parts (including pre-releases).
+ return self::get_core_version( $val, 3, self::VERSION_MAX_CHARS, true );
+ case 'sdk_version':
+ // Get the exact SDK version, which can have up to 4 parts.
+ return self::get_core_version( $val, 4 );
+ case 'version':
+ // Get the entire version but just limited in length.
+ return substr( $val, 0, self::VERSION_MAX_CHARS );
+ case 'language':
+ return self::get_sanitized_language( $val );
+ default:
+ return $val;
+ }
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.0
+ *
+ * @return bool
+ */
+ function has_beta_update() {
+ return (
+ ! empty( $this->_storage->beta_data ) &&
+ ( true === $this->_storage->beta_data['is_beta'] ) &&
+ version_compare( $this->_storage->beta_data['version'], $this->get_plugin_version(), '>' )
+ );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.0
+ *
+ * @return bool
+ */
+ function is_beta() {
+ return (
+ ! empty( $this->_storage->beta_data ) &&
+ ( true === $this->_storage->beta_data['is_beta'] ) &&
+ ( $this->get_plugin_version() === $this->_storage->beta_data['version'] )
+ );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.7.4
+ *
+ * @param array $override_with
+ * @param bool|int|null $network_level_or_blog_id If true, return params for network level opt-in. If integer, get params for specified blog in the network.
+ *
+ * @return array
+ */
+ function get_opt_in_params( $override_with = array(), $network_level_or_blog_id = null ) {
+ $this->_logger->entrance();
+
+ $current_user = self::_get_current_wp_user();
+
+ $activation_action = $this->get_unique_affix() . '_activate_new';
+ $return_url = $this->is_anonymous() ?
+ // If skipped already, then return to the account page.
+ $this->get_account_url( $activation_action, array(), false ) :
+ // Return to the module's main page.
+ $this->get_after_activation_url( 'after_connect_url', array( 'fs_action' => $activation_action ) );
+
+ $versions = $this->get_versions();
+
+ $params = array_merge( $versions, array(
+ 'user_firstname' => $current_user->user_firstname,
+ 'user_lastname' => $current_user->user_lastname,
+ 'user_email' => $current_user->user_email,
+ 'plugin_slug' => $this->_slug,
+ 'plugin_id' => $this->get_id(),
+ 'plugin_public_key' => $this->get_public_key(),
+ 'plugin_version' => $this->get_plugin_version(),
+ 'return_url' => fs_nonce_url( $return_url, $activation_action ),
+ 'account_url' => fs_nonce_url( $this->_get_admin_page_url(
+ 'account',
+ array( 'fs_action' => 'sync_user' )
+ ), 'sync_user' ),
+ 'is_premium' => $this->is_premium(),
+ 'is_active' => true,
+ 'is_uninstalled' => false,
+ 'is_localhost' => WP_FS__IS_LOCALHOST,
+ ) );
+
+ if ( $this->is_addon() ) {
+ $parent_fs = $this->get_parent_instance();
+
+ $params['parent_plugin_slug'] = $parent_fs->_slug;
+ $params['parent_plugin_id'] = $parent_fs->get_id();
+ }
+
+ if ( true === $network_level_or_blog_id ) {
+ if ( ! isset( $override_with['sites'] ) ) {
+ $params['sites'] = $this->get_sites_for_network_level_optin();
+ }
+ } else {
+ $site = is_numeric( $network_level_or_blog_id ) ?
+ array( 'blog_id' => $network_level_or_blog_id ) :
+ null;
+
+ $site = $this->get_site_info( $site );
+
+ $diagnostic_info = array();
+ if ( FS_Permission_Manager::instance( $this )->is_diagnostic_tracking_allowed() ) {
+ $diagnostic_info = array(
+ 'site_name' => $site['title'],
+ 'language' => self::get_sanitized_language( $site['language'] ),
+ );
+ }
+
+ $params = array_merge( $params, $diagnostic_info, array(
+ 'site_uid' => $site['uid'],
+ 'site_url' => $site['url'],
+ ) );
+ }
+
+ if ( $this->is_pending_activation() &&
+ ! empty( $this->_storage->pending_license_key )
+ ) {
+ $params['license_key'] = $this->_storage->pending_license_key;
+ }
+
+ if ( WP_FS__SKIP_EMAIL_ACTIVATION && $this->has_secret_key() ) {
+ // Even though rand() is known for its security issues,
+ // the timestamp adds another layer of protection.
+ // It would be very hard for an attacker to get the secret key form here.
+ // Plus, this should never run in production since the secret should never
+ // be included in the production version.
+ $params['ts'] = WP_FS__SCRIPT_START_TIME;
+ $params['salt'] = md5( uniqid( rand() ) );
+ $params['secure'] = md5(
+ $params['ts'] .
+ $params['salt'] .
+ $this->get_secret_key()
+ );
+ }
+
+ if ( is_multisite() && function_exists( 'get_network' ) ) {
+ $params['network_uid'] = $this->get_anonymous_network_id();
+ }
+
+ return array_merge( $params, $override_with );
+ }
+
+ /**
+ * 1. If successful opt-in or pending activation returns the next page that the user should be redirected to.
+ * 2. If there was an API error, return the API result.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.7.4
+ *
+ * @param string|bool $email
+ * @param string|bool $first
+ * @param string|bool $last
+ * @param string|bool $license_key
+ * @param bool $is_uninstall If "true", this means that the module is currently being uninstalled.
+ * In this case, the user and site info will be sent to the server but no
+ * data will be saved to the WP installation's database.
+ * @param number|bool $trial_plan_id
+ * @param bool $is_disconnected Whether to opt in without tracking.
+ * @param null|bool $is_marketing_allowed
+ * @param array $sites If network-level opt-in, an array of containing details of sites.
+ * @param bool $redirect
+ *
+ * @return string|object
+ * @use WP_Error
+ */
+ function opt_in(
+ $email = false,
+ $first = false,
+ $last = false,
+ $license_key = false,
+ $is_uninstall = false,
+ $trial_plan_id = false,
+ $is_disconnected = false,
+ $is_marketing_allowed = null,
+ $sites = array(),
+ $redirect = true
+ ) {
+ $this->_logger->entrance();
+
+ if ( false === $email ) {
+ $current_user = self::_get_current_wp_user();
+ $email = $current_user->user_email;
+ }
+
+ /**
+ * @since 1.2.1 If activating with license key, ignore the context-user
+ * since the user will be automatically loaded from the license.
+ */
+ if ( empty( $license_key ) ) {
+ // Clean up pending license if opt-ing in again.
+ $this->_storage->remove( 'pending_license_key' );
+
+ if ( ! $is_uninstall ) {
+ $fs_user = Freemius::_get_user_by_email( $email );
+ if ( is_object( $fs_user ) && ! $this->is_pending_activation() ) {
+ return $this->install_with_user(
+ $fs_user,
+ false,
+ $trial_plan_id,
+ $redirect,
+ true,
+ $sites
+ );
+ }
+ }
+ }
+
+ $user_info = array();
+ if ( ! empty( $email ) ) {
+ $user_info['user_email'] = $email;
+ }
+ if ( ! empty( $first ) ) {
+ $user_info['user_firstname'] = $first;
+ }
+ if ( ! empty( $last ) ) {
+ $user_info['user_lastname'] = $last;
+ }
+
+ if ( ! empty( $sites ) ) {
+ $is_network = true;
+
+ $user_info['sites'] = $sites;
+ } else {
+ $is_network = false;
+ }
+
+ $params = $this->get_opt_in_params( $user_info, $is_network );
+
+ $filtered_license_key = false;
+ if ( is_string( $license_key ) ) {
+ $filtered_license_key = $this->apply_filters( 'license_key', $license_key );
+ $params['license_key'] = $filtered_license_key;
+ } else if ( FS_Plugin_Plan::is_valid_id( $trial_plan_id ) ) {
+ $params['trial_plan_id'] = $trial_plan_id;
+ }
+
+ if ( $is_uninstall ) {
+ $params['uninstall_params'] = array(
+ 'reason_id' => $this->_storage->uninstall_reason->id,
+ 'reason_info' => $this->_storage->uninstall_reason->info
+ );
+ }
+
+ if ( isset( $params['license_key'] ) ) {
+ $fs_user = Freemius::_get_user_by_email( $email );
+
+ if ( is_object( $fs_user ) ) {
+ /**
+ * If opting in with a context license and the context WP Admin user already opted in
+ * before from the current site, add the user context security params to avoid the
+ * unnecessary email activation when the context license is owned by the same context user.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 1.2.3
+ */
+ $params = array_merge( $params, FS_Security::instance()->get_context_params(
+ $fs_user,
+ false,
+ 'install_with_existing_user'
+ ) );
+ }
+ }
+
+ if ( is_bool( $is_marketing_allowed ) ) {
+ $params['is_marketing_allowed'] = $is_marketing_allowed;
+ }
+
+ $params['is_disconnected'] = $is_disconnected;
+ $params['format'] = 'json';
+ $params['is_extensions_tracking_allowed'] = FS_Permission_Manager::instance( $this )->is_extensions_tracking_allowed();
+ $params['is_diagnostic_tracking_allowed'] = FS_Permission_Manager::instance( $this )->is_diagnostic_tracking_allowed();
+
+ $request = array(
+ 'method' => 'POST',
+ 'body' => $params,
+ 'timeout' => 60,
+ );
+
+ $url = $this->add_show_pending( WP_FS__ADDRESS . '/action/service/user/install/' );
+ $response = self::safe_remote_post( $url, $request );
+
+ if ( is_wp_error( $response ) ) {
+ /**
+ * @var WP_Error $response
+ */
+ $result = new stdClass();
+
+ $error_code = $response->get_error_code();
+ $error_type = str_replace( ' ', '', ucwords( str_replace( '_', ' ', $error_code ) ) );
+
+ $result->error = (object) array(
+ 'type' => $error_type,
+ 'message' => $response->get_error_message(),
+ 'code' => $error_code,
+ 'http' => 402
+ );
+
+ $this->maybe_modify_api_curl_error_message( $result );
+
+ if ( FS_Api::is_blocked( $result ) ) {
+ $result->error->message = $this->generate_api_blocked_notice_message_from_result( $result );
+ }
+
+ $is_connected = null;
+
+ if ( empty( $license_key ) && $this->is_enable_anonymous() ) {
+ $this->skip_connection( fs_is_network_admin() );
+
+ $is_connected = ( ! FS_Api::is_blocked( $result ) );
+ }
+
+ $this->update_connectivity_info( $is_connected );
+
+ return $result;
+ }
+
+ $this->update_connectivity_info( true );
+
+ // Module is being uninstalled, don't handle the returned data.
+ if ( $is_uninstall ) {
+ return true;
+ }
+
+ /**
+ * When json_decode() executed on PHP 5.2 with an invalid JSON, it will throw a PHP warning. Unfortunately, the new Theme Check doesn't allow PHP silencing and the theme review team isn't open to change that, therefore, instead of using `@json_decode()` we had to use the method without the `@` directive.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.3
+ * @link https://themes.trac.wordpress.org/ticket/46134#comment:5
+ * @link https://themes.trac.wordpress.org/ticket/46134#comment:9
+ * @link https://themes.trac.wordpress.org/ticket/46134#comment:12
+ * @link https://themes.trac.wordpress.org/ticket/46134#comment:14
+ */
+ $decoded = is_string( $response['body'] ) ?
+ json_decode( $response['body'] ) :
+ null;
+
+ if ( empty( $decoded ) ) {
+ return false;
+ }
+
+ if ( ! $this->is_api_result_object( $decoded ) ) {
+ if ( ! empty( $params['license_key'] ) ) {
+ // Pass the fully entered license key to the failure handler.
+ $params['license_key'] = $license_key;
+ }
+
+ return $is_uninstall ?
+ $decoded :
+ $this->apply_filters( 'after_install_failure', $decoded, $params );
+ } else if ( isset( $decoded->pending_activation ) && $decoded->pending_activation ) {
+ if ( $is_network ) {
+ $site_ids = array();
+ foreach ( $sites as $site ) {
+ $site_ids[] = $site['blog_id'];
+ }
+
+ /**
+ * Store the sites so that they can be installed once the user has clicked on the activation link
+ * in the email.
+ *
+ * @author Leo Fajardo (@leorw)
+ */
+ $this->_storage->pending_sites_info = array(
+ 'blog_ids' => $site_ids,
+ 'license_key' => $license_key,
+ 'trial_plan_id' => $trial_plan_id
+ );
+ }
+
+ // Pending activation, add message.
+ return $this->set_pending_confirmation(
+ ( isset( $decoded->email ) ?
+ $decoded->email :
+ true ),
+ false,
+ $filtered_license_key,
+ ! empty( $params['trial_plan_id'] ),
+ isset( $decoded->is_suspicious_email ) && $decoded->is_suspicious_email
+ );
+ } else if ( isset( $decoded->install_secret_key ) ) {
+ return $this->install_with_new_user(
+ $decoded->user_id,
+ $decoded->user_public_key,
+ $decoded->user_secret_key,
+ ( isset( $decoded->is_marketing_allowed ) && ! is_null( $decoded->is_marketing_allowed ) ?
+ $decoded->is_marketing_allowed :
+ null ),
+ ( isset( $decoded->is_extensions_tracking_allowed ) && ! is_null( $decoded->is_extensions_tracking_allowed ) ?
+ $decoded->is_extensions_tracking_allowed :
+ null ),
+ ( isset( $decoded->is_diagnostic_tracking_allowed ) && ! is_null( $decoded->is_diagnostic_tracking_allowed ) ?
+ $decoded->is_diagnostic_tracking_allowed :
+ null ),
+ $decoded->install_id,
+ $decoded->install_public_key,
+ $decoded->install_secret_key,
+ false
+ );
+ } else if ( is_array( $decoded->installs ) ) {
+ return $this->install_many_with_new_user(
+ $decoded->user_id,
+ $decoded->user_public_key,
+ $decoded->user_secret_key,
+ ( isset( $decoded->is_marketing_allowed ) && ! is_null( $decoded->is_marketing_allowed ) ?
+ $decoded->is_marketing_allowed :
+ null ),
+ ( isset( $decoded->is_extensions_tracking_allowed ) && ! is_null( $decoded->is_extensions_tracking_allowed ) ?
+ $decoded->is_extensions_tracking_allowed :
+ null ),
+ ( isset( $decoded->is_diagnostic_tracking_allowed ) && ! is_null( $decoded->is_diagnostic_tracking_allowed ) ?
+ $decoded->is_diagnostic_tracking_allowed :
+ null ),
+ $decoded->installs,
+ false
+ );
+ }
+
+ return $decoded;
+ }
+
+ /**
+ * Set user and site identities.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @param FS_User $user
+ * @param FS_Site $site
+ * @param bool $redirect
+ * @param bool $auto_install Since 1.2.1.7 If `true` and setting up an account with a valid license, will
+ * redirect (or return a URL) to the account page with a special parameter to
+ * trigger the auto installation processes.
+ *
+ * @return string If redirect is `false`, returns the next page the user should be redirected to.
+ */
+ function setup_account(
+ FS_User $user,
+ FS_Site $site,
+ $redirect = true,
+ $auto_install = false
+ ) {
+ return $this->setup_network_account(
+ $user,
+ array( $site ),
+ $redirect,
+ $auto_install,
+ false
+ );
+ }
+
+ /**
+ * Set user and site identities.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param FS_User $user
+ * @param FS_Site[] $installs
+ * @param bool $redirect
+ * @param bool $auto_install Since 1.2.1.7 If `true` and setting up an account with a valid license, will redirect (or return a URL) to the account page with a special parameter to trigger the auto installation processes.
+ * @param bool $is_network_level_opt_in
+ *
+ * @return string If redirect is `false`, returns the next page the user should be redirected to.
+ */
+ function setup_network_account(
+ FS_User $user,
+ array $installs,
+ $redirect = true,
+ $auto_install = false,
+ $is_network_level_opt_in = true
+ ) {
+ $first_install = $installs[0];
+
+ $this->_user = $user;
+ $this->_site = $first_install;
+
+ $this->_sync_plans();
+
+ if ( $this->_storage->handle_gdpr_admin_notice &&
+ $this->should_handle_gdpr_admin_notice() &&
+ FS_GDPR_Manager::instance()->should_show_opt_in_notice()
+ ) {
+ /**
+ * Clear user lock after an opt-in.
+ */
+ require_once WP_FS__DIR_INCLUDES . '/class-fs-user-lock.php';
+ FS_User_Lock::instance()->unlock();
+ }
+
+ if ( 1 < count( $installs ) ) {
+ // Only network level opt-in can have more than one install.
+ $is_network_level_opt_in = true;
+ }
+
+ $this->update_connectivity_info( true );
+
+// $is_network_level_opt_in = self::is_ajax_action_static( 'network_activate', $this->_module_id );
+ // If Freemius was OFF before, turn it on.
+ $this->turn_on();
+
+ $this->handle_account_connection(
+ $installs,
+ ( ! $this->_is_network_active || ! $is_network_level_opt_in )
+ );
+
+ if ( is_numeric( $first_install->license_id ) ) {
+ $this->set_license( $this->_get_license_by_id( $first_install->license_id ) );
+ }
+
+ $this->_admin_notices->remove_sticky( 'connect_account' );
+
+ if ( $this->is_pending_activation() || ! $this->has_settings_menu() ) {
+ $this->clear_pending_activation_mode();
+
+ if ( ! $this->is_paying_or_trial() ) {
+ $this->_admin_notices->add_sticky(
+ sprintf( $this->get_text_inline( '%s opt-in was successfully completed.', 'plugin-x-activation-message' ), '' . $this->get_plugin_name() . ' ' ),
+ 'activation_complete'
+ );
+ }
+ }
+
+ if ( $this->is_paying_or_trial() ) {
+ if ( ! $this->is_premium() ||
+ ! $this->has_premium_version() ||
+ ! $this->has_settings_menu()
+ ) {
+ if ( $this->is_paying() ) {
+ $this->add_complete_upgrade_instructions_notice(
+ sprintf(
+ $this->get_text_inline( 'Your account was successfully activated with the %s plan.', 'activation-with-plan-x-message' ),
+ $this->get_plan_title()
+ ),
+ 'plan_upgraded'
+ );
+ } else {
+ $trial_plan = $this->get_trial_plan();
+
+ $this->add_complete_upgrade_instructions_notice(
+ sprintf(
+ $this->get_text_inline( 'Your trial has been successfully started.', 'trial-started-message' ),
+ '' . $this->get_plugin_name() . ' '
+ ),
+ 'trial_started',
+ $trial_plan->title
+ );
+ }
+ }
+
+ $this->_admin_notices->remove_sticky( array(
+ 'trial_promotion',
+ ) );
+ }
+
+ $plugin_id = fs_request_get( 'plugin_id', false );
+
+ // Store activation time ONLY for plugins & themes (not add-ons).
+ if ( ! is_numeric( $plugin_id ) || ( $plugin_id == $this->_plugin->id ) ) {
+ if ( empty( $this->_storage->activation_timestamp ) ) {
+ $this->_storage->activation_timestamp = WP_FS__SCRIPT_START_TIME;
+ }
+ }
+
+ $next_page = '';
+
+ $extra = array();
+ if ( $auto_install ) {
+ $extra['auto_install'] = 'true';
+ }
+
+ if ( is_numeric( $plugin_id ) ) {
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 1.2.1.6
+ *
+ * Also sync the license after an anonymous user subscribes.
+ */
+ if ( $this->is_anonymous() || $plugin_id != $this->_plugin->id ) {
+ // Add-on was installed - sync license right after install.
+ $next_page = $this->_get_sync_license_url( $plugin_id, true, $extra );
+ }
+ } else {
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.9 If site installed with a valid license, sync license.
+ */
+ if ( $this->is_paying() ) {
+ $this->_sync_plugin_license(
+ true,
+ // Installs data is already synced in the beginning of this method directly or via _set_account().
+ false
+ );
+ }
+
+ // Reload the page with the keys.
+ $next_page = $this->is_anonymous() ?
+ // If user previously skipped, redirect to account page.
+ $this->get_account_url( false, $extra ) :
+ $this->get_after_activation_url( 'after_connect_url', array(), $is_network_level_opt_in );
+ }
+
+ if ( ! empty( $next_page ) && $redirect ) {
+ fs_redirect( $next_page );
+ }
+
+ return $next_page;
+ }
+
+ /**
+ * Install plugin with new user information after approval.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.7
+ */
+ function _install_with_new_user() {
+ $this->_logger->entrance();
+
+ if ( $this->is_registered() ) {
+ return;
+ }
+
+ $has_pending_activation_confirmation_param = fs_request_has( 'pending_activation' );
+
+ $this->update_license_required_permissions_if_anonymous();
+
+ if ( ( $this->is_plugin() && fs_request_is_action( $this->get_unique_affix() . '_activate_new' ) ) ||
+ // @todo This logic should be improved because it's executed on every load of a theme.
+ $this->is_theme()
+ ) {
+// check_admin_referer( $this->_slug . '_activate_new' );
+
+ if ( fs_request_has( 'user_secret_key' ) ) {
+ if ( fs_is_network_admin() && isset( $this->_storage->pending_sites_info ) ) {
+ $pending_sites_info = $this->_storage->pending_sites_info;
+
+ $this->install_many_pending_with_user(
+ fs_request_get( 'user_id' ),
+ fs_request_get_raw( 'user_public_key' ),
+ fs_request_get_raw( 'user_secret_key' ),
+ fs_request_get_bool( 'is_marketing_allowed', null ),
+ fs_request_get_bool( 'is_extensions_tracking_allowed', null ),
+ fs_request_get_bool( 'is_diagnostic_tracking_allowed', null ),
+ $pending_sites_info['blog_ids'],
+ $pending_sites_info['license_key'],
+ $pending_sites_info['trial_plan_id']
+ );
+ } else {
+ $this->install_with_new_user(
+ fs_request_get( 'user_id' ),
+ fs_request_get_raw( 'user_public_key' ),
+ fs_request_get_raw( 'user_secret_key' ),
+ fs_request_get_bool( 'is_marketing_allowed', null ),
+ fs_request_get_bool( 'is_extensions_tracking_allowed', null ),
+ fs_request_get_bool( 'is_diagnostic_tracking_allowed', null ),
+ fs_request_get( 'install_id' ),
+ fs_request_get_raw( 'install_public_key' ),
+ fs_request_get_raw( 'install_secret_key' ),
+ true,
+ fs_request_get_bool( 'auto_install' )
+ );
+ }
+ } else if ( $has_pending_activation_confirmation_param ) {
+ $this->set_pending_confirmation(
+ fs_request_get( 'user_email' ),
+ true,
+ false,
+ false,
+ fs_request_get_bool( 'is_suspicious_email' ),
+ fs_request_get_bool( 'has_upgrade_context' ),
+ fs_request_get( 'support_email_address' )
+ );
+ }
+ }
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param number $id
+ * @param string $public_key
+ * @param string $secret_key
+ *
+ * @return \FS_User
+ */
+ private function setup_user( $id, $public_key, $secret_key ) {
+ $user = self::_get_user_by_id( $id );
+
+ if ( is_object( $user ) ) {
+ $this->_user = $user;
+ } else {
+ $user = new FS_User();
+ $user->id = $id;
+ $user->public_key = $public_key;
+ $user->secret_key = $secret_key;
+
+ $this->_user = $user;
+ $user_result = $this->get_api_user_scope()->get();
+ $user = new FS_User( $user_result );
+
+ $this->_user = $user;
+ $this->_store_user();
+ }
+
+ return $user;
+ }
+
+ /**
+ * Install plugin with new user.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.7.4
+ *
+ * @param number $user_id
+ * @param string $user_public_key
+ * @param string $user_secret_key
+ * @param bool|null $is_marketing_allowed
+ * @param bool|null $is_extensions_tracking_allowed Since 2.3.2
+ * @param bool|null $is_diagnostic_tracking_allowed Since 2.5.0.2
+ * @param number $install_id
+ * @param string $install_public_key
+ * @param string $install_secret_key
+ * @param bool $redirect
+ * @param bool $auto_install Since 1.2.1.7 If `true` and setting up an account with a valid license, will redirect (or return a URL) to the account page with a special parameter to trigger the auto installation processes.
+ *
+ * @return string If redirect is `false`, returns the next page the user should be redirected to.
+ */
+ private function install_with_new_user(
+ $user_id,
+ $user_public_key,
+ $user_secret_key,
+ $is_marketing_allowed,
+ $is_extensions_tracking_allowed,
+ $is_diagnostic_tracking_allowed,
+ $install_id,
+ $install_public_key,
+ $install_secret_key,
+ $redirect = true,
+ $auto_install = false
+ ) {
+ /**
+ * This method is also executed after opting in with a license key since the
+ * license can be potentially associated with a different owner.
+ *
+ * @since 2.0.0
+ */
+ $user = self::_get_user_by_id( $user_id );
+
+ if ( ! is_object( $user ) ) {
+ $user = new FS_User();
+ $user->id = $user_id;
+ $user->public_key = $user_public_key;
+ $user->secret_key = $user_secret_key;
+
+ $this->_user = $user;
+ $user_result = $this->get_api_user_scope()->get();
+ $user = new FS_User( $user_result );
+ }
+
+ $this->_user = $user;
+
+ $site = new FS_Site();
+ $site->id = $install_id;
+ $site->public_key = $install_public_key;
+ $site->secret_key = $install_secret_key;
+
+ $this->_site = $site;
+ $site_result = $this->get_api_site_scope( true )->get();
+ $site = new FS_Site( $site_result );
+ $this->_site = $site;
+
+ if ( ! is_null( $is_marketing_allowed ) ) {
+ $this->disable_opt_in_notice_and_lock_user();
+ }
+
+ FS_Permission_Manager::instance( $this )->update_permissions_tracking_flag( array(
+ FS_Permission_Manager::PERMISSION_DIAGNOSTIC => $is_diagnostic_tracking_allowed,
+ FS_Permission_Manager::PERMISSION_EXTENSIONS => $is_extensions_tracking_allowed,
+ ) );
+
+ return $this->setup_account(
+ $this->_user,
+ $this->_site,
+ $redirect,
+ $auto_install
+ );
+ }
+
+ /**
+ * Install plugin with user.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.0
+ *
+ * @param number $user_id
+ * @param string $user_public_key
+ * @param string $user_secret_key
+ * @param bool|null $is_marketing_allowed
+ * @param bool|null $is_extensions_tracking_allowed Since 2.3.2
+ * @param bool|null $is_diagnostic_tracking_allowed Since 2.5.0.2
+ * @param array $site_ids
+ * @param bool $license_key
+ * @param bool $trial_plan_id
+ * @param bool $redirect
+ *
+ * @return void
+ */
+ private function install_many_pending_with_user(
+ $user_id,
+ $user_public_key,
+ $user_secret_key,
+ $is_marketing_allowed,
+ $is_extensions_tracking_allowed,
+ $is_diagnostic_tracking_allowed,
+ $site_ids,
+ $license_key = false,
+ $trial_plan_id = false,
+ $redirect = true
+ ) {
+ $user = $this->setup_user( $user_id, $user_public_key, $user_secret_key );
+
+ if ( ! is_null( $is_marketing_allowed ) ) {
+ $this->disable_opt_in_notice_and_lock_user();
+ }
+
+ FS_Permission_Manager::instance( $this )->update_permissions_tracking_flag( array(
+ FS_Permission_Manager::PERMISSION_DIAGNOSTIC => $is_diagnostic_tracking_allowed,
+ FS_Permission_Manager::PERMISSION_EXTENSIONS => $is_extensions_tracking_allowed,
+ ) );
+
+ $sites = array();
+ foreach ( $site_ids as $site_id ) {
+ $sites[] = $this->get_site_info( array( 'blog_id' => $site_id ) );
+ }
+
+ $this->install_with_user( $user, $license_key, $trial_plan_id, $redirect, true, $sites );
+ }
+
+ /**
+ * Multi-site install with a new user.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param number $user_id
+ * @param string $user_public_key
+ * @param string $user_secret_key
+ * @param bool|null $is_marketing_allowed
+ * @param bool|null $is_extensions_tracking_allowed Since 2.3.2
+ * @param bool|null $is_diagnostic_tracking_allowed Since 2.5.0.2
+ * @param object[] $installs
+ * @param bool $redirect
+ * @param bool $auto_install Since 1.2.1.7 If `true` and setting up an account with a valid license, will redirect (or return a URL) to the account page with a special parameter to trigger the auto installation processes.
+ *
+ * @return string If redirect is `false`, returns the next page the user should be redirected to.
+ */
+ private function install_many_with_new_user(
+ $user_id,
+ $user_public_key,
+ $user_secret_key,
+ $is_marketing_allowed,
+ $is_extensions_tracking_allowed,
+ $is_diagnostic_tracking_allowed,
+ array $installs,
+ $redirect = true,
+ $auto_install = false
+ ) {
+ $this->setup_user( $user_id, $user_public_key, $user_secret_key );
+
+ if ( ! is_null( $is_marketing_allowed ) ) {
+ $this->disable_opt_in_notice_and_lock_user();
+ }
+
+ FS_Permission_Manager::instance( $this )->update_permissions_tracking_flag( array(
+ FS_Permission_Manager::PERMISSION_DIAGNOSTIC => $is_diagnostic_tracking_allowed,
+ FS_Permission_Manager::PERMISSION_EXTENSIONS => $is_extensions_tracking_allowed,
+ ) );
+
+ $install_ids = array();
+
+ foreach ( $installs as $install ) {
+ $install_ids[] = $install->id;
+ }
+
+ $items_per_request = 25;
+ $left = count( $install_ids );
+ $offset = 0;
+
+ $installs = array();
+ while ( $left > 0 ) {
+ $result = $this->get_api_user_scope()->get( "/plugins/{$this->_module_id}/installs.json?ids=" . implode( ',', array_slice( $install_ids, $offset, $items_per_request ) ) );
+
+ if ( ! $this->is_api_result_object( $result, 'installs' ) ) {
+ // @todo Handle API error.
+ }
+
+ $installs = array_merge( $installs, $result->installs );
+
+ $left -= $items_per_request;
+ $offset += $items_per_request;
+ }
+
+ foreach ( $installs as &$install ) {
+ $install = new FS_Site( $install );
+ }
+
+ return $this->setup_network_account(
+ $this->_user,
+ $installs,
+ $redirect,
+ $auto_install
+ );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.7.4
+ *
+ * @param string|bool $email
+ * @param bool $redirect
+ * @param string|bool $license_key Since 1.2.1.5
+ * @param bool $is_pending_trial Since 1.2.1.5
+ * @param bool $is_suspicious_email Since 2.5.0
+ * @param bool $has_upgrade_context Since 2.5.3
+ * @param bool|string $support_email_address Since 2.5.3
+ *
+ * @return string Since 1.2.1.5 if $redirect is `false`, return the pending activation page.
+ */
+ private function set_pending_confirmation(
+ $email = false,
+ $redirect = true,
+ $license_key = false,
+ $is_pending_trial = false,
+ $is_suspicious_email = false,
+ $has_upgrade_context = false,
+ $support_email_address = false
+ ) {
+ $is_network_admin = fs_is_network_admin();
+
+ if ( $this->_ignore_pending_mode && ! $has_upgrade_context ) {
+ /**
+ * If explicitly asked to ignore pending mode, set to anonymous mode
+ * if require confirmation before finalizing the opt-in except after completing a purchase (otherwise, in this case, they wouldn't see any notice telling them that they should receive their license key via email).
+ *
+ * @author Vova Feldman
+ * @since 1.2.1.6
+ */
+ $this->skip_connection( $is_network_admin );
+ } else {
+ // Install must be activated via email since
+ // user with the same email already exist.
+ $this->_storage->is_pending_activation = true;
+ $this->_add_pending_activation_notice(
+ $email,
+ $is_pending_trial,
+ $is_suspicious_email,
+ $has_upgrade_context,
+ $support_email_address
+ );
+ }
+
+ if ( ! empty( $license_key ) ) {
+ $this->_storage->pending_license_key = $license_key;
+ }
+
+ // Remove the opt-in sticky notice.
+ $this->_admin_notices->remove_sticky( array(
+ 'connect_account',
+ 'trial_promotion',
+ ) );
+
+ $next_page = $this->get_after_activation_url( 'after_pending_connect_url' );
+
+ if ( $redirect ) {
+ // Reload the page with a pending activation message.
+ fs_redirect( $next_page );
+ }
+
+ return $next_page;
+ }
+
+ /**
+ * Install plugin with current logged WP user info.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.7
+ */
+ function _install_with_current_user() {
+ $this->_logger->entrance();
+
+ if ( $this->is_registered() ) {
+ return;
+ }
+
+ if ( fs_request_is_action( $this->get_unique_affix() . '_activate_existing' ) && fs_request_is_post() ) {
+ check_admin_referer( $this->get_unique_affix() . '_activate_existing' );
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.9 Add license key if given.
+ */
+ $license_key = fs_request_get_raw( 'license_secret_key' );
+
+ FS_Permission_Manager::instance( $this )->update_permissions_tracking_flag( array(
+ FS_Permission_Manager::PERMISSION_DIAGNOSTIC => fs_request_get_bool( 'is_diagnostic_tracking_allowed', null ),
+ FS_Permission_Manager::PERMISSION_EXTENSIONS => fs_request_get_bool( 'is_extensions_tracking_allowed', null ),
+ ) );
+
+ $this->install_with_current_user( $license_key );
+ }
+ }
+
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.7.4
+ *
+ * @param string|bool $license_key
+ * @param number|bool $trial_plan_id
+ * @param array $sites Since 2.0.0
+ * @param bool $redirect
+ *
+ * @return object|string If redirect is `false`, returns the next page the user should be redirected to, or the API error object if failed to install.
+ */
+ function install_with_current_user(
+ $license_key = false,
+ $trial_plan_id = false,
+ $sites = array(),
+ $redirect = true
+ ) {
+ // Get current logged WP user.
+ $current_user = self::_get_current_wp_user();
+
+ // Find the relevant FS user by the email.
+ $user = self::_get_user_by_email( $current_user->user_email );
+
+ return $this->install_with_user( $user, $license_key, $trial_plan_id, $redirect, true, $sites );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param \FS_User $user
+ * @param string|bool $license_key
+ * @param number|bool $trial_plan_id
+ * @param bool $redirect
+ * @param bool $setup_account Since 2.0.0. When set to FALSE, executes a light installation without setting up the account as if it's the first opt-in.
+ * @param array $sites Since 2.0.0. If not empty, should be a collection of site details for the bulk install API request.
+ *
+ * @return \FS_Site|object|string If redirect is `false`, returns the next page the user should be redirected to, or the API error object if failed to install. If $setup_account is set to `false`, return the newly created install.
+ */
+ function install_with_user(
+ FS_User $user,
+ $license_key = false,
+ $trial_plan_id = false,
+ $redirect = true,
+ $setup_account = true,
+ $sites = array()
+ ) {
+ // We have to set the user before getting user scope API handler.
+ $this->_user = $user;
+
+ // Install the plugin.
+ $result = $this->create_installs_with_user(
+ $user,
+ $license_key,
+ $trial_plan_id,
+ $sites,
+ $redirect
+ );
+
+ if ( ! $this->is_api_result_entity( $result ) &&
+ ! $this->is_api_result_object( $result, 'installs' )
+ ) {
+ // @todo Handler potential API error of the $result
+ }
+
+ if ( empty( $sites ) ) {
+ $site = new FS_Site( $result );
+ $this->_site = $site;
+
+ if ( ! $setup_account ) {
+ $this->_store_site();
+
+ $this->sync_plan_if_not_exist( $site->plan_id );
+
+ if ( ! empty( $license_key ) && FS_Plugin_License::is_valid_id( $site->license_id ) ) {
+ $this->sync_license_if_not_exist( $site->license_id, $license_key );
+ }
+
+ $this->_admin_notices->remove_sticky( 'connect_account', false );
+
+ return $site;
+ }
+
+ return $this->setup_account( $this->_user, $this->_site, $redirect );
+ } else {
+ $installs = array();
+ foreach ( $result->installs as $install ) {
+ $installs[] = new FS_Site( $install );
+ }
+
+ return $this->setup_network_account(
+ $user,
+ $installs,
+ $redirect
+ );
+ }
+ }
+
+ /**
+ * Initiate an API request to create a collection of installs.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param \FS_User $user
+ * @param bool $license_key
+ * @param bool $trial_plan_id
+ * @param array $sites
+ * @param bool $redirect
+ * @param bool $silent
+ *
+ * @return object|mixed
+ */
+ private function create_installs_with_user(
+ FS_User $user,
+ $license_key = false,
+ $trial_plan_id = false,
+ $sites = array(),
+ $redirect = false,
+ $silent = false
+ ) {
+ $extra_install_params = array(
+ 'uid' => $this->get_anonymous_id(),
+ 'is_disconnected' => false,
+ );
+
+ if ( ! empty( $license_key ) ) {
+ $extra_install_params['license_key'] = $this->apply_filters( 'license_key', $license_key );
+
+ if ( $silent ) {
+ $extra_install_params['ignore_license_owner'] = true;
+ }
+ } else if ( FS_Plugin_Plan::is_valid_id( $trial_plan_id ) ) {
+ $extra_install_params['trial_plan_id'] = $trial_plan_id;
+ }
+
+ if ( ! empty( $sites ) ) {
+ $extra_install_params['sites'] = $sites;
+ }
+
+ $args = $this->get_install_data_for_api( $extra_install_params, false, false );
+
+ // Install the plugin.
+ $result = $this->get_api_user_scope_by_user( $user )->call(
+ "/plugins/{$this->get_id()}/installs.json",
+ 'post',
+ $args
+ );
+
+ if ( ! $this->is_api_result_entity( $result ) &&
+ ! $this->is_api_result_object( $result, 'installs' )
+ ) {
+ if ( ! empty( $args['license_key'] ) ) {
+ // Pass the fully entered license key to the failure handler.
+ $args['license_key'] = $license_key;
+ }
+
+ $result = $this->apply_filters( 'after_install_failure', $result, $args );
+
+ if ( ! $silent ) {
+ $this->_admin_notices->add(
+ sprintf( $this->get_text_inline( 'Couldn\'t activate %s.', 'could-not-activate-x' ), $this->get_plugin_name() ) . ' ' .
+ $this->get_text_inline( 'Please contact us with the following message:', 'contact-us-with-error-message' ) . ' ' . '' . $result->error->message . ' ',
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
+ 'error'
+ );
+ }
+
+ if ( $redirect ) {
+ /**
+ * We set the user before getting the user scope API handler, so the user became temporarily
+ * registered (`is_registered() = true`). Since the API returned an error and we will redirect,
+ * we have to set the user to `null`, otherwise, the user will be redirected to the wrong
+ * activation page based on the return value of `is_registered()`. In addition, in case the
+ * context plugin doesn't have a settings menu and the default page is the `Plugins` page,
+ * misleading plugin activation errors will be shown on the `Plugins` page.
+ *
+ * @author Leo Fajardo (@leorw)
+ */
+ $user = $this->_user;
+
+ $this->_user = null;
+
+ fs_redirect( $this->get_activation_url( array( 'error' => $result->error->message ) ) );
+
+ /**
+ * Restore the user after the redirect, this is relevant when there are cases where the redirect will choose not to do anything.
+ */
+ $this->_user = $user;
+ }
+ }
+
+ return $result;
+ }
+
+ /**
+ * Tries to activate add-on account based on parent plugin info.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ *
+ * @param Freemius $parent_fs
+ * @param bool|int|null $network_level_or_blog_id True for network level opt-in and integer for opt-in for specified blog in the network.
+ * @param FS_Plugin_License $bundle_license Since 2.4.0. If provided, this license will be activated for the add-on.
+ */
+ private function _activate_addon_account(
+ Freemius $parent_fs,
+ $network_level_or_blog_id = null,
+ FS_Plugin_License $bundle_license = null
+ ) {
+ if ( $this->is_registered() ) {
+ // Already activated.
+ return;
+ }
+
+ $permission_ids = FS_Permission_Manager::get_all_permission_ids();
+ $permissions = array();
+ foreach ( $permission_ids as $permission_id ) {
+ $permissions[ $permission_id ] = FS_Permission_Manager::instance( $parent_fs )->is_permission( $permission_id, true );
+ }
+
+ FS_Permission_Manager::instance( $this )->update_permissions_tracking_flag( $permissions );
+
+ /**
+ * Do not override the `uid` if network-level opt-in since the call to `get_sites_for_network_level_optin()`
+ * already returns the data for the current blog.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.0
+ */
+ $uid_param_to_override = ( true === $network_level_or_blog_id ) ?
+ array() :
+ array( 'uid' => $this->get_anonymous_id() );
+
+ $params = $this->get_install_data_for_api(
+ $uid_param_to_override,
+ false,
+ false,
+ /**
+ * Do not include the data for the current blog if network-level opt-in since the call to `get_sites_for_network_level_optin`
+ * already includes the data for it.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.0
+ */
+ ( true !== $network_level_or_blog_id )
+ );
+
+ if ( true === $network_level_or_blog_id ) {
+ $params['sites'] = $this->get_sites_for_network_level_optin();
+
+ if ( empty( $params['sites'] ) ) {
+ return;
+ }
+ }
+
+ if ( is_object( $bundle_license ) ) {
+ $params['license_key'] = $bundle_license->secret_key;
+ }
+
+ // Activate add-on with parent plugin credentials.
+ $result = $parent_fs->get_api_site_scope()->call(
+ "/addons/{$this->_plugin->id}/installs.json",
+ 'post',
+ $params
+ );
+
+ if ( ! $this->is_api_result_object( $result, 'installs' ) ) {
+ if ( is_object( $bundle_license ) ) {
+ /**
+ * When a license object is provided, it's an attempt by the SDK to activate a bundle license and not a user-initiated action, therefore, do not show any admin notice to avoid confusion (e.g.: the notice will show up just above the opt-in link). If the license activation fails, the admin will see an opt-in link instead.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.4.0
+ */
+ } else {
+ $error_message = FS_Api::is_api_error_object( $result ) ?
+ $result->error->message :
+ $this->get_text_inline( 'An unknown error has occurred.', 'unknown-error' );
+
+ $this->_admin_notices->add(
+ sprintf( $this->get_text_inline( 'Couldn\'t activate %s.', 'could-not-activate-x' ), $this->get_plugin_name() ) . ' ' .
+ $this->get_text_inline( 'Please contact us with the following message:', 'contact-us-with-error-message' ) . ' ' . '' . $error_message . ' ',
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
+ 'error'
+ );
+ }
+
+ return;
+ }
+
+ $addon_installs = $result->installs;
+ foreach ( $addon_installs as $key => $addon_install ) {
+ $addon_installs[ $key ] = new FS_Site( $addon_install );
+ }
+
+ $first_install = $addon_installs[0];
+
+ // Get user information based on parent's plugin.
+ $user = $parent_fs->get_user();
+
+ // First of all, set site and user info - otherwise we won't
+ // be able to invoke API calls.
+ $this->_site = $first_install;
+ $this->_user = $user;
+
+ // Sync add-on plans.
+ $this->_sync_plans();
+
+ $this->handle_account_connection( $addon_installs, ! fs_is_network_admin() );
+
+ // Get site's current plan.
+ //$this->_site->plan = $this->_get_plan_by_id( $this->_site->plan->id );
+
+ // Sync licenses.
+ $this->_sync_licenses();
+
+ if ( ! fs_is_network_admin() ) {
+ // Try to activate premium license.
+ $this->_activate_license( true, $bundle_license );
+
+ if ( is_object( $bundle_license ) ) {
+ $this->maybe_activate_bundle_license( $bundle_license );
+ }
+ } else {
+ if ( is_object( $bundle_license ) ) {
+ $premium_license = $bundle_license;
+ } else {
+ $license_id = fs_request_get( 'license_id' );
+
+ if ( is_object( $this->_site ) &&
+ FS_Plugin_License::is_valid_id( $license_id ) &&
+ $license_id == $this->_site->license_id
+ ) {
+ // License is already activated.
+ return;
+ }
+
+ $premium_license = FS_Plugin_License::is_valid_id( $license_id ) ?
+ $this->_get_license_by_id( $license_id ) :
+ $this->_get_available_premium_license();
+ }
+
+ if ( is_object( $premium_license ) ) {
+ $this->maybe_network_activate_addon_license( $premium_license );
+ }
+ }
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.0
+ *
+ * @param FS_Site[] $installs
+ * @param bool $is_site_level
+ */
+ private function handle_account_connection( $installs, $is_site_level ) {
+ $first_install = $installs[0];
+
+ if ( $is_site_level ) {
+ $this->_set_account( $this->_user, $first_install );
+
+ $this->do_action( 'after_account_connection', $this->_user, $first_install );
+ } else {
+ $this->_store_user();
+
+ // Map site addresses to their blog IDs.
+ $address_to_blog_map = $this->get_address_to_blog_map();
+
+ $first_blog_id = null;
+ $blog_2_install_map = array();
+ foreach ( $installs as $install ) {
+ $address = trailingslashit( fs_strip_url_protocol( $install->url ) );
+ $blog_id = $address_to_blog_map[ $address ];
+
+ $this->_store_site( true, $blog_id, $install );
+
+ if ( is_null( $first_blog_id ) ) {
+ $first_blog_id = $blog_id;
+ }
+
+ $blog_2_install_map[ $blog_id ] = $install;
+ }
+
+ if ( ! FS_User::is_valid_id( $this->_storage->network_user_id ) ||
+ ! is_object( self::_get_user_by_id( $this->_storage->network_user_id ) )
+ ) {
+ // Store network user.
+ $this->_storage->network_user_id = $this->_user->id;
+ }
+
+ if ( ! FS_Site::is_valid_id( $this->_storage->network_install_blog_id ) ) {
+ $this->_storage->network_install_blog_id = $first_blog_id;
+ }
+
+ if ( count( $installs ) === count( $address_to_blog_map ) ) {
+ // Super admin opted in for all sites in the network.
+ $this->_storage->is_network_connected = true;
+ }
+
+ $this->_store_licenses( false );
+
+ self::$_accounts->store();
+
+ // Don't sync the installs data on network upgrade
+ if ( ! $this->network_upgrade_mode_completed() ) {
+ $this->send_installs_update();
+ }
+
+ $current_blog = get_current_blog_id();
+
+ foreach ( $blog_2_install_map as $blog_id => $install ) {
+ $this->switch_to_blog( $blog_id );
+
+ $this->do_action( 'after_account_connection', $this->_user, $install );
+ }
+
+ // Switch install context back to the first install.
+ $this->switch_to_blog(
+ $current_blog,
+ $first_install,
+ ( $this->_site->id != $first_install->id )
+ );
+
+ $this->do_action( 'after_network_account_connection', $this->_user, $blog_2_install_map );
+ }
+ }
+
+ /**
+ * Tries to activate parent account based on add-on's info.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @param Freemius $parent_fs
+ */
+ private function activate_parent_account( Freemius $parent_fs ) {
+ if ( ! $this->is_addon() ) {
+ // This is not an add-on.
+ return;
+ }
+
+ if ( $parent_fs->is_registered() ) {
+ // Already activated.
+ return;
+ }
+
+ // Activate parent with add-on's user credentials.
+ $parent_install = $this->get_api_user_scope()->call(
+ "/plugins/{$parent_fs->_plugin->id}/installs.json",
+ 'post',
+ $parent_fs->get_install_data_for_api( array(
+ 'uid' => $parent_fs->get_anonymous_id(),
+ ), false, false )
+ );
+
+ if ( isset( $parent_install->error ) ) {
+ $this->_admin_notices->add(
+ sprintf( $this->get_text_inline( 'Couldn\'t activate %s.', 'could-not-activate-x' ), $this->get_plugin_name() ) . ' ' .
+ $this->get_text_inline( 'Please contact us with the following message:', 'contact-us-with-error-message' ) . ' ' . '' . $parent_install->error->message . ' ',
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
+ 'error'
+ );
+
+ return;
+ }
+
+ $parent_fs->_admin_notices->remove_sticky( 'connect_account' );
+
+ if ( $parent_fs->is_pending_activation() ) {
+ $parent_fs->clear_pending_activation_mode();
+ }
+
+ // Get user information based on parent's plugin.
+ $user = $this->get_user();
+
+ // First of all, set site info - otherwise we won't
+ // be able to invoke API calls.
+ $parent_fs->_site = new FS_Site( $parent_install );
+ $parent_fs->_user = $user;
+
+ // Sync add-on plans.
+ $parent_fs->_sync_plans();
+
+ $parent_fs->update_license_required_permissions_if_anonymous();
+
+ $parent_fs->_set_account( $user, $parent_fs->_site );
+ }
+
+ #endregion
+
+ #----------------------------------------------------------------------------------
+ #region Admin Menu Items
+ #----------------------------------------------------------------------------------
+
+ private $_menu_items = array();
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.8
+ *
+ * @return array
+ */
+ function get_menu_items() {
+ return $this->_menu_items;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.7
+ *
+ * @return string
+ */
+ function get_menu_slug() {
+ return $this->_menu->get_slug();
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ */
+ function _prepare_admin_menu() {
+// if ( ! $this->is_on() ) {
+// return;
+// }
+
+ if ( is_object( $this->_site ) && ! $this->is_registered() ) {
+ return;
+ }
+
+ /**
+ * When running from a site admin with a network activated module and the connection
+ * was NOT delegated and the user still haven't skipped or opted-in, then hide the
+ * site level settings.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ */
+ $should_hide_site_admin_settings = (
+ $this->_is_network_active &&
+ ! fs_is_network_admin() &&
+ ! $this->is_delegated_connection() &&
+ ! $this->is_anonymous() &&
+ ! $this->is_registered()
+ );
+
+ $should_hide_site_admin_settings = $this->apply_filters( 'should_hide_site_admin_settings_on_network_activation_mode', $should_hide_site_admin_settings );
+
+ if ( ( false === $this->has_api_connectivity() && ! $this->is_enable_anonymous() ) ||
+ $should_hide_site_admin_settings
+ ) {
+ $this->_menu->remove_menu_item( $should_hide_site_admin_settings );
+ } else {
+ $this->do_action( fs_is_network_admin() ?
+ 'before_network_admin_menu_init' :
+ 'before_admin_menu_init'
+ );
+
+ $this->add_menu_action();
+
+ $this->add_network_menu_when_missing();
+
+ $this->add_submenu_items();
+ }
+ }
+
+ /**
+ * Admin dashboard menu items modifications.
+ *
+ * NOTE: admin_menu action executed before admin_init.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.7
+ *
+ */
+ private function add_menu_action() {
+ if ( $this->is_activation_mode() ) {
+ if ( $this->show_opt_in_on_setting_page() ) {
+ $this->override_plugin_menu_with_activation();
+ } else {
+ /**
+ * Handle theme opt-in when the opt-in form shows as a dialog box in the themes page.
+ */
+ if ( fs_request_is_action( $this->get_unique_affix() . '_activate_existing' ) ) {
+ add_action( 'load-themes.php', array( &$this, '_install_with_current_user' ) );
+ } else if ( fs_request_is_action( $this->get_unique_affix() . '_activate_new' ) ||
+ fs_request_get_bool( 'pending_activation' )
+ ) {
+ add_action( 'load-themes.php', array( &$this, '_install_with_new_user' ) );
+ }
+ }
+ } else {
+ if ( ! $this->is_registered() ) {
+ // If not registered try to install user.
+ if ( fs_request_is_action( $this->get_unique_affix() . '_activate_new' ) ) {
+ $this->_install_with_new_user();
+ }
+ } else if (
+ fs_request_is_action( 'sync_user' ) &&
+ ( ! $this->has_settings_menu() || $this->show_opt_in_on_themes_page() )
+ ) {
+ $this->_handle_account_user_sync();
+ }
+ }
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ */
+ function _redirect_on_clicked_menu_link() {
+ $this->_logger->entrance();
+
+ $page = fs_request_get('page');
+ $page = is_string($page) ? strtolower($page) : '';
+
+ $this->_logger->log( 'page = ' . $page );
+
+ foreach ( $this->_menu_items as $priority => $items ) {
+ foreach ( $items as $item ) {
+ if ( isset( $item['url'] ) ) {
+ if ( $page === $this->_menu->get_slug( strtolower( $item['menu_slug'] ) ) ) {
+ $this->_logger->log( 'Redirecting to ' . $item['url'] );
+
+ fs_redirect( $item['url'] );
+ }
+ }
+ }
+ }
+ }
+
+ /**
+ * Remove plugin's all admin menu items & pages, and replace with activation page.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ */
+ private function override_plugin_menu_with_activation() {
+ $this->_logger->entrance();
+
+ $hook = false;
+
+ if ( ! $this->has_settings_menu() ) {
+ // Add the opt-in page without a menu item.
+ $hook = FS_Admin_Menu_Manager::add_subpage(
+ '',
+ $this->get_plugin_name(),
+ $this->get_plugin_name(),
+ 'manage_options',
+ $this->_slug,
+ array( &$this, '_connect_page_render' )
+ );
+ } else if ( $this->_menu->is_top_level() ) {
+ if ( $this->_menu->is_override_exact() ) {
+ // Make sure the current page is matching the activation page.
+ if ( ! $this->is_matching_url( $this->get_activation_url() ) ) {
+ return;
+ }
+ }
+
+ $hook = $this->_menu->override_menu_item( array( &$this, '_connect_page_render' ) );
+
+ if ( false === $hook ) {
+ // Create new menu item just for the opt-in.
+ $hook = FS_Admin_Menu_Manager::add_page(
+ $this->get_plugin_name(),
+ $this->get_plugin_name(),
+ 'manage_options',
+ $this->_menu->get_slug(),
+ array( &$this, '_connect_page_render' )
+ );
+ }
+ } else {
+ $menus = array( $this->_menu->get_parent_slug() );
+
+ if ( $this->_menu->is_override_exact() ) {
+ // Make sure the current page is matching the activation page.
+ if ( ! $this->is_matching_url( $this->get_activation_url() ) ) {
+ return;
+ }
+ }
+
+ foreach ( $menus as $parent_slug ) {
+ $hook = $this->_menu->override_submenu_action(
+ $parent_slug,
+ $this->_menu->get_raw_slug(),
+ array( &$this, '_connect_page_render' )
+ );
+
+ if ( false !== $hook ) {
+ // Found plugin's submenu item.
+ break;
+ }
+ }
+ }
+
+ if ( $this->is_activation_page() ) {
+ // Clean admin page from distracting content.
+ self::_clean_admin_content_section();
+ }
+
+ if ( false !== $hook ) {
+ if ( fs_request_is_action( $this->get_unique_affix() . '_activate_existing' ) ) {
+ $this->_install_with_current_user();
+ } else if ( fs_request_is_action( $this->get_unique_affix() . '_activate_new' ) ) {
+ $this->_install_with_new_user();
+ }
+ }
+ }
+
+ /**
+ * If a plugin was network activated and connected but don't have a network
+ * level settings, then add an artificial menu item for the Account and other
+ * Freemius settings.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ */
+ private function add_network_menu_when_missing() {
+ $this->_logger->entrance();
+
+ if ( ! $this->_is_network_active ) {
+ // Plugin wasn't activated on the network level.
+ return;
+ }
+
+ if ( ! fs_is_network_admin() ) {
+ // The context is not the network admin.
+ return;
+ }
+
+ if ( $this->_menu->has_network_menu() ) {
+ // Plugin already has a network level menu.
+ return;
+ }
+
+ if ( $this->is_network_activation_mode() ) {
+ /**
+ * Do not add during activation mode, otherwise, there will be duplicate menus while the opt-in
+ * screen is being shown.
+ *
+ * @author Leo Fajardo (@leorw)
+ */
+ return;
+ }
+
+ if ( ! WP_FS__SHOW_NETWORK_EVEN_WHEN_DELEGATED ) {
+ if ( $this->is_network_delegated_connection() ) {
+ // Super-admin delegated the connection to the site admins.
+ return;
+ }
+ }
+
+ if ( ! $this->_menu->has_menu() || $this->_menu->is_top_level() ) {
+
+ if ( $this->_menu->has_menu() ||
+ ! $this->is_addon() ||
+ $this->is_activation_mode()
+ ) {
+ $this->_dynamically_added_top_level_page_hook_name = $this->_menu->add_page_and_update(
+ $this->get_plugin_name(),
+ $this->get_plugin_name(),
+ 'manage_options',
+ $this->_menu->has_menu() ? $this->_menu->get_slug() : $this->_slug
+ );
+ }
+ } else {
+ $this->_menu->add_subpage_and_update(
+ $this->_menu->get_parent_slug(),
+ $this->get_plugin_name(),
+ $this->get_plugin_name(),
+ 'manage_options',
+ $this->_menu->get_slug()
+ );
+ }
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 1.2.1
+ *
+ * return string
+ */
+ function get_top_level_menu_capability() {
+ global $menu;
+
+ $top_level_menu_slug = $this->get_top_level_menu_slug();
+
+ foreach ( $menu as $menu_info ) {
+ /**
+ * The second element in the menu info array is the capability/role that has access to the menu and the
+ * third element is the menu slug.
+ */
+ if ( $menu_info[2] === $top_level_menu_slug ) {
+ return $menu_info[1];
+ }
+ }
+
+ return 'read';
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.0
+ *
+ * @return string
+ */
+ private function get_top_level_menu_slug() {
+ return ( $this->is_addon() ?
+ $this->get_parent_instance()->_menu->get_top_level_menu_slug() :
+ $this->_menu->get_top_level_menu_slug() );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return string
+ */
+ function get_pricing_cta_label() {
+ $label = $this->get_text_inline( 'Upgrade', 'upgrade' );
+
+ if ( $this->is_in_trial_promotion() &&
+ ! $this->is_paying_or_trial()
+ ) {
+ // If running a trial promotion, modify the pricing to load the trial.
+ $label = $this->get_text_inline( 'Start Trial', 'start-trial' );
+ } else if ( $this->is_paying() ) {
+ $label = $this->get_text_inline( 'Pricing', 'pricing' );
+ }
+
+ return $label;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return bool
+ */
+ function is_pricing_page_visible() {
+ return (
+ // Has at least one paid plan.
+ $this->has_paid_plan() &&
+ // Didn't ask to hide the pricing page.
+ $this->is_page_visible( 'pricing' ) &&
+ // Don't have a valid active license or has more than one plan.
+ ( ! $this->is_paying() || ! $this->is_single_plan( true ) )
+ );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.0
+ *
+ * @param bool $is_activation_mode
+ *
+ * @return bool
+ */
+ private function should_add_submenu_or_action_links( $is_activation_mode ) {
+ if ( $this->is_addon() ) {
+ // No submenu items or action links for add-ons.
+ return false;
+ }
+
+ if ( $this->show_opt_in_on_themes_page() ) {
+ if ( ! fs_is_network_admin() ) {
+ // Also add action links or submenu items when running in a free .org theme so the tabs will be visible.
+ return true;
+ }
+ } else if ( $is_activation_mode ) {
+ // Don't show submenu-items/tabs in activation mode, unless it's a wp.org theme.
+ return false;
+ }
+
+ if ( fs_is_network_admin() ) {
+ /**
+ * Add submenu items or action links to network level when plugin was network activated and the super
+ * admin did NOT delegate the connection of all sites to site admins.
+ */
+ return (
+ $this->_is_network_active &&
+ ( WP_FS__SHOW_NETWORK_EVEN_WHEN_DELEGATED ||
+ ! $this->is_network_delegated_connection() )
+ );
+ }
+
+ return ( ! $this->_is_network_active || $this->is_delegated_connection() );
+ }
+
+ /**
+ * Add default Freemius menu items.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.0
+ * @since 1.2.2.7 Also add submenu items when running in a free .org theme so the tabs will be visible.
+ */
+ private function add_submenu_items() {
+ $this->_logger->entrance();
+
+ $is_activation_mode = $this->is_activation_mode();
+
+ $add_submenu_items = $this->should_add_submenu_or_action_links( $is_activation_mode );
+
+ if ( $add_submenu_items ) {
+ if ( $this->has_affiliate_program() ) {
+ // Add affiliation page.
+ $this->add_submenu_item(
+ $this->get_text_inline( 'Affiliation', 'affiliation' ),
+ array( &$this, '_affiliation_page_render' ),
+ $this->get_plugin_name() . ' – ' . $this->get_text_inline( 'Affiliation', 'affiliation' ),
+ 'manage_options',
+ 'affiliation',
+ 'Freemius::_clean_admin_content_section',
+ WP_FS__DEFAULT_PRIORITY,
+ $this->is_submenu_item_visible( 'affiliation' )
+ );
+ }
+ }
+
+ if ( $add_submenu_items ||
+ ( $is_activation_mode &&
+ $this->is_only_premium() &&
+ $this->is_admin_page( 'account' ) &&
+ fs_request_is_action( $this->get_unique_affix() . '_sync_license' )
+ )
+ ) {
+ if ( ! WP_FS__DEMO_MODE && $this->is_registered() ) {
+ $show_account = (
+ $this->is_submenu_item_visible( 'account' ) &&
+ /**
+ * @since 1.2.2.7 Don't show the Account for free WP.org themes without any paid plans.
+ */
+ ( ! $this->is_free_wp_org_theme() || $this->has_paid_plan() )
+ );
+
+ // Add user account page.
+ $this->add_submenu_item(
+ $this->get_text_inline( 'Account', 'account' ),
+ array( &$this, '_account_page_render' ),
+ $this->get_plugin_name() . ' – ' . $this->get_text_inline( 'Account', 'account' ),
+ 'manage_options',
+ 'account',
+ array( &$this, '_account_page_load' ),
+ WP_FS__DEFAULT_PRIORITY,
+ ( $add_submenu_items && $show_account )
+ );
+ }
+ }
+
+ if ( $add_submenu_items ) {
+ if (! WP_FS__DEMO_MODE && ! $this->is_whitelabeled() ) {
+ // Add contact page.
+ if ( $this->is_premium() ) {
+ $this->add_submenu_item(
+ $this->get_text_inline( 'Contact Us', 'contact-us' ),
+ array( &$this, '_contact_page_render' ),
+ $this->get_plugin_name() . ' – ' . $this->get_text_inline( 'Contact Us', 'contact-us' ),
+ 'manage_options',
+ 'contact',
+ 'Freemius::_clean_admin_content_section',
+ WP_FS__DEFAULT_PRIORITY,
+ $this->is_submenu_item_visible( 'contact' )
+ );
+ } else {
+ $this->add_submenu_link_item(
+ $this->get_text_inline( 'Contact Us', 'contact-us' ),
+ FS_Contact_Form_Manager::instance()->get_standalone_link( $this ),
+ 'contact',
+ 'manage_options',
+ WP_FS__DEFAULT_PRIORITY,
+ $this->is_submenu_item_visible( 'contact' ),
+ 'fs_external_contact',
+ true
+ );
+ }
+ }
+
+ if ( $this->has_addons() ) {
+ $this->add_submenu_item(
+ $this->get_text_inline( 'Add-Ons', 'add-ons' ),
+ array( &$this, '_addons_page_render' ),
+ $this->get_plugin_name() . ' – ' . $this->get_text_inline( 'Add-Ons', 'add-ons' ),
+ 'manage_options',
+ 'addons',
+ array( &$this, '_addons_page_load' ),
+ WP_FS__LOWEST_PRIORITY - 1,
+ $this->is_submenu_item_visible( 'addons' )
+ );
+ }
+ }
+
+ if ( $add_submenu_items ||
+ ( $is_activation_mode && $this->is_only_premium() && $this->is_admin_page( 'pricing' ) )
+ ) {
+ if (! WP_FS__DEMO_MODE && ! $this->is_whitelabeled() ) {
+ $show_pricing = (
+ $this->is_submenu_item_visible( 'pricing' ) &&
+ $this->is_pricing_page_visible()
+ );
+
+ $pricing_cta_text = $this->get_pricing_cta_label();
+ $pricing_class = 'upgrade-mode';
+ if ( $show_pricing ) {
+ if ( $this->is_in_trial_promotion() &&
+ ! $this->is_paying_or_trial()
+ ) {
+ // If running a trial promotion, modify the pricing to load the trial.
+ $pricing_class = 'trial-mode';
+ } else if ( $this->is_paying() ) {
+ $pricing_class = '';
+ }
+ }
+
+ $custom_pricing_url = $this->get_pricing_url_with_filter( null );
+ $pricing_menu_title = $pricing_cta_text . ' ' . ( is_rtl() ? $this->get_text_x_inline( '←', 'ASCII arrow left icon', 'symbol_arrow-left' ) : $this->get_text_x_inline( '➤', 'ASCII arrow right icon', 'symbol_arrow-right' ) );
+ $show_pricing_submenu_item = ( $add_submenu_items && $show_pricing );
+
+ // Add upgrade/pricing submenu item.
+ if ( ! is_null( $custom_pricing_url ) ) {
+ $this->add_submenu_link_item(
+ $pricing_menu_title,
+ $custom_pricing_url,
+ 'pricing',
+ 'manage_options',
+ WP_FS__LOWEST_PRIORITY,
+ $show_pricing_submenu_item,
+ $pricing_class
+ );
+ } else {
+ $this->add_submenu_item(
+ $pricing_menu_title,
+ array( &$this, '_pricing_page_render' ),
+ $this->get_plugin_name() . ' – ' . $this->get_text_x_inline( 'Pricing', 'noun', 'pricing' ),
+ 'manage_options',
+ 'pricing',
+ 'Freemius::_clean_admin_content_section',
+ WP_FS__LOWEST_PRIORITY,
+ $show_pricing_submenu_item,
+ $pricing_class
+ );
+ }
+ }
+ }
+
+ if ( ! $is_activation_mode || ( true !== $this->_storage->require_license_activation ) ) {
+ /**
+ * Add the other menu items if there are any when not in activation mode or license activation is not
+ * required (license activation is required for registered or anonymous users after activating the
+ * premium version when the site is not in trial mode or there's no active valid license).
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.1
+ */
+ if ( 0 < count( $this->_menu_items ) ) {
+ if ( ! $this->_menu->is_top_level() ) {
+ fs_enqueue_local_style( 'fs_common', '/admin/common.css' );
+
+ // Append submenu items right after the plugin's submenu item.
+ $this->order_sub_submenu_items();
+ } else {
+ // Append submenu items.
+ $this->embed_submenu_items();
+ }
+ }
+ }
+ }
+
+ /**
+ * Moved the actual submenu item additions to a separated function,
+ * in order to support sub-submenu items when the plugin's settings
+ * only have a submenu and not top-level menu item.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.4
+ */
+ private function embed_submenu_items() {
+ $item_classes = $this->_menu->is_top_level() ? 'fs-submenu-item' : 'fs-submenu-item fs-sub';
+
+ $item_template = '%4$s ';
+
+ $top_level_menu_capability = $this->get_top_level_menu_capability();
+
+ ksort( $this->_menu_items );
+
+ $is_first_submenu_item = true;
+
+ foreach ( $this->_menu_items as $priority => $items ) {
+ foreach ( $items as $item ) {
+ $capability = ( ! empty( $item['capability'] ) ? $item['capability'] : $top_level_menu_capability );
+
+ $menu_item = sprintf(
+ $item_template,
+ $this->get_unique_affix(),
+ $item['menu_slug'],
+ ! empty( $item['class'] ) ? $item['class'] : '',
+ $item['menu_title'],
+ esc_attr( isset( $item['url'] ) ? $item['url'] : '' ),
+ esc_attr( isset( $item['new_tab'] ) ? 'true' : 'false' )
+ );
+
+ $top_level_menu_slug = $this->get_top_level_menu_slug();
+ $menu_slug = $this->_menu->get_slug( $item['menu_slug'] );
+
+ if ( ! isset( $item['url'] ) ) {
+ $hook = FS_Admin_Menu_Manager::add_subpage(
+ $item['show_submenu'] ?
+ $top_level_menu_slug :
+ '',
+ $item['page_title'],
+ $menu_item,
+ $capability,
+ $menu_slug,
+ $item['render_function']
+ );
+
+ if ( false !== $item['before_render_function'] ) {
+ add_action( "load-$hook", $item['before_render_function'] );
+ }
+ } else {
+ FS_Admin_Menu_Manager::add_subpage(
+ $item['show_submenu'] ?
+ $top_level_menu_slug :
+ '',
+ $item['page_title'],
+ $menu_item,
+ $capability,
+ $menu_slug,
+ array( $this, '' )
+ );
+ }
+
+ if ( $item['show_submenu'] && $is_first_submenu_item ) {
+ if ( $this->_is_network_active && ! empty( $this->_dynamically_added_top_level_page_hook_name ) ) {
+ /**
+ * If the top-level menu has been dynamically created, remove the first submenu item that
+ * WordPress automatically creates when there's no submenu item whose slug matches the
+ * parent's. In the following example, the `Awesome Plugin` submenu item will be removed.
+ *
+ * Awesome Plugin
+ * - Awesome Plugin <-- we want to remove this since there's no real setting page for the top-level
+ *
+ * @author Leo Fajardo (@leorw)
+ */
+ remove_submenu_page( $top_level_menu_slug, $top_level_menu_slug );
+ }
+
+ $is_first_submenu_item = false;
+ }
+ }
+ }
+ }
+
+ /**
+ * Re-order the submenu items so all Freemius added new submenu items
+ * are added right after the plugin's settings submenu item.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.4
+ */
+ private function order_sub_submenu_items() {
+ global $submenu;
+
+ $menu_slug = $this->_menu->get_top_level_menu_slug();
+
+ /**
+ * Before "admin_menu" fires, WordPress will loop over the default submenus and remove pages for which the user
+ * does not have permissions. So in case a plugin does not have top-level menu but does have submenus under any
+ * of the default menus, only users that have the right role can access its sub-submenus (Account, Contact Us,
+ * Support Forum, etc.) since $submenu[ $menu_slug ] will be empty if the user doesn't have permission.
+ *
+ * In case a plugin does not have submenus under any of the default menus but does have submenus under the menu
+ * of another plugin, only users that have the right role can access its sub-submenus since we will use the
+ * capability needed to access the parent menu as the capability for the submenus that we will add.
+ */
+ if ( empty( $submenu[ $menu_slug ] ) ) {
+ return;
+ }
+
+ $top_level_menu = &$submenu[ $menu_slug ];
+
+ $all_submenu_items_after = array();
+
+ $found_submenu_item = false;
+
+ foreach ( $top_level_menu as $submenu_id => $meta ) {
+ if ( $found_submenu_item ) {
+ // Remove all submenu items after the plugin's submenu item.
+ $all_submenu_items_after[] = $meta;
+ unset( $top_level_menu[ $submenu_id ] );
+ }
+
+ if ( $this->_menu->get_raw_slug() === $meta[2] ) {
+ // Found the submenu item, put all below.
+ $found_submenu_item = true;
+ continue;
+ }
+ }
+
+ // Embed all plugin's new submenu items.
+ $this->embed_submenu_items();
+
+ // Start with specially high number to make sure it's appended.
+ $i = max( 10000, max( array_keys( $top_level_menu ) ) + 1 );
+ foreach ( $all_submenu_items_after as $meta ) {
+ $top_level_menu[ $i ] = $meta;
+ $i ++;
+ }
+
+ // Sort submenu items.
+ ksort( $top_level_menu );
+ }
+
+ /**
+ * Helper method to return the module's support forum URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return string
+ */
+ function get_support_forum_url() {
+ return $this->apply_filters( 'support_forum_url', "https://wordpress.org/support/{$this->_module_type}/{$this->_slug}" );
+ }
+
+ /**
+ * Displays the Support Forum link when enabled.
+ *
+ * Can be filtered like so:
+ *
+ * function _fs_show_support_menu( $is_visible, $menu_id ) {
+ * if ( 'support' === $menu_id ) {
+ * return _fs->is_registered();
+ * }
+ * return $is_visible;
+ * }
+ * _fs()->add_filter('is_submenu_visible', '_fs_show_support_menu', 10, 2);
+ *
+ */
+ function _add_default_submenu_items() {
+ if ( ! $this->is_on() ) {
+ return;
+ }
+
+ if ( ! $this->is_activation_mode() &&
+ ( ( $this->_is_network_active && fs_is_network_admin() ) ||
+ ( ! $this->_is_network_active && is_admin() ) )
+ ) {
+ $this->add_submenu_link_item(
+ $this->apply_filters( 'support_forum_submenu', $this->get_text_inline( 'Support Forum', 'support-forum' ) ),
+ $this->get_support_forum_url(),
+ 'wp-support-forum',
+ null,
+ 50,
+ $this->is_submenu_item_visible( 'support' ),
+ '',
+ true
+ );
+ }
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ *
+ * @param string $menu_title
+ * @param callable $render_function
+ * @param bool|string $page_title
+ * @param string $capability
+ * @param bool|string $menu_slug
+ * @param bool|callable $before_render_function
+ * @param int $priority
+ * @param bool $show_submenu
+ * @param string $class Since 1.2.1.5 can add custom classes to menu items.
+ */
+ function add_submenu_item(
+ $menu_title,
+ $render_function,
+ $page_title = false,
+ $capability = 'manage_options',
+ $menu_slug = false,
+ $before_render_function = false,
+ $priority = WP_FS__DEFAULT_PRIORITY,
+ $show_submenu = true,
+ $class = ''
+ ) {
+ $this->_logger->entrance( 'Title = ' . $menu_title );
+
+ if ( $this->is_addon() ) {
+ $parent_fs = $this->get_parent_instance();
+
+ if ( is_object( $parent_fs ) ) {
+ $parent_fs->add_submenu_item(
+ $menu_title,
+ $render_function,
+ $page_title,
+ $capability,
+ $menu_slug,
+ $before_render_function,
+ $priority,
+ $show_submenu,
+ $class
+ );
+
+ return;
+ }
+ }
+
+ if ( ! isset( $this->_menu_items[ $priority ] ) ) {
+ $this->_menu_items[ $priority ] = array();
+ }
+
+ $this->_menu_items[ $priority ][] = array(
+ 'page_title' => is_string( $page_title ) ? $page_title : $menu_title,
+ 'menu_title' => $menu_title,
+ 'capability' => $capability,
+ 'menu_slug' => is_string( $menu_slug ) ? $menu_slug : strtolower( $menu_title ),
+ 'render_function' => $render_function,
+ 'before_render_function' => $before_render_function,
+ 'show_submenu' => $show_submenu,
+ 'class' => $class,
+ );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ *
+ * @param string $menu_title
+ * @param string $url
+ * @param bool $menu_slug
+ * @param string $capability
+ * @param int $priority
+ * @param bool $show_submenu
+ * @param string $class
+ * @param bool $new_tab
+ */
+ function add_submenu_link_item(
+ $menu_title,
+ $url,
+ $menu_slug = false,
+ $capability = 'read',
+ $priority = WP_FS__DEFAULT_PRIORITY,
+ $show_submenu = true,
+ $class = '',
+ $new_tab = false
+ ) {
+ $this->_logger->entrance( 'Title = ' . $menu_title . '; Url = ' . $url );
+
+ if ( $this->is_addon() ) {
+ $parent_fs = $this->get_parent_instance();
+
+ if ( is_object( $parent_fs ) ) {
+ $parent_fs->add_submenu_link_item(
+ $menu_title,
+ $url,
+ $menu_slug,
+ $capability,
+ $priority,
+ $show_submenu,
+ $class,
+ $new_tab
+ );
+
+ return;
+ }
+ }
+
+ if ( ! isset( $this->_menu_items[ $priority ] ) ) {
+ $this->_menu_items[ $priority ] = array();
+ }
+
+ $this->_menu_items[ $priority ][] = array(
+ 'menu_title' => $menu_title,
+ 'capability' => $capability,
+ 'menu_slug' => is_string( $menu_slug ) ? $menu_slug : strtolower( $menu_title ),
+ 'url' => $url,
+ 'page_title' => $menu_title,
+ 'render_function' => 'fs_dummy',
+ 'before_render_function' => '',
+ 'show_submenu' => $show_submenu,
+ 'class' => $class,
+ 'new_tab' => $new_tab,
+ );
+ }
+
+ #endregion ------------------------------------------------------------------
+
+ #--------------------------------------------------------------------------------
+ #region Admin Notices
+ #--------------------------------------------------------------------------------
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.3.1
+ *
+ * @param string|string[] $ids
+ * @param int|null $network_level_or_blog_id
+ *
+ * @uses FS_Admin_Notices::remove_sticky()
+ */
+ function remove_sticky( $ids, $network_level_or_blog_id = null ) {
+ $this->_admin_notices->remove_sticky( $ids, $network_level_or_blog_id );
+ }
+
+ #endregion
+
+ #--------------------------------------------------------------------------------
+ #region Actions / Hooks / Filters
+ #--------------------------------------------------------------------------------
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.7
+ *
+ * @param string $tag
+ *
+ * @return string
+ */
+ public function get_action_tag( $tag ) {
+ return self::get_action_tag_static( $tag, $this->_slug, $this->is_plugin() );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.6
+ *
+ * @param string $tag
+ * @param string $slug
+ * @param bool $is_plugin
+ *
+ * @return string
+ */
+ static function get_action_tag_static( $tag, $slug = '', $is_plugin = true ) {
+ $action = "fs_{$tag}";
+
+ if ( ! empty( $slug ) ) {
+ $action .= '_' . self::get_module_unique_affix( $slug, $is_plugin );
+ }
+
+ return $action;
+ }
+
+ /**
+ * Returns a string that can be used to generate a unique action name,
+ * option name, HTML element ID, or HTML element class.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 1.2.2
+ *
+ * @return string
+ */
+ public function get_unique_affix() {
+ return self::get_module_unique_affix( $this->_slug, $this->is_plugin() );
+ }
+
+ /**
+ * Returns a string that can be used to generate a unique action name,
+ * option name, HTML element ID, or HTML element class.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.5
+ *
+ * @param string $slug
+ * @param bool $is_plugin
+ *
+ * @return string
+ */
+ static function get_module_unique_affix( $slug, $is_plugin = true ) {
+ $affix = $slug;
+
+ if ( ! $is_plugin ) {
+ $affix .= '-' . WP_FS__MODULE_TYPE_THEME;
+ }
+
+ return $affix;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1
+ * @since 1.2.2.5 The AJAX action names are based on the module ID, not like the non-AJAX actions that are
+ * based on the slug for backward compatibility.
+ *
+ * @param string $tag
+ *
+ * @return string
+ */
+ function get_ajax_action( $tag ) {
+ return self::get_ajax_action_static( $tag, $this->_module_id );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.7
+ *
+ * @param string $tag
+ *
+ * @return string
+ */
+ function get_ajax_security( $tag ) {
+ return wp_create_nonce( $this->get_ajax_action( $tag ) );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.7
+ *
+ * @param string $tag
+ */
+ function check_ajax_referer( $tag ) {
+ check_ajax_referer( $this->get_ajax_action( $tag ), 'security' );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.6
+ * @since 1.2.2.5 The AJAX action names are based on the module ID, not like the non-AJAX actions that are
+ * based on the slug for backward compatibility.
+ *
+ * @param string $tag
+ * @param number|null $module_id
+ *
+ * @return string
+ */
+ static function get_ajax_action_static( $tag, $module_id = null ) {
+ $action = "fs_{$tag}";
+
+ if ( ! empty( $module_id ) ) {
+ $action .= "_{$module_id}";
+ }
+
+ return $action;
+ }
+
+ /**
+ * Do action, specific for the current context plugin.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ *
+ * @param string $tag The name of the action to be executed.
+ * @param mixed $arg,... Optional. Additional arguments which are passed on to the
+ * functions hooked to the action. Default empty.
+ *
+ * @uses do_action()
+ */
+ function do_action( $tag, $arg = '' ) {
+ $args = func_get_args();
+
+ $this->_logger->entrance( $tag );
+
+ call_user_func_array( 'do_action', array_merge(
+ array( $this->get_action_tag( $tag ) ),
+ array_slice( $args, 1 ) )
+ );
+ }
+
+ /**
+ * Add action, specific for the current context plugin.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ *
+ * @param string $tag
+ * @param callable $function_to_add
+ * @param int $priority
+ * @param int $accepted_args
+ *
+ * @uses add_action()
+ */
+ function add_action(
+ $tag,
+ $function_to_add,
+ $priority = WP_FS__DEFAULT_PRIORITY,
+ $accepted_args = 1
+ ) {
+ $this->_logger->entrance( $tag );
+
+ add_action( $this->get_action_tag( $tag ), $function_to_add, $priority, $accepted_args );
+ }
+
+ /**
+ * Add AJAX action, specific for the current context plugin.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1
+ *
+ * @param string $tag
+ * @param callable $function_to_add
+ * @param int $priority
+ *
+ * @uses add_action()
+ *
+ * @return bool True if action added, false if no need to add the action since the AJAX call isn't matching.
+ */
+ function add_ajax_action(
+ $tag,
+ $function_to_add,
+ $priority = WP_FS__DEFAULT_PRIORITY
+ ) {
+ $this->_logger->entrance( $tag );
+
+ return self::add_ajax_action_static(
+ $tag,
+ $function_to_add,
+ $priority,
+ $this->_module_id
+ );
+ }
+
+ /**
+ * Add AJAX action.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.6
+ *
+ * @param string $tag
+ * @param callable $function_to_add
+ * @param int $priority
+ * @param number|null $module_id
+ *
+ * @return bool True if action added, false if no need to add the action since the AJAX call isn't matching.
+ * @uses add_action()
+ *
+ */
+ static function add_ajax_action_static(
+ $tag,
+ $function_to_add,
+ $priority = WP_FS__DEFAULT_PRIORITY,
+ $module_id = null
+ ) {
+ self::$_static_logger->entrance( $tag );
+
+ if ( ! self::is_ajax_action_static( $tag, $module_id ) ) {
+ return false;
+ }
+
+ add_action(
+ 'wp_ajax_' . self::get_ajax_action_static( $tag, $module_id ),
+ $function_to_add,
+ $priority,
+ 0
+ );
+
+ self::$_static_logger->info( "$tag AJAX callback action added." );
+
+ return true;
+ }
+
+ /**
+ * Send a JSON response back to an Ajax request.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.5
+ *
+ * @param mixed $response
+ */
+ static function shoot_ajax_response( $response ) {
+ wp_send_json( $response );
+ }
+
+ /**
+ * Send a JSON response back to an Ajax request, indicating success.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.5
+ *
+ * @param mixed $data Data to encode as JSON, then print and exit.
+ */
+ static function shoot_ajax_success( $data = null ) {
+ wp_send_json_success( $data );
+ }
+
+ /**
+ * Send a JSON response back to an Ajax request, indicating failure.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.5
+ *
+ * @param mixed $error Optional error message.
+ */
+ static function shoot_ajax_failure( $error = '' ) {
+ $result = array( 'success' => false );
+ if ( ! empty( $error ) ) {
+ $result['error'] = $error;
+ }
+
+ wp_send_json( $result );
+ }
+
+ /**
+ * Returns an AJAX URL with a special extra param to indicate whether the request was triggered from the network admin or blog admin.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.5.1
+ *
+ * @param string $wrap_with By default, returns the AJAX URL wrapped with single quotes.
+ *
+ * @return string
+ */
+ static function ajax_url( $wrap_with = "'") {
+ if ( fs_is_network_admin() ) {
+ $param_name = '_fs_network_admin';
+ } else {
+ $param_name = '_fs_blog_admin';
+ }
+
+ $url = admin_url( 'admin-ajax.php', 'relative' );
+ $url .= ( false === strpos( $url, '?' ) ) ? '?' : '&';
+ $url .= "{$param_name}=true";
+
+ return "{$wrap_with}{$url}{$wrap_with}";
+ }
+
+ /**
+ * Apply filter, specific for the current context plugin.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @param string $tag The name of the filter hook.
+ * @param mixed $value The value on which the filters hooked to `$tag` are applied on.
+ *
+ * @return mixed The filtered value after all hooked functions are applied to it.
+ *
+ * @uses apply_filters()
+ */
+ function apply_filters( $tag, $value ) {
+ $args = func_get_args();
+
+ $this->_logger->entrance( $tag );
+
+ array_unshift( $args, $this->get_unique_affix() );
+
+ return call_user_func_array( 'fs_apply_filter', $args );
+ }
+
+ /**
+ * Add filter, specific for the current context plugin.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @param string $tag
+ * @param callable $function_to_add
+ * @param int $priority
+ * @param int $accepted_args
+ *
+ * @uses add_filter()
+ */
+ function add_filter( $tag, $function_to_add, $priority = WP_FS__DEFAULT_PRIORITY, $accepted_args = 1 ) {
+ $this->_logger->entrance( $tag );
+
+ add_filter( $this->get_action_tag( $tag ), $function_to_add, $priority, $accepted_args );
+ }
+
+ /**
+ * Check if has filter.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.4
+ *
+ * @param string $tag
+ * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
+ *
+ * @return false|int
+ *
+ * @uses has_filter()
+ */
+ function has_filter( $tag, $function_to_check = false ) {
+ $this->_logger->entrance( $tag );
+
+ return has_filter( $this->get_action_tag( $tag ), $function_to_check );
+ }
+
+ #endregion
+
+ /**
+ * Override default i18n text phrases.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.6
+ *
+ * @param string[] string $key_value
+ *
+ * @uses fs_override_i18n()
+ */
+ function override_i18n( $key_value ) {
+ fs_override_i18n( $key_value, $this->_slug );
+ }
+
+ /* Account Page
+ ------------------------------------------------------------------------------------------------------------------*/
+ /**
+ * Update site information.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ *
+ * @param bool $store Flush to Database if true.
+ * @param null|int $network_level_or_blog_id Since 2.0.0
+ * @param \FS_Site $site Since 2.0.0
+ */
+ private function _store_site( $store = true, $network_level_or_blog_id = null, FS_Site $site = null, $is_backup = false ) {
+ $this->_logger->entrance();
+
+ if ( is_null( $site ) ) {
+ $site = $this->_site;
+ }
+
+ if ( !isset( $site ) || !is_object($site) || empty( $site->id ) ) {
+ $this->_logger->error( "Empty install ID, can't store site." );
+
+ return;
+ }
+
+ $site_clone = clone $site;
+
+ $sites = self::get_all_sites( $this->_module_type, $network_level_or_blog_id, $is_backup );
+
+ if (
+ ! $is_backup &&
+ is_object( $this->_user ) && $this->_user->id != $site->user_id
+ ) {
+ $this->sync_user_by_current_install( $site->user_id );
+
+ $prev_stored_user_id = $this->_storage->get( 'prev_user_id', false, $network_level_or_blog_id );
+
+ if ( empty( $prev_stored_user_id ) &&
+ is_object($this->_user) && $this->_user->id != $site->user_id
+ ) {
+ /**
+ * Store the current user ID as the previous user ID so that the previous user can be used
+ * as the install's owner while the new owner's details are not yet available.
+ *
+ * This will be executed only in the `replica` site. For example, there are 2 sites, namely `original`
+ * and `replica`, then an ownership change was initiated and completed in the `original`, the `replica`
+ * will be using the previous user until it is updated again (e.g.: until the next clone of `original`
+ * into `replica`.
+ *
+ * @author Leo Fajardo (@leorw)
+ */
+ $this->_storage->store( 'prev_user_id', $sites[ $this->_slug ]->user_id, $network_level_or_blog_id );
+ }
+ }
+
+ $sites[ $this->_slug ] = $site_clone;
+
+ $this->set_account_option(
+ ( $is_backup ? 'prev_' : '' ) . 'sites',
+ $sites,
+ $store,
+ $network_level_or_blog_id
+ );
+ }
+
+ /**
+ * Stores the context site in the sites backup storage. This logic is used before deleting the site info so that it can be restored later on if necessary (e.g., if the automatic clone resolution attempt fails).
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.0
+ */
+ private function back_up_site() {
+ $this->_logger->entrance();
+
+ $site_clone = clone $this->_site;
+
+ $this->_store_site( true, null, $site_clone, true );
+ }
+
+ /**
+ * Update plugin's plans information.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.2
+ *
+ * @param bool $store Flush to Database if true.
+ */
+ private function _store_plans( $store = true ) {
+ $this->_logger->entrance();
+
+ $plans = self::get_all_plans( $this->_module_type );
+
+ // Copy plans.
+ $encrypted_plans = array();
+ for ( $i = 0, $len = count( $this->_plans ); $i < $len; $i ++ ) {
+ $encrypted_plans[] = self::_encrypt_entity( $this->_plans[ $i ] );
+ }
+
+ $plans[ $this->_slug ] = $encrypted_plans;
+
+ $this->set_account_option( 'plans', $plans, $store );
+ }
+
+ /**
+ * Update user's plugin licenses.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @param bool $store
+ * @param number|bool $module_id
+ * @param FS_Plugin_License[] $licenses
+ */
+ private function _store_licenses( $store = true, $module_id = false, $licenses = array() ) {
+ $this->_logger->entrance();
+
+ $all_licenses = self::get_all_licenses();
+
+ if ( ! FS_Plugin::is_valid_id( $module_id ) ) {
+ $module_id = $this->_module_id;
+
+ $user_licenses = is_array( $this->_licenses ) ?
+ $this->_licenses :
+ array();
+
+ if ( empty( $user_licenses ) ) {
+ // If the context user doesn't have any license, don't update the licenses collection.
+ return;
+ }
+
+ $new_user_licenses_map = array();
+ foreach ( $user_licenses as $user_license ) {
+ $new_user_licenses_map[ $user_license->id ] = $user_license;
+ }
+
+ self::store_user_id_license_ids_map( array_keys( $new_user_licenses_map ), $this->_module_id, $this->_user->id );
+
+ // Update user licenses.
+ $licenses_to_update_count = count( $new_user_licenses_map );
+ foreach ( $all_licenses[ $module_id ] as $key => $license ) {
+ if ( 0 === $licenses_to_update_count ) {
+ break;
+ }
+
+ if ( isset( $new_user_licenses_map[ $license->id ] ) ) {
+ // Update license.
+ $all_licenses[ $module_id ][ $key ] = $new_user_licenses_map[ $license->id ];
+ unset( $new_user_licenses_map[ $license->id ] );
+
+ $licenses_to_update_count --;
+ }
+ }
+
+ if ( ! empty( $new_user_licenses_map ) ) {
+ // Add new licenses.
+ $all_licenses[ $module_id ] = array_merge( array_values( $new_user_licenses_map ), $all_licenses[ $module_id ] );
+ }
+
+ $licenses = $all_licenses[ $module_id ];
+ }
+
+ if ( ! isset( $all_licenses[ $module_id ] ) ) {
+ $all_licenses[ $module_id ] = array();
+ }
+
+ $all_licenses[ $module_id ] = $licenses;
+
+ self::$_accounts->set_option( 'all_licenses', $all_licenses, $store );
+ }
+
+ /**
+ * Update user information.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ *
+ * @param bool $store Flush to Database if true.
+ */
+ private function _store_user( $store = true ) {
+ $this->_logger->entrance();
+
+ if ( empty( $this->_user->id ) ) {
+ $this->_logger->error( "Empty user ID, can't store user." );
+
+ return;
+ }
+
+ $users = self::get_all_users();
+ $users[ $this->_user->id ] = $this->_user;
+ self::$_accounts->set_option( 'users', $users, $store );
+ }
+
+ /**
+ * Update new updates information.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.4
+ *
+ * @param FS_Plugin_Tag|null $update
+ * @param bool $store Flush to Database if true.
+ * @param bool|number $plugin_id
+ */
+ private function _store_update( $update, $store = true, $plugin_id = false ) {
+ $this->_logger->entrance();
+
+ if ( $update instanceof FS_Plugin_Tag ) {
+ $update->updated = time();
+ }
+
+ if ( ! is_numeric( $plugin_id ) ) {
+ $plugin_id = $this->_plugin->id;
+ }
+
+ $updates = self::get_all_updates();
+ $updates[ $plugin_id ] = $update;
+ self::$_accounts->set_option( 'updates', $updates, $store );
+ }
+
+ /**
+ * Update new updates information.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ *
+ * @param FS_Plugin[] $plugin_addons
+ * @param bool $store Flush to Database if true.
+ */
+ private function _store_addons( $plugin_addons, $store = true ) {
+ $this->_logger->entrance();
+
+ $addons = self::get_all_addons();
+ $addons[ $this->_plugin->id ] = $plugin_addons;
+ self::$_accounts->set_option( 'addons', $addons, $store );
+ }
+
+ /**
+ * Delete plugin's associated add-ons.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.8
+ *
+ * @param bool $store
+ *
+ * @return bool
+ */
+ private function _delete_account_addons( $store = true ) {
+ $all_addons = self::get_all_account_addons();
+
+ if ( ! isset( $all_addons[ $this->_plugin->id ] ) ) {
+ return false;
+ }
+
+ unset( $all_addons[ $this->_plugin->id ] );
+
+ self::$_accounts->set_option( 'account_addons', $all_addons, $store );
+
+ return true;
+ }
+
+ /**
+ * Update account add-ons list.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ *
+ * @param FS_Plugin[] $addons
+ * @param bool $store Flush to Database if true.
+ */
+ private function _store_account_addons( $addons, $store = true ) {
+ $this->_logger->entrance();
+
+ $all_addons = self::get_all_account_addons();
+ $all_addons[ $this->_plugin->id ] = $addons;
+ self::$_accounts->set_option( 'account_addons', $all_addons, $store );
+ }
+
+ /**
+ * Purges the cache for the valid user licenses API call so that when the `Account` or `Add-Ons` page is loaded,
+ * the valid user licenses will be fetched again and the account add-ons may be updated.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.4
+ */
+ private function purge_valid_user_licenses_cache() {
+ if ( ! $this->is_registered() ) {
+ return;
+ }
+
+ $this->get_api_user_scope()->purge_cache( $this->get_valid_user_licenses_endpoint() );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.0
+ *
+ * @param array $all_licenses
+ * @param number|null $site_license_id
+ * @param bool $include_parent_licenses
+ *
+ * @return array
+ */
+ private function get_foreign_licenses_info( $all_licenses, $site_license_id = null, $include_parent_licenses = false ) {
+ $foreign_licenses = array(
+ 'ids' => array(),
+ 'license_keys' => array()
+ );
+
+ $parent_license_ids_map = array();
+
+ foreach ( $all_licenses as $license ) {
+ if ( $license->user_id == $this->_user->id || $license->id == $site_license_id ) {
+ continue;
+ }
+
+ $foreign_licenses['ids'][] = $license->id;
+ $foreign_licenses['license_keys'][] = $license->secret_key;
+
+ if (
+ $include_parent_licenses &&
+ is_object( $this->_license ) &&
+ FS_Plugin_License::is_valid_id( $this->_license->parent_license_id ) &&
+ ! isset( $parent_license_ids_map[ $this->_license->parent_license_id ] )
+ ) {
+ /**
+ * Include the parent license's info only if it has not been included before since child licenses
+ * can have the same parent license.
+ */
+ $foreign_licenses['ids'][] = $this->_license->parent_license_id;
+ $foreign_licenses['license_keys'][] = $license->secret_key;
+
+ $parent_license_ids_map[ $this->_license->parent_license_id ] = true;
+ }
+ }
+
+ if ( empty( $foreign_licenses['ids'] ) ) {
+ $foreign_licenses = array();
+ }
+
+ return $foreign_licenses;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.0
+ *
+ * @return string
+ */
+ private function get_valid_user_licenses_endpoint() {
+ $user_licenses_endpoint = '/licenses.json?type=active' .
+ ( FS_Plugin::is_valid_id( $this->get_bundle_id() ) ? '&is_enriched=true' : '' );
+
+ $foreign_licenses = $this->get_foreign_licenses_info( self::get_all_licenses( $this->_module_id ), null, true );
+
+ if ( ! empty ( $foreign_licenses ) ) {
+ $foreign_licenses = array(
+ // Prefix with `+` to tell the server to include foreign licenses in the licenses collection.
+ 'ids' => ( urlencode( '+' ) . implode( ',', $foreign_licenses['ids'] ) ),
+ 'license_keys' => implode( ',', array_map( 'urlencode', $foreign_licenses['license_keys'] ) )
+ );
+
+ $user_licenses_endpoint = add_query_arg( $foreign_licenses, $user_licenses_endpoint );
+ }
+
+ return $user_licenses_endpoint;
+ }
+
+ /**
+ * Fetches active licenses that are enriched with product type if there's a context `bundle_id` and bundle
+ * licenses enriched with product IDs if there are any. From the licenses, the `get_updated_account_addons`
+ * method filters out non–add-on product IDs and stores the add-on IDs.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.4
+ *
+ * @return stdClass[] array
+ */
+ private function fetch_valid_user_licenses() {
+ $this->_logger->entrance();
+
+ $result = $this->get_api_user_scope()->get( $this->get_valid_user_licenses_endpoint() );
+
+ if ( ! $this->is_api_result_object( $result, 'licenses' ) ||
+ ! is_array( $result->licenses )
+ ) {
+ return array();
+ }
+
+ return $result->licenses;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.4
+ *
+ * @return number[] Account add-on IDs.
+ */
+ function get_updated_account_addons() {
+ $addons = $this->get_addons();
+ if ( empty( $addons ) ) {
+ return array();
+ }
+
+ $account_addons = $this->get_account_addons();
+ if ( ! is_array( $account_addons ) ) {
+ $account_addons = array();
+ }
+
+ $user_licenses = $this->is_registered() ?
+ $this->fetch_valid_user_licenses() :
+ array();
+
+ if ( empty( $user_licenses ) ) {
+ return $account_addons;
+ }
+
+ $addon_ids = array();
+ foreach ( $addons as $addon ) {
+ $addon_ids[] = $addon->id;
+ }
+
+ $license_product_ids = array();
+
+ foreach ( $user_licenses as $license ) {
+ if ( isset( $license->plugin_type ) && 'bundle' === $license->plugin_type ) {
+ $license_product_ids = array_merge( $license_product_ids, $license->products );
+ } else {
+ $license_product_ids[] = $license->plugin_id;
+ }
+ }
+
+ // Filter out non–add-on IDs.
+ $new_account_addons = array_intersect( $addon_ids, $license_product_ids );
+ if ( count( $new_account_addons ) !== count( $account_addons ) ) {
+ $this->_store_account_addons( array_unique( $new_account_addons ) );
+ }
+
+ return $new_account_addons;
+ }
+
+ /**
+ * Store account params in the Database.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.1
+ *
+ * @param null|int $blog_id Since 2.0.0
+ */
+ private function _store_account( $blog_id = null ) {
+ $this->_logger->entrance();
+
+ $this->_store_site( false, $blog_id );
+ $this->_store_user( false );
+ $this->_store_plans( false );
+ $this->_store_licenses( false );
+
+ self::$_accounts->store( $blog_id );
+ }
+
+ /**
+ * Sync user's information.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.3
+ * @uses FS_Api
+ */
+ private function _handle_account_user_sync() {
+ $this->_logger->entrance();
+
+ $api = $this->get_api_user_scope();
+
+ // Get user's information.
+ $user = $api->get( '/', true );
+
+ if ( isset( $user->id ) ) {
+ $this->_user->first = $user->first;
+ $this->_user->last = $user->last;
+ $this->_user->email = $user->email;
+
+ $is_menu_item_account_visible = $this->is_submenu_item_visible( 'account' );
+
+ if ( $user->is_verified &&
+ ( ! isset( $this->_user->is_verified ) || false === $this->_user->is_verified )
+ ) {
+ $this->_user->is_verified = true;
+
+ $this->do_action( 'account_email_verified', $user->email );
+
+ $this->_admin_notices->add(
+ $this->get_text_inline( 'Your email has been successfully verified - you are AWESOME!', 'email-verified-message' ),
+ $this->get_text_x_inline( 'Right on', 'a positive response', 'right-on' ) . '!',
+ 'success',
+ // Make admin sticky if account menu item is invisible,
+ // since the page will be auto redirected to the plugin's
+ // main settings page, and the non-sticky message
+ // will disappear.
+ ! $is_menu_item_account_visible,
+ 'email_verified'
+ );
+ }
+
+ // Flush user details to DB.
+ $this->_store_user();
+
+ $this->do_action( 'after_account_user_sync', $user );
+
+ /**
+ * If account menu item is hidden, redirect to plugin's main settings page.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.6
+ *
+ * @link https://github.com/Freemius/wordpress-sdk/issues/6
+ */
+ if ( ! $is_menu_item_account_visible ) {
+ fs_redirect( $this->_get_admin_page_url() );
+ }
+ }
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ * @uses FS_Api
+ *
+ * @param number|bool $license_id
+ *
+ * @return FS_Subscription|object|bool
+ */
+ private function _fetch_site_license_subscription( $license_id = false ) {
+ $this->_logger->entrance();
+ $api = $this->get_api_site_scope();
+
+ if ( ! is_numeric( $license_id ) ) {
+ $license_id = FS_Plugin_License::is_valid_id( $this->_license->parent_license_id ) ?
+ $this->_license->parent_license_id :
+ $this->_license->id;
+ }
+
+ $result = $api->get( "/licenses/{$license_id}/subscriptions.json", true );
+
+ return ! isset( $result->error ) ?
+ ( ( is_array( $result->subscriptions ) && 0 < count( $result->subscriptions ) ) ?
+ new FS_Subscription( $result->subscriptions[0] ) :
+ false
+ ) :
+ $result;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.4
+ * @uses FS_Api
+ *
+ * @param number|bool $plan_id
+ *
+ * @return FS_Plugin_Plan|object
+ */
+ private function _fetch_site_plan( $plan_id = false ) {
+ $this->_logger->entrance();
+ $api = $this->get_api_site_scope();
+
+ if ( ! is_numeric( $plan_id ) ) {
+ $plan_id = $this->_site->plan_id;
+ }
+
+ $plan = $api->get( "/plans/{$plan_id}.json", true );
+
+ return ! isset( $plan->error ) ? new FS_Plugin_Plan( $plan ) : $plan;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ * @uses FS_Api
+ *
+ * @return FS_Plugin_Plan[]|object
+ */
+ private function _fetch_plugin_plans() {
+ $this->_logger->entrance();
+ $api = $this->get_current_or_network_user_api_scope();
+
+ /**
+ * @since 1.2.3 When running in DEV mode, retrieve pending plans as well.
+ */
+ $result = $api->get( $this->add_show_pending( "/plugins/{$this->_module_id}/plans.json" ), true );
+
+ if ( $this->is_api_result_object( $result, 'plans' ) && is_array( $result->plans ) ) {
+ for ( $i = 0, $len = count( $result->plans ); $i < $len; $i ++ ) {
+ $result->plans[ $i ] = new FS_Plugin_Plan( $result->plans[ $i ] );
+ }
+
+ $result = $result->plans;
+ }
+
+ return $result;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param number $plan_id
+ *
+ * @return \FS_Plugin_Plan|object
+ */
+ private function fetch_plan_by_id( $plan_id ) {
+ $this->_logger->entrance();
+ $api = $this->get_current_or_network_user_api_scope();
+
+ $result = $api->get( "/plugins/{$this->_module_id}/plans/{$plan_id}.json", true );
+
+ return $this->is_api_result_entity( $result ) ?
+ new FS_Plugin_Plan( $result ) :
+ $result;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ * @uses FS_Api
+ *
+ * @param number|bool $plugin_id
+ * @param number|bool $site_license_id
+ * @param array $foreign_licenses @since 2.0.0. This is used by network-activated plugins.
+ * @param number|null $blog_id
+ *
+ * @return FS_Plugin_License[]|object
+ */
+ private function _fetch_licenses(
+ $plugin_id = false,
+ $site_license_id = false,
+ $foreign_licenses = array(),
+ $blog_id = null
+ ) {
+ $this->_logger->entrance();
+
+ $api = $this->get_api_user_scope();
+
+ if ( ! is_numeric( $plugin_id ) ) {
+ $plugin_id = $this->_plugin->id;
+ }
+
+ $user_licenses_endpoint = "/plugins/{$plugin_id}/licenses.json?is_enriched=true";
+ if ( ! empty ( $foreign_licenses ) ) {
+ $foreign_licenses = array(
+ // Prefix with `+` to tell the server to include foreign licenses in the licenses collection.
+ 'ids' => ( urlencode( '+' ) . implode( ',', $foreign_licenses['ids'] ) ),
+ 'license_keys' => implode( ',', array_map( 'urlencode', $foreign_licenses['license_keys'] ) )
+ );
+
+ $user_licenses_endpoint = add_query_arg( $foreign_licenses, $user_licenses_endpoint );
+ }
+
+ $result = $api->get( $user_licenses_endpoint, true );
+
+ $is_site_license_synced = false;
+
+ $api_errors = array();
+
+ if ( $this->is_api_result_object( $result, 'licenses' ) &&
+ is_array( $result->licenses )
+ ) {
+ for ( $i = 0, $len = count( $result->licenses ); $i < $len; $i ++ ) {
+ $result->licenses[ $i ] = new FS_Plugin_License( $result->licenses[ $i ] );
+
+ if ( ( ! $is_site_license_synced ) && is_numeric( $site_license_id ) ) {
+ $is_site_license_synced = ( $site_license_id == $result->licenses[ $i ]->id );
+ }
+ }
+
+ $result = $result->licenses;
+ } else {
+ $api_errors[] = $result;
+ $result = array();
+ }
+
+ if ( ! $is_site_license_synced ) {
+ if ( ! is_null( $blog_id ) ) {
+ /**
+ * If blog ID is not null, the request is for syncing of the license of a single site via the
+ * network-level "Account" page.
+ *
+ * @author Leo Fajardo (@leorw)
+ */
+ $this->switch_to_blog( $blog_id );
+ }
+
+ $api = $this->get_api_site_scope();
+
+ if ( is_numeric( $site_license_id ) ) {
+ // Try to retrieve a foreign license that is linked to the install.
+ $api_result = $api->call( '/licenses.json?is_enriched=true' );
+
+ if ( $this->is_api_result_object( $api_result, 'licenses' ) &&
+ is_array( $api_result->licenses )
+ ) {
+ $licenses = $api_result->licenses;
+
+ if ( ! empty( $licenses ) ) {
+ $result[] = new FS_Plugin_License( $licenses[0] );
+ }
+ } else {
+ $api_errors[] = $api_result;
+ }
+ } else if (
+ is_object( $this->_license ) &&
+ /**
+ * Sync only if the license belongs to the context plugin. `$plugin_id` can be an add-on ID while
+ * the FS instance that does the syncing is the parent FS instance.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.0
+ */
+ $this->_license->plugin_id == $plugin_id
+ ) {
+ $is_license_in_result = false;
+ if ( ! empty( $result ) ) {
+ foreach ( $result as $license ) {
+ if ( $license->id == $this->_license->id ) {
+ $is_license_in_result = true;
+ break;
+ }
+ }
+ }
+
+ if ( ! $is_license_in_result ) {
+ // Fetch foreign license by ID and license key.
+ $license = $api->get( "/licenses/{$this->_license->id}.json?license_key=" .
+ urlencode( $this->_license->secret_key ) . '&is_enriched=true' );
+
+ if ( $this->is_api_result_entity( $license ) ) {
+ $result[] = new FS_Plugin_License( $license );
+ } else {
+ $api_errors[] = $license;
+ }
+ }
+ }
+
+ if ( ! is_null( $blog_id ) ) {
+ $this->switch_to_blog( $this->_storage->network_install_blog_id );
+ }
+ }
+
+ if ( is_array( $result ) && 0 < count( $result ) ) {
+ // If found at least one license, return license collection even if there are errors.
+ return $result;
+ }
+
+ if ( ! empty( $api_errors ) ) {
+ // If found any errors and no licenses, return first error.
+ return $api_errors[0];
+ }
+
+ // Fallback to empty licenses list.
+ return $result;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param number $license_id
+ * @param string $license_key
+ *
+ * @return \FS_Plugin_License|object
+ */
+ private function fetch_license_by_key( $license_id, $license_key ) {
+ $this->_logger->entrance();
+
+ $api = $this->get_current_or_network_user_api_scope();
+
+ $result = $api->get( "/licenses/{$license_id}.json?license_key=" . urlencode( $license_key ) );
+
+ return $this->is_api_result_entity( $result ) ?
+ new FS_Plugin_License( $result ) :
+ $result;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.0
+ * @uses FS_Api
+ *
+ * @param number|bool $plugin_id
+ * @param bool $flush
+ *
+ * @return FS_Payment[]|object
+ */
+ function _fetch_payments( $plugin_id = false, $flush = false ) {
+ $this->_logger->entrance();
+
+ $api = $this->get_api_user_scope();
+
+ if ( ! is_numeric( $plugin_id ) ) {
+ $plugin_id = $this->_plugin->id;
+ }
+
+ $include_bundles = (
+ is_object( $this->_plugin ) &&
+ FS_Plugin::is_valid_id( $this->_plugin->bundle_id )
+ );
+
+ $result = $api->get(
+ "/plugins/{$plugin_id}/payments.json?include_addons=true" . ($include_bundles ? '&include_bundles=true' : ''),
+ $flush
+ );
+
+ if ( ! isset( $result->error ) ) {
+ for ( $i = 0, $len = count( $result->payments ); $i < $len; $i ++ ) {
+ $result->payments[ $i ] = new FS_Payment( $result->payments[ $i ] );
+ }
+ $result = $result->payments;
+ }
+
+ return $result;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.5
+ * @uses FS_Api
+ *
+ * @param bool $flush
+ *
+ * @return \FS_Billing|mixed
+ */
+ function _fetch_billing( $flush = false ) {
+ require_once WP_FS__DIR_INCLUDES . '/entities/class-fs-billing.php';
+
+ $billing = $this->get_api_user_scope()->get( 'billing.json', $flush );
+
+ if ( $this->is_api_result_entity( $billing ) ) {
+ $billing = new FS_Billing( $billing );
+ }
+
+ return $billing;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @param FS_Plugin_License[] $licenses
+ * @param number $module_id
+ */
+ private function _update_licenses( $licenses, $module_id ) {
+ $this->_logger->entrance();
+
+ if ( is_array( $licenses ) ) {
+ for ( $i = 0, $len = count( $licenses ); $i < $len; $i ++ ) {
+ $licenses[ $i ]->updated = time();
+ }
+ }
+
+ $this->_store_licenses( true, $module_id, $licenses );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.4
+ *
+ * @param bool|number $plugin_id
+ * @param bool $flush Since 1.1.7.3
+ * @param int $expiration Since 1.2.2.7
+ * @param bool|string $newer_than Since 2.2.1
+ *
+ * @return object|false New plugin tag info if exist.
+ */
+ private function _fetch_newer_version( $plugin_id = false, $flush = true, $expiration = WP_FS__TIME_24_HOURS_IN_SEC, $newer_than = false ) {
+ $latest_tag = $this->_fetch_latest_version( $plugin_id, $flush, $expiration, $newer_than );
+
+ if ( ! is_object( $latest_tag ) ) {
+ return false;
+ }
+
+ $plugin_version = $this->get_plugin_version();
+
+ // Check if version is actually newer.
+ $has_new_version =
+ // If it's an non-installed add-on then always return latest.
+ ( $this->_is_addon_id( $plugin_id ) && ! $this->is_addon_activated( $plugin_id ) ) ||
+ // Compare versions.
+ version_compare( $plugin_version, $latest_tag->version, '<' );
+
+ $this->_logger->departure( $has_new_version ? 'Found newer plugin version ' . $latest_tag->version : 'No new version' );
+
+ $is_latest_version_beta = ( 'beta' === $latest_tag->release_mode );
+
+ $this->_storage->beta_data = array(
+ 'is_beta' => $is_latest_version_beta,
+ 'version' => $latest_tag->version
+ );
+
+ return $has_new_version ? $latest_tag : false;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @param bool|number $plugin_id
+ * @param bool $flush Since 1.1.7.3
+ * @param int $expiration Since 1.2.2.7
+ * @param bool|string $newer_than Since 2.2.1
+ *
+ * @return bool|FS_Plugin_Tag
+ */
+ function get_update( $plugin_id = false, $flush = true, $expiration = FS_Plugin_Updater::UPDATES_CHECK_CACHE_EXPIRATION, $newer_than = false ) {
+ $this->_logger->entrance();
+
+ if ( ! is_numeric( $plugin_id ) ) {
+ $plugin_id = $this->_plugin->id;
+ }
+
+ $this->check_updates( true, $plugin_id, $flush, $expiration, $newer_than );
+ $updates = $this->get_all_updates();
+
+ return isset( $updates[ $plugin_id ] ) && is_object( $updates[ $plugin_id ] ) ? $updates[ $plugin_id ] : false;
+ }
+
+ /**
+ * Check if site assigned with active license.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ *
+ * @deprecated Please use has_active_valid_license() instead because license can be cancelled.
+ */
+ function has_active_license() {
+ return (
+ is_object( $this->_license ) &&
+ is_numeric( $this->_license->id ) &&
+ ! $this->_license->is_expired()
+ );
+ }
+
+ /**
+ * Check if site assigned with active & valid (not expired) license.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1
+ *
+ * @param bool $check_expiration
+ */
+ function has_active_valid_license( $check_expiration = true ) {
+ return self::is_active_valid_license( $this->_license, $check_expiration );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.1
+ */
+ function is_data_debug_mode() {
+ if ( is_null( $this->is_whitelabeled ) || ! $this->is_whitelabeled ) {
+ return false;
+ }
+
+ $fs = $this->is_addon() ?
+ $this->get_parent_instance() :
+ $this;
+
+ if ( $fs->is_network_active() && fs_is_network_admin() ) {
+ $is_developer_license_debug_mode = get_site_transient( "fs_{$this->get_id()}_data_debug_mode" );
+ } else {
+ $is_developer_license_debug_mode = get_transient( "fs_{$this->get_id()}_data_debug_mode" );
+ }
+
+ return ( 'true' === $is_developer_license_debug_mode );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.1
+ */
+ function _set_data_debug_mode() {
+ if ( ! $this->is_whitelabeled( true ) ) {
+ return;
+ }
+
+ $license_or_user_key = fs_request_get_raw( 'license_or_user_key' );
+
+ $transient_value = ( ! empty( $license_or_user_key ) ) ?
+ 'true' :
+ 'false';
+
+ if ( 'true' === $transient_value ) {
+ $stored_key = $this->_storage->get( ! FS_User::is_valid_id( $this->_storage->last_license_user_id ) ?
+ 'last_license_key' :
+ 'last_license_user_key'
+ );
+
+ if ( md5( $license_or_user_key ) !== $stored_key ) {
+ $this->shoot_ajax_failure( sprintf(
+ '%s... %s',
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ),
+ $this->get_text_inline(
+ 'seems like the key you entered doesn\'t match our records.',
+ 'developer-or-license-not-found'
+ )
+ ) );
+ }
+ }
+
+ if ( $this->is_network_active() && fs_is_network_admin() ) {
+ set_site_transient(
+ "fs_{$this->get_id()}_data_debug_mode",
+ $transient_value,
+ WP_FS__TIME_24_HOURS_IN_SEC / 24
+ );
+ } else {
+ set_transient(
+ "fs_{$this->get_id()}_data_debug_mode",
+ $transient_value,
+ WP_FS__TIME_24_HOURS_IN_SEC / 24
+ );
+ }
+
+ if ( 'true' === $transient_value ) {
+ $this->_admin_notices->add_sticky(
+ $this->get_text_inline(
+ 'Debug mode was successfully enabled and will be automatically disabled in 60 min. You can also disable it earlier by clicking the "Stop Debug" link.',
+ 'data_debug_mode_enabled'
+ ),
+ 'data_debug_mode_enabled'
+ );
+ }
+
+ $this->shoot_ajax_success();
+ }
+
+ /**
+ * Check if a given license is active & valid (not expired).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.1.3
+ *
+ * @param FS_Plugin_License $license
+ * @param bool $check_expiration
+ *
+ * @return bool
+ */
+ private static function is_active_valid_license( $license, $check_expiration = true ) {
+ return (
+ is_object( $license ) &&
+ FS_Plugin_License::is_valid_id( $license->id ) &&
+ $license->is_active() &&
+ ( ! $check_expiration || $license->is_valid() )
+ );
+ }
+
+ /**
+ * Checks if there's any site that is associated with an active & valid license.
+ * This logic is used to determine if the admin can download the premium code base from a network level admin.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.1.3
+ *
+ * @return bool
+ */
+ function has_any_active_valid_license() {
+ if ( ! fs_is_network_admin() ) {
+ return $this->has_active_valid_license();
+ }
+
+ $installs = $this->get_blog_install_map();
+ $all_plugin_licenses = self::get_all_licenses( $this->_module_id );
+
+ foreach ( $installs as $blog_id => $install ) {
+ if ( ! FS_Plugin_License::is_valid_id( $install->license_id ) ) {
+ continue;
+ }
+
+ foreach ( $all_plugin_licenses as $license ) {
+ if ( $license->id == $install->license_id ) {
+ if ( self::is_active_valid_license( $license ) ) {
+ return true;
+ }
+ }
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Check if site assigned with license with enabled features.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ *
+ * @return bool
+ */
+ function has_features_enabled_license() {
+ return (
+ is_object( $this->_license ) &&
+ is_numeric( $this->_license->id ) &&
+ $this->_license->is_features_enabled()
+ );
+ }
+
+ /**
+ * Checks if the product is activated with a bundle license.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.4.0
+ *
+ * @return bool
+ */
+ function is_activated_with_bundle_license() {
+ if ( ! $this->has_features_enabled_license() ) {
+ return false;
+ }
+
+ return FS_Plugin_License::is_valid_id( $this->_license->parent_license_id );
+ }
+
+ /**
+ * Check if user is a trial or have feature enabled license.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.7
+ *
+ * @return bool
+ */
+ function can_use_premium_code() {
+ return $this->is_trial() || $this->has_features_enabled_license();
+ }
+
+ /**
+ * Checks if the current user can activate plugins or switch themes. Note that this method should only be used
+ * after the `init` action is triggered because it is using `current_user_can()` which is only functional after
+ * the context user is authenticated.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 1.2.2
+ *
+ * @return bool
+ */
+ function is_user_admin() {
+ /**
+ * Require a super-admin when network activated, running from the network level OR if
+ * running from the site level but not delegated the opt-in.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ */
+ if ( $this->_is_network_active &&
+ ( fs_is_network_admin() || ! $this->is_delegated_connection() )
+ ) {
+ return is_super_admin();
+ }
+
+ return ( $this->is_plugin() && current_user_can( is_multisite() ? 'manage_options' : 'activate_plugins' ) )
+ || ( $this->is_theme() && current_user_can( 'switch_themes' ) );
+ }
+
+ /**
+ * Sync site's plan.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.3
+ *
+ * @uses FS_Api
+ *
+ * @param bool $background Hints the method if it's a background sync. If false, it means that was initiated by
+ * the admin.
+ * @param bool $is_context_single_site @since 2.0.0. This is used when syncing a license for a single install from the
+ * network-level "Account" page.
+ * @param int|null $current_blog_id @since 2.2.3. This is passed from the `execute_cron` method and used by the
+ * `_sync_plugin_license` method in order to switch to the previous blog when sending
+ * updates for a single site in case `execute_cron` has switched to a different blog.
+ */
+ private function _sync_license( $background = false, $is_context_single_site = false, $current_blog_id = null ) {
+ $this->_logger->entrance();
+
+ $plugin_id = fs_request_get( 'plugin_id', $this->get_id() );
+
+ $is_addon_sync = ( ! $this->_plugin->is_addon() && $plugin_id != $this->get_id() );
+
+ if ( $is_addon_sync ) {
+ $this->_sync_addon_license( $plugin_id, $background );
+ } else {
+ $this->_sync_plugin_license( $background, true, $is_context_single_site, $current_blog_id );
+ }
+
+ $this->do_action( 'after_account_plan_sync', $this->get_plan_name() );
+ }
+
+ /**
+ * Sync plugin's add-on license.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ * @uses FS_Api
+ *
+ * @param number $addon_id
+ * @param bool $background
+ */
+ private function _sync_addon_license( $addon_id, $background ) {
+ $this->_logger->entrance();
+
+ if ( $this->is_addon_activated( $addon_id ) ) {
+ // If already installed, use add-on sync.
+ $fs_addon = self::get_instance_by_id( $addon_id );
+
+ if (
+ // Add-on is network activated and network integrated.
+ $fs_addon->is_network_active() ||
+ // Background sync cron.
+ self::is_cron() ||
+ // Add-on is not network activated or not network integrated.
+ ! fs_is_network_admin()
+ ) {
+ $fs_addon->_sync_license( $background );
+
+ return;
+ }
+ }
+
+ // Validate add-on exists.
+ $addon = $this->get_addon( $addon_id );
+
+ if ( ! is_object( $addon ) ) {
+ return;
+ }
+
+ // Add add-on into account add-ons.
+ $account_addons = $this->get_account_addons();
+ if ( ! is_array( $account_addons ) ) {
+ $account_addons = array();
+ }
+ $account_addons[] = $addon->id;
+ $account_addons = array_unique( $account_addons );
+ $this->_store_account_addons( $account_addons );
+
+ // Load add-on licenses.
+ $licenses = $this->_fetch_licenses( $addon->id );
+
+ // Sync add-on licenses.
+ if ( $this->is_array_instanceof( $licenses, 'FS_Plugin_License' ) ) {
+ $this->_update_licenses( $licenses, $addon->id );
+
+ if ( ! $this->is_addon_installed( $addon->id ) && FS_License_Manager::has_premium_license( $licenses ) ) {
+ $plans_result = $this->get_api_site_or_plugin_scope()->get( $this->add_show_pending( "/addons/{$addon_id}/plans.json" ) );
+
+ if ( ! isset( $plans_result->error ) ) {
+ $plans = array();
+ foreach ( $plans_result->plans as $plan ) {
+ $plans[] = new FS_Plugin_Plan( $plan );
+ }
+
+ $this->_admin_notices->add_sticky(
+ sprintf(
+ ( FS_Plan_Manager::instance()->has_free_plan( $plans ) ?
+ $this->get_text_inline( 'Your %s Add-on plan was successfully upgraded.', 'addon-successfully-upgraded-message' ) :
+ /* translators: %s:product name, e.g. Facebook add-on was successfully... */
+ $this->get_text_inline( '%s Add-on was successfully purchased.', 'addon-successfully-purchased-message' ) ),
+ $addon->title
+ ) . ' ' . $this->get_latest_download_link(
+ $this->get_text_inline( 'Download the latest version', 'download-latest-version' ),
+ $addon_id
+ ),
+ 'addon_plan_upgraded_' . $addon->slug,
+ $this->get_text_x_inline( 'Yee-haw', 'interjection expressing joy or exuberance', 'yee-haw' ) . '!'
+ );
+ }
+ }
+ }
+ }
+
+ /**
+ * Sync site's plugin plan.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ * @uses FS_Api
+ *
+ * @param bool $background Hints the method if it's a background sync. If false, it means that was initiated by the admin.
+ * @param bool $send_installs_update Since 2.0.0
+ * @param bool $is_context_single_site Since 2.0.0. This is used when sending an update for a single install and
+ * syncing its license from the network-level "Account" page (e.g.: after
+ * activating a license only for the single install).
+ * @param int|null $current_blog_id Since 2.2.3. This is passed from the `execute_cron` method so that it
+ * can be used here to switch to the previous blog in case `execute_cron`
+ * has switched to a different blog.
+ */
+ private function _sync_plugin_license(
+ $background = false,
+ $send_installs_update = true,
+ $is_context_single_site = false,
+ $current_blog_id = null
+ ) {
+ $this->_logger->entrance();
+
+ $plan_change = 'none';
+
+ $is_site_level_sync = ( $is_context_single_site || fs_is_blog_admin() || ! $this->_is_network_active );
+
+ if ( ! $send_installs_update ) {
+ $site = $this->_site;
+ } else {
+ /**
+ * Sync site info.
+ *
+ * @todo This line will execute install sync on a daily basis, even if running the free version (for opted-in users). The reason we want to keep it that way is for cases when the user was a paying customer, then there was a failure in subscription payment, and then after some time the payment was successful. This could be heavily optimized. For example, we can skip the $flush if the current install was never associated with a paid version.
+ */
+ if ( $is_site_level_sync ) {
+ /**
+ * Switch to the previous blog since `execute_cron` may have switched to a different blog.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.3
+ */
+ if ( is_numeric( $current_blog_id ) ) {
+ $this->switch_to_blog( $current_blog_id );
+ }
+
+ $result = $this->send_install_update( array(), true, true );
+ $is_valid = $this->is_api_result_entity( $result );
+ } else {
+ $result = $this->send_installs_update( array(), true, true );
+ $is_valid = $this->is_api_result_object( $result, 'installs' );
+ }
+
+ if ( ! $is_valid ) {
+ if ( $is_context_single_site ) {
+ // Switch back to the main blog so that the following logic will have the right entities.
+ $this->switch_to_blog( $this->_storage->network_install_blog_id );
+ }
+
+ // Show API message only if not background sync or if paying customer.
+ if ( ! $background || $this->is_paying() ) {
+ // Try to ping API to see if not blocked.
+ if ( FS_Api::is_blocked( $result ) ) {
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.6 Only show message related to one of the Freemius powered plugins. Once it will be resolved it will fix the issue for all plugins anyways. There's no point to scare users with multiple error messages.
+ */
+ if ( ! self::$_global_admin_notices->has_sticky( 'api_blocked' ) ) {
+ // Add notice immediately if not a background sync.
+ $add_notice = ( ! $background );
+
+ if ( ! $add_notice ) {
+ $counter = (int) get_transient( '_fs_api_connection_retry_counter' );
+
+ // We only want to add the notice after 3 consecutive failures.
+ $add_notice = ( 3 <= $counter );
+
+ if ( ! $add_notice ) {
+ /**
+ * Update counter transient only if notice shouldn't be added. If it is added the transient will be reset anyway, because the retries mechanism should only start counting if the admin isn't aware of the connectivity issue.
+ *
+ * Also, since the background sync happens once a day, setting the transient expiration for a week should be enough to count 3 failures, if there's an actual connectivity issue.
+ */
+ set_transient( '_fs_api_connection_retry_counter', $counter + 1, WP_FS__TIME_WEEK_IN_SEC );
+ }
+ }
+
+ // Add notice instantly for not-background sync and only after 3 failed attempts for background sync.
+ if ( $add_notice ) {
+ self::$_global_admin_notices->add(
+ $this->generate_api_blocked_notice_message_from_result( $result ),
+ '',
+ 'error',
+ $background,
+ 'api_blocked'
+ );
+
+ add_action( 'admin_footer', array( 'Freemius', '_add_api_connectivity_notice_handler_js' ) );
+
+ // Notice was just shown, reset connectivity counter.
+ delete_transient( '_fs_api_connection_retry_counter' );
+ }
+ }
+ } else if ( is_object( $result ) ) {
+ // Authentication params are broken.
+ $this->_admin_notices->add(
+ $this->get_text_inline( 'It seems like one of the authentication parameters is wrong. Update your Public Key, Secret Key & User ID, and try again.', 'wrong-authentication-param-message' ) . '' . $plan->title . ( $this->is_trial() ? ' ' . $this->get_text_x_inline( 'Trial', 'trial period', 'trial' ) : '' ) . ' %s ',
+ $this->contact_url(
+ 'bug',
+ sprintf( $this->get_text_inline( 'I have upgraded my account but when I try to Sync the License, the plan remains %s.', 'plan-did-not-change-email-message' ),
+ strtoupper( $plan->name )
+ )
+ ),
+ $this->get_text_inline( 'Please contact us here', 'contact-us-here' )
+ ),
+ $hmm_text
+ );
+ }
+ }
+ break;
+ case 'upgraded':
+ case 'activated':
+ $this->add_after_plan_activation_or_upgrade_instructions_notice( 'upgraded' === $plan_change );
+
+ $this->_admin_notices->remove_sticky( array(
+ 'trial_started',
+ 'trial_promotion',
+ 'trial_expired',
+ 'activation_complete',
+ 'license_expired',
+ ) );
+ break;
+ case 'extended':
+ $this->_admin_notices->remove_sticky( array(
+ 'trial_expired',
+ 'license_expired',
+ ) );
+ break;
+ case 'changed':
+ $this->_admin_notices->add_sticky(
+ sprintf(
+ $this->get_text_inline( 'Your plan was successfully changed to %s.', 'plan-changed-to-x-message' ),
+ $this->get_plan_title()
+ ),
+ 'plan_changed'
+ );
+
+ $this->_admin_notices->remove_sticky( array(
+ 'trial_started',
+ 'trial_promotion',
+ 'trial_expired',
+ 'activation_complete',
+ ) );
+ break;
+ case 'downgraded':
+ $this->_admin_notices->add_sticky(
+ ($this->has_free_plan() ?
+ sprintf( $this->get_text_inline( 'Your license has expired. You can still continue using the free %s forever.', 'license-expired-blocking-message' ), $this->_module_type ) :
+ /* translators: %1$s: product title; %2$s, %3$s: wrapping HTML anchor element; %4$s: 'plugin', 'theme', or 'add-on'. */
+ sprintf( $this->get_text_inline( 'Your license has expired. %1$sUpgrade now%2$s to continue using the %3$s without interruptions.', 'license-expired-blocking-message_premium-only' ), sprintf('', $this->pricing_url()), ' ', $this->get_module_label(true) ) ),
+ 'license_expired',
+ $hmm_text
+ );
+ $this->_admin_notices->remove_sticky( 'plan_upgraded' );
+ break;
+ case 'cancelled':
+ $this->_admin_notices->add(
+ $this->get_text_inline( 'Your license has been cancelled. If you think it\'s a mistake, please contact support.', 'license-cancelled' ) . ' ' .
+ sprintf(
+ '%s ',
+ $this->contact_url( 'bug' ),
+ $this->get_text_inline( 'Please contact us here', 'contact-us-here' )
+ ),
+ $hmm_text,
+ 'error'
+ );
+ $this->_admin_notices->remove_sticky( 'plan_upgraded' );
+ break;
+ case 'expired':
+ $this->_admin_notices->add_sticky(
+ sprintf( $this->get_text_inline( 'Your license has expired. You can still continue using all the %s features, but you\'ll need to renew your license to continue getting updates and support.', 'license-expired-non-blocking-message' ), $this->get_plan()->title ),
+ 'license_expired',
+ $hmm_text
+ );
+
+ $this->_storage->expired_license_notice_shown = WP_FS__SCRIPT_START_TIME;
+
+ $this->_admin_notices->remove_sticky( 'plan_upgraded' );
+ break;
+ case 'trial_started':
+ $this->add_complete_upgrade_instructions_notice(
+ sprintf(
+ $this->get_text_inline( 'Your trial has been successfully started.', 'trial-started-message' ),
+ '' . $this->get_plugin_name() . ' '
+ ),
+ 'trial_started',
+ $this->get_trial_plan()->title
+ );
+
+ $this->_admin_notices->remove_sticky( array(
+ 'trial_promotion',
+ ) );
+ break;
+ case 'trial_expired':
+ $this->_admin_notices->add_sticky(
+ ($this->has_free_plan() ?
+ $this->get_text_inline( 'Your free trial has expired. You can still continue using all our free features.', 'trial-expired-message' ) :
+ /* translators: %1$s: product title; %2$s, %3$s: wrapping HTML anchor element; %4$s: 'plugin', 'theme', or 'add-on'. */
+ sprintf( $this->get_text_inline( 'Your free trial has expired. %1$sUpgrade now%2$s to continue using the %3$s without interruptions.', 'trial-expired-message_premium-only' ), sprintf('', $this->pricing_url()), ' ', $this->get_module_label(true))),
+ 'trial_expired',
+ $hmm_text
+ );
+ $this->_admin_notices->remove_sticky( array(
+ 'trial_started',
+ 'trial_promotion',
+ 'plan_upgraded',
+ ) );
+ break;
+ }
+ }
+
+ if ( 'none' !== $plan_change ) {
+ if (
+ ! is_object( $this->_license ) ||
+ ! $this->_license->is_whitelabeled
+ ) {
+ $this->_admin_notices->remove_sticky( 'license_whitelabeled' );
+ }
+
+ $this->do_action( 'after_license_change', $plan_change, $this->get_plan() );
+ }
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.4
+ *
+ * @param mixed $result
+ *
+ * @return string
+ */
+ private function generate_api_blocked_notice_message_from_result( $result ) {
+ $api_domains = $this->apply_filters( 'api_domains', array(
+ 'api.freemius.com',
+ 'wp.freemius.com',
+ ) );
+
+ $api_domains_list_items = '';
+
+ foreach( $api_domains as $api_domain ) {
+ $api_domains_list_items .= "{$api_domain} ";
+ }
+
+ $error_message = sprintf(
+ $this->get_text_inline( 'Your server is blocking the access to Freemius\' API, which is crucial for %1$s synchronization. Please contact your host to whitelist the following domains:%2$s', 'server-blocking-access' ),
+ $this->get_plugin_name(),
+ "{$api_domains_list_items} " . $this->get_text_inline( 'Show error details', 'show-error-details' ) . " "
+ );
+
+ $error_message =
+ "{$error_message}
" .
+ '' .
+ '' . $this->get_text_inline( 'Error received from the server:', 'server-error-message' ) . '
';
+
+ return $error_message;
+ }
+
+ /**
+ * Include the required JS at the footer of the admin to trigger the license activation dialog box.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ */
+ public function _open_license_activation_dialog_box() {
+ $vars = array( 'license_id' => $this->_site->license_id );
+ fs_require_once_template( 'js/open-license-activation.php', $vars );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @param bool $background
+ * @param FS_Plugin_License|null $premium_license
+ */
+ protected function _activate_license( $background = false, $premium_license = null ) {
+ $this->_logger->entrance();
+
+ if ( is_null( $premium_license ) ) {
+ $license_id = fs_request_get( 'license_id' );
+
+ if ( is_object( $this->_site ) &&
+ FS_Plugin_License::is_valid_id( $license_id ) &&
+ $license_id == $this->_site->license_id
+ ) {
+ // License is already activated.
+ return;
+ }
+
+ $premium_license = FS_Plugin_License::is_valid_id( $license_id ) ?
+ $this->_get_license_by_id( $license_id ) :
+ $this->_get_available_premium_license();
+ }
+
+ if ( ! is_object( $premium_license ) ) {
+ return;
+ }
+
+ if ( ! is_object( $this->_site ) ) {
+ // Not yet opted-in.
+ $user = $this->get_current_or_network_user();
+ if ( ! is_object( $user ) ) {
+ $user = self::_get_user_by_id( $premium_license->user_id );
+ }
+
+ if ( is_object( $user ) ) {
+ $this->install_with_user( $user, $premium_license->secret_key, false, false, false );
+ } else {
+ $this->opt_in(
+ false,
+ false,
+ false,
+ $premium_license->secret_key
+ );
+
+ return;
+ }
+ }
+
+
+ /**
+ * If the premium license is already associated with the install, just
+ * update the license reference (activation is not required).
+ *
+ * @since 1.1.9
+ */
+ if ( $premium_license->id == $this->_site->license_id ) {
+ // License is already activated.
+ $this->_update_site_license( $premium_license );
+ $this->_store_account();
+
+ return;
+ }
+
+ if ( $this->_site->user_id != $premium_license->user_id ) {
+ $api_request_params = array( 'license_key' => $premium_license->secret_key );
+ } else {
+ $api_request_params = array();
+ }
+
+ $api = $this->get_api_site_scope();
+ $license = $api->call( "/licenses/{$premium_license->id}.json?is_enriched=true", 'put', $api_request_params );
+
+ if ( ! $this->is_api_result_entity( $license ) ) {
+ if ( ! $background ) {
+ $this->_admin_notices->add( sprintf(
+ '%s %s',
+ $this->get_text_inline( 'It looks like the license could not be activated.', 'license-activation-failed-message' ),
+ ( is_object( $license ) && isset( $license->error ) ?
+ $license->error->message :
+ sprintf( '%s%s',
+ $this->get_text_inline( 'Error received from the server:', 'server-error-message' ),
+ var_export( $license, true )
+ )
+ )
+ ),
+ $this->get_text_x_inline( 'Hmm', 'something somebody says when they are thinking about what you have just said.', 'hmm' ) . '...',
+ 'error'
+ );
+ }
+
+ return;
+ }
+
+ $premium_license = new FS_Plugin_License( $license );
+
+ // Updated site plan.
+ $site = $this->get_api_site_scope()->get( '/', true );
+ if ( $this->is_api_result_entity( $site ) ) {
+ $this->_site = new FS_Site( $site );
+ }
+ $this->_update_site_license( $premium_license );
+
+ $this->_store_account();
+
+ if ( $this->is_addon() || $this->has_addons() ) {
+ /**
+ * Purge the valid user licenses cache so that when the "Account" or the "Add-Ons" page is loaded,
+ * an updated valid user licenses collection will be fetched from the server which is used to also
+ * update the account add-ons (add-ons the user has licenses for).
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.4
+ */
+ $this->purge_valid_user_licenses_cache();
+ }
+
+ if ( ! $background ) {
+ $this->add_complete_upgrade_instructions_notice(
+ $this->get_text_inline( 'Your license was successfully activated.', 'license-activated-message' ),
+ 'license_activated'
+ );
+ }
+
+ $this->_admin_notices->remove_sticky( array(
+ 'trial_promotion',
+ 'license_expired',
+ ) );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.5
+ *
+ * @param bool $show_notice
+ */
+ protected function _deactivate_license( $show_notice = true ) {
+ $this->_logger->entrance();
+
+ $hmm_text = $this->get_text_x_inline( 'Hmm', 'something somebody says when they are thinking about what you have just said.', 'hmm' ) . '...';
+
+ if ( ! FS_Plugin_License::is_valid_id( $this->_site->license_id ) ) {
+ $this->_admin_notices->add(
+ sprintf( $this->get_text_inline( 'It looks like your site currently doesn\'t have an active license.', 'no-active-license-message' ), $this->get_plan_title() ),
+ $hmm_text
+ );
+
+ return;
+ }
+
+ $api = $this->get_api_site_scope();
+ $license = $api->call( "/licenses/{$this->_site->license_id}.json", 'delete' );
+
+ $this->handle_license_deactivation_result( $license, $hmm_text, $show_notice );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.1
+ *
+ * @param FS_Plugin_License $license
+ * @param bool|string $hmm_text
+ * @param bool $show_notice
+ */
+ private function handle_license_deactivation_result( $license, $hmm_text = false, $show_notice = true ) {
+ if ( isset( $license->error ) ) {
+ $this->_admin_notices->add(
+ $this->get_text_inline( 'It looks like the license deactivation failed.', 'license-deactivation-failed-message' ) . '%s ',
+ $this->_get_latest_download_local_url( $plugin_id ),
+ $label
+ );
+ }
+
+ /**
+ * Get latest plugin download local URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @param bool|number $plugin_id
+ *
+ * @return string
+ */
+ function _get_latest_download_local_url( $plugin_id = false ) {
+ // Add timestamp to protect from caching.
+ $params = array( 'ts' => WP_FS__SCRIPT_START_TIME );
+
+ if ( ! empty( $plugin_id ) ) {
+ $params['plugin_id'] = $plugin_id;
+ } else if ( $this->is_addon() ) {
+ $params['plugin_id'] = $this->get_id();
+ }
+
+ $fs = $this->is_addon() ?
+ $this->get_parent_instance() :
+ $this;
+
+ return $this->apply_filters( 'download_latest_url', $fs->get_account_url( 'download_latest', $params ) );
+ }
+
+ #endregion Download Plugin ------------------------------------------------------------------
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.4
+ *
+ * @uses FS_Api
+ *
+ * @param bool $background Hints the method if it's a background updates check. If false, it means that
+ * was initiated by the admin.
+ * @param bool|number $plugin_id
+ * @param bool $flush Since 1.1.7.3
+ * @param int $expiration Since 1.2.2.7
+ * @param bool|string $newer_than Since 2.2.1
+ */
+ private function check_updates(
+ $background = false,
+ $plugin_id = false,
+ $flush = true,
+ $expiration = FS_Plugin_Updater::UPDATES_CHECK_CACHE_EXPIRATION,
+ $newer_than = false
+ ) {
+ $this->_logger->entrance();
+
+ // Check if there's a newer version for download.
+ $new_version = $this->_fetch_newer_version( $plugin_id, $flush, $expiration, $newer_than );
+
+ $update = null;
+ if ( is_object( $new_version ) ) {
+ $update = new FS_Plugin_Tag( $new_version );
+
+ if ( ! $background ) {
+ $this->_admin_notices->add(
+ sprintf(
+ /* translators: %s: Numeric version number (e.g. '2.1.9' */
+ $this->get_text_inline( 'Version %s was released.', 'version-x-released' ) . ' ' . $this->get_text_inline( 'Please download %s.', 'please-download-x' ),
+ $update->version,
+ sprintf(
+ '%s ',
+ $this->get_account_url( 'download_latest' ),
+ sprintf(
+ /* translators: %s: plan name (e.g. latest "Professional" version) */
+ $this->get_text_inline( 'the latest %s version here', 'latest-x-version' ),
+ $this->get_plan_title()
+ )
+ )
+ ),
+ $this->get_text_inline( 'New', 'new' ) . '!'
+ );
+ }
+ } else if ( false === $new_version && ! $background ) {
+ $this->_admin_notices->add(
+ $this->get_text_inline( 'Seems like you got the latest release.', 'you-have-latest' ),
+ $this->get_text_inline( 'You are all good!', 'you-are-good' )
+ );
+ }
+
+ $this->_store_update( $update, true, $plugin_id );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.4
+ *
+ * @param bool $flush Since 1.1.7.3 add 24 hour cache by default.
+ *
+ * @return FS_Plugin[]
+ *
+ * @uses FS_Api
+ */
+ private function sync_addons( $flush = false ) {
+ $this->_logger->entrance();
+
+ $api = $this->get_api_site_or_plugin_scope();
+
+ $path = $this->add_show_pending( '/addons.json?enriched=true&count=50' );
+
+ /**
+ * @since 1.2.1
+ *
+ * If there's a cached version of the add-ons and not asking
+ * for a flush, just use the currently stored add-ons.
+ */
+ if ( ! $flush && $api->is_cached( $path ) ) {
+ $addons = self::get_all_addons();
+
+ return isset( $addons[ $this->_plugin->id ] ) ?
+ $addons[ $this->_plugin->id ] :
+ array();
+ }
+
+ $result = $api->get( $path, $flush );
+
+ $addons = array();
+ if ( $this->is_api_result_object( $result, 'plugins' ) &&
+ is_array( $result->plugins )
+ ) {
+ for ( $i = 0, $len = count( $result->plugins ); $i < $len; $i ++ ) {
+ $addons[ $i ] = new FS_Plugin( $result->plugins[ $i ] );
+ }
+
+ $this->_store_addons( $addons, true );
+ }
+
+ return $addons;
+ }
+
+ /**
+ * Handle user email update.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.3
+ * @uses FS_Api
+ *
+ * @param string $new_email
+ *
+ * @return object
+ */
+ private function update_email( $new_email ) {
+ $this->_logger->entrance();
+
+ $api = $this->get_api_user_scope();
+ $user = $api->call( "?plugin_id={$this->_plugin->id}&fields=id,email,is_verified", 'put', array(
+ 'email' => $new_email,
+ 'after_email_confirm_url' => $this->_get_admin_page_url(
+ 'account',
+ array( 'fs_action' => 'sync_user' )
+ ),
+ ) );
+
+ if ( ! isset( $user->error ) ) {
+ $this->_user->email = $user->email;
+ $this->_user->is_verified = $user->is_verified;
+ $this->_store_user();
+ } else {
+ // handle different error cases.
+ }
+
+ return $user;
+ }
+
+ #----------------------------------------------------------------------------------
+ #region API Error Handling
+ #----------------------------------------------------------------------------------
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.1
+ *
+ * @param mixed $result
+ *
+ * @return bool Is API result contains an error.
+ */
+ private function is_api_error( $result ) {
+ return FS_Api::is_api_error( $result );
+ }
+
+ /**
+ * Checks if given API result is a non-empty and not an error object.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.5
+ *
+ * @param mixed $result
+ * @param string|null $required_property Optional property we want to verify that is set.
+ *
+ * @return bool
+ */
+ function is_api_result_object( $result, $required_property = null ) {
+ return FS_Api::is_api_result_object( $result, $required_property );
+ }
+
+ /**
+ * Checks if given API result is a non-empty entity object with non-empty ID.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.5
+ *
+ * @param mixed $result
+ *
+ * @return bool
+ */
+ private function is_api_result_entity( $result ) {
+ return FS_Api::is_api_result_entity( $result );
+ }
+
+ #endregion
+
+ /**
+ * Make sure a given argument is an array of a specific type.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.5
+ *
+ * @param mixed $array
+ * @param string $class
+ *
+ * @return bool
+ */
+ private function is_array_instanceof( $array, $class ) {
+ return ( is_array( $array ) && ( empty( $array ) || $array[0] instanceof $class ) );
+ }
+
+ /**
+ * Start install ownership change.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.1
+ * @uses FS_Api
+ *
+ * @param string $candidate_email
+ * @param string $transfer_type
+ *
+ * @return bool Is ownership change successfully initiated.
+ */
+ private function init_change_owner( $candidate_email, $transfer_type ) {
+ $this->_logger->entrance();
+
+ $installs_info_by_slug_map = $this->get_parent_and_addons_installs_info();
+ $install_ids = array();
+
+ foreach ( $installs_info_by_slug_map as $slug => $install_info ) {
+ $install = $install_info['install'];
+
+ if ( $this->_user->id != $install->user_id ) {
+ // Skip add-on installs that are not owned by the parent product's install's owner.
+ continue;
+ }
+
+ $install_ids[ $slug ] = $install->id;
+ }
+
+ $api = $this->get_api_site_scope();
+ $result = $api->call( "/users/{$this->_user->id}.json", 'put', array(
+ 'email' => $candidate_email,
+ 'transfer_type' => $transfer_type,
+ 'install_ids' => implode( ',', array_values( $install_ids ) ),
+ 'after_confirm_url' => $this->_get_admin_page_url(
+ 'account',
+ array( 'fs_action' => 'change_owner' )
+ ),
+ ) );
+
+ return ! $this->is_api_error( $result );
+ }
+
+ /**
+ * Handle install ownership change.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.1
+ * @uses FS_Api
+ *
+ * @return bool Was ownership change successfully complete.
+ */
+ private function complete_change_owner() {
+ $this->_logger->entrance();
+
+ $install_ids = fs_request_get( 'install_ids' );
+
+ if ( ! empty( $install_ids ) ) {
+ $install_ids = explode( ',', $install_ids );
+
+ foreach ( $install_ids as $key => $install_id ) {
+ if ( ! FS_Site::is_valid_id( $install_id ) ) {
+ unset( $install_ids[ $key ] );
+ }
+ }
+ }
+
+ if ( ! is_array( $install_ids ) ) {
+ $install_ids = array();
+ }
+
+ $user = new FS_User();
+ $user->id = fs_request_get( 'user_id' );
+ $user->public_key = fs_request_get_raw( 'user_public_key' );
+ $user->secret_key = fs_request_get_raw( 'user_secret_key' );
+
+ $prev_user = $this->_user;
+ $this->_user = $user;
+
+ $result = $this->get_api_user_scope( true )->get(
+ "/installs.json?install_ids=" . implode( ',', $install_ids )
+ );
+
+ $current_blog_sites = self::get_all_sites( $this->get_module_type() );
+
+ if ( $this->is_api_result_object( $result, 'installs' ) ) {
+ $site_id_slug_map = array();
+
+ foreach ( $current_blog_sites as $slug => $site ) {
+ $site_id_slug_map[ $site->id ] = $slug;
+ }
+
+ foreach ( $result->installs as $install ) {
+ $site = new FS_Site( $install );
+
+ if ( ! isset( $site_id_slug_map[ $install->id ] ) ) {
+ continue;
+ }
+
+ $current_blog_sites[ $site_id_slug_map[ $install->id ] ] = clone $site;
+
+ if ( $this->_site->id == $site->id ) {
+ $this->_site = $site;
+ }
+ }
+ }
+
+ // Validate install's user and given user.
+ if ( $user->id != $this->_site->user_id ) {
+ $this->_user = $prev_user;
+
+ return false;
+ }
+
+ $this->set_account_option( 'sites', $current_blog_sites, true );
+
+ // Fetch new user information.
+ $user_result = $this->get_api_user_scope( true )->get();
+ $user = new FS_User( $user_result );
+ $this->_user = $user;
+
+ $this->_set_account( $user, $this->_site );
+
+ $remove_user = true;
+ $all_modules_sites = FS_DebugManager::get_all_modules_sites();
+
+ foreach ( $all_modules_sites as $sites_by_module_type ) {
+ foreach ( $sites_by_module_type as $sites_by_slug ) {
+ foreach ( $sites_by_slug as $site ) {
+ if ( $prev_user->id == $site->user_id ) {
+ $remove_user = false;
+ break;
+ }
+ }
+
+ if ( ! $remove_user ) {
+ break;
+ }
+ }
+
+ if ( ! $remove_user ) {
+ break;
+ }
+ }
+
+ if ( $remove_user ) {
+ $users = self::get_all_users();
+
+ if ( isset( $users[ $prev_user->id ] ) ) {
+ unset( $users[ $prev_user->id ] );
+ } else {
+ // If the prev user wasn't found by the key, iterate over the users collection.
+ foreach ( $users as $key => $user ) {
+ if ( $user->id == $prev_user->id ) {
+ unset( $users[ $key ] );
+ break;
+ }
+ }
+ }
+
+ $this->set_account_option( 'users', $users, true );
+ }
+
+ return true;
+ }
+
+ /**
+ * Completes ownership change by license.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.2
+ *
+ * @param number $user_id
+ * @param array[string]number $install_ids_by_slug_map
+ *
+ */
+ private function complete_ownership_change_by_license( $user_id, $install_ids_by_slug_map ) {
+ $this->_logger->entrance();
+
+ $this->sync_user_by_current_install( $user_id );
+
+ $result = $this->get_api_user_scope( true )->get(
+ "/installs.json?install_ids=" . implode( ',', $install_ids_by_slug_map )
+ );
+
+ if ( $this->is_api_result_object( $result, 'installs' ) ) {
+ $sites = self::get_all_sites( $this->get_module_type() );
+ $install_ids_by_slug_map = array_flip( $install_ids_by_slug_map );
+
+ foreach ( $result->installs as $install ) {
+ $site = new FS_Site( $install );
+
+ $sites[ $install_ids_by_slug_map[ $site->id ] ] = clone $site;
+ }
+
+ $this->set_account_option( 'sites', $sites, true );
+ }
+ }
+
+ /**
+ * Handle user name update.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ * @uses FS_Api
+ *
+ * @return object
+ */
+ private function update_user_name() {
+ $this->_logger->entrance();
+ $name = fs_request_get( 'fs_user_name_' . $this->get_unique_affix(), '' );
+
+ $api = $this->get_api_user_scope();
+ $user = $api->call( "?plugin_id={$this->_plugin->id}&fields=id,first,last", 'put', array(
+ 'name' => $name,
+ ) );
+
+ if ( ! isset( $user->error ) ) {
+ $this->_user->first = $user->first;
+ $this->_user->last = $user->last;
+ $this->_store_user();
+ } else {
+ // handle different error cases.
+
+ }
+
+ return $user;
+ }
+
+ /**
+ * Verify user email.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.3
+ * @uses FS_Api
+ */
+ private function verify_email() {
+ $this->_handle_account_user_sync();
+
+ if ( $this->_user->is_verified() ) {
+ return;
+ }
+
+ $api = $this->get_api_site_scope();
+ $result = $api->call( "/users/{$this->_user->id}/verify.json", 'put', array(
+ 'after_email_confirm_url' => $this->_get_admin_page_url(
+ 'account',
+ array( 'fs_action' => 'sync_user' )
+ )
+ ) );
+
+ if ( ! isset( $result->error ) ) {
+ $this->_admin_notices->add( sprintf(
+ $this->get_text_inline( 'Verification mail was just sent to %s. If you can\'t find it after 5 min, please check your spam box.', 'verification-email-sent-message' ),
+ sprintf( '%2$s ', esc_url( $this->_user->email ), $this->_user->email )
+ ) );
+ } else {
+ // handle different error cases.
+
+ }
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.2
+ *
+ * @param array $params
+ * @param bool|null $network
+ *
+ * @return string
+ */
+ function get_activation_url( $params = array(), $network = null ) {
+ if ( $this->is_addon() && $this->has_free_plan() ) {
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.7 Add-on's activation is the parent's module activation.
+ */
+ return $this->get_parent_instance()->get_activation_url( $params );
+ }
+
+ return $this->apply_filters( 'connect_url', $this->_get_admin_page_url( '', $params, $network ) );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.5
+ *
+ * @param array $params
+ *
+ * @return string
+ */
+ function get_reconnect_url( $params = array() ) {
+ $params['fs_action'] = 'reset_anonymous_mode';
+ $params['fs_unique_affix'] = $this->get_unique_affix();
+
+ return $this->get_activation_url( $params );
+ }
+
+ /**
+ * Get the URL of the page that should be loaded after the user connect
+ * or skip in the opt-in screen.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.3
+ *
+ * @param string $filter Filter name.
+ * @param array $params Since 1.2.2.7
+ * @param bool|null $network
+ *
+ * @return string
+ */
+ function get_after_activation_url( $filter, $params = array(), $network = null ) {
+ if ( $this->show_opt_in_on_themes_page() &&
+ ( fs_request_has( 'pending_activation' ) ||
+ // For cases when the first time path is set, even though it's a WP.org theme.
+ fs_request_get_bool( $this->get_unique_affix() . '_show_optin' ) )
+ ) {
+ $first_time_path = '';
+ } else {
+ $first_time_path = $this->_menu->get_first_time_path(
+ fs_is_network_admin() && $this->_is_network_active
+ );
+ }
+
+ if ( $this->_is_network_active &&
+ fs_is_network_admin() &&
+ ! $this->_menu->has_network_menu() &&
+ $this->is_network_registered()
+ ) {
+ $target_url = $this->get_account_url();
+ } else {
+ // Default plugin's page.
+ $target_url = $this->_get_admin_page_url( '', array(), $network );
+ }
+
+ return add_query_arg( $params, $this->apply_filters(
+ $filter,
+ empty( $first_time_path ) ?
+ $target_url :
+ $first_time_path
+ ) );
+ }
+
+ /**
+ * Handle account page updates / edits / actions.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.2
+ *
+ */
+ private function _handle_account_edits() {
+ if ( ! $this->is_user_admin() ) {
+ return;
+ }
+
+ $action = fs_get_action();
+
+ if ( empty( $action ) ) {
+ return;
+ }
+
+ $plugin_id = fs_request_get( 'plugin_id', $this->get_id() );
+ $install_id = fs_request_get( 'install_id', '' );
+
+ // Alias.
+ $oops_text = $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...';
+
+ $is_network_action = $this->is_network_level_action();
+ $blog_id = $this->is_network_level_site_specific_action();
+ $is_parent_plugin_action = ( $plugin_id == $this->get_id() );
+
+ if ( is_numeric( $blog_id ) ) {
+ $this->switch_to_blog( $blog_id );
+ } else {
+ $blog_id = '';
+ }
+
+ switch ( $action ) {
+ case 'opt_in':
+ check_admin_referer( trim( "{$action}:{$blog_id}:{$install_id}", ':' ) );
+
+ if ( $is_parent_plugin_action ) {
+ if ( $is_network_action && ! empty( $blog_id ) ) {
+ if ( ! $this->is_registered() ) {
+ $this->install_with_user(
+ $this->get_network_user(),
+ false,
+ false,
+ false,
+ false
+ );
+
+ $this->_admin_notices->add(
+ $this->get_text_inline( 'Site successfully opted in.', 'successful-opt-in' ),
+ $this->get_text_inline( 'Awesome', 'awesome' )
+ );
+ }
+ }
+ }
+ break;
+
+ case 'toggle_tracking':
+ check_admin_referer( trim( "{$action}:{$blog_id}:{$install_id}", ':' ) );
+
+ if ( $is_parent_plugin_action ) {
+ if ( $is_network_action && ! empty( $blog_id ) ) {
+ if ( $this->is_registered( true ) ) {
+ if ( $this->is_tracking_prohibited( $blog_id ) ) {
+ if ( $this->toggle_site_tracking( true, $blog_id ) ) {
+ $this->_admin_notices->add(
+ sprintf( $this->get_text_inline( 'Sharing diagnostic data with %s helps to provide functionality that\'s more relevant to your website, avoid WordPress or PHP version incompatibilities that can break your website, and recognize which languages & regions the plugin should be translated and tailored to.', 'opt-out-message-appreciation' ), "{$this->get_plugin_title()} " ),
+ $this->get_text_inline( 'Thank you!', 'thank-you' )
+ );
+ }
+ } else {
+ if ( $this->toggle_site_tracking( false, $blog_id ) ) {
+ $install = $this->get_install_by_blog_id( $blog_id );
+
+ $this->_admin_notices->add(
+ sprintf(
+ $this->get_text_inline( 'Diagnostic data will no longer be sent from %s to %s.', 'opted-out-successfully' ),
+ self::get_unfiltered_site_url( $blog_id, true ),
+ "{$this->get_plugin_title()} "
+ )
+ );
+ }
+ }
+ }
+ }
+ }
+
+ break;
+
+ case 'delete_account':
+ check_admin_referer( trim( "{$action}:{$blog_id}:{$install_id}", ':' ) );
+
+ $is_network_deletion = $is_network_action && empty( $blog_id );
+
+ if ( $is_parent_plugin_action ) {
+ // Delete add-on installs if have any.
+ $installed_addons = $this->get_installed_addons();
+ foreach ( $installed_addons as $fs_addon ) {
+ if ( $is_network_deletion ) {
+ $fs_addon->delete_network_account_event();
+ } else {
+ $fs_addon->delete_account_event();
+ }
+ }
+
+ if ( $is_network_deletion ) {
+ $this->delete_network_account_event();
+ } else {
+ $this->delete_account_event();
+ }
+
+ // Clear user and site.
+ $this->_site = null;
+ $this->_user = null;
+
+ $this->maybe_set_slug_and_network_menu_exists_flag();
+
+ fs_redirect( $this->get_activation_url() );
+ } else {
+ if ( $this->is_addon_activated( $plugin_id ) ) {
+ $fs_addon = self::get_instance_by_id( $plugin_id );
+
+ if ( $is_network_deletion ) {
+ $fs_addon->delete_network_account_event();
+ } else {
+ $fs_addon->delete_account_event();
+ }
+
+ fs_redirect( $this->_get_admin_page_url( 'account' ) );
+ }
+ }
+
+ return;
+
+ case 'downgrade_account':
+ if ( is_numeric( $blog_id ) ) {
+ check_admin_referer( trim( "{$action}:{$blog_id}:{$install_id}", ':' ) );
+ } else {
+ check_admin_referer( $action );
+ }
+
+ $switch_to_network_install_blog_after_cancellation = (
+ is_numeric( $blog_id ) &&
+ $plugin_id == $this->get_id() &&
+ ! $this->is_trial()
+ );
+
+ $result = $this->cancel_subscription_or_trial( $plugin_id );
+ if ( $this->is_api_error( $result ) ) {
+ $this->_admin_notices->add(
+ $result->error->message,
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
+ 'error'
+ );
+ }
+
+ if ( $switch_to_network_install_blog_after_cancellation ) {
+ $this->switch_to_blog( $this->_storage->network_install_blog_id );
+ }
+
+ return;
+
+ case 'activate_license':
+ check_admin_referer( trim( "{$action}:{$blog_id}:{$install_id}", ':' ) );
+
+ $fs = $this;
+ if ( $plugin_id != $this->get_id() ) {
+ $fs = $this->is_addon_activated( $plugin_id ) ?
+ self::get_instance_by_id( $plugin_id ) :
+ null;
+ }
+
+ if ( is_object( $fs ) ) {
+ $fs->_activate_license();
+
+ /**
+ * Remove the product ID from `$_REQUEST` so that the syncing of the license for the other products will work properly.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.4.0
+ */
+ unset( $_REQUEST['plugin_id'] );
+
+ if ( $this->is_bundle_license_auto_activation_enabled() ) {
+ $fs->maybe_activate_bundle_license( null, array(), is_numeric( $blog_id ) ? $blog_id : 0 );
+ }
+ }
+
+ return;
+
+ case 'deactivate_license':
+ check_admin_referer( trim( "{$action}:{$blog_id}:{$install_id}", ':' ) );
+
+ if ( $plugin_id == $this->get_id() ) {
+ $this->_deactivate_license();
+
+ if ( $this->is_only_premium() ) {
+ // Clear user and site.
+ $this->_site = null;
+ $this->_user = null;
+
+ if ( ! $is_network_action ) {
+ fs_redirect( $this->get_activation_url() );
+ } else if ( is_numeric( $blog_id ) ) {
+ $this->switch_to_blog( $this->_storage->network_install_blog_id );
+ }
+ }
+ } else {
+ if ( $this->is_addon_activated( $plugin_id ) ) {
+ $fs_addon = self::get_instance_by_id( $plugin_id );
+ $fs_addon->_deactivate_license();
+ }
+ }
+
+ return;
+
+ case 'check_updates':
+ check_admin_referer( $action );
+ $this->check_updates();
+
+ return;
+
+ case 'change_owner':
+ $state = fs_request_get( 'state', 'init' );
+ switch ( $state ) {
+ case 'init':
+ // The nonce is injected by the error handler in `_email_address_update_ajax_handler` function.
+ check_admin_referer( 'change_owner' );
+
+ $candidate_email = fs_request_get( 'candidate_email' );
+ $transfer_type = fs_request_get( 'transfer_type' );
+
+ if ( $this->init_change_owner( $candidate_email, $transfer_type ) ) {
+ if ( 'transfer' === $transfer_type ) {
+ $this->_admin_notices->add( sprintf( $this->get_text_inline( 'A confirmation email was just sent to %s. The email owner must confirm the update within the next 4 hours.', 'change-owner-request-sent-x-transfer' ), '' . $this->_user->email . ' ' ) );
+ } else {
+ $this->_admin_notices->add( sprintf( $this->get_text_inline( 'A confirmation email was just sent to %s. You must confirm the update within the next 4 hours. If you cannot find the email, please check your spam folder.', 'change-owner-request-sent-x' ), '' . $this->_user->email . ' ' ) );
+ }
+ }
+ break;
+ case 'owner_confirmed':
+ // We cannot (or need not to) check the nonce and referer here, because the link comes from the email sent by our API.
+ $candidate_email = fs_request_get( 'candidate_email', '' );
+
+ if ( ! is_email($candidate_email ) ) {
+ return;
+ }
+
+ $this->_admin_notices->add( sprintf( $this->get_text_inline( 'Thanks for confirming the ownership change. An email was just sent to %s for final approval.', 'change-owner-request_owner-confirmed' ), '' . $candidate_email . ' ' ) );
+ break;
+ case 'candidate_confirmed':
+ // We do not need to validate the authenticity of this request here, because the `complete_change_owner` does that for us through API calls.
+ if ( $this->complete_change_owner() ) {
+ $this->_admin_notices->add_sticky(
+ sprintf( $this->get_text_inline( '%s is the new owner of the account.', 'change-owner-request_candidate-confirmed' ), '' . $this->_user->email . ' ' ),
+ 'ownership_changed',
+ $this->get_text_x_inline( 'Congrats', 'as congratulations', 'congrats' ) . '!'
+ );
+ } else {
+ // @todo Handle failed ownership change message.
+ }
+ break;
+ }
+
+ return;
+
+ case 'update_user_name':
+ check_admin_referer( 'update_user_name' );
+
+ $result = $this->update_user_name();
+
+ if ( isset( $result->error ) ) {
+ $this->_admin_notices->add(
+ $this->get_text_inline( 'Please provide your full name.', 'name-update-failed-message' ),
+ $oops_text,
+ 'error'
+ );
+ } else {
+ $this->_admin_notices->add( $this->get_text_inline( 'Your name was successfully updated.', 'name-updated-message' ) );
+ }
+
+ return;
+
+ #region Actions that might be called from external links (e.g. email)
+
+ /**
+ * !!IMPORTANT!!: We cannot check for a valid nonce in this region, because the links could be coming from emails.
+ */
+
+ case 'cancel_trial':
+ $result = $this->cancel_subscription_or_trial( $plugin_id );
+ if ( $this->is_api_error( $result ) ) {
+ $this->_admin_notices->add(
+ $result->error->message,
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
+ 'error'
+ );
+ }
+
+ return;
+
+ case 'verify_email':
+ $this->verify_email();
+
+ return;
+
+ case 'sync_user':
+ $this->_handle_account_user_sync();
+
+ return;
+
+ case $this->get_unique_affix() . '_sync_license':
+ $this->_sync_license();
+
+ return;
+
+ case 'download_latest':
+ $this->download_latest_directly( $plugin_id );
+
+ return;
+
+ #endregion
+ }
+
+ if ( WP_FS__IS_POST_REQUEST ) {
+ $properties = array( 'site_secret_key', 'site_id', 'site_public_key' );
+ foreach ( $properties as $p ) {
+ if ( 'update_' . $p === $action ) {
+ check_admin_referer( $action );
+
+ $this->_logger->log( $action );
+
+ $site_property = substr( $p, strlen( 'site_' ) );
+ $site_property_value = fs_request_get( 'fs_' . $p . '_' . $this->get_unique_affix(), '' );
+ $this->get_site()->{$site_property} = $site_property_value;
+
+ // Store account after modification.
+ $this->_store_site();
+
+ $this->do_action( 'account_property_edit', 'site', $site_property, $site_property_value );
+
+ $this->_admin_notices->add( sprintf(
+ /* translators: %s: User's account property (e.g. email address, name) */
+ $this->get_text_inline( 'You have successfully updated your %s.', 'x-updated' ),
+ '' . str_replace( '_', ' ', $p ) . ' '
+ ) );
+
+ return;
+ }
+ }
+ }
+ }
+
+ /**
+ * Adds CSS classes for the body tag in the admin.
+ *
+ * @param string $classes Space-separated string of class names.
+ *
+ * @return string $classes FS Admin body tag class names.
+ */
+ public function fs_addons_body_class( $classes ) {
+ $classes .= ' plugins-php';
+ return $classes;
+ }
+
+ /**
+ * Account page resources load.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ */
+ function _account_page_load() {
+ $this->_logger->entrance();
+
+ $this->_logger->info( var_export( $_REQUEST, true ) );
+
+ fs_enqueue_local_style( 'fs_account', '/admin/account.css' );
+
+ if ( $this->has_addons() ) {
+ wp_enqueue_script( 'plugin-install' );
+ add_thickbox();
+ add_filter( 'admin_body_class', array( $this, 'fs_addons_body_class' ) );
+ }
+
+ if ( $this->has_paid_plan() &&
+ ! $this->has_any_license() &&
+ ! $this->is_sync_executed() &&
+ $this->is_tracking_allowed()
+ ) {
+ /**
+ * If no licenses found and no sync job was executed during the last 24 hours,
+ * just execute the sync job right away (blocking execution).
+ *
+ * @since 1.1.7.3
+ */
+ $this->run_manual_sync();
+ }
+
+ $this->_handle_account_edits();
+
+ if (
+ is_object( $this->_license ) &&
+ $this->_license->user_id == $this->_user->id &&
+ ! $this->is_whitelabeled( true )
+ ) {
+ $this->_admin_notices->add(
+ sprintf(
+ $this->get_text_inline( "Is this your client's site? %s if you wish to hide sensitive info like your email, license key, prices, billing address & invoices from the WP Admin.", 'license_not_whitelabeled' ),
+ sprintf(
+ '%s ',
+ $this->get_text_inline( 'Click here', 'click-here' )
+ )
+ ),
+ '',
+ 'success',
+ false,
+ 'license_not_whitelabeled'
+ );
+ }
+
+ $this->do_action( 'account_page_load_before_departure' );
+ }
+
+ /**
+ * Renders the "Affiliation" page.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 1.2.3
+ */
+ function _affiliation_page_render() {
+ $this->_logger->entrance();
+
+ $this->fetch_affiliate_and_terms();
+
+ fs_enqueue_local_style( 'fs_affiliation', '/admin/affiliation.css' );
+
+ $is_bundle_context = $this->has_bundle_context();
+
+ $plugin_title = $this->get_plugin_title();
+
+ if ( $is_bundle_context ) {
+ $plugin_title = $this->plugin_affiliate_terms->plugin_title;
+
+ // Add the suffix "Bundle" only if the word is not present in the title itself.
+ if ( false === mb_stripos( $plugin_title, fs_text_inline( 'Bundle', 'bundle' ) ) ) {
+ $plugin_title = $this->apply_filters(
+ 'formatted_bundle_title',
+ $plugin_title . ' ' . fs_text_inline( 'Bundle', 'bundle' )
+ );
+ }
+ }
+
+ $vars = array(
+ 'id' => $this->_module_id,
+ 'plugin_title' => $plugin_title,
+ );
+ echo $this->apply_filters( "/forms/affiliation.php", fs_get_template( '/forms/affiliation.php', $vars ) );
+ }
+
+
+ /**
+ * Render account page.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.0
+ */
+ function _account_page_render() {
+ $this->_logger->entrance();
+
+ $template = 'account.php';
+ $vars = array( 'id' => $this->_module_id );
+
+ /**
+ * Added filter to the template to allow developers wrapping the template
+ * in custom HTML (e.g. within a wizard/tabs).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.6
+ */
+ echo $this->apply_filters( "templates/{$template}", fs_get_template( $template, $vars ) );
+ }
+
+ /**
+ * Render account connect page.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.7
+ */
+ function _connect_page_render() {
+ $this->_logger->entrance();
+
+ $vars = array( 'id' => $this->_module_id );
+
+ /**
+ * Added filter to the template to allow developers wrapping the template
+ * in custom HTML (e.g. within a wizard/tabs).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.6
+ */
+ echo $this->apply_filters( 'templates/connect.php', fs_get_template( 'connect.php', $vars ) );
+ }
+
+ /**
+ * Load required resources before add-ons page render.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ */
+ function _addons_page_load() {
+ $this->_logger->entrance();
+
+ fs_enqueue_local_style( 'fs_addons', '/admin/add-ons.css' );
+
+ wp_enqueue_script( 'plugin-install' );
+ add_thickbox();
+ add_filter( 'admin_body_class', array( $this, 'fs_addons_body_class' ) );
+
+ if ( ! $this->is_registered() && $this->is_org_repo_compliant() ) {
+ $this->_admin_notices->add(
+ sprintf( $this->get_text_inline( 'Just letting you know that the add-ons information of %s is being pulled from an external server.', 'addons-info-external-message' ), '' . $this->get_plugin_name() . ' ' ),
+ $this->get_text_x_inline( 'Heads up', 'advance notice of something that will need attention.', 'heads-up' ),
+ 'update-nag'
+ );
+ }
+ }
+
+ /**
+ * Render add-ons page.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.6
+ */
+ function _addons_page_render() {
+ $this->_logger->entrance();
+
+ $vars = array( 'id' => $this->_module_id );
+
+ /**
+ * Added filter to the template to allow developers wrapping the template
+ * in custom HTML (e.g. within a wizard/tabs).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.6
+ */
+ echo $this->apply_filters( 'templates/add-ons.php', fs_get_template( 'add-ons.php', $vars ) );
+ }
+
+ /* Pricing & Upgrade
+ ------------------------------------------------------------------------------------------------------------------*/
+ /**
+ * Render pricing page.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.0
+ */
+ function _pricing_page_render() {
+ $this->_logger->entrance();
+
+ fs_enqueue_local_style( 'fs_common', '/admin/common.css' );
+ fs_enqueue_local_style( 'fs_checkout', '/admin/checkout.css' );
+
+ $vars = array( 'id' => $this->_module_id );
+
+ if ( 'true' === fs_request_get( 'checkout', false ) ) {
+ echo $this->apply_filters( 'templates/checkout.php', fs_get_template( 'checkout.php', $vars ) );
+ } else {
+ echo $this->apply_filters( 'templates/pricing.php', fs_get_template( 'pricing.php', $vars ) );
+ }
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.1
+ */
+ function _add_pricing_ajax_handler() {
+ $this->add_ajax_action( 'pricing_ajax_action', array( &$this, '_fs_pricing_ajax_action_handler' ) );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.1
+ */
+ function _fs_pricing_ajax_action_handler() {
+ $this->check_ajax_referer( 'pricing_ajax_action' );
+
+ $result = null;
+ $pricing_action = fs_request_get( 'pricing_action' );
+
+ switch ( $pricing_action ) {
+ case 'fetch_pricing_data':
+ $params = array(
+ 'is_enriched' => true,
+ 'trial' => fs_request_get_bool( 'trial' ),
+ 'sandbox' => fs_request_get_raw( 'sandbox' ),
+ 's_ctx_type' => fs_request_get_raw( 's_ctx_type' ),
+ 's_ctx_id' => fs_request_get_raw( 's_ctx_id' ),
+ 's_ctx_ts' => fs_request_get_raw( 's_ctx_ts' ),
+ 's_ctx_secure' => fs_request_get_raw( 's_ctx_secure' ),
+ );
+
+ $bundle_id = $this->get_bundle_id();
+ $bundle_public_key = $this->get_bundle_public_key();
+
+ $has_bundle_context = ( FS_Plugin::is_valid_id( $bundle_id ) && ! empty( $bundle_public_key ) );
+
+ if ( ! $has_bundle_context ) {
+ $api = $this->get_api_plugin_scope();
+ } else {
+ $api = FS_Api::instance(
+ $bundle_id,
+ 'plugin',
+ $bundle_id,
+ $bundle_public_key,
+ ! $this->is_live(),
+ false,
+ $this->get_sdk_version()
+ );
+
+ $params['plugin_id'] = $this->get_id();
+ $params['plugin_public_key'] = $this->get_public_key();
+ }
+
+ $result = $api->get( 'pricing.json?' . http_build_query( $params ) );
+ break;
+ case 'start_trial':
+ $trial_plan_id = fs_request_get( 'plan_id' );
+
+ if ( $this->is_registered() && $this->is_tracking_allowed() ) {
+ $plan = $this->_get_plan_by_id( $trial_plan_id );
+
+ if ( ! $plan ) {
+ $this->shoot_ajax_failure( 'Invalid plan ID.' );
+ return;
+ }
+
+ $result = $this->start_trial( $plan->name, true );
+ } else {
+ // @todo - This fails for sandbox trial at the moment if the trial was already utilized.
+ $result = $this->opt_in(
+ false,
+ false,
+ false,
+ false,
+ false,
+ $trial_plan_id
+ );
+ }
+ }
+
+ if ( is_object( $result ) && $this->is_api_error( $result ) ) {
+ $this->_logger->api_error( $result );
+
+ self::shoot_ajax_failure(
+ isset( $result->error ) ?
+ ( is_string( $result->error ) ? $result->error : $result->error->message ) :
+ var_export( $result, true )
+ );
+ }
+
+ $this->shoot_ajax_success( $result );
+ }
+
+ #----------------------------------------------------------------------------------
+ #region Contact Us
+ #----------------------------------------------------------------------------------
+
+ /**
+ * Render contact-us page.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.3
+ */
+ function _contact_page_render() {
+ $this->_logger->entrance();
+
+ $vars = array( 'id' => $this->_module_id );
+
+ /**
+ * Added filter to the template to allow developers wrapping the template
+ * in custom HTML (e.g. within a wizard/tabs).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.1.3
+ */
+ echo $this->apply_filters( 'templates/contact.php', fs_get_template( 'contact.php', $vars ) );
+ }
+
+ #endregion ------------------------------------------------------------------------
+
+ /**
+ * Hide all admin notices to prevent distractions.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.3
+ *
+ * @uses remove_all_actions()
+ */
+ private static function _hide_admin_notices() {
+ remove_all_actions( 'admin_notices' );
+ remove_all_actions( 'network_admin_notices' );
+ remove_all_actions( 'all_admin_notices' );
+ remove_all_actions( 'user_admin_notices' );
+ }
+
+ static function _clean_admin_content_section_hook() {
+ $hide_admin_notices = true;
+
+ if ( fs_request_is_action( 'allow_clone_resolution_notice' ) ) {
+ check_admin_referer( 'fs_allow_clone_resolution_notice' );
+
+ $hide_admin_notices = false;
+ }
+
+ if ( $hide_admin_notices ) {
+ self::_hide_admin_notices();
+ }
+
+ // Hide footer.
+ echo '';
+ }
+
+ /**
+ * Attach to admin_head hook to hide all admin notices.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.3
+ */
+ static function _clean_admin_content_section() {
+ add_action( 'admin_head', 'Freemius::_clean_admin_content_section_hook' );
+ }
+
+ /* CSS & JavaScript
+ ------------------------------------------------------------------------------------------------------------------*/
+ /* function _enqueue_script($handle, $src) {
+ $url = plugins_url( substr( WP_FS__DIR_JS, strlen( $this->_plugin_dir_path ) ) . '/assets/js/' . $src );
+
+ $this->_logger->entrance( 'script = ' . $url );
+
+ wp_enqueue_script( $handle, $url );
+ }*/
+
+ /* SDK
+ ------------------------------------------------------------------------------------------------------------------*/
+ private $_user_api;
+
+ /**
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.2
+ *
+ * @param bool $flush
+ *
+ * @return FS_Api
+ */
+ function get_api_user_scope( $flush = false ) {
+ if ( ! isset( $this->_user_api ) || $flush ) {
+ $this->_user_api = $this->get_api_user_scope_by_user( $this->_user );
+ }
+
+ return $this->_user_api;
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param \FS_User $user
+ *
+ * @return \FS_Api
+ */
+ private function get_api_user_scope_by_user( FS_User $user ) {
+ return FS_Api::instance(
+ $this->_module_id,
+ 'user',
+ $user->id,
+ $user->public_key,
+ ! $this->is_live(),
+ $user->secret_key,
+ $this->get_sdk_version()
+ );
+ }
+
+ /**
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.0.0
+ *
+ * @param bool $flush
+ *
+ * @return FS_Api
+ */
+ private function get_current_or_network_user_api_scope( $flush = false ) {
+ if ( ! $this->_is_network_active ||
+ ( isset( $this->_user ) && $this->_user instanceof FS_User )
+ ) {
+ return $this->get_api_user_scope( $flush );
+ }
+
+ $user = $this->get_current_or_network_user();
+
+ $this->_user_api = FS_Api::instance(
+ $this->_module_id,
+ 'user',
+ $user->id,
+ $user->public_key,
+ ! $this->is_live(),
+ $user->secret_key,
+ $this->get_sdk_version()
+ );
+
+ return $this->_user_api;
+ }
+
+ private $_site_api;
+
+ /**
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.2
+ *
+ * @param bool $flush
+ *
+ * @return FS_Api
+ */
+ private function get_api_site_scope( $flush = false ) {
+ if ( ! isset( $this->_site_api ) || $flush ) {
+ $this->_site_api = FS_Api::instance(
+ $this->_module_id,
+ 'install',
+ $this->_site->id,
+ $this->_site->public_key,
+ ! $this->is_live(),
+ $this->_site->secret_key,
+ $this->get_sdk_version(),
+ self::get_unfiltered_site_url()
+ );
+ }
+
+ return $this->_site_api;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.0
+ *
+ * @param string $path
+ * @param string $method
+ * @param array $params
+ * @param bool $flush_instance
+ *
+ * @return array|mixed|string|void
+ * @throws Freemius_Exception
+ */
+ private function api_site_call( $path, $method = 'GET', $params = array(), $flush_instance = false ) {
+ $result = $this->get_api_site_scope( $flush_instance )->call( $path, $method, $params );
+
+ /**
+ * Checks if the local install's URL is different from the remote install's URL, update the local install if necessary, and then run the clone handler if the install's URL is different from the URL of the site.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.0
+ */
+ if (
+ $this->is_registered() &&
+ FS_Api::is_api_result_entity( $result ) &&
+ isset( $result->url )
+ ) {
+ $stored_local_url = trailingslashit( $this->_site->url );
+ $stored_remote_url = trailingslashit( $result->url );
+
+ if ( $stored_local_url !== $stored_remote_url ) {
+ $this->_site->url = $result->url;
+ $this->_store_site();
+ }
+
+ if ( fs_strip_url_protocol( $stored_remote_url ) !== self::get_unfiltered_site_url( null, true, true ) ) {
+ FS_Clone_Manager::instance()->maybe_run_clone_resolution();
+ }
+ }
+
+ return $result;
+ }
+
+ private $_plugin_api;
+
+ /**
+ * Get plugin public API scope.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.7
+ *
+ * @return FS_Api
+ */
+ function get_api_plugin_scope() {
+ if ( ! isset( $this->_plugin_api ) ) {
+ $this->_plugin_api = FS_Api::instance(
+ $this->_module_id,
+ 'plugin',
+ $this->_plugin->id,
+ $this->_plugin->public_key,
+ ! $this->is_live(),
+ false,
+ $this->get_sdk_version()
+ );
+ }
+
+ return $this->_plugin_api;
+ }
+
+ /**
+ * Get bundle public API scope.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.3.1
+ *
+ * @return FS_Api
+ */
+ function get_api_bundle_scope() {
+ return FS_Api::instance(
+ $this->get_bundle_id(),
+ 'plugin',
+ $this->get_bundle_id(),
+ $this->get_bundle_public_key(),
+ ! $this->is_live(),
+ false,
+ $this->get_sdk_version()
+ );
+ }
+
+ /**
+ * Get site API scope object (fallback to public plugin scope when not registered).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.7
+ *
+ * @return FS_Api
+ */
+ function get_api_site_or_plugin_scope() {
+ return $this->is_registered() ?
+ $this->get_api_site_scope() :
+ $this->get_api_plugin_scope();
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.3.1
+ *
+ * @param object $result
+ */
+ private function maybe_modify_api_curl_error_message( $result ) {
+ if (
+ 'cUrlMissing' !== $result->error->type &&
+ ( 'CurlException' !== $result->error->type || CURLE_COULDNT_CONNECT != $result->error->code ) &&
+ ( 'HttpRequestFailed' !== $result->error->type || false === strpos( $result->error->message, 'cURL error ' . CURLE_COULDNT_CONNECT ) )
+ ) {
+ return;
+ }
+
+ $result->error->message = $this->esc_html_inline( 'We use PHP cURL library for the API calls, which is a very common library and usually installed and activated out of the box. Unfortunately, cURL is not activated (or disabled) on your server.', 'curl-missing-message' ) .
+ ' ' .
+ $this->esc_html_inline(
+ sprintf(
+ 'Please contact your hosting provider and ask them to whitelist %s for external connection.',
+ implode(
+ ', ',
+ $this->apply_filters( 'api_domains', array(
+ 'api.freemius.com',
+ 'wp.freemius.com'
+ ) )
+ )
+ ),
+ 'connectivity-whitelist'
+ ) .
+ ' ' .
+ sprintf(
+ $this->esc_html_inline( 'Once you are done, deactivate the %s and activate it again.', 'connectivity-reactivate-module' ),
+ $this->get_module_type()
+ );
+ }
+
+ /**
+ * Show trial promotional notice (if any trial exist).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @param FS_Plugin_Plan[] $plans
+ */
+ function _check_for_trial_plans( $plans ) {
+ /**
+ * For some reason core's do_action() flattens arrays when it has a single object item. Therefore, we need to restructure the array as expected.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.1.2
+ */
+ if ( ! is_array( $plans ) && is_object( $plans ) ) {
+ $plans = array( $plans );
+ }
+
+ if ( ! $this->is_array_instanceof( $plans, 'FS_Plugin_Plan' ) ) {
+ $plans = array();
+ }
+
+ $this->_storage->has_trial_plan = FS_Plan_Manager::instance()->has_trial_plan( $plans );
+ }
+
+ /**
+ * During trial promotion the "upgrade" submenu item turns to
+ * "start trial" to encourage the trial. Since we want to keep
+ * the same menu item handler and there's no robust way to
+ * add new arguments to the menu item link's querystring,
+ * use JavaScript to find the menu item and update the href of
+ * the link.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.5
+ */
+ function _fix_start_trial_menu_item_url() {
+ $template_args = array( 'id' => $this->_module_id );
+ fs_require_template( 'add-trial-to-pricing.php', $template_args );
+ }
+
+ /**
+ * Check if module is currently in a trial promotion mode.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return bool
+ */
+ function is_in_trial_promotion() {
+ return $this->_admin_notices->has_sticky( 'trial_promotion' );
+ }
+
+ /**
+ * Show trial promotional notice (if any trial exist).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @return bool If trial notice added.
+ */
+ function _add_trial_notice() {
+ if ( ! $this->is_user_admin() ) {
+ return false;
+ }
+
+ if ( ! $this->is_user_in_admin() ) {
+ return false;
+ }
+
+ if ( $this->_is_network_active ) {
+ if ( fs_is_network_admin() ) {
+ // Network level trial is disabled at the moment.
+ return false;
+ }
+
+ if ( ! $this->is_delegated_connection() ) {
+ // Only delegated sites should support trials.
+ return false;
+ }
+ }
+
+ // Check if trial message is already shown.
+ if ( $this->is_in_trial_promotion() ) {
+ add_action( 'admin_footer', array( &$this, '_fix_start_trial_menu_item_url' ) );
+
+ $this->_menu->add_counter_to_menu_item( 1, 'fs-trial' );
+
+ return false;
+ }
+
+ if ( $this->is_premium() && ! WP_FS__DEV_MODE ) {
+ // Don't show trial if running the premium code, unless running in DEV mode.
+ return false;
+ }
+
+ if ( ! $this->has_trial_plan() ) {
+ // No plans with trial.
+ return false;
+ }
+
+ if ( ! $this->apply_filters( 'show_trial', true ) ) {
+ // Developer explicitly asked not to show the trial promo.
+ return false;
+ }
+
+ if ( $this->is_registered() ) {
+ // Check if trial already utilized.
+ if ( $this->_site->is_trial_utilized() ) {
+ return false;
+ }
+
+ if ( $this->is_paying_or_trial() ) {
+ // Don't show trial if paying or already in trial.
+ return false;
+ }
+ }
+
+ if ( $this->is_activation_mode() || $this->is_pending_activation() ) {
+ // If not yet opted-in/skipped, or pending activation, don't show trial.
+ return false;
+ }
+
+ $last_time_trial_promotion_shown = $this->_storage->get( 'trial_promotion_shown', false );
+ $was_promotion_shown_before = ( false !== $last_time_trial_promotion_shown );
+
+ // Show promotion if never shown before and 24 hours after initial activation with FS.
+ if ( ! $was_promotion_shown_before &&
+ $this->_storage->install_timestamp > ( time() - $this->apply_filters( 'show_first_trial_after_n_sec', WP_FS__TIME_24_HOURS_IN_SEC ) )
+ ) {
+ return false;
+ }
+
+ // OR if promotion was shown before, try showing it every 30 days.
+ if ( $was_promotion_shown_before &&
+ $this->apply_filters( 'reshow_trial_after_every_n_sec', 30 * WP_FS__TIME_24_HOURS_IN_SEC ) > time() - $last_time_trial_promotion_shown
+ ) {
+ return false;
+ }
+
+ $trial_period = $this->_trial_days;
+ $require_payment = $this->_is_trial_require_payment;
+ $trial_url = $this->get_trial_url();
+ $plans_string = strtolower( $this->get_text_inline( 'Awesome', 'awesome' ) );
+
+ if ( $this->is_registered() ) {
+ // If opted-in, override trial with up to date data from API.
+ $trial_plans = FS_Plan_Manager::instance()->get_visible_trial_plans( $this->_plans );
+ $trial_plans_count = count( $trial_plans );
+
+ if ( 0 === $trial_plans_count ) {
+ // If there's no plans with a trial just exit.
+ return false;
+ }
+
+ /**
+ * @var FS_Plugin_Plan $paid_plan
+ */
+ $paid_plan = $trial_plans[0];
+ $require_payment = $paid_plan->is_require_subscription;
+ $trial_period = $paid_plan->trial_period;
+
+ $total_paid_plans = count( $this->_plans ) - ( FS_Plan_Manager::instance()->has_free_plan( $this->_plans ) ? 1 : 0 );
+
+ if ( $total_paid_plans !== $trial_plans_count ) {
+ // Not all paid plans have a trial - generate a string of those that have it.
+ for ( $i = 0; $i < $trial_plans_count; $i ++ ) {
+ $plans_string .= sprintf(
+ ' %s ',
+ $trial_url,
+ $trial_plans[ $i ]->title
+ );
+
+ if ( $i < $trial_plans_count - 2 ) {
+ $plans_string .= ', ';
+ } else if ( $i == $trial_plans_count - 2 ) {
+ $plans_string .= ' and ';
+ }
+ }
+ }
+ }
+
+ $message = sprintf(
+ $this->get_text_x_inline( 'Hey', 'exclamation', 'hey' ) . '! ' . $this->get_text_inline( 'How do you like %s so far? Test all our %s premium features with a %d-day free trial.', 'trial-x-promotion-message' ),
+ sprintf( '%s ', $this->get_plugin_name() ),
+ $plans_string,
+ $trial_period
+ );
+
+ // "No Credit-Card Required" or "No Commitment for N Days".
+ $cc_string = $require_payment ?
+ sprintf( $this->get_text_inline( 'No commitment for %s days - cancel anytime!', 'no-commitment-for-x-days' ), $trial_period ) :
+ $this->get_text_inline( 'No credit card required', 'no-cc-required' ) . '!';
+
+
+ // Start trial button.
+ $button = ' ' . sprintf(
+ '%s ➜ %s ', $this->get_plugin_name() ),
+ $this->get_module_label( true )
+ );
+
+ // HTML code for the "Learn more..." button.
+ $button = ' ' . sprintf(
+ '%s ➜ ' . $link['label'] . ' ';
+ }
+ }
+
+ if ( ! empty( $deactivate_link ) ) {
+ /**
+ * This HTML element is used to identify the correct plugin when attaching an event to its Deactivate link.
+ *
+ * @since 1.2.1.6 Always show the deactivation feedback form since we added automatic free version deactivation upon premium code activation.
+ */
+ $deactivate_link .= '%s ', esc_html( $this->get_plugin_title() ) ),
+ $plan_title,
+ sprintf(
+ '%s ' . $this->esc_html_inline( 'Deactivate the free version', 'deactivate-free-version' ) . '. ' ) :
+ '';
+
+ return sprintf(
+ ' %s: %s. %s%s (%s ). ' ) .
+ $this->get_latest_download_link( sprintf(
+ /* translators: %s: Plan title */
+ $this->get_text_inline( 'Download the latest %s version', 'download-latest-x-version' ),
+ $plan_title
+ ) ),
+ $deactivation_step,
+ $this->get_text_inline( 'Upload and activate the downloaded version', 'upload-and-activate' ),
+ $this->apply_filters( 'upload_and_install_video_url', '//bit.ly/wp-' . $this->_module_type . '-upload' ),
+ $this->get_text_inline( 'How to upload and activate?', 'howto-upload-activate' )
+ );
+ }
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.3
+ *
+ * @param string $message_before_the_instructions
+ * @param string $message_id
+ * @param string $plan_title
+ */
+ private function add_complete_upgrade_instructions_notice(
+ $message_before_the_instructions,
+ $message_id,
+ $plan_title = ''
+ ) {
+ $this->_admin_notices->add_sticky(
+ $message_before_the_instructions .
+ $this->get_complete_upgrade_instructions( $plan_title ),
+ $message_id,
+ $this->get_text_x_inline( 'Yee-haw', 'interjection expressing joy or exuberance', 'yee-haw' ) . '!'
+ );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.3
+ *
+ * @param bool $is_upgrade
+ */
+ private function add_after_plan_activation_or_upgrade_instructions_notice( $is_upgrade = true ) {
+ $this->add_complete_upgrade_instructions_notice(
+ $is_upgrade ?
+ $this->get_text_inline( 'Your plan was successfully upgraded.', 'plan-upgraded-message' ) :
+ $this->get_text_inline( 'Your plan was successfully activated.', 'plan-activated-message' ),
+ 'plan_upgraded'
+ );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.1.0
+ *
+ * @param string $url
+ * @param array $request
+ * @param int $success_cache_expiration
+ * @param int $failure_cache_expiration
+ * @param bool $maybe_enrich_request_for_debug
+ *
+ * @return WP_Error|array
+ */
+ static function safe_remote_post(
+ &$url,
+ $request,
+ $success_cache_expiration = 0,
+ $failure_cache_expiration = 0,
+ $maybe_enrich_request_for_debug = true
+ ) {
+ $should_cache = ($success_cache_expiration + $failure_cache_expiration > 0);
+
+ $cache_key = $should_cache ? md5( fs_strip_url_protocol($url) . json_encode( $request ) ) : false;
+
+ $response = (!WP_FS__DEBUG_SDK && ( false !== $cache_key )) ?
+ get_transient( $cache_key ) :
+ false;
+
+ if ( false === $response ) {
+ if ( $maybe_enrich_request_for_debug ) {
+ FS_DebugManager::enrich_request_for_debug( $url, $request );
+ }
+
+ if ( ! isset( $request['method'] ) ) {
+ $request['method'] = 'POST';
+ }
+
+ $response = FS_Api::remote_request( $url, $request );
+
+ if (
+ 'https://' === substr( $url, 0, 8 ) &&
+ FS_Api::is_ssl_error_response( $response )
+ ) {
+ // Failed due to old version of cURL or Open SSL (SSLv3 is not supported by CloudFlare).
+ $url = 'http://' . substr( $url, 8 );
+
+ $request['timeout'] = 15;
+ $response = FS_Api::remote_request( $url, $request );
+ }
+
+ if ( false !== $cache_key ) {
+ set_transient(
+ $cache_key,
+ $response,
+ ( ( $response instanceof WP_Error ) ?
+ $failure_cache_expiration :
+ $success_cache_expiration )
+ );
+ }
+ }
+
+ return $response;
+ }
+
+ /**
+ * This method is used to enrich the after upgrade notice instructions when the upgraded
+ * license cannot be activated network wide (license quota isn't large enough).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return string
+ */
+ private function get_license_network_activation_notice() {
+ if ( ! $this->_is_network_active ) {
+ // Module isn't network level activated.
+ return '';
+ }
+
+ if ( ! fs_is_network_admin() ) {
+ // Not network level admin.
+ return '';
+ }
+
+ if ( get_blog_count() == 1 ) {
+ // There's only a single site in the network so if there's a context license it was already activated.
+ return '';
+ }
+
+ if ( ! is_object( $this->_license ) ) {
+ // No context license.
+ return '';
+ }
+
+ if ( $this->_license->is_single_site() && 0 < $this->_license->activated ) {
+ // License was already utilized (this is not 100% the case if all the network is localhost sites and the license can be utilized on unlimited localhost sites).
+ return '';
+ }
+
+ if ( $this->can_activate_license_on_network( $this->_license ) ) {
+ // License can be activated on all the network, so probably, the license is already activate on all the network (that's how the after upgrade sync works).
+ return '';
+ }
+
+ return sprintf(
+ $this->get_text_inline( '%sClick here%s to choose the sites where you\'d like to activate the license on.', 'network-choose-sites-for-license' ),
+ '',
+ ' '
+ );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.7
+ *
+ * @param string $key
+ *
+ * @return string
+ */
+ function get_text( $key ) {
+ return fs_text( $key, $this->_slug );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.3
+ *
+ * @param string $text Translatable string.
+ * @param string $key String key for overrides.
+ *
+ * @return string
+ */
+ function get_text_inline( $text, $key = '' ) {
+ return _fs_text_inline( $text, $key, $this->_slug );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.3
+ *
+ * @param string $text Translatable string.
+ * @param string $context Context information for the translators.
+ * @param string $key String key for overrides.
+ *
+ * @return string
+ */
+ function get_text_x_inline( $text, $context, $key ) {
+ return _fs_text_x_inline( $text, $context, $key, $this->_slug );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.3
+ *
+ * @param string $text Translatable string.
+ * @param string $key String key for overrides.
+ *
+ * @return string
+ */
+ function esc_html_inline( $text, $key ) {
+ return esc_html( _fs_text_inline( $text, $key, $this->_slug ) );
+ }
+
+ #----------------------------------------------------------------------------------
+ #region Versioning
+ #----------------------------------------------------------------------------------
+
+ /**
+ * Check if Freemius in SDK upgrade mode.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @return bool
+ */
+ function is_sdk_upgrade_mode() {
+ return isset( $this->_storage->sdk_upgrade_mode ) ?
+ $this->_storage->sdk_upgrade_mode :
+ false;
+ }
+
+ /**
+ * Turn SDK upgrade mode off.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ */
+ function set_sdk_upgrade_complete() {
+ $this->_storage->sdk_upgrade_mode = false;
+ }
+
+ /**
+ * Check if plugin upgrade mode.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @return bool
+ */
+ function is_plugin_upgrade_mode() {
+ return isset( $this->_storage->plugin_upgrade_mode ) ?
+ $this->_storage->plugin_upgrade_mode :
+ false;
+ }
+
+ /**
+ * Turn plugin upgrade mode off.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ */
+ function set_plugin_upgrade_complete() {
+ $this->_storage->plugin_upgrade_mode = false;
+
+ $license_migration = ! empty( $this->_storage->license_migration ) ?
+ $this->_storage->license_migration :
+ array();
+
+ $license_migration['is_migrating'] = false;
+
+ $this->_storage->license_migration = $license_migration;
+ }
+
+ #endregion
+
+ #----------------------------------------------------------------------------------
+ #region Permissions
+ #----------------------------------------------------------------------------------
+
+ /**
+ * Check if specific permission requested.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.6
+ *
+ * @param string $permission
+ *
+ * @return bool
+ */
+ function is_permission_requested( $permission ) {
+ return isset( $this->_permissions[ $permission ] ) && ( true === $this->_permissions[ $permission ] );
+ }
+
+ #endregion
+
+ #----------------------------------------------------------------------------------
+ #region Auto Activation
+ #----------------------------------------------------------------------------------
+
+ /**
+ * Hints the SDK if running an auto-installation.
+ *
+ * @var bool
+ */
+ private $_isAutoInstall = false;
+
+ /**
+ * After upgrade callback to install and auto activate a plugin.
+ * This code will only be executed on explicit request from the user,
+ * following the practice Jetpack are using with their theme installations.
+ *
+ * @link https://make.wordpress.org/plugins/2017/03/16/clarification-of-guideline-8-executable-code-and-installs/
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.7
+ */
+ function _install_premium_version_ajax_action() {
+ $this->_logger->entrance();
+
+ $this->check_ajax_referer( 'install_premium_version' );
+
+ if ( ! $this->is_registered() ) {
+ // Not registered.
+ self::shoot_ajax_failure( array(
+ 'message' => $this->get_text_inline( 'Auto installation only works for opted-in users.', 'auto-install-error-not-opted-in' ),
+ 'code' => 'premium_installed',
+ ) );
+ }
+
+ $plugin_id = fs_request_get( 'target_module_id', $this->get_id() );
+
+ if ( ! FS_Plugin::is_valid_id( $plugin_id ) ) {
+ // Invalid ID.
+ self::shoot_ajax_failure( array(
+ 'message' => $this->get_text_inline( 'Invalid module ID.', 'auto-install-error-invalid-id' ),
+ 'code' => 'invalid_module_id',
+ ) );
+ }
+
+ if ( $plugin_id == $this->get_id() ) {
+ if ( $this->is_premium() ) {
+ // Already using the premium code version.
+ self::shoot_ajax_failure( array(
+ 'message' => $this->get_text_inline( 'Premium version already active.', 'auto-install-error-premium-activated' ),
+ 'code' => 'premium_installed',
+ ) );
+ }
+ if ( ! $this->can_use_premium_code() ) {
+ // Don't have access to the premium code.
+ self::shoot_ajax_failure( array(
+ 'message' => $this->get_text_inline( 'You do not have a valid license to access the premium version.', 'auto-install-error-invalid-license' ),
+ 'code' => 'invalid_license',
+ ) );
+ }
+ if ( ! $this->has_release_on_freemius() ) {
+ // Plugin is a serviceware, no premium code version.
+ self::shoot_ajax_failure( array(
+ 'message' => $this->get_text_inline( 'Plugin is a "Serviceware" which means it does not have a premium code version.', 'auto-install-error-serviceware' ),
+ 'code' => 'premium_version_missing',
+ ) );
+ }
+ } else {
+ $addon = $this->get_addon( $plugin_id );
+
+ if ( ! is_object( $addon ) ) {
+ // Invalid add-on ID.
+ self::shoot_ajax_failure( array(
+ 'message' => $this->get_text_inline( 'Invalid module ID.', 'auto-install-error-invalid-id' ),
+ 'code' => 'invalid_module_id',
+ ) );
+ }
+
+ if ( $this->is_addon_activated( $plugin_id, true ) ) {
+ // Premium add-on version is already activated.
+ self::shoot_ajax_failure( array(
+ 'message' => $this->get_text_inline( 'Premium add-on version already installed.', 'auto-install-error-premium-addon-activated' ),
+ 'code' => 'premium_installed',
+ ) );
+ }
+ }
+
+ $this->_isAutoInstall = true;
+
+ // Try to install and activate.
+ $updater = FS_Plugin_Updater::instance( $this );
+ $result = $updater->install_and_activate_plugin( $plugin_id );
+
+ if ( is_array( $result ) && ! empty( $result['message'] ) ) {
+ self::shoot_ajax_failure( array(
+ 'message' => $result['message'],
+ 'code' => $result['code'],
+ ) );
+ }
+
+ self::shoot_ajax_success( $result );
+ }
+
+ /**
+ * Displays module activation dialog box after a successful upgrade
+ * where the user explicitly requested to auto download and install
+ * the premium version.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.7
+ */
+ function _add_auto_installation_dialog_box() {
+ $this->_logger->entrance();
+
+ if ( ! $this->is_registered() ) {
+ // Not registered.
+ return;
+ }
+
+ $plugin_id = fs_request_get( 'plugin_id', $this->get_id() );
+
+ if ( ! FS_Plugin::is_valid_id( $plugin_id ) ) {
+ // Invalid module ID.
+ return;
+ }
+
+ if ( $plugin_id == $this->get_id() ) {
+ if ( $this->is_premium() ) {
+ // Already using the premium code version.
+ return;
+ }
+ if ( ! $this->can_use_premium_code() ) {
+ // Don't have access to the premium code.
+ return;
+ }
+ if ( ! $this->has_release_on_freemius() ) {
+ // Plugin is a serviceware, no premium code version.
+ return;
+ }
+ } else {
+ $addon = $this->get_addon( $plugin_id );
+
+ if ( ! is_object( $addon ) ) {
+ // Invalid add-on ID.
+ return;
+ }
+
+ if ( $this->is_addon_activated( $plugin_id, true ) ) {
+ // Premium add-on version is already activated.
+ return;
+ }
+ }
+
+ $vars = array(
+ 'id' => $this->_module_id,
+ 'target_module_id' => $plugin_id,
+ 'slug' => $this->_slug,
+ );
+
+ fs_require_template( 'auto-installation.php', $vars );
+ }
+
+ #endregion
+
+ #--------------------------------------------------------------------------------
+ #region Tabs Integration
+ #--------------------------------------------------------------------------------
+
+ #region Module's Original Tabs
+
+ /**
+ * Inject a JavaScript logic to capture the theme tabs HTML.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ */
+ function _tabs_capture() {
+ $this->_logger->entrance();
+
+ if (
+ ! $this->is_product_settings_page() ||
+ ! $this->should_page_include_tabs() ||
+ ! $this->is_matching_url( $this->main_menu_url() )
+ ) {
+ return;
+ }
+
+ $params = array(
+ 'id' => $this->_module_id,
+ );
+
+ fs_require_once_template( 'tabs-capture-js.php', $params );
+ }
+
+ /**
+ * Cache theme's tabs HTML for a week. The cache will also be set as expired
+ * after version and type (free/premium) changes, in addition to the week period.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ */
+ function _store_tabs_ajax_action() {
+ $this->_logger->entrance();
+
+ $this->check_ajax_referer( 'store_tabs' );
+
+ // Init filesystem if not yet initiated.
+ WP_Filesystem();
+
+ // Get POST body HTML data.
+ global $wp_filesystem;
+ $tabs_html = $wp_filesystem->get_contents( "php://input" );
+
+ if ( is_string( $tabs_html ) ) {
+ $tabs_html = trim( $tabs_html );
+ }
+
+ if ( ! is_string( $tabs_html ) || empty( $tabs_html ) ) {
+ self::shoot_ajax_failure();
+ }
+
+ $this->_cache->set( 'tabs', $tabs_html, 7 * WP_FS__TIME_24_HOURS_IN_SEC );
+
+ self::shoot_ajax_success();
+ }
+
+ /**
+ * Cache theme's settings page custom styles. The cache will also be set as expired
+ * after version and type (free/premium) changes, in addition to the week period.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ */
+ function _store_tabs_styles() {
+ $this->_logger->entrance();
+
+ if (
+ ! $this->is_product_settings_page() ||
+ ! $this->should_page_include_tabs() ||
+ ! $this->is_matching_url( $this->main_menu_url() )
+ ) {
+ return;
+ }
+
+ $wp_styles = wp_styles();
+
+ $theme_styles_url = get_template_directory_uri();
+
+ $stylesheets = array();
+ foreach ( $wp_styles->queue as $handler ) {
+ if ( fs_starts_with( $handler, 'fs_' ) ) {
+ // Assume that stylesheets that their handler starts with "fs_" belong to the SDK.
+ continue;
+ }
+
+ /**
+ * @var _WP_Dependency $stylesheet
+ */
+ $stylesheet = $wp_styles->registered[ $handler ];
+
+ if ( fs_starts_with( $stylesheet->src, $theme_styles_url ) ) {
+ $stylesheets[] = $stylesheet->src;
+ }
+ }
+
+ if ( ! empty( $stylesheets ) ) {
+ $this->_cache->set( 'tabs_stylesheets', $stylesheets, 7 * WP_FS__TIME_24_HOURS_IN_SEC );
+ }
+ }
+
+ /**
+ * Check if module's original settings page has any tabs.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return bool
+ */
+ private function has_tabs() {
+ return $this->_cache->has( 'tabs' );
+ }
+
+ /**
+ * Get module's settings page HTML content, starting
+ * from the beginning of the element,
+ * until the tabs HTML (including).
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return string
+ */
+ private function get_tabs_html() {
+ $this->_logger->entrance();
+
+ return $this->_cache->get( 'tabs' );
+ }
+
+ /**
+ * Check if page should include tabs.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return bool
+ */
+ private function should_page_include_tabs() {
+ if ( ! $this->has_settings_menu() ) {
+ // Don't add tabs if no settings at all.
+ return false;
+ }
+
+ if ( self::NAVIGATION_TABS !== $this->_navigation ) {
+ // Only add tabs to themes for now.
+ return false;
+ }
+
+ if ( $this->is_theme() && ! $this->has_paid_plan() && ! $this->has_addons() ) {
+ // Only add tabs to monetizing themes.
+ return false;
+ }
+
+ if ( ! $this->is_product_settings_page() ) {
+ // Only add tabs if browsing one of the product's setting pages.
+ return false;
+ }
+
+ if ( $this->is_activation_mode() && $this->is_activation_page() ) {
+ // Don't include tabs in the activation page.
+ return false;
+ }
+
+ if ( $this->is_admin_page( 'pricing' ) && fs_request_get_bool( 'checkout' ) ) {
+ // Don't add tabs on checkout page, we want to reduce distractions
+ // as much as possible.
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Add the tabs HTML before the setting's page content and
+ * enqueue any required stylesheets.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return bool If tabs were included.
+ */
+ function _add_tabs_before_content() {
+ $this->_logger->entrance();
+
+ if ( ! $this->should_page_include_tabs() ) {
+ return false;
+ }
+
+ $tabs_html = $this->get_tabs_html();
+
+ if ( empty( $tabs_html ) ) {
+ return false;
+ }
+
+ /**
+ * Enqueue the original stylesheets that are included in the
+ * theme settings page. That way, if the theme settings has
+ * some custom _styled_ content above the tabs UI, this
+ * will make sure that the styling is preserved.
+ */
+ $stylesheets = $this->_cache->get( 'tabs_stylesheets', array() );
+ if ( is_array( $stylesheets ) ) {
+ for ( $i = 0, $len = count( $stylesheets ); $i < $len; $i ++ ) {
+ wp_enqueue_style( "fs_{$this->_module_id}_tabs_{$i}", $stylesheets[ $i ] );
+ }
+ }
+
+ // Cut closing
tag.
+ echo substr( trim( $tabs_html ), 0, - 6 );
+
+ return true;
+ }
+
+ /**
+ * Add the tabs closing HTML after the setting's page content.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @return bool If tabs closing HTML was included.
+ */
+ function _add_tabs_after_content() {
+ $this->_logger->entrance();
+
+ if ( ! $this->should_page_include_tabs() ) {
+ return false;
+ }
+
+ echo '';
+
+ return true;
+ }
+
+ #endregion
+
+ /**
+ * Add in-page JavaScript to inject the Freemius tabs into
+ * the module's setting tabs section.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ */
+ function _add_freemius_tabs() {
+ $this->_logger->entrance();
+
+ if ( ! $this->should_page_include_tabs() ) {
+ return;
+ }
+
+ $params = array( 'id' => $this->_module_id );
+ fs_require_once_template( 'tabs.php', $params );
+ }
+
+ #endregion
+
+ #--------------------------------------------------------------------------------
+ #region Customizer Integration for Themes
+ #--------------------------------------------------------------------------------
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ *
+ * @param WP_Customize_Manager $customizer
+ */
+ function _customizer_register( $customizer ) {
+ $this->_logger->entrance();
+
+ if ( $this->is_pricing_page_visible() ) {
+ require_once WP_FS__DIR_INCLUDES . '/customizer/class-fs-customizer-upsell-control.php';
+
+ $customizer->add_section( 'freemius_upsell', array(
+ 'title' => '★ ' . $this->get_text_inline( 'View paid features', 'view-paid-features' ),
+ 'priority' => 1,
+ ) );
+ $customizer->add_setting( 'freemius_upsell', array(
+ 'sanitize_callback' => 'esc_html',
+ ) );
+
+ $customizer->add_control( new FS_Customizer_Upsell_Control( $customizer, 'freemius_upsell', array(
+ 'fs' => $this,
+ 'section' => 'freemius_upsell',
+ 'priority' => 100,
+ ) ) );
+ }
+
+ if ( $this->is_page_visible( 'contact' ) || $this->is_page_visible( 'support' ) ) {
+ require_once WP_FS__DIR_INCLUDES . '/customizer/class-fs-customizer-support-section.php';
+
+ // Main Documentation Link In Customizer Root.
+ $customizer->add_section( new FS_Customizer_Support_Section( $customizer, 'freemius_support', array(
+ 'fs' => $this,
+ 'priority' => 1000,
+ ) ) );
+ }
+ }
+
+ #endregion
+
+ /**
+ * If the theme has a paid version, add some custom
+ * styling to the theme's premium version (if exists)
+ * to highlight that it's the premium version of the
+ * same theme, making it easier for identification
+ * after the user upgrades and upload it to the site.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.2.7
+ */
+ function _style_premium_theme() {
+ $this->_logger->entrance();
+
+ if ( ! self::is_themes_page() ) {
+ // Only include in the themes page.
+ return;
+ }
+
+ if ( ! $this->has_paid_plan() ) {
+ // Only include if has any paid plans.
+ return;
+ }
+
+ $params = null;
+ fs_require_once_template( '/js/jquery.content-change.php', $params );
+
+ $params = array(
+ 'slug' => $this->_slug,
+ 'id' => $this->_module_id,
+ );
+
+ fs_require_template( '/js/style-premium-theme.php', $params );
+ }
+
+ /**
+ * This method will return the absolute URL of the module's local icon.
+ *
+ * When you are running your plugin or theme on a **localhost** environment, if the icon
+ * is not found in the local assets folder, try to fetch the icon URL from Freemius. If not set and
+ * it's a plugin hosted on WordPress.org, try fetching the icon URL from wordpress.org.
+ * If an icon is found, this method will automatically attempt to download the icon and store it
+ * in /freemius/assets/img/{slug}.{png|jpg|gif|svg}.
+ *
+ * It's important to mention that this method is NOT phoning home since the developer will deploy
+ * the product with the local icon in the assets folder. The download process just simplifies
+ * the process for the developer.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return string
+ */
+ function get_local_icon_url() {
+ global $fs_active_plugins;
+
+ /**
+ * @since 1.1.7.5
+ */
+ $local_path = $this->apply_filters( 'plugin_icon', false );
+
+ if ( is_string( $local_path ) ) {
+ $icons = array( $local_path );
+ } else {
+ $img_dir = WP_FS__DIR_IMG;
+
+ // Locate the main assets folder.
+ if ( 1 < count( $fs_active_plugins->plugins ) ) {
+ $plugin_or_theme_img_dir = ( $this->is_plugin() ? WP_PLUGIN_DIR : get_theme_root( get_stylesheet() ) );
+
+ foreach ( $fs_active_plugins->plugins as $sdk_path => &$data ) {
+ if ( $data->plugin_path == $this->get_plugin_basename() ) {
+ $img_dir = $plugin_or_theme_img_dir
+ . '/'
+ /**
+ * The basename will be `themes` or the basename of a custom themes directory.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.3
+ */
+ . str_replace( '../' . basename( $plugin_or_theme_img_dir ) . '/', '', $sdk_path )
+ . '/assets/img';
+
+ break;
+ }
+ }
+ }
+
+ // Try to locate the icon in the assets folder.
+ $icons = glob( fs_normalize_path( $img_dir . "/{$this->_slug}.*" ) );
+
+ if ( ! is_array( $icons ) || 0 === count( $icons ) ) {
+ if ( ! WP_FS__IS_LOCALHOST && $this->is_theme() ) {
+ $icons = array(
+ fs_normalize_path( $img_dir . '/theme-icon.png' )
+ );
+ } else {
+ $icon_found = false;
+ $local_path = fs_normalize_path( "{$img_dir}/{$this->_slug}.png" );
+
+ if ( ! function_exists( 'get_filesystem_method' ) ) {
+ require_once ABSPATH . 'wp-admin/includes/file.php';
+ }
+
+ $have_write_permissions = ( 'direct' === get_filesystem_method( array(), fs_normalize_path( $img_dir ) ) );
+
+ /**
+ * IMPORTANT: THIS CODE WILL NEVER RUN AFTER THE PLUGIN IS IN THE REPO.
+ *
+ * This code will only be executed once during the testing
+ * of the plugin in a local environment. The plugin icon file WILL
+ * already exist in the assets folder when the plugin is deployed to
+ * the repository.
+ */
+ if ( WP_FS__IS_LOCALHOST && $have_write_permissions ) {
+ // Fetch icon from Freemius.
+ $icon = $this->fetch_remote_icon_url();
+
+ // Fetch icon from WordPress.org.
+ if ( empty( $icon ) && $this->is_plugin() && $this->is_org_repo_compliant() ) {
+ if ( ! function_exists( 'plugins_api' ) ) {
+ require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
+ }
+
+ $plugin_information = plugins_api( 'plugin_information', array(
+ 'slug' => $this->_slug,
+ 'fields' => array(
+ 'sections' => false,
+ 'tags' => false,
+ 'icons' => true
+ )
+ ) );
+
+ if (
+ ! is_wp_error( $plugin_information )
+ && isset( $plugin_information->icons )
+ && ! empty( $plugin_information->icons )
+ ) {
+ /**
+ * Get the smallest icon.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 1.2.2
+ */
+ $icon = end( $plugin_information->icons );
+ }
+ }
+
+ if ( ! empty( $icon ) ) {
+ if ( 0 !== strpos( $icon, 'http' ) ) {
+ $icon = 'http:' . $icon;
+ }
+
+ /**
+ * Get a clean file extension, e.g.: "jpg" and not "jpg?rev=1305765".
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 1.2.2
+ */
+ $ext = pathinfo( strtok( $icon, '?' ), PATHINFO_EXTENSION );
+
+ $local_path = fs_normalize_path( "{$img_dir}/{$this->_slug}.{$ext}" );
+
+ // Try to download the icon.
+ $icon_found = fs_download_image( $icon, $local_path );
+ }
+ }
+
+ if ( ! $icon_found ) {
+ // No icons found, fallback to default icon.
+ if ( $have_write_permissions ) {
+ // If have write permissions, copy default icon.
+ copy( fs_normalize_path( $img_dir . "/{$this->_module_type}-icon.png" ), $local_path );
+ } else {
+ // If doesn't have write permissions, use default icon path.
+ $local_path = fs_normalize_path( $img_dir . "/{$this->_module_type}-icon.png" );
+ }
+ }
+
+ $icons = array( $local_path );
+ }
+ }
+ }
+
+ $icon_dir = dirname( $icons[0] );
+
+ return fs_img_url( substr( $icons[0], strlen( $icon_dir ) ), $icon_dir );
+ }
+
+ /**
+ * Fetch module's extended info.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return object|mixed
+ */
+ private function fetch_module_info() {
+ return $this->get_api_plugin_scope()->get( 'info.json', false, WP_FS__TIME_WEEK_IN_SEC );
+ }
+
+ /**
+ * Fetch module's remote icon URL.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @return string
+ */
+ function fetch_remote_icon_url() {
+ $info = $this->fetch_module_info();
+
+ return ( $this->is_api_result_object( $info, 'icon' ) && is_string( $info->icon ) ) ?
+ $info->icon :
+ '';
+ }
+
+ #--------------------------------------------------------------------------------
+ #region GDPR
+ #--------------------------------------------------------------------------------
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.1.0
+ *
+ * @param array $user_plugins
+ *
+ * @return string
+ */
+ private function get_gdpr_admin_notice_string( $user_plugins ) {
+ $this->_logger->entrance();
+
+ $addons = self::get_all_addons();
+
+ foreach ( $user_plugins as $user_plugin ) {
+ $has_addons = isset( $addons[ $user_plugin->id ] );
+
+ if ( WP_FS__MODULE_TYPE_PLUGIN === $user_plugin->type && ! $has_addons ) {
+ if ( $this->_module_id == $user_plugin->id ) {
+ $addons = $this->get_addons();
+ $has_addons = ( ! empty( $addons ) );
+ } else {
+ $plugin_api = FS_Api::instance(
+ $user_plugin->id,
+ 'plugin',
+ $user_plugin->id,
+ $user_plugin->public_key,
+ ! $user_plugin->is_live,
+ false,
+ $this->get_sdk_version()
+ );
+
+ $addons_result = $plugin_api->get( '/addons.json?enriched=true', true );
+
+ if ( $this->is_api_result_object( $addons_result, 'plugins' ) &&
+ is_array( $addons_result->plugins ) &&
+ ! empty( $addons_result->plugins )
+ ) {
+ $has_addons = true;
+ }
+ }
+ }
+
+ $user_plugin->has_addons = $has_addons;
+ }
+
+ $is_single_parent_product = ( 1 === count( $user_plugins ) );
+
+ $multiple_products_text = '';
+
+ if ( $is_single_parent_product ) {
+ $single_parent_product = reset( $user_plugins );
+
+ $thank_you = sprintf(
+ "%s ",
+ $single_parent_product->id,
+ sprintf(
+ $single_parent_product->has_addons ?
+ $this->get_text_inline( 'Thank you so much for using %s and its add-ons!', 'thank-you-for-using-product-and-its-addons' ) :
+ $this->get_text_inline( 'Thank you so much for using %s!', 'thank-you-for-using-product' ),
+ sprintf('%s %s ",
+ $user_plugin->id,
+ $user_plugin->title
+ );
+ } else {
+ $products_and_add_ons .= sprintf(
+ "%s ",
+ $user_plugin->id,
+ sprintf(
+ $this->get_text_inline( '%s and its add-ons', 'product-and-its-addons' ),
+ $user_plugin->title
+ )
+ );
+ }
+ }
+
+ $multiple_products_text = sprintf(
+ "%s: %s%s ', $this->get_text_inline( 'Yes', 'yes' ) ),
+ $this->get_text_inline( 'send me security & feature updates, educational content and offers.', 'send-updates' ),
+ sprintf('%s ', $this->get_text_inline( 'No', 'no' ) ),
+ sprintf(
+ $this->get_text_inline( 'do %sNOT%s send me security & feature updates, educational content and offers.', 'do-not-send-updates' ),
+ '',
+ ' '
+ )
+ );
+
+ return sprintf(
+ '%s %s %s',
+ $thank_you,
+ $already_opted_in,
+ sprintf( $this->get_text_inline( 'Due to the new %sEU General Data Protection Regulation (GDPR)%s compliance requirements it is required that you provide your explicit consent, again, confirming that you are onboard :-)', 'due-to-gdpr-compliance-requirements' ), '', ' ' ) .
+ '' . $this->get_text_inline( "Please let us know if you'd like us to contact you for security & feature updates, educational content, and occasional offers:", 'contact-for-updates' ) . ' ' .
+ $actions .
+ ( $is_single_parent_product ? '' : $multiple_products_text )
+ );
+ }
+
+ /**
+ * This method is called for opted-in users to fetch the is_marketing_allowed flag of the user for all the
+ * plugins and themes they've opted in to.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.1.0
+ *
+ * @param string $user_email
+ * @param string $license_key
+ * @param array $plugin_ids
+ * @param string|null $license_key
+ *
+ * @return array|false
+ */
+ private function fetch_user_marketing_flag_status_by_plugins( $user_email, $license_key, $plugin_ids ) {
+ $request = array(
+ 'method' => 'POST',
+ 'body' => array(),
+ 'timeout' => WP_FS__DEBUG_SDK ? 60 : 30,
+ );
+
+ if ( is_string( $user_email ) ) {
+ $request['body']['email'] = $user_email;
+ } else {
+ $request['body']['license_key'] = $license_key;
+ }
+
+ $result = array();
+
+ $url = WP_FS__ADDRESS . '/action/service/user_plugin/';
+ $total_plugin_ids = count( $plugin_ids );
+
+ $plugin_ids_count_per_request = 10;
+ for ( $i = 1; $i <= $total_plugin_ids; $i += $plugin_ids_count_per_request ) {
+ $plugin_ids_set = array_slice( $plugin_ids, $i - 1, $plugin_ids_count_per_request );
+
+ $request['body']['plugin_ids'] = $plugin_ids_set;
+
+ $response = self::safe_remote_post(
+ $url,
+ $request,
+ WP_FS__TIME_24_HOURS_IN_SEC,
+ WP_FS__TIME_12_HOURS_IN_SEC
+ );
+
+ if ( ! is_wp_error( $response ) ) {
+ $decoded = is_string( $response['body'] ) ?
+ json_decode( $response['body'] ) :
+ null;
+
+ if (
+ !is_object($decoded) ||
+ !isset($decoded->success) ||
+ true !== $decoded->success ||
+ !isset( $decoded->data ) ||
+ !is_array( $decoded->data )
+ ) {
+ return false;
+ }
+
+ $result = array_merge( $result, $decoded->data );
+ }
+ }
+
+ return $result;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.1.0
+ */
+ function _maybe_show_gdpr_admin_notice() {
+ if ( ! $this->is_user_in_admin() ) {
+ return;
+ }
+
+ if ( ! $this->should_handle_gdpr_admin_notice() ) {
+ return;
+ }
+
+ if ( ! $this->is_user_admin() ) {
+ return;
+ }
+
+ require_once WP_FS__DIR_INCLUDES . '/class-fs-user-lock.php';
+
+ $lock = FS_User_Lock::instance();
+
+ /**
+ * Try to acquire a 60-sec lock based on the WP user and thread/process ID.
+ */
+ if ( ! $lock->try_lock( 60 ) ) {
+ return;
+ }
+
+ /**
+ * @var $current_wp_user WP_User
+ */
+ $current_wp_user = self::_get_current_wp_user();
+
+ /**
+ * @var FS_User $current_fs_user
+ */
+ $current_fs_user = Freemius::_get_user_by_email( $current_wp_user->user_email );
+
+ $ten_years_in_sec = 10 * 365 * WP_FS__TIME_24_HOURS_IN_SEC;
+
+ if ( ! is_object( $current_fs_user ) ) {
+ // 10-year lock.
+ $lock->lock( $ten_years_in_sec );
+
+ return;
+ }
+
+ $gdpr = FS_GDPR_Manager::instance();
+
+ if ( $gdpr->is_opt_in_notice_shown() ) {
+ // 30-day lock.
+ $lock->lock( 30 * WP_FS__TIME_24_HOURS_IN_SEC );
+
+ return;
+ }
+
+ if ( ! $gdpr->should_show_opt_in_notice() ) {
+ // 10-year lock.
+ $lock->lock( $ten_years_in_sec );
+
+ return;
+ }
+
+ $last_time_notice_shown = $gdpr->last_time_notice_was_shown();
+ $was_notice_shown_before = ( false !== $last_time_notice_shown );
+
+ if ( $was_notice_shown_before &&
+ 30 * WP_FS__TIME_24_HOURS_IN_SEC > time() - $last_time_notice_shown
+ ) {
+ // If the notice was shown before, show it again after 30 days from the last time it was shown.
+ return;
+ }
+
+ /**
+ * Find all plugin IDs that were installed by the current admin.
+ */
+ $plugin_ids_map = self::get_user_opted_in_module_ids_map( $current_fs_user->id );
+
+ if ( empty( $plugin_ids_map )) {
+ $lock->lock( $ten_years_in_sec );
+
+ return;
+ }
+
+ $user_plugins = $this->fetch_user_marketing_flag_status_by_plugins(
+ $current_fs_user->email,
+ null,
+ array_keys( $plugin_ids_map )
+ );
+
+ if ( empty( $user_plugins ) ) {
+ $lock->lock(
+ is_array($user_plugins) ?
+ $ten_years_in_sec :
+ // Lock for 24-hours on errors.
+ WP_FS__TIME_24_HOURS_IN_SEC
+ );
+
+ return;
+ }
+
+ $has_unset_marketing_optin = false;
+
+ foreach ( $user_plugins as $user_plugin ) {
+ if ( true == $user_plugin->is_marketing_allowed ) {
+ unset( $plugin_ids_map[ $user_plugin->plugin_id ] );
+ }
+
+ if ( ! $has_unset_marketing_optin && is_null( $user_plugin->is_marketing_allowed ) ) {
+ $has_unset_marketing_optin = true;
+ }
+ }
+
+ if ( empty( $plugin_ids_map ) ||
+ ( $was_notice_shown_before && ! $has_unset_marketing_optin )
+ ) {
+ $lock->lock( $ten_years_in_sec );
+
+ return;
+ }
+
+ $modules = array_merge(
+ array_values( self::maybe_get_entities_account_option( 'plugins', array() ) ),
+ array_values( self::maybe_get_entities_account_option( 'themes', array() ) )
+ );
+
+ foreach ( $modules as $module ) {
+ if ( ! FS_Plugin::is_valid_id( $module->parent_plugin_id ) && isset( $plugin_ids_map[ $module->id ] ) ) {
+ $plugin_ids_map[ $module->id ] = $module;
+ }
+ }
+
+ $plugin_title = null;
+ if ( 1 === count( $plugin_ids_map ) ) {
+ $module = reset( $plugin_ids_map );
+ $plugin_title = $module->title;
+ }
+
+ $gdpr->add_opt_in_sticky_notice(
+ $this->get_gdpr_admin_notice_string( $plugin_ids_map ),
+ $plugin_title
+ );
+
+ $this->add_gdpr_optin_ajax_handler_and_style();
+
+ $gdpr->notice_was_just_shown();
+
+ // 30-day lock.
+ $lock->lock( 30 * WP_FS__TIME_24_HOURS_IN_SEC );
+ }
+
+ /**
+ * Prevents the GDPR opt-in admin notice from being added if the user has already chosen to allow or not allow
+ * marketing.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.1.0
+ */
+ private function disable_opt_in_notice_and_lock_user() {
+ FS_GDPR_Manager::instance()->disable_opt_in_notice();
+
+ require_once WP_FS__DIR_INCLUDES . '/class-fs-user-lock.php';
+
+ // 10-year lock.
+ FS_User_Lock::instance()->lock( 10 * 365 * WP_FS__TIME_24_HOURS_IN_SEC );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.4
+ */
+ static function _add_api_connectivity_notice_handler_js() {
+ fs_require_once_template( 'api-connectivity-message-js.php' );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.1.0
+ */
+ function _add_gdpr_optin_js() {
+ $vars = array( 'id' => $this->_module_id );
+
+ fs_require_once_template( 'gdpr-optin-js.php', $vars );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.1.0
+ */
+ function enqueue_gdpr_optin_notice_style() {
+ fs_enqueue_local_style( 'fs_gdpr_optin_notice', '/admin/gdpr-optin-notice.css' );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.1.0
+ */
+ function _maybe_add_gdpr_optin_ajax_handler() {
+ $this->add_ajax_action( 'fetch_is_marketing_required_flag_value', array( &$this, '_fetch_is_marketing_required_flag_value_ajax_action' ) );
+
+ if ( FS_GDPR_Manager::instance()->is_opt_in_notice_shown() ) {
+ $this->add_gdpr_optin_ajax_handler_and_style();
+ }
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.1.0
+ */
+ function _fetch_is_marketing_required_flag_value_ajax_action() {
+ $this->_logger->entrance();
+
+ $this->check_ajax_referer( 'fetch_is_marketing_required_flag_value' );
+
+ $license_key = fs_request_get_raw( 'license_key' );
+
+ if ( empty($license_key) ) {
+ self::shoot_ajax_failure( $this->get_text_inline( 'License key is empty.', 'empty-license-key' ) );
+ }
+
+ $user_plugins = $this->fetch_user_marketing_flag_status_by_plugins(
+ null,
+ $license_key,
+ array( $this->_module_id )
+ );
+
+ if ( ! is_array( $user_plugins ) ||
+ empty($user_plugins) ||
+ !isset($user_plugins[0]->plugin_id) ||
+ $user_plugins[0]->plugin_id != $this->_module_id
+ ) {
+ /**
+ * If faced an error or if the module ID do not match to the current module, ask for GDPR opt-in.
+ *
+ * @author Vova Feldman (@svovaf)
+ */
+ self::shoot_ajax_success( array(
+ 'is_marketing_allowed' => null,
+ 'license_owner_id' => null
+ ) );
+ }
+
+ self::shoot_ajax_success( array(
+ 'is_marketing_allowed' => $user_plugins[0]->is_marketing_allowed,
+ 'license_owner_id' => ( isset( $user_plugins[0]->license_owner_id ) ? $user_plugins[0]->license_owner_id : null )
+ ) );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.3.2
+ *
+ * @param number[] $install_ids
+ *
+ * @return array {
+ * An array of objects containing the installs' licenses owners data.
+ *
+ * @property number $id User ID.
+ * @property string $email User email (can be masked email).
+ * }
+ */
+ private function fetch_installs_licenses_owners_data( $install_ids ) {
+ $this->_logger->entrance();
+
+ $response = $this->get_api_user_scope()->get(
+ '/licenses_owners.json?install_ids=' . implode( ',', $install_ids )
+ );
+
+ $license_owners = array();
+
+ if ( $this->is_api_result_object( $response, 'owners' ) ) {
+ $license_owners = $response->owners;
+ }
+
+ return $license_owners;
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.1.0
+ */
+ private function add_gdpr_optin_ajax_handler_and_style() {
+ // Add GDPR action AJAX callback.
+ $this->add_ajax_action( 'gdpr_optin_action', array( &$this, '_gdpr_optin_ajax_action' ) );
+
+ add_action( 'admin_footer', array( &$this, '_add_gdpr_optin_js' ) );
+ add_action( 'admin_enqueue_scripts', array( &$this, 'enqueue_gdpr_optin_notice_style' ) );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.1.0
+ */
+ function _gdpr_optin_ajax_action() {
+ $this->_logger->entrance();
+
+ $this->check_ajax_referer( 'gdpr_optin_action' );
+
+ if ( ! fs_request_has( 'is_marketing_allowed' ) || ! fs_request_has( 'plugin_ids' ) ) {
+ self::shoot_ajax_failure();
+ }
+
+ $current_wp_user = self::_get_current_wp_user();
+
+ $plugin_ids = fs_request_get( 'plugin_ids', array() );
+ if ( ! is_array( $plugin_ids ) || empty( $plugin_ids ) ) {
+ self::shoot_ajax_failure();
+ }
+
+ $modules = array_merge(
+ array_values( self::maybe_get_entities_account_option( 'plugins', array() ) ),
+ array_values( self::maybe_get_entities_account_option( 'themes', array() ) )
+ );
+
+ foreach ( $modules as $key => $module ) {
+ if ( ! in_array( $module->id, $plugin_ids ) ) {
+ unset( $modules[ $key ] );
+ }
+ }
+
+ if ( empty( $modules ) ) {
+ self::shoot_ajax_failure();
+ }
+
+ $user_api = $this->get_api_user_scope_by_user( Freemius::_get_user_by_email( $current_wp_user->user_email ) );
+
+ foreach ( $modules as $module ) {
+ $user_api->call( "?plugin_id={$module->id}", 'put', array(
+ 'is_marketing_allowed' => ( true == fs_request_get_bool( 'is_marketing_allowed' ) )
+ ) );
+ }
+
+ FS_GDPR_Manager::instance()->remove_opt_in_notice();
+
+ require_once WP_FS__DIR_INCLUDES . '/class-fs-user-lock.php';
+
+ // 10-year lock.
+ FS_User_Lock::instance()->lock( 10 * 365 * WP_FS__TIME_24_HOURS_IN_SEC );
+
+ self::shoot_ajax_success();
+ }
+
+ /**
+ * Checks if the GDPR admin notice should be handled. By default, this logic is off, unless the integrator adds the special 'handle_gdpr_admin_notice' filter.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.1.0
+ *
+ * @return bool
+ */
+ private function should_handle_gdpr_admin_notice() {
+ return $this->apply_filters(
+ 'handle_gdpr_admin_notice',
+ // Default to false.
+ false
+ );
+ }
+
+ #endregion
+
+ #----------------------------------------------------------------------------------
+ #region Marketing
+ #----------------------------------------------------------------------------------
+
+ /**
+ * Check if current user purchased any other plugins before.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @return bool
+ */
+ function has_purchased_before() {
+ // TODO: Implement has_purchased_before() method.
+ throw new Exception( 'not implemented' );
+ }
+
+ /**
+ * Check if current user classified as an agency.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @return bool
+ */
+ function is_agency() {
+ // TODO: Implement is_agency() method.
+ throw new Exception( 'not implemented' );
+ }
+
+ /**
+ * Check if current user classified as a developer.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @return bool
+ */
+ function is_developer() {
+ // TODO: Implement is_developer() method.
+ throw new Exception( 'not implemented' );
+ }
+
+ /**
+ * Check if current user classified as a business.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @return bool
+ */
+ function is_business() {
+ // TODO: Implement is_business() method.
+ throw new Exception( 'not implemented' );
+ }
+
+ #endregion
+
+ #----------------------------------------------------------------------------------
+ #region Helper
+ #----------------------------------------------------------------------------------
+
+ /**
+ * If running with a secret key, assume it's the developer and show pending plans as well.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.1.2
+ *
+ * @param string $path
+ *
+ * @return string
+ */
+ function add_show_pending( $path ) {
+ if ( ! $this->has_secret_key() ) {
+ return $path;
+ }
+
+ return $path . ( false !== strpos( $path, '?' ) ? '&' : '?' ) . 'show_pending=true';
+ }
+
+ #endregion
+ }
diff --git a/edwiser-bridge/freemius/includes/class-fs-admin-notices.php b/edwiser-bridge/freemius/includes/class-fs-admin-notices.php
new file mode 100644
index 0000000..a639402
--- /dev/null
+++ b/edwiser-bridge/freemius/includes/class-fs-admin-notices.php
@@ -0,0 +1,353 @@
+_id = $id;
+ $this->_title = $title;
+ $this->_module_unique_affix = $module_unique_affix;
+ $this->_is_multisite = is_multisite();
+
+ if ( $this->_is_multisite ) {
+ $this->_blog_id = get_current_blog_id();
+
+ $this->_network_notices = FS_Admin_Notice_Manager::instance(
+ $id,
+ $title,
+ $module_unique_affix,
+ $is_network_and_blog_admins,
+ true
+ );
+ }
+
+ $this->_notices = FS_Admin_Notice_Manager::instance(
+ $id,
+ $title,
+ $module_unique_affix,
+ false,
+ $this->_blog_id
+ );
+ }
+
+ /**
+ * Add admin message to admin messages queue, and hook to admin_notices / all_admin_notices if not yet hooked.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.4
+ *
+ * @param string $message
+ * @param string $title
+ * @param string $type
+ * @param bool $is_sticky
+ * @param string $id Message ID
+ * @param bool $store_if_sticky
+ * @param int|null $network_level_or_blog_id
+ *
+ * @uses add_action()
+ */
+ function add(
+ $message,
+ $title = '',
+ $type = 'success',
+ $is_sticky = false,
+ $id = '',
+ $store_if_sticky = true,
+ $network_level_or_blog_id = null,
+ $is_dimissible = null
+ ) {
+ $notices = $this->get_site_or_network_notices( $id, $network_level_or_blog_id );
+
+ $notices->add(
+ $message,
+ $title,
+ $type,
+ $is_sticky,
+ $id,
+ $store_if_sticky,
+ null,
+ null,
+ false,
+ $is_dimissible
+ );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.7
+ *
+ * @param string|string[] $ids
+ * @param int|null $network_level_or_blog_id
+ * @param bool $store
+ */
+ function remove_sticky( $ids, $network_level_or_blog_id = null, $store = true ) {
+ if ( ! is_array( $ids ) ) {
+ $ids = array( $ids );
+ }
+
+ if ( $this->should_use_network_notices( $ids[0], $network_level_or_blog_id ) ) {
+ $notices = $this->_network_notices;
+ } else {
+ $notices = $this->get_site_notices( $network_level_or_blog_id );
+ }
+
+ return $notices->remove_sticky( $ids, $store );
+ }
+
+ /**
+ * Check if sticky message exists by id.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ *
+ * @param string $id
+ * @param int|null $network_level_or_blog_id
+ *
+ * @return bool
+ */
+ function has_sticky( $id, $network_level_or_blog_id = null ) {
+ $notices = $this->get_site_or_network_notices( $id, $network_level_or_blog_id );
+
+ return $notices->has_sticky( $id );
+ }
+
+ /**
+ * Adds sticky admin notification.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.7
+ *
+ * @param string $message
+ * @param string $id Message ID
+ * @param string $title
+ * @param string $type
+ * @param int|null $network_level_or_blog_id
+ * @param number|null $wp_user_id
+ * @param string|null $plugin_title
+ * @param bool $is_network_and_blog_admins Whether or not the message should be shown both on network and
+ * blog admin pages.
+ * @param bool $is_dismissible
+ */
+ function add_sticky(
+ $message,
+ $id,
+ $title = '',
+ $type = 'success',
+ $network_level_or_blog_id = null,
+ $wp_user_id = null,
+ $plugin_title = null,
+ $is_network_and_blog_admins = false,
+ $is_dismissible = true,
+ $data = array()
+ ) {
+ $notices = $this->get_site_or_network_notices( $id, $network_level_or_blog_id );
+
+ $notices->add_sticky( $message, $id, $title, $type, $wp_user_id, $plugin_title, $is_network_and_blog_admins, $is_dismissible, $data );
+ }
+
+ /**
+ * Retrieves the data of a sticky notice.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.4.3
+ *
+ * @param string $id
+ * @param int|null $network_level_or_blog_id
+ *
+ * @return array|null
+ */
+ function get_sticky( $id, $network_level_or_blog_id ) {
+ $notices = $this->get_site_or_network_notices( $id, $network_level_or_blog_id );
+
+ return $notices->get_sticky( $id );
+ }
+
+ /**
+ * Clear all sticky messages.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int|null $network_level_or_blog_id
+ * @param bool $is_temporary
+ */
+ function clear_all_sticky( $network_level_or_blog_id = null, $is_temporary = false ) {
+ if ( ! $this->_is_multisite ||
+ false === $network_level_or_blog_id ||
+ 0 == $network_level_or_blog_id ||
+ is_null( $network_level_or_blog_id )
+ ) {
+ $notices = $this->get_site_notices( $network_level_or_blog_id );
+ $notices->clear_all_sticky( $is_temporary );
+ }
+
+ if ( $this->_is_multisite &&
+ ( true === $network_level_or_blog_id || is_null( $network_level_or_blog_id ) )
+ ) {
+ $this->_network_notices->clear_all_sticky( $is_temporary );
+ }
+ }
+
+ /**
+ * Add admin message to all admin messages queue, and hook to all_admin_notices if not yet hooked.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.4
+ *
+ * @param string $message
+ * @param string $title
+ * @param string $type
+ * @param bool $is_sticky
+ * @param string $id Message ID
+ */
+ function add_all( $message, $title = '', $type = 'success', $is_sticky = false, $id = '' ) {
+ $this->add( $message, $title, $type, $is_sticky, true, $id );
+ }
+
+ #--------------------------------------------------------------------------------
+ #region Helper Methods
+ #--------------------------------------------------------------------------------
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param int $blog_id
+ *
+ * @return FS_Admin_Notice_Manager
+ */
+ private function get_site_notices( $blog_id = 0 ) {
+ if ( 0 == $blog_id || $blog_id == $this->_blog_id ) {
+ return $this->_notices;
+ }
+
+ return FS_Admin_Notice_Manager::instance(
+ $this->_id,
+ $this->_title,
+ $this->_module_unique_affix,
+ false,
+ $blog_id
+ );
+ }
+
+ /**
+ * Check if the network notices should be used.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param string $id
+ * @param null|bool|int $network_level_or_blog_id When an integer, use the given blog storage. When `true` use the multisite notices (if there's a network). When `false`, use the current context blog notices. When `null`, the decision which notices manager to use (MS vs. Current S) will be handled internally and determined based on the $id and the context admin (blog admin vs. network level admin).
+ *
+ * @return bool
+ */
+ private function should_use_network_notices( $id = '', $network_level_or_blog_id = null ) {
+ if ( ! $this->_is_multisite ) {
+ // Not a multisite environment.
+ return false;
+ }
+
+ if ( is_numeric( $network_level_or_blog_id ) ) {
+ // Explicitly asked to use a specified blog storage.
+ return false;
+ }
+
+ if ( is_bool( $network_level_or_blog_id ) ) {
+ // Explicitly specified whether should use the network or blog level storage.
+ return $network_level_or_blog_id;
+ }
+
+ return fs_is_network_admin();
+ }
+
+ /**
+ * Retrieves an instance of FS_Admin_Notice_Manager.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.0
+ *
+ * @param string $id
+ * @param int|null $network_level_or_blog_id
+ *
+ * @return FS_Admin_Notice_Manager
+ */
+ private function get_site_or_network_notices( $id, $network_level_or_blog_id ) {
+ return $this->should_use_network_notices( $id, $network_level_or_blog_id ) ?
+ $this->_network_notices :
+ $this->get_site_notices( $network_level_or_blog_id );
+ }
+
+ #endregion
+ }
\ No newline at end of file
diff --git a/edwiser-bridge/freemius/includes/class-fs-api.php b/edwiser-bridge/freemius/includes/class-fs-api.php
new file mode 100755
index 0000000..1582538
--- /dev/null
+++ b/edwiser-bridge/freemius/includes/class-fs-api.php
@@ -0,0 +1,724 @@
+get_option( 'api_clock_diff', 0 );
+ Freemius_Api_WordPress::SetClockDiff( self::$_clock_diff );
+
+ if ( self::$_options->get_option( 'api_force_http', false ) ) {
+ Freemius_Api_WordPress::SetHttp();
+ }
+ }
+
+ /**
+ * @param string $slug
+ * @param string $scope 'app', 'developer', 'user' or 'install'.
+ * @param number $id Element's id.
+ * @param string $public_key Public key.
+ * @param bool|string $secret_key Element's secret key.
+ * @param bool $is_sandbox
+ * @param null|string $sdk_version
+ * @param null|string $url
+ */
+ private function __construct(
+ $slug,
+ $scope,
+ $id,
+ $public_key,
+ $secret_key,
+ $is_sandbox,
+ $sdk_version,
+ $url
+ ) {
+ $this->_api = new Freemius_Api_WordPress( $scope, $id, $public_key, $secret_key, $is_sandbox );
+
+ $this->_slug = $slug;
+ $this->_sdk_version = $sdk_version;
+ $this->_url = $url;
+ $this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_' . $slug . '_api', WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );
+ }
+
+ /**
+ * Find clock diff between server and API server, and store the diff locally.
+ *
+ * @param bool|int $diff
+ *
+ * @return bool|int False if clock diff didn't change, otherwise returns the clock diff in seconds.
+ */
+ private function _sync_clock_diff( $diff = false ) {
+ $this->_logger->entrance();
+
+ // Sync clock and store.
+ $new_clock_diff = ( false === $diff ) ?
+ Freemius_Api_WordPress::FindClockDiff() :
+ $diff;
+
+ if ( $new_clock_diff === self::$_clock_diff ) {
+ return false;
+ }
+
+ self::$_clock_diff = $new_clock_diff;
+
+ // Update API clock's diff.
+ Freemius_Api_WordPress::SetClockDiff( self::$_clock_diff );
+
+ // Store new clock diff in storage.
+ self::$_options->set_option( 'api_clock_diff', self::$_clock_diff, true );
+
+ return $new_clock_diff;
+ }
+
+ /**
+ * Override API call to enable retry with servers' clock auto sync method.
+ *
+ * @param string $path
+ * @param string $method
+ * @param array $params
+ * @param bool $in_retry Is in retry or first call attempt.
+ *
+ * @return array|mixed|string|void
+ */
+ private function _call( $path, $method = 'GET', $params = array(), $in_retry = false ) {
+ $this->_logger->entrance( $method . ':' . $path );
+
+ $force_http = ( ! $in_retry && self::$_options->get_option( 'api_force_http', false ) );
+
+ if ( self::is_temporary_down() ) {
+ $result = $this->get_temporary_unavailable_error();
+ } else {
+ /**
+ * @since 2.3.0 Include the SDK version with all API requests that going through the API manager. IMPORTANT: Only pass the SDK version if the caller didn't include it yet.
+ */
+ if ( ! empty( $this->_sdk_version ) ) {
+ if ( false === strpos( $path, 'sdk_version=' ) &&
+ ! isset( $params['sdk_version'] )
+ ) {
+ // Always add the sdk_version param in the querystring. DO NOT INCLUDE IT IN THE BODY PARAMS, OTHERWISE, IT MAY LEAD TO AN UNEXPECTED PARAMS PARSING IN CASES WHERE THE $params IS A REGULAR NON-ASSOCIATIVE ARRAY.
+ $path = add_query_arg( 'sdk_version', $this->_sdk_version, $path );
+ }
+ }
+
+ /**
+ * @since 2.5.0 Include the site's URL, if available, in all API requests that are going through the API manager.
+ */
+ if ( ! empty( $this->_url ) ) {
+ if ( false === strpos( $path, 'url=' ) &&
+ ! isset( $params['url'] )
+ ) {
+ $path = add_query_arg( 'url', $this->_url, $path );
+ }
+ }
+
+ $result = $this->_api->Api( $path, $method, $params );
+
+ if (
+ ! $in_retry &&
+ null !== $result &&
+ isset( $result->error ) &&
+ isset( $result->error->code )
+ ) {
+ $retry = false;
+
+ if ( 'request_expired' === $result->error->code ) {
+ $diff = isset( $result->error->timestamp ) ?
+ ( time() - strtotime( $result->error->timestamp ) ) :
+ false;
+
+ // Try to sync clock diff.
+ if ( false !== $this->_sync_clock_diff( $diff ) ) {
+ // Retry call with new synced clock.
+ $retry = true;
+ }
+ } else if (
+ Freemius_Api_WordPress::IsHttps() &&
+ FS_Api::is_ssl_error_response( $result )
+ ) {
+ $force_http = true;
+ $retry = true;
+ }
+
+ if ( $retry ) {
+ if ( $force_http ) {
+ $this->toggle_force_http( true );
+ }
+
+ $result = $this->_call( $path, $method, $params, true );
+ }
+ }
+ }
+
+ if ( self::is_api_error( $result ) ) {
+ if ( $this->_logger->is_on() ) {
+ // Log API errors.
+ $this->_logger->api_error( $result );
+ }
+
+ if ( $force_http ) {
+ $this->toggle_force_http( false );
+ }
+ }
+
+ return $result;
+ }
+
+ /**
+ * Override API call to wrap it in servers' clock sync method.
+ *
+ * @param string $path
+ * @param string $method
+ * @param array $params
+ *
+ * @return array|mixed|string|void
+ * @throws Freemius_Exception
+ */
+ function call( $path, $method = 'GET', $params = array() ) {
+ return $this->_call( $path, $method, $params );
+ }
+
+ /**
+ * Get API request URL signed via query string.
+ *
+ * @param string $path
+ *
+ * @return string
+ */
+ function get_signed_url( $path ) {
+ return $this->_api->GetSignedUrl( $path );
+ }
+
+ /**
+ * @param string $path
+ * @param bool $flush
+ * @param int $expiration (optional) Time until expiration in seconds from now, defaults to 24 hours
+ *
+ * @return stdClass|mixed
+ */
+ function get( $path = '/', $flush = false, $expiration = WP_FS__TIME_24_HOURS_IN_SEC ) {
+ $this->_logger->entrance( $path );
+
+ $cache_key = $this->get_cache_key( $path );
+
+ // Always flush during development.
+ if ( WP_FS__DEV_MODE || $this->_api->IsSandbox() ) {
+ $flush = true;
+ }
+
+ $has_valid_cache = self::$_cache->has_valid( $cache_key, $expiration );
+ $cached_result = $has_valid_cache ?
+ self::$_cache->get( $cache_key ) :
+ null;
+
+ if ( $flush || is_null( $cached_result ) ) {
+ $result = $this->call( $path );
+
+ if ( ! is_object( $result ) || isset( $result->error ) ) {
+ // Api returned an error.
+ if ( is_object( $cached_result ) &&
+ ! isset( $cached_result->error )
+ ) {
+ // If there was an error during a newer data fetch,
+ // fallback to older data version.
+ $result = $cached_result;
+
+ if ( $this->_logger->is_on() ) {
+ $this->_logger->warn( 'Fallback to cached API result: ' . var_export( $cached_result, true ) );
+ }
+ } else {
+ if ( is_object( $result ) && isset( $result->error->http ) && 404 == $result->error->http ) {
+ /**
+ * If the response code is 404, cache the result for half of the `$expiration`.
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.2.4
+ */
+ $expiration /= 2;
+ } else {
+ // If no older data version and the response code is not 404, return result without
+ // caching the error.
+ return $result;
+ }
+ }
+ }
+
+ if ( is_numeric( $expiration ) ) {
+ self::$_cache->set( $cache_key, $result, $expiration );
+ }
+
+ $cached_result = $result;
+ } else {
+ $this->_logger->log( 'Using cached API result.' );
+ }
+
+ return $cached_result;
+ }
+
+ /**
+ * @todo Remove this method after migrating Freemius::safe_remote_post() to FS_Api::call().
+ *
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.4
+ *
+ * @param string $url
+ * @param array $remote_args
+ *
+ * @return array|WP_Error The response array or a WP_Error on failure.
+ */
+ static function remote_request( $url, $remote_args ) {
+ if ( ! class_exists( 'Freemius_Api_WordPress' ) ) {
+ require_once WP_FS__DIR_SDK . '/FreemiusWordPress.php';
+ }
+
+ if ( method_exists( 'Freemius_Api_WordPress', 'RemoteRequest' ) ) {
+ return Freemius_Api_WordPress::RemoteRequest( $url, $remote_args );
+ }
+
+ // The following is for backward compatibility when a modified PHP SDK version is in use and the `Freemius_Api_WordPress:RemoteRequest()` method doesn't exist.
+ $response = wp_remote_request( $url, $remote_args );
+
+ if (
+ is_array( $response ) &&
+ (
+ empty( $response['headers'] ) ||
+ empty( $response['headers']['x-api-server'] )
+ )
+ ) {
+ // API is considered blocked if the response doesn't include the `x-api-server` header. When there's no error but this header doesn't exist, the response is usually not in the expected form (e.g., cannot be JSON-decoded).
+ $response = new WP_Error( 'api_blocked', htmlentities( $response['body'] ) );
+ }
+
+ return $response;
+ }
+
+ /**
+ * Check if there's a cached version of the API request.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1
+ *
+ * @param string $path
+ * @param string $method
+ * @param array $params
+ *
+ * @return bool
+ */
+ function is_cached( $path, $method = 'GET', $params = array() ) {
+ $cache_key = $this->get_cache_key( $path, $method, $params );
+
+ return self::$_cache->has_valid( $cache_key );
+ }
+
+ /**
+ * Invalidate a cached version of the API request.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.5
+ *
+ * @param string $path
+ * @param string $method
+ * @param array $params
+ */
+ function purge_cache( $path, $method = 'GET', $params = array() ) {
+ $this->_logger->entrance( "{$method}:{$path}" );
+
+ $cache_key = $this->get_cache_key( $path, $method, $params );
+
+ self::$_cache->purge( $cache_key );
+ }
+
+ /**
+ * Invalidate a cached version of the API request.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param string $path
+ * @param int $expiration
+ * @param string $method
+ * @param array $params
+ */
+ function update_cache_expiration( $path, $expiration = WP_FS__TIME_24_HOURS_IN_SEC, $method = 'GET', $params = array() ) {
+ $this->_logger->entrance( "{$method}:{$path}:{$expiration}" );
+
+ $cache_key = $this->get_cache_key( $path, $method, $params );
+
+ self::$_cache->update_expiration( $cache_key, $expiration );
+ }
+
+ /**
+ * @param string $path
+ * @param string $method
+ * @param array $params
+ *
+ * @return string
+ * @throws \Freemius_Exception
+ */
+ private function get_cache_key( $path, $method = 'GET', $params = array() ) {
+ $canonized = $this->_api->CanonizePath( $path );
+// $exploded = explode('/', $canonized);
+// return $method . '_' . array_pop($exploded) . '_' . md5($canonized . json_encode($params));
+ return strtolower( $method . ':' . $canonized ) . ( ! empty( $params ) ? '#' . md5( json_encode( $params ) ) : '' );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.4
+ *
+ * @param bool $is_http
+ */
+ private function toggle_force_http( $is_http ) {
+ self::$_options->set_option( 'api_force_http', $is_http, true );
+
+ if ( $is_http ) {
+ Freemius_Api_WordPress::SetHttp();
+ } else if ( method_exists( 'Freemius_Api_WordPress', 'SetHttps' ) ) {
+ Freemius_Api_WordPress::SetHttps();
+ }
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.4
+ *
+ * @param mixed $response
+ *
+ * @return bool
+ */
+ static function is_blocked( $response ) {
+ return (
+ self::is_api_error_object( $response, true ) &&
+ isset( $response->error->code ) &&
+ 'api_blocked' === $response->error->code
+ );
+ }
+
+ /**
+ * Check if API is temporary down.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.6
+ *
+ * @return bool
+ */
+ static function is_temporary_down() {
+ self::_init();
+
+ $test = self::$_cache->get_valid( 'ping_test', null );
+
+ return ( false === $test );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.6
+ *
+ * @return object
+ */
+ private function get_temporary_unavailable_error() {
+ return (object) array(
+ 'error' => (object) array(
+ 'type' => 'TemporaryUnavailable',
+ 'message' => 'API is temporary unavailable, please retry in ' . ( self::$_cache->get_record_expiration( 'ping_test' ) - WP_FS__SCRIPT_START_TIME ) . ' sec.',
+ 'code' => 'temporary_unavailable',
+ 'http' => 503
+ )
+ );
+ }
+
+ /**
+ * Check if based on the API result we should try
+ * to re-run the same request with HTTP instead of HTTPS.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.1.6
+ *
+ * @param $result
+ *
+ * @return bool
+ */
+ private static function should_try_with_http( $result ) {
+ if ( ! Freemius_Api_WordPress::IsHttps() ) {
+ return false;
+ }
+
+ return ( ! is_object( $result ) ||
+ ! isset( $result->error ) ||
+ ! isset( $result->error->code ) ||
+ ! in_array( $result->error->code, array(
+ 'curl_missing',
+ 'cloudflare_ddos_protection',
+ 'maintenance_mode',
+ 'squid_cache_block',
+ 'too_many_requests',
+ ) ) );
+
+ }
+
+ function get_url( $path = '' ) {
+ return Freemius_Api_WordPress::GetUrl( $path, $this->_api->IsSandbox() );
+ }
+
+ /**
+ * Clear API cache.
+ *
+ * @author Vova Feldman (@svovaf)
+ * @since 1.0.9
+ */
+ static function clear_cache() {
+ self::_init();
+
+ self::$_cache = FS_Cache_Manager::get_manager( WP_FS__API_CACHE_OPTION_NAME );
+ self::$_cache->clear();
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.4
+ */
+ static function clear_force_http_flag() {
+ self::$_options->unset_option( 'api_force_http' );
+ }
+
+ #----------------------------------------------------------------------------------
+ #region Error Handling
+ #----------------------------------------------------------------------------------
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 1.2.1.5
+ *
+ * @param mixed $result
+ *
+ * @return bool Is API result contains an error.
+ */
+ static function is_api_error( $result ) {
+ return ( is_object( $result ) && isset( $result->error ) ) ||
+ is_string( $result );
+ }
+
+ /**
+ * @author Vova Feldman (@svovaf)
+ * @since 2.0.0
+ *
+ * @param mixed $result
+ * @param bool $ignore_message
+ *
+ * @return bool Is API result contains an error.
+ */
+ static function is_api_error_object( $result, $ignore_message = false ) {
+ return (
+ is_object( $result ) &&
+ isset( $result->error ) &&
+ ( $ignore_message || isset( $result->error->message ) )
+ );
+ }
+
+ /**
+ * @author Leo Fajardo (@leorw)
+ * @since 2.5.4
+ *
+ * @param WP_Error|object|string $response
+ *
+ * @return bool
+ */
+ static function is_ssl_error_response( $response ) {
+ $http_error = null;
+
+ if ( $response instanceof WP_Error ) {
+ if (
+ isset( $response->errors ) &&
+ isset( $response->errors['http_request_failed'] )
+ ) {
+ $http_error = strtolower( $response->errors['http_request_failed'][0] );
+ }
+ } else if (
+ self::is_api_error_object( $response ) &&
+ ! empty( $response->error->message )
+ ) {
+ $http_error = $response->error->message;
+ }
+
+ return (
+ ! empty( $http_error ) &&
+ (
+ false !== strpos( $http_error, 'curl error 35' ) ||
+ (
+ false === strpos( $http_error, '