/freemius/start.php

  1. <?php 
  2.   /** 
  3.    * @package     Freemius 
  4.    * @copyright   Copyright (c) 2015, Freemius, Inc. 
  5.    * @license     http://opensource.org/licenses/gpl-2.0.php GNU Public License 
  6.    * @since       1.0.3 
  7.    */ 
  8.  
  9.   if ( ! defined( 'ABSPATH' ) ) { 
  10.       exit; 
  11.   } 
  12.  
  13.   /** 
  14.    * Freemius SDK Version. 
  15.    * 
  16.    * @var string 
  17.    */ 
  18.   $this_sdk_version = '1.2.1'; 
  19.  
  20.   #region SDK Selection Logic -------------------------------------------------------------------- 
  21.  
  22.   /** 
  23.    * Special logic added on 1.1.6 to make sure that every Freemius powered plugin 
  24.    * will ALWAYS be loaded with the newest SDK from the active Freemius powered plugins. 
  25.    * 
  26.    * Since Freemius SDK is backward compatible, this will make sure that all Freemius powered 
  27.    * plugins will run correctly. 
  28.    * 
  29.    * @since 1.1.6 
  30.    */ 
  31.  
  32.   global $fs_active_plugins; 
  33.  
  34.   $this_sdk_relative_path = plugin_basename( dirname( __FILE__ ) ); 
  35.  
  36.   if ( ! isset( $fs_active_plugins ) ) { 
  37.       // Require SDK essentials. 
  38.       require_once dirname( __FILE__ ) . '/includes/fs-essential-functions.php'; 
  39.  
  40.       // Load all Freemius powered active plugins. 
  41.       $fs_active_plugins = get_option( 'fs_active_plugins', new stdClass() ); 
  42.  
  43.       if ( ! isset( $fs_active_plugins->plugins ) ) { 
  44.           $fs_active_plugins->plugins = array(); 
  45.       } 
  46.   } 
  47.  
  48.   if ( ! function_exists( 'fs_find_direct_caller_plugin_file' ) ) { 
  49.       require_once dirname( __FILE__ ) . '/includes/supplements/fs-essential-functions-1.1.7.1.php'; 
  50.   } 
  51.  
  52.   // Update current SDK info based on the SDK path. 
  53.   if ( ! isset( $fs_active_plugins->plugins[ $this_sdk_relative_path ] ) || 
  54.        $this_sdk_version != $fs_active_plugins->plugins[ $this_sdk_relative_path ]->version 
  55.  ) { 
  56.       $fs_active_plugins->plugins[ $this_sdk_relative_path ] = (object) array( 
  57.           'version' => $this_sdk_version,  
  58.           'timestamp' => time(),  
  59.           'plugin_path' => plugin_basename( fs_find_direct_caller_plugin_file( __FILE__ ) ),  
  60.  ); 
  61.   } 
  62.  
  63.   $is_current_sdk_newest = isset( $fs_active_plugins->newest ) && ( $this_sdk_relative_path == $fs_active_plugins->newest->sdk_path ); 
  64.  
  65.   if ( ! isset( $fs_active_plugins->newest ) ) { 
  66.       /** 
  67.        * This will be executed only once, for the first time a Freemius powered plugin is activated. 
  68.        */ 
  69.       fs_update_sdk_newest_version( $this_sdk_relative_path, $fs_active_plugins->plugins[ $this_sdk_relative_path ]->plugin_path ); 
  70.  
  71.       $is_current_sdk_newest = true; 
  72.   } else if ( version_compare( $fs_active_plugins->newest->version, $this_sdk_version, '<' ) ) { 
  73.       /** 
  74.        * Current SDK is newer than the newest stored SDK. 
  75.        */ 
  76.       fs_update_sdk_newest_version( $this_sdk_relative_path, $fs_active_plugins->plugins[ $this_sdk_relative_path ]->plugin_path ); 
  77.  
  78.       if ( class_exists( 'Freemius' ) ) { 
  79.           // Older SDK version was already loaded. 
  80.  
  81.           if ( ! $fs_active_plugins->newest->in_activation ) { 
  82.               // Re-order plugins to load this plugin first. 
  83.               fs_newest_sdk_plugin_first(); 
  84.           } 
  85.  
  86.           // Refresh page. 
  87.           if ( fs_redirect( $_SERVER['REQUEST_URI'] ) ) { 
  88.               exit(); 
  89.           } 
  90.       } 
  91.   } else { 
  92.       if ( ! function_exists( 'get_plugins' ) ) { 
  93.           require_once( ABSPATH . 'wp-admin/includes/plugin.php' ); 
  94.       } 
  95.  
  96.       $is_newest_sdk_plugin_activate = is_plugin_active( $fs_active_plugins->newest->plugin_path ); 
  97.  
  98.       if ( $is_current_sdk_newest && 
  99.            ! $is_newest_sdk_plugin_activate && 
  100.            ! $fs_active_plugins->newest->in_activation 
  101.  ) { 
  102.           // If current SDK is the newest and the plugin is NOT active, it means 
  103.           // that the current plugin in activation mode. 
  104.           $fs_active_plugins->newest->in_activation = true; 
  105.           update_option( 'fs_active_plugins', $fs_active_plugins ); 
  106.       } 
  107.  
  108.       $is_newest_sdk_path_valid = ( $is_newest_sdk_plugin_activate || $fs_active_plugins->newest->in_activation ) && file_exists( fs_normalize_path( WP_PLUGIN_DIR . '/' . $this_sdk_relative_path . '/start.php' ) ); 
  109.  
  110.       if ( ! $is_newest_sdk_path_valid && ! $is_current_sdk_newest ) { 
  111.           // Plugin with newest SDK is no longer active, or SDK was moved to a different location. 
  112.           unset( $fs_active_plugins->plugins[ $fs_active_plugins->newest->sdk_path ] ); 
  113.       } 
  114.  
  115.       if ( ! ( $is_newest_sdk_plugin_activate || $fs_active_plugins->newest->in_activation ) || 
  116.            ! $is_newest_sdk_path_valid || 
  117.            // Is newest SDK downgraded. 
  118.            ( $this_sdk_relative_path == $fs_active_plugins->newest->sdk_path && 
  119.              version_compare( $fs_active_plugins->newest->version, $this_sdk_version, '>' ) ) 
  120.  ) { 
  121.           /** 
  122.            * Plugin with newest SDK is no longer active. 
  123.            *    OR 
  124.            * The newest SDK was in the current plugin. BUT, seems like the version of 
  125.            * the SDK was downgraded to a lower SDK. 
  126.            */ 
  127.           // Find the active plugin with the newest SDK version and update the newest reference. 
  128.           fs_fallback_to_newest_active_sdk(); 
  129.       } else { 
  130.           if ( $is_newest_sdk_plugin_activate && 
  131.                $this_sdk_relative_path == $fs_active_plugins->newest->sdk_path && 
  132.                ( $fs_active_plugins->newest->in_activation || 
  133.                  ( class_exists( 'Freemius' ) && ( ! defined( 'WP_FS__SDK_VERSION' ) || version_compare( WP_FS__SDK_VERSION, $this_sdk_version, '<' ) ) ) 
  134.  ) 
  135.  
  136.  ) { 
  137.               if ( $fs_active_plugins->newest->in_activation ) { 
  138.                   // Plugin no more in activation. 
  139.                   $fs_active_plugins->newest->in_activation = false; 
  140.                   update_option( 'fs_active_plugins', $fs_active_plugins ); 
  141.               } 
  142.  
  143.               // Reorder plugins to load plugin with newest SDK first. 
  144.               if ( fs_newest_sdk_plugin_first() ) { 
  145.                   // Refresh page after re-order to make sure activated plugin loads newest SDK. 
  146.                   if ( class_exists( 'Freemius' ) ) { 
  147.                       if ( fs_redirect( $_SERVER['REQUEST_URI'] ) ) { 
  148.                           exit(); 
  149.                       } 
  150.                   } 
  151.               } 
  152.           } 
  153.       } 
  154.   } 
  155.  
  156.   if ( class_exists( 'Freemius' ) ) { 
  157.       // SDK was already loaded. 
  158.       return; 
  159.   } 
  160.  
  161.   if ( version_compare( $this_sdk_version, $fs_active_plugins->newest->version, '<' ) ) { 
  162.       $newest_sdk_starter = fs_normalize_path( WP_PLUGIN_DIR . '/' . $fs_active_plugins->newest->sdk_path . '/start.php' ); 
  163.  
  164.       if ( file_exists( $newest_sdk_starter ) ) { 
  165.           // Reorder plugins to load plugin with newest SDK first. 
  166.           fs_newest_sdk_plugin_first(); 
  167.  
  168.           // There's a newer SDK version, load it instead of the current one! 
  169.           require_once $newest_sdk_starter; 
  170.  
  171.           return; 
  172.       } 
  173.   } 
  174.  
  175.   #endregion SDK Selection Logic -------------------------------------------------------------------- 
  176.  
  177.   #region Hooks & Filters Collection -------------------------------------------------------------------- 
  178.  
  179.   /** 
  180.    * Freemius hooks (actions & filters) tags structure: 
  181.    * 
  182.    *      fs_{filter/action_name}_{plugin_slug} 
  183.    * 
  184.    * -------------------------------------------------------- 
  185.    * 
  186.    * Usage with WordPress' add_action() / add_filter(): 
  187.    * 
  188.    *      add_action('fs_{filter/action_name}_{plugin_slug}', $callable); 
  189.    * 
  190.    * -------------------------------------------------------- 
  191.    * 
  192.    * Usage with Freemius' instance add_action() / add_filter(): 
  193.    * 
  194.    *      // No need to add 'fs_' prefix nor '_{plugin_slug}' suffix. 
  195.    *      my_freemius()->add_action('{action_name}', $callable); 
  196.    * 
  197.    * -------------------------------------------------------- 
  198.    * 
  199.    * Freemius filters collection: 
  200.    * 
  201.    *      fs_connect_url_{plugin_slug} 
  202.    *      fs_trial_promotion_message_{plugin_slug} 
  203.    *      fs_is_long_term_user_{plugin_slug} 
  204.    *      fs_uninstall_reasons_{plugin_slug} 
  205.    *      fs_is_plugin_update_{plugin_slug} 
  206.    *      fs_api_domains_{plugin_slug} 
  207.    *      fs_email_template_sections_{plugin_slug} 
  208.    *      fs_support_forum_submenu_{plugin_slug} 
  209.    *      fs_support_forum_url_{plugin_slug} 
  210.    *      fs_connect_message_{plugin_slug} 
  211.    *      fs_connect_message_on_update_{plugin_slug} 
  212.    *      fs_uninstall_confirmation_message_{plugin_slug} 
  213.    *      fs_pending_activation_message_{plugin_slug} 
  214.    *      fs_is_submenu_visible_{plugin_slug} 
  215.    *      fs_plugin_icon_{plugin_slug} 
  216.    *      fs_show_trial_{plugin_slug} 
  217.    * 
  218.    * -------------------------------------------------------- 
  219.    * 
  220.    * Freemius actions collection: 
  221.    * 
  222.    *      fs_after_license_loaded_{plugin_slug} 
  223.    *      fs_after_license_change_{plugin_slug} 
  224.    *      fs_after_plans_sync_{plugin_slug} 
  225.    * 
  226.    *      fs_after_account_details_{plugin_slug} 
  227.    *      fs_after_account_user_sync_{plugin_slug} 
  228.    *      fs_after_account_plan_sync_{plugin_slug} 
  229.    *      fs_before_account_load_{plugin_slug} 
  230.    *      fs_after_account_connection_{plugin_slug} 
  231.    *      fs_account_property_edit_{plugin_slug} 
  232.    *      fs_account_email_verified_{plugin_slug} 
  233.    *      fs_account_page_load_before_departure_{plugin_slug} 
  234.    *      fs_before_account_delete_{plugin_slug} 
  235.    *      fs_after_account_delete_{plugin_slug} 
  236.    * 
  237.    *      fs_sdk_version_update_{plugin_slug} 
  238.    *      fs_plugin_version_update_{plugin_slug} 
  239.    * 
  240.    *      fs_initiated_{plugin_slug} 
  241.    *      fs_after_init_plugin_registered_{plugin_slug} 
  242.    *      fs_after_init_plugin_anonymous_{plugin_slug} 
  243.    *      fs_after_init_plugin_pending_activations_{plugin_slug} 
  244.    *      fs_after_init_addon_registered_{plugin_slug} 
  245.    *      fs_after_init_addon_anonymous_{plugin_slug} 
  246.    *      fs_after_init_addon_pending_activations_{plugin_slug} 
  247.    * 
  248.    *      fs_after_premium_version_activation_{plugin_slug} 
  249.    *      fs_after_free_version_reactivation_{plugin_slug} 
  250.    * 
  251.    *      fs_after_uninstall_{plugin_slug} 
  252.    *      fs_before_admin_menu_init_{plugin_slug} 
  253.    */ 
  254.  
  255.   #endregion Hooks & Filters Collection -------------------------------------------------------------------- 
  256.  
  257.   if ( ! class_exists( 'Freemius' ) ) { 
  258.  
  259.       if ( ! defined( 'WP_FS__SDK_VERSION' ) ) { 
  260.           define( 'WP_FS__SDK_VERSION', $this_sdk_version ); 
  261.       } 
  262.  
  263.       // Load SDK files. 
  264.       require_once dirname( __FILE__ ) . '/require.php'; 
  265.  
  266.       /** 
  267.        * Quick shortcut to get Freemius for specified plugin. 
  268.        * Used by various templates. 
  269.        * 
  270.        * @param string $slug 
  271.        * 
  272.        * @return Freemius 
  273.        */ 
  274.       function freemius( $slug ) { 
  275.           return Freemius::instance( $slug ); 
  276.       } 
  277.  
  278.       /** 
  279.        * @param string $slug 
  280.        * @param number $plugin_id 
  281.        * @param string $public_key 
  282.        * @param bool   $is_live    Is live or test plugin. 
  283.        * @param bool   $is_premium Hints freemius if running the premium plugin or not. 
  284.        * 
  285.        * @return Freemius 
  286.        * 
  287.        * @deprecated Please use fs_dynamic_init(). 
  288.        */ 
  289.       function fs_init( $slug, $plugin_id, $public_key, $is_live = true, $is_premium = true ) { 
  290.           $fs = Freemius::instance( $slug, true ); 
  291.           $fs->init( $plugin_id, $public_key, $is_live, $is_premium ); 
  292.  
  293.           return $fs; 
  294.       } 
  295.  
  296.       /** 
  297.        * @param array<string, string> $module Plugin or Theme details. 
  298.        * 
  299.        * @return Freemius 
  300.        * @throws Freemius_Exception 
  301.        */ 
  302.       function fs_dynamic_init( $module ) { 
  303.           $fs = Freemius::instance( $module['slug'], true ); 
  304.           $fs->dynamic_init( $module ); 
  305.  
  306.           return $fs; 
  307.       } 
  308.  
  309.       function fs_dump_log() { 
  310.           FS_Logger::dump(); 
  311.       } 
  312.   } 
.