Changeset 10173

Timestamp:

08/17/2020 05:23:02 AM (4 years ago)

Author:

tellyworth

Message:

Plugin dir: check for unique namespaces in the block checker.

This should permit block namespaces to be reused by the same author, but otherwise require that the namespace be unique.

See #5303.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• cli/class-block-plugin-checker.php (modified) (5 diffs)
• shortcodes/class-block-validator.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php

@@ -7 +7 @@
 use WordPressdotorg\Plugin_Directory\Block_JSON\Parser as Block_JSON_Parser;
 use WordPressdotorg\Plugin_Directory\Block_JSON\Validator as Block_JSON_Validator;
+use WordPressdotorg\Plugin_Directory\Plugin_Directory;
 
 /**
@@ -96 +97 @@
             }
         }
+    }
+
+    /**
+     * Return the namespace part of a block name.
+     *
+     * @param string $block The block name.
+     * @return string|bool The namespace, or false if the block name was invalid.
+     */
+    public function get_namespace( $block ) {
+        $parts = explode( '/', $block, 2 );
+        if ( 2 === count( $parts ) ) {
+            return $parts[0];
+        }
+        return false;
+    }
+
+    /**
+     * Return a list of contributors for a given plugin.
+     *
+     * @param WP_Post|int $post The post object or ID.
+     */
+    public function get_plugin_contributors( $post ) {
+        $post = get_post( $post );
+
+        $contributors = get_terms( array(
+            'taxonomy'   => 'plugin_contributors',
+            'object_ids' => array( $post->ID ),
+            'orderby'    => 'term_order',
+            'fields'     => 'names',
+        ) );
+
+        if ( is_wp_error( $contributors ) ) {
+            return array();
+        }
+
+        return $contributors;
     }
 
@@ -357 +394 @@
 
                 while ( $last = array_pop( $context ) ) {
-                    if ( T_STRING === $last[0] && function_exists( $last[1] ) ) {
+                    if ( is_array( $last ) && T_STRING === $last[0] && function_exists( $last[1] ) ) {
                         $function_calls[] = array( $last[1], $last[2], $file );
                     }
@@ -610 +647 @@
 
     /**
+     * Namespace shouldn't clash with other plugins.
+     */
+    function check_for_unique_namespace() {
+        $namespaces = array();
+        foreach ( $this->blocks as $block ) {
+            if ( $parts = explode( '/', $block->name ) ) {
+                $namespaces[] = $parts[0] . '/';
+            }
+        }
+
+        $namespaces = array_unique( $namespaces );
+
+        // Ignore known bogus namespaces
+        $namespaces = array_diff( $namespaces, array( 'cgb/', 'create-block/', 'example/', 'block/', 'core/' ) );
+
+        if ( count( $namespaces ) > 0 ) {
+            foreach ( $namespaces as $namespace ) {
+                $meta_query[] = array(
+                    'key'      => 'block_name',
+                    'value'    => $namespace,
+                    'compare'  => 'LIKE',
+                );
+            }
+            if ( count( $meta_query ) > 1 ) {
+                $meta_query[ 'relation' ] = 'OR';
+            }
+
+            $args = array(
+                'post_type' => 'plugin',
+                'post_status' => 'publish',
+                'nopaging' => true,
+                'meta_query' => $meta_query,
+            );
+
+            $query = new \WP_Query( $args );
+
+            foreach ( $query->posts as $post ) {
+                if ( $post->post_name === $this->slug ) {
+                    continue;
+                }
+
+                $blocks = get_post_meta( $post->ID, 'block_name', false );
+                foreach ( $blocks as $block ) {
+                    if ( in_array( $this->get_namespace( $block ) . '/', $namespaces ) ) {
+
+                        if ( $this->slug ) {
+                            // We're testing a plugin that's in the directory already, so we can check to see if the other plugin shares some contributors.
+
+                            $this_plugin_contribs = $this->get_plugin_contributors( Plugin_Directory::get_plugin_post( $this->slug ) );
+                            $other_plugin_contribs = $this->get_plugin_contributors( $post );
+
+                            if ( !array_intersect( $this_plugin_contribs, $other_plugin_contribs ) ) { 
+                                // If the other plugin has some contributors in common, it's probably fine to share a namespace.
+                                // If not, it's an error that needs to be fixed.
+                                $this->record_result(
+                                    __FUNCTION__,
+                                    'error',
+                                    // translators: %1$s is the namespace, %2$s is a link to the plugin.
+                                    sprintf( __( 'Please use a unique block namespace. Namespace %1$s is already used by %2$s.' ), 
+                                        '<code>' . $this->get_namespace( $block ) . '</code>', 
+                                        '<a href="' . esc_url( get_permalink( $post ) ) . '">' . esc_html( $post->post_title ) . '</a>'
+                                    )
+                                );
+                            }
+                        } else {
+                            // We're testing a plugin that's elsewhere (GitHub?) so we don't know its authors.
+                            // If the namespace is used by another plugin we'll just warn about it, since that might be by the same author.
+                            $this->record_result(
+                                __FUNCTION__,
+                                'warning',
+                                // translators: %1$s is the namespace, %2$s is a link to the plugin.
+                                sprintf( __( 'Please use a unique block namespace. Namespace %1$s is already used by %2$s.' ), 
+                                    '<code>' . $this->get_namespace( $block ) . '</code>', 
+                                    '<a href="' . esc_url( get_permalink( $post ) ) . '">' . esc_html( $post->post_title ) . '</a>'
+                                )
+                            );
+                        }
+                    }
+                }
+            }
+
+        }
+
+    }
+
+    /**
      * There should be at least one block.
      */
@@ -688 +811 @@
                     __( 'More than one top-level block was found: %s', 'wporg-plugins' ),
                     implode( ', ', $list )
-                ),
-                $block_name
+                )
             );
         }

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php

@@ -328 +328 @@
             case 'check_for_multiple_namespaces':
                 return __( 'Block plugins should contain a single main block. Any children blocks should use the same namespace prefix as the main block. Please ensure there are no extraneous blocks included by mistake.', 'wporg-plugins' );
+            case 'check_for_unique_namespace':
+                return __( 'Blocks should use a namespace that is unique to the plugin or its author. It appears this namespace is already in use by another author. If that’s not you then please ensure you choose a unique namespace for your blocks. The plugin slug is a good choice.' );
             // This is a special case, since multiple values may be collapsed.
             case 'check_block_json_is_valid':