Admin
1 year ago
Commands
2 years ago
Db
1 year ago
Ecommerce
1 year ago
Report
1 year ago
Site
2 years ago
TrackingCode
1 year ago
Updater
4 years ago
User
1 year ago
Workarounds
2 years ago
WpStatistics
1 year ago
views
4 years ago
API.php
1 year ago
Access.php
4 years ago
AjaxTracker.php
1 year ago
Annotations.php
4 years ago
Bootstrap.php
1 year ago
Capabilities.php
4 years ago
Compatibility.php
2 years ago
Email.php
2 years ago
ErrorNotice.php
2 years ago
Installer.php
1 year ago
Logger.php
1 year ago
OptOut.php
1 year ago
Paths.php
2 years ago
PluginAdminOverrides.php
2 years ago
PrivacyBadge.php
4 years ago
RedirectOnActivation.php
4 years ago
Referral.php
2 years ago
Roles.php
1 year ago
ScheduledTasks.php
1 year ago
Settings.php
1 year ago
Site.php
3 years ago
TrackingCode.php
1 year ago
Uninstaller.php
1 year ago
Updater.php
1 year ago
User.php
4 years ago
Referral.php
126 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Matomo - free/libre analytics platform |
| 4 | * |
| 5 | * @link https://matomo.org |
| 6 | * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 7 | * @package matomo |
| 8 | */ |
| 9 | |
| 10 | namespace WpMatomo; |
| 11 | |
| 12 | if ( ! defined( 'ABSPATH' ) ) { |
| 13 | exit; // if accessed directly |
| 14 | } |
| 15 | |
| 16 | /** |
| 17 | * Every 90 days we show a please review notice until the user dismisses this notice or clicks on rate us. |
| 18 | * We only show this notice on Matomo screens. |
| 19 | * |
| 20 | * @todo validate the nonce |
| 21 | * phpcs:disable WordPress.Security.NonceVerification.Missing |
| 22 | */ |
| 23 | class Referral { |
| 24 | const OPTION_NAME_REFERRAL_DISMISSED = 'matomo-referral-dismissed'; |
| 25 | |
| 26 | /** |
| 27 | * @var int |
| 28 | */ |
| 29 | private $time; |
| 30 | |
| 31 | public function __construct() { |
| 32 | $this->time = time(); |
| 33 | } |
| 34 | |
| 35 | /** |
| 36 | * @param int $time |
| 37 | * |
| 38 | * @internal for tests only |
| 39 | */ |
| 40 | public function set_time( $time ) { |
| 41 | $this->time = $time; |
| 42 | } |
| 43 | |
| 44 | public function register_hooks() { |
| 45 | $self = $this; |
| 46 | |
| 47 | add_action( |
| 48 | 'wp_ajax_matomo_referral_dismiss_admin_notice', |
| 49 | function () use ( $self ) { |
| 50 | check_ajax_referer( 'matomo-referral-notice-dismiss' ); |
| 51 | |
| 52 | if ( is_admin() && $self->should_show() && $self->can_refer() ) { |
| 53 | // no need for an nonce check here as it's nothing critical |
| 54 | if ( ! empty( $_POST['forever'] ) ) { |
| 55 | $self->dismiss_forever(); |
| 56 | } else { |
| 57 | $self->dismiss(); |
| 58 | } |
| 59 | } |
| 60 | } |
| 61 | ); |
| 62 | add_action( |
| 63 | 'admin_notices', |
| 64 | function () use ( $self ) { |
| 65 | if ( $self->can_refer() && $self->should_show_on_screen() ) { |
| 66 | $self->render(); |
| 67 | } |
| 68 | } |
| 69 | ); |
| 70 | } |
| 71 | |
| 72 | public function render() { |
| 73 | include 'views/referral.php'; |
| 74 | } |
| 75 | |
| 76 | public function should_show_on_screen() { |
| 77 | if ( ! is_admin() ) { |
| 78 | return false; |
| 79 | } |
| 80 | $screen = get_current_screen(); |
| 81 | |
| 82 | return $screen && $screen->id && strpos( $screen->id, 'matomo-' ) === 0; |
| 83 | } |
| 84 | |
| 85 | public function can_refer() { |
| 86 | return current_user_can( Capabilities::KEY_VIEW ); |
| 87 | } |
| 88 | |
| 89 | public function dismiss_forever() { |
| 90 | $ten_years = 60 * 60 * 24 * 365 * 10; |
| 91 | update_option( self::OPTION_NAME_REFERRAL_DISMISSED, $this->time + $ten_years ); |
| 92 | } |
| 93 | |
| 94 | public function dismiss() { |
| 95 | update_option( self::OPTION_NAME_REFERRAL_DISMISSED, $this->time, true ); |
| 96 | } |
| 97 | |
| 98 | public function get_last_dismissed() { |
| 99 | return get_option( self::OPTION_NAME_REFERRAL_DISMISSED ); |
| 100 | } |
| 101 | |
| 102 | private function get_days_in_seconds( $num_days ) { |
| 103 | return 60 * 60 * 24 * $num_days; |
| 104 | } |
| 105 | |
| 106 | public function should_show() { |
| 107 | $dismissed = $this->get_last_dismissed(); |
| 108 | |
| 109 | if ( ! $dismissed ) { |
| 110 | // the first time we check... we set it back 30 days cause we want to see first rating after 60 days |
| 111 | $this->time = $this->time - $this->get_days_in_seconds( 30 ); |
| 112 | $this->dismiss(); |
| 113 | |
| 114 | return false; |
| 115 | } |
| 116 | |
| 117 | $ninety_days_in_seconds = $this->get_days_in_seconds( 90 ); |
| 118 | |
| 119 | if ( $this->time > ( $dismissed + $ninety_days_in_seconds ) ) { |
| 120 | return true; |
| 121 | } |
| 122 | |
| 123 | return false; |
| 124 | } |
| 125 | } |
| 126 |