| @@ -7,11 +7,17 @@ | ||
| 7 | 7 | */ |
| 8 | 8 | |
| 9 | 9 | use Automattic\Jetpack\Connection\Client; |
| 10 | 10 | use Automattic\Jetpack\Connection\Manager; |
| 11 | +use Automattic\Jetpack\Search\Plan as Search_Plan; | |
| 11 | 12 | use Automattic\Jetpack\Status; |
| 12 | 13 | use Automattic\Jetpack\Status\Visitor; |
| 13 | 14 | |
| 15 | +// Required directly rather than relying on the plugin bootstrap: on | |
| 16 | +// WordPress.com Simple this helper is loaded outside load-jetpack.php | |
| 17 | +// (see the GUIDELINES_BANNER_DISMISSED_META_KEY note below). | |
| 18 | +require_once __DIR__ . '/class-jetpack-ai-settings.php'; | |
| 19 | + | |
| 14 | 20 | /** |
| 15 | 21 | * Class Jetpack_AI_Helper |
| 16 | 22 | * |
| 17 | 23 | * @since 11.8 |
| @@ -17,8 +23,23 @@ | ||
| 17 | 23 | * @since 11.8 |
| 18 | 24 | */ |
| 19 | 25 | class Jetpack_AI_Helper { |
| 20 | 26 | /** |
| 27 | + * User meta key storing whether the user dismissed the Content Guidelines | |
| 28 | + * AI empty-state banner. Written by the guidelines-banner-dismissed REST | |
| 29 | + * endpoint and read by the Content Guidelines admin-page preload. | |
| 30 | + * | |
| 31 | + * Lives here rather than on the endpoint class because on WordPress.com | |
| 32 | + * Simple the wpcom-endpoints classes are only loaded in REST requests, | |
| 33 | + * while the preload needs the key during admin page loads. | |
| 34 | + * | |
| 35 | + * @since 16.1 | |
| 36 | + * | |
| 37 | + * @var string | |
| 38 | + */ | |
| 39 | + const GUIDELINES_BANNER_DISMISSED_META_KEY = 'jetpack_content_guidelines_ai_banner_dismissed'; | |
| 40 | + | |
| 41 | + /** | |
| 21 | 42 | * Allow new completion every X seconds. Will return cached result otherwise. |
| 22 | 43 | * |
| 23 | 44 | * @var int |
| 24 | 45 | */ |
| @@ -31,8 +52,22 @@ | ||
| 31 | 52 | */ |
| 32 | 53 | public static $image_generation_cache_timeout = MONTH_IN_SECONDS; |
| 33 | 54 | |
| 34 | 55 | /** |
| 56 | + * Cache AI-assistant feature for 60 seconds. | |
| 57 | + * | |
| 58 | + * @var int | |
| 59 | + */ | |
| 60 | + public static $ai_assistant_feature_cache_timeout = 60; | |
| 61 | + | |
| 62 | + /** | |
| 63 | + * Cache AI-assistant errors for ten seconds. | |
| 64 | + * | |
| 65 | + * @var int | |
| 66 | + */ | |
| 67 | + public static $ai_assistant_feature_error_cache_timeout = 10; | |
| 68 | + | |
| 69 | + /** | |
| 35 | 70 | * Stores the number of JetpackAI calls in case we want to mark AI-assisted posts some way. |
| 36 | 71 | * |
| 37 | 72 | * @var int |
| 38 | 73 | */ |
| @@ -38,8 +73,15 @@ | ||
| 38 | 73 | */ |
| 39 | 74 | public static $post_meta_with_ai_generation_number = '_jetpack_ai_calls'; |
| 40 | 75 | |
| 41 | 76 | /** |
| 77 | + * Storing the error to prevent repeated requests to WPCOM after failure. | |
| 78 | + * | |
| 79 | + * @var null|WP_Error | |
| 80 | + */ | |
| 81 | + private static $ai_assistant_failed_request = null; | |
| 82 | + | |
| 83 | + /** | |
| 42 | 84 | * Checks if a given request is allowed to get AI data from WordPress.com. |
| 43 | 85 | * |
| 44 | 86 | * @param WP_REST_Request $request Full details about the request. |
| 45 | 87 | * |
| @@ -75,16 +117,78 @@ | ||
| 75 | 117 | } elseif ( ( new Automattic\Jetpack\Status\Host() )->is_woa_site() ) { |
| 76 | 118 | $default = true; |
| 77 | 119 | } |
| 78 | 120 | |
| 121 | + // The jetpack_ai_enabled filter runs inside the helper; the host and | |
| 122 | + // master gates apply after the chain and cannot be filtered back on. | |
| 123 | + return Jetpack_AI_Settings::is_ai_enabled( $default ); | |
| 124 | + } | |
| 125 | + | |
| 126 | + /** | |
| 127 | + * Return true if the Content Guidelines AI surfaces should be active on the | |
| 128 | + * current site. | |
| 129 | + * | |
| 130 | + * Same platforms as is_enabled() (WPCOM Simple and Atomic), plus WordPress | |
| 131 | + * VIP sites. Kept separate from is_enabled() so widening Content Guidelines | |
| 132 | + * to VIP does not also open the general AI proxy endpoint there. | |
| 133 | + * | |
| 134 | + * @since 16.2 | |
| 135 | + * | |
| 136 | + * @return bool | |
| 137 | + */ | |
| 138 | + public static function is_enabled_for_content_guidelines() { | |
| 139 | + $default = false; | |
| 140 | + | |
| 141 | + if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) { | |
| 142 | + $default = true; | |
| 143 | + } else { | |
| 144 | + $host = new Automattic\Jetpack\Status\Host(); | |
| 145 | + if ( $host->is_woa_site() || $host->is_vip_site() ) { | |
| 146 | + $default = true; | |
| 147 | + } | |
| 148 | + } | |
| 149 | + | |
| 150 | + // The jetpack_ai_enabled filter runs inside the helper; the host and | |
| 151 | + // master gates apply after the chain and cannot be filtered back on. | |
| 152 | + return Jetpack_AI_Settings::is_ai_enabled( $default ); | |
| 153 | + } | |
| 154 | + | |
| 155 | + /** | |
| 156 | + * Whether the current user has dismissed the Content Guidelines AI | |
| 157 | + * empty-state banner. | |
| 158 | + * | |
| 159 | + * @since 16.1 | |
| 160 | + * | |
| 161 | + * @return bool | |
| 162 | + */ | |
| 163 | + public static function is_guidelines_banner_dismissed() { | |
| 164 | + return (bool) get_user_meta( get_current_user_id(), self::GUIDELINES_BANNER_DISMISSED_META_KEY, true ); | |
| 165 | + } | |
| 166 | + | |
| 167 | + /** | |
| 168 | + * Return true if the AI chat feature should be active on the current site. | |
| 169 | + * | |
| 170 | + * @todo IS_WPCOM (the endpoints need to be updated too). | |
| 171 | + * | |
| 172 | + * @return bool | |
| 173 | + */ | |
| 174 | + public static function is_ai_chat_enabled() { | |
| 175 | + $default = false; | |
| 176 | + | |
| 177 | + $connection = new Manager(); | |
| 178 | + $plan = new Search_Plan(); | |
| 179 | + if ( $connection->is_connected() && $plan->supports_search() ) { | |
| 180 | + $default = true; | |
| 181 | + } | |
| 182 | + | |
| 79 | 183 | /** |
| 80 | - * Filter whether the AI features are enabled in the Jetpack plugin. | |
| 184 | + * Filter whether the AI chat feature is enabled in the Jetpack plugin. | |
| 81 | 185 | * |
| 82 | - * @since 11.8 | |
| 186 | + * @since 12.6 | |
| 83 | 187 | * |
| 84 | - * @param bool $default Are AI features enabled? Defaults to false. | |
| 188 | + * @param bool $default Is AI chat enabled? Defaults to false. | |
| 85 | 189 | */ |
| 86 | - return apply_filters( 'jetpack_ai_enabled', $default ); | |
| 190 | + return apply_filters( 'jetpack_ai_chat_enabled', $default ); | |
| 87 | 191 | } |
| 88 | 192 | |
| 89 | 193 | /** |
| 90 | 194 | * Get the name of the transient for image generation. Unique per prompt and allows for reuse of results for the same prompt across entire WPCOM. |
| @@ -103,8 +207,18 @@ | ||
| 103 | 207 | return 'jetpack_openai_completion_' . get_current_user_id(); // Cache for each user, so that other users dont get weird cached version from somebody else. |
| 104 | 208 | } |
| 105 | 209 | |
| 106 | 210 | /** |
| 211 | + * Get the name of the transient for AI assistance feature. Unique per user. | |
| 212 | + * | |
| 213 | + * @param int $blog_id - Blog ID to get the transient name for. | |
| 214 | + * @return string | |
| 215 | + */ | |
| 216 | + public static function transient_name_for_ai_assistance_feature( $blog_id ) { | |
| 217 | + return 'jetpack_openai_ai_assistance_feature_' . $blog_id; | |
| 218 | + } | |
| 219 | + | |
| 220 | + /** | |
| 107 | 221 | * Mark the edited post as "touched" by AI stuff. |
| 108 | 222 | * |
| 109 | 223 | * @param int $post_id Post ID for which the content is being generated. |
| 110 | 224 | * @return void |
| @@ -163,10 +277,28 @@ | ||
| 163 | 277 | 'content' => $content, |
| 164 | 278 | ), |
| 165 | 279 | ); |
| 166 | 280 | |
| 167 | - $result = ( new OpenAI( 'openai', array( 'post_id' => $post_id ) ) )->request_chat_completion( $data ); | |
| 281 | + $openai = new OpenAI( 'openai', array( 'post_id' => $post_id ) ); | |
| 282 | + $moderation_result = $openai->moderate( | |
| 283 | + implode( | |
| 284 | + ' ', | |
| 285 | + array_map( | |
| 286 | + function ( $msg ) { | |
| 287 | + return $msg['role'] === 'user' ? $msg['content'] : ''; | |
| 288 | + }, | |
| 289 | + $data | |
| 290 | + ) | |
| 291 | + ) | |
| 292 | + ); | |
| 168 | 293 | |
| 294 | + if ( is_wp_error( $moderation_result ) ) { | |
| 295 | + return $moderation_result; | |
| 296 | + } | |
| 297 | + | |
| 298 | + $max_tokens = 480; // Default | |
| 299 | + $result = $openai->request_chat_completion( $data, $max_tokens ); | |
| 300 | + | |
| 169 | 301 | if ( is_wp_error( $result ) ) { |
| 170 | 302 | return $result; |
| 171 | 303 | } |
| 172 | 304 | |
| @@ -187,9 +319,10 @@ | ||
| 187 | 319 | ), |
| 188 | 320 | wp_json_encode( |
| 189 | 321 | array( |
| 190 | 322 | 'content' => $content, |
| 191 | - ) | |
| 323 | + ), | |
| 324 | + JSON_UNESCAPED_SLASHES | |
| 192 | 325 | ), |
| 193 | 326 | 'wpcom' |
| 194 | 327 | ); |
| 195 | 328 | |
| @@ -261,9 +394,10 @@ | ||
| 261 | 394 | ), |
| 262 | 395 | wp_json_encode( |
| 263 | 396 | array( |
| 264 | 397 | 'prompt' => $prompt, |
| 265 | - ) | |
| 398 | + ), | |
| 399 | + JSON_UNESCAPED_SLASHES | |
| 266 | 400 | ), |
| 267 | 401 | 'wpcom' |
| 268 | 402 | ); |
| 269 | 403 | |
| @@ -288,62 +422,69 @@ | ||
| 288 | 422 | * @return mixed |
| 289 | 423 | */ |
| 290 | 424 | public static function get_ai_assistance_feature() { |
| 291 | 425 | if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) { |
| 292 | - $has_ai_assistant_feature = \wpcom_site_has_feature( 'ai-assistant' ); | |
| 293 | - if ( ! class_exists( 'OpenAI' ) ) { | |
| 294 | - \require_lib( 'openai' ); | |
| 295 | - } | |
| 426 | + // On WPCOM, we can get the ID from the site. | |
| 427 | + $blog_id = get_current_blog_id(); | |
| 428 | + $has_ai_assistant_feature = \wpcom_site_has_feature( 'ai-assistant', $blog_id ); | |
| 296 | 429 | |
| 297 | - if ( ! class_exists( 'OpenAI_Limit_Usage' ) ) { | |
| 298 | - if ( is_readable( WP_PLUGIN_DIR . '/openai/openai-limit-usage.php' ) ) { | |
| 299 | - require_once WP_PLUGIN_DIR . '/openai/openai-limit-usage.php'; | |
| 430 | + if ( ! class_exists( 'WPCOM\Jetpack_AI\Usage\Helper' ) ) { | |
| 431 | + if ( is_readable( WP_CONTENT_DIR . '/lib/jetpack-ai/usage/helper.php' ) ) { | |
| 432 | + require_once WP_CONTENT_DIR . '/lib/jetpack-ai/usage/helper.php'; | |
| 300 | 433 | } else { |
| 301 | 434 | return new WP_Error( |
| 302 | - 'openai_limit_usage_not_found', | |
| 303 | - __( 'OpenAI_Limit_Usage class not found.', 'jetpack' ) | |
| 435 | + 'jetpack_ai_usage_helper_not_found', | |
| 436 | + __( 'WPCOM\Jetpack_AI\Usage\Helper class not found.', 'jetpack' ) | |
| 304 | 437 | ); |
| 305 | 438 | } |
| 306 | 439 | } |
| 307 | 440 | |
| 308 | - if ( ! class_exists( 'OpenAI_Request_Count' ) ) { | |
| 309 | - if ( is_readable( WP_PLUGIN_DIR . '/openai/openai-request-count.php' ) ) { | |
| 310 | - require_once WP_PLUGIN_DIR . '/openai/openai-request-count.php'; | |
| 441 | + if ( ! class_exists( 'WPCOM\Jetpack_AI\Feature_Control' ) ) { | |
| 442 | + if ( is_readable( WP_CONTENT_DIR . '/lib/jetpack-ai/feature-control.php' ) ) { | |
| 443 | + require_once WP_CONTENT_DIR . '/lib/jetpack-ai/feature-control.php'; | |
| 311 | 444 | } else { |
| 312 | 445 | return new WP_Error( |
| 313 | - 'openai_request_count_not_found', | |
| 314 | - __( 'OpenAI_Request_Count class not found.', 'jetpack' ) | |
| 446 | + 'jetpack_ai_feature_control_not_found', | |
| 447 | + __( 'WPCOM\Jetpack_AI\Feature_Control class not found.', 'jetpack' ) | |
| 315 | 448 | ); |
| 316 | 449 | } |
| 317 | 450 | } |
| 318 | 451 | |
| 319 | - $blog_id = get_current_blog_id(); | |
| 320 | - $is_over_limit = \OpenAI_Limit_Usage::is_blog_over_request_limit( $blog_id ); | |
| 321 | - $requests_limit = \OpenAI_Limit_Usage::NUM_FREE_REQUESTS_LIMIT; | |
| 322 | - $requests_count = \OpenAI_Request_Count::get_count( $blog_id ); | |
| 452 | + // Determine the upgrade type | |
| 453 | + $upgrade_type = wpcom_is_vip( $blog_id ) ? 'vip' : 'default'; | |
| 323 | 454 | |
| 324 | - /* | |
| 325 | - * Check if the site requires an upgrade. | |
| 326 | - * Ideally, the feature availability | |
| 327 | - * should support site-type handling. | |
| 328 | - * @todo: research how to do it. | |
| 329 | - */ | |
| 330 | - $blogs_details = get_blog_details( $blog_id ); | |
| 331 | - $is_jetpack_site = is_blog_jetpack( $blogs_details ) && ! is_blog_atomic( $blogs_details ); | |
| 332 | - $require_upgrade = $is_jetpack_site ? | |
| 333 | - $is_over_limit && ! $has_ai_assistant_feature : | |
| 334 | - false; | |
| 335 | - | |
| 336 | 455 | return array( |
| 337 | 456 | 'has-feature' => $has_ai_assistant_feature, |
| 338 | - 'is-over-limit' => $is_over_limit, | |
| 339 | - 'requests-count' => $requests_count, | |
| 340 | - 'requests-limit' => $requests_limit, | |
| 341 | - 'site-require-upgrade' => $require_upgrade, | |
| 457 | + 'is-over-limit' => WPCOM\Jetpack_AI\Usage\Helper::is_over_limit( $blog_id ), | |
| 458 | + 'requests-count' => WPCOM\Jetpack_AI\Usage\Helper::get_all_time_requests_count( $blog_id ), | |
| 459 | + 'requests-limit' => WPCOM\Jetpack_AI\Usage\Helper::get_free_requests_limit( $blog_id ), | |
| 460 | + 'usage-period' => WPCOM\Jetpack_AI\Usage\Helper::get_period_data( $blog_id ), | |
| 461 | + 'site-require-upgrade' => WPCOM\Jetpack_AI\Usage\Helper::site_requires_upgrade( $blog_id ), | |
| 462 | + 'upgrade-type' => $upgrade_type, | |
| 463 | + 'upgrade-url' => WPCOM\Jetpack_AI\Usage\Helper::get_upgrade_url( $blog_id ), | |
| 464 | + 'current-tier' => WPCOM\Jetpack_AI\Usage\Helper::get_current_tier( $blog_id ), | |
| 465 | + 'next-tier' => WPCOM\Jetpack_AI\Usage\Helper::get_next_tier( $blog_id ), | |
| 466 | + 'tier-plans' => WPCOM\Jetpack_AI\Usage\Helper::get_tier_plans_list(), | |
| 467 | + 'tier-plans-enabled' => WPCOM\Jetpack_AI\Usage\Helper::ai_tier_plans_enabled(), | |
| 468 | + 'costs' => WPCOM\Jetpack_AI\Usage\Helper::get_costs(), | |
| 469 | + 'features-control' => WPCOM\Jetpack_AI\Feature_Control::get_features(), | |
| 342 | 470 | ); |
| 343 | 471 | } |
| 344 | 472 | |
| 345 | - $blog_id = Jetpack_Options::get_option( 'id' ); | |
| 473 | + // Outside of WPCOM, we need to fetch the data from the site. | |
| 474 | + $blog_id = Jetpack_Options::get_option( 'id' ); | |
| 475 | + | |
| 476 | + // Try to pick the AI Assistant feature from cache. | |
| 477 | + $transient_name = self::transient_name_for_ai_assistance_feature( $blog_id ); | |
| 478 | + $cache = get_transient( $transient_name ); | |
| 479 | + if ( $cache ) { | |
| 480 | + return $cache; | |
| 481 | + } | |
| 482 | + | |
| 483 | + if ( null !== static::$ai_assistant_failed_request ) { | |
| 484 | + return static::$ai_assistant_failed_request; | |
| 485 | + } | |
| 486 | + | |
| 346 | 487 | $request_path = sprintf( '/sites/%d/jetpack-ai/ai-assistant-feature', $blog_id ); |
| 347 | 488 | |
| 348 | 489 | $wpcom_request = Client::wpcom_json_api_request_as_user( |
| 349 | 490 | $request_path, |
| @@ -352,8 +493,9 @@ | ||
| 352 | 493 | 'method' => 'GET', |
| 353 | 494 | 'headers' => array( |
| 354 | 495 | 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ), |
| 355 | 496 | ), |
| 497 | + 'timeout' => 30, | |
| 356 | 498 | ), |
| 357 | 499 | null, |
| 358 | 500 | 'wpcom' |
| 359 | 501 | ); |
| @@ -359,14 +501,29 @@ | ||
| 359 | 501 | ); |
| 360 | 502 | |
| 361 | 503 | $response_code = wp_remote_retrieve_response_code( $wpcom_request ); |
| 362 | 504 | if ( 200 === $response_code ) { |
| 363 | - return json_decode( wp_remote_retrieve_body( $wpcom_request ) ); | |
| 505 | + $ai_assistant_feature_data = json_decode( wp_remote_retrieve_body( $wpcom_request ), true ); | |
| 506 | + | |
| 507 | + // Cache the AI Assistant feature, for Jetpack sites. | |
| 508 | + set_transient( $transient_name, $ai_assistant_feature_data, self::$ai_assistant_feature_cache_timeout ); | |
| 509 | + | |
| 510 | + return $ai_assistant_feature_data; | |
| 364 | 511 | } else { |
| 365 | - return new WP_Error( | |
| 512 | + $error = new WP_Error( | |
| 366 | 513 | 'failed_to_fetch_data', |
| 367 | 514 | esc_html__( 'Unable to fetch the requested data.', 'jetpack' ), |
| 368 | - array( 'status' => $response_code ) | |
| 515 | + array( | |
| 516 | + 'status' => $response_code, | |
| 517 | + 'ts' => time(), | |
| 518 | + ) | |
| 369 | 519 | ); |
| 520 | + | |
| 521 | + // Cache the AI Assistant feature error, for Jetpack sites, avoid API hammering. | |
| 522 | + set_transient( $transient_name, $error, self::$ai_assistant_feature_error_cache_timeout ); | |
| 523 | + | |
| 524 | + static::$ai_assistant_failed_request = $error; | |
| 525 | + | |
| 526 | + return $error; | |
| 370 | 527 | } |
| 371 | 528 | } |
| 372 | 529 | } |
