FooGallery – Image Gallery WordPress Plugin - Version 1.4.31

Version Description

  • New : GDPR notice in readme
  • New : Update to Freemius SDK 2.0.1
  • Fix : Default captions bug introduced in 1.4.30
Download this release

Release Info

Developer bradvin
Plugin Icon 128x128 FooGallery – Image Gallery WordPress Plugin
Version 1.4.31
Comparing to
See all releases

Code changes from version 1.4.30 to 1.4.31

Files changed (18) hide show
  1. README.txt +13 -1
  2. foogallery.php +2 -2
  3. freemius/assets/css/admin/account.css +1 -1
  4. freemius/assets/css/admin/affiliation.css +1 -1
  5. freemius/assets/css/admin/connect.css +1 -1
  6. freemius/assets/css/admin/dialog-boxes.css +1 -1
  7. freemius/assets/img/foogallery.png +0 -0
  8. freemius/assets/scss/_colors.scss +3 -0
  9. freemius/assets/scss/admin/_license-activation.scss +40 -0
  10. freemius/assets/scss/admin/_modal-common.scss +8 -0
  11. freemius/assets/scss/admin/_multisite-options.scss +40 -0
  12. freemius/assets/scss/admin/_tooltip.scss +66 -0
  13. freemius/assets/scss/admin/account.scss +51 -5
  14. freemius/assets/scss/admin/connect.scss +27 -0
  15. freemius/assets/scss/admin/dialog-boxes.scss +1 -0
  16. freemius/composer.json +1 -1
  17. freemius/config.php +372 -325
  18. freemius/includes/class-freemius.php +16690 -10482
README.txt CHANGED
@@ -3,7 +3,7 @@ Contributors: bradvin, steveush, fooplugins, freemius
3
  Donate link: http://fooplugins.com
4
  Tags: gallery, image gallery, photo gallery, responsive, album, media gallery, masonry gallery, portfolio, justified image gallery, video gallery, photography, photographer, retina
5
  Requires at least: 3.9
6
- Tested up to: 4.9.5
7
  Stable tag: trunk
8
  License: GPLv2 or later
9
  License URI: http://www.gnu.org/licenses/gpl-2.0.html
@@ -16,6 +16,12 @@ Why choose FooGallery? Stunning gallery layouts, responsive, retina-ready, light
16
 
17
  [View the FooGallery Homepage & DEMO](http://foo.gallery/)
18
 
 
 
 
 
 
 
19
  **PHP 7 Compatible**
20
 
21
  FooGallery has been tried and tested on servers running PHP 7.
@@ -150,6 +156,12 @@ Update now to get all the latest features, bug fixes and improvements!
150
 
151
  == Changelog ==
152
 
 
 
 
 
 
 
153
  = 1.4.30 =
154
 
155
  * Fix : Album 404 issues when used on homepage
3
  Donate link: http://fooplugins.com
4
  Tags: gallery, image gallery, photo gallery, responsive, album, media gallery, masonry gallery, portfolio, justified image gallery, video gallery, photography, photographer, retina
5
  Requires at least: 3.9
6
+ Tested up to: 4.9.6
7
  Stable tag: trunk
8
  License: GPLv2 or later
9
  License URI: http://www.gnu.org/licenses/gpl-2.0.html
16
 
17
  [View the FooGallery Homepage & DEMO](http://foo.gallery/)
18
 
19
+ **GDPR**
20
+
21
+ When you install FooGallery for the first time, the plugin asks you (the website admin) to opt-in so that we can track your usage of the plugin and provide a better service (send you update emails for new version releases and security updates etc). *This is optional and not required in order to use the plugin.*
22
+
23
+ From your website point of view, FooGallery never collects or stores any visitor information at all, when someone visits your website.
24
+
25
  **PHP 7 Compatible**
26
 
27
  FooGallery has been tried and tested on servers running PHP 7.
156
 
157
  == Changelog ==
158
 
159
+ = 1.4.31 =
160
+
161
+ * New : GDPR notice in readme
162
+ * New : Update to Freemius SDK 2.0.1
163
+ * Fix : Default captions bug introduced in 1.4.30
164
+
165
  = 1.4.30 =
166
 
167
  * Fix : Album 404 issues when used on homepage
foogallery.php CHANGED
@@ -3,7 +3,7 @@
3
  /*
4
  Plugin Name: FooGallery
5
  Description: FooGallery is the most intuitive and extensible gallery management tool ever created for WordPress
6
- Version: 1.4.30
7
  Author: FooPlugins
8
  Plugin URI: https://foo.gallery
9
  Author URI: http://fooplugins.com
@@ -23,7 +23,7 @@ if ( !class_exists( 'FooGallery_Plugin' ) ) {
23
  define( 'FOOGALLERY_PATH', plugin_dir_path( __FILE__ ) );
24
  define( 'FOOGALLERY_URL', plugin_dir_url( __FILE__ ) );
25
  define( 'FOOGALLERY_FILE', __FILE__ );
26
- define( 'FOOGALLERY_VERSION', '1.4.30' );
27
  define( 'FOOGALLERY_SETTINGS_VERSION', '2' );
28
  require_once FOOGALLERY_PATH . 'includes/constants.php';
29
  // Create a helper function for easy SDK access.
3
  /*
4
  Plugin Name: FooGallery
5
  Description: FooGallery is the most intuitive and extensible gallery management tool ever created for WordPress
6
+ Version: 1.4.31
7
  Author: FooPlugins
8
  Plugin URI: https://foo.gallery
9
  Author URI: http://fooplugins.com
23
  define( 'FOOGALLERY_PATH', plugin_dir_path( __FILE__ ) );
24
  define( 'FOOGALLERY_URL', plugin_dir_url( __FILE__ ) );
25
  define( 'FOOGALLERY_FILE', __FILE__ );
26
+ define( 'FOOGALLERY_VERSION', '1.4.31' );
27
  define( 'FOOGALLERY_SETTINGS_VERSION', '2' );
28
  require_once FOOGALLERY_PATH . 'includes/constants.php';
29
  // Create a helper function for easy SDK access.
freemius/assets/css/admin/account.css CHANGED
@@ -1 +1 @@
1
- #fs_account .postbox,#fs_account .widefat{max-width:700px}#fs_account h3{font-size:1.3em;padding:12px 15px;margin:0 0 12px 0;line-height:1.4;border-bottom:1px solid #F1F1F1}#fs_account h3 .dashicons{width:26px;height:26px;font-size:1.3em}#fs_account i.dashicons{font-size:1.2em;height:1.2em;width:1.2em}#fs_account .button i.dashicons{vertical-align:middle}#fs_account .fs-header-actions{position:absolute;top:17px;right:15px;font-size:0.9em}#fs_account .fs-header-actions ul{margin:0}#fs_account .fs-header-actions li{float:left}#fs_account .fs-header-actions li form{display:inline-block}#fs_account .fs-header-actions li a{text-decoration:none}#fs_account_details .button-group{float:right}.rtl #fs_account .fs-header-actions{left:15px;right:auto}.fs-key-value-table{width:100%}.fs-key-value-table form{display:inline-block}.fs-key-value-table tr td:first-child{text-align:right}.fs-key-value-table tr td:first-child nobr{font-weight:bold}.fs-key-value-table tr td:first-child form{display:block}.fs-key-value-table tr td.fs-right{text-align:right}.fs-key-value-table tr.fs-odd{background:#ebebeb}.fs-key-value-table td,.fs-key-value-table th{padding:10px}.fs-key-value-table code{line-height:28px}.fs-key-value-table var,.fs-key-value-table code,.fs-key-value-table input[type="text"]{color:#0073AA;font-size:16px;background:none}.fs-key-value-table input[type="text"]{width:100%;font-weight:bold}label.fs-tag{background:#ffba00;color:#fff;display:inline-block;border-radius:3px;padding:5px;font-size:11px;line-height:11px;vertical-align:baseline}label.fs-tag.fs-warn{background:#ffba00}label.fs-tag.fs-success{background:#46b450}label.fs-tag.fs-error{background:#dc3232}#fs_addons h3{border:none;margin-bottom:0;padding:4px 5px}#fs_addons td{vertical-align:middle}#fs_addons thead{white-space:nowrap}#fs_addons td:first-child,#fs_addons th:first-child{text-align:left;font-weight:bold}#fs_addons td:last-child,#fs_addons th:last-child{text-align:right}#fs_addons th{font-weight:bold}#fs_billing_address{width:100%}#fs_billing_address tr td{width:50%;padding:5px}#fs_billing_address tr:first-of-type td{padding-top:0}#fs_billing_address span{font-weight:bold}#fs_billing_address input,#fs_billing_address select{display:block;width:100%;margin-top:5px}#fs_billing_address input::-moz-placeholder,#fs_billing_address select::-moz-placeholder{color:transparent;opacity:1}#fs_billing_address input:-ms-input-placeholder,#fs_billing_address select:-ms-input-placeholder{color:transparent}#fs_billing_address input::-webkit-input-placeholder,#fs_billing_address select::-webkit-input-placeholder{color:transparent}#fs_billing_address input.fs-read-mode,#fs_billing_address select.fs-read-mode{border-color:transparent;color:#777;border-bottom:1px dashed #ccc;padding-left:0;background:none}#fs_billing_address.fs-read-mode td span{display:none}#fs_billing_address.fs-read-mode input,#fs_billing_address.fs-read-mode select{border-color:transparent;color:#777;border-bottom:1px dashed #ccc;padding-left:0;background:none}#fs_billing_address.fs-read-mode input::-moz-placeholder,#fs_billing_address.fs-read-mode select::-moz-placeholder{color:#ccc;opacity:1}#fs_billing_address.fs-read-mode input:-ms-input-placeholder,#fs_billing_address.fs-read-mode select:-ms-input-placeholder{color:#ccc}#fs_billing_address.fs-read-mode input::-webkit-input-placeholder,#fs_billing_address.fs-read-mode select::-webkit-input-placeholder{color:#ccc}#fs_billing_address button{display:block;width:100%}
1
+ #fs_account .postbox,#fs_account .widefat{max-width:700px}#fs_account h3{font-size:1.3em;padding:12px 15px;margin:0 0 12px 0;line-height:1.4;border-bottom:1px solid #F1F1F1}#fs_account h3 .dashicons{width:26px;height:26px;font-size:1.3em}#fs_account i.dashicons{font-size:1.2em;height:1.2em;width:1.2em}#fs_account .dashicons{vertical-align:middle}#fs_account .fs-header-actions{position:absolute;top:17px;right:15px;font-size:0.9em}#fs_account .fs-header-actions ul{margin:0}#fs_account .fs-header-actions li{float:left}#fs_account .fs-header-actions li form{display:inline-block}#fs_account .fs-header-actions li a{text-decoration:none}#fs_account_details .button-group{float:right}.rtl #fs_account .fs-header-actions{left:15px;right:auto}.fs-key-value-table{width:100%}.fs-key-value-table form{display:inline-block}.fs-key-value-table tr td:first-child{text-align:right}.fs-key-value-table tr td:first-child nobr{font-weight:bold}.fs-key-value-table tr td:first-child form{display:block}.fs-key-value-table tr td.fs-right{text-align:right}.fs-key-value-table tr.fs-odd{background:#ebebeb}.fs-key-value-table td,.fs-key-value-table th{padding:10px}.fs-key-value-table code{line-height:28px}.fs-key-value-table var,.fs-key-value-table code,.fs-key-value-table input[type="text"]{color:#0073AA;font-size:16px;background:none}.fs-key-value-table input[type="text"]{width:100%;font-weight:bold}label.fs-tag{background:#ffba00;color:#fff;display:inline-block;border-radius:3px;padding:5px;font-size:11px;line-height:11px;vertical-align:baseline}label.fs-tag.fs-warn{background:#ffba00}label.fs-tag.fs-success{background:#46b450}label.fs-tag.fs-error{background:#dc3232}#fs_sites .fs-scrollable-table .fs-table-body{max-height:200px;overflow:auto;border:1px solid #e5e5e5}#fs_sites .fs-scrollable-table .fs-table-body>table.widefat{border:none !important}#fs_sites .fs-scrollable-table .fs-main-column{width:100%}#fs_sites .fs-scrollable-table .fs-site-details td:first-of-type{text-align:right;color:grey;width:1px}#fs_sites .fs-scrollable-table .fs-site-details td:last-of-type{text-align:right}#fs_sites .fs-scrollable-table .fs-install-details table tr td{width:1px;white-space:nowrap}#fs_sites .fs-scrollable-table .fs-install-details table tr td:last-of-type{width:auto}#fs_addons h3{border:none;margin-bottom:0;padding:4px 5px}#fs_addons td{vertical-align:middle}#fs_addons thead{white-space:nowrap}#fs_addons td:first-child,#fs_addons th:first-child{text-align:left;font-weight:bold}#fs_addons td:last-child,#fs_addons th:last-child{text-align:right}#fs_addons th{font-weight:bold}#fs_billing_address{width:100%}#fs_billing_address tr td{width:50%;padding:5px}#fs_billing_address tr:first-of-type td{padding-top:0}#fs_billing_address span{font-weight:bold}#fs_billing_address input,#fs_billing_address select{display:block;width:100%;margin-top:5px}#fs_billing_address input::-moz-placeholder,#fs_billing_address select::-moz-placeholder{color:transparent;opacity:1}#fs_billing_address input:-ms-input-placeholder,#fs_billing_address select:-ms-input-placeholder{color:transparent}#fs_billing_address input::-webkit-input-placeholder,#fs_billing_address select::-webkit-input-placeholder{color:transparent}#fs_billing_address input.fs-read-mode,#fs_billing_address select.fs-read-mode{border-color:transparent;color:#777;border-bottom:1px dashed #ccc;padding-left:0;background:none}#fs_billing_address.fs-read-mode td span{display:none}#fs_billing_address.fs-read-mode input,#fs_billing_address.fs-read-mode select{border-color:transparent;color:#777;border-bottom:1px dashed #ccc;padding-left:0;background:none}#fs_billing_address.fs-read-mode input::-moz-placeholder,#fs_billing_address.fs-read-mode select::-moz-placeholder{color:#ccc;opacity:1}#fs_billing_address.fs-read-mode input:-ms-input-placeholder,#fs_billing_address.fs-read-mode select:-ms-input-placeholder{color:#ccc}#fs_billing_address.fs-read-mode input::-webkit-input-placeholder,#fs_billing_address.fs-read-mode select::-webkit-input-placeholder{color:#ccc}#fs_billing_address button{display:block;width:100%}
freemius/assets/css/admin/affiliation.css CHANGED
@@ -1 +1 @@
1
- @charset "UTF-8";#fs_affiliation_content_wrapper #messages{margin-top:25px}#fs_affiliation_content_wrapper h3{font-size:24px;padding:0;margin-left:0}#fs_affiliation_content_wrapper ul li{box-sizing:border-box;list-style-type:none}#fs_affiliation_content_wrapper ul li:before{content:'✓';margin-right:10px;font-weight:bold}#fs_affiliation_content_wrapper p:not(.description),#fs_affiliation_content_wrapper li,#fs_affiliation_content_wrapper label{font-size:16px !important;line-height:26px !important}#fs_affiliation_content_wrapper .button{margin-top:20px;margin-bottom:7px;line-height:35px;height:40px;font-size:16px}#fs_affiliation_content_wrapper .button#cancel_button{margin-right:5px}#fs_affiliation_content_wrapper form .input-container{margin-bottom:15px}#fs_affiliation_content_wrapper form .input-container .input-label{font-weight:bold;display:block;width:100%}#fs_affiliation_content_wrapper form .input-container.input-container-text label,#fs_affiliation_content_wrapper form .input-container.input-container-text input,#fs_affiliation_content_wrapper form .input-container.input-container-text textarea{display:block}#fs_affiliation_content_wrapper form .input-container #add_domain,#fs_affiliation_content_wrapper form .input-container .remove-domain{text-decoration:none;display:inline-block;margin-top:3px}#fs_affiliation_content_wrapper form .input-container #add_domain:focus,#fs_affiliation_content_wrapper form .input-container .remove-domain:focus{box-shadow:none}#fs_affiliation_content_wrapper form .input-container #add_domain.disabled,#fs_affiliation_content_wrapper form .input-container .remove-domain.disabled{color:#aaa;cursor:default}#fs_affiliation_content_wrapper form #extra_domains_container .description{margin-top:0;position:relative;top:-4px}#fs_affiliation_content_wrapper form #extra_domains_container .extra-domain-input-container{margin-bottom:15px}#fs_affiliation_content_wrapper form #extra_domains_container .extra-domain-input-container .domain{display:inline-block;margin-right:5px}#fs_affiliation_content_wrapper form #extra_domains_container .extra-domain-input-container .domain:last-of-type{margin-bottom:0}
1
+ @charset "UTF-8";#fs_affiliation_content_wrapper #messages{margin-top:25px}#fs_affiliation_content_wrapper h3{font-size:24px;padding:0;margin-left:0}#fs_affiliation_content_wrapper ul li{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box;list-style-type:none}#fs_affiliation_content_wrapper ul li:before{content:'✓';margin-right:10px;font-weight:bold}#fs_affiliation_content_wrapper p:not(.description),#fs_affiliation_content_wrapper li,#fs_affiliation_content_wrapper label{font-size:16px !important;line-height:26px !important}#fs_affiliation_content_wrapper .button{margin-top:20px;margin-bottom:7px;line-height:35px;height:40px;font-size:16px}#fs_affiliation_content_wrapper .button#cancel_button{margin-right:5px}#fs_affiliation_content_wrapper form .input-container{margin-bottom:15px}#fs_affiliation_content_wrapper form .input-container .input-label{font-weight:bold;display:block;width:100%}#fs_affiliation_content_wrapper form .input-container.input-container-text label,#fs_affiliation_content_wrapper form .input-container.input-container-text input,#fs_affiliation_content_wrapper form .input-container.input-container-text textarea{display:block}#fs_affiliation_content_wrapper form .input-container #add_domain,#fs_affiliation_content_wrapper form .input-container .remove-domain{text-decoration:none;display:inline-block;margin-top:3px}#fs_affiliation_content_wrapper form .input-container #add_domain:focus,#fs_affiliation_content_wrapper form .input-container .remove-domain:focus{box-shadow:none}#fs_affiliation_content_wrapper form .input-container #add_domain.disabled,#fs_affiliation_content_wrapper form .input-container .remove-domain.disabled{color:#aaa;cursor:default}#fs_affiliation_content_wrapper form #extra_domains_container .description{margin-top:0;position:relative;top:-4px}#fs_affiliation_content_wrapper form #extra_domains_container .extra-domain-input-container{margin-bottom:15px}#fs_affiliation_content_wrapper form #extra_domains_container .extra-domain-input-container .domain{display:inline-block;margin-right:5px}#fs_affiliation_content_wrapper form #extra_domains_container .extra-domain-input-container .domain:last-of-type{margin-bottom:0}
freemius/assets/css/admin/connect.css CHANGED
@@ -1 +1 @@
1
- #fs_connect{width:480px;-moz-box-shadow:0px 1px 2px rgba(0,0,0,0.3);-webkit-box-shadow:0px 1px 2px rgba(0,0,0,0.3);box-shadow:0px 1px 2px rgba(0,0,0,0.3);margin:20px 0}@media screen and (max-width: 479px){#fs_connect{-moz-box-shadow:none;-webkit-box-shadow:none;box-shadow:none;width:auto;margin:0 0 0 -10px}}#fs_connect .fs-content{background:#fff;padding:15px 20px}#fs_connect .fs-content .fs-error{background:snow;color:#d3135a;border:1px solid #d3135a;-moz-box-shadow:0 1px 1px 0 rgba(0,0,0,0.1);-webkit-box-shadow:0 1px 1px 0 rgba(0,0,0,0.1);box-shadow:0 1px 1px 0 rgba(0,0,0,0.1);text-align:center;padding:5px;margin-bottom:10px}#fs_connect .fs-content p{margin:0;padding:0;font-size:1.2em}#fs_connect .fs-license-key-container{position:relative;width:280px;margin:10px auto 0 auto}#fs_connect .fs-license-key-container input{width:100%}#fs_connect .fs-license-key-container .dashicons{position:absolute;top:5px;right:5px}#fs_connect .fs-actions{padding:10px 20px;background:#C0C7CA}#fs_connect .fs-actions .button{padding:0 10px 1px;line-height:35px;height:37px;font-size:16px;margin-bottom:0}#fs_connect .fs-actions .button .dashicons{font-size:37px;margin-left:-8px;margin-right:12px}#fs_connect .fs-actions .button.button-primary{padding-right:15px;padding-left:15px}#fs_connect .fs-actions .button.button-primary:after{content:' \279C'}#fs_connect .fs-actions .button.button-primary.fs-loading:after{content:''}#fs_connect .fs-actions .button.button-secondary{float:right}#fs_connect.fs-anonymous-disabled .fs-actions .button.button-primary{width:100%}#fs_connect .fs-permissions{padding:10px 20px;background:#FEFEFE;-moz-transition:background 0.5s ease;-o-transition:background 0.5s ease;-ms-transition:background 0.5s ease;-webkit-transition:background 0.5s ease;transition:background 0.5s ease}#fs_connect .fs-permissions .fs-license-sync-disclaimer{text-align:center;margin-top:0}#fs_connect .fs-permissions .fs-trigger{font-size:0.9em;text-decoration:none;text-align:center;display:block}#fs_connect .fs-permissions ul{height:0;overflow:hidden;margin:0}#fs_connect .fs-permissions ul li{margin-bottom:12px}#fs_connect .fs-permissions ul li:last-child{margin-bottom:0}#fs_connect .fs-permissions ul li i.dashicons{float:left;font-size:40px;width:40px;height:40px}#fs_connect .fs-permissions ul li div{margin-left:55px}#fs_connect .fs-permissions ul li div span{font-weight:bold;text-transform:uppercase;color:#23282d}#fs_connect .fs-permissions ul li div p{margin:2px 0 0 0}#fs_connect .fs-permissions.fs-open{background:#fff}#fs_connect .fs-permissions.fs-open ul{height:auto;margin:20px 20px 10px 20px}@media screen and (max-width: 479px){#fs_connect .fs-permissions{background:#fff}#fs_connect .fs-permissions .fs-trigger{display:none}#fs_connect .fs-permissions ul{height:auto;margin:20px}}#fs_connect .fs-freemium-licensing{padding:8px;background:#777;color:#fff}#fs_connect .fs-freemium-licensing p{text-align:center;display:block;margin:0;padding:0}#fs_connect .fs-freemium-licensing a{color:#C2EEFF;text-decoration:underline}#fs_connect .fs-visual{padding:12px;line-height:0;background:#fafafa;height:80px;position:relative}#fs_connect .fs-visual .fs-site-icon{position:absolute;left:20px;top:10px}#fs_connect .fs-visual .fs-connect-logo{position:absolute;right:20px;top:10px}#fs_connect .fs-visual .fs-plugin-icon{position:absolute;top:10px;left:50%;margin-left:-40px}#fs_connect .fs-visual .fs-plugin-icon,#fs_connect .fs-visual .fs-site-icon,#fs_connect .fs-visual img,#fs_connect .fs-visual object{width:80px;height:80px}#fs_connect .fs-visual .dashicons-wordpress{font-size:64px;background:#01749a;color:#fff;width:64px;height:64px;padding:8px}#fs_connect .fs-visual .dashicons-plus{position:absolute;top:50%;font-size:30px;margin-top:-10px;color:#bbb}#fs_connect .fs-visual .dashicons-plus.fs-first{left:28%}#fs_connect .fs-visual .dashicons-plus.fs-second{left:65%}#fs_connect .fs-visual .fs-plugin-icon,#fs_connect .fs-visual .fs-connect-logo,#fs_connect .fs-visual .fs-site-icon{border:1px solid #ccc;padding:1px;background:#fff}#fs_connect .fs-terms{text-align:center;font-size:0.85em;padding:5px;background:rgba(0,0,0,0.05)}#fs_connect .fs-terms,#fs_connect .fs-terms a{color:#999}#fs_connect .fs-terms a{text-decoration:none}.rtl #fs_connect .fs-actions{padding:10px 20px;background:#C0C7CA}.rtl #fs_connect .fs-actions .button .dashicons{font-size:37px;margin-left:-8px;margin-right:12px}.rtl #fs_connect .fs-actions .button.button-primary:after{content:' \000bb'}.rtl #fs_connect .fs-actions .button.button-primary.fs-loading:after{content:''}.rtl #fs_connect .fs-actions .button.button-secondary{float:left}.rtl #fs_connect .fs-permissions ul li div{margin-right:55px;margin-left:0}.rtl #fs_connect .fs-permissions ul li i.dashicons{float:right}.rtl #fs_connect .fs-visual .fs-site-icon{right:20px;left:auto}.rtl #fs_connect .fs-visual .fs-connect-logo{right:auto;left:20px}#fs_theme_connect_wrapper{position:fixed;top:0;height:100%;width:100%;z-index:99990;background:rgba(0,0,0,0.75);text-align:center;overflow-y:auto}#fs_theme_connect_wrapper:before{content:"";display:inline-block;vertical-align:middle;height:100%}#fs_theme_connect_wrapper>button.close{color:white;cursor:pointer;height:40px;width:40px;position:absolute;right:0;border:0;background-color:transparent;top:32px}#fs_theme_connect_wrapper #fs_connect{top:0;text-align:left;display:inline-block;vertical-align:middle;margin-top:52px;margin-bottom:20px}#fs_theme_connect_wrapper #fs_connect .fs-terms{background:rgba(140,140,140,0.64)}#fs_theme_connect_wrapper #fs_connect .fs-terms,#fs_theme_connect_wrapper #fs_connect .fs-terms a{color:#c5c5c5}.wp-pointer-content #fs_connect{margin:0;-moz-box-shadow:none;-webkit-box-shadow:none;box-shadow:none}.fs-opt-in-pointer .wp-pointer-content{padding:0}.fs-opt-in-pointer.wp-pointer-top .wp-pointer-arrow{border-bottom-color:#dfdfdf}.fs-opt-in-pointer.wp-pointer-top .wp-pointer-arrow-inner{border-bottom-color:#fafafa}.fs-opt-in-pointer.wp-pointer-bottom .wp-pointer-arrow{border-top-color:#dfdfdf}.fs-opt-in-pointer.wp-pointer-bottom .wp-pointer-arrow-inner{border-top-color:#fafafa}.fs-opt-in-pointer.wp-pointer-left .wp-pointer-arrow{border-right-color:#dfdfdf}.fs-opt-in-pointer.wp-pointer-left .wp-pointer-arrow-inner{border-right-color:#fafafa}.fs-opt-in-pointer.wp-pointer-right .wp-pointer-arrow{border-left-color:#dfdfdf}.fs-opt-in-pointer.wp-pointer-right .wp-pointer-arrow-inner{border-left-color:#fafafa}
1
+ #fs_connect{width:480px;-moz-box-shadow:0px 1px 2px rgba(0,0,0,0.3);-webkit-box-shadow:0px 1px 2px rgba(0,0,0,0.3);box-shadow:0px 1px 2px rgba(0,0,0,0.3);margin:20px 0}@media screen and (max-width: 479px){#fs_connect{-moz-box-shadow:none;-webkit-box-shadow:none;box-shadow:none;width:auto;margin:0 0 0 -10px}}#fs_connect .fs-content{background:#fff;padding:15px 20px}#fs_connect .fs-content .fs-error{background:snow;color:#d3135a;border:1px solid #d3135a;-moz-box-shadow:0 1px 1px 0 rgba(0,0,0,0.1);-webkit-box-shadow:0 1px 1px 0 rgba(0,0,0,0.1);box-shadow:0 1px 1px 0 rgba(0,0,0,0.1);text-align:center;padding:5px;margin-bottom:10px}#fs_connect .fs-content p{margin:0;padding:0;font-size:1.2em}#fs_connect .fs-license-key-container{position:relative;width:280px;margin:10px auto 0 auto}#fs_connect .fs-license-key-container input{width:100%}#fs_connect .fs-license-key-container .dashicons{position:absolute;top:5px;right:5px}#fs_connect.require-license-key #sites_list_container td{cursor:pointer}#fs_connect #delegate_to_site_admins{margin-right:15px;float:right;height:26px;vertical-align:middle;line-height:37px;font-weight:bold;border-bottom:1px dashed;text-decoration:none}#fs_connect #delegate_to_site_admins.rtl{margin-left:15px;margin-right:0}#fs_connect .fs-actions{padding:10px 20px;background:#C0C7CA}#fs_connect .fs-actions .button{padding:0 10px 1px;line-height:35px;height:37px;font-size:16px;margin-bottom:0}#fs_connect .fs-actions .button .dashicons{font-size:37px;margin-left:-8px;margin-right:12px}#fs_connect .fs-actions .button.button-primary{padding-right:15px;padding-left:15px}#fs_connect .fs-actions .button.button-primary:after{content:' \279C'}#fs_connect .fs-actions .button.button-primary.fs-loading:after{content:''}#fs_connect .fs-actions .button.button-secondary{float:right}#fs_connect.fs-anonymous-disabled .fs-actions .button.button-primary{width:100%}#fs_connect .fs-permissions{padding:10px 20px;background:#FEFEFE;-moz-transition:background 0.5s ease;-o-transition:background 0.5s ease;-ms-transition:background 0.5s ease;-webkit-transition:background 0.5s ease;transition:background 0.5s ease}#fs_connect .fs-permissions .fs-license-sync-disclaimer{text-align:center;margin-top:0}#fs_connect .fs-permissions .fs-trigger{font-size:0.9em;text-decoration:none;text-align:center;display:block}#fs_connect .fs-permissions ul{height:0;overflow:hidden;margin:0}#fs_connect .fs-permissions ul li{margin-bottom:12px}#fs_connect .fs-permissions ul li:last-child{margin-bottom:0}#fs_connect .fs-permissions ul li i.dashicons{float:left;font-size:40px;width:40px;height:40px}#fs_connect .fs-permissions ul li div{margin-left:55px}#fs_connect .fs-permissions ul li div span{font-weight:bold;text-transform:uppercase;color:#23282d}#fs_connect .fs-permissions ul li div p{margin:2px 0 0 0}#fs_connect .fs-permissions.fs-open{background:#fff}#fs_connect .fs-permissions.fs-open ul{height:auto;margin:20px 20px 10px 20px}@media screen and (max-width: 479px){#fs_connect .fs-permissions{background:#fff}#fs_connect .fs-permissions .fs-trigger{display:none}#fs_connect .fs-permissions ul{height:auto;margin:20px}}#fs_connect .fs-freemium-licensing{padding:8px;background:#777;color:#fff}#fs_connect .fs-freemium-licensing p{text-align:center;display:block;margin:0;padding:0}#fs_connect .fs-freemium-licensing a{color:#C2EEFF;text-decoration:underline}#fs_connect .fs-visual{padding:12px;line-height:0;background:#fafafa;height:80px;position:relative}#fs_connect .fs-visual .fs-site-icon{position:absolute;left:20px;top:10px}#fs_connect .fs-visual .fs-connect-logo{position:absolute;right:20px;top:10px}#fs_connect .fs-visual .fs-plugin-icon{position:absolute;top:10px;left:50%;margin-left:-40px}#fs_connect .fs-visual .fs-plugin-icon,#fs_connect .fs-visual .fs-site-icon,#fs_connect .fs-visual img,#fs_connect .fs-visual object{width:80px;height:80px}#fs_connect .fs-visual .dashicons-wordpress{font-size:64px;background:#01749a;color:#fff;width:64px;height:64px;padding:8px}#fs_connect .fs-visual .dashicons-plus{position:absolute;top:50%;font-size:30px;margin-top:-10px;color:#bbb}#fs_connect .fs-visual .dashicons-plus.fs-first{left:28%}#fs_connect .fs-visual .dashicons-plus.fs-second{left:65%}#fs_connect .fs-visual .fs-plugin-icon,#fs_connect .fs-visual .fs-connect-logo,#fs_connect .fs-visual .fs-site-icon{border:1px solid #ccc;padding:1px;background:#fff}#fs_connect .fs-terms{text-align:center;font-size:0.85em;padding:5px;background:rgba(0,0,0,0.05)}#fs_connect .fs-terms,#fs_connect .fs-terms a{color:#999}#fs_connect .fs-terms a{text-decoration:none}#multisite_options_container{margin-top:10px;border:1px solid #ccc;padding:5px}#multisite_options_container a{text-decoration:none}#multisite_options_container a:focus{box-shadow:none}#multisite_options_container a.selected{font-weight:bold}#multisite_options_container.apply-on-all-sites{border:0 none;padding:0}#multisite_options_container.apply-on-all-sites #all_sites_options{border-spacing:0}#multisite_options_container.apply-on-all-sites #all_sites_options td:not(:first-child){display:none}#multisite_options_container #sites_list_container{display:none;overflow:auto}#multisite_options_container #sites_list_container table td{border-top:1px solid #ccc;padding:4px 2px}.fs-tooltip-trigger{position:relative}.fs-tooltip-trigger:not(a){cursor:help}.fs-tooltip-trigger .fs-tooltip{opacity:0;visibility:hidden;-moz-transition:opacity 0.3s ease-in-out;-o-transition:opacity 0.3s ease-in-out;-ms-transition:opacity 0.3s ease-in-out;-webkit-transition:opacity 0.3s ease-in-out;transition:opacity 0.3s ease-in-out;position:absolute;background:rgba(0,0,0,0.8);color:#fff;font-family:'arial', serif;font-size:12px;padding:10px;z-index:999999;bottom:100%;margin-bottom:5px;left:0;right:0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px;-moz-box-shadow:1px 1px 1px rgba(0,0,0,0.2);-webkit-box-shadow:1px 1px 1px rgba(0,0,0,0.2);box-shadow:1px 1px 1px rgba(0,0,0,0.2);line-height:1.3em;font-weight:bold;text-align:left}.rtl .fs-tooltip-trigger .fs-tooltip{text-align:right}.fs-tooltip-trigger .fs-tooltip::after{content:' ';display:block;width:0;height:0;border-style:solid;border-width:5px 5px 0 5px;border-color:rgba(0,0,0,0.8) transparent transparent transparent;position:absolute;top:100%;left:21px}.rtl .fs-tooltip-trigger .fs-tooltip::after{right:21px;left:auto}.fs-tooltip-trigger:hover .fs-tooltip{visibility:visible;opacity:1}.rtl #fs_connect .fs-actions{padding:10px 20px;background:#C0C7CA}.rtl #fs_connect .fs-actions .button .dashicons{font-size:37px;margin-left:-8px;margin-right:12px}.rtl #fs_connect .fs-actions .button.button-primary:after{content:' \000bb'}.rtl #fs_connect .fs-actions .button.button-primary.fs-loading:after{content:''}.rtl #fs_connect .fs-actions .button.button-secondary{float:left}.rtl #fs_connect .fs-permissions ul li div{margin-right:55px;margin-left:0}.rtl #fs_connect .fs-permissions ul li i.dashicons{float:right}.rtl #fs_connect .fs-visual .fs-site-icon{right:20px;left:auto}.rtl #fs_connect .fs-visual .fs-connect-logo{right:auto;left:20px}#fs_theme_connect_wrapper{position:fixed;top:0;height:100%;width:100%;z-index:99990;background:rgba(0,0,0,0.75);text-align:center;overflow-y:auto}#fs_theme_connect_wrapper:before{content:"";display:inline-block;vertical-align:middle;height:100%}#fs_theme_connect_wrapper>button.close{color:white;cursor:pointer;height:40px;width:40px;position:absolute;right:0;border:0;background-color:transparent;top:32px}#fs_theme_connect_wrapper #fs_connect{top:0;text-align:left;display:inline-block;vertical-align:middle;margin-top:52px;margin-bottom:20px}#fs_theme_connect_wrapper #fs_connect .fs-terms{background:rgba(140,140,140,0.64)}#fs_theme_connect_wrapper #fs_connect .fs-terms,#fs_theme_connect_wrapper #fs_connect .fs-terms a{color:#c5c5c5}.wp-pointer-content #fs_connect{margin:0;-moz-box-shadow:none;-webkit-box-shadow:none;box-shadow:none}.fs-opt-in-pointer .wp-pointer-content{padding:0}.fs-opt-in-pointer.wp-pointer-top .wp-pointer-arrow{border-bottom-color:#dfdfdf}.fs-opt-in-pointer.wp-pointer-top .wp-pointer-arrow-inner{border-bottom-color:#fafafa}.fs-opt-in-pointer.wp-pointer-bottom .wp-pointer-arrow{border-top-color:#dfdfdf}.fs-opt-in-pointer.wp-pointer-bottom .wp-pointer-arrow-inner{border-top-color:#fafafa}.fs-opt-in-pointer.wp-pointer-left .wp-pointer-arrow{border-right-color:#dfdfdf}.fs-opt-in-pointer.wp-pointer-left .wp-pointer-arrow-inner{border-right-color:#fafafa}.fs-opt-in-pointer.wp-pointer-right .wp-pointer-arrow{border-left-color:#dfdfdf}.fs-opt-in-pointer.wp-pointer-right .wp-pointer-arrow-inner{border-left-color:#fafafa}
freemius/assets/css/admin/dialog-boxes.css CHANGED
@@ -1,2 +1,2 @@
1
- .fs-modal{position:fixed;overflow:auto;height:100%;width:100%;top:0;z-index:100000;display:none;background:rgba(0,0,0,0.6)}.fs-modal .fs-modal-dialog{background:transparent;position:absolute;left:50%;margin-left:-298px;padding-bottom:30px;top:-100%;z-index:100001;width:596px}@media (max-width: 650px){.fs-modal .fs-modal-dialog{margin-left:-50%;box-sizing:border-box;padding-left:10px;padding-right:10px;width:100%}.fs-modal .fs-modal-dialog .fs-modal-panel>h3>strong{font-size:1.3em}}.fs-modal.active{display:block}.fs-modal.active:before{display:block}.fs-modal.active .fs-modal-dialog{top:10%}.fs-modal.fs-success .fs-modal-header{border-bottom-color:#46b450}.fs-modal.fs-success .fs-modal-body{background-color:#f7fff7}.fs-modal.fs-warn .fs-modal-header{border-bottom-color:#ffb900}.fs-modal.fs-warn .fs-modal-body{background-color:#fff8e5}.fs-modal.fs-error .fs-modal-header{border-bottom-color:#dc3232}.fs-modal.fs-error .fs-modal-body{background-color:#ffeaea}.fs-modal .fs-modal-body,.fs-modal .fs-modal-footer{border:0;background:#fefefe;padding:20px}.fs-modal .fs-modal-header{border-bottom:#eeeeee solid 1px;background:#fbfbfb;padding:15px 20px;position:relative;margin-bottom:-10px}.fs-modal .fs-modal-header h4{margin:0;padding:0;text-transform:uppercase;font-size:1.2em;font-weight:bold;color:#cacaca;text-shadow:1px 1px 1px #fff;letter-spacing:0.6px;-webkit-font-smoothing:antialiased}.fs-modal .fs-modal-header .fs-close{position:absolute;right:10px;top:12px;cursor:pointer;color:#bbb;-moz-border-radius:20px;-webkit-border-radius:20px;border-radius:20px;padding:3px;-moz-transition:all 0.2s ease-in-out;-o-transition:all 0.2s ease-in-out;-ms-transition:all 0.2s ease-in-out;-webkit-transition:all 0.2s ease-in-out;transition:all 0.2s ease-in-out}.fs-modal .fs-modal-header .fs-close:hover{color:#fff;background:#aaa}.fs-modal .fs-modal-body{border-bottom:0}.fs-modal .fs-modal-body p{font-size:14px}.fs-modal .fs-modal-body h2{font-size:20px;line-height:1.5em}.fs-modal .fs-modal-body>div{margin-top:10px}.fs-modal .fs-modal-body>div h2{font-weight:bold;font-size:20px;margin-top:0}.fs-modal .fs-modal-footer{border-top:#eeeeee solid 1px;text-align:right}.fs-modal .fs-modal-footer>.button{margin:0 7px}.fs-modal .fs-modal-footer>.button:first-child{margin:0}.fs-modal .fs-modal-panel>.notice.inline{margin:0;display:none}.fs-modal .fs-modal-panel:not(.active){display:none}.rtl .fs-modal .fs-modal-header .fs-close{right:auto;left:20px}body.has-fs-modal{overflow:hidden}.fs-modal.fs-modal-deactivation-feedback .reason-input,.fs-modal.fs-modal-deactivation-feedback .internal-message{margin:3px 0 3px 22px}.fs-modal.fs-modal-deactivation-feedback .reason-input input,.fs-modal.fs-modal-deactivation-feedback .reason-input textarea,.fs-modal.fs-modal-deactivation-feedback .internal-message input,.fs-modal.fs-modal-deactivation-feedback .internal-message textarea{width:100%}.fs-modal.fs-modal-deactivation-feedback li.reason.has-internal-message .internal-message{border:1px solid #ccc;padding:7px;display:none}@media (max-width: 650px){.fs-modal.fs-modal-deactivation-feedback li.reason li.reason{margin-bottom:10px}.fs-modal.fs-modal-deactivation-feedback li.reason li.reason .reason-input,.fs-modal.fs-modal-deactivation-feedback li.reason li.reason .internal-message{margin-left:29px}.fs-modal.fs-modal-deactivation-feedback li.reason li.reason label{display:table}.fs-modal.fs-modal-deactivation-feedback li.reason li.reason label>span{display:table-cell;font-size:1.3em}}.fs-modal.fs-modal-deactivation-feedback .anonymous-feedback-label{float:left}.fs-modal.fs-modal-deactivation-feedback .fs-modal-panel{margin-top:0 !important}.fs-modal.fs-modal-deactivation-feedback .fs-modal-panel h3{margin-top:0;line-height:1.5em}#the-list .deactivate>.fs-slug{display:none}.fs-modal.fs-modal-license-activation .fs-modal-body input.license_key{width:100%}.fs-modal.fs-modal-license-key-resend .email-address-container{overflow:hidden;padding-right:2px}.fs-modal.fs-modal-license-key-resend.fs-freemium input.email-address{width:300px}.fs-modal.fs-modal-license-key-resend.fs-freemium label{display:block;margin-bottom:10px}.fs-modal.fs-modal-license-key-resend.fs-premium input.email-address{width:100%}.fs-modal.fs-modal-license-key-resend.fs-premium .button-container{float:right;margin-left:7px}@media (max-width: 650px){.fs-modal.fs-modal-license-key-resend.fs-premium .button-container{margin-top:2px}}
2
  .rtl .fs-modal.fs-modal-license-key-resend .fs-modal-body .input-container>.email-address-container{padding-left:2px;padding-right:0}.rtl .fs-modal.fs-modal-license-key-resend .fs-modal-body .button-container{float:left;margin-right:7px;margin-left:0}a.show-license-resend-modal{margin-top:4px;display:inline-block}.fs-ajax-loader{position:relative;width:170px;height:20px;margin:auto}.fs-ajax-loader .fs-ajax-loader-bar{position:absolute;top:0;background-color:#0074a3;width:20px;height:20px;-webkit-animation-name:bounce_ajaxLoader;-moz-animation-name:bounce_ajaxLoader;-ms-animation-name:bounce_ajaxLoader;-o-animation-name:bounce_ajaxLoader;animation-name:bounce_ajaxLoader;-webkit-animation-duration:1.5s;-moz-animation-duration:1.5s;-ms-animation-duration:1.5s;-o-animation-duration:1.5s;animation-duration:1.5s;animation-iteration-count:infinite;-o-animation-iteration-count:infinite;-ms-animation-iteration-count:infinite;-webkit-animation-iteration-count:infinite;-moz-animation-iteration-count:infinite;-webkit-animation-direction:normal;-moz-animation-direction:normal;-ms-animation-direction:normal;-o-animation-direction:normal;animation-direction:normal;-moz-transform:0.3;-o-transform:0.3;-ms-transform:0.3;-webkit-transform:0.3;transform:0.3}.fs-ajax-loader .fs-ajax-loader-bar-1{left:0px;animation-delay:0.6s;-o-animation-delay:0.6s;-ms-animation-delay:0.6s;-webkit-animation-delay:0.6s;-moz-animation-delay:0.6s}.fs-ajax-loader .fs-ajax-loader-bar-2{left:19px;animation-delay:0.75s;-o-animation-delay:0.75s;-ms-animation-delay:0.75s;-webkit-animation-delay:0.75s;-moz-animation-delay:0.75s}.fs-ajax-loader .fs-ajax-loader-bar-3{left:38px;animation-delay:0.9s;-o-animation-delay:0.9s;-ms-animation-delay:0.9s;-webkit-animation-delay:0.9s;-moz-animation-delay:0.9s}.fs-ajax-loader .fs-ajax-loader-bar-4{left:57px;animation-delay:1.05s;-o-animation-delay:1.05s;-ms-animation-delay:1.05s;-webkit-animation-delay:1.05s;-moz-animation-delay:1.05s}.fs-ajax-loader .fs-ajax-loader-bar-5{left:76px;animation-delay:1.2s;-o-animation-delay:1.2s;-ms-animation-delay:1.2s;-webkit-animation-delay:1.2s;-moz-animation-delay:1.2s}.fs-ajax-loader .fs-ajax-loader-bar-6{left:95px;animation-delay:1.35s;-o-animation-delay:1.35s;-ms-animation-delay:1.35s;-webkit-animation-delay:1.35s;-moz-animation-delay:1.35s}.fs-ajax-loader .fs-ajax-loader-bar-7{left:114px;animation-delay:1.5s;-o-animation-delay:1.5s;-ms-animation-delay:1.5s;-webkit-animation-delay:1.5s;-moz-animation-delay:1.5s}.fs-ajax-loader .fs-ajax-loader-bar-8{left:133px;animation-delay:1.65s;-o-animation-delay:1.65s;-ms-animation-delay:1.65s;-webkit-animation-delay:1.65s;-moz-animation-delay:1.65s}@-moz-keyframes bounce_ajaxLoader{0%{-moz-transform:scale(1);-o-transform:scale(1);-ms-transform:scale(1);-webkit-transform:scale(1);transform:scale(1);background-color:#0074a3}100%{-moz-transform:scale(0.3);-o-transform:scale(0.3);-ms-transform:scale(0.3);-webkit-transform:scale(0.3);transform:scale(0.3);background-color:#fff}}@-ms-keyframes bounce_ajaxLoader{0%{-moz-transform:scale(1);-o-transform:scale(1);-ms-transform:scale(1);-webkit-transform:scale(1);transform:scale(1);background-color:#0074a3}100%{-moz-transform:scale(0.3);-o-transform:scale(0.3);-ms-transform:scale(0.3);-webkit-transform:scale(0.3);transform:scale(0.3);background-color:#fff}}@-o-keyframes bounce_ajaxLoader{0%{-moz-transform:scale(1);-o-transform:scale(1);-ms-transform:scale(1);-webkit-transform:scale(1);transform:scale(1);background-color:#0074a3}100%{-moz-transform:scale(0.3);-o-transform:scale(0.3);-ms-transform:scale(0.3);-webkit-transform:scale(0.3);transform:scale(0.3);background-color:#fff}}@-webkit-keyframes bounce_ajaxLoader{0%{-moz-transform:scale(1);-o-transform:scale(1);-ms-transform:scale(1);-webkit-transform:scale(1);transform:scale(1);background-color:#0074a3}100%{-moz-transform:scale(0.3);-o-transform:scale(0.3);-ms-transform:scale(0.3);-webkit-transform:scale(0.3);transform:scale(0.3);background-color:#fff}}@keyframes bounce_ajaxLoader{0%{-moz-transform:scale(1);-o-transform:scale(1);-ms-transform:scale(1);-webkit-transform:scale(1);transform:scale(1);background-color:#0074a3}100%{-moz-transform:scale(0.3);-o-transform:scale(0.3);-ms-transform:scale(0.3);-webkit-transform:scale(0.3);transform:scale(0.3);background-color:#fff}}.fs-modal-auto-install #request-filesystem-credentials-form h2,.fs-modal-auto-install #request-filesystem-credentials-form .request-filesystem-credentials-action-buttons{display:none}.fs-modal-auto-install #request-filesystem-credentials-form input[type=password],.fs-modal-auto-install #request-filesystem-credentials-form input[type=email],.fs-modal-auto-install #request-filesystem-credentials-form input[type=text]{-webkit-appearance:none;padding:10px 10px 5px 10px;width:300px;max-width:100%}.fs-modal-auto-install #request-filesystem-credentials-form>div,.fs-modal-auto-install #request-filesystem-credentials-form label,.fs-modal-auto-install #request-filesystem-credentials-form fieldset{width:300px;max-width:100%;margin:0 auto;display:block}
1
+ .fs-modal{position:fixed;overflow:auto;height:100%;width:100%;top:0;z-index:100000;display:none;background:rgba(0,0,0,0.6)}.fs-modal .fs-modal-dialog{background:transparent;position:absolute;left:50%;margin-left:-298px;padding-bottom:30px;top:-100%;z-index:100001;width:596px}@media (max-width: 650px){.fs-modal .fs-modal-dialog{margin-left:-50%;box-sizing:border-box;padding-left:10px;padding-right:10px;width:100%}.fs-modal .fs-modal-dialog .fs-modal-panel>h3>strong{font-size:1.3em}}.fs-modal.active{display:block}.fs-modal.active:before{display:block}.fs-modal.active .fs-modal-dialog{top:10%}.fs-modal.fs-success .fs-modal-header{border-bottom-color:#46b450}.fs-modal.fs-success .fs-modal-body{background-color:#f7fff7}.fs-modal.fs-warn .fs-modal-header{border-bottom-color:#ffb900}.fs-modal.fs-warn .fs-modal-body{background-color:#fff8e5}.fs-modal.fs-error .fs-modal-header{border-bottom-color:#dc3232}.fs-modal.fs-error .fs-modal-body{background-color:#ffeaea}.fs-modal .fs-modal-body,.fs-modal .fs-modal-footer{border:0;background:#fefefe;padding:20px}.fs-modal .fs-modal-header{border-bottom:#eeeeee solid 1px;background:#fbfbfb;padding:15px 20px;position:relative;margin-bottom:-10px}.fs-modal .fs-modal-header h4{margin:0;padding:0;text-transform:uppercase;font-size:1.2em;font-weight:bold;color:#cacaca;text-shadow:1px 1px 1px #fff;letter-spacing:0.6px;-webkit-font-smoothing:antialiased}.fs-modal .fs-modal-header .fs-close{position:absolute;right:10px;top:12px;cursor:pointer;color:#bbb;-moz-border-radius:20px;-webkit-border-radius:20px;border-radius:20px;padding:3px;-moz-transition:all 0.2s ease-in-out;-o-transition:all 0.2s ease-in-out;-ms-transition:all 0.2s ease-in-out;-webkit-transition:all 0.2s ease-in-out;transition:all 0.2s ease-in-out}.fs-modal .fs-modal-header .fs-close:hover{color:#fff;background:#aaa}.fs-modal .fs-modal-header .fs-close .dashicons,.fs-modal .fs-modal-header .fs-close:hover .dashicons{text-decoration:none}.fs-modal .fs-modal-body{border-bottom:0}.fs-modal .fs-modal-body p{font-size:14px}.fs-modal .fs-modal-body h2{font-size:20px;line-height:1.5em}.fs-modal .fs-modal-body>div{margin-top:10px}.fs-modal .fs-modal-body>div h2{font-weight:bold;font-size:20px;margin-top:0}.fs-modal .fs-modal-footer{border-top:#eeeeee solid 1px;text-align:right}.fs-modal .fs-modal-footer>.button{margin:0 7px}.fs-modal .fs-modal-footer>.button:first-child{margin:0}.fs-modal .fs-modal-panel>.notice.inline{margin:0;display:none}.fs-modal .fs-modal-panel:not(.active){display:none}.rtl .fs-modal .fs-modal-header .fs-close{right:auto;left:20px}body.has-fs-modal{overflow:hidden}.fs-modal.fs-modal-deactivation-feedback .reason-input,.fs-modal.fs-modal-deactivation-feedback .internal-message{margin:3px 0 3px 22px}.fs-modal.fs-modal-deactivation-feedback .reason-input input,.fs-modal.fs-modal-deactivation-feedback .reason-input textarea,.fs-modal.fs-modal-deactivation-feedback .internal-message input,.fs-modal.fs-modal-deactivation-feedback .internal-message textarea{width:100%}.fs-modal.fs-modal-deactivation-feedback li.reason.has-internal-message .internal-message{border:1px solid #ccc;padding:7px;display:none}@media (max-width: 650px){.fs-modal.fs-modal-deactivation-feedback li.reason li.reason{margin-bottom:10px}.fs-modal.fs-modal-deactivation-feedback li.reason li.reason .reason-input,.fs-modal.fs-modal-deactivation-feedback li.reason li.reason .internal-message{margin-left:29px}.fs-modal.fs-modal-deactivation-feedback li.reason li.reason label{display:table}.fs-modal.fs-modal-deactivation-feedback li.reason li.reason label>span{display:table-cell;font-size:1.3em}}.fs-modal.fs-modal-deactivation-feedback .anonymous-feedback-label{float:left}.fs-modal.fs-modal-deactivation-feedback .fs-modal-panel{margin-top:0 !important}.fs-modal.fs-modal-deactivation-feedback .fs-modal-panel h3{margin-top:0;line-height:1.5em}#the-list .deactivate>.fs-slug{display:none}.fs-modal.fs-modal-license-activation .fs-modal-body input.license_key{width:100%}#license_options_container table,#license_options_container table select,#license_options_container table #available_license_key{width:100%}#license_options_container table td:first-child{width:1%}#license_options_container table #other_license_key_container label{position:relative;top:6px;float:left;margin-right:5px}#license_options_container table #other_license_key_container div{overflow:hidden;width:auto;height:30px;display:block;top:2px;position:relative}#license_options_container table #other_license_key_container div input{margin:0}#sites_list_container td{cursor:pointer}#multisite_options_container{margin-top:10px;border:1px solid #ccc;padding:5px}#multisite_options_container a{text-decoration:none}#multisite_options_container a:focus{box-shadow:none}#multisite_options_container a.selected{font-weight:bold}#multisite_options_container.apply-on-all-sites{border:0 none;padding:0}#multisite_options_container.apply-on-all-sites #all_sites_options{border-spacing:0}#multisite_options_container.apply-on-all-sites #all_sites_options td:not(:first-child){display:none}#multisite_options_container #sites_list_container{display:none;overflow:auto}#multisite_options_container #sites_list_container table td{border-top:1px solid #ccc;padding:4px 2px}.fs-modal.fs-modal-license-key-resend .email-address-container{overflow:hidden;padding-right:2px}.fs-modal.fs-modal-license-key-resend.fs-freemium input.email-address{width:300px}.fs-modal.fs-modal-license-key-resend.fs-freemium label{display:block;margin-bottom:10px}.fs-modal.fs-modal-license-key-resend.fs-premium input.email-address{width:100%}.fs-modal.fs-modal-license-key-resend.fs-premium .button-container{float:right;margin-left:7px}@media (max-width: 650px){.fs-modal.fs-modal-license-key-resend.fs-premium .button-container{margin-top:2px}}
2
  .rtl .fs-modal.fs-modal-license-key-resend .fs-modal-body .input-container>.email-address-container{padding-left:2px;padding-right:0}.rtl .fs-modal.fs-modal-license-key-resend .fs-modal-body .button-container{float:left;margin-right:7px;margin-left:0}a.show-license-resend-modal{margin-top:4px;display:inline-block}.fs-ajax-loader{position:relative;width:170px;height:20px;margin:auto}.fs-ajax-loader .fs-ajax-loader-bar{position:absolute;top:0;background-color:#0074a3;width:20px;height:20px;-webkit-animation-name:bounce_ajaxLoader;-moz-animation-name:bounce_ajaxLoader;-ms-animation-name:bounce_ajaxLoader;-o-animation-name:bounce_ajaxLoader;animation-name:bounce_ajaxLoader;-webkit-animation-duration:1.5s;-moz-animation-duration:1.5s;-ms-animation-duration:1.5s;-o-animation-duration:1.5s;animation-duration:1.5s;animation-iteration-count:infinite;-o-animation-iteration-count:infinite;-ms-animation-iteration-count:infinite;-webkit-animation-iteration-count:infinite;-moz-animation-iteration-count:infinite;-webkit-animation-direction:normal;-moz-animation-direction:normal;-ms-animation-direction:normal;-o-animation-direction:normal;animation-direction:normal;-moz-transform:0.3;-o-transform:0.3;-ms-transform:0.3;-webkit-transform:0.3;transform:0.3}.fs-ajax-loader .fs-ajax-loader-bar-1{left:0px;animation-delay:0.6s;-o-animation-delay:0.6s;-ms-animation-delay:0.6s;-webkit-animation-delay:0.6s;-moz-animation-delay:0.6s}.fs-ajax-loader .fs-ajax-loader-bar-2{left:19px;animation-delay:0.75s;-o-animation-delay:0.75s;-ms-animation-delay:0.75s;-webkit-animation-delay:0.75s;-moz-animation-delay:0.75s}.fs-ajax-loader .fs-ajax-loader-bar-3{left:38px;animation-delay:0.9s;-o-animation-delay:0.9s;-ms-animation-delay:0.9s;-webkit-animation-delay:0.9s;-moz-animation-delay:0.9s}.fs-ajax-loader .fs-ajax-loader-bar-4{left:57px;animation-delay:1.05s;-o-animation-delay:1.05s;-ms-animation-delay:1.05s;-webkit-animation-delay:1.05s;-moz-animation-delay:1.05s}.fs-ajax-loader .fs-ajax-loader-bar-5{left:76px;animation-delay:1.2s;-o-animation-delay:1.2s;-ms-animation-delay:1.2s;-webkit-animation-delay:1.2s;-moz-animation-delay:1.2s}.fs-ajax-loader .fs-ajax-loader-bar-6{left:95px;animation-delay:1.35s;-o-animation-delay:1.35s;-ms-animation-delay:1.35s;-webkit-animation-delay:1.35s;-moz-animation-delay:1.35s}.fs-ajax-loader .fs-ajax-loader-bar-7{left:114px;animation-delay:1.5s;-o-animation-delay:1.5s;-ms-animation-delay:1.5s;-webkit-animation-delay:1.5s;-moz-animation-delay:1.5s}.fs-ajax-loader .fs-ajax-loader-bar-8{left:133px;animation-delay:1.65s;-o-animation-delay:1.65s;-ms-animation-delay:1.65s;-webkit-animation-delay:1.65s;-moz-animation-delay:1.65s}@-moz-keyframes bounce_ajaxLoader{0%{-moz-transform:scale(1);-o-transform:scale(1);-ms-transform:scale(1);-webkit-transform:scale(1);transform:scale(1);background-color:#0074a3}100%{-moz-transform:scale(0.3);-o-transform:scale(0.3);-ms-transform:scale(0.3);-webkit-transform:scale(0.3);transform:scale(0.3);background-color:#fff}}@-ms-keyframes bounce_ajaxLoader{0%{-moz-transform:scale(1);-o-transform:scale(1);-ms-transform:scale(1);-webkit-transform:scale(1);transform:scale(1);background-color:#0074a3}100%{-moz-transform:scale(0.3);-o-transform:scale(0.3);-ms-transform:scale(0.3);-webkit-transform:scale(0.3);transform:scale(0.3);background-color:#fff}}@-o-keyframes bounce_ajaxLoader{0%{-moz-transform:scale(1);-o-transform:scale(1);-ms-transform:scale(1);-webkit-transform:scale(1);transform:scale(1);background-color:#0074a3}100%{-moz-transform:scale(0.3);-o-transform:scale(0.3);-ms-transform:scale(0.3);-webkit-transform:scale(0.3);transform:scale(0.3);background-color:#fff}}@-webkit-keyframes bounce_ajaxLoader{0%{-moz-transform:scale(1);-o-transform:scale(1);-ms-transform:scale(1);-webkit-transform:scale(1);transform:scale(1);background-color:#0074a3}100%{-moz-transform:scale(0.3);-o-transform:scale(0.3);-ms-transform:scale(0.3);-webkit-transform:scale(0.3);transform:scale(0.3);background-color:#fff}}@keyframes bounce_ajaxLoader{0%{-moz-transform:scale(1);-o-transform:scale(1);-ms-transform:scale(1);-webkit-transform:scale(1);transform:scale(1);background-color:#0074a3}100%{-moz-transform:scale(0.3);-o-transform:scale(0.3);-ms-transform:scale(0.3);-webkit-transform:scale(0.3);transform:scale(0.3);background-color:#fff}}.fs-modal-auto-install #request-filesystem-credentials-form h2,.fs-modal-auto-install #request-filesystem-credentials-form .request-filesystem-credentials-action-buttons{display:none}.fs-modal-auto-install #request-filesystem-credentials-form input[type=password],.fs-modal-auto-install #request-filesystem-credentials-form input[type=email],.fs-modal-auto-install #request-filesystem-credentials-form input[type=text]{-webkit-appearance:none;padding:10px 10px 5px 10px;width:300px;max-width:100%}.fs-modal-auto-install #request-filesystem-credentials-form>div,.fs-modal-auto-install #request-filesystem-credentials-form label,.fs-modal-auto-install #request-filesystem-credentials-form fieldset{width:300px;max-width:100%;margin:0 auto;display:block}
freemius/assets/img/foogallery.png DELETED
Binary file
freemius/assets/scss/_colors.scss CHANGED
@@ -63,3 +63,6 @@ $linkedin_color: #4875b4;
63
  $youtube_color: #ff3333;
64
  $gplus_color: #c63d2d;
65
 
 
 
 
63
  $youtube_color: #ff3333;
64
  $gplus_color: #c63d2d;
65
 
66
+ // Tooltip
67
+ $tooltip-color: #fff;
68
+ $tooltip-bkg-color: rgba(0,0,0,0.8);
freemius/assets/scss/admin/_license-activation.scss CHANGED
@@ -4,4 +4,44 @@
4
  width: 100%;
5
  }
6
  }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  }
4
  width: 100%;
5
  }
6
  }
7
+ }
8
+
9
+ #license_options_container {
10
+ table {
11
+ &, select, #available_license_key {
12
+ width: 100%;
13
+ }
14
+
15
+ td:first-child {
16
+ width: 1%;
17
+ }
18
+
19
+ #other_license_key_container {
20
+ label {
21
+ position: relative;
22
+ top: 6px;
23
+ float: left;
24
+ margin-right: 5px;
25
+ }
26
+
27
+ div {
28
+ overflow: hidden;
29
+ width: auto;
30
+ height: 30px;
31
+ display: block;
32
+ top: 2px;
33
+ position: relative;
34
+
35
+ input {
36
+ margin: 0;
37
+ }
38
+ }
39
+ }
40
+ }
41
+ }
42
+
43
+ #sites_list_container {
44
+ td {
45
+ cursor: pointer;
46
+ }
47
  }
freemius/assets/scss/admin/_modal-common.scss CHANGED
@@ -118,6 +118,14 @@
118
  color: #fff;
119
  background: #aaa;
120
  }
 
 
 
 
 
 
 
 
121
  }
122
  }
123
 
118
  color: #fff;
119
  background: #aaa;
120
  }
121
+
122
+ &, &:hover
123
+ {
124
+ .dashicons
125
+ {
126
+ text-decoration: none;
127
+ }
128
+ }
129
  }
130
  }
131
 
freemius/assets/scss/admin/_multisite-options.scss ADDED
@@ -0,0 +1,40 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ #multisite_options_container {
2
+ margin-top: 10px;
3
+ border: 1px solid #ccc;
4
+ padding: 5px;
5
+
6
+ a {
7
+ text-decoration: none;
8
+
9
+ &:focus {
10
+ box-shadow: none;
11
+ }
12
+
13
+ &.selected {
14
+ font-weight: bold;
15
+ }
16
+ }
17
+
18
+ &.apply-on-all-sites {
19
+ border: 0 none;
20
+ padding: 0;
21
+
22
+ #all_sites_options {
23
+ border-spacing: 0;
24
+
25
+ td:not(:first-child) {
26
+ display: none;
27
+ }
28
+ }
29
+ }
30
+
31
+ #sites_list_container {
32
+ display: none;
33
+ overflow: auto;
34
+
35
+ table td {
36
+ border-top: 1px solid #ccc;
37
+ padding: 4px 2px;
38
+ }
39
+ }
40
+ }
freemius/assets/scss/admin/_tooltip.scss ADDED
@@ -0,0 +1,66 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ .fs-tooltip-trigger
2
+ {
3
+ &:not(a)
4
+ {
5
+ cursor: help;
6
+ }
7
+
8
+ position: relative;
9
+
10
+ .fs-tooltip
11
+ {
12
+ opacity: 0;
13
+ visibility: hidden;
14
+ @include transition(opacity 0.3s ease-in-out);
15
+ position: absolute;
16
+ background: $tooltip-bkg-color;
17
+ color: $tooltip-color;
18
+ font-family: 'arial', serif;
19
+ font-size: 12px;
20
+ padding: 10px;
21
+ z-index: 999999;
22
+ bottom: 100%;
23
+ margin-bottom: 5px;
24
+ left: 0;
25
+ right: 0;
26
+ @include border-radius(5px);
27
+ @include box-shadow(1px 1px 1px rgba(0, 0, 0, 0.2));
28
+ line-height: 1.3em;
29
+ font-weight: bold;
30
+ text-align: left;
31
+
32
+ .rtl &
33
+ {
34
+ text-align: right;
35
+ }
36
+
37
+ &::after
38
+ {
39
+ content: ' ';
40
+ display: block;
41
+ width: 0;
42
+ height: 0;
43
+ border-style: solid;
44
+ border-width: 5px 5px 0 5px;
45
+ border-color: $tooltip-bkg-color transparent transparent transparent;
46
+ position: absolute;
47
+ top: 100%;
48
+ left: 21px;
49
+
50
+ .rtl &
51
+ {
52
+ right: 21px;
53
+ left: auto;
54
+ }
55
+ }
56
+ }
57
+
58
+ &:hover
59
+ {
60
+ .fs-tooltip
61
+ {
62
+ visibility: visible;
63
+ opacity: 1;
64
+ }
65
+ }
66
+ }
freemius/assets/scss/admin/account.scss CHANGED
@@ -30,12 +30,9 @@
30
  width: 1.2em;
31
  }
32
 
33
- .button
34
  {
35
- i.dashicons
36
- {
37
- vertical-align: middle;
38
- }
39
  }
40
 
41
  .fs-header-actions
@@ -160,6 +157,55 @@ label.fs-tag
160
  }
161
  }
162
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
163
  #fs_addons
164
  {
165
  h3
30
  width: 1.2em;
31
  }
32
 
33
+ .dashicons
34
  {
35
+ vertical-align: middle;
 
 
 
36
  }
37
 
38
  .fs-header-actions
157
  }
158
  }
159
 
160
+ #fs_sites
161
+ {
162
+ .fs-scrollable-table
163
+ {
164
+ .fs-table-body {
165
+ max-height: 200px;
166
+ overflow: auto;
167
+ border: 1px solid #e5e5e5;
168
+
169
+ & > table.widefat {
170
+ border: none !important;
171
+ }
172
+ }
173
+
174
+ .fs-main-column {
175
+ width: 100%;
176
+ }
177
+
178
+ .fs-site-details
179
+ {
180
+ td:first-of-type
181
+ {
182
+ text-align: right;
183
+ color: grey;
184
+ width: 1px;
185
+ }
186
+
187
+ td:last-of-type
188
+ {
189
+ text-align: right;
190
+ }
191
+ }
192
+
193
+ .fs-install-details table
194
+ {
195
+ tr td
196
+ {
197
+ width: 1px;
198
+ white-space: nowrap;
199
+
200
+ &:last-of-type
201
+ {
202
+ width: auto;
203
+ }
204
+ }
205
+ }
206
+ }
207
+ }
208
+
209
  #fs_addons
210
  {
211
  h3
freemius/assets/scss/admin/connect.scss CHANGED
@@ -53,6 +53,30 @@ $form_width: 480px;
53
  }
54
  }
55
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
  .fs-actions
57
  {
58
  padding: 10px 20px;
@@ -326,6 +350,9 @@ $form_width: 480px;
326
  }
327
  }
328
 
 
 
 
329
  .rtl
330
  {
331
  #fs_connect
53
  }
54
  }
55
 
56
+ &.require-license-key {
57
+ #sites_list_container {
58
+ td {
59
+ cursor: pointer;
60
+ }
61
+ }
62
+ }
63
+
64
+ #delegate_to_site_admins {
65
+ margin-right: 15px;
66
+ float: right;
67
+ height: 26px;
68
+ vertical-align: middle;
69
+ line-height: 37px;
70
+ font-weight: bold;
71
+ border-bottom: 1px dashed;
72
+ text-decoration: none;
73
+
74
+ &.rtl {
75
+ margin-left: 15px;
76
+ margin-right: 0;
77
+ }
78
+ }
79
+
80
  .fs-actions
81
  {
82
  padding: 10px 20px;
350
  }
351
  }
352
 
353
+ @import "multisite-options";
354
+ @import "tooltip";
355
+
356
  .rtl
357
  {
358
  #fs_connect
freemius/assets/scss/admin/dialog-boxes.scss CHANGED
@@ -2,6 +2,7 @@
2
  @import "modal-common";
3
  @import "deactivation-feedback";
4
  @import "license-activation";
 
5
  @import "license-key-resend";
6
  @import "ajax-loader";
7
  @import "auto-install";
2
  @import "modal-common";
3
  @import "deactivation-feedback";
4
  @import "license-activation";
5
+ @import "multisite-options";
6
  @import "license-key-resend";
7
  @import "ajax-loader";
8
  @import "auto-install";
freemius/composer.json CHANGED
@@ -3,7 +3,7 @@
3
  "description": "Freemius WordPress SDK",
4
  "keywords": ["freemius", "wordpress", "plugin", "sdk"],
5
  "homepage": "https://freemius.com",
6
- "license": "GPL-3.0",
7
  "require": {
8
  "php": ">=5.2"
9
  }
3
  "description": "Freemius WordPress SDK",
4
  "keywords": ["freemius", "wordpress", "plugin", "sdk"],
5
  "homepage": "https://freemius.com",
6
+ "license": "GPL-3.0-only",
7
  "require": {
8
  "php": ">=5.2"
9
  }
freemius/config.php CHANGED
@@ -1,331 +1,378 @@
1
  <?php
2
- /**
3
- * @package Freemius
4
- * @copyright Copyright (c) 2015, Freemius, Inc.
5
- * @license https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3
6
- * @since 1.0.4
7
- */
8
-
9
- if ( ! defined( 'ABSPATH' ) ) {
10
- exit;
11
- }
12
-
13
- if ( ! defined( 'WP_FS__SLUG' ) ) {
14
- define( 'WP_FS__SLUG', 'freemius' );
15
- }
16
- if ( ! defined( 'WP_FS__DEV_MODE' ) ) {
17
- define( 'WP_FS__DEV_MODE', false );
18
- }
19
-
20
- #--------------------------------------------------------------------------------
21
- #region API Connectivity Issues Simulation
22
- #--------------------------------------------------------------------------------
23
-
24
- if ( ! defined( 'WP_FS__SIMULATE_NO_API_CONNECTIVITY' ) ) {
25
- define( 'WP_FS__SIMULATE_NO_API_CONNECTIVITY', false );
26
- }
27
- if ( ! defined( 'WP_FS__SIMULATE_NO_CURL' ) ) {
28
- define( 'WP_FS__SIMULATE_NO_CURL', false );
29
- }
30
- if ( ! defined( 'WP_FS__SIMULATE_NO_API_CONNECTIVITY_CLOUDFLARE' ) ) {
31
- define( 'WP_FS__SIMULATE_NO_API_CONNECTIVITY_CLOUDFLARE', false );
32
- }
33
- if ( ! defined( 'WP_FS__SIMULATE_NO_API_CONNECTIVITY_SQUID_ACL' ) ) {
34
- define( 'WP_FS__SIMULATE_NO_API_CONNECTIVITY_SQUID_ACL', false );
35
- }
36
- if ( WP_FS__SIMULATE_NO_CURL ) {
37
- define( 'FS_SDK__SIMULATE_NO_CURL', true );
38
- }
39
- if ( WP_FS__SIMULATE_NO_API_CONNECTIVITY_CLOUDFLARE ) {
40
- define( 'FS_SDK__SIMULATE_NO_API_CONNECTIVITY_CLOUDFLARE', true );
41
- }
42
- if ( WP_FS__SIMULATE_NO_API_CONNECTIVITY_SQUID_ACL ) {
43
- define( 'FS_SDK__SIMULATE_NO_API_CONNECTIVITY_SQUID_ACL', true );
44
- }
45
-
46
- #endregion
47
-
48
- if ( ! defined( 'WP_FS__SIMULATE_FREEMIUS_OFF' ) ) {
49
- define( 'WP_FS__SIMULATE_FREEMIUS_OFF', false );
50
- }
51
-
52
- if ( ! defined( 'WP_FS__PING_API_ON_IP_OR_HOST_CHANGES' ) ) {
53
- /**
54
- * @since 1.1.7.3
55
- * @author Vova Feldman (@svovaf)
56
- *
57
- * I'm not sure if shared servers periodically change IP, or the subdomain of the
58
- * admin dashboard. Also, I've seen sites that have strange loop of switching
59
- * between domains on a daily basis. Therefore, to eliminate the risk of
60
- * multiple unwanted connectivity test pings, temporary ignore domain or
61
- * server IP changes.
62
- */
63
- define( 'WP_FS__PING_API_ON_IP_OR_HOST_CHANGES', false );
64
- }
65
-
66
- /**
67
- * If your dev environment supports custom public network IP setup
68
- * like VVV, please update WP_FS__LOCALHOST_IP with your public IP
69
- * and uncomment it during dev.
70
- */
71
- if ( ! defined( 'WP_FS__LOCALHOST_IP' ) ) {
72
- // VVV default public network IP.
73
- define( 'WP_FS__VVV_DEFAULT_PUBLIC_IP', '192.168.50.4' );
74
 
75
  // define( 'WP_FS__LOCALHOST_IP', WP_FS__VVV_DEFAULT_PUBLIC_IP );
76
- }
77
-
78
- /**
79
- * If true and running with secret key, the opt-in process
80
- * will skip the email activation process which is invoked
81
- * when the email of the context user already exist in Freemius
82
- * database (as a security precaution, to prevent sharing user
83
- * secret with unauthorized entity).
84
- *
85
- * IMPORTANT:
86
- * AS A SECURITY PRECAUTION, WE VALIDATE THE TIMESTAMP OF THE OPT-IN REQUEST.
87
- * THEREFORE, MAKE SURE THAT WHEN USING THIS PARAMETER,YOUR TESTING ENVIRONMENT'S
88
- * CLOCK IS SYNCED.
89
- */
90
- if ( ! defined( 'WP_FS__SKIP_EMAIL_ACTIVATION' ) ) {
91
- define( 'WP_FS__SKIP_EMAIL_ACTIVATION', false );
92
- }
93
-
94
-
95
- #--------------------------------------------------------------------------------
96
- #region Directories
97
- #--------------------------------------------------------------------------------
98
-
99
- if ( ! defined( 'WP_FS__DIR' ) ) {
100
- define( 'WP_FS__DIR', dirname( __FILE__ ) );
101
- }
102
- if ( ! defined( 'WP_FS__DIR_INCLUDES' ) ) {
103
- define( 'WP_FS__DIR_INCLUDES', WP_FS__DIR . '/includes' );
104
- }
105
- if ( ! defined( 'WP_FS__DIR_TEMPLATES' ) ) {
106
- define( 'WP_FS__DIR_TEMPLATES', WP_FS__DIR . '/templates' );
107
- }
108
- if ( ! defined( 'WP_FS__DIR_ASSETS' ) ) {
109
- define( 'WP_FS__DIR_ASSETS', WP_FS__DIR . '/assets' );
110
- }
111
- if ( ! defined( 'WP_FS__DIR_CSS' ) ) {
112
- define( 'WP_FS__DIR_CSS', WP_FS__DIR_ASSETS . '/css' );
113
- }
114
- if ( ! defined( 'WP_FS__DIR_JS' ) ) {
115
- define( 'WP_FS__DIR_JS', WP_FS__DIR_ASSETS . '/js' );
116
- }
117
- if ( ! defined( 'WP_FS__DIR_IMG' ) ) {
118
- define( 'WP_FS__DIR_IMG', WP_FS__DIR_ASSETS . '/img' );
119
- }
120
- if ( ! defined( 'WP_FS__DIR_SDK' ) ) {
121
- define( 'WP_FS__DIR_SDK', WP_FS__DIR_INCLUDES . '/sdk' );
122
- }
123
-
124
- #endregion
125
-
126
- /**
127
- * Domain / URL / Address
128
- */
129
- define( 'WP_FS__ROOT_DOMAIN_PRODUCTION', 'freemius.com' );
130
- define( 'WP_FS__DOMAIN_PRODUCTION', 'wp.freemius.com' );
131
- define( 'WP_FS__ADDRESS_PRODUCTION', 'https://' . WP_FS__DOMAIN_PRODUCTION );
132
-
133
- if ( ! defined( 'WP_FS__DOMAIN_LOCALHOST' ) ) {
134
- define( 'WP_FS__DOMAIN_LOCALHOST', 'wp.freemius' );
135
- }
136
- if ( ! defined( 'WP_FS__ADDRESS_LOCALHOST' ) ) {
137
- define( 'WP_FS__ADDRESS_LOCALHOST', 'http://' . WP_FS__DOMAIN_LOCALHOST . ':8080' );
138
- }
139
-
140
- if ( ! defined( 'WP_FS__TESTING_DOMAIN' ) ) {
141
- define( 'WP_FS__TESTING_DOMAIN', 'fswp' );
142
- }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
143
 
144
  #--------------------------------------------------------------------------------
145
- #region HTTP
146
- #--------------------------------------------------------------------------------
147
-
148
- if ( ! defined( 'WP_FS__IS_HTTP_REQUEST' ) ) {
149
- define( 'WP_FS__IS_HTTP_REQUEST', isset( $_SERVER['HTTP_HOST'] ) );
150
- }
151
-
152
- if ( ! defined( 'WP_FS__IS_HTTPS' ) ) {
153
- define( 'WP_FS__IS_HTTPS', ( WP_FS__IS_HTTP_REQUEST &&
154
- // Checks if CloudFlare's HTTPS (Flexible SSL support).
155
- isset( $_SERVER['HTTP_X_FORWARDED_PROTO'] ) &&
156
- 'https' === strtolower( $_SERVER['HTTP_X_FORWARDED_PROTO'] )
157
- ) ||
158
- // Check if HTTPS request.
159
- ( isset( $_SERVER['HTTPS'] ) && 'on' == $_SERVER['HTTPS'] ) ||
160
- ( isset( $_SERVER['SERVER_PORT'] ) && 443 == $_SERVER['SERVER_PORT'] )
161
- );
162
- }
163
-
164
- if ( ! defined( 'WP_FS__IS_POST_REQUEST' ) ) {
165
- define( 'WP_FS__IS_POST_REQUEST', ( WP_FS__IS_HTTP_REQUEST &&
166
- strtoupper( $_SERVER['REQUEST_METHOD'] ) == 'POST' ) );
167
- }
168
-
169
- if ( ! defined( 'WP_FS__REMOTE_ADDR' ) ) {
170
- define( 'WP_FS__REMOTE_ADDR', fs_get_ip() );
171
- }
172
-
173
- if ( ! defined( 'WP_FS__IS_LOCALHOST' ) ) {
174
- if ( defined( 'WP_FS__LOCALHOST_IP' ) ) {
175
- define( 'WP_FS__IS_LOCALHOST', ( WP_FS__LOCALHOST_IP === WP_FS__REMOTE_ADDR ) );
176
- } else {
177
- define( 'WP_FS__IS_LOCALHOST', WP_FS__IS_HTTP_REQUEST &&
178
- is_string( WP_FS__REMOTE_ADDR ) &&
179
- ( substr( WP_FS__REMOTE_ADDR, 0, 4 ) === '127.' ||
180
- WP_FS__REMOTE_ADDR === '::1' )
181
- );
182
- }
183
- }
184
-
185
- if ( ! defined( 'WP_FS__IS_LOCALHOST_FOR_SERVER' ) ) {
186
- define( 'WP_FS__IS_LOCALHOST_FOR_SERVER', ( ! WP_FS__IS_HTTP_REQUEST ||
187
- false !== strpos( $_SERVER['HTTP_HOST'], 'localhost' ) ) );
188
- }
189
-
190
- #endregion
191
-
192
- if ( ! defined( 'WP_FS__IS_PRODUCTION_MODE' ) ) {
193
- // By default, run with Freemius production servers.
194
- define( 'WP_FS__IS_PRODUCTION_MODE', true );
195
- }
196
-
197
- if ( ! defined( 'WP_FS__ADDRESS' ) ) {
198
- define( 'WP_FS__ADDRESS', ( WP_FS__IS_PRODUCTION_MODE ? WP_FS__ADDRESS_PRODUCTION : WP_FS__ADDRESS_LOCALHOST ) );
199
- }
200
-
201
-
202
- #--------------------------------------------------------------------------------
203
- #region API
204
- #--------------------------------------------------------------------------------
205
-
206
- if ( ! defined( 'WP_FS__API_ADDRESS_LOCALHOST' ) ) {
207
- define( 'WP_FS__API_ADDRESS_LOCALHOST', 'http://api.freemius:8080' );
208
- }
209
- if ( ! defined( 'WP_FS__API_SANDBOX_ADDRESS_LOCALHOST' ) ) {
210
- define( 'WP_FS__API_SANDBOX_ADDRESS_LOCALHOST', 'http://sandbox-api.freemius:8080' );
211
- }
212
-
213
- // Set API address for local testing.
214
- if ( ! WP_FS__IS_PRODUCTION_MODE ) {
215
- if ( ! defined( 'FS_API__ADDRESS' ) ) {
216
- define( 'FS_API__ADDRESS', WP_FS__API_ADDRESS_LOCALHOST );
217
- }
218
- if ( ! defined( 'FS_API__SANDBOX_ADDRESS' ) ) {
219
- define( 'FS_API__SANDBOX_ADDRESS', WP_FS__API_SANDBOX_ADDRESS_LOCALHOST );
220
- }
221
- }
222
-
223
- #endregion
224
-
225
- #--------------------------------------------------------------------------------
226
- #region Checkout
227
- #--------------------------------------------------------------------------------
228
-
229
- if ( ! defined( 'FS_CHECKOUT__ADDRESS_PRODUCTION' ) ) {
230
- define( 'FS_CHECKOUT__ADDRESS_PRODUCTION', 'https://checkout.freemius.com' );
231
- }
232
-
233
- if ( ! defined( 'FS_CHECKOUT__ADDRESS_LOCALHOST' ) ) {
234
- define( 'FS_CHECKOUT__ADDRESS_LOCALHOST', 'http://checkout.freemius-local.com:8080' );
235
- }
236
-
237
- if ( ! defined( 'FS_CHECKOUT__ADDRESS' ) ) {
238
- define( 'FS_CHECKOUT__ADDRESS', ( WP_FS__IS_PRODUCTION_MODE ? FS_CHECKOUT__ADDRESS_PRODUCTION : FS_CHECKOUT__ADDRESS_LOCALHOST ) );
239
- }
240
-
241
- #endregion
242
-
243
- define( 'WP_FS___OPTION_PREFIX', 'fs' . ( WP_FS__IS_PRODUCTION_MODE ? '' : '_dbg' ) . '_' );
244
-
245
- if ( ! defined( 'WP_FS__ACCOUNTS_OPTION_NAME' ) ) {
246
- define( 'WP_FS__ACCOUNTS_OPTION_NAME', WP_FS___OPTION_PREFIX . 'accounts' );
247
- }
248
- if ( ! defined( 'WP_FS__API_CACHE_OPTION_NAME' ) ) {
249
- define( 'WP_FS__API_CACHE_OPTION_NAME', WP_FS___OPTION_PREFIX . 'api_cache' );
250
- }
251
- define( 'WP_FS__OPTIONS_OPTION_NAME', WP_FS___OPTION_PREFIX . 'options' );
252
-
253
- /**
254
- * Module types
255
- *
256
- * @since 1.2.2
257
- */
258
- define( 'WP_FS__MODULE_TYPE_PLUGIN', 'plugin' );
259
- define( 'WP_FS__MODULE_TYPE_THEME', 'theme' );
260
-
261
- /**
262
- * Billing Frequencies
263
- */
264
- define( 'WP_FS__PERIOD_ANNUALLY', 'annual' );
265
- define( 'WP_FS__PERIOD_MONTHLY', 'monthly' );
266
- define( 'WP_FS__PERIOD_LIFETIME', 'lifetime' );
267
-
268
- /**
269
- * Plans
270
- */
271
- define( 'WP_FS__PLAN_DEFAULT_PAID', false );
272
- define( 'WP_FS__PLAN_FREE', 'free' );
273
- define( 'WP_FS__PLAN_TRIAL', 'trial' );
274
-
275
- /**
276
- * Times in seconds
277
- */
278
- if ( ! defined( 'WP_FS__TIME_5_MIN_IN_SEC' ) ) {
279
- define( 'WP_FS__TIME_5_MIN_IN_SEC', 300 );
280
- }
281
- if ( ! defined( 'WP_FS__TIME_10_MIN_IN_SEC' ) ) {
282
- define( 'WP_FS__TIME_10_MIN_IN_SEC', 600 );
283
- }
284
  // define( 'WP_FS__TIME_15_MIN_IN_SEC', 900 );
285
- if ( ! defined( 'WP_FS__TIME_24_HOURS_IN_SEC' ) ) {
286
- define( 'WP_FS__TIME_24_HOURS_IN_SEC', 86400 );
287
- }
288
- if ( ! defined( 'WP_FS__TIME_WEEK_IN_SEC' ) ) {
289
- define( 'WP_FS__TIME_WEEK_IN_SEC', 7 * WP_FS__TIME_24_HOURS_IN_SEC );
290
- }
291
-
292
- #--------------------------------------------------------------------------------
293
- #region Debugging
294
- #--------------------------------------------------------------------------------
295
-
296
- if ( ! defined( 'WP_FS__DEBUG_SDK' ) ) {
297
- $debug_mode = get_option( 'fs_debug_mode', null );
298
-
299
- if ( $debug_mode === null ) {
300
- $debug_mode = false;
301
- add_option( 'fs_debug_mode', $debug_mode );
302
- }
303
-
304
- define( 'WP_FS__DEBUG_SDK', is_numeric( $debug_mode ) ? ( 0 < $debug_mode ) : WP_FS__DEV_MODE );
305
- }
306
-
307
- if ( ! defined( 'WP_FS__ECHO_DEBUG_SDK' ) ) {
308
- define( 'WP_FS__ECHO_DEBUG_SDK', WP_FS__DEV_MODE && ! empty( $_GET['fs_dbg_echo'] ) );
309
- }
310
- if ( ! defined( 'WP_FS__LOG_DATETIME_FORMAT' ) ) {
311
- define( 'WP_FS__LOG_DATETIME_FORMAT', 'Y-m-d H:i:s' );
312
- }
313
- if ( ! defined( 'FS_API__LOGGER_ON' ) ) {
314
- define( 'FS_API__LOGGER_ON', WP_FS__DEBUG_SDK );
315
- }
316
-
317
- if ( WP_FS__ECHO_DEBUG_SDK ) {
318
- error_reporting( E_ALL );
319
- }
320
-
321
- #endregion
322
-
323
- if ( ! defined( 'WP_FS__SCRIPT_START_TIME' ) ) {
324
- define( 'WP_FS__SCRIPT_START_TIME', time() );
325
- }
326
- if ( ! defined( 'WP_FS__DEFAULT_PRIORITY' ) ) {
327
- define( 'WP_FS__DEFAULT_PRIORITY', 10 );
328
- }
329
- if ( ! defined( 'WP_FS__LOWEST_PRIORITY' ) ) {
330
- define( 'WP_FS__LOWEST_PRIORITY', 999999999 );
331
- }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  <?php
2
+ /**
3
+ * @package Freemius
4
+ * @copyright Copyright (c) 2015, Freemius, Inc.
5
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3
6
+ * @since 1.0.4
7
+ */
8
+
9
+ if ( ! defined( 'ABSPATH' ) ) {
10
+ exit;
11
+ }
12
+
13
+ if ( ! defined( 'WP_FS__SLUG' ) ) {
14
+ define( 'WP_FS__SLUG', 'freemius' );
15
+ }
16
+ if ( ! defined( 'WP_FS__DEV_MODE' ) ) {
17
+ define( 'WP_FS__DEV_MODE', false );
18
+ }
19
+
20
+ #--------------------------------------------------------------------------------
21
+ #region API Connectivity Issues Simulation
22
+ #--------------------------------------------------------------------------------
23
+
24
+ if ( ! defined( 'WP_FS__SIMULATE_NO_API_CONNECTIVITY' ) ) {
25
+ define( 'WP_FS__SIMULATE_NO_API_CONNECTIVITY', false );
26
+ }
27
+ if ( ! defined( 'WP_FS__SIMULATE_NO_CURL' ) ) {
28
+ define( 'WP_FS__SIMULATE_NO_CURL', false );
29
+ }
30
+ if ( ! defined( 'WP_FS__SIMULATE_NO_API_CONNECTIVITY_CLOUDFLARE' ) ) {
31
+ define( 'WP_FS__SIMULATE_NO_API_CONNECTIVITY_CLOUDFLARE', false );
32
+ }
33
+ if ( ! defined( 'WP_FS__SIMULATE_NO_API_CONNECTIVITY_SQUID_ACL' ) ) {
34
+ define( 'WP_FS__SIMULATE_NO_API_CONNECTIVITY_SQUID_ACL', false );
35
+ }
36
+ if ( WP_FS__SIMULATE_NO_CURL ) {
37
+ define( 'FS_SDK__SIMULATE_NO_CURL', true );
38
+ }
39
+ if ( WP_FS__SIMULATE_NO_API_CONNECTIVITY_CLOUDFLARE ) {
40
+ define( 'FS_SDK__SIMULATE_NO_API_CONNECTIVITY_CLOUDFLARE', true );
41
+ }
42
+ if ( WP_FS__SIMULATE_NO_API_CONNECTIVITY_SQUID_ACL ) {
43
+ define( 'FS_SDK__SIMULATE_NO_API_CONNECTIVITY_SQUID_ACL', true );
44
+ }
45
+
46
+ #endregion
47
+
48
+ if ( ! defined( 'WP_FS__SIMULATE_FREEMIUS_OFF' ) ) {
49
+ define( 'WP_FS__SIMULATE_FREEMIUS_OFF', false );
50
+ }
51
+
52
+ if ( ! defined( 'WP_FS__PING_API_ON_IP_OR_HOST_CHANGES' ) ) {
53
+ /**
54
+ * @since 1.1.7.3
55
+ * @author Vova Feldman (@svovaf)
56
+ *
57
+ * I'm not sure if shared servers periodically change IP, or the subdomain of the
58
+ * admin dashboard. Also, I've seen sites that have strange loop of switching
59
+ * between domains on a daily basis. Therefore, to eliminate the risk of
60
+ * multiple unwanted connectivity test pings, temporary ignore domain or
61
+ * server IP changes.
62
+ */
63
+ define( 'WP_FS__PING_API_ON_IP_OR_HOST_CHANGES', false );
64
+ }
65
+
66
+ /**
67
+ * If your dev environment supports custom public network IP setup
68
+ * like VVV, please update WP_FS__LOCALHOST_IP with your public IP
69
+ * and uncomment it during dev.
70
+ */
71
+ if ( ! defined( 'WP_FS__LOCALHOST_IP' ) ) {
72
+ // VVV default public network IP.
73
+ define( 'WP_FS__VVV_DEFAULT_PUBLIC_IP', '192.168.50.4' );
74
 
75
  // define( 'WP_FS__LOCALHOST_IP', WP_FS__VVV_DEFAULT_PUBLIC_IP );
76
+ }
77
+
78
+ /**
79
+ * If true and running with secret key, the opt-in process
80
+ * will skip the email activation process which is invoked
81
+ * when the email of the context user already exist in Freemius
82
+ * database (as a security precaution, to prevent sharing user
83
+ * secret with unauthorized entity).
84
+ *
85
+ * IMPORTANT:
86
+ * AS A SECURITY PRECAUTION, WE VALIDATE THE TIMESTAMP OF THE OPT-IN REQUEST.
87
+ * THEREFORE, MAKE SURE THAT WHEN USING THIS PARAMETER,YOUR TESTING ENVIRONMENT'S
88
+ * CLOCK IS SYNCED.
89
+ */
90
+ if ( ! defined( 'WP_FS__SKIP_EMAIL_ACTIVATION' ) ) {
91
+ define( 'WP_FS__SKIP_EMAIL_ACTIVATION', false );
92
+ }
93
+
94
+
95
+ #--------------------------------------------------------------------------------
96
+ #region Directories
97
+ #--------------------------------------------------------------------------------
98
+
99
+ if ( ! defined( 'WP_FS__DIR' ) ) {
100
+ define( 'WP_FS__DIR', dirname( __FILE__ ) );
101
+ }
102
+ if ( ! defined( 'WP_FS__DIR_INCLUDES' ) ) {
103
+ define( 'WP_FS__DIR_INCLUDES', WP_FS__DIR . '/includes' );
104
+ }
105
+ if ( ! defined( 'WP_FS__DIR_TEMPLATES' ) ) {
106
+ define( 'WP_FS__DIR_TEMPLATES', WP_FS__DIR . '/templates' );
107
+ }
108
+ if ( ! defined( 'WP_FS__DIR_ASSETS' ) ) {
109
+ define( 'WP_FS__DIR_ASSETS', WP_FS__DIR . '/assets' );
110
+ }
111
+ if ( ! defined( 'WP_FS__DIR_CSS' ) ) {
112
+ define( 'WP_FS__DIR_CSS', WP_FS__DIR_ASSETS . '/css' );
113
+ }
114
+ if ( ! defined( 'WP_FS__DIR_JS' ) ) {
115
+ define( 'WP_FS__DIR_JS', WP_FS__DIR_ASSETS . '/js' );
116
+ }
117
+ if ( ! defined( 'WP_FS__DIR_IMG' ) ) {
118
+ define( 'WP_FS__DIR_IMG', WP_FS__DIR_ASSETS . '/img' );
119
+ }
120
+ if ( ! defined( 'WP_FS__DIR_SDK' ) ) {
121
+ define( 'WP_FS__DIR_SDK', WP_FS__DIR_INCLUDES . '/sdk' );
122
+ }
123
+
124
+ #endregion
125
+
126
+ /**
127
+ * Domain / URL / Address
128
+ */
129
+ define( 'WP_FS__ROOT_DOMAIN_PRODUCTION', 'freemius.com' );
130
+ define( 'WP_FS__DOMAIN_PRODUCTION', 'wp.freemius.com' );
131
+ define( 'WP_FS__ADDRESS_PRODUCTION', 'https://' . WP_FS__DOMAIN_PRODUCTION );
132
+
133
+ if ( ! defined( 'WP_FS__DOMAIN_LOCALHOST' ) ) {
134
+ define( 'WP_FS__DOMAIN_LOCALHOST', 'wp.freemius' );
135
+ }
136
+ if ( ! defined( 'WP_FS__ADDRESS_LOCALHOST' ) ) {
137
+ define( 'WP_FS__ADDRESS_LOCALHOST', 'http://' . WP_FS__DOMAIN_LOCALHOST . ':8080' );
138
+ }
139
+
140
+ if ( ! defined( 'WP_FS__TESTING_DOMAIN' ) ) {
141
+ define( 'WP_FS__TESTING_DOMAIN', 'fswp' );
142
+ }
143
+
144
+ #--------------------------------------------------------------------------------
145
+ #region HTTP
146
+ #--------------------------------------------------------------------------------
147
+
148
+ if ( ! defined( 'WP_FS__IS_HTTP_REQUEST' ) ) {
149
+ define( 'WP_FS__IS_HTTP_REQUEST', isset( $_SERVER['HTTP_HOST'] ) );
150
+ }
151
+
152
+ if ( ! defined( 'WP_FS__IS_HTTPS' ) ) {
153
+ define( 'WP_FS__IS_HTTPS', ( WP_FS__IS_HTTP_REQUEST &&
154
+ // Checks if CloudFlare's HTTPS (Flexible SSL support).
155
+ isset( $_SERVER['HTTP_X_FORWARDED_PROTO'] ) &&
156
+ 'https' === strtolower( $_SERVER['HTTP_X_FORWARDED_PROTO'] )
157
+ ) ||
158
+ // Check if HTTPS request.
159
+ ( isset( $_SERVER['HTTPS'] ) && 'on' == $_SERVER['HTTPS'] ) ||
160
+ ( isset( $_SERVER['SERVER_PORT'] ) && 443 == $_SERVER['SERVER_PORT'] )
161
+ );
162
+ }
163
+
164
+ if ( ! defined( 'WP_FS__IS_POST_REQUEST' ) ) {
165
+ define( 'WP_FS__IS_POST_REQUEST', ( WP_FS__IS_HTTP_REQUEST &&
166
+ strtoupper( $_SERVER['REQUEST_METHOD'] ) == 'POST' ) );
167
+ }
168
+
169
+ if ( ! defined( 'WP_FS__REMOTE_ADDR' ) ) {
170
+ define( 'WP_FS__REMOTE_ADDR', fs_get_ip() );
171
+ }
172
+
173
+ if ( ! defined( 'WP_FS__IS_LOCALHOST' ) ) {
174
+ if ( defined( 'WP_FS__LOCALHOST_IP' ) ) {
175
+ define( 'WP_FS__IS_LOCALHOST', ( WP_FS__LOCALHOST_IP === WP_FS__REMOTE_ADDR ) );
176
+ } else {
177
+ define( 'WP_FS__IS_LOCALHOST', WP_FS__IS_HTTP_REQUEST &&
178
+ is_string( WP_FS__REMOTE_ADDR ) &&
179
+ ( substr( WP_FS__REMOTE_ADDR, 0, 4 ) === '127.' ||
180
+ WP_FS__REMOTE_ADDR === '::1' )
181
+ );
182
+ }
183
+ }
184
+
185
+ if ( ! defined( 'WP_FS__IS_LOCALHOST_FOR_SERVER' ) ) {
186
+ define( 'WP_FS__IS_LOCALHOST_FOR_SERVER', ( ! WP_FS__IS_HTTP_REQUEST ||
187
+ false !== strpos( $_SERVER['HTTP_HOST'], 'localhost' ) ) );
188
+ }
189
+
190
+ #endregion
191
+
192
+ if ( ! defined( 'WP_FS__IS_PRODUCTION_MODE' ) ) {
193
+ // By default, run with Freemius production servers.
194
+ define( 'WP_FS__IS_PRODUCTION_MODE', true );
195
+ }
196
+
197
+ if ( ! defined( 'WP_FS__ADDRESS' ) ) {
198
+ define( 'WP_FS__ADDRESS', ( WP_FS__IS_PRODUCTION_MODE ? WP_FS__ADDRESS_PRODUCTION : WP_FS__ADDRESS_LOCALHOST ) );
199
+ }
200
+
201
 
202
  #--------------------------------------------------------------------------------
203
+ #region API
204
+ #--------------------------------------------------------------------------------
205
+
206
+ if ( ! defined( 'WP_FS__API_ADDRESS_LOCALHOST' ) ) {
207
+ define( 'WP_FS__API_ADDRESS_LOCALHOST', 'http://api.freemius:8080' );
208
+ }
209
+ if ( ! defined( 'WP_FS__API_SANDBOX_ADDRESS_LOCALHOST' ) ) {
210
+ define( 'WP_FS__API_SANDBOX_ADDRESS_LOCALHOST', 'http://sandbox-api.freemius:8080' );
211
+ }
212
+
213
+ // Set API address for local testing.
214
+ if ( ! WP_FS__IS_PRODUCTION_MODE ) {
215
+ if ( ! defined( 'FS_API__ADDRESS' ) ) {
216
+ define( 'FS_API__ADDRESS', WP_FS__API_ADDRESS_LOCALHOST );
217
+ }
218
+ if ( ! defined( 'FS_API__SANDBOX_ADDRESS' ) ) {
219
+ define( 'FS_API__SANDBOX_ADDRESS', WP_FS__API_SANDBOX_ADDRESS_LOCALHOST );
220
+ }
221
+ }
222
+
223
+ #endregion
224
+
225
+ #--------------------------------------------------------------------------------
226
+ #region Checkout
227
+ #--------------------------------------------------------------------------------
228
+
229
+ if ( ! defined( 'FS_CHECKOUT__ADDRESS_PRODUCTION' ) ) {
230
+ define( 'FS_CHECKOUT__ADDRESS_PRODUCTION', 'https://checkout.freemius.com' );
231
+ }
232
+
233
+ if ( ! defined( 'FS_CHECKOUT__ADDRESS_LOCALHOST' ) ) {
234
+ define( 'FS_CHECKOUT__ADDRESS_LOCALHOST', 'http://checkout.freemius-local.com:8080' );
235
+ }
236
+
237
+ if ( ! defined( 'FS_CHECKOUT__ADDRESS' ) ) {
238
+ define( 'FS_CHECKOUT__ADDRESS', ( WP_FS__IS_PRODUCTION_MODE ? FS_CHECKOUT__ADDRESS_PRODUCTION : FS_CHECKOUT__ADDRESS_LOCALHOST ) );
239
+ }
240
+
241
+ #endregion
242
+
243
+ define( 'WP_FS___OPTION_PREFIX', 'fs' . ( WP_FS__IS_PRODUCTION_MODE ? '' : '_dbg' ) . '_' );
244
+
245
+ if ( ! defined( 'WP_FS__ACCOUNTS_OPTION_NAME' ) ) {
246
+ define( 'WP_FS__ACCOUNTS_OPTION_NAME', WP_FS___OPTION_PREFIX . 'accounts' );
247
+ }
248
+ if ( ! defined( 'WP_FS__API_CACHE_OPTION_NAME' ) ) {
249
+ define( 'WP_FS__API_CACHE_OPTION_NAME', WP_FS___OPTION_PREFIX . 'api_cache' );
250
+ }
251
+ define( 'WP_FS__OPTIONS_OPTION_NAME', WP_FS___OPTION_PREFIX . 'options' );
252
+
253
+ /**
254
+ * Module types
255
+ *
256
+ * @since 1.2.2
257
+ */
258
+ define( 'WP_FS__MODULE_TYPE_PLUGIN', 'plugin' );
259
+ define( 'WP_FS__MODULE_TYPE_THEME', 'theme' );
260
+
261
+ /**
262
+ * Billing Frequencies
263
+ */
264
+ define( 'WP_FS__PERIOD_ANNUALLY', 'annual' );
265
+ define( 'WP_FS__PERIOD_MONTHLY', 'monthly' );
266
+ define( 'WP_FS__PERIOD_LIFETIME', 'lifetime' );
267
+
268
+ /**
269
+ * Plans
270
+ */
271
+ define( 'WP_FS__PLAN_DEFAULT_PAID', false );
272
+ define( 'WP_FS__PLAN_FREE', 'free' );
273
+ define( 'WP_FS__PLAN_TRIAL', 'trial' );
274
+
275
+ /**
276
+ * Times in seconds
277
+ */
278
+ if ( ! defined( 'WP_FS__TIME_5_MIN_IN_SEC' ) ) {
279
+ define( 'WP_FS__TIME_5_MIN_IN_SEC', 300 );
280
+ }
281
+ if ( ! defined( 'WP_FS__TIME_10_MIN_IN_SEC' ) ) {
282
+ define( 'WP_FS__TIME_10_MIN_IN_SEC', 600 );
283
+ }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
284
  // define( 'WP_FS__TIME_15_MIN_IN_SEC', 900 );
285
+ if ( ! defined( 'WP_FS__TIME_24_HOURS_IN_SEC' ) ) {
286
+ define( 'WP_FS__TIME_24_HOURS_IN_SEC', 86400 );
287
+ }
288
+ if ( ! defined( 'WP_FS__TIME_WEEK_IN_SEC' ) ) {
289
+ define( 'WP_FS__TIME_WEEK_IN_SEC', 7 * WP_FS__TIME_24_HOURS_IN_SEC );
290
+ }
291
+
292
+ #--------------------------------------------------------------------------------
293
+ #region Debugging
294
+ #--------------------------------------------------------------------------------
295
+
296
+ if ( ! defined( 'WP_FS__DEBUG_SDK' ) ) {
297
+ $debug_mode = get_option( 'fs_debug_mode', null );
298
+
299
+ if ( $debug_mode === null ) {
300
+ $debug_mode = false;
301
+ add_option( 'fs_debug_mode', $debug_mode );
302
+ }
303
+
304
+ define( 'WP_FS__DEBUG_SDK', is_numeric( $debug_mode ) ? ( 0 < $debug_mode ) : WP_FS__DEV_MODE );
305
+ }
306
+
307
+ if ( ! defined( 'WP_FS__ECHO_DEBUG_SDK' ) ) {
308
+ define( 'WP_FS__ECHO_DEBUG_SDK', WP_FS__DEV_MODE && ! empty( $_GET['fs_dbg_echo'] ) );
309
+ }
310
+ if ( ! defined( 'WP_FS__LOG_DATETIME_FORMAT' ) ) {
311
+ define( 'WP_FS__LOG_DATETIME_FORMAT', 'Y-m-d H:i:s' );
312
+ }
313
+ if ( ! defined( 'FS_API__LOGGER_ON' ) ) {
314
+ define( 'FS_API__LOGGER_ON', WP_FS__DEBUG_SDK );
315
+ }
316
+
317
+ if ( WP_FS__ECHO_DEBUG_SDK ) {
318
+ error_reporting( E_ALL );
319
+ }
320
+
321
+ #endregion
322
+
323
+ if ( ! defined( 'WP_FS__SCRIPT_START_TIME' ) ) {
324
+ define( 'WP_FS__SCRIPT_START_TIME', time() );
325
+ }
326
+ if ( ! defined( 'WP_FS__DEFAULT_PRIORITY' ) ) {
327
+ define( 'WP_FS__DEFAULT_PRIORITY', 10 );
328
+ }
329
+ if ( ! defined( 'WP_FS__LOWEST_PRIORITY' ) ) {
330
+ define( 'WP_FS__LOWEST_PRIORITY', 999999999 );
331
+ }
332
+
333
+ #--------------------------------------------------------------------------------
334
+ #region Multisite Network
335
+ #--------------------------------------------------------------------------------
336
+
337
+ /**
338
+ * Do not use this define directly, it will have the wrong value
339
+ * during plugin uninstall/deletion when the inclusion of the plugin
340
+ * is triggered due to registration with register_uninstall_hook().
341
+ *
342
+ * Instead, use fs_is_network_admin().
343
+ *
344
+ * @author Vova Feldman (@svovaf)
345
+ */
346
+ if ( ! defined( 'WP_FS__IS_NETWORK_ADMIN' ) ) {
347
+ define( 'WP_FS__IS_NETWORK_ADMIN',
348
+ is_network_admin() ||
349
+ ( is_multisite() &&
350
+ ( ( defined( 'DOING_AJAX' ) && DOING_AJAX &&
351
+ ( isset( $_REQUEST['_fs_network_admin'] ) /*||
352
+ ( ! empty( $_REQUEST['action'] ) && 'delete-plugin' === $_REQUEST['action'] )*/ )
353
+ ) ||
354
+ // Plugin uninstall.
355
+ defined( 'WP_UNINSTALL_PLUGIN' ) )
356
+ )
357
+ );
358
+ }
359
+
360
+ /**
361
+ * Do not use this define directly, it will have the wrong value
362
+ * during plugin uninstall/deletion when the inclusion of the plugin
363
+ * is triggered due to registration with register_uninstall_hook().
364
+ *
365
+ * Instead, use fs_is_blog_admin().
366
+ *
367
+ * @author Vova Feldman (@svovaf)
368
+ */
369
+ if ( ! defined( 'WP_FS__IS_BLOG_ADMIN' ) ) {
370
+ define( 'WP_FS__IS_BLOG_ADMIN', is_blog_admin() || ( defined( 'DOING_AJAX' ) && DOING_AJAX && isset( $_REQUEST['_fs_blog_admin'] ) ) );
371
+ }
372
+
373
+ if ( ! defined( 'WP_FS__SHOW_NETWORK_EVEN_WHEN_DELEGATED' ) ) {
374
+ // Set to true to show network level settings even if delegated to site admins.
375
+ define( 'WP_FS__SHOW_NETWORK_EVEN_WHEN_DELEGATED', false );
376
+ }
377
+
378
+ #endregion
freemius/includes/class-freemius.php CHANGED
@@ -1,14323 +1,19942 @@
1
  <?php
2
- /**
3
- * @package Freemius
4
- * @copyright Copyright (c) 2015, Freemius, Inc.
5
- * @license https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3
6
- * @since 1.0.3
7
- */
8
- if ( ! defined( 'ABSPATH' ) ) {
9
- exit;
10
- }
11
-
12
- // "final class"
13
- class Freemius extends Freemius_Abstract {
14
- /**
15
- * SDK Version
16
- *
17
- * @var string
18
- */
19
- public $version = WP_FS__SDK_VERSION;
20
-
21
- #region Plugin Info
22
-
23
- /**
24
- * @since 1.0.1
25
- *
26
- * @var string
27
- */
28
- private $_slug;
29
-
30
- /**
31
- * @since 1.0.0
32
- *
33
- * @var string
34
- */
35
- private $_plugin_basename;
36
- /**
37
- * @since 1.0.0
38
- *
39
- * @var string
40
- */
41
- private $_free_plugin_basename;
42
- /**
43
- * @since 1.0.0
44
- *
45
- * @var string
46
- */
47
- private $_plugin_dir_path;
48
- /**
49
- * @since 1.0.0
50
- *
51
- * @var string
52
- */
53
- private $_plugin_dir_name;
54
- /**
55
- * @since 1.0.0
56
- *
57
- * @var string
58
- */
59
- private $_plugin_main_file_path;
60
- /**
61
- * @var string[]
62
- */
63
- private $_plugin_data;
64
- /**
65
- * @since 1.0.9
66
- *
67
- * @var string
68
- */
69
- private $_plugin_name;
70
- /**
71
- * @since 1.2.2
72
- *
73
- * @var string
74
- */
75
- private $_module_type;
76
-
77
- #endregion Plugin Info
78
-
79
- /**
80
- * @since 1.0.9
81
- *
82
- * @var bool If false, don't turn Freemius on.
83
- */
84
- private $_is_on;
85
-
86
- /**
87
- * @since 1.1.3
88
- *
89
- * @var bool If false, don't turn Freemius on.
90
- */
91
- private $_is_anonymous;
92
-
93
- /**
94
- * @since 1.0.9
95
- * @var bool If false, issues with connectivity to Freemius API.
96
- */
97
- private $_has_api_connection;
98
-
99
- /**
100
- * @since 1.0.9
101
- * @var bool Hints the SDK if plugin can support anonymous mode (if skip connect is visible).
102
- */
103
- private $_enable_anonymous;
104
-
105
- /**
106
- * @since 1.1.7.5
107
- * @var bool Hints the SDK if plugin should run in anonymous mode (only adds feedback form).
108
- */
109
- private $_anonymous_mode;
110
-
111
- /**
112
- * @since 1.1.9
113
- * @var bool Hints the SDK if plugin have any free plans.
114
- */
115
- private $_is_premium_only;
116
-
117
- /**
118
- * @since 1.2.1.6
119
- * @var bool Hints the SDK if plugin have premium code version at all.
120
- */
121
- private $_has_premium_version;
122
-
123
- /**
124
- * @since 1.2.1.6
125
- * @var bool Hints the SDK if plugin should ignore pending mode by simulating a skip.
126
- */
127
- private $_ignore_pending_mode;
128
-
129
- /**
130
- * @since 1.0.8
131
- * @var bool Hints the SDK if the plugin has any paid plans.
132
- */
133
- private $_has_paid_plans;
134
-
135
- /**
136
- * @since 1.2.1.5
137
- * @var int Hints the SDK if the plugin offers a trial period. If negative, no trial, if zero - has a trial but
138
- * without a specified period, if positive - the number of trial days.
139
- */
140
- private $_trial_days = - 1;
141
-
142
- /**
143
- * @since 1.2.1.5
144
- * @var bool Hints the SDK if the trial requires a payment method or not.
145
- */
146
- private $_is_trial_require_payment = false;
147
-
148
- /**
149
- * @since 1.0.7
150
- * @var bool Hints the SDK if the plugin is WordPress.org compliant.
151
- */
152
- private $_is_org_compliant;
153
-
154
- /**
155
- * @since 1.0.7
156
- * @var bool Hints the SDK if the plugin is has add-ons.
157
- */
158
- private $_has_addons;
159
-
160
- /**
161
- * @since 1.1.6
162
- * @var string[]bool.
163
- */
164
- private $_permissions;
165
-
166
- /**
167
- * @var FS_Key_Value_Storage
168
- */
169
- private $_storage;
170
-
171
- /**
172
- * @since 1.2.2.7
173
- * @var FS_Cache_Manager
174
- */
175
- private $_cache;
176
-
177
- /**
178
- * @since 1.0.0
179
- *
180
- * @var FS_Logger
181
- */
182
- private $_logger;
183
- /**
184
- * @since 1.0.4
185
- *
186
- * @var FS_Plugin
187
- */
188
- private $_plugin = false;
189
- /**
190
- * @since 1.0.4
191
- *
192
- * @var FS_Plugin|false
193
- */
194
- private $_parent_plugin = false;
195
- /**
196
- * @since 1.1.1
197
- *
198
- * @var Freemius
199
- */
200
- private $_parent = false;
201
- /**
202
- * @since 1.0.1
203
- *
204
- * @var FS_User
205
- */
206
- private $_user = false;
207
- /**
208
- * @since 1.0.1
209
- *
210
- * @var FS_Site
211
- */
212
- private $_site = false;
213
- /**
214
- * @since 1.0.1
215
- *
216
- * @var FS_Plugin_License
217
- */
218
- private $_license;
219
- /**
220
- * @since 1.0.2
221
- *
222
- * @var FS_Plugin_Plan[]
223
- */
224
- private $_plans = false;
225
- /**
226
- * @var FS_Plugin_License[]
227
- * @since 1.0.5
228
- */
229
- private $_licenses = false;
230
-
231
- /**
232
- * @since 1.0.1
233
- *
234
- * @var FS_Admin_Menu_Manager
235
- */
236
- private $_menu;
237
-
238
- /**
239
- * @var FS_Admin_Notice_Manager
240
- */
241
- private $_admin_notices;
242
-
243
- /**
244
- * @since 1.1.6
245
- *
246
- * @var FS_Admin_Notice_Manager
247
- */
248
- private static $_global_admin_notices;
249
-
250
- /**
251
- * @var FS_Logger
252
- * @since 1.0.0
253
- */
254
- private static $_static_logger;
255
-
256
- /**
257
- * @var FS_Option_Manager
258
- * @since 1.0.2
259
- */
260
- private static $_accounts;
261
-
262
- /**
263
- * @since 1.2.2
264
- *
265
- * @var number
266
- */
267
- private $_module_id;
268
-
269
- /**
270
- * @var Freemius[]
271
- */
272
- private static $_instances = array();
273
-
274
  /**
275
- * @author Leo Fajardo (@leorw)
276
  *
277
- * @since 1.2.3
 
 
 
 
 
 
 
278
  *
279
- * @var FS_Affiliate
280
  */
281
- private $affiliate = null;
282
 
283
  /**
284
- * @author Leo Fajardo (@leorw)
285
  *
286
- * @since 1.2.3
 
 
 
 
287
  *
288
- * @var FS_AffiliateTerms
289
  */
290
- private $plugin_affiliate_terms = null;
291
-
292
  /**
293
- * @author Leo Fajardo (@leorw)
 
 
 
 
 
 
294
  *
295
- * @since 1.2.3
 
 
 
 
296
  *
297
- * @var FS_AffiliateTerms
298
  */
299
- private $custom_affiliate_terms = null;
300
-
301
- #region Uninstall Reasons IDs
302
-
303
- const REASON_NO_LONGER_NEEDED = 1;
304
- const REASON_FOUND_A_BETTER_PLUGIN = 2;
305
- const REASON_NEEDED_FOR_A_SHORT_PERIOD = 3;
306
- const REASON_BROKE_MY_SITE = 4;
307
- const REASON_SUDDENLY_STOPPED_WORKING = 5;
308
- const REASON_CANT_PAY_ANYMORE = 6;
309
- const REASON_OTHER = 7;
310
- const REASON_DIDNT_WORK = 8;
311
- const REASON_DONT_LIKE_TO_SHARE_MY_INFORMATION = 9;
312
- const REASON_COULDNT_MAKE_IT_WORK = 10;
313
- const REASON_GREAT_BUT_NEED_SPECIFIC_FEATURE = 11;
314
- const REASON_NOT_WORKING = 12;
315
- const REASON_NOT_WHAT_I_WAS_LOOKING_FOR = 13;
316
- const REASON_DIDNT_WORK_AS_EXPECTED = 14;
317
- const REASON_TEMPORARY_DEACTIVATION = 15;
318
-
319
- #endregion
320
-
321
- /* Ctor
322
- ------------------------------------------------------------------------------------------------------------------*/
323
 
324
- /**
325
- * Main singleton instance.
326
- *
327
- * @author Vova Feldman (@svovaf)
328
- * @since 1.0.0
329
- *
330
- * @param number $module_id
331
- * @param string|bool $slug
332
- * @param bool $is_init Since 1.2.1 Is initiation sequence.
333
- */
334
- private function __construct( $module_id, $slug = false, $is_init = false ) {
335
- if ( $is_init && is_numeric( $module_id ) && is_string( $slug ) ) {
336
- $this->store_id_slug_type_path_map( $module_id, $slug );
337
- }
338
-
339
- $this->_module_id = $module_id;
340
- $this->_slug = $this->get_slug();
341
- $this->_module_type = $this->get_module_type();
342
-
343
- $this->_storage = FS_Key_Value_Storage::instance( $this->_module_type . '_data', $this->_slug );
344
- $this->_cache = FS_Cache_Manager::get_manager( WP_FS___OPTION_PREFIX . "cache_{$module_id}" );
345
-
346
- $this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_' . $this->get_unique_affix(), WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );
347
-
348
- $this->_plugin_main_file_path = $this->_find_caller_plugin_file( $is_init );
349
- $this->_plugin_dir_path = plugin_dir_path( $this->_plugin_main_file_path );
350
- $this->_plugin_basename = $this->get_plugin_basename();
351
- $this->_free_plugin_basename = str_replace( '-premium/', '/', $this->_plugin_basename );
352
-
353
- $base_name_split = explode( '/', $this->_plugin_basename );
354
- $this->_plugin_dir_name = $base_name_split[0];
355
-
356
- if ( $this->_logger->is_on() ) {
357
- $this->_logger->info( 'plugin_main_file_path = ' . $this->_plugin_main_file_path );
358
- $this->_logger->info( 'plugin_dir_path = ' . $this->_plugin_dir_path );
359
- $this->_logger->info( 'plugin_basename = ' . $this->_plugin_basename );
360
- $this->_logger->info( 'free_plugin_basename = ' . $this->_free_plugin_basename );
361
- $this->_logger->info( 'plugin_dir_name = ' . $this->_plugin_dir_name );
362
- }
363
-
364
- // Remember link between file to slug.
365
- $this->store_file_slug_map();
366
-
367
- // Store plugin's initial install timestamp.
368
- if ( ! isset( $this->_storage->install_timestamp ) ) {
369
- $this->_storage->install_timestamp = WP_FS__SCRIPT_START_TIME;
370
- }
371
-
372
- if ( ! is_object( $this->_plugin ) ) {
373
- $this->_plugin = FS_Plugin_Manager::instance( $this->_module_id )->get();
374
- }
375
-
376
- $this->_admin_notices = FS_Admin_Notice_Manager::instance(
377
- $this->_slug . ( $this->is_theme() ? ':theme' : '' ),
378
- /**
379
- * Ensure that the admin notice will always have a title by using the stored plugin title if available and
380
- * retrieving the title via the "get_plugin_name" method if there is no stored plugin title available.
381
- *
382
- * @author Leo Fajardo (@leorw)
383
- * @since 1.2.2
384
- */
385
- ( is_object( $this->_plugin ) ? $this->_plugin->title : $this->get_plugin_name() ),
386
- $this->get_unique_affix()
387
- );
388
-
389
- if ( 'true' === fs_request_get( 'fs_clear_api_cache' ) ||
390
- 'true' === fs_request_is_action( 'restart_freemius' )
391
- ) {
392
- FS_Api::clear_cache();
393
- $this->_cache->clear();
394
- }
395
-
396
- $this->_register_hooks();
397
-
398
- $this->_load_account();
399
-
400
- $this->_version_updates_handler();
401
- }
402
-
403
- /**
404
- * Checks whether this module has a settings menu.
405
- *
406
- * @author Leo Fajardo (@leorw)
407
- * @since 1.2.2
408
- *
409
- * @return bool
410
- */
411
- function has_settings_menu() {
412
- return $this->_menu->has_menu();
413
- }
414
-
415
- /**
416
- * Check if the context module is free wp.org theme.
417
- *
418
- * This method is helpful because:
419
- * 1. wp.org themes are limited to a single submenu item,
420
- * and sub-submenu items are most likely not allowed (never verified).
421
- * 2. wp.org themes are not allowed to redirect the user
422
- * after the theme activation, therefore, the agreed UX
423
- * is showing the opt-in as a modal dialog box after
424
- * activation (approved by @otto42, @emiluzelac, @greenshady, @grapplerulrich).
425
- *
426
- * @author Vova Feldman (@svovaf)
427
- * @since 1.2.2.7
428
- *
429
- * @return bool
430
- */
431
- function is_free_wp_org_theme() {
432
- return (
433
- $this->is_theme() &&
434
- $this->is_org_repo_compliant() &&
435
- ! $this->is_premium()
436
- );
437
- }
438
-
439
- /**
440
- * Checks whether this a submenu item is visible.
441
- *
442
- * @author Vova Feldman (@svovaf)
443
- * @since 1.2.2.6
444
- * @since 1.2.2.7 Even if the menu item was specified to be hidden, when it is the context page, then show the submenu item so the user will have the right context page.
445
- *
446
- * @param string $slug
447
- *
448
- * @return bool
449
- */
450
- function is_submenu_item_visible( $slug ) {
451
- if ( $this->is_admin_page( $slug ) ) {
452
- /**
453
- * It is the current context page, so show the submenu item
454
- * so the user will have the right context page, even if it
455
- * was set to hidden.
456
- */
457
- return true;
458
- }
459
-
460
- if ( ! $this->has_settings_menu() ) {
461
- // No menu settings at all.
462
- return false;
463
- }
464
-
465
- if ( $this->is_free_wp_org_theme() ) {
466
- /**
467
- * wp.org themes are limited to a single submenu item, and
468
- * sub-submenu items are most likely not allowed (never verified).
469
- */
470
- return false;
471
- }
472
-
473
- return $this->_menu->is_submenu_item_visible( $slug );
474
- }
475
-
476
- /**
477
- * Check if a Freemius page should be accessible via the UI.
478
- *
479
- * @author Vova Feldman (@svovaf)
480
- * @since 1.2.2.7
481
- *
482
- * @param string $slug
483
- *
484
- * @return bool
485
- */
486
- function is_page_visible( $slug ) {
487
- if ( $this->is_admin_page( $slug ) ) {
488
- return true;
489
- }
490
-
491
- return $this->_menu->is_submenu_item_visible( $slug, true, true );
492
- }
493
-
494
- /**
495
- * @author Vova Feldman (@svovaf)
496
- * @since 1.0.9
497
- */
498
- private function _version_updates_handler() {
499
- if ( ! isset( $this->_storage->sdk_version ) || $this->_storage->sdk_version != $this->version ) {
500
- // Freemius version upgrade mode.
501
- $this->_storage->sdk_last_version = $this->_storage->sdk_version;
502
- $this->_storage->sdk_version = $this->version;
503
-
504
- if ( empty( $this->_storage->sdk_last_version ) ||
505
- version_compare( $this->_storage->sdk_last_version, $this->version, '<' )
506
- ) {
507
- $this->_storage->sdk_upgrade_mode = true;
508
- $this->_storage->sdk_downgrade_mode = false;
509
- } else {
510
- $this->_storage->sdk_downgrade_mode = true;
511
- $this->_storage->sdk_upgrade_mode = false;
512
-
513
- }
514
-
515
- $this->do_action( 'sdk_version_update', $this->_storage->sdk_last_version, $this->version );
516
- }
517
-
518
- $plugin_version = $this->get_plugin_version();
519
- if ( ! isset( $this->_storage->plugin_version ) || $this->_storage->plugin_version != $plugin_version ) {
520
- // Plugin version upgrade mode.
521
- $this->_storage->plugin_last_version = $this->_storage->plugin_version;
522
- $this->_storage->plugin_version = $plugin_version;
523
-
524
- if ( empty( $this->_storage->plugin_last_version ) ||
525
- version_compare( $this->_storage->plugin_last_version, $plugin_version, '<' )
526
- ) {
527
- $this->_storage->plugin_upgrade_mode = true;
528
- $this->_storage->plugin_downgrade_mode = false;
529
- } else {
530
- $this->_storage->plugin_downgrade_mode = true;
531
- $this->_storage->plugin_upgrade_mode = false;
532
- }
533
-
534
- if ( ! empty( $this->_storage->plugin_last_version ) ) {
535
- // Different version of the plugin was installed before, therefore it's an update.
536
- $this->_storage->is_plugin_new_install = false;
537
- }
538
-
539
- $this->do_action( 'plugin_version_update', $this->_storage->plugin_last_version, $plugin_version );
540
- }
541
- }
542
-
543
- /**
544
- * @author Vova Feldman (@svovaf)
545
- * @since 1.1.5
546
- *
547
- * @param string $sdk_prev_version
548
- * @param string $sdk_version
549
- */
550
- function _data_migration( $sdk_prev_version, $sdk_version ) {
551
- /**
552
- * @since 1.1.7.3 Fixed unwanted connectivity test cleanup.
553
- */
554
- if ( empty( $sdk_prev_version ) ) {
555
- return;
556
- }
557
 
558
- if ( version_compare( $sdk_prev_version, '1.2.3', '<' ) &&
559
- version_compare( $sdk_version, '1.2.3', '>=' )
560
- ) {
561
- /**
562
- * Starting from version 1.2.3, paths are stored as relative paths and not absolute paths; so when
563
- * upgrading to 1.2.3, make paths relative.
564
- *
565
- * @author Leo Fajardo (@leorw)
566
- */
567
- $this->make_paths_relative();
568
- }
569
 
570
- if ( version_compare( $sdk_prev_version, '1.1.5', '<' ) &&
571
- version_compare( $sdk_version, '1.1.5', '>=' )
572
- ) {
573
- // On version 1.1.5 merged connectivity and is_on data.
574
- if ( isset( $this->_storage->connectivity_test ) ) {
575
- if ( ! isset( $this->_storage->is_on ) ) {
576
- unset( $this->_storage->connectivity_test );
577
- } else {
578
- $connectivity_data = $this->_storage->connectivity_test;
579
- $connectivity_data['is_active'] = $this->_storage->is_on['is_active'];
580
- $connectivity_data['timestamp'] = $this->_storage->is_on['timestamp'];
581
 
582
- // Override.
583
- $this->_storage->connectivity_test = $connectivity_data;
 
 
 
584
 
585
- // Remove previous structure.
586
- unset( $this->_storage->is_on );
587
- }
 
 
 
588
 
589
- }
590
- }
591
- }
 
 
592
 
593
  /**
594
- * Makes paths relative.
595
- *
596
- * @author Leo Fajardo
597
- * @since 1.2.3
598
  */
599
- private function make_paths_relative() {
600
- $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map', array() );
601
 
602
- if ( isset( $id_slug_type_path_map[ $this->_module_id ]['path'] ) ) {
603
- $id_slug_type_path_map[ $this->_module_id ]['path'] = $this->get_relative_path( $id_slug_type_path_map[ $this->_module_id ]['path'] );
 
 
 
604
 
605
- self::$_accounts->set_option( 'id_slug_type_path_map', $id_slug_type_path_map, true );
606
- }
 
 
 
607
 
608
- if ( isset( $this->_storage->plugin_main_file ) ) {
609
- $plugin_main_file = $this->_storage->plugin_main_file;
 
 
 
610
 
611
- if ( isset( $plugin_main_file->path ) ) {
612
- $this->_storage->plugin_main_file->path = $this->get_relative_path( $this->_storage->plugin_main_file->path );
613
- } else if ( isset( $plugin_main_file->prev_path ) ) {
614
- $this->_storage->plugin_main_file->prev_path = $this->get_relative_path( $this->_storage->plugin_main_file->prev_path );
615
- }
616
- }
617
 
618
- // Remove invalid path that is still associated with the current slug if there's any.
619
- $file_slug_map = self::$_accounts->get_option( 'file_slug_map', array() );
620
- foreach ( $file_slug_map as $plugin_basename => $slug ) {
621
- if ( $slug === $this->_slug &&
622
- $plugin_basename !== $this->_plugin_basename &&
623
- ! file_exists( $this->get_absolute_path( $plugin_basename ) )
624
- ) {
625
- unset( $file_slug_map[ $plugin_basename ] );
626
- self::$_accounts->set_option( 'file_slug_map', $file_slug_map, true );
627
 
628
- break;
629
- }
630
- }
631
- }
 
632
 
633
- /**
634
- * @author Vova Feldman (@svovaf)
635
- * @since 1.2.2.7
636
- *
637
- * @param string $plugin_prev_version
638
- * @param string $plugin_version
639
- */
640
- function _after_version_update( $plugin_prev_version, $plugin_version ) {
641
- if ( $this->is_theme() ) {
642
- // Expire the cache of the previous tabs since the theme may
643
- // have setting updates.
644
- $this->_cache->expire( 'tabs' );
645
- $this->_cache->expire( 'tabs_stylesheets' );
646
- }
647
- }
648
-
649
- /**
650
- * This action is connected to the 'plugins_loaded' hook and helps to determine
651
- * if this is a new plugin installation or a plugin update.
652
- *
653
- * There are 3 different use-cases:
654
- * 1) New plugin installation right with Freemius:
655
- * 1.1 _activate_plugin_event_hook() will be executed first
656
- * 1.2 Since $this->_storage->is_plugin_new_install is not set,
657
- * and $this->_storage->plugin_last_version is not set,
658
- * $this->_storage->is_plugin_new_install will be set to TRUE.
659
- * 1.3 When _plugins_loaded() will be executed, $this->_storage->is_plugin_new_install will
660
- * be already set to TRUE.
661
- *
662
- * 2) Plugin update, didn't have Freemius before, and now have the SDK:
663
- * 2.1 _activate_plugin_event_hook() will not be executed, because
664
- * the activation hook do NOT fires on updates since WP 3.1.
665
- * 2.2 When _plugins_loaded() will be executed, $this->_storage->is_plugin_new_install will
666
- * be empty, therefore, it will be set to FALSE.
667
- *
668
- * 3) Plugin update, had Freemius in prev version as well:
669
- * 3.1 _version_updates_handler() will be executed 1st, since FS was installed
670
- * before, $this->_storage->plugin_last_version will NOT be empty,
671
- * therefore, $this->_storage->is_plugin_new_install will be set to FALSE.
672
- * 3.2 When _plugins_loaded() will be executed, $this->_storage->is_plugin_new_install is
673
- * already set, therefore, it will not be modified.
674
- *
675
- * Use-case #3 is backward compatible, #3.1 will be executed since 1.0.9.
676
- *
677
- * NOTE:
678
- * The only fallback of this mechanism is if an admin updates a plugin based on use-case #2,
679
- * and then, the next immediate PageView is the plugin's main settings page, it will not
680
- * show the opt-in right away. The reason it will happen is because Freemius execution
681
- * will be turned off till the plugin is fully loaded at least once
682
- * (till $this->_storage->was_plugin_loaded is TRUE).
683
- *
684
- * @author Vova Feldman (@svovaf)
685
- * @since 1.1.9
686
- *
687
- */
688
- function _plugins_loaded() {
689
- // Update flag that plugin was loaded with Freemius at least once.
690
- $this->_storage->was_plugin_loaded = true;
691
-
692
- /**
693
- * Bug fix - only set to false when it's a plugin, due to the
694
- * execution sequence of the theme hooks and our methods, if
695
- * this will be set for themes, Freemius will always assume
696
- * it's a theme update.
697
- *
698
- * @author Vova Feldman (@svovaf)
699
- * @since 1.2.2.2
700
- */
701
- if ( $this->is_plugin() &&
702
- ! isset( $this->_storage->is_plugin_new_install )
703
- ) {
704
- $this->_storage->is_plugin_new_install = false;
705
- }
706
- }
707
-
708
- /**
709
- * @author Vova Feldman (@svovaf)
710
- * @since 1.0.9
711
- */
712
- private function _register_hooks() {
713
- $this->_logger->entrance();
714
-
715
- if ( is_admin() ) {
716
- if ( $this->is_plugin() ) {
717
- $plugin_dir = dirname( $this->_plugin_dir_path ) . '/';
718
-
719
- /**
720
- * @since 1.2.2
721
- *
722
- * Hook to both free and premium version activations to support
723
- * auto deactivation on the other version activation.
724
- */
725
- register_activation_hook(
726
- $plugin_dir . $this->_free_plugin_basename,
727
- array( &$this, '_activate_plugin_event_hook' )
728
- );
729
-
730
- register_activation_hook(
731
- $plugin_dir . $this->premium_plugin_basename(),
732
- array( &$this, '_activate_plugin_event_hook' )
733
- );
734
- } else {
735
- add_action( 'after_switch_theme', array( &$this, '_activate_theme_event_hook' ), 10, 2 );
736
-
737
- /**
738
- * Include the required hooks to capture the theme settings' page tabs
739
- * and cache them.
740
- *
741
- * @author Vova Feldman (@svovaf)
742
- * @since 1.2.2.7
743
- */
744
- if ( ! $this->_cache->has_valid( 'tabs' ) ) {
745
- add_action( 'admin_footer', array( &$this, '_tabs_capture' ) );
746
- // Add license activation AJAX callback.
747
- $this->add_ajax_action( 'store_tabs', array( &$this, '_store_tabs_ajax_action' ) );
748
-
749
- add_action( 'admin_enqueue_scripts', array( &$this, '_store_tabs_styles' ), 9999999 );
750
- }
751
-
752
- add_action(
753
- 'admin_footer',
754
- array( &$this, '_add_freemius_tabs' ),
755
- /**
756
- * The tabs JS code must be executed after the tabs capture logic (_tabs_capture()).
757
- * That's why the priority is 11 while the tabs capture logic is added
758
- * with priority 10.
759
- *
760
- * @author Vova Feldman (@svovaf)
761
- */
762
- 11
763
- );
764
-
765
- add_action( 'admin_footer', array( &$this, '_style_premium_theme' ) );
766
- }
767
-
768
- /**
769
- * Part of the mechanism to identify new plugin install vs. plugin update.
770
- *
771
- * @author Vova Feldman (@svovaf)
772
- * @since 1.1.9
773
- */
774
- if ( empty( $this->_storage->was_plugin_loaded ) ) {
775
- if ( $this->is_plugin() &&
776
- $this->is_activation_mode( false ) &&
777
- 0 == did_action( 'plugins_loaded' )
778
- ) {
779
- add_action( 'plugins_loaded', array( &$this, '_plugins_loaded' ) );
780
- } else {
781
- // If was activated before, then it was already loaded before.
782
- $this->_plugins_loaded();
783
- }
784
- }
785
-
786
- if ( ! self::is_ajax() ) {
787
- if ( ! $this->is_addon() ) {
788
- add_action( 'init', array( &$this, '_add_default_submenu_items' ), WP_FS__LOWEST_PRIORITY );
789
- }
790
- }
791
- }
792
-
793
- if ( $this->is_plugin() ) {
794
- register_deactivation_hook( $this->_plugin_main_file_path, array( &$this, '_deactivate_plugin_hook' ) );
795
- }
796
-
797
- if ( $this->is_theme() && self::is_customizer() ) {
798
- // Register customizer upsell.
799
- add_action( 'customize_register', array( &$this, '_customizer_register' ) );
800
- }
801
-
802
- add_action( 'init', array( &$this, '_redirect_on_clicked_menu_link' ), WP_FS__LOWEST_PRIORITY );
803
-
804
- add_action( 'admin_init', array( &$this, '_add_tracking_links' ) );
805
- add_action( 'admin_init', array( &$this, '_add_license_activation' ) );
806
- $this->add_ajax_action( 'update_billing', array( &$this, '_update_billing_ajax_action' ) );
807
- $this->add_ajax_action( 'start_trial', array( &$this, '_start_trial_ajax_action' ) );
808
-
809
- $this->add_ajax_action( 'install_premium_version', array(
810
- &$this,
811
- '_install_premium_version_ajax_action'
812
- ) );
813
 
814
- $this->add_ajax_action( 'submit_affiliate_application', array( &$this, '_submit_affiliate_application' ) );
 
 
 
 
815
 
816
- $this->add_action( 'after_plans_sync', array( &$this, '_check_for_trial_plans' ) );
 
 
 
817
 
818
- $this->add_action( 'sdk_version_update', array( &$this, '_data_migration' ), WP_FS__DEFAULT_PRIORITY, 2 );
819
- $this->add_action( 'plugin_version_update', array( &$this, '_after_version_update' ), WP_FS__DEFAULT_PRIORITY, 2 );
820
- $this->add_filter( 'after_code_type_change', array( &$this, '_after_code_type_change' ) );
 
 
821
 
822
- add_action( 'admin_init', array( &$this, '_add_trial_notice' ) );
823
- add_action( 'admin_init', array( &$this, '_add_affiliate_program_notice' ) );
824
- add_action( 'admin_init', array( &$this, '_enqueue_common_css' ) );
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
825
 
826
- /**
827
- * Handle request to reset anonymous mode for `get_reconnect_url()`.
828
- *
829
- * @author Vova Feldman (@svovaf)
830
- * @since 1.2.1.5
831
- */
832
- if ( fs_request_is_action( 'reset_anonymous_mode' ) &&
833
- $this->get_unique_affix() === fs_request_get( 'fs_unique_affix' )
834
- ) {
835
- add_action( 'admin_init', array( &$this, 'connect_again' ) );
836
- }
837
- }
838
-
839
- /**
840
- * Keeping the uninstall hook registered for free or premium plugin version may result to a fatal error that
841
- * could happen when a user tries to uninstall either version while one of them is still active. Uninstalling a
842
- * plugin will trigger inclusion of the free or premium version and if one of them is active during the
843
- * uninstallation, a fatal error may occur in case the plugin's class or functions are already defined.
844
- *
845
- * @author Leo Fajardo (leorw)
846
- *
847
- * @since 1.2.0
848
- */
849
- private function unregister_uninstall_hook() {
850
- $uninstallable_plugins = (array) get_option( 'uninstall_plugins' );
851
- unset( $uninstallable_plugins[ $this->_free_plugin_basename ] );
852
- unset( $uninstallable_plugins[ $this->premium_plugin_basename() ] );
853
-
854
- update_option( 'uninstall_plugins', $uninstallable_plugins );
855
- }
856
-
857
- /**
858
- * @since 1.2.0 Invalidate module's main file cache, otherwise, FS_Plugin_Updater will not fetch updates.
859
- */
860
- private function clear_module_main_file_cache() {
861
- if ( ! isset( $this->_storage->plugin_main_file ) ||
862
- empty( $this->_storage->plugin_main_file->path )
863
- ) {
864
- return;
865
- }
866
-
867
- $plugin_main_file = clone $this->_storage->plugin_main_file;
868
-
869
- // Store cached path (2nd layer cache).
870
- $plugin_main_file->prev_path = $plugin_main_file->path;
871
-
872
- // Clear cached path.
873
- unset( $plugin_main_file->path );
874
-
875
- $this->_storage->plugin_main_file = $plugin_main_file;
876
-
877
- /**
878
- * Clear global cached path.
879
- *
880
- * @author Leo Fajardo (@leorw)
881
- * @since 1.2.2
882
- */
883
- $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map' );
884
- unset( $id_slug_type_path_map[ $this->_module_id ]['path'] );
885
- self::$_accounts->set_option( 'id_slug_type_path_map', $id_slug_type_path_map, true );
886
- }
887
-
888
- /**
889
- * @author Vova Feldman (@svovaf)
890
- * @since 1.0.9
891
- */
892
- private function _register_account_hooks() {
893
- if ( ! is_admin() ) {
894
- return;
895
- }
896
-
897
- /**
898
- * Always show the deactivation feedback form since we added
899
- * automatic free version deactivation upon premium code activation.
900
- *
901
- * @since 1.2.1.6
902
- */
903
- $this->add_ajax_action(
904
- 'submit_uninstall_reason',
905
- array( &$this, '_submit_uninstall_reason_action' )
906
- );
907
-
908
- if ( ( $this->is_plugin() && self::is_plugins_page() ) ||
909
- ( $this->is_theme() && self::is_themes_page() )
910
- ) {
911
- add_action( 'admin_footer', array( &$this, '_add_deactivation_feedback_dialog_box' ) );
912
- }
913
- }
914
-
915
- /**
916
- * Leverage backtrace to find caller plugin file path.
917
- *
918
- * @author Vova Feldman (@svovaf)
919
- * @since 1.0.6
920
- *
921
- * @param bool $is_init Is initiation sequence.
922
- *
923
- * @return string
924
- */
925
- private function _find_caller_plugin_file( $is_init = false ) {
926
- // Try to load the cached value of the file path.
927
- if ( isset( $this->_storage->plugin_main_file ) ) {
928
- $plugin_main_file = $this->_storage->plugin_main_file;
929
- if ( isset( $plugin_main_file->path ) ) {
930
- $absolute_path = $this->get_absolute_path( $plugin_main_file->path );
931
- if ( file_exists( $absolute_path ) ) {
932
- return $absolute_path;
933
- }
934
- }
935
- }
936
-
937
- /**
938
- * @since 1.2.1
939
- *
940
- * `clear_module_main_file_cache()` is clearing the plugin's cached path on
941
- * deactivation. Therefore, if any plugin/theme was initiating `Freemius`
942
- * with that plugin's slug, it was overriding the empty plugin path with a wrong path.
943
- *
944
- * So, we've added a special mechanism with a 2nd layer of cache that uses `prev_path`
945
- * when the class instantiator isn't the module.
946
- */
947
- if ( ! $is_init ) {
948
- // Fetch prev path cache.
949
- if ( isset( $this->_storage->plugin_main_file ) &&
950
- isset( $this->_storage->plugin_main_file->prev_path )
951
- ) {
952
- $absolute_path = $this->get_absolute_path( $this->_storage->plugin_main_file->prev_path );
953
- if ( file_exists( $absolute_path ) ) {
954
- return $absolute_path;
955
- }
956
- }
957
-
958
- wp_die(
959
- $this->get_text_inline( 'Freemius SDK couldn\'t find the plugin\'s main file. Please contact sdk@freemius.com with the current error.', 'failed-finding-main-path' ) .
960
- " Module: {$this->_slug}; SDK: " . WP_FS__SDK_VERSION . ";",
961
- $this->get_text_inline( 'Error', 'error' ),
962
- array( 'back_link' => true )
963
- );
964
- }
965
-
966
- /**
967
- * @since 1.2.1
968
- *
969
- * Only the original instantiator that calls dynamic_init can modify the module's path.
970
- */
971
- // Find caller module.
972
- $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map', array() );
973
- $this->_storage->plugin_main_file = (object) array(
974
- 'path' => $id_slug_type_path_map[ $this->_module_id ]['path'],
975
- );
976
 
977
- return $this->get_absolute_path( $id_slug_type_path_map[ $this->_module_id ]['path'] );
978
- }
 
 
979
 
980
  /**
981
- * @author Leo Fajardo (@leorw)
982
- * @since 1.2.3
983
  *
984
- * @param string $path
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
985
  *
986
- * @return string
987
  */
988
- private function get_relative_path( $path ) {
989
- $module_root_dir = $this->get_module_root_dir_path();
990
- if ( 0 === strpos( $path, $module_root_dir ) ) {
991
- $path = substr( $path, strlen( $module_root_dir ) );
992
- }
993
 
994
- return $path;
995
- }
 
 
996
 
997
  /**
998
- * @author Leo Fajardo (@leorw)
999
- * @since 1.2.3
1000
  *
1001
- * @param string $path
1002
- * @param string|bool $module_type
 
 
 
 
1003
  *
1004
- * @return string
1005
  */
1006
- private function get_absolute_path( $path, $module_type = false ) {
1007
- $module_root_dir = $this->get_module_root_dir_path( $module_type );
1008
- if ( 0 !== strpos( $path, $module_root_dir ) ) {
1009
- $path = fs_normalize_path( $module_root_dir . $path );
1010
- }
1011
 
1012
- return $path;
1013
- }
 
 
 
 
1014
 
1015
  /**
1016
- * @author Leo Fajardo (@leorw)
1017
- * @since 1.2.3
1018
  *
1019
- * @param string|bool $module_type
 
 
 
 
 
1020
  *
1021
- * @return string
1022
  */
1023
- private function get_module_root_dir_path( $module_type = false ) {
1024
- $is_plugin = empty( $module_type ) ?
1025
- $this->is_plugin() :
1026
- ( WP_FS__MODULE_TYPE_PLUGIN === $module_type );
1027
 
1028
- return fs_normalize_path( trailingslashit( $is_plugin ?
1029
- WP_PLUGIN_DIR :
1030
- get_theme_root() ) );
1031
- }
 
 
1032
 
1033
- /**
1034
- * @author Leo Fajardo (@leorw)
1035
- *
1036
- * @param number $module_id
1037
- * @param string $slug
1038
- *
1039
- * @since 1.2.2
1040
- */
1041
- private function store_id_slug_type_path_map( $module_id, $slug ) {
1042
- $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map', array() );
1043
-
1044
- $store_option = false;
1045
-
1046
- if ( ! isset( $id_slug_type_path_map[ $module_id ] ) ) {
1047
- $id_slug_type_path_map[ $module_id ] = array(
1048
- 'slug' => $slug
1049
- );
1050
-
1051
- $store_option = true;
1052
- }
1053
-
1054
- if ( ! isset( $id_slug_type_path_map[ $module_id ]['path'] ) ||
1055
- /**
1056
- * This verification is for cases when suddenly the same module
1057
- * is installed but with a different folder name.
1058
- *
1059
- * @author Vova Feldman (@svovaf)
1060
- * @since 1.2.3
1061
- */
1062
- ! file_exists( $this->get_absolute_path(
1063
- $id_slug_type_path_map[ $module_id ]['path'],
1064
- $id_slug_type_path_map[ $module_id ]['type']
1065
- ) )
1066
- ) {
1067
- $caller_main_file_and_type = $this->get_caller_main_file_and_type();
1068
-
1069
- $id_slug_type_path_map[ $module_id ]['type'] = $caller_main_file_and_type->module_type;
1070
- $id_slug_type_path_map[ $module_id ]['path'] = $caller_main_file_and_type->path;
1071
-
1072
- $store_option = true;
1073
- }
1074
-
1075
- if ( $store_option ) {
1076
- self::$_accounts->set_option( 'id_slug_type_path_map', $id_slug_type_path_map, true );
1077
- }
1078
- }
1079
-
1080
- /**
1081
- * Identifies the caller type: plugin or theme.
1082
- *
1083
- * @author Leo Fajardo (@leorw)
1084
- * @since 1.2.2
1085
- *
1086
- * @author Vova Feldman (@svovaf)
1087
- * @since 1.2.2.3 Find the earliest module in the call stack that calls to the SDK. This fix is for cases when
1088
- * add-ons are relying on loading the SDK from the parent module, and also allows themes including the
1089
- * SDK an internal file instead of directly from functions.php.
1090
- * @since 1.2.1.7 Knows how to handle cases when an add-on includes the parent module logic.
1091
- */
1092
- private function get_caller_main_file_and_type() {
1093
- self::require_plugin_essentials();
1094
-
1095
- $all_plugins = get_plugins();
1096
- $all_plugins_paths = array();
1097
-
1098
- // Get active plugin's main files real full names (might be symlinks).
1099
- foreach ( $all_plugins as $relative_path => &$data ) {
1100
- if ( false === strpos( fs_normalize_path( $relative_path ), '/' ) ) {
1101
- /**
1102
- * Ignore plugins that don't have a folder (e.g. Hello Dolly) since they
1103
- * can't really include the SDK.
1104
- *
1105
- * @author Vova Feldman
1106
- * @since 1.2.1.7
1107
- */
1108
- continue;
1109
- }
1110
-
1111
- $all_plugins_paths[] = fs_normalize_path( realpath( WP_PLUGIN_DIR . '/' . $relative_path ) );
1112
- }
1113
-
1114
- $caller_file_candidate = false;
1115
- $caller_map = array();
1116
- $module_type = WP_FS__MODULE_TYPE_PLUGIN;
1117
- $themes_dir = fs_normalize_path( get_theme_root() );
1118
-
1119
- for ( $i = 1, $bt = debug_backtrace(), $len = count( $bt ); $i < $len; $i ++ ) {
1120
- if ( empty( $bt[ $i ]['file'] ) ) {
1121
- continue;
1122
- }
1123
-
1124
- if ( $i > 1 && ! empty( $bt[ $i - 1 ]['file'] ) && $bt[ $i ]['file'] === $bt[ $i - 1 ]['file'] ) {
1125
- // If file same as the prev file in the stack, skip it.
1126
- continue;
1127
- }
1128
-
1129
- if ( ! empty( $bt[ $i ]['function'] ) && in_array( $bt[ $i ]['function'], array(
1130
- 'do_action',
1131
- 'apply_filter',
1132
- // The string split is stupid, but otherwise, theme check
1133
- // throws info notices.
1134
- 'requir' . 'e_once',
1135
- 'requir' . 'e',
1136
- 'includ' . 'e_once',
1137
- 'includ' . 'e'
1138
- ) )
1139
- ) {
1140
- // Ignore call stack hooks and files inclusion.
1141
- continue;
1142
- }
1143
-
1144
- $caller_file_path = fs_normalize_path( $bt[ $i ]['file'] );
1145
-
1146
- if ( 'functions.php' === basename( $caller_file_path ) ) {
1147
- /**
1148
- * 1. Assumes that theme's starting execution file is functions.php.
1149
- * 2. This complex logic fixes symlink issues (e.g. with Vargant).
1150
- *
1151
- * @author Vova Feldman (@svovaf)
1152
- * @since 1.2.2.5
1153
- */
1154
-
1155
- if ( $caller_file_path == fs_normalize_path( realpath( trailingslashit( $themes_dir ) . basename( dirname( $caller_file_path ) ) . '/' . basename( $caller_file_path ) ) ) ) {
1156
- $module_type = WP_FS__MODULE_TYPE_THEME;
1157
 
1158
- /**
1159
- * Relative path of the theme, e.g.:
1160
- * `my-theme/functions.php`
1161
- *
1162
- * @author Leo Fajardo (@leorw)
1163
- */
1164
- $caller_file_candidate = basename( dirname( $caller_file_path ) ) .
1165
- '/' .
1166
- basename( $caller_file_path );
1167
-
1168
- continue;
1169
- }
1170
- }
1171
-
1172
- $caller_file_hash = md5( $caller_file_path );
1173
-
1174
- if ( ! isset( $caller_map[ $caller_file_hash ] ) ) {
1175
- foreach ( $all_plugins_paths as $plugin_path ) {
1176
- if ( false !== strpos( $caller_file_path, fs_normalize_path( dirname( $plugin_path ) . '/' ) ) ) {
1177
- $caller_map[ $caller_file_hash ] = fs_normalize_path( $plugin_path );
1178
- break;
1179
- }
1180
- }
1181
- }
1182
-
1183
- if ( isset( $caller_map[ $caller_file_hash ] ) ) {
1184
- $module_type = WP_FS__MODULE_TYPE_PLUGIN;
1185
- $caller_file_candidate = plugin_basename( $caller_map[ $caller_file_hash ] );
1186
- }
1187
- }
1188
-
1189
- return (object) array(
1190
- 'module_type' => $module_type,
1191
- 'path' => $caller_file_candidate
1192
- );
1193
- }
1194
-
1195
- #----------------------------------------------------------------------------------
1196
- #region Deactivation Feedback Form
1197
- #----------------------------------------------------------------------------------
1198
-
1199
- /**
1200
- * Displays a confirmation and feedback dialog box when the user clicks on the "Deactivate" link on the plugins
1201
- * page.
1202
- *
1203
- * @author Vova Feldman (@svovaf)
1204
- * @author Leo Fajardo (@leorw)
1205
- * @since 1.1.2
1206
- */
1207
- function _add_deactivation_feedback_dialog_box() {
1208
- /* Check the type of user:
1209
- * 1. Long-term (long-term)
1210
- * 2. Non-registered and non-anonymous short-term (non-registered-and-non-anonymous-short-term).
1211
- * 3. Short-term (short-term)
1212
- */
1213
- $is_long_term_user = true;
1214
 
1215
- // Check if the site is at least 2 days old.
1216
- $time_installed = $this->_storage->install_timestamp;
 
 
 
 
 
 
 
 
 
 
 
 
1217
 
1218
- // Difference in seconds.
1219
- $date_diff = time() - $time_installed;
 
1220
 
1221
- // Convert seconds to days.
1222
- $date_diff_days = floor( $date_diff / ( 60 * 60 * 24 ) );
1223
 
1224
- if ( $date_diff_days < 2 ) {
1225
- $is_long_term_user = false;
1226
- }
1227
 
1228
- $is_long_term_user = $this->apply_filters( 'is_long_term_user', $is_long_term_user );
1229
 
1230
- if ( $is_long_term_user ) {
1231
- $user_type = 'long-term';
1232
- } else {
1233
- if ( ! $this->is_registered() && ! $this->is_anonymous() ) {
1234
- $user_type = 'non-registered-and-non-anonymous-short-term';
1235
- } else {
1236
- $user_type = 'short-term';
1237
- }
1238
- }
1239
 
1240
- $uninstall_reasons = $this->_get_uninstall_reasons( $user_type );
 
 
 
1241
 
1242
- // Load the HTML template for the deactivation feedback dialog box.
1243
- $vars = array(
1244
- 'reasons' => $uninstall_reasons,
1245
- 'id' => $this->_module_id
1246
- );
1247
 
1248
- /**
1249
- * @todo Deactivation form core functions should be loaded only once! Otherwise, when there are multiple Freemius powered plugins the same code is loaded multiple times. The only thing that should be loaded differently is the various deactivation reasons object based on the state of the plugin.
1250
- */
1251
- fs_require_template( 'forms/deactivation/form.php', $vars );
1252
- }
1253
-
1254
- /**
1255
- * @author Leo Fajardo (leorw)
1256
- * @since 1.1.2
1257
- *
1258
- * @param string $user_type
1259
- *
1260
- * @return array The uninstall reasons for the specified user type.
1261
- */
1262
- function _get_uninstall_reasons( $user_type = 'long-term' ) {
1263
- $module_type = $this->_module_type;
1264
-
1265
- $internal_message_template_var = array(
1266
- 'id' => $this->_module_id
1267
- );
1268
-
1269
- if ( $this->is_registered() && false !== $this->get_plan() && $this->get_plan()->has_technical_support() ) {
1270
- $contact_support_template = fs_get_template( 'forms/deactivation/contact.php', $internal_message_template_var );
1271
- } else {
1272
- $contact_support_template = '';
1273
- }
1274
-
1275
- $reason_found_better_plugin = array(
1276
- 'id' => self::REASON_FOUND_A_BETTER_PLUGIN,
1277
- 'text' => sprintf( $this->get_text_inline( 'I found a better %s', 'reason-found-a-better-plugin' ), $module_type ),
1278
- 'input_type' => 'textfield',
1279
- 'input_placeholder' => sprintf( $this->get_text_inline( "What's the %s's name?", 'placeholder-plugin-name' ), $module_type ),
1280
- );
1281
-
1282
- $reason_temporary_deactivation = array(
1283
- 'id' => self::REASON_TEMPORARY_DEACTIVATION,
1284
- 'text' => sprintf(
1285
- $this->get_text_inline( "It's a temporary %s. I'm just debugging an issue.", 'reason-temporary-x' ),
1286
- strtolower( $this->is_plugin() ?
1287
- $this->get_text_inline( 'Deactivation', 'deactivation' ) :
1288
- $this->get_text_inline( 'Theme Switch', 'theme-switch' )
1289
- )
1290
- ),
1291
- 'input_type' => '',
1292
- 'input_placeholder' => ''
1293
- );
1294
-
1295
- $reason_other = array(
1296
- 'id' => self::REASON_OTHER,
1297
- 'text' => $this->get_text_inline( 'Other', 'reason-other' ),
1298
- 'input_type' => 'textfield',
1299
- 'input_placeholder' => ''
1300
- );
1301
-
1302
- $long_term_user_reasons = array(
1303
- array(
1304
- 'id' => self::REASON_NO_LONGER_NEEDED,
1305
- 'text' => sprintf( $this->get_text_inline( 'I no longer need the %s', 'reason-no-longer-needed' ), $module_type ),
1306
- 'input_type' => '',
1307
- 'input_placeholder' => ''
1308
- ),
1309
- $reason_found_better_plugin,
1310
- array(
1311
- 'id' => self::REASON_NEEDED_FOR_A_SHORT_PERIOD,
1312
- 'text' => sprintf( $this->get_text_inline( 'I only needed the %s for a short period', 'reason-needed-for-a-short-period' ), $module_type ),
1313
- 'input_type' => '',
1314
- 'input_placeholder' => ''
1315
- ),
1316
- array(
1317
- 'id' => self::REASON_BROKE_MY_SITE,
1318
- 'text' => sprintf( $this->get_text_inline( 'The %s broke my site', 'reason-broke-my-site' ), $module_type ),
1319
- 'input_type' => '',
1320
- 'input_placeholder' => '',
1321
- 'internal_message' => $contact_support_template
1322
- ),
1323
- array(
1324
- 'id' => self::REASON_SUDDENLY_STOPPED_WORKING,
1325
- 'text' => sprintf( $this->get_text_inline( 'The %s suddenly stopped working', 'reason-suddenly-stopped-working' ), $module_type ),
1326
- 'input_type' => '',
1327
- 'input_placeholder' => '',
1328
- 'internal_message' => $contact_support_template
1329
- )
1330
- );
1331
-
1332
- if ( $this->is_paying() ) {
1333
- $long_term_user_reasons[] = array(
1334
- 'id' => self::REASON_CANT_PAY_ANYMORE,
1335
- 'text' => $this->get_text_inline( "I can't pay for it anymore", 'reason-cant-pay-anymore' ),
1336
- 'input_type' => 'textfield',
1337
- 'input_placeholder' => $this->get_text_inline( 'What price would you feel comfortable paying?', 'placeholder-comfortable-price' )
1338
- );
1339
- }
1340
-
1341
- $reason_dont_share_info = array(
1342
- 'id' => self::REASON_DONT_LIKE_TO_SHARE_MY_INFORMATION,
1343
- 'text' => $this->get_text_inline( "I don't like to share my information with you", 'reason-dont-like-to-share-my-information' ),
1344
- 'input_type' => '',
1345
- 'input_placeholder' => ''
1346
- );
1347
-
1348
- /**
1349
- * If the current user has selected the "don't share data" reason in the deactivation feedback modal, inform the
1350
- * user by showing additional message that he doesn't have to share data and can just choose to skip the opt-in
1351
- * (the Skip button is included in the message to show). This message will only be shown if anonymous mode is
1352
- * enabled and the user's account is currently not in pending activation state (similar to the way the Skip
1353
- * button in the opt-in form is shown/hidden).
1354
- */
1355
- if ( $this->is_enable_anonymous() && ! $this->is_pending_activation() ) {
1356
- $reason_dont_share_info['internal_message'] = fs_get_template( 'forms/deactivation/retry-skip.php', $internal_message_template_var );
1357
- }
1358
-
1359
- $uninstall_reasons = array(
1360
- 'long-term' => $long_term_user_reasons,
1361
- 'non-registered-and-non-anonymous-short-term' => array(
1362
- array(
1363
- 'id' => self::REASON_DIDNT_WORK,
1364
- 'text' => sprintf( $this->get_text_inline( "The %s didn't work", 'reason-didnt-work' ), $module_type ),
1365
- 'input_type' => '',
1366
- 'input_placeholder' => ''
1367
- ),
1368
- $reason_dont_share_info,
1369
- $reason_found_better_plugin
1370
- ),
1371
- 'short-term' => array(
1372
- array(
1373
- 'id' => self::REASON_COULDNT_MAKE_IT_WORK,
1374
- 'text' => $this->get_text_inline( "I couldn't understand how to make it work", 'reason-couldnt-make-it-work' ),
1375
- 'input_type' => '',
1376
- 'input_placeholder' => '',
1377
- 'internal_message' => $contact_support_template
1378
- ),
1379
- $reason_found_better_plugin,
1380
- array(
1381
- 'id' => self::REASON_GREAT_BUT_NEED_SPECIFIC_FEATURE,
1382
- 'text' => sprintf( $this->get_text_inline( "The %s is great, but I need specific feature that you don't support", 'reason-great-but-need-specific-feature' ), $module_type ),
1383
- 'input_type' => 'textarea',
1384
- 'input_placeholder' => $this->get_text_inline( 'What feature?', 'placeholder-feature' )
1385
- ),
1386
- array(
1387
- 'id' => self::REASON_NOT_WORKING,
1388
- 'text' => sprintf( $this->get_text_inline( 'The %s is not working', 'reason-not-working' ), $module_type ),
1389
- 'input_type' => 'textarea',
1390
- 'input_placeholder' => $this->get_text_inline( "Kindly share what didn't work so we can fix it for future users...", 'placeholder-share-what-didnt-work' )
1391
- ),
1392
- array(
1393
- 'id' => self::REASON_NOT_WHAT_I_WAS_LOOKING_FOR,
1394
- 'text' => $this->get_text_inline( "It's not what I was looking for", 'reason-not-what-i-was-looking-for' ),
1395
- 'input_type' => 'textarea',
1396
- 'input_placeholder' => $this->get_text_inline( "What you've been looking for?", 'placeholder-what-youve-been-looking-for' )
1397
- ),
1398
- array(
1399
- 'id' => self::REASON_DIDNT_WORK_AS_EXPECTED,
1400
- 'text' => sprintf( $this->get_text_inline( "The %s didn't work as expected", 'reason-didnt-work-as-expected' ), $module_type ),
1401
- 'input_type' => 'textarea',
1402
- 'input_placeholder' => $this->get_text_inline( 'What did you expect?', 'placeholder-what-did-you-expect' )
1403
- )
1404
- )
1405
- );
1406
-
1407
- // Randomize the reasons for the current user type.
1408
- shuffle( $uninstall_reasons[ $user_type ] );
1409
-
1410
- // Keep the following reasons as the last items in the list.
1411
- $uninstall_reasons[ $user_type ][] = $reason_temporary_deactivation;
1412
- $uninstall_reasons[ $user_type ][] = $reason_other;
1413
-
1414
- $uninstall_reasons = $this->apply_filters( 'uninstall_reasons', $uninstall_reasons );
1415
-
1416
- return $uninstall_reasons[ $user_type ];
1417
- }
1418
-
1419
- /**
1420
- * Called after the user has submitted his reason for deactivating the plugin.
1421
- *
1422
- * @author Leo Fajardo (@leorw)
1423
- * @since 1.1.2
1424
- */
1425
- function _submit_uninstall_reason_action() {
1426
- $this->_logger->entrance();
1427
-
1428
- $this->check_ajax_referer( 'submit_uninstall_reason' );
1429
-
1430
- $reason_id = fs_request_get( 'reason_id' );
1431
-
1432
- // Check if the given reason ID is an unsigned integer.
1433
- if ( ! ctype_digit( $reason_id ) ) {
1434
- exit;
1435
- }
1436
-
1437
- $reason_info = trim( fs_request_get( 'reason_info', '' ) );
1438
- if ( ! empty( $reason_info ) ) {
1439
- $reason_info = substr( $reason_info, 0, 128 );
1440
- }
1441
-
1442
- $reason = (object) array(
1443
- 'id' => $reason_id,
1444
- 'info' => $reason_info,
1445
- 'is_anonymous' => fs_request_get_bool( 'is_anonymous' )
1446
- );
1447
-
1448
- $this->_storage->store( 'uninstall_reason', $reason );
1449
-
1450
- /**
1451
- * If the module type is "theme", trigger the uninstall event here (on theme deactivation) since themes do
1452
- * not support uninstall hook.
1453
- *
1454
- * @author Leo Fajardo (@leorw)
1455
- * @since 1.2.2
1456
- */
1457
- if ( $this->is_theme() ) {
1458
- $this->_uninstall_plugin_event( false );
1459
- $this->remove_sdk_reference();
1460
- }
1461
-
1462
- // Print '1' for successful operation.
1463
- echo 1;
1464
- exit;
1465
- }
1466
-
1467
- #endregion
1468
-
1469
- #----------------------------------------------------------------------------------
1470
- #region Instance
1471
- #----------------------------------------------------------------------------------
1472
-
1473
- /**
1474
- * Main singleton instance.
1475
- *
1476
- * @author Vova Feldman (@svovaf)
1477
- * @since 1.0.0
1478
- *
1479
- * @param number $module_id
1480
- * @param string|bool $slug
1481
- * @param bool $is_init Is initiation sequence.
1482
- *
1483
- * @return Freemius|false
1484
- */
1485
- static function instance( $module_id, $slug = false, $is_init = false ) {
1486
- if ( empty( $module_id ) ) {
1487
- return false;
1488
- }
1489
-
1490
- if ( ! is_numeric( $module_id ) ) {
1491
- if ( ! $is_init && true === $slug ) {
1492
- $is_init = true;
1493
- }
1494
-
1495
- $slug = $module_id;
1496
-
1497
- $module = FS_Plugin_Manager::instance( $slug )->get();
1498
-
1499
- if ( is_object( $module ) ) {
1500
- $module_id = $module->id;
1501
- }
1502
- }
1503
-
1504
- $key = 'm_' . $module_id;
1505
-
1506
- if ( ! isset( self::$_instances[ $key ] ) ) {
1507
- if ( 0 === count( self::$_instances ) ) {
1508
- self::_load_required_static();
1509
- }
1510
-
1511
- self::$_instances[ $key ] = new Freemius( $module_id, $slug, $is_init );
1512
- }
1513
-
1514
- return self::$_instances[ $key ];
1515
- }
1516
-
1517
- /**
1518
- * @author Vova Feldman (@svovaf)
1519
- * @since 1.0.6
1520
- *
1521
- * @param number $addon_id
1522
- *
1523
- * @return bool
1524
- */
1525
- private static function has_instance( $addon_id ) {
1526
- return isset( self::$_instances[ 'm_' . $addon_id ] );
1527
- }
1528
-
1529
- /**
1530
- * @author Leo Fajardo (@leorw)
1531
- * @since 1.2.2
1532
- *
1533
- * @param string|number $id_or_slug
1534
- *
1535
- * @return number|false
1536
- */
1537
- private static function get_module_id( $id_or_slug ) {
1538
- if ( is_numeric( $id_or_slug ) ) {
1539
- return $id_or_slug;
1540
- }
1541
-
1542
- foreach ( self::$_instances as $instance ) {
1543
- if ( $instance->is_plugin() && ( $id_or_slug === $instance->get_slug() ) ) {
1544
- return $instance->get_id();
1545
- }
1546
- }
1547
-
1548
- return false;
1549
- }
1550
-
1551
- /**
1552
- * @author Vova Feldman (@svovaf)
1553
- * @since 1.0.6
1554
- *
1555
- * @param number $id
1556
- *
1557
- * @return false|Freemius
1558
- */
1559
- static function get_instance_by_id( $id ) {
1560
- return isset ( self::$_instances[ 'm_' . $id ] ) ?
1561
- self::$_instances[ 'm_' . $id ] :
1562
- false;
1563
- }
1564
-
1565
- /**
1566
- *
1567
- * @author Vova Feldman (@svovaf)
1568
- * @since 1.0.1
1569
- *
1570
- * @param $plugin_file
1571
- *
1572
- * @return false|Freemius
1573
- */
1574
- static function get_instance_by_file( $plugin_file ) {
1575
- $slug = self::find_slug_by_basename( $plugin_file );
1576
-
1577
- return ( false !== $slug ) ?
1578
- self::instance( self::get_module_id( $slug ) ) :
1579
- false;
1580
- }
1581
-
1582
- /**
1583
- * @author Vova Feldman (@svovaf)
1584
- * @since 1.0.6
1585
- *
1586
- * @return false|Freemius
1587
- */
1588
- function get_parent_instance() {
1589
- return self::get_instance_by_id( $this->_plugin->parent_plugin_id );
1590
- }
1591
-
1592
- /**
1593
- * @author Vova Feldman (@svovaf)
1594
- * @since 1.0.6
1595
- *
1596
- * @param string|number $id_or_slug
1597
- *
1598
- * @return false|Freemius
1599
- */
1600
- function get_addon_instance( $id_or_slug ) {
1601
- $addon_id = self::get_module_id( $id_or_slug );
1602
-
1603
- return self::instance( $addon_id );
1604
- }
1605
-
1606
- #endregion ------------------------------------------------------------------
1607
-
1608
- /**
1609
- * @author Vova Feldman (@svovaf)
1610
- * @since 1.0.6
1611
- *
1612
- * @return bool
1613
- */
1614
- function is_parent_plugin_installed() {
1615
- $is_active = self::has_instance( $this->_plugin->parent_plugin_id );
1616
-
1617
- if ( $is_active ) {
1618
- return true;
1619
- }
1620
-
1621
- /**
1622
- * Parent module might be a theme. If that's the case, the add-on's FS
1623
- * instance will be loaded prior to the theme's FS instance, therefore,
1624
- * we need to check if it's active with a "look ahead".
1625
- *
1626
- * @author Vova Feldman
1627
- * @since 1.2.2.3
1628
- */
1629
- global $fs_active_plugins;
1630
- if ( is_object( $fs_active_plugins ) && is_array( $fs_active_plugins->plugins ) ) {
1631
- $active_theme = wp_get_theme();
1632
-
1633
- foreach ( $fs_active_plugins->plugins as $sdk => $module ) {
1634
- if ( WP_FS__MODULE_TYPE_THEME === $module->type ) {
1635
- if ( $module->plugin_path == $active_theme->get_stylesheet() ) {
1636
- // Parent module is a theme and it's currently active.
1637
- return true;
1638
- }
1639
- }
1640
- }
1641
- }
1642
-
1643
- return false;
1644
- }
1645
-
1646
- /**
1647
- * Check if add-on parent plugin in activation mode.
1648
- *
1649
- * @author Vova Feldman (@svovaf)
1650
- * @since 1.0.7
1651
- *
1652
- * @return bool
1653
- */
1654
- function is_parent_in_activation() {
1655
- $parent_fs = $this->get_parent_instance();
1656
- if ( ! is_object( $parent_fs ) ) {
1657
- return false;
1658
- }
1659
-
1660
- return ( $parent_fs->is_activation_mode() );
1661
- }
1662
-
1663
- /**
1664
- * Is plugin in activation mode.
1665
- *
1666
- * @author Vova Feldman (@svovaf)
1667
- * @since 1.0.7
1668
- *
1669
- * @param bool $and_on
1670
- *
1671
- * @return bool
1672
- */
1673
- function is_activation_mode( $and_on = true ) {
1674
- return (
1675
- ( $this->is_on() || ! $and_on ) &&
1676
- ( ! $this->is_registered() || ( $this->is_only_premium() && ! $this->has_features_enabled_license() ) ) &&
1677
- ( ! $this->is_enable_anonymous() ||
1678
- ( ! $this->is_anonymous() && ! $this->is_pending_activation() ) )
1679
- );
1680
- }
1681
-
1682
- /**
1683
- * Check if current page is the opt-in/pending-activation page.
1684
- *
1685
- * @author Vova Feldman (@svovaf)
1686
- * @since 1.2.1.7
1687
- *
1688
- * @return bool
1689
- */
1690
- function is_activation_page() {
1691
- if ( $this->_menu->is_main_settings_page() ) {
1692
- return true;
1693
- }
1694
-
1695
- if ( ! $this->is_activation_mode() ) {
1696
- return false;
1697
- }
1698
-
1699
- // Check if current page is matching the activation page.
1700
- return $this->is_matching_url( $this->get_activation_url() );
1701
- }
1702
-
1703
- /**
1704
- * Check if URL path's are matching and that all querystring
1705
- * arguments of the $sub_url exist in the $url with the same values.
1706
- *
1707
- * WARNING:
1708
- * 1. This method doesn't check if the sub/domain are matching.
1709
- * 2. Ignore case sensitivity.
1710
- *
1711
- * @author Vova Feldman (@svovaf)
1712
- * @since 1.2.1.7
1713
- *
1714
- * @param string $sub_url
1715
- * @param string $url If argument is not set, check if the sub_url matching the current's page URL.
1716
- *
1717
- * @return bool
1718
- */
1719
- private function is_matching_url( $sub_url, $url = '' ) {
1720
- if ( empty( $url ) ) {
1721
- $url = $_SERVER['REQUEST_URI'];
1722
- }
1723
-
1724
- $url = strtolower( $url );
1725
- $sub_url = strtolower( $sub_url );
1726
-
1727
- if ( parse_url( $sub_url, PHP_URL_PATH ) !== parse_url( $url, PHP_URL_PATH ) ) {
1728
- // Different path - DO NOT OVERRIDE PAGE.
1729
- return false;
1730
- }
1731
-
1732
- $url_params = array();
1733
- parse_str( parse_url( $url, PHP_URL_QUERY ), $url_params );
1734
-
1735
- $sub_url_params = array();
1736
- parse_str( parse_url( $sub_url, PHP_URL_QUERY ), $sub_url_params );
1737
-
1738
- foreach ( $sub_url_params as $key => $val ) {
1739
- if ( ! isset( $url_params[ $key ] ) || $val != $url_params[ $key ] ) {
1740
- // Not matching query string - DO NOT OVERRIDE PAGE.
1741
- return false;
1742
- }
1743
- }
1744
-
1745
- return true;
1746
- }
1747
-
1748
- /**
1749
- * Get collection of all active plugins.
1750
- *
1751
- * @author Vova Feldman (@svovaf)
1752
- * @since 1.0.9
1753
- *
1754
- * @return array[string]array
1755
- */
1756
- private static function get_active_plugins() {
1757
- self::require_plugin_essentials();
1758
-
1759
- $active_plugin = array();
1760
- $all_plugins = get_plugins();
1761
- $active_plugins_basenames = get_option( 'active_plugins' );
1762
-
1763
- foreach ( $active_plugins_basenames as $plugin_basename ) {
1764
- $active_plugin[ $plugin_basename ] = $all_plugins[ $plugin_basename ];
1765
- }
1766
-
1767
- return $active_plugin;
1768
- }
1769
-
1770
- /**
1771
- * Get collection of all plugins.
1772
- *
1773
- * @author Vova Feldman (@svovaf)
1774
- * @since 1.1.8
1775
- *
1776
- * @return array Key is the plugin file path and the value is an array of the plugin data.
1777
- */
1778
- private static function get_all_plugins() {
1779
- self::require_plugin_essentials();
1780
-
1781
- $all_plugins = get_plugins();
1782
- $active_plugins_basenames = get_option( 'active_plugins' );
1783
-
1784
- foreach ( $all_plugins as $basename => &$data ) {
1785
- // By default set to inactive (next foreach update the active plugins).
1786
- $data['is_active'] = false;
1787
- // Enrich with plugin slug.
1788
- $data['slug'] = self::get_plugin_slug( $basename );
1789
- }
1790
-
1791
- // Flag active plugins.
1792
- foreach ( $active_plugins_basenames as $basename ) {
1793
- if ( isset( $all_plugins[ $basename ] ) ) {
1794
- $all_plugins[ $basename ]['is_active'] = true;
1795
- }
1796
- }
1797
-
1798
- return $all_plugins;
1799
- }
1800
-
1801
-
1802
- /**
1803
- * Cached result of get_site_transient( 'update_plugins' )
1804
- *
1805
- * @author Vova Feldman (@svovaf)
1806
- * @since 1.1.8
1807
- *
1808
- * @var object
1809
- */
1810
- private static $_plugins_info;
1811
-
1812
- /**
1813
- * Helper function to get specified plugin's slug.
1814
- *
1815
- * @author Vova Feldman (@svovaf)
1816
- * @since 1.1.8
1817
- *
1818
- * @param $basename
1819
- *
1820
- * @return string
1821
- */
1822
- private static function get_plugin_slug( $basename ) {
1823
- if ( ! isset( self::$_plugins_info ) ) {
1824
- self::$_plugins_info = get_site_transient( 'update_plugins' );
1825
- }
1826
-
1827
- $slug = '';
1828
-
1829
- if ( is_object( self::$_plugins_info ) ) {
1830
- if ( isset( self::$_plugins_info->no_update ) &&
1831
- isset( self::$_plugins_info->no_update[ $basename ] ) &&
1832
- ! empty( self::$_plugins_info->no_update[ $basename ]->slug )
1833
- ) {
1834
- $slug = self::$_plugins_info->no_update[ $basename ]->slug;
1835
- } else if ( isset( self::$_plugins_info->response ) &&
1836
- isset( self::$_plugins_info->response[ $basename ] ) &&
1837
- ! empty( self::$_plugins_info->response[ $basename ]->slug )
1838
- ) {
1839
- $slug = self::$_plugins_info->response[ $basename ]->slug;
1840
- }
1841
- }
1842
-
1843
- if ( empty( $slug ) ) {
1844
- // Try to find slug from FS data.
1845
- $slug = self::find_slug_by_basename( $basename );
1846
- }
1847
-
1848
- if ( empty( $slug ) ) {
1849
- // Fallback to plugin's folder name.
1850
- $slug = dirname( $basename );
1851
- }
1852
-
1853
- return $slug;
1854
- }
1855
-
1856
- private static $_statics_loaded = false;
1857
-
1858
- /**
1859
- * Load static resources.
1860
- *
1861
- * @author Vova Feldman (@svovaf)
1862
- * @since 1.0.1
1863
- */
1864
- private static function _load_required_static() {
1865
- if ( self::$_statics_loaded ) {
1866
- return;
1867
- }
1868
-
1869
- self::$_static_logger = FS_Logger::get_logger( WP_FS__SLUG, WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );
1870
-
1871
- self::$_static_logger->entrance();
1872
-
1873
- self::$_accounts = FS_Option_Manager::get_manager( WP_FS__ACCOUNTS_OPTION_NAME, true );
1874
-
1875
- self::$_global_admin_notices = FS_Admin_Notice_Manager::instance( 'global' );
1876
-
1877
- add_action( 'admin_menu', array( 'Freemius', '_add_debug_section' ) );
1878
-
1879
- add_action( "wp_ajax_fs_toggle_debug_mode", array( 'Freemius', '_toggle_debug_mode' ) );
1880
-
1881
- self::add_ajax_action_static( 'get_debug_log', array( 'Freemius', '_get_debug_log' ) );
1882
-
1883
- self::add_ajax_action_static( 'get_db_option', array( 'Freemius', '_get_db_option' ) );
1884
-
1885
- self::add_ajax_action_static( 'set_db_option', array( 'Freemius', '_set_db_option' ) );
1886
-
1887
- if ( 0 == did_action( 'plugins_loaded' ) ) {
1888
- add_action( 'plugins_loaded', array( 'Freemius', '_load_textdomain' ), 1 );
1889
- }
1890
-
1891
- self::$_statics_loaded = true;
1892
- }
1893
-
1894
- #----------------------------------------------------------------------------------
1895
- #region Localization
1896
- #----------------------------------------------------------------------------------
1897
-
1898
- /**
1899
- * Load framework's text domain.
1900
- *
1901
- * @author Vova Feldman (@svovaf)
1902
- * @since 1.2.1
1903
- */
1904
- static function _load_textdomain() {
1905
- if ( ! is_admin() ) {
1906
- return;
1907
- }
1908
-
1909
- global $fs_active_plugins;
1910
-
1911
- // Works both for plugins and themes.
1912
- load_plugin_textdomain(
1913
- 'freemius',
1914
- false,
1915
- $fs_active_plugins->newest->sdk_path . '/languages/'
1916
- );
1917
- }
1918
-
1919
- #endregion
1920
-
1921
- #----------------------------------------------------------------------------------
1922
- #region Debugging
1923
- #----------------------------------------------------------------------------------
1924
-
1925
- /**
1926
- * @author Vova Feldman (@svovaf)
1927
- * @since 1.0.8
1928
- */
1929
- static function _add_debug_section() {
1930
- if ( ! current_user_can( 'activate_plugins' )
1931
- && ! current_user_can( 'switch_themes' )
1932
- ) {
1933
- return;
1934
- }
1935
-
1936
- self::$_static_logger->entrance();
1937
-
1938
- $title = sprintf( '%s [v.%s]', fs_text_inline( 'Freemius Debug' ), WP_FS__SDK_VERSION );
1939
-
1940
- if ( WP_FS__DEV_MODE ) {
1941
- // Add top-level debug menu item.
1942
- $hook = FS_Admin_Menu_Manager::add_page(
1943
- $title,
1944
- $title,
1945
- 'manage_options',
1946
- 'freemius',
1947
- array( 'Freemius', '_debug_page_render' )
1948
- );
1949
- } else {
1950
- // Add hidden debug page.
1951
- $hook = FS_Admin_Menu_Manager::add_subpage(
1952
- null,
1953
- $title,
1954
- $title,
1955
- 'manage_options',
1956
- 'freemius',
1957
- array( 'Freemius', '_debug_page_render' )
1958
- );
1959
- }
1960
-
1961
- if ( ! empty( $hook ) ) {
1962
- add_action( "load-$hook", array( 'Freemius', '_debug_page_actions' ) );
1963
- }
1964
- }
1965
-
1966
- /**
1967
- * @author Vova Feldman (@svovaf)
1968
- * @since 1.1.7.3
1969
- */
1970
- static function _toggle_debug_mode() {
1971
- $is_on = fs_request_get( 'is_on', false, 'post' );
1972
-
1973
- if ( fs_request_is_post() && in_array( $is_on, array( 0, 1 ) ) ) {
1974
- update_option( 'fs_debug_mode', $is_on );
1975
-
1976
- // Turn on/off storage logging.
1977
- FS_Logger::_set_storage_logging( ( 1 == $is_on ) );
1978
- }
1979
-
1980
- exit;
1981
- }
1982
-
1983
- /**
1984
- * @author Vova Feldman (@svovaf)
1985
- * @since 1.2.1.6
1986
- */
1987
- static function _get_debug_log() {
1988
- $logs = FS_Logger::load_db_logs(
1989
- fs_request_get( 'filters', false, 'post' ),
1990
- ! empty( $_POST['limit'] ) && is_numeric( $_POST['limit'] ) ? $_POST['limit'] : 200,
1991
- ! empty( $_POST['offset'] ) && is_numeric( $_POST['offset'] ) ? $_POST['offset'] : 0
1992
- );
1993
-
1994
- self::shoot_ajax_success( $logs );
1995
- }
1996
-
1997
- /**
1998
- * @author Vova Feldman (@svovaf)
1999
- * @since 1.2.1.7
2000
- */
2001
- static function _get_db_option() {
2002
- $option_name = fs_request_get( 'option_name' );
2003
-
2004
- $value = get_option( $option_name );
2005
-
2006
- $result = array(
2007
- 'name' => $option_name,
2008
- );
2009
-
2010
- if ( false !== $value ) {
2011
- if ( ! is_string( $value ) ) {
2012
- $value = json_encode( $value );
2013
- }
2014
-
2015
- $result['value'] = $value;
2016
- }
2017
-
2018
- self::shoot_ajax_success( $result );
2019
- }
2020
-
2021
- /**
2022
- * @author Vova Feldman (@svovaf)
2023
- * @since 1.2.1.7
2024
- */
2025
- static function _set_db_option() {
2026
- $option_name = fs_request_get( 'option_name' );
2027
- $option_value = fs_request_get( 'option_value' );
2028
-
2029
- if ( ! empty( $option_value ) ) {
2030
- update_option( $option_name, $option_value );
2031
- }
2032
-
2033
- self::shoot_ajax_success();
2034
- }
2035
-
2036
- /**
2037
- * @author Vova Feldman (@svovaf)
2038
- * @since 1.0.8
2039
- */
2040
- static function _debug_page_actions() {
2041
- self::_clean_admin_content_section();
2042
-
2043
- if ( fs_request_is_action( 'restart_freemius' ) ) {
2044
- check_admin_referer( 'restart_freemius' );
2045
-
2046
- // Clear accounts data.
2047
- self::$_accounts->clear( true );
2048
-
2049
- // Clear SDK reference cache.
2050
- delete_option( 'fs_active_plugins' );
2051
- } else if ( fs_request_is_action( 'simulate_trial' ) ) {
2052
- check_admin_referer( 'simulate_trial' );
2053
-
2054
- $fs = freemius( fs_request_get( 'module_id' ) );
2055
-
2056
- // Update SDK install to at least 24 hours before.
2057
- $fs->_storage->install_timestamp = ( time() - WP_FS__TIME_24_HOURS_IN_SEC );
2058
- // Unset the trial shown timestamp.
2059
- unset( $fs->_storage->trial_promotion_shown );
2060
- } else if ( fs_request_is_action( 'delete_install' ) ) {
2061
- check_admin_referer( 'delete_install' );
2062
-
2063
- self::_delete_site_by_slug(
2064
- fs_request_get( 'slug' ),
2065
- fs_request_get( 'module_type' )
2066
- );
2067
- } else if ( fs_request_is_action( 'download_logs' ) ) {
2068
- check_admin_referer( 'download_logs' );
2069
-
2070
- $download_url = FS_Logger::download_db_logs(
2071
- fs_request_get( 'filters', false, 'post' )
2072
- );
2073
-
2074
- if ( false === $download_url ) {
2075
- wp_die( 'Oops... there was an error while generating the logs download file. Please try again and if it doesn\'t work contact support@freemius.com.' );
2076
- }
2077
-
2078
- fs_redirect( $download_url );
2079
- }
2080
- }
2081
-
2082
- /**
2083
- * @author Vova Feldman (@svovaf)
2084
- * @since 1.0.8
2085
- */
2086
- static function _debug_page_render() {
2087
- self::$_static_logger->entrance();
2088
-
2089
- $vars = array(
2090
- 'plugin_sites' => self::get_all_sites(),
2091
- 'theme_sites' => self::get_all_sites( WP_FS__MODULE_TYPE_THEME ),
2092
- 'users' => self::get_all_users(),
2093
- 'addons' => self::get_all_addons(),
2094
- 'account_addons' => self::get_all_account_addons(),
2095
- 'plugin_licenses' => self::get_all_licenses(),
2096
- 'theme_licenses' => self::get_all_licenses( WP_FS__MODULE_TYPE_THEME )
2097
- );
2098
-
2099
- fs_enqueue_local_style( 'fs_debug', '/admin/debug.css' );
2100
- fs_require_once_template( 'debug.php', $vars );
2101
- }
2102
-
2103
- #endregion
2104
-
2105
- #----------------------------------------------------------------------------------
2106
- #region Connectivity Issues
2107
- #----------------------------------------------------------------------------------
2108
-
2109
- /**
2110
- * Check if Freemius should be turned on for the current plugin install.
2111
- *
2112
- * Note:
2113
- * $this->_is_on is updated in has_api_connectivity()
2114
- *
2115
- * @author Vova Feldman (@svovaf)
2116
- * @since 1.0.9
2117
- *
2118
- * @return bool
2119
- */
2120
- function is_on() {
2121
- self::$_static_logger->entrance();
2122
-
2123
- if ( isset( $this->_is_on ) ) {
2124
- return $this->_is_on;
2125
- }
2126
-
2127
- // If already installed or pending then sure it's on :)
2128
- if ( $this->is_registered() || $this->is_pending_activation() ) {
2129
- $this->_is_on = true;
2130
-
2131
- return true;
2132
- }
2133
-
2134
- return false;
2135
- }
2136
-
2137
- /**
2138
- * @author Vova Feldman (@svovaf)
2139
- * @since 1.1.7.3
2140
- *
2141
- * @param bool $flush_if_no_connectivity
2142
- *
2143
- * @return bool
2144
- */
2145
- private function should_run_connectivity_test( $flush_if_no_connectivity = false ) {
2146
- if ( ! isset( $this->_storage->connectivity_test ) ) {
2147
- // Connectivity test was never executed, or cache was cleared.
2148
- return true;
2149
- }
2150
-
2151
- if ( WP_FS__PING_API_ON_IP_OR_HOST_CHANGES ) {
2152
- if ( WP_FS__IS_HTTP_REQUEST ) {
2153
- if ( $_SERVER['HTTP_HOST'] != $this->_storage->connectivity_test['host'] ) {
2154
- // Domain changed.
2155
- return true;
2156
- }
2157
-
2158
- if ( WP_FS__REMOTE_ADDR != $this->_storage->connectivity_test['server_ip'] ) {
2159
- // Server IP changed.
2160
- return true;
2161
- }
2162
- }
2163
- }
2164
-
2165
- if ( $this->_storage->connectivity_test['is_connected'] &&
2166
- $this->_storage->connectivity_test['is_active']
2167
- ) {
2168
- // API connected and Freemius is active - no need to run connectivity check.
2169
- return false;
2170
- }
2171
-
2172
- if ( $flush_if_no_connectivity ) {
2173
- /**
2174
- * If explicitly asked to flush when no connectivity - do it only
2175
- * if at least 10 sec passed from the last API connectivity test.
2176
- */
2177
- return ( isset( $this->_storage->connectivity_test['timestamp'] ) &&
2178
- ( WP_FS__SCRIPT_START_TIME - $this->_storage->connectivity_test['timestamp'] ) > 10 );
2179
- }
2180
-
2181
- /**
2182
- * @since 1.1.7 Don't check for connectivity on plugin downgrade.
2183
- */
2184
- $version = $this->get_plugin_version();
2185
- if ( version_compare( $version, $this->_storage->connectivity_test['version'], '>' ) ) {
2186
- // If it's a plugin version upgrade and Freemius is off or no connectivity, run connectivity test.
2187
- return true;
2188
- }
2189
-
2190
- return false;
2191
- }
2192
-
2193
- /**
2194
- * @author Vova Feldman (@svovaf)
2195
- * @since 1.1.7.4
2196
- *
2197
- * @return object|false
2198
- */
2199
- private function ping() {
2200
- if ( WP_FS__SIMULATE_NO_API_CONNECTIVITY ) {
2201
- return false;
2202
- }
2203
-
2204
- $version = $this->get_plugin_version();
2205
-
2206
- $is_update = $this->apply_filters( 'is_plugin_update', $this->is_plugin_update() );
2207
-
2208
- return $this->get_api_plugin_scope()->ping(
2209
- $this->get_anonymous_id(),
2210
- array(
2211
- 'is_update' => json_encode( $is_update ),
2212
- 'version' => $version,
2213
- 'sdk' => $this->version,
2214
- 'is_admin' => json_encode( is_admin() ),
2215
- 'is_ajax' => json_encode( self::is_ajax() ),
2216
- 'is_cron' => json_encode( self::is_cron() ),
2217
- 'is_http' => json_encode( WP_FS__IS_HTTP_REQUEST ),
2218
- )
2219
- );
2220
- }
2221
-
2222
- /**
2223
- * Check if there's any connectivity issue to Freemius API.
2224
- *
2225
- * @author Vova Feldman (@svovaf)
2226
- * @since 1.0.9
2227
- *
2228
- * @param bool $flush_if_no_connectivity
2229
- *
2230
- * @return bool
2231
- */
2232
- function has_api_connectivity( $flush_if_no_connectivity = false ) {
2233
- $this->_logger->entrance();
2234
-
2235
- if ( isset( $this->_has_api_connection ) && ( $this->_has_api_connection || ! $flush_if_no_connectivity ) ) {
2236
- return $this->_has_api_connection;
2237
- }
2238
-
2239
- if ( WP_FS__SIMULATE_NO_API_CONNECTIVITY &&
2240
- isset( $this->_storage->connectivity_test ) &&
2241
- true === $this->_storage->connectivity_test['is_connected']
2242
- ) {
2243
- unset( $this->_storage->connectivity_test );
2244
- }
2245
-
2246
- if ( ! $this->should_run_connectivity_test( $flush_if_no_connectivity ) ) {
2247
- $this->_has_api_connection = $this->_storage->connectivity_test['is_connected'];
2248
- /**
2249
- * @since 1.1.6 During dev mode, if there's connectivity - turn Freemius on regardless the configuration.
2250
- *
2251
- * @since 1.2.1.5 If the user running the premium version then ignore the 'is_active' flag and turn Freemius on to enable license key activation.
2252
- */
2253
- $this->_is_on = $this->_storage->connectivity_test['is_active'] ||
2254
- $this->is_premium() ||
2255
- ( WP_FS__DEV_MODE && $this->_has_api_connection && ! WP_FS__SIMULATE_FREEMIUS_OFF );
2256
-
2257
- return $this->_has_api_connection;
2258
- }
2259
-
2260
- $pong = $this->ping();
2261
- $is_connected = $this->get_api_plugin_scope()->is_valid_ping( $pong );
2262
-
2263
- if ( ! $is_connected ) {
2264
- // API failure.
2265
- $this->_add_connectivity_issue_message( $pong );
2266
- }
2267
-
2268
- $this->store_connectivity_info( $pong, $is_connected );
2269
-
2270
- return $this->_has_api_connection;
2271
- }
2272
-
2273
- /**
2274
- * @author Vova Feldman (@svovaf)
2275
- * @since 1.1.7.4
2276
- *
2277
- * @param object $pong
2278
- * @param bool $is_connected
2279
- */
2280
- private function store_connectivity_info( $pong, $is_connected ) {
2281
- $this->_logger->entrance();
2282
-
2283
- $version = $this->get_plugin_version();
2284
-
2285
- if ( ! $is_connected || WP_FS__SIMULATE_FREEMIUS_OFF ) {
2286
- $is_active = false;
2287
- } else {
2288
- $is_active = ( isset( $pong->is_active ) && true == $pong->is_active );
2289
- }
2290
-
2291
- $is_active = $this->apply_filters(
2292
- 'is_on',
2293
- $is_active,
2294
- $this->is_plugin_update(),
2295
- $version
2296
- );
2297
-
2298
- $this->_storage->connectivity_test = array(
2299
- 'is_connected' => $is_connected,
2300
- 'host' => $_SERVER['HTTP_HOST'],
2301
- 'server_ip' => WP_FS__REMOTE_ADDR,
2302
- 'is_active' => $is_active,
2303
- 'timestamp' => WP_FS__SCRIPT_START_TIME,
2304
- // Last version with connectivity attempt.
2305
- 'version' => $version,
2306
- );
2307
-
2308
- $this->_has_api_connection = $is_connected;
2309
- $this->_is_on = $is_active || ( WP_FS__DEV_MODE && $is_connected && ! WP_FS__SIMULATE_FREEMIUS_OFF );
2310
- }
2311
-
2312
- /**
2313
- * Force turning Freemius on.
2314
- *
2315
- * @author Vova Feldman (@svovaf)
2316
- * @since 1.1.8.1
2317
- *
2318
- * @return bool TRUE if successfully turned on.
2319
- */
2320
- private function turn_on() {
2321
- $this->_logger->entrance();
2322
-
2323
- if ( $this->is_on() || ! isset( $this->_storage->connectivity_test['is_active'] ) ) {
2324
- return false;
2325
- }
2326
-
2327
- $updated_connectivity = $this->_storage->connectivity_test;
2328
- $updated_connectivity['is_active'] = true;
2329
- $updated_connectivity['timestamp'] = WP_FS__SCRIPT_START_TIME;
2330
- $this->_storage->connectivity_test = $updated_connectivity;
2331
-
2332
- $this->_is_on = true;
2333
-
2334
- return true;
2335
- }
2336
-
2337
- /**
2338
- * Anonymous and unique site identifier (Hash).
2339
- *
2340
- * @author Vova Feldman (@svovaf)
2341
- * @since 1.1.0
2342
- *
2343
- * @return string
2344
- */
2345
- function get_anonymous_id() {
2346
- $unique_id = self::$_accounts->get_option( 'unique_id' );
2347
 
2348
- if ( empty( $unique_id ) || ! is_string( $unique_id ) ) {
2349
- $key = get_site_url();
 
 
2350
 
2351
- // If localhost, assign microtime instead of domain.
2352
- if ( WP_FS__IS_LOCALHOST ||
2353
- false !== strpos( $key, 'localhost' ) ||
2354
- false === strpos( $key, '.' )
2355
- ) {
2356
- $key = microtime();
2357
- }
2358
 
 
2359
  /**
2360
- * Base the unique identifier on the WP secure authentication key. Which
2361
- * turns the key into a secret anonymous identifier.
 
 
2362
  *
2363
  * @author Vova Feldman (@svovaf)
2364
- * @since 1.2.3
2365
  */
2366
- $unique_id = md5( $key . SECURE_AUTH_KEY );
 
 
 
 
2367
 
2368
- self::$_accounts->set_option( 'unique_id', $unique_id, true );
 
 
2369
  }
2370
 
2371
- $this->_logger->departure( $unique_id );
2372
 
2373
- return $unique_id;
2374
- }
2375
 
2376
- /**
2377
- * @author Vova Feldman (@svovaf)
2378
- * @since 1.1.7.4
2379
- *
2380
- * @return \WP_User
2381
- */
2382
- static function _get_current_wp_user() {
2383
- self::require_pluggable_essentials();
2384
-
2385
- return wp_get_current_user();
2386
- }
2387
-
2388
- /**
2389
- * @author Vova Feldman (@svovaf)
2390
- * @since 1.2.1.7
2391
- *
2392
- * @param string $email
2393
- *
2394
- * @return bool
2395
- */
2396
- static function is_valid_email( $email ) {
2397
- if ( false === filter_var( $email, FILTER_VALIDATE_EMAIL ) ) {
2398
- return false;
2399
- }
2400
-
2401
- $parts = explode( '@', $email );
2402
-
2403
- if ( 2 !== count( $parts ) || empty( $parts[1] ) ) {
2404
- return false;
2405
- }
2406
-
2407
- $blacklist = array(
2408
- 'admin.',
2409
- 'webmaster.',
2410
- 'localhost.',
2411
- 'dev.',
2412
- 'development.',
2413
- 'test.',
2414
- 'stage.',
2415
- 'staging.',
2416
- );
2417
-
2418
- // Make sure domain is not one of the blacklisted.
2419
- foreach ( $blacklist as $invalid ) {
2420
- if ( 0 === strpos( $parts[1], $invalid ) ) {
2421
- return false;
2422
- }
2423
- }
2424
-
2425
- // Get the UTF encoded domain name.
2426
- $domain = idn_to_ascii( $parts[1] ) . '.';
2427
-
2428
- return ( checkdnsrr( $domain, 'MX' ) || checkdnsrr( $domain, 'A' ) );
2429
- }
2430
-
2431
- /**
2432
- * Generate API connectivity issue message.
2433
- *
2434
- * @author Vova Feldman (@svovaf)
2435
- * @since 1.0.9
2436
- *
2437
- * @param mixed $api_result
2438
- * @param bool $is_first_failure
2439
- */
2440
- function _add_connectivity_issue_message( $api_result, $is_first_failure = true ) {
2441
- if ( ! $this->is_premium() && $this->_enable_anonymous ) {
2442
- // Don't add message if it's the free version and can run anonymously.
2443
- return;
2444
- }
2445
-
2446
- if ( ! function_exists( 'wp_nonce_url' ) ) {
2447
- require_once ABSPATH . 'wp-includes/functions.php';
2448
- }
2449
-
2450
- $current_user = self::_get_current_wp_user();
2451
- // $admin_email = get_option( 'admin_email' );
2452
- $admin_email = $current_user->user_email;
2453
-
2454
- // Aliases.
2455
- $deactivate_plugin_title = $this->esc_html_inline( 'That\'s exhausting, please deactivate', 'deactivate-plugin-title' );
2456
- $deactivate_plugin_desc = $this->esc_html_inline( 'We feel your frustration and sincerely apologize for the inconvenience. Hope to see you again in the future.', 'deactivate-plugin-desc' );
2457
- $install_previous_title = $this->esc_html_inline( 'Let\'s try your previous version', 'install-previous-title' );
2458
- $install_previous_desc = $this->esc_html_inline( 'Uninstall this version and install the previous one.', 'install-previous-desc' );
2459
- $fix_issue_title = $this->esc_html_inline( 'Yes - I\'m giving you a chance to fix it', 'fix-issue-title' );
2460
- $fix_issue_desc = $this->esc_html_inline( 'We will do our best to whitelist your server and resolve this issue ASAP. You will get a follow-up email to %s once we have an update.', 'fix-issue-desc' );
2461
- /* translators: %s: product title (e.g. "Awesome Plugin" requires an access to...) */
2462
- $x_requires_access_to_api = $this->esc_html_inline( '%s requires an access to our API.', 'x-requires-access-to-api' );
2463
- $sysadmin_title = $this->esc_html_inline( 'I\'m a system administrator', 'sysadmin-title' );
2464
- $happy_to_resolve_issue_asap = $this->esc_html_inline( 'We are sure it\'s an issue on our side and more than happy to resolve it for you ASAP if you give us a chance.', 'happy-to-resolve-issue-asap' );
2465
 
2466
- $message = false;
2467
- if ( is_object( $api_result ) &&
2468
- isset( $api_result->error ) &&
2469
- isset( $api_result->error->code )
2470
- ) {
2471
- switch ( $api_result->error->code ) {
2472
- case 'curl_missing':
2473
- $missing_methods = '';
2474
- if ( is_array( $api_result->missing_methods ) &&
2475
- ! empty( $api_result->missing_methods )
2476
- ) {
2477
- foreach ( $api_result->missing_methods as $m ) {
2478
- if ( 'curl_version' === $m ) {
2479
- continue;
2480
- }
2481
-
2482
- if ( ! empty( $missing_methods ) ) {
2483
- $missing_methods .= ', ';
2484
- }
2485
-
2486
- $missing_methods .= sprintf( '<code>%s</code>', $m );
2487
- }
2488
-
2489
- if ( ! empty( $missing_methods ) ) {
2490
- $missing_methods = sprintf(
2491
- '<br><br><b>%s</b> %s',
2492
- $this->esc_html_inline( 'Disabled method(s):', 'curl-disabled-methods' ),
2493
- $missing_methods
2494
- );
2495
- }
2496
- }
2497
-
2498
- $message = sprintf(
2499
- $x_requires_access_to_api . ' ' .
2500
- $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' ) . ' ' .
2501
- $missing_methods .
2502
- ' %s',
2503
- '<b>' . $this->get_plugin_name() . '</b>',
2504
- sprintf(
2505
- '<ol id="fs_firewall_issue_options"><li>%s</li><li>%s</li><li>%s</li></ol>',
2506
- sprintf(
2507
- '<a class="fs-resolve" data-type="curl" href="#"><b>%s</b></a>%s',
2508
- $this->get_text_inline( 'I don\'t know what is cURL or how to install it, help me!', 'curl-missing-no-clue-title' ),
2509
- ' - ' . sprintf(
2510
- $this->get_text_inline( 'We\'ll make sure to contact your hosting company and resolve the issue. You will get a follow-up email to %s once we have an update.', 'curl-missing-no-clue-desc' ),
2511
- '<a href="mailto:' . $admin_email . '">' . $admin_email . '</a>'
2512
- )
2513
- ),
2514
- sprintf(
2515
- '<b>%s</b> - %s',
2516
- $sysadmin_title,
2517
- esc_html( sprintf( $this->get_text_inline( 'Great, please install cURL and enable it in your php.ini file. In addition, search for the \'disable_functions\' directive in your php.ini file and remove any disabled methods starting with \'curl_\'. To make sure it was successfully activated, use \'phpinfo()\'. Once activated, deactivate the %s and reactivate it back again.', 'curl-missing-sysadmin-desc' ), $this->get_module_label( true ) ) )
2518
- ),
2519
- sprintf(
2520
- '<a href="%s"><b>%s</b></a> - %s',
2521
- wp_nonce_url( 'plugins.php?action=deactivate&amp;plugin=' . $this->_plugin_basename . '&amp;plugin_status=all&amp;paged=1&amp;s=', 'deactivate-plugin_' . $this->_plugin_basename ),
2522
- $deactivate_plugin_title,
2523
- $deactivate_plugin_desc
2524
- )
2525
- )
2526
- );
2527
- break;
2528
- case 'cloudflare_ddos_protection':
2529
- $message = sprintf(
2530
- $x_requires_access_to_api . ' ' .
2531
- $this->esc_html_inline( 'From unknown reason, CloudFlare, the firewall we use, blocks the connection.', 'cloudflare-blocks-connection-message' ) . ' ' .
2532
- $happy_to_resolve_issue_asap .
2533
- ' %s',
2534
- '<b>' . $this->get_plugin_name() . '</b>',
2535
- sprintf(
2536
- '<ol id="fs_firewall_issue_options"><li>%s</li><li>%s</li><li>%s</li></ol>',
2537
- sprintf(
2538
- '<a class="fs-resolve" data-type="cloudflare" href="#"><b>%s</b></a>%s',
2539
- $fix_issue_title,
2540
- ' - ' . sprintf(
2541
- $fix_issue_desc,
2542
- '<a href="mailto:' . $admin_email . '">' . $admin_email . '</a>'
2543
- )
2544
- ),
2545
- sprintf(
2546
- '<a href="%s" target="_blank"><b>%s</b></a> - %s',
2547
- sprintf( 'https://wordpress.org/plugins/%s/download/', $this->_slug ),
2548
- $install_previous_title,
2549
- $install_previous_desc
2550
- ),
2551
- sprintf(
2552
- '<a href="%s"><b>%s</b></a> - %s',
2553
- wp_nonce_url( 'plugins.php?action=deactivate&amp;plugin=' . $this->_plugin_basename . '&amp;plugin_status=all&amp;paged=1&amp;s=' . '', 'deactivate-plugin_' . $this->_plugin_basename ),
2554
- $deactivate_plugin_title,
2555
- $deactivate_plugin_desc
2556
- )
2557
- )
2558
- );
2559
- break;
2560
- case 'squid_cache_block':
2561
- $message = sprintf(
2562
- $x_requires_access_to_api . ' ' .
2563
- $this->esc_html_inline( 'It looks like your server is using Squid ACL (access control lists), which blocks the connection.', 'squid-blocks-connection-message' ) .
2564
- ' %s',
2565
- '<b>' . $this->get_plugin_name() . '</b>',
2566
- sprintf(
2567
- '<ol id="fs_firewall_issue_options"><li>%s</li><li>%s</li><li>%s</li></ol>',
2568
- sprintf(
2569
- '<a class="fs-resolve" data-type="squid" href="#"><b>%s</b></a> - %s',
2570
- $this->esc_html_inline( 'I don\'t know what is Squid or ACL, help me!', 'squid-no-clue-title' ),
2571
- sprintf(
2572
- $this->esc_html_inline( 'We\'ll make sure to contact your hosting company and resolve the issue. You will get a follow-up email to %s once we have an update.', 'squid-no-clue-desc' ),
2573
- '<a href="mailto:' . $admin_email . '">' . $admin_email . '</a>'
2574
- )
2575
- ),
2576
- sprintf(
2577
- '<b>%s</b> - %s',
2578
- $sysadmin_title,
2579
- sprintf(
2580
- $this->esc_html_inline( 'Great, please whitelist the following domains: %s. Once you are done, deactivate the %s and activate it again.', 'squid-sysadmin-desc' ),
2581
- // We use a filter since the plugin might require additional API connectivity.
2582
- '<b>' . implode( ', ', $this->apply_filters( 'api_domains', array( 'api.freemius.com', 'wp.freemius.com' ) ) ) . '</b>',
2583
- $this->_module_type
2584
- )
2585
- ),
2586
- sprintf(
2587
- '<a href="%s"><b>%s</b></a> - %s',
2588
- wp_nonce_url( 'plugins.php?action=deactivate&amp;plugin=' . $this->_plugin_basename . '&amp;plugin_status=all&amp;paged=1&amp;s=', 'deactivate-plugin_' . $this->_plugin_basename ),
2589
- $deactivate_plugin_title,
2590
- $deactivate_plugin_desc
2591
- )
2592
- )
2593
- );
2594
- break;
2595
- // default:
2596
- // $message = $this->get_text_inline( 'connectivity-test-fails-message' );
2597
- // break;
2598
- }
2599
- }
2600
 
2601
- $message_id = 'failed_connect_api';
2602
- $type = 'error';
 
 
2603
 
2604
- $connectivity_test_fails_message = $this->esc_html_inline( 'From unknown reason, the API connectivity test failed.', 'connectivity-test-fails-message' );
 
 
2605
 
2606
- if ( false === $message ) {
2607
- if ( $is_first_failure ) {
2608
- // First attempt failed.
2609
- $message = sprintf(
2610
- $x_requires_access_to_api . ' ' .
2611
- $connectivity_test_fails_message . ' ' .
2612
- $this->esc_html_inline( 'It\'s probably a temporary issue on our end. Just to be sure, with your permission, would it be o.k to run another connectivity test?', 'connectivity-test-maybe-temporary' ) . '<br><br>' .
2613
- '%s',
2614
- '<b>' . $this->get_plugin_name() . '</b>',
2615
- sprintf(
2616
- '<div id="fs_firewall_issue_options">%s %s</div>',
2617
- sprintf(
2618
- '<a class="button button-primary fs-resolve" data-type="retry_ping" href="#">%s</a>',
2619
- $this->get_text_inline( 'Yes - do your thing', 'yes-do-your-thing' )
2620
- ),
2621
- sprintf(
2622
- '<a href="%s" class="button">%s</a>',
2623
- wp_nonce_url( 'plugins.php?action=deactivate&amp;plugin=' . $this->_plugin_basename . '&amp;plugin_status=all&amp;paged=1&amp;s=', 'deactivate-plugin_' . $this->_plugin_basename ),
2624
- $this->get_text_inline( 'No - just deactivate', 'no-deactivate' )
2625
- )
2626
- )
2627
- );
2628
-
2629
- $message_id = 'failed_connect_api_first';
2630
- $type = 'promotion';
2631
- } else {
2632
- // Second connectivity attempt failed.
2633
- $message = sprintf(
2634
- $x_requires_access_to_api . ' ' .
2635
- $connectivity_test_fails_message . ' ' .
2636
- $happy_to_resolve_issue_asap .
2637
- ' %s',
2638
- '<b>' . $this->get_plugin_name() . '</b>',
2639
- sprintf(
2640
- '<ol id="fs_firewall_issue_options"><li>%s</li><li>%s</li><li>%s</li></ol>',
2641
- sprintf(
2642
- '<a class="fs-resolve" data-type="general" href="#"><b>%s</b></a>%s',
2643
- $fix_issue_title,
2644
- ' - ' . sprintf(
2645
- $fix_issue_desc,
2646
- '<a href="mailto:' . $admin_email . '">' . $admin_email . '</a>'
2647
- )
2648
- ),
2649
- sprintf(
2650
- '<a href="%s" target="_blank"><b>%s</b></a> - %s',
2651
- sprintf( 'https://wordpress.org/plugins/%s/download/', $this->_slug ),
2652
- $install_previous_title,
2653
- $install_previous_desc
2654
- ),
2655
- sprintf(
2656
- '<a href="%s"><b>%s</b></a> - %s',
2657
- wp_nonce_url( 'plugins.php?action=deactivate&amp;plugin=' . $this->_plugin_basename . '&amp;plugin_status=all&amp;paged=1&amp;s=', 'deactivate-plugin_' . $this->_plugin_basename ),
2658
- $deactivate_plugin_title,
2659
- $deactivate_plugin_desc
2660
- )
2661
- )
2662
- );
2663
- }
2664
- }
2665
-
2666
- $this->_admin_notices->add_sticky(
2667
- $message,
2668
- $message_id,
2669
- $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
2670
- $type
2671
- );
2672
- }
2673
-
2674
- /**
2675
- * Handle user request to resolve connectivity issue.
2676
- * This method will send an email to Freemius API technical staff for resolution.
2677
- * The email will contain server's info and installed plugins (might be caching issue).
2678
- *
2679
- * @author Vova Feldman (@svovaf)
2680
- * @since 1.0.9
2681
- */
2682
- function _email_about_firewall_issue() {
2683
- $this->_admin_notices->remove_sticky( 'failed_connect_api' );
2684
-
2685
- $pong = $this->ping();
2686
-
2687
- $is_connected = $this->get_api_plugin_scope()->is_valid_ping( $pong );
2688
-
2689
- if ( $is_connected ) {
2690
- $this->store_connectivity_info( $pong, $is_connected );
2691
-
2692
- echo $this->get_after_plugin_activation_redirect_url();
2693
- exit;
2694
- }
2695
-
2696
- $current_user = self::_get_current_wp_user();
2697
- $admin_email = $current_user->user_email;
2698
-
2699
- $error_type = fs_request_get( 'error_type', 'general' );
2700
-
2701
- switch ( $error_type ) {
2702
- case 'squid':
2703
- $title = 'Squid ACL Blocking Issue';
2704
- break;
2705
- case 'cloudflare':
2706
- $title = 'CloudFlare Blocking Issue';
2707
- break;
2708
- default:
2709
- $title = 'API Connectivity Issue';
2710
- break;
2711
- }
2712
-
2713
- $custom_email_sections = array();
2714
-
2715
- // Add 'API Error' custom email section.
2716
- $custom_email_sections['api_error'] = array(
2717
- 'title' => 'API Error',
2718
- 'rows' => array(
2719
- 'ping' => array(
2720
- 'API Error',
2721
- is_string( $pong ) ? htmlentities( $pong ) : json_encode( $pong )
2722
- ),
2723
- )
2724
- );
2725
-
2726
- // Send email with technical details to resolve API connectivity issues.
2727
- $this->send_email(
2728
- 'api@freemius.com', // recipient
2729
- $title . ' [' . $this->get_plugin_name() . ']', // subject
2730
- $custom_email_sections,
2731
- array( "Reply-To: $admin_email <$admin_email>" ) // headers
2732
- );
2733
-
2734
- $this->_admin_notices->add_sticky(
2735
- sprintf(
2736
- $this->get_text_inline( 'Thank for giving us the chance to fix it! A message was just sent to our technical staff. We will get back to you as soon as we have an update to %s. Appreciate your patience.', 'fix-request-sent-message' ),
2737
- '<a href="mailto:' . $admin_email . '">' . $admin_email . '</a>'
2738
- ),
2739
- 'server_details_sent'
2740
- );
2741
-
2742
- // Action was taken, tell that API connectivity troubleshooting should be off now.
2743
-
2744
- echo "1";
2745
- exit;
2746
- }
2747
-
2748
- /**
2749
- * Handle connectivity test retry approved by the user.
2750
- *
2751
- * @author Vova Feldman (@svovaf)
2752
- * @since 1.1.7.4
2753
- */
2754
- function _retry_connectivity_test() {
2755
- $this->_admin_notices->remove_sticky( 'failed_connect_api_first' );
2756
-
2757
- $pong = $this->ping();
2758
-
2759
- $is_connected = $this->get_api_plugin_scope()->is_valid_ping( $pong );
2760
-
2761
- if ( $is_connected ) {
2762
- $this->store_connectivity_info( $pong, $is_connected );
2763
-
2764
- echo $this->get_after_plugin_activation_redirect_url();
2765
- } else {
2766
- // Add connectivity issue message after 2nd failed attempt.
2767
- $this->_add_connectivity_issue_message( $pong, false );
2768
-
2769
- echo "1";
2770
- }
2771
-
2772
- exit;
2773
- }
2774
-
2775
- static function _add_firewall_issues_javascript() {
2776
- $params = array();
2777
- fs_require_once_template( 'firewall-issues-js.php', $params );
2778
- }
2779
-
2780
- #endregion
2781
-
2782
- #----------------------------------------------------------------------------------
2783
- #region Email
2784
- #----------------------------------------------------------------------------------
2785
-
2786
- /**
2787
- * Generates and sends an HTML email with customizable sections.
2788
- *
2789
- * @author Leo Fajardo (@leorw)
2790
- * @since 1.1.2
2791
- *
2792
- * @param string $to_address
2793
- * @param string $subject
2794
- * @param array $sections
2795
- * @param array $headers
2796
- *
2797
- * @return bool Whether the email contents were sent successfully.
2798
- */
2799
- private function send_email(
2800
- $to_address,
2801
- $subject,
2802
- $sections = array(),
2803
- $headers = array()
2804
- ) {
2805
- $default_sections = $this->get_email_sections();
2806
-
2807
- // Insert new sections or replace the default email sections.
2808
- if ( is_array( $sections ) && ! empty( $sections ) ) {
2809
- foreach ( $sections as $section_id => $custom_section ) {
2810
- if ( ! isset( $default_sections[ $section_id ] ) ) {
2811
- // If the section does not exist, add it.
2812
- $default_sections[ $section_id ] = $custom_section;
2813
- } else {
2814
- // If the section already exists, override it.
2815
- $current_section = $default_sections[ $section_id ];
2816
-
2817
- // Replace the current section's title if a custom section title exists.
2818
- if ( isset( $custom_section['title'] ) ) {
2819
- $current_section['title'] = $custom_section['title'];
2820
- }
2821
-
2822
- // Insert new rows under the current section or replace the default rows.
2823
- if ( isset( $custom_section['rows'] ) && is_array( $custom_section['rows'] ) && ! empty( $custom_section['rows'] ) ) {
2824
- foreach ( $custom_section['rows'] as $row_id => $row ) {
2825
- $current_section['rows'][ $row_id ] = $row;
2826
- }
2827
- }
2828
-
2829
- $default_sections[ $section_id ] = $current_section;
2830
- }
2831
- }
2832
- }
2833
-
2834
- $vars = array( 'sections' => $default_sections );
2835
- $message = fs_get_template( 'email.php', $vars );
2836
-
2837
- // Set the type of email to HTML.
2838
- $headers[] = 'Content-type: text/html; charset=UTF-8';
2839
-
2840
- $header_string = implode( "\r\n", $headers );
2841
-
2842
- return wp_mail(
2843
- $to_address,
2844
- $subject,
2845
- $message,
2846
- $header_string
2847
- );
2848
- }
2849
-
2850
- /**
2851
- * Generates the data for the sections of the email content.
2852
- *
2853
- * @author Leo Fajardo (@leorw)
2854
- * @since 1.1.2
2855
- *
2856
- * @return array
2857
- */
2858
- private function get_email_sections() {
2859
- // Retrieve the current user's information so that we can get the user's email, first name, and last name below.
2860
- $current_user = self::_get_current_wp_user();
2861
-
2862
- // Retrieve the cURL version information so that we can get the version number below.
2863
- $curl_version_information = curl_version();
2864
-
2865
- $active_plugin = self::get_active_plugins();
2866
-
2867
- // Generate the list of active plugins separated by new line.
2868
- $active_plugin_string = '';
2869
- foreach ( $active_plugin as $plugin ) {
2870
- $active_plugin_string .= sprintf(
2871
- '<a href="%s">%s</a> [v%s]<br>',
2872
- $plugin['PluginURI'],
2873
- $plugin['Name'],
2874
- $plugin['Version']
2875
- );
2876
- }
2877
-
2878
- $server_ip = WP_FS__REMOTE_ADDR;
2879
-
2880
- // Add PHP info for deeper investigation.
2881
- ob_start();
2882
- phpinfo();
2883
- $php_info = ob_get_clean();
2884
-
2885
- $api_domain = substr( FS_API__ADDRESS, strpos( FS_API__ADDRESS, ':' ) + 3 );
2886
-
2887
- // Generate the default email sections.
2888
- $sections = array(
2889
- 'sdk' => array(
2890
- 'title' => 'SDK',
2891
- 'rows' => array(
2892
- 'fs_version' => array( 'FS Version', $this->version ),
2893
- 'curl_version' => array( 'cURL Version', $curl_version_information['version'] )
2894
- )
2895
- ),
2896
- 'plugin' => array(
2897
- 'title' => ucfirst( $this->get_module_type() ),
2898
- 'rows' => array(
2899
- 'name' => array( 'Name', $this->get_plugin_name() ),
2900
- 'version' => array( 'Version', $this->get_plugin_version() )
2901
- )
2902
- ),
2903
- 'api' => array(
2904
- 'title' => 'API Subdomain',
2905
- 'rows' => array(
2906
- 'dns' => array(
2907
- 'DNS_CNAME',
2908
- function_exists( 'dns_get_record' ) ?
2909
- var_export( dns_get_record( $api_domain, DNS_CNAME ), true ) :
2910
- 'dns_get_record() disabled/blocked'
2911
- ),
2912
- 'ip' => array(
2913
- 'IP',
2914
- function_exists( 'gethostbyname' ) ?
2915
- gethostbyname( $api_domain ) :
2916
- 'gethostbyname() disabled/blocked'
2917
- ),
2918
- ),
2919
- ),
2920
- 'site' => array(
2921
- 'title' => 'Site',
2922
- 'rows' => array(
2923
- 'unique_id' => array( 'Unique ID', $this->get_anonymous_id() ),
2924
- 'address' => array( 'Address', site_url() ),
2925
- 'host' => array(
2926
- 'HTTP_HOST',
2927
- ( ! empty( $_SERVER['HTTP_HOST'] ) ? $_SERVER['HTTP_HOST'] : '' )
2928
- ),
2929
- 'hosting' => array(
2930
- 'Hosting Company' => fs_request_has( 'hosting_company' ) ?
2931
- fs_request_get( 'hosting_company' ) :
2932
- 'Unknown',
2933
- ),
2934
- 'server_addr' => array(
2935
- 'SERVER_ADDR',
2936
- '<a href="http://www.projecthoneypot.org/ip_' . $server_ip . '">' . $server_ip . '</a>'
2937
- )
2938
- )
2939
- ),
2940
- 'user' => array(
2941
- 'title' => 'User',
2942
- 'rows' => array(
2943
- 'email' => array( 'Email', $current_user->user_email ),
2944
- 'first' => array( 'First', $current_user->user_firstname ),
2945
- 'last' => array( 'Last', $current_user->user_lastname )
2946
- )
2947
- ),
2948
- 'plugins' => array(
2949
- 'title' => 'Plugins',
2950
- 'rows' => array(
2951
- 'active_plugins' => array( 'Active Plugins', $active_plugin_string )
2952
- )
2953
- ),
2954
- 'php_info' => array(
2955
- 'title' => 'PHP Info',
2956
- 'rows' => array(
2957
- 'info' => array( $php_info )
2958
- ),
2959
- )
2960
- );
2961
-
2962
- // Allow the sections to be modified by other code.
2963
- $sections = $this->apply_filters( 'email_template_sections', $sections );
2964
-
2965
- return $sections;
2966
- }
2967
-
2968
- #endregion
2969
-
2970
- #----------------------------------------------------------------------------------
2971
- #region Initialization
2972
- #----------------------------------------------------------------------------------
2973
-
2974
- /**
2975
- * Init plugin's Freemius instance.
2976
- *
2977
- * @author Vova Feldman (@svovaf)
2978
- * @since 1.0.1
2979
- *
2980
- * @param number $id
2981
- * @param string $public_key
2982
- * @param bool $is_live
2983
- * @param bool $is_premium
2984
- */
2985
- function init( $id, $public_key, $is_live = true, $is_premium = true ) {
2986
- $this->_logger->entrance();
2987
-
2988
- $this->dynamic_init( array(
2989
- 'id' => $id,
2990
- 'public_key' => $public_key,
2991
- 'is_live' => $is_live,
2992
- 'is_premium' => $is_premium,
2993
- ) );
2994
- }
2995
-
2996
- /**
2997
- * Dynamic initiator, originally created to support initiation
2998
- * with parent_id for add-ons.
2999
- *
3000
- * @author Vova Feldman (@svovaf)
3001
- * @since 1.0.6
3002
- *
3003
- * @param array $plugin_info
3004
- *
3005
- * @throws Freemius_Exception
3006
- */
3007
- function dynamic_init( array $plugin_info ) {
3008
- $this->_logger->entrance();
3009
-
3010
- $this->parse_settings( $plugin_info );
3011
 
3012
- if ( ! self::is_ajax() ) {
3013
- if ( ! $this->is_addon() || $this->is_only_premium() ) {
3014
- add_action( 'admin_menu', array( &$this, '_prepare_admin_menu' ), WP_FS__LOWEST_PRIORITY );
3015
- }
 
3016
  }
3017
 
3018
- if ( $this->should_stop_execution() ) {
3019
- return;
3020
- }
3021
-
3022
- if ( ! $this->is_registered() ) {
3023
- if ( $this->is_anonymous() ) {
3024
- // If user skipped, no need to test connectivity.
3025
- $this->_has_api_connection = true;
3026
- $this->_is_on = true;
3027
- } else {
3028
- if ( ! $this->has_api_connectivity() ) {
3029
- if ( $this->_admin_notices->has_sticky( 'failed_connect_api_first' ) ||
3030
- $this->_admin_notices->has_sticky( 'failed_connect_api' )
3031
- ) {
3032
- if ( ! $this->_enable_anonymous || $this->is_premium() ) {
3033
- // If anonymous mode is disabled, add firewall admin-notice message.
3034
- add_action( 'admin_footer', array( 'Freemius', '_add_firewall_issues_javascript' ) );
3035
-
3036
- $this->add_ajax_action( 'resolve_firewall_issues', array(
3037
- &$this,
3038
- '_email_about_firewall_issue'
3039
- ) );
3040
-
3041
- $this->add_ajax_action( 'retry_connectivity_test', array(
3042
- &$this,
3043
- '_retry_connectivity_test'
3044
- ) );
3045
- }
3046
- }
3047
-
3048
- return;
3049
- } else {
3050
- $this->_admin_notices->remove_sticky( array(
3051
- 'failed_connect_api_first',
3052
- 'failed_connect_api',
3053
- ) );
3054
-
3055
- if ( $this->_anonymous_mode ) {
3056
- // Simulate anonymous mode.
3057
- $this->_is_anonymous = true;
3058
- }
3059
- }
3060
- }
3061
-
3062
- // Check if Freemius is on for the current plugin.
3063
- // This MUST be executed after all the plugin variables has been loaded.
3064
- if ( ! $this->is_on() ) {
3065
- return;
3066
- }
3067
- }
3068
-
3069
- if ( $this->has_api_connectivity() ) {
3070
- if ( self::is_cron() ) {
3071
- $this->hook_callback_to_sync_cron();
3072
- } else if ( $this->is_user_in_admin() ) {
3073
- /**
3074
- * Schedule daily data sync cron if:
3075
- *
3076
- * 1. User opted-in (for tracking).
3077
- * 2. If skipped, but later upgraded (opted-in via upgrade).
3078
- *
3079
- * @author Vova Feldman (@svovaf)
3080
- * @since 1.1.7.3
3081
- *
3082
- */
3083
- if ( $this->is_registered() ) {
3084
- if ( ! $this->is_sync_cron_on() && $this->is_tracking_allowed() ) {
3085
- $this->schedule_sync_cron();
3086
- }
3087
- }
3088
-
3089
- /**
3090
- * Check if requested for manual blocking background sync.
3091
- */
3092
- if ( fs_request_has( 'background_sync' ) ) {
3093
- $this->run_manual_sync();
3094
- }
3095
- }
3096
- }
3097
-
3098
- if ( $this->is_registered() ) {
3099
- $this->hook_callback_to_install_sync();
3100
- }
3101
-
3102
- if ( $this->is_addon() ) {
3103
- if ( $this->is_parent_plugin_installed() ) {
3104
- // Link to parent FS.
3105
- $this->_parent = self::get_instance_by_id( $this->_plugin->parent_plugin_id );
3106
-
3107
- // Get parent plugin reference.
3108
- $this->_parent_plugin = $this->_parent->get_plugin();
3109
- }
3110
- }
3111
-
3112
- if ( $this->is_user_in_admin() ) {
3113
- if ( self::is_plugins_page() && $this->is_plugin() ) {
3114
- $this->hook_plugin_action_links();
3115
- }
3116
-
3117
- if ( $this->is_addon() ) {
3118
- if ( ! $this->is_parent_plugin_installed() ) {
3119
- $parent_name = $this->get_option( $plugin_info, 'parent_name', null );
3120
-
3121
- if ( isset( $plugin_info['parent'] ) ) {
3122
- $parent_name = $this->get_option( $plugin_info['parent'], 'name', null );
3123
- }
3124
-
3125
- $this->_admin_notices->add(
3126
- ( ! empty( $parent_name ) ?
3127
- sprintf( $this->get_text_x_inline( '%s cannot run without %s.', 'addonX cannot run without pluginY', 'addon-x-cannot-run-without-y' ), $this->get_plugin_name(), $parent_name ) :
3128
- sprintf( $this->get_text_x_inline( '%s cannot run without the plugin.', 'addonX cannot run...', 'addon-x-cannot-run-without-parent' ), $this->get_plugin_name() )
3129
- ),
3130
- $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
3131
- 'error'
3132
- );
3133
-
3134
- return;
3135
- } else {
3136
- if ( $this->_parent->is_registered() && ! $this->is_registered() ) {
3137
- // If parent plugin activated, automatically install add-on for the user.
3138
- $this->_activate_addon_account( $this->_parent );
3139
- } else if ( ! $this->_parent->is_registered() && $this->is_registered() ) {
3140
- // If add-on activated and parent not, automatically install parent for the user.
3141
- $this->activate_parent_account( $this->_parent );
3142
- }
3143
-
3144
- // @todo This should be only executed on activation. It should be migrated to register_activation_hook() together with other activation related logic.
3145
- if ( $this->is_premium() ) {
3146
- // Remove add-on download admin-notice.
3147
- $this->_parent->_admin_notices->remove_sticky( array(
3148
- 'addon_plan_upgraded_' . $this->_slug,
3149
- 'no_addon_license_' . $this->_slug,
3150
- ) );
3151
- }
3152
 
3153
- // $this->deactivate_premium_only_addon_without_license();
3154
- }
3155
- } else {
3156
- if ( $this->has_addons() &&
3157
- 'plugin-information' === fs_request_get( 'tab', false ) &&
3158
- $this->get_id() == fs_request_get( 'parent_plugin_id', false )
3159
- ) {
3160
- require_once WP_FS__DIR_INCLUDES . '/fs-plugin-info-dialog.php';
3161
 
3162
- new FS_Plugin_Info_Dialog( $this );
3163
- }
3164
- }
3165
 
3166
- add_action( 'admin_init', array( &$this, '_admin_init_action' ) );
 
3167
 
3168
- // if ( $this->is_registered() ||
3169
- // $this->is_anonymous() ||
3170
- // $this->is_pending_activation()
3171
- // ) {
3172
- // $this->_init_admin();
3173
- // }
3174
- }
3175
-
3176
- /**
3177
- * Should be called outside `$this->is_user_in_admin()` scope
3178
- * because the updater has some logic that needs to be executed
3179
- * during AJAX calls.
3180
- *
3181
- * Currently we need to hook to the `http_request_host_is_external` filter.
3182
- * In the future, there might be additional logic added.
3183
- *
3184
- * @author Vova Feldman
3185
- * @since 1.2.1.6
3186
- */
3187
- if ( $this->is_premium() && $this->has_release_on_freemius() ) {
3188
- new FS_Plugin_Updater( $this );
3189
- }
3190
-
3191
- $this->do_action( 'initiated' );
3192
-
3193
- if ( $this->_storage->prev_is_premium !== $this->_plugin->is_premium ) {
3194
- if ( isset( $this->_storage->prev_is_premium ) ) {
3195
- $this->apply_filters(
3196
- 'after_code_type_change',
3197
- // New code type.
3198
- $this->_plugin->is_premium
3199
- );
3200
- } else {
3201
- // Set for code type for the first time.
3202
- $this->_storage->prev_is_premium = $this->_plugin->is_premium;
3203
- }
3204
- }
3205
-
3206
- if ( ! $this->is_addon() ) {
3207
- if ( $this->is_registered() ) {
3208
- // Fix for upgrade from versions < 1.0.9.
3209
- if ( ! isset( $this->_storage->activation_timestamp ) ) {
3210
- $this->_storage->activation_timestamp = WP_FS__SCRIPT_START_TIME;
3211
- }
3212
-
3213
- $this->do_action( 'after_init_plugin_registered' );
3214
- } else if ( $this->is_anonymous() ) {
3215
- $this->do_action( 'after_init_plugin_anonymous' );
3216
- } else if ( $this->is_pending_activation() ) {
3217
- $this->do_action( 'after_init_plugin_pending_activations' );
3218
- }
3219
- } else {
3220
- if ( $this->is_registered() ) {
3221
- $this->do_action( 'after_init_addon_registered' );
3222
- } else if ( $this->is_anonymous() ) {
3223
- $this->do_action( 'after_init_addon_anonymous' );
3224
- } else if ( $this->is_pending_activation() ) {
3225
- $this->do_action( 'after_init_addon_pending_activations' );
3226
- }
3227
- }
3228
- }
3229
-
3230
- /**
3231
- * @author Leo Fajardo (@leorw)
3232
- *
3233
- * @since 1.2.1.5
3234
- */
3235
- function _stop_tracking_callback() {
3236
- $this->_logger->entrance();
3237
-
3238
- $this->check_ajax_referer( 'stop_tracking' );
3239
-
3240
- $result = $this->stop_tracking();
3241
-
3242
- if ( true === $result ) {
3243
- self::shoot_ajax_success();
3244
- }
3245
-
3246
- $this->_logger->api_error( $result );
3247
-
3248
- self::shoot_ajax_failure(
3249
- sprintf( $this->get_text_inline( 'Unexpected API error. Please contact the %s\'s author with the following error.', 'unexpected-api-error' ), $this->_module_type ) .
3250
- ( $this->is_api_error( $result ) && isset( $result->error ) ?
3251
- $result->error->message :
3252
- var_export( $result, true ) )
3253
- );
3254
- }
3255
-
3256
- /**
3257
- * @author Leo Fajardo (@leorw)
3258
- * @since 1.2.1.5
3259
- */
3260
- function _allow_tracking_callback() {
3261
- $this->_logger->entrance();
3262
-
3263
- $this->check_ajax_referer( 'allow_tracking' );
3264
-
3265
- $result = $this->allow_tracking();
3266
-
3267
- if ( true === $result ) {
3268
- self::shoot_ajax_success();
3269
- }
3270
-
3271
- $this->_logger->api_error( $result );
3272
-
3273
- self::shoot_ajax_failure(
3274
- sprintf( $this->get_text_inline( 'Unexpected API error. Please contact the %s\'s author with the following error.', 'unexpected-api-error' ), $this->_module_type ) .
3275
- ( $this->is_api_error( $result ) && isset( $result->error ) ?
3276
- $result->error->message :
3277
- var_export( $result, true ) )
3278
- );
3279
- }
3280
-
3281
- /**
3282
- * Opt-out from usage tracking.
3283
- *
3284
- * Note: This will not delete the account information but will stop all tracking.
3285
- *
3286
- * Returns:
3287
- * 1. FALSE - If the user never opted-in.
3288
- * 2. TRUE - If successfully opted-out.
3289
- * 3. object - API result on failure.
3290
- *
3291
- * @author Leo Fajardo (@leorw)
3292
- * @since 1.2.1.5
3293
- *
3294
- * @return bool|object
3295
- */
3296
- function stop_tracking() {
3297
- $this->_logger->entrance();
3298
-
3299
- if ( ! $this->is_registered() ) {
3300
- // User never opted-in.
3301
- return false;
3302
- }
3303
-
3304
- if ( $this->is_tracking_prohibited() ) {
3305
- // Already disconnected.
3306
- return true;
3307
- }
3308
-
3309
- // Send update to FS.
3310
- $result = $this->get_api_site_scope()->call( '/?fields=is_disconnected', 'put', array(
3311
- 'is_disconnected' => true
3312
- ) );
3313
-
3314
- if ( ! $this->is_api_result_entity( $result ) ||
3315
- ! isset( $result->is_disconnected ) ||
3316
- ! $result->is_disconnected
3317
- ) {
3318
- $this->_logger->api_error( $result );
3319
-
3320
- return $result;
3321
- }
3322
-
3323
- $this->_site->is_disconnected = $result->is_disconnected;
3324
- $this->_store_site();
3325
-
3326
- $this->clear_sync_cron();
3327
-
3328
- // Successfully disconnected.
3329
- return true;
3330
- }
3331
-
3332
- /**
3333
- * Opt-in back into usage tracking.
3334
- *
3335
- * Note: This will only work if the user opted-in previously.
3336
- *
3337
- * Returns:
3338
- * 1. FALSE - If the user never opted-in.
3339
- * 2. TRUE - If successfully opted-in back to usage tracking.
3340
- * 3. object - API result on failure.
3341
- *
3342
- * @author Leo Fajardo (@leorw)
3343
- * @since 1.2.1.5
3344
- *
3345
- * @return bool|object
3346
- */
3347
- function allow_tracking() {
3348
- $this->_logger->entrance();
3349
-
3350
- if ( ! $this->is_registered() ) {
3351
- // User never opted-in.
3352
- return false;
3353
- }
3354
-
3355
- if ( $this->is_tracking_allowed() ) {
3356
- // Tracking already allowed.
3357
- return true;
3358
- }
3359
-
3360
- $result = $this->get_api_site_scope()->call( '/?is_disconnected', 'put', array(
3361
- 'is_disconnected' => false
3362
- ) );
3363
-
3364
- if ( ! $this->is_api_result_entity( $result ) ||
3365
- ! isset( $result->is_disconnected ) ||
3366
- $result->is_disconnected
3367
- ) {
3368
- $this->_logger->api_error( $result );
3369
-
3370
- return $result;
3371
- }
3372
-
3373
- $this->_site->is_disconnected = $result->is_disconnected;
3374
- $this->_store_site();
3375
-
3376
- $this->schedule_sync_cron();
3377
-
3378
- // Successfully reconnected.
3379
- return true;
3380
- }
3381
-
3382
- /**
3383
- * If user opted-in and later disabled usage-tracking,
3384
- * re-allow tracking for licensing and updates.
3385
- *
3386
- * @author Leo Fajardo (@leorw)
3387
- *
3388
- * @since 1.2.1.5
3389
- */
3390
- private function reconnect_locally() {
3391
- $this->_logger->entrance();
3392
-
3393
- if ( $this->is_tracking_prohibited() &&
3394
- $this->is_registered()
3395
- ) {
3396
- $this->_site->is_disconnected = false;
3397
- $this->_store_site();
3398
- }
3399
- }
3400
-
3401
- /**
3402
- * Parse plugin's settings (as defined by the plugin dev).
3403
- *
3404
- * @author Vova Feldman (@svovaf)
3405
- * @since 1.1.7.3
3406
- *
3407
- * @param array $plugin_info
3408
- *
3409
- * @throws \Freemius_Exception
3410
- */
3411
- private function parse_settings( &$plugin_info ) {
3412
- $this->_logger->entrance();
3413
-
3414
- $id = $this->get_numeric_option( $plugin_info, 'id', false );
3415
- $public_key = $this->get_option( $plugin_info, 'public_key', false );
3416
- $secret_key = $this->get_option( $plugin_info, 'secret_key', null );
3417
- $parent_id = $this->get_numeric_option( $plugin_info, 'parent_id', null );
3418
- $parent_name = $this->get_option( $plugin_info, 'parent_name', null );
3419
-
3420
- /**
3421
- * @author Vova Feldman (@svovaf)
3422
- * @since 1.1.9 Try to pull secret key from external config.
3423
- */
3424
- if ( is_null( $secret_key ) && defined( "WP_FS__{$this->_slug}_SECRET_KEY" ) ) {
3425
- $secret_key = constant( "WP_FS__{$this->_slug}_SECRET_KEY" );
3426
- }
3427
 
3428
- if ( isset( $plugin_info['parent'] ) ) {
3429
- $parent_id = $this->get_numeric_option( $plugin_info['parent'], 'id', null );
3430
- // $parent_slug = $this->get_option( $plugin_info['parent'], 'slug', null );
3431
- // $parent_public_key = $this->get_option( $plugin_info['parent'], 'public_key', null );
3432
- // $parent_name = $this->get_option( $plugin_info['parent'], 'name', null );
3433
- }
3434
-
3435
- if ( false === $id ) {
3436
- throw new Freemius_Exception( array(
3437
- 'error' => array(
3438
- 'type' => 'ParameterNotSet',
3439
- 'message' => 'Plugin id parameter is not set.',
3440
- 'code' => 'plugin_id_not_set',
3441
- 'http' => 500,
3442
- )
3443
- ) );
3444
- }
3445
- if ( false === $public_key ) {
3446
- throw new Freemius_Exception( array(
3447
- 'error' => array(
3448
- 'type' => 'ParameterNotSet',
3449
- 'message' => 'Plugin public_key parameter is not set.',
3450
- 'code' => 'plugin_public_key_not_set',
3451
- 'http' => 500,
3452
- )
3453
- ) );
3454
- }
3455
-
3456
- $plugin = ( $this->_plugin instanceof FS_Plugin ) ?
3457
- $this->_plugin :
3458
- new FS_Plugin();
3459
-
3460
- $plugin->update( array(
3461
- 'id' => $id,
3462
- 'type' => $this->get_option( $plugin_info, 'type', $this->_module_type),
3463
- 'public_key' => $public_key,
3464
- 'slug' => $this->_slug,
3465
- 'parent_plugin_id' => $parent_id,
3466
- 'version' => $this->get_plugin_version(),
3467
- 'title' => $this->get_plugin_name(),
3468
- 'file' => $this->_plugin_basename,
3469
- 'is_premium' => $this->get_bool_option( $plugin_info, 'is_premium', true ),
3470
- 'is_live' => $this->get_bool_option( $plugin_info, 'is_live', true ),
3471
- 'affiliate_moderation' => $this->get_option( $plugin_info, 'has_affiliation' ),
3472
- ) );
3473
-
3474
- if ( $plugin->is_updated() ) {
3475
- // Update plugin details.
3476
- $this->_plugin = FS_Plugin_Manager::instance( $this->_module_id )->store( $plugin );
3477
- }
3478
- // Set the secret key after storing the plugin, we don't want to store the key in the storage.
3479
- $this->_plugin->secret_key = $secret_key;
3480
-
3481
- if ( ! isset( $plugin_info['menu'] ) ) {
3482
- $plugin_info['menu'] = array();
3483
-
3484
- if ( ! empty( $this->_storage->sdk_last_version ) &&
3485
- version_compare( $this->_storage->sdk_last_version, '1.1.2', '<=' )
3486
- ) {
3487
- // Backward compatibility to 1.1.2
3488
- $plugin_info['menu']['slug'] = isset( $plugin_info['menu_slug'] ) ?
3489
- $plugin_info['menu_slug'] :
3490
- $this->_slug;
3491
- }
3492
- }
3493
-
3494
- $this->_menu = FS_Admin_Menu_Manager::instance(
3495
- $this->_module_id,
3496
- $this->_module_type,
3497
- $this->get_unique_affix()
3498
- );
3499
-
3500
- $this->_menu->init( $plugin_info['menu'], $this->is_addon() );
3501
-
3502
- $this->_has_addons = $this->get_bool_option( $plugin_info, 'has_addons', false );
3503
- $this->_has_paid_plans = $this->get_bool_option( $plugin_info, 'has_paid_plans', true );
3504
- $this->_has_premium_version = $this->get_bool_option( $plugin_info, 'has_premium_version', $this->_has_paid_plans );
3505
- $this->_ignore_pending_mode = $this->get_bool_option( $plugin_info, 'ignore_pending_mode', false );
3506
- $this->_is_org_compliant = $this->get_bool_option( $plugin_info, 'is_org_compliant', true );
3507
- $this->_is_premium_only = $this->get_bool_option( $plugin_info, 'is_premium_only', false );
3508
- if ( $this->_is_premium_only ) {
3509
- // If premium only plugin, disable anonymous mode.
3510
- $this->_enable_anonymous = false;
3511
- $this->_anonymous_mode = false;
3512
- } else {
3513
- $this->_enable_anonymous = $this->get_bool_option( $plugin_info, 'enable_anonymous', true );
3514
- $this->_anonymous_mode = $this->get_bool_option( $plugin_info, 'anonymous_mode', false );
3515
- }
3516
- $this->_permissions = $this->get_option( $plugin_info, 'permissions', array() );
3517
-
3518
- if ( ! empty( $plugin_info['trial'] ) ) {
3519
- $this->_trial_days = $this->get_numeric_option(
3520
- $plugin_info['trial'],
3521
- 'days',
3522
- // Default to 0 - trial without days specification.
3523
- 0
3524
- );
3525
-
3526
- $this->_is_trial_require_payment = $this->get_bool_option( $plugin_info['trial'], 'is_require_payment', false );
3527
- }
3528
- }
3529
-
3530
- /**
3531
- * @param string[] $options
3532
- * @param string $key
3533
- * @param mixed $default
3534
- *
3535
- * @return bool
3536
- */
3537
- private function get_option( &$options, $key, $default = false ) {
3538
- return ! empty( $options[ $key ] ) ? $options[ $key ] : $default;
3539
- }
3540
-
3541
- private function get_bool_option( &$options, $key, $default = false ) {
3542
- return isset( $options[ $key ] ) && is_bool( $options[ $key ] ) ? $options[ $key ] : $default;
3543
- }
3544
-
3545
- private function get_numeric_option( &$options, $key, $default = false ) {
3546
- return isset( $options[ $key ] ) && is_numeric( $options[ $key ] ) ? $options[ $key ] : $default;
3547
- }
3548
-
3549
- /**
3550
- * Gate keeper.
3551
- *
3552
- * @author Vova Feldman (@svovaf)
3553
- * @since 1.1.7.3
3554
- *
3555
- * @return bool
3556
- */
3557
- private function should_stop_execution() {
3558
- if ( empty( $this->_storage->was_plugin_loaded ) ) {
3559
- /**
3560
- * Don't execute Freemius until plugin was fully loaded at least once,
3561
- * to give the opportunity for the activation hook to run before pinging
3562
- * the API for connectivity test. This logic is relevant for the
3563
- * identification of new plugin install vs. plugin update.
3564
- *
3565
- * @author Vova Feldman (@svovaf)
3566
- * @since 1.1.9
3567
- */
3568
- return true;
3569
- }
3570
-
3571
- if ( $this->is_activation_mode() ) {
3572
- if ( ! is_admin() ) {
3573
- /**
3574
- * If in activation mode, don't execute Freemius outside of the
3575
- * admin dashboard.
3576
- *
3577
- * @author Vova Feldman (@svovaf)
3578
- * @since 1.1.7.3
3579
- */
3580
- return true;
3581
- }
3582
-
3583
- if ( ! WP_FS__IS_HTTP_REQUEST ) {
3584
- /**
3585
- * If in activation and executed without HTTP context (e.g. CLI, Cronjob),
3586
- * then don't start Freemius.
3587
- *
3588
- * @author Vova Feldman (@svovaf)
3589
- * @since 1.1.6.3
3590
- *
3591
- * @link https://wordpress.org/support/topic/errors-in-the-freemius-class-when-running-in-wordpress-in-cli
3592
- */
3593
- return true;
3594
- }
3595
-
3596
- if ( self::is_cron() ) {
3597
- /**
3598
- * If in activation mode, don't execute Freemius during wp crons
3599
- * (wp crons have HTTP context - called as HTTP request).
3600
- *
3601
- * @author Vova Feldman (@svovaf)
3602
- * @since 1.1.7.3
3603
- */
3604
- return true;
3605
- }
3606
-
3607
- if ( self::is_ajax() &&
3608
- ! $this->_admin_notices->has_sticky( 'failed_connect_api_first' ) &&
3609
- ! $this->_admin_notices->has_sticky( 'failed_connect_api' )
3610
- ) {
3611
- /**
3612
- * During activation, if running in AJAX mode, unless there's a sticky
3613
- * connectivity issue notice, don't run Freemius.
3614
- *
3615
- * @author Vova Feldman (@svovaf)
3616
- * @since 1.1.7.3
3617
- */
3618
- return true;
3619
- }
3620
- }
3621
-
3622
- return false;
3623
- }
3624
-
3625
- /**
3626
- * Triggered after code type has changed.
3627
- *
3628
- * @author Vova Feldman (@svovaf)
3629
- * @since 1.1.9.1
3630
- */
3631
- function _after_code_type_change() {
3632
- $this->_logger->entrance();
3633
-
3634
- if ( $this->is_theme() ) {
3635
- // Expire the cache of the previous tabs since the theme may
3636
- // have setting updates after code type has changed.
3637
- $this->_cache->expire( 'tabs' );
3638
- $this->_cache->expire( 'tabs_stylesheets' );
3639
- }
3640
-
3641
- if ( $this->is_registered() ) {
3642
- if ( ! $this->is_addon() ) {
3643
- add_action(
3644
- is_admin() ? 'admin_init' : 'init',
3645
- array( &$this, '_plugin_code_type_changed' )
3646
- );
3647
- }
3648
-
3649
- if ( $this->is_premium() ) {
3650
- // Purge cached payments after switching to the premium version.
3651
- // @todo This logic doesn't handle purging the cache for serviceware module upgrade.
3652
- $this->get_api_user_scope()->purge_cache( "/plugins/{$this->_module_id}/payments.json?include_addons=true" );
3653
- }
3654
- }
3655
- }
3656
-
3657
- /**
3658
- * Handles plugin's code type change (free <--> premium).
3659
- *
3660
- * @author Vova Feldman (@svovaf)
3661
- * @since 1.0.9
3662
- */
3663
- function _plugin_code_type_changed() {
3664
- $this->_logger->entrance();
3665
-
3666
- if ( $this->is_premium() ) {
3667
- $this->reconnect_locally();
3668
-
3669
- // Activated premium code.
3670
- $this->do_action( 'after_premium_version_activation' );
3671
-
3672
- // Remove all sticky messages related to download of the premium version.
3673
- $this->_admin_notices->remove_sticky( array(
3674
- 'trial_started',
3675
- 'plan_upgraded',
3676
- 'plan_changed',
3677
- 'license_activated',
3678
- ) );
3679
-
3680
- if ( ! $this->is_only_premium() ) {
3681
- $this->_admin_notices->add_sticky(
3682
- sprintf( $this->get_text_inline( 'Premium %s version was successfully activated.', 'premium-activated-message' ), $this->_module_type ),
3683
- 'premium_activated',
3684
- $this->get_text_x_inline( 'W00t',
3685
- 'Used to express elation, enthusiasm, or triumph (especially in electronic communication).', 'woot' ) . '!'
3686
- );
3687
- }
3688
- } else {
3689
- // Remove sticky message related to premium code activation.
3690
- $this->_admin_notices->remove_sticky( 'premium_activated' );
3691
-
3692
- // Activated free code (after had the premium before).
3693
- $this->do_action( 'after_free_version_reactivation' );
3694
-
3695
- if ( $this->is_paying() && ! $this->is_premium() ) {
3696
- $this->_admin_notices->add_sticky(
3697
- sprintf(
3698
- /* translators: %s: License type (e.g. you have a professional license) */
3699
- $this->get_text_inline( 'You have a %s license.', 'you-have-x-license' ),
3700
- $this->_site->plan->title
3701
- ) . $this->get_complete_upgrade_instructions(),
3702
- 'plan_upgraded',
3703
- $this->get_text_x_inline( 'Yee-haw', 'interjection expressing joy or exuberance', 'yee-haw' ) . '!'
3704
- );
3705
- }
3706
- }
3707
-
3708
- // Schedule code type changes event.
3709
- $this->schedule_install_sync();
3710
-
3711
- /**
3712
- * Unregister the uninstall hook for the other version of the plugin (with different code type) to avoid
3713
- * triggering a fatal error when uninstalling that plugin. For example, after deactivating the "free" version
3714
- * of a specific plugin, its uninstall hook should be unregistered after the "premium" version has been
3715
- * activated. If we don't do that, a fatal error will occur when we try to uninstall the "free" version since
3716
- * the main file of the "free" version will be loaded first before calling the hooked callback. Since the
3717
- * free and premium versions are almost identical (same class or have same functions), a fatal error like
3718
- * "Cannot redeclare class MyClass" or "Cannot redeclare my_function()" will occur.
3719
- */
3720
- $this->unregister_uninstall_hook();
3721
-
3722
- $this->clear_module_main_file_cache();
3723
-
3724
- // Update is_premium of latest version.
3725
- $this->_storage->prev_is_premium = $this->_plugin->is_premium;
3726
- }
3727
-
3728
- #endregion
3729
-
3730
- #----------------------------------------------------------------------------------
3731
- #region Add-ons
3732
- #----------------------------------------------------------------------------------
3733
-
3734
- /**
3735
- * Check if add-on installed and activated on site.
3736
- *
3737
- * @author Vova Feldman (@svovaf)
3738
- * @since 1.0.6
3739
- *
3740
- * @param string|number $id_or_slug
3741
- * @param bool|null $is_premium Since 1.2.1.7 can check for specified add-on version.
3742
- *
3743
- * @return bool
3744
- */
3745
- function is_addon_activated( $id_or_slug, $is_premium = null ) {
3746
- $this->_logger->entrance();
3747
-
3748
- $addon_id = self::get_module_id( $id_or_slug );
3749
- $is_activated = self::has_instance( $addon_id );
3750
-
3751
- if ( ! $is_activated ) {
3752
- return false;
3753
- }
3754
-
3755
- if ( is_bool( $is_premium ) ) {
3756
- // Check if the specified code version is activate.
3757
- $addon = $this->get_addon_instance( $addon_id );
3758
- $is_activated = ( $is_premium === $addon->is_premium() );
3759
- }
3760
-
3761
- return $is_activated;
3762
- }
3763
-
3764
- /**
3765
- * Check if add-on was connected to install
3766
- *
3767
- * @author Vova Feldman (@svovaf)
3768
- * @since 1.1.7
3769
- *
3770
- * @param string|number $id_or_slug
3771
- *
3772
- * @return bool
3773
- */
3774
- function is_addon_connected( $id_or_slug ) {
3775
- $this->_logger->entrance();
3776
-
3777
- $sites = self::get_all_sites( WP_FS__MODULE_TYPE_PLUGIN );
3778
-
3779
- $addon_id = self::get_module_id( $id_or_slug );
3780
- $addon = $this->get_addon( $addon_id );
3781
- $slug = $addon->slug;
3782
- if ( ! isset( $sites[ $slug ] ) ) {
3783
- return false;
3784
- }
3785
-
3786
- $site = $sites[ $slug ];
3787
-
3788
- $plugin = FS_Plugin_Manager::instance( $addon_id )->get();
3789
-
3790
- if ( $plugin->parent_plugin_id != $this->_plugin->id ) {
3791
- // The given slug do NOT belong to any of the plugin's add-ons.
3792
- return false;
3793
- }
3794
-
3795
- return ( is_object( $site ) &&
3796
- is_numeric( $site->id ) &&
3797
- is_numeric( $site->user_id ) &&
3798
- is_object( $site->plan )
3799
- );
3800
- }
3801
-
3802
- /**
3803
- * Determines if add-on installed.
3804
- *
3805
- * NOTE: This is a heuristic and only works if the folder/file named as the slug.
3806
- *
3807
- * @author Vova Feldman (@svovaf)
3808
- * @since 1.0.6
3809
- *
3810
- * @param string|number $id_or_slug
3811
- *
3812
- * @return bool
3813
- */
3814
- function is_addon_installed( $id_or_slug ) {
3815
- $this->_logger->entrance();
3816
-
3817
- $addon_id = self::get_module_id( $id_or_slug );
3818
-
3819
- return file_exists( fs_normalize_path( WP_PLUGIN_DIR . '/' . $this->get_addon_basename( $addon_id ) ) );
3820
- }
3821
-
3822
- /**
3823
- * Get add-on basename.
3824
- *
3825
- * @author Vova Feldman (@svovaf)
3826
- * @since 1.0.6
3827
- *
3828
- * @param string|number $id_or_slug
3829
- *
3830
- * @return string
3831
- */
3832
- function get_addon_basename( $id_or_slug ) {
3833
- $addon_id = self::get_module_id( $id_or_slug );
3834
-
3835
- if ( $this->is_addon_activated( $addon_id ) ) {
3836
- return self::instance( $addon_id )->get_plugin_basename();
3837
- }
3838
-
3839
- $addon = $this->get_addon( $addon_id );
3840
- $premium_basename = "{$addon->slug}-premium/{$addon->slug}.php";
3841
-
3842
- if ( file_exists( fs_normalize_path( WP_PLUGIN_DIR . '/' . $premium_basename ) ) ) {
3843
- return $premium_basename;
3844
- }
3845
-
3846
- $all_plugins = $this->get_all_plugins();
3847
-
3848
- foreach ( $all_plugins as $basename => &$data ) {
3849
- if ( $addon->slug === $data['slug'] ||
3850
- $addon->slug . '-premium' === $data['slug']
3851
- ) {
3852
- return $basename;
3853
- }
3854
- }
3855
-
3856
- $free_basename = "{$addon->slug}/{$addon->slug}.php";
3857
-
3858
- return $free_basename;
3859
- }
3860
-
3861
- /**
3862
- * Get installed add-ons instances.
3863
- *
3864
- * @author Vova Feldman (@svovaf)
3865
- * @since 1.0.6
3866
- *
3867
- * @return Freemius[]
3868
- */
3869
- function get_installed_addons() {
3870
- $installed_addons = array();
3871
- foreach ( self::$_instances as $instance ) {
3872
- if ( $instance->is_addon() && is_object( $instance->_parent_plugin ) ) {
3873
- if ( $this->_plugin->id == $instance->_parent_plugin->id ) {
3874
- $installed_addons[] = $instance;
3875
- }
3876
- }
3877
- }
3878
-
3879
- return $installed_addons;
3880
- }
3881
-
3882
- /**
3883
- * Check if any add-ons of the plugin are installed.
3884
- *
3885
- * @author Leo Fajardo (@leorw)
3886
- * @since 1.1.1
3887
- *
3888
- * @return bool
3889
- */
3890
- function has_installed_addons() {
3891
- if ( ! $this->has_addons() ) {
3892
- return false;
3893
- }
3894
-
3895
- foreach ( self::$_instances as $instance ) {
3896
- if ( $instance->is_addon() && is_object( $instance->_parent_plugin ) ) {
3897
- if ( $this->_plugin->id == $instance->_parent_plugin->id ) {
3898
- return true;
3899
- }
3900
- }
3901
- }
3902
-
3903
- return false;
3904
- }
3905
-
3906
- /**
3907
- * Tell Freemius that the current plugin is an add-on.
3908
- *
3909
- * @author Vova Feldman (@svovaf)
3910
- * @since 1.0.6
3911
- *
3912
- * @param number $parent_plugin_id The parent plugin ID
3913
- */
3914
- function init_addon( $parent_plugin_id ) {
3915
- $this->_plugin->parent_plugin_id = $parent_plugin_id;
3916
- }
3917
-
3918
- /**
3919
- * @author Vova Feldman (@svovaf)
3920
- * @since 1.0.6
3921
- *
3922
- * @return bool
3923
- */
3924
- function is_addon() {
3925
- return isset( $this->_plugin->parent_plugin_id ) && is_numeric( $this->_plugin->parent_plugin_id );
3926
- }
3927
-
3928
- /**
3929
- * Deactivate add-on if it's premium only and the user does't have a valid license.
3930
- *
3931
- * @param bool $is_after_trial_cancel
3932
- *
3933
- * @return bool If add-on was deactivated.
3934
- */
3935
- private function deactivate_premium_only_addon_without_license( $is_after_trial_cancel = false ) {
3936
- if ( ! $this->has_free_plan() &&
3937
- ! $this->has_features_enabled_license() &&
3938
- ! $this->_has_premium_license()
3939
- ) {
3940
- if ( $this->is_registered() ) {
3941
- // IF wrapper is turned off because activation_timestamp is currently only stored for plugins (not addons).
3942
- // if (empty($this->_storage->activation_timestamp) ||
3943
- // (WP_FS__SCRIPT_START_TIME - $this->_storage->activation_timestamp) > 30
3944
- // ) {
3945
- /**
3946
- * @todo When it's first fail, there's no reason to try and re-sync because the licenses were just synced after initial activation.
3947
- *
3948
- * Retry syncing the user add-on licenses.
3949
- */
3950
- // Sync licenses.
3951
- $this->_sync_licenses();
3952
- // }
3953
-
3954
- // Try to activate premium license.
3955
- $this->_activate_license( true );
3956
- }
3957
-
3958
- if ( ! $this->has_free_plan() &&
3959
- ! $this->has_features_enabled_license() &&
3960
- ! $this->_has_premium_license()
3961
- ) {
3962
- // @todo Check if deactivate plugins also call the deactivation hook.
3963
-
3964
- $this->_parent->_admin_notices->add_sticky(
3965
- sprintf(
3966
- ($is_after_trial_cancel ?
3967
- $this->_parent->get_text_inline(
3968
- '%s free trial was successfully cancelled. Since the add-on is premium only it was automatically deactivated. If you like to use it in the future, you\'ll have to purchase a license.',
3969
- 'addon-trial-cancelled-message'
3970
- ) :
3971
- $this->_parent->get_text_inline(
3972
- '%s is a premium only add-on. You have to purchase a license first before activating the plugin.',
3973
- 'addon-no-license-message'
3974
- )
3975
- ),
3976
- '<b>' . $this->_plugin->title . '</b>'
3977
- ) . ' ' . sprintf(
3978
- '<a href="%s" aria-label="%s" class="button button-primary" style="margin-left: 10px; vertical-align: middle;">%s &nbsp;&#10140;</a>',
3979
- $this->_parent->addon_url( $this->_slug ),
3980
- esc_attr( sprintf( $this->_parent->get_text_inline( 'More information about %s', 'more-information-about-x' ), $this->_plugin->title ) ),
3981
- $this->_parent->get_text_inline( 'Purchase License', 'purchase-license' )
3982
- ),
3983
- 'no_addon_license_' . $this->_slug,
3984
- ( $is_after_trial_cancel ? '' : $this->_parent->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...' ),
3985
- ( $is_after_trial_cancel ? 'success' : 'error' )
3986
- );
3987
-
3988
- deactivate_plugins( array( $this->_plugin_basename ), true );
3989
-
3990
- return true;
3991
- }
3992
- }
3993
-
3994
- return false;
3995
- }
3996
-
3997
- #endregion
3998
-
3999
- #----------------------------------------------------------------------------------
4000
- #region Sandbox
4001
- #----------------------------------------------------------------------------------
4002
-
4003
- /**
4004
- * Set Freemius into sandbox mode for debugging.
4005
- *
4006
- * @author Vova Feldman (@svovaf)
4007
- * @since 1.0.4
4008
- *
4009
- * @param string $secret_key
4010
- */
4011
- function init_sandbox( $secret_key ) {
4012
- $this->_plugin->secret_key = $secret_key;
4013
-
4014
- // Update plugin details.
4015
- FS_Plugin_Manager::instance( $this->_module_id )->update( $this->_plugin, true );
4016
- }
4017
-
4018
- /**
4019
- * Check if running payments in sandbox mode.
4020
- *
4021
- * @author Vova Feldman (@svovaf)
4022
- * @since 1.0.4
4023
- *
4024
- * @return bool
4025
- */
4026
- function is_payments_sandbox() {
4027
- return ( ! $this->is_live() ) || isset( $this->_plugin->secret_key );
4028
- }
4029
-
4030
- #endregion
4031
-
4032
- /**
4033
- * Check if running test vs. live plugin.
4034
- *
4035
- * @author Vova Feldman (@svovaf)
4036
- * @since 1.0.5
4037
- *
4038
- * @return bool
4039
- */
4040
- function is_live() {
4041
- return $this->_plugin->is_live;
4042
- }
4043
-
4044
- /**
4045
- * Check if the user skipped connecting the account with Freemius.
4046
- *
4047
- * @author Vova Feldman (@svovaf)
4048
- * @since 1.0.7
4049
- *
4050
- * @return bool
4051
- */
4052
- function is_anonymous() {
4053
- if ( ! isset( $this->_is_anonymous ) ) {
4054
- if ( ! isset( $this->_storage->is_anonymous ) ) {
4055
- // Not skipped.
4056
- $this->_is_anonymous = false;
4057
- } else if ( is_bool( $this->_storage->is_anonymous ) ) {
4058
- // For back compatibility, since the variable was boolean before.
4059
- $this->_is_anonymous = $this->_storage->is_anonymous;
4060
-
4061
- // Upgrade stored data format to 1.1.3 format.
4062
- $this->set_anonymous_mode( $this->_storage->is_anonymous );
4063
- } else {
4064
- // Version 1.1.3 and later.
4065
- $this->_is_anonymous = $this->_storage->is_anonymous['is'];
4066
- }
4067
- }
4068
-
4069
- return $this->_is_anonymous;
4070
- }
4071
-
4072
- /**
4073
- * Check if user connected his account and install pending email activation.
4074
- *
4075
- * @author Vova Feldman (@svovaf)
4076
- * @since 1.0.7
4077
- *
4078
- * @return bool
4079
- */
4080
- function is_pending_activation() {
4081
- return $this->_storage->get( 'is_pending_activation', false );
4082
- }
4083
-
4084
- /**
4085
- * Check if plugin must be WordPress.org compliant.
4086
- *
4087
- * @since 1.0.7
4088
- *
4089
- * @return bool
4090
- */
4091
- function is_org_repo_compliant() {
4092
- return $this->_is_org_compliant;
4093
- }
4094
-
4095
- #----------------------------------------------------------------------------------
4096
- #region Daily Sync Cron
4097
- #----------------------------------------------------------------------------------
4098
-
4099
- /**
4100
- * @author Vova Feldman (@svovaf)
4101
- * @since 1.1.7.3
4102
- */
4103
- private function run_manual_sync() {
4104
- self::require_pluggable_essentials();
4105
-
4106
- if ( ! $this->is_user_admin() ) {
4107
- return;
4108
- }
4109
-
4110
- // Run manual sync.
4111
- $this->_sync_cron();
4112
-
4113
- // Reschedule next cron to run 24 hours from now (performance optimization).
4114
- $this->clear_sync_cron();
4115
-
4116
- $this->schedule_sync_cron( time() + WP_FS__TIME_24_HOURS_IN_SEC, false );
4117
- }
4118
-
4119
- /**
4120
- * Data sync cron job. Replaces the background sync non blocking HTTP request
4121
- * that doesn't halt page loading.
4122
- *
4123
- * @author Vova Feldman (@svovaf)
4124
- * @since 1.1.7.3
4125
- */
4126
- function _sync_cron() {
4127
- $this->_logger->entrance();
4128
-
4129
- // Store the last time data sync was executed.
4130
- $this->_storage->sync_timestamp = time();
4131
-
4132
- // Check if API is temporary down.
4133
- if ( FS_Api::is_temporary_down() ) {
4134
- return;
4135
- }
4136
-
4137
- // @todo Add logic that identifies API latency, and reschedule the next background sync randomly between 8-16 hours.
4138
-
4139
- if ( $this->is_registered() ) {
4140
- if ( $this->has_paid_plan() ) {
4141
- // Initiate background plan sync.
4142
- $this->_sync_license( true );
4143
-
4144
- if ( $this->is_paying() ) {
4145
- // Check for premium plugin updates.
4146
- $this->check_updates( true );
4147
- }
4148
- } else {
4149
- // Sync install (only if something changed locally).
4150
- $this->sync_install();
4151
- }
4152
- }
4153
-
4154
- $this->do_action( 'after_sync_cron' );
4155
- }
4156
-
4157
- /**
4158
- * Check if sync was executed in the last $period of seconds.
4159
- *
4160
- * @author Vova Feldman (@svovaf)
4161
- * @since 1.1.7.3
4162
- *
4163
- * @param int $period In seconds
4164
- *
4165
- * @return bool
4166
- */
4167
- private function is_sync_executed( $period = WP_FS__TIME_24_HOURS_IN_SEC ) {
4168
- if ( ! isset( $this->_storage->sync_timestamp ) ) {
4169
- return false;
4170
- }
4171
-
4172
- return ( $this->_storage->sync_timestamp > ( WP_FS__SCRIPT_START_TIME - $period ) );
4173
- }
4174
-
4175
- /**
4176
- * @author Vova Feldman (@svovaf)
4177
- * @since 1.1.7.3
4178
- *
4179
- * @return bool
4180
- */
4181
- private function is_sync_cron_on() {
4182
- /**
4183
- * @var object $sync_cron_data
4184
- */
4185
- $sync_cron_data = $this->_storage->get( 'sync_cron', null );
4186
-
4187
- return ( ! is_null( $sync_cron_data ) && true === $sync_cron_data->on );
4188
- }
4189
-
4190
- /**
4191
- * @author Vova Feldman (@svovaf)
4192
- * @since 1.1.7.3
4193
- *
4194
- * @param int $start_at Defaults to now.
4195
- * @param bool $randomize_start If true, schedule first job randomly during the next 12 hours. Otherwise,
4196
- * schedule job to start right away.
4197
- */
4198
- private function schedule_sync_cron( $start_at = WP_FS__SCRIPT_START_TIME, $randomize_start = true ) {
4199
- $this->_logger->entrance();
4200
-
4201
- if ( $randomize_start ) {
4202
- // Schedule first sync with a random 12 hour time range from now.
4203
- $start_at += rand( 0, ( WP_FS__TIME_24_HOURS_IN_SEC / 2 ) );
4204
- }
4205
-
4206
- // Schedule daily WP cron.
4207
- wp_schedule_event(
4208
- $start_at,
4209
- 'daily',
4210
- $this->get_action_tag( 'data_sync' )
4211
- );
4212
-
4213
- $this->_storage->store( 'sync_cron', (object) array(
4214
- 'version' => $this->get_plugin_version(),
4215
- 'sdk_version' => $this->version,
4216
- 'timestamp' => WP_FS__SCRIPT_START_TIME,
4217
- 'on' => true,
4218
- ) );
4219
- }
4220
-
4221
- /**
4222
- * Add the actual sync function to the cron job hook.
4223
- *
4224
- * @author Vova Feldman (@svovaf)
4225
- * @since 1.1.7.3
4226
- */
4227
- private function hook_callback_to_sync_cron() {
4228
- $this->add_action( 'data_sync', array( &$this, '_sync_cron' ) );
4229
- }
4230
-
4231
- /**
4232
- * @author Vova Feldman (@svovaf)
4233
- * @since 1.1.7.3
4234
- */
4235
- private function clear_sync_cron() {
4236
- $this->_logger->entrance();
4237
-
4238
- if ( ! $this->is_sync_cron_on() ) {
4239
- return;
4240
- }
4241
-
4242
- $this->_storage->remove( 'sync_cron' );
4243
-
4244
- wp_clear_scheduled_hook( $this->get_action_tag( 'data_sync' ) );
4245
- }
4246
-
4247
- /**
4248
- * Unix timestamp for next sync cron execution or false if not scheduled.
4249
- *
4250
- * @author Vova Feldman (@svovaf)
4251
- * @since 1.1.7.3
4252
- *
4253
- * @return int|false
4254
- */
4255
- function next_sync_cron() {
4256
- $this->_logger->entrance();
4257
-
4258
- if ( ! $this->is_sync_cron_on() ) {
4259
- return false;
4260
- }
4261
-
4262
- return wp_next_scheduled( $this->get_action_tag( 'data_sync' ) );
4263
- }
4264
-
4265
- /**
4266
- * Unix timestamp for previous sync cron execution or false if never executed.
4267
- *
4268
- * @author Vova Feldman (@svovaf)
4269
- * @since 1.1.7.3
4270
- *
4271
- * @return int|false
4272
- */
4273
- function last_sync_cron() {
4274
- $this->_logger->entrance();
4275
-
4276
- return $this->_storage->get( 'sync_timestamp' );
4277
- }
4278
-
4279
- #endregion Daily Sync Cron ------------------------------------------------------------------
4280
-
4281
- #----------------------------------------------------------------------------------
4282
- #region Async Install Sync
4283
- #----------------------------------------------------------------------------------
4284
-
4285
- /**
4286
- * @author Vova Feldman (@svovaf)
4287
- * @since 1.1.7.3
4288
- *
4289
- * @return bool
4290
- */
4291
- private function is_install_sync_scheduled() {
4292
- /**
4293
- * @var object $cron_data
4294
- */
4295
- $cron_data = $this->_storage->get( 'install_sync_cron', null );
4296
-
4297
- return ( ! is_null( $cron_data ) && true === $cron_data->on );
4298
- }
4299
-
4300
- /**
4301
- * Instead of running blocking install sync event, execute non blocking scheduled wp-cron.
4302
- *
4303
- * @author Vova Feldman (@svovaf)
4304
- * @since 1.1.7.3
4305
- */
4306
- private function schedule_install_sync() {
4307
- $this->_logger->entrance();
4308
-
4309
- $this->clear_install_sync_cron();
4310
-
4311
- // Schedule immediate install sync.
4312
- wp_schedule_single_event(
4313
- WP_FS__SCRIPT_START_TIME,
4314
- $this->get_action_tag( 'install_sync' )
4315
- );
4316
-
4317
- $this->_storage->store( 'install_sync_cron', (object) array(
4318
- 'version' => $this->get_plugin_version(),
4319
- 'sdk_version' => $this->version,
4320
- 'timestamp' => WP_FS__SCRIPT_START_TIME,
4321
- 'on' => true,
4322
- ) );
4323
- }
4324
-
4325
- /**
4326
- * Unix timestamp for previous install sync cron execution or false if never executed.
4327
- *
4328
- * @todo There's some very strange bug that $this->_storage->install_sync_timestamp value is not being
4329
- * updated. But for sure the sync event is working.
4330
- *
4331
- * @author Vova Feldman (@svovaf)
4332
- * @since 1.1.7.3
4333
- *
4334
- * @return int|false
4335
- */
4336
- function last_install_sync() {
4337
- $this->_logger->entrance();
4338
-
4339
- return $this->_storage->get( 'install_sync_timestamp' );
4340
- }
4341
-
4342
- /**
4343
- * Unix timestamp for next install sync cron execution or false if not scheduled.
4344
- *
4345
- * @author Vova Feldman (@svovaf)
4346
- * @since 1.1.7.3
4347
- *
4348
- * @return int|false
4349
- */
4350
- function next_install_sync() {
4351
- $this->_logger->entrance();
4352
-
4353
- if ( ! $this->is_install_sync_scheduled() ) {
4354
- return false;
4355
- }
4356
-
4357
- return wp_next_scheduled( $this->get_action_tag( 'install_sync' ) );
4358
- }
4359
-
4360
- /**
4361
- * Add the actual install sync function to the cron job hook.
4362
- *
4363
- * @author Vova Feldman (@svovaf)
4364
- * @since 1.1.7.3
4365
- */
4366
- private function hook_callback_to_install_sync() {
4367
- $this->add_action( 'install_sync', array( &$this, '_run_sync_install' ) );
4368
- }
4369
-
4370
- /**
4371
- * @author Vova Feldman (@svovaf)
4372
- * @since 1.1.7.3
4373
- */
4374
- private function clear_install_sync_cron() {
4375
- $this->_logger->entrance();
4376
-
4377
- if ( ! $this->is_install_sync_scheduled() ) {
4378
- return;
4379
- }
4380
-
4381
- $this->_storage->remove( 'install_sync_cron' );
4382
-
4383
- wp_clear_scheduled_hook( $this->get_action_tag( 'install_sync' ) );
4384
- }
4385
-
4386
- /**
4387
- * @author Vova Feldman (@svovaf)
4388
- * @since 1.1.7.3
4389
- */
4390
- public function _run_sync_install() {
4391
- $this->_logger->entrance();
4392
-
4393
- // Update last install sync timestamp.
4394
- $this->_storage->install_sync_timestamp = time();
4395
-
4396
- $this->sync_install( array(), true );
4397
- }
4398
-
4399
- #endregion Async Install Sync ------------------------------------------------------------------
4400
-
4401
- /**
4402
- * Show a notice that activation is currently pending.
4403
- *
4404
- * @author Vova Feldman (@svovaf)
4405
- * @since 1.0.7
4406
- *
4407
- * @param bool|string $email
4408
- * @param bool $is_pending_trial Since 1.2.1.5
4409
- */
4410
- function _add_pending_activation_notice( $email = false, $is_pending_trial = false ) {
4411
- if ( ! is_string( $email ) ) {
4412
- $current_user = self::_get_current_wp_user();
4413
- $email = $current_user->user_email;
4414
- }
4415
-
4416
- $this->_admin_notices->add_sticky(
4417
- sprintf(
4418
- $this->get_text_inline( 'You should receive an activation email for %s to your mailbox at %s. Please make sure you click the activation button in that email to %s.', 'pending-activation-message' ),
4419
- '<b>' . $this->get_plugin_name() . '</b>',
4420
- '<b>' . $email . '</b>',
4421
- ( $is_pending_trial ?
4422
- $this->get_text_inline( 'start the trial', 'start-the-trial' ) :
4423
- $this->get_text_inline( 'complete the install', 'complete-the-install' ) )
4424
- ),
4425
- 'activation_pending',
4426
- 'Thanks!'
4427
- );
4428
- }
4429
-
4430
- /**
4431
- * Check if currently in plugin activation.
4432
- *
4433
- * @author Vova Feldman (@svovaf)
4434
- * @since 1.1.4
4435
- *
4436
- * @return bool
4437
- */
4438
- function is_plugin_activation() {
4439
- return get_option( 'fs_'
4440
- . ( $this->is_plugin() ? '' : $this->_module_type . '_' )
4441
- . "{$this->_slug}_activated", false );
4442
- }
4443
-
4444
- /**
4445
- *
4446
- * NOTE: admin_menu action executed before admin_init.
4447
- *
4448
- * @author Vova Feldman (@svovaf)
4449
- * @since 1.0.7
4450
- */
4451
- function _admin_init_action() {
4452
- /**
4453
- * Automatically redirect to connect/activation page after plugin activation.
4454
- *
4455
- * @since 1.1.7 Do NOT redirect to opt-in when running in network admin mode.
4456
- */
4457
- if ( $this->is_plugin_activation() ) {
4458
- delete_option( 'fs_'
4459
- . ( $this->is_plugin() ? '' : $this->_module_type . '_' )
4460
- . "{$this->_slug}_activated" );
4461
-
4462
- if ( ! function_exists( 'is_network_admin' ) || ! is_network_admin() ) {
4463
- $this->_redirect_on_activation_hook();
4464
-
4465
- return;
4466
- }
4467
- }
4468
-
4469
- if ( fs_request_is_action( $this->get_unique_affix() . '_skip_activation' ) ) {
4470
- check_admin_referer( $this->get_unique_affix() . '_skip_activation' );
4471
-
4472
- $this->skip_connection();
4473
-
4474
- fs_redirect( $this->get_after_activation_url( 'after_skip_url' ) );
4475
- }
4476
-
4477
- if ( ! $this->is_addon() && ! $this->is_registered() && ! $this->is_anonymous() ) {
4478
- if ( ! $this->is_pending_activation() ) {
4479
- if ( ! $this->_menu->is_main_settings_page() ) {
4480
- /**
4481
- * If a user visits any other admin page before activating the premium-only theme with a valid
4482
- * license, reactivate the previous theme.
4483
- *
4484
- * @author Leo Fajardo (@leorw)
4485
- * @since 1.2.2
4486
- */
4487
- if ( $this->is_theme()
4488
- && $this->is_only_premium()
4489
- && ! $this->has_settings_menu()
4490
- && ! isset( $_REQUEST['fs_action'] )
4491
- && $this->can_activate_previous_theme()
4492
- ) {
4493
- $this->activate_previous_theme();
4494
-
4495
- return;
4496
- }
4497
-
4498
- if ( $this->is_plugin_new_install() || $this->is_only_premium() ) {
4499
- // Show notice for new plugin installations.
4500
- $this->_admin_notices->add(
4501
- sprintf(
4502
- $this->get_text_inline( 'You are just one step away - %s', 'you-are-step-away' ),
4503
- sprintf( '<b><a href="%s">%s</a></b>',
4504
- $this->get_activation_url(),
4505
- sprintf( $this->get_text_x_inline( 'Complete "%s" Activation Now',
4506
- '%s - plugin name. As complete "PluginX" activation now', 'activate-x-now' ), $this->get_plugin_name() )
4507
- )
4508
- ),
4509
- '',
4510
- 'update-nag'
4511
- );
4512
- } else {
4513
- if ( ! isset( $this->_storage->sticky_optin_added ) ) {
4514
- $this->_storage->sticky_optin_added = true;
4515
-
4516
- // Show notice for new plugin installations.
4517
- $this->_admin_notices->add_sticky(
4518
- sprintf(
4519
- $this->get_text_inline( 'We made a few tweaks to the %s, %s', 'few-plugin-tweaks' ),
4520
- $this->_module_type,
4521
- sprintf( '<b><a href="%s">%s</a></b>',
4522
- $this->get_activation_url(),
4523
- sprintf( $this->get_text_inline( 'Opt in to make "%s" Better!', 'optin-x-now' ), $this->get_plugin_name() )
4524
- )
4525
- ),
4526
- 'connect_account',
4527
- '',
4528
- 'update-nag'
4529
- );
4530
- }
4531
-
4532
- if ( $this->has_filter( 'optin_pointer_element' ) ) {
4533
- // Don't show admin nag if plugin update.
4534
- wp_enqueue_script( 'wp-pointer' );
4535
- wp_enqueue_style( 'wp-pointer' );
4536
-
4537
- $this->_enqueue_connect_essentials();
4538
-
4539
- add_action( 'admin_print_footer_scripts', array(
4540
- $this,
4541
- '_add_connect_pointer_script'
4542
- ) );
4543
- }
4544
- }
4545
- }
4546
- }
4547
-
4548
- if ( $this->is_theme() &&
4549
- $this->_menu->is_main_settings_page()
4550
- ) {
4551
- $this->_show_theme_activation_optin_dialog();
4552
- }
4553
- }
4554
-
4555
- $this->_add_upgrade_action_link();
4556
- }
4557
-
4558
- /**
4559
- * Enqueue connect requires scripts and styles.
4560
- *
4561
- * @author Vova Feldman (@svovaf)
4562
- * @since 1.1.4
4563
- */
4564
- function _enqueue_connect_essentials() {
4565
- wp_enqueue_script( 'jquery' );
4566
- wp_enqueue_script( 'json2' );
4567
-
4568
- fs_enqueue_local_script( 'postmessage', 'nojquery.ba-postmessage.min.js' );
4569
- fs_enqueue_local_script( 'fs-postmessage', 'postmessage.js' );
4570
-
4571
- fs_enqueue_local_style( 'fs_connect', '/admin/connect.css' );
4572
- }
4573
-
4574
- /**
4575
- * Add connect / opt-in pointer.
4576
- *
4577
- * @author Vova Feldman (@svovaf)
4578
- * @since 1.1.4
4579
- */
4580
- function _add_connect_pointer_script() {
4581
- $vars = array( 'id' => $this->_module_id );
4582
- $pointer_content = fs_get_template( 'connect.php', $vars );
4583
- ?>
4584
- <script type="text/javascript">// <![CDATA[
4585
- jQuery(document).ready(function ($) {
4586
- if ('undefined' !== typeof(jQuery().pointer)) {
4587
-
4588
- var element = <?php echo $this->apply_filters( 'optin_pointer_element', '$("#non_existing_element");' ) ?>;
4589
-
4590
- if (element.length > 0) {
4591
- var optin = $(element).pointer($.extend(true, {}, {
4592
- content : <?php echo json_encode( $pointer_content ) ?>,
4593
- position : {
4594
- edge : 'left',
4595
- align: 'center'
4596
- },
4597
- buttons : function () {
4598
- // Don't show pointer buttons.
4599
- return '';
4600
- },
4601
- pointerWidth: 482
4602
- }, <?php echo $this->apply_filters( 'optin_pointer_options_json', '{}' ) ?>));
4603
-
4604
- <?php
4605
- echo $this->apply_filters( 'optin_pointer_execute', "
4606
 
4607
- optin.pointer('open');
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4608
 
4609
- // Tag the opt-in pointer with custom class.
4610
- $('.wp-pointer #fs_connect')
4611
- .parents('.wp-pointer.wp-pointer-top')
4612
- .addClass('fs-opt-in-pointer');
4613
 
4614
- ", 'element', 'optin' ) ?>
4615
- }
4616
- }
4617
- });
4618
- // ]]></script>
4619
- <?php
4620
- }
4621
-
4622
- /**
4623
- * Return current page's URL.
4624
- *
4625
- * @author Vova Feldman (@svovaf)
4626
- * @since 1.0.7
4627
- *
4628
- * @return string
4629
- */
4630
- function current_page_url() {
4631
- $url = 'http';
4632
-
4633
- if ( isset( $_SERVER["HTTPS"] ) ) {
4634
- if ( $_SERVER["HTTPS"] == "on" ) {
4635
- $url .= "s";
4636
- }
4637
- }
4638
- $url .= "://";
4639
- if ( $_SERVER["SERVER_PORT"] != "80" ) {
4640
- $url .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
4641
- } else {
4642
- $url .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
4643
- }
4644
-
4645
- return esc_url( $url );
4646
- }
4647
-
4648
- /**
4649
- * Check if the current page is the plugin's main admin settings page.
4650
- *
4651
- * @author Vova Feldman (@svovaf)
4652
- * @since 1.0.7
4653
- *
4654
- * @return bool
4655
- */
4656
- function _is_plugin_page() {
4657
- return fs_is_plugin_page( $this->_menu->get_raw_slug() ) ||
4658
- fs_is_plugin_page( $this->_slug );
4659
- }
4660
-
4661
- /* Events
4662
- ------------------------------------------------------------------------------------------------------------------*/
4663
- /**
4664
- * Delete site install from Database.
4665
- *
4666
- * @author Vova Feldman (@svovaf)
4667
- * @since 1.0.1
4668
- *
4669
- * @param bool $store
4670
- */
4671
- function _delete_site( $store = true ) {
4672
- self::_delete_site_by_slug( $this->_slug, $this->_module_type, $store );
4673
- }
4674
-
4675
- /**
4676
- * Delete site install from Database.
4677
- *
4678
- * @author Vova Feldman (@svovaf)
4679
- * @since 1.2.2.7
4680
- *
4681
- * @param string $slug
4682
- * @param string $module_type
4683
- * @param bool $store
4684
- */
4685
- static function _delete_site_by_slug($slug, $module_type, $store = true ) {
4686
- $sites = self::get_all_sites( $module_type );
4687
-
4688
- if ( isset( $sites[ $slug ] ) ) {
4689
- unset( $sites[ $slug ] );
4690
- }
4691
-
4692
- self::set_account_option_by_module( $module_type, 'sites', $sites, $store );
4693
- }
4694
-
4695
- /**
4696
- * Delete plugin's plans information.
4697
- *
4698
- * @param bool $store Flush to Database if true.
4699
- *
4700
- * @author Vova Feldman (@svovaf)
4701
- * @since 1.0.9
4702
- */
4703
- private function _delete_plans( $store = true ) {
4704
- $this->_logger->entrance();
4705
-
4706
- $plans = self::get_all_plans( $this->_module_type );
4707
-
4708
- unset( $plans[ $this->_slug ] );
4709
-
4710
- $this->set_account_option( 'plans', $plans, $store );
4711
- }
4712
-
4713
- /**
4714
- * Delete all plugin licenses.
4715
- *
4716
- * @author Vova Feldman (@svovaf)
4717
- * @since 1.0.9
4718
- *
4719
- * @param bool $store
4720
- * @param string|bool $plugin_slug
4721
- */
4722
- private function _delete_licenses( $store = true, $plugin_slug = false ) {
4723
- $this->_logger->entrance();
4724
-
4725
- $all_licenses = self::get_all_licenses( $this->_module_type );
4726
-
4727
- if ( ! is_string( $plugin_slug ) ) {
4728
- $plugin_slug = $this->_slug;
4729
- }
4730
-
4731
- unset( $all_licenses[ $plugin_slug ] );
4732
-
4733
- $this->set_account_option( 'licenses', $all_licenses, $store );
4734
- }
4735
-
4736
- /**
4737
- * Check if Freemius was added on new plugin installation.
4738
- *
4739
- * @author Vova Feldman (@svovaf)
4740
- * @since 1.1.5
4741
- *
4742
- * @return bool
4743
- */
4744
- function is_plugin_new_install() {
4745
- return isset( $this->_storage->is_plugin_new_install ) &&
4746
- $this->_storage->is_plugin_new_install;
4747
- }
4748
-
4749
- /**
4750
- * Check if it's the first plugin release that is running Freemius.
4751
- *
4752
- * @author Vova Feldman (@svovaf)
4753
- * @since 1.2.1.5
4754
- *
4755
- * @return bool
4756
- */
4757
- function is_first_freemius_powered_version() {
4758
- return empty( $this->_storage->plugin_last_version );
4759
- }
4760
-
4761
- /**
4762
- * @author Leo Fajardo (@leorw)
4763
- * @since 1.2.2
4764
- *
4765
- * @return bool|string
4766
- */
4767
- private function get_previous_theme_slug() {
4768
- return isset( $this->_storage->previous_theme ) ?
4769
- $this->_storage->previous_theme :
4770
- false;
4771
- }
4772
-
4773
- /**
4774
- * @author Leo Fajardo (@leorw)
4775
- * @since 1.2.2
4776
- *
4777
- * @return string
4778
- */
4779
- private function can_activate_previous_theme() {
4780
- $slug = $this->get_previous_theme_slug();
4781
- if ( false !== $slug && current_user_can( 'switch_themes' ) ) {
4782
- $theme_instance = wp_get_theme( $slug );
4783
-
4784
- return $theme_instance->exists();
4785
- }
4786
-
4787
- return false;
4788
- }
4789
-
4790
- /**
4791
- * @author Leo Fajardo (@leorw)
4792
- * @since 1.2.2
4793
- *
4794
- * @return string
4795
- */
4796
- private function activate_previous_theme() {
4797
- switch_theme( $this->get_previous_theme_slug() );
4798
- unset( $this->_storage->previous_theme );
4799
-
4800
- global $pagenow;
4801
- if ( 'themes.php' === $pagenow ) {
4802
- /**
4803
- * Refresh the active theme information.
4804
- *
4805
- * @author Leo Fajardo (@leorw)
4806
- * @since 1.2.2
4807
- */
4808
- fs_redirect( admin_url( $pagenow ) );
4809
- }
4810
- }
4811
-
4812
- /**
4813
- * @author Leo Fajardo (@leorw)
4814
- * @since 1.2.2
4815
- *
4816
- * @return string
4817
- */
4818
- function get_previous_theme_activation_url() {
4819
- if ( ! $this->can_activate_previous_theme() ) {
4820
- return '';
4821
- }
4822
-
4823
- /**
4824
- * Activation URL
4825
- *
4826
- * @author Leo Fajardo (@leorw)
4827
- * @since 1.2.2
4828
- */
4829
- return wp_nonce_url(
4830
- admin_url( 'themes.php?action=activate&stylesheet=' . urlencode( $this->get_previous_theme_slug() ) ),
4831
- 'switch-theme_' . $this->get_previous_theme_slug()
4832
- );
4833
- }
4834
-
4835
- /**
4836
- * Saves the slug of the previous theme if it still exists so that it can be used by the logic in the opt-in
4837
- * form that decides whether to add a close button to the opt-in dialog or not. So after a premium-only theme is
4838
- * activated, the close button will appear and will reactivate the previous theme if clicked. If the previous
4839
- * theme doesn't exist, then there will be no close button.
4840
- *
4841
- * @author Leo Fajardo (@leorw)
4842
- * @since 1.2.2
4843
- *
4844
- * @param string $slug_or_name Old theme's slug or name.
4845
- * @param bool|WP_Theme $old_theme WP_Theme instance of the old theme if it still exists.
4846
- */
4847
- function _activate_theme_event_hook( $slug_or_name, $old_theme = false ) {
4848
- $this->_storage->previous_theme = ( false !== $old_theme ) ?
4849
- $old_theme->get_stylesheet() :
4850
- $slug_or_name;
4851
-
4852
- $this->_activate_plugin_event_hook();
4853
- }
4854
-
4855
- /**
4856
- * Plugin activated hook.
4857
- *
4858
- * @author Vova Feldman (@svovaf)
4859
- * @since 1.0.1
4860
- *
4861
- * @uses FS_Api
4862
- */
4863
- function _activate_plugin_event_hook() {
4864
- $this->_logger->entrance( 'slug = ' . $this->_slug );
4865
-
4866
- if ( ! $this->is_user_admin() ) {
4867
- return;
4868
- }
4869
-
4870
- $this->unregister_uninstall_hook();
4871
-
4872
- // Clear API cache on activation.
4873
- FS_Api::clear_cache();
4874
-
4875
- $is_premium_version_activation = ( current_filter() !== ( 'activate_' . $this->_free_plugin_basename ) );
4876
-
4877
- $this->_logger->info( 'Activating ' . ( $is_premium_version_activation ? 'premium' : 'free' ) . ' plugin version.' );
4878
-
4879
- // 1. If running in the activation of the FREE module, get the basename of the PREMIUM.
4880
- // 2. If running in the activation of the PREMIUM module, get the basename of the FREE.
4881
- $other_version_basename = $is_premium_version_activation ?
4882
- $this->_free_plugin_basename :
4883
- $this->premium_plugin_basename();
4884
-
4885
- /**
4886
- * If the other module version is activate, deactivate it.
4887
- *
4888
- * @author Leo Fajardo (@leorw)
4889
- * @since 1.2.2
4890
- */
4891
- if ( is_plugin_active( $other_version_basename ) ) {
4892
- deactivate_plugins( $other_version_basename );
4893
- }
4894
 
4895
- if ( $this->is_registered() ) {
4896
- if ( $is_premium_version_activation ) {
4897
- $this->reconnect_locally();
4898
- }
4899
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4900
 
4901
- // Schedule re-activation event and sync.
4902
- // $this->sync_install( array(), true );
4903
- $this->schedule_install_sync();
4904
-
4905
- // If activating the premium module version, add an admin notice to congratulate for an upgrade completion.
4906
- if ( $is_premium_version_activation ) {
4907
- $this->_admin_notices->add(
4908
- sprintf( $this->get_text_inline( 'The upgrade of %s was successfully completed.', 'successful-version-upgrade-message' ), sprintf( '<b>%s</b>', $this->_plugin->title ) ),
4909
- $this->get_text_x_inline( 'W00t',
4910
- 'Used to express elation, enthusiasm, or triumph (especially in electronic communication).', 'woot' ) . '!'
4911
- );
4912
- }
4913
- } else if ( $this->is_anonymous() ) {
4914
- /**
4915
- * Reset "skipped" click cache on the following:
4916
- * 1. Freemius DEV mode.
4917
- * 2. WordPress DEBUG mode.
4918
- * 3. If a plugin and the user skipped the exact same version before.
4919
- *
4920
- * @since 1.2.2.7 Ulrich Pogson (@grapplerulrich) asked to not reset the SKIPPED flag if the exact same THEME version was activated before unless the developer is running with WP_DEBUG on, or Freemius debug mode on (WP_FS__DEV_MODE).
4921
- *
4922
- * @todo 4. If explicitly asked to retry after every activation.
4923
- */
4924
- if ( WP_FS__DEV_MODE ||
4925
- (
4926
- ( $this->is_plugin() || ( defined( 'WP_DEBUG' ) && WP_DEBUG ) ) &&
4927
- $this->get_plugin_version() == $this->_storage->is_anonymous['version']
4928
- )
4929
- ) {
4930
- $this->reset_anonymous_mode();
4931
- }
4932
- }
4933
-
4934
- if ( ! isset( $this->_storage->is_plugin_new_install ) ) {
4935
- /**
4936
- * If no previous version of plugin's version exist, it means that it's either
4937
- * the first time that the plugin installed on the site, or the plugin was installed
4938
- * before but didn't have Freemius integrated.
4939
- *
4940
- * Since register_activation_hook() do NOT fires on updates since 3.1, and only fires
4941
- * on manual activation via the dashboard, is_plugin_activation() is TRUE
4942
- * only after immediate activation.
4943
- *
4944
- * @since 1.1.4
4945
- * @link https://make.wordpress.org/core/2010/10/27/plugin-activation-hooks-no-longer-fire-for-updates/
4946
- */
4947
- $this->_storage->is_plugin_new_install = empty( $this->_storage->plugin_last_version );
4948
- }
4949
-
4950
- if ( ! $this->_anonymous_mode &&
4951
- $this->has_api_connectivity( WP_FS__DEV_MODE ) &&
4952
- ! $this->_isAutoInstall
4953
- ) {
4954
- // Store hint that the plugin was just activated to enable auto-redirection to settings.
4955
- add_option( 'fs_'
4956
- . ( $this->is_plugin() ? '' : $this->_module_type . '_' )
4957
- . "{$this->_slug}_activated", true );
4958
- }
4959
-
4960
- /**
4961
- * Activation hook is executed after the plugin's main file is loaded, therefore,
4962
- * after the plugin was loaded. The logic is located at activate_plugin()
4963
- * ./wp-admin/includes/plugin.php.
4964
- *
4965
- * @author Vova Feldman (@svovaf)
4966
- * @since 1.1.9
4967
- */
4968
- $this->_storage->was_plugin_loaded = true;
4969
- }
4970
 
4971
- /**
4972
- * Delete account.
4973
- *
4974
- * @author Vova Feldman (@svovaf)
4975
- * @since 1.0.3
4976
- *
4977
- * @param bool $check_user Enforce checking if user have plugins activation privileges.
4978
- */
4979
- function delete_account_event( $check_user = true ) {
4980
- $this->_logger->entrance( 'slug = ' . $this->_slug );
 
 
 
 
 
 
 
 
4981
 
4982
- if ( $check_user && ! $this->is_user_admin() ) {
4983
- return;
4984
- }
4985
 
4986
- $this->do_action( 'before_account_delete' );
 
4987
 
4988
- // Clear all admin notices.
4989
- $this->_admin_notices->clear_all_sticky();
 
 
 
4990
 
4991
- $this->_delete_site( false );
 
 
 
 
 
 
 
 
4992
 
4993
- $this->_delete_plans( false );
 
 
 
4994
 
4995
- $this->_delete_licenses( false );
 
 
4996
 
4997
- // Delete add-ons related to plugin's account.
4998
- $this->_delete_account_addons( false );
 
4999
 
5000
- // @todo Delete plans and licenses of add-ons.
 
 
 
 
 
 
 
 
 
 
 
 
 
5001
 
5002
- self::$_accounts->store();
 
 
 
5003
 
5004
- /**
5005
- * IMPORTANT:
5006
- * Clear crons must be executed before clearing all storage.
5007
- * Otherwise, the cron will not be cleared.
5008
- */
5009
- $this->clear_sync_cron();
5010
- $this->clear_install_sync_cron();
5011
-
5012
- // Clear all storage data.
5013
- $this->_storage->clear_all( true, array(
5014
- 'connectivity_test',
5015
- 'is_on',
5016
- ) );
5017
-
5018
- // Send delete event.
5019
- $this->get_api_site_scope()->call( '/', 'delete' );
5020
-
5021
- $this->do_action( 'after_account_delete' );
5022
- }
5023
-
5024
- /**
5025
- * Plugin deactivation hook.
5026
- *
5027
- * @author Vova Feldman (@svovaf)
5028
- * @since 1.0.1
5029
- */
5030
- function _deactivate_plugin_hook() {
5031
- $this->_logger->entrance( 'slug = ' . $this->_slug );
5032
-
5033
- if ( ! current_user_can( 'activate_plugins' ) ) {
5034
- return;
5035
- }
5036
-
5037
- $this->_admin_notices->clear_all_sticky();
5038
- if ( isset( $this->_storage->sticky_optin_added ) ) {
5039
- unset( $this->_storage->sticky_optin_added );
5040
- }
5041
-
5042
- if ( ! isset( $this->_storage->is_plugin_new_install ) ) {
5043
- // Remember that plugin was already installed.
5044
- $this->_storage->is_plugin_new_install = false;
5045
- }
5046
-
5047
- // Hook to plugin uninstall.
5048
- register_uninstall_hook( $this->_plugin_main_file_path, array( 'Freemius', '_uninstall_plugin_hook' ) );
5049
-
5050
- $this->clear_module_main_file_cache();
5051
- $this->clear_sync_cron();
5052
- $this->clear_install_sync_cron();
5053
-
5054
- if ( $this->is_registered() ) {
5055
- // Send deactivation event.
5056
- $this->sync_install( array(
5057
- 'is_active' => false,
5058
- ) );
5059
- } else {
5060
- if ( ! $this->has_api_connectivity() ) {
5061
- // Reset connectivity test cache.
5062
- unset( $this->_storage->connectivity_test );
5063
- }
5064
- }
5065
-
5066
- // Clear API cache on deactivation.
5067
- FS_Api::clear_cache();
5068
-
5069
- $this->remove_sdk_reference();
5070
- }
5071
-
5072
- /**
5073
- * @author Vova Feldman (@svovaf)
5074
- * @since 1.1.6
5075
- */
5076
- private function remove_sdk_reference() {
5077
- global $fs_active_plugins;
5078
-
5079
- foreach ( $fs_active_plugins->plugins as $sdk_path => &$data ) {
5080
- if ( $this->_plugin_basename == $data->plugin_path ) {
5081
- unset( $fs_active_plugins->plugins[ $sdk_path ] );
5082
- break;
5083
- }
5084
- }
5085
-
5086
- fs_fallback_to_newest_active_sdk();
5087
- }
5088
-
5089
- /**
5090
- * @author Vova Feldman (@svovaf)
5091
- * @since 1.1.3
5092
- *
5093
- * @param bool $is_anonymous
5094
- */
5095
- private function set_anonymous_mode( $is_anonymous = true ) {
5096
- // Store information regarding skip to try and opt-in the user
5097
- // again in the future.
5098
- $this->_storage->is_anonymous = array(
5099
- 'is' => $is_anonymous,
5100
- 'timestamp' => WP_FS__SCRIPT_START_TIME,
5101
- 'version' => $this->get_plugin_version(),
5102
- );
5103
-
5104
- // Update anonymous mode cache.
5105
- $this->_is_anonymous = $is_anonymous;
5106
- }
5107
-
5108
- /**
5109
- * @author Vova Feldman (@svovaf)
5110
- * @since 1.1.3
5111
- */
5112
- private function reset_anonymous_mode() {
5113
- unset( $this->_storage->is_anonymous );
5114
-
5115
- /**
5116
- * Ensure that this field is also "false", otherwise, if the current module's type is "theme" and the module
5117
- * has no menus, the opt-in popup will not be shown immediately (in this case, the user will have to click
5118
- * on the admin notice that contains the opt-in link in order to trigger the opt-in popup).
5119
- *
5120
- * @author Leo Fajardo (@leorw)
5121
- * @since 1.2.2
5122
- */
5123
- unset( $this->_is_anonymous );
5124
- }
5125
-
5126
- /**
5127
- * Clears the anonymous mode and redirects to the opt-in screen.
5128
- *
5129
- * @author Vova Feldman (@svovaf)
5130
- * @since 1.1.7
5131
- */
5132
- function connect_again() {
5133
- if ( ! $this->is_anonymous() ) {
5134
- return;
5135
- }
5136
-
5137
- $this->reset_anonymous_mode();
5138
-
5139
- fs_redirect( $this->get_activation_url() );
5140
- }
5141
-
5142
- /**
5143
- * Skip account connect, and set anonymous mode.
5144
- *
5145
- * @author Vova Feldman (@svovaf)
5146
- * @since 1.1.1
5147
- */
5148
- private function skip_connection() {
5149
- $this->_logger->entrance();
5150
-
5151
- $this->_admin_notices->remove_sticky( 'connect_account' );
5152
-
5153
- $this->set_anonymous_mode();
5154
-
5155
- // Send anonymous skip event.
5156
- // No user identified info nor any tracking will be sent after the user skips the opt-in.
5157
- $this->get_api_plugin_scope()->call( 'skip.json', 'put', array(
5158
- 'uid' => $this->get_anonymous_id(),
5159
- ) );
5160
- }
5161
-
5162
- /**
5163
- * Plugin version update hook.
5164
- *
5165
- * @author Vova Feldman (@svovaf)
5166
- * @since 1.0.4
5167
- */
5168
- private function update_plugin_version_event() {
5169
- $this->_logger->entrance();
5170
-
5171
- if ( ! $this->is_registered() ) {
5172
- return;
5173
- }
5174
-
5175
- $this->schedule_install_sync();
5176
- // $this->sync_install( array(), true );
5177
- }
5178
-
5179
- /**
5180
- * Return a list of modified plugins since the last sync.
5181
- *
5182
- * Note:
5183
- * There's no point to store a plugins counter since even if the number of
5184
- * plugins didn't change, we still need to check if the versions are all the
5185
- * same and the activity state is similar.
5186
- *
5187
- * @author Vova Feldman (@svovaf)
5188
- * @since 1.1.8
5189
- *
5190
- * @return array|false
5191
- */
5192
- private function get_plugins_data_for_api() {
5193
- // Alias.
5194
- $option_name = 'all_plugins';
5195
-
5196
- $all_cached_plugins = self::$_accounts->get_option( $option_name );
5197
-
5198
- if ( ! is_object( $all_cached_plugins ) ) {
5199
- $all_cached_plugins = (object) array(
5200
- 'timestamp' => '',
5201
- 'md5' => '',
5202
- 'plugins' => array(),
5203
- );
5204
- }
5205
-
5206
- $time = time();
5207
-
5208
- if ( ! empty( $all_cached_plugins->timestamp ) &&
5209
- ( $time - $all_cached_plugins->timestamp ) < WP_FS__TIME_5_MIN_IN_SEC
5210
- ) {
5211
- // Don't send plugin updates if last update was in the past 5 min.
5212
- return false;
5213
- }
5214
-
5215
- // Write timestamp to lock the logic.
5216
- $all_cached_plugins->timestamp = $time;
5217
- self::$_accounts->set_option( $option_name, $all_cached_plugins, true );
5218
-
5219
- // Reload options from DB.
5220
- self::$_accounts->load( true );
5221
- $all_cached_plugins = self::$_accounts->get_option( $option_name );
5222
-
5223
- if ( $time != $all_cached_plugins->timestamp ) {
5224
- // If timestamp is different, then another thread captured the lock.
5225
- return false;
5226
- }
5227
-
5228
- // Check if there's a change in plugins.
5229
- $all_plugins = self::get_all_plugins();
5230
-
5231
- // Check if plugins changed.
5232
- ksort( $all_plugins );
5233
-
5234
- $plugins_signature = '';
5235
- foreach ( $all_plugins as $basename => $data ) {
5236
- $plugins_signature .= $data['slug'] . ',' .
5237
- $data['Version'] . ',' .
5238
- ( $data['is_active'] ? '1' : '0' ) . ';';
5239
- }
5240
-
5241
- // Check if plugins status changed (version or active/inactive).
5242
- $plugins_changed = ( $all_cached_plugins->md5 !== md5( $plugins_signature ) );
5243
-
5244
- $plugins_update_data = array();
5245
-
5246
- if ( $plugins_changed ) {
5247
- // Change in plugins, report changes.
5248
-
5249
- // Update existing plugins info.
5250
- foreach ( $all_cached_plugins->plugins as $basename => $data ) {
5251
- if ( ! isset( $all_plugins[ $basename ] ) ) {
5252
- // Plugin uninstalled.
5253
- $uninstalled_plugin_data = $data;
5254
- $uninstalled_plugin_data['is_active'] = false;
5255
- $uninstalled_plugin_data['is_uninstalled'] = true;
5256
- $plugins_update_data[] = $uninstalled_plugin_data;
5257
-
5258
- unset( $all_plugins[ $basename ] );
5259
- unset( $all_cached_plugins->plugins[ $basename ] );
5260
- } else if ( $data['is_active'] !== $all_plugins[ $basename ]['is_active'] ||
5261
- $data['version'] !== $all_plugins[ $basename ]['Version']
5262
- ) {
5263
- // Plugin activated or deactivated, or version changed.
5264
- $all_cached_plugins->plugins[ $basename ]['is_active'] = $all_plugins[ $basename ]['is_active'];
5265
- $all_cached_plugins->plugins[ $basename ]['version'] = $all_plugins[ $basename ]['Version'];
5266
-
5267
- $plugins_update_data[] = $all_cached_plugins->plugins[ $basename ];
5268
- }
5269
- }
5270
-
5271
- // Find new plugins that weren't yet seen before.
5272
- foreach ( $all_plugins as $basename => $data ) {
5273
- if ( ! isset( $all_cached_plugins->plugins[ $basename ] ) ) {
5274
- // New plugin.
5275
- $new_plugin = array(
5276
- 'slug' => $data['slug'],
5277
- 'version' => $data['Version'],
5278
- 'title' => $data['Name'],
5279
- 'is_active' => $data['is_active'],
5280
- 'is_uninstalled' => false,
5281
- );
5282
-
5283
- $plugins_update_data[] = $new_plugin;
5284
- $all_cached_plugins->plugins[ $basename ] = $new_plugin;
5285
- }
5286
- }
5287
-
5288
- $all_cached_plugins->md5 = md5( $plugins_signature );
5289
- $all_cached_plugins->timestamp = $time;
5290
- self::$_accounts->set_option( $option_name, $all_cached_plugins, true );
5291
- }
5292
-
5293
- return $plugins_update_data;
5294
- }
5295
-
5296
- /**
5297
- * Return a list of modified themes since the last sync.
5298
- *
5299
- * Note:
5300
- * There's no point to store a themes counter since even if the number of
5301
- * themes didn't change, we still need to check if the versions are all the
5302
- * same and the activity state is similar.
5303
- *
5304
- * @author Vova Feldman (@svovaf)
5305
- * @since 1.1.8
5306
- *
5307
- * @return array|false
5308
- */
5309
- private function get_themes_data_for_api() {
5310
- // Alias.
5311
- $option_name = 'all_themes';
5312
-
5313
- $all_cached_themes = self::$_accounts->get_option( $option_name );
5314
-
5315
- if ( ! is_object( $all_cached_themes ) ) {
5316
- $all_cached_themes = (object) array(
5317
- 'timestamp' => '',
5318
- 'md5' => '',
5319
- 'themes' => array(),
5320
- );
5321
- }
5322
-
5323
- $time = time();
5324
-
5325
- if ( ! empty( $all_cached_themes->timestamp ) &&
5326
- ( $time - $all_cached_themes->timestamp ) < WP_FS__TIME_5_MIN_IN_SEC
5327
- ) {
5328
- // Don't send theme updates if last update was in the past 5 min.
5329
- return false;
5330
- }
5331
-
5332
- // Write timestamp to lock the logic.
5333
- $all_cached_themes->timestamp = $time;
5334
- self::$_accounts->set_option( $option_name, $all_cached_themes, true );
5335
-
5336
- // Reload options from DB.
5337
- self::$_accounts->load( true );
5338
- $all_cached_themes = self::$_accounts->get_option( $option_name );
5339
-
5340
- if ( $time != $all_cached_themes->timestamp ) {
5341
- // If timestamp is different, then another thread captured the lock.
5342
- return false;
5343
- }
5344
-
5345
- // Get active theme.
5346
- $active_theme = wp_get_theme();
5347
- $active_theme_stylesheet = $active_theme->get_stylesheet();
5348
-
5349
- // Check if there's a change in themes.
5350
- $all_themes = wp_get_themes();
5351
-
5352
- // Check if themes changed.
5353
- ksort( $all_themes );
5354
-
5355
- $themes_signature = '';
5356
- foreach ( $all_themes as $slug => $data ) {
5357
- $is_active = ( $slug === $active_theme_stylesheet );
5358
- $themes_signature .= $slug . ',' .
5359
- $data->version . ',' .
5360
- ( $is_active ? '1' : '0' ) . ';';
5361
- }
5362
-
5363
- // Check if themes status changed (version or active/inactive).
5364
- $themes_changed = ( $all_cached_themes->md5 !== md5( $themes_signature ) );
5365
-
5366
- $themes_update_data = array();
5367
-
5368
- if ( $themes_changed ) {
5369
- // Change in themes, report changes.
5370
-
5371
- // Update existing themes info.
5372
- foreach ( $all_cached_themes->themes as $slug => $data ) {
5373
- $is_active = ( $slug === $active_theme_stylesheet );
5374
-
5375
- if ( ! isset( $all_themes[ $slug ] ) ) {
5376
- // Plugin uninstalled.
5377
- $uninstalled_theme_data = $data;
5378
- $uninstalled_theme_data['is_active'] = false;
5379
- $uninstalled_theme_data['is_uninstalled'] = true;
5380
- $themes_update_data[] = $uninstalled_theme_data;
5381
-
5382
- unset( $all_themes[ $slug ] );
5383
- unset( $all_cached_themes->themes[ $slug ] );
5384
- } else if ( $data['is_active'] !== $is_active ||
5385
- $data['version'] !== $all_themes[ $slug ]->version
5386
- ) {
5387
- // Plugin activated or deactivated, or version changed.
5388
-
5389
- $all_cached_themes->themes[ $slug ]['is_active'] = $is_active;
5390
- $all_cached_themes->themes[ $slug ]['version'] = $all_themes[ $slug ]->version;
5391
-
5392
- $themes_update_data[] = $all_cached_themes->themes[ $slug ];
5393
- }
5394
- }
5395
-
5396
- // Find new themes that weren't yet seen before.
5397
- foreach ( $all_themes as $slug => $data ) {
5398
- if ( ! isset( $all_cached_themes->themes[ $slug ] ) ) {
5399
- $is_active = ( $slug === $active_theme_stylesheet );
5400
-
5401
- // New plugin.
5402
- $new_plugin = array(
5403
- 'slug' => $slug,
5404
- 'version' => $data->version,
5405
- 'title' => $data->name,
5406
- 'is_active' => $is_active,
5407
- 'is_uninstalled' => false,
5408
- );
5409
-
5410
- $themes_update_data[] = $new_plugin;
5411
- $all_cached_themes->themes[ $slug ] = $new_plugin;
5412
- }
5413
- }
5414
-
5415
- $all_cached_themes->md5 = md5( $themes_signature );
5416
- $all_cached_themes->timestamp = time();
5417
- self::$_accounts->set_option( $option_name, $all_cached_themes, true );
5418
- }
5419
-
5420
- return $themes_update_data;
5421
- }
5422
-
5423
- /**
5424
- * Update install details.
5425
- *
5426
- * @author Vova Feldman (@svovaf)
5427
- * @since 1.1.2
5428
- *
5429
- * @param string[] string $override
5430
- * @param bool $include_plugins Since 1.1.8 by default include plugin changes.
5431
- * @param bool $include_themes Since 1.1.8 by default include plugin changes.
5432
- *
5433
- * @return array
5434
- */
5435
- private function get_install_data_for_api(
5436
- array $override,
5437
- $include_plugins = true,
5438
- $include_themes = true
5439
- ) {
5440
- /**
5441
- * @since 1.1.8 Also send plugin updates.
5442
- */
5443
- if ( $include_plugins && ! isset( $override['plugins'] ) ) {
5444
- $plugins = $this->get_plugins_data_for_api();
5445
- if ( ! empty( $plugins ) ) {
5446
- $override['plugins'] = $plugins;
5447
- }
5448
- }
5449
- /**
5450
- * @since 1.1.8 Also send themes updates.
5451
- */
5452
- if ( $include_themes && ! isset( $override['themes'] ) ) {
5453
- $themes = $this->get_themes_data_for_api();
5454
- if ( ! empty( $themes ) ) {
5455
- $override['themes'] = $themes;
5456
- }
5457
- }
5458
-
5459
- return array_merge( array(
5460
- 'version' => $this->get_plugin_version(),
5461
- 'is_premium' => $this->is_premium(),
5462
- 'language' => get_bloginfo( 'language' ),
5463
- 'charset' => get_bloginfo( 'charset' ),
5464
- 'platform_version' => get_bloginfo( 'version' ),
5465
- 'sdk_version' => $this->version,
5466
- 'programming_language_version' => phpversion(),
5467
- 'title' => get_bloginfo( 'name' ),
5468
- 'url' => get_site_url(),
5469
- // Special params.
5470
- 'is_active' => true,
5471
- 'is_disconnected' => $this->is_tracking_prohibited(),
5472
- 'is_uninstalled' => false,
5473
- ), $override );
5474
- }
5475
-
5476
- /**
5477
- * Update install only if changed.
5478
- *
5479
- * @author Vova Feldman (@svovaf)
5480
- * @since 1.0.9
5481
- *
5482
- * @param string[] string $override
5483
- * @param bool $flush
5484
- *
5485
- * @return false|object|string
5486
- */
5487
- private function send_install_update( $override = array(), $flush = false ) {
5488
- $this->_logger->entrance();
5489
-
5490
- $check_properties = $this->get_install_data_for_api( $override );
5491
-
5492
- if ( $flush ) {
5493
- $params = $check_properties;
5494
- } else {
5495
- $params = array();
5496
- $special = array();
5497
- $special_override = false;
5498
-
5499
- foreach ( $check_properties as $p => $v ) {
5500
- if ( property_exists( $this->_site, $p ) ) {
5501
- if ( ( is_bool( $this->_site->{$p} ) || ! empty( $this->_site->{$p} ) ) &&
5502
- $this->_site->{$p} != $v
5503
- ) {
5504
- $this->_site->{$p} = $v;
5505
- $params[ $p ] = $v;
5506
- }
5507
- } else {
5508
- $special[ $p ] = $v;
5509
-
5510
- if ( isset( $override[ $p ] ) ||
5511
- 'plugins' === $p ||
5512
- 'themes' === $p
5513
- ) {
5514
- $special_override = true;
5515
- }
5516
- }
5517
- }
5518
-
5519
- if ( $special_override || 0 < count( $params ) ) {
5520
- // Add special params only if has at least one
5521
- // standard param, or if explicitly requested to
5522
- // override a special param or a param which is not exist
5523
- // in the install object.
5524
- $params = array_merge( $params, $special );
5525
- }
5526
- }
5527
-
5528
- if ( 0 < count( $params ) ) {
5529
- // Update last install sync timestamp.
5530
- $this->_storage->install_sync_timestamp = time();
5531
-
5532
- $params['uid'] = $this->get_anonymous_id();
5533
-
5534
- // Send updated values to FS.
5535
- $site = $this->get_api_site_scope()->call( '/', 'put', $params );
5536
-
5537
- if ( $this->is_api_result_entity( $site ) ) {
5538
- // I successfully sent install update, clear scheduled sync if exist.
5539
- $this->clear_install_sync_cron();
5540
- }
5541
-
5542
- return $site;
5543
- }
5544
-
5545
- return false;
5546
- }
5547
-
5548
- /**
5549
- * Update install only if changed.
5550
- *
5551
- * @author Vova Feldman (@svovaf)
5552
- * @since 1.0.9
5553
- *
5554
- * @param string[] string $override
5555
- * @param bool $flush
5556
- */
5557
- private function sync_install( $override = array(), $flush = false ) {
5558
- $this->_logger->entrance();
5559
-
5560
- $site = $this->send_install_update( $override, $flush );
5561
-
5562
- if ( false === $site ) {
5563
- // No sync required.
5564
- return;
5565
- }
5566
-
5567
- if ( ! $this->is_api_result_entity( $site ) ) {
5568
- // Failed to sync, don't update locally.
5569
- return;
5570
- }
5571
-
5572
- $plan = $this->get_plan();
5573
- $this->_site = new FS_Site( $site );
5574
- $this->_site->plan = $plan;
5575
-
5576
- $this->_store_site( true );
5577
- }
5578
-
5579
- /**
5580
- * Track install's custom event.
5581
- *
5582
- * IMPORTANT:
5583
- * Custom event tracking is currently only supported for specific clients.
5584
- * If you are not one of them, please don't use this method. If you will,
5585
- * the API will simply ignore your request based on the plugin ID.
5586
- *
5587
- * Need custom tracking for your plugin or theme?
5588
- * If you are interested in custom event tracking please contact yo@freemius.com
5589
- * for further details.
5590
- *
5591
- * @author Vova Feldman (@svovaf)
5592
- * @since 1.2.1
5593
- *
5594
- * @param string $name Event name.
5595
- * @param array $properties Associative key/value array with primitive values only
5596
- * @param bool $process_at A valid future date-time in the following format Y-m-d H:i:s.
5597
- * @param bool $once If true, event will be tracked only once. IMPORTANT: Still trigger the API call.
5598
- *
5599
- * @return object|false Event data or FALSE on failure.
5600
- *
5601
- * @throws \Freemius_InvalidArgumentException
5602
- */
5603
- public function track_event( $name, $properties = array(), $process_at = false, $once = false ) {
5604
- $this->_logger->entrance( http_build_query( array( 'name' => $name, 'once' => $once ) ) );
5605
-
5606
- if ( ! $this->is_registered() ) {
5607
- return false;
5608
- }
5609
-
5610
- $event = array( 'type' => $name );
5611
-
5612
- if ( is_numeric( $process_at ) && $process_at > time() ) {
5613
- $event['process_at'] = $process_at;
5614
- }
5615
-
5616
- if ( $once ) {
5617
- $event['once'] = true;
5618
- }
5619
-
5620
- if ( ! empty( $properties ) ) {
5621
- // Verify associative array values are primitive.
5622
- foreach ( $properties as $k => $v ) {
5623
- if ( ! is_scalar( $v ) ) {
5624
- throw new Freemius_InvalidArgumentException( 'The $properties argument must be an associative key/value array with primitive values only.' );
5625
- }
5626
- }
5627
-
5628
- $event['properties'] = $properties;
5629
- }
5630
-
5631
- $result = $this->get_api_site_scope()->call( 'events.json', 'post', $event );
5632
-
5633
- return $this->is_api_error( $result ) ?
5634
- false :
5635
- $result;
5636
- }
5637
-
5638
- /**
5639
- * Track install's custom event only once, but it still triggers the API call.
5640
- *
5641
- * IMPORTANT:
5642
- * Custom event tracking is currently only supported for specific clients.
5643
- * If you are not one of them, please don't use this method. If you will,
5644
- * the API will simply ignore your request based on the plugin ID.
5645
- *
5646
- * Need custom tracking for your plugin or theme?
5647
- * If you are interested in custom event tracking please contact yo@freemius.com
5648
- * for further details.
5649
- *
5650
- * @author Vova Feldman (@svovaf)
5651
- * @since 1.2.1
5652
- *
5653
- * @param string $name Event name.
5654
- * @param array $properties Associative key/value array with primitive values only
5655
- * @param bool $process_at A valid future date-time in the following format Y-m-d H:i:s.
5656
- *
5657
- * @return object|false Event data or FALSE on failure.
5658
- *
5659
- * @throws \Freemius_InvalidArgumentException
5660
- *
5661
- * @user Freemius::track_event()
5662
- */
5663
- public function track_event_once( $name, $properties = array(), $process_at = false ) {
5664
- return $this->track_event( $name, $properties, $process_at, true );
5665
- }
5666
-
5667
- /**
5668
- * Plugin uninstall hook.
5669
- *
5670
- * @author Vova Feldman (@svovaf)
5671
- * @since 1.0.1
5672
- *
5673
- * @param bool $check_user Enforce checking if user have plugins activation privileges.
5674
- */
5675
- function _uninstall_plugin_event( $check_user = true ) {
5676
- $this->_logger->entrance( 'slug = ' . $this->_slug );
5677
-
5678
- if ( $check_user && ! current_user_can( 'activate_plugins' ) ) {
5679
- return;
5680
- }
5681
-
5682
- $params = array();
5683
- $uninstall_reason = null;
5684
- if ( isset( $this->_storage->uninstall_reason ) ) {
5685
- $uninstall_reason = $this->_storage->uninstall_reason;
5686
- $params['reason_id'] = $uninstall_reason->id;
5687
- $params['reason_info'] = $uninstall_reason->info;
5688
- }
5689
-
5690
- if ( ! $this->is_registered() ) {
5691
- // Send anonymous uninstall event only if user submitted a feedback.
5692
- if ( isset( $uninstall_reason ) ) {
5693
- if ( isset( $uninstall_reason->is_anonymous ) && ! $uninstall_reason->is_anonymous ) {
5694
- $this->opt_in( false, false, false, false, true );
5695
- } else {
5696
- $params['uid'] = $this->get_anonymous_id();
5697
- $this->get_api_plugin_scope()->call( 'uninstall.json', 'put', $params );
5698
- }
5699
- }
5700
- } else {
5701
- // Send uninstall event.
5702
- $this->send_install_update( array_merge( $params, array(
5703
- 'is_active' => false,
5704
- 'is_uninstalled' => true,
5705
- ) ) );
5706
- }
5707
-
5708
- // @todo Decide if we want to delete plugin information from db.
5709
- }
5710
-
5711
- /**
5712
- * @author Vova Feldman (@svovaf)
5713
- * @since 1.1.1
5714
- *
5715
- * @return string
5716
- */
5717
- function premium_plugin_basename() {
5718
- return "{$this->_slug}-premium/" . basename( $this->_free_plugin_basename );
5719
- }
5720
-
5721
- /**
5722
- * Uninstall plugin hook. Called only when connected his account with Freemius for active sites tracking.
5723
- *
5724
- * @author Vova Feldman (@svovaf)
5725
- * @since 1.0.2
5726
- */
5727
- public static function _uninstall_plugin_hook() {
5728
- self::_load_required_static();
5729
-
5730
- self::$_static_logger->entrance();
5731
-
5732
- if ( ! current_user_can( 'activate_plugins' ) ) {
5733
- return;
5734
- }
5735
-
5736
- $plugin_file = substr( current_filter(), strlen( 'uninstall_' ) );
5737
-
5738
- self::$_static_logger->info( 'plugin = ' . $plugin_file );
5739
-
5740
- define( 'WP_FS__UNINSTALL_MODE', true );
5741
-
5742
- $fs = self::get_instance_by_file( $plugin_file );
5743
-
5744
- if ( is_object( $fs ) ) {
5745
- self::require_plugin_essentials();
5746
-
5747
- if ( is_plugin_active( $fs->_free_plugin_basename ) ||
5748
- is_plugin_active( $fs->premium_plugin_basename() )
5749
- ) {
5750
- // Deleting Free or Premium plugin version while the other version still installed.
5751
- return;
5752
- }
5753
-
5754
- $fs->_uninstall_plugin_event();
5755
-
5756
- $fs->do_action( 'after_uninstall' );
5757
- }
5758
- }
5759
-
5760
- #----------------------------------------------------------------------------------
5761
- #region Plugin Information
5762
- #----------------------------------------------------------------------------------
5763
-
5764
- /**
5765
- * Load WordPress core plugin.php essential module.
5766
- *
5767
- * @author Vova Feldman (@svovaf)
5768
- * @since 1.1.1
5769
- */
5770
- private static function require_plugin_essentials() {
5771
- if ( ! function_exists( 'get_plugins' ) ) {
5772
- self::$_static_logger->log( 'Including wp-admin/includes/plugin.php...' );
5773
-
5774
- require_once ABSPATH . 'wp-admin/includes/plugin.php';
5775
- }
5776
- }
5777
-
5778
- /**
5779
- * Load WordPress core pluggable.php module.
5780
- *
5781
- * @author Vova Feldman (@svovaf)
5782
- * @since 1.1.2
5783
- */
5784
- private static function require_pluggable_essentials() {
5785
- if ( ! function_exists( 'wp_get_current_user' ) ) {
5786
- require_once ABSPATH . 'wp-includes/pluggable.php';
5787
- }
5788
- }
5789
-
5790
- /**
5791
- * Return plugin data.
5792
- *
5793
- * @author Vova Feldman (@svovaf)
5794
- * @since 1.0.1
5795
- *
5796
- * @return array
5797
- */
5798
- function get_plugin_data() {
5799
- if ( ! isset( $this->_plugin_data ) ) {
5800
- self::require_plugin_essentials();
5801
-
5802
- if ( $this->is_plugin() ) {
5803
- /**
5804
- * @author Vova Feldman (@svovaf)
5805
- * @since 1.2.0 When using get_plugin_data() do NOT translate plugin data.
5806
- *
5807
- * @link https://github.com/Freemius/wordpress-sdk/issues/77
5808
- */
5809
- $plugin_data = get_plugin_data(
5810
- $this->_plugin_main_file_path,
5811
- false,
5812
- false
5813
- );
5814
- } else {
5815
- $theme_data = wp_get_theme();
5816
-
5817
- $plugin_data = array(
5818
- 'Name' => $theme_data->get( 'Name' ),
5819
- 'Version' => $theme_data->get( 'Version' ),
5820
- 'Author' => $theme_data->get( 'Author' ),
5821
- 'Description' => $theme_data->get( 'Description' ),
5822
- 'PluginURI' => $theme_data->get( 'ThemeURI' ),
5823
- );
5824
- }
5825
-
5826
- $this->_plugin_data = $plugin_data;
5827
- }
5828
-
5829
- return $this->_plugin_data;
5830
- }
5831
-
5832
- /**
5833
- * @author Vova Feldman (@svovaf)
5834
- * @since 1.0.1
5835
- * @since 1.2.2.5 If slug not set load slug by module ID.
5836
- *
5837
- * @return string Plugin slug.
5838
- */
5839
- function get_slug() {
5840
- if ( ! isset( $this->_slug ) ) {
5841
- $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map', array() );
5842
- $this->_slug = $id_slug_type_path_map[ $this->_module_id ]['slug'];
5843
- }
5844
-
5845
- return $this->_slug;
5846
- }
5847
-
5848
- /**
5849
- * @author Vova Feldman (@svovaf)
5850
- * @since 1.2.1.7
5851
- *
5852
- * @return string Plugin slug.
5853
- */
5854
- function get_target_folder_name() {
5855
- return $this->_slug . ( $this->can_use_premium_code() ? '-premium' : '' );
5856
- }
5857
-
5858
- /**
5859
- * @author Vova Feldman (@svovaf)
5860
- * @since 1.0.1
5861
- *
5862
- * @return number Plugin ID.
5863
- */
5864
- function get_id() {
5865
- return $this->_plugin->id;
5866
- }
5867
-
5868
- /**
5869
- * @author Vova Feldman (@svovaf)
5870
- * @since 1.2.1.5
5871
- *
5872
- * @return string Freemius SDK version
5873
- */
5874
- function get_sdk_version() {
5875
- return $this->version;
5876
- }
5877
-
5878
- /**
5879
- * @author Vova Feldman (@svovaf)
5880
- * @since 1.2.1.5
5881
- *
5882
- * @return number Parent plugin ID (if parent exist).
5883
- */
5884
- function get_parent_id() {
5885
- return $this->is_addon() ?
5886
- $this->get_parent_instance()->get_id() :
5887
- $this->_plugin->id;
5888
- }
5889
-
5890
- /**
5891
- * @author Vova Feldman (@svovaf)
5892
- * @since 1.0.1
5893
- *
5894
- * @return string Plugin public key.
5895
- */
5896
- function get_public_key() {
5897
- return $this->_plugin->public_key;
5898
- }
5899
-
5900
- /**
5901
- * Will be available only on sandbox mode.
5902
- *
5903
- * @author Vova Feldman (@svovaf)
5904
- * @since 1.0.4
5905
- *
5906
- * @return mixed Plugin secret key.
5907
- */
5908
- function get_secret_key() {
5909
- return $this->_plugin->secret_key;
5910
- }
5911
-
5912
- /**
5913
- * @author Vova Feldman (@svovaf)
5914
- * @since 1.1.1
5915
- *
5916
- * @return bool
5917
- */
5918
- function has_secret_key() {
5919
- return ! empty( $this->_plugin->secret_key );
5920
- }
5921
-
5922
- /**
5923
- * @author Vova Feldman (@svovaf)
5924
- * @since 1.0.9
5925
- *
5926
- * @return string
5927
- */
5928
- function get_plugin_name() {
5929
- $this->_logger->entrance();
5930
-
5931
- if ( ! isset( $this->_plugin_name ) ) {
5932
- $plugin_data = $this->get_plugin_data();
5933
-
5934
- // Get name.
5935
- $this->_plugin_name = $plugin_data['Name'];
5936
-
5937
- // Check if plugin name contains "(Premium)" suffix and remove it.
5938
- $suffix = ' (premium)';
5939
- $suffix_len = strlen( $suffix );
5940
-
5941
- if ( strlen( $plugin_data['Name'] ) > $suffix_len &&
5942
- $suffix === substr( strtolower( $plugin_data['Name'] ), - $suffix_len )
5943
- ) {
5944
- $this->_plugin_name = substr( $plugin_data['Name'], 0, - $suffix_len );
5945
- }
5946
-
5947
- $this->_logger->departure( 'Name = ' . $this->_plugin_name );
5948
- }
5949
-
5950
- return $this->_plugin_name;
5951
- }
5952
-
5953
- /**
5954
- * @author Vova Feldman (@svovaf)
5955
- * @since 1.0.0
5956
- *
5957
- * @return string
5958
- */
5959
- function get_plugin_version() {
5960
- $this->_logger->entrance();
5961
-
5962
- $plugin_data = $this->get_plugin_data();
5963
-
5964
- $this->_logger->departure( 'Version = ' . $plugin_data['Version'] );
5965
-
5966
- return $this->apply_filters( 'plugin_version', $plugin_data['Version'] );
5967
- }
5968
-
5969
- /**
5970
- * @author Vova Feldman (@svovaf)
5971
- * @since 1.2.1.7
5972
- *
5973
- * @return string
5974
- */
5975
- function get_plugin_title() {
5976
- $this->_logger->entrance();
5977
-
5978
- $title = $this->_plugin->title;
5979
-
5980
- return $this->apply_filters( 'plugin_title', $title );
5981
- }
5982
-
5983
- /**
5984
- * @author Vova Feldman (@svovaf)
5985
- * @since 1.2.2.7
5986
- *
5987
- * @param bool $lowercase
5988
- *
5989
- * @return string
5990
- */
5991
- function get_module_label( $lowercase = false ) {
5992
- $label = $this->is_addon() ?
5993
- $this->get_text_inline( 'Add-On', 'addon' ) :
5994
- ( $this->is_plugin() ?
5995
- $this->get_text_inline( 'Plugin', 'plugin' ) :
5996
- $this->get_text_inline( 'Theme', 'theme' ) );
5997
-
5998
- if ( $lowercase ) {
5999
- $label = strtolower( $label );
6000
- }
6001
-
6002
- return $label;
6003
- }
6004
-
6005
- /**
6006
- * @author Vova Feldman (@svovaf)
6007
- * @since 1.0.4
6008
- *
6009
- * @return string
6010
- */
6011
- function get_plugin_basename() {
6012
- if ( ! isset( $this->_plugin_basename ) ) {
6013
- if ( $this->is_plugin() ) {
6014
- $this->_plugin_basename = plugin_basename( $this->_plugin_main_file_path );
6015
- } else {
6016
- $this->_plugin_basename = basename( dirname( $this->_plugin_main_file_path ) );
6017
- }
6018
- }
6019
-
6020
- return $this->_plugin_basename;
6021
- }
6022
-
6023
- function get_plugin_folder_name() {
6024
- $this->_logger->entrance();
6025
-
6026
- $plugin_folder = $this->_plugin_basename;
6027
-
6028
- while ( '.' !== dirname( $plugin_folder ) ) {
6029
- $plugin_folder = dirname( $plugin_folder );
6030
- }
6031
-
6032
- $this->_logger->departure( 'Folder Name = ' . $plugin_folder );
6033
-
6034
- return $plugin_folder;
6035
- }
6036
-
6037
- #endregion ------------------------------------------------------------------
6038
-
6039
- /* Account
6040
- ------------------------------------------------------------------------------------------------------------------*/
6041
 
6042
- /**
6043
- * Find plugin's slug by plugin's basename.
6044
- *
6045
- * @author Vova Feldman (@svovaf)
6046
- * @since 1.0.9
6047
- *
6048
- * @param string $plugin_base_name
6049
- *
6050
- * @return false|string
6051
- */
6052
- private static function find_slug_by_basename( $plugin_base_name ) {
6053
- $file_slug_map = self::$_accounts->get_option( 'file_slug_map', array() );
6054
-
6055
- if ( ! array( $file_slug_map ) || ! isset( $file_slug_map[ $plugin_base_name ] ) ) {
6056
- return false;
6057
- }
6058
-
6059
- return $file_slug_map[ $plugin_base_name ];
6060
- }
6061
-
6062
- /**
6063
- * Store the map between the plugin's basename to the slug.
6064
- *
6065
- * @author Vova Feldman (@svovaf)
6066
- * @since 1.0.9
6067
- */
6068
- private function store_file_slug_map() {
6069
- $file_slug_map = self::$_accounts->get_option( 'file_slug_map', array() );
6070
-
6071
- if ( ! array( $file_slug_map ) ) {
6072
- $file_slug_map = array();
6073
- }
6074
-
6075
- if ( ! isset( $file_slug_map[ $this->_plugin_basename ] ) ||
6076
- $file_slug_map[ $this->_plugin_basename ] !== $this->_slug
6077
- ) {
6078
- $file_slug_map[ $this->_plugin_basename ] = $this->_slug;
6079
- self::$_accounts->set_option( 'file_slug_map', $file_slug_map, true );
6080
- }
6081
- }
6082
-
6083
- /**
6084
- * @return FS_User[]
6085
- */
6086
- static function get_all_users() {
6087
- $users = self::$_accounts->get_option( 'users', array() );
6088
-
6089
- if ( ! is_array( $users ) ) {
6090
- $users = array();
6091
- }
6092
-
6093
- return $users;
6094
- }
6095
-
6096
- /**
6097
- * @param string $module_type
6098
- *
6099
- * @return FS_Site[]
6100
- */
6101
- private static function get_all_sites( $module_type = WP_FS__MODULE_TYPE_PLUGIN ) {
6102
- $sites = self::get_account_option( 'sites', $module_type );
6103
-
6104
- if ( ! is_array( $sites ) ) {
6105
- $sites = array();
6106
- }
6107
-
6108
- return $sites;
6109
- }
6110
-
6111
- /**
6112
- * @author Leo Fajardo (@leorw)
6113
- *
6114
- * @since 1.2.2
6115
- *
6116
- * @param string $option_name
6117
- * @param string $module_type
6118
- *
6119
- * @return mixed
6120
- */
6121
- private static function get_account_option( $option_name, $module_type ) {
6122
- if ( WP_FS__MODULE_TYPE_PLUGIN !== $module_type ) {
6123
- $option_name = $module_type . '_' . $option_name;
6124
- }
6125
-
6126
- return self::$_accounts->get_option( $option_name, array() );
6127
- }
6128
-
6129
- /**
6130
- * @author Leo Fajardo (@leorw)
6131
- *
6132
- * @since 1.2.2
6133
- *
6134
- * @param string $option_name
6135
- * @param mixed $option_value
6136
- * @param bool $store
6137
- */
6138
- private function set_account_option( $option_name, $option_value, $store ) {
6139
- self::set_account_option_by_module(
6140
- $this->_module_type,
6141
- $option_name,
6142
- $option_value,
6143
- $store
6144
- );
6145
- }
6146
-
6147
- /**
6148
- * @author Vova Feldman (@svovaf)
6149
- *
6150
- * @since 1.2.2.7
6151
- *
6152
- * @param string $module_type
6153
- * @param string $option_name
6154
- * @param mixed $option_value
6155
- * @param bool $store
6156
- */
6157
- private static function set_account_option_by_module( $module_type, $option_name, $option_value, $store ) {
6158
- if ( WP_FS__MODULE_TYPE_PLUGIN != $module_type ) {
6159
- $option_name = $module_type . '_' . $option_name;
6160
- }
6161
-
6162
- self::$_accounts->set_option( $option_name, $option_value, $store );
6163
- }
6164
-
6165
- /**
6166
- * @author Vova Feldman (@svovaf)
6167
- * @since 1.0.6
6168
- *
6169
- * @param string $module_type
6170
- *
6171
- * @return FS_Plugin_License[]
6172
- */
6173
- private static function get_all_licenses( $module_type = WP_FS__MODULE_TYPE_PLUGIN ) {
6174
- $licenses = self::get_account_option( 'licenses', $module_type );
6175
-
6176
- if ( ! is_array( $licenses ) ) {
6177
- $licenses = array();
6178
- }
6179
-
6180
- return $licenses;
6181
- }
6182
-
6183
- /**
6184
- * @param string|bool $module_type
6185
- *
6186
- * @return FS_Plugin_Plan[]
6187
- */
6188
- private static function get_all_plans( $module_type = false ) {
6189
- $plans = self::get_account_option( 'plans', $module_type );
6190
-
6191
- if ( ! is_array( $plans ) ) {
6192
- $plans = array();
6193
- }
6194
-
6195
- return $plans;
6196
- }
6197
-
6198
- /**
6199
- * @author Vova Feldman (@svovaf)
6200
- * @since 1.0.4
6201
- *
6202
- * @return FS_Plugin_Tag[]
6203
- */
6204
- private static function get_all_updates() {
6205
- $updates = self::$_accounts->get_option( 'updates', array() );
6206
-
6207
- if ( ! is_array( $updates ) ) {
6208
- $updates = array();
6209
- }
6210
-
6211
- return $updates;
6212
- }
6213
-
6214
- /**
6215
- * @author Vova Feldman (@svovaf)
6216
- * @since 1.0.6
6217
- *
6218
- * @return array<number,FS_Plugin[]>|false
6219
- */
6220
- private static function get_all_addons() {
6221
- $addons = self::$_accounts->get_option( 'addons', array() );
6222
-
6223
- if ( ! is_array( $addons ) ) {
6224
- $addons = array();
6225
- }
6226
-
6227
- return $addons;
6228
- }
6229
-
6230
- /**
6231
- * @author Vova Feldman (@svovaf)
6232
- * @since 1.0.6
6233
- *
6234
- * @return FS_Plugin[]|false
6235
- */
6236
- private static function get_all_account_addons() {
6237
- $addons = self::$_accounts->get_option( 'account_addons', array() );
6238
-
6239
- if ( ! is_array( $addons ) ) {
6240
- $addons = array();
6241
- }
6242
-
6243
- return $addons;
6244
- }
6245
-
6246
- /**
6247
- * Check if user has connected his account (opted-in).
6248
- *
6249
- * Note:
6250
- * If the user opted-in and opted-out on a later stage,
6251
- * this will still return true. If you want to check if the
6252
- * user is currently opted-in, use:
6253
- * `$fs->is_registered() && $fs->is_tracking_allowed()`
6254
- *
6255
- * @author Vova Feldman (@svovaf)
6256
- * @since 1.0.1
6257
- * @return bool
6258
- */
6259
- function is_registered() {
6260
- return is_object( $this->_user );
6261
- }
6262
-
6263
- /**
6264
- * Returns TRUE if the user opted-in and didn't disconnect (opt-out).
6265
- *
6266
- * @author Leo Fajardo (@leorw)
6267
- * @since 1.2.1.5
6268
- *
6269
- * @return bool
6270
- */
6271
- function is_tracking_allowed() {
6272
- return ( is_object( $this->_site ) && true !== $this->_site->is_disconnected );
6273
- }
6274
-
6275
- /**
6276
- * @author Vova Feldman (@svovaf)
6277
- * @since 1.0.4
6278
- *
6279
- * @return FS_Plugin
6280
- */
6281
- function get_plugin() {
6282
- return $this->_plugin;
6283
- }
6284
-
6285
- /**
6286
- * @author Vova Feldman (@svovaf)
6287
- * @since 1.0.3
6288
- *
6289
- * @return FS_User
6290
- */
6291
- function get_user() {
6292
- return $this->_user;
6293
- }
6294
-
6295
- /**
6296
- * @author Vova Feldman (@svovaf)
6297
- * @since 1.0.3
6298
- *
6299
- * @return FS_Site
6300
- */
6301
- function get_site() {
6302
- return $this->_site;
6303
- }
6304
-
6305
- /**
6306
- * Get plugin add-ons.
6307
- *
6308
- * @author Vova Feldman (@svovaf)
6309
- * @since 1.0.6
6310
- *
6311
- * @since 1.1.7.3 If not yet loaded, fetch data from the API.
6312
- *
6313
- * @param bool $flush
6314
- *
6315
- * @return FS_Plugin[]|false
6316
- */
6317
- function get_addons( $flush = false ) {
6318
- $this->_logger->entrance();
6319
-
6320
- if ( ! $this->_has_addons ) {
6321
- return false;
6322
- }
6323
-
6324
- $addons = $this->sync_addons( $flush );
6325
-
6326
- return ( ! is_array( $addons ) || empty( $addons ) ) ?
6327
- false :
6328
- $addons;
6329
- }
6330
-
6331
- /**
6332
- * @author Vova Feldman (@svovaf)
6333
- * @since 1.0.6
6334
- *
6335
- * @return FS_Plugin[]|false
6336
- */
6337
- function get_account_addons() {
6338
- $this->_logger->entrance();
6339
-
6340
- $addons = self::get_all_account_addons();
6341
-
6342
- if ( ! is_array( $addons ) ||
6343
- ! isset( $addons[ $this->_plugin->id ] ) ||
6344
- ! is_array( $addons[ $this->_plugin->id ] ) ||
6345
- 0 === count( $addons[ $this->_plugin->id ] )
6346
- ) {
6347
- return false;
6348
- }
6349
-
6350
- return $addons[ $this->_plugin->id ];
6351
- }
6352
-
6353
- /**
6354
- * Check if user has any
6355
- *
6356
- * @author Vova Feldman (@svovaf)
6357
- * @since 1.1.6
6358
- *
6359
- * @return bool
6360
- */
6361
- function has_account_addons() {
6362
- $addons = $this->get_account_addons();
6363
-
6364
- return is_array( $addons ) && ( 0 < count( $addons ) );
6365
- }
6366
-
6367
-
6368
- /**
6369
- * Get add-on by ID (from local data).
6370
- *
6371
- * @author Vova Feldman (@svovaf)
6372
- * @since 1.0.6
6373
- *
6374
- * @param number $id
6375
- *
6376
- * @return FS_Plugin|false
6377
- */
6378
- function get_addon( $id ) {
6379
- $this->_logger->entrance();
6380
-
6381
- $addons = $this->get_addons();
6382
-
6383
- if ( is_array( $addons ) ) {
6384
- foreach ( $addons as $addon ) {
6385
- if ( $id == $addon->id ) {
6386
- return $addon;
6387
- }
6388
- }
6389
- }
6390
-
6391
- return false;
6392
- }
6393
-
6394
- /**
6395
- * Get add-on by slug (from local data).
6396
- *
6397
- * @author Vova Feldman (@svovaf)
6398
- * @since 1.0.6
6399
- *
6400
- * @param string $slug
6401
- *
6402
- * @param bool $flush
6403
- *
6404
- * @return FS_Plugin|false
6405
- */
6406
- function get_addon_by_slug( $slug, $flush = false ) {
6407
- $this->_logger->entrance();
6408
-
6409
- $addons = $this->get_addons( $flush );
6410
-
6411
- if ( is_array( $addons ) ) {
6412
- foreach ( $addons as $addon ) {
6413
- if ( $slug === $addon->slug ) {
6414
- return $addon;
6415
- }
6416
- }
6417
- }
6418
-
6419
- return false;
6420
- }
6421
-
6422
- #----------------------------------------------------------------------------------
6423
- #region Plans & Licensing
6424
- #----------------------------------------------------------------------------------
6425
-
6426
- /**
6427
- * Check if running premium plugin code.
6428
- *
6429
- * @author Vova Feldman (@svovaf)
6430
- * @since 1.0.5
6431
- *
6432
- * @return bool
6433
- */
6434
- function is_premium() {
6435
- return $this->_plugin->is_premium;
6436
- }
6437
-
6438
- /**
6439
- * Get site's plan ID.
6440
- *
6441
- * @author Vova Feldman (@svovaf)
6442
- * @since 1.0.2
6443
- *
6444
- * @return number
6445
- */
6446
- function get_plan_id() {
6447
- return $this->_site->plan->id;
6448
- }
6449
-
6450
- /**
6451
- * Get site's plan title.
6452
- *
6453
- * @author Vova Feldman (@svovaf)
6454
- * @since 1.0.2
6455
- *
6456
- * @return string
6457
- */
6458
- function get_plan_title() {
6459
- return $this->_site->plan->title;
6460
- }
6461
-
6462
- /**
6463
- * @author Vova Feldman (@svovaf)
6464
- * @since 1.0.9
6465
- *
6466
- * @return FS_Plugin_Plan|false
6467
- */
6468
- function get_plan() {
6469
- return is_object( $this->_site->plan ) ?
6470
- $this->_site->plan :
6471
- false;
6472
- }
6473
-
6474
- /**
6475
- * @author Vova Feldman (@svovaf)
6476
- * @since 1.0.3
6477
- *
6478
- * @return bool
6479
- */
6480
- function is_trial() {
6481
- $this->_logger->entrance();
6482
-
6483
- if ( ! $this->is_registered() ) {
6484
- return false;
6485
- }
6486
-
6487
- return $this->_site->is_trial();
6488
- }
6489
-
6490
- /**
6491
- * Check if currently in a trial with payment method (credit card or paypal).
6492
- *
6493
- * @author Vova Feldman (@svovaf)
6494
- * @since 1.1.7
6495
- *
6496
- * @return bool
6497
- */
6498
- function is_paid_trial() {
6499
- $this->_logger->entrance();
6500
-
6501
- if ( ! $this->is_trial() ) {
6502
- return false;
6503
- }
6504
-
6505
- return $this->has_active_valid_license() && ( $this->_site->trial_plan_id == $this->_license->plan_id );
6506
- }
6507
-
6508
- /**
6509
- * Check if trial already utilized.
6510
- *
6511
- * @since 1.0.9
6512
- *
6513
- * @return bool
6514
- */
6515
- function is_trial_utilized() {
6516
- $this->_logger->entrance();
6517
-
6518
- if ( ! $this->is_registered() ) {
6519
- return false;
6520
- }
6521
-
6522
- return $this->_site->is_trial_utilized();
6523
- }
6524
-
6525
- /**
6526
- * Get trial plan information (if in trial).
6527
- *
6528
- * @author Vova Feldman (@svovaf)
6529
- * @since 1.0.9
6530
- *
6531
- * @return bool|FS_Plugin_Plan
6532
- */
6533
- function get_trial_plan() {
6534
- $this->_logger->entrance();
6535
-
6536
- if ( ! $this->is_trial() ) {
6537
- return false;
6538
- }
6539
-
6540
- return $this->_storage->trial_plan;
6541
- }
6542
-
6543
- /**
6544
- * Check if the user has an activate, non-expired license on current plugin's install.
6545
- *
6546
- * @since 1.0.9
6547
- *
6548
- * @return bool
6549
- */
6550
- function is_paying() {
6551
- $this->_logger->entrance();
6552
-
6553
- if ( ! $this->is_registered() ) {
6554
- return false;
6555
- }
6556
-
6557
- if ( ! $this->has_paid_plan() ) {
6558
- return false;
6559
- }
6560
-
6561
- return (
6562
- ! $this->is_trial() &&
6563
- 'free' !== $this->_site->plan->name &&
6564
- $this->has_active_valid_license()
6565
- );
6566
- }
6567
-
6568
- /**
6569
- * @author Vova Feldman (@svovaf)
6570
- * @since 1.0.4
6571
- *
6572
- * @return bool
6573
- */
6574
- function is_free_plan() {
6575
- if ( ! $this->is_registered() ) {
6576
- return true;
6577
- }
6578
-
6579
- if ( ! $this->has_paid_plan() ) {
6580
- return true;
6581
- }
6582
-
6583
- return (
6584
- 'free' === $this->_site->plan->name ||
6585
- ! $this->has_features_enabled_license()
6586
- );
6587
- }
6588
-
6589
- /**
6590
- * @author Vova Feldman (@svovaf)
6591
- * @since 1.0.5
6592
- *
6593
- * @return bool
6594
- */
6595
- function _has_premium_license() {
6596
- $this->_logger->entrance();
6597
-
6598
- $premium_license = $this->_get_available_premium_license();
6599
-
6600
- return ( false !== $premium_license );
6601
- }
6602
-
6603
- /**
6604
- * Check if user has any licenses associated with the plugin (including expired or blocking).
6605
- *
6606
- * @author Vova Feldman (@svovaf)
6607
- * @since 1.1.7.3
6608
- *
6609
- * @return bool
6610
- */
6611
- private function has_any_license() {
6612
- return is_array( $this->_licenses ) && ( 0 < count( $this->_licenses ) );
6613
- }
6614
-
6615
- /**
6616
- * @author Vova Feldman (@svovaf)
6617
- * @since 1.0.5
6618
- *
6619
- * @return FS_Plugin_License|false
6620
- */
6621
- function _get_available_premium_license() {
6622
- $this->_logger->entrance();
6623
-
6624
- if ( ! $this->has_paid_plan() ) {
6625
- return false;
6626
- }
6627
-
6628
- if ( is_array( $this->_licenses ) ) {
6629
- foreach ( $this->_licenses as $license ) {
6630
- if ( ! $license->is_utilized() && $license->is_features_enabled() ) {
6631
- return $license;
6632
- }
6633
- }
6634
- }
6635
-
6636
- return false;
6637
- }
6638
-
6639
- /**
6640
- * Sync local plugin plans with remote server.
6641
- *
6642
- * @author Vova Feldman (@svovaf)
6643
- * @since 1.0.5
6644
- *
6645
- * @return FS_Plugin_Plan[]|object
6646
- */
6647
- function _sync_plans() {
6648
- $plans = $this->_fetch_plugin_plans();
6649
-
6650
- if ( $this->is_array_instanceof( $plans, 'FS_Plugin_Plan' ) ) {
6651
- $this->_plans = $plans;
6652
- $this->_store_plans();
6653
- }
6654
-
6655
- $this->do_action( 'after_plans_sync', $plans );
6656
-
6657
- return $this->_plans;
6658
- }
6659
-
6660
- /**
6661
- * @author Vova Feldman (@svovaf)
6662
- * @since 1.0.5
6663
- *
6664
- * @param number $id
6665
- *
6666
- * @return FS_Plugin_Plan|false
6667
- */
6668
- function _get_plan_by_id( $id ) {
6669
- $this->_logger->entrance();
6670
-
6671
- if ( ! is_array( $this->_plans ) || 0 === count( $this->_plans ) ) {
6672
- $this->_sync_plans();
6673
- }
6674
-
6675
- foreach ( $this->_plans as $plan ) {
6676
- if ( $id == $plan->id ) {
6677
- return $plan;
6678
- }
6679
- }
6680
-
6681
- return false;
6682
- }
6683
-
6684
- /**
6685
- * @author Vova Feldman (@svovaf)
6686
- * @since 1.1.8.1
6687
- *
6688
- * @param string $name
6689
- *
6690
- * @return FS_Plugin_Plan|false
6691
- */
6692
- private function get_plan_by_name( $name ) {
6693
- $this->_logger->entrance();
6694
-
6695
- if ( ! is_array( $this->_plans ) || 0 === count( $this->_plans ) ) {
6696
- $this->_sync_plans();
6697
- }
6698
-
6699
- foreach ( $this->_plans as $plan ) {
6700
- if ( $name == $plan->name ) {
6701
- return $plan;
6702
- }
6703
- }
6704
-
6705
- return false;
6706
- }
6707
-
6708
- /**
6709
- * Sync local plugin plans with remote server.
6710
- *
6711
- * @author Vova Feldman (@svovaf)
6712
- * @since 1.0.6
6713
- *
6714
- * @param number|bool $site_license_id
6715
- *
6716
- * @return FS_Plugin_License[]|object
6717
- */
6718
- function _sync_licenses( $site_license_id = false ) {
6719
- $licenses = $this->_fetch_licenses( false, $site_license_id );
6720
-
6721
- if ( $this->is_array_instanceof( $licenses, 'FS_Plugin_License' ) ) {
6722
- $this->_licenses = $licenses;
6723
- $this->_store_licenses();
6724
- }
6725
-
6726
- // Update current license.
6727
- if ( is_object( $this->_license ) ) {
6728
- $this->_license = $this->_get_license_by_id( $this->_license->id );
6729
- }
6730
-
6731
- return $this->_licenses;
6732
- }
6733
-
6734
- /**
6735
- * @author Vova Feldman (@svovaf)
6736
- * @since 1.0.5
6737
- *
6738
- * @param number $id
6739
- *
6740
- * @return FS_Plugin_License|false
6741
- */
6742
- function _get_license_by_id( $id ) {
6743
- $this->_logger->entrance();
6744
-
6745
- if ( ! is_numeric( $id ) ) {
6746
- return false;
6747
- }
6748
-
6749
- if ( ! $this->has_any_license() ) {
6750
- $this->_sync_licenses();
6751
- }
6752
-
6753
- foreach ( $this->_licenses as $license ) {
6754
- if ( $id == $license->id ) {
6755
- return $license;
6756
- }
6757
- }
6758
-
6759
- return false;
6760
- }
6761
-
6762
- /**
6763
- * Sync site's license with user licenses.
6764
- *
6765
- * @author Vova Feldman (@svovaf)
6766
- * @since 1.0.6
6767
- *
6768
- * @param FS_Plugin_License|null $new_license
6769
- */
6770
- function _update_site_license( $new_license ) {
6771
- $this->_logger->entrance();
6772
-
6773
- $this->_license = $new_license;
6774
-
6775
- if ( ! is_object( $new_license ) ) {
6776
- $this->_site->license_id = null;
6777
- $this->_sync_site_subscription( null );
6778
-
6779
- return;
6780
- }
6781
-
6782
- $this->_site->license_id = $this->_license->id;
6783
-
6784
- if ( ! is_array( $this->_licenses ) ) {
6785
- $this->_licenses = array();
6786
- }
6787
-
6788
- $is_license_found = false;
6789
- for ( $i = 0, $len = count( $this->_licenses ); $i < $len; $i ++ ) {
6790
- if ( $new_license->id == $this->_licenses[ $i ]->id ) {
6791
- $this->_licenses[ $i ] = $new_license;
6792
-
6793
- $is_license_found = true;
6794
- break;
6795
- }
6796
- }
6797
-
6798
- // If new license just append.
6799
- if ( ! $is_license_found ) {
6800
- $this->_licenses[] = $new_license;
6801
- }
6802
-
6803
- $this->_sync_site_subscription( $new_license );
6804
- }
6805
-
6806
- /**
6807
- * Sync site's subscription.
6808
- *
6809
- * @author Vova Feldman (@svovaf)
6810
- * @since 1.0.9
6811
- *
6812
- * @param FS_Plugin_License|null $license
6813
- *
6814
- * @return bool|\FS_Subscription
6815
- */
6816
- private function _sync_site_subscription( $license ) {
6817
- if ( ! is_object( $license ) ) {
6818
- unset( $this->_storage->subscription );
6819
-
6820
- return false;
6821
- }
6822
-
6823
- // Load subscription details if not lifetime.
6824
- $subscription = $license->is_lifetime() ?
6825
- false :
6826
- $this->_fetch_site_license_subscription();
6827
-
6828
- if ( is_object( $subscription ) && ! isset( $subscription->error ) ) {
6829
- $this->_storage->subscription = $subscription;
6830
- } else {
6831
- unset( $this->_storage->subscription );
6832
- }
6833
-
6834
- return $subscription;
6835
- }
6836
-
6837
- /**
6838
- * @author Vova Feldman (@svovaf)
6839
- * @since 1.0.6
6840
- *
6841
- * @return bool|\FS_Plugin_License
6842
- */
6843
- function _get_license() {
6844
- return $this->_license;
6845
- }
6846
-
6847
- /**
6848
- * @return bool|\FS_Subscription
6849
- */
6850
- function _get_subscription() {
6851
- return isset( $this->_storage->subscription ) ?
6852
- $this->_storage->subscription :
6853
- false;
6854
- }
6855
-
6856
- /**
6857
- * @author Vova Feldman (@svovaf)
6858
- * @since 1.0.2
6859
- *
6860
- * @param string $plan Plan name
6861
- * @param bool $exact If true, looks for exact plan. If false, also check "higher" plans.
6862
- *
6863
- * @return bool
6864
- */
6865
- function is_plan( $plan, $exact = false ) {
6866
- $this->_logger->entrance();
6867
-
6868
- if ( ! $this->is_registered() ) {
6869
- return false;
6870
- }
6871
-
6872
- $plan = strtolower( $plan );
6873
-
6874
- if ( $this->_site->plan->name === $plan ) // Exact plan.
6875
- {
6876
- return true;
6877
- } else if ( $exact ) // Required exact, but plans are different.
6878
- {
6879
- return false;
6880
- }
6881
-
6882
- $current_plan_order = - 1;
6883
- $required_plan_order = - 1;
6884
- for ( $i = 0, $len = count( $this->_plans ); $i < $len; $i ++ ) {
6885
- if ( $plan === $this->_plans[ $i ]->name ) {
6886
- $required_plan_order = $i;
6887
- } else if ( $this->_site->plan->name === $this->_plans[ $i ]->name ) {
6888
- $current_plan_order = $i;
6889
- }
6890
- }
6891
-
6892
- return ( $current_plan_order > $required_plan_order );
6893
- }
6894
-
6895
- /**
6896
- * Check if module has only one plan.
6897
- *
6898
- * @author Vova Feldman (@svovaf)
6899
- * @since 1.2.1.7
6900
- *
6901
- * @return bool
6902
- */
6903
- function is_single_plan() {
6904
- $this->_logger->entrance();
6905
-
6906
- if ( ! $this->is_registered() ||
6907
- ! is_array( $this->_plans ) ||
6908
- 0 === count( $this->_plans )
6909
- ) {
6910
- return true;
6911
- }
6912
-
6913
- return ( 1 === count( $this->_plans ) );
6914
- }
6915
-
6916
- /**
6917
- * Check if plan based on trial. If not in trial mode, should return false.
6918
- *
6919
- * @since 1.0.9
6920
- *
6921
- * @param string $plan Plan name
6922
- * @param bool $exact If true, looks for exact plan. If false, also check "higher" plans.
6923
- *
6924
- * @return bool
6925
- */
6926
- function is_trial_plan( $plan, $exact = false ) {
6927
- $this->_logger->entrance();
6928
-
6929
- if ( ! $this->is_registered() ) {
6930
- return false;
6931
- }
6932
-
6933
- if ( ! $this->is_trial() ) {
6934
- return false;
6935
- }
6936
-
6937
- if ( ! isset( $this->_storage->trial_plan ) ) {
6938
- // Store trial plan information.
6939
- $this->_enrich_site_trial_plan( true );
6940
- }
6941
-
6942
- if ( $this->_storage->trial_plan->name === $plan ) // Exact plan.
6943
- {
6944
- return true;
6945
- } else if ( $exact ) // Required exact, but plans are different.
6946
- {
6947
- return false;
6948
- }
6949
-
6950
- $current_plan_order = - 1;
6951
- $required_plan_order = - 1;
6952
- for ( $i = 0, $len = count( $this->_plans ); $i < $len; $i ++ ) {
6953
- if ( $plan === $this->_plans[ $i ]->name ) {
6954
- $required_plan_order = $i;
6955
- } else if ( $this->_storage->trial_plan->name === $this->_plans[ $i ]->name ) {
6956
- $current_plan_order = $i;
6957
- }
6958
- }
6959
-
6960
- return ( $current_plan_order > $required_plan_order );
6961
- }
6962
-
6963
- /**
6964
- * Check if plugin has any paid plans.
6965
- *
6966
- * @author Vova Feldman (@svovaf)
6967
- * @since 1.0.7
6968
- *
6969
- * @return bool
6970
- */
6971
- function has_paid_plan() {
6972
- return $this->_has_paid_plans ||
6973
- FS_Plan_Manager::instance()->has_paid_plan( $this->_plans );
6974
- }
6975
-
6976
- /**
6977
- * Check if plugin has any plan with a trail.
6978
- *
6979
- * @author Vova Feldman (@svovaf)
6980
- * @since 1.0.9
6981
- *
6982
- * @return bool
6983
- */
6984
- function has_trial_plan() {
6985
- if ( ! $this->is_registered() ) {
6986
- /**
6987
- * @author Vova Feldman(@svovaf)
6988
- * @since 1.2.1.5
6989
- *
6990
- * Allow setting a trial from the SDK without calling the API.
6991
- * But, if the user did opt-in, continue using the real data from the API.
6992
- */
6993
- if ( $this->_trial_days >= 0 ) {
6994
- return true;
6995
- }
6996
-
6997
- return false;
6998
- }
6999
-
7000
- return $this->_storage->get( 'has_trial_plan', false );
7001
- }
7002
-
7003
- /**
7004
- * Check if plugin has any free plan, or is it premium only.
7005
- *
7006
- * Note: If no plans configured, assume plugin is free.
7007
- *
7008
- * @author Vova Feldman (@svovaf)
7009
- * @since 1.0.7
7010
- *
7011
- * @return bool
7012
- */
7013
- function has_free_plan() {
7014
- return ! $this->is_only_premium();
7015
- }
7016
-
7017
- /**
7018
- * Displays a license activation dialog box when the user clicks on the "Activate License"
7019
- * or "Change License" link on the plugins
7020
- * page.
7021
- *
7022
- * @author Leo Fajardo (@leorw)
7023
- * @since 1.1.9
7024
- */
7025
- function _add_license_activation_dialog_box() {
7026
- $vars = array(
7027
- 'id' => $this->_module_id,
7028
- );
7029
-
7030
- fs_require_template( 'forms/license-activation.php', $vars );
7031
- fs_require_template( 'forms/resend-key.php', $vars );
7032
- }
7033
-
7034
- /**
7035
- * Displays the opt-out dialog box when the user clicks on the "Opt Out" link on the "Plugins"
7036
- * page.
7037
- *
7038
- * @author Leo Fajardo (@leorw)
7039
- * @since 1.2.1.5
7040
- */
7041
- function _add_optout_dialog() {
7042
- if ( $this->is_theme() ) {
7043
- $vars = null;
7044
- fs_require_once_template( '/js/jquery.content-change.php', $vars );
7045
- }
7046
-
7047
- $vars = array( 'id' => $this->_module_id );
7048
- fs_require_template( 'forms/optout.php', $vars );
7049
- }
7050
-
7051
- /**
7052
- * Prepare page to include all required UI and logic for the license activation dialog.
7053
- *
7054
- * @author Vova Feldman (@svovaf)
7055
- * @since 1.2.0
7056
- */
7057
- function _add_license_activation() {
7058
- if ( ! $this->is_user_admin() ) {
7059
- // Only admins can activate a license.
7060
- return;
7061
- }
7062
-
7063
- if ( ! $this->has_paid_plan() ) {
7064
- // Module doesn't have any paid plans.
7065
- return;
7066
- }
7067
-
7068
- if ( ! $this->is_premium() ) {
7069
- // Only add license activation logic to the premium version.
7070
- return;
7071
- }
7072
-
7073
- // Add license activation link and AJAX request handler.
7074
- if ( self::is_plugins_page() ) {
7075
- /**
7076
- * @since 1.2.0 Add license action link only on plugins page.
7077
- */
7078
- $this->_add_license_action_link();
7079
- }
7080
-
7081
- // Add license activation AJAX callback.
7082
- $this->add_ajax_action( 'activate_license', array( &$this, '_activate_license_ajax_action' ) );
7083
-
7084
- // Add resend license AJAX callback.
7085
- $this->add_ajax_action( 'resend_license_key', array( &$this, '_resend_license_key_ajax_action' ) );
7086
- }
7087
-
7088
- /**
7089
- * @author Leo Fajardo (@leorw)
7090
- * @since 1.1.9
7091
- */
7092
- function _activate_license_ajax_action() {
7093
- $this->_logger->entrance();
7094
-
7095
- $this->check_ajax_referer( 'activate_license' );
7096
-
7097
- $license_key = trim( fs_request_get( 'license_key' ) );
7098
-
7099
- if ( empty( $license_key ) ) {
7100
- exit;
7101
- }
7102
-
7103
- $plugin_id = fs_request_get( 'module_id', '', 'post' );
7104
- $fs = ( $plugin_id == $this->_module_id ) ?
7105
- $this :
7106
- $this->get_addon_instance( $plugin_id );
7107
-
7108
- $error = false;
7109
- $next_page = false;
7110
-
7111
- if ( $fs->is_registered() ) {
7112
- $api = $fs->get_api_site_scope();
7113
- $install = $api->call( '/', 'put', array(
7114
- 'license_key' => $fs->apply_filters( 'license_key', $license_key )
7115
- ) );
7116
-
7117
- if ( isset( $install->error ) ) {
7118
- $error = $install->error->message;
7119
- } else {
7120
- $fs->_sync_license( true );
7121
 
7122
- $next_page = $fs->is_addon() ?
7123
- $fs->get_parent_instance()->get_account_url() :
7124
- $fs->get_account_url();
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7125
 
7126
- $fs->reconnect_locally();
7127
- }
7128
- } else {
7129
- $next_page = $fs->opt_in( false, false, false, $license_key );
7130
-
7131
- if ( isset( $next_page->error ) ) {
7132
- $error = $next_page->error;
7133
- }
7134
- }
7135
-
7136
- $result = array(
7137
- 'success' => ( false === $error )
7138
- );
7139
-
7140
- if ( false !== $error ) {
7141
- $result['error'] = $error;
7142
- } else {
7143
- $result['next_page'] = $next_page;
7144
- }
7145
-
7146
- echo json_encode( $result );
7147
-
7148
- exit;
7149
- }
7150
-
7151
- /**
7152
- * Billing update AJAX callback.
7153
- *
7154
- * @author Vova Feldman (@svovaf)
7155
- * @since 1.2.1.5
7156
- */
7157
- function _update_billing_ajax_action() {
7158
- $this->_logger->entrance();
7159
-
7160
- $this->check_ajax_referer( 'update_billing' );
7161
-
7162
- if ( ! $this->is_user_admin() ) {
7163
- // Only for admins.
7164
- self::shoot_ajax_failure();
7165
- }
7166
-
7167
- $billing = fs_request_get( 'billing' );
7168
-
7169
- $api = $this->get_api_user_scope();
7170
- $result = $api->call( '/billing.json', 'put', array_merge( $billing, array(
7171
- 'plugin_id' => $this->get_parent_id(),
7172
- ) ) );
7173
-
7174
- if ( ! $this->is_api_result_entity( $result ) ) {
7175
- self::shoot_ajax_failure();
7176
- }
7177
-
7178
- // Purge cached billing.
7179
- $this->get_api_user_scope()->purge_cache( 'billing.json' );
7180
-
7181
- self::shoot_ajax_success();
7182
- }
7183
-
7184
- /**
7185
- * Trial start for anonymous users (AJAX callback).
7186
- *
7187
- * @author Vova Feldman (@svovaf)
7188
- * @since 1.2.1.5
7189
- */
7190
- function _start_trial_ajax_action() {
7191
- $this->_logger->entrance();
7192
-
7193
- $this->check_ajax_referer( 'start_trial' );
7194
-
7195
- if ( ! $this->is_user_admin() ) {
7196
- // Only for admins.
7197
- self::shoot_ajax_failure();
7198
- }
7199
-
7200
- $trial_data = fs_request_get( 'trial' );
7201
-
7202
- $next_page = $this->opt_in(
7203
- false,
7204
- false,
7205
- false,
7206
- false,
7207
- false,
7208
- $trial_data['plan_id']
7209
- );
7210
-
7211
- if ( is_object( $next_page ) && $this->is_api_error( $next_page ) ) {
7212
- self::shoot_ajax_failure(
7213
- isset( $next_page->error ) ?
7214
- $next_page->error->message :
7215
- var_export( $next_page, true )
7216
- );
7217
- }
7218
-
7219
- $this->shoot_ajax_success( array(
7220
- 'next_page' => $next_page,
7221
- ) );
7222
- }
7223
-
7224
- /**
7225
- * @author Leo Fajardo (@leorw)
7226
- * @since 1.2.0
7227
- */
7228
- function _resend_license_key_ajax_action() {
7229
- $this->_logger->entrance();
7230
-
7231
- $this->check_ajax_referer( 'resend_license_key' );
7232
-
7233
- $email_address = sanitize_email( trim( fs_request_get( 'email', '', 'post' ) ) );
7234
-
7235
- if ( empty( $email_address ) ) {
7236
- exit;
7237
- }
7238
-
7239
- $error = false;
7240
-
7241
- $api = $this->get_api_plugin_scope();
7242
- $result = $api->call( '/licenses/resend.json', 'post',
7243
- array(
7244
- 'email' => $email_address,
7245
- 'url' => home_url(),
7246
- )
7247
- );
7248
-
7249
- if ( is_object( $result ) && isset( $result->error ) ) {
7250
- $error = $result->error;
7251
-
7252
- if ( in_array( $error->code, array( 'invalid_email', 'no_user' ) ) ) {
7253
- $error = $this->get_text_inline( "We couldn't find your email address in the system, are you sure it's the right address?", 'email-not-found' );
7254
- } else if ( 'no_license' === $error->code ) {
7255
- $error = $this->get_text_inline( "We can't see any active licenses associated with that email address, are you sure it's the right address?", 'no-active-licenses' );
7256
- } else {
7257
- $error = $error->message;
7258
- }
7259
- }
7260
-
7261
- $licenses = array(
7262
- 'success' => ( false === $error )
7263
- );
7264
-
7265
- if ( false !== $error ) {
7266
- $licenses['error'] = sprintf( '%s... %s', $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ), strtolower( $error ) );
7267
- }
7268
-
7269
- echo json_encode( $licenses );
7270
-
7271
- exit;
7272
- }
7273
-
7274
- /**
7275
- * @author Vova Feldman (@svovaf)
7276
- * @since 1.2.1.8
7277
- *
7278
- * @var string
7279
- */
7280
- private static $_pagenow;
7281
-
7282
- /**
7283
- * Get current page or the referer if executing a WP AJAX request.
7284
- *
7285
- * @author Vova Feldman (@svovaf)
7286
- * @since 1.2.1.8
7287
- *
7288
- * @return string
7289
- */
7290
- static function get_current_page() {
7291
- if ( ! isset( self::$_pagenow ) ) {
7292
- global $pagenow;
7293
-
7294
- self::$_pagenow = $pagenow;
7295
-
7296
- if ( self::is_ajax() &&
7297
- 'admin-ajax.php' === $pagenow
7298
- ) {
7299
- $referer = fs_get_raw_referer();
7300
-
7301
- if ( is_string( $referer ) ) {
7302
- $parts = explode( '?', $referer );
7303
-
7304
- self::$_pagenow = basename( $parts[0] );
7305
- }
7306
- }
7307
- }
7308
-
7309
- return self::$_pagenow;
7310
- }
7311
-
7312
- /**
7313
- * Helper method to check if user in the plugins page.
7314
- *
7315
- * @author Vova Feldman (@svovaf)
7316
- * @since 1.2.1.5
7317
- *
7318
- * @return bool
7319
- */
7320
- static function is_plugins_page() {
7321
- return ( 'plugins.php' === self::get_current_page() );
7322
- }
7323
-
7324
- /**
7325
- * Helper method to check if user in the themes page.
7326
- *
7327
- * @author Vova Feldman (@svovaf)
7328
- * @since 1.2.2.6
7329
- *
7330
- * @return bool
7331
- */
7332
- static function is_themes_page() {
7333
- return ( 'themes.php' === self::get_current_page() );
7334
- }
7335
-
7336
- #----------------------------------------------------------------------------------
7337
- #region Affiliation
7338
- #----------------------------------------------------------------------------------
7339
-
7340
- /**
7341
- * @author Leo Fajardo
7342
- * @since 1.2.3
7343
  *
7344
- * @return bool
 
7345
  */
7346
- function has_affiliate_program() {
7347
- if ( ! is_object( $this->_plugin ) ) {
7348
- return false;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7349
  }
7350
 
7351
- return $this->_plugin->has_affiliate_program();
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7352
  }
7353
 
7354
  /**
7355
  * @author Leo Fajardo (@leorw)
7356
- * @since 1.2.4
7357
  */
7358
- private function fetch_affiliate_terms() {
7359
- if ( ! is_object( $this->plugin_affiliate_terms ) ) {
7360
- $plugins_api = $this->get_api_plugin_scope();
7361
- $affiliate_terms = $plugins_api->get( '/aff.json?type=affiliation', false, WP_FS__TIME_WEEK_IN_SEC );
7362
-
7363
- if ( ! $this->is_api_result_entity( $affiliate_terms ) ) {
7364
- return;
7365
- }
7366
 
7367
- $this->plugin_affiliate_terms = new FS_AffiliateTerms( $affiliate_terms );
 
7368
  }
7369
  }
7370
 
7371
  /**
7372
  * @author Leo Fajardo (@leorw)
7373
- * @since 1.2.4
7374
  */
7375
- private function fetch_affiliate_and_custom_terms() {
7376
- if ( ! empty( $this->_storage->affiliate_application_data ) ) {
7377
- $application_data = $this->_storage->affiliate_application_data;
7378
- $flush = ( ! isset( $application_data['status'] ) || 'pending' === $application_data['status'] );
 
 
 
7379
 
7380
- $users_api = $this->get_api_user_scope();
7381
- $result = $users_api->get( "/plugins/{$this->_plugin->id}/aff/{$this->plugin_affiliate_terms->id}/affiliates.json", $flush, WP_FS__TIME_WEEK_IN_SEC );
7382
- if ( $this->is_api_result_object( $result, 'affiliates' ) ) {
7383
- if ( ! empty( $result->affiliates ) ) {
7384
- $affiliate = new FS_Affiliate( $result->affiliates[0] );
 
7385
 
7386
- if ( ! isset( $application_data['status'] ) || $application_data['status'] !== $affiliate->status ) {
7387
- $application_data['status'] = $affiliate->status;
7388
- $this->_storage->affiliate_application_data = $application_data;
7389
- }
7390
 
7391
- if ( $affiliate->is_using_custom_terms ) {
7392
- $affiliate_terms = $users_api->get( "/plugins/{$this->_plugin->id}/affiliates/{$affiliate->id}/aff/{$affiliate->custom_affiliate_terms_id}.json", $flush, WP_FS__TIME_WEEK_IN_SEC );
7393
- if ( $this->is_api_result_entity( $affiliate_terms ) ) {
7394
- $this->custom_affiliate_terms = new FS_AffiliateTerms( $affiliate_terms );
7395
- }
7396
- }
7397
 
7398
- $this->affiliate = $affiliate;
 
 
 
 
 
 
 
 
7399
  }
7400
  }
7401
  }
7402
- }
7403
 
7404
- /**
7405
- * @author Leo Fajardo (@leorw)
7406
- * @since 1.2.3
7407
- */
7408
- private function fetch_affiliate_and_terms() {
7409
- $this->_logger->entrance();
7410
 
7411
- $this->fetch_affiliate_terms();
7412
- $this->fetch_affiliate_and_custom_terms();
 
 
 
 
 
 
 
 
 
 
 
7413
  }
7414
 
7415
  /**
7416
- * @author Leo Fajardo
7417
- * @since 1.2.3
7418
  *
7419
- * @return FS_Affiliate
 
7420
  */
7421
- function get_affiliate() {
7422
- return $this->affiliate;
7423
- }
 
 
 
 
 
 
 
 
7424
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7425
 
7426
  /**
7427
- * @author Leo Fajardo
7428
- * @since 1.2.3
7429
  *
7430
- * @return FS_AffiliateTerms
 
7431
  */
7432
- function get_affiliate_terms() {
7433
- return is_object( $this->custom_affiliate_terms ) ?
7434
- $this->custom_affiliate_terms :
7435
- $this->plugin_affiliate_terms;
 
 
 
7436
  }
7437
 
7438
  /**
7439
- * @author Leo Fajardo
7440
- * @since 1.2.3
 
 
 
 
 
7441
  *
7442
- * @return FS_Affiliate|null
 
7443
  */
7444
- function _submit_affiliate_application() {
7445
- $this->_logger->entrance();
 
 
 
 
 
7446
 
7447
- $this->check_ajax_referer( 'submit_affiliate_application' );
7448
 
7449
- if ( ! $this->is_user_admin() ) {
7450
- // Only for admins.
7451
- self::shoot_ajax_failure();
7452
- }
 
 
 
 
 
7453
 
7454
- $affiliate = fs_request_get( 'affiliate' );
7455
 
7456
- if ( empty( $affiliate['promotion_methods'] ) ) {
7457
- unset( $affiliate['promotion_methods'] );
7458
- }
 
 
7459
 
7460
- if ( ! empty( $affiliate['additional_domains'] ) ) {
7461
- $affiliate['additional_domains'] = array_unique( $affiliate['additional_domains'] );
 
 
 
 
 
 
7462
  }
7463
 
7464
- if ( ! $this->is_registered() ) {
7465
- // Opt in but don't track usage.
7466
- $next_page = $this->opt_in(
7467
- false,
7468
- false,
7469
- false,
7470
- false,
7471
- false,
7472
- false,
7473
- true
7474
- );
7475
 
7476
- if ( is_object( $next_page ) && $this->is_api_error( $next_page ) ) {
7477
- self::shoot_ajax_failure(
7478
- isset( $next_page->error ) ?
7479
- $next_page->error->message :
7480
- var_export( $next_page, true )
7481
- );
7482
- } else if ( $this->is_pending_activation() ) {
7483
- self::shoot_ajax_failure( $this->get_text_inline( 'Account is pending activation.', 'account-is-pending-activation' ) );
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7484
  }
7485
  }
7486
 
7487
- $this->fetch_affiliate_terms();
7488
 
7489
- $api = $this->get_api_user_scope();
7490
- $result = $api->call(
7491
- ( "/plugins/{$this->_plugin->id}/aff/{$this->plugin_affiliate_terms->id}/affiliates.json" ),
7492
- 'post',
7493
- $affiliate
7494
- );
7495
 
7496
- if ( $this->is_api_error( $result ) ) {
7497
- self::shoot_ajax_failure(
7498
- isset( $result->error ) ?
7499
- $result->error->message :
7500
- var_export( $result, true )
7501
- );
7502
- }
7503
- else
7504
- {
7505
- if ( $this->_admin_notices->has_sticky( 'affiliate_program' ) ) {
7506
- $this->_admin_notices->remove_sticky( 'affiliate_program' );
7507
- }
7508
 
7509
- $affiliate_application_data = array(
7510
- 'status' => 'pending',
7511
- 'stats_description' => $affiliate['stats_description'],
7512
- 'promotion_method_description' => $affiliate['promotion_method_description'],
7513
- );
 
 
7514
 
7515
- if ( ! empty( $affiliate['promotion_methods'] ) ) {
7516
- $affiliate_application_data['promotion_methods'] = $affiliate['promotion_methods'];
7517
- }
7518
 
7519
- if ( ! empty( $affiliate['domain'] ) ) {
7520
- $affiliate_application_data['domain'] = $affiliate['domain'];
 
 
 
 
 
 
 
 
 
 
7521
  }
7522
 
7523
- if ( ! empty( $affiliate['additional_domains'] ) ) {
7524
- $affiliate_application_data['additional_domains'] = $affiliate['additional_domains'];
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7525
  }
7526
 
7527
- $this->_storage->affiliate_application_data = $affiliate_application_data;
7528
- }
 
 
 
 
 
 
 
 
7529
 
7530
- // Purge cached affiliate.
7531
- $api->purge_cache( 'affiliate.json' );
 
 
 
 
 
7532
 
7533
- self::shoot_ajax_success( $result );
 
 
 
 
 
 
 
 
 
 
 
 
7534
  }
7535
 
7536
  /**
7537
- * @author Leo Fajardo
7538
- * @since 1.2.3
7539
  *
7540
- * @return array|null
 
 
 
 
 
7541
  */
7542
- function get_affiliate_application_data() {
7543
- if ( empty( $this->_storage->affiliate_application_data ) ) {
7544
- return null;
7545
- }
7546
-
7547
- return $this->_storage->affiliate_application_data;
7548
  }
7549
 
7550
- #endregion Affiliation ------------------------------------------------------------
7551
-
7552
- #----------------------------------------------------------------------------------
7553
- #region URL Generators
7554
- #----------------------------------------------------------------------------------
7555
-
7556
- /**
7557
- * Alias to pricing_url().
7558
- *
7559
- * @author Vova Feldman (@svovaf)
7560
- * @since 1.0.2
7561
- *
7562
- * @uses pricing_url()
7563
- *
7564
- * @param string $period Billing cycle
7565
- * @param bool $is_trial
7566
- *
7567
- * @return string
7568
- */
7569
- function get_upgrade_url( $period = WP_FS__PERIOD_ANNUALLY, $is_trial = false ) {
7570
- return $this->pricing_url( $period, $is_trial );
7571
- }
7572
-
7573
- /**
7574
- * @author Vova Feldman (@svovaf)
7575
- * @since 1.0.9
7576
- *
7577
- * @uses get_upgrade_url()
7578
- *
7579
- * @return string
7580
- */
7581
- function get_trial_url() {
7582
- return $this->get_upgrade_url( WP_FS__PERIOD_ANNUALLY, true );
7583
- }
7584
-
7585
- /**
7586
- * Plugin's pricing URL.
7587
- *
7588
- * @author Vova Feldman (@svovaf)
7589
- * @since 1.0.4
7590
- *
7591
- * @param string $billing_cycle Billing cycle
7592
- *
7593
- * @param bool $is_trial
7594
- *
7595
- * @return string
7596
- */
7597
- function pricing_url( $billing_cycle = WP_FS__PERIOD_ANNUALLY, $is_trial = false ) {
7598
- $this->_logger->entrance();
7599
-
7600
- $params = array(
7601
- 'billing_cycle' => $billing_cycle
7602
- );
7603
-
7604
- if ( $is_trial ) {
7605
- $params['trial'] = 'true';
7606
- }
7607
-
7608
- return $this->_get_admin_page_url( 'pricing', $params );
7609
- }
7610
-
7611
- /**
7612
- * Checkout page URL.
7613
- *
7614
- * @author Vova Feldman (@svovaf)
7615
- * @since 1.0.6
7616
- *
7617
- * @param string $billing_cycle Billing cycle
7618
- * @param bool $is_trial
7619
- * @param array $extra (optional) Extra parameters, override other query params.
7620
- *
7621
- * @return string
7622
- */
7623
- function checkout_url(
7624
- $billing_cycle = WP_FS__PERIOD_ANNUALLY,
7625
- $is_trial = false,
7626
- $extra = array()
7627
- ) {
7628
- $this->_logger->entrance();
7629
-
7630
- $params = array(
7631
- 'checkout' => 'true',
7632
- 'billing_cycle' => $billing_cycle,
7633
- );
7634
-
7635
- if ( $is_trial ) {
7636
- $params['trial'] = 'true';
7637
- }
7638
-
7639
- /**
7640
- * Params in extra override other params.
7641
- */
7642
- $params = array_merge( $params, $extra );
7643
-
7644
- return $this->_get_admin_page_url( 'pricing', $params );
7645
- }
7646
-
7647
- /**
7648
- * Add-on checkout URL.
7649
- *
7650
- * @author Vova Feldman (@svovaf)
7651
- * @since 1.1.7
7652
- *
7653
- * @param number $addon_id
7654
- * @param number $pricing_id
7655
- * @param string $billing_cycle
7656
- * @param bool $is_trial
7657
- *
7658
- * @return string
7659
- */
7660
- function addon_checkout_url(
7661
- $addon_id,
7662
- $pricing_id,
7663
- $billing_cycle = WP_FS__PERIOD_ANNUALLY,
7664
- $is_trial = false
7665
- ) {
7666
- return $this->checkout_url( $billing_cycle, $is_trial, array(
7667
- 'plugin_id' => $addon_id,
7668
- 'pricing_id' => $pricing_id,
7669
- ) );
7670
- }
7671
-
7672
- #endregion
7673
-
7674
- #endregion ------------------------------------------------------------------
7675
-
7676
- /**
7677
- * Check if plugin has any add-ons.
7678
- *
7679
- * @author Vova Feldman (@svovaf)
7680
- * @since 1.0.5
7681
- *
7682
- * @since 1.1.7.3 Base logic only on the parameter provided by the developer in the init function.
7683
- *
7684
- * @return bool
7685
- */
7686
- function has_addons() {
7687
- $this->_logger->entrance();
7688
-
7689
- return $this->_has_addons;
7690
- }
7691
-
7692
- /**
7693
- * Check if plugin can work in anonymous mode.
7694
- *
7695
- * @author Vova Feldman (@svovaf)
7696
- * @since 1.0.9
7697
- *
7698
- * @return bool
7699
- *
7700
- * @deprecated Please use is_enable_anonymous() instead
7701
- */
7702
- function enable_anonymous() {
7703
- return $this->_enable_anonymous;
7704
- }
7705
-
7706
- /**
7707
- * Check if plugin can work in anonymous mode.
7708
- *
7709
- * @author Vova Feldman (@svovaf)
7710
- * @since 1.1.9
7711
- *
7712
- * @return bool
7713
- */
7714
- function is_enable_anonymous() {
7715
- return $this->_enable_anonymous;
7716
- }
7717
-
7718
- /**
7719
- * Check if plugin is premium only (no free plans).
7720
- *
7721
- * @author Vova Feldman (@svovaf)
7722
- * @since 1.1.9
7723
- *
7724
- * @return bool
7725
- */
7726
- function is_only_premium() {
7727
- return $this->_is_premium_only;
7728
- }
7729
-
7730
- /**
7731
- * Checks if the plugin's type is "plugin". The other type is "theme".
7732
- *
7733
- * @author Leo Fajardo (@leorw)
7734
- * @since 1.2.2
7735
- *
7736
- * @return bool
7737
- */
7738
- function is_plugin() {
7739
- return ( WP_FS__MODULE_TYPE_PLUGIN === $this->_module_type );
7740
- }
7741
-
7742
- /**
7743
- * @author Leo Fajardo (@leorw)
7744
- * @since 1.2.2
7745
- *
7746
- * @return string
7747
- */
7748
- function get_module_type() {
7749
- if ( ! isset( $this->_module_type ) ) {
7750
- $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map', array() );
7751
- $this->_module_type = $id_slug_type_path_map[ $this->_module_id ]['type'];
7752
- }
7753
-
7754
- return $this->_module_type;
7755
- }
7756
-
7757
- /**
7758
- * @author Leo Fajardo (@leorw)
7759
- * @since 1.2.2
7760
- *
7761
- * @return string
7762
- */
7763
- function get_plugin_main_file_path() {
7764
- return $this->_plugin_main_file_path;
7765
- }
7766
-
7767
- /**
7768
- * Check if module has a premium code version.
7769
- *
7770
- * Serviceware module might be freemium without any
7771
- * premium code version, where the paid features
7772
- * are all part of the service.
7773
- *
7774
- * @author Vova Feldman (@svovaf)
7775
- * @since 1.2.1.6
7776
- *
7777
- * @return bool
7778
- */
7779
- function has_premium_version() {
7780
- return $this->_has_premium_version;
7781
- }
7782
-
7783
- /**
7784
- * Check if feature supported with current site's plan.
7785
- *
7786
- * @author Vova Feldman (@svovaf)
7787
- * @since 1.0.1
7788
- *
7789
- * @todo IMPLEMENT
7790
- *
7791
- * @param number $feature_id
7792
- *
7793
- * @throws Exception
7794
- */
7795
- function is_feature_supported( $feature_id ) {
7796
- throw new Exception( 'not implemented' );
7797
- }
7798
-
7799
- /**
7800
- * @author Vova Feldman (@svovaf)
7801
- * @since 1.0.1
7802
- *
7803
- * @return bool Is running in SSL/HTTPS
7804
- */
7805
- function is_ssl() {
7806
- return WP_FS__IS_HTTPS;
7807
- }
7808
-
7809
- /**
7810
- * @author Vova Feldman (@svovaf)
7811
- * @since 1.0.9
7812
- *
7813
- * @return bool Is running in AJAX call.
7814
- *
7815
- * @link http://wordpress.stackexchange.com/questions/70676/how-to-check-if-i-am-in-admin-ajax
7816
- */
7817
- static function is_ajax() {
7818
- return ( defined( 'DOING_AJAX' ) && DOING_AJAX );
7819
- }
7820
-
7821
- /**
7822
- * Check if it's an AJAX call targeted for the current module.
7823
- *
7824
- * @author Vova Feldman (@svovaf)
7825
- * @since 1.2.0
7826
- *
7827
- * @param array|string $actions Collection of AJAX actions.
7828
- *
7829
- * @return bool
7830
- */
7831
- function is_ajax_action( $actions ) {
7832
- // Verify it's an ajax call.
7833
- if ( ! self::is_ajax() ) {
7834
- return false;
7835
- }
7836
-
7837
- // Verify the call is relevant for the plugin.
7838
- if ( $this->_module_id != fs_request_get( 'module_id' ) ) {
7839
- return false;
7840
- }
7841
-
7842
- // Verify it's one of the specified actions.
7843
- if ( is_string( $actions ) ) {
7844
- $actions = explode( ',', $actions );
7845
- }
7846
-
7847
- if ( is_array( $actions ) && 0 < count( $actions ) ) {
7848
- $ajax_action = fs_request_get( 'action' );
7849
-
7850
- foreach ( $actions as $action ) {
7851
- if ( $ajax_action === $this->get_action_tag( $action ) ) {
7852
- return true;
7853
- }
7854
- }
7855
- }
7856
-
7857
- return false;
7858
- }
7859
-
7860
- /**
7861
- * Check if it's an AJAX call targeted for current request.
7862
- *
7863
- * @author Vova Feldman (@svovaf)
7864
- * @since 1.2.0
7865
- *
7866
- * @param array|string $actions Collection of AJAX actions.
7867
- * @param number|null $module_id
7868
- *
7869
- * @return bool
7870
- */
7871
- static function is_ajax_action_static( $actions, $module_id = null ) {
7872
- // Verify it's an ajax call.
7873
- if ( ! self::is_ajax() ) {
7874
- return false;
7875
- }
7876
-
7877
-
7878
- if ( ! empty( $module_id ) ) {
7879
- // Verify the call is relevant for the plugin.
7880
- if ( $module_id != fs_request_get( 'module_id' ) ) {
7881
- return false;
7882
- }
7883
- }
7884
-
7885
- // Verify it's one of the specified actions.
7886
- if ( is_string( $actions ) ) {
7887
- $actions = explode( ',', $actions );
7888
- }
7889
-
7890
- if ( is_array( $actions ) && 0 < count( $actions ) ) {
7891
- $ajax_action = fs_request_get( 'action' );
7892
-
7893
- foreach ( $actions as $action ) {
7894
- if ( $ajax_action === self::get_ajax_action_static( $action, $module_id ) ) {
7895
- return true;
7896
- }
7897
- }
7898
- }
7899
-
7900
- return false;
7901
- }
7902
-
7903
- /**
7904
- * @author Vova Feldman (@svovaf)
7905
- * @since 1.1.7
7906
- *
7907
- * @return bool
7908
- */
7909
- static function is_cron() {
7910
- return ( defined( 'DOING_CRON' ) && DOING_CRON );
7911
- }
7912
-
7913
- /**
7914
- * Check if a real user is visiting the admin dashboard.
7915
- *
7916
- * @author Vova Feldman (@svovaf)
7917
- * @since 1.1.7
7918
- *
7919
- * @return bool
7920
- */
7921
- function is_user_in_admin() {
7922
- return is_admin() && ! self::is_ajax() && ! self::is_cron();
7923
- }
7924
-
7925
- /**
7926
- * Check if a real user is in the customizer view.
7927
- *
7928
- * @author Vova Feldman (@svovaf)
7929
- * @since 1.2.2.7
7930
- *
7931
- * @return bool
7932
- */
7933
- static function is_customizer() {
7934
- return is_customize_preview();
7935
- }
7936
-
7937
- /**
7938
- * Check if running in HTTPS and if site's plan matching the specified plan.
7939
- *
7940
- * @param string $plan
7941
- * @param bool $exact
7942
- *
7943
- * @return bool
7944
- */
7945
- function is_ssl_and_plan( $plan, $exact = false ) {
7946
- return ( $this->is_ssl() && $this->is_plan( $plan, $exact ) );
7947
- }
7948
-
7949
- /**
7950
- * Construct plugin's settings page URL.
7951
- *
7952
- * @author Vova Feldman (@svovaf)
7953
- * @since 1.0.4
7954
- *
7955
- * @param string $page
7956
- * @param array $params
7957
- *
7958
- * @return string
7959
- */
7960
- function _get_admin_page_url( $page = '', $params = array() ) {
7961
- if ( 0 < count( $params ) ) {
7962
- foreach ( $params as $k => $v ) {
7963
- $params[ $k ] = urlencode( $v );
7964
- }
7965
- }
7966
-
7967
- $page_param = $this->_menu->get_slug( $page );
7968
 
7969
- if ( empty( $page ) &&
7970
- $this->is_theme() &&
7971
- // Show the opt-in as an overlay for free wp.org themes or themes without any settings page.
7972
- ( $this->is_free_wp_org_theme() || ! $this->has_settings_menu() ) ) {
7973
- $params[ $this->get_unique_affix() . '_show_optin' ] = 'true';
 
 
 
 
 
 
7974
 
7975
- return add_query_arg(
7976
- $params,
7977
- admin_url( 'themes.php' )
7978
- );
7979
  }
7980
 
7981
- if ( ! $this->has_settings_menu() ) {
7982
- if ( ! empty( $page ) ) {
7983
- // Module doesn't have a setting page, but since the request is for
7984
- // a specific Freemius page, use the admin.php path.
7985
- return add_query_arg( array_merge( $params, array(
7986
- 'page' => $page_param,
7987
- ) ), admin_url( 'admin.php' ) );
7988
- } else {
7989
- if ( $this->is_activation_mode() ) {
7990
- /**
7991
- * @author Vova Feldman
7992
- * @since 1.2.1.6
7993
- *
7994
- * If plugin doesn't have a settings page, create one for the opt-in screen.
7995
- */
7996
- return add_query_arg( array_merge( $params, array(
7997
- 'page' => $this->_slug,
7998
- ) ), admin_url( 'admin.php', 'admin' ) );
7999
- } else {
8000
- // Plugin without a settings page.
8001
- return add_query_arg(
8002
- $params,
8003
- admin_url( 'plugins.php' )
8004
- );
8005
- }
8006
- }
8007
- }
8008
-
8009
- // Module has a submenu settings page.
8010
- if ( ! $this->_menu->is_top_level() ) {
8011
- $parent_slug = $this->_menu->get_parent_slug();
8012
- $menu_file = ( false !== strpos( $parent_slug, '.php' ) ) ?
8013
- $parent_slug :
8014
- 'admin.php';
8015
-
8016
- return add_query_arg( array_merge( $params, array(
8017
- 'page' => $page_param,
8018
- ) ), admin_url( $menu_file, 'admin' ) );
8019
- }
8020
-
8021
- // Module has a top level CPT settings page.
8022
- if ( $this->_menu->is_cpt() ) {
8023
- if ( empty( $page ) && $this->is_activation_mode() ) {
8024
- return add_query_arg( array_merge( $params, array(
8025
- 'page' => $page_param
8026
- ) ), admin_url( 'admin.php', 'admin' ) );
8027
- } else {
8028
- if ( ! empty( $page ) ) {
8029
- $params['page'] = $page_param;
8030
- }
8031
-
8032
- return add_query_arg(
8033
- $params,
8034
- admin_url( $this->_menu->get_raw_slug(), 'admin' )
8035
- );
8036
- }
8037
- }
8038
-
8039
- // Module has a custom top level settings page.
8040
- return add_query_arg( array_merge( $params, array(
8041
- 'page' => $page_param,
8042
- ) ), admin_url( 'admin.php', 'admin' ) );
8043
- }
8044
-
8045
- /**
8046
- * Check if currently in a specified admin page.
8047
- *
8048
- * @author Vova Feldman (@svovaf)
8049
- * @since 1.2.2.7
8050
- *
8051
- * @param string $page
8052
- *
8053
- * @return bool
8054
- */
8055
- function is_admin_page( $page ) {
8056
- return ( $this->_menu->get_slug( $page ) === fs_request_get( 'page', '', 'get' ) );
8057
- }
8058
-
8059
- /**
8060
- * Get module's main admin setting page URL.
8061
- *
8062
- * @author Vova Feldman (@svovaf)
8063
- * @since 1.2.2.7
8064
- *
8065
- * @return string
8066
- */
8067
- function main_menu_url() {
8068
- return $this->_menu->main_menu_url();
8069
- }
8070
-
8071
- /**
8072
- * Check if currently on the theme's setting page or
8073
- * on any of the Freemius added pages (via tabs).
8074
- *
8075
- * @author Vova Feldman (@svovaf)
8076
- * @since 1.2.2.7
8077
- *
8078
- * @return bool
8079
- */
8080
- function is_theme_settings_page() {
8081
- return fs_starts_with(
8082
- fs_request_get( 'page', '', 'get' ),
8083
- $this->_menu->get_slug()
8084
- );
8085
- }
8086
-
8087
- /**
8088
- * Plugin's account page + sync license URL.
8089
- *
8090
- * @author Vova Feldman (@svovaf)
8091
- * @since 1.1.9.1
8092
- *
8093
- * @param bool|number $plugin_id
8094
- * @param bool $add_action_nonce
8095
- * @param array $params
8096
- *
8097
- * @return string
8098
- */
8099
- function _get_sync_license_url( $plugin_id = false, $add_action_nonce = true, $params = array() ) {
8100
- if ( is_numeric( $plugin_id ) ) {
8101
- $params['plugin_id'] = $plugin_id;
8102
- }
8103
-
8104
- return $this->get_account_url(
8105
- $this->get_unique_affix() . '_sync_license',
8106
- $params,
8107
- $add_action_nonce
8108
- );
8109
- }
8110
-
8111
- /**
8112
- * Plugin's account URL.
8113
- *
8114
- * @author Vova Feldman (@svovaf)
8115
- * @since 1.0.4
8116
- *
8117
- * @param bool|string $action
8118
- * @param array $params
8119
- *
8120
- * @param bool $add_action_nonce
8121
- *
8122
- * @return string
8123
- */
8124
- function get_account_url( $action = false, $params = array(), $add_action_nonce = true ) {
8125
- if ( is_string( $action ) ) {
8126
- $params['fs_action'] = $action;
8127
- }
8128
-
8129
- self::require_pluggable_essentials();
8130
-
8131
- return ( $add_action_nonce && is_string( $action ) ) ?
8132
- fs_nonce_url( $this->_get_admin_page_url( 'account', $params ), $action ) :
8133
- $this->_get_admin_page_url( 'account', $params );
8134
- }
8135
-
8136
- /**
8137
- * @author Vova Feldman (@svovaf)
8138
- * @since 1.2.0
8139
- *
8140
- * @param string $tab
8141
- * @param bool $action
8142
- * @param array $params
8143
- * @param bool $add_action_nonce
8144
- *
8145
- * @return string
8146
- *
8147
- * @uses get_account_url()
8148
- */
8149
- function get_account_tab_url( $tab, $action = false, $params = array(), $add_action_nonce = true ) {
8150
- $params['tab'] = $tab;
8151
-
8152
- return $this->get_account_url( $action, $params, $add_action_nonce );
8153
- }
8154
-
8155
- /**
8156
- * Plugin's account URL.
8157
- *
8158
- * @author Vova Feldman (@svovaf)
8159
- * @since 1.0.4
8160
- *
8161
- * @param bool|string $topic
8162
- * @param bool|string $message
8163
- *
8164
- * @return string
8165
- */
8166
- function contact_url( $topic = false, $message = false ) {
8167
- $params = array();
8168
- if ( is_string( $topic ) ) {
8169
- $params['topic'] = $topic;
8170
- }
8171
- if ( is_string( $message ) ) {
8172
- $params['message'] = $message;
8173
- }
8174
-
8175
- if ( $this->is_addon() ) {
8176
- $params['addon_id'] = $this->get_id();
8177
-
8178
- return $this->get_parent_instance()->_get_admin_page_url( 'contact', $params );
8179
- } else {
8180
- return $this->_get_admin_page_url( 'contact', $params );
8181
- }
8182
- }
8183
-
8184
- /**
8185
- * Add-on direct info URL.
8186
- *
8187
- * @author Vova Feldman (@svovaf)
8188
- * @since 1.1.0
8189
- *
8190
- * @param string $slug
8191
- *
8192
- * @return string
8193
- */
8194
- function addon_url( $slug ) {
8195
- return $this->_get_admin_page_url( 'addons', array(
8196
- 'slug' => $slug
8197
- ) );
8198
- }
8199
-
8200
- /* Logger
8201
- ------------------------------------------------------------------------------------------------------------------*/
8202
- /**
8203
- * @param string $id
8204
- * @param bool $prefix_slug
8205
- *
8206
- * @return FS_Logger
8207
- */
8208
- function get_logger( $id = '', $prefix_slug = true ) {
8209
- return FS_Logger::get_logger( ( $prefix_slug ? $this->_slug : '' ) . ( ( ! $prefix_slug || empty( $id ) ) ? '' : '_' ) . $id );
8210
- }
8211
-
8212
- /**
8213
- * @param $id
8214
- * @param bool $load_options
8215
- * @param bool $prefix_slug
8216
- *
8217
- * @return FS_Option_Manager
8218
- */
8219
- function get_options_manager( $id, $load_options = false, $prefix_slug = true ) {
8220
- return FS_Option_Manager::get_manager( ( $prefix_slug ? $this->_slug : '' ) . ( ( ! $prefix_slug || empty( $id ) ) ? '' : '_' ) . $id, $load_options );
8221
- }
8222
-
8223
- /* Security
8224
- ------------------------------------------------------------------------------------------------------------------*/
8225
- private static function _encrypt( $str ) {
8226
- if ( is_null( $str ) ) {
8227
- return null;
8228
- }
8229
-
8230
- /**
8231
- * The encrypt/decrypt functions are used to protect
8232
- * the user from messing up with some of the sensitive
8233
- * data stored for the module as a JSON in the database.
8234
- *
8235
- * I used the same suggested hack by the theme review team.
8236
- * For more details, look at the function `Base64UrlDecode()`
8237
- * in `./sdk/FreemiusBase.php`.
8238
- *
8239
- * @todo Remove this hack once the base64 error is removed from the Theme Check.
8240
- *
8241
- * @author Vova Feldman (@svovaf)
8242
- * @since 1.2.2
8243
- */
8244
- $fn = 'base64' . '_encode';
8245
-
8246
- return $fn( $str );
8247
- }
8248
-
8249
- static function _decrypt( $str ) {
8250
- if ( is_null( $str ) ) {
8251
- return null;
8252
- }
8253
-
8254
- /**
8255
- * The encrypt/decrypt functions are used to protect
8256
- * the user from messing up with some of the sensitive
8257
- * data stored for the module as a JSON in the database.
8258
- *
8259
- * I used the same suggested hack by the theme review team.
8260
- * For more details, look at the function `Base64UrlDecode()`
8261
- * in `./sdk/FreemiusBase.php`.
8262
- *
8263
- * @todo Remove this hack once the base64 error is removed from the Theme Check.
8264
- *
8265
- * @author Vova Feldman (@svovaf)
8266
- * @since 1.2.2
8267
- */
8268
- $fn = 'base64' . '_decode';
8269
-
8270
- return $fn( $str );
8271
- }
8272
-
8273
- /**
8274
- * @author Vova Feldman (@svovaf)
8275
- * @since 1.0.5
8276
- *
8277
- * @param FS_Entity $entity
8278
- *
8279
- * @return FS_Entity Return an encrypted clone entity.
8280
- */
8281
- private static function _encrypt_entity( FS_Entity $entity ) {
8282
- $clone = clone $entity;
8283
- $props = get_object_vars( $entity );
8284
-
8285
- foreach ( $props as $key => $val ) {
8286
- $clone->{$key} = self::_encrypt( $val );
8287
- }
8288
-
8289
- return $clone;
8290
- }
8291
-
8292
- /**
8293
- * @author Vova Feldman (@svovaf)
8294
- * @since 1.0.5
8295
- *
8296
- * @param FS_Entity $entity
8297
- *
8298
- * @return FS_Entity Return an decrypted clone entity.
8299
- */
8300
- private static function decrypt_entity( FS_Entity $entity ) {
8301
- $clone = clone $entity;
8302
- $props = get_object_vars( $entity );
8303
-
8304
- foreach ( $props as $key => $val ) {
8305
- $clone->{$key} = self::_decrypt( $val );
8306
- }
8307
-
8308
- return $clone;
8309
- }
8310
-
8311
- /**
8312
- * Tries to activate account based on POST params.
8313
- *
8314
- * @author Vova Feldman (@svovaf)
8315
- * @since 1.0.2
8316
- */
8317
- function _activate_account() {
8318
- if ( $this->is_registered() ) {
8319
- // Already activated.
8320
- return;
8321
- }
8322
-
8323
- self::_clean_admin_content_section();
8324
-
8325
- if ( fs_request_is_action( 'activate' ) && fs_request_is_post() ) {
8326
- // check_admin_referer( 'activate_' . $this->_plugin->public_key );
8327
-
8328
- // Verify matching plugin details.
8329
- if ( $this->_plugin->id != fs_request_get( 'plugin_id' ) || $this->_slug != fs_request_get( 'plugin_slug' ) ) {
8330
- return;
8331
- }
8332
-
8333
- $user = new FS_User();
8334
- $user->id = fs_request_get( 'user_id' );
8335
- $user->public_key = fs_request_get( 'user_public_key' );
8336
- $user->secret_key = fs_request_get( 'user_secret_key' );
8337
- $user->email = fs_request_get( 'user_email' );
8338
- $user->first = fs_request_get( 'user_first' );
8339
- $user->last = fs_request_get( 'user_last' );
8340
- $user->is_verified = fs_request_get_bool( 'user_is_verified' );
8341
-
8342
- $site = new FS_Site();
8343
- $site->id = fs_request_get( 'install_id' );
8344
- $site->public_key = fs_request_get( 'install_public_key' );
8345
- $site->secret_key = fs_request_get( 'install_secret_key' );
8346
- $site->plan->id = fs_request_get( 'plan_id' );
8347
- $site->plan->title = fs_request_get( 'plan_title' );
8348
- $site->plan->name = fs_request_get( 'plan_name' );
8349
-
8350
- $plans = array();
8351
- $plans_data = json_decode( urldecode( fs_request_get( 'plans' ) ) );
8352
- foreach ( $plans_data as $p ) {
8353
- $plans[] = new FS_Plugin_Plan( $p );
8354
- }
8355
-
8356
- $this->_set_account( $user, $site, $plans );
8357
-
8358
- // Reload the page with the keys.
8359
- fs_redirect( $this->_get_admin_page_url() );
8360
- }
8361
- }
8362
-
8363
- /**
8364
- * @author Vova Feldman (@svovaf)
8365
- * @since 1.0.7
8366
- *
8367
- * @param string $email
8368
- *
8369
- * @return FS_User|bool
8370
- */
8371
- static function _get_user_by_email( $email ) {
8372
- self::$_static_logger->entrance();
8373
-
8374
- $email = trim( strtolower( $email ) );
8375
- $users = self::get_all_users();
8376
- if ( is_array( $users ) ) {
8377
- foreach ( $users as $u ) {
8378
- if ( $email === trim( strtolower( $u->email ) ) ) {
8379
- return $u;
8380
- }
8381
- }
8382
- }
8383
-
8384
- return false;
8385
- }
8386
-
8387
- #----------------------------------------------------------------------------------
8388
- #region Account (Loading, Updates & Activation)
8389
- #----------------------------------------------------------------------------------
8390
-
8391
- /***
8392
- * Load account information (user + site).
8393
- *
8394
- * @author Vova Feldman (@svovaf)
8395
- * @since 1.0.1
8396
- */
8397
- private function _load_account() {
8398
- $this->_logger->entrance();
8399
-
8400
- $this->do_action( 'before_account_load' );
8401
-
8402
- $sites = self::get_all_sites( $this->_module_type );
8403
- $users = self::get_all_users();
8404
- $plans = self::get_all_plans( $this->_module_type );
8405
- $licenses = self::get_all_licenses( $this->_module_type );
8406
-
8407
- if ( $this->_logger->is_on() && is_admin() ) {
8408
- $this->_logger->log( 'sites = ' . var_export( $sites, true ) );
8409
- $this->_logger->log( 'users = ' . var_export( $users, true ) );
8410
- $this->_logger->log( 'plans = ' . var_export( $plans, true ) );
8411
- $this->_logger->log( 'licenses = ' . var_export( $licenses, true ) );
8412
- }
8413
-
8414
- $site = isset( $sites[ $this->_slug ] ) ? $sites[ $this->_slug ] : false;
8415
-
8416
- if ( is_object( $site ) &&
8417
- is_numeric( $site->id ) &&
8418
- is_numeric( $site->user_id ) &&
8419
- is_object( $site->plan )
8420
- ) {
8421
- // Load site.
8422
- $this->_site = clone $site;
8423
- $this->_site->plan = self::decrypt_entity( $this->_site->plan );
8424
 
8425
- /**
8426
- * If the install owner's details are not stored locally, use the previous user's details if available.
8427
- *
8428
- * @author Leo Fajardo (@leorw)
8429
- */
8430
- if ( ! isset( $users[ $this->_site->user_id ] ) && FS_User::is_valid_id( $this->_storage->prev_user_id ) ) {
8431
- $user_id = $this->_storage->prev_user_id;
8432
- } else {
8433
- $user_id = $this->_site->user_id;
8434
- }
8435
-
8436
- // Load relevant user.
8437
- $this->_user = clone $users[ $user_id ];
8438
-
8439
- // Load plans.
8440
- $this->_plans = $plans[ $this->_slug ];
8441
- if ( ! is_array( $this->_plans ) || empty( $this->_plans ) ) {
8442
- $this->_sync_plans();
8443
- } else {
8444
- for ( $i = 0, $len = count( $this->_plans ); $i < $len; $i ++ ) {
8445
- if ( $this->_plans[ $i ] instanceof FS_Plugin_Plan ) {
8446
- $this->_plans[ $i ] = self::decrypt_entity( $this->_plans[ $i ] );
8447
- } else {
8448
- unset( $this->_plans[ $i ] );
8449
- }
8450
- }
8451
- }
8452
-
8453
- // Load licenses.
8454
- $this->_licenses = array();
8455
- if ( is_array( $licenses ) &&
8456
- isset( $licenses[ $this->_slug ] ) &&
8457
- isset( $licenses[ $this->_slug ][ $this->_user->id ] )
8458
- ) {
8459
- $this->_licenses = $licenses[ $this->_slug ][ $this->_user->id ];
8460
- }
8461
-
8462
- $this->_license = $this->_get_license_by_id( $this->_site->license_id );
8463
-
8464
- if ( $this->_site->version != $this->get_plugin_version() ) {
8465
- // If stored install version is different than current installed plugin version,
8466
- // then update plugin version event.
8467
- $this->update_plugin_version_event();
8468
- }
8469
- }
8470
-
8471
- $this->_register_account_hooks();
8472
- }
8473
-
8474
- /**
8475
- * @author Vova Feldman (@svovaf)
8476
- * @since 1.0.1
8477
- *
8478
- * @param FS_User $user
8479
- * @param FS_Site $site
8480
- * @param bool|array $plans
8481
- */
8482
- private function _set_account( FS_User $user, FS_Site $site, $plans = false ) {
8483
- $site->slug = $this->_slug;
8484
- $site->user_id = $user->id;
8485
-
8486
- $this->_site = $site;
8487
- $this->_user = $user;
8488
- if ( false !== $plans ) {
8489
- $this->_plans = $plans;
8490
- }
8491
-
8492
- $this->send_install_update();
8493
-
8494
- $this->_store_account();
8495
-
8496
- }
8497
-
8498
- /**
8499
- * @author Vova Feldman (@svovaf)
8500
- * @since 1.1.7.4
8501
- *
8502
- * @param array $override_with
8503
- *
8504
- * @return array
8505
- */
8506
- function get_opt_in_params( $override_with = array() ) {
8507
- $this->_logger->entrance();
8508
-
8509
- $current_user = self::_get_current_wp_user();
8510
-
8511
- $activation_action = $this->get_unique_affix() . '_activate_new';
8512
- $return_url = $this->is_anonymous() ?
8513
- // If skipped already, then return to the account page.
8514
- $this->get_account_url( $activation_action, array(), false ) :
8515
- // Return to the module's main page.
8516
- $this->get_after_activation_url( 'after_connect_url', array( 'fs_action' => $activation_action ) );
8517
-
8518
- $params = array(
8519
- 'user_firstname' => $current_user->user_firstname,
8520
- 'user_lastname' => $current_user->user_lastname,
8521
- 'user_nickname' => $current_user->user_nicename,
8522
- 'user_email' => $current_user->user_email,
8523
- 'user_ip' => WP_FS__REMOTE_ADDR,
8524
- 'plugin_slug' => $this->_slug,
8525
- 'plugin_id' => $this->get_id(),
8526
- 'plugin_public_key' => $this->get_public_key(),
8527
- 'plugin_version' => $this->get_plugin_version(),
8528
- 'return_url' => fs_nonce_url( $return_url, $activation_action ),
8529
- 'account_url' => fs_nonce_url( $this->_get_admin_page_url(
8530
- 'account',
8531
- array( 'fs_action' => 'sync_user' )
8532
- ), 'sync_user' ),
8533
- 'site_uid' => $this->get_anonymous_id(),
8534
- 'site_url' => get_site_url(),
8535
- 'site_name' => get_bloginfo( 'name' ),
8536
- 'platform_version' => get_bloginfo( 'version' ),
8537
- 'sdk_version' => $this->version,
8538
- 'programming_language_version' => phpversion(),
8539
- 'language' => get_bloginfo( 'language' ),
8540
- 'charset' => get_bloginfo( 'charset' ),
8541
- 'is_premium' => $this->is_premium(),
8542
- 'is_active' => true,
8543
- 'is_uninstalled' => false,
8544
- );
8545
-
8546
- if ( $this->is_pending_activation() &&
8547
- ! empty( $this->_storage->pending_license_key )
8548
- ) {
8549
- $params['license_key'] = $this->_storage->pending_license_key;
8550
- }
8551
-
8552
- if ( WP_FS__SKIP_EMAIL_ACTIVATION && $this->has_secret_key() ) {
8553
- // Even though rand() is known for its security issues,
8554
- // the timestamp adds another layer of protection.
8555
- // It would be very hard for an attacker to get the secret key form here.
8556
- // Plus, this should never run in production since the secret should never
8557
- // be included in the production version.
8558
- $params['ts'] = WP_FS__SCRIPT_START_TIME;
8559
- $params['salt'] = md5( uniqid( rand() ) );
8560
- $params['secure'] = md5(
8561
- $params['ts'] .
8562
- $params['salt'] .
8563
- $this->get_secret_key()
8564
- );
8565
- }
8566
-
8567
- return array_merge( $params, $override_with );
8568
- }
8569
-
8570
- /**
8571
- * 1. If successful opt-in or pending activation returns the next page that the user should be redirected to.
8572
- * 2. If there was an API error, return the API result.
8573
- *
8574
- * @author Vova Feldman (@svovaf)
8575
- * @since 1.1.7.4
8576
- *
8577
- * @param string|bool $email
8578
- * @param string|bool $first
8579
- * @param string|bool $last
8580
- * @param string|bool $license_key
8581
- * @param bool $is_uninstall If "true", this means that the module is currently being uninstalled.
8582
- * In this case, the user and site info will be sent to the server but no
8583
- * data will be saved to the WP installation's database.
8584
- * @param number|bool $trial_plan_id
8585
- * @param bool $is_disconnected Whether or not to opt in without tracking.
8586
- *
8587
- * @return string|object
8588
- * @use WP_Error
8589
- */
8590
- function opt_in(
8591
- $email = false,
8592
- $first = false,
8593
- $last = false,
8594
- $license_key = false,
8595
- $is_uninstall = false,
8596
- $trial_plan_id = false,
8597
- $is_disconnected = false
8598
- ) {
8599
- $this->_logger->entrance();
8600
-
8601
- if ( false === $email ) {
8602
- $current_user = self::_get_current_wp_user();
8603
- $email = $current_user->user_email;
8604
- }
8605
-
8606
- /**
8607
- * @since 1.2.1 If activating with license key, ignore the context-user
8608
- * since the user will be automatically loaded from the license.
8609
- */
8610
- if ( empty( $license_key ) ) {
8611
- // Clean up pending license if opt-ing in again.
8612
- $this->_storage->remove( 'pending_license_key' );
8613
-
8614
- if ( ! $is_uninstall ) {
8615
- $fs_user = Freemius::_get_user_by_email( $email );
8616
- if ( is_object( $fs_user ) && ! $this->is_pending_activation() ) {
8617
- return $this->install_with_current_user( false, $trial_plan_id );
8618
- }
8619
- }
8620
- }
8621
-
8622
- $user_info = array();
8623
- if ( ! empty( $email ) ) {
8624
- $user_info['user_email'] = $email;
8625
- }
8626
- if ( ! empty( $first ) ) {
8627
- $user_info['user_firstname'] = $first;
8628
- }
8629
- if ( ! empty( $last ) ) {
8630
- $user_info['user_lastname'] = $last;
8631
- }
8632
-
8633
- $params = $this->get_opt_in_params( $user_info );
8634
-
8635
- $filtered_license_key = false;
8636
- if ( is_string( $license_key ) ) {
8637
- $filtered_license_key = $this->apply_filters( 'license_key', $license_key );
8638
- $params['license_key'] = $filtered_license_key;
8639
- } else if ( FS_Plugin_Plan::is_valid_id( $trial_plan_id ) ) {
8640
- $params['trial_plan_id'] = $trial_plan_id;
8641
- }
8642
-
8643
- if ( $is_uninstall ) {
8644
- $params['uninstall_params'] = array(
8645
- 'reason_id' => $this->_storage->uninstall_reason->id,
8646
- 'reason_info' => $this->_storage->uninstall_reason->info
8647
- );
8648
- }
8649
-
8650
- if ( isset( $params['license_key'] ) ) {
8651
- $fs_user = Freemius::_get_user_by_email( $email );
8652
-
8653
- if ( is_object( $fs_user ) ) {
8654
- /**
8655
- * If opting in with a context license and the context WP Admin user already opted in
8656
- * before from the current site, add the user context security params to avoid the
8657
- * unnecessry email activation when the context license is owned by the same context user.
8658
- *
8659
- * @author Leo Fajardo (@leorw)
8660
- * @since 1.2.3
8661
- */
8662
- $params = array_merge( $params, FS_Security::instance()->get_context_params(
8663
- $fs_user,
8664
- false,
8665
- 'install_with_existing_user'
8666
- ) );
8667
- }
8668
- }
8669
 
8670
- $params['is_disconnected'] = $is_disconnected;
8671
- $params['format'] = 'json';
8672
-
8673
- $url = WP_FS__ADDRESS . '/action/service/user/install/';
8674
- if ( isset( $_COOKIE['XDEBUG_SESSION'] ) ) {
8675
- $url = add_query_arg( 'XDEBUG_SESSION', 'PHPSTORM', $url );
8676
- }
8677
-
8678
- $response = wp_remote_post( $url, array(
8679
- 'method' => 'POST',
8680
- 'body' => $params,
8681
- 'timeout' => 15,
8682
- ) );
8683
-
8684
- if ( $response instanceof WP_Error ) {
8685
- if ( 'https://' === substr( $url, 0, 8 ) &&
8686
- isset( $response->errors ) &&
8687
- isset( $response->errors['http_request_failed'] )
8688
- ) {
8689
- $http_error = strtolower( $response->errors['http_request_failed'][0] );
8690
-
8691
- if ( false !== strpos( $http_error, 'ssl' ) ) {
8692
- // Failed due to old version of cURL or Open SSL (SSLv3 is not supported by CloudFlare).
8693
- $url = 'http://' . substr( $url, 8 );
8694
-
8695
- $response = wp_remote_post( $url, array(
8696
- 'method' => 'POST',
8697
- 'body' => $params,
8698
- 'timeout' => 15,
8699
- ) );
8700
- }
8701
- }
8702
- }
8703
-
8704
- if ( is_wp_error( $response ) ) {
8705
- /**
8706
- * @var WP_Error $response
8707
- */
8708
- $result = new stdClass();
8709
-
8710
- $error_code = $response->get_error_code();
8711
- $error_type = str_replace( ' ', '', ucwords( str_replace( '_', ' ', $error_code ) ) );
8712
-
8713
- $result->error = (object) array(
8714
- 'type' => $error_type,
8715
- 'message' => $response->get_error_message(),
8716
- 'code' => $error_code,
8717
- 'http' => 402
8718
- );
8719
-
8720
- return $result;
8721
- }
8722
-
8723
- // Module is being uninstalled, don't handle the returned data.
8724
- if ( $is_uninstall ) {
8725
- return true;
8726
- }
8727
 
8728
  /**
8729
- * 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.
 
 
 
8730
  *
8731
  * @author Vova Feldman (@svovaf)
8732
- * @since 1.2.3
8733
- * @link https://themes.trac.wordpress.org/ticket/46134#comment:5
8734
- * @link https://themes.trac.wordpress.org/ticket/46134#comment:9
8735
- * @link https://themes.trac.wordpress.org/ticket/46134#comment:12
8736
- * @link https://themes.trac.wordpress.org/ticket/46134#comment:14
8737
  */
8738
- $decoded = is_string( $response['body'] ) ?
8739
- json_decode( $response['body'] ) :
8740
- null;
 
 
 
8741
 
8742
- if ( empty( $decoded ) ) {
8743
- return false;
8744
- }
8745
-
8746
- if ( ! $this->is_api_result_object( $decoded ) ) {
8747
- if ( ! empty( $params['license_key'] ) ) {
8748
- // Pass the fully entered license key to the failure handler.
8749
- $params['license_key'] = $license_key;
8750
- }
8751
-
8752
- return $is_uninstall ?
8753
- $decoded :
8754
- $this->apply_filters( 'after_install_failure', $decoded, $params );
8755
- } else if ( isset( $decoded->pending_activation ) && $decoded->pending_activation ) {
8756
- // Pending activation, add message.
8757
- return $this->set_pending_confirmation(
8758
- ( isset( $decoded->email ) ?
8759
- $decoded->email :
8760
- true ),
8761
- false,
8762
- $filtered_license_key,
8763
- ! empty( $params['trial_plan_id'] )
8764
- );
8765
- } else if ( isset( $decoded->install_secret_key ) ) {
8766
- return $this->install_with_new_user(
8767
- $decoded->user_id,
8768
- $decoded->user_public_key,
8769
- $decoded->user_secret_key,
8770
- $decoded->install_id,
8771
- $decoded->install_public_key,
8772
- $decoded->install_secret_key,
8773
- false
8774
- );
8775
- }
8776
-
8777
- return $decoded;
8778
- }
8779
-
8780
- /**
8781
- * Set user and site identities.
8782
- *
8783
- * @author Vova Feldman (@svovaf)
8784
- * @since 1.0.9
8785
- *
8786
- * @param FS_User $user
8787
- * @param FS_Site $site
8788
- * @param bool $redirect
8789
- * @param bool $auto_install Since 1.2.1.7 If `true` and setting up an account with a valid license, will
8790
- * redirect (or return a URL) to the account page with a special parameter to
8791
- * trigger the auto installation processes.
8792
- *
8793
- * @return string If redirect is `false`, returns the next page the user should be redirected to.
8794
- */
8795
- function setup_account(
8796
- FS_User $user,
8797
- FS_Site $site,
8798
- $redirect = true,
8799
- $auto_install = false
8800
- ) {
8801
- $this->_user = $user;
8802
- $this->_site = $site;
8803
-
8804
- $this->_sync_plans();
8805
-
8806
- $this->_enrich_site_plan( false );
8807
-
8808
- $this->_set_account( $user, $site );
8809
-
8810
- if ( $this->is_trial() ) {
8811
- // Store trial plan information.
8812
- $this->_enrich_site_trial_plan( true );
8813
- }
8814
-
8815
- // If Freemius was OFF before, turn it on.
8816
- $this->turn_on();
8817
-
8818
- $this->do_action( 'after_account_connection', $user, $site );
8819
-
8820
- if ( is_numeric( $site->license_id ) ) {
8821
- $this->_license = $this->_get_license_by_id( $site->license_id );
8822
- }
8823
-
8824
- $this->_admin_notices->remove_sticky( 'connect_account' );
8825
-
8826
- if ( $this->is_pending_activation() || ! $this->has_settings_menu() ) {
8827
- // Remove pending activation sticky notice (if still exist).
8828
- $this->_admin_notices->remove_sticky( 'activation_pending' );
8829
-
8830
- // Remove plugin from pending activation mode.
8831
- unset( $this->_storage->is_pending_activation );
8832
-
8833
- if ( ! $this->is_paying_or_trial() ) {
8834
- $this->_admin_notices->add_sticky(
8835
- sprintf( $this->get_text_x_inline( '%s activation was successfully completed.',
8836
- 'pluginX activation was successfully...', 'plugin-x-activation-message' ), '<b>' . $this->get_plugin_name() . '</b>' ),
8837
- 'activation_complete'
8838
- );
8839
- }
8840
- }
8841
-
8842
- if ( $this->is_paying_or_trial() ) {
8843
- if ( ! $this->is_premium() || ! $this->has_premium_version() || ! $this->has_settings_menu() ) {
8844
- if ( $this->is_paying() ) {
8845
- $this->_admin_notices->add_sticky(
8846
- sprintf(
8847
- $this->get_text_inline( 'Your account was successfully activated with the %s plan.', 'activation-with-plan-x-message' ),
8848
- $this->_site->plan->title
8849
- ) . $this->get_complete_upgrade_instructions(),
8850
- 'plan_upgraded',
8851
- $this->get_text_x_inline( 'Yee-haw', 'interjection expressing joy or exuberance', 'yee-haw' ) . '!'
8852
- );
8853
- } else {
8854
- $this->_admin_notices->add_sticky(
8855
- sprintf(
8856
- $this->get_text_inline( 'Your trial has been successfully started.', 'trial-started-message' ),
8857
- '<i>' . $this->get_plugin_name() . '</i>'
8858
- ) . $this->get_complete_upgrade_instructions( $this->_storage->trial_plan->title ),
8859
- 'trial_started',
8860
- $this->get_text_x_inline( 'Yee-haw', 'interjection expressing joy or exuberance', 'yee-haw' ) . '!'
8861
- );
8862
- }
8863
- }
8864
-
8865
- $this->_admin_notices->remove_sticky( array(
8866
- 'trial_promotion',
8867
- ) );
8868
- }
8869
-
8870
- $plugin_id = fs_request_get( 'plugin_id', false );
8871
-
8872
- // Store activation time ONLY for plugins (not add-ons).
8873
- if ( ! is_numeric( $plugin_id ) || ( $plugin_id == $this->_plugin->id ) ) {
8874
- $this->_storage->activation_timestamp = WP_FS__SCRIPT_START_TIME;
8875
- }
8876
-
8877
- $next_page = '';
8878
-
8879
- $extra = array();
8880
- if ( $auto_install ) {
8881
- $extra['auto_install'] = 'true';
8882
- }
8883
-
8884
- if ( is_numeric( $plugin_id ) ) {
8885
- /**
8886
- * @author Leo Fajardo
8887
- * @since 1.2.1.6
8888
- *
8889
- * Also sync the license after an anonymous user subscribes.
8890
- */
8891
- if ( $this->is_anonymous() || $plugin_id != $this->_plugin->id ) {
8892
- // Add-on was installed - sync license right after install.
8893
- $next_page = $this->_get_sync_license_url( $plugin_id, true, $extra );
8894
- }
8895
- } else {
8896
- /**
8897
- * @author Vova Feldman (@svovaf)
8898
- * @since 1.1.9 If site installed with a valid license, sync license.
8899
- */
8900
- if ( $this->is_paying() ) {
8901
- $this->_sync_plugin_license( true );
8902
- }
8903
-
8904
- // Reload the page with the keys.
8905
- $next_page = $this->is_anonymous() ?
8906
- // If user previously skipped, redirect to account page.
8907
- $this->get_account_url( false, $extra ) :
8908
- $this->get_after_activation_url( 'after_connect_url' );
8909
- }
8910
-
8911
- if ( ! empty( $next_page ) && $redirect ) {
8912
- fs_redirect( $next_page );
8913
- }
8914
-
8915
- return $next_page;
8916
- }
8917
-
8918
- /**
8919
- * Install plugin with new user information after approval.
8920
- *
8921
- * @author Vova Feldman (@svovaf)
8922
- * @since 1.0.7
8923
- */
8924
- function _install_with_new_user() {
8925
- $this->_logger->entrance();
8926
-
8927
- if ( $this->is_registered() ) {
8928
- return;
8929
- }
8930
-
8931
- if ( ( $this->is_plugin() && fs_request_is_action( $this->get_unique_affix() . '_activate_new' ) ) ||
8932
- // @todo This logic should be improved because it's executed on every load of a theme.
8933
- $this->is_theme()
8934
- ) {
8935
- // check_admin_referer( $this->_slug . '_activate_new' );
8936
 
8937
- if ( fs_request_has( 'user_secret_key' ) ) {
8938
- $this->install_with_new_user(
8939
- fs_request_get( 'user_id' ),
8940
- fs_request_get( 'user_public_key' ),
8941
- fs_request_get( 'user_secret_key' ),
8942
- fs_request_get( 'install_id' ),
8943
- fs_request_get( 'install_public_key' ),
8944
- fs_request_get( 'install_secret_key' ),
8945
- true,
8946
- fs_request_get_bool( 'auto_install' )
8947
- );
8948
- } else if ( fs_request_has( 'pending_activation' ) ) {
8949
- $this->set_pending_confirmation( fs_request_get( 'user_email' ), true );
8950
- }
8951
- }
8952
- }
8953
-
8954
- /**
8955
- * Install plugin with new user.
8956
- *
8957
- * @author Vova Feldman (@svovaf)
8958
- * @since 1.1.7.4
8959
- *
8960
- * @param number $user_id
8961
- * @param string $user_public_key
8962
- * @param string $user_secret_key
8963
- * @param number $install_id
8964
- * @param string $install_public_key
8965
- * @param string $install_secret_key
8966
- * @param bool $redirect
8967
- * @param bool $auto_install Since 1.2.1.7 If `true` and setting up an account with a valid license, will
8968
- * redirect (or return a URL) to the account page with a special parameter to
8969
- * trigger the auto installation processes.
8970
- *
8971
- * @return string If redirect is `false`, returns the next page the user should be redirected to.
8972
- */
8973
- private function install_with_new_user(
8974
- $user_id,
8975
- $user_public_key,
8976
- $user_secret_key,
8977
- $install_id,
8978
- $install_public_key,
8979
- $install_secret_key,
8980
- $redirect = true,
8981
- $auto_install = false
8982
- ) {
8983
- $user = new FS_User();
8984
- $user->id = $user_id;
8985
- $user->public_key = $user_public_key;
8986
- $user->secret_key = $user_secret_key;
8987
-
8988
- $this->_user = $user;
8989
- $user_result = $this->get_api_user_scope()->get();
8990
- $user = new FS_User( $user_result );
8991
- $this->_user = $user;
8992
-
8993
- $site = new FS_Site();
8994
- $site->id = $install_id;
8995
- $site->public_key = $install_public_key;
8996
- $site->secret_key = $install_secret_key;
8997
-
8998
- $this->_site = $site;
8999
- $site_result = $this->get_api_site_scope()->get();
9000
- $site = new FS_Site( $site_result );
9001
- $this->_site = $site;
9002
-
9003
- return $this->setup_account(
9004
- $this->_user,
9005
- $this->_site,
9006
- $redirect,
9007
- $auto_install
9008
- );
9009
- }
9010
-
9011
- /**
9012
- * @author Vova Feldman (@svovaf)
9013
- * @since 1.1.7.4
9014
- *
9015
- * @param string|bool $email
9016
- * @param bool $redirect
9017
- * @param string|bool $license_key Since 1.2.1.5
9018
- * @param bool $is_pending_trial Since 1.2.1.5
9019
- *
9020
- * @return string Since 1.2.1.5 if $redirect is `false`, return the pending activation page.
9021
- */
9022
- private function set_pending_confirmation(
9023
- $email = false,
9024
- $redirect = true,
9025
- $license_key = false,
9026
- $is_pending_trial = false
9027
- ) {
9028
- if ( $this->_ignore_pending_mode ) {
9029
- /**
9030
- * If explicitly asked to ignore pending mode, set to anonymous mode
9031
- * if require confirmation before finalizing the opt-in.
9032
- *
9033
- * @author Vova Feldman
9034
- * @since 1.2.1.6
9035
- */
9036
- $this->skip_connection();
9037
- } else {
9038
- // Install must be activated via email since
9039
- // user with the same email already exist.
9040
- $this->_storage->is_pending_activation = true;
9041
- $this->_add_pending_activation_notice( $email, $is_pending_trial );
9042
- }
9043
-
9044
- if ( ! empty( $license_key ) ) {
9045
- $this->_storage->pending_license_key = $license_key;
9046
- }
9047
-
9048
- // Remove the opt-in sticky notice.
9049
- $this->_admin_notices->remove_sticky( array(
9050
- 'connect_account',
9051
- 'trial_promotion',
9052
- ) );
9053
-
9054
- $next_page = $this->get_after_activation_url( 'after_pending_connect_url' );
9055
-
9056
- // Reload the page with with pending activation message.
9057
- if ( $redirect ) {
9058
- fs_redirect( $next_page );
9059
- }
9060
-
9061
- return $next_page;
9062
- }
9063
-
9064
- /**
9065
- * Install plugin with current logged WP user info.
9066
- *
9067
- * @author Vova Feldman (@svovaf)
9068
- * @since 1.0.7
9069
- */
9070
- function _install_with_current_user() {
9071
- $this->_logger->entrance();
9072
-
9073
- if ( $this->is_registered() ) {
9074
- return;
9075
- }
9076
-
9077
- if ( fs_request_is_action( $this->get_unique_affix() . '_activate_existing' ) && fs_request_is_post() ) {
9078
- // check_admin_referer( 'activate_existing_' . $this->_plugin->public_key );
9079
 
9080
- /**
9081
- * @author Vova Feldman (@svovaf)
9082
- * @since 1.1.9 Add license key if given.
9083
- */
9084
- $license_key = fs_request_get( 'license_secret_key' );
9085
-
9086
- $this->install_with_current_user( $license_key );
9087
- }
9088
- }
9089
-
9090
-
9091
- /**
9092
- * @author Vova Feldman (@svovaf)
9093
- * @since 1.1.7.4
9094
- *
9095
- * @param string|bool $license_key
9096
- * @param number|bool $trial_plan_id
9097
- * @param bool $redirect
9098
- *
9099
- * @return string|object If redirect is `false`, returns the next page the user should be redirected to, or the
9100
- * API error object if failed to install.
9101
- */
9102
- private function install_with_current_user(
9103
- $license_key = false,
9104
- $trial_plan_id = false,
9105
- $redirect = true
9106
- ) {
9107
- // Get current logged WP user.
9108
- $current_user = self::_get_current_wp_user();
9109
-
9110
- // Find the relevant FS user by the email.
9111
- $user = self::_get_user_by_email( $current_user->user_email );
9112
-
9113
- // We have to set the user before getting user scope API handler.
9114
- $this->_user = $user;
9115
-
9116
- $extra_install_params = array(
9117
- 'uid' => $this->get_anonymous_id(),
9118
- );
9119
-
9120
- if ( ! empty( $license_key ) ) {
9121
- $filtered_license_key = $this->apply_filters( 'license_key', $license_key );
9122
- $extra_install_params['license_key'] = $filtered_license_key;
9123
- } else if ( FS_Plugin_Plan::is_valid_id( $trial_plan_id ) ) {
9124
- $extra_install_params['trial_plan_id'] = $trial_plan_id;
9125
- }
9126
-
9127
- $args = $this->get_install_data_for_api( $extra_install_params, false, false );
9128
-
9129
- // Install the plugin.
9130
- $install = $this->get_api_user_scope()->call(
9131
- "/plugins/{$this->get_id()}/installs.json",
9132
- 'post',
9133
- $args
9134
- );
9135
-
9136
- if ( ! $this->is_api_result_entity( $install ) ) {
9137
- if ( ! empty( $args['license_key'] ) ) {
9138
- // Pass full the fully entered license key to the failure handler.
9139
- $args['license_key'] = $license_key;
9140
- }
9141
-
9142
- $install = $this->apply_filters( 'after_install_failure', $install, $args );
9143
-
9144
- $this->_admin_notices->add(
9145
- sprintf( $this->get_text_inline( 'Couldn\'t activate %s.', 'could-not-activate-x' ), $this->get_plugin_name() ) . ' ' .
9146
- $this->get_text_inline( 'Please contact us with the following message:', 'contact-us-with-error-message' ) . ' ' . '<b>' . $install->error->message . '</b>',
9147
- $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
9148
- 'error'
9149
- );
9150
-
9151
- if ( $redirect ) {
9152
  /**
9153
- * We set the user before getting the user scope API handler, so the user became temporarily
9154
- * registered (`is_registered() = true`). Since the API returned an error and we will redirect,
9155
- * we have to set the user to `null`, otherwise, the user will be redirected to the wrong
9156
- * activation page based on the return value of `is_registered()`. In addition, in case the
9157
- * context plugin doesn't have a settings menu and the default page is the `Plugins` page,
9158
- * misleading plugin activation errors will be shown on the `Plugins` page.
9159
  *
9160
- * @author Leo Fajardo (@leorw)
 
9161
  */
9162
- $this->_user = null;
 
 
 
9163
 
9164
- fs_redirect( $this->get_activation_url( array( 'error' => $install->error->message ) ) );
9165
- }
9166
-
9167
- return $install;
9168
- }
9169
-
9170
- $site = new FS_Site( $install );
9171
- $this->_site = $site;
9172
-
9173
- return $this->setup_account( $this->_user, $this->_site, $redirect );
9174
- }
9175
-
9176
- /**
9177
- * Tries to activate add-on account based on parent plugin info.
9178
- *
9179
- * @author Vova Feldman (@svovaf)
9180
- * @since 1.0.6
9181
- *
9182
- * @param Freemius $parent_fs
9183
- */
9184
- private function _activate_addon_account( Freemius $parent_fs ) {
9185
- if ( $this->is_registered() ) {
9186
- // Already activated.
9187
- return;
9188
- }
9189
-
9190
- // Activate add-on with parent plugin credentials.
9191
- $addon_install = $parent_fs->get_api_site_scope()->call(
9192
- "/addons/{$this->_plugin->id}/installs.json",
9193
- 'post',
9194
- $this->get_install_data_for_api( array(
9195
- 'uid' => $this->get_anonymous_id(),
9196
- ), false, false )
9197
- );
9198
-
9199
- if ( isset( $addon_install->error ) ) {
9200
- $this->_admin_notices->add(
9201
- sprintf( $this->get_text_inline( 'Couldn\'t activate %s.', 'could-not-activate-x' ), $this->get_plugin_name() ) . ' ' .
9202
- $this->get_text_inline( 'Please contact us with the following message:', 'contact-us-with-error-message' ) . ' ' . '<b>' . $addon_install->error->message . '</b>',
9203
- $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
9204
- 'error'
9205
- );
9206
-
9207
- return;
9208
- }
9209
-
9210
- // First of all, set site info - otherwise we won't
9211
- // be able to invoke API calls.
9212
- $this->_site = new FS_Site( $addon_install );
9213
-
9214
- // Sync add-on plans.
9215
- $this->_sync_plans();
9216
-
9217
- // Get site's current plan.
9218
- $this->_site->plan = $this->_get_plan_by_id( $this->_site->plan->id );
9219
-
9220
- // Get user information based on parent's plugin.
9221
- $user = $parent_fs->get_user();
9222
-
9223
- $this->_set_account( $user, $this->_site );
9224
-
9225
- // Sync licenses.
9226
- $this->_sync_licenses();
9227
-
9228
- // Try to activate premium license.
9229
- $this->_activate_license( true );
9230
- }
9231
-
9232
- /**
9233
- * Tries to activate parent account based on add-on's info.
9234
- *
9235
- * @author Vova Feldman (@svovaf)
9236
- * @since 1.2.2.7
9237
- *
9238
- * @param Freemius $parent_fs
9239
- */
9240
- private function activate_parent_account( Freemius $parent_fs ) {
9241
- if ( ! $this->is_addon() ) {
9242
- // This is not an add-on.
9243
- return;
9244
- }
9245
-
9246
- if ( $parent_fs->is_registered() ) {
9247
- // Already activated.
9248
- return;
9249
- }
9250
-
9251
- // Activate parent with add-on's user credentials.
9252
- $parent_install = $this->get_api_user_scope()->call(
9253
- "/plugins/{$parent_fs->_plugin->id}/installs.json",
9254
- 'post',
9255
- $parent_fs->get_install_data_for_api( array(
9256
- 'uid' => $parent_fs->get_anonymous_id(),
9257
- ), false, false )
9258
- );
9259
-
9260
- if ( isset( $parent_install->error ) ) {
9261
- $this->_admin_notices->add(
9262
- sprintf( $this->get_text_inline( 'Couldn\'t activate %s.', 'could-not-activate-x' ), $this->get_plugin_name() ) . ' ' .
9263
- $this->get_text_inline( 'Please contact us with the following message:', 'contact-us-with-error-message' ) . ' ' . '<b>' . $parent_install->error->message . '</b>',
9264
- $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
9265
- 'error'
9266
- );
9267
-
9268
- return;
9269
- }
9270
 
9271
- $parent_fs->_admin_notices->remove_sticky( 'connect_account' );
 
 
 
 
 
 
 
 
 
 
9272
 
9273
- if ( $parent_fs->is_pending_activation() ) {
9274
- $parent_fs->_admin_notices->remove_sticky( 'activation_pending' );
9275
 
9276
- unset( $parent_fs->_storage->is_pending_activation );
9277
- }
 
 
 
 
 
 
 
 
 
 
9278
 
9279
- // First of all, set site info - otherwise we won't
9280
- // be able to invoke API calls.
9281
- $parent_fs->_site = new FS_Site( $parent_install );
9282
 
9283
- // Sync add-on plans.
9284
- $parent_fs->_sync_plans();
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9285
 
9286
- // Get site's current plan.
9287
- $parent_fs->_site->plan = $parent_fs->_get_plan_by_id( $parent_fs->_site->plan->id );
 
 
 
 
9288
 
9289
- // Get user information based on parent's plugin.
9290
- $user = $this->get_user();
 
 
9291
 
9292
- $parent_fs->_set_account( $user, $parent_fs->_site );
9293
- }
9294
 
9295
- #endregion
 
 
 
 
9296
 
9297
- #----------------------------------------------------------------------------------
9298
- #region Admin Menu Items
9299
- #----------------------------------------------------------------------------------
 
9300
 
9301
- private $_menu_items = array();
 
 
 
9302
 
9303
- /**
9304
- * @author Vova Feldman (@svovaf)
9305
- * @since 1.2.1.8
9306
- *
9307
- * @return array
9308
- */
9309
- function get_menu_items() {
9310
- return $this->_menu_items;
9311
- }
9312
 
9313
- /**
9314
- * @author Vova Feldman (@svovaf)
9315
- * @since 1.0.7
9316
- *
9317
- * @return string
9318
- */
9319
- function get_menu_slug() {
9320
- return $this->_menu->get_slug();
9321
- }
9322
 
9323
- /**
9324
- * @author Vova Feldman (@svovaf)
9325
- * @since 1.0.9
9326
- */
9327
- function _prepare_admin_menu() {
9328
- // if ( ! $this->is_on() ) {
9329
- // return;
9330
- // }
9331
 
9332
- if ( ! $this->has_api_connectivity() && ! $this->is_enable_anonymous() ) {
9333
- $this->_menu->remove_menu_item();
9334
- } else {
9335
- $this->do_action( 'before_admin_menu_init' );
9336
-
9337
- $this->add_menu_action();
9338
- $this->add_submenu_items();
9339
- }
9340
- }
9341
-
9342
- /**
9343
- * Admin dashboard menu items modifications.
9344
- *
9345
- * NOTE: admin_menu action executed before admin_init.
9346
- *
9347
- * @author Vova Feldman (@svovaf)
9348
- * @since 1.0.7
9349
- *
9350
- */
9351
- private function add_menu_action() {
9352
- if ( $this->is_activation_mode() ) {
9353
- if ( $this->is_plugin() || ( $this->has_settings_menu() && ! $this->is_free_wp_org_theme() ) ) {
9354
- $this->override_plugin_menu_with_activation();
9355
- } else {
9356
- /**
9357
- * Handle theme opt-in when the opt-in form shows as a dialog box in the themes page.
9358
- */
9359
- if ( fs_request_is_action( $this->get_unique_affix() . '_activate_existing' ) ) {
9360
- add_action( 'load-themes.php', array( &$this, '_install_with_current_user' ) );
9361
- } else if ( fs_request_is_action( $this->get_unique_affix() . '_activate_new' ) ||
9362
- fs_request_get_bool( 'pending_activation' )
9363
- ) {
9364
- add_action( 'load-themes.php', array( &$this, '_install_with_new_user' ) );
9365
- }
9366
- }
9367
- } else {
9368
- if ( ! $this->is_registered() ) {
9369
- // If not registered try to install user.
9370
- if ( fs_request_is_action( $this->get_unique_affix() . '_activate_new' ) ) {
9371
- $this->_install_with_new_user();
9372
- }
9373
- } else if (
9374
- fs_request_is_action( 'sync_user' ) &&
9375
- ( ! $this->has_settings_menu() || $this->is_free_wp_org_theme() )
9376
- ) {
9377
- $this->_handle_account_user_sync();
9378
- }
9379
- }
9380
- }
9381
-
9382
- /**
9383
- * @author Vova Feldman (@svovaf)
9384
- * @since 1.0.1
9385
- */
9386
- function _redirect_on_clicked_menu_link() {
9387
- $this->_logger->entrance();
9388
-
9389
- $page = strtolower( isset( $_REQUEST['page'] ) ? $_REQUEST['page'] : '' );
9390
-
9391
- $this->_logger->log( 'page = ' . $page );
9392
-
9393
- foreach ( $this->_menu_items as $priority => $items ) {
9394
- foreach ( $items as $item ) {
9395
- if ( isset( $item['url'] ) ) {
9396
- if ( $page === $this->_menu->get_slug( strtolower( $item['menu_slug'] ) ) ) {
9397
- $this->_logger->log( 'Redirecting to ' . $item['url'] );
9398
-
9399
- fs_redirect( $item['url'] );
9400
- }
9401
- }
9402
- }
9403
- }
9404
- }
9405
-
9406
- /**
9407
- * Remove plugin's all admin menu items & pages, and replace with activation page.
9408
- *
9409
- * @author Vova Feldman (@svovaf)
9410
- * @since 1.0.1
9411
- */
9412
- private function override_plugin_menu_with_activation() {
9413
- $this->_logger->entrance();
9414
-
9415
- $hook = false;
9416
-
9417
- if ( ! $this->_menu->has_menu() ) {
9418
- // Add the opt-in page without a menu item.
9419
- $hook = FS_Admin_Menu_Manager::add_subpage(
9420
- null,
9421
- $this->get_plugin_name(),
9422
- $this->get_plugin_name(),
9423
- 'manage_options',
9424
- $this->_slug,
9425
- array( &$this, '_connect_page_render' )
9426
- );
9427
- } else if ( $this->_menu->is_top_level() ) {
9428
- $hook = $this->_menu->override_menu_item( array( &$this, '_connect_page_render' ) );
9429
-
9430
- if ( false === $hook ) {
9431
- // Create new menu item just for the opt-in.
9432
- $hook = FS_Admin_Menu_Manager::add_page(
9433
- $this->get_plugin_name(),
9434
- $this->get_plugin_name(),
9435
- 'manage_options',
9436
- $this->_menu->get_slug(),
9437
- array( &$this, '_connect_page_render' )
9438
- );
9439
- }
9440
- } else {
9441
- $menus = array( $this->_menu->get_parent_slug() );
9442
-
9443
- if ( $this->_menu->is_override_exact() ) {
9444
- // Make sure the current page is matching the activation page.
9445
- if ( ! $this->is_matching_url( $this->get_activation_url() ) ) {
9446
- return;
9447
- }
9448
- }
9449
-
9450
- foreach ( $menus as $parent_slug ) {
9451
- $hook = $this->_menu->override_submenu_action(
9452
- $parent_slug,
9453
- $this->_menu->get_raw_slug(),
9454
- array( &$this, '_connect_page_render' )
9455
- );
9456
-
9457
- if ( false !== $hook ) {
9458
- // Found plugin's submenu item.
9459
- break;
9460
- }
9461
- }
9462
- }
9463
-
9464
- if ( $this->is_activation_page() ) {
9465
- // Clean admin page from distracting content.
9466
- self::_clean_admin_content_section();
9467
- }
9468
-
9469
- if ( false !== $hook ) {
9470
- if ( fs_request_is_action( $this->get_unique_affix() . '_activate_existing' ) ) {
9471
- $this->_install_with_current_user();
9472
- } else if ( fs_request_is_action( $this->get_unique_affix() . '_activate_new' ) ) {
9473
- $this->_install_with_new_user();
9474
- }
9475
- }
9476
- }
9477
-
9478
- /**
9479
- * @author Leo Fajardo (leorw)
9480
- * @since 1.2.1
9481
- *
9482
- * return string
9483
- */
9484
- function get_top_level_menu_capability() {
9485
- global $menu;
9486
-
9487
- $top_level_menu_slug = $this->get_top_level_menu_slug();
9488
-
9489
- foreach ( $menu as $menu_info ) {
9490
- /**
9491
- * The second element in the menu info array is the capability/role that has access to the menu and the
9492
- * third element is the menu slug.
9493
- */
9494
- if ( $menu_info[2] === $top_level_menu_slug ) {
9495
- return $menu_info[1];
9496
- }
9497
- }
9498
-
9499
- return 'read';
9500
- }
9501
-
9502
- /**
9503
- * @author Vova Feldman (@svovaf)
9504
- * @since 1.0.0
9505
- *
9506
- * @return string
9507
- */
9508
- private function get_top_level_menu_slug() {
9509
- return ( $this->is_addon() ?
9510
- $this->get_parent_instance()->_menu->get_top_level_menu_slug() :
9511
- $this->_menu->get_top_level_menu_slug() );
9512
- }
9513
-
9514
- /**
9515
- * @author Vova Feldman (@svovaf)
9516
- * @since 1.2.2.7
9517
- *
9518
- * @return string
9519
- */
9520
- function get_pricing_cta_label() {
9521
- $label = $this->get_text_inline( 'Upgrade', 'upgrade' );
9522
-
9523
- if ( $this->is_in_trial_promotion() &&
9524
- ! $this->is_paying_or_trial()
9525
- ) {
9526
- // If running a trial promotion, modify the pricing to load the trial.
9527
- $label = $this->get_text_inline( 'Start Trial', 'start-trial' );
9528
- } else if ( $this->is_paying() ) {
9529
- $label = $this->get_text_inline( 'Pricing', 'pricing' );
9530
- }
9531
-
9532
- return $label;
9533
- }
9534
-
9535
- /**
9536
- * @author Vova Feldman (@svovaf)
9537
- * @since 1.2.2.7
9538
- *
9539
- * @return bool
9540
- */
9541
- function is_pricing_page_visible() {
9542
- return (
9543
- // Has at least one paid plan.
9544
- $this->has_paid_plan() &&
9545
- // Didn't ask to hide the pricing page.
9546
- $this->is_page_visible( 'pricing' ) &&
9547
- // Don't have a valid active license or has more than one plan.
9548
- ( ! $this->is_paying() || ! $this->is_single_plan() )
9549
- );
9550
- }
9551
-
9552
- /**
9553
- * Add default Freemius menu items.
9554
- *
9555
- * @author Vova Feldman (@svovaf)
9556
- * @since 1.0.0
9557
- */
9558
- private function add_submenu_items() {
9559
- $this->_logger->entrance();
9560
-
9561
- if ( ! $this->is_addon() ) {
9562
- /**
9563
- * @since 1.2.2.7 Also add submenu items when running in a free .org theme so the tabs will be visible.
9564
- */
9565
- if ( ! $this->is_activation_mode() || $this->is_free_wp_org_theme() ) {
9566
- if ( $this->has_affiliate_program() ) {
9567
- // Add affiliation page.
9568
- $this->add_submenu_item(
9569
- $this->get_text_inline( 'Affiliation', 'affiliation' ),
9570
- array( &$this, '_affiliation_page_render' ),
9571
- $this->get_plugin_name() . ' &ndash; ' . $this->get_text_inline( 'Affiliation', 'affiliation' ),
9572
- 'manage_options',
9573
- 'affiliation',
9574
- 'Freemius::_clean_admin_content_section',
9575
- WP_FS__DEFAULT_PRIORITY,
9576
- $this->is_submenu_item_visible( 'affiliation' )
9577
- );
9578
- }
9579
 
9580
- if ( $this->is_registered() ) {
9581
- $show_account = (
9582
- $this->is_submenu_item_visible( 'account' ) &&
9583
- /**
9584
- * @since 1.2.2.7 Don't show the Account for free WP.org themes without any paid plans.
9585
- */
9586
- ( ! $this->is_free_wp_org_theme() || $this->has_paid_plan() )
9587
- );
9588
-
9589
- // Add user account page.
9590
- $this->add_submenu_item(
9591
- $this->get_text_inline( 'Account', 'account' ),
9592
- array( &$this, '_account_page_render' ),
9593
- $this->get_plugin_name() . ' &ndash; ' . $this->get_text_inline( 'Account', 'account' ),
9594
- 'manage_options',
9595
- 'account',
9596
- array( &$this, '_account_page_load' ),
9597
- WP_FS__DEFAULT_PRIORITY,
9598
- $show_account
9599
- );
9600
- }
9601
-
9602
- // Add contact page.
9603
- $this->add_submenu_item(
9604
- $this->get_text_inline( 'Contact Us', 'contact-us' ),
9605
- array( &$this, '_contact_page_render' ),
9606
- $this->get_plugin_name() . ' &ndash; ' . $this->get_text_inline( 'Contact Us', 'contact-us' ),
9607
- 'manage_options',
9608
- 'contact',
9609
- 'Freemius::_clean_admin_content_section',
9610
- WP_FS__DEFAULT_PRIORITY,
9611
- $this->is_submenu_item_visible( 'contact' )
9612
- );
9613
-
9614
- if ( $this->has_addons() ) {
9615
- $this->add_submenu_item(
9616
- $this->get_text_inline( 'Add-Ons', 'add-ons' ),
9617
- array( &$this, '_addons_page_render' ),
9618
- $this->get_plugin_name() . ' &ndash; ' . $this->get_text_inline( 'Add-Ons', 'add-ons' ),
9619
- 'manage_options',
9620
- 'addons',
9621
- array( &$this, '_addons_page_load' ),
9622
- WP_FS__LOWEST_PRIORITY - 1,
9623
- $this->is_submenu_item_visible( 'addons' )
9624
- );
9625
- }
9626
-
9627
- $show_pricing = (
9628
- $this->is_submenu_item_visible( 'pricing' ) &&
9629
- $this->is_pricing_page_visible()
9630
- );
9631
-
9632
- $pricing_cta_text = $this->get_pricing_cta_label();
9633
- $pricing_class = 'upgrade-mode';
9634
- if ( $show_pricing ) {
9635
- if ( $this->is_in_trial_promotion() &&
9636
- ! $this->is_paying_or_trial()
9637
- ) {
9638
- // If running a trial promotion, modify the pricing to load the trial.
9639
- $pricing_class = 'trial-mode';
9640
- } else if ( $this->is_paying() ) {
9641
- $pricing_class = '';
9642
- }
9643
- }
9644
-
9645
- // Add upgrade/pricing page.
9646
- $this->add_submenu_item(
9647
- $pricing_cta_text . '&nbsp;&nbsp;' . ( is_rtl() ? '&#x2190;' : '&#x27a4;' ),
9648
- array( &$this, '_pricing_page_render' ),
9649
- $this->get_plugin_name() . ' &ndash; ' . $this->get_text_x_inline( 'Pricing', 'noun', 'pricing' ),
9650
- 'manage_options',
9651
- 'pricing',
9652
- 'Freemius::_clean_admin_content_section',
9653
- WP_FS__LOWEST_PRIORITY,
9654
- $show_pricing,
9655
- $pricing_class
9656
- );
9657
- }
9658
- }
9659
-
9660
-
9661
- if ( 0 < count( $this->_menu_items ) ) {
9662
- if ( ! $this->_menu->is_top_level() ) {
9663
- fs_enqueue_local_style( 'fs_common', '/admin/common.css' );
9664
-
9665
- // Append submenu items right after the plugin's submenu item.
9666
- $this->order_sub_submenu_items();
9667
- } else {
9668
- // Append submenu items.
9669
- $this->embed_submenu_items();
9670
- }
9671
- }
9672
- }
9673
-
9674
- /**
9675
- * Moved the actual submenu item additions to a separated function,
9676
- * in order to support sub-submenu items when the plugin's settings
9677
- * only have a submenu and not top-level menu item.
9678
- *
9679
- * @author Vova Feldman (@svovaf)
9680
- * @since 1.1.4
9681
- */
9682
- private function embed_submenu_items() {
9683
- $item_template = $this->_menu->is_top_level() ?
9684
- '<span class="fs-submenu-item %s %s %s">%s</span>' :
9685
- '<span class="fs-submenu-item fs-sub %s %s %s">%s</span>';
9686
-
9687
- $top_level_menu_capability = $this->get_top_level_menu_capability();
9688
-
9689
- ksort( $this->_menu_items );
9690
-
9691
- foreach ( $this->_menu_items as $priority => $items ) {
9692
- foreach ( $items as $item ) {
9693
- $capability = ( ! empty( $item['capability'] ) ? $item['capability'] : $top_level_menu_capability );
9694
-
9695
- $menu_item = sprintf(
9696
- $item_template,
9697
- $this->get_unique_affix(),
9698
- $item['menu_slug'],
9699
- ! empty( $item['class'] ) ? $item['class'] : '',
9700
- $item['menu_title']
9701
- );
9702
-
9703
- $menu_slug = $this->_menu->get_slug( $item['menu_slug'] );
9704
-
9705
- if ( ! isset( $item['url'] ) ) {
9706
- $hook = FS_Admin_Menu_Manager::add_subpage(
9707
- $item['show_submenu'] ?
9708
- $this->get_top_level_menu_slug() :
9709
- null,
9710
- $item['page_title'],
9711
- $menu_item,
9712
- $capability,
9713
- $menu_slug,
9714
- $item['render_function']
9715
- );
9716
-
9717
- if ( false !== $item['before_render_function'] ) {
9718
- add_action( "load-$hook", $item['before_render_function'] );
9719
- }
9720
- } else {
9721
- FS_Admin_Menu_Manager::add_subpage(
9722
- $item['show_submenu'] ?
9723
- $this->get_top_level_menu_slug() :
9724
- null,
9725
- $item['page_title'],
9726
- $menu_item,
9727
- $capability,
9728
- $menu_slug,
9729
- array( $this, '' )
9730
- );
9731
- }
9732
- }
9733
- }
9734
- }
9735
-
9736
- /**
9737
- * Re-order the submenu items so all Freemius added new submenu items
9738
- * are added right after the plugin's settings submenu item.
9739
- *
9740
- * @author Vova Feldman (@svovaf)
9741
- * @since 1.1.4
9742
- */
9743
- private function order_sub_submenu_items() {
9744
- global $submenu;
9745
-
9746
- $menu_slug = $this->_menu->get_top_level_menu_slug();
9747
-
9748
- /**
9749
- * Before "admin_menu" fires, WordPress will loop over the default submenus and remove pages for which the user
9750
- * does not have permissions. So in case a plugin does not have top-level menu but does have submenus under any
9751
- * of the default menus, only users that have the right role can access its sub-submenus (Account, Contact Us,
9752
- * Support Forum, etc.) since $submenu[ $menu_slug ] will be empty if the user doesn't have permission.
9753
- *
9754
- * In case a plugin does not have submenus under any of the default menus but does have submenus under the menu
9755
- * of another plugin, only users that have the right role can access its sub-submenus since we will use the
9756
- * capability needed to access the parent menu as the capability for the submenus that we will add.
9757
- */
9758
- if ( empty( $submenu[ $menu_slug ] ) ) {
9759
- return;
9760
- }
9761
-
9762
- $top_level_menu = &$submenu[ $menu_slug ];
9763
-
9764
- $all_submenu_items_after = array();
9765
-
9766
- $found_submenu_item = false;
9767
-
9768
- foreach ( $top_level_menu as $submenu_id => $meta ) {
9769
- if ( $found_submenu_item ) {
9770
- // Remove all submenu items after the plugin's submenu item.
9771
- $all_submenu_items_after[] = $meta;
9772
- unset( $top_level_menu[ $submenu_id ] );
9773
- }
9774
-
9775
- if ( $this->_menu->get_raw_slug() === $meta[2] ) {
9776
- // Found the submenu item, put all below.
9777
- $found_submenu_item = true;
9778
- continue;
9779
- }
9780
- }
9781
-
9782
- // Embed all plugin's new submenu items.
9783
- $this->embed_submenu_items();
9784
-
9785
- // Start with specially high number to make sure it's appended.
9786
- $i = max( 10000, max( array_keys( $top_level_menu ) ) + 1 );
9787
- foreach ( $all_submenu_items_after as $meta ) {
9788
- $top_level_menu[ $i ] = $meta;
9789
- $i ++;
9790
- }
9791
-
9792
- // Sort submenu items.
9793
- ksort( $top_level_menu );
9794
- }
9795
-
9796
- /**
9797
- * Helper method to return the module's support forum URL.
9798
- *
9799
- * @author Vova Feldman (@svovaf)
9800
- * @since 1.2.2.7
9801
- *
9802
- * @return string
9803
- */
9804
- function get_support_forum_url() {
9805
- return $this->apply_filters( 'support_forum_url', "https://wordpress.org/support/{$this->_module_type}/{$this->_slug}" );
9806
- }
9807
-
9808
- /**
9809
- * Displays the Support Forum link when enabled.
9810
- *
9811
- * Can be filtered like so:
9812
- *
9813
- * function _fs_show_support_menu( $is_visible, $menu_id ) {
9814
- * if ( 'support' === $menu_id ) {
9815
- * return _fs->is_registered();
9816
- * }
9817
- * return $is_visible;
9818
- * }
9819
- * _fs()->add_filter('is_submenu_visible', '_fs_show_support_menu', 10, 2);
9820
- *
9821
- */
9822
- function _add_default_submenu_items() {
9823
- if ( ! $this->is_on() ) {
9824
- return;
9825
- }
9826
-
9827
- if ( ! $this->is_activation_mode() ) {
9828
- $this->add_submenu_link_item(
9829
- $this->apply_filters( 'support_forum_submenu', $this->get_text_inline( 'Support Forum', 'support-forum' ) ),
9830
- $this->get_support_forum_url(),
9831
- 'wp-support-forum',
9832
- null,
9833
- 50,
9834
- $this->is_submenu_item_visible( 'support' )
9835
- );
9836
- }
9837
- }
9838
-
9839
- /**
9840
- * @author Vova Feldman (@svovaf)
9841
- * @since 1.0.1
9842
- *
9843
- * @param string $menu_title
9844
- * @param callable $render_function
9845
- * @param bool|string $page_title
9846
- * @param string $capability
9847
- * @param bool|string $menu_slug
9848
- * @param bool|callable $before_render_function
9849
- * @param int $priority
9850
- * @param bool $show_submenu
9851
- * @param string $class Since 1.2.1.5 can add custom classes to menu items.
9852
- */
9853
- function add_submenu_item(
9854
- $menu_title,
9855
- $render_function,
9856
- $page_title = false,
9857
- $capability = 'manage_options',
9858
- $menu_slug = false,
9859
- $before_render_function = false,
9860
- $priority = WP_FS__DEFAULT_PRIORITY,
9861
- $show_submenu = true,
9862
- $class = ''
9863
- ) {
9864
- $this->_logger->entrance( 'Title = ' . $menu_title );
9865
-
9866
- if ( $this->is_addon() ) {
9867
- $parent_fs = $this->get_parent_instance();
9868
-
9869
- if ( is_object( $parent_fs ) ) {
9870
- $parent_fs->add_submenu_item(
9871
- $menu_title,
9872
- $render_function,
9873
- $page_title,
9874
- $capability,
9875
- $menu_slug,
9876
- $before_render_function,
9877
- $priority,
9878
- $show_submenu,
9879
- $class
9880
- );
9881
-
9882
- return;
9883
- }
9884
- }
9885
-
9886
- if ( ! isset( $this->_menu_items[ $priority ] ) ) {
9887
- $this->_menu_items[ $priority ] = array();
9888
- }
9889
-
9890
- $this->_menu_items[ $priority ][] = array(
9891
- 'page_title' => is_string( $page_title ) ? $page_title : $menu_title,
9892
- 'menu_title' => $menu_title,
9893
- 'capability' => $capability,
9894
- 'menu_slug' => is_string( $menu_slug ) ? $menu_slug : strtolower( $menu_title ),
9895
- 'render_function' => $render_function,
9896
- 'before_render_function' => $before_render_function,
9897
- 'show_submenu' => $show_submenu,
9898
- 'class' => $class,
9899
- );
9900
- }
9901
-
9902
- /**
9903
- * @author Vova Feldman (@svovaf)
9904
- * @since 1.0.1
9905
- *
9906
- * @param string $menu_title
9907
- * @param string $url
9908
- * @param bool $menu_slug
9909
- * @param string $capability
9910
- * @param int $priority
9911
- * @param bool $show_submenu
9912
- */
9913
- function add_submenu_link_item(
9914
- $menu_title,
9915
- $url,
9916
- $menu_slug = false,
9917
- $capability = 'read',
9918
- $priority = WP_FS__DEFAULT_PRIORITY,
9919
- $show_submenu = true
9920
- ) {
9921
- $this->_logger->entrance( 'Title = ' . $menu_title . '; Url = ' . $url );
9922
-
9923
- if ( $this->is_addon() ) {
9924
- $parent_fs = $this->get_parent_instance();
9925
-
9926
- if ( is_object( $parent_fs ) ) {
9927
- $parent_fs->add_submenu_link_item(
9928
- $menu_title,
9929
- $url,
9930
- $menu_slug,
9931
- $capability,
9932
- $priority,
9933
- $show_submenu
9934
- );
9935
-
9936
- return;
9937
- }
9938
- }
9939
-
9940
- if ( ! isset( $this->_menu_items[ $priority ] ) ) {
9941
- $this->_menu_items[ $priority ] = array();
9942
- }
9943
-
9944
- $this->_menu_items[ $priority ][] = array(
9945
- 'menu_title' => $menu_title,
9946
- 'capability' => $capability,
9947
- 'menu_slug' => is_string( $menu_slug ) ? $menu_slug : strtolower( $menu_title ),
9948
- 'url' => $url,
9949
- 'page_title' => $menu_title,
9950
- 'render_function' => 'fs_dummy',
9951
- 'before_render_function' => '',
9952
- 'show_submenu' => $show_submenu,
9953
- );
9954
- }
9955
-
9956
- #endregion ------------------------------------------------------------------
9957
-
9958
-
9959
- #--------------------------------------------------------------------------------
9960
- #region Actions / Hooks / Filters
9961
- #--------------------------------------------------------------------------------
9962
-
9963
- /**
9964
- * @author Vova Feldman (@svovaf)
9965
- * @since 1.1.7
9966
- *
9967
- * @param string $tag
9968
- *
9969
- * @return string
9970
- */
9971
- public function get_action_tag( $tag ) {
9972
- return self::get_action_tag_static( $tag, $this->_slug, $this->is_plugin() );
9973
- }
9974
-
9975
- /**
9976
- * @author Vova Feldman (@svovaf)
9977
- * @since 1.2.1.6
9978
- *
9979
- * @param string $tag
9980
- * @param string $slug
9981
- * @param bool $is_plugin
9982
- *
9983
- * @return string
9984
- */
9985
- static function get_action_tag_static( $tag, $slug = '', $is_plugin = true ) {
9986
- $action = "fs_{$tag}";
9987
-
9988
- if ( ! empty( $slug ) ) {
9989
- $action .= '_' . self::get_module_unique_affix( $slug, $is_plugin );
9990
- }
9991
-
9992
- return $action;
9993
- }
9994
-
9995
- /**
9996
- * Returns a string that can be used to generate a unique action name,
9997
- * option name, HTML element ID, or HTML element class.
9998
- *
9999
- * @author Leo Fajardo (@leorw)
10000
- * @since 1.2.2
10001
- *
10002
- * @return string
10003
- */
10004
- public function get_unique_affix() {
10005
- return self::get_module_unique_affix( $this->_slug, $this->is_plugin() );
10006
- }
10007
-
10008
- /**
10009
- * Returns a string that can be used to generate a unique action name,
10010
- * option name, HTML element ID, or HTML element class.
10011
- *
10012
- * @author Vova Feldman (@svovaf)
10013
- * @since 1.2.2.5
10014
- *
10015
- * @param string $slug
10016
- * @param bool $is_plugin
10017
- *
10018
- * @return string
10019
- */
10020
- static function get_module_unique_affix( $slug, $is_plugin = true ) {
10021
- $affix = $slug;
10022
-
10023
- if ( ! $is_plugin ) {
10024
- $affix .= '-' . WP_FS__MODULE_TYPE_THEME;
10025
- }
10026
-
10027
- return $affix;
10028
- }
10029
-
10030
- /**
10031
- * @author Vova Feldman (@svovaf)
10032
- * @since 1.2.1
10033
- * @since 1.2.2.5 The AJAX action names are based on the module ID, not like the non-AJAX actions that are
10034
- * based on the slug for backward compatibility.
10035
- *
10036
- * @param string $tag
10037
- *
10038
- * @return string
10039
- */
10040
- function get_ajax_action( $tag ) {
10041
- return self::get_ajax_action_static( $tag, $this->_module_id );
10042
- }
10043
-
10044
- /**
10045
- * @author Vova Feldman (@svovaf)
10046
- * @since 1.2.1.7
10047
- *
10048
- * @param string $tag
10049
- *
10050
- * @return string
10051
- */
10052
- function get_ajax_security( $tag ) {
10053
- return wp_create_nonce( $this->get_ajax_action( $tag ) );
10054
- }
10055
-
10056
- /**
10057
- * @author Vova Feldman (@svovaf)
10058
- * @since 1.2.1.7
10059
- *
10060
- * @param string $tag
10061
- */
10062
- function check_ajax_referer( $tag ) {
10063
- check_ajax_referer( $this->get_ajax_action( $tag ), 'security' );
10064
- }
10065
-
10066
- /**
10067
- * @author Vova Feldman (@svovaf)
10068
- * @since 1.2.1.6
10069
- * @since 1.2.2.5 The AJAX action names are based on the module ID, not like the non-AJAX actions that are
10070
- * based on the slug for backward compatibility.
10071
- *
10072
- * @param string $tag
10073
- * @param number|null $module_id
10074
- *
10075
- * @return string
10076
- */
10077
- private static function get_ajax_action_static( $tag, $module_id = null ) {
10078
- $action = "fs_{$tag}";
10079
-
10080
- if ( ! empty( $module_id ) ) {
10081
- $action .= "_{$module_id}";
10082
- }
10083
-
10084
- return $action;
10085
- }
10086
-
10087
- /**
10088
- * Do action, specific for the current context plugin.
10089
- *
10090
- * @author Vova Feldman (@svovaf)
10091
- * @since 1.0.1
10092
- *
10093
- * @param string $tag The name of the action to be executed.
10094
- * @param mixed $arg,... Optional. Additional arguments which are passed on to the
10095
- * functions hooked to the action. Default empty.
10096
- *
10097
- * @uses do_action()
10098
- */
10099
- function do_action( $tag, $arg = '' ) {
10100
- $this->_logger->entrance( $tag );
10101
-
10102
- $args = func_get_args();
10103
-
10104
- call_user_func_array( 'do_action', array_merge(
10105
- array( $this->get_action_tag( $tag ) ),
10106
- array_slice( $args, 1 ) )
10107
- );
10108
- }
10109
-
10110
- /**
10111
- * Add action, specific for the current context plugin.
10112
- *
10113
- * @author Vova Feldman (@svovaf)
10114
- * @since 1.0.1
10115
- *
10116
- * @param string $tag
10117
- * @param callable $function_to_add
10118
- * @param int $priority
10119
- * @param int $accepted_args
10120
- *
10121
- * @uses add_action()
10122
- */
10123
- function add_action(
10124
- $tag,
10125
- $function_to_add,
10126
- $priority = WP_FS__DEFAULT_PRIORITY,
10127
- $accepted_args = 1
10128
- ) {
10129
- $this->_logger->entrance( $tag );
10130
-
10131
- add_action( $this->get_action_tag( $tag ), $function_to_add, $priority, $accepted_args );
10132
- }
10133
-
10134
- /**
10135
- * Add AJAX action, specific for the current context plugin.
10136
- *
10137
- * @author Vova Feldman (@svovaf)
10138
- * @since 1.2.1
10139
- *
10140
- * @param string $tag
10141
- * @param callable $function_to_add
10142
- * @param int $priority
10143
- *
10144
- * @uses add_action()
10145
- *
10146
- * @return bool True if action added, false if no need to add the action since the AJAX call isn't matching.
10147
- */
10148
- function add_ajax_action(
10149
- $tag,
10150
- $function_to_add,
10151
- $priority = WP_FS__DEFAULT_PRIORITY
10152
- ) {
10153
- $this->_logger->entrance( $tag );
10154
-
10155
- return self::add_ajax_action_static(
10156
- $tag,
10157
- $function_to_add,
10158
- $priority,
10159
- $this->_module_id
10160
- );
10161
- }
10162
-
10163
- /**
10164
- * Add AJAX action.
10165
- *
10166
- * @author Vova Feldman (@svovaf)
10167
- * @since 1.2.1.6
10168
- *
10169
- * @param string $tag
10170
- * @param callable $function_to_add
10171
- * @param int $priority
10172
- * @param number|null $module_id
10173
- *
10174
- * @return bool True if action added, false if no need to add the action since the AJAX call isn't matching.
10175
- * @uses add_action()
10176
- *
10177
- */
10178
- static function add_ajax_action_static(
10179
- $tag,
10180
- $function_to_add,
10181
- $priority = WP_FS__DEFAULT_PRIORITY,
10182
- $module_id = null
10183
- ) {
10184
- self::$_static_logger->entrance( $tag );
10185
-
10186
- if ( ! self::is_ajax_action_static( $tag, $module_id ) ) {
10187
- return false;
10188
- }
10189
-
10190
- add_action(
10191
- 'wp_ajax_' . self::get_ajax_action_static( $tag, $module_id ),
10192
- $function_to_add,
10193
- $priority,
10194
- 0
10195
- );
10196
-
10197
- self::$_static_logger->info( "$tag AJAX callback action added." );
10198
-
10199
- return true;
10200
- }
10201
-
10202
- /**
10203
- * Send a JSON response back to an Ajax request.
10204
- *
10205
- * @author Vova Feldman (@svovaf)
10206
- * @since 1.2.1.5
10207
- *
10208
- * @param mixed $response
10209
- */
10210
- static function shoot_ajax_response( $response ) {
10211
- wp_send_json( $response );
10212
- }
10213
-
10214
- /**
10215
- * Send a JSON response back to an Ajax request, indicating success.
10216
- *
10217
- * @author Vova Feldman (@svovaf)
10218
- * @since 1.2.1.5
10219
- *
10220
- * @param mixed $data Data to encode as JSON, then print and exit.
10221
- */
10222
- static function shoot_ajax_success( $data = null ) {
10223
- wp_send_json_success( $data );
10224
- }
10225
-
10226
- /**
10227
- * Send a JSON response back to an Ajax request, indicating failure.
10228
- *
10229
- * @author Vova Feldman (@svovaf)
10230
- * @since 1.2.1.5
10231
- *
10232
- * @param mixed $error Optional error message.
10233
- */
10234
- static function shoot_ajax_failure( $error = '' ) {
10235
- $result = array( 'success' => false );
10236
- if ( ! empty( $error ) ) {
10237
- $result['error'] = $error;
10238
- }
10239
-
10240
- wp_send_json( $result );
10241
- }
10242
-
10243
- /**
10244
- * Apply filter, specific for the current context plugin.
10245
- *
10246
- * @author Vova Feldman (@svovaf)
10247
- * @since 1.0.9
10248
- *
10249
- * @param string $tag The name of the filter hook.
10250
- * @param mixed $value The value on which the filters hooked to `$tag` are applied on.
10251
- *
10252
- * @return mixed The filtered value after all hooked functions are applied to it.
10253
- *
10254
- * @uses apply_filters()
10255
- */
10256
- function apply_filters( $tag, $value ) {
10257
- $this->_logger->entrance( $tag );
10258
-
10259
- $args = func_get_args();
10260
- array_unshift( $args, $this->get_unique_affix() );
10261
-
10262
- return call_user_func_array( 'fs_apply_filter', $args );
10263
- }
10264
-
10265
- /**
10266
- * Add filter, specific for the current context plugin.
10267
- *
10268
- * @author Vova Feldman (@svovaf)
10269
- * @since 1.0.9
10270
- *
10271
- * @param string $tag
10272
- * @param callable $function_to_add
10273
- * @param int $priority
10274
- * @param int $accepted_args
10275
- *
10276
- * @uses add_filter()
10277
- */
10278
- function add_filter( $tag, $function_to_add, $priority = WP_FS__DEFAULT_PRIORITY, $accepted_args = 1 ) {
10279
- $this->_logger->entrance( $tag );
10280
-
10281
- add_filter( $this->get_action_tag( $tag ), $function_to_add, $priority, $accepted_args );
10282
- }
10283
-
10284
- /**
10285
- * Check if has filter.
10286
- *
10287
- * @author Vova Feldman (@svovaf)
10288
- * @since 1.1.4
10289
- *
10290
- * @param string $tag
10291
- * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
10292
- *
10293
- * @return false|int
10294
- *
10295
- * @uses has_filter()
10296
- */
10297
- function has_filter( $tag, $function_to_check = false ) {
10298
- $this->_logger->entrance( $tag );
10299
-
10300
- return has_filter( $this->get_action_tag( $tag ), $function_to_check );
10301
- }
10302
-
10303
- #endregion
10304
-
10305
- /**
10306
- * Override default i18n text phrases.
10307
- *
10308
- * @author Vova Feldman (@svovaf)
10309
- * @since 1.1.6
10310
- *
10311
- * @param string[] string $key_value
10312
- *
10313
- * @uses fs_override_i18n()
10314
- */
10315
- function override_i18n( $key_value ) {
10316
- fs_override_i18n( $key_value, $this->_slug );
10317
- }
10318
-
10319
- /* Account Page
10320
- ------------------------------------------------------------------------------------------------------------------*/
10321
- /**
10322
- * Update site information.
10323
- *
10324
- * @author Vova Feldman (@svovaf)
10325
- * @since 1.0.1
10326
- *
10327
- * @param bool $store Flush to Database if true.
10328
- */
10329
- private function _store_site( $store = true ) {
10330
- $this->_logger->entrance();
10331
 
10332
- if ( empty( $this->_site->id ) ) {
10333
- $this->_logger->error( "Empty install ID, can't store site." );
10334
 
10335
- return;
10336
- }
10337
 
10338
- $encrypted_site = clone $this->_site;
10339
- $encrypted_site->plan = self::_encrypt_entity( $this->_site->plan );
 
 
 
 
 
 
10340
 
10341
- $sites = self::get_all_sites( $this->_module_type );
 
 
10342
 
10343
- if ( empty( $this->_storage->prev_user_id ) && $this->_user->id != $this->_site->user_id ) {
10344
- /**
10345
- * Store the current user ID as the previous user ID so that the previous user can be used
10346
- * as the install's owner while the new owner's details are not yet available.
10347
- *
10348
- * This will be executed only in the `replica` site. For example, there are 2 sites, namely `original`
10349
- * and `replica`, then an ownership change was initiated and completed in the `original`, the `replica`
10350
- * will be using the previous user until it is updated again (e.g.: until the next clone of `original`
10351
- * into `replica`.
10352
- *
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10353
  * @author Leo Fajardo (@leorw)
10354
  */
10355
- $this->_storage->prev_user_id = $sites[ $this->_slug ]->user_id;
10356
- }
10357
-
10358
- $sites[ $this->_slug ] = $encrypted_site;
10359
-
10360
- $this->set_account_option( 'sites', $sites, $store );
10361
- }
10362
-
10363
- /**
10364
- * Update plugin's plans information.
10365
- *
10366
- * @author Vova Feldman (@svovaf)
10367
- * @since 1.0.2
10368
- *
10369
- * @param bool $store Flush to Database if true.
10370
- */
10371
- private function _store_plans( $store = true ) {
10372
- $this->_logger->entrance();
10373
-
10374
- $plans = self::get_all_plans( $this->_module_type );
10375
-
10376
- // Copy plans.
10377
- $encrypted_plans = array();
10378
- for ( $i = 0, $len = count( $this->_plans ); $i < $len; $i ++ ) {
10379
- $encrypted_plans[] = self::_encrypt_entity( $this->_plans[ $i ] );
10380
- }
10381
-
10382
- $plans[ $this->_slug ] = $encrypted_plans;
10383
-
10384
- $this->set_account_option( 'plans', $plans, $store );
10385
- }
10386
-
10387
- /**
10388
- * Update user's plugin licenses.
10389
- *
10390
- * @author Vova Feldman (@svovaf)
10391
- * @since 1.0.5
10392
- *
10393
- * @param bool $store
10394
- * @param string|bool $plugin_slug
10395
- * @param FS_Plugin_License[] $licenses
10396
- */
10397
- private function _store_licenses( $store = true, $plugin_slug = false, $licenses = array() ) {
10398
- $this->_logger->entrance();
10399
-
10400
- $all_licenses = self::get_all_licenses( $this->_module_type );
10401
-
10402
- if ( ! is_string( $plugin_slug ) ) {
10403
- $plugin_slug = $this->_slug;
10404
- $licenses = $this->_licenses;
10405
- }
10406
-
10407
- if ( ! isset( $all_licenses[ $plugin_slug ] ) ) {
10408
- $all_licenses[ $plugin_slug ] = array();
10409
- }
10410
-
10411
- $all_licenses[ $plugin_slug ][ $this->_user->id ] = $licenses;
10412
-
10413
- $this->set_account_option( 'licenses', $all_licenses, $store );
10414
- }
10415
-
10416
- /**
10417
- * Update user information.
10418
- *
10419
- * @author Vova Feldman (@svovaf)
10420
- * @since 1.0.1
10421
- *
10422
- * @param bool $store Flush to Database if true.
10423
- */
10424
- private function _store_user( $store = true ) {
10425
- $this->_logger->entrance();
10426
-
10427
- if ( empty( $this->_user->id ) ) {
10428
- $this->_logger->error( "Empty user ID, can't store user." );
10429
-
10430
- return;
10431
- }
10432
-
10433
- $users = self::get_all_users();
10434
- $users[ $this->_user->id ] = $this->_user;
10435
- self::$_accounts->set_option( 'users', $users, $store );
10436
- }
10437
-
10438
- /**
10439
- * Update new updates information.
10440
- *
10441
- * @author Vova Feldman (@svovaf)
10442
- * @since 1.0.4
10443
- *
10444
- * @param FS_Plugin_Tag|null $update
10445
- * @param bool $store Flush to Database if true.
10446
- * @param bool|number $plugin_id
10447
- */
10448
- private function _store_update( $update, $store = true, $plugin_id = false ) {
10449
- $this->_logger->entrance();
10450
-
10451
- if ( $update instanceof FS_Plugin_Tag ) {
10452
- $update->updated = time();
10453
- }
10454
-
10455
- if ( ! is_numeric( $plugin_id ) ) {
10456
- $plugin_id = $this->_plugin->id;
10457
- }
10458
-
10459
- $updates = self::get_all_updates();
10460
- $updates[ $plugin_id ] = $update;
10461
- self::$_accounts->set_option( 'updates', $updates, $store );
10462
- }
10463
-
10464
- /**
10465
- * Update new updates information.
10466
- *
10467
- * @author Vova Feldman (@svovaf)
10468
- * @since 1.0.6
10469
- *
10470
- * @param FS_Plugin[] $plugin_addons
10471
- * @param bool $store Flush to Database if true.
10472
- */
10473
- private function _store_addons( $plugin_addons, $store = true ) {
10474
- $this->_logger->entrance();
10475
-
10476
- $addons = self::get_all_addons();
10477
- $addons[ $this->_plugin->id ] = $plugin_addons;
10478
- self::$_accounts->set_option( 'addons', $addons, $store );
10479
- }
10480
-
10481
- /**
10482
- * Delete plugin's associated add-ons.
10483
- *
10484
- * @author Vova Feldman (@svovaf)
10485
- * @since 1.0.8
10486
- *
10487
- * @param bool $store
10488
- *
10489
- * @return bool
10490
- */
10491
- private function _delete_account_addons( $store = true ) {
10492
- $all_addons = self::get_all_account_addons();
10493
-
10494
- if ( ! isset( $all_addons[ $this->_plugin->id ] ) ) {
10495
- return false;
10496
- }
10497
-
10498
- unset( $all_addons[ $this->_plugin->id ] );
10499
-
10500
- self::$_accounts->set_option( 'account_addons', $all_addons, $store );
10501
-
10502
- return true;
10503
- }
10504
-
10505
- /**
10506
- * Update account add-ons list.
10507
- *
10508
- * @author Vova Feldman (@svovaf)
10509
- * @since 1.0.6
10510
- *
10511
- * @param FS_Plugin[] $addons
10512
- * @param bool $store Flush to Database if true.
10513
- */
10514
- private function _store_account_addons( $addons, $store = true ) {
10515
- $this->_logger->entrance();
10516
-
10517
- $all_addons = self::get_all_account_addons();
10518
- $all_addons[ $this->_plugin->id ] = $addons;
10519
- self::$_accounts->set_option( 'account_addons', $all_addons, $store );
10520
- }
10521
-
10522
- /**
10523
- * Store account params in the Database.
10524
- *
10525
- * @author Vova Feldman (@svovaf)
10526
- * @since 1.0.1
10527
- */
10528
- private function _store_account() {
10529
- $this->_logger->entrance();
10530
-
10531
- $this->_store_site( false );
10532
- $this->_store_user( false );
10533
- $this->_store_plans( false );
10534
- $this->_store_licenses( false );
10535
-
10536
- self::$_accounts->store();
10537
- }
10538
-
10539
- /**
10540
- * Sync user's information.
10541
- *
10542
- * @author Vova Feldman (@svovaf)
10543
- * @since 1.0.3
10544
- * @uses FS_Api
10545
- */
10546
- private function _handle_account_user_sync() {
10547
- $this->_logger->entrance();
10548
-
10549
- $api = $this->get_api_user_scope();
10550
-
10551
- // Get user's information.
10552
- $user = $api->get( '/', true );
10553
-
10554
- if ( isset( $user->id ) ) {
10555
- $this->_user->first = $user->first;
10556
- $this->_user->last = $user->last;
10557
- $this->_user->email = $user->email;
10558
-
10559
- $is_menu_item_account_visible = $this->is_submenu_item_visible( 'account' );
10560
-
10561
- if ( $user->is_verified &&
10562
- ( ! isset( $this->_user->is_verified ) || false === $this->_user->is_verified )
10563
- ) {
10564
- $this->_user->is_verified = true;
10565
-
10566
- $this->do_action( 'account_email_verified', $user->email );
10567
-
10568
- $this->_admin_notices->add(
10569
- $this->get_text_inline( 'Your email has been successfully verified - you are AWESOME!', 'email-verified-message' ),
10570
- $this->get_text_x_inline( 'Right on', 'a positive response', 'right-on' ) . '!',
10571
- 'success',
10572
- // Make admin sticky if account menu item is invisible,
10573
- // since the page will be auto redirected to the plugin's
10574
- // main settings page, and the non-sticky message
10575
- // will disappear.
10576
- ! $is_menu_item_account_visible,
10577
- false,
10578
- 'email_verified'
10579
- );
10580
- }
10581
-
10582
- // Flush user details to DB.
10583
- $this->_store_user();
10584
-
10585
- $this->do_action( 'after_account_user_sync', $user );
10586
-
10587
- /**
10588
- * If account menu item is hidden, redirect to plugin's main settings page.
10589
- *
10590
- * @author Vova Feldman (@svovaf)
10591
- * @since 1.1.6
10592
- *
10593
- * @link https://github.com/Freemius/wordpress-sdk/issues/6
10594
- */
10595
- if ( ! $is_menu_item_account_visible ) {
10596
- fs_redirect( $this->_get_admin_page_url() );
10597
- }
10598
- }
10599
- }
10600
-
10601
- /**
10602
- * @param bool $store
10603
- *
10604
- * @return FS_Plugin_Plan|object|false
10605
- */
10606
- private function _enrich_site_plan( $store = true ) {
10607
- // Try to load plan from local cache.
10608
- $plan = $this->_get_plan_by_id( $this->_site->plan->id );
10609
-
10610
- if ( false === $plan ) {
10611
- $plan = $this->_fetch_site_plan();
10612
- }
10613
-
10614
- if ( $plan instanceof FS_Plugin_Plan ) {
10615
- $this->_update_plan( $plan, $store );
10616
- }
10617
-
10618
- return $plan;
10619
- }
10620
-
10621
- /**
10622
- * @author Vova Feldman (@svovaf)
10623
- * @since 1.0.9
10624
- * @uses FS_Api
10625
- *
10626
- * @param bool $store
10627
- *
10628
- * @return FS_Plugin_Plan|object|false
10629
- */
10630
- private function _enrich_site_trial_plan( $store = true ) {
10631
- // Try to load plan from local cache.
10632
- $trial_plan = $this->_get_plan_by_id( $this->_site->trial_plan_id );
10633
-
10634
- if ( false === $trial_plan ) {
10635
- $trial_plan = $this->_fetch_site_plan( $this->_site->trial_plan_id );
10636
- }
10637
-
10638
- if ( $trial_plan instanceof FS_Plugin_Plan ) {
10639
- $this->_storage->store( 'trial_plan', $trial_plan, $store );
10640
- }
10641
-
10642
- return $trial_plan;
10643
- }
10644
-
10645
- /**
10646
- * @author Vova Feldman (@svovaf)
10647
- * @since 1.0.9
10648
- * @uses FS_Api
10649
- *
10650
- * @param number|bool $license_id
10651
- *
10652
- * @return FS_Subscription|object|bool
10653
- */
10654
- private function _fetch_site_license_subscription( $license_id = false ) {
10655
- $this->_logger->entrance();
10656
- $api = $this->get_api_site_scope();
10657
-
10658
- if ( ! is_numeric( $license_id ) ) {
10659
- $license_id = $this->_license->id;
10660
- }
10661
-
10662
- $result = $api->get( "/licenses/{$license_id}/subscriptions.json", true );
10663
-
10664
- return ! isset( $result->error ) ?
10665
- ( ( is_array( $result->subscriptions ) && 0 < count( $result->subscriptions ) ) ?
10666
- new FS_Subscription( $result->subscriptions[0] ) :
10667
- false
10668
- ) :
10669
- $result;
10670
- }
10671
-
10672
- /**
10673
- * @author Vova Feldman (@svovaf)
10674
- * @since 1.0.4
10675
- * @uses FS_Api
10676
- *
10677
- * @param number|bool $plan_id
10678
- *
10679
- * @return FS_Plugin_Plan|object
10680
- */
10681
- private function _fetch_site_plan( $plan_id = false ) {
10682
- $this->_logger->entrance();
10683
- $api = $this->get_api_site_scope();
10684
-
10685
- if ( ! is_numeric( $plan_id ) ) {
10686
- $plan_id = $this->_site->plan->id;
10687
- }
10688
-
10689
- $plan = $api->get( "/plans/{$plan_id}.json", true );
10690
-
10691
- return ! isset( $plan->error ) ? new FS_Plugin_Plan( $plan ) : $plan;
10692
- }
10693
-
10694
- /**
10695
- * @author Vova Feldman (@svovaf)
10696
- * @since 1.0.5
10697
- * @uses FS_Api
10698
- *
10699
- * @return FS_Plugin_Plan[]|object
10700
- */
10701
- private function _fetch_plugin_plans() {
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  <?php
2
+ /**
3
+ * @package Freemius
4
+ * @copyright Copyright (c) 2015, Freemius, Inc.
5
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3
6
+ * @since 1.0.3
7
+ */
8
+ if ( ! defined( 'ABSPATH' ) ) {
9
+ exit;
10
+ }
11
+
12
+ // "final class"
13
+ class Freemius extends Freemius_Abstract {
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  /**
15
+ * SDK Version
16
  *
17
+ * @var string
18
+ */
19
+ public $version = WP_FS__SDK_VERSION;
20
+
21
+ #region Plugin Info
22
+
23
+ /**
24
+ * @since 1.0.1
25
  *
26
+ * @var string
27
  */
28
+ private $_slug;
29
 
30
  /**
31
+ * @since 1.0.0
32
  *
33
+ * @var string
34
+ */
35
+ private $_plugin_basename;
36
+ /**
37
+ * @since 1.0.0
38
  *
39
+ * @var string
40
  */
41
+ private $_free_plugin_basename;
 
42
  /**
43
+ * @since 1.0.0
44
+ *
45
+ * @var string
46
+ */
47
+ private $_plugin_dir_path;
48
+ /**
49
+ * @since 1.0.0
50
  *
51
+ * @var string
52
+ */
53
+ private $_plugin_dir_name;
54
+ /**
55
+ * @since 1.0.0
56
  *
57
+ * @var string
58
  */
59
+ private $_plugin_main_file_path;
60
+ /**
61
+ * @var string[]
62
+ */
63
+ private $_plugin_data;
64
+ /**
65
+ * @since 1.0.9
66
+ *
67
+ * @var string
68
+ */
69
+ private $_plugin_name;
70
+ /**
71
+ * @since 1.2.2
72
+ *
73
+ * @var string
74
+ */
75
+ private $_module_type;
 
 
 
 
 
 
 
76
 
77
+ #endregion Plugin Info
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
78
 
79
+ /**
80
+ * @since 1.0.9
81
+ *
82
+ * @var bool If false, don't turn Freemius on.
83
+ */
84
+ private $_is_on;
 
 
 
 
 
85
 
86
+ /**
87
+ * @since 1.1.3
88
+ *
89
+ * @var bool If false, don't turn Freemius on.
90
+ */
91
+ private $_is_anonymous;
 
 
 
 
 
92
 
93
+ /**
94
+ * @since 1.0.9
95
+ * @var bool If false, issues with connectivity to Freemius API.
96
+ */
97
+ private $_has_api_connection;
98
 
99
+ /**
100
+ * @since 1.0.9
101
+ * @since 2.0.0 Default to true since we need the property during the instance construction, prior to the dynamic_init() execution.
102
+ * @var bool Hints the SDK if plugin can support anonymous mode (if skip connect is visible).
103
+ */
104
+ private $_enable_anonymous = true;
105
 
106
+ /**
107
+ * @since 1.1.7.5
108
+ * @var bool Hints the SDK if plugin should run in anonymous mode (only adds feedback form).
109
+ */
110
+ private $_anonymous_mode;
111
 
112
  /**
113
+ * @since 1.1.9
114
+ * @var bool Hints the SDK if plugin have any free plans.
 
 
115
  */
116
+ private $_is_premium_only;
 
117
 
118
+ /**
119
+ * @since 1.2.1.6
120
+ * @var bool Hints the SDK if plugin have premium code version at all.
121
+ */
122
+ private $_has_premium_version;
123
 
124
+ /**
125
+ * @since 1.2.1.6
126
+ * @var bool Hints the SDK if plugin should ignore pending mode by simulating a skip.
127
+ */
128
+ private $_ignore_pending_mode;
129
 
130
+ /**
131
+ * @since 1.0.8
132
+ * @var bool Hints the SDK if the plugin has any paid plans.
133
+ */
134
+ private $_has_paid_plans;
135
 
136
+ /**
137
+ * @since 1.2.1.5
138
+ * @var int Hints the SDK if the plugin offers a trial period. If negative, no trial, if zero - has a trial but
139
+ * without a specified period, if positive - the number of trial days.
140
+ */
141
+ private $_trial_days = - 1;
142
 
143
+ /**
144
+ * @since 1.2.1.5
145
+ * @var bool Hints the SDK if the trial requires a payment method or not.
146
+ */
147
+ private $_is_trial_require_payment = false;
 
 
 
 
148
 
149
+ /**
150
+ * @since 1.0.7
151
+ * @var bool Hints the SDK if the plugin is WordPress.org compliant.
152
+ */
153
+ private $_is_org_compliant;
154
 
155
+ /**
156
+ * @since 1.0.7
157
+ * @var bool Hints the SDK if the plugin is has add-ons.
158
+ */
159
+ private $_has_addons;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
160
 
161
+ /**
162
+ * @since 1.1.6
163
+ * @var string[]bool.
164
+ */
165
+ private $_permissions;
166
 
167
+ /**
168
+ * @var FS_Storage
169
+ */
170
+ private $_storage;
171
 
172
+ /**
173
+ * @since 1.2.2.7
174
+ * @var FS_Cache_Manager
175
+ */
176
+ private $_cache;
177
 
178
+ /**
179
+ * @since 1.0.0
180
+ *
181
+ * @var FS_Logger
182
+ */
183
+ private $_logger;
184
+ /**
185
+ * @since 1.0.4
186
+ *
187
+ * @var FS_Plugin
188
+ */
189
+ private $_plugin = false;
190
+ /**
191
+ * @since 1.0.4
192
+ *
193
+ * @var FS_Plugin|false
194
+ */
195
+ private $_parent_plugin = false;
196
+ /**
197
+ * @since 1.1.1
198
+ *
199
+ * @var Freemius
200
+ */
201
+ private $_parent = false;
202
+ /**
203
+ * @since 1.0.1
204
+ *
205
+ * @var FS_User
206
+ */
207
+ private $_user = false;
208
+ /**
209
+ * @since 1.0.1
210
+ *
211
+ * @var FS_Site
212
+ */
213
+ private $_site = false;
214
+ /**
215
+ * @since 1.0.1
216
+ *
217
+ * @var FS_Plugin_License
218
+ */
219
+ private $_license;
220
+ /**
221
+ * @since 1.0.2
222
+ *
223
+ * @var FS_Plugin_Plan[]
224
+ */
225
+ private $_plans = false;
226
+ /**
227
+ * @var FS_Plugin_License[]
228
+ * @since 1.0.5
229
+ */
230
+ private $_licenses = false;
231
 
232
+ /**
233
+ * @since 1.0.1
234
+ *
235
+ * @var FS_Admin_Menu_Manager
236
+ */
237
+ private $_menu;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
238
 
239
+ /**
240
+ * @var FS_Admin_Notices
241
+ */
242
+ private $_admin_notices;
243
 
244
  /**
245
+ * @since 1.1.6
 
246
  *
247
+ * @var FS_Admin_Notices
248
+ */
249
+ private static $_global_admin_notices;
250
+
251
+ /**
252
+ * @var FS_Logger
253
+ * @since 1.0.0
254
+ */
255
+ private static $_static_logger;
256
+
257
+ /**
258
+ * @var FS_Options
259
+ * @since 1.0.2
260
+ */
261
+ private static $_accounts;
262
+
263
+ /**
264
+ * @since 1.2.2
265
  *
266
+ * @var number
267
  */
268
+ private $_module_id;
 
 
 
 
269
 
270
+ /**
271
+ * @var Freemius[]
272
+ */
273
+ private static $_instances = array();
274
 
275
  /**
276
+ * @since 1.2.3
 
277
  *
278
+ * @var FS_Affiliate
279
+ */
280
+ private $affiliate = null;
281
+
282
+ /**
283
+ * @since 1.2.3
284
  *
285
+ * @var FS_AffiliateTerms
286
  */
287
+ private $plugin_affiliate_terms = null;
 
 
 
 
288
 
289
+ /**
290
+ * @since 1.2.3
291
+ *
292
+ * @var FS_AffiliateTerms
293
+ */
294
+ private $custom_affiliate_terms = null;
295
 
296
  /**
297
+ * @since 2.0.0
 
298
  *
299
+ * @var bool
300
+ */
301
+ private $_is_multisite_integrated;
302
+
303
+ /**
304
+ * @since 2.0.0
305
  *
306
+ * @var bool True if the current request is for a network admin screen and the plugin is network active.
307
  */
308
+ private $_is_network_active;
 
 
 
309
 
310
+ /**
311
+ * @since 2.0.0
312
+ *
313
+ * @var int|null The original blog ID the plugin was loaded with.
314
+ */
315
+ private $_blog_id = null;
316
 
317
+ /**
318
+ * @since 2.0.0
319
+ *
320
+ * @var int|null The current execution context. When true, run on network context. When int, run on the specified blog context.
321
+ */
322
+ private $_context_is_network_or_blog_id = null;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
323
 
324
+ /**
325
+ * @since 2.0.0
326
+ *
327
+ * @var string
328
+ */
329
+ private $_dynamically_added_top_level_page_hook_name = '';
330
+
331
+ #region Uninstall Reasons IDs
332
+
333
+ const REASON_NO_LONGER_NEEDED = 1;
334
+ const REASON_FOUND_A_BETTER_PLUGIN = 2;
335
+ const REASON_NEEDED_FOR_A_SHORT_PERIOD = 3;
336
+ const REASON_BROKE_MY_SITE = 4;
337
+ const REASON_SUDDENLY_STOPPED_WORKING = 5;
338
+ const REASON_CANT_PAY_ANYMORE = 6;
339
+ const REASON_OTHER = 7;
340
+ const REASON_DIDNT_WORK = 8;
341
+ const REASON_DONT_LIKE_TO_SHARE_MY_INFORMATION = 9;
342
+ const REASON_COULDNT_MAKE_IT_WORK = 10;
343
+ const REASON_GREAT_BUT_NEED_SPECIFIC_FEATURE = 11;
344
+ const REASON_NOT_WORKING = 12;
345
+ const REASON_NOT_WHAT_I_WAS_LOOKING_FOR = 13;
346
+ const REASON_DIDNT_WORK_AS_EXPECTED = 14;
347
+ const REASON_TEMPORARY_DEACTIVATION = 15;
348
+
349
+ #endregion
350
+
351
+ /* Ctor
352
+ ------------------------------------------------------------------------------------------------------------------*/
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
353
 
354
+ /**
355
+ * Main singleton instance.
356
+ *
357
+ * @author Vova Feldman (@svovaf)
358
+ * @since 1.0.0
359
+ *
360
+ * @param number $module_id
361
+ * @param string|bool $slug
362
+ * @param bool $is_init Since 1.2.1 Is initiation sequence.
363
+ */
364
+ private function __construct( $module_id, $slug = false, $is_init = false ) {
365
+ if ( $is_init && is_numeric( $module_id ) && is_string( $slug ) ) {
366
+ $this->store_id_slug_type_path_map( $module_id, $slug );
367
+ }
368
 
369
+ $this->_module_id = $module_id;
370
+ $this->_slug = $this->get_slug();
371
+ $this->_module_type = $this->get_module_type();
372
 
373
+ $this->_blog_id = is_multisite() ? get_current_blog_id() : null;
 
374
 
375
+ $this->_storage = FS_Storage::instance( $this->_module_type, $this->_slug );
 
 
376
 
377
+ $this->_cache = FS_Cache_Manager::get_manager( WP_FS___OPTION_PREFIX . "cache_{$module_id}" );
378
 
379
+ $this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_' . $this->get_unique_affix(), WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );
 
 
 
 
 
 
 
 
380
 
381
+ $this->_plugin_main_file_path = $this->_find_caller_plugin_file( $is_init );
382
+ $this->_plugin_dir_path = plugin_dir_path( $this->_plugin_main_file_path );
383
+ $this->_plugin_basename = $this->get_plugin_basename();
384
+ $this->_free_plugin_basename = str_replace( '-premium/', '/', $this->_plugin_basename );
385
 
386
+ $this->_is_multisite_integrated = (
387
+ defined( "WP_FS__PRODUCT_{$module_id}_MULTISITE" ) &&
388
+ ( true === constant( "WP_FS__PRODUCT_{$module_id}_MULTISITE" ) )
389
+ );
 
390
 
391
+ $this->_is_network_active = (
392
+ is_multisite() &&
393
+ $this->_is_multisite_integrated &&
394
+ // Themes are always network activated, but the ACTUAL activation is per site.
395
+ $this->is_plugin() &&
396
+ ( is_plugin_active_for_network( $this->_plugin_basename ) ||
397
+ // Plugin network level activation or uninstall.
398
+ is_plugin_inactive( $this->_plugin_basename ) )
399
+ );
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
400
 
401
+ $this->_storage->set_network_active(
402
+ $this->_is_network_active,
403
+ $this->is_delegated_connection()
404
+ );
405
 
406
+ #region Migration
 
 
 
 
 
 
407
 
408
+ if ( is_multisite() ) {
409
  /**
410
+ * If the install_timestamp exists on the site level but doesn't exist on the
411
+ * network level storage, it means that we need to process the storage with migration.
412
+ *
413
+ * The code in this `if` scope will only be executed once and only for the first site that will execute it because once we migrate the storage data, install_timestamp will be already set in the network level storage.
414
  *
415
  * @author Vova Feldman (@svovaf)
416
+ * @since 2.0.0
417
  */
418
+ if ( false === $this->_storage->get( 'install_timestamp', false, true ) &&
419
+ false !== $this->_storage->get( 'install_timestamp', false, false )
420
+ ) {
421
+ // Initiate storage migration.
422
+ $this->_storage->migrate_to_network();
423
 
424
+ // Migrate module cache to network level storage.
425
+ $this->_cache->migrate_to_network();
426
+ }
427
  }
428
 
429
+ #endregion
430
 
431
+ $base_name_split = explode( '/', $this->_plugin_basename );
432
+ $this->_plugin_dir_name = $base_name_split[0];
433
 
434
+ if ( $this->_logger->is_on() ) {
435
+ $this->_logger->info( 'plugin_main_file_path = ' . $this->_plugin_main_file_path );
436
+ $this->_logger->info( 'plugin_dir_path = ' . $this->_plugin_dir_path );
437
+ $this->_logger->info( 'plugin_basename = ' . $this->_plugin_basename );
438
+ $this->_logger->info( 'free_plugin_basename = ' . $this->_free_plugin_basename );
439
+ $this->_logger->info( 'plugin_dir_name = ' . $this->_plugin_dir_name );
440
+ }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
441
 
442
+ // Remember link between file to slug.
443
+ $this->store_file_slug_map();
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
444
 
445
+ // Store plugin's initial install timestamp.
446
+ if ( ! isset( $this->_storage->install_timestamp ) ) {
447
+ $this->_storage->install_timestamp = WP_FS__SCRIPT_START_TIME;
448
+ }
449
 
450
+ if ( ! is_object( $this->_plugin ) ) {
451
+ $this->_plugin = FS_Plugin_Manager::instance( $this->_module_id )->get();
452
+ }
453
 
454
+ $this->_admin_notices = FS_Admin_Notices::instance(
455
+ $this->_slug . ( $this->is_theme() ? ':theme' : '' ),
456
+ /**
457
+ * Ensure that the admin notice will always have a title by using the stored plugin title if available and
458
+ * retrieving the title via the "get_plugin_name" method if there is no stored plugin title available.
459
+ *
460
+ * @author Leo Fajardo (@leorw)
461
+ * @since 1.2.2
462
+ */
463
+ ( is_object( $this->_plugin ) ? $this->_plugin->title : $this->get_plugin_name() ),
464
+ $this->get_unique_affix()
465
+ );
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
466
 
467
+ if ( 'true' === fs_request_get( 'fs_clear_api_cache' ) ||
468
+ 'true' === fs_request_is_action( 'restart_freemius' )
469
+ ) {
470
+ FS_Api::clear_cache();
471
+ $this->_cache->clear();
472
  }
473
 
474
+ $this->_register_hooks();
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
475
 
476
+ /**
477
+ * Starting from version 2.0.0, `FS_Site` entities no longer have the `plan` property and have `plan_id`
478
+ * instead. This should be called before calling `_load_account()`, otherwise, `$this->_site` will not be
479
+ * loaded in `_load_account` for versions of SDK starting from 2.0.0.
480
+ *
481
+ * @author Leo Fajardo (@leorw)
482
+ */
483
+ self::migrate_install_plan_to_plan_id( $this->_storage );
484
 
485
+ $this->_load_account();
 
 
486
 
487
+ $this->_version_updates_handler();
488
+ }
489
 
490
+ /**
491
+ * Checks whether this module has a settings menu.
492
+ *
493
+ * @author Leo Fajardo (@leorw)
494
+ * @since 1.2.2
495
+ *
496
+ * @return bool
497
+ */
498
+ function has_settings_menu() {
499
+ return ( $this->_is_network_active && fs_is_network_admin() ) ?
500
+ $this->_menu->has_network_menu() :
501
+ $this->_menu->has_menu();
502
+ }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
503
 
504
+ /**
505
+ * Check if the context module is free wp.org theme.
506
+ *
507
+ * This method is helpful because:
508
+ * 1. wp.org themes are limited to a single submenu item,
509
+ * and sub-submenu items are most likely not allowed (never verified).
510
+ * 2. wp.org themes are not allowed to redirect the user
511
+ * after the theme activation, therefore, the agreed UX
512
+ * is showing the opt-in as a modal dialog box after
513
+ * activation (approved by @otto42, @emiluzelac, @greenshady, @grapplerulrich).
514
+ *
515
+ * @author Vova Feldman (@svovaf)
516
+ * @since 1.2.2.7
517
+ *
518
+ * @return bool
519
+ */
520
+ function is_free_wp_org_theme() {
521
+ return (
522
+ $this->is_theme() &&
523
+ $this->is_org_repo_compliant() &&
524
+ ! $this->is_premium()
525
+ );
526
+ }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
527
 
528
+ /**
529
+ * Checks whether this a submenu item is visible.
530
+ *
531
+ * @author Vova Feldman (@svovaf)
532
+ * @since 1.2.2.6
533
+ * @since 1.2.2.7 Even if the menu item was specified to be hidden, when it is the context page, then show the submenu item so the user will have the right context page.
534
+ *
535
+ * @param string $slug
536
+ *
537
+ * @return bool
538
+ */
539
+ function is_submenu_item_visible( $slug ) {
540
+ if ( $this->is_admin_page( $slug ) ) {
541
+ /**
542
+ * It is the current context page, so show the submenu item
543
+ * so the user will have the right context page, even if it
544
+ * was set to hidden.
545
+ */
546
+ return true;
547
+ }
548
 
549
+ if ( ! $this->has_settings_menu() ) {
550
+ // No menu settings at all.
551
+ return false;
552
+ }
553
 
554
+ if ( $this->is_free_wp_org_theme() ) {
555
+ /**
556
+ * wp.org themes are limited to a single submenu item, and
557
+ * sub-submenu items are most likely not allowed (never verified).
558
+ */
559
+ return false;
560
+ }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
561
 
562
+ return $this->_menu->is_submenu_item_visible( $slug );
563
+ }
 
 
564
 
565
+ /**
566
+ * Check if a Freemius page should be accessible via the UI.
567
+ *
568
+ * @author Vova Feldman (@svovaf)
569
+ * @since 1.2.2.7
570
+ *
571
+ * @param string $slug
572
+ *
573
+ * @return bool
574
+ */
575
+ function is_page_visible( $slug ) {
576
+ if ( $this->is_admin_page( $slug ) ) {
577
+ return true;
578
+ }
579
 
580
+ return $this->_menu->is_submenu_item_visible( $slug, true, true );
581
+ }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
582
 
583
+ /**
584
+ * @author Vova Feldman (@svovaf)
585
+ * @since 1.0.9
586
+ */
587
+ private function _version_updates_handler() {
588
+ if ( ! isset( $this->_storage->sdk_version ) || $this->_storage->sdk_version != $this->version ) {
589
+ // Freemius version upgrade mode.
590
+ $this->_storage->sdk_last_version = $this->_storage->sdk_version;
591
+ $this->_storage->sdk_version = $this->version;
592
+
593
+ if ( empty( $this->_storage->sdk_last_version ) ||
594
+ version_compare( $this->_storage->sdk_last_version, $this->version, '<' )
595
+ ) {
596
+ $this->_storage->sdk_upgrade_mode = true;
597
+ $this->_storage->sdk_downgrade_mode = false;
598
+ } else {
599
+ $this->_storage->sdk_downgrade_mode = true;
600
+ $this->_storage->sdk_upgrade_mode = false;
601
 
602
+ }
 
 
603
 
604
+ $this->do_action( 'sdk_version_update', $this->_storage->sdk_last_version, $this->version );
605
+ }
606
 
607
+ $plugin_version = $this->get_plugin_version();
608
+ if ( ! isset( $this->_storage->plugin_version ) || $this->_storage->plugin_version != $plugin_version ) {
609
+ // Plugin version upgrade mode.
610
+ $this->_storage->plugin_last_version = $this->_storage->plugin_version;
611
+ $this->_storage->plugin_version = $plugin_version;
612
 
613
+ if ( empty( $this->_storage->plugin_last_version ) ||
614
+ version_compare( $this->_storage->plugin_last_version, $plugin_version, '<' )
615
+ ) {
616
+ $this->_storage->plugin_upgrade_mode = true;
617
+ $this->_storage->plugin_downgrade_mode = false;
618
+ } else {
619
+ $this->_storage->plugin_downgrade_mode = true;
620
+ $this->_storage->plugin_upgrade_mode = false;
621
+ }
622
 
623
+ if ( ! empty( $this->_storage->plugin_last_version ) ) {
624
+ // Different version of the plugin was installed before, therefore it's an update.
625
+ $this->_storage->is_plugin_new_install = false;
626
+ }
627
 
628
+ $this->do_action( 'plugin_version_update', $this->_storage->plugin_last_version, $plugin_version );
629
+ }
630
+ }
631
 
632
+ #--------------------------------------------------------------------------------
633
+ #region Data Migration on SDK Update
634
+ #--------------------------------------------------------------------------------
635
 
636
+ /**
637
+ * @author Vova Feldman (@svovaf)
638
+ * @since 1.1.5
639
+ *
640
+ * @param string $sdk_prev_version
641
+ * @param string $sdk_version
642
+ */
643
+ function _data_migration( $sdk_prev_version, $sdk_version ) {
644
+ /**
645
+ * @since 1.1.7.3 Fixed unwanted connectivity test cleanup.
646
+ */
647
+ if ( empty( $sdk_prev_version ) ) {
648
+ return;
649
+ }
650
 
651
+ if ( version_compare( $sdk_prev_version, '2.0.0', '<' ) &&
652
+ version_compare( $sdk_version, '2.0.0', '>=' )
653
+ ) {
654
+ $this->migrate_to_subscriptions_collection();
655
 
656
+ $this->consolidate_licenses();
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
657
 
658
+ // Clear trial_plan since it's now loaded from the plans collection when needed.
659
+ $this->_storage->remove( 'trial_plan', true, false );
660
+ }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
661
 
662
+ if ( version_compare( $sdk_prev_version, '1.2.3', '<' ) &&
663
+ version_compare( $sdk_version, '1.2.3', '>=' )
664
+ ) {
665
+ /**
666
+ * Starting from version 1.2.3, paths are stored as relative paths and not absolute paths; so when upgrading to 1.2.3, make paths relative.
667
+ *
668
+ * @author Leo Fajardo (@leorw)
669
+ */
670
+ $this->make_paths_relative();
671
+ }
672
+
673
+ if ( version_compare( $sdk_prev_version, '1.1.5', '<' ) &&
674
+ version_compare( $sdk_version, '1.1.5', '>=' )
675
+ ) {
676
+ // On version 1.1.5 merged connectivity and is_on data.
677
+ if ( isset( $this->_storage->connectivity_test ) ) {
678
+ if ( ! isset( $this->_storage->is_on ) ) {
679
+ unset( $this->_storage->connectivity_test );
680
+ } else {
681
+ $connectivity_data = $this->_storage->connectivity_test;
682
+ $connectivity_data['is_active'] = $this->_storage->is_on['is_active'];
683
+ $connectivity_data['timestamp'] = $this->_storage->is_on['timestamp'];
684
+
685
+ // Override.
686
+ $this->_storage->connectivity_test = $connectivity_data;
687
+
688
+ // Remove previous structure.
689
+ unset( $this->_storage->is_on );
690
+ }
691
+
692
+ }
693
+ }
694
+ }
695
 
696
+ /**
697
+ * @author Leo Fajardo (@leorw)
698
+ * @since 2.0.0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
699
  *
700
+ * @param \FS_Storage $storage
701
+ * @param bool|int|null $blog_id
702
  */
703
+ private static function migrate_install_plan_to_plan_id( FS_Storage $storage, $blog_id = null ) {
704
+ if ( empty( $storage->sdk_version ) ) {
705
+ // New installation of the plugin, no need to upgrade.
706
+ return;
707
+ }
708
+
709
+ if ( ! version_compare( $storage->sdk_version, '2.0.0', '<' ) ) {
710
+ // Previous version is >= 2.0.0, so no need to migrate.
711
+ return;
712
+ }
713
+
714
+ // Alias.
715
+ $module_type = $storage->get_module_type();
716
+ $module_slug = $storage->get_module_slug();
717
+
718
+ $installs = self::get_all_sites( $module_type, $blog_id );
719
+ $install = isset( $installs[ $module_slug ] ) ? $installs[ $module_slug ] : null;
720
+
721
+ if ( ! is_object( $install ) ) {
722
+ return;
723
  }
724
 
725
+ if ( isset( $install->plan ) && is_object( $install->plan ) ) {
726
+ if ( isset( $install->plan->id ) && ! empty( $install->plan->id ) ) {
727
+ $install->plan_id = self::_decrypt( $install->plan->id );
728
+ }
729
+
730
+ unset( $install->plan );
731
+
732
+ $installs[ $module_slug ] = clone $install;
733
+
734
+ self::set_account_option_by_module(
735
+ $module_type,
736
+ 'sites',
737
+ $installs,
738
+ true,
739
+ $blog_id
740
+ );
741
+ }
742
  }
743
 
744
  /**
745
  * @author Leo Fajardo (@leorw)
746
+ * @since 2.0.0
747
  */
748
+ private function migrate_to_subscriptions_collection() {
749
+ if ( ! is_object( $this->_site ) ) {
750
+ return;
751
+ }
 
 
 
 
752
 
753
+ if ( isset( $this->_storage->subscription ) && is_object( $this->_storage->subscription ) ) {
754
+ $this->_storage->subscriptions = array( $this->_storage->subscription );
755
  }
756
  }
757
 
758
  /**
759
  * @author Leo Fajardo (@leorw)
760
+ * @since 2.0.0
761
  */
762
+ private function consolidate_licenses() {
763
+ $plugin_licenses = self::get_account_option( 'licenses', WP_FS__MODULE_TYPE_PLUGIN );
764
+ if ( isset( $plugin_licenses[ $this->_slug ] ) ) {
765
+ $plugin_licenses = $plugin_licenses[ $this->_slug ];
766
+ } else {
767
+ $plugin_licenses = array();
768
+ }
769
 
770
+ $theme_licenses = self::get_account_option( 'licenses', WP_FS__MODULE_TYPE_THEME );
771
+ if ( isset( $theme_licenses[ $this->_slug ] ) ) {
772
+ $theme_licenses = $theme_licenses[ $this->_slug ];
773
+ } else {
774
+ $theme_licenses = array();
775
+ }
776
 
777
+ if ( empty( $plugin_licenses ) && empty( $theme_licenses ) ) {
778
+ return;
779
+ }
 
780
 
781
+ $all_licenses = array();
782
+ $user_id_license_ids_map = array();
 
 
 
 
783
 
784
+ foreach ( $plugin_licenses as $user_id => $user_licenses ) {
785
+ if ( is_array( $user_licenses ) ) {
786
+ if ( ! isset( $user_license_ids[ $user_id ] ) ) {
787
+ $user_id_license_ids_map[ $user_id ] = array();
788
+ }
789
+
790
+ foreach ( $user_licenses as $user_license ) {
791
+ $all_licenses[] = $user_license;
792
+ $user_id_license_ids_map[ $user_id ][] = $user_license->id;
793
  }
794
  }
795
  }
 
796
 
797
+ foreach ( $theme_licenses as $user_id => $user_licenses ) {
798
+ if ( is_array( $user_licenses ) ) {
799
+ if ( ! isset( $user_license_ids[ $user_id ] ) ) {
800
+ $user_id_license_ids_map[ $user_id ] = array();
801
+ }
 
802
 
803
+ foreach ( $user_licenses as $user_license ) {
804
+ $all_licenses[] = $user_license;
805
+ $user_id_license_ids_map[ $user_id ][] = $user_license->id;
806
+ }
807
+ }
808
+ }
809
+
810
+ self::store_user_id_license_ids_map(
811
+ $user_id_license_ids_map,
812
+ $this->_module_id
813
+ );
814
+
815
+ $this->_store_licenses( true, $this->_module_id, $all_licenses );
816
  }
817
 
818
  /**
819
+ * Makes paths relative.
 
820
  *
821
+ * @author Leo Fajardo (@leorw)
822
+ * @since 1.2.3
823
  */
824
+ private function make_paths_relative() {
825
+ $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map', array() );
826
+
827
+ if ( isset( $id_slug_type_path_map[ $this->_module_id ]['path'] ) ) {
828
+ $id_slug_type_path_map[ $this->_module_id ]['path'] = $this->get_relative_path( $id_slug_type_path_map[ $this->_module_id ]['path'] );
829
+
830
+ self::$_accounts->set_option( 'id_slug_type_path_map', $id_slug_type_path_map, true );
831
+ }
832
+
833
+ if ( isset( $this->_storage->plugin_main_file ) ) {
834
+ $plugin_main_file = $this->_storage->plugin_main_file;
835
 
836
+ if ( isset( $plugin_main_file->path ) ) {
837
+ $this->_storage->plugin_main_file->path = $this->get_relative_path( $this->_storage->plugin_main_file->path );
838
+ } else if ( isset( $plugin_main_file->prev_path ) ) {
839
+ $this->_storage->plugin_main_file->prev_path = $this->get_relative_path( $this->_storage->plugin_main_file->prev_path );
840
+ }
841
+ }
842
+
843
+ // Remove invalid path that is still associated with the current slug if there's any.
844
+ $file_slug_map = self::$_accounts->get_option( 'file_slug_map', array() );
845
+ foreach ( $file_slug_map as $plugin_basename => $slug ) {
846
+ if ( $slug === $this->_slug &&
847
+ $plugin_basename !== $this->_plugin_basename &&
848
+ ! file_exists( $this->get_absolute_path( $plugin_basename ) )
849
+ ) {
850
+ unset( $file_slug_map[ $plugin_basename ] );
851
+ self::$_accounts->set_option( 'file_slug_map', $file_slug_map, true );
852
+
853
+ break;
854
+ }
855
+ }
856
+ }
857
 
858
  /**
859
+ * @author Vova Feldman (@svovaf)
860
+ * @since 1.2.2.7
861
  *
862
+ * @param string $plugin_prev_version
863
+ * @param string $plugin_version
864
  */
865
+ function _after_version_update( $plugin_prev_version, $plugin_version ) {
866
+ if ( $this->is_theme() ) {
867
+ // Expire the cache of the previous tabs since the theme may
868
+ // have setting updates.
869
+ $this->_cache->expire( 'tabs' );
870
+ $this->_cache->expire( 'tabs_stylesheets' );
871
+ }
872
  }
873
 
874
  /**
875
+ * A special migration logic for the $_accounts, executed for all the plugins in the system:
876
+ * - Moves some data to the network level storage.
877
+ * - If the plugin's connection was skipped for all sites, set the plugin as if it was network skipped.
878
+ * - If the plugin's connection was ignored for all sites, don't do anything in terms of the network connection.
879
+ * - If the plugin was connected to all sites by the same super-admin, set the plugin as if was network opted-in for all sites.
880
+ * - If there's at least one site that was connected by a super-admin, find the "main super-admin" (the one that installed the majority of the plugin installs) and set the plugin as if was network activated with the main super-admin, set all the sites that were skipped or opted-in with a different user to delegated mode. Then, prompt the currently logged super-admin to choose what to do with the ignored sites.
881
+ * - If there are any sites in the network which the connection decision was not yet taken for, set this plugin into network activation mode so a super-admin can choose what to do with the rest of the sites.
882
  *
883
+ * @author Vova Feldman (@svovaf)
884
+ * @since 2.0.0
885
  */
886
+ private static function migrate_accounts_to_network() {
887
+ $sites = self::get_sites();
888
+ $sites_count = count( $sites );
889
+ $connection_status = array();
890
+ $plugin_slugs = array();
891
+ foreach ( $sites as $site ) {
892
+ $blog_id = self::get_site_blog_id( $site );
893
 
894
+ self::$_accounts->migrate_to_network( $blog_id );
895
 
896
+ /**
897
+ * Build a list of all Freemius powered plugins slugs.
898
+ */
899
+ $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map', array(), $blog_id );
900
+ foreach ( $id_slug_type_path_map as $module_id => $data ) {
901
+ if ( WP_FS__MODULE_TYPE_PLUGIN === $data['type'] ) {
902
+ $plugin_slugs[ $data['slug'] ] = true;
903
+ }
904
+ }
905
 
906
+ $installs = self::get_account_option( 'sites', WP_FS__MODULE_TYPE_PLUGIN, $blog_id );
907
 
908
+ if ( is_array( $installs ) ) {
909
+ foreach ( $installs as $slug => $install ) {
910
+ if ( ! isset( $connection_status[ $slug ] ) ) {
911
+ $connection_status[ $slug ] = array();
912
+ }
913
 
914
+ if ( is_object( $install ) &&
915
+ FS_Site::is_valid_id( $install->id ) &&
916
+ FS_User::is_valid_id( $install->user_id )
917
+ ) {
918
+ $connection_status[ $slug ][ $blog_id ] = $install->user_id;
919
+ }
920
+ }
921
+ }
922
  }
923
 
924
+ foreach ( $plugin_slugs as $slug => $true ) {
925
+ if ( ! isset( $connection_status[ $slug ] ) ) {
926
+ $connection_status[ $slug ] = array();
927
+ }
 
 
 
 
 
 
 
928
 
929
+ foreach ( $sites as $site ) {
930
+ $blog_id = self::get_site_blog_id( $site );
931
+
932
+ if ( isset( $connection_status[ $slug ][ $blog_id ] ) ) {
933
+ continue;
934
+ }
935
+
936
+ $storage = FS_Storage::instance( WP_FS__MODULE_TYPE_PLUGIN, $slug );
937
+
938
+ $is_anonymous = $storage->get( 'is_anonymous', null, $blog_id );
939
+
940
+ if ( ! is_null( $is_anonymous ) ) {
941
+ // Since 1.1.3 is_anonymous is an array.
942
+ if ( is_array( $is_anonymous ) && isset( $is_anonymous['is'] ) ) {
943
+ $is_anonymous = $is_anonymous['is'];
944
+ }
945
+
946
+ if ( is_bool( $is_anonymous ) && true === $is_anonymous ) {
947
+ $connection_status[ $slug ][ $blog_id ] = 'skipped';
948
+ }
949
+ }
950
+
951
+ if ( ! isset( $connection_status[ $slug ][ $blog_id ] ) ) {
952
+ $connection_status[ $slug ][ $blog_id ] = 'ignored';
953
+ }
954
  }
955
  }
956
 
957
+ $super_admins = array();
958
 
959
+ foreach ( $connection_status as $slug => $blogs_status ) {
960
+ $skips = 0;
961
+ $ignores = 0;
962
+ $connections = 0;
963
+ $opted_in_users = array();
964
+ $opted_in_super_admins = array();
965
 
966
+ $storage = FS_Storage::instance( WP_FS__MODULE_TYPE_PLUGIN, $slug );
 
 
 
 
 
 
 
 
 
 
 
967
 
968
+ foreach ( $blogs_status as $blog_id => $status_or_user_id ) {
969
+ if ( 'skipped' === $status_or_user_id ) {
970
+ $skips ++;
971
+ } else if ( 'ignored' === $status_or_user_id ) {
972
+ $ignores ++;
973
+ } else if ( FS_User::is_valid_id( $status_or_user_id ) ) {
974
+ $connections ++;
975
 
976
+ if ( ! isset( $opted_in_users[ $status_or_user_id ] ) ) {
977
+ $opted_in_users[ $status_or_user_id ] = array();
978
+ }
979
 
980
+ $opted_in_users[ $status_or_user_id ][] = $blog_id;
981
+
982
+ if ( isset( $super_admins[ $status_or_user_id ] ) ||
983
+ self::is_super_admin( $status_or_user_id )
984
+ ) {
985
+ // Cache super-admin data.
986
+ $super_admins[ $status_or_user_id ] = true;
987
+
988
+ // Remember opted-in super-admins for the plugin.
989
+ $opted_in_super_admins[ $status_or_user_id ] = true;
990
+ }
991
+ }
992
  }
993
 
994
+ $main_super_admin_user_id = null;
995
+ $all_migrated = false;
996
+ if ( $sites_count == $skips ) {
997
+ // All sites were skipped -> network skip by copying the anonymous mode from any of the sites.
998
+ $storage->is_anonymous_ms = $storage->is_anonymous;
999
+
1000
+ $all_migrated = true;
1001
+ } else if ( $sites_count == $ignores ) {
1002
+ // Don't do anything, still in activation mode.
1003
+
1004
+ $all_migrated = true;
1005
+ } else if ( 0 < count( $opted_in_super_admins ) ) {
1006
+ // Find the super-admin with the majority of installs.
1007
+ $max_installs_by_super_admin = 0;
1008
+ foreach ( $opted_in_super_admins as $user_id => $true ) {
1009
+ $installs_count = count( $opted_in_users[ $user_id ] );
1010
+
1011
+ if ( $installs_count > $max_installs_by_super_admin ) {
1012
+ $max_installs_by_super_admin = $installs_count;
1013
+ $main_super_admin_user_id = $user_id;
1014
+ }
1015
+ }
1016
+
1017
+ if ( $sites_count == $connections && 1 == count( $opted_in_super_admins ) ) {
1018
+ // Super-admin opted-in for all sites in the network.
1019
+ $storage->is_network_connected = true;
1020
+
1021
+ $all_migrated = true;
1022
+ }
1023
+
1024
+ // Store network user.
1025
+ $storage->network_user_id = $main_super_admin_user_id;
1026
+
1027
+ $storage->network_install_blog_id = ( $sites_count == $connections ) ?
1028
+ // Since all sites are opted-in, associating with the main site.
1029
+ get_current_blog_id() :
1030
+ // Associating with the 1st found opted-in site.
1031
+ $opted_in_users[ $main_super_admin_user_id ][0];
1032
+
1033
+ /**
1034
+ * Make sure we migrate the plan ID of the network install, otherwise, if after the migration
1035
+ * the 1st page that will be loaded is the network level WP Admin and $storage->network_install_blog_id
1036
+ * is different than the main site of the network, the $this->_site will not be set since the plan_id
1037
+ * will be empty.
1038
+ */
1039
+ $storage->migrate_to_network();
1040
+ self::migrate_install_plan_to_plan_id( $storage, $storage->network_install_blog_id );
1041
+ } else {
1042
+ // At least one opt-in. All the opt-in were created by a non-super-admin.
1043
+ if ( 0 == $ignores ) {
1044
+ // All sites were opted-in or skipped, all by non-super-admin. So delegate all.
1045
+ $storage->store( 'is_delegated_connection', true, true );
1046
+
1047
+ $all_migrated = true;
1048
+ }
1049
  }
1050
 
1051
+ if ( ! $all_migrated ) {
1052
+ /**
1053
+ * Delegate all sites that were:
1054
+ * 1) Opted-in by a user that is NOT the main-super-admin.
1055
+ * 2) Skipped and non of the sites was opted-in by a super-admin. If any site was opted-in by a super-admin, there will be a main-super-admin, and we consider the skip as if it was done by that user.
1056
+ */
1057
+ foreach ( $blogs_status as $blog_id => $status_or_user_id ) {
1058
+ if ( $status_or_user_id == $main_super_admin_user_id ) {
1059
+ continue;
1060
+ }
1061
 
1062
+ if ( FS_User::is_valid_id( $status_or_user_id ) ||
1063
+ ( 'skipped' === $status_or_user_id && is_null( $main_super_admin_user_id ) )
1064
+ ) {
1065
+ $storage->store( 'is_delegated_connection', true, $blog_id );
1066
+ }
1067
+ }
1068
+ }
1069
 
1070
+
1071
+ if ( ( $connections + $skips > 0 ) ) {
1072
+ if ( $ignores > 0 ) {
1073
+ /**
1074
+ * If admin already opted-in or skipped in any of the network sites, and also
1075
+ * have sites which the connection decision was not yet taken, set this plugin
1076
+ * into network activation mode so the super-admin can choose what to do with
1077
+ * the rest of the sites.
1078
+ */
1079
+ self::set_network_upgrade_mode( $storage );
1080
+ }
1081
+ }
1082
+ }
1083
  }
1084
 
1085
  /**
1086
+ * Set a module into network upgrade mode.
 
1087
  *
1088
+ * @author Vova Feldman (@svovaf)
1089
+ * @since 2.0.0
1090
+ *
1091
+ * @param \FS_Storage $storage
1092
+ *
1093
+ * @return bool
1094
  */
1095
+ private static function set_network_upgrade_mode( FS_Storage $storage ) {
1096
+ return $storage->is_network_activation = true;
 
 
 
 
1097
  }
1098
 
1099
+ /**
1100
+ * Will return true after upgrading to the SDK with the network level integration,
1101
+ * when the super-admin involvement is required regarding the rest of the sites.
1102
+ *
1103
+ * @author Vova Feldman (@svovaf)
1104
+ * @since 2.0.0
1105
+ *
1106
+ * @return bool
1107
+ */
1108
+ function is_network_upgrade_mode() {
1109
+ return $this->_storage->get( 'is_network_activation' );
1110
+ }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1111
 
1112
+ /**
1113
+ * Clear flag after the upgrade mode completion.
1114
+ *
1115
+ * @author Vova Feldman (@svovaf)
1116
+ * @since 2.0.0
1117
+ *
1118
+ * @return bool True if network activation was on and now completed.
1119
+ */
1120
+ private function network_upgrade_mode_completed() {
1121
+ if ( fs_is_network_admin() && $this->is_network_upgrade_mode() ) {
1122
+ $this->_storage->remove( 'is_network_activation' );
1123
 
1124
+ return true;
 
 
 
1125
  }
1126
 
1127
+ return false;
1128
+ }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1129
 
1130
+ #endregion
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1131
 
1132
+ /**
1133
+ * This action is connected to the 'plugins_loaded' hook and helps to determine
1134
+ * if this is a new plugin installation or a plugin update.
1135
+ *
1136
+ * There are 3 different use-cases:
1137
+ * 1) New plugin installation right with Freemius:
1138
+ * 1.1 _activate_plugin_event_hook() will be executed first
1139
+ * 1.2 Since $this->_storage->is_plugin_new_install is not set,
1140
+ * and $this->_storage->plugin_last_version is not set,
1141
+ * $this->_storage->is_plugin_new_install will be set to TRUE.
1142
+ * 1.3 When _plugins_loaded() will be executed, $this->_storage->is_plugin_new_install will
1143
+ * be already set to TRUE.
1144
+ *
1145
+ * 2) Plugin update, didn't have Freemius before, and now have the SDK:
1146
+ * 2.1 _activate_plugin_event_hook() will not be executed, because
1147
+ * the activation hook do NOT fires on updates since WP 3.1.
1148
+ * 2.2 When _plugins_loaded() will be executed, $this->_storage->is_plugin_new_install will
1149
+ * be empty, therefore, it will be set to FALSE.
1150
+ *
1151
+ * 3) Plugin update, had Freemius in prev version as well:
1152
+ * 3.1 _version_updates_handler() will be executed 1st, since FS was installed
1153
+ * before, $this->_storage->plugin_last_version will NOT be empty,
1154
+ * therefore, $this->_storage->is_plugin_new_install will be set to FALSE.
1155
+ * 3.2 When _plugins_loaded() will be executed, $this->_storage->is_plugin_new_install is
1156
+ * already set, therefore, it will not be modified.
1157
+ *
1158
+ * Use-case #3 is backward compatible, #3.1 will be executed since 1.0.9.
1159
+ *
1160
+ * NOTE:
1161
+ * The only fallback of this mechanism is if an admin updates a plugin based on use-case #2,
1162
+ * and then, the next immediate PageView is the plugin's main settings page, it will not
1163
+ * show the opt-in right away. The reason it will happen is because Freemius execution
1164
+ * will be turned off till the plugin is fully loaded at least once
1165
+ * (till $this->_storage->was_plugin_loaded is TRUE).
1166
+ *
1167
+ * @author Vova Feldman (@svovaf)
1168
+ * @since 1.1.9
1169
+ *
1170
+ */
1171
+ function _plugins_loaded() {
1172
+ // Update flag that plugin was loaded with Freemius at least once.
1173
+ $this->_storage->was_plugin_loaded = true;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1174
 
1175
  /**
1176
+ * Bug fix - only set to false when it's a plugin, due to the
1177
+ * execution sequence of the theme hooks and our methods, if
1178
+ * this will be set for themes, Freemius will always assume
1179
+ * it's a theme update.
1180
  *
1181
  * @author Vova Feldman (@svovaf)
1182
+ * @since 1.2.2.2
 
 
 
 
1183
  */
1184
+ if ( $this->is_plugin() &&
1185
+ ! isset( $this->_storage->is_plugin_new_install )
1186
+ ) {
1187
+ $this->_storage->is_plugin_new_install = false;
1188
+ }
1189
+ }
1190
 
1191
+ /**
1192
+ * Add special parameter to WP admin AJAX calls so when we
1193
+ * process AJAX calls we can identify its source properly.
1194
+ *
1195
+ * @author Leo Fajardo (@leorw)
1196
+ * @since 2.0.0
1197
+ */
1198
+ static function _enrich_ajax_url() {
1199
+ $admin_param = is_network_admin() ?
1200
+ '_fs_network_admin' :
1201
+ '_fs_blog_admin';
1202
+ ?>
1203
+ <script type="text/javascript">
1204
+ (function ($) {
1205
+ $(document).ajaxSend(function (event, jqxhr, settings) {
1206
+ if (settings.url &&
1207
+ -1 < settings.url.indexOf('admin-ajax.php') &&
1208
+ ! ( settings.url.indexOf( '<?php echo $admin_param ?>' ) > 0 )
1209
+ ) {
1210
+ if (settings.url.indexOf('?') > 0) {
1211
+ settings.url += '&';
1212
+ } else {
1213
+ settings.url += '?';
1214
+ }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1215
 
1216
+ settings.url += '<?php echo $admin_param ?>=true';
1217
+
1218
+ }
1219
+ });
1220
+ })(jQuery);
1221
+ </script>
1222
+ <?php
1223
+ }
1224
+
1225
+ /**
1226
+ * @author Vova Feldman (@svovaf)
1227
+ * @since 1.0.9
1228
+ */
1229
+ private function _register_hooks() {
1230
+ $this->_logger->entrance();
1231
+
1232
+ if ( is_admin() ) {
1233
+ add_action( 'plugins_loaded', array( &$this, '_hook_action_links_and_register_account_hooks' ) );
1234
+
1235
+ if ( $this->is_plugin() ) {
1236
+ $plugin_dir = dirname( $this->_plugin_dir_path ) . '/';
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1237
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1238
  /**
1239
+ * @since 1.2.2
 
 
 
 
 
1240
  *
1241
+ * Hook to both free and premium version activations to support
1242
+ * auto deactivation on the other version activation.
1243
  */
1244
+ register_activation_hook(
1245
+ $plugin_dir . $this->_free_plugin_basename,
1246
+ array( &$this, '_activate_plugin_event_hook' )
1247
+ );
1248
 
1249
+ register_activation_hook(
1250
+ $plugin_dir . $this->premium_plugin_basename(),
1251
+ array( &$this, '_activate_plugin_event_hook' )
1252
+ );
1253
+ } else {
1254
+ add_action( 'after_switch_theme', array( &$this, '_activate_theme_event_hook' ), 10, 2 );
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1255
 
1256
+ /**
1257
+ * Include the required hooks to capture the theme settings' page tabs
1258
+ * and cache them.
1259
+ *
1260
+ * @author Vova Feldman (@svovaf)
1261
+ * @since 1.2.2.7
1262
+ */
1263
+ if ( ! $this->_cache->has_valid( 'tabs' ) ) {
1264
+ add_action( 'admin_footer', array( &$this, '_tabs_capture' ) );
1265
+ // Add license activation AJAX callback.
1266
+ $this->add_ajax_action( 'store_tabs', array( &$this, '_store_tabs_ajax_action' ) );
1267
 
1268
+ add_action( 'admin_enqueue_scripts', array( &$this, '_store_tabs_styles' ), 9999999 );
1269
+ }
1270
 
1271
+ add_action(
1272
+ 'admin_footer',
1273
+ array( &$this, '_add_freemius_tabs' ),
1274
+ /**
1275
+ * The tabs JS code must be executed after the tabs capture logic (_tabs_capture()).
1276
+ * That's why the priority is 11 while the tabs capture logic is added
1277
+ * with priority 10.
1278
+ *
1279
+ * @author Vova Feldman (@svovaf)
1280
+ */
1281
+ 11
1282
+ );
1283
 
1284
+ add_action( 'admin_footer', array( &$this, '_style_premium_theme' ) );
1285
+ }
 
1286
 
1287
+ /**
1288
+ * Part of the mechanism to identify new plugin install vs. plugin update.
1289
+ *
1290
+ * @author Vova Feldman (@svovaf)
1291
+ * @since 1.1.9
1292
+ */
1293
+ if ( empty( $this->_storage->was_plugin_loaded ) ) {
1294
+ /**
1295
+ * During the plugin activation (not theme), 'plugins_loaded' will be already executed
1296
+ * when the logic gets here since the activation logic first add the activate plugins,
1297
+ * then triggers 'plugins_loaded', and only then include the code of the plugin that
1298
+ * is activated. Which means that _plugins_loaded() will NOT be executed during the
1299
+ * plugin activation, and that IS intentional.
1300
+ *
1301
+ * @author Vova Feldman (@svovaf)
1302
+ */
1303
+ if ( $this->is_plugin() && $this->is_activation_mode( false ) ) {
1304
+ add_action( 'plugins_loaded', array( &$this, '_plugins_loaded' ) );
1305
+ } else {
1306
+ // If was activated before, then it was already loaded before.
1307
+ $this->_plugins_loaded();
1308
+ }
1309
+ }
1310
 
1311
+ if ( ! self::is_ajax() ) {
1312
+ if ( ! $this->is_addon() ) {
1313
+ add_action( 'init', array( &$this, '_add_default_submenu_items' ), WP_FS__LOWEST_PRIORITY );
1314
+ }
1315
+ }
1316
+ }
1317
 
1318
+ if ( $this->is_plugin() ) {
1319
+ if ( $this->_is_network_active ) {
1320
+ add_action( 'wpmu_new_blog', array( $this, '_after_new_blog_callback' ), 10, 6 );
1321
+ }
1322
 
1323
+ register_deactivation_hook( $this->_plugin_main_file_path, array( &$this, '_deactivate_plugin_hook' ) );
1324
+ }
1325
 
1326
+ if ( is_multisite() ) {
1327
+ add_action( 'deactivate_blog', array( &$this, '_after_site_deactivated_callback' ) );
1328
+ add_action( 'archive_blog', array( &$this, '_after_site_deactivated_callback' ) );
1329
+ add_action( 'make_spam_blog', array( &$this, '_after_site_deactivated_callback' ) );
1330
+ add_action( 'deleted_blog', array( &$this, '_after_site_deleted_callback' ), 10, 2 );
1331
 
1332
+ add_action( 'activate_blog', array( &$this, '_after_site_reactivated_callback' ) );
1333
+ add_action( 'unarchive_blog', array( &$this, '_after_site_reactivated_callback' ) );
1334
+ add_action( 'make_ham_blog', array( &$this, '_after_site_reactivated_callback' ) );
1335
+ }
1336
 
1337
+ if ( $this->is_theme() && self::is_customizer() ) {
1338
+ // Register customizer upsell.
1339
+ add_action( 'customize_register', array( &$this, '_customizer_register' ) );
1340
+ }
1341
 
1342
+ add_action( 'init', array( &$this, '_redirect_on_clicked_menu_link' ), WP_FS__LOWEST_PRIORITY );
 
 
 
 
 
 
 
 
1343
 
1344
+ if ( $this->is_theme() ) {
1345
+ add_action( 'admin_init', array( &$this, '_add_tracking_links' ) );
1346
+ }
 
 
 
 
 
 
1347
 
1348
+ add_action( 'admin_init', array( &$this, '_add_license_activation' ) );
1349
+ $this->add_ajax_action( 'update_billing', array( &$this, '_update_billing_ajax_action' ) );
1350
+ $this->add_ajax_action( 'start_trial', array( &$this, '_start_trial_ajax_action' ) );
 
 
 
 
 
1351
 
1352
+ if ( $this->_is_network_active && fs_is_network_admin() ) {
1353
+ $this->add_ajax_action( 'network_activate', array( &$this, '_network_activate_ajax_action' ) );
1354
+ }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1355
 
1356
+ $this->add_ajax_action( 'install_premium_version', array(
1357
+ &$this,
1358
+ '_install_premium_version_ajax_action'
1359
+ ) );
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1360
 
1361
+ $this->add_ajax_action( 'submit_affiliate_application', array( &$this, '_submit_affiliate_application' ) );
 
1362
 
1363
+ $this->add_action( 'after_plans_sync', array( &$this, '_check_for_trial_plans' ) );
 
1364
 
1365
+ $this->add_action( 'sdk_version_update', array( &$this, '_data_migration' ), WP_FS__DEFAULT_PRIORITY, 2 );
1366
+ $this->add_action(
1367
+ 'plugin_version_update',
1368
+ array( &$this, '_after_version_update' ),
1369
+ WP_FS__DEFAULT_PRIORITY,
1370
+ 2
1371
+ );
1372
+ $this->add_filter( 'after_code_type_change', array( &$this, '_after_code_type_change' ) );
1373
 
1374
+ add_action( 'admin_init', array( &$this, '_add_trial_notice' ) );
1375
+ add_action( 'admin_init', array( &$this, '_add_affiliate_program_notice' ) );
1376
+ add_action( 'admin_init', array( &$this, '_enqueue_common_css' ) );
1377
 
1378
+ /**
1379
+ * Handle request to reset anonymous mode for `get_reconnect_url()`.
1380
+ *
1381
+ * @author Vova Feldman (@svovaf)
1382
+ * @since 1.2.1.5
1383
+ */
1384
+ if ( fs_request_is_action( 'reset_anonymous_mode' ) &&
1385
+ $this->get_unique_affix() === fs_request_get( 'fs_unique_affix' )
1386
+ ) {
1387
+ add_action( 'admin_init', array( &$this, 'connect_again' ) );
1388
+ }
1389
+ }
1390
+
1391
+ /**
1392
+ * Keeping the uninstall hook registered for free or premium plugin version may result to a fatal error that
1393
+ * could happen when a user tries to uninstall either version while one of them is still active. Uninstalling a
1394
+ * plugin will trigger inclusion of the free or premium version and if one of them is active during the
1395
+ * uninstallation, a fatal error may occur in case the plugin's class or functions are already defined.
1396
+ *
1397
+ * @author Leo Fajardo (@leorw)
1398
+ *
1399
+ * @since 1.2.0
1400
+ */
1401
+ private function unregister_uninstall_hook() {
1402
+ $uninstallable_plugins = (array) get_option( 'uninstall_plugins' );
1403
+ unset( $uninstallable_plugins[ $this->_free_plugin_basename ] );
1404
+ unset( $uninstallable_plugins[ $this->premium_plugin_basename() ] );
1405
+
1406
+ update_option( 'uninstall_plugins', $uninstallable_plugins );
1407
+ }
1408
+
1409
+ /**
1410
+ * @since 1.2.0 Invalidate module's main file cache, otherwise, FS_Plugin_Updater will not fetch updates.
1411
+ */
1412
+ private function clear_module_main_file_cache() {
1413
+ if ( ! isset( $this->_storage->plugin_main_file ) ||
1414
+ empty( $this->_storage->plugin_main_file->path )
1415
+ ) {
1416
+ return;
1417
+ }
1418
+
1419
+ $plugin_main_file = clone $this->_storage->plugin_main_file;
1420
+
1421
+ // Store cached path (2nd layer cache).
1422
+ $plugin_main_file->prev_path = $plugin_main_file->path;
1423
+
1424
+ // Clear cached path.
1425
+ unset( $plugin_main_file->path );
1426
+
1427
+ $this->_storage->plugin_main_file = $plugin_main_file;
1428
+
1429
+ /**
1430
+ * Clear global cached path.
1431
+ *
1432
+ * @author Leo Fajardo (@leorw)
1433
+ * @since 1.2.2
1434
+ */
1435
+ $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map' );
1436
+ unset( $id_slug_type_path_map[ $this->_module_id ]['path'] );
1437
+ self::$_accounts->set_option( 'id_slug_type_path_map', $id_slug_type_path_map, true );
1438
+ }
1439
+
1440
+ /**
1441
+ * @author Leo Fajardo (@leorw)
1442
+ * @since 2.0.0
1443
+ */
1444
+ function _hook_action_links_and_register_account_hooks() {
1445
+ add_action( 'admin_init', array( &$this, '_add_tracking_links' ) );
1446
+
1447
+ if ( self::is_plugins_page() && $this->is_plugin() ) {
1448
+ $this->hook_plugin_action_links();
1449
+ }
1450
+
1451
+ $this->_register_account_hooks();
1452
+ }
1453
+
1454
+ /**
1455
+ * @author Vova Feldman (@svovaf)
1456
+ * @since 1.0.9
1457
+ */
1458
+ private function _register_account_hooks() {
1459
+ if ( ! is_admin() ) {
1460
+ return;
1461
+ }
1462
+
1463
+ /**
1464
+ * Always show the deactivation feedback form since we added
1465
+ * automatic free version deactivation upon premium code activation.
1466
+ *
1467
+ * @since 1.2.1.6
1468
+ */
1469
+ $this->add_ajax_action(
1470
+ 'submit_uninstall_reason',
1471
+ array( &$this, '_submit_uninstall_reason_action' )
1472
+ );
1473
+
1474
+ if ( ! $this->is_addon() || $this->is_parent_plugin_installed() ) {
1475
+ if ( ( $this->is_plugin() && self::is_plugins_page() ) ||
1476
+ ( $this->is_theme() && self::is_themes_page() )
1477
+ ) {
1478
+ add_action( 'admin_footer', array( &$this, '_add_deactivation_feedback_dialog_box' ) );
1479
+ }
1480
+ }
1481
+ }
1482
+
1483
+ /**
1484
+ * Leverage backtrace to find caller plugin file path.
1485
+ *
1486
+ * @author Vova Feldman (@svovaf)
1487
+ * @since 1.0.6
1488
+ *
1489
+ * @param bool $is_init Is initiation sequence.
1490
+ *
1491
+ * @return string
1492
+ */
1493
+ private function _find_caller_plugin_file( $is_init = false ) {
1494
+ // Try to load the cached value of the file path.
1495
+ if ( isset( $this->_storage->plugin_main_file ) ) {
1496
+ $plugin_main_file = $this->_storage->plugin_main_file;
1497
+ if ( isset( $plugin_main_file->path ) ) {
1498
+ $absolute_path = $this->get_absolute_path( $plugin_main_file->path );
1499
+ if ( file_exists( $absolute_path ) ) {
1500
+ return $absolute_path;
1501
+ }
1502
+ }
1503
+ }
1504
+
1505
+ /**
1506
+ * @since 1.2.1
1507
+ *
1508
+ * `clear_module_main_file_cache()` is clearing the plugin's cached path on
1509
+ * deactivation. Therefore, if any plugin/theme was initiating `Freemius`
1510
+ * with that plugin's slug, it was overriding the empty plugin path with a wrong path.
1511
+ *
1512
+ * So, we've added a special mechanism with a 2nd layer of cache that uses `prev_path`
1513
+ * when the class instantiator isn't the module.
1514
+ */
1515
+ if ( ! $is_init ) {
1516
+ // Fetch prev path cache.
1517
+ if ( isset( $this->_storage->plugin_main_file ) &&
1518
+ isset( $this->_storage->plugin_main_file->prev_path )
1519
+ ) {
1520
+ $absolute_path = $this->get_absolute_path( $this->_storage->plugin_main_file->prev_path );
1521
+ if ( file_exists( $absolute_path ) ) {
1522
+ return $absolute_path;
1523
+ }
1524
+ }
1525
+
1526
+ wp_die(
1527
+ $this->get_text_inline( 'Freemius SDK couldn\'t find the plugin\'s main file. Please contact sdk@freemius.com with the current error.', 'failed-finding-main-path' ) .
1528
+ " Module: {$this->_slug}; SDK: " . WP_FS__SDK_VERSION . ";",
1529
+ $this->get_text_inline( 'Error', 'error' ),
1530
+ array( 'back_link' => true )
1531
+ );
1532
+ }
1533
+
1534
+ /**
1535
+ * @since 1.2.1
1536
+ *
1537
+ * Only the original instantiator that calls dynamic_init can modify the module's path.
1538
+ */
1539
+ // Find caller module.
1540
+ $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map', array() );
1541
+ $this->_storage->plugin_main_file = (object) array(
1542
+ 'path' => $id_slug_type_path_map[ $this->_module_id ]['path'],
1543
+ );
1544
+
1545
+ return $this->get_absolute_path( $id_slug_type_path_map[ $this->_module_id ]['path'] );
1546
+ }
1547
+
1548
+ /**
1549
+ * @author Leo Fajardo (@leorw)
1550
+ * @since 1.2.3
1551
+ *
1552
+ * @param string $path
1553
+ *
1554
+ * @return string
1555
+ */
1556
+ private function get_relative_path( $path ) {
1557
+ $module_root_dir = $this->get_module_root_dir_path();
1558
+ if ( 0 === strpos( $path, $module_root_dir ) ) {
1559
+ $path = substr( $path, strlen( $module_root_dir ) );
1560
+ }
1561
+
1562
+ return $path;
1563
+ }
1564
+
1565
+ /**
1566
+ * @author Leo Fajardo (@leorw)
1567
+ * @since 1.2.3
1568
+ *
1569
+ * @param string $path
1570
+ * @param string|bool $module_type
1571
+ *
1572
+ * @return string
1573
+ */
1574
+ private function get_absolute_path( $path, $module_type = false ) {
1575
+ $module_root_dir = $this->get_module_root_dir_path( $module_type );
1576
+ if ( 0 !== strpos( $path, $module_root_dir ) ) {
1577
+ $path = fs_normalize_path( $module_root_dir . $path );
1578
+ }
1579
+
1580
+ return $path;
1581
+ }
1582
+
1583
+ /**
1584
+ * @author Leo Fajardo (@leorw)
1585
+ * @since 1.2.3
1586
+ *
1587
+ * @param string|bool $module_type
1588
+ *
1589
+ * @return string
1590
+ */
1591
+ private function get_module_root_dir_path( $module_type = false ) {
1592
+ $is_plugin = empty( $module_type ) ?
1593
+ $this->is_plugin() :
1594
+ ( WP_FS__MODULE_TYPE_PLUGIN === $module_type );
1595
+
1596
+ return fs_normalize_path( trailingslashit( $is_plugin ?
1597
+ WP_PLUGIN_DIR :
1598
+ get_theme_root() ) );
1599
+ }
1600
+
1601
+ /**
1602
+ * @author Leo Fajardo (@leorw)
1603
+ *
1604
+ * @param number $module_id
1605
+ * @param string $slug
1606
+ *
1607
+ * @since 1.2.2
1608
+ */
1609
+ private function store_id_slug_type_path_map( $module_id, $slug ) {
1610
+ $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map', array() );
1611
+
1612
+ $store_option = false;
1613
+
1614
+ if ( ! isset( $id_slug_type_path_map[ $module_id ] ) ) {
1615
+ $id_slug_type_path_map[ $module_id ] = array(
1616
+ 'slug' => $slug
1617
+ );
1618
+
1619
+ $store_option = true;
1620
+ }
1621
+
1622
+ if ( ! isset( $id_slug_type_path_map[ $module_id ]['path'] ) ||
1623
+ /**
1624
+ * This verification is for cases when suddenly the same module
1625
+ * is installed but with a different folder name.
1626
+ *
1627
+ * @author Vova Feldman (@svovaf)
1628
+ * @since 1.2.3
1629
+ */
1630
+ ! file_exists( $this->get_absolute_path(
1631
+ $id_slug_type_path_map[ $module_id ]['path'],
1632
+ $id_slug_type_path_map[ $module_id ]['type']
1633
+ ) )
1634
+ ) {
1635
+ $caller_main_file_and_type = $this->get_caller_main_file_and_type();
1636
+
1637
+ $id_slug_type_path_map[ $module_id ]['type'] = $caller_main_file_and_type->module_type;
1638
+ $id_slug_type_path_map[ $module_id ]['path'] = $caller_main_file_and_type->path;
1639
+
1640
+ $store_option = true;
1641
+ }
1642
+
1643
+ if ( $store_option ) {
1644
+ self::$_accounts->set_option( 'id_slug_type_path_map', $id_slug_type_path_map, true );
1645
+ }
1646
+ }
1647
+
1648
+ /**
1649
+ * Identifies the caller type: plugin or theme.
1650
+ *
1651
+ * @author Leo Fajardo (@leorw)
1652
+ * @since 1.2.2
1653
+ *
1654
+ * @author Vova Feldman (@svovaf)
1655
+ * @since 1.2.2.3 Find the earliest module in the call stack that calls to the SDK. This fix is for cases when
1656
+ * add-ons are relying on loading the SDK from the parent module, and also allows themes including the
1657
+ * SDK an internal file instead of directly from functions.php.
1658
+ * @since 1.2.1.7 Knows how to handle cases when an add-on includes the parent module logic.
1659
+ */
1660
+ private function get_caller_main_file_and_type() {
1661
+ self::require_plugin_essentials();
1662
+
1663
+ $all_plugins = get_plugins();
1664
+ $all_plugins_paths = array();
1665
+
1666
+ // Get active plugin's main files real full names (might be symlinks).
1667
+ foreach ( $all_plugins as $relative_path => &$data ) {
1668
+ if ( false === strpos( fs_normalize_path( $relative_path ), '/' ) ) {
1669
+ /**
1670
+ * Ignore plugins that don't have a folder (e.g. Hello Dolly) since they
1671
+ * can't really include the SDK.
1672
+ *
1673
+ * @author Vova Feldman
1674
+ * @since 1.2.1.7
1675
+ */
1676
+ continue;
1677
+ }
1678
+
1679
+ $all_plugins_paths[] = fs_normalize_path( realpath( WP_PLUGIN_DIR . '/' . $relative_path ) );
1680
+ }
1681
+
1682
+ $caller_file_candidate = false;
1683
+ $caller_map = array();
1684
+ $module_type = WP_FS__MODULE_TYPE_PLUGIN;
1685
+ $themes_dir = fs_normalize_path( get_theme_root() );
1686
+
1687
+ for ( $i = 1, $bt = debug_backtrace(), $len = count( $bt ); $i < $len; $i ++ ) {
1688
+ if ( empty( $bt[ $i ]['file'] ) ) {
1689
+ continue;
1690
+ }
1691
+
1692
+ if ( $i > 1 && ! empty( $bt[ $i - 1 ]['file'] ) && $bt[ $i ]['file'] === $bt[ $i - 1 ]['file'] ) {
1693
+ // If file same as the prev file in the stack, skip it.
1694
+ continue;
1695
+ }
1696
+
1697
+ if ( ! empty( $bt[ $i ]['function'] ) && in_array( $bt[ $i ]['function'], array(
1698
+ 'do_action',
1699
+ 'apply_filter',
1700
+ // The string split is stupid, but otherwise, theme check
1701
+ // throws info notices.
1702
+ 'requir' . 'e_once',
1703
+ 'requir' . 'e',
1704
+ 'includ' . 'e_once',
1705
+ 'includ' . 'e'
1706
+ ) )
1707
+ ) {
1708
+ // Ignore call stack hooks and files inclusion.
1709
+ continue;
1710
+ }
1711
+
1712
+ $caller_file_path = fs_normalize_path( $bt[ $i ]['file'] );
1713
+
1714
+ if ( 'functions.php' === basename( $caller_file_path ) ) {
1715
+ /**
1716
+ * 1. Assumes that theme's starting execution file is functions.php.
1717
+ * 2. This complex logic fixes symlink issues (e.g. with Vargant).
1718
+ *
1719
+ * @author Vova Feldman (@svovaf)
1720
+ * @since 1.2.2.5
1721
+ */
1722
+
1723
+ if ( $caller_file_path == fs_normalize_path( realpath( trailingslashit( $themes_dir ) . basename( dirname( $caller_file_path ) ) . '/' . basename( $caller_file_path ) ) ) ) {
1724
+ $module_type = WP_FS__MODULE_TYPE_THEME;
1725
+
1726
+ /**
1727
+ * Relative path of the theme, e.g.:
1728
+ * `my-theme/functions.php`
1729
+ *
1730
+ * @author Leo Fajardo (@leorw)
1731
+ */
1732
+ $caller_file_candidate = basename( dirname( $caller_file_path ) ) .
1733
+ '/' .
1734
+ basename( $caller_file_path );
1735
+
1736
+ continue;
1737
+ }
1738
+ }
1739
+
1740
+ $caller_file_hash = md5( $caller_file_path );
1741
+
1742
+ if ( ! isset( $caller_map[ $caller_file_hash ] ) ) {
1743
+ foreach ( $all_plugins_paths as $plugin_path ) {
1744
+ if ( false !== strpos( $caller_file_path, fs_normalize_path( dirname( $plugin_path ) . '/' ) ) ) {
1745
+ $caller_map[ $caller_file_hash ] = fs_normalize_path( $plugin_path );
1746
+ break;
1747
+ }
1748
+ }
1749
+ }
1750
+
1751
+ if ( isset( $caller_map[ $caller_file_hash ] ) ) {
1752
+ $module_type = WP_FS__MODULE_TYPE_PLUGIN;
1753
+ $caller_file_candidate = plugin_basename( $caller_map[ $caller_file_hash ] );
1754
+ }
1755
+ }
1756
+
1757
+ return (object) array(
1758
+ 'module_type' => $module_type,
1759
+ 'path' => $caller_file_candidate
1760
+ );
1761
+ }
1762
+
1763
+ #----------------------------------------------------------------------------------
1764
+ #region Deactivation Feedback Form
1765
+ #----------------------------------------------------------------------------------
1766
+
1767
+ /**
1768
+ * Displays a confirmation and feedback dialog box when the user clicks on the "Deactivate" link on the plugins
1769
+ * page.
1770
+ *
1771
+ * @author Vova Feldman (@svovaf)
1772
+ * @author Leo Fajardo (@leorw)
1773
+ * @since 1.1.2
1774
+ */
1775
+ function _add_deactivation_feedback_dialog_box() {
1776
+ /* Check the type of user:
1777
+ * 1. Long-term (long-term)
1778
+ * 2. Non-registered and non-anonymous short-term (non-registered-and-non-anonymous-short-term).
1779
+ * 3. Short-term (short-term)
1780
+ */
1781
+ $is_long_term_user = true;
1782
+
1783
+ // Check if the site is at least 2 days old.
1784
+ $time_installed = $this->_storage->install_timestamp;
1785
+
1786
+ // Difference in seconds.
1787
+ $date_diff = time() - $time_installed;
1788
+
1789
+ // Convert seconds to days.
1790
+ $date_diff_days = floor( $date_diff / ( 60 * 60 * 24 ) );
1791
+
1792
+ if ( $date_diff_days < 2 ) {
1793
+ $is_long_term_user = false;
1794
+ }
1795
+
1796
+ $is_long_term_user = $this->apply_filters( 'is_long_term_user', $is_long_term_user );
1797
+
1798
+ if ( $is_long_term_user ) {
1799
+ $user_type = 'long-term';
1800
+ } else {
1801
+ if ( ! $this->is_registered() && ! $this->is_anonymous() ) {
1802
+ $user_type = 'non-registered-and-non-anonymous-short-term';
1803
+ } else {
1804
+ $user_type = 'short-term';
1805
+ }
1806
+ }
1807
+
1808
+ $uninstall_reasons = $this->_get_uninstall_reasons( $user_type );
1809
+
1810
+ // Load the HTML template for the deactivation feedback dialog box.
1811
+ $vars = array(
1812
+ 'reasons' => $uninstall_reasons,
1813
+ 'id' => $this->_module_id
1814
+ );
1815
+
1816
+ /**
1817
+ * @todo Deactivation form core functions should be loaded only once! Otherwise, when there are multiple Freemius powered plugins the same code is loaded multiple times. The only thing that should be loaded differently is the various deactivation reasons object based on the state of the plugin.
1818
+ */
1819
+ fs_require_template( 'forms/deactivation/form.php', $vars );
1820
+ }
1821
+
1822
+ /**
1823
+ * @author Leo Fajardo (@leorw)
1824
+ * @since 1.1.2
1825
+ *
1826
+ * @param string $user_type
1827
+ *
1828
+ * @return array The uninstall reasons for the specified user type.
1829
+ */
1830
+ function _get_uninstall_reasons( $user_type = 'long-term' ) {
1831
+ $module_type = $this->_module_type;
1832
+
1833
+ $internal_message_template_var = array(
1834
+ 'id' => $this->_module_id
1835
+ );
1836
+
1837
+ $plan = $this->get_plan();
1838
+
1839
+ if ( $this->is_registered() && is_object( $plan ) && $plan->has_technical_support() ) {
1840
+ $contact_support_template = fs_get_template( 'forms/deactivation/contact.php', $internal_message_template_var );
1841
+ } else {
1842
+ $contact_support_template = '';
1843
+ }
1844
+
1845
+ $reason_found_better_plugin = array(
1846
+ 'id' => self::REASON_FOUND_A_BETTER_PLUGIN,
1847
+ 'text' => sprintf( $this->get_text_inline( 'I found a better %s', 'reason-found-a-better-plugin' ), $module_type ),
1848
+ 'input_type' => 'textfield',
1849
+ 'input_placeholder' => sprintf( $this->get_text_inline( "What's the %s's name?", 'placeholder-plugin-name' ), $module_type ),
1850
+ );
1851
+
1852
+ $reason_temporary_deactivation = array(
1853
+ 'id' => self::REASON_TEMPORARY_DEACTIVATION,
1854
+ 'text' => sprintf(
1855
+ $this->get_text_inline( "It's a temporary %s. I'm just debugging an issue.", 'reason-temporary-x' ),
1856
+ strtolower( $this->is_plugin() ?
1857
+ $this->get_text_inline( 'Deactivation', 'deactivation' ) :
1858
+ $this->get_text_inline( 'Theme Switch', 'theme-switch' )
1859
+ )
1860
+ ),
1861
+ 'input_type' => '',
1862
+ 'input_placeholder' => ''
1863
+ );
1864
+
1865
+ $reason_other = array(
1866
+ 'id' => self::REASON_OTHER,
1867
+ 'text' => $this->get_text_inline( 'Other', 'reason-other' ),
1868
+ 'input_type' => 'textfield',
1869
+ 'input_placeholder' => ''
1870
+ );
1871
+
1872
+ $long_term_user_reasons = array(
1873
+ array(
1874
+ 'id' => self::REASON_NO_LONGER_NEEDED,
1875
+ 'text' => sprintf( $this->get_text_inline( 'I no longer need the %s', 'reason-no-longer-needed' ), $module_type ),
1876
+ 'input_type' => '',
1877
+ 'input_placeholder' => ''
1878
+ ),
1879
+ $reason_found_better_plugin,
1880
+ array(
1881
+ 'id' => self::REASON_NEEDED_FOR_A_SHORT_PERIOD,
1882
+ 'text' => sprintf( $this->get_text_inline( 'I only needed the %s for a short period', 'reason-needed-for-a-short-period' ), $module_type ),
1883
+ 'input_type' => '',
1884
+ 'input_placeholder' => ''
1885
+ ),
1886
+ array(
1887
+ 'id' => self::REASON_BROKE_MY_SITE,
1888
+ 'text' => sprintf( $this->get_text_inline( 'The %s broke my site', 'reason-broke-my-site' ), $module_type ),
1889
+ 'input_type' => '',
1890
+ 'input_placeholder' => '',
1891
+ 'internal_message' => $contact_support_template
1892
+ ),
1893
+ array(
1894
+ 'id' => self::REASON_SUDDENLY_STOPPED_WORKING,
1895
+ 'text' => sprintf( $this->get_text_inline( 'The %s suddenly stopped working', 'reason-suddenly-stopped-working' ), $module_type ),
1896
+ 'input_type' => '',
1897
+ 'input_placeholder' => '',
1898
+ 'internal_message' => $contact_support_template
1899
+ )
1900
+ );
1901
+
1902
+ if ( $this->is_paying() ) {
1903
+ $long_term_user_reasons[] = array(
1904
+ 'id' => self::REASON_CANT_PAY_ANYMORE,
1905
+ 'text' => $this->get_text_inline( "I can't pay for it anymore", 'reason-cant-pay-anymore' ),
1906
+ 'input_type' => 'textfield',
1907
+ 'input_placeholder' => $this->get_text_inline( 'What price would you feel comfortable paying?', 'placeholder-comfortable-price' )
1908
+ );
1909
+ }
1910
+
1911
+ $reason_dont_share_info = array(
1912
+ 'id' => self::REASON_DONT_LIKE_TO_SHARE_MY_INFORMATION,
1913
+ 'text' => $this->get_text_inline( "I don't like to share my information with you", 'reason-dont-like-to-share-my-information' ),
1914
+ 'input_type' => '',
1915
+ 'input_placeholder' => ''
1916
+ );
1917
+
1918
+ /**
1919
+ * If the current user has selected the "don't share data" reason in the deactivation feedback modal, inform the
1920
+ * user by showing additional message that he doesn't have to share data and can just choose to skip the opt-in
1921
+ * (the Skip button is included in the message to show). This message will only be shown if anonymous mode is
1922
+ * enabled and the user's account is currently not in pending activation state (similar to the way the Skip
1923
+ * button in the opt-in form is shown/hidden).
1924
+ */
1925
+ if ( $this->is_enable_anonymous() && ! $this->is_pending_activation() ) {
1926
+ $reason_dont_share_info['internal_message'] = fs_get_template( 'forms/deactivation/retry-skip.php', $internal_message_template_var );
1927
+ }
1928
+
1929
+ $uninstall_reasons = array(
1930
+ 'long-term' => $long_term_user_reasons,
1931
+ 'non-registered-and-non-anonymous-short-term' => array(
1932
+ array(
1933
+ 'id' => self::REASON_DIDNT_WORK,
1934
+ 'text' => sprintf( $this->get_text_inline( "The %s didn't work", 'reason-didnt-work' ), $module_type ),
1935
+ 'input_type' => '',
1936
+ 'input_placeholder' => ''
1937
+ ),
1938
+ $reason_dont_share_info,
1939
+ $reason_found_better_plugin
1940
+ ),
1941
+ 'short-term' => array(
1942
+ array(
1943
+ 'id' => self::REASON_COULDNT_MAKE_IT_WORK,
1944
+ 'text' => $this->get_text_inline( "I couldn't understand how to make it work", 'reason-couldnt-make-it-work' ),
1945
+ 'input_type' => '',
1946
+ 'input_placeholder' => '',
1947
+ 'internal_message' => $contact_support_template
1948
+ ),
1949
+ $reason_found_better_plugin,
1950
+ array(
1951
+ 'id' => self::REASON_GREAT_BUT_NEED_SPECIFIC_FEATURE,
1952
+ 'text' => sprintf( $this->get_text_inline( "The %s is great, but I need specific feature that you don't support", 'reason-great-but-need-specific-feature' ), $module_type ),
1953
+ 'input_type' => 'textarea',
1954
+ 'input_placeholder' => $this->get_text_inline( 'What feature?', 'placeholder-feature' )
1955
+ ),
1956
+ array(
1957
+ 'id' => self::REASON_NOT_WORKING,
1958
+ 'text' => sprintf( $this->get_text_inline( 'The %s is not working', 'reason-not-working' ), $module_type ),
1959
+ 'input_type' => 'textarea',
1960
+ 'input_placeholder' => $this->get_text_inline( "Kindly share what didn't work so we can fix it for future users...", 'placeholder-share-what-didnt-work' )
1961
+ ),
1962
+ array(
1963
+ 'id' => self::REASON_NOT_WHAT_I_WAS_LOOKING_FOR,
1964
+ 'text' => $this->get_text_inline( "It's not what I was looking for", 'reason-not-what-i-was-looking-for' ),
1965
+ 'input_type' => 'textarea',
1966
+ 'input_placeholder' => $this->get_text_inline( "What you've been looking for?", 'placeholder-what-youve-been-looking-for' )
1967
+ ),
1968
+ array(
1969
+ 'id' => self::REASON_DIDNT_WORK_AS_EXPECTED,
1970
+ 'text' => sprintf( $this->get_text_inline( "The %s didn't work as expected", 'reason-didnt-work-as-expected' ), $module_type ),
1971
+ 'input_type' => 'textarea',
1972
+ 'input_placeholder' => $this->get_text_inline( 'What did you expect?', 'placeholder-what-did-you-expect' )
1973
+ )
1974
+ )
1975
+ );
1976
+
1977
+ // Randomize the reasons for the current user type.
1978
+ shuffle( $uninstall_reasons[ $user_type ] );
1979
+
1980
+ // Keep the following reasons as the last items in the list.
1981
+ $uninstall_reasons[ $user_type ][] = $reason_temporary_deactivation;
1982
+ $uninstall_reasons[ $user_type ][] = $reason_other;
1983
+
1984
+ $uninstall_reasons = $this->apply_filters( 'uninstall_reasons', $uninstall_reasons );
1985
+
1986
+ return $uninstall_reasons[ $user_type ];
1987
+ }
1988
+
1989
+ /**
1990
+ * Called after the user has submitted his reason for deactivating the plugin.
1991
+ *
1992
+ * @author Leo Fajardo (@leorw)
1993
+ * @since 1.1.2
1994
+ */
1995
+ function _submit_uninstall_reason_action() {
1996
+ $this->_logger->entrance();
1997
+
1998
+ $this->check_ajax_referer( 'submit_uninstall_reason' );
1999
+
2000
+ $reason_id = fs_request_get( 'reason_id' );
2001
+
2002
+ // Check if the given reason ID is an unsigned integer.
2003
+ if ( ! ctype_digit( $reason_id ) ) {
2004
+ exit;
2005
+ }
2006
+
2007
+ $reason_info = trim( fs_request_get( 'reason_info', '' ) );
2008
+ if ( ! empty( $reason_info ) ) {
2009
+ $reason_info = substr( $reason_info, 0, 128 );
2010
+ }
2011
+
2012
+ $reason = (object) array(
2013
+ 'id' => $reason_id,
2014
+ 'info' => $reason_info,
2015
+ 'is_anonymous' => fs_request_get_bool( 'is_anonymous' )
2016
+ );
2017
+
2018
+ $this->_storage->store( 'uninstall_reason', $reason );
2019
+
2020
+ /**
2021
+ * If the module type is "theme", trigger the uninstall event here (on theme deactivation) since themes do
2022
+ * not support uninstall hook.
2023
+ *
2024
+ * @author Leo Fajardo (@leorw)
2025
+ * @since 1.2.2
2026
+ */
2027
+ if ( $this->is_theme() ) {
2028
+ $this->_uninstall_plugin_event( false );
2029
+ $this->remove_sdk_reference();
2030
+ }
2031
+
2032
+ // Print '1' for successful operation.
2033
+ echo 1;
2034
+ exit;
2035
+ }
2036
+
2037
+ #endregion
2038
+
2039
+ #----------------------------------------------------------------------------------
2040
+ #region Instance
2041
+ #----------------------------------------------------------------------------------
2042
+
2043
+ /**
2044
+ * Main singleton instance.
2045
+ *
2046
+ * @author Vova Feldman (@svovaf)
2047
+ * @since 1.0.0
2048
+ *
2049
+ * @param number $module_id
2050
+ * @param string|bool $slug
2051
+ * @param bool $is_init Is initiation sequence.
2052
+ *
2053
+ * @return Freemius|false
2054
+ */
2055
+ static function instance( $module_id, $slug = false, $is_init = false ) {
2056
+ if ( empty( $module_id ) ) {
2057
+ return false;
2058
+ }
2059
+
2060
+ /**
2061
+ * Load the essential static data prior to initiating FS_Plugin_Manager since there's an essential MS network migration logic that needs to be executed prior to the initiation.
2062
+ */
2063
+ self::_load_required_static();
2064
+
2065
+ if ( ! is_numeric( $module_id ) ) {
2066
+ if ( ! $is_init && true === $slug ) {
2067
+ $is_init = true;
2068
+ }
2069
+
2070
+ $slug = $module_id;
2071
+
2072
+ $module = FS_Plugin_Manager::instance( $slug )->get();
2073
+
2074
+ if ( is_object( $module ) ) {
2075
+ $module_id = $module->id;
2076
+ }
2077
+ }
2078
+
2079
+ $key = 'm_' . $module_id;
2080
+
2081
+ if ( ! isset( self::$_instances[ $key ] ) ) {
2082
+ self::$_instances[ $key ] = new Freemius( $module_id, $slug, $is_init );
2083
+ }
2084
+
2085
+ return self::$_instances[ $key ];
2086
+ }
2087
+
2088
+ /**
2089
+ * @author Vova Feldman (@svovaf)
2090
+ * @since 1.0.6
2091
+ *
2092
+ * @param number $addon_id
2093
+ *
2094
+ * @return bool
2095
+ */
2096
+ private static function has_instance( $addon_id ) {
2097
+ return isset( self::$_instances[ 'm_' . $addon_id ] );
2098
+ }
2099
+
2100
+ /**
2101
+ * @author Leo Fajardo (@leorw)
2102
+ * @since 1.2.2
2103
+ *
2104
+ * @param string|number $id_or_slug
2105
+ *
2106
+ * @return number|false
2107
+ */
2108
+ private static function get_module_id( $id_or_slug ) {
2109
+ if ( is_numeric( $id_or_slug ) ) {
2110
+ return $id_or_slug;
2111
+ }
2112
+
2113
+ foreach ( self::$_instances as $instance ) {
2114
+ if ( $instance->is_plugin() && ( $id_or_slug === $instance->get_slug() ) ) {
2115
+ return $instance->get_id();
2116
+ }
2117
+ }
2118
+
2119
+ return false;
2120
+ }
2121
+
2122
+ /**
2123
+ * @author Vova Feldman (@svovaf)
2124
+ * @since 1.0.6
2125
+ *
2126
+ * @param number $id
2127
+ *
2128
+ * @return false|Freemius
2129
+ */
2130
+ static function get_instance_by_id( $id ) {
2131
+ return isset ( self::$_instances[ 'm_' . $id ] ) ?
2132
+ self::$_instances[ 'm_' . $id ] :
2133
+ false;
2134
+ }
2135
+
2136
+ /**
2137
+ *
2138
+ * @author Vova Feldman (@svovaf)
2139
+ * @since 1.0.1
2140
+ *
2141
+ * @param $plugin_file
2142
+ *
2143
+ * @return false|Freemius
2144
+ */
2145
+ static function get_instance_by_file( $plugin_file ) {
2146
+ $slug = self::find_slug_by_basename( $plugin_file );
2147
+
2148
+ return ( false !== $slug ) ?
2149
+ self::instance( self::get_module_id( $slug ) ) :
2150
+ false;
2151
+ }
2152
+
2153
+ /**
2154
+ * @author Vova Feldman (@svovaf)
2155
+ * @since 1.0.6
2156
+ *
2157
+ * @return false|Freemius
2158
+ */
2159
+ function get_parent_instance() {
2160
+ return self::get_instance_by_id( $this->_plugin->parent_plugin_id );
2161
+ }
2162
+
2163
+ /**
2164
+ * @author Vova Feldman (@svovaf)
2165
+ * @since 1.0.6
2166
+ *
2167
+ * @param string|number $id_or_slug
2168
+ *
2169
+ * @return false|Freemius
2170
+ */
2171
+ function get_addon_instance( $id_or_slug ) {
2172
+ $addon_id = self::get_module_id( $id_or_slug );
2173
+
2174
+ return self::instance( $addon_id );
2175
+ }
2176
+
2177
+ #endregion ------------------------------------------------------------------
2178
+
2179
+ /**
2180
+ * @author Vova Feldman (@svovaf)
2181
+ * @since 1.0.6
2182
+ *
2183
+ * @return bool
2184
+ */
2185
+ function is_parent_plugin_installed() {
2186
+ $is_active = self::has_instance( $this->_plugin->parent_plugin_id );
2187
+
2188
+ if ( $is_active ) {
2189
+ return true;
2190
+ }
2191
+
2192
+ /**
2193
+ * Parent module might be a theme. If that's the case, the add-on's FS
2194
+ * instance will be loaded prior to the theme's FS instance, therefore,
2195
+ * we need to check if it's active with a "look ahead".
2196
+ *
2197
+ * @author Vova Feldman
2198
+ * @since 1.2.2.3
2199
+ */
2200
+ global $fs_active_plugins;
2201
+ if ( is_object( $fs_active_plugins ) && is_array( $fs_active_plugins->plugins ) ) {
2202
+ $active_theme = wp_get_theme();
2203
+
2204
+ foreach ( $fs_active_plugins->plugins as $sdk => $module ) {
2205
+ if ( WP_FS__MODULE_TYPE_THEME === $module->type ) {
2206
+ if ( $module->plugin_path == $active_theme->get_stylesheet() ) {
2207
+ // Parent module is a theme and it's currently active.
2208
+ return true;
2209
+ }
2210
+ }
2211
+ }
2212
+ }
2213
+
2214
+ return false;
2215
+ }
2216
+
2217
+ /**
2218
+ * Check if add-on parent plugin in activation mode.
2219
+ *
2220
+ * @author Vova Feldman (@svovaf)
2221
+ * @since 1.0.7
2222
+ *
2223
+ * @return bool
2224
+ */
2225
+ function is_parent_in_activation() {
2226
+ $parent_fs = $this->get_parent_instance();
2227
+ if ( ! is_object( $parent_fs ) ) {
2228
+ return false;
2229
+ }
2230
+
2231
+ return ( $parent_fs->is_activation_mode() );
2232
+ }
2233
+
2234
+ /**
2235
+ * Is plugin in activation mode.
2236
+ *
2237
+ * @author Vova Feldman (@svovaf)
2238
+ * @since 1.0.7
2239
+ *
2240
+ * @param bool $and_on
2241
+ *
2242
+ * @return bool
2243
+ */
2244
+ function is_activation_mode( $and_on = true ) {
2245
+ return fs_is_network_admin() ?
2246
+ $this->is_network_activation_mode( $and_on ) :
2247
+ $this->is_site_activation_mode( $and_on );
2248
+ }
2249
+
2250
+ /**
2251
+ * Is plugin in activation mode.
2252
+ *
2253
+ * @author Vova Feldman (@svovaf)
2254
+ * @since 1.0.7
2255
+ *
2256
+ * @param bool $and_on
2257
+ *
2258
+ * @return bool
2259
+ */
2260
+ function is_site_activation_mode( $and_on = true ) {
2261
+ return (
2262
+ ( $this->is_on() || ! $and_on ) &&
2263
+ ( ! $this->is_registered() ||
2264
+ ( $this->is_only_premium() && ! $this->has_features_enabled_license() ) ) &&
2265
+ ( ! $this->is_enable_anonymous() ||
2266
+ ( ! $this->is_anonymous() && ! $this->is_pending_activation() ) )
2267
+ );
2268
+ }
2269
+
2270
+ /**
2271
+ * Checks if the SDK in network activation mode.
2272
+ *
2273
+ * @author Leo Fajardo (@leorw)
2274
+ * @since 2.0.0
2275
+ *
2276
+ * @param bool $and_on
2277
+ *
2278
+ * @return bool
2279
+ */
2280
+ private function is_network_activation_mode( $and_on = true ) {
2281
+ if ( ! $this->_is_network_active ) {
2282
+ // Not network activated.
2283
+ return false;
2284
+ }
2285
+
2286
+ if ( $this->is_network_upgrade_mode() ) {
2287
+ // Special flag to enforce network activation mode to decide what to do with the sites that are not yet opted-in nor skipped.
2288
+ return true;
2289
+ }
2290
+
2291
+ if ( ! $this->is_site_activation_mode( $and_on ) ) {
2292
+ // Whether the context is single site or the network, if the plugin is no longer in activation mode then it is not in network activation mode as well.
2293
+ return false;
2294
+ }
2295
+
2296
+ if ( $this->is_network_delegated_connection() ) {
2297
+ // Super-admin delegated the connection to the site admins -> not activation mode.
2298
+ return false;
2299
+ }
2300
+
2301
+ if ( $this->is_network_anonymous() ) {
2302
+ // Super-admin skipped the connection network wide -> not activation mode.
2303
+ return false;
2304
+ }
2305
+
2306
+ if ( $this->is_network_registered() ) {
2307
+ // Super-admin connected at least one site -> not activation mode.
2308
+ return false;
2309
+ }
2310
+
2311
+ return true;
2312
+ }
2313
+
2314
+ /**
2315
+ * Check if current page is the opt-in/pending-activation page.
2316
+ *
2317
+ * @author Vova Feldman (@svovaf)
2318
+ * @since 1.2.1.7
2319
+ *
2320
+ * @return bool
2321
+ */
2322
+ function is_activation_page() {
2323
+ if ( $this->_menu->is_main_settings_page() ) {
2324
+ return true;
2325
+ }
2326
+
2327
+ if ( ! $this->is_activation_mode() ) {
2328
+ return false;
2329
+ }
2330
+
2331
+ // Check if current page is matching the activation page.
2332
+ return $this->is_matching_url( $this->get_activation_url() );
2333
+ }
2334
+
2335
+ /**
2336
+ * Check if URL path's are matching and that all querystring
2337
+ * arguments of the $sub_url exist in the $url with the same values.
2338
+ *
2339
+ * WARNING:
2340
+ * 1. This method doesn't check if the sub/domain are matching.
2341
+ * 2. Ignore case sensitivity.
2342
+ *
2343
+ * @author Vova Feldman (@svovaf)
2344
+ * @since 1.2.1.7
2345
+ *
2346
+ * @param string $sub_url
2347
+ * @param string $url If argument is not set, check if the sub_url matching the current's page URL.
2348
+ *
2349
+ * @return bool
2350
+ */
2351
+ private function is_matching_url( $sub_url, $url = '' ) {
2352
+ if ( empty( $url ) ) {
2353
+ $url = $_SERVER['REQUEST_URI'];
2354
+ }
2355
+
2356
+ $url = strtolower( $url );
2357
+ $sub_url = strtolower( $sub_url );
2358
+
2359
+ if ( parse_url( $sub_url, PHP_URL_PATH ) !== parse_url( $url, PHP_URL_PATH ) ) {
2360
+ // Different path - DO NOT OVERRIDE PAGE.
2361
+ return false;
2362
+ }
2363
+
2364
+ $url_params = array();
2365
+ parse_str( parse_url( $url, PHP_URL_QUERY ), $url_params );
2366
+
2367
+ $sub_url_params = array();
2368
+ parse_str( parse_url( $sub_url, PHP_URL_QUERY ), $sub_url_params );
2369
+
2370
+ foreach ( $sub_url_params as $key => $val ) {
2371
+ if ( ! isset( $url_params[ $key ] ) || $val != $url_params[ $key ] ) {
2372
+ // Not matching query string - DO NOT OVERRIDE PAGE.
2373
+ return false;
2374
+ }
2375
+ }
2376
+
2377
+ return true;
2378
+ }
2379
+
2380
+ /**
2381
+ * Get the basenames of all active plugins for specific blog. Including network activated plugins.
2382
+ *
2383
+ * @author Vova Feldman (@svovaf)
2384
+ * @since 2.0.0
2385
+ *
2386
+ * @param int $blog_id
2387
+ *
2388
+ * @return string[]
2389
+ */
2390
+ private static function get_active_plugins_basenames( $blog_id = 0 ) {
2391
+ if ( is_multisite() && $blog_id > 0 ) {
2392
+ $active_basenames = get_blog_option( $blog_id, 'active_plugins' );
2393
+ } else {
2394
+ $active_basenames = get_option( 'active_plugins' );
2395
+ }
2396
+
2397
+ if ( is_multisite() ) {
2398
+ $network_active_basenames = get_site_option( 'active_sitewide_plugins' );
2399
+
2400
+ if ( is_array( $network_active_basenames ) && ! empty( $network_active_basenames ) ) {
2401
+ $active_basenames = array_merge( $active_basenames, $network_active_basenames );
2402
+ }
2403
+ }
2404
+
2405
+ return $active_basenames;
2406
+ }
2407
+
2408
+ /**
2409
+ * Get collection of all active plugins. Including network activated plugins.
2410
+ *
2411
+ * @author Vova Feldman (@svovaf)
2412
+ * @since 1.0.9
2413
+ *
2414
+ * @param int $blog_id Since 2.0.0
2415
+ *
2416
+ * @return array[string]array
2417
+ */
2418
+ private static function get_active_plugins( $blog_id = 0 ) {
2419
+ self::require_plugin_essentials();
2420
+
2421
+ $active_plugin = array();
2422
+ $all_plugins = get_plugins();
2423
+ $active_plugins_basenames = self::get_active_plugins_basenames( $blog_id );
2424
+
2425
+ foreach ( $active_plugins_basenames as $plugin_basename ) {
2426
+ $active_plugin[ $plugin_basename ] = $all_plugins[ $plugin_basename ];
2427
+ }
2428
+
2429
+ return $active_plugin;
2430
+ }
2431
+
2432
+ /**
2433
+ * Get collection of all site active plugins for a specified blog.
2434
+ *
2435
+ * @author Vova Feldman (@svovaf)
2436
+ * @since 2.0.0
2437
+ *
2438
+ * @param int $blog_id
2439
+ *
2440
+ * @return array[string]array
2441
+ */
2442
+ private static function get_site_active_plugins( $blog_id = 0 ) {
2443
+ $active_basenames = ( is_multisite() && $blog_id > 0 ) ?
2444
+ get_blog_option( $blog_id, 'active_plugins' ) :
2445
+ get_option( 'active_plugins' );
2446
+
2447
+ $active = array();
2448
+ foreach ( $active_basenames as $basename ) {
2449
+ $active[ $basename ] = array(
2450
+ 'is_active' => true,
2451
+ 'Version' => '1.0', // Dummy version.
2452
+ 'slug' => self::get_plugin_slug( $basename ),
2453
+ );
2454
+ }
2455
+
2456
+ return $active;
2457
+ }
2458
+
2459
+ /**
2460
+ * Get collection of all plugins with their activation status for a specified blog.
2461
+ *
2462
+ * @author Vova Feldman (@svovaf)
2463
+ * @since 1.1.8
2464
+ *
2465
+ * @param int $blog_id Since 2.0.0
2466
+ *
2467
+ * @return array Key is the plugin file path and the value is an array of the plugin data.
2468
+ */
2469
+ private static function get_all_plugins( $blog_id = 0 ) {
2470
+ self::require_plugin_essentials();
2471
+
2472
+ $all_plugins = get_plugins();
2473
+
2474
+ $active_plugins_basenames = self::get_active_plugins_basenames( $blog_id );
2475
+
2476
+ foreach ( $all_plugins as $basename => &$data ) {
2477
+ // By default set to inactive (next foreach update the active plugins).
2478
+ $data['is_active'] = false;
2479
+ // Enrich with plugin slug.
2480
+ $data['slug'] = self::get_plugin_slug( $basename );
2481
+ }
2482
+
2483
+ // Flag active plugins.
2484
+ foreach ( $active_plugins_basenames as $basename ) {
2485
+ if ( isset( $all_plugins[ $basename ] ) ) {
2486
+ $all_plugins[ $basename ]['is_active'] = true;
2487
+ }
2488
+ }
2489
+
2490
+ return $all_plugins;
2491
+ }
2492
+
2493
+ /**
2494
+ * Get collection of all plugins and if they are network level activated.
2495
+ *
2496
+ * @author Vova Feldman (@svovaf)
2497
+ * @since 2.0.0
2498
+ *
2499
+ * @return array Key is the plugin basename and the value is an array of the plugin data.
2500
+ */
2501
+ private static function get_network_plugins() {
2502
+ self::require_plugin_essentials();
2503
+
2504
+ $all_plugins = get_plugins();
2505
+
2506
+ $network_active_basenames = is_multisite() ?
2507
+ get_site_option( 'active_sitewide_plugins' ) :
2508
+ array();
2509
+
2510
+ foreach ( $all_plugins as $basename => &$data ) {
2511
+ // By default set to inactive (next foreach update the active plugins).
2512
+ $data['is_active'] = false;
2513
+ // Enrich with plugin slug.
2514
+ $data['slug'] = self::get_plugin_slug( $basename );
2515
+ }
2516
+
2517
+ // Flag active plugins.
2518
+ foreach ( $network_active_basenames as $basename ) {
2519
+ if ( isset( $all_plugins[ $basename ] ) ) {
2520
+ $all_plugins[ $basename ]['is_active'] = true;
2521
+ }
2522
+ }
2523
+
2524
+ return $all_plugins;
2525
+ }
2526
+
2527
+ /**
2528
+ * Cached result of get_site_transient( 'update_plugins' )
2529
+ *
2530
+ * @author Vova Feldman (@svovaf)
2531
+ * @since 1.1.8
2532
+ *
2533
+ * @var object
2534
+ */
2535
+ private static $_plugins_info;
2536
+
2537
+ /**
2538
+ * Helper function to get specified plugin's slug.
2539
+ *
2540
+ * @author Vova Feldman (@svovaf)
2541
+ * @since 1.1.8
2542
+ *
2543
+ * @param $basename
2544
+ *
2545
+ * @return string
2546
+ */
2547
+ private static function get_plugin_slug( $basename ) {
2548
+ if ( ! isset( self::$_plugins_info ) ) {
2549
+ self::$_plugins_info = get_site_transient( 'update_plugins' );
2550
+ }
2551
+
2552
+ $slug = '';
2553
+
2554
+ if ( is_object( self::$_plugins_info ) ) {
2555
+ if ( isset( self::$_plugins_info->no_update ) &&
2556
+ isset( self::$_plugins_info->no_update[ $basename ] ) &&
2557
+ ! empty( self::$_plugins_info->no_update[ $basename ]->slug )
2558
+ ) {
2559
+ $slug = self::$_plugins_info->no_update[ $basename ]->slug;
2560
+ } else if ( isset( self::$_plugins_info->response ) &&
2561
+ isset( self::$_plugins_info->response[ $basename ] ) &&
2562
+ ! empty( self::$_plugins_info->response[ $basename ]->slug )
2563
+ ) {
2564
+ $slug = self::$_plugins_info->response[ $basename ]->slug;
2565
+ }
2566
+ }
2567
+
2568
+ if ( empty( $slug ) ) {
2569
+ // Try to find slug from FS data.
2570
+ $slug = self::find_slug_by_basename( $basename );
2571
+ }
2572
+
2573
+ if ( empty( $slug ) ) {
2574
+ // Fallback to plugin's folder name.
2575
+ $slug = dirname( $basename );
2576
+ }
2577
+
2578
+ return $slug;
2579
+ }
2580
+
2581
+ private static $_statics_loaded = false;
2582
+
2583
+ /**
2584
+ * Load static resources.
2585
+ *
2586
+ * @author Vova Feldman (@svovaf)
2587
+ * @since 1.0.1
2588
+ */
2589
+ private static function _load_required_static() {
2590
+ if ( self::$_statics_loaded ) {
2591
+ return;
2592
+ }
2593
+
2594
+ self::$_static_logger = FS_Logger::get_logger( WP_FS__SLUG, WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );
2595
+
2596
+ self::$_static_logger->entrance();
2597
+
2598
+ self::$_accounts = FS_Options::instance( WP_FS__ACCOUNTS_OPTION_NAME, true );
2599
+
2600
+ if ( is_multisite() ) {
2601
+ /**
2602
+ * If the id_slug_type_path_map exists on the site level but doesn't exist on the
2603
+ * network level storage, it means that we need to process the storage with migration.
2604
+ *
2605
+ * The code in this `if` scope will only be executed once and only for the first site that will execute it because once we migrate the storage data, id_slug_type_path_map will be already set in the network level storage.
2606
+ *
2607
+ * @author Vova Feldman (@svovaf)
2608
+ * @since 2.0.0
2609
+ */
2610
+ if ( null === self::$_accounts->get_option( 'id_slug_type_path_map', null, true ) &&
2611
+ null !== self::$_accounts->get_option( 'id_slug_type_path_map', null, false )
2612
+ ) {
2613
+ self::migrate_accounts_to_network();
2614
+
2615
+ // Migrate API options from site level to network level.
2616
+ $api_network_options = FS_Option_Manager::get_manager( WP_FS__OPTIONS_OPTION_NAME, true, true );
2617
+ $api_network_options->migrate_to_network();
2618
+
2619
+ // Migrate API cache to network level storage.
2620
+ FS_Cache_Manager::get_manager( WP_FS__API_CACHE_OPTION_NAME )->migrate_to_network();
2621
+ }
2622
+ }
2623
+
2624
+ self::$_global_admin_notices = FS_Admin_Notices::instance( 'global' );
2625
+
2626
+ add_action( ( fs_is_network_admin() ? 'network_' : '' ) . 'admin_menu', array(
2627
+ 'Freemius',
2628
+ '_add_debug_section'
2629
+ ) );
2630
+
2631
+ add_action( "wp_ajax_fs_toggle_debug_mode", array( 'Freemius', '_toggle_debug_mode' ) );
2632
+
2633
+ self::add_ajax_action_static( 'get_debug_log', array( 'Freemius', '_get_debug_log' ) );
2634
+
2635
+ self::add_ajax_action_static( 'get_db_option', array( 'Freemius', '_get_db_option' ) );
2636
+
2637
+ self::add_ajax_action_static( 'set_db_option', array( 'Freemius', '_set_db_option' ) );
2638
+
2639
+ if ( 0 == did_action( 'plugins_loaded' ) ) {
2640
+ add_action( 'plugins_loaded', array( 'Freemius', '_load_textdomain' ), 1 );
2641
+ }
2642
+
2643
+ add_action( 'admin_footer', array( 'Freemius', '_enrich_ajax_url' ) );
2644
+
2645
+ self::$_statics_loaded = true;
2646
+ }
2647
+
2648
+ #----------------------------------------------------------------------------------
2649
+ #region Localization
2650
+ #----------------------------------------------------------------------------------
2651
+
2652
+ /**
2653
+ * Load framework's text domain.
2654
+ *
2655
+ * @author Vova Feldman (@svovaf)
2656
+ * @since 1.2.1
2657
+ */
2658
+ static function _load_textdomain() {
2659
+ if ( ! is_admin() ) {
2660
+ return;
2661
+ }
2662
+
2663
+ global $fs_active_plugins;
2664
+
2665
+ // Works both for plugins and themes.
2666
+ load_plugin_textdomain(
2667
+ 'freemius',
2668
+ false,
2669
+ $fs_active_plugins->newest->sdk_path . '/languages/'
2670
+ );
2671
+ }
2672
+
2673
+ #endregion
2674
+
2675
+ #----------------------------------------------------------------------------------
2676
+ #region Debugging
2677
+ #----------------------------------------------------------------------------------
2678
+
2679
+ /**
2680
+ * @author Vova Feldman (@svovaf)
2681
+ * @since 1.0.8
2682
+ */
2683
+ static function _add_debug_section() {
2684
+ if ( ! is_super_admin() ) {
2685
+ // Add debug page only for super-admins.
2686
+ return;
2687
+ }
2688
+
2689
+ self::$_static_logger->entrance();
2690
+
2691
+ $title = sprintf( '%s [v.%s]', fs_text_inline( 'Freemius Debug' ), WP_FS__SDK_VERSION );
2692
+
2693
+ if ( WP_FS__DEV_MODE ) {
2694
+ // Add top-level debug menu item.
2695
+ $hook = FS_Admin_Menu_Manager::add_page(
2696
+ $title,
2697
+ $title,
2698
+ 'manage_options',
2699
+ 'freemius',
2700
+ array( 'Freemius', '_debug_page_render' )
2701
+ );
2702
+ } else {
2703
+ // Add hidden debug page.
2704
+ $hook = FS_Admin_Menu_Manager::add_subpage(
2705
+ null,
2706
+ $title,
2707
+ $title,
2708
+ 'manage_options',
2709
+ 'freemius',
2710
+ array( 'Freemius', '_debug_page_render' )
2711
+ );
2712
+ }
2713
+
2714
+ if ( ! empty( $hook ) ) {
2715
+ add_action( "load-$hook", array( 'Freemius', '_debug_page_actions' ) );
2716
+ }
2717
+ }
2718
+
2719
+ /**
2720
+ * @author Vova Feldman (@svovaf)
2721
+ * @since 1.1.7.3
2722
+ */
2723
+ static function _toggle_debug_mode() {
2724
+ $is_on = fs_request_get( 'is_on', false, 'post' );
2725
+
2726
+ if ( fs_request_is_post() && in_array( $is_on, array( 0, 1 ) ) ) {
2727
+ update_option( 'fs_debug_mode', $is_on );
2728
+
2729
+ // Turn on/off storage logging.
2730
+ FS_Logger::_set_storage_logging( ( 1 == $is_on ) );
2731
+ }
2732
+
2733
+ exit;
2734
+ }
2735
+
2736
+ /**
2737
+ * @author Vova Feldman (@svovaf)
2738
+ * @since 1.2.1.6
2739
+ */
2740
+ static function _get_debug_log() {
2741
+ $logs = FS_Logger::load_db_logs(
2742
+ fs_request_get( 'filters', false, 'post' ),
2743
+ ! empty( $_POST['limit'] ) && is_numeric( $_POST['limit'] ) ? $_POST['limit'] : 200,
2744
+ ! empty( $_POST['offset'] ) && is_numeric( $_POST['offset'] ) ? $_POST['offset'] : 0
2745
+ );
2746
+
2747
+ self::shoot_ajax_success( $logs );
2748
+ }
2749
+
2750
+ /**
2751
+ * @author Vova Feldman (@svovaf)
2752
+ * @since 1.2.1.7
2753
+ */
2754
+ static function _get_db_option() {
2755
+ $option_name = fs_request_get( 'option_name' );
2756
+
2757
+ $value = get_option( $option_name );
2758
+
2759
+ $result = array(
2760
+ 'name' => $option_name,
2761
+ );
2762
+
2763
+ if ( false !== $value ) {
2764
+ if ( ! is_string( $value ) ) {
2765
+ $value = json_encode( $value );
2766
+ }
2767
+
2768
+ $result['value'] = $value;
2769
+ }
2770
+
2771
+ self::shoot_ajax_success( $result );
2772
+ }
2773
+
2774
+ /**
2775
+ * @author Vova Feldman (@svovaf)
2776
+ * @since 1.2.1.7
2777
+ */
2778
+ static function _set_db_option() {
2779
+ $option_name = fs_request_get( 'option_name' );
2780
+ $option_value = fs_request_get( 'option_value' );
2781
+
2782
+ if ( ! empty( $option_value ) ) {
2783
+ update_option( $option_name, $option_value );
2784
+ }
2785
+
2786
+ self::shoot_ajax_success();
2787
+ }
2788
+
2789
+ /**
2790
+ * @author Vova Feldman (@svovaf)
2791
+ * @since 1.0.8
2792
+ */
2793
+ static function _debug_page_actions() {
2794
+ self::_clean_admin_content_section();
2795
+
2796
+ if ( fs_request_is_action( 'restart_freemius' ) ) {
2797
+ check_admin_referer( 'restart_freemius' );
2798
+
2799
+ if ( ! is_multisite() ) {
2800
+ // Clear accounts data.
2801
+ self::$_accounts->clear( null, true );
2802
+ } else {
2803
+ $sites = self::get_sites();
2804
+ foreach ( $sites as $site ) {
2805
+ $blog_id = self::get_site_blog_id( $site );
2806
+ self::$_accounts->clear( $blog_id, true );
2807
+ }
2808
+
2809
+ // Clear network level storage.
2810
+ self::$_accounts->clear( true, true );
2811
+ }
2812
+
2813
+ // Clear SDK reference cache.
2814
+ delete_option( 'fs_active_plugins' );
2815
+ } else if ( fs_request_is_action( 'clear_updates_data' ) ) {
2816
+ check_admin_referer( 'clear_updates_data' );
2817
+
2818
+ if ( ! is_multisite() ) {
2819
+ set_site_transient( 'update_plugins', null );
2820
+ set_site_transient( 'update_themes', null );
2821
+ } else {
2822
+ $current_blog_id = get_current_blog_id();
2823
+
2824
+ $sites = self::get_sites();
2825
+ foreach ( $sites as $site ) {
2826
+ switch_to_blog( self::get_site_blog_id( $site ) );
2827
+
2828
+ set_site_transient( 'update_plugins', null );
2829
+ set_site_transient( 'update_themes', null );
2830
+ }
2831
+
2832
+ switch_to_blog( $current_blog_id );
2833
+ }
2834
+ } else if ( fs_request_is_action( 'simulate_trial' ) ) {
2835
+ check_admin_referer( 'simulate_trial' );
2836
+
2837
+ $fs = freemius( fs_request_get( 'module_id' ) );
2838
+
2839
+ // Update SDK install to at least 24 hours before.
2840
+ $fs->_storage->install_timestamp = ( time() - WP_FS__TIME_24_HOURS_IN_SEC );
2841
+ // Unset the trial shown timestamp.
2842
+ unset( $fs->_storage->trial_promotion_shown );
2843
+ } else if ( fs_request_is_action( 'simulate_network_upgrade' ) ) {
2844
+ check_admin_referer( 'simulate_network_upgrade' );
2845
+
2846
+ $fs = freemius( fs_request_get( 'module_id' ) );
2847
+
2848
+ self::set_network_upgrade_mode( $fs->_storage );
2849
+ } else if ( fs_request_is_action( 'delete_install' ) ) {
2850
+ check_admin_referer( 'delete_install' );
2851
+
2852
+ self::_delete_site_by_slug(
2853
+ fs_request_get( 'slug' ),
2854
+ fs_request_get( 'module_type' ),
2855
+ true,
2856
+ fs_request_get( 'blog_id', null )
2857
+ );
2858
+ } else if ( fs_request_is_action( 'delete_user' ) ) {
2859
+ check_admin_referer( 'delete_user' );
2860
+
2861
+ self::delete_user( fs_request_get( 'user_id' ) );
2862
+ } else if ( fs_request_is_action( 'download_logs' ) ) {
2863
+ check_admin_referer( 'download_logs' );
2864
+
2865
+ $download_url = FS_Logger::download_db_logs(
2866
+ fs_request_get( 'filters', false, 'post' )
2867
+ );
2868
+
2869
+ if ( false === $download_url ) {
2870
+ wp_die( 'Oops... there was an error while generating the logs download file. Please try again and if it doesn\'t work contact support@freemius.com.' );
2871
+ }
2872
+
2873
+ fs_redirect( $download_url );
2874
+ }
2875
+ }
2876
+
2877
+ /**
2878
+ * @author Vova Feldman (@svovaf)
2879
+ * @since 1.0.8
2880
+ */
2881
+ static function _debug_page_render() {
2882
+ self::$_static_logger->entrance();
2883
+
2884
+ if ( ! is_multisite() ) {
2885
+ $all_plugins_installs = self::get_all_sites( WP_FS__MODULE_TYPE_PLUGIN );
2886
+ $all_themes_installs = self::get_all_sites( WP_FS__MODULE_TYPE_THEME );
2887
+ } else {
2888
+ $sites = self::get_sites();
2889
+
2890
+ $all_plugins_installs = array();
2891
+ $all_themes_installs = array();
2892
+
2893
+ foreach ( $sites as $site ) {
2894
+ $blog_id = self::get_site_blog_id( $site );
2895
+
2896
+ $plugins_installs = self::get_all_sites( WP_FS__MODULE_TYPE_PLUGIN, $blog_id );
2897
+
2898
+ foreach ( $plugins_installs as $slug => $install ) {
2899
+ if ( ! isset( $all_plugins_installs[ $slug ] ) ) {
2900
+ $all_plugins_installs[ $slug ] = array();
2901
+ }
2902
+
2903
+ $install->blog_id = $blog_id;
2904
+
2905
+ $all_plugins_installs[ $slug ][] = $install;
2906
+ }
2907
+
2908
+ $themes_installs = self::get_all_sites( WP_FS__MODULE_TYPE_THEME, $blog_id );
2909
+
2910
+ foreach ( $themes_installs as $slug => $install ) {
2911
+ if ( ! isset( $all_themes_installs[ $slug ] ) ) {
2912
+ $all_themes_installs[ $slug ] = array();
2913
+ }
2914
+
2915
+ $install->blog_id = $blog_id;
2916
+
2917
+ $all_themes_installs[ $slug ][] = $install;
2918
+ }
2919
+ }
2920
+ }
2921
+
2922
+ $licenses_by_module_type = self::get_all_licenses_by_module_type();
2923
+
2924
+ $vars = array(
2925
+ 'plugin_sites' => $all_plugins_installs,
2926
+ 'theme_sites' => $all_themes_installs,
2927
+ 'users' => self::get_all_users(),
2928
+ 'addons' => self::get_all_addons(),
2929
+ 'account_addons' => self::get_all_account_addons(),
2930
+ 'plugin_licenses' => $licenses_by_module_type[ WP_FS__MODULE_TYPE_PLUGIN ],
2931
+ 'theme_licenses' => $licenses_by_module_type[ WP_FS__MODULE_TYPE_THEME ]
2932
+ );
2933
+
2934
+ fs_enqueue_local_style( 'fs_debug', '/admin/debug.css' );
2935
+ fs_require_once_template( 'debug.php', $vars );
2936
+ }
2937
+
2938
+ #endregion
2939
+
2940
+ #----------------------------------------------------------------------------------
2941
+ #region Connectivity Issues
2942
+ #----------------------------------------------------------------------------------
2943
+
2944
+ /**
2945
+ * Check if Freemius should be turned on for the current plugin install.
2946
+ *
2947
+ * Note:
2948
+ * $this->_is_on is updated in has_api_connectivity()
2949
+ *
2950
+ * @author Vova Feldman (@svovaf)
2951
+ * @since 1.0.9
2952
+ *
2953
+ * @return bool
2954
+ */
2955
+ function is_on() {
2956
+ self::$_static_logger->entrance();
2957
+
2958
+ if ( isset( $this->_is_on ) ) {
2959
+ return $this->_is_on;
2960
+ }
2961
+
2962
+ // If already installed or pending then sure it's on :)
2963
+ if ( $this->is_registered() || $this->is_pending_activation() ) {
2964
+ $this->_is_on = true;
2965
+
2966
+ return true;
2967
+ }
2968
+
2969
+ return false;
2970
+ }
2971
+
2972
+ /**
2973
+ * @author Vova Feldman (@svovaf)
2974
+ * @since 1.1.7.3
2975
+ *
2976
+ * @param bool $flush_if_no_connectivity
2977
+ *
2978
+ * @return bool
2979
+ */
2980
+ private function should_run_connectivity_test( $flush_if_no_connectivity = false ) {
2981
+ if ( ! isset( $this->_storage->connectivity_test ) ) {
2982
+ // Connectivity test was never executed, or cache was cleared.
2983
+ return true;
2984
+ }
2985
+
2986
+ if ( WP_FS__PING_API_ON_IP_OR_HOST_CHANGES ) {
2987
+ if ( WP_FS__IS_HTTP_REQUEST ) {
2988
+ if ( $_SERVER['HTTP_HOST'] != $this->_storage->connectivity_test['host'] ) {
2989
+ // Domain changed.
2990
+ return true;
2991
+ }
2992
+
2993
+ if ( WP_FS__REMOTE_ADDR != $this->_storage->connectivity_test['server_ip'] ) {
2994
+ // Server IP changed.
2995
+ return true;
2996
+ }
2997
+ }
2998
+ }
2999
+
3000
+ if ( $this->_storage->connectivity_test['is_connected'] &&
3001
+ $this->_storage->connectivity_test['is_active']
3002
+ ) {
3003
+ // API connected and Freemius is active - no need to run connectivity check.
3004
+ return false;
3005
+ }
3006
+
3007
+ if ( $flush_if_no_connectivity ) {
3008
+ /**
3009
+ * If explicitly asked to flush when no connectivity - do it only
3010
+ * if at least 10 sec passed from the last API connectivity test.
3011
+ */
3012
+ return ( isset( $this->_storage->connectivity_test['timestamp'] ) &&
3013
+ ( WP_FS__SCRIPT_START_TIME - $this->_storage->connectivity_test['timestamp'] ) > 10 );
3014
+ }
3015
+
3016
+ /**
3017
+ * @since 1.1.7 Don't check for connectivity on plugin downgrade.
3018
+ */
3019
+ $version = $this->get_plugin_version();
3020
+ if ( version_compare( $version, $this->_storage->connectivity_test['version'], '>' ) ) {
3021
+ // If it's a plugin version upgrade and Freemius is off or no connectivity, run connectivity test.
3022
+ return true;
3023
+ }
3024
+
3025
+ return false;
3026
+ }
3027
+
3028
+ /**
3029
+ * @author Vova Feldman (@svovaf)
3030
+ * @since 1.1.7.4
3031
+ *
3032
+ * @param int|null $blog_id Since 2.0.0.
3033
+ *
3034
+ * @return object|false
3035
+ */
3036
+ private function ping( $blog_id = null ) {
3037
+ if ( WP_FS__SIMULATE_NO_API_CONNECTIVITY ) {
3038
+ return false;
3039
+ }
3040
+
3041
+ $version = $this->get_plugin_version();
3042
+
3043
+ $is_update = $this->apply_filters( 'is_plugin_update', $this->is_plugin_update() );
3044
+
3045
+ return $this->get_api_plugin_scope()->ping(
3046
+ $this->get_anonymous_id( $blog_id ),
3047
+ array(
3048
+ 'is_update' => json_encode( $is_update ),
3049
+ 'version' => $version,
3050
+ 'sdk' => $this->version,
3051
+ 'is_admin' => json_encode( is_admin() ),
3052
+ 'is_ajax' => json_encode( self::is_ajax() ),
3053
+ 'is_cron' => json_encode( self::is_cron() ),
3054
+ 'is_http' => json_encode( WP_FS__IS_HTTP_REQUEST ),
3055
+ )
3056
+ );
3057
+ }
3058
+
3059
+ /**
3060
+ * Check if there's any connectivity issue to Freemius API.
3061
+ *
3062
+ * @author Vova Feldman (@svovaf)
3063
+ * @since 1.0.9
3064
+ *
3065
+ * @param bool $flush_if_no_connectivity
3066
+ *
3067
+ * @return bool
3068
+ */
3069
+ function has_api_connectivity( $flush_if_no_connectivity = false ) {
3070
+ $this->_logger->entrance();
3071
+
3072
+ if ( isset( $this->_has_api_connection ) && ( $this->_has_api_connection || ! $flush_if_no_connectivity ) ) {
3073
+ return $this->_has_api_connection;
3074
+ }
3075
+
3076
+ if ( WP_FS__SIMULATE_NO_API_CONNECTIVITY &&
3077
+ isset( $this->_storage->connectivity_test ) &&
3078
+ true === $this->_storage->connectivity_test['is_connected']
3079
+ ) {
3080
+ unset( $this->_storage->connectivity_test );
3081
+ }
3082
+
3083
+ if ( ! $this->should_run_connectivity_test( $flush_if_no_connectivity ) ) {
3084
+ $this->_has_api_connection = $this->_storage->connectivity_test['is_connected'];
3085
+ /**
3086
+ * @since 1.1.6 During dev mode, if there's connectivity - turn Freemius on regardless the configuration.
3087
+ *
3088
+ * @since 1.2.1.5 If the user running the premium version then ignore the 'is_active' flag and turn Freemius on to enable license key activation.
3089
+ */
3090
+ $this->_is_on = $this->_storage->connectivity_test['is_active'] ||
3091
+ $this->is_premium() ||
3092
+ ( WP_FS__DEV_MODE && $this->_has_api_connection && ! WP_FS__SIMULATE_FREEMIUS_OFF );
3093
+
3094
+ return $this->_has_api_connection;
3095
+ }
3096
+
3097
+ $pong = $this->ping();
3098
+ $is_connected = $this->get_api_plugin_scope()->is_valid_ping( $pong );
3099
+
3100
+ if ( ! $is_connected ) {
3101
+ // API failure.
3102
+ $this->_add_connectivity_issue_message( $pong );
3103
+ }
3104
+
3105
+ $this->store_connectivity_info( $pong, $is_connected );
3106
+
3107
+ return $this->_has_api_connection;
3108
+ }
3109
+
3110
+ /**
3111
+ * @author Vova Feldman (@svovaf)
3112
+ * @since 1.1.7.4
3113
+ *
3114
+ * @param object $pong
3115
+ * @param bool $is_connected
3116
+ */
3117
+ private function store_connectivity_info( $pong, $is_connected ) {
3118
+ $this->_logger->entrance();
3119
+
3120
+ $version = $this->get_plugin_version();
3121
+
3122
+ if ( ! $is_connected || WP_FS__SIMULATE_FREEMIUS_OFF ) {
3123
+ $is_active = false;
3124
+ } else {
3125
+ $is_active = ( isset( $pong->is_active ) && true == $pong->is_active );
3126
+ }
3127
+
3128
+ $is_active = $this->apply_filters(
3129
+ 'is_on',
3130
+ $is_active,
3131
+ $this->is_plugin_update(),
3132
+ $version
3133
+ );
3134
+
3135
+ $this->_storage->connectivity_test = array(
3136
+ 'is_connected' => $is_connected,
3137
+ 'host' => $_SERVER['HTTP_HOST'],
3138
+ 'server_ip' => WP_FS__REMOTE_ADDR,
3139
+ 'is_active' => $is_active,
3140
+ 'timestamp' => WP_FS__SCRIPT_START_TIME,
3141
+ // Last version with connectivity attempt.
3142
+ 'version' => $version,
3143
+ );
3144
+
3145
+ $this->_has_api_connection = $is_connected;
3146
+ $this->_is_on = $is_active || ( WP_FS__DEV_MODE && $is_connected && ! WP_FS__SIMULATE_FREEMIUS_OFF );
3147
+ }
3148
+
3149
+ /**
3150
+ * Force turning Freemius on.
3151
+ *
3152
+ * @author Vova Feldman (@svovaf)
3153
+ * @since 1.1.8.1
3154
+ *
3155
+ * @return bool TRUE if successfully turned on.
3156
+ */
3157
+ private function turn_on() {
3158
+ $this->_logger->entrance();
3159
+
3160
+ if ( $this->is_on() || ! isset( $this->_storage->connectivity_test['is_active'] ) ) {
3161
+ return false;
3162
+ }
3163
+
3164
+ $updated_connectivity = $this->_storage->connectivity_test;
3165
+ $updated_connectivity['is_active'] = true;
3166
+ $updated_connectivity['timestamp'] = WP_FS__SCRIPT_START_TIME;
3167
+ $this->_storage->connectivity_test = $updated_connectivity;
3168
+
3169
+ $this->_is_on = true;
3170
+
3171
+ return true;
3172
+ }
3173
+
3174
+ /**
3175
+ * Anonymous and unique site identifier (Hash).
3176
+ *
3177
+ * @author Vova Feldman (@svovaf)
3178
+ * @since 1.1.0
3179
+ *
3180
+ * @param null|int $blog_id Since 2.0.0
3181
+ *
3182
+ * @return string
3183
+ */
3184
+ function get_anonymous_id( $blog_id = null ) {
3185
+ $unique_id = self::$_accounts->get_option( 'unique_id', null, $blog_id );
3186
+
3187
+ if ( empty( $unique_id ) || ! is_string( $unique_id ) ) {
3188
+ $key = fs_strip_url_protocol( get_site_url( $blog_id ) );
3189
+
3190
+ $secure_auth = SECURE_AUTH_KEY;
3191
+ if ( empty( $secure_auth ) || false !== strpos( $secure_auth, ' ' ) ) {
3192
+ // Protect against default auth key.
3193
+ $secure_auth = md5( microtime() );
3194
+ }
3195
+
3196
+ /**
3197
+ * Base the unique identifier on the WP secure authentication key. Which
3198
+ * turns the key into a secret anonymous identifier. This will help us
3199
+ * to avoid duplicate installs generation on the backend upon opt-in.
3200
+ *
3201
+ * @author Vova Feldman (@svovaf)
3202
+ * @since 1.2.3
3203
+ */
3204
+ $unique_id = md5( $key . $secure_auth );
3205
+
3206
+ self::$_accounts->set_option( 'unique_id', $unique_id, true, $blog_id );
3207
+ }
3208
+
3209
+ $this->_logger->departure( $unique_id );
3210
+
3211
+ return $unique_id;
3212
+ }
3213
+
3214
+ /**
3215
+ * @author Vova Feldman (@svovaf)
3216
+ * @since 1.1.7.4
3217
+ *
3218
+ * @return \WP_User
3219
+ */
3220
+ static function _get_current_wp_user() {
3221
+ self::require_pluggable_essentials();
3222
+
3223
+ return wp_get_current_user();
3224
+ }
3225
+
3226
+ /**
3227
+ * @author Vova Feldman (@svovaf)
3228
+ * @since 1.2.1.7
3229
+ *
3230
+ * @param string $email
3231
+ *
3232
+ * @return bool
3233
+ */
3234
+ static function is_valid_email( $email ) {
3235
+ if ( false === filter_var( $email, FILTER_VALIDATE_EMAIL ) ) {
3236
+ return false;
3237
+ }
3238
+
3239
+ $parts = explode( '@', $email );
3240
+
3241
+ if ( 2 !== count( $parts ) || empty( $parts[1] ) ) {
3242
+ return false;
3243
+ }
3244
+
3245
+ $blacklist = array(
3246
+ 'admin.',
3247
+ 'webmaster.',
3248
+ 'localhost.',
3249
+ 'dev.',
3250
+ 'development.',
3251
+ 'test.',
3252
+ 'stage.',
3253
+ 'staging.',
3254
+ );
3255
+
3256
+ // Make sure domain is not one of the blacklisted.
3257
+ foreach ( $blacklist as $invalid ) {
3258
+ if ( 0 === strpos( $parts[1], $invalid ) ) {
3259
+ return false;
3260
+ }
3261
+ }
3262
+
3263
+ // Get the UTF encoded domain name.
3264
+ $domain = idn_to_ascii( $parts[1] ) . '.';
3265
+
3266
+ return ( checkdnsrr( $domain, 'MX' ) || checkdnsrr( $domain, 'A' ) );
3267
+ }
3268
+
3269
+ /**
3270
+ * Generate API connectivity issue message.
3271
+ *
3272
+ * @author Vova Feldman (@svovaf)
3273
+ * @since 1.0.9
3274
+ *
3275
+ * @param mixed $api_result
3276
+ * @param bool $is_first_failure
3277
+ */
3278
+ function _add_connectivity_issue_message( $api_result, $is_first_failure = true ) {
3279
+ if ( ! $this->is_premium() && $this->_enable_anonymous ) {
3280
+ // Don't add message if it's the free version and can run anonymously.
3281
+ return;
3282
+ }
3283
+
3284
+ if ( ! function_exists( 'wp_nonce_url' ) ) {
3285
+ require_once ABSPATH . 'wp-includes/functions.php';
3286
+ }
3287
+
3288
+ $current_user = self::_get_current_wp_user();
3289
+ // $admin_email = get_option( 'admin_email' );
3290
+ $admin_email = $current_user->user_email;
3291
+
3292
+ // Aliases.
3293
+ $deactivate_plugin_title = $this->esc_html_inline( 'That\'s exhausting, please deactivate', 'deactivate-plugin-title' );
3294
+ $deactivate_plugin_desc = $this->esc_html_inline( 'We feel your frustration and sincerely apologize for the inconvenience. Hope to see you again in the future.', 'deactivate-plugin-desc' );
3295
+ $install_previous_title = $this->esc_html_inline( 'Let\'s try your previous version', 'install-previous-title' );
3296
+ $install_previous_desc = $this->esc_html_inline( 'Uninstall this version and install the previous one.', 'install-previous-desc' );
3297
+ $fix_issue_title = $this->esc_html_inline( 'Yes - I\'m giving you a chance to fix it', 'fix-issue-title' );
3298
+ $fix_issue_desc = $this->esc_html_inline( 'We will do our best to whitelist your server and resolve this issue ASAP. You will get a follow-up email to %s once we have an update.', 'fix-issue-desc' );
3299
+ /* translators: %s: product title (e.g. "Awesome Plugin" requires an access to...) */
3300
+ $x_requires_access_to_api = $this->esc_html_inline( '%s requires an access to our API.', 'x-requires-access-to-api' );
3301
+ $sysadmin_title = $this->esc_html_inline( 'I\'m a system administrator', 'sysadmin-title' );
3302
+ $happy_to_resolve_issue_asap = $this->esc_html_inline( 'We are sure it\'s an issue on our side and more than happy to resolve it for you ASAP if you give us a chance.', 'happy-to-resolve-issue-asap' );
3303
+
3304
+ $message = false;
3305
+ if ( is_object( $api_result ) &&
3306
+ isset( $api_result->error ) &&
3307
+ isset( $api_result->error->code )
3308
+ ) {
3309
+ switch ( $api_result->error->code ) {
3310
+ case 'curl_missing':
3311
+ $missing_methods = '';
3312
+ if ( is_array( $api_result->missing_methods ) &&
3313
+ ! empty( $api_result->missing_methods )
3314
+ ) {
3315
+ foreach ( $api_result->missing_methods as $m ) {
3316
+ if ( 'curl_version' === $m ) {
3317
+ continue;
3318
+ }
3319
+
3320
+ if ( ! empty( $missing_methods ) ) {
3321
+ $missing_methods .= ', ';
3322
+ }
3323
+
3324
+ $missing_methods .= sprintf( '<code>%s</code>', $m );
3325
+ }
3326
+
3327
+ if ( ! empty( $missing_methods ) ) {
3328
+ $missing_methods = sprintf(
3329
+ '<br><br><b>%s</b> %s',
3330
+ $this->esc_html_inline( 'Disabled method(s):', 'curl-disabled-methods' ),
3331
+ $missing_methods
3332
+ );
3333
+ }
3334
+ }
3335
+
3336
+ $message = sprintf(
3337
+ $x_requires_access_to_api . ' ' .
3338
+ $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' ) . ' ' .
3339
+ $missing_methods .
3340
+ ' %s',
3341
+ '<b>' . $this->get_plugin_name() . '</b>',
3342
+ sprintf(
3343
+ '<ol id="fs_firewall_issue_options"><li>%s</li><li>%s</li><li>%s</li></ol>',
3344
+ sprintf(
3345
+ '<a class="fs-resolve" data-type="curl" href="#"><b>%s</b></a>%s',
3346
+ $this->get_text_inline( 'I don\'t know what is cURL or how to install it, help me!', 'curl-missing-no-clue-title' ),
3347
+ ' - ' . sprintf(
3348
+ $this->get_text_inline( 'We\'ll make sure to contact your hosting company and resolve the issue. You will get a follow-up email to %s once we have an update.', 'curl-missing-no-clue-desc' ),
3349
+ '<a href="mailto:' . $admin_email . '">' . $admin_email . '</a>'
3350
+ )
3351
+ ),
3352
+ sprintf(
3353
+ '<b>%s</b> - %s',
3354
+ $sysadmin_title,
3355
+ esc_html( sprintf( $this->get_text_inline( 'Great, please install cURL and enable it in your php.ini file. In addition, search for the \'disable_functions\' directive in your php.ini file and remove any disabled methods starting with \'curl_\'. To make sure it was successfully activated, use \'phpinfo()\'. Once activated, deactivate the %s and reactivate it back again.', 'curl-missing-sysadmin-desc' ), $this->get_module_label( true ) ) )
3356
+ ),
3357
+ sprintf(
3358
+ '<a href="%s"><b>%s</b></a> - %s',
3359
+ wp_nonce_url( 'plugins.php?action=deactivate&amp;plugin=' . $this->_plugin_basename . '&amp;plugin_status=all&amp;paged=1&amp;s=', 'deactivate-plugin_' . $this->_plugin_basename ),
3360
+ $deactivate_plugin_title,
3361
+ $deactivate_plugin_desc
3362
+ )
3363
+ )
3364
+ );
3365
+ break;
3366
+ case 'cloudflare_ddos_protection':
3367
+ $message = sprintf(
3368
+ $x_requires_access_to_api . ' ' .
3369
+ $this->esc_html_inline( 'From unknown reason, CloudFlare, the firewall we use, blocks the connection.', 'cloudflare-blocks-connection-message' ) . ' ' .
3370
+ $happy_to_resolve_issue_asap .
3371
+ ' %s',
3372
+ '<b>' . $this->get_plugin_name() . '</b>',
3373
+ sprintf(
3374
+ '<ol id="fs_firewall_issue_options"><li>%s</li><li>%s</li><li>%s</li></ol>',
3375
+ sprintf(
3376
+ '<a class="fs-resolve" data-type="cloudflare" href="#"><b>%s</b></a>%s',
3377
+ $fix_issue_title,
3378
+ ' - ' . sprintf(
3379
+ $fix_issue_desc,
3380
+ '<a href="mailto:' . $admin_email . '">' . $admin_email . '</a>'
3381
+ )
3382
+ ),
3383
+ sprintf(
3384
+ '<a href="%s" target="_blank"><b>%s</b></a> - %s',
3385
+ sprintf( 'https://wordpress.org/plugins/%s/download/', $this->_slug ),
3386
+ $install_previous_title,
3387
+ $install_previous_desc
3388
+ ),
3389
+ sprintf(
3390
+ '<a href="%s"><b>%s</b></a> - %s',
3391
+ wp_nonce_url( 'plugins.php?action=deactivate&amp;plugin=' . $this->_plugin_basename . '&amp;plugin_status=all&amp;paged=1&amp;s=' . '', 'deactivate-plugin_' . $this->_plugin_basename ),
3392
+ $deactivate_plugin_title,
3393
+ $deactivate_plugin_desc
3394
+ )
3395
+ )
3396
+ );
3397
+ break;
3398
+ case 'squid_cache_block':
3399
+ $message = sprintf(
3400
+ $x_requires_access_to_api . ' ' .
3401
+ $this->esc_html_inline( 'It looks like your server is using Squid ACL (access control lists), which blocks the connection.', 'squid-blocks-connection-message' ) .
3402
+ ' %s',
3403
+ '<b>' . $this->get_plugin_name() . '</b>',
3404
+ sprintf(
3405
+ '<ol id="fs_firewall_issue_options"><li>%s</li><li>%s</li><li>%s</li></ol>',
3406
+ sprintf(
3407
+ '<a class="fs-resolve" data-type="squid" href="#"><b>%s</b></a> - %s',
3408
+ $this->esc_html_inline( 'I don\'t know what is Squid or ACL, help me!', 'squid-no-clue-title' ),
3409
+ sprintf(
3410
+ $this->esc_html_inline( 'We\'ll make sure to contact your hosting company and resolve the issue. You will get a follow-up email to %s once we have an update.', 'squid-no-clue-desc' ),
3411
+ '<a href="mailto:' . $admin_email . '">' . $admin_email . '</a>'
3412
+ )
3413
+ ),
3414
+ sprintf(
3415
+ '<b>%s</b> - %s',
3416
+ $sysadmin_title,
3417
+ sprintf(
3418
+ $this->esc_html_inline( 'Great, please whitelist the following domains: %s. Once you are done, deactivate the %s and activate it again.', 'squid-sysadmin-desc' ),
3419
+ // We use a filter since the plugin might require additional API connectivity.
3420
+ '<b>' . implode( ', ', $this->apply_filters( 'api_domains', array(
3421
+ 'api.freemius.com',
3422
+ 'wp.freemius.com'
3423
+ ) ) ) . '</b>',
3424
+ $this->_module_type
3425
+ )
3426
+ ),
3427
+ sprintf(
3428
+ '<a href="%s"><b>%s</b></a> - %s',
3429
+ wp_nonce_url( 'plugins.php?action=deactivate&amp;plugin=' . $this->_plugin_basename . '&amp;plugin_status=all&amp;paged=1&amp;s=', 'deactivate-plugin_' . $this->_plugin_basename ),
3430
+ $deactivate_plugin_title,
3431
+ $deactivate_plugin_desc
3432
+ )
3433
+ )
3434
+ );
3435
+ break;
3436
+ // default:
3437
+ // $message = $this->get_text_inline( 'connectivity-test-fails-message' );
3438
+ // break;
3439
+ }
3440
+ }
3441
+
3442
+ $message_id = 'failed_connect_api';
3443
+ $type = 'error';
3444
+
3445
+ $connectivity_test_fails_message = $this->esc_html_inline( 'From unknown reason, the API connectivity test failed.', 'connectivity-test-fails-message' );
3446
+
3447
+ if ( false === $message ) {
3448
+ if ( $is_first_failure ) {
3449
+ // First attempt failed.
3450
+ $message = sprintf(
3451
+ $x_requires_access_to_api . ' ' .
3452
+ $connectivity_test_fails_message . ' ' .
3453
+ $this->esc_html_inline( 'It\'s probably a temporary issue on our end. Just to be sure, with your permission, would it be o.k to run another connectivity test?', 'connectivity-test-maybe-temporary' ) . '<br><br>' .
3454
+ '%s',
3455
+ '<b>' . $this->get_plugin_name() . '</b>',
3456
+ sprintf(
3457
+ '<div id="fs_firewall_issue_options">%s %s</div>',
3458
+ sprintf(
3459
+ '<a class="button button-primary fs-resolve" data-type="retry_ping" href="#">%s</a>',
3460
+ $this->get_text_inline( 'Yes - do your thing', 'yes-do-your-thing' )
3461
+ ),
3462
+ sprintf(
3463
+ '<a href="%s" class="button">%s</a>',
3464
+ wp_nonce_url( 'plugins.php?action=deactivate&amp;plugin=' . $this->_plugin_basename . '&amp;plugin_status=all&amp;paged=1&amp;s=', 'deactivate-plugin_' . $this->_plugin_basename ),
3465
+ $this->get_text_inline( 'No - just deactivate', 'no-deactivate' )
3466
+ )
3467
+ )
3468
+ );
3469
+
3470
+ $message_id = 'failed_connect_api_first';
3471
+ $type = 'promotion';
3472
+ } else {
3473
+ // Second connectivity attempt failed.
3474
+ $message = sprintf(
3475
+ $x_requires_access_to_api . ' ' .
3476
+ $connectivity_test_fails_message . ' ' .
3477
+ $happy_to_resolve_issue_asap .
3478
+ ' %s',
3479
+ '<b>' . $this->get_plugin_name() . '</b>',
3480
+ sprintf(
3481
+ '<ol id="fs_firewall_issue_options"><li>%s</li><li>%s</li><li>%s</li></ol>',
3482
+ sprintf(
3483
+ '<a class="fs-resolve" data-type="general" href="#"><b>%s</b></a>%s',
3484
+ $fix_issue_title,
3485
+ ' - ' . sprintf(
3486
+ $fix_issue_desc,
3487
+ '<a href="mailto:' . $admin_email . '">' . $admin_email . '</a>'
3488
+ )
3489
+ ),
3490
+ sprintf(
3491
+ '<a href="%s" target="_blank"><b>%s</b></a> - %s',
3492
+ sprintf( 'https://wordpress.org/plugins/%s/download/', $this->_slug ),
3493
+ $install_previous_title,
3494
+ $install_previous_desc
3495
+ ),
3496
+ sprintf(
3497
+ '<a href="%s"><b>%s</b></a> - %s',
3498
+ wp_nonce_url( 'plugins.php?action=deactivate&amp;plugin=' . $this->_plugin_basename . '&amp;plugin_status=all&amp;paged=1&amp;s=', 'deactivate-plugin_' . $this->_plugin_basename ),
3499
+ $deactivate_plugin_title,
3500
+ $deactivate_plugin_desc
3501
+ )
3502
+ )
3503
+ );
3504
+ }
3505
+ }
3506
+
3507
+ $this->_admin_notices->add_sticky(
3508
+ $message,
3509
+ $message_id,
3510
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
3511
+ $type
3512
+ );
3513
+ }
3514
+
3515
+ /**
3516
+ * Handle user request to resolve connectivity issue.
3517
+ * This method will send an email to Freemius API technical staff for resolution.
3518
+ * The email will contain server's info and installed plugins (might be caching issue).
3519
+ *
3520
+ * @author Vova Feldman (@svovaf)
3521
+ * @since 1.0.9
3522
+ */
3523
+ function _email_about_firewall_issue() {
3524
+ $this->_admin_notices->remove_sticky( 'failed_connect_api' );
3525
+
3526
+ $pong = $this->ping();
3527
+
3528
+ $is_connected = $this->get_api_plugin_scope()->is_valid_ping( $pong );
3529
+
3530
+ if ( $is_connected ) {
3531
+ $this->store_connectivity_info( $pong, $is_connected );
3532
+
3533
+ echo $this->get_after_plugin_activation_redirect_url();
3534
+ exit;
3535
+ }
3536
+
3537
+ $current_user = self::_get_current_wp_user();
3538
+ $admin_email = $current_user->user_email;
3539
+
3540
+ $error_type = fs_request_get( 'error_type', 'general' );
3541
+
3542
+ switch ( $error_type ) {
3543
+ case 'squid':
3544
+ $title = 'Squid ACL Blocking Issue';
3545
+ break;
3546
+ case 'cloudflare':
3547
+ $title = 'CloudFlare Blocking Issue';
3548
+ break;
3549
+ default:
3550
+ $title = 'API Connectivity Issue';
3551
+ break;
3552
+ }
3553
+
3554
+ $custom_email_sections = array();
3555
+
3556
+ // Add 'API Error' custom email section.
3557
+ $custom_email_sections['api_error'] = array(
3558
+ 'title' => 'API Error',
3559
+ 'rows' => array(
3560
+ 'ping' => array(
3561
+ 'API Error',
3562
+ is_string( $pong ) ? htmlentities( $pong ) : json_encode( $pong )
3563
+ ),
3564
+ )
3565
+ );
3566
+
3567
+ // Send email with technical details to resolve API connectivity issues.
3568
+ $this->send_email(
3569
+ 'api@freemius.com', // recipient
3570
+ $title . ' [' . $this->get_plugin_name() . ']', // subject
3571
+ $custom_email_sections,
3572
+ array( "Reply-To: $admin_email <$admin_email>" ) // headers
3573
+ );
3574
+
3575
+ $this->_admin_notices->add_sticky(
3576
+ sprintf(
3577
+ $this->get_text_inline( 'Thank for giving us the chance to fix it! A message was just sent to our technical staff. We will get back to you as soon as we have an update to %s. Appreciate your patience.', 'fix-request-sent-message' ),
3578
+ '<a href="mailto:' . $admin_email . '">' . $admin_email . '</a>'
3579
+ ),
3580
+ 'server_details_sent'
3581
+ );
3582
+
3583
+ // Action was taken, tell that API connectivity troubleshooting should be off now.
3584
+
3585
+ echo "1";
3586
+ exit;
3587
+ }
3588
+
3589
+ /**
3590
+ * Handle connectivity test retry approved by the user.
3591
+ *
3592
+ * @author Vova Feldman (@svovaf)
3593
+ * @since 1.1.7.4
3594
+ */
3595
+ function _retry_connectivity_test() {
3596
+ $this->_admin_notices->remove_sticky( 'failed_connect_api_first' );
3597
+
3598
+ $pong = $this->ping();
3599
+
3600
+ $is_connected = $this->get_api_plugin_scope()->is_valid_ping( $pong );
3601
+
3602
+ if ( $is_connected ) {
3603
+ $this->store_connectivity_info( $pong, $is_connected );
3604
+
3605
+ echo $this->get_after_plugin_activation_redirect_url();
3606
+ } else {
3607
+ // Add connectivity issue message after 2nd failed attempt.
3608
+ $this->_add_connectivity_issue_message( $pong, false );
3609
+
3610
+ echo "1";
3611
+ }
3612
+
3613
+ exit;
3614
+ }
3615
+
3616
+ static function _add_firewall_issues_javascript() {
3617
+ $params = array();
3618
+ fs_require_once_template( 'firewall-issues-js.php', $params );
3619
+ }
3620
+
3621
+ #endregion
3622
+
3623
+ #----------------------------------------------------------------------------------
3624
+ #region Email
3625
+ #----------------------------------------------------------------------------------
3626
+
3627
+ /**
3628
+ * Generates and sends an HTML email with customizable sections.
3629
+ *
3630
+ * @author Leo Fajardo (@leorw)
3631
+ * @since 1.1.2
3632
+ *
3633
+ * @param string $to_address
3634
+ * @param string $subject
3635
+ * @param array $sections
3636
+ * @param array $headers
3637
+ *
3638
+ * @return bool Whether the email contents were sent successfully.
3639
+ */
3640
+ private function send_email(
3641
+ $to_address,
3642
+ $subject,
3643
+ $sections = array(),
3644
+ $headers = array()
3645
+ ) {
3646
+ $default_sections = $this->get_email_sections();
3647
+
3648
+ // Insert new sections or replace the default email sections.
3649
+ if ( is_array( $sections ) && ! empty( $sections ) ) {
3650
+ foreach ( $sections as $section_id => $custom_section ) {
3651
+ if ( ! isset( $default_sections[ $section_id ] ) ) {
3652
+ // If the section does not exist, add it.
3653
+ $default_sections[ $section_id ] = $custom_section;
3654
+ } else {
3655
+ // If the section already exists, override it.
3656
+ $current_section = $default_sections[ $section_id ];
3657
+
3658
+ // Replace the current section's title if a custom section title exists.
3659
+ if ( isset( $custom_section['title'] ) ) {
3660
+ $current_section['title'] = $custom_section['title'];
3661
+ }
3662
+
3663
+ // Insert new rows under the current section or replace the default rows.
3664
+ if ( isset( $custom_section['rows'] ) && is_array( $custom_section['rows'] ) && ! empty( $custom_section['rows'] ) ) {
3665
+ foreach ( $custom_section['rows'] as $row_id => $row ) {
3666
+ $current_section['rows'][ $row_id ] = $row;
3667
+ }
3668
+ }
3669
+
3670
+ $default_sections[ $section_id ] = $current_section;
3671
+ }
3672
+ }
3673
+ }
3674
+
3675
+ $vars = array( 'sections' => $default_sections );
3676
+ $message = fs_get_template( 'email.php', $vars );
3677
+
3678
+ // Set the type of email to HTML.
3679
+ $headers[] = 'Content-type: text/html; charset=UTF-8';
3680
+
3681
+ $header_string = implode( "\r\n", $headers );
3682
+
3683
+ return wp_mail(
3684
+ $to_address,
3685
+ $subject,
3686
+ $message,
3687
+ $header_string
3688
+ );
3689
+ }
3690
+
3691
+ /**
3692
+ * Generates the data for the sections of the email content.
3693
+ *
3694
+ * @author Leo Fajardo (@leorw)
3695
+ * @since 1.1.2
3696
+ *
3697
+ * @return array
3698
+ */
3699
+ private function get_email_sections() {
3700
+ // Retrieve the current user's information so that we can get the user's email, first name, and last name below.
3701
+ $current_user = self::_get_current_wp_user();
3702
+
3703
+ // Retrieve the cURL version information so that we can get the version number below.
3704
+ $curl_version_information = curl_version();
3705
+
3706
+ $active_plugin = self::get_active_plugins();
3707
+
3708
+ // Generate the list of active plugins separated by new line.
3709
+ $active_plugin_string = '';
3710
+ foreach ( $active_plugin as $plugin ) {
3711
+ $active_plugin_string .= sprintf(
3712
+ '<a href="%s">%s</a> [v%s]<br>',
3713
+ $plugin['PluginURI'],
3714
+ $plugin['Name'],
3715
+ $plugin['Version']
3716
+ );
3717
+ }
3718
+
3719
+ $server_ip = WP_FS__REMOTE_ADDR;
3720
+
3721
+ // Add PHP info for deeper investigation.
3722
+ ob_start();
3723
+ phpinfo();
3724
+ $php_info = ob_get_clean();
3725
+
3726
+ $api_domain = substr( FS_API__ADDRESS, strpos( FS_API__ADDRESS, ':' ) + 3 );
3727
+
3728
+ // Generate the default email sections.
3729
+ $sections = array(
3730
+ 'sdk' => array(
3731
+ 'title' => 'SDK',
3732
+ 'rows' => array(
3733
+ 'fs_version' => array( 'FS Version', $this->version ),
3734
+ 'curl_version' => array( 'cURL Version', $curl_version_information['version'] )
3735
+ )
3736
+ ),
3737
+ 'plugin' => array(
3738
+ 'title' => ucfirst( $this->get_module_type() ),
3739
+ 'rows' => array(
3740
+ 'name' => array( 'Name', $this->get_plugin_name() ),
3741
+ 'version' => array( 'Version', $this->get_plugin_version() )
3742
+ )
3743
+ ),
3744
+ 'api' => array(
3745
+ 'title' => 'API Subdomain',
3746
+ 'rows' => array(
3747
+ 'dns' => array(
3748
+ 'DNS_CNAME',
3749
+ function_exists( 'dns_get_record' ) ?
3750
+ var_export( dns_get_record( $api_domain, DNS_CNAME ), true ) :
3751
+ 'dns_get_record() disabled/blocked'
3752
+ ),
3753
+ 'ip' => array(
3754
+ 'IP',
3755
+ function_exists( 'gethostbyname' ) ?
3756
+ gethostbyname( $api_domain ) :
3757
+ 'gethostbyname() disabled/blocked'
3758
+ ),
3759
+ ),
3760
+ ),
3761
+ 'site' => array(
3762
+ 'title' => 'Site',
3763
+ 'rows' => array(
3764
+ 'unique_id' => array( 'Unique ID', $this->get_anonymous_id() ),
3765
+ 'address' => array( 'Address', site_url() ),
3766
+ 'host' => array(
3767
+ 'HTTP_HOST',
3768
+ ( ! empty( $_SERVER['HTTP_HOST'] ) ? $_SERVER['HTTP_HOST'] : '' )
3769
+ ),
3770
+ 'hosting' => array(
3771
+ 'Hosting Company' => fs_request_has( 'hosting_company' ) ?
3772
+ fs_request_get( 'hosting_company' ) :
3773
+ 'Unknown',
3774
+ ),
3775
+ 'server_addr' => array(
3776
+ 'SERVER_ADDR',
3777
+ '<a href="http://www.projecthoneypot.org/ip_' . $server_ip . '">' . $server_ip . '</a>'
3778
+ )
3779
+ )
3780
+ ),
3781
+ 'user' => array(
3782
+ 'title' => 'User',
3783
+ 'rows' => array(
3784
+ 'email' => array( 'Email', $current_user->user_email ),
3785
+ 'first' => array( 'First', $current_user->user_firstname ),
3786
+ 'last' => array( 'Last', $current_user->user_lastname )
3787
+ )
3788
+ ),
3789
+ 'plugins' => array(
3790
+ 'title' => 'Plugins',
3791
+ 'rows' => array(
3792
+ 'active_plugins' => array( 'Active Plugins', $active_plugin_string )
3793
+ )
3794
+ ),
3795
+ 'php_info' => array(
3796
+ 'title' => 'PHP Info',
3797
+ 'rows' => array(
3798
+ 'info' => array( $php_info )
3799
+ ),
3800
+ )
3801
+ );
3802
+
3803
+ // Allow the sections to be modified by other code.
3804
+ $sections = $this->apply_filters( 'email_template_sections', $sections );
3805
+
3806
+ return $sections;
3807
+ }
3808
+
3809
+ #endregion
3810
+
3811
+ #----------------------------------------------------------------------------------
3812
+ #region Initialization
3813
+ #----------------------------------------------------------------------------------
3814
+
3815
+ /**
3816
+ * Init plugin's Freemius instance.
3817
+ *
3818
+ * @author Vova Feldman (@svovaf)
3819
+ * @since 1.0.1
3820
+ *
3821
+ * @param number $id
3822
+ * @param string $public_key
3823
+ * @param bool $is_live
3824
+ * @param bool $is_premium
3825
+ */
3826
+ function init( $id, $public_key, $is_live = true, $is_premium = true ) {
3827
+ $this->_logger->entrance();
3828
+
3829
+ $this->dynamic_init( array(
3830
+ 'id' => $id,
3831
+ 'public_key' => $public_key,
3832
+ 'is_live' => $is_live,
3833
+ 'is_premium' => $is_premium,
3834
+ ) );
3835
+ }
3836
+
3837
+ /**
3838
+ * Dynamic initiator, originally created to support initiation
3839
+ * with parent_id for add-ons.
3840
+ *
3841
+ * @author Vova Feldman (@svovaf)
3842
+ * @since 1.0.6
3843
+ *
3844
+ * @param array $plugin_info
3845
+ *
3846
+ * @throws Freemius_Exception
3847
+ */
3848
+ function dynamic_init( array $plugin_info ) {
3849
+ $this->_logger->entrance();
3850
+
3851
+ $this->parse_settings( $plugin_info );
3852
+
3853
+ if ( ! self::is_ajax() ) {
3854
+ if ( ! $this->is_addon() || $this->is_only_premium() ) {
3855
+ add_action(
3856
+ ( $this->_is_network_active && fs_is_network_admin() ? 'network_' : '' ) . 'admin_menu',
3857
+ array( &$this, '_prepare_admin_menu' ),
3858
+ WP_FS__LOWEST_PRIORITY
3859
+ );
3860
+ }
3861
+ }
3862
+
3863
+ if ( $this->should_stop_execution() ) {
3864
+ return;
3865
+ }
3866
+
3867
+ if ( ! $this->is_registered() ) {
3868
+ if ( $this->is_anonymous() ) {
3869
+ // If user skipped, no need to test connectivity.
3870
+ $this->_has_api_connection = true;
3871
+ $this->_is_on = true;
3872
+ } else {
3873
+ if ( ! $this->has_api_connectivity() ) {
3874
+ if ( $this->_admin_notices->has_sticky( 'failed_connect_api_first' ) ||
3875
+ $this->_admin_notices->has_sticky( 'failed_connect_api' )
3876
+ ) {
3877
+ if ( ! $this->_enable_anonymous || $this->is_premium() ) {
3878
+ // If anonymous mode is disabled, add firewall admin-notice message.
3879
+ add_action( 'admin_footer', array( 'Freemius', '_add_firewall_issues_javascript' ) );
3880
+
3881
+ $ajax_action_suffix = $this->_slug . ( $this->is_theme() ? ':theme' : '' );
3882
+ add_action( "wp_ajax_fs_resolve_firewall_issues_{$ajax_action_suffix}", array(
3883
+ &$this,
3884
+ '_email_about_firewall_issue'
3885
+ ) );
3886
+
3887
+ add_action( "wp_ajax_fs_retry_connectivity_test_{$ajax_action_suffix}", array(
3888
+ &$this,
3889
+ '_retry_connectivity_test'
3890
+ ) );
3891
+
3892
+ /**
3893
+ * Currently the admin notice manager relies on the module's type and slug. The new AJAX actions manager uses module IDs, hence, consider to replace the if block above with the commented code below after adjusting the admin notices manager to work with module IDs.
3894
+ *
3895
+ * @author Vova Feldman (@svovaf)
3896
+ * @since 2.0.0
3897
+ */
3898
+ /*$this->add_ajax_action( 'resolve_firewall_issues', array(
3899
+ &$this,
3900
+ '_email_about_firewall_issue'
3901
+ ) );
3902
+
3903
+ $this->add_ajax_action( 'retry_connectivity_test', array(
3904
+ &$this,
3905
+ '_retry_connectivity_test'
3906
+ ) );*/
3907
+ }
3908
+ }
3909
+
3910
+ return;
3911
+ } else {
3912
+ $this->_admin_notices->remove_sticky( array(
3913
+ 'failed_connect_api_first',
3914
+ 'failed_connect_api',
3915
+ ) );
3916
+
3917
+ if ( $this->_anonymous_mode ) {
3918
+ // Simulate anonymous mode.
3919
+ $this->_is_anonymous = true;
3920
+ }
3921
+ }
3922
+ }
3923
+ }
3924
+
3925
+ /**
3926
+ * This should be executed even if Freemius is off for the core module,
3927
+ * otherwise, the add-ons dialogbox won't work properly. This is esepcially
3928
+ * relevant when the developer decided to turn FS off for existing users.
3929
+ *
3930
+ * @author Vova Feldman (@svovaf)
3931
+ */
3932
+ if ( $this->is_user_in_admin() &&
3933
+ ! $this->is_addon() &&
3934
+ $this->has_addons() &&
3935
+ 'plugin-information' === fs_request_get( 'tab', false ) &&
3936
+ $this->get_id() == fs_request_get( 'parent_plugin_id', false )
3937
+ ) {
3938
+ require_once WP_FS__DIR_INCLUDES . '/fs-plugin-info-dialog.php';
3939
+
3940
+ new FS_Plugin_Info_Dialog( $this );
3941
+ }
3942
+
3943
+ // Check if Freemius is on for the current plugin.
3944
+ // This MUST be executed after all the plugin variables has been loaded.
3945
+ if ( ! $this->is_registered() && ! $this->is_on() ) {
3946
+ return;
3947
+ }
3948
+
3949
+ if ( $this->has_api_connectivity() ) {
3950
+ if ( self::is_cron() ) {
3951
+ $this->hook_callback_to_sync_cron();
3952
+ } else if ( $this->is_user_in_admin() ) {
3953
+ /**
3954
+ * Schedule daily data sync cron if:
3955
+ *
3956
+ * 1. User opted-in (for tracking).
3957
+ * 2. If skipped, but later upgraded (opted-in via upgrade).
3958
+ *
3959
+ * @author Vova Feldman (@svovaf)
3960
+ * @since 1.1.7.3
3961
+ *
3962
+ */
3963
+ if ( $this->is_registered() ) {
3964
+ if ( ! $this->is_sync_cron_on() && $this->is_tracking_allowed() ) {
3965
+ $this->schedule_sync_cron();
3966
+ }
3967
+ }
3968
+
3969
+ /**
3970
+ * Check if requested for manual blocking background sync.
3971
+ */
3972
+ if ( fs_request_has( 'background_sync' ) ) {
3973
+ $this->run_manual_sync();
3974
+ }
3975
+ }
3976
+ }
3977
+
3978
+ if ( $this->is_registered() ) {
3979
+ $this->hook_callback_to_install_sync();
3980
+ }
3981
+
3982
+ if ( $this->is_addon() ) {
3983
+ if ( $this->is_parent_plugin_installed() ) {
3984
+ // Link to parent FS.
3985
+ $this->_parent = self::get_instance_by_id( $this->_plugin->parent_plugin_id );
3986
+
3987
+ // Get parent plugin reference.
3988
+ $this->_parent_plugin = $this->_parent->get_plugin();
3989
+ }
3990
+ }
3991
+
3992
+ if ( $this->is_user_in_admin() ) {
3993
+ if ( $this->is_addon() ) {
3994
+ if ( ! $this->is_parent_plugin_installed() ) {
3995
+ $parent_name = $this->get_option( $plugin_info, 'parent_name', null );
3996
+
3997
+ if ( isset( $plugin_info['parent'] ) ) {
3998
+ $parent_name = $this->get_option( $plugin_info['parent'], 'name', null );
3999
+ }
4000
+
4001
+ $this->_admin_notices->add(
4002
+ ( ! empty( $parent_name ) ?
4003
+ sprintf( $this->get_text_x_inline( '%s cannot run without %s.', 'addonX cannot run without pluginY', 'addon-x-cannot-run-without-y' ), $this->get_plugin_name(), $parent_name ) :
4004
+ sprintf( $this->get_text_x_inline( '%s cannot run without the plugin.', 'addonX cannot run...', 'addon-x-cannot-run-without-parent' ), $this->get_plugin_name() )
4005
+ ),
4006
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
4007
+ 'error'
4008
+ );
4009
+
4010
+ return;
4011
+ } else {
4012
+ if ( $this->_parent->is_registered() && ! $this->is_registered() ) {
4013
+ // If parent plugin activated, automatically install add-on for the user.
4014
+ $this->_activate_addon_account( $this->_parent );
4015
+ } else if ( ! $this->_parent->is_registered() && $this->is_registered() ) {
4016
+ // If add-on activated and parent not, automatically install parent for the user.
4017
+ $this->activate_parent_account( $this->_parent );
4018
+ }
4019
+
4020
+ // @todo This should be only executed on activation. It should be migrated to register_activation_hook() together with other activation related logic.
4021
+ if ( $this->is_premium() ) {
4022
+ // Remove add-on download admin-notice.
4023
+ $this->_parent->_admin_notices->remove_sticky( array(
4024
+ 'addon_plan_upgraded_' . $this->_slug,
4025
+ 'no_addon_license_' . $this->_slug,
4026
+ ) );
4027
+ }
4028
+
4029
+ // $this->deactivate_premium_only_addon_without_license();
4030
+ }
4031
+ }
4032
+
4033
+ add_action( 'admin_init', array( &$this, '_admin_init_action' ) );
4034
+
4035
+ // if ( $this->is_registered() ||
4036
+ // $this->is_anonymous() ||
4037
+ // $this->is_pending_activation()
4038
+ // ) {
4039
+ // $this->_init_admin();
4040
+ // }
4041
+ }
4042
+
4043
+ /**
4044
+ * Should be called outside `$this->is_user_in_admin()` scope
4045
+ * because the updater has some logic that needs to be executed
4046
+ * during AJAX calls.
4047
+ *
4048
+ * Currently we need to hook to the `http_request_host_is_external` filter.
4049
+ * In the future, there might be additional logic added.
4050
+ *
4051
+ * @author Vova Feldman
4052
+ * @since 1.2.1.6
4053
+ */
4054
+ if ( $this->is_premium() && $this->has_release_on_freemius() ) {
4055
+ FS_Plugin_Updater::instance( $this );
4056
+ }
4057
+
4058
+ $this->do_action( 'initiated' );
4059
+
4060
+ if ( $this->_storage->prev_is_premium !== $this->_plugin->is_premium ) {
4061
+ if ( isset( $this->_storage->prev_is_premium ) ) {
4062
+ $this->apply_filters(
4063
+ 'after_code_type_change',
4064
+ // New code type.
4065
+ $this->_plugin->is_premium
4066
+ );
4067
+ } else {
4068
+ // Set for code type for the first time.
4069
+ $this->_storage->prev_is_premium = $this->_plugin->is_premium;
4070
+ }
4071
+ }
4072
+
4073
+ if ( ! $this->is_addon() ) {
4074
+ if ( $this->is_registered() ) {
4075
+ // Fix for upgrade from versions < 1.0.9.
4076
+ if ( ! isset( $this->_storage->activation_timestamp ) ) {
4077
+ $this->_storage->activation_timestamp = WP_FS__SCRIPT_START_TIME;
4078
+ }
4079
+
4080
+ $this->do_action( 'after_init_plugin_registered' );
4081
+ } else if ( $this->is_anonymous() ) {
4082
+ $this->do_action( 'after_init_plugin_anonymous' );
4083
+ } else if ( $this->is_pending_activation() ) {
4084
+ $this->do_action( 'after_init_plugin_pending_activations' );
4085
+ }
4086
+ } else {
4087
+ if ( $this->is_registered() ) {
4088
+ $this->do_action( 'after_init_addon_registered' );
4089
+ } else if ( $this->is_anonymous() ) {
4090
+ $this->do_action( 'after_init_addon_anonymous' );
4091
+ } else if ( $this->is_pending_activation() ) {
4092
+ $this->do_action( 'after_init_addon_pending_activations' );
4093
+ }
4094
+ }
4095
+ }
4096
+
4097
+ /**
4098
+ * @author Leo Fajardo (@leorw)
4099
+ *
4100
+ * @since 1.2.1.5
4101
+ */
4102
+ function _stop_tracking_callback() {
4103
+ $this->_logger->entrance();
4104
+
4105
+ $this->check_ajax_referer( 'stop_tracking' );
4106
+
4107
+ $result = $this->stop_tracking( fs_is_network_admin() );
4108
+
4109
+ if ( true === $result ) {
4110
+ self::shoot_ajax_success();
4111
+ }
4112
+
4113
+ $this->_logger->api_error( $result );
4114
+
4115
+ self::shoot_ajax_failure(
4116
+ sprintf( $this->get_text_inline( 'Unexpected API error. Please contact the %s\'s author with the following error.', 'unexpected-api-error' ), $this->_module_type ) .
4117
+ ( $this->is_api_error( $result ) && isset( $result->error ) ?
4118
+ $result->error->message :
4119
+ var_export( $result, true ) )
4120
+ );
4121
+ }
4122
+
4123
+ /**
4124
+ * @author Leo Fajardo (@leorw)
4125
+ * @since 1.2.1.5
4126
+ */
4127
+ function _allow_tracking_callback() {
4128
+ $this->_logger->entrance();
4129
+
4130
+ $this->check_ajax_referer( 'allow_tracking' );
4131
+
4132
+ $result = $this->allow_tracking( fs_is_network_admin() );
4133
+
4134
+ if ( true === $result ) {
4135
+ self::shoot_ajax_success();
4136
+ }
4137
+
4138
+ $this->_logger->api_error( $result );
4139
+
4140
+ self::shoot_ajax_failure(
4141
+ sprintf( $this->get_text_inline( 'Unexpected API error. Please contact the %s\'s author with the following error.', 'unexpected-api-error' ), $this->_module_type ) .
4142
+ ( $this->is_api_error( $result ) && isset( $result->error ) ?
4143
+ $result->error->message :
4144
+ var_export( $result, true ) )
4145
+ );
4146
+ }
4147
+
4148
+ /**
4149
+ * Opt-out from usage tracking.
4150
+ *
4151
+ * Note: This will not delete the account information but will stop all tracking.
4152
+ *
4153
+ * Returns:
4154
+ * 1. FALSE - If the user never opted-in.
4155
+ * 2. TRUE - If successfully opted-out.
4156
+ * 3. object - API result on failure.
4157
+ *
4158
+ * @author Leo Fajardo (@leorw)
4159
+ * @since 1.2.1.5
4160
+ *
4161
+ * @return bool|object
4162
+ */
4163
+ function stop_site_tracking() {
4164
+ $this->_logger->entrance();
4165
+
4166
+ if ( ! $this->is_registered() ) {
4167
+ // User never opted-in.
4168
+ return false;
4169
+ }
4170
+
4171
+ if ( $this->is_tracking_prohibited() ) {
4172
+ // Already disconnected.
4173
+ return true;
4174
+ }
4175
+
4176
+ // Send update to FS.
4177
+ $result = $this->get_api_site_scope()->call( '/?fields=is_disconnected', 'put', array(
4178
+ 'is_disconnected' => true
4179
+ ) );
4180
+
4181
+ if ( ! $this->is_api_result_entity( $result ) ||
4182
+ ! isset( $result->is_disconnected ) ||
4183
+ ! $result->is_disconnected
4184
+ ) {
4185
+ $this->_logger->api_error( $result );
4186
+
4187
+ return $result;
4188
+ }
4189
+
4190
+ $this->_site->is_disconnected = $result->is_disconnected;
4191
+ $this->_store_site();
4192
+
4193
+ $this->clear_sync_cron();
4194
+
4195
+ // Successfully disconnected.
4196
+ return true;
4197
+ }
4198
+
4199
+ /**
4200
+ * Opt-out network from usage tracking.
4201
+ *
4202
+ * Note: This will not delete the account information but will stop all tracking.
4203
+ *
4204
+ * Returns:
4205
+ * 1. FALSE - If the user never opted-in.
4206
+ * 2. TRUE - If successfully opted-out.
4207
+ * 3. object - API result on failure.
4208
+ *
4209
+ * @author Leo Fajardo (@leorw)
4210
+ * @since 1.2.1.5
4211
+ *
4212
+ * @return bool|object
4213
+ */
4214
+ function stop_network_tracking() {
4215
+ $this->_logger->entrance();
4216
+
4217
+ if ( ! $this->is_registered() ) {
4218
+ // User never opted-in.
4219
+ return false;
4220
+ }
4221
+
4222
+ $install_id_2_blog_id = array();
4223
+ $installs_map = $this->get_blog_install_map();
4224
+
4225
+ $opt_out_all = true;
4226
+
4227
+ $params = array();
4228
+ foreach ( $installs_map as $blog_id => $install ) {
4229
+ if ( $install->is_tracking_prohibited() ) {
4230
+ // Already opted-out.
4231
+ continue;
4232
+ }
4233
+
4234
+ if ( $this->is_site_delegated_connection( $blog_id ) ) {
4235
+ // Opt-out only from non-delegated installs.
4236
+ $opt_out_all = false;
4237
+ continue;
4238
+ }
4239
+
4240
+ $params[] = array( 'id' => $install->id );
4241
+
4242
+ $install_id_2_blog_id[ $install->id ] = $blog_id;
4243
+ }
4244
+
4245
+ if ( empty( $install_id_2_blog_id ) ) {
4246
+ return true;
4247
+ }
4248
+
4249
+ $params[] = array( 'is_disconnected' => true );
4250
+
4251
+ // Send update to FS.
4252
+ $result = $this->get_current_or_network_user_api_scope()->call( "/plugins/{$this->_module_id}/installs.json", 'put', $params );
4253
+
4254
+ if ( ! $this->is_api_result_object( $result, 'installs' ) ) {
4255
+ $this->_logger->api_error( $result );
4256
+
4257
+ return $result;
4258
+ }
4259
+
4260
+ foreach ( $result->installs as $r_install ) {
4261
+ $blog_id = $install_id_2_blog_id[ $r_install->id ];
4262
+ $install = $installs_map[ $blog_id ];
4263
+ $install->is_disconnected = $r_install->is_disconnected;
4264
+ $this->_store_site( true, $blog_id, $install );
4265
+ }
4266
+
4267
+ $this->clear_sync_cron( $opt_out_all );
4268
+
4269
+ // Successfully disconnected.
4270
+ return true;
4271
+ }
4272
+
4273
+ /**
4274
+ * Opt-out from usage tracking.
4275
+ *
4276
+ * Note: This will not delete the account information but will stop all tracking.
4277
+ *
4278
+ * Returns:
4279
+ * 1. FALSE - If the user never opted-in.
4280
+ * 2. TRUE - If successfully opted-out.
4281
+ * 3. object - API result on failure.
4282
+ *
4283
+ * @author Leo Fajardo (@leorw)
4284
+ * @since 1.2.1.5
4285
+ *
4286
+ * @param bool $is_network_action
4287
+ *
4288
+ * @return bool|object
4289
+ */
4290
+ function stop_tracking( $is_network_action = false ) {
4291
+ $this->_logger->entrance();
4292
+
4293
+ return $is_network_action ?
4294
+ $this->stop_network_tracking() :
4295
+ $this->stop_site_tracking();
4296
+ }
4297
+
4298
+ /**
4299
+ * Opt-in back into usage tracking.
4300
+ *
4301
+ * Note: This will only work if the user opted-in previously.
4302
+ *
4303
+ * Returns:
4304
+ * 1. FALSE - If the user never opted-in.
4305
+ * 2. TRUE - If successfully opted-in back to usage tracking.
4306
+ * 3. object - API result on failure.
4307
+ *
4308
+ * @author Leo Fajardo (@leorw)
4309
+ * @since 1.2.1.5
4310
+ *
4311
+ * @return bool|object
4312
+ */
4313
+ function allow_site_tracking() {
4314
+ $this->_logger->entrance();
4315
+
4316
+ if ( ! $this->is_registered() ) {
4317
+ // User never opted-in.
4318
+ return false;
4319
+ }
4320
+
4321
+ if ( $this->is_tracking_allowed() ) {
4322
+ // Tracking already allowed.
4323
+ return true;
4324
+ }
4325
+
4326
+ $result = $this->get_api_site_scope()->call( '/?is_disconnected', 'put', array(
4327
+ 'is_disconnected' => false
4328
+ ) );
4329
+
4330
+ if ( ! $this->is_api_result_entity( $result ) ||
4331
+ ! isset( $result->is_disconnected ) ||
4332
+ $result->is_disconnected
4333
+ ) {
4334
+ $this->_logger->api_error( $result );
4335
+
4336
+ return $result;
4337
+ }
4338
+
4339
+ $this->_site->is_disconnected = $result->is_disconnected;
4340
+ $this->_store_site();
4341
+
4342
+ $this->schedule_sync_cron();
4343
+
4344
+ // Successfully reconnected.
4345
+ return true;
4346
+ }
4347
+
4348
+ /**
4349
+ * Opt-in network back into usage tracking.
4350
+ *
4351
+ * Note: This will only work if the user opted-in previously.
4352
+ *
4353
+ * Returns:
4354
+ * 1. FALSE - If the user never opted-in.
4355
+ * 2. TRUE - If successfully opted-in back to usage tracking.
4356
+ * 3. object - API result on failure.
4357
+ *
4358
+ * @author Leo Fajardo (@leorw)
4359
+ * @since 1.2.1.5
4360
+ *
4361
+ * @return bool|object
4362
+ */
4363
+ function allow_network_tracking() {
4364
+ $this->_logger->entrance();
4365
+
4366
+ if ( ! $this->is_registered() ) {
4367
+ // User never opted-in.
4368
+ return false;
4369
+ }
4370
+
4371
+ $install_id_2_blog_id = array();
4372
+ $installs_map = $this->get_blog_install_map();
4373
+
4374
+ $params = array();
4375
+ foreach ( $installs_map as $blog_id => $install ) {
4376
+ if ( $install->is_tracking_allowed() ) {
4377
+ continue;
4378
+ }
4379
+
4380
+ $params[] = array( 'id' => $install->id );
4381
+
4382
+ $install_id_2_blog_id[ $install->id ] = $blog_id;
4383
+ }
4384
+
4385
+ if ( empty( $install_id_2_blog_id ) ) {
4386
+ return true;
4387
+ }
4388
+
4389
+ $params[] = array( 'is_disconnected' => false );
4390
+
4391
+ // Send update to FS.
4392
+ $result = $this->get_current_or_network_user_api_scope()->call( "/plugins/{$this->_module_id}/installs.json", 'put', $params );
4393
+
4394
+
4395
+ if ( ! $this->is_api_result_object( $result, 'installs' ) ) {
4396
+ $this->_logger->api_error( $result );
4397
+
4398
+ return $result;
4399
+ }
4400
+
4401
+ foreach ( $result->installs as $r_install ) {
4402
+ $blog_id = $install_id_2_blog_id[ $r_install->id ];
4403
+ $install = $installs_map[ $blog_id ];
4404
+ $install->is_disconnected = $r_install->is_disconnected;
4405
+ $this->_store_site( true, $blog_id, $install );
4406
+ }
4407
+
4408
+ $this->schedule_sync_cron();
4409
+
4410
+ // Successfully reconnected.
4411
+ return true;
4412
+ }
4413
+
4414
+ /**
4415
+ * Opt-in back into usage tracking.
4416
+ *
4417
+ * Note: This will only work if the user opted-in previously.
4418
+ *
4419
+ * Returns:
4420
+ * 1. FALSE - If the user never opted-in.
4421
+ * 2. TRUE - If successfully opted-in back to usage tracking.
4422
+ * 3. object - API result on failure.
4423
+ *
4424
+ * @author Leo Fajardo (@leorw)
4425
+ * @since 1.2.1.5
4426
+ *
4427
+ * @param bool $is_network_action
4428
+ *
4429
+ * @return bool|object
4430
+ */
4431
+ function allow_tracking( $is_network_action = false ) {
4432
+ $this->_logger->entrance();
4433
+
4434
+ return $is_network_action ?
4435
+ $this->allow_network_tracking() :
4436
+ $this->allow_site_tracking();
4437
+ }
4438
+
4439
+ /**
4440
+ * If user opted-in and later disabled usage-tracking,
4441
+ * re-allow tracking for licensing and updates.
4442
+ *
4443
+ * @author Leo Fajardo (@leorw)
4444
+ * @since 1.2.1.5
4445
+ *
4446
+ * @param bool $is_context_single_site
4447
+ */
4448
+ private function reconnect_locally( $is_context_single_site = false ) {
4449
+ $this->_logger->entrance();
4450
+
4451
+ if ( ! $this->is_registered() ) {
4452
+ return;
4453
+ }
4454
+
4455
+ if ( ! fs_is_network_admin() || $is_context_single_site ) {
4456
+ if ( $this->is_tracking_prohibited() ) {
4457
+ $this->_site->is_disconnected = false;
4458
+ $this->_store_site();
4459
+ }
4460
+ } else {
4461
+ $installs_map = $this->get_blog_install_map();
4462
+ foreach ( $installs_map as $blog_id => $install ) {
4463
+ /**
4464
+ * @var FS_Site $install
4465
+ */
4466
+ if ( $install->is_tracking_prohibited() ) {
4467
+ $install->is_disconnected = false;
4468
+ $this->_store_site( true, $blog_id, $install );
4469
+ }
4470
+ }
4471
+ }
4472
+ }
4473
+
4474
+ /**
4475
+ * Parse plugin's settings (as defined by the plugin dev).
4476
+ *
4477
+ * @author Vova Feldman (@svovaf)
4478
+ * @since 1.1.7.3
4479
+ *
4480
+ * @param array $plugin_info
4481
+ *
4482
+ * @throws \Freemius_Exception
4483
+ */
4484
+ private function parse_settings( &$plugin_info ) {
4485
+ $this->_logger->entrance();
4486
+
4487
+ $id = $this->get_numeric_option( $plugin_info, 'id', false );
4488
+ $public_key = $this->get_option( $plugin_info, 'public_key', false );
4489
+ $secret_key = $this->get_option( $plugin_info, 'secret_key', null );
4490
+ $parent_id = $this->get_numeric_option( $plugin_info, 'parent_id', null );
4491
+ $parent_name = $this->get_option( $plugin_info, 'parent_name', null );
4492
+
4493
+ /**
4494
+ * @author Vova Feldman (@svovaf)
4495
+ * @since 1.1.9 Try to pull secret key from external config.
4496
+ */
4497
+ if ( is_null( $secret_key ) && defined( "WP_FS__{$this->_slug}_SECRET_KEY" ) ) {
4498
+ $secret_key = constant( "WP_FS__{$this->_slug}_SECRET_KEY" );
4499
+ }
4500
+
4501
+ if ( isset( $plugin_info['parent'] ) ) {
4502
+ $parent_id = $this->get_numeric_option( $plugin_info['parent'], 'id', null );
4503
+ // $parent_slug = $this->get_option( $plugin_info['parent'], 'slug', null );
4504
+ // $parent_public_key = $this->get_option( $plugin_info['parent'], 'public_key', null );
4505
+ // $parent_name = $this->get_option( $plugin_info['parent'], 'name', null );
4506
+ }
4507
+
4508
+ if ( false === $id ) {
4509
+ throw new Freemius_Exception( array(
4510
+ 'error' => array(
4511
+ 'type' => 'ParameterNotSet',
4512
+ 'message' => 'Plugin id parameter is not set.',
4513
+ 'code' => 'plugin_id_not_set',
4514
+ 'http' => 500,
4515
+ )
4516
+ ) );
4517
+ }
4518
+ if ( false === $public_key ) {
4519
+ throw new Freemius_Exception( array(
4520
+ 'error' => array(
4521
+ 'type' => 'ParameterNotSet',
4522
+ 'message' => 'Plugin public_key parameter is not set.',
4523
+ 'code' => 'plugin_public_key_not_set',
4524
+ 'http' => 500,
4525
+ )
4526
+ ) );
4527
+ }
4528
+
4529
+ $plugin = ( $this->_plugin instanceof FS_Plugin ) ?
4530
+ $this->_plugin :
4531
+ new FS_Plugin();
4532
+
4533
+ $plugin->update( array(
4534
+ 'id' => $id,
4535
+ 'type' => $this->get_option( $plugin_info, 'type', $this->_module_type ),
4536
+ 'public_key' => $public_key,
4537
+ 'slug' => $this->_slug,
4538
+ 'parent_plugin_id' => $parent_id,
4539
+ 'version' => $this->get_plugin_version(),
4540
+ 'title' => $this->get_plugin_name(),
4541
+ 'file' => $this->_plugin_basename,
4542
+ 'is_premium' => $this->get_bool_option( $plugin_info, 'is_premium', true ),
4543
+ 'is_live' => $this->get_bool_option( $plugin_info, 'is_live', true ),
4544
+ 'affiliate_moderation' => $this->get_option( $plugin_info, 'has_affiliation' ),
4545
+ ) );
4546
+
4547
+ if ( $plugin->is_updated() ) {
4548
+ // Update plugin details.
4549
+ $this->_plugin = FS_Plugin_Manager::instance( $this->_module_id )->store( $plugin );
4550
+ }
4551
+ // Set the secret key after storing the plugin, we don't want to store the key in the storage.
4552
+ $this->_plugin->secret_key = $secret_key;
4553
+
4554
+ if ( ! isset( $plugin_info['menu'] ) ) {
4555
+ $plugin_info['menu'] = array();
4556
+
4557
+ if ( ! empty( $this->_storage->sdk_last_version ) &&
4558
+ version_compare( $this->_storage->sdk_last_version, '1.1.2', '<=' )
4559
+ ) {
4560
+ // Backward compatibility to 1.1.2
4561
+ $plugin_info['menu']['slug'] = isset( $plugin_info['menu_slug'] ) ?
4562
+ $plugin_info['menu_slug'] :
4563
+ $this->_slug;
4564
+ }
4565
+ }
4566
+
4567
+ $this->_menu = FS_Admin_Menu_Manager::instance(
4568
+ $this->_module_id,
4569
+ $this->_module_type,
4570
+ $this->get_unique_affix()
4571
+ );
4572
+
4573
+ $this->_menu->init( $plugin_info['menu'], $this->is_addon() );
4574
+
4575
+ $this->_has_addons = $this->get_bool_option( $plugin_info, 'has_addons', false );
4576
+ $this->_has_paid_plans = $this->get_bool_option( $plugin_info, 'has_paid_plans', true );
4577
+ $this->_has_premium_version = $this->get_bool_option( $plugin_info, 'has_premium_version', $this->_has_paid_plans );
4578
+ $this->_ignore_pending_mode = $this->get_bool_option( $plugin_info, 'ignore_pending_mode', false );
4579
+ $this->_is_org_compliant = $this->get_bool_option( $plugin_info, 'is_org_compliant', true );
4580
+ $this->_is_premium_only = $this->get_bool_option( $plugin_info, 'is_premium_only', false );
4581
+ if ( $this->_is_premium_only ) {
4582
+ // If premium only plugin, disable anonymous mode.
4583
+ $this->_enable_anonymous = false;
4584
+ $this->_anonymous_mode = false;
4585
+ } else {
4586
+ $this->_enable_anonymous = $this->get_bool_option( $plugin_info, 'enable_anonymous', true );
4587
+ $this->_anonymous_mode = $this->get_bool_option( $plugin_info, 'anonymous_mode', false );
4588
+ }
4589
+ $this->_permissions = $this->get_option( $plugin_info, 'permissions', array() );
4590
+
4591
+ if ( ! empty( $plugin_info['trial'] ) ) {
4592
+ $this->_trial_days = $this->get_numeric_option(
4593
+ $plugin_info['trial'],
4594
+ 'days',
4595
+ // Default to 0 - trial without days specification.
4596
+ 0
4597
+ );
4598
+
4599
+ $this->_is_trial_require_payment = $this->get_bool_option( $plugin_info['trial'], 'is_require_payment', false );
4600
+ }
4601
+ }
4602
+
4603
+ /**
4604
+ * @param string[] $options
4605
+ * @param string $key
4606
+ * @param mixed $default
4607
+ *
4608
+ * @return bool
4609
+ */
4610
+ private function get_option( &$options, $key, $default = false ) {
4611
+ return ! empty( $options[ $key ] ) ? $options[ $key ] : $default;
4612
+ }
4613
+
4614
+ private function get_bool_option( &$options, $key, $default = false ) {
4615
+ return isset( $options[ $key ] ) && is_bool( $options[ $key ] ) ? $options[ $key ] : $default;
4616
+ }
4617
+
4618
+ private function get_numeric_option( &$options, $key, $default = false ) {
4619
+ return isset( $options[ $key ] ) && is_numeric( $options[ $key ] ) ? $options[ $key ] : $default;
4620
+ }
4621
+
4622
+ /**
4623
+ * Gate keeper.
4624
+ *
4625
+ * @author Vova Feldman (@svovaf)
4626
+ * @since 1.1.7.3
4627
+ *
4628
+ * @return bool
4629
+ */
4630
+ private function should_stop_execution() {
4631
+ if ( empty( $this->_storage->was_plugin_loaded ) ) {
4632
+ /**
4633
+ * Don't execute Freemius until plugin was fully loaded at least once,
4634
+ * to give the opportunity for the activation hook to run before pinging
4635
+ * the API for connectivity test. This logic is relevant for the
4636
+ * identification of new plugin install vs. plugin update.
4637
+ *
4638
+ * @author Vova Feldman (@svovaf)
4639
+ * @since 1.1.9
4640
+ */
4641
+ return true;
4642
+ }
4643
+
4644
+ if ( $this->is_activation_mode() ) {
4645
+ if ( ! is_admin() ) {
4646
+ /**
4647
+ * If in activation mode, don't execute Freemius outside of the
4648
+ * admin dashboard.
4649
+ *
4650
+ * @author Vova Feldman (@svovaf)
4651
+ * @since 1.1.7.3
4652
+ */
4653
+ return true;
4654
+ }
4655
+
4656
+ if ( ! WP_FS__IS_HTTP_REQUEST ) {
4657
+ /**
4658
+ * If in activation and executed without HTTP context (e.g. CLI, Cronjob),
4659
+ * then don't start Freemius.
4660
+ *
4661
+ * @author Vova Feldman (@svovaf)
4662
+ * @since 1.1.6.3
4663
+ *
4664
+ * @link https://wordpress.org/support/topic/errors-in-the-freemius-class-when-running-in-wordpress-in-cli
4665
+ */
4666
+ return true;
4667
+ }
4668
+
4669
+ if ( self::is_cron() ) {
4670
+ /**
4671
+ * If in activation mode, don't execute Freemius during wp crons
4672
+ * (wp crons have HTTP context - called as HTTP request).
4673
+ *
4674
+ * @author Vova Feldman (@svovaf)
4675
+ * @since 1.1.7.3
4676
+ */
4677
+ return true;
4678
+ }
4679
+
4680
+ if ( self::is_ajax() &&
4681
+ ! $this->_admin_notices->has_sticky( 'failed_connect_api_first' ) &&
4682
+ ! $this->_admin_notices->has_sticky( 'failed_connect_api' )
4683
+ ) {
4684
+ /**
4685
+ * During activation, if running in AJAX mode, unless there's a sticky
4686
+ * connectivity issue notice, don't run Freemius.
4687
+ *
4688
+ * @author Vova Feldman (@svovaf)
4689
+ * @since 1.1.7.3
4690
+ */
4691
+ return true;
4692
+ }
4693
+ }
4694
+
4695
+ return false;
4696
+ }
4697
+
4698
+ /**
4699
+ * Triggered after code type has changed.
4700
+ *
4701
+ * @author Vova Feldman (@svovaf)
4702
+ * @since 1.1.9.1
4703
+ */
4704
+ function _after_code_type_change() {
4705
+ $this->_logger->entrance();
4706
+
4707
+ if ( $this->is_theme() ) {
4708
+ // Expire the cache of the previous tabs since the theme may
4709
+ // have setting updates after code type has changed.
4710
+ $this->_cache->expire( 'tabs' );
4711
+ $this->_cache->expire( 'tabs_stylesheets' );
4712
+ }
4713
+
4714
+ if ( $this->is_registered() ) {
4715
+ if ( ! $this->is_addon() ) {
4716
+ add_action(
4717
+ is_admin() ? 'admin_init' : 'init',
4718
+ array( &$this, '_plugin_code_type_changed' )
4719
+ );
4720
+ }
4721
+
4722
+ if ( $this->is_premium() ) {
4723
+ // Purge cached payments after switching to the premium version.
4724
+ // @todo This logic doesn't handle purging the cache for serviceware module upgrade.
4725
+ $this->get_api_user_scope()->purge_cache( "/plugins/{$this->_module_id}/payments.json?include_addons=true" );
4726
+ }
4727
+ }
4728
+ }
4729
+
4730
+ /**
4731
+ * Handles plugin's code type change (free <--> premium).
4732
+ *
4733
+ * @author Vova Feldman (@svovaf)
4734
+ * @since 1.0.9
4735
+ */
4736
+ function _plugin_code_type_changed() {
4737
+ $this->_logger->entrance();
4738
+
4739
+ if ( $this->is_premium() ) {
4740
+ $this->reconnect_locally();
4741
+
4742
+ // Activated premium code.
4743
+ $this->do_action( 'after_premium_version_activation' );
4744
+
4745
+ // Remove all sticky messages related to download of the premium version.
4746
+ $this->_admin_notices->remove_sticky( array(
4747
+ 'trial_started',
4748
+ 'plan_upgraded',
4749
+ 'plan_changed',
4750
+ 'license_activated',
4751
+ ) );
4752
+
4753
+ $notice = '';
4754
+ if ( ! $this->is_only_premium() ) {
4755
+ $notice = sprintf( $this->get_text_inline( 'Premium %s version was successfully activated.', 'premium-activated-message' ), $this->_module_type );
4756
+ }
4757
+
4758
+ $license_notice = $this->get_license_network_activation_notice();
4759
+ if ( ! empty( $license_notice ) ) {
4760
+ $notice .= ' ' . $license_notice;
4761
+ }
4762
+
4763
+ if ( ! empty( $notice ) ) {
4764
+ $this->_admin_notices->add_sticky(
4765
+ trim( $notice ),
4766
+ 'premium_activated',
4767
+ $this->get_text_x_inline( 'W00t',
4768
+ 'Used to express elation, enthusiasm, or triumph (especially in electronic communication).', 'woot' ) . '!'
4769
+ );
4770
+ }
4771
+ } else {
4772
+ // Remove sticky message related to premium code activation.
4773
+ $this->_admin_notices->remove_sticky( 'premium_activated' );
4774
+
4775
+ // Activated free code (after had the premium before).
4776
+ $this->do_action( 'after_free_version_reactivation' );
4777
+
4778
+ if ( $this->is_paying() && ! $this->is_premium() ) {
4779
+ $this->_admin_notices->add_sticky(
4780
+ sprintf(
4781
+ /* translators: %s: License type (e.g. you have a professional license) */
4782
+ $this->get_text_inline( 'You have a %s license.', 'you-have-x-license' ),
4783
+ $this->get_plan_title()
4784
+ ) . $this->get_complete_upgrade_instructions(),
4785
+ 'plan_upgraded',
4786
+ $this->get_text_x_inline( 'Yee-haw', 'interjection expressing joy or exuberance', 'yee-haw' ) . '!'
4787
+ );
4788
+ }
4789
+ }
4790
+
4791
+ // Schedule code type changes event.
4792
+ $this->schedule_install_sync();
4793
+
4794
+ /**
4795
+ * Unregister the uninstall hook for the other version of the plugin (with different code type) to avoid
4796
+ * triggering a fatal error when uninstalling that plugin. For example, after deactivating the "free" version
4797
+ * of a specific plugin, its uninstall hook should be unregistered after the "premium" version has been
4798
+ * activated. If we don't do that, a fatal error will occur when we try to uninstall the "free" version since
4799
+ * the main file of the "free" version will be loaded first before calling the hooked callback. Since the
4800
+ * free and premium versions are almost identical (same class or have same functions), a fatal error like
4801
+ * "Cannot redeclare class MyClass" or "Cannot redeclare my_function()" will occur.
4802
+ */
4803
+ $this->unregister_uninstall_hook();
4804
+
4805
+ $this->clear_module_main_file_cache();
4806
+
4807
+ // Update is_premium of latest version.
4808
+ $this->_storage->prev_is_premium = $this->_plugin->is_premium;
4809
+ }
4810
+
4811
+ #endregion
4812
+
4813
+ #----------------------------------------------------------------------------------
4814
+ #region Add-ons
4815
+ #----------------------------------------------------------------------------------
4816
+
4817
+ /**
4818
+ * Check if add-on installed and activated on site.
4819
+ *
4820
+ * @author Vova Feldman (@svovaf)
4821
+ * @since 1.0.6
4822
+ *
4823
+ * @param string|number $id_or_slug
4824
+ * @param bool|null $is_premium Since 1.2.1.7 can check for specified add-on version.
4825
+ *
4826
+ * @return bool
4827
+ */
4828
+ function is_addon_activated( $id_or_slug, $is_premium = null ) {
4829
+ $this->_logger->entrance();
4830
+
4831
+ $addon_id = self::get_module_id( $id_or_slug );
4832
+ $is_activated = self::has_instance( $addon_id );
4833
+
4834
+ if ( ! $is_activated ) {
4835
+ return false;
4836
+ }
4837
+
4838
+ if ( is_bool( $is_premium ) ) {
4839
+ // Check if the specified code version is activate.
4840
+ $addon = $this->get_addon_instance( $addon_id );
4841
+ $is_activated = ( $is_premium === $addon->is_premium() );
4842
+ }
4843
+
4844
+ return $is_activated;
4845
+ }
4846
+
4847
+ /**
4848
+ * Check if add-on was connected to install
4849
+ *
4850
+ * @author Vova Feldman (@svovaf)
4851
+ * @since 1.1.7
4852
+ *
4853
+ * @param string|number $id_or_slug
4854
+ *
4855
+ * @return bool
4856
+ */
4857
+ function is_addon_connected( $id_or_slug ) {
4858
+ $this->_logger->entrance();
4859
+
4860
+ $sites = self::get_all_sites( WP_FS__MODULE_TYPE_PLUGIN );
4861
+
4862
+ $addon_id = self::get_module_id( $id_or_slug );
4863
+ $addon = $this->get_addon( $addon_id );
4864
+ $slug = $addon->slug;
4865
+ if ( ! isset( $sites[ $slug ] ) ) {
4866
+ return false;
4867
+ }
4868
+
4869
+ $site = $sites[ $slug ];
4870
+
4871
+ $plugin = FS_Plugin_Manager::instance( $addon_id )->get();
4872
+
4873
+ if ( $plugin->parent_plugin_id != $this->_plugin->id ) {
4874
+ // The given slug do NOT belong to any of the plugin's add-ons.
4875
+ return false;
4876
+ }
4877
+
4878
+ return ( is_object( $site ) &&
4879
+ is_numeric( $site->id ) &&
4880
+ is_numeric( $site->user_id ) &&
4881
+ FS_Plugin_Plan::is_valid_id( $site->plan_id )
4882
+ );
4883
+ }
4884
+
4885
+ /**
4886
+ * Determines if add-on installed.
4887
+ *
4888
+ * NOTE: This is a heuristic and only works if the folder/file named as the slug.
4889
+ *
4890
+ * @author Vova Feldman (@svovaf)
4891
+ * @since 1.0.6
4892
+ *
4893
+ * @param string|number $id_or_slug
4894
+ *
4895
+ * @return bool
4896
+ */
4897
+ function is_addon_installed( $id_or_slug ) {
4898
+ $this->_logger->entrance();
4899
+
4900
+ $addon_id = self::get_module_id( $id_or_slug );
4901
+
4902
+ return file_exists( fs_normalize_path( WP_PLUGIN_DIR . '/' . $this->get_addon_basename( $addon_id ) ) );
4903
+ }
4904
+
4905
+ /**
4906
+ * Get add-on basename.
4907
+ *
4908
+ * @author Vova Feldman (@svovaf)
4909
+ * @since 1.0.6
4910
+ *
4911
+ * @param string|number $id_or_slug
4912
+ *
4913
+ * @return string
4914
+ */
4915
+ function get_addon_basename( $id_or_slug ) {
4916
+ $addon_id = self::get_module_id( $id_or_slug );
4917
+
4918
+ if ( $this->is_addon_activated( $addon_id ) ) {
4919
+ return self::instance( $addon_id )->get_plugin_basename();
4920
+ }
4921
+
4922
+ $addon = $this->get_addon( $addon_id );
4923
+ $premium_basename = "{$addon->slug}-premium/{$addon->slug}.php";
4924
+
4925
+ if ( file_exists( fs_normalize_path( WP_PLUGIN_DIR . '/' . $premium_basename ) ) ) {
4926
+ return $premium_basename;
4927
+ }
4928
+
4929
+ $all_plugins = $this->get_all_plugins();
4930
+
4931
+ foreach ( $all_plugins as $basename => &$data ) {
4932
+ if ( $addon->slug === $data['slug'] ||
4933
+ $addon->slug . '-premium' === $data['slug']
4934
+ ) {
4935
+ return $basename;
4936
+ }
4937
+ }
4938
+
4939
+ $free_basename = "{$addon->slug}/{$addon->slug}.php";
4940
+
4941
+ return $free_basename;
4942
+ }
4943
+
4944
+ /**
4945
+ * Get installed add-ons instances.
4946
+ *
4947
+ * @author Vova Feldman (@svovaf)
4948
+ * @since 1.0.6
4949
+ *
4950
+ * @return Freemius[]
4951
+ */
4952
+ function get_installed_addons() {
4953
+ $installed_addons = array();
4954
+ foreach ( self::$_instances as $instance ) {
4955
+ if ( $instance->is_addon() && is_object( $instance->_parent_plugin ) ) {
4956
+ if ( $this->_plugin->id == $instance->_parent_plugin->id ) {
4957
+ $installed_addons[] = $instance;
4958
+ }
4959
+ }
4960
+ }
4961
+
4962
+ return $installed_addons;
4963
+ }
4964
+
4965
+ /**
4966
+ * Check if any add-ons of the plugin are installed.
4967
+ *
4968
+ * @author Leo Fajardo (@leorw)
4969
+ * @since 1.1.1
4970
+ *
4971
+ * @return bool
4972
+ */
4973
+ function has_installed_addons() {
4974
+ if ( ! $this->has_addons() ) {
4975
+ return false;
4976
+ }
4977
+
4978
+ foreach ( self::$_instances as $instance ) {
4979
+ if ( $instance->is_addon() && is_object( $instance->_parent_plugin ) ) {
4980
+ if ( $this->_plugin->id == $instance->_parent_plugin->id ) {
4981
+ return true;
4982
+ }
4983
+ }
4984
+ }
4985
+
4986
+ return false;
4987
+ }
4988
+
4989
+ /**
4990
+ * Tell Freemius that the current plugin is an add-on.
4991
+ *
4992
+ * @author Vova Feldman (@svovaf)
4993
+ * @since 1.0.6
4994
+ *
4995
+ * @param number $parent_plugin_id The parent plugin ID
4996
+ */
4997
+ function init_addon( $parent_plugin_id ) {
4998
+ $this->_plugin->parent_plugin_id = $parent_plugin_id;
4999
+ }
5000
+
5001
+ /**
5002
+ * @author Vova Feldman (@svovaf)
5003
+ * @since 1.0.6
5004
+ *
5005
+ * @return bool
5006
+ */
5007
+ function is_addon() {
5008
+ return isset( $this->_plugin->parent_plugin_id ) && is_numeric( $this->_plugin->parent_plugin_id );
5009
+ }
5010
+
5011
+ /**
5012
+ * Deactivate add-on if it's premium only and the user does't have a valid license.
5013
+ *
5014
+ * @param bool $is_after_trial_cancel
5015
+ *
5016
+ * @return bool If add-on was deactivated.
5017
+ */
5018
+ private function deactivate_premium_only_addon_without_license( $is_after_trial_cancel = false ) {
5019
+ if ( ! $this->has_free_plan() &&
5020
+ ! $this->has_features_enabled_license() &&
5021
+ ! $this->_has_premium_license()
5022
+ ) {
5023
+ if ( $this->is_registered() ) {
5024
+ // IF wrapper is turned off because activation_timestamp is currently only stored for plugins (not addons).
5025
+ // if (empty($this->_storage->activation_timestamp) ||
5026
+ // (WP_FS__SCRIPT_START_TIME - $this->_storage->activation_timestamp) > 30
5027
+ // ) {
5028
+ /**
5029
+ * @todo When it's first fail, there's no reason to try and re-sync because the licenses were just synced after initial activation.
5030
+ *
5031
+ * Retry syncing the user add-on licenses.
5032
+ */
5033
+ // Sync licenses.
5034
+ $this->_sync_licenses();
5035
+ // }
5036
+
5037
+ // Try to activate premium license.
5038
+ $this->_activate_license( true );
5039
+ }
5040
+
5041
+ if ( ! $this->has_free_plan() &&
5042
+ ! $this->has_features_enabled_license() &&
5043
+ ! $this->_has_premium_license()
5044
+ ) {
5045
+ // @todo Check if deactivate plugins also call the deactivation hook.
5046
+
5047
+ $this->_parent->_admin_notices->add_sticky(
5048
+ sprintf(
5049
+ ( $is_after_trial_cancel ?
5050
+ $this->_parent->get_text_inline(
5051
+ '%s free trial was successfully cancelled. Since the add-on is premium only it was automatically deactivated. If you like to use it in the future, you\'ll have to purchase a license.',
5052
+ 'addon-trial-cancelled-message'
5053
+ ) :
5054
+ $this->_parent->get_text_inline(
5055
+ '%s is a premium only add-on. You have to purchase a license first before activating the plugin.',
5056
+ 'addon-no-license-message'
5057
+ )
5058
+ ),
5059
+ '<b>' . $this->_plugin->title . '</b>'
5060
+ ) . ' ' . sprintf(
5061
+ '<a href="%s" aria-label="%s" class="button button-primary" style="margin-left: 10px; vertical-align: middle;">%s &nbsp;&#10140;</a>',
5062
+ $this->_parent->addon_url( $this->_slug ),
5063
+ esc_attr( sprintf( $this->_parent->get_text_inline( 'More information about %s', 'more-information-about-x' ), $this->_plugin->title ) ),
5064
+ $this->_parent->get_text_inline( 'Purchase License', 'purchase-license' )
5065
+ ),
5066
+ 'no_addon_license_' . $this->_slug,
5067
+ ( $is_after_trial_cancel ? '' : $this->_parent->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...' ),
5068
+ ( $is_after_trial_cancel ? 'success' : 'error' )
5069
+ );
5070
+
5071
+ deactivate_plugins( array( $this->_plugin_basename ), true );
5072
+
5073
+ return true;
5074
+ }
5075
+ }
5076
+
5077
+ return false;
5078
+ }
5079
+
5080
+ #endregion
5081
+
5082
+ #----------------------------------------------------------------------------------
5083
+ #region Sandbox
5084
+ #----------------------------------------------------------------------------------
5085
+
5086
+ /**
5087
+ * Set Freemius into sandbox mode for debugging.
5088
+ *
5089
+ * @author Vova Feldman (@svovaf)
5090
+ * @since 1.0.4
5091
+ *
5092
+ * @param string $secret_key
5093
+ */
5094
+ function init_sandbox( $secret_key ) {
5095
+ $this->_plugin->secret_key = $secret_key;
5096
+
5097
+ // Update plugin details.
5098
+ FS_Plugin_Manager::instance( $this->_module_id )->update( $this->_plugin, true );
5099
+ }
5100
+
5101
+ /**
5102
+ * Check if running payments in sandbox mode.
5103
+ *
5104
+ * @author Vova Feldman (@svovaf)
5105
+ * @since 1.0.4
5106
+ *
5107
+ * @return bool
5108
+ */
5109
+ function is_payments_sandbox() {
5110
+ return ( ! $this->is_live() ) || isset( $this->_plugin->secret_key );
5111
+ }
5112
+
5113
+ #endregion
5114
+
5115
+ /**
5116
+ * Check if running test vs. live plugin.
5117
+ *
5118
+ * @author Vova Feldman (@svovaf)
5119
+ * @since 1.0.5
5120
+ *
5121
+ * @return bool
5122
+ */
5123
+ function is_live() {
5124
+ return $this->_plugin->is_live;
5125
+ }
5126
+
5127
+ /**
5128
+ * Check if super-admin skipped connection for all sites in the network.
5129
+ *
5130
+ * @author Vova Feldman (@svovaf)
5131
+ * @since 2.0.0
5132
+ */
5133
+ function is_network_anonymous() {
5134
+ if ( ! $this->_is_network_active ) {
5135
+ return false;
5136
+ }
5137
+
5138
+ $is_anonymous_ms = $this->_storage->get( 'is_anonymous_ms' );
5139
+
5140
+ if ( empty( $is_anonymous_ms ) ) {
5141
+ return false;
5142
+ }
5143
+
5144
+ return $is_anonymous_ms['is'];
5145
+ }
5146
+
5147
+ /**
5148
+ * Check if super-admin opted-in for all sites in the network.
5149
+ *
5150
+ * @author Vova Feldman (@svovaf)
5151
+ * @since 2.0.0
5152
+ */
5153
+ function is_network_connected() {
5154
+ if ( ! $this->_is_network_active ) {
5155
+ return false;
5156
+ }
5157
+
5158
+ return $this->_storage->get( 'is_network_connected' );
5159
+ }
5160
+
5161
+ /**
5162
+ * Check if the user skipped connecting the account with Freemius.
5163
+ *
5164
+ * @author Vova Feldman (@svovaf)
5165
+ * @since 1.0.7
5166
+ *
5167
+ * @return bool
5168
+ */
5169
+ function is_anonymous() {
5170
+ if ( ! isset( $this->_is_anonymous ) ) {
5171
+ if ( $this->is_network_anonymous() ) {
5172
+ $this->_is_anonymous = true;
5173
+ } else {
5174
+ if ( ! isset( $this->_storage->is_anonymous ) ) {
5175
+ // Not skipped.
5176
+ $this->_is_anonymous = false;
5177
+ } else if ( is_bool( $this->_storage->is_anonymous ) ) {
5178
+ // For back compatibility, since the variable was boolean before.
5179
+ $this->_is_anonymous = $this->_storage->is_anonymous;
5180
+
5181
+ // Upgrade stored data format to 1.1.3 format.
5182
+ $this->set_anonymous_mode( $this->_storage->is_anonymous );
5183
+ } else {
5184
+ // Version 1.1.3 and later.
5185
+ $this->_is_anonymous = $this->_storage->is_anonymous['is'];
5186
+ }
5187
+ }
5188
+ }
5189
+
5190
+ return $this->_is_anonymous;
5191
+ }
5192
+
5193
+ /**
5194
+ * Check if the user skipped the connection of a specified site.
5195
+ *
5196
+ * @author Vova Feldman (@svovaf)
5197
+ * @since 2.0.0
5198
+ *
5199
+ * @param int $blog_id
5200
+ *
5201
+ * @return bool
5202
+ */
5203
+ function is_anonymous_site( $blog_id = 0 ) {
5204
+ if ( $this->is_network_anonymous() ) {
5205
+ return true;
5206
+ }
5207
+
5208
+ $is_anonymous = $this->_storage->get( 'is_anonymous', false, $blog_id );
5209
+
5210
+ if ( empty( $is_anonymous ) ) {
5211
+ return false;
5212
+ }
5213
+
5214
+ return $is_anonymous['is'];
5215
+ }
5216
+
5217
+ /**
5218
+ * Check if user connected his account and install pending email activation.
5219
+ *
5220
+ * @author Vova Feldman (@svovaf)
5221
+ * @since 1.0.7
5222
+ *
5223
+ * @return bool
5224
+ */
5225
+ function is_pending_activation() {
5226
+ return $this->_storage->get( 'is_pending_activation', false );
5227
+ }
5228
+
5229
+ /**
5230
+ * Check if plugin must be WordPress.org compliant.
5231
+ *
5232
+ * @since 1.0.7
5233
+ *
5234
+ * @return bool
5235
+ */
5236
+ function is_org_repo_compliant() {
5237
+ return $this->_is_org_compliant;
5238
+ }
5239
+
5240
+ #--------------------------------------------------------------------------------
5241
+ #region WP Cron Common
5242
+ #--------------------------------------------------------------------------------
5243
+
5244
+ /**
5245
+ * @author Vova Feldman (@svovaf)
5246
+ * @since 2.0.0
5247
+ *
5248
+ * @param string $name Cron name.
5249
+ *
5250
+ * @return object
5251
+ */
5252
+ private function get_cron_data( $name ) {
5253
+ $this->_logger->entrance( $name );
5254
+
5255
+ /**
5256
+ * @var object $cron_data
5257
+ */
5258
+ return $this->_storage->get( "{$name}_cron", null );
5259
+ }
5260
+
5261
+ /**
5262
+ * @author Vova Feldman (@svovaf)
5263
+ * @since 2.0.0
5264
+ *
5265
+ * @param string $name Cron name.
5266
+ */
5267
+ private function clear_cron_data( $name ) {
5268
+ $this->_logger->entrance( $name );
5269
+
5270
+ $this->_storage->remove( "{$name}_cron" );
5271
+ }
5272
+
5273
+ /**
5274
+ * @author Vova Feldman (@svovaf)
5275
+ * @since 2.0.0
5276
+ *
5277
+ * @param string $name Cron name.
5278
+ * @param int $cron_blog_id The cron executing blog ID.
5279
+ */
5280
+ private function set_cron_data( $name, $cron_blog_id = 0 ) {
5281
+ $this->_logger->entrance( $name );
5282
+
5283
+ $this->_storage->store( "{$name}_cron", (object) array(
5284
+ 'version' => $this->get_plugin_version(),
5285
+ 'blog_id' => $cron_blog_id,
5286
+ 'sdk_version' => $this->version,
5287
+ 'timestamp' => WP_FS__SCRIPT_START_TIME,
5288
+ 'on' => true,
5289
+ ) );
5290
+ }
5291
+
5292
+ /**
5293
+ * Get the cron's executing blog ID.
5294
+ *
5295
+ * @author Vova Feldman (@svovaf)
5296
+ * @since 2.0.0
5297
+ *
5298
+ * @param string $name Cron name.
5299
+ *
5300
+ * @return int
5301
+ */
5302
+ private function get_cron_blog_id( $name ) {
5303
+ $this->_logger->entrance( $name );
5304
+
5305
+ /**
5306
+ * @var object $cron_data
5307
+ */
5308
+ $cron_data = $this->get_cron_data( $name );
5309
+
5310
+ return ( is_object( $cron_data ) && is_numeric( $cron_data->blog_id ) ) ?
5311
+ $cron_data->blog_id :
5312
+ 0;
5313
+ }
5314
+
5315
+ /**
5316
+ * @author Vova Feldman (@svovaf)
5317
+ * @since 2.0.0
5318
+ *
5319
+ * @param string $name Cron name.
5320
+ *
5321
+ * @return bool
5322
+ */
5323
+ private function is_cron_on( $name ) {
5324
+ $this->_logger->entrance( $name );
5325
+
5326
+ /**
5327
+ * @var object $cron_data
5328
+ */
5329
+ $cron_data = $this->get_cron_data( $name );
5330
+
5331
+ return ( ! is_null( $cron_data ) && true === $cron_data->on );
5332
+ }
5333
+
5334
+ /**
5335
+ * Unix timestamp for previous cron execution or false if never executed.
5336
+ *
5337
+ * @author Vova Feldman (@svovaf)
5338
+ * @since 2.0.0
5339
+ *
5340
+ * @param string $name Cron name.
5341
+ *
5342
+ * @return int|false
5343
+ */
5344
+ private function cron_last_execution( $name ) {
5345
+ $this->_logger->entrance( $name );
5346
+
5347
+ return $this->_storage->get( "{$name}_timestamp" );
5348
+ }
5349
+
5350
+ /**
5351
+ * Set cron execution time to now.
5352
+ *
5353
+ * @author Vova Feldman (@svovaf)
5354
+ * @since 2.0.0
5355
+ *
5356
+ * @param string $name Cron name.
5357
+ */
5358
+ private function set_cron_execution_timestamp( $name ) {
5359
+ $this->_logger->entrance( $name );
5360
+
5361
+ $this->_storage->store( "{$name}_timestamp", time() );
5362
+ }
5363
+
5364
+ /**
5365
+ * Check if cron was executed in the last $period of seconds.
5366
+ *
5367
+ * @author Vova Feldman (@svovaf)
5368
+ * @since 2.0.0
5369
+ *
5370
+ * @param string $name Cron name.
5371
+ * @param int $period In seconds
5372
+ *
5373
+ * @return bool
5374
+ */
5375
+ private function is_cron_executed( $name, $period = WP_FS__TIME_24_HOURS_IN_SEC ) {
5376
+ $this->_logger->entrance( $name );
5377
+
5378
+ $last_execution = $this->set_cron_execution_timestamp( $name );
5379
+
5380
+ if ( ! is_numeric( $last_execution ) ) {
5381
+ return false;
5382
+ }
5383
+
5384
+ return ( $last_execution > ( WP_FS__SCRIPT_START_TIME - $period ) );
5385
+ }
5386
+
5387
+ /**
5388
+ * WP Cron is executed on a site level. When running in a multisite network environment
5389
+ * with the network integration activated, for optimization reasons, we are consolidating
5390
+ * the installs data sync cron to be executed only from a single site.
5391
+ *
5392
+ * @author Vova Feldman (@svovaf)
5393
+ * @since 2.0.0
5394
+ *
5395
+ * @param int $except_blog_id Target any except the excluded blog ID.
5396
+ *
5397
+ * @return int
5398
+ */
5399
+ private function get_cron_target_blog_id( $except_blog_id = 0 ) {
5400
+ if ( ! is_multisite() ) {
5401
+ return 0;
5402
+ }
5403
+
5404
+ if ( $this->_is_network_active &&
5405
+ is_numeric( $this->_storage->network_install_blog_id ) &&
5406
+ $except_blog_id != $this->_storage->network_install_blog_id &&
5407
+ self::is_site_active( $this->_storage->network_install_blog_id )
5408
+ ) {
5409
+ // Try to run cron from the main network blog.
5410
+ $install = $this->get_install_by_blog_id( $this->_storage->network_install_blog_id );
5411
+
5412
+ if ( is_object( $install ) &&
5413
+ ( $this->is_premium() || $install->is_tracking_allowed() )
5414
+ ) {
5415
+ return $this->_storage->network_install_blog_id;
5416
+ }
5417
+ }
5418
+
5419
+ // Get first opted-in blog ID with active tracking.
5420
+ $installs = $this->get_blog_install_map();
5421
+ foreach ( $installs as $blog_id => $install ) {
5422
+ if ( $except_blog_id != $blog_id &&
5423
+ self::is_site_active( $blog_id ) &&
5424
+ ( $this->is_premium() || $install->is_tracking_allowed() )
5425
+ ) {
5426
+ return $blog_id;
5427
+ }
5428
+ }
5429
+
5430
+ return 0;
5431
+ }
5432
+
5433
+ /**
5434
+ * @author Vova Feldman (@svovaf)
5435
+ * @since 2.0.0
5436
+ *
5437
+ * @param string $name Cron name.
5438
+ * @param string $action_tag Callback action tag.
5439
+ * @param bool $is_network_clear If set to TRUE, clear sync cron even if there are installs that are still connected.
5440
+ */
5441
+ private function clear_cron( $name, $action_tag = '', $is_network_clear = false ) {
5442
+ $this->_logger->entrance( $name );
5443
+
5444
+ if ( ! $this->is_cron_on( $name ) ) {
5445
+ return;
5446
+ }
5447
+
5448
+ $clear_cron = true;
5449
+ if ( ! $is_network_clear && $this->_is_network_active ) {
5450
+ $installs = $this->get_blog_install_map();
5451
+
5452
+ foreach ( $installs as $blog_id => $install ) {
5453
+ /**
5454
+ * @var FS_Site $install
5455
+ */
5456
+ if ( $install->is_tracking_allowed() ) {
5457
+ $clear_cron = false;
5458
+ break;
5459
+ }
5460
+ }
5461
+ }
5462
+
5463
+ if ( ! $clear_cron ) {
5464
+ return;
5465
+ }
5466
+
5467
+ /**
5468
+ * @var object $cron_data
5469
+ */
5470
+ $cron_data = $this->get_cron_data( $name );
5471
+
5472
+ $cron_blog_id = is_object( $cron_data ) && isset( $cron_data->blog_id ) ?
5473
+ $cron_data->blog_id :
5474
+ 0;
5475
+
5476
+ $this->clear_cron_data( $name );
5477
+
5478
+ if ( 0 < $cron_blog_id ) {
5479
+ switch_to_blog( $cron_blog_id );
5480
+ }
5481
+
5482
+ if ( empty( $action_tag ) ) {
5483
+ $action_tag = $name;
5484
+ }
5485
+
5486
+ wp_clear_scheduled_hook( $this->get_action_tag( $action_tag ) );
5487
+
5488
+ if ( 0 < $cron_blog_id ) {
5489
+ restore_current_blog();
5490
+ }
5491
+ }
5492
+
5493
+ /**
5494
+ * Unix timestamp for next cron execution or false if not scheduled.
5495
+ *
5496
+ * @author Vova Feldman (@svovaf)
5497
+ * @since 2.0.0
5498
+ *
5499
+ * @param string $name Cron name.
5500
+ * @param string $action_tag Callback action tag.
5501
+ *
5502
+ * @return int|false
5503
+ */
5504
+ private function get_next_scheduled_cron( $name, $action_tag = '' ) {
5505
+ $this->_logger->entrance( $name );
5506
+
5507
+ if ( ! $this->is_cron_on( $name ) ) {
5508
+ return false;
5509
+ }
5510
+
5511
+ /**
5512
+ * @var object $cron_data
5513
+ */
5514
+ $cron_data = $this->get_cron_data( $name );
5515
+
5516
+ $cron_blog_id = is_object( $cron_data ) && isset( $cron_data->blog_id ) ?
5517
+ $cron_data->blog_id :
5518
+ 0;
5519
+
5520
+ if ( 0 < $cron_blog_id ) {
5521
+ switch_to_blog( $cron_blog_id );
5522
+ }
5523
+
5524
+ if ( empty( $action_tag ) ) {
5525
+ $action_tag = $name;
5526
+ }
5527
+
5528
+ $next_scheduled = wp_next_scheduled( $this->get_action_tag( $action_tag ) );
5529
+
5530
+ if ( 0 < $cron_blog_id ) {
5531
+ restore_current_blog();
5532
+ }
5533
+
5534
+ return $next_scheduled;
5535
+ }
5536
+
5537
+ /**
5538
+ * @author Vova Feldman (@svovaf)
5539
+ * @since 2.0.0
5540
+ *
5541
+ * @param string $name Cron name.
5542
+ * @param string $action_tag Callback action tag.
5543
+ * @param string $recurrence 'single' or 'daily'.
5544
+ * @param int $start_at Defaults to now.
5545
+ * @param bool $randomize_start If true, schedule first job randomly during the next 12 hours. Otherwise, schedule job to start right away.
5546
+ * @param int $except_blog_id Target any except the excluded blog ID.
5547
+ */
5548
+ private function schedule_cron(
5549
+ $name,
5550
+ $action_tag = '',
5551
+ $recurrence = 'single',
5552
+ $start_at = WP_FS__SCRIPT_START_TIME,
5553
+ $randomize_start = true,
5554
+ $except_blog_id = 0
5555
+ ) {
5556
+ $this->_logger->entrance( $name );
5557
+
5558
+ $this->clear_cron( $name, $action_tag, true );
5559
+
5560
+ $cron_blog_id = $this->get_cron_target_blog_id( $except_blog_id );
5561
+
5562
+ if ( is_multisite() && 0 == $cron_blog_id ) {
5563
+ // Don't schedule cron since couldn't find a target blog.
5564
+ return;
5565
+ }
5566
+
5567
+ if ( 0 < $cron_blog_id ) {
5568
+ switch_to_blog( $cron_blog_id );
5569
+ }
5570
+
5571
+ if ( 'daily' === $recurrence ) {
5572
+ if ( $randomize_start ) {
5573
+ // Schedule first sync with a random 12 hour time range from now.
5574
+ $start_at += rand( 0, ( WP_FS__TIME_24_HOURS_IN_SEC / 2 ) );
5575
+ }
5576
+
5577
+ // Schedule daily WP cron.
5578
+ wp_schedule_event(
5579
+ $start_at,
5580
+ 'daily',
5581
+ $this->get_action_tag( $action_tag )
5582
+ );
5583
+ } else if ( 'single' === $recurrence ) {
5584
+ // Schedule single cron.
5585
+ wp_schedule_single_event(
5586
+ $start_at,
5587
+ $this->get_action_tag( $action_tag )
5588
+ );
5589
+ }
5590
+
5591
+ $this->set_cron_data( $name, $cron_blog_id );
5592
+
5593
+ if ( 0 < $cron_blog_id ) {
5594
+ restore_current_blog();
5595
+ }
5596
+ }
5597
+
5598
+ /**
5599
+ * Consolidated cron execution for performance optimization. The max number of API requests is based on the number of unique opted-in users.
5600
+ * that doesn't halt page loading.
5601
+ *
5602
+ * @author Vova Feldman (@svovaf)
5603
+ * @since 2.0.0
5604
+ *
5605
+ * @param string $name Cron name.
5606
+ * @param callable $callable The function that should be executed.
5607
+ */
5608
+ private function execute_cron( $name, $callable ) {
5609
+ $this->_logger->entrance( $name );
5610
+
5611
+ // Store the last time data sync was executed.
5612
+ $this->set_cron_execution_timestamp( $name );
5613
+
5614
+ // Check if API is temporary down.
5615
+ if ( FS_Api::is_temporary_down() ) {
5616
+ return;
5617
+ }
5618
+
5619
+ // @todo Add logic that identifies API latency, and reschedule the next background sync randomly between 8-16 hours.
5620
+
5621
+ $users_2_blog_ids = array();
5622
+
5623
+ if ( ! is_multisite() ) {
5624
+ // Add dummy blog.
5625
+ $users_2_blog_ids[0] = array( 0 );
5626
+ } else {
5627
+ $installs = $this->get_blog_install_map();
5628
+ foreach ( $installs as $blog_id => $install ) {
5629
+ if ( $this->is_premium() || $install->is_tracking_allowed() ) {
5630
+ if ( ! isset( $users_2_blog_ids[ $install->user_id ] ) ) {
5631
+ $users_2_blog_ids[ $install->user_id ] = array();
5632
+ }
5633
+
5634
+ $users_2_blog_ids[ $install->user_id ][] = $blog_id;
5635
+ }
5636
+ }
5637
+ }
5638
+
5639
+ foreach ( $users_2_blog_ids as $user_id => $blog_ids ) {
5640
+ if ( 0 < $blog_ids[0] ) {
5641
+ $this->switch_to_blog( $blog_ids[0] );
5642
+ }
5643
+
5644
+ call_user_func_array( $callable, array( $blog_ids ) );
5645
+
5646
+ foreach ( $blog_ids as $blog_id ) {
5647
+ $this->do_action( "after_{$name}_cron", $blog_id );
5648
+ }
5649
+ }
5650
+
5651
+ if ( is_multisite() ) {
5652
+ $this->do_action( "after_{$name}_cron_multisite" );
5653
+ }
5654
+ }
5655
+
5656
+ #endregion
5657
+
5658
+ #----------------------------------------------------------------------------------
5659
+ #region Daily Sync Cron
5660
+ #----------------------------------------------------------------------------------
5661
+
5662
+
5663
+ /**
5664
+ * @author Vova Feldman (@svovaf)
5665
+ * @since 2.0.0
5666
+ *
5667
+ * @return bool
5668
+ */
5669
+ private function is_sync_cron_scheduled() {
5670
+ return $this->is_cron_on( 'sync' );
5671
+ }
5672
+
5673
+ /**
5674
+ * Get the sync cron's executing blog ID.
5675
+ *
5676
+ * @author Vova Feldman (@svovaf)
5677
+ * @since 2.0.0
5678
+ *
5679
+ * @return int
5680
+ */
5681
+ private function get_sync_cron_blog_id() {
5682
+ return $this->get_cron_blog_id( 'sync' );
5683
+ }
5684
+
5685
+ /**
5686
+ * @author Vova Feldman (@svovaf)
5687
+ * @since 1.1.7.3
5688
+ */
5689
+ private function run_manual_sync() {
5690
+ self::require_pluggable_essentials();
5691
+
5692
+ if ( ! $this->is_user_admin() ) {
5693
+ return;
5694
+ }
5695
+
5696
+ // Run manual sync.
5697
+ $this->_sync_cron();
5698
+
5699
+ // Reschedule next cron to run 24 hours from now (performance optimization).
5700
+ $this->schedule_sync_cron( time() + WP_FS__TIME_24_HOURS_IN_SEC, false );
5701
+ }
5702
+
5703
+ /**
5704
+ * Data sync cron job. Replaces the background sync non blocking HTTP request
5705
+ * that doesn't halt page loading.
5706
+ *
5707
+ * @author Vova Feldman (@svovaf)
5708
+ * @since 1.1.7.3
5709
+ * @since 2.0.0 Consolidate all the data sync into the same cron for performance optimization. The max number of API requests is based on the number of unique opted-in users.
5710
+ */
5711
+ function _sync_cron() {
5712
+ $this->_logger->entrance();
5713
+
5714
+ $this->execute_cron( 'sync', array( &$this, '_sync_cron_method' ) );
5715
+ }
5716
+
5717
+ /**
5718
+ * The actual data sync cron logic.
5719
+ *
5720
+ * @author Vova Feldman (@svovaf)
5721
+ * @since 2.0.0
5722
+ *
5723
+ * @param int[] $blog_ids
5724
+ */
5725
+ function _sync_cron_method( array $blog_ids ) {
5726
+ if ( $this->is_registered() ) {
5727
+ if ( $this->has_paid_plan() ) {
5728
+ // Initiate background plan sync.
5729
+ $this->_sync_license( true );
5730
+
5731
+ if ( $this->is_paying() ) {
5732
+ // Check for premium plugin updates.
5733
+ $this->check_updates( true );
5734
+ }
5735
+ } else {
5736
+ // Sync install(s) (only if something changed locally).
5737
+ if ( 1 < count( $blog_ids ) ) {
5738
+ $this->sync_installs();
5739
+ } else {
5740
+ $this->sync_install();
5741
+ }
5742
+ }
5743
+ }
5744
+ }
5745
+
5746
+ /**
5747
+ * Check if sync was executed in the last $period of seconds.
5748
+ *
5749
+ * @author Vova Feldman (@svovaf)
5750
+ * @since 1.1.7.3
5751
+ *
5752
+ * @param int $period In seconds
5753
+ *
5754
+ * @return bool
5755
+ */
5756
+ private function is_sync_executed( $period = WP_FS__TIME_24_HOURS_IN_SEC ) {
5757
+ return $this->is_cron_executed( 'sync', $period );
5758
+ }
5759
+
5760
+ /**
5761
+ * @author Vova Feldman (@svovaf)
5762
+ * @since 1.1.7.3
5763
+ *
5764
+ * @return bool
5765
+ */
5766
+ private function is_sync_cron_on() {
5767
+ return $this->is_cron_on( 'sync' );
5768
+ }
5769
+
5770
+ /**
5771
+ * @author Vova Feldman (@svovaf)
5772
+ * @since 1.1.7.3
5773
+ *
5774
+ * @param int $start_at Defaults to now.
5775
+ * @param bool $randomize_start If true, schedule first job randomly during the next 12 hours. Otherwise, schedule job to start right away.
5776
+ * @param int $except_blog_id Since 2.0.0 when running in a multisite network environment, the cron execution is consolidated. This param allows excluding excluded specified blog ID from being the cron executor.
5777
+ */
5778
+ private function schedule_sync_cron(
5779
+ $start_at = WP_FS__SCRIPT_START_TIME,
5780
+ $randomize_start = true,
5781
+ $except_blog_id = 0
5782
+ ) {
5783
+ $this->schedule_cron(
5784
+ 'sync',
5785
+ 'data_sync',
5786
+ 'daily',
5787
+ $start_at,
5788
+ $randomize_start,
5789
+ $except_blog_id
5790
+ );
5791
+ }
5792
+
5793
+ /**
5794
+ * Add the actual sync function to the cron job hook.
5795
+ *
5796
+ * @author Vova Feldman (@svovaf)
5797
+ * @since 1.1.7.3
5798
+ */
5799
+ private function hook_callback_to_sync_cron() {
5800
+ $this->add_action( 'data_sync', array( &$this, '_sync_cron' ) );
5801
+ }
5802
+
5803
+ /**
5804
+ * @author Vova Feldman (@svovaf)
5805
+ * @since 1.1.7.3
5806
+ *
5807
+ * @param bool $is_network_clear Since 2.0.0 If set to TRUE, clear sync cron even if there are installs that are still connected.
5808
+ */
5809
+ private function clear_sync_cron( $is_network_clear = false ) {
5810
+ $this->_logger->entrance();
5811
+
5812
+ $this->clear_cron( 'sync', 'data_sync', $is_network_clear );
5813
+ }
5814
+
5815
+ /**
5816
+ * Unix timestamp for next sync cron execution or false if not scheduled.
5817
+ *
5818
+ * @author Vova Feldman (@svovaf)
5819
+ * @since 1.1.7.3
5820
+ *
5821
+ * @return int|false
5822
+ */
5823
+ function next_sync_cron() {
5824
+ return $this->get_next_scheduled_cron( 'sync', 'data_sync' );
5825
+ }
5826
+
5827
+ /**
5828
+ * Unix timestamp for previous sync cron execution or false if never executed.
5829
+ *
5830
+ * @author Vova Feldman (@svovaf)
5831
+ * @since 1.1.7.3
5832
+ *
5833
+ * @return int|false
5834
+ */
5835
+ function last_sync_cron() {
5836
+ return $this->cron_last_execution( 'sync' );
5837
+ }
5838
+
5839
+ #endregion Daily Sync Cron ------------------------------------------------------------------
5840
+
5841
+ #----------------------------------------------------------------------------------
5842
+ #region Async Install Sync
5843
+ #----------------------------------------------------------------------------------
5844
+
5845
+ /**
5846
+ * @author Vova Feldman (@svovaf)
5847
+ * @since 1.1.7.3
5848
+ *
5849
+ * @return bool
5850
+ */
5851
+ private function is_install_sync_scheduled() {
5852
+ return $this->is_cron_on( 'install_sync' );
5853
+ }
5854
+
5855
+ /**
5856
+ * Get the sync cron's executing blog ID.
5857
+ *
5858
+ * @author Vova Feldman (@svovaf)
5859
+ * @since 2.0.0
5860
+ *
5861
+ * @return int
5862
+ */
5863
+ private function get_install_sync_cron_blog_id() {
5864
+ return $this->get_cron_blog_id( 'install_sync' );
5865
+ }
5866
+
5867
+ /**
5868
+ * Instead of running blocking install sync event, execute non blocking scheduled wp-cron.
5869
+ *
5870
+ * @author Vova Feldman (@svovaf)
5871
+ * @since 1.1.7.3
5872
+ *
5873
+ * @param int $except_blog_id Since 2.0.0 when running in a multisite network environment, the cron execution is consolidated. This param allows excluding excluded specified blog ID from being the cron executor.
5874
+ */
5875
+ private function schedule_install_sync( $except_blog_id = 0 ) {
5876
+ $this->schedule_cron( 'install_sync', 'install_sync', 'single', 0, false, $except_blog_id );
5877
+ }
5878
+
5879
+ /**
5880
+ * Unix timestamp for previous install sync cron execution or false if never executed.
5881
+ *
5882
+ * @todo There's some very strange bug that $this->_storage->install_sync_timestamp value is not being updated. But for sure the sync event is working.
5883
+ *
5884
+ * @author Vova Feldman (@svovaf)
5885
+ * @since 1.1.7.3
5886
+ *
5887
+ * @return int|false
5888
+ */
5889
+ function last_install_sync() {
5890
+ return $this->cron_last_execution( 'install_sync' );
5891
+ }
5892
+
5893
+ /**
5894
+ * Unix timestamp for next install sync cron execution or false if not scheduled.
5895
+ *
5896
+ * @author Vova Feldman (@svovaf)
5897
+ * @since 1.1.7.3
5898
+ *
5899
+ * @return int|false
5900
+ */
5901
+ function next_install_sync() {
5902
+ return $this->get_next_scheduled_cron( 'install_sync', 'install_sync' );
5903
+ }
5904
+
5905
+ /**
5906
+ * Add the actual install sync function to the cron job hook.
5907
+ *
5908
+ * @author Vova Feldman (@svovaf)
5909
+ * @since 1.1.7.3
5910
+ */
5911
+ private function hook_callback_to_install_sync() {
5912
+ $this->add_action( 'install_sync', array( &$this, '_run_sync_install' ) );
5913
+ }
5914
+
5915
+ /**
5916
+ * @author Vova Feldman (@svovaf)
5917
+ * @since 1.1.7.3
5918
+ *
5919
+ * @param bool $is_network_clear Since 2.0.0 If set to TRUE, clear sync cron even if there are installs that are still connected.
5920
+ */
5921
+ private function clear_install_sync_cron( $is_network_clear = false ) {
5922
+ $this->_logger->entrance();
5923
+
5924
+ $this->clear_cron( 'install_sync', 'install_sync', $is_network_clear );
5925
+ }
5926
+
5927
+ /**
5928
+ * @author Vova Feldman (@svovaf)
5929
+ * @since 1.1.7.3
5930
+ * @since 2.0.0 Consolidate all the data sync into the same cron for performance optimization. The max number of API requests is based on the number of unique opted-in users.
5931
+ */
5932
+ public function _run_sync_install() {
5933
+ $this->_logger->entrance();
5934
+
5935
+ $this->execute_cron( 'sync', array( &$this, '_sync_install_cron_method' ) );
5936
+ }
5937
+
5938
+ /**
5939
+ * The actual install(s) sync cron logic.
5940
+ *
5941
+ * @author Vova Feldman (@svovaf)
5942
+ * @since 2.0.0
5943
+ *
5944
+ * @param int[] $blog_ids
5945
+ */
5946
+ function _sync_install_cron_method( array $blog_ids ) {
5947
+ if ( $this->is_registered() ) {
5948
+ if ( 1 < count( $blog_ids ) ) {
5949
+ $this->sync_installs( array(), true );
5950
+ } else {
5951
+ $this->sync_install( array(), true );
5952
+ }
5953
+ }
5954
+ }
5955
+
5956
+ #endregion Async Install Sync ------------------------------------------------------------------
5957
+
5958
+ /**
5959
+ * Show a notice that activation is currently pending.
5960
+ *
5961
+ * @author Vova Feldman (@svovaf)
5962
+ * @since 1.0.7
5963
+ *
5964
+ * @param bool|string $email
5965
+ * @param bool $is_pending_trial Since 1.2.1.5
5966
+ */
5967
+ function _add_pending_activation_notice( $email = false, $is_pending_trial = false ) {
5968
+ if ( ! is_string( $email ) ) {
5969
+ $current_user = self::_get_current_wp_user();
5970
+ $email = $current_user->user_email;
5971
+ }
5972
+
5973
+ $this->_admin_notices->add_sticky(
5974
+ sprintf(
5975
+ $this->get_text_inline( 'You should receive an activation email for %s to your mailbox at %s. Please make sure you click the activation button in that email to %s.', 'pending-activation-message' ),
5976
+ '<b>' . $this->get_plugin_name() . '</b>',
5977
+ '<b>' . $email . '</b>',
5978
+ ( $is_pending_trial ?
5979
+ $this->get_text_inline( 'start the trial', 'start-the-trial' ) :
5980
+ $this->get_text_inline( 'complete the install', 'complete-the-install' ) )
5981
+ ),
5982
+ 'activation_pending',
5983
+ 'Thanks!'
5984
+ );
5985
+ }
5986
+
5987
+ /**
5988
+ * Check if currently in plugin activation.
5989
+ *
5990
+ * @author Vova Feldman (@svovaf)
5991
+ * @since 1.1.4
5992
+ *
5993
+ * @return bool
5994
+ */
5995
+ function is_plugin_activation() {
5996
+ return get_option( 'fs_'
5997
+ . ( $this->is_plugin() ? '' : $this->_module_type . '_' )
5998
+ . "{$this->_slug}_activated", false );
5999
+ }
6000
+
6001
+ /**
6002
+ *
6003
+ * NOTE: admin_menu action executed before admin_init.
6004
+ *
6005
+ * @author Vova Feldman (@svovaf)
6006
+ * @since 1.0.7
6007
+ */
6008
+ function _admin_init_action() {
6009
+ /**
6010
+ * Automatically redirect to connect/activation page after plugin activation.
6011
+ *
6012
+ * @since 1.1.7 Do NOT redirect to opt-in when running in network admin mode.
6013
+ */
6014
+ if ( $this->is_plugin_activation() ) {
6015
+ delete_option( 'fs_'
6016
+ . ( $this->is_plugin() ? '' : $this->_module_type . '_' )
6017
+ . "{$this->_slug}_activated" );
6018
+
6019
+ $this->_redirect_on_activation_hook();
6020
+
6021
+ return;
6022
+ }
6023
+
6024
+ if ( fs_request_is_action( $this->get_unique_affix() . '_skip_activation' ) ) {
6025
+ check_admin_referer( $this->get_unique_affix() . '_skip_activation' );
6026
+
6027
+ $this->skip_connection( null, fs_is_network_admin() );
6028
+
6029
+ fs_redirect( $this->get_after_activation_url( 'after_skip_url' ) );
6030
+ }
6031
+
6032
+ if ( $this->is_network_activation_mode() &&
6033
+ fs_request_is_action( $this->get_unique_affix() . '_delegate_activation' )
6034
+ ) {
6035
+ check_admin_referer( $this->get_unique_affix() . '_delegate_activation' );
6036
+
6037
+ $this->delegate_connection();
6038
+
6039
+ fs_redirect( $this->get_after_activation_url( 'after_delegation_url' ) );
6040
+ }
6041
+
6042
+ if ( ! $this->is_addon() &&
6043
+ (
6044
+ // Not registered nor anonymous.
6045
+ ( ! $this->is_registered() && ! $this->is_anonymous() ) ||
6046
+ // OR, network level and in network upgrade mode.
6047
+ ( fs_is_network_admin() && $this->_is_network_active && $this->is_network_upgrade_mode() )
6048
+ )
6049
+ ) {
6050
+ if ( ! $this->is_pending_activation() ) {
6051
+ if ( ! $this->_menu->is_main_settings_page() ) {
6052
+ /**
6053
+ * If a user visits any other admin page before activating the premium-only theme with a valid
6054
+ * license, reactivate the previous theme.
6055
+ *
6056
+ * @author Leo Fajardo (@leorw)
6057
+ * @since 1.2.2
6058
+ */
6059
+ if ( $this->is_theme()
6060
+ && $this->is_only_premium()
6061
+ && ! $this->has_settings_menu()
6062
+ && ! isset( $_REQUEST['fs_action'] )
6063
+ && $this->can_activate_previous_theme()
6064
+ ) {
6065
+ $this->activate_previous_theme();
6066
+
6067
+ return;
6068
+ }
6069
+
6070
+ if ( ! fs_is_network_admin() &&
6071
+ $this->is_network_activation_mode() &&
6072
+ ! $this->is_delegated_connection()
6073
+ ) {
6074
+ return;
6075
+ }
6076
+
6077
+ if ( $this->is_plugin_new_install() || $this->is_only_premium() ) {
6078
+ // Show notice for new plugin installations.
6079
+ $this->_admin_notices->add(
6080
+ sprintf(
6081
+ $this->get_text_inline( 'You are just one step away - %s', 'you-are-step-away' ),
6082
+ sprintf( '<b><a href="%s">%s</a></b>',
6083
+ $this->get_activation_url( array(), ! $this->is_delegated_connection() ),
6084
+ sprintf( $this->get_text_x_inline( 'Complete "%s" Activation Now',
6085
+ '%s - plugin name. As complete "PluginX" activation now', 'activate-x-now' ), $this->get_plugin_name() )
6086
+ )
6087
+ ),
6088
+ '',
6089
+ 'update-nag'
6090
+ );
6091
+ } else {
6092
+ if ( $this->should_add_sticky_optin_notice() ) {
6093
+ $this->add_sticky_optin_admin_notice();
6094
+ }
6095
+
6096
+ if ( $this->has_filter( 'optin_pointer_element' ) ) {
6097
+ // Don't show admin nag if plugin update.
6098
+ wp_enqueue_script( 'wp-pointer' );
6099
+ wp_enqueue_style( 'wp-pointer' );
6100
+
6101
+ $this->_enqueue_connect_essentials();
6102
+
6103
+ add_action( 'admin_print_footer_scripts', array(
6104
+ $this,
6105
+ '_add_connect_pointer_script'
6106
+ ) );
6107
+ }
6108
+ }
6109
+ }
6110
+ }
6111
+
6112
+ if ( $this->is_theme() &&
6113
+ $this->_menu->is_main_settings_page()
6114
+ ) {
6115
+ $this->_show_theme_activation_optin_dialog();
6116
+ }
6117
+ }
6118
+
6119
+ $this->_add_upgrade_action_link();
6120
+ }
6121
+
6122
+ /**
6123
+ * @author Vova Feldman (@svovaf)
6124
+ * @since 2.0.0
6125
+ *
6126
+ * @return bool
6127
+ */
6128
+ private function should_add_sticky_optin_notice() {
6129
+ if ( fs_is_network_admin() ) {
6130
+ if ( ! $this->_is_network_active ) {
6131
+ return false;
6132
+ }
6133
+
6134
+ if ( ! $this->is_network_activation_mode() ) {
6135
+ return false;
6136
+ }
6137
+
6138
+ return ! isset( $this->_storage->sticky_optin_added_ms );
6139
+ }
6140
+
6141
+ if ( ! $this->is_activation_mode() ) {
6142
+ return false;
6143
+ }
6144
+
6145
+ // If running from a blog admin and delegated the connection.
6146
+ return ! isset( $this->_storage->sticky_optin_added );
6147
+ }
6148
+
6149
+ /**
6150
+ * @author Leo Fajardo (@leorw)
6151
+ * @since 2.0.0
6152
+ */
6153
+ private function add_sticky_optin_admin_notice() {
6154
+ if ( ! $this->_is_network_active || ! fs_is_network_admin() ) {
6155
+ $this->_storage->sticky_optin_added = true;
6156
+ } else {
6157
+ $this->_storage->sticky_optin_added_ms = true;
6158
+ }
6159
+
6160
+ // Show notice for new plugin installations.
6161
+ $this->_admin_notices->add_sticky(
6162
+ sprintf(
6163
+ $this->get_text_inline( 'We made a few tweaks to the %s, %s', 'few-plugin-tweaks' ),
6164
+ $this->_module_type,
6165
+ sprintf( '<b><a href="%s">%s</a></b>',
6166
+ $this->get_activation_url(),
6167
+ sprintf( $this->get_text_inline( 'Opt in to make "%s" Better!', 'optin-x-now' ), $this->get_plugin_name() )
6168
+ )
6169
+ ),
6170
+ 'connect_account',
6171
+ '',
6172
+ 'update-nag'
6173
+ );
6174
+ }
6175
+
6176
+ /**
6177
+ * Enqueue connect requires scripts and styles.
6178
+ *
6179
+ * @author Vova Feldman (@svovaf)
6180
+ * @since 1.1.4
6181
+ */
6182
+ function _enqueue_connect_essentials() {
6183
+ wp_enqueue_script( 'jquery' );
6184
+ wp_enqueue_script( 'json2' );
6185
+
6186
+ fs_enqueue_local_script( 'postmessage', 'nojquery.ba-postmessage.min.js' );
6187
+ fs_enqueue_local_script( 'fs-postmessage', 'postmessage.js' );
6188
+
6189
+ fs_enqueue_local_style( 'fs_connect', '/admin/connect.css' );
6190
+ }
6191
+
6192
+ /**
6193
+ * Add connect / opt-in pointer.
6194
+ *
6195
+ * @author Vova Feldman (@svovaf)
6196
+ * @since 1.1.4
6197
+ */
6198
+ function _add_connect_pointer_script() {
6199
+ $vars = array( 'id' => $this->_module_id );
6200
+ $pointer_content = fs_get_template( 'connect.php', $vars );
6201
+ ?>
6202
+ <script type="text/javascript">// <![CDATA[
6203
+ jQuery(document).ready(function ($) {
6204
+ if ('undefined' !== typeof(jQuery().pointer)) {
6205
+
6206
+ var element = <?php echo $this->apply_filters( 'optin_pointer_element', '$("#non_existing_element");' ) ?>;
6207
+
6208
+ if (element.length > 0) {
6209
+ var optin = $(element).pointer($.extend(true, {}, {
6210
+ content : <?php echo json_encode( $pointer_content ) ?>,
6211
+ position : {
6212
+ edge : 'left',
6213
+ align: 'center'
6214
+ },
6215
+ buttons : function () {
6216
+ // Don't show pointer buttons.
6217
+ return '';
6218
+ },
6219
+ pointerWidth: 482
6220
+ }, <?php echo $this->apply_filters( 'optin_pointer_options_json', '{}' ) ?>));
6221
+
6222
+ <?php
6223
+ echo $this->apply_filters( 'optin_pointer_execute', "
6224
+
6225
+ optin.pointer('open');
6226
+
6227
+ // Tag the opt-in pointer with custom class.
6228
+ $('.wp-pointer #fs_connect')
6229
+ .parents('.wp-pointer.wp-pointer-top')
6230
+ .addClass('fs-opt-in-pointer');
6231
+
6232
+ ", 'element', 'optin' ) ?>
6233
+ }
6234
+ }
6235
+ });
6236
+ // ]]></script>
6237
+ <?php
6238
+ }
6239
+
6240
+ /**
6241
+ * Return current page's URL.
6242
+ *
6243
+ * @author Vova Feldman (@svovaf)
6244
+ * @since 1.0.7
6245
+ *
6246
+ * @return string
6247
+ */
6248
+ function current_page_url() {
6249
+ $url = 'http';
6250
+
6251
+ if ( isset( $_SERVER["HTTPS"] ) ) {
6252
+ if ( $_SERVER["HTTPS"] == "on" ) {
6253
+ $url .= "s";
6254
+ }
6255
+ }
6256
+ $url .= "://";
6257
+ if ( $_SERVER["SERVER_PORT"] != "80" ) {
6258
+ $url .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
6259
+ } else {
6260
+ $url .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
6261
+ }
6262
+
6263
+ return esc_url( $url );
6264
+ }
6265
+
6266
+ /**
6267
+ * Check if the current page is the plugin's main admin settings page.
6268
+ *
6269
+ * @author Vova Feldman (@svovaf)
6270
+ * @since 1.0.7
6271
+ *
6272
+ * @return bool
6273
+ */
6274
+ function _is_plugin_page() {
6275
+ return fs_is_plugin_page( $this->_menu->get_raw_slug() ) ||
6276
+ fs_is_plugin_page( $this->_slug );
6277
+ }
6278
+
6279
+ /* Events
6280
+ ------------------------------------------------------------------------------------------------------------------*/
6281
+ /**
6282
+ * Delete site install from Database.
6283
+ *
6284
+ * @author Vova Feldman (@svovaf)
6285
+ * @since 1.0.1
6286
+ *
6287
+ * @param bool $store
6288
+ * @param int|null $blog_id Since 2.0.0
6289
+ *
6290
+ * @return false|int The install ID if deleted. Otherwise, FALSE (when install not exist).
6291
+ */
6292
+ function _delete_site( $store = true, $blog_id = null ) {
6293
+ return self::_delete_site_by_slug( $this->_slug, $this->_module_type, $store, $blog_id );
6294
+ }
6295
+
6296
+ /**
6297
+ * Delete site install from Database.
6298
+ *
6299
+ * @author Vova Feldman (@svovaf)
6300
+ * @since 1.2.2.7
6301
+ *
6302
+ * @param string $slug
6303
+ * @param string $module_type
6304
+ * @param bool $store
6305
+ * @param int|null $blog_id Since 2.0.0
6306
+ *
6307
+ * @return false|int The install ID if deleted. Otherwise, FALSE (when install not exist).
6308
+ */
6309
+ static function _delete_site_by_slug( $slug, $module_type, $store = true, $blog_id = null ) {
6310
+ $sites = self::get_all_sites( $module_type, $blog_id );
6311
+
6312
+ $install_id = false;
6313
+
6314
+ if ( isset( $sites[ $slug ] ) ) {
6315
+ if ( is_object( $sites[ $slug ] ) ) {
6316
+ $install_id = $sites[ $slug ]->id;
6317
+ }
6318
+
6319
+ unset( $sites[ $slug ] );
6320
+
6321
+ self::set_account_option_by_module( $module_type, 'sites', $sites, $store, $blog_id );
6322
+ }
6323
+
6324
+ return $install_id;
6325
+ }
6326
+
6327
+ /**
6328
+ * Delete user.
6329
+ *
6330
+ * @author Vova Feldman (@svovaf)
6331
+ * @since 2.0.0
6332
+ *
6333
+ * @param number $user_id
6334
+ * @param bool $store
6335
+ *
6336
+ * @return false|int The user ID if deleted. Otherwise, FALSE (when install not exist).
6337
+ */
6338
+ private static function delete_user( $user_id, $store = true ) {
6339
+ $users = self::get_all_users();
6340
+
6341
+ if ( ! is_array( $users ) || ! isset( $users[ $user_id ] ) ) {
6342
+ return false;
6343
+ }
6344
+
6345
+ unset( $users[ $user_id ] );
6346
+
6347
+ self::$_accounts->set_option( 'users', $users, $store );
6348
+
6349
+ return $user_id;
6350
+ }
6351
+
6352
+ /**
6353
+ * Delete plugin's plans information.
6354
+ *
6355
+ * @param bool $store Flush to Database if true.
6356
+ * @param bool $keep_associated_plans If set to false, delete all plans, even if a plan is associated with an install.
6357
+ *
6358
+ * @author Vova Feldman (@svovaf)
6359
+ * @since 1.0.9
6360
+ */
6361
+ private function _delete_plans( $store = true, $keep_associated_plans = true ) {
6362
+ $this->_logger->entrance();
6363
+
6364
+ $plans = self::get_all_plans( $this->_module_type );
6365
+
6366
+ $plans_to_keep = array();
6367
+
6368
+ if ( $keep_associated_plans ) {
6369
+ $plans_ids_to_keep = $this->get_plans_ids_associated_with_installs();
6370
+ foreach ( $plans_ids_to_keep as $plan_id ) {
6371
+ $plan = self::_get_plan_by_id( $plan_id );
6372
+ if ( is_object( $plan ) ) {
6373
+ $plans_to_keep[] = $plan;
6374
+ }
6375
+ }
6376
+ }
6377
+
6378
+ if ( ! empty( $plans_to_keep ) ) {
6379
+ $plans[ $this->_slug ] = $plans_to_keep;
6380
+ } else {
6381
+ unset( $plans[ $this->_slug ] );
6382
+ }
6383
+
6384
+ $this->set_account_option( 'plans', $plans, $store );
6385
+ }
6386
+
6387
+ /**
6388
+ * Delete all plugin licenses.
6389
+ *
6390
+ * @author Vova Feldman (@svovaf)
6391
+ * @since 1.0.9
6392
+ *
6393
+ * @param bool $store
6394
+ */
6395
+ private function _delete_licenses( $store = true ) {
6396
+ $this->_logger->entrance();
6397
+
6398
+ $all_licenses = self::get_all_licenses();
6399
+
6400
+ unset( $all_licenses[ $this->_module_id ] );
6401
+
6402
+ self::$_accounts->set_option( 'all_licenses', $all_licenses, $store );
6403
+ }
6404
+
6405
+ /**
6406
+ * Check if Freemius was added on new plugin installation.
6407
+ *
6408
+ * @author Vova Feldman (@svovaf)
6409
+ * @since 1.1.5
6410
+ *
6411
+ * @return bool
6412
+ */
6413
+ function is_plugin_new_install() {
6414
+ return isset( $this->_storage->is_plugin_new_install ) &&
6415
+ $this->_storage->is_plugin_new_install;
6416
+ }
6417
+
6418
+ /**
6419
+ * Check if it's the first plugin release that is running Freemius.
6420
+ *
6421
+ * @author Vova Feldman (@svovaf)
6422
+ * @since 1.2.1.5
6423
+ *
6424
+ * @return bool
6425
+ */
6426
+ function is_first_freemius_powered_version() {
6427
+ return empty( $this->_storage->plugin_last_version );
6428
+ }
6429
+
6430
+ /**
6431
+ * @author Leo Fajardo (@leorw)
6432
+ * @since 1.2.2
6433
+ *
6434
+ * @return bool|string
6435
+ */
6436
+ private function get_previous_theme_slug() {
6437
+ return isset( $this->_storage->previous_theme ) ?
6438
+ $this->_storage->previous_theme :
6439
+ false;
6440
+ }
6441
+
6442
+ /**
6443
+ * @author Leo Fajardo (@leorw)
6444
+ * @since 1.2.2
6445
+ *
6446
+ * @return string
6447
+ */
6448
+ private function can_activate_previous_theme() {
6449
+ $slug = $this->get_previous_theme_slug();
6450
+ if ( false !== $slug && current_user_can( 'switch_themes' ) ) {
6451
+ $theme_instance = wp_get_theme( $slug );
6452
+
6453
+ return $theme_instance->exists();
6454
+ }
6455
+
6456
+ return false;
6457
+ }
6458
+
6459
+ /**
6460
+ * @author Leo Fajardo (@leorw)
6461
+ * @since 1.2.2
6462
+ *
6463
+ * @return string
6464
+ */
6465
+ private function activate_previous_theme() {
6466
+ switch_theme( $this->get_previous_theme_slug() );
6467
+ unset( $this->_storage->previous_theme );
6468
+
6469
+ global $pagenow;
6470
+ if ( 'themes.php' === $pagenow ) {
6471
+ /**
6472
+ * Refresh the active theme information.
6473
+ *
6474
+ * @author Leo Fajardo (@leorw)
6475
+ * @since 1.2.2
6476
+ */
6477
+ fs_redirect( $this->admin_url( $pagenow ) );
6478
+ }
6479
+ }
6480
+
6481
+ /**
6482
+ * @author Leo Fajardo (@leorw)
6483
+ * @since 1.2.2
6484
+ *
6485
+ * @return string
6486
+ */
6487
+ function get_previous_theme_activation_url() {
6488
+ if ( ! $this->can_activate_previous_theme() ) {
6489
+ return '';
6490
+ }
6491
+
6492
+ /**
6493
+ * Activation URL
6494
+ *
6495
+ * @author Leo Fajardo (@leorw)
6496
+ * @since 1.2.2
6497
+ */
6498
+ return wp_nonce_url(
6499
+ $this->admin_url( 'themes.php?action=activate&stylesheet=' . urlencode( $this->get_previous_theme_slug() ) ),
6500
+ 'switch-theme_' . $this->get_previous_theme_slug()
6501
+ );
6502
+ }
6503
+
6504
+ /**
6505
+ * Saves the slug of the previous theme if it still exists so that it can be used by the logic in the opt-in
6506
+ * form that decides whether to add a close button to the opt-in dialog or not. So after a premium-only theme is
6507
+ * activated, the close button will appear and will reactivate the previous theme if clicked. If the previous
6508
+ * theme doesn't exist, then there will be no close button.
6509
+ *
6510
+ * @author Leo Fajardo (@leorw)
6511
+ * @since 1.2.2
6512
+ *
6513
+ * @param string $slug_or_name Old theme's slug or name.
6514
+ * @param bool|WP_Theme $old_theme WP_Theme instance of the old theme if it still exists.
6515
+ */
6516
+ function _activate_theme_event_hook( $slug_or_name, $old_theme = false ) {
6517
+ $this->_storage->previous_theme = ( false !== $old_theme ) ?
6518
+ $old_theme->get_stylesheet() :
6519
+ $slug_or_name;
6520
+
6521
+ $this->_activate_plugin_event_hook();
6522
+ }
6523
+
6524
+ /**
6525
+ * Plugin activated hook.
6526
+ *
6527
+ * @author Vova Feldman (@svovaf)
6528
+ * @since 1.0.1
6529
+ *
6530
+ * @uses FS_Api
6531
+ */
6532
+ function _activate_plugin_event_hook() {
6533
+ $this->_logger->entrance( 'slug = ' . $this->_slug );
6534
+
6535
+ if ( ! $this->is_user_admin() ) {
6536
+ return;
6537
+ }
6538
+
6539
+ $this->unregister_uninstall_hook();
6540
+
6541
+ // Clear API cache on activation.
6542
+ FS_Api::clear_cache();
6543
+
6544
+ $is_premium_version_activation = ( current_filter() !== ( 'activate_' . $this->_free_plugin_basename ) );
6545
+
6546
+ $this->_logger->info( 'Activating ' . ( $is_premium_version_activation ? 'premium' : 'free' ) . ' plugin version.' );
6547
+
6548
+ // 1. If running in the activation of the FREE module, get the basename of the PREMIUM.
6549
+ // 2. If running in the activation of the PREMIUM module, get the basename of the FREE.
6550
+ $other_version_basename = $is_premium_version_activation ?
6551
+ $this->_free_plugin_basename :
6552
+ $this->premium_plugin_basename();
6553
+
6554
+ if ( ! $this->_is_network_active ) {
6555
+ /**
6556
+ * During the activation, the plugin isn't yet active, therefore,
6557
+ * _is_network_active will be set to false even if it's a network level
6558
+ * activation. So we need to fix that by looking at the is_network_admin() value.
6559
+ *
6560
+ * @author Vova Feldman
6561
+ */
6562
+ $this->_is_network_active = (
6563
+ $this->_is_multisite_integrated &&
6564
+ // Themes are always network activated, but the ACTUAL activation is per site.
6565
+ $this->is_plugin() &&
6566
+ fs_is_network_admin()
6567
+ );
6568
+ }
6569
+
6570
+ /**
6571
+ * If the other module version is activate, deactivate it.
6572
+ *
6573
+ * is_plugin_active() checks if the plugin active on the site or the network level
6574
+ * and deactivate_plugins() deactivates the plugin whether its activated on the site
6575
+ * or network level.
6576
+ *
6577
+ * @author Leo Fajardo (@leorw)
6578
+ * @since 1.2.2
6579
+ */
6580
+ if ( is_plugin_active( $other_version_basename ) ) {
6581
+ deactivate_plugins( $other_version_basename );
6582
+ }
6583
+
6584
+ if ( $this->is_registered() ) {
6585
+ if ( $is_premium_version_activation ) {
6586
+ $this->reconnect_locally();
6587
+ }
6588
+
6589
+
6590
+ // Schedule re-activation event and sync.
6591
+ // $this->sync_install( array(), true );
6592
+ $this->schedule_install_sync();
6593
+
6594
+ // If activating the premium module version, add an admin notice to congratulate for an upgrade completion.
6595
+ if ( $is_premium_version_activation ) {
6596
+ $this->_admin_notices->add(
6597
+ sprintf( $this->get_text_inline( 'The upgrade of %s was successfully completed.', 'successful-version-upgrade-message' ), sprintf( '<b>%s</b>', $this->_plugin->title ) ),
6598
+ $this->get_text_x_inline( 'W00t',
6599
+ 'Used to express elation, enthusiasm, or triumph (especially in electronic communication).', 'woot' ) . '!'
6600
+ );
6601
+ }
6602
+ } else if ( $this->is_anonymous() ) {
6603
+ if ( isset( $this->_storage->is_anonymous_ms ) && $this->_storage->is_anonymous_ms['is'] ) {
6604
+ $plugin_version = $this->_storage->is_anonymous_ms['version'];
6605
+ $network = true;
6606
+ } else {
6607
+ $plugin_version = $this->_storage->is_anonymous['version'];
6608
+ $network = false;
6609
+ }
6610
+
6611
+ /**
6612
+ * Reset "skipped" click cache on the following:
6613
+ * 1. Freemius DEV mode.
6614
+ * 2. WordPress DEBUG mode.
6615
+ * 3. If a plugin and the user skipped the exact same version before.
6616
+ *
6617
+ * @since 1.2.2.7 Ulrich Pogson (@grapplerulrich) asked to not reset the SKIPPED flag if the exact same THEME version was activated before unless the developer is running with WP_DEBUG on, or Freemius debug mode on (WP_FS__DEV_MODE).
6618
+ *
6619
+ * @todo 4. If explicitly asked to retry after every activation.
6620
+ */
6621
+ if ( WP_FS__DEV_MODE ||
6622
+ (
6623
+ ( $this->is_plugin() || ( defined( 'WP_DEBUG' ) && WP_DEBUG ) ) &&
6624
+ $this->get_plugin_version() == $plugin_version
6625
+ )
6626
+ ) {
6627
+ $this->reset_anonymous_mode( $network );
6628
+ }
6629
+ }
6630
+
6631
+ if ( ! isset( $this->_storage->is_plugin_new_install ) ) {
6632
+ /**
6633
+ * If no previous version of plugin's version exist, it means that it's either
6634
+ * the first time that the plugin installed on the site, or the plugin was installed
6635
+ * before but didn't have Freemius integrated.
6636
+ *
6637
+ * Since register_activation_hook() do NOT fires on updates since 3.1, and only fires
6638
+ * on manual activation via the dashboard, is_plugin_activation() is TRUE
6639
+ * only after immediate activation.
6640
+ *
6641
+ * @since 1.1.4
6642
+ * @link https://make.wordpress.org/core/2010/10/27/plugin-activation-hooks-no-longer-fire-for-updates/
6643
+ */
6644
+ $this->_storage->is_plugin_new_install = empty( $this->_storage->plugin_last_version );
6645
+ }
6646
+
6647
+ if ( ! $this->_anonymous_mode &&
6648
+ $this->has_api_connectivity( WP_FS__DEV_MODE ) &&
6649
+ ! $this->_isAutoInstall
6650
+ ) {
6651
+ // Store hint that the plugin was just activated to enable auto-redirection to settings.
6652
+ add_option( 'fs_'
6653
+ . ( $this->is_plugin() ? '' : $this->_module_type . '_' )
6654
+ . "{$this->_slug}_activated", true );
6655
+ }
6656
+
6657
+ /**
6658
+ * Activation hook is executed after the plugin's main file is loaded, therefore,
6659
+ * after the plugin was loaded. The logic is located at activate_plugin()
6660
+ * ./wp-admin/includes/plugin.php.
6661
+ *
6662
+ * @author Vova Feldman (@svovaf)
6663
+ * @since 1.1.9
6664
+ */
6665
+ $this->_storage->was_plugin_loaded = true;
6666
+ }
6667
+
6668
+ /**
6669
+ * Delete account.
6670
+ *
6671
+ * @author Vova Feldman (@svovaf)
6672
+ * @since 1.0.3
6673
+ *
6674
+ * @param bool $check_user Enforce checking if user have plugins activation privileges.
6675
+ */
6676
+ function delete_account_event( $check_user = true ) {
6677
+ $this->_logger->entrance( 'slug = ' . $this->_slug );
6678
+
6679
+ if ( $check_user && ! $this->is_user_admin() ) {
6680
+ return;
6681
+ }
6682
+
6683
+ $this->do_action( 'before_account_delete' );
6684
+
6685
+ // Clear all admin notices.
6686
+ $this->_admin_notices->clear_all_sticky( false );
6687
+
6688
+ $this->_delete_site( false );
6689
+
6690
+ $delete_network_common_data = true;
6691
+
6692
+ if ( $this->_is_network_active ) {
6693
+ $installs = $this->get_blog_install_map();
6694
+
6695
+ // Don't delete common network data unless no other installs left.
6696
+ $delete_network_common_data = empty( $installs );
6697
+ }
6698
+
6699
+ if ( $delete_network_common_data ) {
6700
+ $this->_delete_plans( false );
6701
+
6702
+ $this->_delete_licenses( false );
6703
+
6704
+ // Delete add-ons related to plugin's account.
6705
+ $this->_delete_account_addons( false );
6706
+ }
6707
+
6708
+ // @todo Delete plans and licenses of add-ons.
6709
+
6710
+ self::$_accounts->store();
6711
+
6712
+ /**
6713
+ * IMPORTANT:
6714
+ * Clear crons must be executed before clearing all storage.
6715
+ * Otherwise, the cron will not be cleared.
6716
+ */
6717
+ if ( $delete_network_common_data ) {
6718
+ $this->clear_sync_cron();
6719
+ }
6720
+
6721
+ $this->clear_install_sync_cron();
6722
+
6723
+ // Clear all storage data.
6724
+ $this->_storage->clear_all( true, array(
6725
+ 'connectivity_test',
6726
+ 'is_on',
6727
+ ), false );
6728
+
6729
+ // Send delete event.
6730
+ $this->get_api_site_scope()->call( '/', 'delete' );
6731
+
6732
+ $this->do_action( 'after_account_delete' );
6733
+ }
6734
+
6735
+ /**
6736
+ * Delete network level account.
6737
+ *
6738
+ * @author Vova Feldman (@svovaf)
6739
+ * @since 2.0.0
6740
+ *
6741
+ * @param bool $check_user Enforce checking if user have plugins activation privileges.
6742
+ */
6743
+ function delete_network_account_event( $check_user = true ) {
6744
+ $this->_logger->entrance( 'slug = ' . $this->_slug );
6745
+
6746
+ if ( $check_user && ! $this->is_user_admin() ) {
6747
+ return;
6748
+ }
6749
+
6750
+ $this->do_action( 'before_network_account_delete' );
6751
+
6752
+ // Clear all admin notices.
6753
+ $this->_admin_notices->clear_all_sticky();
6754
+
6755
+ $this->_delete_plans( false, false );
6756
+
6757
+ $this->_delete_licenses( false );
6758
+
6759
+ // Delete add-ons related to plugin's account.
6760
+ $this->_delete_account_addons( false );
6761
+
6762
+ // @todo Delete plans and licenses of add-ons.
6763
+
6764
+ self::$_accounts->store( true );
6765
+
6766
+ /**
6767
+ * IMPORTANT:
6768
+ * Clear crons must be executed before clearing all storage.
6769
+ * Otherwise, the cron will not be cleared.
6770
+ */
6771
+ $this->clear_sync_cron( true );
6772
+ $this->clear_install_sync_cron( true );
6773
+
6774
+ $sites = self::get_sites();
6775
+
6776
+ $install_ids = array();
6777
+ foreach ( $sites as $site ) {
6778
+ $blog_id = self::get_site_blog_id( $site );
6779
+
6780
+ $install_id = $this->_delete_site( true, $blog_id );
6781
+
6782
+ // Clear all storage data.
6783
+ $this->_storage->clear_all( true, array( 'connectivity_test' ), $blog_id );
6784
+
6785
+ if ( FS_Site::is_valid_id( $install_id ) ) {
6786
+ $install_ids[] = $install_id;
6787
+ }
6788
+
6789
+ switch_to_blog( $blog_id );
6790
+
6791
+ $this->do_action( 'after_account_delete' );
6792
+
6793
+ restore_current_blog();
6794
+ }
6795
+
6796
+ $this->_storage->clear_all( true, array(
6797
+ 'connectivity_test',
6798
+ 'is_on',
6799
+ ), true );
6800
+
6801
+ // Send delete event.
6802
+ if ( ! empty( $install_ids ) ) {
6803
+ $result = $this->get_current_or_network_user_api_scope()->call( "/plugins/{$this->_module_id}/installs.json?ids=" . implode( ',', $install_ids ), 'delete' );
6804
+ }
6805
+
6806
+ $this->do_action( 'after_network_account_delete' );
6807
+ }
6808
+
6809
+ /**
6810
+ * Plugin deactivation hook.
6811
+ *
6812
+ * @author Vova Feldman (@svovaf)
6813
+ * @since 1.0.1
6814
+ */
6815
+ function _deactivate_plugin_hook() {
6816
+ $this->_logger->entrance( 'slug = ' . $this->_slug );
6817
+
6818
+ if ( ! $this->is_user_admin() ) {
6819
+ return;
6820
+ }
6821
+
6822
+ $is_network_deactivation = fs_is_network_admin();
6823
+ $storage_keys_for_removal = array();
6824
+
6825
+ $this->_admin_notices->clear_all_sticky();
6826
+
6827
+ $storage_keys_for_removal[] = 'sticky_optin_added';
6828
+ if ( isset( $this->_storage->sticky_optin_added ) ) {
6829
+ unset( $this->_storage->sticky_optin_added );
6830
+ }
6831
+
6832
+ if ( ! isset( $this->_storage->is_plugin_new_install ) ) {
6833
+ // Remember that plugin was already installed.
6834
+ $this->_storage->is_plugin_new_install = false;
6835
+ }
6836
+
6837
+ // Hook to plugin uninstall.
6838
+ register_uninstall_hook( $this->_plugin_main_file_path, array( 'Freemius', '_uninstall_plugin_hook' ) );
6839
+
6840
+ $this->clear_module_main_file_cache();
6841
+ $this->clear_sync_cron( $this->_is_network_active );
6842
+ $this->clear_install_sync_cron();
6843
+
6844
+ if ( $this->is_registered() ) {
6845
+ if ( $is_network_deactivation ) {
6846
+ // Send deactivation event.
6847
+ $this->sync_installs( array(
6848
+ 'is_active' => false,
6849
+ ) );
6850
+ } else {
6851
+ // Send deactivation event.
6852
+ $this->sync_install( array(
6853
+ 'is_active' => false,
6854
+ ) );
6855
+ }
6856
+ } else {
6857
+ if ( ! $this->has_api_connectivity() ) {
6858
+ // Reset connectivity test cache.
6859
+ unset( $this->_storage->connectivity_test );
6860
+
6861
+ $storage_keys_for_removal[] = 'connectivity_test';
6862
+ }
6863
+ }
6864
+
6865
+ if ( $is_network_deactivation ) {
6866
+ if ( isset( $this->_storage->sticky_optin_added_ms ) ) {
6867
+ unset( $this->_storage->sticky_optin_added_ms );
6868
+ }
6869
+
6870
+ if ( ! empty( $storage_keys_for_removal ) ) {
6871
+ $sites = self::get_sites();
6872
+
6873
+ foreach ( $sites as $site ) {
6874
+ $blog_id = self::get_site_blog_id( $site );
6875
+
6876
+ foreach ( $storage_keys_for_removal as $key ) {
6877
+ $this->_storage->remove( $key, false, $blog_id );
6878
+ }
6879
+
6880
+ $this->_storage->save( $blog_id );
6881
+ }
6882
+ }
6883
+ }
6884
+
6885
+ // Clear API cache on deactivation.
6886
+ FS_Api::clear_cache();
6887
+
6888
+ $this->remove_sdk_reference();
6889
+ }
6890
+
6891
+ /**
6892
+ * @author Vova Feldman (@svovaf)
6893
+ * @since 1.1.6
6894
+ */
6895
+ private function remove_sdk_reference() {
6896
+ global $fs_active_plugins;
6897
+
6898
+ foreach ( $fs_active_plugins->plugins as $sdk_path => &$data ) {
6899
+ if ( $this->_plugin_basename == $data->plugin_path ) {
6900
+ unset( $fs_active_plugins->plugins[ $sdk_path ] );
6901
+ break;
6902
+ }
6903
+ }
6904
+
6905
+ fs_fallback_to_newest_active_sdk();
6906
+ }
6907
+
6908
+ /**
6909
+ * @author Vova Feldman (@svovaf)
6910
+ * @since 1.1.3
6911
+ *
6912
+ * @param bool $is_anonymous
6913
+ * @param bool|int $network_or_blog_id Since 2.0.0
6914
+ */
6915
+ private function set_anonymous_mode( $is_anonymous = true, $network_or_blog_id = 0 ) {
6916
+ // Store information regarding skip to try and opt-in the user
6917
+ // again in the future.
6918
+ $skip_info = array(
6919
+ 'is' => $is_anonymous,
6920
+ 'timestamp' => WP_FS__SCRIPT_START_TIME,
6921
+ 'version' => $this->get_plugin_version(),
6922
+ );
6923
+
6924
+ if ( true === $network_or_blog_id ) {
6925
+ $this->_storage->is_anonymous_ms = $skip_info;
6926
+ } else {
6927
+ $this->_storage->store( 'is_anonymous', $skip_info, $network_or_blog_id );
6928
+ }
6929
+
6930
+ $this->network_upgrade_mode_completed();
6931
+
6932
+ // Update anonymous mode cache.
6933
+ $this->_is_anonymous = $is_anonymous;
6934
+ }
6935
+
6936
+ /**
6937
+ * @author Vova Feldman (@svovaf)
6938
+ * @since 2.0.0
6939
+ *
6940
+ * @param int $blog_id Site ID.
6941
+ * @param int $user_id User ID.
6942
+ * @param string $domain Site domain.
6943
+ * @param string $path Site path.
6944
+ * @param int $network_id Network ID. Only relevant on multi-network installations.
6945
+ * @param array $meta Metadata. Used to set initial site options.
6946
+ *
6947
+ * @uses Freemius::is_license_network_active() to check if the context license was network activated by the super-admin.
6948
+ * @uses Freemius::is_network_connected() to check if the super-admin network opted-in.
6949
+ * @uses Freemius::is_network_anonymous() to check if the super-admin network skipped.
6950
+ * @uses Freemius::is_network_delegated_connection() to check if the super-admin network delegated the connection to the site admins.
6951
+ */
6952
+ function _after_new_blog_callback( $blog_id, $user_id, $domain, $path, $network_id, $meta ) {
6953
+ $this->_logger->entrance();
6954
+
6955
+ if ( $this->is_premium() &&
6956
+ $this->is_network_connected() &&
6957
+ is_object( $this->_license ) &&
6958
+ $this->_license->can_activate( FS_Site::is_localhost_by_address( $domain ) ) &&
6959
+ $this->is_license_network_active( $blog_id )
6960
+ ) {
6961
+ /**
6962
+ * Running the premium version, the license was network activated, and the license can also be activated on the current site -> so try to opt-in with the license key.
6963
+ */
6964
+ $current_blog_id = get_current_blog_id();
6965
+ $license = clone $this->_license;
6966
+
6967
+ $this->switch_to_blog( $blog_id );
6968
+
6969
+ // Opt-in with network user.
6970
+ $this->install_with_user(
6971
+ $this->get_network_user(),
6972
+ $license->secret_key,
6973
+ false,
6974
+ false,
6975
+ false
6976
+ );
6977
+
6978
+ if ( is_object( $this->_site ) ) {
6979
+ if ( $this->_site->license_id == $license->id ) {
6980
+ /**
6981
+ * If the license was activated successfully, sync the license data from the remote server.
6982
+ */
6983
+ $this->_license = $license;
6984
+ $this->sync_site_license();
6985
+ }
6986
+ }
6987
+
6988
+ $this->switch_to_blog( $current_blog_id );
6989
+
6990
+ if ( is_object( $this->_site ) ) {
6991
+ // Already connected (with or without a license), so no need to continue.
6992
+ return;
6993
+ }
6994
+ }
6995
+
6996
+ if ( $this->is_network_anonymous() ) {
6997
+ /**
6998
+ * Opt-in was network skipped so automatically skip the opt-in for the new site.
6999
+ */
7000
+ $this->skip_site_connection( $blog_id );
7001
+ } else if ( $this->is_network_delegated_connection() ) {
7002
+ /**
7003
+ * Opt-in was network delegated so automatically delegate the opt-in for the new site's admin.
7004
+ */
7005
+ $this->delegate_site_connection( $blog_id );
7006
+ } else if ( $this->is_network_connected() ) {
7007
+ /**
7008
+ * Opt-in was network activated so automatically opt-in with the network user and new site admin.
7009
+ */
7010
+ $current_blog_id = get_current_blog_id();
7011
+
7012
+ $this->switch_to_blog( $blog_id );
7013
+
7014
+ // Opt-in with network user.
7015
+ $this->install_with_user(
7016
+ $this->get_network_user(),
7017
+ false,
7018
+ false,
7019
+ false,
7020
+ false
7021
+ );
7022
+
7023
+ $this->switch_to_blog( $current_blog_id );
7024
+ } else {
7025
+ /**
7026
+ * If the super-admin mixed different options (connect, skip, delegated):
7027
+ * a) If at least one site connection was delegated, then automatically delegate connection.
7028
+ * b) Otherwise, it means that at least one site was skipped and at least one site was connected. For a simplified UX in the initial release of the multisite network integration, skip the connection for the newly created site. If the super-admin will want to opt-in they can still do that from the network level Account page.
7029
+ */
7030
+ $has_delegated_site = false;
7031
+
7032
+ $sites = self::get_sites();
7033
+ foreach ( $sites as $site ) {
7034
+ $blog_id = self::get_site_blog_id( $site );
7035
+
7036
+ if ( $this->is_site_delegated_connection( $blog_id ) ) {
7037
+ $has_delegated_site = true;
7038
+ break;
7039
+ }
7040
+ }
7041
+
7042
+ if ( $has_delegated_site ) {
7043
+ $this->delegate_site_connection( $blog_id );
7044
+ } else {
7045
+ $this->skip_site_connection( $blog_id );
7046
+ }
7047
+ }
7048
+ }
7049
+
7050
+ /**
7051
+ * @author Vova Feldman (@svovaf)
7052
+ * @since 1.1.3
7053
+ *
7054
+ * @param bool|int $network_or_blog_id Since 2.0.0.
7055
+ */
7056
+ private function reset_anonymous_mode( $network_or_blog_id = 0 ) {
7057
+ if ( true === $network_or_blog_id ) {
7058
+ unset( $this->_storage->is_anonymous_ms );
7059
+ } else {
7060
+ $this->_storage->remove( 'is_anonymous', true, $network_or_blog_id );
7061
+ }
7062
+
7063
+ /**
7064
+ * Ensure that this field is also "false", otherwise, if the current module's type is "theme" and the module
7065
+ * has no menus, the opt-in popup will not be shown immediately (in this case, the user will have to click
7066
+ * on the admin notice that contains the opt-in link in order to trigger the opt-in popup).
7067
+ *
7068
+ * @author Leo Fajardo (@leorw)
7069
+ * @since 1.2.2
7070
+ */
7071
+ if ( ! $this->_is_network_active ||
7072
+ 0 === $network_or_blog_id ||
7073
+ get_current_blog_id() == $network_or_blog_id ||
7074
+ ( true === $network_or_blog_id && fs_is_network_admin() )
7075
+ ) {
7076
+ unset( $this->_is_anonymous );
7077
+ }
7078
+ }
7079
+
7080
+ /**
7081
+ * Clears the anonymous mode and redirects to the opt-in screen.
7082
+ *
7083
+ * @author Vova Feldman (@svovaf)
7084
+ * @since 1.1.7
7085
+ */
7086
+ function connect_again() {
7087
+ if ( ! $this->is_anonymous() ) {
7088
+ return;
7089
+ }
7090
+
7091
+ $this->reset_anonymous_mode( fs_is_network_admin() );
7092
+
7093
+ fs_redirect( $this->get_activation_url() );
7094
+ }
7095
+
7096
+ /**
7097
+ * Skip account connect, and set anonymous mode.
7098
+ *
7099
+ * @author Vova Feldman (@svovaf)
7100
+ * @since 1.1.1
7101
+ *
7102
+ * @param array|null $sites Since 2.0.0. Specific sites.
7103
+ * @param bool $skip_all_network Since 2.0.0. If true, skip connection for all sites.
7104
+ */
7105
+ private function skip_connection( $sites = null, $skip_all_network = false ) {
7106
+ $this->_logger->entrance();
7107
+
7108
+ $this->_admin_notices->remove_sticky( 'connect_account' );
7109
+
7110
+ if ( $skip_all_network ) {
7111
+ $this->set_anonymous_mode( true, true );
7112
+ }
7113
+
7114
+ if ( ! $skip_all_network && empty( $sites ) ) {
7115
+ $this->skip_site_connection();
7116
+ } else {
7117
+ $uids = array();
7118
+
7119
+ if ( $skip_all_network ) {
7120
+ $this->set_anonymous_mode( true, true );
7121
+
7122
+ $sites = self::get_sites();
7123
+ foreach ( $sites as $site ) {
7124
+ $blog_id = self::get_site_blog_id( $site );
7125
+ $this->skip_site_connection( $blog_id, false );
7126
+ $uids[] = $this->get_anonymous_id( $blog_id );
7127
+ }
7128
+ } else if ( ! empty( $sites ) ) {
7129
+ foreach ( $sites as $site ) {
7130
+ $uids[] = $site['uid'];
7131
+ $this->skip_site_connection( $site['blog_id'], false );
7132
+ }
7133
+ }
7134
+
7135
+ // Send anonymous skip event.
7136
+ // No user identified info nor any tracking will be sent after the user skips the opt-in.
7137
+ $this->get_api_plugin_scope()->call( 'skip.json', 'put', array(
7138
+ 'uids' => $uids,
7139
+ ) );
7140
+ }
7141
+
7142
+ $this->network_upgrade_mode_completed();
7143
+ }
7144
+
7145
+ /**
7146
+ * Skip connection for specific site in the network.
7147
+ *
7148
+ * @author Vova Feldman (@svovaf)
7149
+ * @since 2.0.0
7150
+ *
7151
+ * @param int|null $blog_id
7152
+ * @param bool $send_skip
7153
+ */
7154
+ private function skip_site_connection( $blog_id = null, $send_skip = true ) {
7155
+ $this->_logger->entrance();
7156
+
7157
+ $this->_admin_notices->remove_sticky( 'connect_account', $blog_id );
7158
+
7159
+ $this->set_anonymous_mode( true, $blog_id );
7160
+
7161
+ if ( $send_skip ) {
7162
+ $this->get_api_plugin_scope()->call( 'skip.json', 'put', array(
7163
+ 'uids' => array( $this->get_anonymous_id( $blog_id ) ),
7164
+ ) );
7165
+ }
7166
+ }
7167
+
7168
+ /**
7169
+ * Plugin version update hook.
7170
+ *
7171
+ * @author Vova Feldman (@svovaf)
7172
+ * @since 1.0.4
7173
+ */
7174
+ private function update_plugin_version_event() {
7175
+ $this->_logger->entrance();
7176
+
7177
+ if ( ! $this->is_registered() ) {
7178
+ return;
7179
+ }
7180
+
7181
+ $this->schedule_install_sync();
7182
+ // $this->sync_install( array(), true );
7183
+ }
7184
+
7185
+ /**
7186
+ * Generate an MD5 signature of a plugins collection.
7187
+ * This helper methods used to identify changes in a plugins collection.
7188
+ *
7189
+ * @author Vova Feldman (@svovaf)
7190
+ * @since 2.0.0
7191
+ *
7192
+ * @param array [string]array $plugins
7193
+ *
7194
+ * @return string
7195
+ */
7196
+ private function get_plugins_thumbprint( $plugins ) {
7197
+ ksort( $plugins );
7198
+
7199
+ $thumbprint = '';
7200
+ foreach ( $plugins as $basename => $data ) {
7201
+ $thumbprint .= $data['slug'] . ',' .
7202
+ $data['Version'] . ',' .
7203
+ ( $data['is_active'] ? '1' : '0' ) . ';';
7204
+ }
7205
+
7206
+ return md5( $thumbprint );
7207
+ }
7208
+
7209
+ /**
7210
+ * Return a list of modified plugins since the last sync.
7211
+ *
7212
+ * Note:
7213
+ * There's no point to store a plugins counter since even if the number of
7214
+ * plugins didn't change, we still need to check if the versions are all the
7215
+ * same and the activity state is similar.
7216
+ *
7217
+ * @author Vova Feldman (@svovaf)
7218
+ * @since 1.1.8
7219
+ *
7220
+ * @return array|false
7221
+ */
7222
+ private function get_plugins_data_for_api() {
7223
+ // Alias.
7224
+ $site_active_plugins_option_name = 'active_plugins';
7225
+ $network_plugins_option_name = 'all_plugins';
7226
+
7227
+ /**
7228
+ * Collection of all site level active plugins.
7229
+ */
7230
+ $site_active_plugins_cache = self::$_accounts->get_option( $site_active_plugins_option_name );
7231
+
7232
+ if ( ! is_object( $site_active_plugins_cache ) ) {
7233
+ $site_active_plugins_cache = (object) array(
7234
+ 'timestamp' => '',
7235
+ 'md5' => '',
7236
+ 'plugins' => array(),
7237
+ );
7238
+ }
7239
+
7240
+ $time = time();
7241
+
7242
+ if ( ! empty( $site_active_plugins_cache->timestamp ) &&
7243
+ ( $time - $site_active_plugins_cache->timestamp ) < WP_FS__TIME_5_MIN_IN_SEC
7244
+ ) {
7245
+ // Don't send plugin updates if last update was in the past 5 min.
7246
+ return false;
7247
+ }
7248
+
7249
+ // Write timestamp to lock the logic.
7250
+ $site_active_plugins_cache->timestamp = $time;
7251
+ self::$_accounts->set_option( $site_active_plugins_option_name, $site_active_plugins_cache, true );
7252
+
7253
+ // Reload options from DB.
7254
+ self::$_accounts->load( true );
7255
+ $site_active_plugins_cache = self::$_accounts->get_option( $site_active_plugins_option_name );
7256
+
7257
+ if ( $time != $site_active_plugins_cache->timestamp ) {
7258
+ // If timestamp is different, then another thread captured the lock.
7259
+ return false;
7260
+ }
7261
+
7262
+ /**
7263
+ * Collection of all plugins (network level).
7264
+ */
7265
+ $network_plugins_cache = self::$_accounts->get_option( $network_plugins_option_name );
7266
+
7267
+ if ( ! is_object( $network_plugins_cache ) ) {
7268
+ $network_plugins_cache = (object) array(
7269
+ 'timestamp' => '',
7270
+ 'md5' => '',
7271
+ 'plugins' => array(),
7272
+ );
7273
+ }
7274
+
7275
+ // Check if there's a change in plugins.
7276
+ $network_plugins = self::get_network_plugins();
7277
+ $site_active_plugins = self::get_site_active_plugins();
7278
+
7279
+ $network_plugins_thumbprint = $this->get_plugins_thumbprint( $network_plugins );
7280
+ $site_active_plugins_thumbprint = $this->get_plugins_thumbprint( $site_active_plugins );
7281
+
7282
+ // Check if plugins status changed (version or active/inactive).
7283
+ $network_plugins_changed = ( $network_plugins_cache->md5 !== $network_plugins_thumbprint );
7284
+ $site_active_plugins_changed = ( $site_active_plugins_cache->md5 !== $site_active_plugins_thumbprint );
7285
+
7286
+ if ( ! $network_plugins_changed &&
7287
+ ! $site_active_plugins_changed
7288
+ ) {
7289
+ // No changes.
7290
+ return array();
7291
+ }
7292
+
7293
+ $plugins_update_data = array();
7294
+
7295
+ foreach ( $network_plugins_cache->plugins as $basename => $data ) {
7296
+ if ( ! isset( $network_plugins[ $basename ] ) ) {
7297
+ // Plugin uninstalled.
7298
+ $uninstalled_plugin_data = $data;
7299
+ $uninstalled_plugin_data['is_active'] = false;
7300
+ $uninstalled_plugin_data['is_uninstalled'] = true;
7301
+ $plugins_update_data[] = $uninstalled_plugin_data;
7302
+
7303
+ unset( $network_plugins[ $basename ] );
7304
+
7305
+ unset( $network_plugins_cache->plugins[ $basename ] );
7306
+ unset( $site_active_plugins_cache->plugins[ $basename ] );
7307
+
7308
+ continue;
7309
+ }
7310
+
7311
+ $was_active = $data['is_active'] ||
7312
+ ( isset( $site_active_plugins_cache->plugins[ $basename ] ) &&
7313
+ true === $site_active_plugins_cache->plugins[ $basename ]['is_active'] );
7314
+ $is_active = $network_plugins[ $basename ]['is_active'] ||
7315
+ ( isset( $site_active_plugins[ $basename ] ) &&
7316
+ $site_active_plugins[ $basename ]['is_active'] );
7317
+
7318
+ if ( ! isset( $site_active_plugins_cache->plugins[ $basename ] ) &&
7319
+ isset( $site_active_plugins[ $basename ] )
7320
+ ) {
7321
+ // Plugin was site level activated.
7322
+ $site_active_plugins_cache->plugins[ $basename ] = $network_plugins[ $basename ];
7323
+ $site_active_plugins_cache->plugins[ $basename ]['is_active'] = true;
7324
+ } else if ( isset( $site_active_plugins_cache->plugins[ $basename ] ) &&
7325
+ ! isset( $site_active_plugins[ $basename ] )
7326
+ ) {
7327
+ // Plugin was site level deactivated.
7328
+ unset( $site_active_plugins_cache->plugins[ $basename ] );
7329
+ }
7330
+
7331
+ $prev_version = $data['version'];
7332
+ $current_version = $network_plugins[ $basename ]['Version'];
7333
+
7334
+ if ( $was_active !== $is_active || $prev_version !== $current_version ) {
7335
+ // Plugin activated or deactivated, or version changed.
7336
+
7337
+ if ( $was_active !== $is_active ) {
7338
+ if ( $data['is_active'] != $network_plugins[ $basename ]['is_active'] ) {
7339
+ $network_plugins_cache->plugins[ $basename ]['is_active'] = $data['is_active'];
7340
+ }
7341
+ }
7342
+
7343
+ if ( $prev_version !== $current_version ) {
7344
+ $network_plugins_cache->plugins[ $basename ]['Version'] = $current_version;
7345
+ }
7346
+
7347
+ $updated_plugin_data = $data;
7348
+ $updated_plugin_data['is_active'] = $is_active;
7349
+ $updated_plugin_data['version'] = $current_version;
7350
+ $updated_plugin_data['title'] = $network_plugins[ $basename ]['Name'];
7351
+ $plugins_update_data[] = $updated_plugin_data;
7352
+ }
7353
+ }
7354
+
7355
+ // Find new plugins that weren't yet seen before.
7356
+ foreach ( $network_plugins as $basename => $data ) {
7357
+ if ( ! isset( $network_plugins_cache->plugins[ $basename ] ) ) {
7358
+ // New plugin.
7359
+ $new_plugin = array(
7360
+ 'slug' => $data['slug'],
7361
+ 'version' => $data['Version'],
7362
+ 'title' => $data['Name'],
7363
+ 'is_active' => $data['is_active'],
7364
+ 'is_uninstalled' => false,
7365
+ );
7366
+
7367
+ $plugins_update_data[] = $new_plugin;
7368
+ $network_plugins_cache->plugins[ $basename ] = $new_plugin;
7369
+
7370
+ if ( isset( $site_active_plugins[ $basename ] ) ) {
7371
+ $site_active_plugins_cache->plugins[ $basename ] = $new_plugin;
7372
+ $site_active_plugins_cache->plugins[ $basename ]['is_active'] = true;
7373
+ }
7374
+ }
7375
+ }
7376
+
7377
+ $site_active_plugins_cache->md5 = $site_active_plugins_thumbprint;
7378
+ $site_active_plugins_cache->timestamp = $time;
7379
+ self::$_accounts->set_option( $site_active_plugins_option_name, $site_active_plugins_cache, true );
7380
+
7381
+ $network_plugins_cache->md5 = $network_plugins_thumbprint;
7382
+ $network_plugins_cache->timestamp = $time;
7383
+ self::$_accounts->set_option( $network_plugins_option_name, $network_plugins_cache, true );
7384
+
7385
+ return $plugins_update_data;
7386
+ }
7387
+
7388
+ /**
7389
+ * Return a list of modified themes since the last sync.
7390
+ *
7391
+ * Note:
7392
+ * There's no point to store a themes counter since even if the number of
7393
+ * themes didn't change, we still need to check if the versions are all the
7394
+ * same and the activity state is similar.
7395
+ *
7396
+ * @author Vova Feldman (@svovaf)
7397
+ * @since 1.1.8
7398
+ *
7399
+ * @return array|false
7400
+ */
7401
+ private function get_themes_data_for_api() {
7402
+ // Alias.
7403
+ $option_name = 'all_themes';
7404
+
7405
+ $all_cached_themes = self::$_accounts->get_option( $option_name );
7406
+
7407
+ if ( ! is_object( $all_cached_themes ) ) {
7408
+ $all_cached_themes = (object) array(
7409
+ 'timestamp' => '',
7410
+ 'md5' => '',
7411
+ 'themes' => array(),
7412
+ );
7413
+ }
7414
+
7415
+ $time = time();
7416
+
7417
+ if ( ! empty( $all_cached_themes->timestamp ) &&
7418
+ ( $time - $all_cached_themes->timestamp ) < WP_FS__TIME_5_MIN_IN_SEC
7419
+ ) {
7420
+ // Don't send theme updates if last update was in the past 5 min.
7421
+ return false;
7422
+ }
7423
+
7424
+ // Write timestamp to lock the logic.
7425
+ $all_cached_themes->timestamp = $time;
7426
+ self::$_accounts->set_option( $option_name, $all_cached_themes, true );
7427
+
7428
+ // Reload options from DB.
7429
+ self::$_accounts->load( true );
7430
+ $all_cached_themes = self::$_accounts->get_option( $option_name );
7431
+
7432
+ if ( $time != $all_cached_themes->timestamp ) {
7433
+ // If timestamp is different, then another thread captured the lock.
7434
+ return false;
7435
+ }
7436
+
7437
+ // Get active theme.
7438
+ $active_theme = wp_get_theme();
7439
+ $active_theme_stylesheet = $active_theme->get_stylesheet();
7440
+
7441
+ // Check if there's a change in themes.
7442
+ $all_themes = wp_get_themes();
7443
+
7444
+ // Check if themes changed.
7445
+ ksort( $all_themes );
7446
+
7447
+ $themes_signature = '';
7448
+ foreach ( $all_themes as $slug => $data ) {
7449
+ $is_active = ( $slug === $active_theme_stylesheet );
7450
+ $themes_signature .= $slug . ',' .
7451
+ $data->version . ',' .
7452
+ ( $is_active ? '1' : '0' ) . ';';
7453
+ }
7454
+
7455
+ // Check if themes status changed (version or active/inactive).
7456
+ $themes_changed = ( $all_cached_themes->md5 !== md5( $themes_signature ) );
7457
+
7458
+ $themes_update_data = array();
7459
+
7460
+ if ( $themes_changed ) {
7461
+ // Change in themes, report changes.
7462
+
7463
+ // Update existing themes info.
7464
+ foreach ( $all_cached_themes->themes as $slug => $data ) {
7465
+ $is_active = ( $slug === $active_theme_stylesheet );
7466
+
7467
+ if ( ! isset( $all_themes[ $slug ] ) ) {
7468
+ // Plugin uninstalled.
7469
+ $uninstalled_theme_data = $data;
7470
+ $uninstalled_theme_data['is_active'] = false;
7471
+ $uninstalled_theme_data['is_uninstalled'] = true;
7472
+ $themes_update_data[] = $uninstalled_theme_data;
7473
+
7474
+ unset( $all_themes[ $slug ] );
7475
+ unset( $all_cached_themes->themes[ $slug ] );
7476
+ } else if ( $data['is_active'] !== $is_active ||
7477
+ $data['version'] !== $all_themes[ $slug ]->version
7478
+ ) {
7479
+ // Plugin activated or deactivated, or version changed.
7480
+
7481
+ $all_cached_themes->themes[ $slug ]['is_active'] = $is_active;
7482
+ $all_cached_themes->themes[ $slug ]['version'] = $all_themes[ $slug ]->version;
7483
+
7484
+ $themes_update_data[] = $all_cached_themes->themes[ $slug ];
7485
+ }
7486
+ }
7487
+
7488
+ // Find new themes that weren't yet seen before.
7489
+ foreach ( $all_themes as $slug => $data ) {
7490
+ if ( ! isset( $all_cached_themes->themes[ $slug ] ) ) {
7491
+ $is_active = ( $slug === $active_theme_stylesheet );
7492
+
7493
+ // New plugin.
7494
+ $new_plugin = array(
7495
+ 'slug' => $slug,
7496
+ 'version' => $data->version,
7497
+ 'title' => $data->name,
7498
+ 'is_active' => $is_active,
7499
+ 'is_uninstalled' => false,
7500
+ );
7501
+
7502
+ $themes_update_data[] = $new_plugin;
7503
+ $all_cached_themes->themes[ $slug ] = $new_plugin;
7504
+ }
7505
+ }
7506
+
7507
+ $all_cached_themes->md5 = md5( $themes_signature );
7508
+ $all_cached_themes->timestamp = time();
7509
+ self::$_accounts->set_option( $option_name, $all_cached_themes, true );
7510
+ }
7511
+
7512
+ return $themes_update_data;
7513
+ }
7514
+
7515
+ /**
7516
+ * Get site data for API install request.
7517
+ *
7518
+ * @author Vova Feldman (@svovaf)
7519
+ * @since 1.1.2
7520
+ *
7521
+ * @param string[] string $override
7522
+ * @param bool $include_plugins Since 1.1.8 by default include plugin changes.
7523
+ * @param bool $include_themes Since 1.1.8 by default include plugin changes.
7524
+ *
7525
+ * @return array
7526
+ */
7527
+ private function get_install_data_for_api(
7528
+ array $override,
7529
+ $include_plugins = true,
7530
+ $include_themes = true
7531
+ ) {
7532
+ /**
7533
+ * @since 1.1.8 Also send plugin updates.
7534
+ */
7535
+ if ( $include_plugins && ! isset( $override['plugins'] ) ) {
7536
+ $plugins = $this->get_plugins_data_for_api();
7537
+ if ( ! empty( $plugins ) ) {
7538
+ $override['plugins'] = $plugins;
7539
+ }
7540
+ }
7541
+ /**
7542
+ * @since 1.1.8 Also send themes updates.
7543
+ */
7544
+ if ( $include_themes && ! isset( $override['themes'] ) ) {
7545
+ $themes = $this->get_themes_data_for_api();
7546
+ if ( ! empty( $themes ) ) {
7547
+ $override['themes'] = $themes;
7548
+ }
7549
+ }
7550
+
7551
+ return array_merge( array(
7552
+ 'version' => $this->get_plugin_version(),
7553
+ 'is_premium' => $this->is_premium(),
7554
+ 'language' => get_bloginfo( 'language' ),
7555
+ 'charset' => get_bloginfo( 'charset' ),
7556
+ 'platform_version' => get_bloginfo( 'version' ),
7557
+ 'sdk_version' => $this->version,
7558
+ 'programming_language_version' => phpversion(),
7559
+ 'title' => get_bloginfo( 'name' ),
7560
+ 'url' => get_site_url(),
7561
+ // Special params.
7562
+ 'is_active' => true,
7563
+ 'is_disconnected' => $this->is_tracking_prohibited(),
7564
+ 'is_uninstalled' => false,
7565
+ ), $override );
7566
+ }
7567
+
7568
+ /**
7569
+ * Update installs details.
7570
+ *
7571
+ * @todo V1 of multiste network support doesn't support plugin and theme data sending.
7572
+ *
7573
+ * @author Vova Feldman (@svovaf)
7574
+ * @since 2.0.0
7575
+ *
7576
+ * @param string[] string $override
7577
+ * @param bool $only_diff
7578
+ * @param bool $include_plugins Since 1.1.8 by default include plugin changes.
7579
+ * @param bool $include_themes Since 1.1.8 by default include plugin changes.
7580
+ *
7581
+ * @return array
7582
+ */
7583
+ private function get_installs_data_for_api(
7584
+ array $override,
7585
+ $only_diff = false,
7586
+ $include_plugins = true,
7587
+ $include_themes = true
7588
+ ) {
7589
+ /**
7590
+ * @since 1.1.8 Also send plugin updates.
7591
+ */
7592
+ // if ( $include_plugins && ! isset( $override['plugins'] ) ) {
7593
+ // $plugins = $this->get_plugins_data_for_api();
7594
+ // if ( ! empty( $plugins ) ) {
7595
+ // $override['plugins'] = $plugins;
7596
+ // }
7597
+ // }
7598
+ /**
7599
+ * @since 1.1.8 Also send themes updates.
7600
+ */
7601
+ // if ( $include_themes && ! isset( $override['themes'] ) ) {
7602
+ // $themes = $this->get_themes_data_for_api();
7603
+ // if ( ! empty( $themes ) ) {
7604
+ // $override['themes'] = $themes;
7605
+ // }
7606
+ // }
7607
+
7608
+ // Common properties.
7609
+ $common = array_merge( array(
7610
+ 'version' => $this->get_plugin_version(),
7611
+ 'is_premium' => $this->is_premium(),
7612
+ 'sdk_version' => $this->version,
7613
+ 'programming_language_version' => phpversion(),
7614
+ 'platform_version' => get_bloginfo( 'version' ),
7615
+ ), $override );
7616
+
7617
+
7618
+ $is_common_diff_for_any_site = false;
7619
+ $common_diff_union = array();
7620
+
7621
+ $installs_data = array();
7622
+
7623
+ $sites = self::get_sites();
7624
+
7625
+ foreach ( $sites as $site ) {
7626
+ $blog_id = self::get_site_blog_id( $site );
7627
+
7628
+ $install = $this->get_install_by_blog_id( $blog_id );
7629
+
7630
+ if ( is_object( $install ) ) {
7631
+ if ( $install->user_id != $this->_user->id ) {
7632
+ // Install belongs to a different owner.
7633
+ continue;
7634
+ }
7635
+
7636
+ if ( ! $this->is_premium() && $install->is_tracking_prohibited() ) {
7637
+ // Don't send updates regarding opted-out installs.
7638
+ continue;
7639
+ }
7640
+
7641
+ $install_data = $this->get_site_info( $site );
7642
+
7643
+ $uid = $install_data['uid'];
7644
+
7645
+ unset( $install_data['blog_id'] );
7646
+ unset( $install_data['uid'] );
7647
+
7648
+ $install_data['is_disconnected'] = $install->is_disconnected;
7649
+ $install_data['is_active'] = $this->is_active_for_site( $blog_id );
7650
+ $install_data['is_uninstalled'] = $install->is_uninstalled;
7651
+
7652
+ $common_diff = null;
7653
+ $is_common_diff = false;
7654
+ if ( $only_diff ) {
7655
+ $install_data = $this->get_install_diff_for_api( $install_data, $install, $override );
7656
+ $common_diff = $this->get_install_diff_for_api( $common, $install, $override );
7657
+
7658
+ $is_common_diff = ! empty( $common_diff );
7659
+
7660
+ if ( $is_common_diff ) {
7661
+ foreach ( $common_diff as $k => $v ) {
7662
+ if ( ! isset( $common_diff_union[ $k ] ) ) {
7663
+ $common_diff_union[ $k ] = $v;
7664
+ }
7665
+ }
7666
+ }
7667
+
7668
+ $is_common_diff_for_any_site = $is_common_diff_for_any_site || $is_common_diff;
7669
+ }
7670
+
7671
+ if ( ! empty( $install_data ) || $is_common_diff ) {
7672
+ // Add install ID and site unique ID.
7673
+ $install_data['id'] = $install->id;
7674
+ $install_data['uid'] = $uid;
7675
+
7676
+ $installs_data[] = $install_data;
7677
+ }
7678
+ }
7679
+ }
7680
+
7681
+ restore_current_blog();
7682
+
7683
+ if ( 0 < count( $installs_data ) && ( $is_common_diff_for_any_site || ! $only_diff ) ) {
7684
+ if ( ! $only_diff ) {
7685
+ $installs_data[] = $common;
7686
+ } else if ( ! empty( $common_diff_union ) ) {
7687
+ $installs_data[] = $common_diff_union;
7688
+ }
7689
+ }
7690
+
7691
+ foreach ( $installs_data as &$data ) {
7692
+ $data = (object) $data;
7693
+ }
7694
+
7695
+ return $installs_data;
7696
+ }
7697
+
7698
+ /**
7699
+ * Compare site actual data to the stored install data and return the differences for an API data sync.
7700
+ *
7701
+ * @author Vova Feldman (@svovaf)
7702
+ * @since 2.0.0
7703
+ *
7704
+ * @param array $site
7705
+ * @param FS_Site $install
7706
+ * @param string[] string $override
7707
+ *
7708
+ * @return array
7709
+ */
7710
+ private function get_install_diff_for_api( $site, $install, $override = array() ) {
7711
+ $diff = array();
7712
+ $special = array();
7713
+ $special_override = false;
7714
+
7715
+ foreach ( $site as $p => $v ) {
7716
+ if ( property_exists( $install, $p ) ) {
7717
+ if ( ( is_bool( $install->{$p} ) || ! empty( $install->{$p} ) ) &&
7718
+ $install->{$p} != $v
7719
+ ) {
7720
+ $install->{$p} = $v;
7721
+ $diff[ $p ] = $v;
7722
+ }
7723
+ } else {
7724
+ $special[ $p ] = $v;
7725
+
7726
+ if ( isset( $override[ $p ] ) ||
7727
+ 'plugins' === $p ||
7728
+ 'themes' === $p
7729
+ ) {
7730
+ $special_override = true;
7731
+ }
7732
+ }
7733
+ }
7734
+
7735
+ if ( $special_override || 0 < count( $diff ) ) {
7736
+ // Add special params only if has at least one
7737
+ // standard param, or if explicitly requested to
7738
+ // override a special param or a param which is not exist
7739
+ // in the install object.
7740
+ $diff = array_merge( $diff, $special );
7741
+ }
7742
+
7743
+ return $diff;
7744
+ }
7745
+
7746
+ /**
7747
+ * Update install only if changed.
7748
+ *
7749
+ * @author Vova Feldman (@svovaf)
7750
+ * @since 1.0.9
7751
+ *
7752
+ * @param string[] string $override
7753
+ * @param bool $flush
7754
+ *
7755
+ * @return false|object|string
7756
+ */
7757
+ private function send_install_update( $override = array(), $flush = false ) {
7758
+ $this->_logger->entrance();
7759
+
7760
+ $check_properties = $this->get_install_data_for_api( $override );
7761
+
7762
+ if ( $flush ) {
7763
+ $params = $check_properties;
7764
+ } else {
7765
+ $params = $this->get_install_diff_for_api( $check_properties, $this->_site, $override );
7766
+ }
7767
+
7768
+ if ( 0 < count( $params ) ) {
7769
+ if ( ! is_multisite() ) {
7770
+ // Update last install sync timestamp.
7771
+ $this->set_cron_execution_timestamp( 'install_sync' );
7772
+ }
7773
+
7774
+ $params['uid'] = $this->get_anonymous_id();
7775
+
7776
+ // Send updated values to FS.
7777
+ $site = $this->get_api_site_scope()->call( '/', 'put', $params );
7778
+
7779
+ if ( $this->is_api_result_entity( $site ) ) {
7780
+ if ( ! is_multisite() ) {
7781
+ // I successfully sent install update, clear scheduled sync if exist.
7782
+ $this->clear_install_sync_cron();
7783
+ }
7784
+ }
7785
+
7786
+ return $site;
7787
+ }
7788
+
7789
+ return false;
7790
+ }
7791
+
7792
+ /**
7793
+ * Update installs only if changed.
7794
+ *
7795
+ * @author Vova Feldman (@svovaf)
7796
+ * @since 2.0.0
7797
+ *
7798
+ * @param string[] string $override
7799
+ * @param bool $flush
7800
+ *
7801
+ * @return false|object|string
7802
+ */
7803
+ private function send_installs_update( $override = array(), $flush = false ) {
7804
+ $this->_logger->entrance();
7805
+
7806
+ $installs_data = $this->get_installs_data_for_api( $override, ! $flush );
7807
+
7808
+ if ( empty( $installs_data ) ) {
7809
+ return false;
7810
+ }
7811
+
7812
+ // Update last install sync timestamp.
7813
+ $this->set_cron_execution_timestamp( 'install_sync' );
7814
+
7815
+ // Send updated values to FS.
7816
+ $result = $this->get_api_user_scope()->call( "/plugins/{$this->_plugin->id}/installs.json", 'put', $installs_data );
7817
+
7818
+ if ( $this->is_api_result_object( $result, 'installs' ) ) {
7819
+ // I successfully sent installs update, clear scheduled sync if exist.
7820
+ $this->clear_install_sync_cron();
7821
+ }
7822
+
7823
+ return $result;
7824
+ }
7825
+
7826
+ /**
7827
+ * Update install only if changed.
7828
+ *
7829
+ * @author Vova Feldman (@svovaf)
7830
+ * @since 1.0.9
7831
+ *
7832
+ * @param string[] string $override
7833
+ * @param bool $flush
7834
+ */
7835
+ private function sync_install( $override = array(), $flush = false ) {
7836
+ $this->_logger->entrance();
7837
+
7838
+ $site = $this->send_install_update( $override, $flush );
7839
+
7840
+ if ( false === $site ) {
7841
+ // No sync required.
7842
+ return;
7843
+ }
7844
+
7845
+ if ( ! $this->is_api_result_entity( $site ) ) {
7846
+ // Failed to sync, don't update locally.
7847
+ return;
7848
+ }
7849
+
7850
+ $this->_site = new FS_Site( $site );
7851
+
7852
+ $this->_store_site( true );
7853
+ }
7854
+
7855
+ /**
7856
+ * Update install only if changed.
7857
+ *
7858
+ * @author Vova Feldman (@svovaf)
7859
+ * @since 1.0.9
7860
+ *
7861
+ * @param string[] string $override
7862
+ * @param bool $flush
7863
+ */
7864
+ private function sync_installs( $override = array(), $flush = false ) {
7865
+ $this->_logger->entrance();
7866
+
7867
+ $result = $this->send_installs_update( $override, $flush );
7868
+
7869
+ if ( false === $result ) {
7870
+ // No sync required.
7871
+ return;
7872
+ }
7873
+
7874
+ if ( ! $this->is_api_result_object( $result, 'installs' ) ) {
7875
+ // Failed to sync, don't update locally.
7876
+ return;
7877
+ }
7878
+
7879
+ $address_to_blog_map = $this->get_address_to_blog_map();
7880
+
7881
+ foreach ( $result->installs as $install ) {
7882
+ $this->_site = new FS_Site( $install );
7883
+
7884
+ $address = trailingslashit( fs_strip_url_protocol( $install->url ) );
7885
+ $blog_id = $address_to_blog_map[ $address ];
7886
+
7887
+ $this->_store_site( true, $blog_id );
7888
+ }
7889
+ }
7890
+
7891
+ /**
7892
+ * Track install's custom event.
7893
+ *
7894
+ * IMPORTANT:
7895
+ * Custom event tracking is currently only supported for specific clients.
7896
+ * If you are not one of them, please don't use this method. If you will,
7897
+ * the API will simply ignore your request based on the plugin ID.
7898
+ *
7899
+ * Need custom tracking for your plugin or theme?
7900
+ * If you are interested in custom event tracking please contact yo@freemius.com
7901
+ * for further details.
7902
+ *
7903
+ * @author Vova Feldman (@svovaf)
7904
+ * @since 1.2.1
7905
+ *
7906
+ * @param string $name Event name.
7907
+ * @param array $properties Associative key/value array with primitive values only
7908
+ * @param bool $process_at A valid future date-time in the following format Y-m-d H:i:s.
7909
+ * @param bool $once If true, event will be tracked only once. IMPORTANT: Still trigger the API call.
7910
+ *
7911
+ * @return object|false Event data or FALSE on failure.
7912
+ *
7913
+ * @throws \Freemius_InvalidArgumentException
7914
+ */
7915
+ public function track_event( $name, $properties = array(), $process_at = false, $once = false ) {
7916
+ $this->_logger->entrance( http_build_query( array( 'name' => $name, 'once' => $once ) ) );
7917
+
7918
+ if ( ! $this->is_registered() ) {
7919
+ return false;
7920
+ }
7921
+
7922
+ $event = array( 'type' => $name );
7923
+
7924
+ if ( is_numeric( $process_at ) && $process_at > time() ) {
7925
+ $event['process_at'] = $process_at;
7926
+ }
7927
+
7928
+ if ( $once ) {
7929
+ $event['once'] = true;
7930
+ }
7931
+
7932
+ if ( ! empty( $properties ) ) {
7933
+ // Verify associative array values are primitive.
7934
+ foreach ( $properties as $k => $v ) {
7935
+ if ( ! is_scalar( $v ) ) {
7936
+ throw new Freemius_InvalidArgumentException( 'The $properties argument must be an associative key/value array with primitive values only.' );
7937
+ }
7938
+ }
7939
+
7940
+ $event['properties'] = $properties;
7941
+ }
7942
+
7943
+ $result = $this->get_api_site_scope()->call( 'events.json', 'post', $event );
7944
+
7945
+ return $this->is_api_error( $result ) ?
7946
+ false :
7947
+ $result;
7948
+ }
7949
+
7950
+ /**
7951
+ * Track install's custom event only once, but it still triggers the API call.
7952
+ *
7953
+ * IMPORTANT:
7954
+ * Custom event tracking is currently only supported for specific clients.
7955
+ * If you are not one of them, please don't use this method. If you will,
7956
+ * the API will simply ignore your request based on the plugin ID.
7957
+ *
7958
+ * Need custom tracking for your plugin or theme?
7959
+ * If you are interested in custom event tracking please contact yo@freemius.com
7960
+ * for further details.
7961
+ *
7962
+ * @author Vova Feldman (@svovaf)
7963
+ * @since 1.2.1
7964
+ *
7965
+ * @param string $name Event name.
7966
+ * @param array $properties Associative key/value array with primitive values only
7967
+ * @param bool $process_at A valid future date-time in the following format Y-m-d H:i:s.
7968
+ *
7969
+ * @return object|false Event data or FALSE on failure.
7970
+ *
7971
+ * @throws \Freemius_InvalidArgumentException
7972
+ *
7973
+ * @user Freemius::track_event()
7974
+ */
7975
+ public function track_event_once( $name, $properties = array(), $process_at = false ) {
7976
+ return $this->track_event( $name, $properties, $process_at, true );
7977
+ }
7978
+
7979
+ /**
7980
+ * Plugin uninstall hook.
7981
+ *
7982
+ * @author Vova Feldman (@svovaf)
7983
+ * @since 1.0.1
7984
+ *
7985
+ * @param bool $check_user Enforce checking if user have plugins activation privileges.
7986
+ */
7987
+ function _uninstall_plugin_event( $check_user = true ) {
7988
+ $this->_logger->entrance( 'slug = ' . $this->_slug );
7989
+
7990
+ if ( $check_user && ! current_user_can( 'activate_plugins' ) ) {
7991
+ return;
7992
+ }
7993
+
7994
+ $params = array();
7995
+ $uninstall_reason = null;
7996
+ if ( isset( $this->_storage->uninstall_reason ) ) {
7997
+ $uninstall_reason = $this->_storage->uninstall_reason;
7998
+ $params['reason_id'] = $uninstall_reason->id;
7999
+ $params['reason_info'] = $uninstall_reason->info;
8000
+ }
8001
+
8002
+ if ( ! $this->is_registered() ) {
8003
+ // Send anonymous uninstall event only if user submitted a feedback.
8004
+ if ( isset( $uninstall_reason ) ) {
8005
+ if ( isset( $uninstall_reason->is_anonymous ) && ! $uninstall_reason->is_anonymous ) {
8006
+ $this->opt_in( false, false, false, false, true );
8007
+ } else {
8008
+ $params['uid'] = $this->get_anonymous_id();
8009
+ $this->get_api_plugin_scope()->call( 'uninstall.json', 'put', $params );
8010
+ }
8011
+ }
8012
+ } else {
8013
+ $params = array_merge( $params, array(
8014
+ 'is_active' => false,
8015
+ 'is_uninstalled' => true,
8016
+ ) );
8017
+
8018
+ if ( $this->_is_network_active ) {
8019
+ // Send uninstall event.
8020
+ $this->send_installs_update( $params );
8021
+ } else {
8022
+ // Send uninstall event.
8023
+ $this->send_install_update( $params );
8024
+ }
8025
+ }
8026
+
8027
+ // @todo Decide if we want to delete plugin information from db.
8028
+ }
8029
+
8030
+ /**
8031
+ * @author Vova Feldman (@svovaf)
8032
+ * @since 1.1.1
8033
+ *
8034
+ * @return string
8035
+ */
8036
+ function premium_plugin_basename() {
8037
+ return "{$this->_slug}-premium/" . basename( $this->_free_plugin_basename );
8038
+ }
8039
+
8040
+ /**
8041
+ * Uninstall plugin hook. Called only when connected his account with Freemius for active sites tracking.
8042
+ *
8043
+ * @author Vova Feldman (@svovaf)
8044
+ * @since 1.0.2
8045
+ */
8046
+ public static function _uninstall_plugin_hook() {
8047
+ self::_load_required_static();
8048
+
8049
+ self::$_static_logger->entrance();
8050
+
8051
+ if ( ! current_user_can( 'activate_plugins' ) ) {
8052
+ return;
8053
+ }
8054
+
8055
+ $plugin_file = substr( current_filter(), strlen( 'uninstall_' ) );
8056
+
8057
+ self::$_static_logger->info( 'plugin = ' . $plugin_file );
8058
+
8059
+ define( 'WP_FS__UNINSTALL_MODE', true );
8060
+
8061
+ $fs = self::get_instance_by_file( $plugin_file );
8062
+
8063
+ if ( is_object( $fs ) ) {
8064
+ self::require_plugin_essentials();
8065
+
8066
+ if ( is_plugin_active( $fs->_free_plugin_basename ) ||
8067
+ is_plugin_active( $fs->premium_plugin_basename() )
8068
+ ) {
8069
+ // Deleting Free or Premium plugin version while the other version still installed.
8070
+ return;
8071
+ }
8072
+
8073
+ $fs->_uninstall_plugin_event();
8074
+
8075
+ $fs->do_action( 'after_uninstall' );
8076
+ }
8077
+ }
8078
+
8079
+ #----------------------------------------------------------------------------------
8080
+ #region Plugin Information
8081
+ #----------------------------------------------------------------------------------
8082
+
8083
+ /**
8084
+ * Load WordPress core plugin.php essential module.
8085
+ *
8086
+ * @author Vova Feldman (@svovaf)
8087
+ * @since 1.1.1
8088
+ */
8089
+ private static function require_plugin_essentials() {
8090
+ if ( ! function_exists( 'get_plugins' ) ) {
8091
+ self::$_static_logger->log( 'Including wp-admin/includes/plugin.php...' );
8092
+
8093
+ require_once ABSPATH . 'wp-admin/includes/plugin.php';
8094
+ }
8095
+ }
8096
+
8097
+ /**
8098
+ * Load WordPress core pluggable.php module.
8099
+ *
8100
+ * @author Vova Feldman (@svovaf)
8101
+ * @since 1.1.2
8102
+ */
8103
+ private static function require_pluggable_essentials() {
8104
+ if ( ! function_exists( 'wp_get_current_user' ) ) {
8105
+ require_once ABSPATH . 'wp-includes/pluggable.php';
8106
+ }
8107
+ }
8108
+
8109
+ /**
8110
+ * Return plugin data.
8111
+ *
8112
+ * @author Vova Feldman (@svovaf)
8113
+ * @since 1.0.1
8114
+ *
8115
+ * @return array
8116
+ */
8117
+ function get_plugin_data() {
8118
+ if ( ! isset( $this->_plugin_data ) ) {
8119
+ self::require_plugin_essentials();
8120
+
8121
+ if ( $this->is_plugin() ) {
8122
+ /**
8123
+ * @author Vova Feldman (@svovaf)
8124
+ * @since 1.2.0 When using get_plugin_data() do NOT translate plugin data.
8125
+ *
8126
+ * @link https://github.com/Freemius/wordpress-sdk/issues/77
8127
+ */
8128
+ $plugin_data = get_plugin_data(
8129
+ $this->_plugin_main_file_path,
8130
+ false,
8131
+ false
8132
+ );
8133
+ } else {
8134
+ $theme_data = wp_get_theme();
8135
+
8136
+ $plugin_data = array(
8137
+ 'Name' => $theme_data->get( 'Name' ),
8138
+ 'Version' => $theme_data->get( 'Version' ),
8139
+ 'Author' => $theme_data->get( 'Author' ),
8140
+ 'Description' => $theme_data->get( 'Description' ),
8141
+ 'PluginURI' => $theme_data->get( 'ThemeURI' ),
8142
+ );
8143
+ }
8144
+
8145
+ $this->_plugin_data = $plugin_data;
8146
+ }
8147
+
8148
+ return $this->_plugin_data;
8149
+ }
8150
+
8151
+ /**
8152
+ * @author Vova Feldman (@svovaf)
8153
+ * @since 1.0.1
8154
+ * @since 1.2.2.5 If slug not set load slug by module ID.
8155
+ *
8156
+ * @return string Plugin slug.
8157
+ */
8158
+ function get_slug() {
8159
+ if ( ! isset( $this->_slug ) ) {
8160
+ $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map', array() );
8161
+ $this->_slug = $id_slug_type_path_map[ $this->_module_id ]['slug'];
8162
+ }
8163
+
8164
+ return $this->_slug;
8165
+ }
8166
+
8167
+ /**
8168
+ * @author Vova Feldman (@svovaf)
8169
+ * @since 1.2.1.7
8170
+ *
8171
+ * @return string Plugin slug.
8172
+ */
8173
+ function get_target_folder_name() {
8174
+ return $this->_slug . ( $this->can_use_premium_code() ? '-premium' : '' );
8175
+ }
8176
+
8177
+ /**
8178
+ * @author Vova Feldman (@svovaf)
8179
+ * @since 1.0.1
8180
+ *
8181
+ * @return number Plugin ID.
8182
+ */
8183
+ function get_id() {
8184
+ return $this->_plugin->id;
8185
+ }
8186
+
8187
+ /**
8188
+ * @author Vova Feldman (@svovaf)
8189
+ * @since 1.2.1.5
8190
+ *
8191
+ * @return string Freemius SDK version
8192
+ */
8193
+ function get_sdk_version() {
8194
+ return $this->version;
8195
+ }
8196
+
8197
+ /**
8198
+ * @author Vova Feldman (@svovaf)
8199
+ * @since 1.2.1.5
8200
+ *
8201
+ * @return number Parent plugin ID (if parent exist).
8202
+ */
8203
+ function get_parent_id() {
8204
+ return $this->is_addon() ?
8205
+ $this->get_parent_instance()->get_id() :
8206
+ $this->_plugin->id;
8207
+ }
8208
+
8209
+ /**
8210
+ * @author Vova Feldman (@svovaf)
8211
+ * @since 1.0.1
8212
+ *
8213
+ * @return string Plugin public key.
8214
+ */
8215
+ function get_public_key() {
8216
+ return $this->_plugin->public_key;
8217
+ }
8218
+
8219
+ /**
8220
+ * Will be available only on sandbox mode.
8221
+ *
8222
+ * @author Vova Feldman (@svovaf)
8223
+ * @since 1.0.4
8224
+ *
8225
+ * @return mixed Plugin secret key.
8226
+ */
8227
+ function get_secret_key() {
8228
+ return $this->_plugin->secret_key;
8229
+ }
8230
+
8231
+ /**
8232
+ * @author Vova Feldman (@svovaf)
8233
+ * @since 1.1.1
8234
+ *
8235
+ * @return bool
8236
+ */
8237
+ function has_secret_key() {
8238
+ return ! empty( $this->_plugin->secret_key );
8239
+ }
8240
+
8241
+ /**
8242
+ * @author Vova Feldman (@svovaf)
8243
+ * @since 1.0.9
8244
+ *
8245
+ * @return string
8246
+ */
8247
+ function get_plugin_name() {
8248
+ $this->_logger->entrance();
8249
+
8250
+ if ( ! isset( $this->_plugin_name ) ) {
8251
+ $plugin_data = $this->get_plugin_data();
8252
+
8253
+ // Get name.
8254
+ $this->_plugin_name = $plugin_data['Name'];
8255
+
8256
+ // Check if plugin name contains "(Premium)" suffix and remove it.
8257
+ $suffix = ' (premium)';
8258
+ $suffix_len = strlen( $suffix );
8259
+
8260
+ if ( strlen( $plugin_data['Name'] ) > $suffix_len &&
8261
+ $suffix === substr( strtolower( $plugin_data['Name'] ), - $suffix_len )
8262
+ ) {
8263
+ $this->_plugin_name = substr( $plugin_data['Name'], 0, - $suffix_len );
8264
+ }
8265
+
8266
+ $this->_logger->departure( 'Name = ' . $this->_plugin_name );
8267
+ }
8268
+
8269
+ return $this->_plugin_name;
8270
+ }
8271
+
8272
+ /**
8273
+ * @author Vova Feldman (@svovaf)
8274
+ * @since 1.0.0
8275
+ *
8276
+ * @return string
8277
+ */
8278
+ function get_plugin_version() {
8279
+ $this->_logger->entrance();
8280
+
8281
+ $plugin_data = $this->get_plugin_data();
8282
+
8283
+ $this->_logger->departure( 'Version = ' . $plugin_data['Version'] );
8284
+
8285
+ return $this->apply_filters( 'plugin_version', $plugin_data['Version'] );
8286
+ }
8287
+
8288
+ /**
8289
+ * @author Vova Feldman (@svovaf)
8290
+ * @since 1.2.1.7
8291
+ *
8292
+ * @return string
8293
+ */
8294
+ function get_plugin_title() {
8295
+ $this->_logger->entrance();
8296
+
8297
+ $title = $this->_plugin->title;
8298
+
8299
+ return $this->apply_filters( 'plugin_title', $title );
8300
+ }
8301
+
8302
+ /**
8303
+ * @author Vova Feldman (@svovaf)
8304
+ * @since 1.2.2.7
8305
+ *
8306
+ * @param bool $lowercase
8307
+ *
8308
+ * @return string
8309
+ */
8310
+ function get_module_label( $lowercase = false ) {
8311
+ $label = $this->is_addon() ?
8312
+ $this->get_text_inline( 'Add-On', 'addon' ) :
8313
+ ( $this->is_plugin() ?
8314
+ $this->get_text_inline( 'Plugin', 'plugin' ) :
8315
+ $this->get_text_inline( 'Theme', 'theme' ) );
8316
+
8317
+ if ( $lowercase ) {
8318
+ $label = strtolower( $label );
8319
+ }
8320
+
8321
+ return $label;
8322
+ }
8323
+
8324
+ /**
8325
+ * @author Vova Feldman (@svovaf)
8326
+ * @since 1.0.4
8327
+ *
8328
+ * @return string
8329
+ */
8330
+ function get_plugin_basename() {
8331
+ if ( ! isset( $this->_plugin_basename ) ) {
8332
+ if ( $this->is_plugin() ) {
8333
+ $this->_plugin_basename = plugin_basename( $this->_plugin_main_file_path );
8334
+ } else {
8335
+ $this->_plugin_basename = basename( dirname( $this->_plugin_main_file_path ) );
8336
+ }
8337
+ }
8338
+
8339
+ return $this->_plugin_basename;
8340
+ }
8341
+
8342
+ function get_plugin_folder_name() {
8343
+ $this->_logger->entrance();
8344
+
8345
+ $plugin_folder = $this->_plugin_basename;
8346
+
8347
+ while ( '.' !== dirname( $plugin_folder ) ) {
8348
+ $plugin_folder = dirname( $plugin_folder );
8349
+ }
8350
+
8351
+ $this->_logger->departure( 'Folder Name = ' . $plugin_folder );
8352
+
8353
+ return $plugin_folder;
8354
+ }
8355
+
8356
+ #endregion ------------------------------------------------------------------
8357
+
8358
+ /* Account
8359
+ ------------------------------------------------------------------------------------------------------------------*/
8360
+
8361
+ /**
8362
+ * Find plugin's slug by plugin's basename.
8363
+ *
8364
+ * @author Vova Feldman (@svovaf)
8365
+ * @since 1.0.9
8366
+ *
8367
+ * @param string $plugin_base_name
8368
+ *
8369
+ * @return false|string
8370
+ */
8371
+ private static function find_slug_by_basename( $plugin_base_name ) {
8372
+ $file_slug_map = self::$_accounts->get_option( 'file_slug_map', array() );
8373
+
8374
+ if ( ! array( $file_slug_map ) || ! isset( $file_slug_map[ $plugin_base_name ] ) ) {
8375
+ return false;
8376
+ }
8377
+
8378
+ return $file_slug_map[ $plugin_base_name ];
8379
+ }
8380
+
8381
+ /**
8382
+ * Store the map between the plugin's basename to the slug.
8383
+ *
8384
+ * @author Vova Feldman (@svovaf)
8385
+ * @since 1.0.9
8386
+ */
8387
+ private function store_file_slug_map() {
8388
+ $file_slug_map = self::$_accounts->get_option( 'file_slug_map', array() );
8389
+
8390
+ if ( ! array( $file_slug_map ) ) {
8391
+ $file_slug_map = array();
8392
+ }
8393
+
8394
+ if ( ! isset( $file_slug_map[ $this->_plugin_basename ] ) ||
8395
+ $file_slug_map[ $this->_plugin_basename ] !== $this->_slug
8396
+ ) {
8397
+ $file_slug_map[ $this->_plugin_basename ] = $this->_slug;
8398
+ self::$_accounts->set_option( 'file_slug_map', $file_slug_map, true );
8399
+ }
8400
+ }
8401
+
8402
+ /**
8403
+ * @return array[number]FS_User
8404
+ */
8405
+ static function get_all_users() {
8406
+ $users = self::$_accounts->get_option( 'users', array() );
8407
+
8408
+ if ( ! is_array( $users ) ) {
8409
+ $users = array();
8410
+ }
8411
+
8412
+ return $users;
8413
+ }
8414
+
8415
+ /**
8416
+ * @param string $module_type
8417
+ * @param null|int $blog_id Since 2.0.0
8418
+ *
8419
+ * @return array[string]FS_Site
8420
+ */
8421
+ private static function get_all_sites(
8422
+ $module_type = WP_FS__MODULE_TYPE_PLUGIN,
8423
+ $blog_id = null
8424
+ ) {
8425
+ $sites = self::get_account_option( 'sites', $module_type, $blog_id );
8426
+
8427
+ if ( ! is_array( $sites ) ) {
8428
+ $sites = array();
8429
+ }
8430
+
8431
+ return $sites;
8432
+ }
8433
+
8434
+ /**
8435
+ * @author Leo Fajardo (@leorw)
8436
+ *
8437
+ * @since 1.2.2
8438
+ *
8439
+ * @param string $option_name
8440
+ * @param string $module_type
8441
+ * @param null|int $network_level_or_blog_id Since 2.0.0
8442
+ *
8443
+ * @return mixed
8444
+ */
8445
+ private static function get_account_option( $option_name, $module_type = null, $network_level_or_blog_id = null ) {
8446
+ if ( ! is_null( $module_type ) && WP_FS__MODULE_TYPE_PLUGIN !== $module_type ) {
8447
+ $option_name = $module_type . '_' . $option_name;
8448
+ }
8449
+
8450
+ return self::$_accounts->get_option( $option_name, array(), $network_level_or_blog_id );
8451
+ }
8452
+
8453
+ /**
8454
+ * @author Leo Fajardo (@leorw)
8455
+ *
8456
+ * @since 1.2.2
8457
+ *
8458
+ * @param string $option_name
8459
+ * @param mixed $option_value
8460
+ * @param bool $store
8461
+ * @param null|int $network_level_or_blog_id Since 2.0.0
8462
+ */
8463
+ private function set_account_option( $option_name, $option_value, $store, $network_level_or_blog_id = null ) {
8464
+ self::set_account_option_by_module(
8465
+ $this->_module_type,
8466
+ $option_name,
8467
+ $option_value,
8468
+ $store,
8469
+ $network_level_or_blog_id
8470
+ );
8471
+ }
8472
+
8473
+ /**
8474
+ * @author Vova Feldman (@svovaf)
8475
+ *
8476
+ * @since 1.2.2.7
8477
+ *
8478
+ * @param string $module_type
8479
+ * @param string $option_name
8480
+ * @param mixed $option_value
8481
+ * @param bool $store
8482
+ * @param null|int $network_level_or_blog_id Since 2.0.0
8483
+ */
8484
+ private static function set_account_option_by_module(
8485
+ $module_type,
8486
+ $option_name,
8487
+ $option_value,
8488
+ $store,
8489
+ $network_level_or_blog_id = null
8490
+ ) {
8491
+ if ( WP_FS__MODULE_TYPE_PLUGIN != $module_type ) {
8492
+ $option_name = $module_type . '_' . $option_name;
8493
+ }
8494
+
8495
+ self::$_accounts->set_option( $option_name, $option_value, $store, $network_level_or_blog_id );
8496
+ }
8497
+
8498
+ /**
8499
+ * @author Vova Feldman (@svovaf)
8500
+ * @since 1.0.6
8501
+ *
8502
+ * @param number|null $module_id
8503
+ *
8504
+ * @return FS_Plugin_License[]
8505
+ */
8506
+ private static function get_all_licenses( $module_id = null ) {
8507
+ $licenses = self::get_account_option( 'all_licenses' );
8508
+
8509
+ if ( ! is_array( $licenses ) ) {
8510
+ $licenses = array();
8511
+ }
8512
+
8513
+ if ( is_null( $module_id ) ) {
8514
+ return $licenses;
8515
+ }
8516
+
8517
+ $licenses = isset( $licenses[ $module_id ] ) ?
8518
+ $licenses[ $module_id ] :
8519
+ array();
8520
+
8521
+ return $licenses;
8522
+ }
8523
+
8524
+ /**
8525
+ * @author Leo Fajardo (@leorw)
8526
+ * @since 2.0.0
8527
+ *
8528
+ * @return array
8529
+ */
8530
+ private static function get_all_licenses_by_module_type() {
8531
+ $licenses = self::get_account_option( 'all_licenses' );
8532
+
8533
+ $licenses_by_module_type = array(
8534
+ WP_FS__MODULE_TYPE_PLUGIN => array(),
8535
+ WP_FS__MODULE_TYPE_THEME => array()
8536
+ );
8537
+
8538
+ if ( ! is_array( $licenses ) ) {
8539
+ return $licenses_by_module_type;
8540
+ }
8541
+
8542
+ foreach ( $licenses as $module_id => $module_licenses ) {
8543
+ $fs = self::get_instance_by_id( $module_id );
8544
+ if ( false === $fs ) {
8545
+ continue;
8546
+ }
8547
+
8548
+ $licenses_by_module_type[ $fs->_module_type ] = array_merge( $licenses_by_module_type[ $fs->_module_type ], $module_licenses );
8549
+ }
8550
+
8551
+ return $licenses_by_module_type;
8552
+ }
8553
+
8554
+ /**
8555
+ * @author Leo Fajardo (@leorw)
8556
+ * @since 2.0.0
8557
+ *
8558
+ * @param number $module_id
8559
+ * @param number|null $user_id
8560
+ *
8561
+ * @return array
8562
+ */
8563
+ private static function get_user_id_license_ids_map( $module_id, $user_id = null ) {
8564
+ $all_modules_user_id_license_ids_map = self::get_account_option( 'user_id_license_ids_map' );
8565
+
8566
+ if ( ! is_array( $all_modules_user_id_license_ids_map ) ) {
8567
+ $all_modules_user_id_license_ids_map = array();
8568
+ }
8569
+
8570
+ $user_id_license_ids_map = isset( $all_modules_user_id_license_ids_map[ $module_id ] ) ?
8571
+ $all_modules_user_id_license_ids_map[ $module_id ] :
8572
+ array();
8573
+
8574
+ if ( FS_User::is_valid_id( $user_id ) ) {
8575
+ $user_id_license_ids_map = isset( $user_id_license_ids_map[ $user_id ] ) ?
8576
+ $user_id_license_ids_map[ $user_id ] :
8577
+ array();
8578
+ }
8579
+
8580
+ return $user_id_license_ids_map;
8581
+ }
8582
+
8583
+ /**
8584
+ * @author Leo Fajardo (@leorw)
8585
+ * @since 2.0.0
8586
+ *
8587
+ * @param array $new_user_id_license_ids_map
8588
+ * @param number $module_id
8589
+ * @param number|null $user_id
8590
+ */
8591
+ private static function store_user_id_license_ids_map( $new_user_id_license_ids_map, $module_id, $user_id = null ) {
8592
+ $all_modules_user_id_license_ids_map = self::get_account_option( 'user_id_license_ids_map' );
8593
+ if ( ! is_array( $all_modules_user_id_license_ids_map ) ) {
8594
+ $all_modules_user_id_license_ids_map = array();
8595
+ }
8596
+
8597
+ if ( ! isset( $all_modules_user_id_license_ids_map[ $module_id ] ) ) {
8598
+ $all_modules_user_id_license_ids_map[ $module_id ] = array();
8599
+ }
8600
+
8601
+ if ( FS_User::is_valid_id( $user_id ) ) {
8602
+ $all_modules_user_id_license_ids_map[ $module_id ][ $user_id ] = $new_user_id_license_ids_map;
8603
+ } else {
8604
+ $all_modules_user_id_license_ids_map[ $module_id ] = $new_user_id_license_ids_map;
8605
+ }
8606
+
8607
+ self::$_accounts->set_option( 'user_id_license_ids_map', $all_modules_user_id_license_ids_map, true );
8608
+ }
8609
+
8610
+ /**
8611
+ * Get a collection of the user's linked license IDs.
8612
+ *
8613
+ * @author Vova Feldman (@svovaf)
8614
+ * @since 2.0.0
8615
+ *
8616
+ * @param number $user_id
8617
+ *
8618
+ * @return number[]
8619
+ */
8620
+ private function get_user_linked_license_ids( $user_id ) {
8621
+ return self::get_user_id_license_ids_map( $this->_module_id, $user_id );
8622
+ }
8623
+
8624
+ /**
8625
+ * Override the user's linked license IDs with a new IDs collection.
8626
+ *
8627
+ * @author Vova Feldman (@svovaf)
8628
+ * @since 2.0.0
8629
+ *
8630
+ * @param number $user_id
8631
+ * @param number[] $license_ids
8632
+ */
8633
+ private function set_user_linked_license_ids( $user_id, array $license_ids ) {
8634
+ self::store_user_id_license_ids_map( $license_ids, $this->_module_id, $user_id );
8635
+ }
8636
+
8637
+ /**
8638
+ * Link a specified license ID to a given user.
8639
+ *
8640
+ * @author Vova Feldman (@svovaf)
8641
+ * @since 2.0.0
8642
+ *
8643
+ * @param number $license_id
8644
+ * @param number $user_id
8645
+ */
8646
+ private function link_license_2_user( $license_id, $user_id ) {
8647
+ $license_ids = $this->get_user_linked_license_ids( $user_id );
8648
+
8649
+ if ( in_array( $license_id, $license_ids ) ) {
8650
+ // License already linked.
8651
+ return;
8652
+ }
8653
+
8654
+ $license_ids[] = $license_id;
8655
+
8656
+ $this->set_user_linked_license_ids( $user_id, $license_ids );
8657
+ }
8658
+
8659
+ /**
8660
+ * @param string|bool $module_type
8661
+ *
8662
+ * @return FS_Plugin_Plan[]
8663
+ */
8664
+ private static function get_all_plans( $module_type = false ) {
8665
+ $plans = self::get_account_option( 'plans', $module_type );
8666
+
8667
+ if ( ! is_array( $plans ) ) {
8668
+ $plans = array();
8669
+ }
8670
+
8671
+ return $plans;
8672
+ }
8673
+
8674
+ /**
8675
+ * @author Vova Feldman (@svovaf)
8676
+ * @since 1.0.4
8677
+ *
8678
+ * @return FS_Plugin_Tag[]
8679
+ */
8680
+ private static function get_all_updates() {
8681
+ $updates = self::$_accounts->get_option( 'updates', array() );
8682
+
8683
+ if ( ! is_array( $updates ) ) {
8684
+ $updates = array();
8685
+ }
8686
+
8687
+ return $updates;
8688
+ }
8689
+
8690
+ /**
8691
+ * @author Vova Feldman (@svovaf)
8692
+ * @since 1.0.6
8693
+ *
8694
+ * @return array<number,FS_Plugin[]>|false
8695
+ */
8696
+ private static function get_all_addons() {
8697
+ $addons = self::$_accounts->get_option( 'addons', array() );
8698
+
8699
+ if ( ! is_array( $addons ) ) {
8700
+ $addons = array();
8701
+ }
8702
+
8703
+ return $addons;
8704
+ }
8705
+
8706
+ /**
8707
+ * @author Vova Feldman (@svovaf)
8708
+ * @since 1.0.6
8709
+ *
8710
+ * @return FS_Plugin[]|false
8711
+ */
8712
+ private static function get_all_account_addons() {
8713
+ $addons = self::$_accounts->get_option( 'account_addons', array() );
8714
+
8715
+ if ( ! is_array( $addons ) ) {
8716
+ $addons = array();
8717
+ }
8718
+
8719
+ return $addons;
8720
+ }
8721
+
8722
+ /**
8723
+ * Check if user has connected his account (opted-in).
8724
+ *
8725
+ * Note:
8726
+ * If the user opted-in and opted-out on a later stage,
8727
+ * this will still return true. If you want to check if the
8728
+ * user is currently opted-in, use:
8729
+ * `$fs->is_registered() && $fs->is_tracking_allowed()`
8730
+ *
8731
+ * @author Vova Feldman (@svovaf)
8732
+ * @since 1.0.1
8733
+ * @return bool
8734
+ */
8735
+ function is_registered() {
8736
+ return is_object( $this->_user );
8737
+ }
8738
+
8739
+ /**
8740
+ * Returns TRUE if the user opted-in and didn't disconnect (opt-out).
8741
+ *
8742
+ * @author Leo Fajardo (@leorw)
8743
+ * @since 1.2.1.5
8744
+ *
8745
+ * @return bool
8746
+ */
8747
+ function is_tracking_allowed() {
8748
+ return ( is_object( $this->_site ) && $this->_site->is_tracking_allowed() );
8749
+ }
8750
+
8751
+ /**
8752
+ * @author Vova Feldman (@svovaf)
8753
+ * @since 1.0.4
8754
+ *
8755
+ * @return FS_Plugin
8756
+ */
8757
+ function get_plugin() {
8758
+ return $this->_plugin;
8759
+ }
8760
+
8761
+ /**
8762
+ * @author Vova Feldman (@svovaf)
8763
+ * @since 1.0.3
8764
+ *
8765
+ * @return FS_User
8766
+ */
8767
+ function get_user() {
8768
+ return $this->_user;
8769
+ }
8770
+
8771
+ /**
8772
+ * @author Vova Feldman (@svovaf)
8773
+ * @since 1.0.3
8774
+ *
8775
+ * @return FS_Site
8776
+ */
8777
+ function get_site() {
8778
+ return $this->_site;
8779
+ }
8780
+
8781
+ /**
8782
+ * Get plugin add-ons.
8783
+ *
8784
+ * @author Vova Feldman (@svovaf)
8785
+ * @since 1.0.6
8786
+ *
8787
+ * @since 1.1.7.3 If not yet loaded, fetch data from the API.
8788
+ *
8789
+ * @param bool $flush
8790
+ *
8791
+ * @return FS_Plugin[]|false
8792
+ */
8793
+ function get_addons( $flush = false ) {
8794
+ $this->_logger->entrance();
8795
+
8796
+ if ( ! $this->_has_addons ) {
8797
+ return false;
8798
+ }
8799
+
8800
+ $addons = $this->sync_addons( $flush );
8801
+
8802
+ return ( ! is_array( $addons ) || empty( $addons ) ) ?
8803
+ false :
8804
+ $addons;
8805
+ }
8806
+
8807
+ /**
8808
+ * @author Vova Feldman (@svovaf)
8809
+ * @since 1.0.6
8810
+ *
8811
+ * @return FS_Plugin[]|false
8812
+ */
8813
+ function get_account_addons() {
8814
+ $this->_logger->entrance();
8815
+
8816
+ $addons = self::get_all_account_addons();
8817
+
8818
+ if ( ! is_array( $addons ) ||
8819
+ ! isset( $addons[ $this->_plugin->id ] ) ||
8820
+ ! is_array( $addons[ $this->_plugin->id ] ) ||
8821
+ 0 === count( $addons[ $this->_plugin->id ] )
8822
+ ) {
8823
+ return false;
8824
+ }
8825
+
8826
+ return $addons[ $this->_plugin->id ];
8827
+ }
8828
+
8829
+ /**
8830
+ * Check if user has any
8831
+ *
8832
+ * @author Vova Feldman (@svovaf)
8833
+ * @since 1.1.6
8834
+ *
8835
+ * @return bool
8836
+ */
8837
+ function has_account_addons() {
8838
+ $addons = $this->get_account_addons();
8839
+
8840
+ return is_array( $addons ) && ( 0 < count( $addons ) );
8841
+ }
8842
+
8843
+
8844
+ /**
8845
+ * Get add-on by ID (from local data).
8846
+ *
8847
+ * @author Vova Feldman (@svovaf)
8848
+ * @since 1.0.6
8849
+ *
8850
+ * @param number $id
8851
+ *
8852
+ * @return FS_Plugin|false
8853
+ */
8854
+ function get_addon( $id ) {
8855
+ $this->_logger->entrance();
8856
+
8857
+ $addons = $this->get_addons();
8858
+
8859
+ if ( is_array( $addons ) ) {
8860
+ foreach ( $addons as $addon ) {
8861
+ if ( $id == $addon->id ) {
8862
+ return $addon;
8863
+ }
8864
+ }
8865
+ }
8866
+
8867
+ return false;
8868
+ }
8869
+
8870
+ /**
8871
+ * Get add-on by slug (from local data).
8872
+ *
8873
+ * @author Vova Feldman (@svovaf)
8874
+ * @since 1.0.6
8875
+ *
8876
+ * @param string $slug
8877
+ *
8878
+ * @param bool $flush
8879
+ *
8880
+ * @return FS_Plugin|false
8881
+ */
8882
+ function get_addon_by_slug( $slug, $flush = false ) {
8883
+ $this->_logger->entrance();
8884
+
8885
+ $addons = $this->get_addons( $flush );
8886
+
8887
+ if ( is_array( $addons ) ) {
8888
+ foreach ( $addons as $addon ) {
8889
+ if ( $slug === $addon->slug ) {
8890
+ return $addon;
8891
+ }
8892
+ }
8893
+ }
8894
+
8895
+ return false;
8896
+ }
8897
+
8898
+ /**
8899
+ * @author Vova Feldman (@svovaf)
8900
+ * @since 2.0.0
8901
+ *
8902
+ * @param number $user_id
8903
+ *
8904
+ * @return FS_User
8905
+ */
8906
+ static function _get_user_by_id( $user_id ) {
8907
+ self::$_static_logger->entrance( "user_id = {$user_id}" );
8908
+
8909
+ $users = self::get_all_users();
8910
+
8911
+ if ( is_array( $users ) ) {
8912
+ if ( isset( $users[ $user_id ] ) &&
8913
+ $users[ $user_id ] instanceof FS_User &&
8914
+ $user_id == $users[ $user_id ]->id
8915
+ ) {
8916
+ return $users[ $user_id ];
8917
+ }
8918
+
8919
+ // If user wasn't found by the key, iterate over all the users collection.
8920
+ foreach ( $users as $user ) {
8921
+ /**
8922
+ * @var FS_User $user
8923
+ */
8924
+ if ( $user_id == $user->id ) {
8925
+ return $user;
8926
+ }
8927
+ }
8928
+ }
8929
+
8930
+ return null;
8931
+ }
8932
+
8933
+ /**
8934
+ * Checks if a Freemius user_id is associated with a super-admin.
8935
+ *
8936
+ * @author Vova Feldman (@svovaf)
8937
+ * @since 2.0.0
8938
+ *
8939
+ * @param number $user_id
8940
+ *
8941
+ * @return bool
8942
+ */
8943
+ private static function is_super_admin( $user_id ) {
8944
+ $is_super_admin = false;
8945
+
8946
+ $user = self::_get_user_by_id( $user_id );
8947
+
8948
+ if ( $user instanceof FS_User && ! empty( $user->email ) ) {
8949
+ self::require_pluggable_essentials();
8950
+
8951
+ $wp_user = get_user_by( 'email', $user->email );
8952
+
8953
+ if ( $wp_user instanceof WP_User ) {
8954
+ $super_admins = get_super_admins();
8955
+ $is_super_admin = ( is_array( $super_admins ) && in_array( $wp_user->user_login, $super_admins ) );
8956
+ }
8957
+ }
8958
+
8959
+ return $is_super_admin;
8960
+ }
8961
+
8962
+ #----------------------------------------------------------------------------------
8963
+ #region Plans & Licensing
8964
+ #----------------------------------------------------------------------------------
8965
+
8966
+ /**
8967
+ * Check if running premium plugin code.
8968
+ *
8969
+ * @author Vova Feldman (@svovaf)
8970
+ * @since 1.0.5
8971
+ *
8972
+ * @return bool
8973
+ */
8974
+ function is_premium() {
8975
+ return $this->_plugin->is_premium;
8976
+ }
8977
+
8978
+ /**
8979
+ * Get site's plan ID.
8980
+ *
8981
+ * @author Vova Feldman (@svovaf)
8982
+ * @since 1.0.2
8983
+ *
8984
+ * @return number
8985
+ */
8986
+ function get_plan_id() {
8987
+ return $this->_site->plan_id;
8988
+ }
8989
+
8990
+ /**
8991
+ * Get site's plan title.
8992
+ *
8993
+ * @author Vova Feldman (@svovaf)
8994
+ * @since 1.0.2
8995
+ *
8996
+ * @return string
8997
+ */
8998
+ function get_plan_title() {
8999
+ $plan = $this->get_plan();
9000
+
9001
+ return is_object( $plan ) ? $plan->title : 'PLAN_TITLE';
9002
+ }
9003
+
9004
+ /**
9005
+ * Get site's plan name.
9006
+ *
9007
+ * @author Vova Feldman (@svovaf)
9008
+ * @since 2.0.0
9009
+ *
9010
+ * @return string
9011
+ */
9012
+ function get_plan_name() {
9013
+ $plan = $this->get_plan();
9014
+
9015
+ return is_object( $plan ) ? $plan->name : 'PLAN_NAME';
9016
+ }
9017
+
9018
+ /**
9019
+ * @author Vova Feldman (@svovaf)
9020
+ * @since 1.0.9
9021
+ *
9022
+ * @return FS_Plugin_Plan|false
9023
+ */
9024
+ function get_plan() {
9025
+ if ( ! is_object( $this->_site ) ) {
9026
+ return false;
9027
+ }
9028
+
9029
+ return FS_Plugin_Plan::is_valid_id( $this->_site->plan_id ) ?
9030
+ $this->_get_plan_by_id( $this->_site->plan_id ) :
9031
+ false;
9032
+ }
9033
+
9034
+ /**
9035
+ * @author Vova Feldman (@svovaf)
9036
+ * @since 1.0.3
9037
+ *
9038
+ * @return bool
9039
+ */
9040
+ function is_trial() {
9041
+ $this->_logger->entrance();
9042
+
9043
+ if ( ! $this->is_registered() ) {
9044
+ return false;
9045
+ }
9046
+
9047
+ return $this->_site->is_trial();
9048
+ }
9049
+
9050
+ /**
9051
+ * Check if currently in a trial with payment method (credit card or paypal).
9052
+ *
9053
+ * @author Vova Feldman (@svovaf)
9054
+ * @since 1.1.7
9055
+ *
9056
+ * @return bool
9057
+ */
9058
+ function is_paid_trial() {
9059
+ $this->_logger->entrance();
9060
+
9061
+ if ( ! $this->is_trial() ) {
9062
+ return false;
9063
+ }
9064
+
9065
+ return $this->has_active_valid_license() && ( $this->_site->trial_plan_id == $this->_license->plan_id );
9066
+ }
9067
+
9068
+ /**
9069
+ * Check if trial already utilized.
9070
+ *
9071
+ * @since 1.0.9
9072
+ *
9073
+ * @return bool
9074
+ */
9075
+ function is_trial_utilized() {
9076
+ $this->_logger->entrance();
9077
+
9078
+ if ( ! $this->is_registered() ) {
9079
+ return false;
9080
+ }
9081
+
9082
+ return $this->_site->is_trial_utilized();
9083
+ }
9084
+
9085
+ /**
9086
+ * Get trial plan information (if in trial).
9087
+ *
9088
+ * @author Vova Feldman (@svovaf)
9089
+ * @since 1.0.9
9090
+ *
9091
+ * @return bool|FS_Plugin_Plan
9092
+ */
9093
+ function get_trial_plan() {
9094
+ $this->_logger->entrance();
9095
+
9096
+ if ( ! $this->is_trial() ) {
9097
+ return false;
9098
+ }
9099
+
9100
+ // Try to load plan from local cache.
9101
+ $trial_plan = $this->_get_plan_by_id( $this->_site->trial_plan_id );
9102
+
9103
+ if ( ! is_object( $trial_plan ) ) {
9104
+ $trial_plan = $this->_fetch_site_plan( $this->_site->trial_plan_id );
9105
+
9106
+ /**
9107
+ * If managed to fetch the plan, add it to the plans collection.
9108
+ */
9109
+ if ( $trial_plan instanceof FS_Plugin_Plan ) {
9110
+ if ( ! is_array( $this->_plans ) ) {
9111
+ $this->_plans = array();
9112
+ }
9113
+
9114
+ $this->_plans[] = $trial_plan;
9115
+ $this->_store_plans();
9116
+ }
9117
+ }
9118
+
9119
+ if ( $trial_plan instanceof FS_Plugin_Plan ) {
9120
+ return $trial_plan;
9121
+ }
9122
+
9123
+ /**
9124
+ * If for some reason failed to get the trial plan, fallback to a dummy name and title.
9125
+ */
9126
+ $trial_plan = new FS_Plugin_Plan();
9127
+ $trial_plan->id = $this->_site->trial_plan_id;
9128
+ $trial_plan->name = 'pro';
9129
+ $trial_plan->title = 'Pro';
9130
+
9131
+ return $trial_plan;
9132
+ }
9133
+
9134
+ /**
9135
+ * Check if the user has an activate, non-expired license on current plugin's install.
9136
+ *
9137
+ * @since 1.0.9
9138
+ *
9139
+ * @return bool
9140
+ */
9141
+ function is_paying() {
9142
+ $this->_logger->entrance();
9143
+
9144
+ if ( ! $this->is_registered() ) {
9145
+ return false;
9146
+ }
9147
+
9148
+ if ( ! $this->has_paid_plan() ) {
9149
+ return false;
9150
+ }
9151
+
9152
+ return (
9153
+ ! $this->is_trial() &&
9154
+ 'free' !== $this->get_plan_name() &&
9155
+ $this->has_active_valid_license()
9156
+ );
9157
+ }
9158
+
9159
+ /**
9160
+ * @author Vova Feldman (@svovaf)
9161
+ * @since 1.0.4
9162
+ *
9163
+ * @return bool
9164
+ */
9165
+ function is_free_plan() {
9166
+ if ( ! $this->is_registered() ) {
9167
+ return true;
9168
+ }
9169
+
9170
+ if ( ! $this->has_paid_plan() ) {
9171
+ return true;
9172
+ }
9173
+
9174
+ return (
9175
+ 'free' === $this->get_plan_name() ||
9176
+ ! $this->has_features_enabled_license()
9177
+ );
9178
+ }
9179
+
9180
+ /**
9181
+ * @author Vova Feldman (@svovaf)
9182
+ * @since 1.0.5
9183
+ *
9184
+ * @return bool
9185
+ */
9186
+ function _has_premium_license() {
9187
+ $this->_logger->entrance();
9188
+
9189
+ $premium_license = $this->_get_available_premium_license();
9190
+
9191
+ return ( false !== $premium_license );
9192
+ }
9193
+
9194
+ /**
9195
+ * Check if user has any licenses associated with the plugin (including expired or blocking).
9196
+ *
9197
+ * @author Vova Feldman (@svovaf)
9198
+ * @since 1.1.7.3
9199
+ *
9200
+ * @return bool
9201
+ */
9202
+ private function has_any_license() {
9203
+ return is_array( $this->_licenses ) && ( 0 < count( $this->_licenses ) );
9204
+ }
9205
+
9206
+ /**
9207
+ * @author Vova Feldman (@svovaf)
9208
+ * @since 1.0.5
9209
+ *
9210
+ * @param bool|null $is_localhost
9211
+ *
9212
+ * @return FS_Plugin_License|false
9213
+ */
9214
+ function _get_available_premium_license( $is_localhost = null ) {
9215
+ $this->_logger->entrance();
9216
+
9217
+ $licenses = $this->get_available_premium_licenses( $is_localhost );
9218
+ if ( ! empty( $licenses ) ) {
9219
+ return $licenses[0];
9220
+ }
9221
+
9222
+ return false;
9223
+ }
9224
+
9225
+ /**
9226
+ * @author Vova Feldman (@svovaf)
9227
+ * @since 1.0.5
9228
+ *
9229
+ * @param bool|null $is_localhost
9230
+ *
9231
+ * @return FS_Plugin_License[]
9232
+ */
9233
+ function get_available_premium_licenses( $is_localhost = null ) {
9234
+ $this->_logger->entrance();
9235
+
9236
+ $licenses = array();
9237
+ if ( ! $this->has_paid_plan() ) {
9238
+ return $licenses;
9239
+ }
9240
+
9241
+ if ( is_array( $this->_licenses ) ) {
9242
+ foreach ( $this->_licenses as $license ) {
9243
+ if ( ! $license->can_activate( $is_localhost ) ) {
9244
+ continue;
9245
+ }
9246
+
9247
+ $licenses[] = $license;
9248
+ }
9249
+ }
9250
+
9251
+ return $licenses;
9252
+ }
9253
+
9254
+ /**
9255
+ * Sync local plugin plans with remote server.
9256
+ *
9257
+ * 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).
9258
+ *
9259
+ * @author Vova Feldman (@svovaf)
9260
+ * @since 1.0.5
9261
+ *
9262
+ * @return FS_Plugin_Plan[]|object
9263
+ */
9264
+ function _sync_plans() {
9265
+ $plans = $this->_fetch_plugin_plans();
9266
+
9267
+ if ( $this->is_array_instanceof( $plans, 'FS_Plugin_Plan' ) ) {
9268
+ $plans_map = array();
9269
+ foreach ( $plans as $plan ) {
9270
+ $plans_map[ $plan->id ] = true;
9271
+ }
9272
+
9273
+ $plans_ids_to_keep = $this->get_plans_ids_associated_with_installs();
9274
+
9275
+ foreach ( $plans_ids_to_keep as $plan_id ) {
9276
+ if ( isset( $plans_map[ $plan_id ] ) ) {
9277
+ continue;
9278
+ }
9279
+
9280
+ $missing_plan = self::_get_plan_by_id( $plan_id );
9281
+
9282
+ if ( is_object( $missing_plan ) ) {
9283
+ $plans[] = $missing_plan;
9284
+ }
9285
+ }
9286
+
9287
+ $this->_plans = $plans;
9288
+ $this->_store_plans();
9289
+ }
9290
+
9291
+ $this->do_action( 'after_plans_sync', $plans );
9292
+
9293
+ return $this->_plans;
9294
+ }
9295
+
9296
+ /**
9297
+ * Check if specified plan exists locally. If not, fetch it and store it.
9298
+ *
9299
+ * @author Vova Feldman (@svovaf)
9300
+ * @since 2.0.0
9301
+ *
9302
+ * @param number $plan_id
9303
+ *
9304
+ * @return \FS_Plugin_Plan|object The plan entity or the API error object on failure.
9305
+ */
9306
+ private function sync_plan_if_not_exist( $plan_id ) {
9307
+ $plan = self::_get_plan_by_id( $plan_id );
9308
+
9309
+ if ( is_object( $plan ) ) {
9310
+ // Plan already exists.
9311
+ return $plan;
9312
+ }
9313
+
9314
+ $plan = $this->fetch_plan_by_id( $plan_id );
9315
+
9316
+ if ( $plan instanceof FS_Plugin_Plan ) {
9317
+ $this->_plans[] = $plan;
9318
+ $this->_store_plans();
9319
+
9320
+ return $plan;
9321
+ }
9322
+
9323
+ return $plan;
9324
+ }
9325
+
9326
+ /**
9327
+ * Check if specified license exists locally. If not, fetch it and store it.
9328
+ *
9329
+ * @author Vova Feldman (@svovaf)
9330
+ * @since 2.0.0
9331
+ *
9332
+ * @param number $license_id
9333
+ * @param string $license_key
9334
+ *
9335
+ * @return \FS_Plugin_Plan|object The plan entity or the API error object on failure.
9336
+ */
9337
+ private function sync_license_if_not_exist( $license_id, $license_key ) {
9338
+ $license = $this->_get_license_by_id( $license_id );
9339
+
9340
+ if ( is_object( $license ) ) {
9341
+ // License already exists.
9342
+ return $license;
9343
+ }
9344
+
9345
+ $license = $this->fetch_license_by_key( $license_id, $license_key );
9346
+
9347
+ if ( $license instanceof FS_Plugin_License ) {
9348
+ $this->_licenses[] = $license;
9349
+ $this->_license = $license;
9350
+ $this->_store_licenses();
9351
+
9352
+ return $license;
9353
+ }
9354
+
9355
+ return $license;
9356
+ }
9357
+
9358
+ /**
9359
+ * Get a collection of unique plan IDs that are associated with any installs in the network.
9360
+ *
9361
+ * @author Leo Fajardo (@leorw)
9362
+ * @since 2.0.0
9363
+ *
9364
+ * @return number[]
9365
+ */
9366
+ private function get_plans_ids_associated_with_installs() {
9367
+ if ( ! $this->_is_network_active ) {
9368
+ if ( ! is_object( $this->_site ) ||
9369
+ ! FS_Plugin_Plan::is_valid_id( $this->_site->plan_id )
9370
+ ) {
9371
+ return array();
9372
+ }
9373
+
9374
+ return array( $this->_site->plan_id );
9375
+ }
9376
+
9377
+ $plan_ids = array();
9378
+ $sites = self::get_sites();
9379
+ foreach ( $sites as $site ) {
9380
+ $blog_id = self::get_site_blog_id( $site );
9381
+ $install = $this->get_install_by_blog_id( $blog_id );
9382
+
9383
+ if ( ! is_object( $install ) ||
9384
+ ! FS_Plugin_Plan::is_valid_id( $install->plan_id )
9385
+ ) {
9386
+ continue;
9387
+ }
9388
+
9389
+ $plan_ids[ $install->plan_id ] = true;
9390
+ }
9391
+
9392
+ return array_keys( $plan_ids );
9393
+ }
9394
+
9395
+ /**
9396
+ * Get a collection of unique license IDs that are associated with any installs in the network.
9397
+ *
9398
+ * @author Leo Fajardo (@leorw)
9399
+ * @since 2.0.0
9400
+ *
9401
+ * @return number[]
9402
+ */
9403
+ private function get_license_ids_associated_with_installs() {
9404
+ if ( ! $this->_is_network_active ) {
9405
+ if ( ! is_object( $this->_site ) ||
9406
+ ! FS_Plugin_License::is_valid_id( $this->_site->license_id )
9407
+ ) {
9408
+ return array();
9409
+ }
9410
+
9411
+ return array( $this->_site->license_id );
9412
+ }
9413
+
9414
+ $license_ids = array();
9415
+ $sites = self::get_sites();
9416
+ foreach ( $sites as $site ) {
9417
+ $blog_id = self::get_site_blog_id( $site );
9418
+ $install = $this->get_install_by_blog_id( $blog_id );
9419
+
9420
+ if ( ! is_object( $install ) ||
9421
+ ! FS_Plugin_License::is_valid_id( $install->license_id )
9422
+ ) {
9423
+ continue;
9424
+ }
9425
+
9426
+ $license_ids[ $install->license_id ] = true;
9427
+ }
9428
+
9429
+ return array_keys( $license_ids );
9430
+ }
9431
+
9432
+ /**
9433
+ * @author Vova Feldman (@svovaf)
9434
+ * @since 1.0.5
9435
+ *
9436
+ * @param number $id
9437
+ *
9438
+ * @return FS_Plugin_Plan|false
9439
+ */
9440
+ function _get_plan_by_id( $id ) {
9441
+ $this->_logger->entrance();
9442
+
9443
+ if ( ! is_array( $this->_plans ) || 0 === count( $this->_plans ) ) {
9444
+ $this->_sync_plans();
9445
+ }
9446
+
9447
+ foreach ( $this->_plans as $plan ) {
9448
+ if ( $id == $plan->id ) {
9449
+ return $plan;
9450
+ }
9451
+ }
9452
+
9453
+ return false;
9454
+ }
9455
+
9456
+ /**
9457
+ * @author Vova Feldman (@svovaf)
9458
+ * @since 1.1.8.1
9459
+ *
9460
+ * @param string $name
9461
+ *
9462
+ * @return FS_Plugin_Plan|false
9463
+ */
9464
+ private function get_plan_by_name( $name ) {
9465
+ $this->_logger->entrance();
9466
+
9467
+ if ( ! is_array( $this->_plans ) || 0 === count( $this->_plans ) ) {
9468
+ $this->_sync_plans();
9469
+ }
9470
+
9471
+ foreach ( $this->_plans as $plan ) {
9472
+ if ( $name == $plan->name ) {
9473
+ return $plan;
9474
+ }
9475
+ }
9476
+
9477
+ return false;
9478
+ }
9479
+
9480
+ /**
9481
+ * Sync local licenses with remote server.
9482
+ *
9483
+ * @author Vova Feldman (@svovaf)
9484
+ * @since 1.0.6
9485
+ *
9486
+ * @param number|bool $site_license_id
9487
+ * @param number|null $blog_id
9488
+ *
9489
+ * @return FS_Plugin_License[]|object
9490
+ */
9491
+ function _sync_licenses( $site_license_id = false, $blog_id = null ) {
9492
+ $this->_logger->entrance();
9493
+
9494
+ $is_network_admin = fs_is_network_admin();
9495
+
9496
+ if ( $is_network_admin && is_null( $blog_id ) ) {
9497
+ $all_licenses = self::get_all_licenses( $this->_module_id );
9498
+ } else {
9499
+ $all_licenses = $this->get_user_licenses( $this->_user->id );
9500
+ }
9501
+
9502
+ $foreign_licenses = array(
9503
+ 'ids' => array(),
9504
+ 'license_keys' => array()
9505
+ );
9506
+
9507
+ $all_licenses_map = array();
9508
+ foreach ( $all_licenses as $license ) {
9509
+ $all_licenses_map[ $license->id ] = true;
9510
+ if ( $license->user_id == $this->_user->id || $license->id == $site_license_id ) {
9511
+ continue;
9512
+ }
9513
+
9514
+ $foreign_licenses['ids'][] = $license->id;
9515
+ $foreign_licenses['license_keys'][] = $license->secret_key;
9516
+ }
9517
+
9518
+ if ( empty( $foreign_licenses['ids'] ) ) {
9519
+ $foreign_licenses = array();
9520
+ }
9521
+
9522
+ $licenses = $this->_fetch_licenses( false, $site_license_id, $foreign_licenses, $blog_id );
9523
+
9524
+ if ( $this->is_array_instanceof( $licenses, 'FS_Plugin_License' ) ) {
9525
+ $licenses_map = array();
9526
+ foreach ( $licenses as $license ) {
9527
+ $licenses_map[ $license->id ] = true;
9528
+ }
9529
+
9530
+ // $license_ids_to_keep = $this->get_license_ids_associated_with_installs();
9531
+ // foreach ( $license_ids_to_keep as $license_id ) {
9532
+ // if ( isset( $licenses_map[ $license_id ] ) ) {
9533
+ // continue;
9534
+ // }
9535
+ //
9536
+ // $missing_license = self::_get_license_by_id( $license_id, false );
9537
+ // if ( is_object( $missing_license ) ) {
9538
+ // $licenses[] = $missing_license;
9539
+ // $licenses_map[ $missing_license->id ] = true;
9540
+ // }
9541
+ // }
9542
+
9543
+ $user_license_ids = $this->get_user_linked_license_ids( $this->_user->id );
9544
+
9545
+ foreach ( $user_license_ids as $key => $license_id ) {
9546
+ if ( ! isset( $licenses_map[ $license_id ] ) ) {
9547
+ // Remove access to licenses that no longer exist.
9548
+ unset( $user_license_ids[ $key ] );
9549
+ }
9550
+ }
9551
+
9552
+ if ( ! empty( $user_license_ids ) ) {
9553
+ foreach ( $licenses_map as $license_id => $value ) {
9554
+ if ( ! isset( $all_licenses_map[ $license_id ] ) ) {
9555
+ // Associate new licenses with the user who triggered the license syncing.
9556
+ $user_license_ids[] = $license_id;
9557
+ }
9558
+ }
9559
+
9560
+ $user_license_ids = array_unique( $user_license_ids );
9561
+ } else {
9562
+ $user_license_ids = array_keys( $licenses_map );
9563
+ }
9564
+
9565
+ if ( ! $is_network_admin || ! is_null( $blog_id ) ) {
9566
+ $user_licenses = array();
9567
+ foreach ( $licenses as $license ) {
9568
+ if ( ! in_array( $license->id, $user_license_ids ) ) {
9569
+ continue;
9570
+ }
9571
+
9572
+ $user_licenses[] = $license;
9573
+ }
9574
+
9575
+ $this->_licenses = $user_licenses;
9576
+ } else {
9577
+ $this->_licenses = $licenses;
9578
+ }
9579
+
9580
+ $this->set_user_linked_license_ids( $this->_user->id, $user_license_ids );
9581
+
9582
+ $this->_store_licenses( true, $this->_module_id, $licenses );
9583
+ }
9584
+
9585
+ // Update current license.
9586
+ if ( is_object( $this->_license ) ) {
9587
+ $this->_license = $this->_get_license_by_id( $this->_license->id );
9588
+ }
9589
+
9590
+ return $this->_licenses;
9591
+ }
9592
+
9593
+ /**
9594
+ * @author Vova Feldman (@svovaf)
9595
+ * @since 1.0.5
9596
+ *
9597
+ * @param number $id
9598
+ * @param bool $sync_licenses
9599
+ *
9600
+ * @return FS_Plugin_License|false
9601
+ */
9602
+ function _get_license_by_id( $id, $sync_licenses = true ) {
9603
+ $this->_logger->entrance();
9604
+
9605
+ if ( ! FS_Plugin_License::is_valid_id( $id ) ) {
9606
+ return false;
9607
+ }
9608
+
9609
+ /**
9610
+ * When running from the network level admin and opted-in from the network,
9611
+ * check if the license exists in the network user licenses collection.
9612
+ *
9613
+ * @author Vova Feldman (@svovaf)
9614
+ * @since 2.0.0
9615
+ */
9616
+ if ( fs_is_network_admin() &&
9617
+ $this->is_network_registered() &&
9618
+ ( ! is_object( $this->_user ) || $this->_storage->network_user_id != $this->_user->id )
9619
+ ) {
9620
+ $licenses = $this->get_user_licenses( $this->_storage->network_user_id );
9621
+
9622
+ foreach ( $licenses as $license ) {
9623
+ if ( $id == $license->id ) {
9624
+ return $license;
9625
+ }
9626
+ }
9627
+ }
9628
+
9629
+ if ( ! $this->has_any_license() && $sync_licenses ) {
9630
+ $this->_sync_licenses( $id );
9631
+ }
9632
+
9633
+ if ( is_array( $this->_licenses ) ) {
9634
+ foreach ( $this->_licenses as $license ) {
9635
+ if ( $id == $license->id ) {
9636
+ return $license;
9637
+ }
9638
+ }
9639
+ }
9640
+
9641
+ return false;
9642
+ }
9643
+
9644
+ /**
9645
+ * 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.
9646
+ *
9647
+ * @author Vova Feldman (@svovaf)
9648
+ * @since 2.0.0
9649
+ *
9650
+ * @param number $id
9651
+ *
9652
+ * @return FS_Plugin_License
9653
+ */
9654
+ private function get_license_by_id( $id ) {
9655
+ $licenses = self::get_all_licenses( $this->_module_id );
9656
+
9657
+ if ( is_array( $licenses ) && ! empty( $licenses ) ) {
9658
+ foreach ( $licenses as $license ) {
9659
+ if ( $id == $license->id ) {
9660
+ return $license;
9661
+ }
9662
+ }
9663
+ }
9664
+
9665
+ return null;
9666
+ }
9667
+
9668
+ /**
9669
+ * Synchronize the site's context license by fetching the license form the API and updating the local data with it.
9670
+ *
9671
+ * @author Vova Feldman (@svovaf)
9672
+ * @since 2.0.0
9673
+ *
9674
+ * @return \FS_Plugin_License|mixed
9675
+ */
9676
+ private function sync_site_license() {
9677
+ $api = $this->get_api_user_scope();
9678
+
9679
+ $result = $api->get( "/licenses/{$this->_license->id}.json?license_key=" . urlencode( $this->_license->secret_key ), true );
9680
+
9681
+ if ( ! $this->is_api_result_entity( $result ) ) {
9682
+ return $result;
9683
+ }
9684
+
9685
+ $license = $this->_update_site_license( new FS_Plugin_License( $result ) );
9686
+ $this->_store_licenses();
9687
+
9688
+ return $license;
9689
+ }
9690
+
9691
+ /**
9692
+ * Get all user's available licenses for the current module.
9693
+ *
9694
+ * @author Vova Feldman (@svovaf)
9695
+ * @since 2.0.0
9696
+ *
9697
+ * @param number $user_id
9698
+ *
9699
+ * @return FS_Plugin_License[]
9700
+ */
9701
+ private function get_user_licenses( $user_id ) {
9702
+ $all_licenses = self::get_all_licenses( $this->_module_id );
9703
+ if ( empty( $all_licenses ) ) {
9704
+ return array();
9705
+ }
9706
+
9707
+ $user_license_ids = $this->get_user_linked_license_ids( $user_id );
9708
+ if ( empty( $user_license_ids ) ) {
9709
+ return array();
9710
+ }
9711
+
9712
+ $licenses = array();
9713
+ foreach ( $all_licenses as $license ) {
9714
+ if ( in_array( $license->id, $user_license_ids ) ) {
9715
+ $licenses[] = $license;
9716
+ }
9717
+ }
9718
+
9719
+ return $licenses;
9720
+ }
9721
+
9722
+ /**
9723
+ * Checks if the context license is network activated except on the given blog ID.
9724
+ *
9725
+ * @author Vova Feldman (@svovaf)
9726
+ * @since 2.0.0
9727
+ *
9728
+ * @param int $except_blog_id
9729
+ *
9730
+ * @return bool
9731
+ */
9732
+ private function is_license_network_active( $except_blog_id = 0 ) {
9733
+ $this->_logger->entrance();
9734
+
9735
+ if ( ! is_object( $this->_license ) ) {
9736
+ return false;
9737
+ }
9738
+
9739
+ $sites = self::get_sites();
9740
+
9741
+ if ( $this->_license->total_activations() < ( count( $sites ) - 1 ) ) {
9742
+ // There are more sites than the number of activations, so license cannot be network activated.
9743
+ return false;
9744
+ }
9745
+
9746
+ foreach ( $sites as $site ) {
9747
+ $blog_id = self::get_site_blog_id( $site );
9748
+
9749
+ if ( $except_blog_id == $blog_id ) {
9750
+ // Skip excluded blog.
9751
+ continue;
9752
+ }
9753
+
9754
+ $install = $this->get_install_by_blog_id( $blog_id );
9755
+
9756
+ if ( is_object( $install ) && $install->license_id != $this->_license->id ) {
9757
+ return false;
9758
+ }
9759
+ }
9760
+
9761
+ return true;
9762
+ }
9763
+
9764
+ /**
9765
+ * 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.
9766
+ *
9767
+ * Notice: On success, this method will also update the license activations counters (without updating the license in the storage).
9768
+ *
9769
+ * @author Vova Feldman (@svovaf)
9770
+ * @since 2.0.0
9771
+ *
9772
+ * @param \FS_User $user
9773
+ * @param \FS_Plugin_License $license
9774
+ *
9775
+ * @return bool
9776
+ */
9777
+ private function try_activate_license_on_network( FS_User $user, FS_Plugin_License $license ) {
9778
+ $this->_logger->entrance();
9779
+
9780
+ $result = $this->can_activate_license_on_network( $license );
9781
+
9782
+ if ( false === $result ) {
9783
+ return false;
9784
+ }
9785
+
9786
+ $installs_without_license = $result['installs'];
9787
+ if ( ! empty( $installs_without_license ) ) {
9788
+ $this->activate_license_on_many_installs( $user, $license->secret_key, $installs_without_license );
9789
+ }
9790
+
9791
+ $disconnected_site_ids = $result['sites'];
9792
+ if ( ! empty( $disconnected_site_ids ) ) {
9793
+ $this->activate_license_on_many_sites( $user, $license->secret_key, $disconnected_site_ids );
9794
+ }
9795
+
9796
+ $this->link_license_2_user( $license->id, $user->id );
9797
+
9798
+ // Sync license after activations.
9799
+ $license->activated += $result['production_count'];
9800
+ $license->activated_local += $result['localhost_count'];
9801
+
9802
+ // $this->_store_licenses()
9803
+
9804
+ return true;
9805
+ }
9806
+
9807
+ /**
9808
+ * Checks if the given license can be activated on the whole network.
9809
+ *
9810
+ * @author Vova Feldman (@svovaf)
9811
+ * @since 2.0.0
9812
+ *
9813
+ * @param \FS_Plugin_License $license
9814
+ *
9815
+ * @return false|array {
9816
+ * @type array[int]FS_Site $installs Blog ID to install map.
9817
+ * @type int[] $sites Non-connected blog IDs.
9818
+ * @type int $production_count Production sites count.
9819
+ * @type int $localhost_count Production sites count.
9820
+ * }
9821
+ */
9822
+ private function can_activate_license_on_network( FS_Plugin_License $license ) {
9823
+ $sites = self::get_sites();
9824
+
9825
+ $production_count = 0;
9826
+ $localhost_count = 0;
9827
+
9828
+ $installs_without_license = array();
9829
+ $disconnected_site_ids = array();
9830
+
9831
+ foreach ( $sites as $site ) {
9832
+ $blog_id = self::get_site_blog_id( $site );
9833
+ $install = $this->get_install_by_blog_id( $blog_id );
9834
+
9835
+ if ( is_object( $install ) ) {
9836
+ if ( FS_Plugin_License::is_valid_id( $install->license_id ) ) {
9837
+ // License already activated on the install.
9838
+ continue;
9839
+ }
9840
+
9841
+ $url = $install->url;
9842
+
9843
+ $installs_without_license[ $blog_id ] = $install;
9844
+ } else {
9845
+ $url = is_object( $site ) ?
9846
+ $site->siteurl :
9847
+ get_site_url( $blog_id );
9848
+
9849
+ $disconnected_site_ids[] = $blog_id;
9850
+ }
9851
+
9852
+ if ( FS_Site::is_localhost_by_address( $url ) ) {
9853
+ $localhost_count ++;
9854
+ } else {
9855
+ $production_count ++;
9856
+ }
9857
+ }
9858
+
9859
+ if ( ! $license->can_activate_bulk( $production_count, $localhost_count ) ) {
9860
+ return false;
9861
+ }
9862
+
9863
+ return array(
9864
+ 'installs' => $installs_without_license,
9865
+ 'sites' => $disconnected_site_ids,
9866
+ 'production_count' => $production_count,
9867
+ 'localhost_count' => $localhost_count,
9868
+ );
9869
+ }
9870
+
9871
+ /**
9872
+ * Activate a given license on a collection of installs.
9873
+ *
9874
+ * @author Vova Feldman (@svovaf)
9875
+ * @since 2.0.0
9876
+ *
9877
+ * @param \FS_User $user
9878
+ * @param string $license_key
9879
+ * @param array $blog_2_install_map {
9880
+ * @key int Blog ID.
9881
+ * @value FS_Site Blog's associated install.
9882
+ * }
9883
+ *
9884
+ * @return mixed|true
9885
+ */
9886
+ private function activate_license_on_many_installs(
9887
+ FS_User $user,
9888
+ $license_key,
9889
+ array $blog_2_install_map
9890
+ ) {
9891
+ $params = array(
9892
+ array( 'license_key' => $this->apply_filters( 'license_key', $license_key ) )
9893
+ );
9894
+
9895
+ $install_2_blog_map = array();
9896
+ foreach ( $blog_2_install_map as $blog_id => $install ) {
9897
+ $params[] = array( 'id' => $install->id );
9898
+
9899
+ $install_2_blog_map[ $install->id ] = $blog_id;
9900
+ }
9901
+
9902
+ $result = $this->get_api_user_scope_by_user( $user )->call(
9903
+ "plugins/{$this->_plugin->id}/installs.json",
9904
+ 'PUT',
9905
+ $params
9906
+ );
9907
+
9908
+ if ( ! $this->is_api_result_object( $result, 'installs' ) ) {
9909
+ return $result;
9910
+ }
9911
+
9912
+ foreach ( $result->installs as $r_install ) {
9913
+ $install = new FS_Site( $r_install );
9914
+ $install->is_disconnected = false;
9915
+
9916
+ // Update install.
9917
+ $this->_store_site(
9918
+ true,
9919
+ $install_2_blog_map[ $r_install->id ],
9920
+ $install
9921
+ );
9922
+ }
9923
+
9924
+ return true;
9925
+ }
9926
+
9927
+ /**
9928
+ * Activate a given license on a collection of blogs/sites that are not yet opted-in.
9929
+ *
9930
+ * @author Vova Feldman (@svovaf)
9931
+ * @since 2.0.0
9932
+ *
9933
+ * @param \FS_User $user
9934
+ * @param string $license_key
9935
+ * @param int[] $site_ids
9936
+ *
9937
+ * @return true|mixed True if successful, otherwise, the API result.
9938
+ */
9939
+ private function activate_license_on_many_sites(
9940
+ FS_User $user,
9941
+ $license_key,
9942
+ array $site_ids
9943
+ ) {
9944
+ $sites = array();
9945
+ foreach ( $site_ids as $site_id ) {
9946
+ $sites[] = $this->get_site_info( array( 'blog_id' => $site_id ) );
9947
+ }
9948
+
9949
+ // Install the plugin.
9950
+ $result = $this->create_installs_with_user(
9951
+ $user,
9952
+ $license_key,
9953
+ false,
9954
+ $sites,
9955
+ false,
9956
+ true
9957
+ );
9958
+
9959
+ if ( ! $this->is_api_result_entity( $result ) &&
9960
+ ! $this->is_api_result_object( $result, 'installs' )
9961
+ ) {
9962
+ return $result;
9963
+ }
9964
+
9965
+ $installs = array();
9966
+ foreach ( $result->installs as $install ) {
9967
+ $installs[] = new FS_Site( $install );
9968
+ }
9969
+
9970
+ // Map site addresses to their blog IDs.
9971
+ $address_to_blog_map = $this->get_address_to_blog_map();
9972
+
9973
+ $first_blog_id = null;
9974
+
9975
+ foreach ( $installs as $install ) {
9976
+ $address = trailingslashit( fs_strip_url_protocol( $install->url ) );
9977
+ $blog_id = $address_to_blog_map[ $address ];
9978
+
9979
+ $this->_store_site( true, $blog_id, $install );
9980
+
9981
+ $this->reset_anonymous_mode( $blog_id );
9982
+
9983
+ if ( is_null( $first_blog_id ) ) {
9984
+ $first_blog_id = $blog_id;
9985
+ }
9986
+ }
9987
+
9988
+ if ( ! FS_Site::is_valid_id( $this->_storage->network_install_blog_id ) ) {
9989
+ $this->_storage->network_install_blog_id = $first_blog_id;
9990
+ }
9991
+
9992
+ return true;
9993
+ }
9994
+
9995
+ /**
9996
+ * Sync site's license with user licenses.
9997
+ *
9998
+ * @author Vova Feldman (@svovaf)
9999
+ * @since 1.0.6
10000
+ *
10001
+ * @param FS_Plugin_License|null $new_license
10002
+ *
10003
+ * @return FS_Plugin_License|null
10004
+ */
10005
+ function _update_site_license( $new_license ) {
10006
+ $this->_logger->entrance();
10007
+
10008
+ $this->_license = $new_license;
10009
+
10010
+ if ( ! is_object( $new_license ) ) {
10011
+ $this->_site->license_id = null;
10012
+ $this->_sync_site_subscription( null );
10013
+
10014
+ return $this->_license;
10015
+ }
10016
+
10017
+ $this->_site->license_id = $this->_license->id;
10018
+
10019
+ if ( ! is_array( $this->_licenses ) ) {
10020
+ $this->_licenses = array();
10021
+ }
10022
+
10023
+ $is_license_found = false;
10024
+ for ( $i = 0, $len = count( $this->_licenses ); $i < $len; $i ++ ) {
10025
+ if ( $new_license->id == $this->_licenses[ $i ]->id ) {
10026
+ $this->_licenses[ $i ] = $new_license;
10027
+
10028
+ $is_license_found = true;
10029
+ break;
10030
+ }
10031
+ }
10032
+
10033
+ // If new license just append.
10034
+ if ( ! $is_license_found ) {
10035
+ $this->_licenses[] = $new_license;
10036
+ }
10037
+
10038
+ $this->_sync_site_subscription( $new_license );
10039
+
10040
+ return $this->_license;
10041
+ }
10042
+
10043
+ /**
10044
+ * Sync site's subscription.
10045
+ *
10046
+ * @author Vova Feldman (@svovaf)
10047
+ * @since 1.0.9
10048
+ *
10049
+ * @param FS_Plugin_License|null $license
10050
+ *
10051
+ * @return bool|\FS_Subscription
10052
+ */
10053
+ private function _sync_site_subscription( $license ) {
10054
+ if ( ! is_object( $license ) ) {
10055
+ $this->delete_unused_subscriptions();
10056
+
10057
+ return false;
10058
+ }
10059
+
10060
+ // Load subscription details if not lifetime.
10061
+ $subscription = $license->is_lifetime() ?
10062
+ false :
10063
+ $this->_fetch_site_license_subscription();
10064
+
10065
+ if ( is_object( $subscription ) && ! isset( $subscription->error ) ) {
10066
+ $this->store_subscription( $subscription );
10067
+ } else {
10068
+ $this->delete_unused_subscriptions();
10069
+ }
10070
+
10071
+ return $subscription;
10072
+ }
10073
+
10074
+ /**
10075
+ * @author Vova Feldman (@svovaf)
10076
+ * @since 1.0.6
10077
+ *
10078
+ * @return bool|\FS_Plugin_License
10079
+ */
10080
+ function _get_license() {
10081
+ if ( ! fs_is_network_admin() || is_object( $this->_license ) ) {
10082
+ return $this->_license;
10083
+ }
10084
+
10085
+ return $this->_get_available_premium_license();
10086
+ }
10087
+
10088
+ /**
10089
+ * @param number $license_id
10090
+ *
10091
+ * @return null|\FS_Subscription
10092
+ */
10093
+ function _get_subscription( $license_id ) {
10094
+ if ( ! isset( $this->_storage->subscriptions ) ||
10095
+ empty( $this->_storage->subscriptions )
10096
+ ) {
10097
+ return null;
10098
+ }
10099
+
10100
+ foreach ( $this->_storage->subscriptions as $subscription ) {
10101
+ if ( $subscription->license_id == $license_id ) {
10102
+ return $subscription;
10103
+ }
10104
+ }
10105
+
10106
+ return null;
10107
+ }
10108
+
10109
+ /**
10110
+ * @author Leo Fajardo (@leorw)
10111
+ * @since 2.0.0
10112
+ *
10113
+ * @param FS_Subscription $subscription
10114
+ */
10115
+ function store_subscription( FS_Subscription $subscription ) {
10116
+ if ( ! isset( $this->_storage->subscriptions ) ) {
10117
+ $this->_storage->subscriptions = array();
10118
+ }
10119
+
10120
+ if ( empty( $this->_storage->subscriptions ) || ! is_multisite() ) {
10121
+ $this->_storage->subscriptions = array( $subscription );
10122
+
10123
+ return;
10124
+ }
10125
+
10126
+ $subscriptions = $this->_storage->subscriptions;
10127
+
10128
+ $updated_subscription = false;
10129
+ foreach ( $subscriptions as $key => $existing_subscription ) {
10130
+ if ( $existing_subscription->id == $subscription->id ) {
10131
+ $subscriptions[ $key ] = $subscription;
10132
+ $updated_subscription = true;
10133
+ break;
10134
+ }
10135
+ }
10136
+
10137
+ if ( ! $updated_subscription ) {
10138
+ $subscriptions[] = $subscription;
10139
+ }
10140
+
10141
+ $this->_storage->subscriptions = $subscriptions;
10142
+ }
10143
+
10144
+ /**
10145
+ * @author Leo Fajardo (@leorw)
10146
+ * @since 2.0.0
10147
+ */
10148
+ function delete_unused_subscriptions() {
10149
+ if ( ! isset( $this->_storage->subscriptions ) ||
10150
+ empty( $this->_storage->subscriptions ) ||
10151
+ // Clean up only if there are already at least 3 subscriptions.
10152
+ ( count( $this->_storage->subscriptions ) < 3 )
10153
+ ) {
10154
+ return;
10155
+ }
10156
+
10157
+ if ( ! is_multisite() ) {
10158
+ // If not multisite, there should only be 1 subscription, so just clear the array.
10159
+ $this->_storage->subscriptions = array();
10160
+
10161
+ return;
10162
+ }
10163
+
10164
+ $subscriptions_to_keep_by_license_id_map = array();
10165
+ $sites = self::get_sites();
10166
+ foreach ( $sites as $site ) {
10167
+ $blog_id = self::get_site_blog_id( $site );
10168
+ $install = $this->get_install_by_blog_id( $blog_id );
10169
+
10170
+ if ( ! is_object( $install ) ||
10171
+ ! FS_Plugin_License::is_valid_id( $install->license_id )
10172
+ ) {
10173
+ continue;
10174
+ }
10175
+
10176
+ $subscriptions_to_keep_by_license_id_map[ $install->license_id ] = true;
10177
+ }
10178
+
10179
+ if ( empty( $subscriptions_to_keep_by_license_id_map ) ) {
10180
+ $this->_storage->subscriptions = array();
10181
+
10182
+ return;
10183
+ }
10184
+
10185
+ foreach ( $this->_storage->subscriptions as $key => $subscription ) {
10186
+ if ( ! isset( $subscriptions_to_keep_by_license_id_map[ $subscription->license_id ] ) ) {
10187
+ unset( $this->_storage->subscriptions[ $key ] );
10188
+ }
10189
+ }
10190
+ }
10191
+
10192
+ /**
10193
+ * @author Vova Feldman (@svovaf)
10194
+ * @since 1.0.2
10195
+ *
10196
+ * @param string $plan Plan name
10197
+ * @param bool $exact If true, looks for exact plan. If false, also check "higher" plans.
10198
+ *
10199
+ * @return bool
10200
+ */
10201
+ function is_plan( $plan, $exact = false ) {
10202
+ $this->_logger->entrance();
10203
+
10204
+ if ( ! $this->is_registered() ) {
10205
+ return false;
10206
+ }
10207
+
10208
+ $plan = strtolower( $plan );
10209
+
10210
+ $current_plan_name = $this->get_plan_name();
10211
+
10212
+ if ( $current_plan_name === $plan ) {
10213
+ // Exact plan.
10214
+ return true;
10215
+ } else if ( $exact ) {
10216
+ // Required exact, but plans are different.
10217
+ return false;
10218
+ }
10219
+
10220
+ $current_plan_order = - 1;
10221
+ $required_plan_order = - 1;
10222
+ for ( $i = 0, $len = count( $this->_plans ); $i < $len; $i ++ ) {
10223
+ if ( $plan === $this->_plans[ $i ]->name ) {
10224
+ $required_plan_order = $i;
10225
+ } else if ( $current_plan_name === $this->_plans[ $i ]->name ) {
10226
+ $current_plan_order = $i;
10227
+ }
10228
+ }
10229
+
10230
+ return ( $current_plan_order > $required_plan_order );
10231
+ }
10232
+
10233
+ /**
10234
+ * Check if module has only one plan.
10235
+ *
10236
+ * @author Vova Feldman (@svovaf)
10237
+ * @since 1.2.1.7
10238
+ *
10239
+ * @return bool
10240
+ */
10241
+ function is_single_plan() {
10242
+ $this->_logger->entrance();
10243
+
10244
+ if ( ! $this->is_registered() ||
10245
+ ! is_array( $this->_plans ) ||
10246
+ 0 === count( $this->_plans )
10247
+ ) {
10248
+ return true;
10249
+ }
10250
+
10251
+ return ( 1 === count( $this->_plans ) );
10252
+ }
10253
+
10254
+ /**
10255
+ * Check if plan based on trial. If not in trial mode, should return false.
10256
+ *
10257
+ * @since 1.0.9
10258
+ *
10259
+ * @param string $plan Plan name
10260
+ * @param bool $exact If true, looks for exact plan. If false, also check "higher" plans.
10261
+ *
10262
+ * @return bool
10263
+ */
10264
+ function is_trial_plan( $plan, $exact = false ) {
10265
+ $this->_logger->entrance();
10266
+
10267
+ if ( ! $this->is_registered() ) {
10268
+ return false;
10269
+ }
10270
+
10271
+ if ( ! $this->is_trial() ) {
10272
+ return false;
10273
+ }
10274
+
10275
+ $trial_plan = $this->get_trial_plan();
10276
+
10277
+ if ( $trial_plan->name === $plan ) {
10278
+ // Exact plan.
10279
+ return true;
10280
+ } else if ( $exact ) {
10281
+ // Required exact, but plans are different.
10282
+ return false;
10283
+ }
10284
+
10285
+ $current_plan_order = - 1;
10286
+ $required_plan_order = - 1;
10287
+ for ( $i = 0, $len = count( $this->_plans ); $i < $len; $i ++ ) {
10288
+ if ( $plan === $this->_plans[ $i ]->name ) {
10289
+ $required_plan_order = $i;
10290
+ } else if ( $trial_plan->name === $this->_plans[ $i ]->name ) {
10291
+ $current_plan_order = $i;
10292
+ }
10293
+ }
10294
+
10295
+ return ( $current_plan_order > $required_plan_order );
10296
+ }
10297
+
10298
+ /**
10299
+ * Check if plugin has any paid plans.
10300
+ *
10301
+ * @author Vova Feldman (@svovaf)
10302
+ * @since 1.0.7
10303
+ *
10304
+ * @return bool
10305
+ */
10306
+ function has_paid_plan() {
10307
+ return $this->_has_paid_plans ||
10308
+ FS_Plan_Manager::instance()->has_paid_plan( $this->_plans );
10309
+ }
10310
+
10311
+ /**
10312
+ * Check if plugin has any plan with a trail.
10313
+ *
10314
+ * @author Vova Feldman (@svovaf)
10315
+ * @since 1.0.9
10316
+ *
10317
+ * @return bool
10318
+ */
10319
+ function has_trial_plan() {
10320
+ /**
10321
+ * @author Vova Feldman(@svovaf)
10322
+ * @since 1.2.1.5
10323
+ *
10324
+ * Allow setting a trial from the SDK without calling the API.
10325
+ * But, if the user did opt-in, continue using the real data from the API.
10326
+ */
10327
+ if ( $this->_trial_days >= 0 ) {
10328
+ return true;
10329
+ }
10330
+
10331
+ return $this->_storage->get( 'has_trial_plan', false );
10332
+ }
10333
+
10334
+ /**
10335
+ * Check if plugin has any free plan, or is it premium only.
10336
+ *
10337
+ * Note: If no plans configured, assume plugin is free.
10338
+ *
10339
+ * @author Vova Feldman (@svovaf)
10340
+ * @since 1.0.7
10341
+ *
10342
+ * @return bool
10343
+ */
10344
+ function has_free_plan() {
10345
+ return ! $this->is_only_premium();
10346
+ }
10347
+
10348
+ /**
10349
+ * Displays a license activation dialog box when the user clicks on the "Activate License"
10350
+ * or "Change License" link on the plugins
10351
+ * page.
10352
+ *
10353
+ * @author Leo Fajardo (@leorw)
10354
+ * @since 1.1.9
10355
+ */
10356
+ function _add_license_activation_dialog_box() {
10357
+ $vars = array(
10358
+ 'id' => $this->_module_id,
10359
+ );
10360
+
10361
+ fs_require_template( 'forms/license-activation.php', $vars );
10362
+ fs_require_template( 'forms/resend-key.php', $vars );
10363
+ }
10364
+
10365
+ /**
10366
+ * Displays the opt-out dialog box when the user clicks on the "Opt Out" link on the "Plugins"
10367
+ * page.
10368
+ *
10369
+ * @author Leo Fajardo (@leorw)
10370
+ * @since 1.2.1.5
10371
+ */
10372
+ function _add_optout_dialog() {
10373
+ if ( $this->is_theme() ) {
10374
+ $vars = null;
10375
+ fs_require_once_template( '/js/jquery.content-change.php', $vars );
10376
+ }
10377
+
10378
+ $vars = array( 'id' => $this->_module_id );
10379
+ fs_require_template( 'forms/optout.php', $vars );
10380
+ }
10381
+
10382
+ /**
10383
+ * Prepare page to include all required UI and logic for the license activation dialog.
10384
+ *
10385
+ * @author Vova Feldman (@svovaf)
10386
+ * @since 1.2.0
10387
+ */
10388
+ function _add_license_activation() {
10389
+ if ( ! $this->is_user_admin() ) {
10390
+ // Only admins can activate a license.
10391
+ return;
10392
+ }
10393
+
10394
+ if ( ! $this->has_paid_plan() ) {
10395
+ // Module doesn't have any paid plans.
10396
+ return;
10397
+ }
10398
+
10399
+ if ( ! $this->is_premium() ) {
10400
+ // Only add license activation logic to the premium version.
10401
+ return;
10402
+ }
10403
+
10404
+ // Add license activation link and AJAX request handler.
10405
+ if ( self::is_plugins_page() ) {
10406
+ /**
10407
+ * @since 1.2.0 Add license action link only on plugins page.
10408
+ */
10409
+ $this->_add_license_action_link();
10410
+ }
10411
+
10412
+ // Add license activation AJAX callback.
10413
+ $this->add_ajax_action( 'activate_license', array( &$this, '_activate_license_ajax_action' ) );
10414
+
10415
+ // Add resend license AJAX callback.
10416
+ $this->add_ajax_action( 'resend_license_key', array( &$this, '_resend_license_key_ajax_action' ) );
10417
+ }
10418
+
10419
+ /**
10420
+ * @author Leo Fajardo (@leorw)
10421
+ *
10422
+ * @since 1.1.9
10423
+ * @since 2.0.0 When a super-admin that hasn't connected before is network activating a license and excluding some of the sites for the license activation, go over the unselected sites in the network and if a site is not connected, skipped, nor delegated, if it's a freemium product then just skip the connection for the site, if it's a premium only product, delegate the connection and license activation to the site admin (Vova Feldman @svovaf).
10424
+ */
10425
+ function _activate_license_ajax_action() {
10426
+ $this->_logger->entrance();
10427
+
10428
+ $this->check_ajax_referer( 'activate_license' );
10429
+
10430
+ $license_key = trim( fs_request_get( 'license_key' ) );
10431
+
10432
+ if ( empty( $license_key ) ) {
10433
+ exit;
10434
+ }
10435
+
10436
+ $plugin_id = fs_request_get( 'module_id', '', 'post' );
10437
+ $fs = ( $plugin_id == $this->_module_id ) ?
10438
+ $this :
10439
+ $this->get_addon_instance( $plugin_id );
10440
+
10441
+ $error = false;
10442
+ $next_page = false;
10443
+
10444
+ $sites = fs_is_network_admin() ?
10445
+ fs_request_get( 'sites', array(), 'post' ) :
10446
+ array();
10447
+
10448
+ $blog_id = fs_request_get( 'blog_id' );
10449
+ $has_valid_blog_id = is_numeric( $blog_id );
10450
+
10451
+ if ( $fs->is_registered() ) {
10452
+ if ( fs_is_network_admin() && ! $has_valid_blog_id ) {
10453
+ // If no specific blog ID was provided, activate the license for all sites in the network.
10454
+ $blog_2_install_map = array();
10455
+ $site_ids = array();
10456
+
10457
+ foreach ( $sites as $site ) {
10458
+ if ( ! isset( $site['blog_id'] ) || ! is_numeric( $site['blog_id'] ) ) {
10459
+ continue;
10460
+ }
10461
+
10462
+ $install = $this->get_install_by_blog_id( $site['blog_id'] );
10463
+
10464
+ if ( is_object( $install ) ) {
10465
+ $blog_2_install_map[ $site['blog_id'] ] = $install;
10466
+ } else {
10467
+ $site_ids[] = $site['blog_id'];
10468
+ }
10469
+ }
10470
+
10471
+ $user = $this->get_current_or_network_user();
10472
+
10473
+ if ( ! empty( $blog_2_install_map ) ) {
10474
+ $result = $this->activate_license_on_many_installs( $user, $license_key, $blog_2_install_map );
10475
+
10476
+ if ( true !== $result ) {
10477
+ $error = FS_Api::is_api_error_object( $result ) ?
10478
+ $result->error->message :
10479
+ var_export( $result, true );
10480
+ }
10481
+ }
10482
+
10483
+ if ( empty( $error ) && ! empty( $site_ids ) ) {
10484
+ $result = $this->activate_license_on_many_sites( $user, $license_key, $site_ids );
10485
+
10486
+ if ( true !== $result ) {
10487
+ $error = FS_Api::is_api_error_object( $result ) ?
10488
+ $result->error->message :
10489
+ var_export( $result, true );
10490
+ }
10491
+ }
10492
+ } else {
10493
+ if ( $has_valid_blog_id ) {
10494
+ /**
10495
+ * If a specific blog ID was provided, activate the license only for the install that is
10496
+ * associated with the given blog ID.
10497
+ *
10498
+ * @author Leo Fajardo (@leorw)
10499
+ */
10500
+ $this->switch_to_blog( $blog_id );
10501
+ }
10502
+
10503
+ $api = $fs->get_api_site_scope();
10504
+
10505
+ $params = array(
10506
+ 'license_key' => $fs->apply_filters( 'license_key', $license_key )
10507
+ );
10508
+
10509
+ $install = $api->call( '/', 'put', $params );
10510
+
10511
+ if ( FS_Api::is_api_error( $install ) ) {
10512
+ $error = FS_Api::is_api_error_object( $install ) ?
10513
+ $install->error->message :
10514
+ var_export( $install->error, true );
10515
+ } else {
10516
+ $fs->reconnect_locally( $has_valid_blog_id );
10517
+ }
10518
+ }
10519
+
10520
+ if ( empty( $error ) ) {
10521
+ $this->network_upgrade_mode_completed();
10522
+
10523
+ $fs->_sync_license( true, $has_valid_blog_id );
10524
+
10525
+ $next_page = $fs->is_addon() ?
10526
+ $fs->get_parent_instance()->get_account_url() :
10527
+ $fs->get_account_url();
10528
+ }
10529
+ } else {
10530
+ $next_page = $fs->opt_in(
10531
+ false,
10532
+ false,
10533
+ false,
10534
+ $license_key,
10535
+ false,
10536
+ false,
10537
+ false,
10538
+ $sites
10539
+ );
10540
+
10541
+ if ( isset( $next_page->error ) ) {
10542
+ $error = $next_page->error;
10543
+ } else {
10544
+ if ( fs_is_network_admin() ) {
10545
+ /**
10546
+ * Get the list of sites that were just opted-in (and license activated).
10547
+ * This is an optimization for the next part below saving some DB queries.
10548
+ */
10549
+ $connected_sites = array();
10550
+ foreach ( $sites as $site ) {
10551
+ if ( isset( $site['blog_id'] ) && is_numeric( $site['blog_id'] ) ) {
10552
+ $connected_sites[ $site['blog_id'] ] = true;
10553
+ }
10554
+ }
10555
+
10556
+ $all_sites = self::get_sites();
10557
+ $pending_sites = array();
10558
+
10559
+ /**
10560
+ * Check if there are any sites that are not connected, skipped, nor delegated. For every site that falls into that category, if the product is freemium, skip the connection. If the product is premium only, delegate the connection to the site administrator.
10561
+ *
10562
+ * @author Vova Feldman (@svovaf)
10563
+ */
10564
+ foreach ( $all_sites as $site ) {
10565
+ $blog_id = self::get_site_blog_id( $site );
10566
+
10567
+ if ( isset( $connected_sites[ $blog_id ] ) ) {
10568
+ // Site was just connected.
10569
+ continue;
10570
+ }
10571
+
10572
+ if ( $this->is_installed_on_site( $blog_id ) ) {
10573
+ // Site was already connected before.
10574
+ continue;
10575
+ }
10576
+
10577
+ if ( $this->is_site_delegated_connection( $blog_id ) ) {
10578
+ // Site's connection was delegated.
10579
+ continue;
10580
+ }
10581
+
10582
+ if ( $this->is_anonymous_site( $blog_id ) ) {
10583
+ // Site connection was already skipped.
10584
+ continue;
10585
+ }
10586
+
10587
+ $pending_sites[] = self::get_site_info( $site );
10588
+ }
10589
+
10590
+ if ( ! empty( $pending_sites ) ) {
10591
+ if ( $this->is_freemium() ) {
10592
+ $this->skip_connection( $pending_sites );
10593
+ } else {
10594
+ $this->delegate_connection( $pending_sites );
10595
+ }
10596
+ }
10597
+ }
10598
+ }
10599
+ }
10600
+
10601
+ $result = array(
10602
+ 'success' => ( false === $error )
10603
+ );
10604
+
10605
+ if ( false !== $error ) {
10606
+ $result['error'] = $error;
10607
+ } else {
10608
+ $result['next_page'] = $next_page;
10609
+ }
10610
+
10611
+ echo json_encode( $result );
10612
+
10613
+ exit;
10614
+ }
10615
+
10616
+ /**
10617
+ * @author Leo Fajardo (@leorw)
10618
+ * @since 1.2.3.1
10619
+ */
10620
+ function _network_activate_ajax_action() {
10621
+ $this->_logger->entrance();
10622
+
10623
+ $this->check_ajax_referer( 'network_activate' );
10624
+
10625
+ $plugin_id = fs_request_get( 'module_id', '', 'post' );
10626
+ $fs = ( $plugin_id == $this->_module_id ) ?
10627
+ $this :
10628
+ $this->get_addon_instance( $plugin_id );
10629
+
10630
+ $error = false;
10631
+
10632
+ $sites = fs_request_get( 'sites', array(), 'post' );
10633
+ if ( is_array( $sites ) && ! empty( $sites ) ) {
10634
+ $sites_by_action = array(
10635
+ 'allow' => array(),
10636
+ 'delegate' => array(),
10637
+ 'skip' => array()
10638
+ );
10639
+
10640
+ foreach ( $sites as $site ) {
10641
+ $sites_by_action[ $site['action'] ][] = $site;
10642
+ }
10643
+
10644
+ $total_sites = count( $sites );
10645
+ $total_sites_to_delegate = count( $sites_by_action['delegate'] );
10646
+
10647
+ $next_page = '';
10648
+ if ( $total_sites === $total_sites_to_delegate &&
10649
+ ! $this->is_network_upgrade_mode()
10650
+ ) {
10651
+ $this->delegate_connection();
10652
+ } else {
10653
+ if ( ! empty( $sites_by_action['delegate'] ) ) {
10654
+ $this->delegate_connection( $sites_by_action['delegate'] );
10655
+ }
10656
+
10657
+ if ( ! empty( $sites_by_action['skip'] ) ) {
10658
+ $this->skip_connection( $sites_by_action['skip'] );
10659
+ }
10660
+
10661
+ if ( ! empty( $sites_by_action['allow'] ) ) {
10662
+ if ( ! $fs->is_registered() || ! $this->_is_network_active ) {
10663
+ $next_page = $fs->opt_in(
10664
+ false,
10665
+ false,
10666
+ false,
10667
+ false,
10668
+ false,
10669
+ false,
10670
+ false,
10671
+ $sites_by_action['allow']
10672
+ );
10673
+ } else {
10674
+ $next_page = $fs->install_with_user(
10675
+ $this->get_network_user(),
10676
+ false,
10677
+ false,
10678
+ false,
10679
+ true,
10680
+ $sites_by_action['allow']
10681
+ );
10682
+ }
10683
+
10684
+ if ( is_object( $next_page ) && isset( $next_page->error ) ) {
10685
+ $error = $next_page->error;
10686
+ }
10687
+ }
10688
+ }
10689
+
10690
+ if ( empty( $next_page ) ) {
10691
+ $next_page = $this->get_after_activation_url( 'after_network_activation_url' );
10692
+ }
10693
+ } else {
10694
+ $error = $this->get_text_inline( 'invalid_site_details_collection', 'Invalid site details collection.' );
10695
+ }
10696
+
10697
+ $result = array(
10698
+ 'success' => ( false === $error )
10699
+ );
10700
+
10701
+ if ( false !== $error ) {
10702
+ $result['error'] = $error;
10703
+ } else {
10704
+ $result['next_page'] = $next_page;
10705
+ }
10706
+
10707
+ echo json_encode( $result );
10708
+
10709
+ exit;
10710
+ }
10711
+
10712
+ /**
10713
+ * Billing update AJAX callback.
10714
+ *
10715
+ * @author Vova Feldman (@svovaf)
10716
+ * @since 1.2.1.5
10717
+ */
10718
+ function _update_billing_ajax_action() {
10719
+ $this->_logger->entrance();
10720
+
10721
+ $this->check_ajax_referer( 'update_billing' );
10722
+
10723
+ if ( ! $this->is_user_admin() ) {
10724
+ // Only for admins.
10725
+ self::shoot_ajax_failure();
10726
+ }
10727
+
10728
+ $billing = fs_request_get( 'billing' );
10729
+
10730
+ $api = $this->get_api_user_scope();
10731
+ $result = $api->call( '/billing.json', 'put', array_merge( $billing, array(
10732
+ 'plugin_id' => $this->get_parent_id(),
10733
+ ) ) );
10734
+
10735
+ if ( ! $this->is_api_result_entity( $result ) ) {
10736
+ self::shoot_ajax_failure();
10737
+ }
10738
+
10739
+ // Purge cached billing.
10740
+ $this->get_api_user_scope()->purge_cache( 'billing.json' );
10741
+
10742
+ self::shoot_ajax_success();
10743
+ }
10744
+
10745
+ /**
10746
+ * Trial start for anonymous users (AJAX callback).
10747
+ *
10748
+ * @author Vova Feldman (@svovaf)
10749
+ * @since 1.2.1.5
10750
+ */
10751
+ function _start_trial_ajax_action() {
10752
+ $this->_logger->entrance();
10753
+
10754
+ $this->check_ajax_referer( 'start_trial' );
10755
+
10756
+ if ( ! $this->is_user_admin() ) {
10757
+ // Only for admins.
10758
+ self::shoot_ajax_failure();
10759
+ }
10760
+
10761
+ $trial_data = fs_request_get( 'trial' );
10762
+
10763
+ $next_page = $this->opt_in(
10764
+ false,
10765
+ false,
10766
+ false,
10767
+ false,
10768
+ false,
10769
+ $trial_data['plan_id']
10770
+ );
10771
+
10772
+ if ( is_object( $next_page ) && $this->is_api_error( $next_page ) ) {
10773
+ self::shoot_ajax_failure(
10774
+ isset( $next_page->error ) ?
10775
+ $next_page->error->message :
10776
+ var_export( $next_page, true )
10777
+ );
10778
+ }
10779
+
10780
+ $this->shoot_ajax_success( array(
10781
+ 'next_page' => $next_page,
10782
+ ) );
10783
+ }
10784
+
10785
+ /**
10786
+ * @author Leo Fajardo (@leorw)
10787
+ * @since 1.2.0
10788
+ */
10789
+ function _resend_license_key_ajax_action() {
10790
+ $this->_logger->entrance();
10791
+
10792
+ $this->check_ajax_referer( 'resend_license_key' );
10793
+
10794
+ $email_address = sanitize_email( trim( fs_request_get( 'email', '', 'post' ) ) );
10795
+
10796
+ if ( empty( $email_address ) ) {
10797
+ exit;
10798
+ }
10799
+
10800
+ $error = false;
10801
+
10802
+ $api = $this->get_api_plugin_scope();
10803
+ $result = $api->call( '/licenses/resend.json', 'post',
10804
+ array(
10805
+ 'email' => $email_address,
10806
+ 'url' => home_url(),
10807
+ )
10808
+ );
10809
+
10810
+ if ( is_object( $result ) && isset( $result->error ) ) {
10811
+ $error = $result->error;
10812
+
10813
+ if ( in_array( $error->code, array( 'invalid_email', 'no_user' ) ) ) {
10814
+ $error = $this->get_text_inline( "We couldn't find your email address in the system, are you sure it's the right address?", 'email-not-found' );
10815
+ } else if ( 'no_license' === $error->code ) {
10816
+ $error = $this->get_text_inline( "We can't see any active licenses associated with that email address, are you sure it's the right address?", 'no-active-licenses' );
10817
+ } else {
10818
+ $error = $error->message;
10819
+ }
10820
+ }
10821
+
10822
+ $licenses = array(
10823
+ 'success' => ( false === $error )
10824
+ );
10825
+
10826
+ if ( false !== $error ) {
10827
+ $licenses['error'] = sprintf( '%s... %s', $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ), strtolower( $error ) );
10828
+ }
10829
+
10830
+ echo json_encode( $licenses );
10831
+
10832
+ exit;
10833
+ }
10834
+
10835
+ /**
10836
+ * @author Vova Feldman (@svovaf)
10837
+ * @since 1.2.1.8
10838
+ *
10839
+ * @var string
10840
+ */
10841
+ private static $_pagenow;
10842
+
10843
+ /**
10844
+ * Get current page or the referer if executing a WP AJAX request.
10845
+ *
10846
+ * @author Vova Feldman (@svovaf)
10847
+ * @since 1.2.1.8
10848
+ *
10849
+ * @return string
10850
+ */
10851
+ static function get_current_page() {
10852
+ if ( ! isset( self::$_pagenow ) ) {
10853
+ global $pagenow;
10854
+
10855
+ self::$_pagenow = $pagenow;
10856
+
10857
+ if ( self::is_ajax() &&
10858
+ 'admin-ajax.php' === $pagenow
10859
+ ) {
10860
+ $referer = fs_get_raw_referer();
10861
+
10862
+ if ( is_string( $referer ) ) {
10863
+ $parts = explode( '?', $referer );
10864
+
10865
+ self::$_pagenow = basename( $parts[0] );
10866
+ }
10867
+ }
10868
+ }
10869
+
10870
+ return self::$_pagenow;
10871
+ }
10872
+
10873
+ /**
10874
+ * Helper method to check if user in the plugins page.
10875
+ *
10876
+ * @author Vova Feldman (@svovaf)
10877
+ * @since 1.2.1.5
10878
+ *
10879
+ * @return bool
10880
+ */
10881
+ static function is_plugins_page() {
10882
+ return ( 'plugins.php' === self::get_current_page() );
10883
+ }
10884
+
10885
+ /**
10886
+ * Helper method to check if user in the themes page.
10887
+ *
10888
+ * @author Vova Feldman (@svovaf)
10889
+ * @since 1.2.2.6
10890
+ *
10891
+ * @return bool
10892
+ */
10893
+ static function is_themes_page() {
10894
+ return ( 'themes.php' === self::get_current_page() );
10895
+ }
10896
+
10897
+ #----------------------------------------------------------------------------------
10898
+ #region Affiliation
10899
+ #----------------------------------------------------------------------------------
10900
+
10901
+ /**
10902
+ * @author Leo Fajardo (@leorw)
10903
+ * @since 1.2.3
10904
+ *
10905
+ * @return bool
10906
+ */
10907
+ function has_affiliate_program() {
10908
+ if ( ! is_object( $this->_plugin ) ) {
10909
+ return false;
10910
+ }
10911
+
10912
+ return $this->_plugin->has_affiliate_program();
10913
+ }
10914
+
10915
+ /**
10916
+ * @author Leo Fajardo (@leorw)
10917
+ * @since 1.2.4
10918
+ */
10919
+ private function fetch_affiliate_terms() {
10920
+ if ( ! is_object( $this->plugin_affiliate_terms ) ) {
10921
+ $plugins_api = $this->get_api_plugin_scope();
10922
+ $affiliate_terms = $plugins_api->get( '/aff.json?type=affiliation', false );
10923
+
10924
+ if ( ! $this->is_api_result_entity( $affiliate_terms ) ) {
10925
+ return;
10926
+ }
10927
+
10928
+ $this->plugin_affiliate_terms = new FS_AffiliateTerms( $affiliate_terms );
10929
+ }
10930
+ }
10931
+
10932
+ /**
10933
+ * @author Leo Fajardo (@leorw)
10934
+ * @since 1.2.4
10935
+ */
10936
+ private function fetch_affiliate_and_custom_terms() {
10937
+ if ( ! empty( $this->_storage->affiliate_application_data ) ) {
10938
+ $application_data = $this->_storage->affiliate_application_data;
10939
+ $flush = ( ! isset( $application_data['status'] ) || 'pending' === $application_data['status'] );
10940
+
10941
+ $users_api = $this->get_api_user_scope();
10942
+ $result = $users_api->get( "/plugins/{$this->_plugin->id}/aff/{$this->plugin_affiliate_terms->id}/affiliates.json", $flush );
10943
+ if ( $this->is_api_result_object( $result, 'affiliates' ) ) {
10944
+ if ( ! empty( $result->affiliates ) ) {
10945
+ $affiliate = new FS_Affiliate( $result->affiliates[0] );
10946
+
10947
+ if ( ! isset( $application_data['status'] ) || $application_data['status'] !== $affiliate->status ) {
10948
+ $application_data['status'] = $affiliate->status;
10949
+ $this->_storage->affiliate_application_data = $application_data;
10950
+ }
10951
+
10952
+ if ( $affiliate->is_using_custom_terms ) {
10953
+ $affiliate_terms = $users_api->get( "/plugins/{$this->_plugin->id}/affiliates/{$affiliate->id}/aff/{$affiliate->custom_affiliate_terms_id}.json", $flush );
10954
+ if ( $this->is_api_result_entity( $affiliate_terms ) ) {
10955
+ $this->custom_affiliate_terms = new FS_AffiliateTerms( $affiliate_terms );
10956
+ }
10957
+ }
10958
+
10959
+ $this->affiliate = $affiliate;
10960
+ }
10961
+ }
10962
+ }
10963
+ }
10964
+
10965
+ /**
10966
+ * @author Leo Fajardo (@leorw)
10967
+ * @since 1.2.3
10968
+ */
10969
+ private function fetch_affiliate_and_terms() {
10970
+ $this->_logger->entrance();
10971
+
10972
+ $this->fetch_affiliate_terms();
10973
+ $this->fetch_affiliate_and_custom_terms();
10974
+ }
10975
+
10976
+ /**
10977
+ * @author Leo Fajardo (@leorw)
10978
+ * @since 1.2.3
10979
+ *
10980
+ * @return FS_Affiliate
10981
+ */
10982
+ function get_affiliate() {
10983
+ return $this->affiliate;
10984
+ }
10985
+
10986
+
10987
+ /**
10988
+ * @author Leo Fajardo (@leorw)
10989
+ * @since 1.2.3
10990
+ *
10991
+ * @return FS_AffiliateTerms
10992
+ */
10993
+ function get_affiliate_terms() {
10994
+ return is_object( $this->custom_affiliate_terms ) ?
10995
+ $this->custom_affiliate_terms :
10996
+ $this->plugin_affiliate_terms;
10997
+ }
10998
+
10999
+ /**
11000
+ * @author Leo Fajardo (@leorw)
11001
+ * @since 1.2.3
11002
+ */
11003
+ function _submit_affiliate_application() {
11004
+ $this->_logger->entrance();
11005
+
11006
+ $this->check_ajax_referer( 'submit_affiliate_application' );
11007
+
11008
+ if ( ! $this->is_user_admin() ) {
11009
+ // Only for admins.
11010
+ self::shoot_ajax_failure();
11011
+ }
11012
+
11013
+ $affiliate = fs_request_get( 'affiliate' );
11014
+
11015
+ if ( empty( $affiliate['promotion_methods'] ) ) {
11016
+ unset( $affiliate['promotion_methods'] );
11017
+ }
11018
+
11019
+ if ( ! empty( $affiliate['additional_domains'] ) ) {
11020
+ $affiliate['additional_domains'] = array_unique( $affiliate['additional_domains'] );
11021
+ }
11022
+
11023
+ if ( ! $this->is_registered() ) {
11024
+ // Opt in but don't track usage.
11025
+ $next_page = $this->opt_in(
11026
+ false,
11027
+ false,
11028
+ false,
11029
+ false,
11030
+ false,
11031
+ false,
11032
+ true
11033
+ );
11034
+
11035
+ if ( is_object( $next_page ) && $this->is_api_error( $next_page ) ) {
11036
+ self::shoot_ajax_failure(
11037
+ isset( $next_page->error ) ?
11038
+ $next_page->error->message :
11039
+ var_export( $next_page, true )
11040
+ );
11041
+ } else if ( $this->is_pending_activation() ) {
11042
+ self::shoot_ajax_failure( $this->get_text_inline( 'Account is pending activation.', 'account-is-pending-activation' ) );
11043
+ }
11044
+ }
11045
+
11046
+ $this->fetch_affiliate_terms();
11047
+
11048
+ $api = $this->get_api_user_scope();
11049
+ $result = $api->call(
11050
+ ( "/plugins/{$this->_plugin->id}/aff/{$this->plugin_affiliate_terms->id}/affiliates.json" ),
11051
+ 'post',
11052
+ $affiliate
11053
+ );
11054
+
11055
+ if ( $this->is_api_error( $result ) ) {
11056
+ self::shoot_ajax_failure(
11057
+ isset( $result->error ) ?
11058
+ $result->error->message :
11059
+ var_export( $result, true )
11060
+ );
11061
+ } else {
11062
+ if ( $this->_admin_notices->has_sticky( 'affiliate_program' ) ) {
11063
+ $this->_admin_notices->remove_sticky( 'affiliate_program' );
11064
+ }
11065
+
11066
+ $affiliate_application_data = array(
11067
+ 'status' => 'pending',
11068
+ 'stats_description' => $affiliate['stats_description'],
11069
+ 'promotion_method_description' => $affiliate['promotion_method_description'],
11070
+ );
11071
+
11072
+ if ( ! empty( $affiliate['promotion_methods'] ) ) {
11073
+ $affiliate_application_data['promotion_methods'] = $affiliate['promotion_methods'];
11074
+ }
11075
+
11076
+ if ( ! empty( $affiliate['domain'] ) ) {
11077
+ $affiliate_application_data['domain'] = $affiliate['domain'];
11078
+ }
11079
+
11080
+ if ( ! empty( $affiliate['additional_domains'] ) ) {
11081
+ $affiliate_application_data['additional_domains'] = $affiliate['additional_domains'];
11082
+ }
11083
+
11084
+ $this->_storage->affiliate_application_data = $affiliate_application_data;
11085
+ }
11086
+
11087
+ // Purge cached affiliate.
11088
+ $api->purge_cache( 'affiliate.json' );
11089
+
11090
+ self::shoot_ajax_success( $result );
11091
+ }
11092
+
11093
+ /**
11094
+ * @author Leo Fajardo (@leorw)
11095
+ * @since 1.2.3
11096
+ *
11097
+ * @return array|null
11098
+ */
11099
+ function get_affiliate_application_data() {
11100
+ if ( empty( $this->_storage->affiliate_application_data ) ) {
11101
+ return null;
11102
+ }
11103
+
11104
+ return $this->_storage->affiliate_application_data;
11105
+ }
11106
+
11107
+ #endregion Affiliation ------------------------------------------------------------
11108
+
11109
+ #----------------------------------------------------------------------------------
11110
+ #region URL Generators
11111
+ #----------------------------------------------------------------------------------
11112
+
11113
+ /**
11114
+ * Alias to pricing_url().
11115
+ *
11116
+ * @author Vova Feldman (@svovaf)
11117
+ * @since 1.0.2
11118
+ *
11119
+ * @uses pricing_url()
11120
+ *
11121
+ * @param string $period Billing cycle
11122
+ * @param bool $is_trial
11123
+ *
11124
+ * @return string
11125
+ */
11126
+ function get_upgrade_url( $period = WP_FS__PERIOD_ANNUALLY, $is_trial = false ) {
11127
+ return $this->pricing_url( $period, $is_trial );
11128
+ }
11129
+
11130
+ /**
11131
+ * @author Vova Feldman (@svovaf)
11132
+ * @since 1.0.9
11133
+ *
11134
+ * @uses get_upgrade_url()
11135
+ *
11136
+ * @return string
11137
+ */
11138
+ function get_trial_url() {
11139
+ return $this->get_upgrade_url( WP_FS__PERIOD_ANNUALLY, true );
11140
+ }
11141
+
11142
+ /**
11143
+ * Plugin's pricing URL.
11144
+ *
11145
+ * @author Vova Feldman (@svovaf)
11146
+ * @since 1.0.4
11147
+ *
11148
+ * @param string $billing_cycle Billing cycle
11149
+ *
11150
+ * @param bool $is_trial
11151
+ *
11152
+ * @return string
11153
+ */
11154
+ function pricing_url( $billing_cycle = WP_FS__PERIOD_ANNUALLY, $is_trial = false ) {
11155
+ $this->_logger->entrance();
11156
+
11157
+ $params = array(
11158
+ 'billing_cycle' => $billing_cycle
11159
+ );
11160
+
11161
+ if ( $is_trial ) {
11162
+ $params['trial'] = 'true';
11163
+ }
11164
+
11165
+ if ( $this->is_addon() ) {
11166
+ return $this->_parent->addon_url( $this->_slug );
11167
+ }
11168
+
11169
+ return $this->_get_admin_page_url( 'pricing', $params );
11170
+ }
11171
+
11172
+ /**
11173
+ * Checkout page URL.
11174
+ *
11175
+ * @author Vova Feldman (@svovaf)
11176
+ * @since 1.0.6
11177
+ *
11178
+ * @param string $billing_cycle Billing cycle
11179
+ * @param bool $is_trial
11180
+ * @param array $extra (optional) Extra parameters, override other query params.
11181
+ *
11182
+ * @return string
11183
+ */
11184
+ function checkout_url(
11185
+ $billing_cycle = WP_FS__PERIOD_ANNUALLY,
11186
+ $is_trial = false,
11187
+ $extra = array()
11188
+ ) {
11189
+ $this->_logger->entrance();
11190
+
11191
+ $params = array(
11192
+ 'checkout' => 'true',
11193
+ 'billing_cycle' => $billing_cycle,
11194
+ );
11195
+
11196
+ if ( $is_trial ) {
11197
+ $params['trial'] = 'true';
11198
+ }
11199
+
11200
+ /**
11201
+ * Params in extra override other params.
11202
+ */
11203
+ $params = array_merge( $params, $extra );
11204
+
11205
+ return $this->_get_admin_page_url( 'pricing', $params );
11206
+ }
11207
+
11208
+ /**
11209
+ * Add-on checkout URL.
11210
+ *
11211
+ * @author Vova Feldman (@svovaf)
11212
+ * @since 1.1.7
11213
+ *
11214
+ * @param number $addon_id
11215
+ * @param number $pricing_id
11216
+ * @param string $billing_cycle
11217
+ * @param bool $is_trial
11218
+ *
11219
+ * @return string
11220
+ */
11221
+ function addon_checkout_url(
11222
+ $addon_id,
11223
+ $pricing_id,
11224
+ $billing_cycle = WP_FS__PERIOD_ANNUALLY,
11225
+ $is_trial = false
11226
+ ) {
11227
+ return $this->checkout_url( $billing_cycle, $is_trial, array(
11228
+ 'plugin_id' => $addon_id,
11229
+ 'pricing_id' => $pricing_id,
11230
+ ) );
11231
+ }
11232
+
11233
+ #endregion
11234
+
11235
+ #endregion ------------------------------------------------------------------
11236
+
11237
+ /**
11238
+ * Check if plugin has any add-ons.
11239
+ *
11240
+ * @author Vova Feldman (@svovaf)
11241
+ * @since 1.0.5
11242
+ *
11243
+ * @since 1.1.7.3 Base logic only on the parameter provided by the developer in the init function.
11244
+ *
11245
+ * @return bool
11246
+ */
11247
+ function has_addons() {
11248
+ $this->_logger->entrance();
11249
+
11250
+ return $this->_has_addons;
11251
+ }
11252
+
11253
+ /**
11254
+ * Check if plugin can work in anonymous mode.
11255
+ *
11256
+ * @author Vova Feldman (@svovaf)
11257
+ * @since 1.0.9
11258
+ *
11259
+ * @return bool
11260
+ *
11261
+ * @deprecated Please use is_enable_anonymous() instead.
11262
+ */
11263
+ function enable_anonymous() {
11264
+ return $this->_enable_anonymous;
11265
+ }
11266
+
11267
+ /**
11268
+ * Check if plugin can work in anonymous mode.
11269
+ *
11270
+ * @author Vova Feldman (@svovaf)
11271
+ * @since 1.1.9
11272
+ *
11273
+ * @return bool
11274
+ */
11275
+ function is_enable_anonymous() {
11276
+ return $this->_enable_anonymous;
11277
+ }
11278
+
11279
+ /**
11280
+ * Check if plugin is premium only (no free plans).
11281
+ *
11282
+ * @author Vova Feldman (@svovaf)
11283
+ * @since 1.1.9
11284
+ *
11285
+ * @return bool
11286
+ */
11287
+ function is_only_premium() {
11288
+ return $this->_is_premium_only;
11289
+ }
11290
+
11291
+ /**
11292
+ * Checks if the plugin's type is "plugin". The other type is "theme".
11293
+ *
11294
+ * @author Leo Fajardo (@leorw)
11295
+ * @since 1.2.2
11296
+ *
11297
+ * @return bool
11298
+ */
11299
+ function is_plugin() {
11300
+ return ( WP_FS__MODULE_TYPE_PLUGIN === $this->_module_type );
11301
+ }
11302
+
11303
+ /**
11304
+ * @author Leo Fajardo (@leorw)
11305
+ * @since 1.2.2
11306
+ *
11307
+ * @return string
11308
+ */
11309
+ function get_module_type() {
11310
+ if ( ! isset( $this->_module_type ) ) {
11311
+ $id_slug_type_path_map = self::$_accounts->get_option( 'id_slug_type_path_map', array() );
11312
+ $this->_module_type = $id_slug_type_path_map[ $this->_module_id ]['type'];
11313
+ }
11314
+
11315
+ return $this->_module_type;
11316
+ }
11317
+
11318
+ /**
11319
+ * @author Leo Fajardo (@leorw)
11320
+ * @since 1.2.2
11321
+ *
11322
+ * @return string
11323
+ */
11324
+ function get_plugin_main_file_path() {
11325
+ return $this->_plugin_main_file_path;
11326
+ }
11327
+
11328
+ /**
11329
+ * Check if module has a premium code version.
11330
+ *
11331
+ * Serviceware module might be freemium without any
11332
+ * premium code version, where the paid features
11333
+ * are all part of the service.
11334
+ *
11335
+ * @author Vova Feldman (@svovaf)
11336
+ * @since 1.2.1.6
11337
+ *
11338
+ * @return bool
11339
+ */
11340
+ function has_premium_version() {
11341
+ return $this->_has_premium_version;
11342
+ }
11343
+
11344
+ /**
11345
+ * Check if feature supported with current site's plan.
11346
+ *
11347
+ * @author Vova Feldman (@svovaf)
11348
+ * @since 1.0.1
11349
+ *
11350
+ * @todo IMPLEMENT
11351
+ *
11352
+ * @param number $feature_id
11353
+ *
11354
+ * @throws Exception
11355
+ */
11356
+ function is_feature_supported( $feature_id ) {
11357
+ throw new Exception( 'not implemented' );
11358
+ }
11359
+
11360
+ /**
11361
+ * @author Vova Feldman (@svovaf)
11362
+ * @since 1.0.1
11363
+ *
11364
+ * @return bool Is running in SSL/HTTPS
11365
+ */
11366
+ function is_ssl() {
11367
+ return WP_FS__IS_HTTPS;
11368
+ }
11369
+
11370
+ /**
11371
+ * @author Vova Feldman (@svovaf)
11372
+ * @since 1.0.9
11373
+ *
11374
+ * @return bool Is running in AJAX call.
11375
+ *
11376
+ * @link http://wordpress.stackexchange.com/questions/70676/how-to-check-if-i-am-in-admin-ajax
11377
+ */
11378
+ static function is_ajax() {
11379
+ return ( defined( 'DOING_AJAX' ) && DOING_AJAX );
11380
+ }
11381
+
11382
+ /**
11383
+ * Check if it's an AJAX call targeted for the current module.
11384
+ *
11385
+ * @author Vova Feldman (@svovaf)
11386
+ * @since 1.2.0
11387
+ *
11388
+ * @param array|string $actions Collection of AJAX actions.
11389
+ *
11390
+ * @return bool
11391
+ */
11392
+ function is_ajax_action( $actions ) {
11393
+ // Verify it's an ajax call.
11394
+ if ( ! self::is_ajax() ) {
11395
+ return false;
11396
+ }
11397
+
11398
+ // Verify the call is relevant for the plugin.
11399
+ if ( $this->_module_id != fs_request_get( 'module_id' ) ) {
11400
+ return false;
11401
+ }
11402
+
11403
+ // Verify it's one of the specified actions.
11404
+ if ( is_string( $actions ) ) {
11405
+ $actions = explode( ',', $actions );
11406
+ }
11407
+
11408
+ if ( is_array( $actions ) && 0 < count( $actions ) ) {
11409
+ $ajax_action = fs_request_get( 'action' );
11410
+
11411
+ foreach ( $actions as $action ) {
11412
+ if ( $ajax_action === $this->get_action_tag( $action ) ) {
11413
+ return true;
11414
+ }
11415
+ }
11416
+ }
11417
+
11418
+ return false;
11419
+ }
11420
+
11421
+ /**
11422
+ * Check if it's an AJAX call targeted for current request.
11423
+ *
11424
+ * @author Vova Feldman (@svovaf)
11425
+ * @since 1.2.0
11426
+ *
11427
+ * @param array|string $actions Collection of AJAX actions.
11428
+ * @param number|null $module_id
11429
+ *
11430
+ * @return bool
11431
+ */
11432
+ static function is_ajax_action_static( $actions, $module_id = null ) {
11433
+ // Verify it's an ajax call.
11434
+ if ( ! self::is_ajax() ) {
11435
+ return false;
11436
+ }
11437
+
11438
+
11439
+ if ( ! empty( $module_id ) ) {
11440
+ // Verify the call is relevant for the plugin.
11441
+ if ( $module_id != fs_request_get( 'module_id' ) ) {
11442
+ return false;
11443
+ }
11444
+ }
11445
+
11446
+ // Verify it's one of the specified actions.
11447
+ if ( is_string( $actions ) ) {
11448
+ $actions = explode( ',', $actions );
11449
+ }
11450
+
11451
+ if ( is_array( $actions ) && 0 < count( $actions ) ) {
11452
+ $ajax_action = fs_request_get( 'action' );
11453
+
11454
+ foreach ( $actions as $action ) {
11455
+ if ( $ajax_action === self::get_ajax_action_static( $action, $module_id ) ) {
11456
+ return true;
11457
+ }
11458
+ }
11459
+ }
11460
+
11461
+ return false;
11462
+ }
11463
+
11464
+ /**
11465
+ * @author Vova Feldman (@svovaf)
11466
+ * @since 1.1.7
11467
+ *
11468
+ * @return bool
11469
+ */
11470
+ static function is_cron() {
11471
+ return ( defined( 'DOING_CRON' ) && DOING_CRON );
11472
+ }
11473
+
11474
+ /**
11475
+ * Check if a real user is visiting the admin dashboard.
11476
+ *
11477
+ * @author Vova Feldman (@svovaf)
11478
+ * @since 1.1.7
11479
+ *
11480
+ * @return bool
11481
+ */
11482
+ function is_user_in_admin() {
11483
+ return is_admin() && ! self::is_ajax() && ! self::is_cron();
11484
+ }
11485
+
11486
+ /**
11487
+ * Check if a real user is in the customizer view.
11488
+ *
11489
+ * @author Vova Feldman (@svovaf)
11490
+ * @since 1.2.2.7
11491
+ *
11492
+ * @return bool
11493
+ */
11494
+ static function is_customizer() {
11495
+ return is_customize_preview();
11496
+ }
11497
+
11498
+ /**
11499
+ * Check if running in HTTPS and if site's plan matching the specified plan.
11500
+ *
11501
+ * @param string $plan
11502
+ * @param bool $exact
11503
+ *
11504
+ * @return bool
11505
+ */
11506
+ function is_ssl_and_plan( $plan, $exact = false ) {
11507
+ return ( $this->is_ssl() && $this->is_plan( $plan, $exact ) );
11508
+ }
11509
+
11510
+ /**
11511
+ * Construct plugin's settings page URL.
11512
+ *
11513
+ * @author Vova Feldman (@svovaf)
11514
+ * @since 1.0.4
11515
+ *
11516
+ * @param string $page
11517
+ * @param array $params
11518
+ * @param bool|null $network
11519
+ *
11520
+ * @return string
11521
+ */
11522
+ function _get_admin_page_url( $page = '', $params = array(), $network = null ) {
11523
+ if ( is_null( $network ) ) {
11524
+ $network = (
11525
+ $this->_is_network_active &&
11526
+ ( fs_is_network_admin() || ! $this->is_delegated_connection() )
11527
+ );
11528
+ }
11529
+
11530
+ if ( 0 < count( $params ) ) {
11531
+ foreach ( $params as $k => $v ) {
11532
+ $params[ $k ] = urlencode( $v );
11533
+ }
11534
+ }
11535
+
11536
+ $page_param = $this->_menu->get_slug( $page );
11537
+
11538
+ if ( empty( $page ) &&
11539
+ $this->is_theme() &&
11540
+ // Show the opt-in as an overlay for free wp.org themes or themes without any settings page.
11541
+ ( $this->is_free_wp_org_theme() || ! $this->has_settings_menu() )
11542
+ ) {
11543
+ $params[ $this->get_unique_affix() . '_show_optin' ] = 'true';
11544
+
11545
+ return add_query_arg(
11546
+ $params,
11547
+ $this->admin_url( 'themes.php', 'admin', $network )
11548
+ );
11549
+ }
11550
+
11551
+ if ( ! $this->has_settings_menu() ) {
11552
+ if ( ! empty( $page ) ) {
11553
+ // Module doesn't have a setting page, but since the request is for
11554
+ // a specific Freemius page, use the admin.php path.
11555
+ return add_query_arg( array_merge( $params, array(
11556
+ 'page' => $page_param,
11557
+ ) ), $this->admin_url( 'admin.php', 'admin', $network ) );
11558
+ } else {
11559
+ if ( $this->is_activation_mode() ) {
11560
+ /**
11561
+ * @author Vova Feldman
11562
+ * @since 1.2.1.6
11563
+ *
11564
+ * If plugin doesn't have a settings page, create one for the opt-in screen.
11565
+ */
11566
+ return add_query_arg( array_merge( $params, array(
11567
+ 'page' => $this->_slug,
11568
+ ) ), $this->admin_url( 'admin.php', 'admin', $network ) );
11569
+ } else {
11570
+ // Plugin without a settings page.
11571
+ return add_query_arg(
11572
+ $params,
11573
+ $this->admin_url( 'plugins.php', 'admin', $network )
11574
+ );
11575
+ }
11576
+ }
11577
+ }
11578
+
11579
+ // Module has a submenu settings page.
11580
+ if ( ! $this->_menu->is_top_level() ) {
11581
+ $parent_slug = $this->_menu->get_parent_slug();
11582
+ $menu_file = ( false !== strpos( $parent_slug, '.php' ) ) ?
11583
+ $parent_slug :
11584
+ 'admin.php';
11585
+
11586
+ return add_query_arg( array_merge( $params, array(
11587
+ 'page' => $page_param,
11588
+ ) ), $this->admin_url( $menu_file, 'admin', $network ) );
11589
+ }
11590
+
11591
+ // Module has a top level CPT settings page.
11592
+ if ( $this->_menu->is_cpt() ) {
11593
+ if ( empty( $page ) && $this->is_activation_mode() ) {
11594
+ return add_query_arg( array_merge( $params, array(
11595
+ 'page' => $page_param
11596
+ ) ), $this->admin_url( 'admin.php', 'admin', $network ) );
11597
+ } else {
11598
+ if ( ! empty( $page ) ) {
11599
+ $params['page'] = $page_param;
11600
+ }
11601
+
11602
+ return add_query_arg(
11603
+ $params,
11604
+ $this->admin_url( $this->_menu->get_raw_slug(), 'admin', $network )
11605
+ );
11606
+ }
11607
+ }
11608
+
11609
+ // Module has a custom top level settings page.
11610
+ return add_query_arg( array_merge( $params, array(
11611
+ 'page' => $page_param,
11612
+ ) ), $this->admin_url( 'admin.php', 'admin', $network ) );
11613
+ }
11614
+
11615
+ #--------------------------------------------------------------------------------
11616
+ #region Multisite
11617
+ #--------------------------------------------------------------------------------
11618
+
11619
+ /**
11620
+ * @author Leo Fajardo (@leorw)
11621
+ * @since 2.0.0
11622
+ *
11623
+ * @return bool
11624
+ */
11625
+ function is_network_active() {
11626
+ return $this->_is_network_active;
11627
+ }
11628
+
11629
+ /**
11630
+ * Delegate activation for the given sites in the network (or all sites if `null`) to site admins.
11631
+ *
11632
+ * @author Leo Fajardo (@leorw)
11633
+ * @since 2.0.0
11634
+ *
11635
+ * @param array|null $sites
11636
+ */
11637
+ private function delegate_connection( $sites = null ) {
11638
+ $this->_logger->entrance();
11639
+
11640
+ $this->_admin_notices->remove_sticky( 'connect_account' );
11641
+
11642
+ if ( is_null( $sites ) ) {
11643
+ // All sites delegation.
11644
+ $this->_storage->store( 'is_delegated_connection', true, true, true );
11645
+ } else {
11646
+ // Specified sites delegation.
11647
+ foreach ( $sites as $site ) {
11648
+ $this->delegate_site_connection( $site['blog_id'] );
11649
+ }
11650
+ }
11651
+
11652
+ $this->network_upgrade_mode_completed();
11653
+ }
11654
+
11655
+ /**
11656
+ * Delegate specific network site conncetion to the site admin.
11657
+ *
11658
+ * @author Vova Feldman (@svovaf)
11659
+ * @since 2.0.0
11660
+ *
11661
+ * @param int $blog_id
11662
+ */
11663
+ private function delegate_site_connection( $blog_id ) {
11664
+ $this->_storage->store( 'is_delegated_connection', true, $blog_id, true );
11665
+ }
11666
+
11667
+ /**
11668
+ * Check if super-admin delegated the connection of ALL sites to the site admins.
11669
+ *
11670
+ * @author Vova Feldman (@svovaf)
11671
+ * @since 2.0.0
11672
+ *
11673
+ * @return bool
11674
+ */
11675
+ function is_network_delegated_connection() {
11676
+ if ( ! $this->_is_network_active ) {
11677
+ return false;
11678
+ }
11679
+
11680
+ return $this->_storage->get( 'is_delegated_connection', false, true );
11681
+ }
11682
+
11683
+ /**
11684
+ * @author Leo Fajardo (@leorw)
11685
+ * @since 2.0.0
11686
+ *
11687
+ * @param int $blog_id
11688
+ *
11689
+ * @return bool
11690
+ */
11691
+ function is_site_delegated_connection( $blog_id = 0 ) {
11692
+ if ( ! $this->_is_network_active ) {
11693
+ return false;
11694
+ }
11695
+
11696
+ if ( 0 == $blog_id ) {
11697
+ $blog_id = get_current_blog_id();
11698
+ }
11699
+
11700
+ return $this->_storage->get( 'is_delegated_connection', false, $blog_id );
11701
+ }
11702
+
11703
+ /**
11704
+ * Check if delegated the connection. When running within the the network admin,
11705
+ * and haven't specified the blog ID, checks if network level delegated. If running
11706
+ * within a site admin or specified a blog ID, check if delegated the connection for
11707
+ * the current context site.
11708
+ *
11709
+ * If executed outside the the admin, check if delegated the connection
11710
+ * for the current context site OR the whole network.
11711
+ *
11712
+ * @author Vova Feldman (@svovaf)
11713
+ * @since 2.0.0
11714
+ *
11715
+ * @param int $blog_id If set, checks if network delegated or blog specific delegated.
11716
+ *
11717
+ * @return bool
11718
+ */
11719
+ function is_delegated_connection( $blog_id = 0 ) {
11720
+ if ( ! $this->_is_network_active ) {
11721
+ return false;
11722
+ }
11723
+
11724
+ if ( fs_is_network_admin() && 0 == $blog_id ) {
11725
+ return $this->is_network_delegated_connection();
11726
+ }
11727
+
11728
+ return (
11729
+ $this->is_network_delegated_connection() ||
11730
+ $this->is_site_delegated_connection( $blog_id )
11731
+ );
11732
+ }
11733
+
11734
+ /**
11735
+ * Check if the current module is active for the site.
11736
+ *
11737
+ * @author Vova Feldman (@svovaf)
11738
+ * @since 2.0.0
11739
+ *
11740
+ * @param int $blog_id
11741
+ *
11742
+ * @return bool
11743
+ */
11744
+ function is_active_for_site( $blog_id ) {
11745
+ if ( ! is_multisite() ) {
11746
+ // Not a multisite and this code is executed, means that the plugin is active.
11747
+ return true;
11748
+ }
11749
+
11750
+ if ( $this->is_theme() ) {
11751
+ // All themes are site level activated.
11752
+ return true;
11753
+ }
11754
+
11755
+ if ( $this->_is_network_active ) {
11756
+ // Plugin was network activated so it's active.
11757
+ return true;
11758
+ }
11759
+
11760
+ return in_array( $this->_plugin_basename, (array) get_blog_option( $blog_id, 'active_plugins', array() ) );
11761
+ }
11762
+
11763
+ /**
11764
+ * @author Leo Fajardo (@leorw)
11765
+ * @since 2.0.0
11766
+ *
11767
+ * @return array Active & public sites collection.
11768
+ */
11769
+ static function get_sites() {
11770
+ /**
11771
+ * For consistency with get_blog_list() which only return active public sites.
11772
+ *
11773
+ * @author Vova Feldman (@svovaf)
11774
+ */
11775
+ $args = array(
11776
+ 'public' => 1,
11777
+ 'archived' => 0,
11778
+ 'mature' => 0,
11779
+ 'spam' => 0,
11780
+ 'deleted' => 0,
11781
+ );
11782
+
11783
+ if ( function_exists( 'get_sites' ) ) {
11784
+ // For WP 4.6 and above.
11785
+ return get_sites( $args );
11786
+ } else if ( function_exists( 'wp_get_sites' ) ) {
11787
+ // For WP 3.7 to WP 4.5.
11788
+ return wp_get_sites( $args );
11789
+ } else {
11790
+ // For WP 3.6 and below.
11791
+ return get_blog_list( 0, 'all' );
11792
+ }
11793
+ }
11794
+
11795
+ /**
11796
+ * Checks if a given blog is active.
11797
+ *
11798
+ * @author Vova Feldman (@svovaf)
11799
+ * @since 2.0.0
11800
+ *
11801
+ * @param $blog_id
11802
+ *
11803
+ * @return bool
11804
+ */
11805
+ private static function is_site_active( $blog_id ) {
11806
+ global $wpdb;
11807
+
11808
+ $blog_info = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->blogs} WHERE blog_id = %d", $blog_id ) );
11809
+
11810
+ if ( ! is_object( $blog_info ) ) {
11811
+ return false;
11812
+ }
11813
+
11814
+ return (
11815
+ true == $blog_info->public &&
11816
+ false == $blog_info->archived &&
11817
+ false == $blog_info->mature &&
11818
+ false == $blog_info->spam &&
11819
+ false == $blog_info->deleted
11820
+ );
11821
+ }
11822
+
11823
+ /**
11824
+ * Get a mapping between the site addresses to their blog IDs.
11825
+ *
11826
+ * @author Vova Feldman (@svovaf)
11827
+ * @since 2.0.0
11828
+ *
11829
+ * @return array {
11830
+ * @key string Site address without protocol with a trailing slash.
11831
+ * @value int Site's blog ID.
11832
+ * }
11833
+ */
11834
+ private function get_address_to_blog_map() {
11835
+ $sites = self::get_sites();
11836
+
11837
+ // Map site addresses to their blog IDs.
11838
+ $address_to_blog_map = array();
11839
+ foreach ( $sites as $site ) {
11840
+ $blog_id = self::get_site_blog_id( $site );
11841
+ $address = trailingslashit( fs_strip_url_protocol( get_site_url( $blog_id ) ) );
11842
+ $address_to_blog_map[ $address ] = $blog_id;
11843
+ }
11844
+
11845
+ return $address_to_blog_map;
11846
+ }
11847
+
11848
+ /**
11849
+ * Get a mapping between the site addresses to their blog IDs.
11850
+ *
11851
+ * @author Vova Feldman (@svovaf)
11852
+ * @since 2.0.0
11853
+ *
11854
+ * @return array {
11855
+ * @key int Site's blog ID.
11856
+ * @value FS_Site Associated install.
11857
+ * }
11858
+ */
11859
+ function get_blog_install_map() {
11860
+ $sites = self::get_sites();
11861
+
11862
+ // Map site blog ID to its install.
11863
+ $install_map = array();
11864
+
11865
+ foreach ( $sites as $site ) {
11866
+ $blog_id = self::get_site_blog_id( $site );
11867
+ $install = $this->get_install_by_blog_id( $blog_id );
11868
+
11869
+ if ( is_object( $install ) ) {
11870
+ $install_map[ $blog_id ] = $install;
11871
+ }
11872
+ }
11873
+
11874
+ return $install_map;
11875
+ }
11876
+
11877
+ /**
11878
+ * @author Leo Fajardo (@leorw)
11879
+ *
11880
+ * @return null|array {
11881
+ * 'install' => FS_Site Module's install,
11882
+ * 'blog_id' => string The associated blog ID.
11883
+ * }
11884
+ */
11885
+ private function find_first_install() {
11886
+ $sites = self::get_sites();
11887
+
11888
+ foreach ( $sites as $site ) {
11889
+ $blog_id = self::get_site_blog_id( $site );
11890
+ $install = $this->get_install_by_blog_id( $blog_id );
11891
+
11892
+ if ( is_object( $install ) ) {
11893
+ return array(
11894
+ 'install' => $install,
11895
+ 'blog_id' => $blog_id
11896
+ );
11897
+ }
11898
+ }
11899
+
11900
+ return null;
11901
+ }
11902
+
11903
+ /**
11904
+ * Switches the Freemius site level context to a specified blog.
11905
+ *
11906
+ * @author Vova Feldman (@svovaf)
11907
+ * @since 2.0.0
11908
+ *
11909
+ * @param int $blog_id
11910
+ * @param FS_Site $install
11911
+ */
11912
+ function switch_to_blog( $blog_id, FS_Site $install = null ) {
11913
+ if ( $blog_id == $this->_context_is_network_or_blog_id ) {
11914
+ return;
11915
+ }
11916
+
11917
+ switch_to_blog( $blog_id );
11918
+ $this->_context_is_network_or_blog_id = $blog_id;
11919
+
11920
+ self::$_accounts->set_site_blog_context( $blog_id );
11921
+ $this->_storage->set_site_blog_context( $blog_id );
11922
+ $this->_storage->set_network_active( true, $this->is_delegated_connection( $blog_id ) );
11923
+
11924
+ $this->_site = is_object( $install ) ?
11925
+ $install :
11926
+ $this->get_install_by_blog_id( $blog_id );
11927
+
11928
+ $this->_user = false;
11929
+ $this->_licenses = false;
11930
+ $this->_license = null;
11931
+
11932
+ if ( is_object( $this->_site ) ) {
11933
+ // Try to fetch user from install.
11934
+ $this->_user = self::_get_user_by_id( $this->_site->user_id );
11935
+
11936
+ if ( ! is_object( $this->_user ) &&
11937
+ FS_User::is_valid_id( $this->_storage->prev_user_id )
11938
+ ) {
11939
+ // Try to fetch previously saved user.
11940
+ $this->_user = self::_get_user_by_id( $this->_storage->prev_user_id );
11941
+
11942
+ if ( ! is_object( $this->_user ) ) {
11943
+ // Fallback to network's user.
11944
+ $this->_user = $this->get_network_user();
11945
+ }
11946
+ }
11947
+
11948
+ $all_plugin_licenses = self::get_all_licenses( $this->_module_id );
11949
+
11950
+ if ( ! empty( $all_plugin_licenses ) ) {
11951
+ if ( ! FS_Plugin_License::is_valid_id( $this->_site->license_id ) ) {
11952
+ $this->_license = null;
11953
+ } else {
11954
+ $license_found = false;
11955
+ foreach ( $all_plugin_licenses as $license ) {
11956
+ if ( $license->id == $this->_site->license_id ) {
11957
+ // License found.
11958
+ $this->_license = $license;
11959
+ $license_found = true;
11960
+ break;
11961
+ }
11962
+ }
11963
+
11964
+ if ( $license_found ) {
11965
+ $this->link_license_2_user( $this->_license->id, $this->_user->id );
11966
+ }
11967
+ }
11968
+
11969
+ $this->_licenses = $this->get_user_licenses( $this->_user->id );
11970
+ }
11971
+ }
11972
+
11973
+ unset( $this->_site_api );
11974
+ unset( $this->_user_api );
11975
+ }
11976
+
11977
+ /**
11978
+ * Restore the blog context to the blog that originally loaded the module.
11979
+ *
11980
+ * @author Vova Feldman (@svovaf)
11981
+ * @since 2.0.0
11982
+ */
11983
+ function restore_current_blog() {
11984
+ $this->switch_to_blog( $this->_blog_id );
11985
+ }
11986
+
11987
+ /**
11988
+ * @author Vova Feldman (@svovaf)
11989
+ * @since 2.0.0
11990
+ *
11991
+ * @param array|WP_Site $site
11992
+ *
11993
+ * @return int
11994
+ */
11995
+ static function get_site_blog_id( &$site ) {
11996
+ return ( $site instanceof WP_Site ) ?
11997
+ $site->blog_id :
11998
+ $site['blog_id'];
11999
+ }
12000
+
12001
+ /**
12002
+ * @author Leo Fajardo (@leorw)
12003
+ * @since 2.0.0
12004
+ *
12005
+ * @param array|WP_Site|null $site
12006
+ *
12007
+ * @return array
12008
+ */
12009
+ function get_site_info( $site = null ) {
12010
+ $this->_logger->entrance();
12011
+
12012
+ $switched = false;
12013
+
12014
+ if ( is_null( $site ) ) {
12015
+ $url = get_site_url();
12016
+ $name = get_bloginfo( 'name' );
12017
+ $blog_id = null;
12018
+ } else {
12019
+ $blog_id = self::get_site_blog_id( $site );
12020
+
12021
+ if ( get_current_blog_id() != $blog_id ) {
12022
+ switch_to_blog( $blog_id );
12023
+ $switched = true;
12024
+ }
12025
+
12026
+ if ( $site instanceof WP_Site ) {
12027
+ $url = $site->siteurl;
12028
+ $name = $site->blogname;
12029
+ } else {
12030
+ $url = get_site_url( $blog_id );
12031
+ $name = get_bloginfo( 'name' );
12032
+ }
12033
+ }
12034
+
12035
+ $info = array(
12036
+ 'uid' => $this->get_anonymous_id( $blog_id ),
12037
+ 'url' => $url,
12038
+ 'title' => $name,
12039
+ 'language' => get_bloginfo( 'language' ),
12040
+ 'charset' => get_bloginfo( 'charset' ),
12041
+ );
12042
+
12043
+ if ( is_numeric( $blog_id ) ) {
12044
+ $info['blog_id'] = $blog_id;
12045
+ }
12046
+
12047
+ if ( $switched ) {
12048
+ restore_current_blog();
12049
+ }
12050
+
12051
+ return $info;
12052
+ }
12053
+
12054
+ /**
12055
+ * Load the module's install based on the blog ID.
12056
+ *
12057
+ * @author Vova Feldman (@svovaf)
12058
+ * @since 2.0.0
12059
+ *
12060
+ * @param int|null $blog_id
12061
+ *
12062
+ * @return FS_Site
12063
+ */
12064
+ function get_install_by_blog_id( $blog_id = null ) {
12065
+ $installs = self::get_all_sites( $this->_module_type, $blog_id );
12066
+ $install = isset( $installs[ $this->_slug ] ) ? $installs[ $this->_slug ] : null;
12067
+
12068
+ if ( is_object( $install ) &&
12069
+ is_numeric( $install->id ) &&
12070
+ is_numeric( $install->user_id ) &&
12071
+ FS_Plugin_Plan::is_valid_id( $install->plan_id )
12072
+ ) {
12073
+ // Load site.
12074
+ $install = clone $install;
12075
+ }
12076
+
12077
+ return $install;
12078
+ }
12079
+
12080
+ /**
12081
+ * Check if module is installed on a specified site.
12082
+ *
12083
+ * @author Vova Feldman (@svovaf)
12084
+ * @since 2.0.0
12085
+ *
12086
+ * @param int|null $blog_id
12087
+ *
12088
+ * @return bool
12089
+ */
12090
+ function is_installed_on_site( $blog_id = null ) {
12091
+ $installs = self::get_all_sites( $this->_module_type, $blog_id );
12092
+ $install = isset( $installs[ $this->_slug ] ) ? $installs[ $this->_slug ] : null;
12093
+
12094
+ return (
12095
+ is_object( $install ) &&
12096
+ is_numeric( $install->id ) &&
12097
+ is_numeric( $install->user_id ) &&
12098
+ FS_Plugin_Plan::is_valid_id( $install->plan_id )
12099
+ );
12100
+ }
12101
+
12102
+ /**
12103
+ * Check if super-admin connected at least one site via the network opt-in.
12104
+ *
12105
+ * @author Vova Feldman (@svovaf)
12106
+ * @since 2.0.0
12107
+ *
12108
+ * @return bool
12109
+ */
12110
+ function is_network_registered() {
12111
+ if ( ! $this->_is_network_active ) {
12112
+ return false;
12113
+ }
12114
+
12115
+ return FS_User::is_valid_id( $this->_storage->network_user_id );
12116
+ }
12117
+
12118
+ /**
12119
+ * Returns the main user associated with the network.
12120
+ *
12121
+ * @author Vova Feldman (@svovaf)
12122
+ * @since 2.0.0
12123
+ *
12124
+ * @return FS_User
12125
+ */
12126
+ function get_network_user() {
12127
+ if ( ! $this->_is_network_active ) {
12128
+ return null;
12129
+ }
12130
+
12131
+ return FS_User::is_valid_id( $this->_storage->network_user_id ) ?
12132
+ self::_get_user_by_id( $this->_storage->network_user_id ) :
12133
+ null;
12134
+ }
12135
+
12136
+ /**
12137
+ * Returns the current context user or the network's main user.
12138
+ *
12139
+ * @author Vova Feldman (@svovaf)
12140
+ * @since 2.0.0
12141
+ *
12142
+ * @return FS_User
12143
+ */
12144
+ function get_current_or_network_user() {
12145
+ return ( $this->_user instanceof FS_User ) ?
12146
+ $this->_user :
12147
+ $this->get_network_user();
12148
+ }
12149
+
12150
+ /**
12151
+ * Returns the main install associated with the network.
12152
+ *
12153
+ * @author Vova Feldman (@svovaf)
12154
+ * @since 2.0.0
12155
+ *
12156
+ * @return FS_Site
12157
+ */
12158
+ function get_network_install() {
12159
+ if ( ! $this->_is_network_active ) {
12160
+ return null;
12161
+ }
12162
+
12163
+ return FS_Site::is_valid_id( $this->_storage->network_install_blog_id ) ?
12164
+ $this->get_install_by_blog_id( $this->_storage->network_install_blog_id ) :
12165
+ null;
12166
+ }
12167
+
12168
+ /**
12169
+ * Returns the blog ID that is associated with the main install.
12170
+ *
12171
+ * @author Leo Fajardo (@leorw)
12172
+ * @since 2.0.0
12173
+ *
12174
+ * @return int|null
12175
+ */
12176
+ function get_network_install_blog_id() {
12177
+ if ( ! $this->_is_network_active ) {
12178
+ return null;
12179
+ }
12180
+
12181
+ return FS_Site::is_valid_id( $this->_storage->network_install_blog_id ) ?
12182
+ $this->_storage->network_install_blog_id :
12183
+ null;
12184
+ }
12185
+
12186
+ /**
12187
+ * Returns the current context install or the network's main install.
12188
+ *
12189
+ * @author Vova Feldman (@svovaf)
12190
+ * @since 2.0.0
12191
+ *
12192
+ * @return FS_Site
12193
+ */
12194
+ function get_current_or_network_install() {
12195
+ return ( $this->_site instanceof FS_Site ) ?
12196
+ $this->_site :
12197
+ $this->get_network_install();
12198
+ }
12199
+
12200
+ /**
12201
+ * Check if executing a site level action from the network level admin.
12202
+ *
12203
+ * @author Vova Feldman (@svovaf)
12204
+ * @since 2.0.0
12205
+ *
12206
+ * @return false|int If yes, return the requested blog ID.
12207
+ */
12208
+ private function is_network_level_site_specific_action() {
12209
+ if ( ! $this->_is_network_active ) {
12210
+ return false;
12211
+ }
12212
+
12213
+ if ( ! fs_is_network_admin() ) {
12214
+ return false;
12215
+ }
12216
+
12217
+ $blog_id = fs_request_get( 'blog_id', '' );
12218
+
12219
+ return is_numeric( $blog_id ) ? $blog_id : false;
12220
+ }
12221
+
12222
+ /**
12223
+ * Check if executing an action from the network level admin.
12224
+ *
12225
+ * @author Vova Feldman (@svovaf)
12226
+ * @since 2.0.0
12227
+ *
12228
+ * @return bool
12229
+ */
12230
+ private function is_network_level_action() {
12231
+ return ( $this->_is_network_active && fs_is_network_admin() );
12232
+ }
12233
+
12234
+ /**
12235
+ * Needs to be executed after site deactivation, archive, deletion, or flag as spam.
12236
+ * 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.
12237
+ *
12238
+ * @author Vova Feldman (@svovaf)
12239
+ * @since 2.0.0
12240
+ *
12241
+ * @param int $context_blog_id
12242
+ */
12243
+ private function update_multisite_data_after_site_deactivation( $context_blog_id = 0 ) {
12244
+ $this->_logger->entrance();
12245
+
12246
+ if ( $this->_is_network_active ) {
12247
+ if ( $context_blog_id == $this->_storage->network_install_blog_id ) {
12248
+ $installs_map = $this->get_blog_install_map();
12249
+
12250
+ foreach ( $installs_map as $blog_id => $install ) {
12251
+ /**
12252
+ * @var FS_Site $install
12253
+ */
12254
+ if ( $context_blog_id == $blog_id ) {
12255
+ continue;
12256
+ }
12257
+
12258
+ if ( $install->user_id != $this->_storage->network_user_id ) {
12259
+ continue;
12260
+ }
12261
+
12262
+ // Switch reference to a blog that is opted-in and belong to the same super-admin.
12263
+ $this->_storage->network_install_blog_id = $blog_id;
12264
+ break;
12265
+ }
12266
+ }
12267
+ }
12268
+
12269
+ if ( $this->is_sync_cron_scheduled() &&
12270
+ $context_blog_id == $this->get_sync_cron_blog_id()
12271
+ ) {
12272
+ $this->schedule_sync_cron( WP_FS__SCRIPT_START_TIME, true, $context_blog_id );
12273
+ }
12274
+
12275
+ if ( $this->is_install_sync_scheduled() &&
12276
+ $context_blog_id == $this->get_install_sync_cron_blog_id()
12277
+ ) {
12278
+ $this->schedule_install_sync( $context_blog_id );
12279
+ }
12280
+ }
12281
+
12282
+ /**
12283
+ * Executed after site deactivation, archive, or flag as spam.
12284
+ *
12285
+ * @author Vova Feldman (@svovaf)
12286
+ * @since 2.0.0
12287
+ *
12288
+ * @param int $context_blog_id
12289
+ */
12290
+ public function _after_site_deactivated_callback( $context_blog_id = 0 ) {
12291
+ $this->_logger->entrance();
12292
+
12293
+ $install = $this->get_install_by_blog_id( $context_blog_id );
12294
+
12295
+ if ( ! is_object( $install ) ) {
12296
+ // Site not connected.
12297
+ return;
12298
+ }
12299
+
12300
+ $this->update_multisite_data_after_site_deactivation( $context_blog_id );
12301
+
12302
+ $current_blog_id = get_current_blog_id();
12303
+
12304
+ $this->switch_to_blog( $context_blog_id );
12305
+
12306
+ // Send deactivation event.
12307
+ $this->sync_install( array(
12308
+ 'is_active' => false,
12309
+ ) );
12310
+
12311
+ $this->switch_to_blog( $current_blog_id );
12312
+ }
12313
+
12314
+ /**
12315
+ * Executed after site deletion.
12316
+ *
12317
+ * @author Vova Feldman (@svovaf)
12318
+ * @since 2.0.0
12319
+ *
12320
+ * @param int $context_blog_id
12321
+ * @param bool $drop True if site's database tables should be dropped. Default is false.
12322
+ */
12323
+ public function _after_site_deleted_callback( $context_blog_id = 0, $drop = false ) {
12324
+ $this->_logger->entrance();
12325
+
12326
+ $install = $this->get_install_by_blog_id( $context_blog_id );
12327
+
12328
+ if ( ! is_object( $install ) ) {
12329
+ // Site not connected.
12330
+ return;
12331
+ }
12332
+
12333
+ $this->update_multisite_data_after_site_deactivation( $context_blog_id );
12334
+
12335
+ $current_blog_id = get_current_blog_id();
12336
+
12337
+ $this->switch_to_blog( $context_blog_id );
12338
+
12339
+ if ( $drop ) {
12340
+ // Delete install if dropping site DB.
12341
+ $this->delete_account_event();
12342
+ } else {
12343
+ // Send deactivation event.
12344
+ $this->sync_install( array(
12345
+ 'is_active' => false,
12346
+ ) );
12347
+ }
12348
+
12349
+ $this->switch_to_blog( $current_blog_id );
12350
+ }
12351
+
12352
+ /**
12353
+ * Executed after site re-activation.
12354
+ *
12355
+ * @author Vova Feldman (@svovaf)
12356
+ * @since 2.0.0
12357
+ *
12358
+ * @param int $context_blog_id
12359
+ */
12360
+ public function _after_site_reactivated_callback( $context_blog_id = 0 ) {
12361
+ $this->_logger->entrance();
12362
+
12363
+ $install = $this->get_install_by_blog_id( $context_blog_id );
12364
+
12365
+ if ( ! is_object( $install ) ) {
12366
+ // Site not connected.
12367
+ return;
12368
+ }
12369
+
12370
+ if ( ! self::is_site_active( $context_blog_id ) ) {
12371
+ // Site not yet active (can be in spam mode, archived, deleted...).
12372
+ return;
12373
+ }
12374
+
12375
+ $current_blog_id = get_current_blog_id();
12376
+
12377
+ $this->switch_to_blog( $context_blog_id );
12378
+
12379
+ // Send re-activation event.
12380
+ $this->sync_install( array(
12381
+ 'is_active' => true,
12382
+ ) );
12383
+
12384
+ $this->switch_to_blog( $current_blog_id );
12385
+ }
12386
+
12387
+ #endregion Multisite
12388
+
12389
+ /**
12390
+ * @author Leo Fajardo (@leorw)
12391
+ *
12392
+ * @param string $path
12393
+ * @param string $scheme
12394
+ * @param bool $network
12395
+ *
12396
+ * @return string
12397
+ */
12398
+ private function admin_url( $path = '', $scheme = 'admin', $network = true ) {
12399
+ return ( $this->_is_network_active && $network ) ?
12400
+ network_admin_url( $path, $scheme ) :
12401
+ admin_url( $path, $scheme );
12402
+ }
12403
+
12404
+ /**
12405
+ * Check if currently in a specified admin page.
12406
+ *
12407
+ * @author Vova Feldman (@svovaf)
12408
+ * @since 1.2.2.7
12409
+ *
12410
+ * @param string $page
12411
+ *
12412
+ * @return bool
12413
+ */
12414
+ function is_admin_page( $page ) {
12415
+ return ( $this->_menu->get_slug( $page ) === fs_request_get( 'page', '', 'get' ) );
12416
+ }
12417
+
12418
+ /**
12419
+ * Get module's main admin setting page URL.
12420
+ *
12421
+ * @author Vova Feldman (@svovaf)
12422
+ * @since 1.2.2.7
12423
+ *
12424
+ * @return string
12425
+ */
12426
+ function main_menu_url() {
12427
+ return $this->_menu->main_menu_url();
12428
+ }
12429
+
12430
+ /**
12431
+ * Check if currently on the theme's setting page or
12432
+ * on any of the Freemius added pages (via tabs).
12433
+ *
12434
+ * @author Vova Feldman (@svovaf)
12435
+ * @since 1.2.2.7
12436
+ *
12437
+ * @return bool
12438
+ */
12439
+ function is_theme_settings_page() {
12440
+ return fs_starts_with(
12441
+ fs_request_get( 'page', '', 'get' ),
12442
+ $this->_menu->get_slug()
12443
+ );
12444
+ }
12445
+
12446
+ /**
12447
+ * Plugin's account page + sync license URL.
12448
+ *
12449
+ * @author Vova Feldman (@svovaf)
12450
+ * @since 1.1.9.1
12451
+ *
12452
+ * @param bool|number $plugin_id
12453
+ * @param bool $add_action_nonce
12454
+ * @param array $params
12455
+ *
12456
+ * @return string
12457
+ */
12458
+ function _get_sync_license_url( $plugin_id = false, $add_action_nonce = true, $params = array() ) {
12459
+ if ( is_numeric( $plugin_id ) ) {
12460
+ $params['plugin_id'] = $plugin_id;
12461
+ }
12462
+
12463
+ return $this->get_account_url(
12464
+ $this->get_unique_affix() . '_sync_license',
12465
+ $params,
12466
+ $add_action_nonce
12467
+ );
12468
+ }
12469
+
12470
+ /**
12471
+ * Plugin's account URL.
12472
+ *
12473
+ * @author Vova Feldman (@svovaf)
12474
+ * @since 1.0.4
12475
+ *
12476
+ * @param bool|string $action
12477
+ * @param array $params
12478
+ *
12479
+ * @param bool $add_action_nonce
12480
+ *
12481
+ * @return string
12482
+ */
12483
+ function get_account_url( $action = false, $params = array(), $add_action_nonce = true ) {
12484
+ if ( is_string( $action ) ) {
12485
+ $params['fs_action'] = $action;
12486
+ }
12487
+
12488
+ self::require_pluggable_essentials();
12489
+
12490
+ return ( $add_action_nonce && is_string( $action ) ) ?
12491
+ fs_nonce_url( $this->_get_admin_page_url( 'account', $params ), $action ) :
12492
+ $this->_get_admin_page_url( 'account', $params );
12493
+ }
12494
+
12495
+ /**
12496
+ * @author Vova Feldman (@svovaf)
12497
+ * @since 1.2.0
12498
+ *
12499
+ * @param string $tab
12500
+ * @param bool $action
12501
+ * @param array $params
12502
+ * @param bool $add_action_nonce
12503
+ *
12504
+ * @return string
12505
+ *
12506
+ * @uses get_account_url()
12507
+ */
12508
+ function get_account_tab_url( $tab, $action = false, $params = array(), $add_action_nonce = true ) {
12509
+ $params['tab'] = $tab;
12510
+
12511
+ return $this->get_account_url( $action, $params, $add_action_nonce );
12512
+ }
12513
+
12514
+ /**
12515
+ * Plugin's account URL.
12516
+ *
12517
+ * @author Vova Feldman (@svovaf)
12518
+ * @since 1.0.4
12519
+ *
12520
+ * @param bool|string $topic
12521
+ * @param bool|string $message
12522
+ *
12523
+ * @return string
12524
+ */
12525
+ function contact_url( $topic = false, $message = false ) {
12526
+ $params = array();
12527
+ if ( is_string( $topic ) ) {
12528
+ $params['topic'] = $topic;
12529
+ }
12530
+ if ( is_string( $message ) ) {
12531
+ $params['message'] = $message;
12532
+ }
12533
+
12534
+ if ( $this->is_addon() ) {
12535
+ $params['addon_id'] = $this->get_id();
12536
+
12537
+ return $this->get_parent_instance()->_get_admin_page_url( 'contact', $params );
12538
+ } else {
12539
+ return $this->_get_admin_page_url( 'contact', $params );
12540
+ }
12541
+ }
12542
+
12543
+ /**
12544
+ * Add-on direct info URL.
12545
+ *
12546
+ * @author Vova Feldman (@svovaf)
12547
+ * @since 1.1.0
12548
+ *
12549
+ * @param string $slug
12550
+ *
12551
+ * @return string
12552
+ */
12553
+ function addon_url( $slug ) {
12554
+ return $this->_get_admin_page_url( 'addons', array(
12555
+ 'slug' => $slug
12556
+ ) );
12557
+ }
12558
+
12559
+ /* Logger
12560
+ ------------------------------------------------------------------------------------------------------------------*/
12561
+ /**
12562
+ * @param string $id
12563
+ * @param bool $prefix_slug
12564
+ *
12565
+ * @return FS_Logger
12566
+ */
12567
+ function get_logger( $id = '', $prefix_slug = true ) {
12568
+ return FS_Logger::get_logger( ( $prefix_slug ? $this->_slug : '' ) . ( ( ! $prefix_slug || empty( $id ) ) ? '' : '_' ) . $id );
12569
+ }
12570
+
12571
+ /**
12572
+ * Note: This method is used externally so don't delete it.
12573
+ *
12574
+ * @param $id
12575
+ * @param bool $load_options
12576
+ * @param bool $prefix_slug
12577
+ *
12578
+ * @return FS_Option_Manager
12579
+ */
12580
+ function get_options_manager( $id, $load_options = false, $prefix_slug = true ) {
12581
+ return FS_Option_Manager::get_manager( ( $prefix_slug ? $this->_slug : '' ) . ( ( ! $prefix_slug || empty( $id ) ) ? '' : '_' ) . $id, $load_options );
12582
+ }
12583
+
12584
+ /* Security
12585
+ ------------------------------------------------------------------------------------------------------------------*/
12586
+ private static function _encrypt( $str ) {
12587
+ if ( is_null( $str ) ) {
12588
+ return null;
12589
+ }
12590
+
12591
+ /**
12592
+ * The encrypt/decrypt functions are used to protect
12593
+ * the user from messing up with some of the sensitive
12594
+ * data stored for the module as a JSON in the database.
12595
+ *
12596
+ * I used the same suggested hack by the theme review team.
12597
+ * For more details, look at the function `Base64UrlDecode()`
12598
+ * in `./sdk/FreemiusBase.php`.
12599
+ *
12600
+ * @todo Remove this hack once the base64 error is removed from the Theme Check.
12601
+ *
12602
+ * @author Vova Feldman (@svovaf)
12603
+ * @since 1.2.2
12604
+ */
12605
+ $fn = 'base64' . '_encode';
12606
+
12607
+ return $fn( $str );
12608
+ }
12609
+
12610
+ static function _decrypt( $str ) {
12611
+ if ( is_null( $str ) ) {
12612
+ return null;
12613
+ }
12614
+
12615
+ /**
12616
+ * The encrypt/decrypt functions are used to protect
12617
+ * the user from messing up with some of the sensitive
12618
+ * data stored for the module as a JSON in the database.
12619
+ *
12620
+ * I used the same suggested hack by the theme review team.
12621
+ * For more details, look at the function `Base64UrlDecode()`
12622
+ * in `./sdk/FreemiusBase.php`.
12623
+ *
12624
+ * @todo Remove this hack once the base64 error is removed from the Theme Check.
12625
+ *
12626
+ * @author Vova Feldman (@svovaf)
12627
+ * @since 1.2.2
12628
+ */
12629
+ $fn = 'base64' . '_decode';
12630
+
12631
+ return $fn( $str );
12632
+ }
12633
+
12634
+ /**
12635
+ * @author Vova Feldman (@svovaf)
12636
+ * @since 1.0.5
12637
+ *
12638
+ * @param FS_Entity $entity
12639
+ *
12640
+ * @return FS_Entity Return an encrypted clone entity.
12641
+ */
12642
+ private static function _encrypt_entity( FS_Entity $entity ) {
12643
+ $clone = clone $entity;
12644
+ $props = get_object_vars( $entity );
12645
+
12646
+ foreach ( $props as $key => $val ) {
12647
+ $clone->{$key} = self::_encrypt( $val );
12648
+ }
12649
+
12650
+ return $clone;
12651
+ }
12652
+
12653
+ /**
12654
+ * @author Vova Feldman (@svovaf)
12655
+ * @since 1.0.5
12656
+ *
12657
+ * @param FS_Entity $entity
12658
+ *
12659
+ * @return FS_Entity Return an decrypted clone entity.
12660
+ */
12661
+ private static function decrypt_entity( FS_Entity $entity ) {
12662
+ $clone = clone $entity;
12663
+ $props = get_object_vars( $entity );
12664
+
12665
+ foreach ( $props as $key => $val ) {
12666
+ $clone->{$key} = self::_decrypt( $val );
12667
+ }
12668
+
12669
+ return $clone;
12670
+ }
12671
+
12672
+ /**
12673
+ * Tries to activate account based on POST params.
12674
+ *
12675
+ * @author Vova Feldman (@svovaf)
12676
+ * @since 1.0.2
12677
+ *
12678
+ * @deprecated Not in use, outdated.
12679
+ */
12680
+ function _activate_account() {
12681
+ if ( $this->is_registered() ) {
12682
+ // Already activated.
12683
+ return;
12684
+ }
12685
+
12686
+ self::_clean_admin_content_section();
12687
+
12688
+ if ( fs_request_is_action( 'activate' ) && fs_request_is_post() ) {
12689
+ // check_admin_referer( 'activate_' . $this->_plugin->public_key );
12690
+
12691
+ // Verify matching plugin details.
12692
+ if ( $this->_plugin->id != fs_request_get( 'plugin_id' ) || $this->_slug != fs_request_get( 'plugin_slug' ) ) {
12693
+ return;
12694
+ }
12695
+
12696
+ $user = new FS_User();
12697
+ $user->id = fs_request_get( 'user_id' );
12698
+ $user->public_key = fs_request_get( 'user_public_key' );
12699
+ $user->secret_key = fs_request_get( 'user_secret_key' );
12700
+ $user->email = fs_request_get( 'user_email' );
12701
+ $user->first = fs_request_get( 'user_first' );
12702
+ $user->last = fs_request_get( 'user_last' );
12703
+ $user->is_verified = fs_request_get_bool( 'user_is_verified' );
12704
+
12705
+ $site = new FS_Site();
12706
+ $site->id = fs_request_get( 'install_id' );
12707
+ $site->public_key = fs_request_get( 'install_public_key' );
12708
+ $site->secret_key = fs_request_get( 'install_secret_key' );
12709
+ $site->plan_id = fs_request_get( 'plan_id' );
12710
+
12711
+ $plans = array();
12712
+ $plans_data = json_decode( urldecode( fs_request_get( 'plans' ) ) );
12713
+ foreach ( $plans_data as $p ) {
12714
+ $plan = new FS_Plugin_Plan( $p );
12715
+ if ( $site->plan_id == $plan->id ) {
12716
+ $plan->title = fs_request_get( 'plan_title' );
12717
+ $plan->name = fs_request_get( 'plan_name' );
12718
+ }
12719
+
12720
+ $plans[] = $plan;
12721
+ }
12722
+
12723
+ $this->_set_account( $user, $site, $plans );
12724
+
12725
+ // Reload the page with the keys.
12726
+ fs_redirect( $this->_get_admin_page_url() );
12727
+ }
12728
+ }
12729
+
12730
+ /**
12731
+ * @author Vova Feldman (@svovaf)
12732
+ * @since 1.0.7
12733
+ *
12734
+ * @param string $email
12735
+ *
12736
+ * @return FS_User|false
12737
+ */
12738
+ static function _get_user_by_email( $email ) {
12739
+ self::$_static_logger->entrance();
12740
+
12741
+ $email = trim( strtolower( $email ) );
12742
+
12743
+ $users = self::get_all_users();
12744
+
12745
+ if ( is_array( $users ) ) {
12746
+ foreach ( $users as $user ) {
12747
+ if ( $email === trim( strtolower( $user->email ) ) ) {
12748
+ return $user;
12749
+ }
12750
+ }
12751
+ }
12752
+
12753
+ return false;
12754
+ }
12755
+
12756
+ #----------------------------------------------------------------------------------
12757
+ #region Account (Loading, Updates & Activation)
12758
+ #----------------------------------------------------------------------------------
12759
+
12760
+ /***
12761
+ * Load account information (user + site).
12762
+ *
12763
+ * @author Vova Feldman (@svovaf)
12764
+ * @since 1.0.1
12765
+ */
12766
+ private function _load_account() {
12767
+ $this->_logger->entrance();
12768
+
12769
+ $this->do_action( 'before_account_load' );
12770
+
12771
+ $users = self::get_all_users();
12772
+ $plans = self::get_all_plans( $this->_module_type );
12773
+
12774
+ if ( $this->_logger->is_on() && is_admin() ) {
12775
+ $this->_logger->log( 'users = ' . var_export( $users, true ) );
12776
+ $this->_logger->log( 'plans = ' . var_export( $plans, true ) );
12777
+ }
12778
+
12779
+ $site = fs_is_network_admin() ?
12780
+ $this->get_network_install() :
12781
+ $this->get_install_by_blog_id();
12782
+
12783
+ if ( fs_is_network_admin() &&
12784
+ ! is_object( $site ) &&
12785
+ FS_Site::is_valid_id( $this->_storage->network_install_blog_id )
12786
+ ) {
12787
+ $first_install = $this->find_first_install();
12788
+
12789
+ if ( is_null( $first_install ) ) {
12790
+ unset( $this->_storage->network_install_blog_id );
12791
+ } else {
12792
+ $site = $first_install['install'];
12793
+ $this->_storage->network_install_blog_id = $first_install['blog_id'];
12794
+ }
12795
+ }
12796
+
12797
+ if ( is_object( $site ) &&
12798
+ is_numeric( $site->id ) &&
12799
+ is_numeric( $site->user_id ) &&
12800
+ FS_Plugin_Plan::is_valid_id( $site->plan_id )
12801
+ ) {
12802
+ // Load site.
12803
+ $this->_site = $site;
12804
+
12805
+ // Load plans.
12806
+ $this->_plans = $plans[ $this->_slug ];
12807
+ if ( ! is_array( $this->_plans ) || empty( $this->_plans ) ) {
12808
+ $this->_sync_plans();
12809
+ } else {
12810
+ for ( $i = 0, $len = count( $this->_plans ); $i < $len; $i ++ ) {
12811
+ if ( $this->_plans[ $i ] instanceof FS_Plugin_Plan ) {
12812
+ $this->_plans[ $i ] = self::decrypt_entity( $this->_plans[ $i ] );
12813
+ } else {
12814
+ unset( $this->_plans[ $i ] );
12815
+ }
12816
+ }
12817
+ }
12818
+ }
12819
+
12820
+ $user = null;
12821
+ if ( fs_is_network_admin() && $this->_is_network_active ) {
12822
+ $user = $this->get_network_user();
12823
+ }
12824
+
12825
+ if ( is_object( $user ) ) {
12826
+ $this->_user = clone $user;
12827
+ } else if ( $this->_site ) {
12828
+ $user = self::_get_user_by_id( $this->_site->user_id );
12829
+
12830
+ if ( ! is_object( $user ) && FS_User::is_valid_id( $this->_storage->prev_user_id ) ) {
12831
+ /**
12832
+ * Try to load the previous owner. This recovery is used for the following use-case:
12833
+ * 1. Opt-in
12834
+ * 2. Cloning site1 to site2
12835
+ * 3. Ownership switch in site1 (same applies for site2)
12836
+ * 4. Install data sync on site2
12837
+ * 5. Now site2's install is associated with the new owner which does not exists locally.
12838
+ */
12839
+ $user = self::_get_user_by_id( $this->_storage->prev_user_id );
12840
+ }
12841
+
12842
+ if ( ! is_object( $user ) ) {
12843
+ /**
12844
+ * This is a special fault tolerance mechanism to handle a scenario that the user data is missing.
12845
+ */
12846
+ $user = $this->fetch_user_by_install();
12847
+ }
12848
+
12849
+ $this->_user = ( $user instanceof FS_User ) ?
12850
+ clone $user :
12851
+ null;
12852
+ }
12853
+
12854
+ if ( is_object( $this->_user ) ) {
12855
+ // Load licenses.
12856
+ $this->_licenses = $this->get_user_licenses( $this->_user->id );
12857
+ }
12858
+
12859
+ if ( is_object( $this->_site ) ) {
12860
+ $this->_license = $this->_get_license_by_id( $this->_site->license_id );
12861
+
12862
+ if ( $this->_site->version != $this->get_plugin_version() ) {
12863
+ // If stored install version is different than current installed plugin version,
12864
+ // then update plugin version event.
12865
+ $this->update_plugin_version_event();
12866
+ }
12867
+ }
12868
+
12869
+ if ( $this->is_theme() ) {
12870
+ $this->_register_account_hooks();
12871
+ }
12872
+ }
12873
+
12874
+ /**
12875
+ * Special user recovery mechanism.
12876
+ *
12877
+ * @author Vova Feldman (@svovaf)
12878
+ * @since 2.0.0
12879
+ *
12880
+ * @return \FS_User|mixed
12881
+ */
12882
+ private function fetch_user_by_install() {
12883
+ $api = $this->get_api_site_scope();
12884
+
12885
+ $uid = $this->get_anonymous_id();
12886
+ $request_path = "/users/{$this->_site->user_id}.json?uid={$uid}";
12887
+
12888
+ $result = $api->get( $request_path, false, WP_FS__TIME_10_MIN_IN_SEC );
12889
+
12890
+ if ( $this->is_api_result_entity( $result ) ) {
12891
+ $user = new FS_User( $result );
12892
+ $this->_user = $user;
12893
+ $this->_store_user();
12894
+
12895
+ return $user;
12896
+ }
12897
+
12898
+ $error_code = FS_Api::get_error_code( $result );
12899
+
12900
+ if ( in_array( $error_code, array( 'invalid_unique_id', 'user_cannot_be_recovered' ) ) ) {
12901
+ /**
12902
+ * Those API errors will continue coming and are not recoverable with the
12903
+ * current site's data. Therefore, extend the API call's cached result to 7 days.
12904
+ */
12905
+ $api->update_cache_expiration( $request_path, WP_FS__TIME_WEEK_IN_SEC );
12906
+ }
12907
+
12908
+ return $result;
12909
+ }
12910
+
12911
+ /**
12912
+ * @author Vova Feldman (@svovaf)
12913
+ * @since 1.0.1
12914
+ *
12915
+ * @param FS_User $user
12916
+ * @param FS_Site $site
12917
+ * @param bool|array $plans
12918
+ */
12919
+ private function _set_account( FS_User $user, FS_Site $site, $plans = false ) {
12920
+ $site->user_id = $user->id;
12921
+
12922
+ $this->_site = $site;
12923
+ $this->_user = $user;
12924
+ if ( false !== $plans ) {
12925
+ $this->_plans = $plans;
12926
+ }
12927
+
12928
+ $this->send_install_update();
12929
+
12930
+ $this->_store_account();
12931
+
12932
+ }
12933
+
12934
+ /**
12935
+ * @author Vova Feldman (@svovaf)
12936
+ * @since 1.1.7.4
12937
+ *
12938
+ * @param array $override_with
12939
+ * @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.
12940
+ *
12941
+ * @return array
12942
+ */
12943
+ function get_opt_in_params( $override_with = array(), $network_level_or_blog_id = null ) {
12944
+ $this->_logger->entrance();
12945
+
12946
+ $current_user = self::_get_current_wp_user();
12947
+
12948
+ $activation_action = $this->get_unique_affix() . '_activate_new';
12949
+ $return_url = $this->is_anonymous() ?
12950
+ // If skipped already, then return to the account page.
12951
+ $this->get_account_url( $activation_action, array(), false ) :
12952
+ // Return to the module's main page.
12953
+ $this->get_after_activation_url( 'after_connect_url', array( 'fs_action' => $activation_action ) );
12954
+
12955
+ $params = array(
12956
+ 'user_firstname' => $current_user->user_firstname,
12957
+ 'user_lastname' => $current_user->user_lastname,
12958
+ 'user_nickname' => $current_user->user_nicename,
12959
+ 'user_email' => $current_user->user_email,
12960
+ 'user_ip' => WP_FS__REMOTE_ADDR,
12961
+ 'plugin_slug' => $this->_slug,
12962
+ 'plugin_id' => $this->get_id(),
12963
+ 'plugin_public_key' => $this->get_public_key(),
12964
+ 'plugin_version' => $this->get_plugin_version(),
12965
+ 'return_url' => fs_nonce_url( $return_url, $activation_action ),
12966
+ 'account_url' => fs_nonce_url( $this->_get_admin_page_url(
12967
+ 'account',
12968
+ array( 'fs_action' => 'sync_user' )
12969
+ ), 'sync_user' ),
12970
+ 'platform_version' => get_bloginfo( 'version' ),
12971
+ 'sdk_version' => $this->version,
12972
+ 'programming_language_version' => phpversion(),
12973
+ 'is_premium' => $this->is_premium(),
12974
+ 'is_active' => true,
12975
+ 'is_uninstalled' => false,
12976
+ );
12977
+
12978
+ if ( true === $network_level_or_blog_id ) {
12979
+ if ( ! isset( $override_with['sites'] ) ) {
12980
+ $params['sites'] = array();
12981
+
12982
+ $sites = self::get_sites();
12983
+
12984
+ foreach ( $sites as $site ) {
12985
+ $blog_id = self::get_site_blog_id( $site );
12986
+ if ( ! $this->is_site_delegated_connection( $blog_id ) &&
12987
+ ! $this->is_installed_on_site( $blog_id )
12988
+ ) {
12989
+ $params['sites'][] = $this->get_site_info( $site );
12990
+ }
12991
+ }
12992
+ }
12993
+ } else {
12994
+ $site = is_numeric( $network_level_or_blog_id ) ?
12995
+ array( 'blog_id' => $network_level_or_blog_id ) :
12996
+ null;
12997
+
12998
+ $site = $this->get_site_info( $site );
12999
+
13000
+ $params = array_merge( $params, array(
13001
+ 'site_uid' => $site['uid'],
13002
+ 'site_url' => $site['url'],
13003
+ 'site_name' => $site['title'],
13004
+ 'language' => $site['language'],
13005
+ 'charset' => $site['charset'],
13006
+ ) );
13007
+ }
13008
+
13009
+ if ( $this->is_pending_activation() &&
13010
+ ! empty( $this->_storage->pending_license_key )
13011
+ ) {
13012
+ $params['license_key'] = $this->_storage->pending_license_key;
13013
+ }
13014
+
13015
+ if ( WP_FS__SKIP_EMAIL_ACTIVATION && $this->has_secret_key() ) {
13016
+ // Even though rand() is known for its security issues,
13017
+ // the timestamp adds another layer of protection.
13018
+ // It would be very hard for an attacker to get the secret key form here.
13019
+ // Plus, this should never run in production since the secret should never
13020
+ // be included in the production version.
13021
+ $params['ts'] = WP_FS__SCRIPT_START_TIME;
13022
+ $params['salt'] = md5( uniqid( rand() ) );
13023
+ $params['secure'] = md5(
13024
+ $params['ts'] .
13025
+ $params['salt'] .
13026
+ $this->get_secret_key()
13027
+ );
13028
+ }
13029
+
13030
+ return array_merge( $params, $override_with );
13031
+ }
13032
+
13033
+ /**
13034
+ * 1. If successful opt-in or pending activation returns the next page that the user should be redirected to.
13035
+ * 2. If there was an API error, return the API result.
13036
+ *
13037
+ * @author Vova Feldman (@svovaf)
13038
+ * @since 1.1.7.4
13039
+ *
13040
+ * @param string|bool $email
13041
+ * @param string|bool $first
13042
+ * @param string|bool $last
13043
+ * @param string|bool $license_key
13044
+ * @param bool $is_uninstall If "true", this means that the module is currently being uninstalled.
13045
+ * In this case, the user and site info will be sent to the server but no
13046
+ * data will be saved to the WP installation's database.
13047
+ * @param number|bool $trial_plan_id
13048
+ * @param bool $is_disconnected Whether or not to opt in without tracking.
13049
+ * @param array $sites If network-level opt-in, an array of containing details of sites.
13050
+ *
13051
+ * @return string|object
13052
+ * @use WP_Error
13053
+ */
13054
+ function opt_in(
13055
+ $email = false,
13056
+ $first = false,
13057
+ $last = false,
13058
+ $license_key = false,
13059
+ $is_uninstall = false,
13060
+ $trial_plan_id = false,
13061
+ $is_disconnected = false,
13062
+ $sites = array()
13063
+ ) {
13064
+ $this->_logger->entrance();
13065
+
13066
+ if ( false === $email ) {
13067
+ $current_user = self::_get_current_wp_user();
13068
+ $email = $current_user->user_email;
13069
+ }
13070
+
13071
+ /**
13072
+ * @since 1.2.1 If activating with license key, ignore the context-user
13073
+ * since the user will be automatically loaded from the license.
13074
+ */
13075
+ if ( empty( $license_key ) ) {
13076
+ // Clean up pending license if opt-ing in again.
13077
+ $this->_storage->remove( 'pending_license_key' );
13078
+
13079
+ if ( ! $is_uninstall ) {
13080
+ $fs_user = Freemius::_get_user_by_email( $email );
13081
+ if ( is_object( $fs_user ) && ! $this->is_pending_activation() ) {
13082
+ return $this->install_with_current_user(
13083
+ false,
13084
+ $trial_plan_id,
13085
+ $sites
13086
+ );
13087
+ }
13088
+ }
13089
+ }
13090
+
13091
+ $user_info = array();
13092
+ if ( ! empty( $email ) ) {
13093
+ $user_info['user_email'] = $email;
13094
+ }
13095
+ if ( ! empty( $first ) ) {
13096
+ $user_info['user_firstname'] = $first;
13097
+ }
13098
+ if ( ! empty( $last ) ) {
13099
+ $user_info['user_lastname'] = $last;
13100
+ }
13101
+
13102
+ if ( ! empty( $sites ) ) {
13103
+ $is_network = true;
13104
+
13105
+ $user_info['sites'] = $sites;
13106
+ } else {
13107
+ $is_network = false;
13108
+ }
13109
+
13110
+ $params = $this->get_opt_in_params( $user_info, $is_network );
13111
+
13112
+ $filtered_license_key = false;
13113
+ if ( is_string( $license_key ) ) {
13114
+ $filtered_license_key = $this->apply_filters( 'license_key', $license_key );
13115
+ $params['license_key'] = $filtered_license_key;
13116
+ } else if ( FS_Plugin_Plan::is_valid_id( $trial_plan_id ) ) {
13117
+ $params['trial_plan_id'] = $trial_plan_id;
13118
+ }
13119
+
13120
+ if ( $is_uninstall ) {
13121
+ $params['uninstall_params'] = array(
13122
+ 'reason_id' => $this->_storage->uninstall_reason->id,
13123
+ 'reason_info' => $this->_storage->uninstall_reason->info
13124
+ );
13125
+ }
13126
+
13127
+ if ( isset( $params['license_key'] ) ) {
13128
+ $fs_user = Freemius::_get_user_by_email( $email );
13129
+
13130
+ if ( is_object( $fs_user ) ) {
13131
+ /**
13132
+ * If opting in with a context license and the context WP Admin user already opted in
13133
+ * before from the current site, add the user context security params to avoid the
13134
+ * unnecessary email activation when the context license is owned by the same context user.
13135
+ *
13136
+ * @author Leo Fajardo (@leorw)
13137
+ * @since 1.2.3
13138
+ */
13139
+ $params = array_merge( $params, FS_Security::instance()->get_context_params(
13140
+ $fs_user,
13141
+ false,
13142
+ 'install_with_existing_user'
13143
+ ) );
13144
+ }
13145
+ }
13146
+
13147
+ $params['is_disconnected'] = $is_disconnected;
13148
+ $params['format'] = 'json';
13149
+
13150
+ $request = array(
13151
+ 'method' => 'POST',
13152
+ 'body' => $params,
13153
+ 'timeout' => WP_FS__DEBUG_SDK ? 60 : 30,
13154
+ );
13155
+
13156
+ $url = WP_FS__ADDRESS . '/action/service/user/install/';
13157
+
13158
+ if ( WP_FS__DEBUG_SDK || isset( $_COOKIE['XDEBUG_SESSION'] ) ) {
13159
+ $url = add_query_arg( 'XDEBUG_SESSION_START', rand( 0, 9999999 ), $url );
13160
+ $url = add_query_arg( 'XDEBUG_SESSION', 'PHPSTORM', $url );
13161
+
13162
+ $request['cookies'] = array(
13163
+ new WP_Http_Cookie( array(
13164
+ 'name' => 'XDEBUG_SESSION',
13165
+ 'value' => 'PHPSTORM',
13166
+ ) )
13167
+ );
13168
+ }
13169
+
13170
+ $response = wp_remote_post( $url, $request );
13171
+
13172
+ if ( $response instanceof WP_Error ) {
13173
+ if ( 'https://' === substr( $url, 0, 8 ) &&
13174
+ isset( $response->errors ) &&
13175
+ isset( $response->errors['http_request_failed'] )
13176
+ ) {
13177
+ $http_error = strtolower( $response->errors['http_request_failed'][0] );
13178
+
13179
+ if ( false !== strpos( $http_error, 'ssl' ) ||
13180
+ false !== strpos( $http_error, 'curl error 35' )
13181
+ ) {
13182
+ // Failed due to old version of cURL or Open SSL (SSLv3 is not supported by CloudFlare).
13183
+ $url = 'http://' . substr( $url, 8 );
13184
+
13185
+ $response = wp_remote_post( $url, array(
13186
+ 'method' => 'POST',
13187
+ 'body' => $params,
13188
+ 'timeout' => 15,
13189
+ ) );
13190
+ }
13191
+ }
13192
+ }
13193
+
13194
+ if ( is_wp_error( $response ) ) {
13195
+ /**
13196
+ * @var WP_Error $response
13197
+ */
13198
+ $result = new stdClass();
13199
+
13200
+ $error_code = $response->get_error_code();
13201
+ $error_type = str_replace( ' ', '', ucwords( str_replace( '_', ' ', $error_code ) ) );
13202
+
13203
+ $result->error = (object) array(
13204
+ 'type' => $error_type,
13205
+ 'message' => $response->get_error_message(),
13206
+ 'code' => $error_code,
13207
+ 'http' => 402
13208
+ );
13209
+
13210
+ return $result;
13211
+ }
13212
+
13213
+ // Module is being uninstalled, don't handle the returned data.
13214
+ if ( $is_uninstall ) {
13215
+ return true;
13216
+ }
13217
+
13218
+ /**
13219
+ * 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.
13220
+ *
13221
+ * @author Vova Feldman (@svovaf)
13222
+ * @since 1.2.3
13223
+ * @link https://themes.trac.wordpress.org/ticket/46134#comment:5
13224
+ * @link https://themes.trac.wordpress.org/ticket/46134#comment:9
13225
+ * @link https://themes.trac.wordpress.org/ticket/46134#comment:12
13226
+ * @link https://themes.trac.wordpress.org/ticket/46134#comment:14
13227
+ */
13228
+ $decoded = is_string( $response['body'] ) ?
13229
+ json_decode( $response['body'] ) :
13230
+ null;
13231
+
13232
+ if ( empty( $decoded ) ) {
13233
+ return false;
13234
+ }
13235
+
13236
+ if ( ! $this->is_api_result_object( $decoded ) ) {
13237
+ if ( ! empty( $params['license_key'] ) ) {
13238
+ // Pass the fully entered license key to the failure handler.
13239
+ $params['license_key'] = $license_key;
13240
+ }
13241
+
13242
+ return $is_uninstall ?
13243
+ $decoded :
13244
+ $this->apply_filters( 'after_install_failure', $decoded, $params );
13245
+ } else if ( isset( $decoded->pending_activation ) && $decoded->pending_activation ) {
13246
+ if ( $is_network ) {
13247
+ $site_ids = array();
13248
+ foreach ( $sites as $site ) {
13249
+ $site_ids[] = $site['blog_id'];
13250
+ }
13251
+
13252
+ /**
13253
+ * Store the sites so that they can be installed once the user has clicked on the activation link
13254
+ * in the email.
13255
+ *
13256
+ * @author Leo Fajardo (@leorw)
13257
+ */
13258
+ $this->_storage->pending_sites_info = array(
13259
+ 'blog_ids' => $site_ids,
13260
+ 'license_key' => $license_key,
13261
+ 'trial_plan_id' => $trial_plan_id
13262
+ );
13263
+ }
13264
+
13265
+ // Pending activation, add message.
13266
+ return $this->set_pending_confirmation(
13267
+ ( isset( $decoded->email ) ?
13268
+ $decoded->email :
13269
+ true ),
13270
+ false,
13271
+ $filtered_license_key,
13272
+ ! empty( $params['trial_plan_id'] )
13273
+ );
13274
+ } else if ( isset( $decoded->install_secret_key ) ) {
13275
+ return $this->install_with_new_user(
13276
+ $decoded->user_id,
13277
+ $decoded->user_public_key,
13278
+ $decoded->user_secret_key,
13279
+ $decoded->install_id,
13280
+ $decoded->install_public_key,
13281
+ $decoded->install_secret_key,
13282
+ false
13283
+ );
13284
+ } else if ( is_array( $decoded->installs ) ) {
13285
+ return $this->install_many_with_new_user(
13286
+ $decoded->user_id,
13287
+ $decoded->user_public_key,
13288
+ $decoded->user_secret_key,
13289
+ $decoded->installs,
13290
+ false
13291
+ );
13292
+ }
13293
+
13294
+ return $decoded;
13295
+ }
13296
+
13297
+ /**
13298
+ * Set user and site identities.
13299
+ *
13300
+ * @author Vova Feldman (@svovaf)
13301
+ * @since 1.0.9
13302
+ *
13303
+ * @param FS_User $user
13304
+ * @param FS_Site $site
13305
+ * @param bool $redirect
13306
+ * @param bool $auto_install Since 1.2.1.7 If `true` and setting up an account with a valid license, will
13307
+ * redirect (or return a URL) to the account page with a special parameter to
13308
+ * trigger the auto installation processes.
13309
+ *
13310
+ * @return string If redirect is `false`, returns the next page the user should be redirected to.
13311
+ */
13312
+ function setup_account(
13313
+ FS_User $user,
13314
+ FS_Site $site,
13315
+ $redirect = true,
13316
+ $auto_install = false
13317
+ ) {
13318
+ return $this->setup_network_account(
13319
+ $user,
13320
+ array( $site ),
13321
+ $redirect,
13322
+ $auto_install,
13323
+ false
13324
+ );
13325
+ }
13326
+
13327
+ /**
13328
+ * Set user and site identities.
13329
+ *
13330
+ * @author Vova Feldman (@svovaf)
13331
+ * @since 2.0.0
13332
+ *
13333
+ * @param FS_User $user
13334
+ * @param FS_Site[] $installs
13335
+ * @param bool $redirect
13336
+ * @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.
13337
+ * @param bool $is_network_level_opt_in
13338
+ *
13339
+ * @return string If redirect is `false`, returns the next page the user should be redirected to.
13340
+ */
13341
+ function setup_network_account(
13342
+ FS_User $user,
13343
+ array $installs,
13344
+ $redirect = true,
13345
+ $auto_install = false,
13346
+ $is_network_level_opt_in = true
13347
+ ) {
13348
+ $first_install = $installs[0];
13349
+
13350
+ $this->_user = $user;
13351
+ $this->_site = $first_install;
13352
+
13353
+ $this->_sync_plans();
13354
+
13355
+ if ( 1 < count( $installs ) ) {
13356
+ // Only network level opt-in can have more than one install.
13357
+ $is_network_level_opt_in = true;
13358
+ }
13359
+ // $is_network_level_opt_in = self::is_ajax_action_static( 'network_activate', $this->_module_id );
13360
+ // If Freemius was OFF before, turn it on.
13361
+ $this->turn_on();
13362
+
13363
+ if ( ! $this->_is_network_active || ! $is_network_level_opt_in ) {
13364
+ $this->_set_account( $user, $first_install );
13365
+
13366
+ $this->do_action( 'after_account_connection', $user, $first_install );
13367
+ } else {
13368
+ // Map site addresses to their blog IDs.
13369
+ $address_to_blog_map = $this->get_address_to_blog_map();
13370
+
13371
+ $first_blog_id = null;
13372
+ $blog_2_install_map = array();
13373
+ foreach ( $installs as $install ) {
13374
+ $address = trailingslashit( fs_strip_url_protocol( $install->url ) );
13375
+ $blog_id = $address_to_blog_map[ $address ];
13376
+
13377
+ $this->_store_site( true, $blog_id, $install );
13378
+
13379
+ if ( is_null( $first_blog_id ) ) {
13380
+ $first_blog_id = $blog_id;
13381
+ }
13382
+
13383
+ $blog_2_install_map[ $blog_id ] = $install;
13384
+ }
13385
+
13386
+ if ( ! FS_User::is_valid_id( $this->_storage->network_user_id ) ||
13387
+ ! is_object( self::_get_user_by_id( $this->_storage->network_user_id ) )
13388
+ ) {
13389
+ // Store network user.
13390
+ $this->_storage->network_user_id = $this->_user->id;
13391
+ }
13392
+
13393
+ if ( ! FS_Site::is_valid_id( $this->_storage->network_install_blog_id ) ) {
13394
+ $this->_storage->network_install_blog_id = $first_blog_id;
13395
+ }
13396
+
13397
+ if ( count( $installs ) === count( $address_to_blog_map ) ) {
13398
+ // Super-admin opted-in for all sites in the network.
13399
+ $this->_storage->is_network_connected = true;
13400
+ }
13401
+
13402
+ $this->_store_licenses( false );
13403
+
13404
+ self::$_accounts->store();
13405
+
13406
+ // Don't sync the installs data on network upgrade
13407
+ if ( ! $this->network_upgrade_mode_completed() ) {
13408
+ $this->send_installs_update();
13409
+ }
13410
+
13411
+ // Switch install context back to the first install.
13412
+ $this->_site = $first_install;
13413
+
13414
+ $current_blog = get_current_blog_id();
13415
+
13416
+ foreach ( $blog_2_install_map as $blog_id => $install ) {
13417
+ $this->switch_to_blog( $blog_id );
13418
+
13419
+ $this->do_action( 'after_account_connection', $user, $install );
13420
+ }
13421
+
13422
+ $this->switch_to_blog( $current_blog );
13423
+
13424
+ $this->do_action( 'after_network_account_connection', $user, $blog_2_install_map );
13425
+ }
13426
+
13427
+ if ( is_numeric( $first_install->license_id ) ) {
13428
+ $this->_license = $this->_get_license_by_id( $first_install->license_id );
13429
+ }
13430
+
13431
+ $this->_admin_notices->remove_sticky( 'connect_account' );
13432
+
13433
+ if ( $this->is_pending_activation() || ! $this->has_settings_menu() ) {
13434
+ // Remove pending activation sticky notice (if still exist).
13435
+ $this->_admin_notices->remove_sticky( 'activation_pending' );
13436
+
13437
+ // Remove plugin from pending activation mode.
13438
+ unset( $this->_storage->is_pending_activation );
13439
+
13440
+ if ( ! $this->is_paying_or_trial() ) {
13441
+ $this->_admin_notices->add_sticky(
13442
+ sprintf( $this->get_text_inline( '%s activation was successfully completed.', 'plugin-x-activation-message' ), '<b>' . $this->get_plugin_name() . '</b>' ),
13443
+ 'activation_complete'
13444
+ );
13445
+ }
13446
+ }
13447
+
13448
+ if ( $this->is_paying_or_trial() ) {
13449
+ if ( ! $this->is_premium() ||
13450
+ ! $this->has_premium_version() ||
13451
+ ! $this->has_settings_menu()
13452
+ ) {
13453
+ if ( $this->is_paying() ) {
13454
+ $this->_admin_notices->add_sticky(
13455
+ sprintf(
13456
+ $this->get_text_inline( 'Your account was successfully activated with the %s plan.', 'activation-with-plan-x-message' ),
13457
+ $this->get_plan_title()
13458
+ ) . $this->get_complete_upgrade_instructions(),
13459
+ 'plan_upgraded',
13460
+ $this->get_text_x_inline( 'Yee-haw', 'interjection expressing joy or exuberance', 'yee-haw' ) . '!'
13461
+ );
13462
+ } else {
13463
+ $trial_plan = $this->get_trial_plan();
13464
+
13465
+ $this->_admin_notices->add_sticky(
13466
+ sprintf(
13467
+ $this->get_text_inline( 'Your trial has been successfully started.', 'trial-started-message' ),
13468
+ '<i>' . $this->get_plugin_name() . '</i>'
13469
+ ) . $this->get_complete_upgrade_instructions( $trial_plan->title ),
13470
+ 'trial_started',
13471
+ $this->get_text_x_inline( 'Yee-haw', 'interjection expressing joy or exuberance', 'yee-haw' ) . '!'
13472
+ );
13473
+ }
13474
+ }
13475
+
13476
+ $this->_admin_notices->remove_sticky( array(
13477
+ 'trial_promotion',
13478
+ ) );
13479
+ }
13480
+
13481
+ $plugin_id = fs_request_get( 'plugin_id', false );
13482
+
13483
+ // Store activation time ONLY for plugins & themes (not add-ons).
13484
+ if ( ! is_numeric( $plugin_id ) || ( $plugin_id == $this->_plugin->id ) ) {
13485
+ if ( empty( $this->_storage->activation_timestamp ) ) {
13486
+ $this->_storage->activation_timestamp = WP_FS__SCRIPT_START_TIME;
13487
+ }
13488
+ }
13489
+
13490
+ $next_page = '';
13491
+
13492
+ $extra = array();
13493
+ if ( $auto_install ) {
13494
+ $extra['auto_install'] = 'true';
13495
+ }
13496
+
13497
+ if ( is_numeric( $plugin_id ) ) {
13498
+ /**
13499
+ * @author Leo Fajardo (@leorw)
13500
+ * @since 1.2.1.6
13501
+ *
13502
+ * Also sync the license after an anonymous user subscribes.
13503
+ */
13504
+ if ( $this->is_anonymous() || $plugin_id != $this->_plugin->id ) {
13505
+ // Add-on was installed - sync license right after install.
13506
+ $next_page = $this->_get_sync_license_url( $plugin_id, true, $extra );
13507
+ }
13508
+ } else {
13509
+ /**
13510
+ * @author Vova Feldman (@svovaf)
13511
+ * @since 1.1.9 If site installed with a valid license, sync license.
13512
+ */
13513
+ if ( $this->is_paying() ) {
13514
+ $this->_sync_plugin_license(
13515
+ true,
13516
+ // Installs data is already synced in the beginning of this method directly or via _set_account().
13517
+ false
13518
+ );
13519
+ }
13520
+
13521
+ // Reload the page with the keys.
13522
+ $next_page = $this->is_anonymous() ?
13523
+ // If user previously skipped, redirect to account page.
13524
+ $this->get_account_url( false, $extra ) :
13525
+ $this->get_after_activation_url( 'after_connect_url', array(), $is_network_level_opt_in );
13526
+ }
13527
+
13528
+ if ( ! empty( $next_page ) && $redirect ) {
13529
+ fs_redirect( $next_page );
13530
+ }
13531
+
13532
+ return $next_page;
13533
+ }
13534
+
13535
+ /**
13536
+ * Install plugin with new user information after approval.
13537
+ *
13538
+ * @author Vova Feldman (@svovaf)
13539
+ * @since 1.0.7
13540
+ */
13541
+ function _install_with_new_user() {
13542
+ $this->_logger->entrance();
13543
+
13544
+ if ( $this->is_registered() ) {
13545
+ return;
13546
+ }
13547
+
13548
+ if ( ( $this->is_plugin() && fs_request_is_action( $this->get_unique_affix() . '_activate_new' ) ) ||
13549
+ // @todo This logic should be improved because it's executed on every load of a theme.
13550
+ $this->is_theme()
13551
+ ) {
13552
+ // check_admin_referer( $this->_slug . '_activate_new' );
13553
+
13554
+ if ( fs_request_has( 'user_secret_key' ) ) {
13555
+ if ( fs_is_network_admin() && isset( $this->_storage->pending_sites_info ) ) {
13556
+ $pending_sites_info = $this->_storage->pending_sites_info;
13557
+
13558
+ $this->install_many_pending_with_user(
13559
+ fs_request_get( 'user_id' ),
13560
+ fs_request_get( 'user_public_key' ),
13561
+ fs_request_get( 'user_secret_key' ),
13562
+ $pending_sites_info['blog_ids'],
13563
+ $pending_sites_info['license_key'],
13564
+ $pending_sites_info['trial_plan_id']
13565
+ );
13566
+ } else {
13567
+ $this->install_with_new_user(
13568
+ fs_request_get( 'user_id' ),
13569
+ fs_request_get( 'user_public_key' ),
13570
+ fs_request_get( 'user_secret_key' ),
13571
+ fs_request_get( 'install_id' ),
13572
+ fs_request_get( 'install_public_key' ),
13573
+ fs_request_get( 'install_secret_key' ),
13574
+ true,
13575
+ fs_request_get_bool( 'auto_install' )
13576
+ );
13577
+ }
13578
+ } else if ( fs_request_has( 'pending_activation' ) ) {
13579
+ $this->set_pending_confirmation( fs_request_get( 'user_email' ), true );
13580
+ }
13581
+ }
13582
+ }
13583
+
13584
+ /**
13585
+ * @author Vova Feldman (@svovaf)
13586
+ * @since 2.0.0
13587
+ *
13588
+ * @param number $id
13589
+ * @param string $public_key
13590
+ * @param string $secret_key
13591
+ *
13592
+ * @return \FS_User
13593
+ */
13594
+ private function setup_user( $id, $public_key, $secret_key ) {
13595
+ $user = self::_get_user_by_id( $id );
13596
+
13597
+ if ( is_object( $user ) ) {
13598
+ $this->_user = $user;
13599
+ } else {
13600
+ $user = new FS_User();
13601
+ $user->id = $id;
13602
+ $user->public_key = $public_key;
13603
+ $user->secret_key = $secret_key;
13604
+
13605
+ $this->_user = $user;
13606
+ $user_result = $this->get_api_user_scope()->get();
13607
+ $user = new FS_User( $user_result );
13608
+
13609
+ $this->_user = $user;
13610
+ $this->_store_user();
13611
+ }
13612
+
13613
+ return $user;
13614
+ }
13615
+
13616
+ /**
13617
+ * Install plugin with new user.
13618
+ *
13619
+ * @author Vova Feldman (@svovaf)
13620
+ * @since 1.1.7.4
13621
+ *
13622
+ * @param number $user_id
13623
+ * @param string $user_public_key
13624
+ * @param string $user_secret_key
13625
+ * @param number $install_id
13626
+ * @param string $install_public_key
13627
+ * @param string $install_secret_key
13628
+ * @param bool $redirect
13629
+ * @param bool $auto_install Since 1.2.1.7 If `true` and setting up an account with a valid license, will
13630
+ * redirect (or return a URL) to the account page with a special parameter to
13631
+ * trigger the auto installation processes.
13632
+ *
13633
+ * @return string If redirect is `false`, returns the next page the user should be redirected to.
13634
+ */
13635
+ private function install_with_new_user(
13636
+ $user_id,
13637
+ $user_public_key,
13638
+ $user_secret_key,
13639
+ $install_id,
13640
+ $install_public_key,
13641
+ $install_secret_key,
13642
+ $redirect = true,
13643
+ $auto_install = false
13644
+ ) {
13645
+ /**
13646
+ * This method is also executed after opting in with a license key since the
13647
+ * license can be potentially associated with a different owner.
13648
+ *
13649
+ * @since 2.0.0
13650
+ */
13651
+ $user = self::_get_user_by_id( $user_id );
13652
+
13653
+ if ( ! is_object( $user ) ) {
13654
+ $user = new FS_User();
13655
+ $user->id = $user_id;
13656
+ $user->public_key = $user_public_key;
13657
+ $user->secret_key = $user_secret_key;
13658
+
13659
+ $this->_user = $user;
13660
+ $user_result = $this->get_api_user_scope()->get();
13661
+ $user = new FS_User( $user_result );
13662
+ }
13663
+
13664
+ $this->_user = $user;
13665
+
13666
+ $site = new FS_Site();
13667
+ $site->id = $install_id;
13668
+ $site->public_key = $install_public_key;
13669
+ $site->secret_key = $install_secret_key;
13670
+
13671
+ $this->_site = $site;
13672
+ $site_result = $this->get_api_site_scope()->get();
13673
+ $site = new FS_Site( $site_result );
13674
+ $this->_site = $site;
13675
+
13676
+ return $this->setup_account(
13677
+ $this->_user,
13678
+ $this->_site,
13679
+ $redirect,
13680
+ $auto_install
13681
+ );
13682
+ }
13683
+
13684
+ /**
13685
+ * Install plugin with user.
13686
+ *
13687
+ * @author Leo Fajardo (@leorw)
13688
+ * @since 2.0.0
13689
+ *
13690
+ * @param number $user_id
13691
+ * @param string $user_public_key
13692
+ * @param string $user_secret_key
13693
+ * @param array $site_ids
13694
+ * @param bool $license_key
13695
+ * @param bool $trial_plan_id
13696
+ * @param bool $redirect
13697
+ *
13698
+ * @return string If redirect is `false`, returns the next page the user should be redirected to.
13699
+ */
13700
+ private function install_many_pending_with_user(
13701
+ $user_id,
13702
+ $user_public_key,
13703
+ $user_secret_key,
13704
+ $site_ids,
13705
+ $license_key = false,
13706
+ $trial_plan_id = false,
13707
+ $redirect = true
13708
+ ) {
13709
+ $user = $this->setup_user( $user_id, $user_public_key, $user_secret_key );
13710
+
13711
+ $sites = array();
13712
+ foreach ( $site_ids as $site_id ) {
13713
+ $sites[] = $this->get_site_info( array( 'blog_id' => $site_id ) );
13714
+ }
13715
+
13716
+ $this->install_with_user( $user, $license_key, $trial_plan_id, $redirect, true, $sites );
13717
+ }
13718
+
13719
+ /**
13720
+ * Multi-site install with a new user.
13721
+ *
13722
+ * @author Vova Feldman (@svovaf)
13723
+ * @since 2.0.0
13724
+ *
13725
+ * @param number $user_id
13726
+ * @param string $user_public_key
13727
+ * @param string $user_secret_key
13728
+ * @param object[] $installs
13729
+ * @param bool $redirect
13730
+ * @param bool $auto_install Since 1.2.1.7 If `true` and setting up an account with a valid license, will
13731
+ * redirect (or return a URL) to the account page with a special parameter to
13732
+ * trigger the auto installation processes.
13733
+ *
13734
+ * @return string If redirect is `false`, returns the next page the user should be redirected to.
13735
+ */
13736
+ private function install_many_with_new_user(
13737
+ $user_id,
13738
+ $user_public_key,
13739
+ $user_secret_key,
13740
+ array $installs,
13741
+ $redirect = true,
13742
+ $auto_install = false
13743
+ ) {
13744
+ $this->setup_user( $user_id, $user_public_key, $user_secret_key );
13745
+
13746
+ $install_ids = array();
13747
+
13748
+ foreach ( $installs as $install ) {
13749
+ $install_ids[] = $install->id;
13750
+ }
13751
+
13752
+ $left = count( $install_ids );
13753
+ $offset = 0;
13754
+
13755
+ $installs = array();
13756
+ while ( $left > 0 ) {
13757
+ $result = $this->get_api_user_scope()->get( "/plugins/{$this->_module_id}/installs.json?ids=" . implode( ',', array_slice( $install_ids, $offset, 25 ) ) );
13758
+
13759
+ if ( ! $this->is_api_result_object( $result, 'installs' ) ) {
13760
+ // @todo Handle API error.
13761
+ }
13762
+
13763
+ $installs = array_merge( $installs, $result->installs );
13764
+
13765
+ $left -= 25;
13766
+ }
13767
+
13768
+ foreach ( $installs as &$install ) {
13769
+ $install = new FS_Site( $install );
13770
+ }
13771
+
13772
+ return $this->setup_network_account(
13773
+ $this->_user,
13774
+ $installs,
13775
+ $redirect,
13776
+ $auto_install
13777
+ );
13778
+ }
13779
+
13780
+ /**
13781
+ * @author Vova Feldman (@svovaf)
13782
+ * @since 1.1.7.4
13783
+ *
13784
+ * @param string|bool $email
13785
+ * @param bool $redirect
13786
+ * @param string|bool $license_key Since 1.2.1.5
13787
+ * @param bool $is_pending_trial Since 1.2.1.5
13788
+ *
13789
+ * @return string Since 1.2.1.5 if $redirect is `false`, return the pending activation page.
13790
+ */
13791
+ private function set_pending_confirmation(
13792
+ $email = false,
13793
+ $redirect = true,
13794
+ $license_key = false,
13795
+ $is_pending_trial = false
13796
+ ) {
13797
+ if ( $this->_ignore_pending_mode ) {
13798
+ /**
13799
+ * If explicitly asked to ignore pending mode, set to anonymous mode
13800
+ * if require confirmation before finalizing the opt-in.
13801
+ *
13802
+ * @author Vova Feldman
13803
+ * @since 1.2.1.6
13804
+ */
13805
+ $this->skip_connection( null, fs_is_network_admin() );
13806
+ } else {
13807
+ // Install must be activated via email since
13808
+ // user with the same email already exist.
13809
+ $this->_storage->is_pending_activation = true;
13810
+ $this->_add_pending_activation_notice( $email, $is_pending_trial );
13811
+ }
13812
+
13813
+ if ( ! empty( $license_key ) ) {
13814
+ $this->_storage->pending_license_key = $license_key;
13815
+ }
13816
+
13817
+ // Remove the opt-in sticky notice.
13818
+ $this->_admin_notices->remove_sticky( array(
13819
+ 'connect_account',
13820
+ 'trial_promotion',
13821
+ ) );
13822
+
13823
+ $next_page = $this->get_after_activation_url( 'after_pending_connect_url' );
13824
+
13825
+ // Reload the page with with pending activation message.
13826
+ if ( $redirect ) {
13827
+ fs_redirect( $next_page );
13828
+ }
13829
+
13830
+ return $next_page;
13831
+ }
13832
+
13833
+ /**
13834
+ * Install plugin with current logged WP user info.
13835
+ *
13836
+ * @author Vova Feldman (@svovaf)
13837
+ * @since 1.0.7
13838
+ */
13839
+ function _install_with_current_user() {
13840
+ $this->_logger->entrance();
13841
+
13842
+ if ( $this->is_registered() ) {
13843
+ return;
13844
+ }
13845
+
13846
+ if ( fs_request_is_action( $this->get_unique_affix() . '_activate_existing' ) && fs_request_is_post() ) {
13847
+ // check_admin_referer( 'activate_existing_' . $this->_plugin->public_key );
13848
+
13849
+ /**
13850
+ * @author Vova Feldman (@svovaf)
13851
+ * @since 1.1.9 Add license key if given.
13852
+ */
13853
+ $license_key = fs_request_get( 'license_secret_key' );
13854
+
13855
+ $this->install_with_current_user( $license_key );
13856
+ }
13857
+ }
13858
+
13859
+
13860
+ /**
13861
+ * @author Vova Feldman (@svovaf)
13862
+ * @since 1.1.7.4
13863
+ *
13864
+ * @param string|bool $license_key
13865
+ * @param number|bool $trial_plan_id
13866
+ * @param array $sites Since 2.0.0
13867
+ * @param bool $redirect
13868
+ *
13869
+ * @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.
13870
+ */
13871
+ private function install_with_current_user(
13872
+ $license_key = false,
13873
+ $trial_plan_id = false,
13874
+ $sites = array(),
13875
+ $redirect = true
13876
+ ) {
13877
+ // Get current logged WP user.
13878
+ $current_user = self::_get_current_wp_user();
13879
+
13880
+ // Find the relevant FS user by the email.
13881
+ $user = self::_get_user_by_email( $current_user->user_email );
13882
+
13883
+ return $this->install_with_user( $user, $license_key, $trial_plan_id, $redirect, true, $sites );
13884
+ }
13885
+
13886
+ /**
13887
+ * @author Vova Feldman (@svovaf)
13888
+ * @since 2.0.0
13889
+ *
13890
+ * @param \FS_User $user
13891
+ * @param string|bool $license_key
13892
+ * @param number|bool $trial_plan_id
13893
+ * @param bool $redirect
13894
+ * @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.
13895
+ * @param array $sites Since 2.0.0. If not empty, should be a collection of site details for the bulk install API request.
13896
+ *
13897
+ * @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.
13898
+ */
13899
+ private function install_with_user(
13900
+ FS_User $user,
13901
+ $license_key = false,
13902
+ $trial_plan_id = false,
13903
+ $redirect = true,
13904
+ $setup_account = true,
13905
+ $sites = array()
13906
+ ) {
13907
+ // We have to set the user before getting user scope API handler.
13908
+ $this->_user = $user;
13909
+
13910
+ // Install the plugin.
13911
+ $result = $this->create_installs_with_user(
13912
+ $user,
13913
+ $license_key,
13914
+ $trial_plan_id,
13915
+ $sites,
13916
+ $redirect
13917
+ );
13918
+
13919
+ if ( ! $this->is_api_result_entity( $result ) &&
13920
+ ! $this->is_api_result_object( $result, 'installs' )
13921
+ ) {
13922
+ // @todo Handler potential API error of the $result
13923
+ }
13924
+
13925
+ if ( empty( $sites ) ) {
13926
+ $site = new FS_Site( $result );
13927
+ $this->_site = $site;
13928
+
13929
+ if ( ! $setup_account ) {
13930
+ $this->_store_site();
13931
+
13932
+ $this->sync_plan_if_not_exist( $site->plan_id );
13933
+
13934
+ if ( ! empty( $license_key ) && FS_Plugin_License::is_valid_id( $site->license_id ) ) {
13935
+ $this->sync_license_if_not_exist( $site->license_id, $license_key );
13936
+ }
13937
+
13938
+ $this->_admin_notices->remove_sticky( 'connect_account', false );
13939
+
13940
+ return $site;
13941
+ }
13942
+
13943
+ return $this->setup_account( $this->_user, $this->_site, $redirect );
13944
+ } else {
13945
+ $installs = array();
13946
+ foreach ( $result->installs as $install ) {
13947
+ $installs[] = new FS_Site( $install );
13948
+ }
13949
+
13950
+ return $this->setup_network_account(
13951
+ $user,
13952
+ $installs,
13953
+ $redirect
13954
+ );
13955
+ }
13956
+ }
13957
+
13958
+ /**
13959
+ * Initiate an API request to create a collection of installs.
13960
+ *
13961
+ * @author Vova Feldman (@svovaf)
13962
+ * @since 2.0.0
13963
+ *
13964
+ * @param \FS_User $user
13965
+ * @param bool $license_key
13966
+ * @param bool $trial_plan_id
13967
+ * @param array $sites
13968
+ * @param bool $redirect
13969
+ * @param bool $silent
13970
+ *
13971
+ * @return object|mixed
13972
+ */
13973
+ private function create_installs_with_user(
13974
+ FS_User $user,
13975
+ $license_key = false,
13976
+ $trial_plan_id = false,
13977
+ $sites = array(),
13978
+ $redirect = false,
13979
+ $silent = false
13980
+ ) {
13981
+ $extra_install_params = array(
13982
+ 'uid' => $this->get_anonymous_id(),
13983
+ 'is_disconnected' => false,
13984
+ );
13985
+
13986
+ if ( ! empty( $license_key ) ) {
13987
+ $extra_install_params['license_key'] = $this->apply_filters( 'license_key', $license_key );
13988
+ } else if ( FS_Plugin_Plan::is_valid_id( $trial_plan_id ) ) {
13989
+ $extra_install_params['trial_plan_id'] = $trial_plan_id;
13990
+ }
13991
+
13992
+ if ( ! empty( $sites ) ) {
13993
+ $extra_install_params['sites'] = $sites;
13994
+ }
13995
+
13996
+ $args = $this->get_install_data_for_api( $extra_install_params, false, false );
13997
+
13998
+ // Install the plugin.
13999
+ $result = $this->get_api_user_scope_by_user( $user )->call(
14000
+ "/plugins/{$this->get_id()}/installs.json",
14001
+ 'post',
14002
+ $args
14003
+ );
14004
+
14005
+ if ( ! $this->is_api_result_entity( $result ) &&
14006
+ ! $this->is_api_result_object( $result, 'installs' )
14007
+ ) {
14008
+ if ( ! empty( $args['license_key'] ) ) {
14009
+ // Pass full the fully entered license key to the failure handler.
14010
+ $args['license_key'] = $license_key;
14011
+ }
14012
+
14013
+ $result = $this->apply_filters( 'after_install_failure', $result, $args );
14014
+
14015
+ if ( ! $silent ) {
14016
+ $this->_admin_notices->add(
14017
+ sprintf( $this->get_text_inline( 'Couldn\'t activate %s.', 'could-not-activate-x' ), $this->get_plugin_name() ) . ' ' .
14018
+ $this->get_text_inline( 'Please contact us with the following message:', 'contact-us-with-error-message' ) . ' ' . '<b>' . $result->error->message . '</b>',
14019
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
14020
+ 'error'
14021
+ );
14022
+ }
14023
+
14024
+ if ( $redirect ) {
14025
+ /**
14026
+ * We set the user before getting the user scope API handler, so the user became temporarily
14027
+ * registered (`is_registered() = true`). Since the API returned an error and we will redirect,
14028
+ * we have to set the user to `null`, otherwise, the user will be redirected to the wrong
14029
+ * activation page based on the return value of `is_registered()`. In addition, in case the
14030
+ * context plugin doesn't have a settings menu and the default page is the `Plugins` page,
14031
+ * misleading plugin activation errors will be shown on the `Plugins` page.
14032
+ *
14033
+ * @author Leo Fajardo (@leorw)
14034
+ */
14035
+ $this->_user = null;
14036
+
14037
+ fs_redirect( $this->get_activation_url( array( 'error' => $result->error->message ) ) );
14038
+ }
14039
+ }
14040
+
14041
+ return $result;
14042
+ }
14043
+
14044
+ /**
14045
+ * Tries to activate add-on account based on parent plugin info.
14046
+ *
14047
+ * @author Vova Feldman (@svovaf)
14048
+ * @since 1.0.6
14049
+ *
14050
+ * @param Freemius $parent_fs
14051
+ */
14052
+ private function _activate_addon_account( Freemius $parent_fs ) {
14053
+ if ( $this->is_registered() ) {
14054
+ // Already activated.
14055
+ return;
14056
+ }
14057
+
14058
+ // Activate add-on with parent plugin credentials.
14059
+ $addon_install = $parent_fs->get_api_site_scope()->call(
14060
+ "/addons/{$this->_plugin->id}/installs.json",
14061
+ 'post',
14062
+ $this->get_install_data_for_api( array(
14063
+ 'uid' => $this->get_anonymous_id(),
14064
+ ), false, false )
14065
+ );
14066
+
14067
+ if ( isset( $addon_install->error ) ) {
14068
+ $this->_admin_notices->add(
14069
+ sprintf( $this->get_text_inline( 'Couldn\'t activate %s.', 'could-not-activate-x' ), $this->get_plugin_name() ) . ' ' .
14070
+ $this->get_text_inline( 'Please contact us with the following message:', 'contact-us-with-error-message' ) . ' ' . '<b>' . $addon_install->error->message . '</b>',
14071
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
14072
+ 'error'
14073
+ );
14074
+
14075
+ return;
14076
+ }
14077
+
14078
+ // Get user information based on parent's plugin.
14079
+ $user = $parent_fs->get_user();
14080
+
14081
+ // First of all, set site and user info - otherwise we won't
14082
+ // be able to invoke API calls.
14083
+ $this->_site = new FS_Site( $addon_install );
14084
+ $this->_user = $user;
14085
+
14086
+ // Sync add-on plans.
14087
+ $this->_sync_plans();
14088
+
14089
+ // Get site's current plan.
14090
+ //$this->_site->plan = $this->_get_plan_by_id( $this->_site->plan->id );
14091
+
14092
+ $this->_set_account( $user, $this->_site );
14093
+
14094
+ // Sync licenses.
14095
+ $this->_sync_licenses();
14096
+
14097
+ // Try to activate premium license.
14098
+ $this->_activate_license( true );
14099
+ }
14100
+
14101
+ /**
14102
+ * Tries to activate parent account based on add-on's info.
14103
+ *
14104
+ * @author Vova Feldman (@svovaf)
14105
+ * @since 1.2.2.7
14106
+ *
14107
+ * @param Freemius $parent_fs
14108
+ */
14109
+ private function activate_parent_account( Freemius $parent_fs ) {
14110
+ if ( ! $this->is_addon() ) {
14111
+ // This is not an add-on.
14112
+ return;
14113
+ }
14114
+
14115
+ if ( $parent_fs->is_registered() ) {
14116
+ // Already activated.
14117
+ return;
14118
+ }
14119
+
14120
+ // Activate parent with add-on's user credentials.
14121
+ $parent_install = $this->get_api_user_scope()->call(
14122
+ "/plugins/{$parent_fs->_plugin->id}/installs.json",
14123
+ 'post',
14124
+ $parent_fs->get_install_data_for_api( array(
14125
+ 'uid' => $parent_fs->get_anonymous_id(),
14126
+ ), false, false )
14127
+ );
14128
+
14129
+ if ( isset( $parent_install->error ) ) {
14130
+ $this->_admin_notices->add(
14131
+ sprintf( $this->get_text_inline( 'Couldn\'t activate %s.', 'could-not-activate-x' ), $this->get_plugin_name() ) . ' ' .
14132
+ $this->get_text_inline( 'Please contact us with the following message:', 'contact-us-with-error-message' ) . ' ' . '<b>' . $parent_install->error->message . '</b>',
14133
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
14134
+ 'error'
14135
+ );
14136
+
14137
+ return;
14138
+ }
14139
+
14140
+ $parent_fs->_admin_notices->remove_sticky( 'connect_account' );
14141
+
14142
+ if ( $parent_fs->is_pending_activation() ) {
14143
+ $parent_fs->_admin_notices->remove_sticky( 'activation_pending' );
14144
+
14145
+ unset( $parent_fs->_storage->is_pending_activation );
14146
+ }
14147
+
14148
+ // First of all, set site info - otherwise we won't
14149
+ // be able to invoke API calls.
14150
+ $parent_fs->_site = new FS_Site( $parent_install );
14151
+
14152
+ // Sync add-on plans.
14153
+ $parent_fs->_sync_plans();
14154
+
14155
+ // Get user information based on parent's plugin.
14156
+ $user = $this->get_user();
14157
+
14158
+ $parent_fs->_set_account( $user, $parent_fs->_site );
14159
+ }
14160
+
14161
+ #endregion
14162
+
14163
+ #----------------------------------------------------------------------------------
14164
+ #region Admin Menu Items
14165
+ #----------------------------------------------------------------------------------
14166
+
14167
+ private $_menu_items = array();
14168
+
14169
+ /**
14170
+ * @author Vova Feldman (@svovaf)
14171
+ * @since 1.2.1.8
14172
+ *
14173
+ * @return array
14174
+ */
14175
+ function get_menu_items() {
14176
+ return $this->_menu_items;
14177
+ }
14178
+
14179
+ /**
14180
+ * @author Vova Feldman (@svovaf)
14181
+ * @since 1.0.7
14182
+ *
14183
+ * @return string
14184
+ */
14185
+ function get_menu_slug() {
14186
+ return $this->_menu->get_slug();
14187
+ }
14188
+
14189
+ /**
14190
+ * @author Vova Feldman (@svovaf)
14191
+ * @since 1.0.9
14192
+ */
14193
+ function _prepare_admin_menu() {
14194
+ // if ( ! $this->is_on() ) {
14195
+ // return;
14196
+ // }
14197
+
14198
+ /**
14199
+ * When running from a site admin with a network activated module and the connection
14200
+ * was NOT delegated and the user still haven't skipped or opted-in, then hide the
14201
+ * site level settings.
14202
+ *
14203
+ * @author Vova Feldman (@svovaf)
14204
+ * @since 2.0.0
14205
+ */
14206
+ $should_hide_site_admin_settings = (
14207
+ $this->_is_network_active &&
14208
+ ! fs_is_network_admin() &&
14209
+ ! $this->is_delegated_connection() &&
14210
+ ! $this->is_anonymous() &&
14211
+ ! $this->is_registered()
14212
+ );
14213
+
14214
+ if ( ( ! $this->has_api_connectivity() && ! $this->is_enable_anonymous() ) ||
14215
+ $should_hide_site_admin_settings
14216
+ ) {
14217
+ $this->_menu->remove_menu_item( $should_hide_site_admin_settings );
14218
+ } else {
14219
+ $this->do_action( fs_is_network_admin() ?
14220
+ 'before_network_admin_menu_init' :
14221
+ 'before_admin_menu_init'
14222
+ );
14223
+
14224
+ $this->add_menu_action();
14225
+
14226
+ $this->add_network_menu_when_missing();
14227
+
14228
+ $this->add_submenu_items();
14229
+ }
14230
+ }
14231
+
14232
+ /**
14233
+ * Admin dashboard menu items modifications.
14234
+ *
14235
+ * NOTE: admin_menu action executed before admin_init.
14236
+ *
14237
+ * @author Vova Feldman (@svovaf)
14238
+ * @since 1.0.7
14239
+ *
14240
+ */
14241
+ private function add_menu_action() {
14242
+ if ( $this->is_activation_mode() ) {
14243
+ if ( $this->is_plugin() || ( $this->has_settings_menu() && ! $this->is_free_wp_org_theme() ) ) {
14244
+ $this->override_plugin_menu_with_activation();
14245
+ } else {
14246
+ /**
14247
+ * Handle theme opt-in when the opt-in form shows as a dialog box in the themes page.
14248
+ */
14249
+ if ( fs_request_is_action( $this->get_unique_affix() . '_activate_existing' ) ) {
14250
+ add_action( 'load-themes.php', array( &$this, '_install_with_current_user' ) );
14251
+ } else if ( fs_request_is_action( $this->get_unique_affix() . '_activate_new' ) ||
14252
+ fs_request_get_bool( 'pending_activation' )
14253
+ ) {
14254
+ add_action( 'load-themes.php', array( &$this, '_install_with_new_user' ) );
14255
+ }
14256
+ }
14257
+ } else {
14258
+ if ( ! $this->is_registered() ) {
14259
+ // If not registered try to install user.
14260
+ if ( fs_request_is_action( $this->get_unique_affix() . '_activate_new' ) ) {
14261
+ $this->_install_with_new_user();
14262
+ }
14263
+ } else if (
14264
+ fs_request_is_action( 'sync_user' ) &&
14265
+ ( ! $this->has_settings_menu() || $this->is_free_wp_org_theme() )
14266
+ ) {
14267
+ $this->_handle_account_user_sync();
14268
+ }
14269
+ }
14270
+ }
14271
+
14272
+ /**
14273
+ * @author Vova Feldman (@svovaf)
14274
+ * @since 1.0.1
14275
+ */
14276
+ function _redirect_on_clicked_menu_link() {
14277
+ $this->_logger->entrance();
14278
+
14279
+ $page = strtolower( isset( $_REQUEST['page'] ) ? $_REQUEST['page'] : '' );
14280
+
14281
+ $this->_logger->log( 'page = ' . $page );
14282
+
14283
+ foreach ( $this->_menu_items as $priority => $items ) {
14284
+ foreach ( $items as $item ) {
14285
+ if ( isset( $item['url'] ) ) {
14286
+ if ( $page === $this->_menu->get_slug( strtolower( $item['menu_slug'] ) ) ) {
14287
+ $this->_logger->log( 'Redirecting to ' . $item['url'] );
14288
+
14289
+ fs_redirect( $item['url'] );
14290
+ }
14291
+ }
14292
+ }
14293
+ }
14294
+ }
14295
+
14296
+ /**
14297
+ * Remove plugin's all admin menu items & pages, and replace with activation page.
14298
+ *
14299
+ * @author Vova Feldman (@svovaf)
14300
+ * @since 1.0.1
14301
+ */
14302
+ private function override_plugin_menu_with_activation() {
14303
+ $this->_logger->entrance();
14304
+
14305
+ $hook = false;
14306
+
14307
+ if ( ! $this->_menu->has_menu() ) {
14308
+ // Add the opt-in page without a menu item.
14309
+ $hook = FS_Admin_Menu_Manager::add_subpage(
14310
+ null,
14311
+ $this->get_plugin_name(),
14312
+ $this->get_plugin_name(),
14313
+ 'manage_options',
14314
+ $this->_slug,
14315
+ array( &$this, '_connect_page_render' )
14316
+ );
14317
+ } else if ( $this->_menu->is_top_level() ) {
14318
+ if ( $this->_menu->is_override_exact() ) {
14319
+ // Make sure the current page is matching the activation page.
14320
+ if ( ! $this->is_matching_url( $this->get_activation_url() ) ) {
14321
+ return;
14322
+ }
14323
+ }
14324
+
14325
+ $hook = $this->_menu->override_menu_item( array( &$this, '_connect_page_render' ) );
14326
+
14327
+ if ( false === $hook ) {
14328
+ // Create new menu item just for the opt-in.
14329
+ $hook = FS_Admin_Menu_Manager::add_page(
14330
+ $this->get_plugin_name(),
14331
+ $this->get_plugin_name(),
14332
+ 'manage_options',
14333
+ $this->_menu->get_slug(),
14334
+ array( &$this, '_connect_page_render' )
14335
+ );
14336
+ }
14337
+ } else {
14338
+ $menus = array( $this->_menu->get_parent_slug() );
14339
+
14340
+ if ( $this->_menu->is_override_exact() ) {
14341
+ // Make sure the current page is matching the activation page.
14342
+ if ( ! $this->is_matching_url( $this->get_activation_url() ) ) {
14343
+ return;
14344
+ }
14345
+ }
14346
+
14347
+ foreach ( $menus as $parent_slug ) {
14348
+ $hook = $this->_menu->override_submenu_action(
14349
+ $parent_slug,
14350
+ $this->_menu->get_raw_slug(),
14351
+ array( &$this, '_connect_page_render' )
14352
+ );
14353
+
14354
+ if ( false !== $hook ) {
14355
+ // Found plugin's submenu item.
14356
+ break;
14357
+ }
14358
+ }
14359
+ }
14360
+
14361
+ if ( $this->is_activation_page() ) {
14362
+ // Clean admin page from distracting content.
14363
+ self::_clean_admin_content_section();
14364
+ }
14365
+
14366
+ if ( false !== $hook ) {
14367
+ if ( fs_request_is_action( $this->get_unique_affix() . '_activate_existing' ) ) {
14368
+ $this->_install_with_current_user();
14369
+ } else if ( fs_request_is_action( $this->get_unique_affix() . '_activate_new' ) ) {
14370
+ $this->_install_with_new_user();
14371
+ }
14372
+ }
14373
+ }
14374
+
14375
+ /**
14376
+ * If a plugin was network activated and connected but don't have a network
14377
+ * level settings, then add an artificial menu item for the Account and other
14378
+ * Freemius settings.
14379
+ *
14380
+ * @author Vova Feldman (@svovaf)
14381
+ * @since 2.0.0
14382
+ */
14383
+ private function add_network_menu_when_missing() {
14384
+ $this->_logger->entrance();
14385
+
14386
+ if ( ! $this->_is_network_active ) {
14387
+ // Plugin wasn't activated on the network level.
14388
+ return;
14389
+ }
14390
+
14391
+ if ( ! fs_is_network_admin() ) {
14392
+ // The context is not the network admin.
14393
+ return;
14394
+ }
14395
+
14396
+ if ( $this->_menu->has_network_menu() ) {
14397
+ // Plugin already has a network level menu.
14398
+ return;
14399
+ }
14400
+
14401
+ if ( $this->is_network_activation_mode() ) {
14402
+ /**
14403
+ * Do not add during activation mode, otherwise, there will be duplicate menus while the opt-in
14404
+ * screen is being shown.
14405
+ *
14406
+ * @author Leo Fajardo (@leorw)
14407
+ */
14408
+ return;
14409
+ }
14410
+
14411
+ if ( ! WP_FS__SHOW_NETWORK_EVEN_WHEN_DELEGATED ) {
14412
+ if ( $this->is_network_delegated_connection() ) {
14413
+ // Super-admin delegated the connection to the site admins.
14414
+ return;
14415
+ }
14416
+ }
14417
+
14418
+ if ( ! $this->_menu->has_menu() || $this->_menu->is_top_level() ) {
14419
+ $this->_dynamically_added_top_level_page_hook_name = $this->_menu->add_page_and_update(
14420
+ $this->get_plugin_name(),
14421
+ $this->get_plugin_name(),
14422
+ 'manage_options',
14423
+ $this->_menu->has_menu() ? $this->_menu->get_slug() : $this->_slug
14424
+ );
14425
+ } else {
14426
+ $this->_menu->add_subpage_and_update(
14427
+ $this->_menu->get_parent_slug(),
14428
+ $this->get_plugin_name(),
14429
+ $this->get_plugin_name(),
14430
+ 'manage_options',
14431
+ $this->_menu->get_slug()
14432
+ );
14433
+ }
14434
+ }
14435
+
14436
+ /**
14437
+ * @author Leo Fajardo (@leorw)
14438
+ * @since 1.2.1
14439
+ *
14440
+ * return string
14441
+ */
14442
+ function get_top_level_menu_capability() {
14443
+ global $menu;
14444
+
14445
+ $top_level_menu_slug = $this->get_top_level_menu_slug();
14446
+
14447
+ foreach ( $menu as $menu_info ) {
14448
+ /**
14449
+ * The second element in the menu info array is the capability/role that has access to the menu and the
14450
+ * third element is the menu slug.
14451
+ */
14452
+ if ( $menu_info[2] === $top_level_menu_slug ) {
14453
+ return $menu_info[1];
14454
+ }
14455
+ }
14456
+
14457
+ return 'read';
14458
+ }
14459
+
14460
+ /**
14461
+ * @author Vova Feldman (@svovaf)
14462
+ * @since 1.0.0
14463
+ *
14464
+ * @return string
14465
+ */
14466
+ private function get_top_level_menu_slug() {
14467
+ return ( $this->is_addon() ?
14468
+ $this->get_parent_instance()->_menu->get_top_level_menu_slug() :
14469
+ $this->_menu->get_top_level_menu_slug() );
14470
+ }
14471
+
14472
+ /**
14473
+ * @author Vova Feldman (@svovaf)
14474
+ * @since 1.2.2.7
14475
+ *
14476
+ * @return string
14477
+ */
14478
+ function get_pricing_cta_label() {
14479
+ $label = $this->get_text_inline( 'Upgrade', 'upgrade' );
14480
+
14481
+ if ( $this->is_in_trial_promotion() &&
14482
+ ! $this->is_paying_or_trial()
14483
+ ) {
14484
+ // If running a trial promotion, modify the pricing to load the trial.
14485
+ $label = $this->get_text_inline( 'Start Trial', 'start-trial' );
14486
+ } else if ( $this->is_paying() ) {
14487
+ $label = $this->get_text_inline( 'Pricing', 'pricing' );
14488
+ }
14489
+
14490
+ return $label;
14491
+ }
14492
+
14493
+ /**
14494
+ * @author Vova Feldman (@svovaf)
14495
+ * @since 1.2.2.7
14496
+ *
14497
+ * @return bool
14498
+ */
14499
+ function is_pricing_page_visible() {
14500
+ return (
14501
+ // Has at least one paid plan.
14502
+ $this->has_paid_plan() &&
14503
+ // Didn't ask to hide the pricing page.
14504
+ $this->is_page_visible( 'pricing' ) &&
14505
+ // Don't have a valid active license or has more than one plan.
14506
+ ( ! $this->is_paying() || ! $this->is_single_plan() )
14507
+ );
14508
+ }
14509
+
14510
+ /**
14511
+ * Add default Freemius menu items.
14512
+ *
14513
+ * @author Vova Feldman (@svovaf)
14514
+ * @since 1.0.0
14515
+ * @since 1.2.2.7 Also add submenu items when running in a free .org theme so the tabs will be visible.
14516
+ */
14517
+ private function add_submenu_items() {
14518
+ $this->_logger->entrance();
14519
+
14520
+ if ( $this->is_addon() ) {
14521
+ // No submenu items for add-ons.
14522
+ $add_submenu_items = false;
14523
+ } else if ( $this->is_free_wp_org_theme() && ! fs_is_network_admin() ) {
14524
+ // Also add submenu items when running in a free .org theme so the tabs will be visible.
14525
+ $add_submenu_items = true;
14526
+ } else if ( $this->is_activation_mode() && ! $this->is_free_wp_org_theme() ) {
14527
+ $add_submenu_items = false;
14528
+ } else if ( fs_is_network_admin() ) {
14529
+ /**
14530
+ * Add submenu items to network level when plugin was network
14531
+ * activated and the super-admin did NOT delegated the connection
14532
+ * of all sites to site admins.
14533
+ */
14534
+ $add_submenu_items = (
14535
+ $this->_is_network_active &&
14536
+ ( WP_FS__SHOW_NETWORK_EVEN_WHEN_DELEGATED ||
14537
+ ! $this->is_network_delegated_connection() )
14538
+ );
14539
+ } else {
14540
+ $add_submenu_items = ( ! $this->_is_network_active || $this->is_delegated_connection() );
14541
+ }
14542
+
14543
+ if ( $add_submenu_items ) {
14544
+ if ( $this->has_affiliate_program() ) {
14545
+ // Add affiliation page.
14546
+ $this->add_submenu_item(
14547
+ $this->get_text_inline( 'Affiliation', 'affiliation' ),
14548
+ array( &$this, '_affiliation_page_render' ),
14549
+ $this->get_plugin_name() . ' &ndash; ' . $this->get_text_inline( 'Affiliation', 'affiliation' ),
14550
+ 'manage_options',
14551
+ 'affiliation',
14552
+ 'Freemius::_clean_admin_content_section',
14553
+ WP_FS__DEFAULT_PRIORITY,
14554
+ $this->is_submenu_item_visible( 'affiliation' )
14555
+ );
14556
+ }
14557
+
14558
+ if ( $this->is_registered() ) {
14559
+ $show_account = (
14560
+ $this->is_submenu_item_visible( 'account' ) &&
14561
+ /**
14562
+ * @since 1.2.2.7 Don't show the Account for free WP.org themes without any paid plans.
14563
+ */
14564
+ ( ! $this->is_free_wp_org_theme() || $this->has_paid_plan() )
14565
+ );
14566
+
14567
+ // Add user account page.
14568
+ $this->add_submenu_item(
14569
+ $this->get_text_inline( 'Account', 'account' ),
14570
+ array( &$this, '_account_page_render' ),
14571
+ $this->get_plugin_name() . ' &ndash; ' . $this->get_text_inline( 'Account', 'account' ),
14572
+ 'manage_options',
14573
+ 'account',
14574
+ array( &$this, '_account_page_load' ),
14575
+ WP_FS__DEFAULT_PRIORITY,
14576
+ $show_account
14577
+ );
14578
+ }
14579
+
14580
+ // Add contact page.
14581
+ $this->add_submenu_item(
14582
+ $this->get_text_inline( 'Contact Us', 'contact-us' ),
14583
+ array( &$this, '_contact_page_render' ),
14584
+ $this->get_plugin_name() . ' &ndash; ' . $this->get_text_inline( 'Contact Us', 'contact-us' ),
14585
+ 'manage_options',
14586
+ 'contact',
14587
+ 'Freemius::_clean_admin_content_section',
14588
+ WP_FS__DEFAULT_PRIORITY,
14589
+ $this->is_submenu_item_visible( 'contact' )
14590
+ );
14591
+
14592
+ if ( $this->has_addons() ) {
14593
+ $this->add_submenu_item(
14594
+ $this->get_text_inline( 'Add-Ons', 'add-ons' ),
14595
+ array( &$this, '_addons_page_render' ),
14596
+ $this->get_plugin_name() . ' &ndash; ' . $this->get_text_inline( 'Add-Ons', 'add-ons' ),
14597
+ 'manage_options',
14598
+ 'addons',
14599
+ array( &$this, '_addons_page_load' ),
14600
+ WP_FS__LOWEST_PRIORITY - 1,
14601
+ $this->is_submenu_item_visible( 'addons' )
14602
+ );
14603
+ }
14604
+
14605
+ $show_pricing = (
14606
+ $this->is_submenu_item_visible( 'pricing' ) &&
14607
+ $this->is_pricing_page_visible()
14608
+ );
14609
+
14610
+ $pricing_cta_text = $this->get_pricing_cta_label();
14611
+ $pricing_class = 'upgrade-mode';
14612
+ if ( $show_pricing ) {
14613
+ if ( $this->is_in_trial_promotion() &&
14614
+ ! $this->is_paying_or_trial()
14615
+ ) {
14616
+ // If running a trial promotion, modify the pricing to load the trial.
14617
+ $pricing_class = 'trial-mode';
14618
+ } else if ( $this->is_paying() ) {
14619
+ $pricing_class = '';
14620
+ }
14621
+ }
14622
+
14623
+ // Add upgrade/pricing page.
14624
+ $this->add_submenu_item(
14625
+ $pricing_cta_text . '&nbsp;&nbsp;' . ( is_rtl() ? '&#x2190;' : '&#x27a4;' ),
14626
+ array( &$this, '_pricing_page_render' ),
14627
+ $this->get_plugin_name() . ' &ndash; ' . $this->get_text_x_inline( 'Pricing', 'noun', 'pricing' ),
14628
+ 'manage_options',
14629
+ 'pricing',
14630
+ 'Freemius::_clean_admin_content_section',
14631
+ WP_FS__LOWEST_PRIORITY,
14632
+ $show_pricing,
14633
+ $pricing_class
14634
+ );
14635
+ }
14636
+
14637
+ if ( 0 < count( $this->_menu_items ) ) {
14638
+ if ( ! $this->_menu->is_top_level() ) {
14639
+ fs_enqueue_local_style( 'fs_common', '/admin/common.css' );
14640
+
14641
+ // Append submenu items right after the plugin's submenu item.
14642
+ $this->order_sub_submenu_items();
14643
+ } else {
14644
+ // Append submenu items.
14645
+ $this->embed_submenu_items();
14646
+ }
14647
+ }
14648
+ }
14649
+
14650
+ /**
14651
+ * Moved the actual submenu item additions to a separated function,
14652
+ * in order to support sub-submenu items when the plugin's settings
14653
+ * only have a submenu and not top-level menu item.
14654
+ *
14655
+ * @author Vova Feldman (@svovaf)
14656
+ * @since 1.1.4
14657
+ */
14658
+ private function embed_submenu_items() {
14659
+ $item_template = $this->_menu->is_top_level() ?
14660
+ '<span class="fs-submenu-item %s %s %s">%s</span>' :
14661
+ '<span class="fs-submenu-item fs-sub %s %s %s">%s</span>';
14662
+
14663
+ $top_level_menu_capability = $this->get_top_level_menu_capability();
14664
+
14665
+ ksort( $this->_menu_items );
14666
+
14667
+ $is_first_submenu_item = true;
14668
+
14669
+ foreach ( $this->_menu_items as $priority => $items ) {
14670
+ foreach ( $items as $item ) {
14671
+ if ( $item['show_submenu'] && $is_first_submenu_item ) {
14672
+ if ( $this->_is_network_active && ! empty( $this->_dynamically_added_top_level_page_hook_name ) ) {
14673
+ $item['menu_slug'] = '';
14674
+
14675
+ $this->_menu->override_menu_item( $item['render_function'] );
14676
+ }
14677
+
14678
+ $is_first_submenu_item = false;
14679
+ }
14680
+
14681
+ $capability = ( ! empty( $item['capability'] ) ? $item['capability'] : $top_level_menu_capability );
14682
+
14683
+ $menu_item = sprintf(
14684
+ $item_template,
14685
+ $this->get_unique_affix(),
14686
+ $item['menu_slug'],
14687
+ ! empty( $item['class'] ) ? $item['class'] : '',
14688
+ $item['menu_title']
14689
+ );
14690
+
14691
+ $menu_slug = $this->_menu->get_slug( $item['menu_slug'] );
14692
+
14693
+ if ( ! isset( $item['url'] ) ) {
14694
+ $hook = FS_Admin_Menu_Manager::add_subpage(
14695
+ $item['show_submenu'] ?
14696
+ $this->get_top_level_menu_slug() :
14697
+ null,
14698
+ $item['page_title'],
14699
+ $menu_item,
14700
+ $capability,
14701
+ $menu_slug,
14702
+ $item['render_function']
14703
+ );
14704
+
14705
+ if ( false !== $item['before_render_function'] ) {
14706
+ add_action( "load-$hook", $item['before_render_function'] );
14707
+ }
14708
+ } else {
14709
+ FS_Admin_Menu_Manager::add_subpage(
14710
+ $item['show_submenu'] ?
14711
+ $this->get_top_level_menu_slug() :
14712
+ null,
14713
+ $item['page_title'],
14714
+ $menu_item,
14715
+ $capability,
14716
+ $menu_slug,
14717
+ array( $this, '' )
14718
+ );
14719
+ }
14720
+ }
14721
+ }
14722
+ }
14723
+
14724
+ /**
14725
+ * Re-order the submenu items so all Freemius added new submenu items
14726
+ * are added right after the plugin's settings submenu item.
14727
+ *
14728
+ * @author Vova Feldman (@svovaf)
14729
+ * @since 1.1.4
14730
+ */
14731
+ private function order_sub_submenu_items() {
14732
+ global $submenu;
14733
+
14734
+ $menu_slug = $this->_menu->get_top_level_menu_slug();
14735
+
14736
+ /**
14737
+ * Before "admin_menu" fires, WordPress will loop over the default submenus and remove pages for which the user
14738
+ * does not have permissions. So in case a plugin does not have top-level menu but does have submenus under any
14739
+ * of the default menus, only users that have the right role can access its sub-submenus (Account, Contact Us,
14740
+ * Support Forum, etc.) since $submenu[ $menu_slug ] will be empty if the user doesn't have permission.
14741
+ *
14742
+ * In case a plugin does not have submenus under any of the default menus but does have submenus under the menu
14743
+ * of another plugin, only users that have the right role can access its sub-submenus since we will use the
14744
+ * capability needed to access the parent menu as the capability for the submenus that we will add.
14745
+ */
14746
+ if ( empty( $submenu[ $menu_slug ] ) ) {
14747
+ return;
14748
+ }
14749
+
14750
+ $top_level_menu = &$submenu[ $menu_slug ];
14751
+
14752
+ $all_submenu_items_after = array();
14753
+
14754
+ $found_submenu_item = false;
14755
+
14756
+ foreach ( $top_level_menu as $submenu_id => $meta ) {
14757
+ if ( $found_submenu_item ) {
14758
+ // Remove all submenu items after the plugin's submenu item.
14759
+ $all_submenu_items_after[] = $meta;
14760
+ unset( $top_level_menu[ $submenu_id ] );
14761
+ }
14762
+
14763
+ if ( $this->_menu->get_raw_slug() === $meta[2] ) {
14764
+ // Found the submenu item, put all below.
14765
+ $found_submenu_item = true;
14766
+ continue;
14767
+ }
14768
+ }
14769
+
14770
+ // Embed all plugin's new submenu items.
14771
+ $this->embed_submenu_items();
14772
+
14773
+ // Start with specially high number to make sure it's appended.
14774
+ $i = max( 10000, max( array_keys( $top_level_menu ) ) + 1 );
14775
+ foreach ( $all_submenu_items_after as $meta ) {
14776
+ $top_level_menu[ $i ] = $meta;
14777
+ $i ++;
14778
+ }
14779
+
14780
+ // Sort submenu items.
14781
+ ksort( $top_level_menu );
14782
+ }
14783
+
14784
+ /**
14785
+ * Helper method to return the module's support forum URL.
14786
+ *
14787
+ * @author Vova Feldman (@svovaf)
14788
+ * @since 1.2.2.7
14789
+ *
14790
+ * @return string
14791
+ */
14792
+ function get_support_forum_url() {
14793
+ return $this->apply_filters( 'support_forum_url', "https://wordpress.org/support/{$this->_module_type}/{$this->_slug}" );
14794
+ }
14795
+
14796
+ /**
14797
+ * Displays the Support Forum link when enabled.
14798
+ *
14799
+ * Can be filtered like so:
14800
+ *
14801
+ * function _fs_show_support_menu( $is_visible, $menu_id ) {
14802
+ * if ( 'support' === $menu_id ) {
14803
+ * return _fs->is_registered();
14804
+ * }
14805
+ * return $is_visible;
14806
+ * }
14807
+ * _fs()->add_filter('is_submenu_visible', '_fs_show_support_menu', 10, 2);
14808
+ *
14809
+ */
14810
+ function _add_default_submenu_items() {
14811
+ if ( ! $this->is_on() ) {
14812
+ return;
14813
+ }
14814
+
14815
+ if ( ! $this->is_activation_mode() &&
14816
+ ( ( $this->_is_network_active && fs_is_network_admin() ) ||
14817
+ ( ! $this->_is_network_active && is_admin() ) )
14818
+ ) {
14819
+ $this->add_submenu_link_item(
14820
+ $this->apply_filters( 'support_forum_submenu', $this->get_text_inline( 'Support Forum', 'support-forum' ) ),
14821
+ $this->get_support_forum_url(),
14822
+ 'wp-support-forum',
14823
+ null,
14824
+ 50,
14825
+ $this->is_submenu_item_visible( 'support' )
14826
+ );
14827
+ }
14828
+ }
14829
+
14830
+ /**
14831
+ * @author Vova Feldman (@svovaf)
14832
+ * @since 1.0.1
14833
+ *
14834
+ * @param string $menu_title
14835
+ * @param callable $render_function
14836
+ * @param bool|string $page_title
14837
+ * @param string $capability
14838
+ * @param bool|string $menu_slug
14839
+ * @param bool|callable $before_render_function
14840
+ * @param int $priority
14841
+ * @param bool $show_submenu
14842
+ * @param string $class Since 1.2.1.5 can add custom classes to menu items.
14843
+ */
14844
+ function add_submenu_item(
14845
+ $menu_title,
14846
+ $render_function,
14847
+ $page_title = false,
14848
+ $capability = 'manage_options',
14849
+ $menu_slug = false,
14850
+ $before_render_function = false,
14851
+ $priority = WP_FS__DEFAULT_PRIORITY,
14852
+ $show_submenu = true,
14853
+ $class = ''
14854
+ ) {
14855
+ $this->_logger->entrance( 'Title = ' . $menu_title );
14856
+
14857
+ if ( $this->is_addon() ) {
14858
+ $parent_fs = $this->get_parent_instance();
14859
+
14860
+ if ( is_object( $parent_fs ) ) {
14861
+ $parent_fs->add_submenu_item(
14862
+ $menu_title,
14863
+ $render_function,
14864
+ $page_title,
14865
+ $capability,
14866
+ $menu_slug,
14867
+ $before_render_function,
14868
+ $priority,
14869
+ $show_submenu,
14870
+ $class
14871
+ );
14872
+
14873
+ return;
14874
+ }
14875
+ }
14876
+
14877
+ if ( ! isset( $this->_menu_items[ $priority ] ) ) {
14878
+ $this->_menu_items[ $priority ] = array();
14879
+ }
14880
+
14881
+ $this->_menu_items[ $priority ][] = array(
14882
+ 'page_title' => is_string( $page_title ) ? $page_title : $menu_title,
14883
+ 'menu_title' => $menu_title,
14884
+ 'capability' => $capability,
14885
+ 'menu_slug' => is_string( $menu_slug ) ? $menu_slug : strtolower( $menu_title ),
14886
+ 'render_function' => $render_function,
14887
+ 'before_render_function' => $before_render_function,
14888
+ 'show_submenu' => $show_submenu,
14889
+ 'class' => $class,
14890
+ );
14891
+ }
14892
+
14893
+ /**
14894
+ * @author Vova Feldman (@svovaf)
14895
+ * @since 1.0.1
14896
+ *
14897
+ * @param string $menu_title
14898
+ * @param string $url
14899
+ * @param bool $menu_slug
14900
+ * @param string $capability
14901
+ * @param int $priority
14902
+ * @param bool $show_submenu
14903
+ */
14904
+ function add_submenu_link_item(
14905
+ $menu_title,
14906
+ $url,
14907
+ $menu_slug = false,
14908
+ $capability = 'read',
14909
+ $priority = WP_FS__DEFAULT_PRIORITY,
14910
+ $show_submenu = true
14911
+ ) {
14912
+ $this->_logger->entrance( 'Title = ' . $menu_title . '; Url = ' . $url );
14913
+
14914
+ if ( $this->is_addon() ) {
14915
+ $parent_fs = $this->get_parent_instance();
14916
+
14917
+ if ( is_object( $parent_fs ) ) {
14918
+ $parent_fs->add_submenu_link_item(
14919
+ $menu_title,
14920
+ $url,
14921
+ $menu_slug,
14922
+ $capability,
14923
+ $priority,
14924
+ $show_submenu
14925
+ );
14926
+
14927
+ return;
14928
+ }
14929
+ }
14930
+
14931
+ if ( ! isset( $this->_menu_items[ $priority ] ) ) {
14932
+ $this->_menu_items[ $priority ] = array();
14933
+ }
14934
+
14935
+ $this->_menu_items[ $priority ][] = array(
14936
+ 'menu_title' => $menu_title,
14937
+ 'capability' => $capability,
14938
+ 'menu_slug' => is_string( $menu_slug ) ? $menu_slug : strtolower( $menu_title ),
14939
+ 'url' => $url,
14940
+ 'page_title' => $menu_title,
14941
+ 'render_function' => 'fs_dummy',
14942
+ 'before_render_function' => '',
14943
+ 'show_submenu' => $show_submenu,
14944
+ );
14945
+ }
14946
+
14947
+ #endregion ------------------------------------------------------------------
14948
+
14949
+
14950
+ #--------------------------------------------------------------------------------
14951
+ #region Actions / Hooks / Filters
14952
+ #--------------------------------------------------------------------------------
14953
+
14954
+ /**
14955
+ * @author Vova Feldman (@svovaf)
14956
+ * @since 1.1.7
14957
+ *
14958
+ * @param string $tag
14959
+ *
14960
+ * @return string
14961
+ */
14962
+ public function get_action_tag( $tag ) {
14963
+ return self::get_action_tag_static( $tag, $this->_slug, $this->is_plugin() );
14964
+ }
14965
+
14966
+ /**
14967
+ * @author Vova Feldman (@svovaf)
14968
+ * @since 1.2.1.6
14969
+ *
14970
+ * @param string $tag
14971
+ * @param string $slug
14972
+ * @param bool $is_plugin
14973
+ *
14974
+ * @return string
14975
+ */
14976
+ static function get_action_tag_static( $tag, $slug = '', $is_plugin = true ) {
14977
+ $action = "fs_{$tag}";
14978
+
14979
+ if ( ! empty( $slug ) ) {
14980
+ $action .= '_' . self::get_module_unique_affix( $slug, $is_plugin );
14981
+ }
14982
+
14983
+ return $action;
14984
+ }
14985
+
14986
+ /**
14987
+ * Returns a string that can be used to generate a unique action name,
14988
+ * option name, HTML element ID, or HTML element class.
14989
+ *
14990
+ * @author Leo Fajardo (@leorw)
14991
+ * @since 1.2.2
14992
+ *
14993
+ * @return string
14994
+ */
14995
+ public function get_unique_affix() {
14996
+ return self::get_module_unique_affix( $this->_slug, $this->is_plugin() );
14997
+ }
14998
+
14999
+ /**
15000
+ * Returns a string that can be used to generate a unique action name,
15001
+ * option name, HTML element ID, or HTML element class.
15002
+ *
15003
+ * @author Vova Feldman (@svovaf)
15004
+ * @since 1.2.2.5
15005
+ *
15006
+ * @param string $slug
15007
+ * @param bool $is_plugin
15008
+ *
15009
+ * @return string
15010
+ */
15011
+ static function get_module_unique_affix( $slug, $is_plugin = true ) {
15012
+ $affix = $slug;
15013
+
15014
+ if ( ! $is_plugin ) {
15015
+ $affix .= '-' . WP_FS__MODULE_TYPE_THEME;
15016
+ }
15017
+
15018
+ return $affix;
15019
+ }
15020
+
15021
+ /**
15022
+ * @author Vova Feldman (@svovaf)
15023
+ * @since 1.2.1
15024
+ * @since 1.2.2.5 The AJAX action names are based on the module ID, not like the non-AJAX actions that are
15025
+ * based on the slug for backward compatibility.
15026
+ *
15027
+ * @param string $tag
15028
+ *
15029
+ * @return string
15030
+ */
15031
+ function get_ajax_action( $tag ) {
15032
+ return self::get_ajax_action_static( $tag, $this->_module_id );
15033
+ }
15034
+
15035
+ /**
15036
+ * @author Vova Feldman (@svovaf)
15037
+ * @since 1.2.1.7
15038
+ *
15039
+ * @param string $tag
15040
+ *
15041
+ * @return string
15042
+ */
15043
+ function get_ajax_security( $tag ) {
15044
+ return wp_create_nonce( $this->get_ajax_action( $tag ) );
15045
+ }
15046
+
15047
+ /**
15048
+ * @author Vova Feldman (@svovaf)
15049
+ * @since 1.2.1.7
15050
+ *
15051
+ * @param string $tag
15052
+ */
15053
+ function check_ajax_referer( $tag ) {
15054
+ check_ajax_referer( $this->get_ajax_action( $tag ), 'security' );
15055
+ }
15056
+
15057
+ /**
15058
+ * @author Vova Feldman (@svovaf)
15059
+ * @since 1.2.1.6
15060
+ * @since 1.2.2.5 The AJAX action names are based on the module ID, not like the non-AJAX actions that are
15061
+ * based on the slug for backward compatibility.
15062
+ *
15063
+ * @param string $tag
15064
+ * @param number|null $module_id
15065
+ *
15066
+ * @return string
15067
+ */
15068
+ private static function get_ajax_action_static( $tag, $module_id = null ) {
15069
+ $action = "fs_{$tag}";
15070
+
15071
+ if ( ! empty( $module_id ) ) {
15072
+ $action .= "_{$module_id}";
15073
+ }
15074
+
15075
+ return $action;
15076
+ }
15077
+
15078
+ /**
15079
+ * Do action, specific for the current context plugin.
15080
+ *
15081
+ * @author Vova Feldman (@svovaf)
15082
+ * @since 1.0.1
15083
+ *
15084
+ * @param string $tag The name of the action to be executed.
15085
+ * @param mixed $arg,... Optional. Additional arguments which are passed on to the
15086
+ * functions hooked to the action. Default empty.
15087
+ *
15088
+ * @uses do_action()
15089
+ */
15090
+ function do_action( $tag, $arg = '' ) {
15091
+ $this->_logger->entrance( $tag );
15092
+
15093
+ $args = func_get_args();
15094
+
15095
+ call_user_func_array( 'do_action', array_merge(
15096
+ array( $this->get_action_tag( $tag ) ),
15097
+ array_slice( $args, 1 ) )
15098
+ );
15099
+ }
15100
+
15101
+ /**
15102
+ * Add action, specific for the current context plugin.
15103
+ *
15104
+ * @author Vova Feldman (@svovaf)
15105
+ * @since 1.0.1
15106
+ *
15107
+ * @param string $tag
15108
+ * @param callable $function_to_add
15109
+ * @param int $priority
15110
+ * @param int $accepted_args
15111
+ *
15112
+ * @uses add_action()
15113
+ */
15114
+ function add_action(
15115
+ $tag,
15116
+ $function_to_add,
15117
+ $priority = WP_FS__DEFAULT_PRIORITY,
15118
+ $accepted_args = 1
15119
+ ) {
15120
+ $this->_logger->entrance( $tag );
15121
+
15122
+ add_action( $this->get_action_tag( $tag ), $function_to_add, $priority, $accepted_args );
15123
+ }
15124
+
15125
+ /**
15126
+ * Add AJAX action, specific for the current context plugin.
15127
+ *
15128
+ * @author Vova Feldman (@svovaf)
15129
+ * @since 1.2.1
15130
+ *
15131
+ * @param string $tag
15132
+ * @param callable $function_to_add
15133
+ * @param int $priority
15134
+ *
15135
+ * @uses add_action()
15136
+ *
15137
+ * @return bool True if action added, false if no need to add the action since the AJAX call isn't matching.
15138
+ */
15139
+ function add_ajax_action(
15140
+ $tag,
15141
+ $function_to_add,
15142
+ $priority = WP_FS__DEFAULT_PRIORITY
15143
+ ) {
15144
+ $this->_logger->entrance( $tag );
15145
+
15146
+ return self::add_ajax_action_static(
15147
+ $tag,
15148
+ $function_to_add,
15149
+ $priority,
15150
+ $this->_module_id
15151
+ );
15152
+ }
15153
+
15154
+ /**
15155
+ * Add AJAX action.
15156
+ *
15157
+ * @author Vova Feldman (@svovaf)
15158
+ * @since 1.2.1.6
15159
+ *
15160
+ * @param string $tag
15161
+ * @param callable $function_to_add
15162
+ * @param int $priority
15163
+ * @param number|null $module_id
15164
+ *
15165
+ * @return bool True if action added, false if no need to add the action since the AJAX call isn't matching.
15166
+ * @uses add_action()
15167
+ *
15168
+ */
15169
+ static function add_ajax_action_static(
15170
+ $tag,
15171
+ $function_to_add,
15172
+ $priority = WP_FS__DEFAULT_PRIORITY,
15173
+ $module_id = null
15174
+ ) {
15175
+ self::$_static_logger->entrance( $tag );
15176
+
15177
+ if ( ! self::is_ajax_action_static( $tag, $module_id ) ) {
15178
+ return false;
15179
+ }
15180
+
15181
+ add_action(
15182
+ 'wp_ajax_' . self::get_ajax_action_static( $tag, $module_id ),
15183
+ $function_to_add,
15184
+ $priority,
15185
+ 0
15186
+ );
15187
+
15188
+ self::$_static_logger->info( "$tag AJAX callback action added." );
15189
+
15190
+ return true;
15191
+ }
15192
+
15193
+ /**
15194
+ * Send a JSON response back to an Ajax request.
15195
+ *
15196
+ * @author Vova Feldman (@svovaf)
15197
+ * @since 1.2.1.5
15198
+ *
15199
+ * @param mixed $response
15200
+ */
15201
+ static function shoot_ajax_response( $response ) {
15202
+ wp_send_json( $response );
15203
+ }
15204
+
15205
+ /**
15206
+ * Send a JSON response back to an Ajax request, indicating success.
15207
+ *
15208
+ * @author Vova Feldman (@svovaf)
15209
+ * @since 1.2.1.5
15210
+ *
15211
+ * @param mixed $data Data to encode as JSON, then print and exit.
15212
+ */
15213
+ static function shoot_ajax_success( $data = null ) {
15214
+ wp_send_json_success( $data );
15215
+ }
15216
+
15217
+ /**
15218
+ * Send a JSON response back to an Ajax request, indicating failure.
15219
+ *
15220
+ * @author Vova Feldman (@svovaf)
15221
+ * @since 1.2.1.5
15222
+ *
15223
+ * @param mixed $error Optional error message.
15224
+ */
15225
+ static function shoot_ajax_failure( $error = '' ) {
15226
+ $result = array( 'success' => false );
15227
+ if ( ! empty( $error ) ) {
15228
+ $result['error'] = $error;
15229
+ }
15230
+
15231
+ wp_send_json( $result );
15232
+ }
15233
+
15234
+ /**
15235
+ * Apply filter, specific for the current context plugin.
15236
+ *
15237
+ * @author Vova Feldman (@svovaf)
15238
+ * @since 1.0.9
15239
+ *
15240
+ * @param string $tag The name of the filter hook.
15241
+ * @param mixed $value The value on which the filters hooked to `$tag` are applied on.
15242
+ *
15243
+ * @return mixed The filtered value after all hooked functions are applied to it.
15244
+ *
15245
+ * @uses apply_filters()
15246
+ */
15247
+ function apply_filters( $tag, $value ) {
15248
+ $this->_logger->entrance( $tag );
15249
+
15250
+ $args = func_get_args();
15251
+ array_unshift( $args, $this->get_unique_affix() );
15252
+
15253
+ return call_user_func_array( 'fs_apply_filter', $args );
15254
+ }
15255
+
15256
+ /**
15257
+ * Add filter, specific for the current context plugin.
15258
+ *
15259
+ * @author Vova Feldman (@svovaf)
15260
+ * @since 1.0.9
15261
+ *
15262
+ * @param string $tag
15263
+ * @param callable $function_to_add
15264
+ * @param int $priority
15265
+ * @param int $accepted_args
15266
+ *
15267
+ * @uses add_filter()
15268
+ */
15269
+ function add_filter( $tag, $function_to_add, $priority = WP_FS__DEFAULT_PRIORITY, $accepted_args = 1 ) {
15270
+ $this->_logger->entrance( $tag );
15271
+
15272
+ add_filter( $this->get_action_tag( $tag ), $function_to_add, $priority, $accepted_args );
15273
+ }
15274
+
15275
+ /**
15276
+ * Check if has filter.
15277
+ *
15278
+ * @author Vova Feldman (@svovaf)
15279
+ * @since 1.1.4
15280
+ *
15281
+ * @param string $tag
15282
+ * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
15283
+ *
15284
+ * @return false|int
15285
+ *
15286
+ * @uses has_filter()
15287
+ */
15288
+ function has_filter( $tag, $function_to_check = false ) {
15289
+ $this->_logger->entrance( $tag );
15290
+
15291
+ return has_filter( $this->get_action_tag( $tag ), $function_to_check );
15292
+ }
15293
+
15294
+ #endregion
15295
+
15296
+ /**
15297
+ * Override default i18n text phrases.
15298
+ *
15299
+ * @author Vova Feldman (@svovaf)
15300
+ * @since 1.1.6
15301
+ *
15302
+ * @param string[] string $key_value
15303
+ *
15304
+ * @uses fs_override_i18n()
15305
+ */
15306
+ function override_i18n( $key_value ) {
15307
+ fs_override_i18n( $key_value, $this->_slug );
15308
+ }
15309
+
15310
+ /* Account Page
15311
+ ------------------------------------------------------------------------------------------------------------------*/
15312
+ /**
15313
+ * Update site information.
15314
+ *
15315
+ * @author Vova Feldman (@svovaf)
15316
+ * @since 1.0.1
15317
+ *
15318
+ * @param bool $store Flush to Database if true.
15319
+ * @param null|int $network_level_or_blog_id Since 2.0.0
15320
+ * @param \FS_Site $site Since 2.0.0
15321
+ */
15322
+ private function _store_site( $store = true, $network_level_or_blog_id = null, FS_Site $site = null ) {
15323
+ $this->_logger->entrance();
15324
+
15325
+ if ( empty( $this->_site->id ) ) {
15326
+ $this->_logger->error( "Empty install ID, can't store site." );
15327
+
15328
+ return;
15329
+ }
15330
+
15331
+ $encrypted_site = clone ( is_object( $site ) ? $site : $this->_site );
15332
+
15333
+ $sites = self::get_all_sites( $this->_module_type, $network_level_or_blog_id );
15334
+
15335
+ $prev_stored_user_id = $this->_storage->get( 'prev_user_id', false, $network_level_or_blog_id );
15336
+
15337
+ if ( empty( $prev_stored_user_id ) &&
15338
+ $this->_user->id != $this->_site->user_id
15339
+ ) {
15340
+ /**
15341
+ * Store the current user ID as the previous user ID so that the previous user can be used
15342
+ * as the install's owner while the new owner's details are not yet available.
15343
+ *
15344
+ * This will be executed only in the `replica` site. For example, there are 2 sites, namely `original`
15345
+ * and `replica`, then an ownership change was initiated and completed in the `original`, the `replica`
15346
+ * will be using the previous user until it is updated again (e.g.: until the next clone of `original`
15347
+ * into `replica`.
15348
+ *
15349
  * @author Leo Fajardo (@leorw)
15350
  */
15351
+ $this->_storage->store( 'prev_user_id', $sites[ $this->_slug ]->user_id, $network_level_or_blog_id );
15352
+ }
15353
+
15354
+ $sites[ $this->_slug ] = $encrypted_site;
15355
+
15356
+ $this->set_account_option( 'sites', $sites, $store, $network_level_or_blog_id );
15357
+ }
15358
+
15359
+ /**
15360
+ * Update plugin's plans information.
15361
+ *
15362
+ * @author Vova Feldman (@svovaf)
15363
+ * @since 1.0.2
15364
+ *
15365
+ * @param bool $store Flush to Database if true.
15366
+ */
15367
+ private function _store_plans( $store = true ) {
15368
+ $this->_logger->entrance();
15369
+
15370
+ $plans = self::get_all_plans( $this->_module_type );
15371
+
15372
+ // Copy plans.
15373
+ $encrypted_plans = array();
15374
+ for ( $i = 0, $len = count( $this->_plans ); $i < $len; $i ++ ) {
15375
+ $encrypted_plans[] = self::_encrypt_entity( $this->_plans[ $i ] );
15376
+ }
15377
+
15378
+ $plans[ $this->_slug ] = $encrypted_plans;
15379
+
15380
+ $this->set_account_option( 'plans', $plans, $store );
15381
+ }
15382
+
15383
+ /**
15384
+ * Update user's plugin licenses.
15385
+ *
15386
+ * @author Vova Feldman (@svovaf)
15387
+ * @since 1.0.5
15388
+ *
15389
+ * @param bool $store
15390
+ * @param number|bool $module_id
15391
+ * @param FS_Plugin_License[] $licenses
15392
+ */
15393
+ private function _store_licenses( $store = true, $module_id = false, $licenses = array() ) {
15394
+ $this->_logger->entrance();
15395
+
15396
+ $all_licenses = self::get_all_licenses();
15397
+
15398
+ if ( ! FS_Plugin::is_valid_id( $module_id ) ) {
15399
+ $module_id = $this->_module_id;
15400
+
15401
+ $user_licenses = is_array( $this->_licenses ) ?
15402
+ $this->_licenses :
15403
+ array();
15404
+
15405
+ if ( empty( $user_licenses ) ) {
15406
+ // If the context user doesn't have any license, don't update the licenses collection.
15407
+ return;
15408
+ }
15409
+
15410
+ $new_user_licenses_map = array();
15411
+ foreach ( $user_licenses as $user_license ) {
15412
+ $new_user_licenses_map[ $user_license->id ] = $user_license;
15413
+ }
15414
+
15415
+ self::store_user_id_license_ids_map( array_keys( $new_user_licenses_map ), $this->_module_id, $this->_user->id );
15416
+
15417
+ // Update user licenses.
15418
+ $licenses_to_update_count = count( $new_user_licenses_map );
15419
+ foreach ( $all_licenses[ $module_id ] as $key => $license ) {
15420
+ if ( 0 === $licenses_to_update_count ) {
15421
+ break;
15422
+ }
15423
+
15424
+ if ( isset( $new_user_licenses_map[ $license->id ] ) ) {
15425
+ // Update license.
15426
+ $all_licenses[ $module_id ][ $key ] = $new_user_licenses_map[ $license->id ];
15427
+ unset( $new_user_licenses_map[ $license->id ] );
15428
+
15429
+ $licenses_to_update_count --;
15430
+ }
15431
+ }
15432
+
15433
+ if ( ! empty( $new_user_licenses_map ) ) {
15434
+ // Add new licenses.
15435
+ $all_licenses[ $module_id ] = array_merge( array_values( $new_user_licenses_map ), $all_licenses[ $module_id ] );
15436
+ }
15437
+
15438
+ $licenses = $all_licenses[ $module_id ];
15439
+ }
15440
+
15441
+ if ( ! isset( $all_licenses[ $module_id ] ) ) {
15442
+ $all_licenses[ $module_id ] = array();
15443
+ }
15444
+
15445
+ $all_licenses[ $module_id ] = $licenses;
15446
+
15447
+ self::$_accounts->set_option( 'all_licenses', $all_licenses, $store );
15448
+ }
15449
+
15450
+ /**
15451
+ * Update user information.
15452
+ *
15453
+ * @author Vova Feldman (@svovaf)
15454
+ * @since 1.0.1
15455
+ *
15456
+ * @param bool $store Flush to Database if true.
15457
+ */
15458
+ private function _store_user( $store = true ) {
15459
+ $this->_logger->entrance();
15460
+
15461
+ if ( empty( $this->_user->id ) ) {
15462
+ $this->_logger->error( "Empty user ID, can't store user." );
15463
+
15464
+ return;
15465
+ }
15466
+
15467
+ $users = self::get_all_users();
15468
+ $users[ $this->_user->id ] = $this->_user;
15469
+ self::$_accounts->set_option( 'users', $users, $store );
15470
+ }
15471
+
15472
+ /**
15473
+ * Update new updates information.
15474
+ *
15475
+ * @author Vova Feldman (@svovaf)
15476
+ * @since 1.0.4
15477
+ *
15478
+ * @param FS_Plugin_Tag|null $update
15479
+ * @param bool $store Flush to Database if true.
15480
+ * @param bool|number $plugin_id
15481
+ */
15482
+ private function _store_update( $update, $store = true, $plugin_id = false ) {
15483
+ $this->_logger->entrance();
15484
+
15485
+ if ( $update instanceof FS_Plugin_Tag ) {
15486
+ $update->updated = time();
15487
+ }
15488
+
15489
+ if ( ! is_numeric( $plugin_id ) ) {
15490
+ $plugin_id = $this->_plugin->id;
15491
+ }
15492
+
15493
+ $updates = self::get_all_updates();
15494
+ $updates[ $plugin_id ] = $update;
15495
+ self::$_accounts->set_option( 'updates', $updates, $store );
15496
+ }
15497
+
15498
+ /**
15499
+ * Update new updates information.
15500
+ *
15501
+ * @author Vova Feldman (@svovaf)
15502
+ * @since 1.0.6
15503
+ *
15504
+ * @param FS_Plugin[] $plugin_addons
15505
+ * @param bool $store Flush to Database if true.
15506
+ */
15507
+ private function _store_addons( $plugin_addons, $store = true ) {
15508
+ $this->_logger->entrance();
15509
+
15510
+ $addons = self::get_all_addons();
15511
+ $addons[ $this->_plugin->id ] = $plugin_addons;
15512
+ self::$_accounts->set_option( 'addons', $addons, $store );
15513
+ }
15514
+
15515
+ /**
15516
+ * Delete plugin's associated add-ons.
15517
+ *
15518
+ * @author Vova Feldman (@svovaf)
15519
+ * @since 1.0.8
15520
+ *
15521
+ * @param bool $store
15522
+ *
15523
+ * @return bool
15524
+ */
15525
+ private function _delete_account_addons( $store = true ) {
15526
+ $all_addons = self::get_all_account_addons();
15527
+
15528
+ if ( ! isset( $all_addons[ $this->_plugin->id ] ) ) {
15529
+ return false;
15530
+ }
15531
+
15532
+ unset( $all_addons[ $this->_plugin->id ] );
15533
+
15534
+ self::$_accounts->set_option( 'account_addons', $all_addons, $store );
15535
+
15536
+ return true;
15537
+ }
15538
+
15539
+ /**
15540
+ * Update account add-ons list.
15541
+ *
15542
+ * @author Vova Feldman (@svovaf)
15543
+ * @since 1.0.6
15544
+ *
15545
+ * @param FS_Plugin[] $addons
15546
+ * @param bool $store Flush to Database if true.
15547
+ */
15548
+ private function _store_account_addons( $addons, $store = true ) {
15549
+ $this->_logger->entrance();
15550
+
15551
+ $all_addons = self::get_all_account_addons();
15552
+ $all_addons[ $this->_plugin->id ] = $addons;
15553
+ self::$_accounts->set_option( 'account_addons', $all_addons, $store );
15554
+ }
15555
+
15556
+ /**
15557
+ * Store account params in the Database.
15558
+ *
15559
+ * @author Vova Feldman (@svovaf)
15560
+ * @since 1.0.1
15561
+ *
15562
+ * @param null|int $blog_id Since 2.0.0
15563
+ */
15564
+ private function _store_account( $blog_id = null ) {
15565
+ $this->_logger->entrance();
15566
+
15567
+ $this->_store_site( false, $blog_id );
15568
+ $this->_store_user( false );
15569
+ $this->_store_plans( false );
15570
+ $this->_store_licenses( false );
15571
+
15572
+ self::$_accounts->store( $blog_id );
15573
+ }
15574
+
15575
+ /**
15576
+ * Sync user's information.
15577
+ *
15578
+ * @author Vova Feldman (@svovaf)
15579
+ * @since 1.0.3
15580
+ * @uses FS_Api
15581
+ */
15582
+ private function _handle_account_user_sync() {
15583
+ $this->_logger->entrance();
15584
+
15585
+ $api = $this->get_api_user_scope();
15586
+
15587
+ // Get user's information.
15588
+ $user = $api->get( '/', true );
15589
+
15590
+ if ( isset( $user->id ) ) {
15591
+ $this->_user->first = $user->first;
15592
+ $this->_user->last = $user->last;
15593
+ $this->_user->email = $user->email;
15594
+
15595
+ $is_menu_item_account_visible = $this->is_submenu_item_visible( 'account' );
15596
+
15597
+ if ( $user->is_verified &&
15598
+ ( ! isset( $this->_user->is_verified ) || false === $this->_user->is_verified )
15599
+ ) {
15600
+ $this->_user->is_verified = true;
15601
+
15602
+ $this->do_action( 'account_email_verified', $user->email );
15603
+
15604
+ $this->_admin_notices->add(
15605
+ $this->get_text_inline( 'Your email has been successfully verified - you are AWESOME!', 'email-verified-message' ),
15606
+ $this->get_text_x_inline( 'Right on', 'a positive response', 'right-on' ) . '!',
15607
+ 'success',
15608
+ // Make admin sticky if account menu item is invisible,
15609
+ // since the page will be auto redirected to the plugin's
15610
+ // main settings page, and the non-sticky message
15611
+ // will disappear.
15612
+ ! $is_menu_item_account_visible,
15613
+ 'email_verified'
15614
+ );
15615
+ }
15616
+
15617
+ // Flush user details to DB.
15618
+ $this->_store_user();
15619
+
15620
+ $this->do_action( 'after_account_user_sync', $user );
15621
+
15622
+ /**
15623
+ * If account menu item is hidden, redirect to plugin's main settings page.
15624
+ *
15625
+ * @author Vova Feldman (@svovaf)
15626
+ * @since 1.1.6
15627
+ *
15628
+ * @link https://github.com/Freemius/wordpress-sdk/issues/6
15629
+ */
15630
+ if ( ! $is_menu_item_account_visible ) {
15631
+ fs_redirect( $this->_get_admin_page_url() );
15632
+ }
15633
+ }
15634
+ }
15635
+
15636
+ /**
15637
+ * @author Vova Feldman (@svovaf)
15638
+ * @since 1.0.9
15639
+ * @uses FS_Api
15640
+ *
15641
+ * @param number|bool $license_id
15642
+ *
15643
+ * @return FS_Subscription|object|bool
15644
+ */
15645
+ private function _fetch_site_license_subscription( $license_id = false ) {
15646
+ $this->_logger->entrance();
15647
+ $api = $this->get_api_site_scope();
15648
+
15649
+ if ( ! is_numeric( $license_id ) ) {
15650
+ $license_id = $this->_license->id;
15651
+ }
15652
+
15653
+ $result = $api->get( "/licenses/{$license_id}/subscriptions.json", true );
15654
+
15655
+ return ! isset( $result->error ) ?
15656
+ ( ( is_array( $result->subscriptions ) && 0 < count( $result->subscriptions ) ) ?
15657
+ new FS_Subscription( $result->subscriptions[0] ) :
15658
+ false
15659
+ ) :
15660
+ $result;
15661
+ }
15662
+
15663
+ /**
15664
+ * @author Vova Feldman (@svovaf)
15665
+ * @since 1.0.4
15666
+ * @uses FS_Api
15667
+ *
15668
+ * @param number|bool $plan_id
15669
+ *
15670
+ * @return FS_Plugin_Plan|object
15671
+ */
15672
+ private function _fetch_site_plan( $plan_id = false ) {
15673
+ $this->_logger->entrance();
15674
+ $api = $this->get_api_site_scope();
15675
+
15676
+ if ( ! is_numeric( $plan_id ) ) {
15677
+ $plan_id = $this->_site->plan_id;
15678
+ }
15679
+
15680
+ $plan = $api->get( "/plans/{$plan_id}.json", true );
15681
+
15682
+ return ! isset( $plan->error ) ? new FS_Plugin_Plan( $plan ) : $plan;
15683
+ }
15684
+
15685
+ /**
15686
+ * @author Vova Feldman (@svovaf)
15687
+ * @since 1.0.5
15688
+ * @uses FS_Api
15689
+ *
15690
+ * @return FS_Plugin_Plan[]|object
15691
+ */
15692
+ private function _fetch_plugin_plans() {
15693
+ $this->_logger->entrance();
15694
+ $api = $this->get_current_or_network_user_api_scope();
15695
+
15696
+ /**
15697
+ * @since 1.2.3 When running in DEV mode, retrieve pending plans as well.
15698
+ */
15699
+ $result = $api->get( "/plugins/{$this->_module_id}/plans.json?show_pending=" . ( $this->has_secret_key() ? 'true' : 'false' ), true );
15700
+
15701
+ if ( $this->is_api_result_object( $result, 'plans' ) && is_array( $result->plans ) ) {
15702
+ for ( $i = 0, $len = count( $result->plans ); $i < $len; $i ++ ) {
15703
+ $result->plans[ $i ] = new FS_Plugin_Plan( $result->plans[ $i ] );
15704
+ }
15705
+
15706
+ $result = $result->plans;
15707
+ }
15708
+
15709
+ return $result;
15710
+ }
15711
+
15712
+ /**
15713
+ * @author Vova Feldman (@svovaf)
15714
+ * @since 2.0.0
15715
+ *
15716
+ * @param number $plan_id
15717
+ *
15718
+ * @return \FS_Plugin_Plan|object
15719
+ */
15720
+ private function fetch_plan_by_id( $plan_id ) {
15721
+ $this->_logger->entrance();
15722
+ $api = $this->get_current_or_network_user_api_scope();
15723
+
15724
+ $result = $api->get( "/plugins/{$this->_module_id}/plans/{$plan_id}.json", true );
15725
+
15726
+ return $this->is_api_result_entity( $result ) ?
15727
+ new FS_Plugin_Plan( $result ) :
15728
+ $result;
15729
+ }
15730
+
15731
+ /**
15732
+ * @author Vova Feldman (@svovaf)
15733
+ * @since 1.0.5
15734
+ * @uses FS_Api
15735
+ *
15736
+ * @param number|bool $plugin_id
15737
+ * @param number|bool $site_license_id
15738
+ * @param array $foreign_licenses @since 2.0.0. This is used by network-activated plugins.
15739
+ * @param number|null $blog_id
15740
+ *
15741
+ * @return FS_Plugin_License[]|object
15742
+ */
15743
+ private function _fetch_licenses(
15744
+ $plugin_id = false,
15745
+ $site_license_id = false,
15746
+ $foreign_licenses = array(),
15747
+ $blog_id = null
15748
+ ) {
15749
+ $this->_logger->entrance();
15750
+
15751
+ $api = $this->get_api_user_scope();
15752
+
15753
+ if ( ! is_numeric( $plugin_id ) ) {
15754
+ $plugin_id = $this->_plugin->id;
15755
+ }
15756
+
15757
+ $user_licenses_endpoint = "/plugins/{$plugin_id}/licenses.json";
15758
+ if ( ! empty ( $foreign_licenses ) ) {
15759
+ $foreign_licenses = array(
15760
+ // Prefix with `+` to tell the server to include foreign licenses in the licenses collection.
15761
+ 'ids' => ( urlencode( '+' ) . implode( ',', $foreign_licenses['ids'] ) ),
15762
+ 'license_keys' => implode( ',', array_map( 'urlencode', $foreign_licenses['license_keys'] ) )
15763
+ );
15764
+
15765
+ $user_licenses_endpoint = add_query_arg( $foreign_licenses, $user_licenses_endpoint );
15766
+ }
15767
+
15768
+ $result = $api->get( $user_licenses_endpoint, true );
15769
+
15770
+ $is_site_license_synced = false;
15771
+
15772
+ $api_errors = array();
15773
+
15774
+ if ( $this->is_api_result_object( $result, 'licenses' ) &&
15775
+ is_array( $result->licenses )
15776
+ ) {
15777
+ for ( $i = 0, $len = count( $result->licenses ); $i < $len; $i ++ ) {
15778
+ $result->licenses[ $i ] = new FS_Plugin_License( $result->licenses[ $i ] );
15779
+
15780
+ if ( ( ! $is_site_license_synced ) && is_numeric( $site_license_id ) ) {
15781
+ $is_site_license_synced = ( $site_license_id == $result->licenses[ $i ]->id );
15782
+ }
15783
+ }
15784
+
15785
+ $result = $result->licenses;
15786
+ } else {
15787
+ $api_errors[] = $result;
15788
+ $result = array();
15789
+ }
15790
+
15791
+ if ( ! $is_site_license_synced ) {
15792
+ if ( ! is_null( $blog_id ) ) {
15793
+ /**
15794
+ * If blog ID is not null, the request is for syncing of the license of a single site via the
15795
+ * network-level "Account" page.
15796
+ *
15797
+ * @author Leo Fajardo (@leorw)
15798
+ */
15799
+ $this->switch_to_blog( $blog_id );
15800
+ }
15801
+
15802
+ $api = $this->get_api_site_scope();
15803
+
15804
+ if ( is_numeric( $site_license_id ) ) {
15805
+ // Try to retrieve a foreign license that is linked to the install.
15806
+ $api_result = $api->call( '/licenses.json' );
15807
+
15808
+ if ( $this->is_api_result_object( $api_result, 'licenses' ) &&
15809
+ is_array( $api_result->licenses )
15810
+ ) {
15811
+ $licenses = $api_result->licenses;
15812
+
15813
+ if ( ! empty( $licenses ) ) {
15814
+ $result[] = new FS_Plugin_License( $licenses[0] );
15815
+ }
15816
+ } else {
15817
+ $api_errors[] = $api_result;
15818
+ }
15819
+ } else if ( is_object( $this->_license ) ) {
15820
+ $is_license_in_result = false;
15821
+ if ( ! empty( $result ) ) {
15822
+ foreach ( $result as $license ) {
15823
+ if ( $license->id == $this->_license->id ) {
15824
+ $is_license_in_result = true;
15825
+ break;
15826
+ }
15827
+ }
15828
+ }
15829
+
15830
+ if ( ! $is_license_in_result ) {
15831
+ // Fetch foreign license by ID and license key.
15832
+ $license = $api->get( "/licenses/{$this->_license->id}.json?license_key=" .
15833
+ urlencode( $this->_license->secret_key ) );
15834
+
15835
+ if ( $this->is_api_result_entity( $license ) ) {
15836
+ $result[] = new FS_Plugin_License( $license );
15837
+ } else {
15838
+ $api_errors[] = $license;
15839
+ }
15840
+ }
15841
+ }
15842
+
15843
+ if ( ! is_null( $blog_id ) ) {
15844
+ $this->switch_to_blog( $this->_storage->network_install_blog_id );
15845
+ }
15846
+ }
15847
+
15848
+ if ( is_array( $result ) && 0 < count( $result ) ) {
15849
+ // If found at least one license, return license collection even if there are errors.
15850
+ return $result;
15851
+ }
15852
+
15853
+ if ( ! empty( $api_errors ) ) {
15854
+ // If found any errors and no licenses, return first error.
15855
+ return $api_errors[0];
15856
+ }
15857
+
15858
+ // Fallback to empty licenses list.
15859
+ return $result;
15860
+ }
15861
+
15862
+ /**
15863
+ * @author Vova Feldman (@svovaf)
15864
+ * @since 2.0.0
15865
+ *
15866
+ * @param number $license_id
15867
+ * @param string $license_key
15868
+ *
15869
+ * @return \FS_Plugin_License|object
15870
+ */
15871
+ private function fetch_license_by_key( $license_id, $license_key ) {
15872
+ $this->_logger->entrance();
15873
+
15874
+ $api = $this->get_current_or_network_user_api_scope();
15875
+
15876
+ $result = $api->get( "/licenses/{$license_id}.json?license_key=" . urlencode( $license_key ) );
15877
+
15878
+ return $this->is_api_result_entity( $result ) ?
15879
+ new FS_Plugin_License( $result ) :
15880
+ $result;
15881
+ }
15882
+
15883
+ /**
15884
+ * @author Vova Feldman (@svovaf)
15885
+ * @since 1.2.0
15886
+ * @uses FS_Api
15887
+ *
15888
+ * @param number|bool $plugin_id
15889
+ * @param bool $flush
15890
+ *
15891
+ * @return FS_Payment[]|object
15892
+ */
15893
+ function _fetch_payments( $plugin_id = false, $flush = false ) {
15894
+ $this->_logger->entrance();
15895
+
15896
+ $api = $this->get_api_user_scope();
15897
+
15898
+ if ( ! is_numeric( $plugin_id ) ) {
15899
+ $plugin_id = $this->_plugin->id;
15900
+ }
15901
+
15902
+ $result = $api->get( "/plugins/{$plugin_id}/payments.json?include_addons=true", $flush );
15903
+
15904
+ if ( ! isset( $result->error ) ) {
15905
+ for ( $i = 0, $len = count( $result->payments ); $i < $len; $i ++ ) {
15906
+ $result->payments[ $i ] = new FS_Payment( $result->payments[ $i ] );
15907
+ }
15908
+ $result = $result->payments;
15909
+ }
15910
+
15911
+ return $result;
15912
+ }
15913
+
15914
+ /**
15915
+ * @author Vova Feldman (@svovaf)
15916
+ * @since 1.2.1.5
15917
+ * @uses FS_Api
15918
+ *
15919
+ * @param bool $flush
15920
+ *
15921
+ * @return \FS_Billing|mixed
15922
+ */
15923
+ function _fetch_billing( $flush = false ) {
15924
+ require_once WP_FS__DIR_INCLUDES . '/entities/class-fs-billing.php';
15925
+
15926
+ $billing = $this->get_api_user_scope()->get( 'billing.json', $flush );
15927
+
15928
+ if ( $this->is_api_result_entity( $billing ) ) {
15929
+ $billing = new FS_Billing( $billing );
15930
+ }
15931
+
15932
+ return $billing;
15933
+ }
15934
+
15935
+ /**
15936
+ * @author Vova Feldman (@svovaf)
15937
+ * @since 1.0.5
15938
+ *
15939
+ * @param FS_Plugin_License[] $licenses
15940
+ * @param number $module_id
15941
+ */
15942
+ private function _update_licenses( $licenses, $module_id ) {
15943
+ $this->_logger->entrance();
15944
+
15945
+ if ( is_array( $licenses ) ) {
15946
+ for ( $i = 0, $len = count( $licenses ); $i < $len; $i ++ ) {
15947
+ $licenses[ $i ]->updated = time();
15948
+ }
15949
+ }
15950
+
15951
+ $this->_store_licenses( true, $module_id, $licenses );
15952
+ }
15953
+
15954
+ /**
15955
+ * @author Vova Feldman (@svovaf)
15956
+ * @since 1.0.4
15957
+ *
15958
+ * @param bool|number $plugin_id
15959
+ * @param bool $flush Since 1.1.7.3
15960
+ * @param int $expiration Since 1.2.2.7
15961
+ *
15962
+ * @return object|false New plugin tag info if exist.
15963
+ */
15964
+ private function _fetch_newer_version( $plugin_id = false, $flush = true, $expiration = WP_FS__TIME_24_HOURS_IN_SEC ) {
15965
+ $latest_tag = $this->_fetch_latest_version( $plugin_id, $flush, $expiration );
15966
+
15967
+ if ( ! is_object( $latest_tag ) ) {
15968
+ return false;
15969
+ }
15970
+
15971
+ // Check if version is actually newer.
15972
+ $has_new_version =
15973
+ // If it's an non-installed add-on then always return latest.
15974
+ ( $this->_is_addon_id( $plugin_id ) && ! $this->is_addon_activated( $plugin_id ) ) ||
15975
+ // Compare versions.
15976
+ version_compare( $this->get_plugin_version(), $latest_tag->version, '<' );
15977
+
15978
+ $this->_logger->departure( $has_new_version ? 'Found newer plugin version ' . $latest_tag->version : 'No new version' );
15979
+
15980
+ return $has_new_version ? $latest_tag : false;
15981
+ }
15982
+
15983
+ /**
15984
+ * @author Vova Feldman (@svovaf)
15985
+ * @since 1.0.5
15986
+ *
15987
+ * @param bool|number $plugin_id
15988
+ * @param bool $flush Since 1.1.7.3
15989
+ * @param int $expiration Since 1.2.2.7
15990
+ *
15991
+ * @return bool|FS_Plugin_Tag
15992
+ */
15993
+ function get_update( $plugin_id = false, $flush = true, $expiration = WP_FS__TIME_24_HOURS_IN_SEC ) {
15994
+ $this->_logger->entrance();
15995
+
15996
+ if ( ! is_numeric( $plugin_id ) ) {
15997
+ $plugin_id = $this->_plugin->id;
15998
+ }
15999
+
16000
+ $this->check_updates( true, $plugin_id, $flush, $expiration );
16001
+ $updates = $this->get_all_updates();
16002
+
16003
+ return isset( $updates[ $plugin_id ] ) && is_object( $updates[ $plugin_id ] ) ? $updates[ $plugin_id ] : false;
16004
+ }
16005
+
16006
+ /**
16007
+ * Check if site assigned with active license.
16008
+ *
16009
+ * @author Vova Feldman (@svovaf)
16010
+ * @since 1.0.6
16011
+ *
16012
+ * @deprecated Please use has_active_valid_license() instead because license can be cancelled.
16013
+ */
16014
+ function has_active_license() {
16015
+ return (
16016
+ is_object( $this->_license ) &&
16017
+ is_numeric( $this->_license->id ) &&
16018
+ ! $this->_license->is_expired()
16019
+ );
16020
+ }
16021
+
16022
+ /**
16023
+ * Check if site assigned with active & valid (not expired) license.
16024
+ *
16025
+ * @author Vova Feldman (@svovaf)
16026
+ * @since 1.2.1
16027
+ */
16028
+ function has_active_valid_license() {
16029
+ return (
16030
+ is_object( $this->_license ) &&
16031
+ is_numeric( $this->_license->id ) &&
16032
+ $this->_license->is_active() &&
16033
+ $this->_license->is_valid()
16034
+ );
16035
+ }
16036
+
16037
+ /**
16038
+ * Check if site assigned with license with enabled features.
16039
+ *
16040
+ * @author Vova Feldman (@svovaf)
16041
+ * @since 1.0.6
16042
+ *
16043
+ * @return bool
16044
+ */
16045
+ function has_features_enabled_license() {
16046
+ return (
16047
+ is_object( $this->_license ) &&
16048
+ is_numeric( $this->_license->id ) &&
16049
+ $this->_license->is_features_enabled()
16050
+ );
16051
+ }
16052
+
16053
+ /**
16054
+ * Check if user is a trial or have feature enabled license.
16055
+ *
16056
+ * @author Vova Feldman (@svovaf)
16057
+ * @since 1.1.7
16058
+ *
16059
+ * @return bool
16060
+ */
16061
+ function can_use_premium_code() {
16062
+ return $this->is_trial() || $this->has_features_enabled_license();
16063
+ }
16064
+
16065
+ /**
16066
+ * Checks if the current user can activate plugins or switch themes. Note that this method should only be used
16067
+ * after the `init` action is triggered because it is using `current_user_can()` which is only functional after
16068
+ * the context user is authenticated.
16069
+ *
16070
+ * @author Leo Fajardo (@leorw)
16071
+ * @since 1.2.2
16072
+ *
16073
+ * @return bool
16074
+ */
16075
+ function is_user_admin() {
16076
+ /**
16077
+ * Require a super-admin when network activated, running from the network level OR if
16078
+ * running from the site level but not delegated the opt-in.
16079
+ *
16080
+ * @author Vova Feldman (@svovaf)
16081
+ * @since 2.0.0
16082
+ */
16083
+ if ( $this->_is_network_active &&
16084
+ ( fs_is_network_admin() || ! $this->is_delegated_connection() )
16085
+ ) {
16086
+ return is_super_admin();
16087
+ }
16088
+
16089
+ return ( $this->is_plugin() && current_user_can( is_multisite() ? 'manage_options' : 'activate_plugins' ) )
16090
+ || ( $this->is_theme() && current_user_can( 'switch_themes' ) );
16091
+ }
16092
+
16093
+ /**
16094
+ * Sync site's plan.
16095
+ *
16096
+ * @author Vova Feldman (@svovaf)
16097
+ * @since 1.0.3
16098
+ *
16099
+ * @uses FS_Api
16100
+ *
16101
+ * @param bool $background Hints the method if it's a background sync. If false, it means that was initiated by
16102
+ * the admin.
16103
+ * @param bool $is_context_single_site @since 2.0.0. This is used when syncing a license for a single install from the
16104
+ * network-level "Account" page.
16105
+ */
16106
+ private function _sync_license( $background = false, $is_context_single_site = false ) {
16107
+ $this->_logger->entrance();
16108
+
16109
+ $plugin_id = fs_request_get( 'plugin_id', $this->get_id() );
16110
+
16111
+ $is_addon_sync = ( ! $this->_plugin->is_addon() && $plugin_id != $this->get_id() );
16112
+
16113
+ if ( $is_addon_sync ) {
16114
+ $this->_sync_addon_license( $plugin_id, $background );
16115
+ } else {
16116
+ $this->_sync_plugin_license( $background, true, $is_context_single_site );
16117
+ }
16118
+
16119
+ $this->do_action( 'after_account_plan_sync', $this->get_plan_name() );
16120
+ }
16121
+
16122
+ /**
16123
+ * Sync plugin's add-on license.
16124
+ *
16125
+ * @author Vova Feldman (@svovaf)
16126
+ * @since 1.0.6
16127
+ * @uses FS_Api
16128
+ *
16129
+ * @param number $addon_id
16130
+ * @param bool $background
16131
+ */
16132
+ private function _sync_addon_license( $addon_id, $background ) {
16133
+ $this->_logger->entrance();
16134
+
16135
+ if ( $this->is_addon_activated( $addon_id ) ) {
16136
+ // If already installed, use add-on sync.
16137
+ $fs_addon = self::get_instance_by_id( $addon_id );
16138
+ $fs_addon->_sync_license( $background );
16139
+
16140
+ return;
16141
+ }
16142
+
16143
+ // Validate add-on exists.
16144
+ $addon = $this->get_addon( $addon_id );
16145
+
16146
+ if ( ! is_object( $addon ) ) {
16147
+ return;
16148
+ }
16149
+
16150
+ // Add add-on into account add-ons.
16151
+ $account_addons = $this->get_account_addons();
16152
+ if ( ! is_array( $account_addons ) ) {
16153
+ $account_addons = array();
16154
+ }
16155
+ $account_addons[] = $addon->id;
16156
+ $account_addons = array_unique( $account_addons );
16157
+ $this->_store_account_addons( $account_addons );
16158
+
16159
+ // Load add-on licenses.
16160
+ $licenses = $this->_fetch_licenses( $addon->id );
16161
+
16162
+ // Sync add-on licenses.
16163
+ if ( $this->is_array_instanceof( $licenses, 'FS_Plugin_License' ) ) {
16164
+ $this->_update_licenses( $licenses, $addon->id );
16165
+
16166
+ if ( ! $this->is_addon_installed( $addon->id ) && FS_License_Manager::has_premium_license( $licenses ) ) {
16167
+ $plans_result = $this->get_api_site_or_plugin_scope()->get( "/addons/{$addon_id}/plans.json" );
16168
+
16169
+ if ( ! isset( $plans_result->error ) ) {
16170
+ $plans = array();
16171
+ foreach ( $plans_result->plans as $plan ) {
16172
+ $plans[] = new FS_Plugin_Plan( $plan );
16173
+ }
16174
+
16175
+ $this->_admin_notices->add_sticky(
16176
+ sprintf(
16177
+ ( FS_Plan_Manager::instance()->has_free_plan( $plans ) ?
16178
+ $this->get_text_inline( 'Your %s Add-on plan was successfully upgraded.', 'addon-successfully-upgraded-message' ) :
16179
+ /* translators: %s:product name, e.g. Facebook add-on was successfully... */
16180
+ $this->get_text_inline( '%s Add-on was successfully purchased.', 'addon-successfully-purchased-message' ) ),
16181
+ $addon->title
16182
+ ) . ' ' . $this->get_latest_download_link(
16183
+ $this->get_text_inline( 'Download the latest version', 'download-latest-version' ),
16184
+ $addon_id
16185
+ ),
16186
+ 'addon_plan_upgraded_' . $addon->slug,
16187
+ $this->get_text_x_inline( 'Yee-haw', 'interjection expressing joy or exuberance', 'yee-haw' ) . '!'
16188
+ );
16189
+ }
16190
+ }
16191
+ }
16192
+ }
16193
+
16194
+ /**
16195
+ * Sync site's plugin plan.
16196
+ *
16197
+ * @author Vova Feldman (@svovaf)
16198
+ * @since 1.0.6
16199
+ * @uses FS_Api
16200
+ *
16201
+ * @param bool $background Hints the method if it's a background sync. If false, it means that was initiated by the admin.
16202
+ * @param bool $send_installs_update Since 2.0.0
16203
+ * @param bool $is_context_single_site Since 2.0.0. This is used when sending an update for a single install and
16204
+ * syncing its license from the network-level "Account" page (e.g.: after
16205
+ * activating a license only for the single install).
16206
+ */
16207
+ private function _sync_plugin_license(
16208
+ $background = false,
16209
+ $send_installs_update = true,
16210
+ $is_context_single_site = false
16211
+ ) {
16212
+ $this->_logger->entrance();
16213
+
16214
+ $plan_change = 'none';
16215
+
16216
+ $is_site_level_sync = ( $is_context_single_site || fs_is_blog_admin() || ! $this->_is_network_active );
16217
+
16218
+ if ( ! $send_installs_update ) {
16219
+ $site = $this->_site;
16220
+ } else {
16221
+ /**
16222
+ * Sync site info.
16223
+ *
16224
+ * @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.
16225
+ */
16226
+ if ( $is_site_level_sync ) {
16227
+ $result = $this->send_install_update( array(), true );
16228
+ $is_valid = $this->is_api_result_entity( $result );
16229
+ } else {
16230
+ $result = $this->send_installs_update( array(), true );
16231
+ $is_valid = $this->is_api_result_object( $result, 'installs' );
16232
+ }
16233
+
16234
+ if ( ! $is_valid ) {
16235
+ if ( $is_context_single_site ) {
16236
+ // Switch back to the main blog so that the following logic will have the right entities.
16237
+ $this->switch_to_blog( $this->_storage->network_install_blog_id );
16238
+ }
16239
+
16240
+ // Show API messages only if not background sync or if paying customer.
16241
+ if ( ! $background || $this->is_paying() ) {
16242
+ // Try to ping API to see if not blocked.
16243
+ if ( ! FS_Api::test() ) {
16244
+ /**
16245
+ * Failed to ping API - blocked!
16246
+ *
16247
+ * @author Vova Feldman (@svovaf)
16248
+ * @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.
16249
+ */
16250
+ $api = $this->get_api_site_scope();
16251
+
16252
+ if ( ! self::$_global_admin_notices->has_sticky( 'api_blocked' ) ) {
16253
+ self::$_global_admin_notices->add(
16254
+ sprintf(
16255
+ $this->get_text_x_inline( 'Your server is blocking the access to Freemius\' API, which is crucial for %1s synchronization. Please contact your host to whitelist %2s', '%1s - plugin title, %2s - API domain', 'server-blocking-access' ),
16256
+ $this->get_plugin_name(),
16257
+ '<a href="' . $api->get_url() . '" target="_blank">' . $api->get_url() . '</a>'
16258
+ ) . '<br> ' . $this->get_text_inline( 'Error received from the server:', 'server-error-message' ) . var_export( $result->error, true ),
16259
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
16260
+ 'error',
16261
+ $background,
16262
+ 'api_blocked'
16263
+ );
16264
+ }
16265
+ } else {
16266
+ // Authentication params are broken.
16267
+ $this->_admin_notices->add(
16268
+ $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' ),
16269
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
16270
+ 'error'
16271
+ );
16272
+ }
16273
+ }
16274
+
16275
+ // No reason to continue with license sync while there are API issues.
16276
+ return;
16277
+ }
16278
+
16279
+ if ( $is_site_level_sync ) {
16280
+ $site = new FS_Site( $result );
16281
+ } else {
16282
+ // Map site addresses to their blog IDs.
16283
+ $address_to_blog_map = $this->get_address_to_blog_map();
16284
+
16285
+ // Find the current context install.
16286
+ $site = null;
16287
+ foreach ( $result->installs as $install ) {
16288
+ if ( $install->id == $this->_site->id ) {
16289
+ $site = new FS_Site( $install );
16290
+ } else {
16291
+ $address = trailingslashit( fs_strip_url_protocol( $install->url ) );
16292
+ $blog_id = $address_to_blog_map[ $address ];
16293
+
16294
+ $this->_store_site( true, $blog_id, new FS_Site( $install ) );
16295
+ }
16296
+ }
16297
+ }
16298
+
16299
+ // Sync plans.
16300
+ $this->_sync_plans();
16301
+ }
16302
+
16303
+ // Remove sticky API connectivity message.
16304
+ self::$_global_admin_notices->remove_sticky( 'api_blocked' );
16305
+
16306
+ if ( ! $this->has_paid_plan() ) {
16307
+ $this->_site = $site;
16308
+ $this->_store_site(
16309
+ true,
16310
+ $is_site_level_sync ?
16311
+ null :
16312
+ $this->get_network_install_blog_id()
16313
+ );
16314
+ } else {
16315
+ $context_blog_id = 0;
16316
+
16317
+ if ( $is_context_single_site ) {
16318
+ $context_blog_id = get_current_blog_id();
16319
+
16320
+ // Switch back to the main blog in order to properly sync the license.
16321
+ $this->switch_to_blog( $this->_storage->network_install_blog_id );
16322
+ }
16323
+
16324
+ /**
16325
+ * Sync licenses. Pass the site's license ID so that the foreign licenses will be fetched if the license
16326
+ * associated with that ID is not included in the user's licenses collection.
16327
+ */
16328
+ $this->_sync_licenses(
16329
+ $site->license_id,
16330
+ ( $is_context_single_site ?
16331
+ $context_blog_id :
16332
+ null
16333
+ )
16334
+ );
16335
+
16336
+ if ( $is_context_single_site ) {
16337
+ $this->switch_to_blog( $context_blog_id );
16338
+ }
16339
+
16340
+ // Check if plan / license changed.
16341
+ if ( $site->plan_id != $this->_site->plan_id ||
16342
+ // Check if trial started.
16343
+ $site->trial_plan_id != $this->_site->trial_plan_id ||
16344
+ $site->trial_ends != $this->_site->trial_ends ||
16345
+ // Check if license changed.
16346
+ $site->license_id != $this->_site->license_id
16347
+ ) {
16348
+ if ( $site->is_trial() && ( ! $this->_site->is_trial() || $site->trial_ends != $this->_site->trial_ends ) ) {
16349
+ // New trial started.
16350
+ $this->_site = $site;
16351
+ $plan_change = 'trial_started';
16352
+
16353
+ // For trial with subscription use-case.
16354
+ $new_license = is_null( $site->license_id ) ? null : $this->_get_license_by_id( $site->license_id );
16355
+
16356
+ if ( is_object( $new_license ) && $new_license->is_valid() ) {
16357
+ $this->_site = $site;
16358
+ $this->_update_site_license( $new_license );
16359
+ $this->_store_licenses();
16360
+
16361
+ $this->_sync_site_subscription( $this->_license );
16362
+ }
16363
+ } else if ( $this->_site->is_trial() && ! $site->is_trial() && ! is_numeric( $site->license_id ) ) {
16364
+ // Was in trial, but now trial expired and no license ID.
16365
+ // New trial started.
16366
+ $this->_site = $site;
16367
+ $plan_change = 'trial_expired';
16368
+ } else {
16369
+ $is_free = $this->is_free_plan();
16370
+
16371
+ // Make sure license exist and not expired.
16372
+ $new_license = is_null( $site->license_id ) ?
16373
+ null :
16374
+ $this->_get_license_by_id( $site->license_id );
16375
+
16376
+ if ( $is_free && is_null( $new_license ) && $this->has_any_license() && $this->_license->is_cancelled ) {
16377
+ // License cancelled.
16378
+ $this->_site = $site;
16379
+ $this->_update_site_license( $new_license );
16380
+ $this->_store_licenses();
16381
+
16382
+ $plan_change = 'cancelled';
16383
+ } else if ( $is_free && ( ( ! is_object( $new_license ) || $new_license->is_expired() ) ) ) {
16384
+ // The license is expired, so ignore upgrade method.
16385
+ $this->_site = $site;
16386
+ } else {
16387
+ // License changed.
16388
+ $this->_site = $site;
16389
+
16390
+ /**
16391
+ * IMPORTANT:
16392
+ * The line below should be executed before trying to activate the license on the rest of the network, otherwise, the license' activation counters may be out of sync + there's no need to activate the license on the context site since it's already activated on it.
16393
+ *
16394
+ * @author Vova Feldman (@svovaf)
16395
+ * @since 2.0.0
16396
+ */
16397
+ $this->_update_site_license( $new_license );
16398
+
16399
+ if ( ! $is_context_single_site &&
16400
+ fs_is_network_admin() &&
16401
+ $this->_is_network_active &&
16402
+ $new_license->quota > 1 &&
16403
+ get_blog_count() > 1
16404
+ ) {
16405
+ // See if license can activated on all sites.
16406
+ if ( ! $this->try_activate_license_on_network( $this->_user, $new_license ) ) {
16407
+ if ( ! fs_request_get_bool( 'auto_install' ) ) {
16408
+ // Open the license activation dialog box on the account page.
16409
+ add_action( 'admin_footer', array(
16410
+ &$this,
16411
+ '_open_license_activation_dialog_box'
16412
+ ) );
16413
+ }
16414
+ }
16415
+ }
16416
+
16417
+ $this->_store_licenses();
16418
+
16419
+ $plan_change = $is_free ?
16420
+ 'upgraded' :
16421
+ ( is_object( $new_license ) ?
16422
+ 'changed' :
16423
+ 'downgraded' );
16424
+ }
16425
+ }
16426
+
16427
+ // Store updated site info.
16428
+ $this->_store_site(
16429
+ true,
16430
+ $is_site_level_sync ?
16431
+ null :
16432
+ $this->get_network_install_blog_id()
16433
+ );
16434
+ } else {
16435
+ if ( is_object( $this->_license ) && $this->_license->is_expired() ) {
16436
+ if ( ! $this->has_features_enabled_license() ) {
16437
+ $this->_deactivate_license();
16438
+ $plan_change = 'downgraded';
16439
+ } else {
16440
+ $plan_change = 'expired';
16441
+ }
16442
+ }
16443
+
16444
+ if ( is_numeric( $site->license_id ) && is_object( $this->_license ) ) {
16445
+ $this->_sync_site_subscription( $this->_license );
16446
+ }
16447
+ }
16448
+ }
16449
+
16450
+ $hmm_text = $this->get_text_x_inline( 'Hmm', 'something somebody says when they are thinking about what you have just said.', 'hmm' ) . '...';
16451
+
16452
+ if ( $this->has_paid_plan() ) {
16453
+ switch ( $plan_change ) {
16454
+ case 'none':
16455
+ if ( ! $background && is_admin() ) {
16456
+ $plan = $this->is_trial() ?
16457
+ $this->get_trial_plan() :
16458
+ $this->get_plan();
16459
+
16460
+ if ( $plan->is_free() ) {
16461
+ $this->_admin_notices->add(
16462
+ sprintf(
16463
+ $this->get_text_inline( 'It looks like you are still on the %s plan. If you did upgrade or change your plan, it\'s probably an issue on our side - sorry.', 'plan-did-not-change-message' ),
16464
+ '<i><b>' . $plan->title . ( $this->is_trial() ? ' ' . $this->get_text_x_inline( 'Trial', 'trial period', 'trial' ) : '' ) . '</b></i>'
16465
+ ) . ' ' . sprintf(
16466
+ '<a href="%s">%s</a>',
16467
+ $this->contact_url(
16468
+ 'bug',
16469
+ 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' ),
16470
+ strtoupper( $plan->name )
16471
+ )
16472
+ ),
16473
+ $this->get_text_inline( 'Please contact us here', 'contact-us-here' )
16474
+ ),
16475
+ $hmm_text
16476
+ );
16477
+ }
16478
+ }
16479
+ break;
16480
+ case 'upgraded':
16481
+ $this->_admin_notices->add_sticky(
16482
+ sprintf(
16483
+ $this->get_text_inline( 'Your plan was successfully upgraded.', 'plan-upgraded-message' ),
16484
+ '<i>' . $this->get_plugin_name() . '</i>'
16485
+ ) . $this->get_complete_upgrade_instructions(),
16486
+ 'plan_upgraded',
16487
+ $this->get_text_x_inline( 'Yee-haw', 'interjection expressing joy or exuberance', 'yee-haw' ) . '!'
16488
+ );
16489
+
16490
+ $this->_admin_notices->remove_sticky( array(
16491
+ 'trial_started',
16492
+ 'trial_promotion',
16493
+ 'trial_expired',
16494
+ 'activation_complete',
16495
+ ) );
16496
+ break;
16497
+ case 'changed':
16498
+ $this->_admin_notices->add_sticky(
16499
+ sprintf(
16500
+ $this->get_text_inline( 'Your plan was successfully changed to %s.', 'plan-changed-to-x-message' ),
16501
+ $this->get_plan_title()
16502
+ ),
16503
+ 'plan_changed'
16504
+ );
16505
+
16506
+ $this->_admin_notices->remove_sticky( array(
16507
+ 'trial_started',
16508
+ 'trial_promotion',
16509
+ 'trial_expired',
16510
+ 'activation_complete',
16511
+ ) );
16512
+ break;
16513
+ case 'downgraded':
16514
+ $this->_admin_notices->add_sticky(
16515
+ 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 ),
16516
+ 'license_expired',
16517
+ $hmm_text
16518
+ );
16519
+ $this->_admin_notices->remove_sticky( 'plan_upgraded' );
16520
+ break;
16521
+ case 'cancelled':
16522
+ $this->_admin_notices->add(
16523
+ $this->get_text_inline( 'Your license has been cancelled. If you think it\'s a mistake, please contact support.', 'license-cancelled' ) . ' ' .
16524
+ sprintf(
16525
+ '<a href="%s">%s</a>',
16526
+ $this->contact_url( 'bug' ),
16527
+ $this->get_text_inline( 'Please contact us here', 'contact-us-here' )
16528
+ ),
16529
+ $hmm_text,
16530
+ 'error'
16531
+ );
16532
+ $this->_admin_notices->remove_sticky( 'plan_upgraded' );
16533
+ break;
16534
+ case 'expired':
16535
+ $this->_admin_notices->add_sticky(
16536
+ 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 ),
16537
+ 'license_expired',
16538
+ $hmm_text
16539
+ );
16540
+ $this->_admin_notices->remove_sticky( 'plan_upgraded' );
16541
+ break;
16542
+ case 'trial_started':
16543
+ $this->_admin_notices->add_sticky(
16544
+ sprintf(
16545
+ $this->get_text_inline( 'Your trial has been successfully started.', 'trial-started-message' ),
16546
+ '<i>' . $this->get_plugin_name() . '</i>'
16547
+ ) . $this->get_complete_upgrade_instructions( $this->get_trial_plan()->title ),
16548
+ 'trial_started',
16549
+ $this->get_text_x_inline( 'Yee-haw', 'interjection expressing joy or exuberance', 'yee-haw' ) . '!'
16550
+ );
16551
+
16552
+ $this->_admin_notices->remove_sticky( array(
16553
+ 'trial_promotion',
16554
+ ) );
16555
+ break;
16556
+ case 'trial_expired':
16557
+ $this->_admin_notices->add_sticky(
16558
+ $this->get_text_inline( 'Your trial has expired. You can still continue using all our free features.', 'trial-expired-message' ),
16559
+ 'trial_expired',
16560
+ $hmm_text
16561
+ );
16562
+ $this->_admin_notices->remove_sticky( array(
16563
+ 'trial_started',
16564
+ 'trial_promotion',
16565
+ 'plan_upgraded',
16566
+ ) );
16567
+ break;
16568
+ }
16569
+ }
16570
+
16571
+ if ( 'none' !== $plan_change ) {
16572
+ $this->do_action( 'after_license_change', $plan_change, $this->get_plan() );
16573
+ }
16574
+ }
16575
+
16576
+ /**
16577
+ * Include the required JS at the footer of the admin to trigger the license activation dialog box.
16578
+ *
16579
+ * @author Vova Feldman (@svovaf)
16580
+ * @since 2.0.0
16581
+ */
16582
+ public function _open_license_activation_dialog_box() {
16583
+ $vars = array( 'license_id' => $this->_site->license_id );
16584
+ fs_require_once_template( 'js/open-license-activation.php', $vars );
16585
+ }
16586
+
16587
+ /**
16588
+ * @author Vova Feldman (@svovaf)
16589
+ * @since 1.0.5
16590
+ *
16591
+ * @param bool $background
16592
+ */
16593
+ protected function _activate_license( $background = false ) {
16594
+ $this->_logger->entrance();
16595
+
16596
+ $license_id = fs_request_get( 'license_id' );
16597
+
16598
+ if ( is_object( $this->_site ) &&
16599
+ FS_Plugin_License::is_valid_id( $license_id ) &&
16600
+ $license_id == $this->_site->license_id
16601
+ ) {
16602
+ // License is already activated.
16603
+ return;
16604
+ }
16605
+
16606
+ $premium_license = FS_Plugin_License::is_valid_id( $license_id ) ?
16607
+ $this->_get_license_by_id( $license_id ) :
16608
+ $this->_get_available_premium_license();
16609
+
16610
+ if ( ! is_object( $premium_license ) ) {
16611
+ return;
16612
+ }
16613
+
16614
+ if ( ! is_object( $this->_site ) ) {
16615
+ // Not yet opted-in.
16616
+ $user = $this->get_current_or_network_user();
16617
+ if ( ! is_object( $user ) ) {
16618
+ $user = self::_get_user_by_id( $premium_license->user_id );
16619
+ }
16620
+
16621
+ if ( is_object( $user ) ) {
16622
+ $this->install_with_user( $user, $premium_license->secret_key, false, false, false );
16623
+ } else {
16624
+ $this->opt_in(
16625
+ false,
16626
+ false,
16627
+ false,
16628
+ $premium_license->secret_key
16629
+ );
16630
+
16631
+ return;
16632
+ }
16633
+ }
16634
+
16635
+
16636
+ /**
16637
+ * If the premium license is already associated with the install, just
16638
+ * update the license reference (activation is not required).
16639
+ *
16640
+ * @since 1.1.9
16641
+ */
16642
+ if ( $premium_license->id == $this->_site->license_id ) {
16643
+ // License is already activated.
16644
+ $this->_update_site_license( $premium_license );
16645
+ $this->_store_account();
16646
+
16647
+ return;
16648
+ }
16649
+
16650
+ if ( $this->_site->user_id != $premium_license->user_id ) {
16651
+ $api_request_params = array( 'license_key' => $premium_license->secret_key );
16652
+ } else {
16653
+ $api_request_params = array();
16654
+ }
16655
+
16656
+ $api = $this->get_api_site_scope();
16657
+ $license = $api->call( "/licenses/{$premium_license->id}.json", 'put', $api_request_params );
16658
+
16659
+ if ( ! $this->is_api_result_entity( $license ) ) {
16660
+ if ( ! $background ) {
16661
+ $this->_admin_notices->add( sprintf(
16662
+ '%s %s',
16663
+ $this->get_text_inline( 'It looks like the license could not be activated.', 'license-activation-failed-message' ),
16664
+ ( is_object( $license ) && isset( $license->error ) ?
16665
+ $license->error->message :
16666
+ sprintf( '%s<br><code>%s</code>',
16667
+ $this->get_text_inline( 'Error received from the server:', 'server-error-message' ),
16668
+ var_export( $license, true )
16669
+ )
16670
+ )
16671
+ ),
16672
+ $this->get_text_x_inline( 'Hmm', 'something somebody says when they are thinking about what you have just said.', 'hmm' ) . '...',
16673
+ 'error'
16674
+ );
16675
+ }
16676
+
16677
+ return;
16678
+ }
16679
+
16680
+ $premium_license = new FS_Plugin_License( $license );
16681
+
16682
+ // Updated site plan.
16683
+ $site = $this->get_api_site_scope()->get( '/', true );
16684
+ if ( $this->is_api_result_entity( $site ) ) {
16685
+ $this->_site = new FS_Site( $site );
16686
+ }
16687
+ $this->_update_site_license( $premium_license );
16688
+
16689
+ $this->_store_account();
16690
+
16691
+ if ( ! $background ) {
16692
+ $this->_admin_notices->add_sticky(
16693
+ $this->get_text_inline( 'Your license was successfully activated.', 'license-activated-message' ) .
16694
+ $this->get_complete_upgrade_instructions(),
16695
+ 'license_activated',
16696
+ $this->get_text_x_inline( 'Yee-haw', 'interjection expressing joy or exuberance', 'yee-haw' ) . '!'
16697
+ );
16698
+ }
16699
+
16700
+ $this->_admin_notices->remove_sticky( array(
16701
+ 'trial_promotion',
16702
+ 'license_expired',
16703
+ ) );
16704
+ }
16705
+
16706
+ /**
16707
+ * @author Vova Feldman (@svovaf)
16708
+ * @since 1.0.5
16709
+ *
16710
+ * @param bool $show_notice
16711
+ */
16712
+ protected function _deactivate_license( $show_notice = true ) {
16713
+ $this->_logger->entrance();
16714
+
16715
+ $hmm_text = $this->get_text_x_inline( 'Hmm', 'something somebody says when they are thinking about what you have just said.', 'hmm' ) . '...';
16716
+
16717
+ if ( ! FS_Plugin_License::is_valid_id( $this->_site->license_id ) ) {
16718
+ $this->_admin_notices->add(
16719
+ 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() ),
16720
+ $hmm_text
16721
+ );
16722
+
16723
+ return;
16724
+ }
16725
+
16726
+ $api = $this->get_api_site_scope();
16727
+ $license = $api->call( "/licenses/{$this->_site->license_id}.json", 'delete' );
16728
+
16729
+ if ( isset( $license->error ) ) {
16730
+ $this->_admin_notices->add(
16731
+ $this->get_text_inline( 'It looks like the license deactivation failed.', 'license-deactivation-failed-message' ) . '<br> ' .
16732
+ $this->get_text_inline( 'Error received from the server:', 'server-error-message' ) . ' ' . var_export( $license->error, true ),
16733
+ $hmm_text,
16734
+ 'error'
16735
+ );
16736
+
16737
+ return;
16738
+ }
16739
+
16740
+ // Update license cache.
16741
+ if ( is_array( $this->_licenses ) ) {
16742
+ for ( $i = 0, $len = count( $this->_licenses ); $i < $len; $i ++ ) {
16743
+ if ( $license->id == $this->_licenses[ $i ]->id ) {
16744
+ $this->_licenses[ $i ] = new FS_Plugin_License( $license );
16745
+ }
16746
+ }
16747
+ }
16748
+
16749
+ // Updated site plan to default.
16750
+ $this->_sync_plans();
16751
+ $this->_site->plan_id = $this->_plans[0]->id;
16752
+ // Unlink license from site.
16753
+ $this->_update_site_license( null );
16754
+
16755
+ $this->_store_account();
16756
+
16757
+ if ( $show_notice ) {
16758
+ $this->_admin_notices->add(
16759
+ sprintf( $this->get_text_inline( 'Your license was successfully deactivated, you are back to the %s plan.', 'license-deactivation-message' ), $this->get_plan_title() ),
16760
+ $this->get_text_inline( 'O.K', 'ok' )
16761
+ );
16762
+ }
16763
+
16764
+ $this->_admin_notices->remove_sticky( array(
16765
+ 'plan_upgraded',
16766
+ 'license_activated',
16767
+ ) );
16768
+ }
16769
+
16770
+ /**
16771
+ * Site plan downgrade.
16772
+ *
16773
+ * @author Vova Feldman (@svovaf)
16774
+ * @since 1.0.4
16775
+ *
16776
+ * @uses FS_Api
16777
+ */
16778
+ private function _downgrade_site() {
16779
+ $this->_logger->entrance();
16780
+
16781
+ $api = $this->get_api_site_scope();
16782
+ $site = $api->call( 'downgrade.json', 'put' );
16783
+
16784
+ $plan_downgraded = false;
16785
+ $plan = false;
16786
+ if ( $this->is_api_result_entity( $site ) ) {
16787
+ $prev_plan_id = $this->_site->plan_id;
16788
+
16789
+ // Update new site plan id.
16790
+ $this->_site->plan_id = $site->plan_id;
16791
+
16792
+ $plan = $this->get_plan();
16793
+ $subscription = $this->_sync_site_subscription( $this->_license );
16794
+
16795
+ // Plan downgraded if plan was changed or subscription was cancelled.
16796
+ $plan_downgraded = ( $plan instanceof FS_Plugin_Plan && $prev_plan_id != $plan->id ) ||
16797
+ ( is_object( $subscription ) && ! isset( $subscription->error ) && ! $subscription->is_active() );
16798
+ } else {
16799
+ // handle different error cases.
16800
+
16801
+ }
16802
+
16803
+ if ( $plan_downgraded ) {
16804
+ // Remove previous sticky message about upgrade (if exist).
16805
+ $this->_admin_notices->remove_sticky( 'plan_upgraded' );
16806
+
16807
+ $this->_admin_notices->add(
16808
+ sprintf( $this->get_text_inline( 'Your plan was successfully downgraded. Your %s plan license will expire in %s.', 'plan-x-downgraded-message' ),
16809
+ $plan->title,
16810
+ human_time_diff( time(), strtotime( $this->_license->expiration ) )
16811
+ )
16812
+ );
16813
+
16814
+ // Store site updates.
16815
+ $this->_store_site();
16816
+ } else {
16817
+ $this->_admin_notices->add(
16818
+ $this->get_text_inline( 'Seems like we are having some temporary issue with your plan downgrade. Please try again in few minutes.', 'plan-downgraded-failure-message' ),
16819
+ $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...',
16820
+ 'error'
16821
+ );
16822
+ }
16823
+ }
16824
+
16825
+ /**
16826
+ * @author Vova Feldman (@svovaf)
16827
+ * @since 1.1.8.1
16828
+ *
16829
+ * @param bool|string $plan_name
16830
+ *
16831
+ * @return bool If trial was successfully started.
16832
+ */
16833
+ function start_trial( $plan_name = false ) {
16834
+ $this->_logger->entrance();
16835
+
16836
+ // Alias.
16837
+ $oops_text = $this->get_text_x_inline( 'Oops', 'exclamation', 'oops' ) . '...';
16838
+
16839
+ if ( $this->is_trial() ) {
16840
+ // Already in trial mode.
16841
+ $this->_admin_notices->add(
16842
+ sprintf( $this->get_text_inline( 'You are already running the %s in a trial mode.', 'in-trial-mode' ), $this->_module_type ),
16843
+ $oops_text,
16844
+ 'error'
16845
+ );
16846
+
16847
+ return false;
16848
+ }
16849
+
16850
+ if ( $this->_site->is_trial_utilized() ) {
16851
+ // Trial was already utilized.
16852
+ $this->_admin_notices->add(
16853
+ $this->get_text_inline( 'You already utilized a trial before.', 'trial-utilized' ),
16854
+ $oops_text,
16855
+ 'error'
16856
+ );
16857
+
16858
+ return false;
16859
+ }
16860
+
16861
+ if ( false !== $plan_name ) {
16862
+ $plan = $this->get_plan_by_name( $plan_name );
16863
+
16864
+ if ( false === $plan ) {
16865
+ // Plan doesn't exist.
16866
+ $this->_admin_notices->add(
16867
+ sprintf( $this->get_text_inline( 'Plan %s do not exist, therefore, can\'t start a trial.', 'trial-plan-x-not-exist' ), $plan_name ),
16868
+ $oops_text,
16869
+ 'error'
16870
+ );
16871
+
16872
+ return false;
16873
+ }
16874
+
16875
+ if ( ! $plan->has_trial() ) {
16876
+ // Plan doesn't exist.
16877
+ $this->_admin_notices->add(
16878
+ sprintf( $this->get_text_inline( 'Plan %s does not support a trial period.', 'plan-x-no-trial' ), $plan_name ),
16879
+ $oops_text,
16880
+ 'error'
16881
+ );
16882
+
16883
+ return false;
16884
+ }
16885
+ } else {
16886
+ if ( ! $this->has_trial_plan() ) {
16887
+ // None of the plans have a trial.
16888
+ $this->_admin_notices->add(
16889
+ sprintf( $this->get_text_inline( 'None of the %s\'s plans supports a trial period.', 'no-trials' ), $this->_module_type ),
16890
+ $oops_text,
16891
+ 'error'
16892
+ );
16893
+
16894
+ return false;
16895
+ }
16896
+
16897
+ $plans_with_trial = FS_Plan_Manager::instance()->get_trial_plans( $this->_plans );
16898
+
16899
+ $plan = $plans_with_trial[0];
16900
+ }
16901
+
16902
+ $api = $this->get_api_site_scope();
16903
+ $plan = $api->call( "plans/{$plan->id}/trials.json", 'post' );
16904
+
16905
+ if ( ! $this->is_api_result_entity( $plan ) ) {
16906
+ // Some API error while trying to start the trial.
16907
+ $this->_admin_notices->add(
16908
+ sprintf( $this->get_text_inline( 'Unexpected API error. Please contact the %s\'s author with the following error.', 'unexpected-api-error' ), $this->_module_type )
16909
+