Merge branch 'release/0.6.35'

Author: ljonesfl

.version.json

@@ -2,6 +2,6 @@
   "strategy": "semver",
   "major": 0,
   "minor": 6,
-  "patch": 34,
+  "patch": 35,
   "build": 0
 }

examples/config/config.yaml

@@ -17,6 +17,9 @@ cache:
     markdown: true
     json: false
     xml: false
+  # Garbage collection settings (optional, defaults shown)
+  # gc_probability: 0.01  # 1% chance to run GC on cache write
+  # gc_divisor: 100      # Used with probability for fine-tuning
 
 system:
   timezone: US/Eastern

src/Bootstrap.php

@@ -60,3 +60,14 @@ function Dispatch( Application $App ) : void
 		echo 'Ouch.';
 	}
 }
+
+/**
+ * Clear expired cache entries
+ *
+ * @param Application $App
+ * @return int Number of entries removed
+ */
+function ClearExpiredCache( Application $App ) : int
+{
+	return $App->clearExpiredCache();
+}

src/Mvc/Application.php

@@ -366,5 +366,47 @@ function( $Parameters )
 			}
 		);
 	}
+
+	/**
+	 * Clear expired cache entries
+	 *
+	 * @return int Number of entries removed
+	 */
+	public function clearExpiredCache(): int
+	{
+		$Cache = Registry::getInstance()->get( 'ViewCache' );
+		
+		if( $Cache instanceof \Neuron\Mvc\Cache\ViewCache )
+		{
+			return $Cache->gc();
+		}
+		
+		// Try to initialize cache from settings if not already loaded
+		$Settings = $this->getSettingManager();
+		
+		if( $Settings )
+		{
+			try
+			{
+				$Config = \Neuron\Mvc\Cache\CacheConfig::fromSettings( $Settings->getSource() );
+				
+				if( $Config->isEnabled() )
+				{
+					$BasePath = $this->getBasePath();
+					$CachePath = $BasePath . DIRECTORY_SEPARATOR . $Config->getCachePath();
+					
+					$Storage = new \Neuron\Mvc\Cache\Storage\FileCacheStorage( $CachePath );
+					
+					return $Storage->gc();
+				}
+			}
+			catch( \Exception $e )
+			{
+				// Unable to initialize cache
+			}
+		}
+		
+		return 0;
+	}
 }
 

src/Mvc/Cache/CacheConfig.php

@@ -122,6 +122,41 @@ public static function fromSettings( ISettingSource $Settings ): self
 			$CacheSettings['views'] = $ViewSettings;
 		}
 
+		// Get GC settings if present
+		$GcProbability = $Settings->get( 'cache', 'gc_probability' );
+		if( $GcProbability !== null )
+		{
+			$CacheSettings['gc_probability'] = (float) $GcProbability;
+		}
+		
+		$GcDivisor = $Settings->get( 'cache', 'gc_divisor' );
+		if( $GcDivisor !== null )
+		{
+			$CacheSettings['gc_divisor'] = (int) $GcDivisor;
+		}
+		
 		return new self( $CacheSettings );
 	}
+
+	/**
+	 * Get garbage collection probability
+	 *
+	 * @return float
+	 */
+	public function getGcProbability(): float
+	{
+		// Default: 1% chance (0.01)
+		return (float) ( $this->_Settings['gc_probability'] ?? 0.01 );
+	}
+
+	/**
+	 * Get garbage collection divisor
+	 *
+	 * @return int
+	 */
+	public function getGcDivisor(): int
+	{
+		// Default divisor for probability calculation
+		return (int) ( $this->_Settings['gc_divisor'] ?? 100 );
+	}
 }

src/Mvc/Cache/Storage/FileCacheStorage.php

@@ -173,6 +173,25 @@ public function isExpired( string $Key ): bool
 		return time() > $MetaData['expires'];
 	}
 
+	/**
+	 * Run garbage collection to remove expired cache entries
+	 *
+	 * @return int Number of entries removed
+	 */
+	public function gc(): int
+	{
+		$Count = 0;
+		
+		if( !is_dir( $this->_BasePath ) )
+		{
+			return 0;
+		}
+		
+		$this->scanAndClean( $this->_BasePath, $Count );
+		
+		return $Count;
+	}
+
 	/**
 	 * Get file path for cache key
 	 *
@@ -267,4 +286,68 @@ private function recursiveDelete( string $Path, bool $DeleteSelf = true ): bool
 
 		return true;
 	}
+
+	/**
+	 * Scan directory and clean expired entries
+	 *
+	 * @param string $Dir
+	 * @param int $Count
+	 * @return void
+	 */
+	private function scanAndClean( string $Dir, int &$Count ): void
+	{
+		$Items = scandir( $Dir );
+		
+		if( $Items === false )
+		{
+			return;
+		}
+		
+		foreach( $Items as $Item )
+		{
+			if( $Item === '.' || $Item === '..' )
+			{
+				continue;
+			}
+			
+			$ItemPath = $Dir . DIRECTORY_SEPARATOR . $Item;
+			
+			if( is_dir( $ItemPath ) )
+			{
+				// Recursively scan subdirectories
+				$this->scanAndClean( $ItemPath, $Count );
+			}
+			elseif( substr( $Item, -5 ) === '.meta' )
+			{
+				// Check if this meta file indicates an expired entry
+				$MetaContent = file_get_contents( $ItemPath );
+				
+				if( $MetaContent !== false )
+				{
+					$MetaData = json_decode( $MetaContent, true );
+					
+					if( $MetaData && isset( $MetaData['expires'] ) && time() > $MetaData['expires'] )
+					{
+						// Remove the meta file
+						@unlink( $ItemPath );
+						
+						// Remove the corresponding cache file
+						$CachePath = substr( $ItemPath, 0, -5 ) . '.cache';
+						if( file_exists( $CachePath ) )
+						{
+							@unlink( $CachePath );
+						}
+						
+						$Count++;
+					}
+				}
+			}
+		}
+		
+		// Try to remove empty subdirectories (but not the base directory)
+		if( $Dir !== $this->_BasePath )
+		{
+			@rmdir( $Dir );
+		}
+	}
 }

src/Mvc/Cache/ViewCache.php

@@ -7,22 +7,24 @@
 class ViewCache
 {
 	private bool $_Enabled;
-	private string $_CachePath;
 	private int $_DefaultTtl;
 	private ICacheStorage $_Storage;
+	private ?CacheConfig $_Config;
 
 	/**
 	 * ViewCache constructor
 	 *
 	 * @param ICacheStorage $Storage
 	 * @param bool $Enabled
 	 * @param int $DefaultTtl
+	 * @param CacheConfig|null $Config
 	 */
-	public function __construct( ICacheStorage $Storage, bool $Enabled = true, int $DefaultTtl = 3600 )
+	public function __construct( ICacheStorage $Storage, bool $Enabled = true, int $DefaultTtl = 3600, ?CacheConfig $Config = null )
 	{
 		$this->_Storage = $Storage;
 		$this->_Enabled = $Enabled;
 		$this->_DefaultTtl = $DefaultTtl;
+		$this->_Config = $Config;
 	}
 
 	/**
@@ -59,7 +61,15 @@ public function set( string $Key, string $Content, ?int $Ttl = null ): bool
 
 		$Ttl = $Ttl ?? $this->_DefaultTtl;
 
-		return $this->_Storage->write( $Key, $Content, $Ttl );
+		$Result = $this->_Storage->write( $Key, $Content, $Ttl );
+		
+		// Run garbage collection based on probability
+		if( $Result && $this->shouldRunGc() )
+		{
+			$this->gc();
+		}
+		
+		return $Result;
 	}
 
 	/**
@@ -140,6 +150,16 @@ public function setEnabled( bool $Enabled ): void
 		$this->_Enabled = $Enabled;
 	}
 
+	/**
+	 * Run garbage collection to remove expired cache entries
+	 *
+	 * @return int Number of entries removed
+	 */
+	public function gc(): int
+	{
+		return $this->_Storage->gc();
+	}
+
 	/**
 	 * Hash data array for cache key
 	 *
@@ -152,4 +172,37 @@ private function hashData( array $Data ): string
 
 		return md5( serialize( $Data ) );
 	}
+
+	/**
+	 * Check if garbage collection should run
+	 *
+	 * @return bool
+	 */
+	private function shouldRunGc(): bool
+	{
+		if( !$this->_Config )
+		{
+			// If no config, use default 1% probability
+			return mt_rand( 1, 100 ) === 1;
+		}
+		
+		$Probability = $this->_Config->getGcProbability();
+		
+		// If probability is 0, GC is disabled
+		if( $Probability <= 0 )
+		{
+			return false;
+		}
+		
+		// If probability is 1 or higher, always run
+		if( $Probability >= 1 )
+		{
+			return true;
+		}
+		
+		$Divisor = $this->_Config->getGcDivisor();
+		
+		// Roll the dice
+		return mt_rand( 1, $Divisor ) <= ( $Probability * $Divisor );
+	}
 }

src/Mvc/Views/CacheableView.php

@@ -151,7 +151,7 @@ private function initializeCache(): ?ViewCache
 					$CachePath = $BasePath . DIRECTORY_SEPARATOR . $Config->getCachePath();
 
 					$Storage = new FileCacheStorage( $CachePath );
-					$Cache = new ViewCache( $Storage, true, $Config->getDefaultTtl() );
+					$Cache = new ViewCache( $Storage, true, $Config->getDefaultTtl(), $Config );
 
 					$Registry->set( 'ViewCache', $Cache );