Initial commit

Author: TBarregren

kntnt-mu-scripts.php

@@ -0,0 +1,205 @@
+<?php
+/**
+ * Plugin Name: Kntnt Must Use Scripts
+ * Description: Copies PHP files with namespace Kntnt\Mu_Scripts\* from scripts subfolder to mu-plugins directory on activation, removes them on deactivation.
+ * Version: 1.0.0
+ * Plugin URI: https://www.kntnt.com/
+ * Author: Kntnt
+ * Author URI: https://www.kntnt.com/
+ * Requires at least: 6.0
+ * Requires PHP: 8.3
+ * License: GPL v2 or later
+ * License URI: https://www.gnu.org/licenses/gpl-2.0.html
+ */
+
+declare( strict_types = 1 );
+
+namespace Kntnt\Mu_Scripts;
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+enum LogLevel: string {
+
+	case INFO = 'info';
+	case ERROR = 'error';
+	case WARNING = 'warning';
+
+}
+
+class Plugin {
+
+	/**
+	 * Required namespace prefix for mu-plugin files
+	 */
+	private const string REQUIRED_NAMESPACE_PREFIX = 'Kntnt\\Mu_Scripts\\';
+
+	/**
+	 * Plugin file path
+	 */
+	private static string $plugin_file;
+
+	/**
+	 * Initialize the plugin
+	 */
+	public static function init(): void {
+		self::$plugin_file = __FILE__;
+
+		// Register activation and deactivation hooks
+		register_activation_hook( self::$plugin_file, self::on_activation( ... ) );
+		register_deactivation_hook( self::$plugin_file, self::on_deactivation( ... ) );
+	}
+
+	/**
+	 * Plugin activation callback
+	 */
+	public static function on_activation(): void {
+		$plugin_dir = plugin_dir_path( self::$plugin_file );
+		$scripts_dir = $plugin_dir . 'scripts/';
+
+		if ( ! is_dir( $scripts_dir ) ) {
+			self::log( LogLevel::ERROR, "Scripts directory not found: {$scripts_dir}" );
+			return;
+		}
+
+		$mu_plugins_dir = WPMU_PLUGIN_DIR . '/';
+
+		// Create mu-plugins directory if it doesn't exist
+		// Note: We create it but never delete it, even on deactivation
+		if ( ! is_dir( $mu_plugins_dir ) && ! wp_mkdir_p( $mu_plugins_dir ) ) {
+			self::log( LogLevel::ERROR, "Failed to create mu-plugins directory: {$mu_plugins_dir}" );
+			return;
+		}
+
+		$copied_files = [];
+
+		try {
+			$php_files = self::get_php_files( $scripts_dir );
+
+			foreach ( $php_files as $source_file ) {
+				// Check if file has the required namespace
+				if ( ! self::has_required_namespace( $source_file ) ) {
+					$filename = basename( $source_file );
+					self::log( LogLevel::WARNING, "Skipping {$filename} - missing required namespace " . self::REQUIRED_NAMESPACE_PREFIX );
+					continue;
+				}
+
+				$filename = basename( $source_file );
+				$destination_file = $mu_plugins_dir . $filename;
+
+				if ( copy( $source_file, $destination_file ) ) {
+					$copied_files[] = $filename;
+					self::log( LogLevel::INFO, "Copied {$filename} to mu-plugins" );
+				}
+				else {
+					self::log( LogLevel::ERROR, "Failed to copy {$filename}" );
+				}
+			}
+
+			$count = count( $copied_files );
+			if ( $count > 0 ) {
+				self::log( LogLevel::INFO, "Successfully copied {$count} PHP files to mu-plugins" );
+			}
+
+		} catch ( Exception $e ) {
+			self::log( LogLevel::ERROR, "Error during file copying: {$e->getMessage()}" );
+		}
+	}
+
+	/**
+	 * Plugin deactivation callback
+	 */
+	public static function on_deactivation(): void {
+		$mu_plugins_dir = WPMU_PLUGIN_DIR . '/';
+
+		if ( ! is_dir( $mu_plugins_dir ) ) {
+			self::log( LogLevel::INFO, 'No mu-plugins directory found' );
+			return;
+		}
+
+		$removed_count = 0;
+		$php_files = self::get_php_files( $mu_plugins_dir );
+
+		foreach ( $php_files as $file_path ) {
+			if ( self::has_required_namespace( $file_path ) ) {
+				$filename = basename( $file_path );
+
+				if ( unlink( $file_path ) ) {
+					$removed_count ++;
+					self::log( LogLevel::INFO, "Removed {$filename} from mu-plugins" );
+				}
+				else {
+					self::log( LogLevel::ERROR, "Failed to remove {$filename}" );
+				}
+			}
+		}
+
+		self::log( LogLevel::INFO, "Successfully removed {$removed_count} files from mu-plugins" );
+	}
+
+	/**
+	 * Get all PHP files from a directory (root level only)
+	 */
+	private static function get_php_files( string $directory ): array {
+		if ( ! is_dir( $directory ) ) {
+			return [];
+		}
+
+		$php_files = [];
+		$files = scandir( $directory );
+
+		foreach ( $files as $file ) {
+			if ( $file === '.' || $file === '..' ) {
+				continue;
+			}
+
+			$file_path = $directory . $file;
+			if ( is_file( $file_path ) && pathinfo( $file, PATHINFO_EXTENSION ) === 'php' ) {
+				$php_files[] = $file_path;
+			}
+		}
+
+		return $php_files;
+	}
+
+	/**
+	 * Check if a PHP file has the required namespace
+	 * Only accepts format: namespace Kntnt\Mu_Scripts\Something;
+	 */
+	private static function has_required_namespace( string $file_path ): bool {
+		// Read first 2KB of file (namespace should be early in file)
+		$content = file_get_contents( $file_path, false, null, 0, 2048 );
+		if ( $content === false ) {
+			return false;
+		}
+
+		// Remove comments to avoid false matches
+		$content = preg_replace( [
+			'/\/\*.*?\*\//s',  // Block comments
+			'/\/\/.*$/m',      // Line comments  
+			'/#.*$/m',          // Hash comments
+		], '', $content );
+
+		// Look for our required namespace declaration
+		$pattern = '/^\s*namespace\s+' . preg_quote( self::REQUIRED_NAMESPACE_PREFIX, '/' ) . '/m';
+		return preg_match( $pattern, $content ) === 1;
+	}
+
+	/**
+	 * Log messages with different levels
+	 */
+	private static function log( LogLevel $level, string $message ): void {
+		$prefix = match ( $level ) {
+			LogLevel::INFO => 'Kntnt Must Use Scripts',
+			LogLevel::ERROR => 'Kntnt Must Use Scripts ERROR',
+			LogLevel::WARNING => 'Kntnt Must Use Scripts WARNING',
+		};
+
+		error_log( "{$prefix}: {$message}" );
+	}
+
+}
+
+// Initialize the plugin
+Plugin::init();

scripts/.gitignore

@@ -0,0 +1 @@
+!.gitignore