1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
|
<?php
/**
* Utility for handling the generation and caching of css files
*/
class Less_Cache {
/** @var string|false Directory less.php can use for storing data */
public static $cache_dir = false;
/** @var string Prefix for the storing data */
public static $prefix = 'lessphp_';
/** @var string Prefix for the storing vars */
public static $prefix_vars = 'lessphpvars_';
/**
* @var int Specifies the number of seconds after which data created by less.php will be seen
* as 'garbage' and potentially cleaned up
*/
public static $gc_lifetime = 604800;
/**
* Save and reuse the results of compiled less files.
* The first call to Get() will generate css and save it.
* Subsequent calls to Get() with the same arguments will return the same css filename
*
* @param array $less_files Array of .less files to compile
* @param array $parser_options Array of compiler options
* @param array $modify_vars Array of variables
* @return string|false Name of the css file
*/
public static function Get( $less_files, $parser_options = [], $modify_vars = [] ) {
// check $cache_dir
if ( isset( $parser_options['cache_dir'] ) ) {
self::$cache_dir = $parser_options['cache_dir'];
}
if ( empty( self::$cache_dir ) ) {
throw new Exception( 'cache_dir not set' );
}
if ( isset( $parser_options['prefix'] ) ) {
self::$prefix = $parser_options['prefix'];
}
if ( empty( self::$prefix ) ) {
throw new Exception( 'prefix not set' );
}
if ( isset( $parser_options['prefix_vars'] ) ) {
self::$prefix_vars = $parser_options['prefix_vars'];
}
if ( empty( self::$prefix_vars ) ) {
throw new Exception( 'prefix_vars not set' );
}
self::CheckCacheDir();
$less_files = (array)$less_files;
// create a file for variables
if ( !empty( $modify_vars ) ) {
$lessvars = Less_Parser::serializeVars( $modify_vars );
$vars_file = self::$cache_dir . self::$prefix_vars . sha1( $lessvars ) . '.less';
if ( !file_exists( $vars_file ) ) {
file_put_contents( $vars_file, $lessvars );
}
$less_files += [ $vars_file => '/' ];
}
// generate name for compiled css file
$hash = md5( json_encode( $less_files ) );
$list_file = self::$cache_dir . self::$prefix . $hash . '.list';
// check cached content
if ( !isset( $parser_options['use_cache'] ) || $parser_options['use_cache'] === true ) {
if ( file_exists( $list_file ) ) {
self::ListFiles( $list_file, $list, $cached_name );
$compiled_name = self::CompiledName( $list, $hash );
// if $cached_name is the same as the $compiled name, don't regenerate
if ( !$cached_name || $cached_name === $compiled_name ) {
$output_file = self::OutputFile( $compiled_name, $parser_options );
if ( $output_file && file_exists( $output_file ) ) {
@touch( $list_file );
return basename( $output_file ); // for backwards compatibility, we just return the name of the file
}
}
}
}
$compiled = self::Cache( $less_files, $parser_options );
if ( !$compiled ) {
return false;
}
$compiled_name = self::CompiledName( $less_files, $hash );
$output_file = self::OutputFile( $compiled_name, $parser_options );
// save the file list
$list = $less_files;
$list[] = $compiled_name;
$cache = implode( "\n", $list );
file_put_contents( $list_file, $cache );
// save the css
file_put_contents( $output_file, $compiled );
// clean up
self::CleanCache();
return basename( $output_file );
}
/**
* Force the compiler to regenerate the cached css file
*
* @param array $less_files Array of .less files to compile
* @param array $parser_options Array of compiler options
* @param array $modify_vars Array of variables
* @return string Name of the css file
*/
public static function Regen( $less_files, $parser_options = [], $modify_vars = [] ) {
$parser_options['use_cache'] = false;
return self::Get( $less_files, $parser_options, $modify_vars );
}
public static function Cache( &$less_files, $parser_options = [] ) {
$parser_options['cache_dir'] = self::$cache_dir;
$parser = new Less_Parser( $parser_options );
// combine files
foreach ( $less_files as $file_path => $uri_or_less ) {
// treat as less markup if there are newline characters
if ( strpos( $uri_or_less, "\n" ) !== false ) {
$parser->Parse( $uri_or_less );
continue;
}
$parser->ParseFile( $file_path, $uri_or_less );
}
$compiled = $parser->getCss();
$less_files = $parser->getParsedFiles();
return $compiled;
}
private static function OutputFile( $compiled_name, $parser_options ) {
// custom output file
if ( !empty( $parser_options['output'] ) ) {
// relative to cache directory?
if ( preg_match( '#[\\\\/]#', $parser_options['output'] ) ) {
return $parser_options['output'];
}
return self::$cache_dir . $parser_options['output'];
}
return self::$cache_dir . $compiled_name;
}
private static function CompiledName( $files, $extrahash ) {
// save the file list
$temp = [ Less_Version::cache_version ];
foreach ( $files as $file ) {
$temp[] = filemtime( $file ) . "\t" . filesize( $file ) . "\t" . $file;
}
return self::$prefix . sha1( json_encode( $temp ) . $extrahash ) . '.css';
}
public static function SetCacheDir( $dir ) {
self::$cache_dir = $dir;
self::CheckCacheDir();
}
public static function CheckCacheDir() {
self::$cache_dir = str_replace( '\\', '/', self::$cache_dir );
self::$cache_dir = rtrim( self::$cache_dir, '/' ) . '/';
if ( !file_exists( self::$cache_dir ) ) {
if ( !mkdir( self::$cache_dir ) ) {
throw new Less_Exception_Parser( 'Less.php cache directory couldn\'t be created: ' . self::$cache_dir );
}
} elseif ( !is_dir( self::$cache_dir ) ) {
throw new Less_Exception_Parser( 'Less.php cache directory doesn\'t exist: ' . self::$cache_dir );
} elseif ( !is_writable( self::$cache_dir ) ) {
throw new Less_Exception_Parser( 'Less.php cache directory isn\'t writable: ' . self::$cache_dir );
}
}
/**
* Delete unused less.php files
*/
public static function CleanCache() {
static $clean = false;
if ( $clean || empty( self::$cache_dir ) ) {
return;
}
$clean = true;
// only remove files with extensions created by less.php
// css files removed based on the list files
$remove_types = [ 'lesscache' => 1, 'list' => 1, 'less' => 1, 'map' => 1 ];
$files = scandir( self::$cache_dir );
if ( !$files ) {
return;
}
$check_time = time() - self::$gc_lifetime;
foreach ( $files as $file ) {
// don't delete if the file wasn't created with less.php
if ( strpos( $file, self::$prefix ) !== 0 ) {
continue;
}
$parts = explode( '.', $file );
$type = array_pop( $parts );
if ( !isset( $remove_types[$type] ) ) {
continue;
}
$fullPath = self::$cache_dir . $file;
$mtime = filemtime( $fullPath );
// don't delete if it's a relatively new file
if ( $mtime > $check_time ) {
continue;
}
// delete the list file and associated css file
if ( $type === 'list' ) {
self::ListFiles( $fullPath, $list, $css_file_name );
if ( $css_file_name ) {
$css_file = self::$cache_dir . $css_file_name;
if ( file_exists( $css_file ) ) {
unlink( $css_file );
}
}
}
unlink( $fullPath );
}
}
/**
* Get the list of less files and generated css file from a list file
*/
public static function ListFiles( $list_file, &$list, &$css_file_name ) {
$list = explode( "\n", file_get_contents( $list_file ) );
// pop the cached name that should match $compiled_name
$css_file_name = array_pop( $list );
if ( !preg_match( '/^' . self::$prefix . '[a-f0-9]+\.css$/', $css_file_name ) ) {
$list[] = $css_file_name;
$css_file_name = false;
}
}
}
|