Add code style check and build script (pluginkollektiv#202)

* Add minify script, remove *.min.css * Add code style check for CSS, fix existing violations * Add code style check for PHP (WP CS + PHP compatibility) * Rename files and variables according to WP code style * Escape output according to WP code style, fix multiple assignments and prepared statement * Fix input sanitization errors * Update GitHub actions to include composer install * Use latest version of the composer action, simply nonce sanitization * Fix .gitattributes, add .distignore * add .distignore to .gitattributes export-ignore * update NPM dev dependencies Co-authored-by: Stefan Kalscheuer <[email protected]>
timse201 · Feb 7, 2021 · f8326db · f8326db
1 parent 1e21870
commit f8326db
Show file tree

Hide file tree

Showing 32 changed files with 3,399 additions and 283 deletions.
diff --git a/.distignore b/.distignore
@@ -0,0 +1,18 @@
+# Directories
+/.git
+/.github
+/.wordpress-org
+/node_modules
+/vendor
+
+# Files
+/.distignore
+/.editorconfig
+/.gitattributes
+/.gitignore
+/.stylelintrc.json
+/composer.json
+/composer.lock
+/package.json
+/package-lock.json
+/phpcs.xml
diff --git a/.gitattributes b/.gitattributes
@@ -2,11 +2,16 @@
 /.github export-ignore
 /.wordpress-org export-ignore
 /node_modules export-ignore
+/vendor export-ignore
 
 # Files
+/.distignore export-ignore
 /.editorconfig export-ignore
 /.gitattributes export-ignore
 /.gitignore export-ignore
-/Gruntfile.js export-ignore
+/.stylelintrc.json export-ignore
 /composer.json export-ignore
+/composer.lock export-ignore
 /package.json export-ignore
+/package-lock.json export-ignore
+/phpcs.xml export-ignore
diff --git a/.github/workflows/wordpress-plugin-asset-update.yml b/.github/workflows/wordpress-plugin-asset-update.yml
@@ -8,10 +8,11 @@ jobs:
     name: Push to master
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v2
+    - uses: php-actions/composer@v5
     - name: WordPress.org plugin asset/readme update
-      uses: 10up/action-wordpress-plugin-asset-update@master
+      uses: 10up/action-wordpress-plugin-asset-update@stable
       env:
         SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
         SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
-        README_NAME: README.md
+        README_NAME: README.txt
diff --git a/.github/workflows/wordpress-plugin-deploy.yml b/.github/workflows/wordpress-plugin-deploy.yml
@@ -2,16 +2,17 @@ name: Deploy to WordPress.org
 on:
   push:
     tags:
-    - "*"
-    - "!*-*"
+      - "*"
+      - "!*-*"
 jobs:
   tag:
     name: New tag
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-    - name: WordPress Plugin Deploy
-      uses: 10up/action-wordpress-plugin-deploy@master
-      env:
-        SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
-        SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
+      - uses: actions/checkout@v2
+      - uses: php-actions/composer@v5
+      - name: WordPress Plugin Deploy
+        uses: 10up/action-wordpress-plugin-deploy@stable
+        env:
+          SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
+          SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
-composer.lock
-node_modules
-vendor
+.idea/
+css/*.min.css
+vendor/
+node_modules/
diff --git a/.stylelintrc.json b/.stylelintrc.json
@@ -0,0 +1,7 @@
+{
+  "extends": "@wordpress/stylelint-config",
+  "rules": {
+    "declaration-property-unit-whitelist": null,
+    "selector-id-pattern": null
+  }
+}
diff --git a/Gruntfile.js b/Gruntfile.js
diff --git a/apc/proxy.php b/apc/proxy.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * Proxy for APC based caching.
+ *
+ * @package Cachify
+ */
 
 if ( ! empty( $_COOKIE ) ) {
 	foreach ( $_COOKIE as $k => $v ) {
@@ -18,7 +23,8 @@
  */
 function cachify_is_ssl() {
 	if ( isset( $_SERVER['HTTPS'] ) ) {
-		if ( 'on' === strtolower( $_SERVER['HTTPS'] ) ) {
+		// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
+		if ( 'on' === strtolower( wp_unslash( $_SERVER['HTTPS'] ) ) ) {
 			return true;
 		}
 
@@ -34,19 +40,26 @@ function cachify_is_ssl() {
 
 if (
 	empty( $_cachify_logged_in )
+	&& extension_loaded( 'apc' )
 	&& ( strpos( filter_input( INPUT_SERVER, 'PHP_SELF', FILTER_SANITIZE_STRING ), '/wp-admin/' ) === false )
 	&& ( strpos( filter_input( INPUT_SERVER, 'HTTP_ACCEPT_ENCODING', FILTER_SANITIZE_STRING ), 'gzip' ) !== false )
-	&& extension_loaded( 'apc' )
-	&& ( $cache = apc_fetch( md5( ( cachify_is_ssl() ? 'https-' : '' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) . '.cachify' ) )
 ) {
-	ini_set( 'zlib.output_compression', 'Off' );
+	$prefix = cachify_is_ssl() ? 'https-' : '';
+	$cache = apc_fetch(
+		// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.ValidatedSanitizedInput.InputNotValidated
+		md5( $prefix . wp_unslash( $_SERVER['HTTP_HOST'] ) . wp_unslash( $_SERVER['REQUEST_URI'] ) )
+		. '.cachify'
+	);
+	if ( $cache ) {
+		ini_set( 'zlib.output_compression', 'Off' );
 
-	header( 'Vary: Accept-Encoding' );
-	header( 'X-Powered-By: Cachify' );
-	header( 'Content-Encoding: gzip' );
-	header( 'Content-Length: ' . strlen( $cache ) );
-	header( 'Content-Type: text/html; charset=utf-8' );
+		header( 'Vary: Accept-Encoding' );
+		header( 'X-Powered-By: Cachify' );
+		header( 'Content-Encoding: gzip' );
+		header( 'Content-Length: ' . strlen( $cache ) );
+		header( 'Content-Type: text/html; charset=utf-8' );
 
-	echo $cache;
-	exit;
+		echo $cache; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+		exit;
+	}
 }
diff --git a/cachify.php b/cachify.php
@@ -1,16 +1,17 @@
 <?php
-/*
-Plugin Name: Cachify
-Description: Easy to use WordPress caching plugin. Serving static blog pages from database, disk, Memcached or APC.
-Author:      pluginkollektiv
-Author URI:  https://pluginkollektiv.org
-Plugin URI:  https://cachify.pluginkollektiv.org/
-License:     GPLv2 or later
-License URI: http://www.gnu.org/licenses/gpl-2.0.html
-Version:     2.3.0
-Text Domain: cachify
-Domain Path: /lang
-*/
+/**
+ * Plugin Name: Cachify
+ * Description: Easy to use WordPress caching plugin. Serving static blog pages from database, disk, Memcached or APC.
+ * Author:      pluginkollektiv
+ * Author URI:  https://pluginkollektiv.org
+ * Plugin URI:  https://cachify.pluginkollektiv.org
+ * License:     GPLv2 or later
+ * License URI: http://www.gnu.org/licenses/gpl-2.0.html
+ * Version:     2.3.0
+ * Text Domain: cachify
+ *
+ * @package Cachify
+ */
 
 /*
 Copyright (C)  2011-2015 Sergej Müller
@@ -74,24 +75,28 @@
 
 /* WP-CLI */
 add_action(
-    'cli_init',
-    array(
-        'Cachify_CLI',
-        'add_commands'
-    )
+	'cli_init',
+	array(
+		'Cachify_CLI',
+		'add_commands',
+	)
 );
 
 /* Autoload Init */
 spl_autoload_register( 'cachify_autoload' );
 
-/* Autoload function */
+/**
+ * Autoload the class.
+ *
+ * @param string $class the class name.
+ */
 function cachify_autoload( $class ) {
 	if ( in_array( $class, array( 'Cachify', 'Cachify_APC', 'Cachify_DB', 'Cachify_HDD', 'Cachify_MEMCACHED', 'Cachify_CLI' ) ) ) {
 		require_once(
 			sprintf(
-				'%s/inc/%s.class.php',
+				'%s/inc/class-%s.php',
 				CACHIFY_DIR,
-				strtolower( $class )
+				strtolower( str_replace( '_', '-', $class ) )
 			)
 		);
 	}

diff --git a/composer.json b/composer.json
@@ -24,5 +24,40 @@
   "require": {
     "php": ">=5.2.0",
     "composer/installers": "~1.0"
+  },
+  "require-dev": {
+    "dealerdirect/phpcodesniffer-composer-installer": "^v0.7",
+    "matthiasmullie/minify": "^1.3",
+    "squizlabs/php_codesniffer": "^3.5",
+    "phpcompatibility/phpcompatibility-wp": "^2.1",
+    "wp-coding-standards/wpcs": "^2.3"
+  },
+  "scripts": {
+    "post-install-cmd": [
+      "@build"
+    ],
+    "post-update-cmd": [
+      "@build"
+    ],
+    "build": [
+      "minifycss css/dashboard.css > css/dashboard.min.css",
+      "minifycss css/settings.css > css/settings.min.css"
+    ],
+    "cs": [
+      "@lint-php"
+    ],
+    "csfix": [
+      "phpcbf --standard=phpcs.xml"
+    ],
+    "lint-all": [
+      "@lint-php",
+      "@lint-css"
+    ],
+    "lint-css": [
+      "npx stylelint css/dashboard.css css/settings.css"
+    ],
+    "lint-php": [
+      "phpcs --standard=phpcs.xml -s"
+    ]
   }
 }