extract and fix lock methods
parent
208b331080
commit
f587328b4a
|
@ -0,0 +1,148 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* @brief zoneclearFeedServer, a plugin for Dotclear 2
|
||||||
|
*
|
||||||
|
* @package Dotclear
|
||||||
|
* @subpackage Plugin
|
||||||
|
*
|
||||||
|
* @author Jean-Christian Denis, BG, Pierre Van Glabeke
|
||||||
|
*
|
||||||
|
* @copyright Jean-Christian Denis
|
||||||
|
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
||||||
|
*/
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Dotclear\Plugin\zoneclearFeedServer;
|
||||||
|
|
||||||
|
use Dotclear\Helper\File\{
|
||||||
|
Files,
|
||||||
|
Path
|
||||||
|
};
|
||||||
|
|
||||||
|
class Lock
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Locked files resource stack.
|
||||||
|
*
|
||||||
|
* @var array<string,resource>
|
||||||
|
*/
|
||||||
|
protected static $lock_stack = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Locked files status stack.
|
||||||
|
*
|
||||||
|
* @var array<string,bool>
|
||||||
|
*/
|
||||||
|
protected static $lock_disposable = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Last lock attempt error
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
protected static $lock_error = '';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lock file.
|
||||||
|
*
|
||||||
|
* @param string $file The file path
|
||||||
|
* @param bool $disposable File only use to lock
|
||||||
|
*
|
||||||
|
* @return null|string Clean file path on success, empty string on error, null if already locked
|
||||||
|
*/
|
||||||
|
public static function lock(string $file, bool $disposable = false): ?string
|
||||||
|
{
|
||||||
|
# Real path
|
||||||
|
$file = Path::real($file, false);
|
||||||
|
if (false === $file) {
|
||||||
|
self::$lock_error = __("Can't get file path");
|
||||||
|
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
# not a dir
|
||||||
|
if (is_dir($file)) {
|
||||||
|
self::$lock_error = __("Can't lock a directory");
|
||||||
|
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
# already marked as locked
|
||||||
|
if (isset(self::$lock_stack[$file]) || $disposable && file_exists($file)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
# Need flock function
|
||||||
|
if (!function_exists('flock')) {
|
||||||
|
self::$lock_error = __("Can't call php function named flock");
|
||||||
|
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
# Make dir
|
||||||
|
if (!is_dir(dirname($file))) {
|
||||||
|
Files::makeDir(dirname($file), true);
|
||||||
|
}
|
||||||
|
|
||||||
|
# Open new file
|
||||||
|
if (!file_exists($file)) {
|
||||||
|
$resource = @fopen($file, 'w');
|
||||||
|
if ($resource === false) {
|
||||||
|
self::$lock_error = __("Can't create file");
|
||||||
|
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
fwrite($resource, '1', strlen('1'));
|
||||||
|
//fclose($resource);
|
||||||
|
} else {
|
||||||
|
# Open existsing file
|
||||||
|
$resource = @fopen($file, 'r+');
|
||||||
|
if ($resource === false) {
|
||||||
|
self::$lock_error = __("Can't open file");
|
||||||
|
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Lock file
|
||||||
|
if (!flock($resource, LOCK_EX | LOCK_NB)) {
|
||||||
|
self::$lock_error = __("Can't lock file");
|
||||||
|
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
self::$lock_stack[$file] = $resource;
|
||||||
|
self::$lock_disposable[$file] = $disposable;
|
||||||
|
|
||||||
|
return $file;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unlock file.
|
||||||
|
*
|
||||||
|
* @param string $file The file to unlock
|
||||||
|
*/
|
||||||
|
public static function unlock(string $file): void
|
||||||
|
{
|
||||||
|
if (isset(self::$lock_stack[$file])) {
|
||||||
|
fclose(self::$lock_stack[$file]);
|
||||||
|
if (!empty(self::$lock_disposable[$file]) && file_exists($file)) {
|
||||||
|
@unlink($file);
|
||||||
|
}
|
||||||
|
unset(
|
||||||
|
self::$lock_stack[$file],
|
||||||
|
self::$lock_disposable[$file]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get last error from lock method.
|
||||||
|
*
|
||||||
|
* @return string The last lock error
|
||||||
|
*/
|
||||||
|
public static function getlastLockError(): string
|
||||||
|
{
|
||||||
|
return self::$lock_error;
|
||||||
|
}
|
||||||
|
}
|
|
@ -63,7 +63,7 @@ class ZoneclearFeedServer
|
||||||
/** @var Settings The settings instance */
|
/** @var Settings The settings instance */
|
||||||
public readonly Settings $settings;
|
public readonly Settings $settings;
|
||||||
|
|
||||||
/** @var null|resource $lock File lock for update */
|
/** @var null|string $lock File lock for update */
|
||||||
private static $lock = null;
|
private static $lock = null;
|
||||||
|
|
||||||
/** @var null|string $user Affiliate user ID */
|
/** @var null|string $user Affiliate user ID */
|
||||||
|
@ -416,54 +416,30 @@ class ZoneclearFeedServer
|
||||||
*
|
*
|
||||||
* @return bool True if file is locked
|
* @return bool True if file is locked
|
||||||
*/
|
*/
|
||||||
public function lockUpdate()
|
public function lockUpdate(): bool
|
||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
# Need flock function
|
|
||||||
if (!function_exists('flock')) {
|
|
||||||
throw new Exception("Can't call php function named flock");
|
|
||||||
}
|
|
||||||
# Cache writable ?
|
# Cache writable ?
|
||||||
if (!is_writable(DC_TPL_CACHE)) {
|
if (!is_writable(DC_TPL_CACHE)) {
|
||||||
throw new Exception("Can't write in cache fodler");
|
throw new Exception("Can't write in cache fodler");
|
||||||
}
|
}
|
||||||
# Set file path
|
# Set file path
|
||||||
$f_md5 = md5((string) dcCore::app()->blog?->id);
|
$f_md5 = md5((string) dcCore::app()->blog?->id);
|
||||||
$cached_file = sprintf(
|
$file = sprintf(
|
||||||
'%s/%s/%s/%s/%s.txt',
|
'%s/%s/%s/%s/%s.txt',
|
||||||
DC_TPL_CACHE,
|
DC_TPL_CACHE,
|
||||||
'periodical',
|
My::id(),
|
||||||
substr($f_md5, 0, 2),
|
substr($f_md5, 0, 2),
|
||||||
substr($f_md5, 2, 2),
|
substr($f_md5, 2, 2),
|
||||||
$f_md5
|
$f_md5
|
||||||
);
|
);
|
||||||
# Real path
|
|
||||||
$cached_file = Path::real($cached_file, false);
|
$file = Lock::lock($file);
|
||||||
if (false === $cached_file) {
|
if (is_null($file) || empty($file)) {
|
||||||
throw new Exception("Can't get cache file path");
|
return false;
|
||||||
}
|
}
|
||||||
# Make dir
|
|
||||||
if (!is_dir(dirname($cached_file))) {
|
self::$lock = $file;
|
||||||
Files::makeDir(dirname($cached_file), true);
|
|
||||||
}
|
|
||||||
# Make file
|
|
||||||
if (!file_exists($cached_file)) {
|
|
||||||
!$fp = @fopen($cached_file, 'w');
|
|
||||||
if ($fp === false) {
|
|
||||||
throw new Exception("Can't create file");
|
|
||||||
}
|
|
||||||
fwrite($fp, '1', strlen('1'));
|
|
||||||
fclose($fp);
|
|
||||||
}
|
|
||||||
# Open file
|
|
||||||
if (!($fp = @fopen($cached_file, 'r+'))) {
|
|
||||||
throw new Exception("Can't open file");
|
|
||||||
}
|
|
||||||
# Lock file
|
|
||||||
if (!flock($fp, LOCK_EX)) {
|
|
||||||
throw new Exception("Can't lock file");
|
|
||||||
}
|
|
||||||
self::$lock = $fp;
|
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
} catch (Exception $e) {
|
} catch (Exception $e) {
|
||||||
|
@ -477,7 +453,7 @@ class ZoneclearFeedServer
|
||||||
public function unlockUpdate(): void
|
public function unlockUpdate(): void
|
||||||
{
|
{
|
||||||
if (!is_null(self::$lock)) {
|
if (!is_null(self::$lock)) {
|
||||||
@fclose(self::$lock);
|
Lock::unlock(self::$lock);
|
||||||
self::$lock = null;
|
self::$lock = null;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -500,13 +476,7 @@ class ZoneclearFeedServer
|
||||||
}
|
}
|
||||||
|
|
||||||
# Limit to one update at a time
|
# Limit to one update at a time
|
||||||
try {
|
if (!$this->lockUpdate()) {
|
||||||
$this->lockUpdate();
|
|
||||||
} catch (Exception $e) {
|
|
||||||
if ($throw) {
|
|
||||||
throw $e;
|
|
||||||
}
|
|
||||||
|
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue