Changeset 2580537

Timestamp:

08/09/2021 08:10:43 PM (5 years ago)

Author:

procifer

Message:

Akismet 4.1.11a1: Added support for Akismet API usage notifications on Akismet settings and edit-comments admin pages.

Location:

akismet/trunk

Files:

• .htaccess (modified) (1 diff)
• _inc/akismet.css (modified) (1 diff)
• _inc/img/logo-a-2x.png (added)
• akismet.php (modified) (2 diffs)
• class.akismet-admin.php (modified) (4 diffs)
• class.akismet.php (modified) (2 diffs)
• readme.txt (modified) (1 diff)
• views/notice.php (modified) (1 diff)

akismet/trunk/.htaccess

@@ -24 +24 @@
 
 # Akismet images
-<FilesMatch "^logo-full-2x\.png$">
+<FilesMatch "^logo-(a|full)-2x\.png$">
     <IfModule !mod_authz_core.c>
         Allow from all

akismet/trunk/_inc/akismet.css

@@ -661 +661 @@
     padding-bottom: 1.5rem;
 }
+
+div.error.akismet-usage-limit-alert {
+    padding: 25px 45px 25px 15px;
+    display: flex;
+    align-items: center;
+}
+
+#akismet-plugin-container .akismet-usage-limit-alert {
+    margin: 0 auto 0.625rem auto;
+    box-sizing: border-box;
+    box-shadow: 0 0 0 1px rgba(200, 215, 225, 0.5), 0 1px 2px #e9eff3;
+    border: none;
+    border-left: 4px solid #d63638;
+}
+
+.akismet-usage-limit-alert .akismet-usage-limit-logo {
+    width: 38px;
+    min-width: 38px;
+    height: 38px;
+    border-radius: 20px;
+    margin-right: 18px;
+    background: black;
+    position: relative;
+}
+
+.akismet-usage-limit-alert .akismet-usage-limit-logo img {
+    position: absolute;
+    width: 22px;
+    left: 8px;
+    top: 10px;
+}
+
+.akismet-usage-limit-alert .akismet-usage-limit-text {
+    flex-grow: 1;
+    margin-right: 18px;
+}
+
+.akismet-usage-limit-alert h3 {
+    margin: 0;
+}
+
+.akismet-usage-limit-alert .akismet-usage-limit-cta {
+    text-align: right;
+}
+
+@media (max-width: 550px) {
+    div.error.akismet-usage-limit-alert {
+        display: block;
+    }
+
+    .akismet-usage-limit-alert .akismet-usage-limit-logo,
+    .akismet-usage-limit-alert .akismet-usage-limit-text {
+        margin-bottom: 15px;
+    }
+
+    .akismet-usage-limit-alert .akismet-usage-limit-cta {
+        text-align: left;
+    }
+}

akismet/trunk/akismet.php

@@ -7 +7 @@
 Plugin URI: https://akismet.com/
 Description: Used by millions, Akismet is quite possibly the best way in the world to <strong>protect your blog from spam</strong>. It keeps your site protected even while you sleep. To get started: activate the Akismet plugin and then go to your Akismet Settings page to set up your API key.
-Version: 4.1.10
+Version: 4.1.11a1
 Author: Automattic
 Author URI: https://automattic.com/wordpress-plugins/
@@ -38 +38 @@
 }
 
-define( 'AKISMET_VERSION', '4.1.10' );
+define( 'AKISMET_VERSION', '4.1.11a1' );
 define( 'AKISMET__MINIMUM_WP_VERSION', '4.0' );
 define( 'AKISMET__PLUGIN_DIR', plugin_dir_path( __FILE__ ) );

akismet/trunk/class.akismet-admin.php

@@ -889 +889 @@
     }
 
+    public static function get_usage_limit_alert_data() {
+        return array(
+            'type'         => 'usage-limit',
+            'code'         => (int) get_option( 'akismet_alert_code' ),
+            'msg'          => get_option( 'akismet_alert_msg' ),
+            'api_calls'    => get_option( 'akismet_alert_api_calls' ),
+            'usage_limit'  => get_option( 'akismet_alert_usage_limit' ),
+            'upgrade_plan' => get_option( 'akismet_alert_upgrade_plan' ),
+            'upgrade_url'  => get_option( 'akismet_alert_upgrade_url' ),
+        );
+    }
+
+    public static function display_usage_limit_alert() {
+        Akismet::view( 'notice', self::get_usage_limit_alert_data() );
+    }
+
     public static function display_spam_check_warning() {
         Akismet::fix_scheduled_recheck();
@@ -1020 +1036 @@
         if ( !isset( self::$notices['status'] ) && in_array( $akismet_user->status, array( 'cancelled', 'suspended', 'missing', 'no-sub' ) ) ) {
             $notices[] = array( 'type' => $akismet_user->status );
+        }
+
+        $alert_code = get_option( 'akismet_alert_code' );
+        if ( preg_match( '/^105\d\d$/', $alert_code ) ) {
+            $notices[] = self::get_usage_limit_alert_data();
         }
 
@@ -1041 +1062 @@
         $notices[] = array( 'type' => 'limit-reached', 'level' => 'yellow' );
         $notices[] = array( 'type' => 'limit-reached', 'level' => 'red' );
+        $notices[] = array( 'type' => 'usage-limit', 'api_calls' => '15000', 'usage_limit' => '10000', 'upgrade_plan' => 'Enterprise', 'upgrade_url' => 'https://akismet.com/account/' );
         */
         
@@ -1057 +1079 @@
         if ( in_array( $hook_suffix, array( 'edit-comments.php' ) ) && (int) get_option( 'akismet_alert_code' ) > 0 ) {
             Akismet::verify_key( Akismet::get_api_key() ); //verify that the key is still in alert state
-            
-            if ( get_option( 'akismet_alert_code' ) > 0 )
+        
+            $alert_code = get_option( 'akismet_alert_code' );
+            if ( preg_match( '/^105\d\d$/', $alert_code ) ) {
+                self::display_usage_limit_alert();
+            }
+            elseif ( $alert_code > 0 ) {
                 self::display_alert();
+            }
         }
         elseif ( ( 'plugins.php' === $hook_suffix || 'edit-comments.php' === $hook_suffix ) && ! Akismet::get_api_key() ) {

akismet/trunk/class.akismet.php

@@ -5 +5 @@
     const API_PORT = 80;
     const MAX_DELAY_BEFORE_MODERATION_EMAIL = 86400; // One day in seconds
+
+    const LIMIT_NOTICE_FIRST_MONTH_OVER_LIMIT        = 10501;
+    const LIMIT_NOTICE_SECOND_MONTH_OVER_LIMIT       = 10502;
+    const LIMIT_NOTICE_THIRD_MONTH_APPROACHING_LIMIT = 10504;
+    const LIMIT_NOTICE_THIRD_MONTH_OVER_LIMIT        = 10508;
+    const LIMIT_NOTICE_FOUR_PLUS_MONTHS_OVER_LIMIT   = 10516;
 
     private static $last_comment = '';
@@ -1255 +1261 @@
     // given a response from an API call like check_key_status(), update the alert code options if an alert is present.
     public static function update_alert( $response ) {
-        $code = $msg = null;
-        if ( isset( $response[0]['x-akismet-alert-code'] ) ) {
-            $code = $response[0]['x-akismet-alert-code'];
-            $msg  = $response[0]['x-akismet-alert-msg'];
-        }
-
-        // only call update_option() if the value has changed
-        if ( $code != get_option( 'akismet_alert_code' ) ) {
-            if ( ! $code ) {
-                delete_option( 'akismet_alert_code' );
-                delete_option( 'akismet_alert_msg' );
-            }
-            else {
-                update_option( 'akismet_alert_code', $code );
-                update_option( 'akismet_alert_msg', $msg );
+        $alert_option_prefix = 'akismet_alert_';
+        $alert_header_prefix = 'x-akismet-alert-';
+        $alert_header_names  = array(
+            'code',
+            'msg',
+            'api-calls',
+            'usage-limit',
+            'upgrade-plan',
+            'upgrade-url',
+        );
+
+        foreach( $alert_header_names as $alert_header_name ) {
+            $value = null;
+            if ( isset( $response[0][$alert_header_prefix . $alert_header_name] ) ) {
+                $value = $response[0][$alert_header_prefix . $alert_header_name];
+            }
+
+            $option_name = $alert_option_prefix . str_replace( '-', '_', $alert_header_name );
+            if ( $value != get_option( $option_name ) ) {
+                if ( ! $value ) {
+                    delete_option( $option_name );
+                }
+                else {
+                    update_option( $option_name, $value );
+                }
             }
         }

akismet/trunk/readme.txt

@@ -30 +30 @@
 
 == Changelog ==
+
+= 4.1.11 =
+*Release Date - TBD*
+
+* Added support for Akismet API usage notifications on Akismet settings and edit-comments admin pages.
 
 = 4.1.10 =

akismet/trunk/views/notice.php

@@ -140 +140 @@
     <?php endif; ?>
 </div>
+<?php elseif ( $type == 'usage-limit' ) :?>
+<div class="error akismet-usage-limit-alert">
+    <div class="akismet-usage-limit-logo">
+        <img src="<?php echo esc_url( plugins_url( '../_inc/img/logo-a-2x.png', __FILE__ ) ); ?>" alt="Akismet" />
+    </div>
+    <div class="akismet-usage-limit-text">
+        <h3>
+        <?php
+        switch ( $code ) {
+            case Akismet::LIMIT_NOTICE_FIRST_MONTH_OVER_LIMIT:
+            case Akismet::LIMIT_NOTICE_SECOND_MONTH_OVER_LIMIT:
+                esc_html_e( 'Your Akismet account usage is over the plan limit', 'akismet' );
+                break;
+            case Akismet::LIMIT_NOTICE_THIRD_MONTH_APPROACHING_LIMIT:
+                esc_html_e( 'Your Akismet account usage is approaching the plan limit', 'akismet' );
+                break;
+            case Akismet::LIMIT_NOTICE_THIRD_MONTH_OVER_LIMIT:
+            case Akismet::LIMIT_NOTICE_FOUR_PLUS_MONTHS_OVER_LIMIT:
+                esc_html_e( 'Your account has been restricted', 'akismet' );
+                break;
+            default:
+        }
+        ?>
+        </h3>
+        <p>
+        <?php
+        switch ( $code ) {
+            case Akismet::LIMIT_NOTICE_FIRST_MONTH_OVER_LIMIT:
+                printf(
+                    __( 'Since %s, your account made %s API calls, compared to your plan limit of %s. <a href="%s" target="_blank">Learn more</a> about usage limits.', 'akismet' ),
+                    esc_html( gmdate( 'F' ) . ' 1' ),
+                    number_format( $api_calls ),
+                    number_format( $usage_limit ),
+                    'https://docs.akismet.com/akismet-api-usage-limits/'
+                );
+                break;
+            case Akismet::LIMIT_NOTICE_SECOND_MONTH_OVER_LIMIT:
+                esc_html_e( 'Your Akismet usage has been over the plan limit for two consecutive months. Next month, we will restrict your account after you reach the limit. Please consider upgrading your plan.', 'akismet' );
+                break;
+            case Akismet::LIMIT_NOTICE_THIRD_MONTH_APPROACHING_LIMIT:
+                esc_html_e( 'Your Akismet usage is nearing the plan limit for the third consecutive month. We will restrict your account after you reach the limit. Upgrade your plan so Akismet can continue blocking spam.', 'akismet' );
+                break;
+            case Akismet::LIMIT_NOTICE_THIRD_MONTH_OVER_LIMIT:
+            case Akismet::LIMIT_NOTICE_FOUR_PLUS_MONTHS_OVER_LIMIT:
+                esc_html_e( 'Your Akismet usage has been over the plan limit for three consecutive months. We have restricted your account for the rest of the month. Upgrade your plan so Akismet can continue blocking spam.', 'akismet' );
+                break;
+            default:
+        }
+        ?>
+        </p>
+    </div>
+    <div class="akismet-usage-limit-cta">
+        <?php printf( __( '<a href="%1$s" class="button" target="_blank">Upgrade to %2$s</a>', 'akismet' ), esc_attr( $upgrade_url ), esc_html( $upgrade_plan ) ); ?>
+    </div>
+</div>
 <?php endif;?>