| @@ -6,15 +6,14 @@ | ||
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | 8 | namespace Code_Snippets; |
| 9 | 9 | |
| 10 | -use Code_Snippets\Core\DB; | |
| 11 | -use Code_Snippets\Flat_Files\Snippet_Files; | |
| 12 | 10 | use Exception; |
| 13 | 11 | use Code_Snippets\Model\Snippet; |
| 14 | 12 | use Code_Snippets\Utils\Validator; |
| 15 | 13 | use Throwable; |
| 16 | 14 | use function Code_Snippets\Utils\get_self_option; |
| 15 | +use function Code_Snippets\Utils\validate_network_param; | |
| 17 | 16 | use function Code_Snippets\Utils\update_self_option; |
| 18 | 17 | |
| 19 | 18 | /** |
| 20 | 19 | * Get the locked status for a snippet from wp_options. |
| @@ -24,9 +23,9 @@ | ||
| 24 | 23 | * |
| 25 | 24 | * @return bool Whether the snippet is locked. |
| 26 | 25 | */ |
| 27 | 26 | function is_snippet_locked( int $snippet_id, ?bool $network = null ): bool { |
| 28 | - $network = DB::validate_network_param( $network ); | |
| 27 | + $network = validate_network_param( $network ); | |
| 29 | 28 | $locked_snippets = get_self_option( $network, 'code_snippets_locked', [] ); |
| 30 | 29 | |
| 31 | 30 | return isset( $locked_snippets[ $snippet_id ] ) && $locked_snippets[ $snippet_id ]; |
| 32 | 31 | } |
| @@ -40,9 +39,9 @@ | ||
| 40 | 39 | * |
| 41 | 40 | * @return void |
| 42 | 41 | */ |
| 43 | 42 | function set_snippet_locked( int $snippet_id, bool $locked, ?bool $network = null ): void { |
| 44 | - $network = DB::validate_network_param( $network ); | |
| 43 | + $network = validate_network_param( $network ); | |
| 45 | 44 | $locked_snippets = get_self_option( $network, 'code_snippets_locked', [] ); |
| 46 | 45 | |
| 47 | 46 | if ( $locked ) { |
| 48 | 47 | $locked_snippets[ $snippet_id ] = true; |
| @@ -64,9 +63,12 @@ | ||
| 64 | 63 | function clean_active_snippets_cache( string $table_name, $scopes = false ) { |
| 65 | 64 | $scope_groups = $scopes |
| 66 | 65 | ? [ $scopes ] |
| 67 | 66 | : [ |
| 67 | + // Content snippets. | |
| 68 | 68 | [ 'head-content', 'body-content', 'footer-content' ], |
| 69 | + | |
| 70 | + // Function snippets. | |
| 69 | 71 | [ 'global', 'single-use', 'front-end' ], |
| 70 | 72 | [ 'global', 'single-use', 'admin' ], |
| 71 | 73 | ]; |
| 72 | 74 | |
| @@ -88,8 +90,90 @@ | ||
| 88 | 90 | clean_active_snippets_cache( $table_name ); |
| 89 | 91 | } |
| 90 | 92 | |
| 91 | 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 | +/** | |
| 92 | 176 | * Retrieve a list of snippets from the database. |
| 93 | 177 | * Read operation. |
| 94 | 178 | * |
| 95 | 179 | * @param array<string> $ids The IDs of the snippets to fetch. |
| @@ -107,9 +191,9 @@ | ||
| 107 | 191 | if ( 1 === $ids_count ) { |
| 108 | 192 | return [ get_snippet( $ids[0], $network ) ]; |
| 109 | 193 | } |
| 110 | 194 | |
| 111 | - $network = DB::validate_network_param( $network ); | |
| 195 | + $network = validate_network_param( $network ); | |
| 112 | 196 | $table_name = code_snippets()->db->get_table_name( $network ); |
| 113 | 197 | |
| 114 | 198 | $snippets = wp_cache_get( "all_snippets_$table_name", CACHE_GROUP ); |
| 115 | 199 | |
| @@ -229,9 +313,9 @@ | ||
| 229 | 313 | function get_snippet( int $id = 0, ?bool $network = null ): ?Snippet { |
| 230 | 314 | global $wpdb; |
| 231 | 315 | |
| 232 | 316 | $id = absint( $id ); |
| 233 | - $network = DB::validate_network_param( $network ); | |
| 317 | + $network = validate_network_param( $network ); | |
| 234 | 318 | $table_name = code_snippets()->db->get_table_name( $network ); |
| 235 | 319 | |
| 236 | 320 | if ( 0 === $id ) { |
| 237 | 321 | // If an invalid ID is provided, then return an empty snippet object. |
| @@ -340,9 +424,9 @@ | ||
| 340 | 424 | * @since 2.0.0 |
| 341 | 425 | */ |
| 342 | 426 | function activate_snippet( int $id, ?bool $network = null ) { |
| 343 | 427 | global $wpdb; |
| 344 | - $network = DB::validate_network_param( $network ); | |
| 428 | + $network = validate_network_param( $network ); | |
| 345 | 429 | $table_name = code_snippets()->db->get_table_name( $network ); |
| 346 | 430 | |
| 347 | 431 | // Retrieve the snippet code from the database for validation before activating. |
| 348 | 432 | $snippet = get_snippet( $id, $network ); |
| @@ -389,9 +473,9 @@ | ||
| 389 | 473 | * @since 2.0.0 |
| 390 | 474 | */ |
| 391 | 475 | function activate_snippets( array $ids, ?bool $network = null ): ?array { |
| 392 | 476 | global $wpdb; |
| 393 | - $network = DB::validate_network_param( $network ); | |
| 477 | + $network = validate_network_param( $network ); | |
| 394 | 478 | $table_name = code_snippets()->db->get_table_name( $network ); |
| 395 | 479 | |
| 396 | 480 | $snippets = get_snippets( $ids, $network ); |
| 397 | 481 | |
| @@ -402,13 +486,28 @@ | ||
| 402 | 486 | // Loop through each snippet code and validate individually. |
| 403 | 487 | $valid_ids = []; |
| 404 | 488 | $valid_snippets = []; |
| 405 | 489 | |
| 490 | + // Names claimed by snippets already accepted into this batch. A snippet is | |
| 491 | + // otherwise validated only against what PHP has declared so far, which does | |
| 492 | + // not include the other snippets about to be activated alongside it. | |
| 493 | + $claimed_identifiers = []; | |
| 494 | + | |
| 406 | 495 | foreach ( $snippets as $snippet ) { |
| 407 | - $validator = new Validator( $snippet->code ); | |
| 496 | + // Only PHP is validated. The validator looks for redeclarations of | |
| 497 | + // existing PHP functions and classes, which says nothing meaningful | |
| 498 | + // about CSS or JavaScript. | |
| 499 | + if ( 'php' !== $snippet->type ) { | |
| 500 | + $valid_ids[] = $snippet->id; | |
| 501 | + $valid_snippets[] = $snippet; | |
| 502 | + continue; | |
| 503 | + } | |
| 504 | + | |
| 505 | + $validator = new Validator( $snippet->code, $claimed_identifiers ); | |
| 408 | 506 | $code_error = $validator->validate(); |
| 409 | 507 | |
| 410 | 508 | if ( ! $code_error ) { |
| 509 | + $claimed_identifiers = $validator->get_claimed_identifiers(); | |
| 411 | 510 | $valid_ids[] = $snippet->id; |
| 412 | 511 | $valid_snippets[] = $snippet; |
| 413 | 512 | } |
| 414 | 513 | } |
| @@ -446,9 +545,9 @@ | ||
| 446 | 545 | * @since 2.0.0 |
| 447 | 546 | */ |
| 448 | 547 | function deactivate_snippet( int $id, ?bool $network = null ): ?Snippet { |
| 449 | 548 | global $wpdb; |
| 450 | - $network = DB::validate_network_param( $network ); | |
| 549 | + $network = validate_network_param( $network ); | |
| 451 | 550 | $table = code_snippets()->db->get_table_name( $network ); |
| 452 | 551 | |
| 453 | 552 | // Set the snippet to inactive. |
| 454 | 553 | $result = $wpdb->update( |
| @@ -488,9 +587,9 @@ | ||
| 488 | 587 | * @since 2.0.0 |
| 489 | 588 | */ |
| 490 | 589 | function delete_snippet( int $id, ?bool $network = null ): bool { |
| 491 | 590 | global $wpdb; |
| 492 | - $network = DB::validate_network_param( $network ); | |
| 591 | + $network = validate_network_param( $network ); | |
| 493 | 592 | $table = code_snippets()->db->get_table_name( $network ); |
| 494 | 593 | |
| 495 | 594 | $snippet = get_snippet( $id, $network ); |
| 496 | 595 | |
| @@ -532,9 +631,9 @@ | ||
| 532 | 631 | * @since 3.8.0 |
| 533 | 632 | */ |
| 534 | 633 | function trash_snippet( int $id, ?bool $network = null ): bool { |
| 535 | 634 | global $wpdb; |
| 536 | - $network = DB::validate_network_param( $network ); | |
| 635 | + $network = validate_network_param( $network ); | |
| 537 | 636 | $table = code_snippets()->db->get_table_name( $network ); |
| 538 | 637 | |
| 539 | 638 | $snippet = get_snippet( $id, $network ); |
| 540 | 639 | |
| @@ -563,9 +662,9 @@ | ||
| 563 | 662 | * @since 3.8.0 |
| 564 | 663 | */ |
| 565 | 664 | function restore_snippet( int $id, ?bool $network = null ): bool { |
| 566 | 665 | global $wpdb; |
| 567 | - $network = DB::validate_network_param( $network ); | |
| 666 | + $network = validate_network_param( $network ); | |
| 568 | 667 | $table = code_snippets()->db->get_table_name( $network ); |
| 569 | 668 | |
| 570 | 669 | $result = $wpdb->update( $table, [ 'active' => '0' ], [ 'id' => $id ], [ '%d' ] ); |
| 571 | 670 | |
| @@ -643,13 +742,12 @@ | ||
| 643 | 742 | |
| 644 | 743 | // Update the last modification date if necessary. |
| 645 | 744 | $snippet->update_modified(); |
| 646 | 745 | |
| 746 | + // Strip any wrapper markup that came along with the pasted code. | |
| 747 | + $snippet->code = normalize_snippet_code( $snippet->code, $snippet->type ); | |
| 748 | + | |
| 647 | 749 | 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 | 750 | // Deactivate snippet if code contains errors. |
| 653 | 751 | if ( $snippet->active && 'single-use' !== $snippet->scope ) { |
| 654 | 752 | test_snippet_code( $snippet ); |
| 655 | 753 | |
| @@ -666,8 +764,13 @@ | ||
| 666 | 764 | |
| 667 | 765 | // Shared network snippets are always considered inactive. |
| 668 | 766 | $snippet->active = $snippet->active && ! $snippet->shared_network; |
| 669 | 767 | |
| 768 | + // Snippet authorship: track who created and who last edited each snippet. | |
| 769 | + // `created_by` is fixed at insert time; `updated_by` reflects every save. | |
| 770 | + $current_user_id = get_current_user_id(); | |
| 771 | + $author_id = $current_user_id > 0 ? $current_user_id : null; | |
| 772 | + | |
| 670 | 773 | // Build the list of data to insert (excluding locked, which is stored in wp_options). |
| 671 | 774 | $data = [ |
| 672 | 775 | 'name' => $snippet->name, |
| 673 | 776 | 'description' => $snippet->desc, |
| @@ -679,12 +782,14 @@ | ||
| 679 | 782 | 'active' => intval( $snippet->active ), |
| 680 | 783 | 'modified' => $snippet->modified, |
| 681 | 784 | 'revision' => $snippet->revision, |
| 682 | 785 | 'cloud_id' => $snippet->cloud_id_owner ? $snippet->cloud_id_owner : null, |
| 786 | + 'updated_by' => $author_id, | |
| 683 | 787 | ]; |
| 684 | 788 | |
| 685 | 789 | // Create a new snippet if the ID is not set. |
| 686 | 790 | if ( 0 === $snippet->id ) { |
| 791 | + $data['created_by'] = $author_id; | |
| 687 | 792 | $result = $wpdb->insert( $table, $data, '%s' ); |
| 688 | 793 | if ( false === $result ) { |
| 689 | 794 | return null; |
| 690 | 795 | } |
| @@ -730,8 +835,40 @@ | ||
| 730 | 835 | return $updated; |
| 731 | 836 | } |
| 732 | 837 | |
| 733 | 838 | /** |
| 839 | + * Resolve a user ID to a compact author object for display. | |
| 840 | + * | |
| 841 | + * Returns the user's ID, display name, and avatar URL, or null when the ID is | |
| 842 | + * empty or the user no longer exists. Results are cached per request, so a list | |
| 843 | + * of snippets sharing authors only triggers one lookup per distinct user. | |
| 844 | + * | |
| 845 | + * @param int $user_id User ID to resolve. | |
| 846 | + * | |
| 847 | + * @return array{id: int, display_name: string, avatar_url: string}|null | |
| 848 | + */ | |
| 849 | +function get_snippet_author( int $user_id ): ?array { | |
| 850 | + static $cache = []; | |
| 851 | + | |
| 852 | + if ( $user_id <= 0 ) { | |
| 853 | + return null; | |
| 854 | + } | |
| 855 | + | |
| 856 | + if ( ! array_key_exists( $user_id, $cache ) ) { | |
| 857 | + $user = get_userdata( $user_id ); | |
| 858 | + $cache[ $user_id ] = $user ? | |
| 859 | + [ | |
| 860 | + 'id' => $user_id, | |
| 861 | + 'display_name' => $user->display_name, | |
| 862 | + 'avatar_url' => (string) get_avatar_url( $user_id, [ 'size' => 32 ] ), | |
| 863 | + ] : | |
| 864 | + null; | |
| 865 | + } | |
| 866 | + | |
| 867 | + return $cache[ $user_id ]; | |
| 868 | +} | |
| 869 | + | |
| 870 | +/** | |
| 734 | 871 | * Execute a snippet. |
| 735 | 872 | * Execute operation. |
| 736 | 873 | * |
| 737 | 874 | * Code must NOT be escaped, as it will be executed directly. |
| @@ -785,9 +922,9 @@ | ||
| 785 | 922 | */ |
| 786 | 923 | function get_snippet_by_cloud_id( string $cloud_id, ?bool $multisite = null ): ?Snippet { |
| 787 | 924 | global $wpdb; |
| 788 | 925 | |
| 789 | - $multisite = DB::validate_network_param( $multisite ); | |
| 926 | + $multisite = validate_network_param( $multisite ); | |
| 790 | 927 | $table_name = code_snippets()->db->get_table_name( $multisite ); |
| 791 | 928 | |
| 792 | 929 | $cached_snippets = wp_cache_get( "all_snippets_$table_name", CACHE_GROUP ); |
| 793 | 930 | |
| @@ -813,8 +950,64 @@ | ||
| 813 | 950 | return apply_filters( 'code_snippets/get_snippet_by_cloud_id', $snippet, $cloud_id, $multisite ); |
| 814 | 951 | } |
| 815 | 952 | |
| 816 | 953 | /** |
| 954 | + * Remove the wrapper markup that a snippet's code does not need. | |
| 955 | + * | |
| 956 | + * Snippet code is stored bare: PHP is evaluated already inside PHP, and CSS and | |
| 957 | + * JavaScript are wrapped in their own tags when printed. People increasingly | |
| 958 | + * paste code generated by an AI assistant, which almost always arrives wrapped | |
| 959 | + * in the tags for its language and sometimes in a markdown code fence as well. | |
| 960 | + * | |
| 961 | + * Leaving that markup in place fails differently depending on the type, and all | |
| 962 | + * three ways are unhelpful. PHP raises a syntax error, so the snippet saves and | |
| 963 | + * is then quietly deactivated. CSS and JavaScript have no syntax check at all, | |
| 964 | + * so they save as active and emit doubled tags on the front end with nothing | |
| 965 | + * reported anywhere. | |
| 966 | + * | |
| 967 | + * Only a wrapper around the whole snippet is removed. Tags appearing partway | |
| 968 | + * through the code are left alone, since those are the author's own. | |
| 969 | + * | |
| 970 | + * @param string $code Snippet code as provided. | |
| 971 | + * @param string $type Snippet type: php, css, js or html. | |
| 972 | + * | |
| 973 | + * @return string Code with any surrounding wrapper markup removed. | |
| 974 | + */ | |
| 975 | +function normalize_snippet_code( string $code, string $type ): string { | |
| 976 | + // A markdown fence around the whole snippet, as copied from a chat window. | |
| 977 | + // The closing fence only goes when an opening one was there: on its own it | |
| 978 | + // is the author's content, as in an HTML snippet ending in backticks. | |
| 979 | + $code = preg_replace( '/\A\s*```[a-z]*[ \t]*\R/i', '', $code, 1, $fenced ); | |
| 980 | + | |
| 981 | + if ( $fenced ) { | |
| 982 | + $code = preg_replace( '/\R\s*```\s*\z/', '', $code ); | |
| 983 | + } | |
| 984 | + | |
| 985 | + switch ( $type ) { | |
| 986 | + case 'php': | |
| 987 | + // `php` is matched as a whole word so that `<?phpinfo()` is not | |
| 988 | + // mistaken for an opening tag followed by `info()`. | |
| 989 | + $code = preg_replace( '/\A\s*<\?(?:php\b)?/i', '', $code ); | |
| 990 | + $code = preg_replace( '/\?>\s*\z/', '', $code ); | |
| 991 | + break; | |
| 992 | + | |
| 993 | + case 'css': | |
| 994 | + $code = preg_replace( '/\A\s*<style\b[^>]*>/i', '', $code ); | |
| 995 | + $code = preg_replace( '/<\/style\s*>\s*\z/i', '', $code ); | |
| 996 | + break; | |
| 997 | + | |
| 998 | + case 'js': | |
| 999 | + $code = preg_replace( '/\A\s*<script\b[^>]*>/i', '', $code ); | |
| 1000 | + $code = preg_replace( '/<\/script\s*>\s*\z/i', '', $code ); | |
| 1001 | + break; | |
| 1002 | + } | |
| 1003 | + | |
| 1004 | + // Drop the single line break left behind by an opening tag on its own line, | |
| 1005 | + // so the stored code does not gain a blank first line each time. | |
| 1006 | + return preg_replace( '/\A\R/', '', $code ); | |
| 1007 | +} | |
| 1008 | + | |
| 1009 | +/** | |
| 817 | 1010 | * Update a snippet entry given a list of fields. |
| 818 | 1011 | * Write operation. |
| 819 | 1012 | * |
| 820 | 1013 | * @param int $snippet_id ID of the snippet to update. |
| @@ -823,9 +1016,9 @@ | ||
| 823 | 1016 | */ |
| 824 | 1017 | function update_snippet_fields( int $snippet_id, array $fields, ?bool $network = null ) { |
| 825 | 1018 | global $wpdb; |
| 826 | 1019 | |
| 827 | - $network = DB::validate_network_param( $network ); | |
| 1020 | + $network = validate_network_param( $network ); | |
| 828 | 1021 | $table = code_snippets()->db->get_table_name( $network ); |
| 829 | 1022 | |
| 830 | 1023 | // Build a new snippet object for the validation. |
| 831 | 1024 | $snippet = new Snippet(); |
