MediaWiki 1.39.10
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FSLockManager Class Reference
File backend » Lock management

Simple version of LockManager based on using FS lock files. More...

Inheritance diagram for FSLockManager:
Inheritance graph
[legend]
Collaboration diagram for FSLockManager:
Collaboration graph
[legend]

Public Member Functions

 __construct (array $config)
 Construct a new instance from configuration.
 
 __destruct ()
 Make sure remaining locks get cleared.
 
- Public Member Functions inherited from LockManager
 lock (array $paths, $type=self::LOCK_EX, $timeout=0)
 Lock the resources at the given abstract paths.
 
 lockByType (array $pathsByType, $timeout=0)
 Lock the resources at the given abstract paths.
 
 unlock (array $paths, $type=self::LOCK_EX)
 Unlock the resources at the given abstract paths.
 
 unlockByType (array $pathsByType)
 Unlock the resources at the given abstract paths.
 

Protected Member Functions

 doLock (array $paths, $type)
 
 doSingleLock ( $path, $type)
 Lock a single resource key.
 
 doSingleUnlock ( $path, $type)
 Unlock a single resource key.
 
 doUnlock (array $paths, $type)
 
 getLockPath ( $path)
 Get the path to the lock file for a key.
 
- Protected Member Functions inherited from LockManager
 doLockByType (array $pathsByType)
 
 doUnlockByType (array $pathsByType)
 
 normalizePathsByType (array $pathsByType)
 Normalize the $paths array by converting LOCK_UW locks into the appropriate type and removing any duplicated paths for each lock type.
 
 sha1Base16Absolute ( $path)
 Get the base 16 SHA-1 of a string, padded to 31 digits.
 
 sha1Base36Absolute ( $path)
 Get the base 36 SHA-1 of a string, padded to 31 digits.
 

Protected Attributes

array $handles = []
 Map of (locked key => lock file handle)
 
bool $isWindows
 
string $lockDir
 Global dir for all servers.
 
array $lockTypeMap
 Mapping of lock types to the type actually used.
 
- Protected Attributes inherited from LockManager
 $domain
 
array $locksHeld = []
 Map of (resource path => lock type => count)
 
 $lockTTL
 
array $lockTypeMap
 Mapping of lock types to the type actually used.
 
LoggerInterface $logger
 
string $session
 Random 32-char hex number.
 
const CLI_LOCK_TTL = 3600
 Default lock TTL in CLI mode.
 
const MAX_LOCK_TTL = 2 * 3600
 Max expected lock expiry in any context.
 
const MIN_GUESSED_LOCK_TTL = 5 * 60
 The minimum lock TTL if it is guessed from max_execution_time rather than configured.
 
const MIN_LOCK_TTL = 5
 Minimum lock TTL.
 

Additional Inherited Members

- Public Attributes inherited from LockManager
const LOCK_EX = 3
 
const LOCK_SH = 1
 Lock types; stronger locks have higher values.
 
const LOCK_UW = 2
 

Detailed Description

Simple version of LockManager based on using FS lock files.

All locks are non-blocking, which avoids deadlocks.

This should work fine for small sites running off one server. Do not use this with 'lockDirectory' set to an NFS mount unless the NFS client is at least version 2.6.12. Otherwise, the BSD flock() locks will be ignored; see http://nfs.sourceforge.net/#section_d.

Since
1.19

Definition at line 38 of file FSLockManager.php.

Constructor & Destructor Documentation

◆ __construct()

FSLockManager::__construct ( array $config)

Construct a new instance from configuration.

Parameters
array$configIncludes:
  • lockDirectory : Directory containing the lock files

Reimplemented from LockManager.

Definition at line 61 of file FSLockManager.php.

◆ __destruct()

FSLockManager::__destruct ( )

Make sure remaining locks get cleared.

Definition at line 251 of file FSLockManager.php.

References $path, and doSingleUnlock().

Member Function Documentation

◆ doLock()

FSLockManager::doLock ( array $paths,
$type )
protected
See also
LockManager::doLock()
Parameters
array$paths
int$type
Returns
StatusValue

Reimplemented from LockManager.

Definition at line 74 of file FSLockManager.php.

References $path, $type, doSingleLock(), and doUnlock().

◆ doSingleLock()

FSLockManager::doSingleLock ( $path,
$type )
protected

Lock a single resource key.

Parameters
string$path
int$type
Returns
StatusValue

Definition at line 116 of file FSLockManager.php.

References $path, $type, getLockPath(), LockManager\LOCK_EX, and LockManager\LOCK_SH.

Referenced by doLock().

◆ doSingleUnlock()

FSLockManager::doSingleUnlock ( $path,
$type )
protected

Unlock a single resource key.

Parameters
string$path
int$type
Returns
StatusValue

Definition at line 165 of file FSLockManager.php.

References $path, and $type.

Referenced by __destruct(), and doUnlock().

◆ doUnlock()

FSLockManager::doUnlock ( array $paths,
$type )
protected
See also
LockManager::doUnlock()
Parameters
array$paths
int$type
Returns
StatusValue

Reimplemented from LockManager.

Definition at line 99 of file FSLockManager.php.

References $path, $type, and doSingleUnlock().

Referenced by doLock().

◆ getLockPath()

FSLockManager::getLockPath ( $path)
protected

Get the path to the lock file for a key.

Parameters
string$path
Returns
string

Definition at line 244 of file FSLockManager.php.

Referenced by doSingleLock().

Member Data Documentation

◆ $handles

array FSLockManager::$handles = []
protected

Map of (locked key => lock file handle)

Definition at line 50 of file FSLockManager.php.

◆ $isWindows

bool FSLockManager::$isWindows
protected

Definition at line 53 of file FSLockManager.php.

◆ $lockDir

string FSLockManager::$lockDir
protected

Global dir for all servers.

Definition at line 47 of file FSLockManager.php.

◆ $lockTypeMap

array FSLockManager::$lockTypeMap
protected
Initial value:
= [
self::LOCK_SH => self::LOCK_SH,
self::LOCK_UW => self::LOCK_SH,
self::LOCK_EX => self::LOCK_EX
]

Mapping of lock types to the type actually used.

Definition at line 40 of file FSLockManager.php.

The documentation for this class was generated from the following file: