PluginProbe
Code Snippets / 4.0.0-beta.3
Code Snippets v4.0.0-beta.3
4.0.0-beta.3 4.0.0-beta.2 3.10.2 3.10.1 3.10.0 3.10.0-beta.2 3.10.0-beta.1 4.0.0-beta.1 3.9.6 trunk 2.10.0 2.10.1 2.12.0 2.12.1 2.13.0 2.13.1 2.13.2 2.13.3 2.14.0 2.14.1 2.14.2 2.14.3 2.14.4 2.14.5 2.14.6 All 66 releases
← All changes | php/snippet-ops.php +175 -24 3.10.2 → 4.0.0-beta.3 View file →
@@ -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
@@ -101,8 +103,24 @@
101 103 *
102 104 * @return bool Whether the group was flushed.
103 105 */
104 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 +
105 123 if ( ! function_exists( 'wp_cache_flush_group' ) ||
106 124 ! function_exists( 'wp_cache_supports' ) ||
107 125 ! wp_cache_supports( 'flush_group' ) ) {
108 126 return false;
@@ -107,9 +125,9 @@
107 125 ! wp_cache_supports( 'flush_group' ) ) {
108 126 return false;
109 127 }
110 128
111 - return (bool) wp_cache_flush_group( $group );
129 + return wp_cache_flush_group( $group );
112 130 }
113 131
114 132 /**
115 133 * Flush the cache groups belonging to other versions of the plugin.
@@ -128,12 +146,34 @@
128 146 // upgrading from 3.10.0 or 3.10.1 sheds the objects that would otherwise
129 147 // still be waiting to break its next rollback.
130 148 flush_cache_group( CACHE_GROUP_BASE );
131 149
132 - flush_cache_group( CACHE_GROUP );
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 + }
133 156 }
134 157
135 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 +/**
136 176 * Retrieve a list of snippets from the database.
137 177 * Read operation.
138 178 *
139 179 * @param array<string> $ids The IDs of the snippets to fetch.
@@ -151,9 +191,9 @@
151 191 if ( 1 === $ids_count ) {
152 192 return [ get_snippet( $ids[0], $network ) ];
153 193 }
154 194
155 - $network = DB::validate_network_param( $network );
195 + $network = validate_network_param( $network );
156 196 $table_name = code_snippets()->db->get_table_name( $network );
157 197
158 198 $snippets = wp_cache_get( "all_snippets_$table_name", CACHE_GROUP );
159 199
@@ -273,9 +313,9 @@
273 313 function get_snippet( int $id = 0, ?bool $network = null ): ?Snippet {
274 314 global $wpdb;
275 315
276 316 $id = absint( $id );
277 - $network = DB::validate_network_param( $network );
317 + $network = validate_network_param( $network );
278 318 $table_name = code_snippets()->db->get_table_name( $network );
279 319
280 320 if ( 0 === $id ) {
281 321 // If an invalid ID is provided, then return an empty snippet object.
@@ -384,9 +424,9 @@
384 424 * @since 2.0.0
385 425 */
386 426 function activate_snippet( int $id, ?bool $network = null ) {
387 427 global $wpdb;
388 - $network = DB::validate_network_param( $network );
428 + $network = validate_network_param( $network );
389 429 $table_name = code_snippets()->db->get_table_name( $network );
390 430
391 431 // Retrieve the snippet code from the database for validation before activating.
392 432 $snippet = get_snippet( $id, $network );
@@ -414,8 +454,13 @@
414 454 if ( ! $result ) {
415 455 return __( 'Could not activate snippet.', 'code-snippets' );
416 456 }
417 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 +
418 463 update_shared_network_snippets( [ $snippet ] );
419 464 do_action( 'code_snippets/activate_snippet', $snippet, $network );
420 465 clean_snippets_cache( $table_name );
421 466 return $snippet;
@@ -433,9 +478,9 @@
433 478 * @since 2.0.0
434 479 */
435 480 function activate_snippets( array $ids, ?bool $network = null ): ?array {
436 481 global $wpdb;
437 - $network = DB::validate_network_param( $network );
482 + $network = validate_network_param( $network );
438 483 $table_name = code_snippets()->db->get_table_name( $network );
439 484
440 485 $snippets = get_snippets( $ids, $network );
441 486
@@ -486,8 +531,10 @@
486 531 if ( ! $rows_updated ) {
487 532 return null;
488 533 }
489 534
535 + clean_snippets_cache( $table_name );
536 +
490 537 update_shared_network_snippets( $valid_snippets );
491 538 do_action( 'code_snippets/activate_snippets', $valid_snippets, $table_name );
492 539 clean_snippets_cache( $table_name );
493 540 return $valid_ids;
@@ -505,9 +552,9 @@
505 552 * @since 2.0.0
506 553 */
507 554 function deactivate_snippet( int $id, ?bool $network = null ): ?Snippet {
508 555 global $wpdb;
509 - $network = DB::validate_network_param( $network );
556 + $network = validate_network_param( $network );
510 557 $table = code_snippets()->db->get_table_name( $network );
511 558
512 559 // Set the snippet to inactive.
513 560 $result = $wpdb->update(
@@ -521,10 +568,14 @@
521 568 if ( ! $result ) {
522 569 return null;
523 570 }
524 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 +
525 577 // Update the recently active list.
526 - $snippet = get_snippet( $id );
527 578 $recently_active = get_self_option( $network, 'recently_active_snippets', [] );
528 579 $recently_active[ $id ] = time();
529 580 update_self_option( $network, 'recently_active_snippets', $recently_active );
530 581
@@ -547,9 +598,9 @@
547 598 * @since 2.0.0
548 599 */
549 600 function delete_snippet( int $id, ?bool $network = null ): bool {
550 601 global $wpdb;
551 - $network = DB::validate_network_param( $network );
602 + $network = validate_network_param( $network );
552 603 $table = code_snippets()->db->get_table_name( $network );
553 604
554 605 $snippet = get_snippet( $id, $network );
555 606
@@ -564,10 +615,10 @@
564 615 array( '%d' )
565 616 );
566 617
567 618 if ( $result ) {
619 + clean_snippets_cache( $table );
568 620 do_action( 'code_snippets/delete_snippet', $snippet, $network );
569 - clean_snippets_cache( $table );
570 621
571 622 $recently_active = get_self_option( $network, 'recently_active_snippets', [] );
572 623
573 624 if ( isset( $recently_active[ $id ] ) ) {
@@ -591,9 +642,9 @@
591 642 * @since 3.8.0
592 643 */
593 644 function trash_snippet( int $id, ?bool $network = null ): bool {
594 645 global $wpdb;
595 - $network = DB::validate_network_param( $network );
646 + $network = validate_network_param( $network );
596 647 $table = code_snippets()->db->get_table_name( $network );
597 648
598 649 $snippet = get_snippet( $id, $network );
599 650
@@ -603,10 +654,10 @@
603 654 }
604 655
605 656 $wpdb->update( $table, [ 'active' => '-1' ], [ 'id' => $id ], [ '%d' ] );
606 657
658 + clean_snippets_cache( $table );
607 659 do_action( 'code_snippets/trash_snippet', $snippet, $network );
608 - clean_snippets_cache( $table );
609 660
610 661 return true;
611 662 }
612 663
@@ -622,16 +673,16 @@
622 673 * @since 3.8.0
623 674 */
624 675 function restore_snippet( int $id, ?bool $network = null ): bool {
625 676 global $wpdb;
626 - $network = DB::validate_network_param( $network );
677 + $network = validate_network_param( $network );
627 678 $table = code_snippets()->db->get_table_name( $network );
628 679
629 680 $result = $wpdb->update( $table, [ 'active' => '0' ], [ 'id' => $id ], [ '%d' ] );
630 681
631 682 if ( $result ) {
683 + clean_snippets_cache( $table );
632 684 do_action( 'code_snippets/restore_snippet', $id, $network );
633 - clean_snippets_cache( $table );
634 685 }
635 686
636 687 return (bool) $result;
637 688 }
@@ -702,13 +753,12 @@
702 753
703 754 // Update the last modification date if necessary.
704 755 $snippet->update_modified();
705 756
757 + // Strip any wrapper markup that came along with the pasted code.
758 + $snippet->code = normalize_snippet_code( $snippet->code, $snippet->type );
759 +
706 760 if ( 'php' === $snippet->type ) {
707 - // Remove tags from beginning and end of snippet.
708 - $snippet->code = preg_replace( '|^\s*<\?(php)?|', '', $snippet->code );
709 - $snippet->code = preg_replace( '|\?>\s*$|', '', $snippet->code );
710 -
711 761 // Deactivate snippet if code contains errors.
712 762 if ( $snippet->active && 'single-use' !== $snippet->scope ) {
713 763 test_snippet_code( $snippet );
714 764
@@ -725,8 +775,13 @@
725 775
726 776 // Shared network snippets are always considered inactive.
727 777 $snippet->active = $snippet->active && ! $snippet->shared_network;
728 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 +
729 784 // Build the list of data to insert (excluding locked, which is stored in wp_options).
730 785 $data = [
731 786 'name' => $snippet->name,
732 787 'description' => $snippet->desc,
@@ -738,12 +793,14 @@
738 793 'active' => intval( $snippet->active ),
739 794 'modified' => $snippet->modified,
740 795 'revision' => $snippet->revision,
741 796 'cloud_id' => $snippet->cloud_id_owner ? $snippet->cloud_id_owner : null,
797 + 'updated_by' => $author_id,
742 798 ];
743 799
744 800 // Create a new snippet if the ID is not set.
745 801 if ( 0 === $snippet->id ) {
802 + $data['created_by'] = $author_id;
746 803 $result = $wpdb->insert( $table, $data, '%s' );
747 804 if ( false === $result ) {
748 805 return null;
749 806 }
@@ -763,8 +820,14 @@
763 820
764 821 set_snippet_locked( $snippet->id, $snippet->locked, $snippet->network );
765 822 $wpdb->update( $table, $data, [ 'id' => $snippet->id ], null, [ '%d' ] );
766 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 +
767 830 $updated = get_snippet( $snippet->id, $snippet->network );
768 831 $updated->code_error = $snippet->code_error;
769 832 $updated->code_error_trace = $snippet->code_error_trace;
770 833
@@ -789,8 +852,40 @@
789 852 return $updated;
790 853 }
791 854
792 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 +/**
793 888 * Execute a snippet.
794 889 * Execute operation.
795 890 *
796 891 * Code must NOT be escaped, as it will be executed directly.
@@ -844,9 +939,9 @@
844 939 */
845 940 function get_snippet_by_cloud_id( string $cloud_id, ?bool $multisite = null ): ?Snippet {
846 941 global $wpdb;
847 942
848 - $multisite = DB::validate_network_param( $multisite );
943 + $multisite = validate_network_param( $multisite );
849 944 $table_name = code_snippets()->db->get_table_name( $multisite );
850 945
851 946 $cached_snippets = wp_cache_get( "all_snippets_$table_name", CACHE_GROUP );
852 947
@@ -872,8 +967,64 @@
872 967 return apply_filters( 'code_snippets/get_snippet_by_cloud_id', $snippet, $cloud_id, $multisite );
873 968 }
874 969
875 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 +/**
876 1027 * Update a snippet entry given a list of fields.
877 1028 * Write operation.
878 1029 *
879 1030 * @param int $snippet_id ID of the snippet to update.
@@ -882,9 +1033,9 @@
882 1033 */
883 1034 function update_snippet_fields( int $snippet_id, array $fields, ?bool $network = null ) {
884 1035 global $wpdb;
885 1036
886 - $network = DB::validate_network_param( $network );
1037 + $network = validate_network_param( $network );
887 1038 $table = code_snippets()->db->get_table_name( $network );
888 1039
889 1040 // Build a new snippet object for the validation.
890 1041 $snippet = new Snippet();