Changeset 10013

Timestamp:

07/06/2020 04:20:13 AM (5 years ago)

Author:

tellyworth

Message:

Plugin directory: add more validation rules.

Also improve a few existing rules.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php (modified) (7 diffs)

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

@@ -35 +35 @@
     protected $blocks = null;
     protected $block_json_files = null;
+    protected $asset_php_files = null;
     protected $block_json_validation = array();
 
@@ -44 +45 @@
     public function __construct( $slug = null ) {
         $this->slug = $slug;
+
+        add_filter( 'extra_plugin_headers', function( $extra_headers ) {
+            $extra_headers[ 'License' ] = 'License';
+            return $extra_headers;
+        } );
     }
 
@@ -204 +210 @@
             $this->block_json_validation[ $block_json_file ] = $validator->validate( $block_json );
         }
+
+        $this->asset_php_files = $this->find_asset_php_files( $this->path_to_plugin );
     }
 
@@ -261 +269 @@
 
     /**
+     * Find index.asset.php files as generated by the create block scripts.
+     */
+    public function find_asset_php_files( $base_dir ) {
+        return Filesystem::list_files( $base_dir, true, '!(:^|/)\w+\.asset\.php$!' );
+    }
+
+    /**
      * Used by check_*() functions to record info.
      *
@@ -297 +312 @@
      */
     function check_license() {
-        if ( empty( $this->readme->license ) ) {
+        if ( empty( $this->readme->license ) && empty( $this->headers->License ) ) {
             $this->record_result( __FUNCTION__,
                 'warning',
-                __( 'Missing license in readme.txt.', 'wporg-plugins' )
+                __( 'No plugin license was found.', 'wporg-plugins' )
+            );
+        } elseif ( !empty( $this->readme->license ) ) {
+            $this->record_result( __FUNCTION__,
+                'info',
+                sprintf( __( 'Found a license in readme.txt: %s.', 'wporg-plugins' ), $this->readme->license ),
+                $this->readme->license
+            );
+        } elseif ( !empty( $this->headers->License ) ) {
+            $this->record_result( __FUNCTION__,
+                'info',
+                sprintf( __( 'Found a license in plugin headers: %s.', 'wporg-plugins' ), $this->headers->License ),
+                $this->headers->License
+            );
+        }
+    }
+
+    /**
+     * Must have plugin headers.
+     */
+    function check_plugin_headers() {
+        if ( empty( $this->headers ) ) {
+            $this->record_result( __FUNCTION__,
+                'error',
+                __( 'Missing plugin headers. Is this a WordPress plugin?', 'wporg-plugins' )
+            );
+        }
+    }
+
+    /**
+     * Should have the 'block' tag.
+     */
+    function check_block_tag() {
+        if ( empty( $this->readme->tags ) || !in_array( 'block', array_map( 'strtolower', $this->readme_tags ) ) ) {
+            $this->record_result( __FUNCTION__,
+                'warning',
+                __( 'No block tag found in readme.txt.', 'wporg-plugins' ),
+                $this->readme->tags
             );
         } else {
             $this->record_result( __FUNCTION__,
                 'info',
-                __( 'Found a license in readme.txt.', 'wporg-plugins' ),
-                $this->readme->license
+                __( 'Found a block tag in readme.txt.', 'wporg-plugins' ),
+                $this->readme->tags
             );
         }
@@ -358 +410 @@
         } else {
             $this->record_result( __FUNCTION__,
-                'info',
+                ( count( $this->blocks ) < 5 ? 'info' : 'warning' ), // 5+ blocks suggests it's probably not a block plugin
                 sprintf( _n( 'Found %d block.', 'Found %d blocks.', count( $this->blocks ), 'wporg-plugins' ), count( $this->blocks ) ),
                 array_keys( $this->blocks )
@@ -505 +557 @@
         }
     }
+
+    /**
+     * Does it have an index.asset.php file generate by the create block scripts?
+     */
+    function check_asset_php_file() {
+        $count = 0;
+        foreach ( $this->asset_php_files as $file ) {
+            $contents = file_get_contents( $file );
+            if ( false !== strpos( $contents, '<?php return array(' ) )
+                ++ $count;
+        }
+
+        if ( 1 === $count ) {
+            $this->record_result( __FUNCTION__,
+                'info',
+                sprintf( __( 'PHP asset file found: %s.', 'wporg-plugins' ), $this->relative_filename( $file ) ),
+                $this->relative_filename( $file )
+            );
+        } elseif ( $count > 1 ) {
+            $this->record_result( __FUNCTION__,
+                'warning',
+                sprintf( __( 'Found %s PHP asset files.', 'wporg-plugins' ), $count ),
+                array_map( array( $this, relative_filename ), $this->asset_php_files )
+            );
+        }
+    }
+
+    /**
+     * Does it have a lot of PHP code?
+     */
+    function check_php_size() {
+        $php_files = Filesystem::list_files( $this->path_to_plugin, true, '!\.php$!i' );
+        $total_size = 0;
+        foreach ( $php_files as $file ) {
+            $total_size += filesize( $file );
+        }
+        if ( $total_size > 50 * KB_IN_BYTES ) {
+            $this->record_result( __FUNCTION__,
+                'error',
+                sprintf( __( 'Found %s of PHP code. Please submit PHP plugins to the plugin directory.', 'wporg-plugins' ), size_format( $total_size ) ),
+                $total_size
+            );
+        } elseif ( $total_size > 10 * KB_IN_BYTES ) {
+            $this->record_result( __FUNCTION__,
+                'warning',
+                sprintf( __( 'Found %s of PHP code. This might not be a block plugin.', 'wporg-plugins' ), size_format( $total_size ) ),
+                $total_size
+            );
+        } else {
+            $this->record_result( __FUNCTION__,
+                'info',
+                sprintf( __( 'Found %s of PHP code. Thanks for keeping it minimal!', 'wporg-plugins' ), size_format( $total_size ) ),
+                $total_size
+            );
+        }
+    }
 }