MediaWiki  REL1_31
Go to the documentation of this file.
1 <?php
6 use Psr\Log\LoggerInterface;
7 use Wikimedia\WaitConditionLoop;
46 abstract class LockManager {
48  protected $logger;
51  protected $lockTypeMap = [
52  self::LOCK_SH => self::LOCK_SH,
53  self::LOCK_UW => self::LOCK_EX, // subclasses may use self::LOCK_SH
54  self::LOCK_EX => self::LOCK_EX
55  ];
58  protected $locksHeld = [];
60  protected $domain; // string; domain (usually wiki ID)
61  protected $lockTTL; // integer; maximum time locks can be held
64  protected $session;
67  const LOCK_SH = 1; // shared lock (for reads)
68  const LOCK_UW = 2; // shared lock (for reads used to write elsewhere)
69  const LOCK_EX = 3; // exclusive lock (for writes)
72  const MAX_LOCK_TTL = 7200; // 2 hours
82  public function __construct( array $config ) {
83  $this->domain = isset( $config['domain'] ) ? $config['domain'] : 'global';
84  if ( isset( $config['lockTTL'] ) ) {
85  $this->lockTTL = max( 5, $config['lockTTL'] );
86  } elseif ( PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg' ) {
87  $this->lockTTL = 3600;
88  } else {
89  $met = ini_get( 'max_execution_time' ); // this is 0 in CLI mode
90  $this->lockTTL = max( 5 * 60, 2 * (int)$met );
91  }
93  // Upper bound on how long to keep lock structures around. This is useful when setting
94  // TTLs, as the "lockTTL" value may vary based on CLI mode and app server group. This is
95  // a "safe" value that can be used to avoid clobbering other locks that use high TTLs.
96  $this->lockTTL = min( $this->lockTTL, self::MAX_LOCK_TTL );
98  $random = [];
99  for ( $i = 1; $i <= 5; ++$i ) {
100  $random[] = mt_rand( 0, 0xFFFFFFF );
101  }
102  $this->session = md5( implode( '-', $random ) );
104  $this->logger = isset( $config['logger'] ) ? $config['logger'] : new \Psr\Log\NullLogger();
105  }
115  final public function lock( array $paths, $type = self::LOCK_EX, $timeout = 0 ) {
116  return $this->lockByType( [ $type => $paths ], $timeout );
117  }
127  final public function lockByType( array $pathsByType, $timeout = 0 ) {
128  $pathsByType = $this->normalizePathsByType( $pathsByType );
130  $status = null;
131  $loop = new WaitConditionLoop(
132  function () use ( &$status, $pathsByType ) {
133  $status = $this->doLockByType( $pathsByType );
135  return $status->isOK() ?: WaitConditionLoop::CONDITION_CONTINUE;
136  },
137  $timeout
138  );
139  $loop->invoke();
141  return $status;
142  }
151  final public function unlock( array $paths, $type = self::LOCK_EX ) {
152  return $this->unlockByType( [ $type => $paths ] );
153  }
162  final public function unlockByType( array $pathsByType ) {
163  $pathsByType = $this->normalizePathsByType( $pathsByType );
164  $status = $this->doUnlockByType( $pathsByType );
166  return $status;
167  }
177  final protected function sha1Base36Absolute( $path ) {
178  return Wikimedia\base_convert( sha1( "{$this->domain}:{$path}" ), 16, 36, 31 );
179  }
189  final protected function sha1Base16Absolute( $path ) {
190  return sha1( "{$this->domain}:{$path}" );
191  }
201  final protected function normalizePathsByType( array $pathsByType ) {
202  $res = [];
203  foreach ( $pathsByType as $type => $paths ) {
204  $res[$this->lockTypeMap[$type]] = array_unique( $paths );
205  }
207  return $res;
208  }
216  protected function doLockByType( array $pathsByType ) {
218  $lockedByType = []; // map of (type => paths)
219  foreach ( $pathsByType as $type => $paths ) {
220  $status->merge( $this->doLock( $paths, $type ) );
221  if ( $status->isOK() ) {
222  $lockedByType[$type] = $paths;
223  } else {
224  // Release the subset of locks that were acquired
225  foreach ( $lockedByType as $lType => $lPaths ) {
226  $status->merge( $this->doUnlock( $lPaths, $lType ) );
227  }
228  break;
229  }
230  }
232  return $status;
233  }
242  abstract protected function doLock( array $paths, $type );
250  protected function doUnlockByType( array $pathsByType ) {
252  foreach ( $pathsByType as $type => $paths ) {
253  $status->merge( $this->doUnlock( $paths, $type ) );
254  }
256  return $status;
257  }
266  abstract protected function doUnlock( array $paths, $type );
267 }
Class for handling resource locking.
Definition: LockManager.php:46
array $locksHeld
Map of (resource path => lock type => count)
Definition: LockManager.php:58
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
the array() calling protocol came about after MediaWiki 1.4rc1.
const LOCK_SH
Lock types; stronger locks have higher values.
Definition: LockManager.php:67
sha1Base16Absolute( $path)
Get the base 16 SHA-1 of a string, padded to 31 digits.
Definition: LockManager.php:189
const LOCK_UW
Definition: LockManager.php:68
Definition: database.txt:21
array $lockTypeMap
Mapping of lock types to the type actually used.
Definition: LockManager.php:51
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
normalizePathsByType(array $pathsByType)
Normalize the $paths array by converting LOCK_UW locks into the appropriate type and removing any dup...
Definition: LockManager.php:201
Definition: LockManager.php:61
sha1Base36Absolute( $path)
Get the base 36 SHA-1 of a string, padded to 31 digits.
Definition: LockManager.php:177
doUnlockByType(array $pathsByType)
Definition: LockManager.php:250
unlock(array $paths, $type=self::LOCK_EX)
Unlock the resources at the given abstract paths.
Definition: LockManager.php:151
lock(array $paths, $type=self::LOCK_EX, $timeout=0)
Lock the resources at the given abstract paths.
Definition: LockManager.php:115
unlockByType(array $pathsByType)
Unlock the resources at the given abstract paths.
Definition: LockManager.php:162
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
LoggerInterface $logger
Definition: LockManager.php:48
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1255
string $session
Random 32-char hex number.
Definition: LockManager.php:64
doUnlock(array $paths, $type)
Unlock resources with the given keys and lock type.
Definition: NoLocalSettings.php:25
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
__construct(array $config)
Construct a new instance from configuration.
Definition: LockManager.php:82
const LOCK_EX
Definition: LockManager.php:69
doLock(array $paths, $type)
Lock resources with the given keys and lock type.
doLockByType(array $pathsByType)
Definition: LockManager.php:216
lockByType(array $pathsByType, $timeout=0)
Lock the resources at the given abstract paths.
Definition: LockManager.php:127
Definition: LockManager.php:60
Definition: testCompression.php:48