Merge pull request #37 from PhilETaylor/opcache

nibra · web-flow · commit a37d3407c7b0 · 2021-04-01T17:28:10.000+02:00
Propose Opcache invalidation on file operations
diff --git a/src/File.php b/src/File.php
@@ -91,6 +91,8 @@ public static function copy($src, $dest, $path = null, $useStreams = false)
 				throw new FilesystemException(sprintf('%1$s(%2$s, %3$s): %4$s', __METHOD__, $src, $dest, $stream->getError()));
 			}
 
+			self::invalidateFileCache($dest);
+
 			return true;
 		}
 
@@ -99,6 +101,8 @@ public static function copy($src, $dest, $path = null, $useStreams = false)
 			throw new FilesystemException(__METHOD__ . ': Copy failed.');
 		}
 
+		self::invalidateFileCache($dest);
+
 		return true;
 	}
 
@@ -136,6 +140,8 @@ public static function delete($file)
 			{
 				throw new FilesystemException(__METHOD__ . ': Failed deleting ' . $filename);
 			}
+
+			self::invalidateFileCache($file);
 		}
 
 		return true;
@@ -177,6 +183,8 @@ public static function move($src, $dest, $path = '', $useStreams = false)
 				throw new FilesystemException(__METHOD__ . ': ' . $stream->getError());
 			}
 
+			self::invalidateFileCache($dest);
+
 			return true;
 		}
 
@@ -185,6 +193,8 @@ public static function move($src, $dest, $path = '', $useStreams = false)
 			throw new FilesystemException(__METHOD__ . ': Rename failed.');
 		}
 
+		self::invalidateFileCache($dest);
+
 		return true;
 	}
 
@@ -218,6 +228,8 @@ public static function write($file, &$buffer, $useStreams = false, $appendToFile
 			$stream->set('chunksize', (1024 * 1024));
 			$stream->writeFile($file, $buffer, $appendToFile);
 
+			self::invalidateFileCache($file);
+
 			return true;
 		}
 
@@ -226,10 +238,16 @@ public static function write($file, &$buffer, $useStreams = false, $appendToFile
 		// Set the required flag to only append to the file and not overwrite it
 		if ($appendToFile === true)
 		{
-			return \is_int(file_put_contents($file, $buffer, \FILE_APPEND));
+			$res = \is_int(file_put_contents($file, $buffer, \FILE_APPEND));
 		}
+		else
+		{
+			$res = \is_int(file_put_contents($file, $buffer));
+		}
+
+		self::invalidateFileCache($file);
 
-		return \is_int(file_put_contents($file, $buffer));
+		return $res;
 	}
 
 	/**
@@ -266,6 +284,8 @@ public static function upload($src, $dest, $useStreams = false)
 				throw new FilesystemException(sprintf('%1$s(%2$s, %3$s): %4$s', __METHOD__, $src, $dest, $stream->getError()));
 			}
 
+			self::invalidateFileCache($dest);
+
 			return true;
 		}
 
@@ -274,6 +294,8 @@ public static function upload($src, $dest, $useStreams = false)
 			// Short circuit to prevent file permission errors
 			if (Path::setPermissions($dest))
 			{
+				self::invalidateFileCache($dest);
+
 				return true;
 			}
 
@@ -282,4 +304,25 @@ public static function upload($src, $dest, $useStreams = false)
 
 		throw new FilesystemException(__METHOD__ . ': Failed to move file.');
 	}
+
+	/**
+	 * Invalidate any opcache for a newly written file immediately, if opcache* functions exist and if this was a PHP file.
+	 *
+	 * @param   string  $file  The path to the file just written to, to flush from opcache
+	 *
+	 * @return void
+	 */
+	public static function invalidateFileCache($file)
+	{
+		if (function_exists('opcache_invalidate'))
+		{
+			$info = pathinfo($file);
+
+			if (isset($info['extension']) && $info['extension'] === 'php')
+			{
+				// Force invalidation to be absolutely sure the opcache is cleared for this file.
+				opcache_invalidate($file, true);
+			}
+		}
+	}
 }

Original file line number	Diff line number	Diff line change
`@@ -91,6 +91,8 @@ public static function copy($src, $dest, $path = null, $useStreams = false)`
`91`	`91`	`throw new FilesystemException(sprintf('%1$s(%2$s, %3$s): %4$s', __METHOD__, $src, $dest, $stream->getError()));`
`92`	`92`	`}`
`93`	`93`
	`94`	`+ self::invalidateFileCache($dest);`
	`95`	`+`
`94`	`96`	`return true;`
`95`	`97`	`}`
`96`	`98`
`@@ -99,6 +101,8 @@ public static function copy($src, $dest, $path = null, $useStreams = false)`
`99`	`101`	`throw new FilesystemException(__METHOD__ . ': Copy failed.');`
`100`	`102`	`}`
`101`	`103`
	`104`	`+ self::invalidateFileCache($dest);`
	`105`	`+`
`102`	`106`	`return true;`
`103`	`107`	`}`
`104`	`108`
`@@ -136,6 +140,8 @@ public static function delete($file)`
`136`	`140`	`{`
`137`	`141`	`throw new FilesystemException(__METHOD__ . ': Failed deleting ' . $filename);`
`138`	`142`	`}`
	`143`	`+`
	`144`	`+ self::invalidateFileCache($file);`
`139`	`145`	`}`
`140`	`146`
`141`	`147`	`return true;`
`@@ -177,6 +183,8 @@ public static function move($src, $dest, $path = '', $useStreams = false)`
`177`	`183`	`throw new FilesystemException(__METHOD__ . ': ' . $stream->getError());`
`178`	`184`	`}`
`179`	`185`
	`186`	`+ self::invalidateFileCache($dest);`
	`187`	`+`
`180`	`188`	`return true;`
`181`	`189`	`}`
`182`	`190`
`@@ -185,6 +193,8 @@ public static function move($src, $dest, $path = '', $useStreams = false)`
`185`	`193`	`throw new FilesystemException(__METHOD__ . ': Rename failed.');`
`186`	`194`	`}`
`187`	`195`
	`196`	`+ self::invalidateFileCache($dest);`
	`197`	`+`
`188`	`198`	`return true;`
`189`	`199`	`}`
`190`	`200`
`@@ -218,6 +228,8 @@ public static function write($file, &$buffer, $useStreams = false, $appendToFile`
`218`	`228`	`$stream->set('chunksize', (1024 * 1024));`
`219`	`229`	`$stream->writeFile($file, $buffer, $appendToFile);`
`220`	`230`
	`231`	`+ self::invalidateFileCache($file);`
	`232`	`+`
`221`	`233`	`return true;`
`222`	`234`	`}`
`223`	`235`
`@@ -226,10 +238,16 @@ public static function write($file, &$buffer, $useStreams = false, $appendToFile`
`226`	`238`	`// Set the required flag to only append to the file and not overwrite it`
`227`	`239`	`if ($appendToFile === true)`
`228`	`240`	`{`
`229`		`- return \is_int(file_put_contents($file, $buffer, \FILE_APPEND));`
	`241`	`+ $res = \is_int(file_put_contents($file, $buffer, \FILE_APPEND));`
`230`	`242`	`}`
	`243`	`+ else`
	`244`	`+ {`
	`245`	`+ $res = \is_int(file_put_contents($file, $buffer));`
	`246`	`+ }`
	`247`	`+`
	`248`	`+ self::invalidateFileCache($file);`
`231`	`249`
`232`		`- return \is_int(file_put_contents($file, $buffer));`
	`250`	`+ return $res;`
`233`	`251`	`}`
`234`	`252`
`235`	`253`	`/**`
`@@ -266,6 +284,8 @@ public static function upload($src, $dest, $useStreams = false)`
`266`	`284`	`throw new FilesystemException(sprintf('%1$s(%2$s, %3$s): %4$s', __METHOD__, $src, $dest, $stream->getError()));`
`267`	`285`	`}`
`268`	`286`
	`287`	`+ self::invalidateFileCache($dest);`
	`288`	`+`
`269`	`289`	`return true;`
`270`	`290`	`}`
`271`	`291`
`@@ -274,6 +294,8 @@ public static function upload($src, $dest, $useStreams = false)`
`274`	`294`	`// Short circuit to prevent file permission errors`
`275`	`295`	`if (Path::setPermissions($dest))`
`276`	`296`	`{`
	`297`	`+ self::invalidateFileCache($dest);`
	`298`	`+`
`277`	`299`	`return true;`
`278`	`300`	`}`
`279`	`301`
`@@ -282,4 +304,25 @@ public static function upload($src, $dest, $useStreams = false)`
`282`	`304`
`283`	`305`	`throw new FilesystemException(__METHOD__ . ': Failed to move file.');`
`284`	`306`	`}`
	`307`	`+`
	`308`	`+ /**`
	`309`	`+ * Invalidate any opcache for a newly written file immediately, if opcache* functions exist and if this was a PHP file.`
	`310`	`+ *`
	`311`	`+ * @param string $file The path to the file just written to, to flush from opcache`
	`312`	`+ *`
	`313`	`+ * @return void`
	`314`	`+ */`
	`315`	`+ public static function invalidateFileCache($file)`
	`316`	`+ {`
	`317`	`+ if (function_exists('opcache_invalidate'))`
	`318`	`+ {`
	`319`	`+ $info = pathinfo($file);`
	`320`	`+`
	`321`	`+ if (isset($info['extension']) && $info['extension'] === 'php')`
	`322`	`+ {`
	`323`	`+ // Force invalidation to be absolutely sure the opcache is cleared for this file.`
	`324`	`+ opcache_invalidate($file, true);`
	`325`	`+ }`
	`326`	`+ }`
	`327`	`+ }`
`285`	`328`	`}`