| @@ -6,14 +6,14 @@ | ||
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | 8 | namespace Code_Snippets; |
| 9 | 9 | |
| 10 | -use Code_Snippets\Core\DB; | |
| 11 | 10 | use Exception; |
| 12 | 11 | use Code_Snippets\Model\Snippet; |
| 13 | 12 | use Code_Snippets\Utils\Validator; |
| 14 | 13 | use Throwable; |
| 15 | 14 | use function Code_Snippets\Utils\get_self_option; |
| 15 | +use function Code_Snippets\Utils\validate_network_param; | |
| 16 | 16 | use function Code_Snippets\Utils\update_self_option; |
| 17 | 17 | |
| 18 | 18 | /** |
| 19 | 19 | * Get the locked status for a snippet from wp_options. |
| @@ -23,9 +23,9 @@ | ||
| 23 | 23 | * |
| 24 | 24 | * @return bool Whether the snippet is locked. |
| 25 | 25 | */ |
| 26 | 26 | function is_snippet_locked( int $snippet_id, ?bool $network = null ): bool { |
| 27 | - $network = DB::validate_network_param( $network ); | |
| 27 | + $network = validate_network_param( $network ); | |
| 28 | 28 | $locked_snippets = get_self_option( $network, 'code_snippets_locked', [] ); |
| 29 | 29 | |
| 30 | 30 | return isset( $locked_snippets[ $snippet_id ] ) && $locked_snippets[ $snippet_id ]; |
| 31 | 31 | } |
| @@ -39,9 +39,9 @@ | ||
| 39 | 39 | * |
| 40 | 40 | * @return void |
| 41 | 41 | */ |
| 42 | 42 | function set_snippet_locked( int $snippet_id, bool $locked, ?bool $network = null ): void { |
| 43 | - $network = DB::validate_network_param( $network ); | |
| 43 | + $network = validate_network_param( $network ); | |
| 44 | 44 | $locked_snippets = get_self_option( $network, 'code_snippets_locked', [] ); |
| 45 | 45 | |
| 46 | 46 | if ( $locked ) { |
| 47 | 47 | $locked_snippets[ $snippet_id ] = true; |
| @@ -63,9 +63,12 @@ | ||
| 63 | 63 | function clean_active_snippets_cache( string $table_name, $scopes = false ) { |
| 64 | 64 | $scope_groups = $scopes |
| 65 | 65 | ? [ $scopes ] |
| 66 | 66 | : [ |
| 67 | + // Content snippets. | |
| 67 | 68 | [ 'head-content', 'body-content', 'footer-content' ], |
| 69 | + | |
| 70 | + // Function snippets. | |
| 68 | 71 | [ 'global', 'single-use', 'front-end' ], |
| 69 | 72 | [ 'global', 'single-use', 'admin' ], |
| 70 | 73 | ]; |
| 71 | 74 | |
| @@ -87,8 +90,90 @@ | ||
| 87 | 90 | clean_active_snippets_cache( $table_name ); |
| 88 | 91 | } |
| 89 | 92 | |
| 90 | 93 | /** |
| 94 | + * Flush an entire cache group, where the object cache supports it. | |
| 95 | + * | |
| 96 | + * Not all persistent cache drop-ins implement group flushing, and the function | |
| 97 | + * itself only exists from WordPress 6.1, so both are checked before use. A | |
| 98 | + * failure is not important: cache groups are scoped to the plugin version, so | |
| 99 | + * flushing is housekeeping rather than something correctness depends on, and | |
| 100 | + * anything left behind is evicted by the cache in its own time. | |
| 101 | + * | |
| 102 | + * @param string $group Cache group to flush. | |
| 103 | + * | |
| 104 | + * @return bool Whether the group was flushed. | |
| 105 | + */ | |
| 106 | +function flush_cache_group( string $group ): bool { | |
| 107 | + /** | |
| 108 | + * Short-circuits flushing a cache group. | |
| 109 | + * | |
| 110 | + * Returning a boolean skips the object cache entirely: false makes the | |
| 111 | + * caller fall back to deleting the known keys one by one, for a cache | |
| 112 | + * that reports group support it does not really have. | |
| 113 | + * | |
| 114 | + * @param bool|null $flushed Whether the group was flushed, or null to let the cache try. | |
| 115 | + * @param string $group Cache group. | |
| 116 | + */ | |
| 117 | + $flushed = apply_filters( 'code_snippets/pre_flush_cache_group', null, $group ); | |
| 118 | + | |
| 119 | + if ( null !== $flushed ) { | |
| 120 | + return (bool) $flushed; | |
| 121 | + } | |
| 122 | + | |
| 123 | + if ( ! function_exists( 'wp_cache_flush_group' ) || | |
| 124 | + ! function_exists( 'wp_cache_supports' ) || | |
| 125 | + ! wp_cache_supports( 'flush_group' ) ) { | |
| 126 | + return false; | |
| 127 | + } | |
| 128 | + | |
| 129 | + return wp_cache_flush_group( $group ); | |
| 130 | +} | |
| 131 | + | |
| 132 | +/** | |
| 133 | + * Flush the cache groups belonging to other versions of the plugin. | |
| 134 | + * | |
| 135 | + * @param string $previous_version Version the site was running beforehand. | |
| 136 | + * | |
| 137 | + * @return void | |
| 138 | + */ | |
| 139 | +function flush_versioned_cache_groups( string $previous_version ): void { | |
| 140 | + if ( '' !== $previous_version && PLUGIN_VERSION !== $previous_version ) { | |
| 141 | + flush_cache_group( CACHE_GROUP_BASE . '_' . $previous_version ); | |
| 142 | + } | |
| 143 | + | |
| 144 | + // Versions before the group was scoped wrote to the unscoped group, and no | |
| 145 | + // version that scopes it ever writes there again. Clearing it means a site | |
| 146 | + // upgrading from 3.10.0 or 3.10.1 sheds the objects that would otherwise | |
| 147 | + // still be waiting to break its next rollback. | |
| 148 | + flush_cache_group( CACHE_GROUP_BASE ); | |
| 149 | + | |
| 150 | + // Where the cache cannot flush a whole group, the keys this plugin writes | |
| 151 | + // are deleted one by one instead, so an uninstall followed by a reinstall | |
| 152 | + // of the same version cannot read snippets that no longer exist. | |
| 153 | + if ( ! flush_cache_group( CACHE_GROUP ) ) { | |
| 154 | + flush_known_cache_keys(); | |
| 155 | + } | |
| 156 | +} | |
| 157 | + | |
| 158 | +/** | |
| 159 | + * Delete every key this plugin is known to write in its current cache group. | |
| 160 | + * | |
| 161 | + * @return void | |
| 162 | + */ | |
| 163 | +function flush_known_cache_keys(): void { | |
| 164 | + // Both tables' keys go, whether this is a network: deleting a key | |
| 165 | + // that was never written does not cost anything, and it keeps one path to test. | |
| 166 | + $tables = [ code_snippets()->db->get_table_name( false ), code_snippets()->db->get_table_name( true ) ]; | |
| 167 | + | |
| 168 | + foreach ( array_unique( $tables ) as $table ) { | |
| 169 | + clean_snippets_cache( $table ); | |
| 170 | + } | |
| 171 | + | |
| 172 | + wp_cache_delete( Settings\CACHE_KEY, CACHE_GROUP ); | |
| 173 | +} | |
| 174 | + | |
| 175 | +/** | |
| 91 | 176 | * Retrieve a list of snippets from the database. |
| 92 | 177 | * Read operation. |
| 93 | 178 | * |
| 94 | 179 | * @param array<string> $ids The IDs of the snippets to fetch. |
| @@ -97,18 +182,18 @@ | ||
| 97 | 182 | * @return Snippet[] List of Snippet objects. |
| 98 | 183 | * |
| 99 | 184 | * @since 2.0 |
| 100 | 185 | */ |
| 101 | -function get_snippets( array $ids = array(), ?bool $network = null ): array { | |
| 186 | +function get_snippets( array $ids = [], ?bool $network = null ): array { | |
| 102 | 187 | global $wpdb; |
| 103 | 188 | |
| 104 | 189 | // If only one ID has been passed in, defer to the get_snippet() function. |
| 105 | 190 | $ids_count = count( $ids ); |
| 106 | 191 | if ( 1 === $ids_count ) { |
| 107 | - return array( get_snippet( $ids[0], $network ) ); | |
| 192 | + return [ get_snippet( $ids[0], $network ) ]; | |
| 108 | 193 | } |
| 109 | 194 | |
| 110 | - $network = DB::validate_network_param( $network ); | |
| 195 | + $network = validate_network_param( $network ); | |
| 111 | 196 | $table_name = code_snippets()->db->get_table_name( $network ); |
| 112 | 197 | |
| 113 | 198 | $snippets = wp_cache_get( "all_snippets_$table_name", CACHE_GROUP ); |
| 114 | 199 | |
| @@ -220,17 +305,17 @@ | ||
| 220 | 305 | * |
| 221 | 306 | * @param int $id The ID of the snippet to retrieve. 0 to build a new snippet. |
| 222 | 307 | * @param bool|null $network Retrieve a multisite-wide snippet (true) or site-wide snippet (false). |
| 223 | 308 | * |
| 224 | - * @return Snippet A single snippet object. | |
| 309 | + * @return ?Snippet A single snippet object. | |
| 225 | 310 | * |
| 226 | 311 | * @since 2.0.0 |
| 227 | 312 | */ |
| 228 | -function get_snippet( int $id = 0, ?bool $network = null ): Snippet { | |
| 313 | +function get_snippet( int $id = 0, ?bool $network = null ): ?Snippet { | |
| 229 | 314 | global $wpdb; |
| 230 | 315 | |
| 231 | 316 | $id = absint( $id ); |
| 232 | - $network = DB::validate_network_param( $network ); | |
| 317 | + $network = validate_network_param( $network ); | |
| 233 | 318 | $table_name = code_snippets()->db->get_table_name( $network ); |
| 234 | 319 | |
| 235 | 320 | if ( 0 === $id ) { |
| 236 | 321 | // If an invalid ID is provided, then return an empty snippet object. |
| @@ -339,9 +424,9 @@ | ||
| 339 | 424 | * @since 2.0.0 |
| 340 | 425 | */ |
| 341 | 426 | function activate_snippet( int $id, ?bool $network = null ) { |
| 342 | 427 | global $wpdb; |
| 343 | - $network = DB::validate_network_param( $network ); | |
| 428 | + $network = validate_network_param( $network ); | |
| 344 | 429 | $table_name = code_snippets()->db->get_table_name( $network ); |
| 345 | 430 | |
| 346 | 431 | // Retrieve the snippet code from the database for validation before activating. |
| 347 | 432 | $snippet = get_snippet( $id, $network ); |
| @@ -369,8 +454,13 @@ | ||
| 369 | 454 | if ( ! $result ) { |
| 370 | 455 | return __( 'Could not activate snippet.', 'code-snippets' ); |
| 371 | 456 | } |
| 372 | 457 | |
| 458 | + // Read back over a cleared cache, so what follows sees the snippet as | |
| 459 | + // active rather than as it was fetched for validation above. | |
| 460 | + clean_snippets_cache( $table_name ); | |
| 461 | + $snippet = get_snippet( $id, $network ); | |
| 462 | + | |
| 373 | 463 | update_shared_network_snippets( [ $snippet ] ); |
| 374 | 464 | do_action( 'code_snippets/activate_snippet', $snippet, $network ); |
| 375 | 465 | clean_snippets_cache( $table_name ); |
| 376 | 466 | return $snippet; |
| @@ -388,9 +478,9 @@ | ||
| 388 | 478 | * @since 2.0.0 |
| 389 | 479 | */ |
| 390 | 480 | function activate_snippets( array $ids, ?bool $network = null ): ?array { |
| 391 | 481 | global $wpdb; |
| 392 | - $network = DB::validate_network_param( $network ); | |
| 482 | + $network = validate_network_param( $network ); | |
| 393 | 483 | $table_name = code_snippets()->db->get_table_name( $network ); |
| 394 | 484 | |
| 395 | 485 | $snippets = get_snippets( $ids, $network ); |
| 396 | 486 | |
| @@ -401,13 +491,28 @@ | ||
| 401 | 491 | // Loop through each snippet code and validate individually. |
| 402 | 492 | $valid_ids = []; |
| 403 | 493 | $valid_snippets = []; |
| 404 | 494 | |
| 495 | + // Names claimed by snippets already accepted into this batch. A snippet is | |
| 496 | + // otherwise validated only against what PHP has declared so far, which does | |
| 497 | + // not include the other snippets about to be activated alongside it. | |
| 498 | + $claimed_identifiers = []; | |
| 499 | + | |
| 405 | 500 | foreach ( $snippets as $snippet ) { |
| 406 | - $validator = new Validator( $snippet->code ); | |
| 501 | + // Only PHP is validated. The validator looks for redeclarations of | |
| 502 | + // existing PHP functions and classes, which says nothing meaningful | |
| 503 | + // about CSS or JavaScript. | |
| 504 | + if ( 'php' !== $snippet->type ) { | |
| 505 | + $valid_ids[] = $snippet->id; | |
| 506 | + $valid_snippets[] = $snippet; | |
| 507 | + continue; | |
| 508 | + } | |
| 509 | + | |
| 510 | + $validator = new Validator( $snippet->code, $claimed_identifiers ); | |
| 407 | 511 | $code_error = $validator->validate(); |
| 408 | 512 | |
| 409 | 513 | if ( ! $code_error ) { |
| 514 | + $claimed_identifiers = $validator->get_claimed_identifiers(); | |
| 410 | 515 | $valid_ids[] = $snippet->id; |
| 411 | 516 | $valid_snippets[] = $snippet; |
| 412 | 517 | } |
| 413 | 518 | } |
| @@ -426,8 +531,10 @@ | ||
| 426 | 531 | if ( ! $rows_updated ) { |
| 427 | 532 | return null; |
| 428 | 533 | } |
| 429 | 534 | |
| 535 | + clean_snippets_cache( $table_name ); | |
| 536 | + | |
| 430 | 537 | update_shared_network_snippets( $valid_snippets ); |
| 431 | 538 | do_action( 'code_snippets/activate_snippets', $valid_snippets, $table_name ); |
| 432 | 539 | clean_snippets_cache( $table_name ); |
| 433 | 540 | return $valid_ids; |
| @@ -445,9 +552,9 @@ | ||
| 445 | 552 | * @since 2.0.0 |
| 446 | 553 | */ |
| 447 | 554 | function deactivate_snippet( int $id, ?bool $network = null ): ?Snippet { |
| 448 | 555 | global $wpdb; |
| 449 | - $network = DB::validate_network_param( $network ); | |
| 556 | + $network = validate_network_param( $network ); | |
| 450 | 557 | $table = code_snippets()->db->get_table_name( $network ); |
| 451 | 558 | |
| 452 | 559 | // Set the snippet to inactive. |
| 453 | 560 | $result = $wpdb->update( |
| @@ -461,11 +568,16 @@ | ||
| 461 | 568 | if ( ! $result ) { |
| 462 | 569 | return null; |
| 463 | 570 | } |
| 464 | 571 | |
| 572 | + // Read back over a cleared cache, so the snippet is seen as inactive by | |
| 573 | + // everything below rather than as it stood before the write. | |
| 574 | + clean_snippets_cache( $table ); | |
| 575 | + $snippet = get_snippet( $id, $network ); | |
| 576 | + | |
| 465 | 577 | // Update the recently active list. |
| 466 | - $snippet = get_snippet( $id ); | |
| 467 | - $recently_active = [ $id => time() ] + get_self_option( $network, 'recently_active_snippets', [] ); | |
| 578 | + $recently_active = get_self_option( $network, 'recently_active_snippets', [] ); | |
| 579 | + $recently_active[ $id ] = time(); | |
| 468 | 580 | update_self_option( $network, 'recently_active_snippets', $recently_active ); |
| 469 | 581 | |
| 470 | 582 | update_shared_network_snippets( [ $snippet ] ); |
| 471 | 583 | do_action( 'code_snippets/deactivate_snippet', $id, $network ); |
| @@ -486,9 +598,9 @@ | ||
| 486 | 598 | * @since 2.0.0 |
| 487 | 599 | */ |
| 488 | 600 | function delete_snippet( int $id, ?bool $network = null ): bool { |
| 489 | 601 | global $wpdb; |
| 490 | - $network = DB::validate_network_param( $network ); | |
| 602 | + $network = validate_network_param( $network ); | |
| 491 | 603 | $table = code_snippets()->db->get_table_name( $network ); |
| 492 | 604 | |
| 493 | 605 | $snippet = get_snippet( $id, $network ); |
| 494 | 606 | |
| @@ -503,11 +615,10 @@ | ||
| 503 | 615 | array( '%d' ) |
| 504 | 616 | ); |
| 505 | 617 | |
| 506 | 618 | if ( $result ) { |
| 619 | + clean_snippets_cache( $table ); | |
| 507 | 620 | do_action( 'code_snippets/delete_snippet', $snippet, $network ); |
| 508 | - clean_snippets_cache( $table ); | |
| 509 | - code_snippets()->cloud_api->delete_snippet_from_transient_data( $id ); | |
| 510 | 621 | |
| 511 | 622 | $recently_active = get_self_option( $network, 'recently_active_snippets', [] ); |
| 512 | 623 | |
| 513 | 624 | if ( isset( $recently_active[ $id ] ) ) { |
| @@ -531,9 +642,9 @@ | ||
| 531 | 642 | * @since 3.8.0 |
| 532 | 643 | */ |
| 533 | 644 | function trash_snippet( int $id, ?bool $network = null ): bool { |
| 534 | 645 | global $wpdb; |
| 535 | - $network = DB::validate_network_param( $network ); | |
| 646 | + $network = validate_network_param( $network ); | |
| 536 | 647 | $table = code_snippets()->db->get_table_name( $network ); |
| 537 | 648 | |
| 538 | 649 | $snippet = get_snippet( $id, $network ); |
| 539 | 650 | |
| @@ -543,11 +654,10 @@ | ||
| 543 | 654 | } |
| 544 | 655 | |
| 545 | 656 | $wpdb->update( $table, [ 'active' => '-1' ], [ 'id' => $id ], [ '%d' ] ); |
| 546 | 657 | |
| 658 | + clean_snippets_cache( $table ); | |
| 547 | 659 | do_action( 'code_snippets/trash_snippet', $snippet, $network ); |
| 548 | - clean_snippets_cache( $table ); | |
| 549 | - code_snippets()->cloud_api->delete_snippet_from_transient_data( $id ); | |
| 550 | 660 | |
| 551 | 661 | return true; |
| 552 | 662 | } |
| 553 | 663 | |
| @@ -563,16 +673,16 @@ | ||
| 563 | 673 | * @since 3.8.0 |
| 564 | 674 | */ |
| 565 | 675 | function restore_snippet( int $id, ?bool $network = null ): bool { |
| 566 | 676 | global $wpdb; |
| 567 | - $network = DB::validate_network_param( $network ); | |
| 677 | + $network = validate_network_param( $network ); | |
| 568 | 678 | $table = code_snippets()->db->get_table_name( $network ); |
| 569 | 679 | |
| 570 | 680 | $result = $wpdb->update( $table, [ 'active' => '0' ], [ 'id' => $id ], [ '%d' ] ); |
| 571 | 681 | |
| 572 | 682 | if ( $result ) { |
| 683 | + clean_snippets_cache( $table ); | |
| 573 | 684 | do_action( 'code_snippets/restore_snippet', $id, $network ); |
| 574 | - clean_snippets_cache( $table ); | |
| 575 | 685 | } |
| 576 | 686 | |
| 577 | 687 | return (bool) $result; |
| 578 | 688 | } |
| @@ -643,13 +753,12 @@ | ||
| 643 | 753 | |
| 644 | 754 | // Update the last modification date if necessary. |
| 645 | 755 | $snippet->update_modified(); |
| 646 | 756 | |
| 757 | + // Strip any wrapper markup that came along with the pasted code. | |
| 758 | + $snippet->code = normalize_snippet_code( $snippet->code, $snippet->type ); | |
| 759 | + | |
| 647 | 760 | if ( 'php' === $snippet->type ) { |
| 648 | - // Remove tags from beginning and end of snippet. | |
| 649 | - $snippet->code = preg_replace( '|^\s*<\?(php)?|', '', $snippet->code ); | |
| 650 | - $snippet->code = preg_replace( '|\?>\s*$|', '', $snippet->code ); | |
| 651 | - | |
| 652 | 761 | // Deactivate snippet if code contains errors. |
| 653 | 762 | if ( $snippet->active && 'single-use' !== $snippet->scope ) { |
| 654 | 763 | test_snippet_code( $snippet ); |
| 655 | 764 | |
| @@ -666,8 +775,13 @@ | ||
| 666 | 775 | |
| 667 | 776 | // Shared network snippets are always considered inactive. |
| 668 | 777 | $snippet->active = $snippet->active && ! $snippet->shared_network; |
| 669 | 778 | |
| 779 | + // Snippet authorship: track who created and who last edited each snippet. | |
| 780 | + // `created_by` is fixed at insert time; `updated_by` reflects every save. | |
| 781 | + $current_user_id = get_current_user_id(); | |
| 782 | + $author_id = $current_user_id > 0 ? $current_user_id : null; | |
| 783 | + | |
| 670 | 784 | // Build the list of data to insert (excluding locked, which is stored in wp_options). |
| 671 | 785 | $data = [ |
| 672 | 786 | 'name' => $snippet->name, |
| 673 | 787 | 'description' => $snippet->desc, |
| @@ -678,13 +792,15 @@ | ||
| 678 | 792 | 'priority' => $snippet->priority, |
| 679 | 793 | 'active' => intval( $snippet->active ), |
| 680 | 794 | 'modified' => $snippet->modified, |
| 681 | 795 | 'revision' => $snippet->revision, |
| 682 | - 'cloud_id' => $snippet->cloud_id ? $snippet->cloud_id : null, | |
| 796 | + 'cloud_id' => $snippet->cloud_id_owner ? $snippet->cloud_id_owner : null, | |
| 797 | + 'updated_by' => $author_id, | |
| 683 | 798 | ]; |
| 684 | 799 | |
| 685 | 800 | // Create a new snippet if the ID is not set. |
| 686 | 801 | if ( 0 === $snippet->id ) { |
| 802 | + $data['created_by'] = $author_id; | |
| 687 | 803 | $result = $wpdb->insert( $table, $data, '%s' ); |
| 688 | 804 | if ( false === $result ) { |
| 689 | 805 | return null; |
| 690 | 806 | } |
| @@ -689,9 +805,9 @@ | ||
| 689 | 805 | return null; |
| 690 | 806 | } |
| 691 | 807 | |
| 692 | 808 | $snippet->id = $wpdb->insert_id; |
| 693 | - $updated = get_snippet( $snippet->id ); | |
| 809 | + $updated = get_snippet( $snippet->id, $snippet->network ); | |
| 694 | 810 | $updated->code_error = $snippet->code_error; |
| 695 | 811 | $updated->code_error_trace = $snippet->code_error_trace; |
| 696 | 812 | do_action( 'code_snippets/create_snippet', $updated, $table ); |
| 697 | 813 | |
| @@ -704,8 +820,14 @@ | ||
| 704 | 820 | |
| 705 | 821 | set_snippet_locked( $snippet->id, $snippet->locked, $snippet->network ); |
| 706 | 822 | $wpdb->update( $table, $data, [ 'id' => $snippet->id ], null, [ '%d' ] ); |
| 707 | 823 | |
| 824 | + // The row has changed, so the cached list no longer describes it. It is | |
| 825 | + // dropped before the snippet is read back, because everything below — | |
| 826 | + // the value this returns and what its hooks are handed — has to be the | |
| 827 | + // saved snippet rather than the one that was there beforehand. | |
| 828 | + clean_snippets_cache( $table ); | |
| 829 | + | |
| 708 | 830 | $updated = get_snippet( $snippet->id, $snippet->network ); |
| 709 | 831 | $updated->code_error = $snippet->code_error; |
| 710 | 832 | $updated->code_error_trace = $snippet->code_error_trace; |
| 711 | 833 | |
| @@ -711,9 +833,10 @@ | ||
| 711 | 833 | |
| 712 | 834 | do_action( 'code_snippets/update_snippet', $updated, $table, $existing, $snippet ); |
| 713 | 835 | |
| 714 | 836 | if ( ! $updated->active && $existing->active ) { |
| 715 | - $recently_active = [ $updated->id => time() ] + get_self_option( $updated->network, 'recently_active_snippets', [] ); | |
| 837 | + $recently_active = get_self_option( $updated->network, 'recently_active_snippets', [] ); | |
| 838 | + $recently_active[ $updated->id ] = time(); | |
| 716 | 839 | update_self_option( $updated->network, 'recently_active_snippets', $recently_active ); |
| 717 | 840 | } elseif ( ! $updated->active ) { |
| 718 | 841 | $recently_active = get_self_option( $updated->network, 'recently_active_snippets', [] ); |
| 719 | 842 | |
| @@ -729,8 +852,40 @@ | ||
| 729 | 852 | return $updated; |
| 730 | 853 | } |
| 731 | 854 | |
| 732 | 855 | /** |
| 856 | + * Resolve a user ID to a compact author object for display. | |
| 857 | + * | |
| 858 | + * Returns the user's ID, display name, and avatar URL, or null when the ID is | |
| 859 | + * empty or the user no longer exists. Results are cached per request, so a list | |
| 860 | + * of snippets sharing authors only triggers one lookup per distinct user. | |
| 861 | + * | |
| 862 | + * @param int $user_id User ID to resolve. | |
| 863 | + * | |
| 864 | + * @return array{id: int, display_name: string, avatar_url: string}|null | |
| 865 | + */ | |
| 866 | +function get_snippet_author( int $user_id ): ?array { | |
| 867 | + static $cache = []; | |
| 868 | + | |
| 869 | + if ( $user_id <= 0 ) { | |
| 870 | + return null; | |
| 871 | + } | |
| 872 | + | |
| 873 | + if ( ! array_key_exists( $user_id, $cache ) ) { | |
| 874 | + $user = get_userdata( $user_id ); | |
| 875 | + $cache[ $user_id ] = $user ? | |
| 876 | + [ | |
| 877 | + 'id' => $user_id, | |
| 878 | + 'display_name' => $user->display_name, | |
| 879 | + 'avatar_url' => (string) get_avatar_url( $user_id, [ 'size' => 32 ] ), | |
| 880 | + ] : | |
| 881 | + null; | |
| 882 | + } | |
| 883 | + | |
| 884 | + return $cache[ $user_id ]; | |
| 885 | +} | |
| 886 | + | |
| 887 | +/** | |
| 733 | 888 | * Execute a snippet. |
| 734 | 889 | * Execute operation. |
| 735 | 890 | * |
| 736 | 891 | * Code must NOT be escaped, as it will be executed directly. |
| @@ -784,9 +939,9 @@ | ||
| 784 | 939 | */ |
| 785 | 940 | function get_snippet_by_cloud_id( string $cloud_id, ?bool $multisite = null ): ?Snippet { |
| 786 | 941 | global $wpdb; |
| 787 | 942 | |
| 788 | - $multisite = DB::validate_network_param( $multisite ); | |
| 943 | + $multisite = validate_network_param( $multisite ); | |
| 789 | 944 | $table_name = code_snippets()->db->get_table_name( $multisite ); |
| 790 | 945 | |
| 791 | 946 | $cached_snippets = wp_cache_get( "all_snippets_$table_name", CACHE_GROUP ); |
| 792 | 947 | |
| @@ -812,8 +967,64 @@ | ||
| 812 | 967 | return apply_filters( 'code_snippets/get_snippet_by_cloud_id', $snippet, $cloud_id, $multisite ); |
| 813 | 968 | } |
| 814 | 969 | |
| 815 | 970 | /** |
| 971 | + * Remove the wrapper markup that a snippet's code does not need. | |
| 972 | + * | |
| 973 | + * Snippet code is stored bare: PHP is evaluated already inside PHP, and CSS and | |
| 974 | + * JavaScript are wrapped in their own tags when printed. People increasingly | |
| 975 | + * paste code generated by an AI assistant, which almost always arrives wrapped | |
| 976 | + * in the tags for its language and sometimes in a markdown code fence as well. | |
| 977 | + * | |
| 978 | + * Leaving that markup in place fails differently depending on the type, and all | |
| 979 | + * three ways are unhelpful. PHP raises a syntax error, so the snippet saves and | |
| 980 | + * is then quietly deactivated. CSS and JavaScript have no syntax check at all, | |
| 981 | + * so they save as active and emit doubled tags on the front end with nothing | |
| 982 | + * reported anywhere. | |
| 983 | + * | |
| 984 | + * Only a wrapper around the whole snippet is removed. Tags appearing partway | |
| 985 | + * through the code are left alone, since those are the author's own. | |
| 986 | + * | |
| 987 | + * @param string $code Snippet code as provided. | |
| 988 | + * @param string $type Snippet type: php, css, js or html. | |
| 989 | + * | |
| 990 | + * @return string Code with any surrounding wrapper markup removed. | |
| 991 | + */ | |
| 992 | +function normalize_snippet_code( string $code, string $type ): string { | |
| 993 | + // A markdown fence around the whole snippet, as copied from a chat window. | |
| 994 | + // The closing fence only goes when an opening one was there: on its own it | |
| 995 | + // is the author's content, as in an HTML snippet ending in backticks. | |
| 996 | + $code = preg_replace( '/\A\s*```[a-z]*[ \t]*\R/i', '', $code, 1, $fenced ); | |
| 997 | + | |
| 998 | + if ( $fenced ) { | |
| 999 | + $code = preg_replace( '/\R\s*```\s*\z/', '', $code ); | |
| 1000 | + } | |
| 1001 | + | |
| 1002 | + switch ( $type ) { | |
| 1003 | + case 'php': | |
| 1004 | + // `php` is matched as a whole word so that `<?phpinfo()` is not | |
| 1005 | + // mistaken for an opening tag followed by `info()`. | |
| 1006 | + $code = preg_replace( '/\A\s*<\?(?:php\b)?/i', '', $code ); | |
| 1007 | + $code = preg_replace( '/\?>\s*\z/', '', $code ); | |
| 1008 | + break; | |
| 1009 | + | |
| 1010 | + case 'css': | |
| 1011 | + $code = preg_replace( '/\A\s*<style\b[^>]*>/i', '', $code ); | |
| 1012 | + $code = preg_replace( '/<\/style\s*>\s*\z/i', '', $code ); | |
| 1013 | + break; | |
| 1014 | + | |
| 1015 | + case 'js': | |
| 1016 | + $code = preg_replace( '/\A\s*<script\b[^>]*>/i', '', $code ); | |
| 1017 | + $code = preg_replace( '/<\/script\s*>\s*\z/i', '', $code ); | |
| 1018 | + break; | |
| 1019 | + } | |
| 1020 | + | |
| 1021 | + // Drop the single line break left behind by an opening tag on its own line, | |
| 1022 | + // so the stored code does not gain a blank first line each time. | |
| 1023 | + return preg_replace( '/\A\R/', '', $code ); | |
| 1024 | +} | |
| 1025 | + | |
| 1026 | +/** | |
| 816 | 1027 | * Update a snippet entry given a list of fields. |
| 817 | 1028 | * Write operation. |
| 818 | 1029 | * |
| 819 | 1030 | * @param int $snippet_id ID of the snippet to update. |
| @@ -822,8 +1033,9 @@ | ||
| 822 | 1033 | */ |
| 823 | 1034 | function update_snippet_fields( int $snippet_id, array $fields, ?bool $network = null ) { |
| 824 | 1035 | global $wpdb; |
| 825 | 1036 | |
| 1037 | + $network = validate_network_param( $network ); | |
| 826 | 1038 | $table = code_snippets()->db->get_table_name( $network ); |
| 827 | 1039 | |
| 828 | 1040 | // Build a new snippet object for the validation. |
| 829 | 1041 | $snippet = new Snippet(); |
| @@ -856,14 +1068,13 @@ | ||
| 856 | 1068 | if ( null !== $locked_value ) { |
| 857 | 1069 | set_snippet_locked( $snippet->id, $locked_value, $network ); |
| 858 | 1070 | } |
| 859 | 1071 | |
| 1072 | + clean_snippets_cache( $table ); | |
| 860 | 1073 | $updated = get_snippet( $snippet->id, $network ); |
| 861 | 1074 | if ( $updated->id ) { |
| 862 | 1075 | do_action( 'code_snippets/update_snippet', $updated, $table ); |
| 863 | 1076 | } |
| 864 | - | |
| 865 | - clean_snippets_cache( $table ); | |
| 866 | 1077 | } |
| 867 | 1078 | |
| 868 | 1079 | /** |
| 869 | 1080 | * Evaluate a snippet by loading it from the filesystem. |
| @@ -872,9 +1083,9 @@ | ||
| 872 | 1083 | * @param string $file Snippet filename. |
| 873 | 1084 | * @param int $id Snippet ID. |
| 874 | 1085 | * @param bool $force Force snippet execution, even if save mode is active. |
| 875 | 1086 | * |
| 876 | - * @return bool|Throwable|null | |
| 1087 | + * @return bool|Exception|Throwable|null Code error if encountered during execution, or result of snippet execution otherwise. | |
| 877 | 1088 | */ |
| 878 | 1089 | function execute_snippet_from_flat_file( string $code, string $file, int $id = 0, bool $force = false ) { |
| 879 | 1090 | if ( ! is_file( $file ) ) { |
| 880 | 1091 | execute_snippet( $code, $id, $force ); |
