| 1 |
<?php |
| 2 |
/** |
| 3 |
* IMPORTANT: |
| 4 |
* This file will be loaded based on the order of the plugins/themes load. |
| 5 |
* If there's a theme and a plugin using Freemius, the plugin's essential |
| 6 |
* file will always load first. |
| 7 |
* |
| 8 |
* @package Freemius |
| 9 |
* @copyright Copyright (c) 2015, Freemius, Inc. |
| 10 |
* @license https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3 |
| 11 |
* @since 1.1.5 |
| 12 |
*/ |
| 13 |
|
| 14 |
if ( ! function_exists( 'fs_normalize_path' ) ) { |
| 15 |
if ( function_exists( 'wp_normalize_path' ) ) { |
| 16 |
/** |
| 17 |
* Normalize a filesystem path. |
| 18 |
* |
| 19 |
* Replaces backslashes with forward slashes for Windows systems, and ensures |
| 20 |
* no duplicate slashes exist. |
| 21 |
* |
| 22 |
* @param string $path Path to normalize. |
| 23 |
* |
| 24 |
* @return string Normalized path. |
| 25 |
*/ |
| 26 |
function fs_normalize_path( $path ) { |
| 27 |
return wp_normalize_path( $path ); |
| 28 |
} |
| 29 |
} else { |
| 30 |
function fs_normalize_path( $path ) { |
| 31 |
$path = str_replace( '\\', '/', $path ); |
| 32 |
$path = preg_replace( '|/+|', '/', $path ); |
| 33 |
|
| 34 |
return $path; |
| 35 |
} |
| 36 |
} |
| 37 |
} |
| 38 |
|
| 39 |
#region Core Redirect (copied from BuddyPress) ----------------------------------------- |
| 40 |
|
| 41 |
if ( ! function_exists( 'fs_redirect' ) ) { |
| 42 |
/** |
| 43 |
* Redirects to another page, with a workaround for the IIS Set-Cookie bug. |
| 44 |
* |
| 45 |
* @link http://support.microsoft.com/kb/q176113/ |
| 46 |
* @since 1.5.1 |
| 47 |
* @uses apply_filters() Calls 'wp_redirect' hook on $location and $status. |
| 48 |
* |
| 49 |
* @param string $location The path to redirect to. |
| 50 |
* @param bool $exit If true, exit after redirect (Since 1.2.1.5). |
| 51 |
* @param int $status Status code to use. |
| 52 |
* |
| 53 |
* @return bool False if $location is not set |
| 54 |
*/ |
| 55 |
function fs_redirect( $location, $exit = true, $status = 302 ) { |
| 56 |
global $is_IIS; |
| 57 |
|
| 58 |
$file = ''; |
| 59 |
$line = ''; |
| 60 |
if ( headers_sent($file, $line) ) { |
| 61 |
if ( WP_FS__DEBUG_SDK && class_exists( 'FS_Admin_Notice_Manager' ) ) { |
| 62 |
$notices = FS_Admin_Notice_Manager::instance( 'global' ); |
| 63 |
|
| 64 |
$notices->add( "Freemius failed to redirect the page because the headers have been already sent from line <b><code>{$line}</code></b> in file <b><code>{$file}</code></b>. If it's unexpected, it usually happens due to invalid space and/or EOL character(s).", 'Oops...', 'error' ); |
| 65 |
} |
| 66 |
|
| 67 |
return false; |
| 68 |
} |
| 69 |
|
| 70 |
if ( defined( 'DOING_AJAX' ) ) { |
| 71 |
// Don't redirect on AJAX calls. |
| 72 |
return false; |
| 73 |
} |
| 74 |
|
| 75 |
if ( ! $location ) // allows the wp_redirect filter to cancel a redirect |
| 76 |
{ |
| 77 |
return false; |
| 78 |
} |
| 79 |
|
| 80 |
$location = fs_sanitize_redirect( $location ); |
| 81 |
|
| 82 |
if ( $is_IIS ) { |
| 83 |
header( "Refresh: 0;url=$location" ); |
| 84 |
} else { |
| 85 |
if ( php_sapi_name() != 'cgi-fcgi' ) { |
| 86 |
status_header( $status ); |
| 87 |
} // This causes problems on IIS and some FastCGI setups |
| 88 |
header( "Location: $location" ); |
| 89 |
} |
| 90 |
|
| 91 |
if ( $exit ) { |
| 92 |
exit(); |
| 93 |
} |
| 94 |
|
| 95 |
return true; |
| 96 |
} |
| 97 |
|
| 98 |
if ( ! function_exists( 'fs_sanitize_redirect' ) ) { |
| 99 |
/** |
| 100 |
* Sanitizes a URL for use in a redirect. |
| 101 |
* |
| 102 |
* @since 2.3 |
| 103 |
* |
| 104 |
* @param string $location |
| 105 |
* |
| 106 |
* @return string redirect-sanitized URL |
| 107 |
*/ |
| 108 |
function fs_sanitize_redirect( $location ) { |
| 109 |
$location = preg_replace( '|[^a-z0-9-~+_.?#=&;,/:%!]|i', '', $location ); |
| 110 |
$location = fs_kses_no_null( $location ); |
| 111 |
|
| 112 |
// remove %0d and %0a from location |
| 113 |
$strip = array( '%0d', '%0a' ); |
| 114 |
$found = true; |
| 115 |
while ( $found ) { |
| 116 |
$found = false; |
| 117 |
foreach ( (array) $strip as $val ) { |
| 118 |
while ( strpos( $location, $val ) !== false ) { |
| 119 |
$found = true; |
| 120 |
$location = str_replace( $val, '', $location ); |
| 121 |
} |
| 122 |
} |
| 123 |
} |
| 124 |
|
| 125 |
return $location; |
| 126 |
} |
| 127 |
} |
| 128 |
|
| 129 |
if ( ! function_exists( 'fs_kses_no_null' ) ) { |
| 130 |
/** |
| 131 |
* Removes any NULL characters in $string. |
| 132 |
* |
| 133 |
* @since 1.0.0 |
| 134 |
* |
| 135 |
* @param string $string |
| 136 |
* |
| 137 |
* @return string |
| 138 |
*/ |
| 139 |
function fs_kses_no_null( $string ) { |
| 140 |
$string = preg_replace( '/\0+/', '', $string ); |
| 141 |
$string = preg_replace( '/(\\\\0)+/', '', $string ); |
| 142 |
|
| 143 |
return $string; |
| 144 |
} |
| 145 |
} |
| 146 |
} |
| 147 |
|
| 148 |
#endregion Core Redirect (copied from BuddyPress) ----------------------------------------- |
| 149 |
|
| 150 |
if ( ! function_exists( '__fs' ) ) { |
| 151 |
global $fs_text_overrides; |
| 152 |
|
| 153 |
if ( ! isset( $fs_text_overrides ) ) { |
| 154 |
$fs_text_overrides = array(); |
| 155 |
} |
| 156 |
|
| 157 |
/** |
| 158 |
* Retrieve a translated text by key. |
| 159 |
* |
| 160 |
* @deprecated Use `fs_text()` instead since methods starting with `__` trigger warnings in Php 7. |
| 161 |
* @todo Remove this method in the future. |
| 162 |
* |
| 163 |
* @author Vova Feldman (@svovaf) |
| 164 |
* @since 1.1.4 |
| 165 |
* |
| 166 |
* @param string $key |
| 167 |
* @param string $slug |
| 168 |
* |
| 169 |
* @return string |
| 170 |
* |
| 171 |
* @global $fs_text, $fs_text_overrides |
| 172 |
*/ |
| 173 |
function __fs( $key, $slug = 'freemius' ) { |
| 174 |
global $fs_text, |
| 175 |
$fs_module_info_text, |
| 176 |
$fs_text_overrides; |
| 177 |
|
| 178 |
if ( isset( $fs_text_overrides[ $slug ] ) ) { |
| 179 |
if ( isset( $fs_text_overrides[ $slug ][ $key ] ) ) { |
| 180 |
return $fs_text_overrides[ $slug ][ $key ]; |
| 181 |
} |
| 182 |
|
| 183 |
$lower_key = strtolower( $key ); |
| 184 |
if ( isset( $fs_text_overrides[ $slug ][ $lower_key ] ) ) { |
| 185 |
return $fs_text_overrides[ $slug ][ $lower_key ]; |
| 186 |
} |
| 187 |
} |
| 188 |
|
| 189 |
if ( ! isset( $fs_text ) ) { |
| 190 |
$dir = defined( 'WP_FS__DIR_INCLUDES' ) ? |
| 191 |
WP_FS__DIR_INCLUDES : |
| 192 |
dirname( __FILE__ ); |
| 193 |
|
| 194 |
require_once $dir . '/i18n.php'; |
| 195 |
} |
| 196 |
|
| 197 |
if ( isset( $fs_text[ $key ] ) ) { |
| 198 |
return $fs_text[ $key ]; |
| 199 |
} |
| 200 |
|
| 201 |
if ( isset( $fs_module_info_text[ $key ] ) ) { |
| 202 |
return $fs_module_info_text[ $key ]; |
| 203 |
} |
| 204 |
|
| 205 |
return $key; |
| 206 |
} |
| 207 |
|
| 208 |
/** |
| 209 |
* Output a translated text by key. |
| 210 |
* |
| 211 |
* @deprecated Use `fs_echo()` instead for consistency with `fs_text()`. |
| 212 |
* |
| 213 |
* @todo Remove this method in the future. |
| 214 |
* |
| 215 |
* @author Vova Feldman (@svovaf) |
| 216 |
* @since 1.1.4 |
| 217 |
* |
| 218 |
* @param string $key |
| 219 |
* @param string $slug |
| 220 |
*/ |
| 221 |
function _efs( $key, $slug = 'freemius' ) { |
| 222 |
fs_echo( $key, $slug ); |
| 223 |
} |
| 224 |
} |
| 225 |
|
| 226 |
if ( ! function_exists( 'fs_override_i18n' ) ) { |
| 227 |
/** |
| 228 |
* Override default i18n text phrases. |
| 229 |
* |
| 230 |
* @author Vova Feldman (@svovaf) |
| 231 |
* @since 1.1.6 |
| 232 |
* |
| 233 |
* @param string[] $key_value |
| 234 |
* @param string $slug |
| 235 |
* |
| 236 |
* @global $fs_text_overrides |
| 237 |
*/ |
| 238 |
function fs_override_i18n( array $key_value, $slug = 'freemius' ) { |
| 239 |
global $fs_text_overrides; |
| 240 |
|
| 241 |
if ( ! isset( $fs_text_overrides[ $slug ] ) ) { |
| 242 |
$fs_text_overrides[ $slug ] = array(); |
| 243 |
} |
| 244 |
|
| 245 |
foreach ( $key_value as $key => $value ) { |
| 246 |
$fs_text_overrides[ $slug ][ $key ] = $value; |
| 247 |
} |
| 248 |
} |
| 249 |
} |
| 250 |
|
| 251 |
if ( ! function_exists( 'fs_get_ip' ) ) { |
| 252 |
/** |
| 253 |
* Get client IP. |
| 254 |
* |
| 255 |
* @author Vova Feldman (@svovaf) |
| 256 |
* @since 1.1.2 |
| 257 |
* |
| 258 |
* @return string|null |
| 259 |
*/ |
| 260 |
function fs_get_ip() { |
| 261 |
$fields = array( |
| 262 |
'HTTP_CF_CONNECTING_IP', |
| 263 |
'HTTP_CLIENT_IP', |
| 264 |
'HTTP_X_FORWARDED_FOR', |
| 265 |
'HTTP_X_FORWARDED', |
| 266 |
'HTTP_FORWARDED_FOR', |
| 267 |
'HTTP_FORWARDED', |
| 268 |
'REMOTE_ADDR', |
| 269 |
); |
| 270 |
|
| 271 |
foreach ( $fields as $ip_field ) { |
| 272 |
if ( ! empty( $_SERVER[ $ip_field ] ) ) { |
| 273 |
return $_SERVER[ $ip_field ]; |
| 274 |
} |
| 275 |
} |
| 276 |
|
| 277 |
return null; |
| 278 |
} |
| 279 |
} |
| 280 |
|
| 281 |
/** |
| 282 |
* Leverage backtrace to find caller plugin main file path. |
| 283 |
* |
| 284 |
* @author Vova Feldman (@svovaf) |
| 285 |
* @since 1.0.6 |
| 286 |
* |
| 287 |
* @return string |
| 288 |
*/ |
| 289 |
function fs_find_caller_plugin_file() { |
| 290 |
/** |
| 291 |
* All the code below will be executed once on activation. |
| 292 |
* If the user changes the main plugin's file name, the file_exists() |
| 293 |
* will catch it. |
| 294 |
*/ |
| 295 |
if ( ! function_exists( 'get_plugins' ) ) { |
| 296 |
require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
| 297 |
} |
| 298 |
|
| 299 |
$all_plugins = get_plugins(); |
| 300 |
$all_plugins_paths = array(); |
| 301 |
|
| 302 |
// Get active plugin's main files real full names (might be symlinks). |
| 303 |
foreach ( $all_plugins as $relative_path => &$data ) { |
| 304 |
$all_plugins_paths[] = fs_normalize_path( realpath( WP_PLUGIN_DIR . '/' . $relative_path ) ); |
| 305 |
} |
| 306 |
|
| 307 |
$plugin_file = null; |
| 308 |
for ( $i = 1, $bt = debug_backtrace(), $len = count( $bt ); $i < $len; $i ++ ) { |
| 309 |
if ( empty( $bt[ $i ]['file'] ) ) { |
| 310 |
continue; |
| 311 |
} |
| 312 |
|
| 313 |
if ( in_array( fs_normalize_path( $bt[ $i ]['file'] ), $all_plugins_paths ) ) { |
| 314 |
$plugin_file = $bt[ $i ]['file']; |
| 315 |
break; |
| 316 |
} |
| 317 |
} |
| 318 |
|
| 319 |
if ( is_null( $plugin_file ) ) { |
| 320 |
// Throw an error to the developer in case of some edge case dev environment. |
| 321 |
wp_die( |
| 322 |
'Freemius SDK couldn\'t find the plugin\'s main file. Please contact sdk@freemius.com with the current error.', |
| 323 |
'Error', |
| 324 |
array( 'back_link' => true ) |
| 325 |
); |
| 326 |
} |
| 327 |
|
| 328 |
return $plugin_file; |
| 329 |
} |
| 330 |
|
| 331 |
require_once dirname( __FILE__ ) . '/supplements/fs-essential-functions-1.1.7.1.php'; |
| 332 |
|
| 333 |
/** |
| 334 |
* Update SDK newest version reference. |
| 335 |
* |
| 336 |
* @author Vova Feldman (@svovaf) |
| 337 |
* @since 1.1.6 |
| 338 |
* |
| 339 |
* @param string $sdk_relative_path |
| 340 |
* @param string|bool $plugin_file |
| 341 |
* |
| 342 |
* @global $fs_active_plugins |
| 343 |
*/ |
| 344 |
function fs_update_sdk_newest_version( $sdk_relative_path, $plugin_file = false ) { |
| 345 |
/** |
| 346 |
* If there is a plugin running an older version of FS (1.2.1 or below), the `fs_update_sdk_newest_version()` |
| 347 |
* function in the older version will be used instead of this one. But since the older version is using |
| 348 |
* the `is_plugin_active` function to check if a plugin is active, passing the theme's `plugin_path` to the |
| 349 |
* `is_plugin_active` function will return false since the path is not a plugin path, so `in_activation` will be |
| 350 |
* `true` for theme modules and the upgrading of the SDK version to 1.2.2 or newer version will work fine. |
| 351 |
* |
| 352 |
* Future versions that will call this function will use the proper logic here instead of just relying on the |
| 353 |
* `is_plugin_active` function to fail for themes. |
| 354 |
* |
| 355 |
* @author Leo Fajardo (@leorw) |
| 356 |
* @since 1.2.2 |
| 357 |
*/ |
| 358 |
|
| 359 |
global $fs_active_plugins; |
| 360 |
|
| 361 |
$newest_sdk = $fs_active_plugins->plugins[ $sdk_relative_path ]; |
| 362 |
|
| 363 |
if ( ! is_string( $plugin_file ) ) { |
| 364 |
$plugin_file = plugin_basename( fs_find_caller_plugin_file() ); |
| 365 |
} |
| 366 |
|
| 367 |
if ( ! isset( $newest_sdk->type ) || 'theme' !== $newest_sdk->type ) { |
| 368 |
$in_activation = ( ! is_plugin_active( $plugin_file ) ); |
| 369 |
} else { |
| 370 |
$theme = wp_get_theme(); |
| 371 |
$in_activation = ( $newest_sdk->plugin_path == $theme->stylesheet ); |
| 372 |
} |
| 373 |
|
| 374 |
$fs_active_plugins->newest = (object) array( |
| 375 |
'plugin_path' => $plugin_file, |
| 376 |
'sdk_path' => $sdk_relative_path, |
| 377 |
'version' => $newest_sdk->version, |
| 378 |
'in_activation' => $in_activation, |
| 379 |
'timestamp' => time(), |
| 380 |
); |
| 381 |
|
| 382 |
// Update DB with latest SDK version and path. |
| 383 |
update_option( 'fs_active_plugins', $fs_active_plugins ); |
| 384 |
} |
| 385 |
|
| 386 |
/** |
| 387 |
* Reorder the plugins load order so the plugin with the newest Freemius SDK is loaded first. |
| 388 |
* |
| 389 |
* @author Vova Feldman (@svovaf) |
| 390 |
* @since 1.1.6 |
| 391 |
* |
| 392 |
* @return bool Was plugin order changed. Return false if plugin was loaded first anyways. |
| 393 |
* |
| 394 |
* @global $fs_active_plugins |
| 395 |
*/ |
| 396 |
function fs_newest_sdk_plugin_first() { |
| 397 |
global $fs_active_plugins; |
| 398 |
|
| 399 |
/** |
| 400 |
* @todo Multi-site network activated plugin are always loaded prior to site plugins so if there's a a plugin activated in the network mode that has an older version of the SDK of another plugin which is site activated that has new SDK version, the fs-essential-functions.php will be loaded from the older SDK. Same thing about MU plugins (loaded even before network activated plugins). |
| 401 |
* |
| 402 |
* @link https://github.com/Freemius/wordpress-sdk/issues/26 |
| 403 |
*/ |
| 404 |
// $active_sitewide_plugins = get_site_option( 'active_sitewide_plugins' ); |
| 405 |
|
| 406 |
$active_plugins = get_option( 'active_plugins' ); |
| 407 |
$newest_sdk_plugin_key = array_search( $fs_active_plugins->newest->plugin_path, $active_plugins ); |
| 408 |
if ( 0 == $newest_sdk_plugin_key ) { |
| 409 |
// if it's 0 it's the first plugin already, no need to continue |
| 410 |
return false; |
| 411 |
} |
| 412 |
|
| 413 |
array_splice( $active_plugins, $newest_sdk_plugin_key, 1 ); |
| 414 |
array_unshift( $active_plugins, $fs_active_plugins->newest->plugin_path ); |
| 415 |
update_option( 'active_plugins', $active_plugins ); |
| 416 |
|
| 417 |
return true; |
| 418 |
} |
| 419 |
|
| 420 |
/** |
| 421 |
* Go over all Freemius SDKs in the system and find and "remember" |
| 422 |
* the newest SDK which is associated with an active plugin. |
| 423 |
* |
| 424 |
* @author Vova Feldman (@svovaf) |
| 425 |
* @since 1.1.6 |
| 426 |
* |
| 427 |
* @global $fs_active_plugins |
| 428 |
*/ |
| 429 |
function fs_fallback_to_newest_active_sdk() { |
| 430 |
global $fs_active_plugins; |
| 431 |
|
| 432 |
/** |
| 433 |
* @var object $newest_sdk_data |
| 434 |
*/ |
| 435 |
$newest_sdk_data = null; |
| 436 |
$newest_sdk_path = null; |
| 437 |
|
| 438 |
foreach ( $fs_active_plugins->plugins as $sdk_relative_path => $data ) { |
| 439 |
if ( is_null( $newest_sdk_data ) || version_compare( $data->version, $newest_sdk_data->version, '>' ) |
| 440 |
) { |
| 441 |
// If plugin inactive or SDK starter file doesn't exist, remove SDK reference. |
| 442 |
if ( 'plugin' === $data->type ) { |
| 443 |
$is_module_active = is_plugin_active( $data->plugin_path ); |
| 444 |
} else { |
| 445 |
$active_theme = wp_get_theme(); |
| 446 |
$is_module_active = ( $data->plugin_path === $active_theme->get_template() ); |
| 447 |
} |
| 448 |
|
| 449 |
$is_sdk_exists = file_exists( fs_normalize_path( WP_PLUGIN_DIR . '/' . $sdk_relative_path . '/start.php' ) ); |
| 450 |
|
| 451 |
if ( ! $is_module_active || ! $is_sdk_exists ) { |
| 452 |
unset( $fs_active_plugins->plugins[ $sdk_relative_path ] ); |
| 453 |
|
| 454 |
// No need to store the data since it will be stored in fs_update_sdk_newest_version() |
| 455 |
// or explicitly with update_option(). |
| 456 |
} else { |
| 457 |
$newest_sdk_data = $data; |
| 458 |
$newest_sdk_path = $sdk_relative_path; |
| 459 |
} |
| 460 |
} |
| 461 |
} |
| 462 |
|
| 463 |
if ( is_null( $newest_sdk_data ) ) { |
| 464 |
// Couldn't find any SDK reference. |
| 465 |
$fs_active_plugins = new stdClass(); |
| 466 |
update_option( 'fs_active_plugins', $fs_active_plugins ); |
| 467 |
} else { |
| 468 |
fs_update_sdk_newest_version( $newest_sdk_path, $newest_sdk_data->plugin_path ); |
| 469 |
} |
| 470 |
} |
| 471 |
|
| 472 |
#region Actions / Filters ----------------------------------------- |
| 473 |
|
| 474 |
/** |
| 475 |
* Apply filter for specific plugin. |
| 476 |
* |
| 477 |
* @author Vova Feldman (@svovaf) |
| 478 |
* @since 1.0.9 |
| 479 |
* |
| 480 |
* @param string $module_unique_affix Module's unique affix. |
| 481 |
* @param string $tag The name of the filter hook. |
| 482 |
* @param mixed $value The value on which the filters hooked to `$tag` are applied on. |
| 483 |
* |
| 484 |
* @return mixed The filtered value after all hooked functions are applied to it. |
| 485 |
* |
| 486 |
* @uses apply_filters() |
| 487 |
*/ |
| 488 |
function fs_apply_filter( $module_unique_affix, $tag, $value ) { |
| 489 |
$args = func_get_args(); |
| 490 |
|
| 491 |
return call_user_func_array( 'apply_filters', array_merge( |
| 492 |
array( "fs_{$tag}_{$module_unique_affix}" ), |
| 493 |
array_slice( $args, 2 ) ) |
| 494 |
); |
| 495 |
} |
| 496 |
|
| 497 |
#endregion Actions / Filters ----------------------------------------- |
