MediaWiki  1.33.0
Go to the documentation of this file.
1 <?php
33 class FileOpBatch {
34  /* Timeout related parameters */
35  const MAX_BATCH_SIZE = 1000; // integer
56  public static function attempt( array $performOps, array $opts, FileJournal $journal ) {
59  $n = count( $performOps );
60  if ( $n > self::MAX_BATCH_SIZE ) {
61  $status->fatal( 'backend-fail-batchsize', $n, self::MAX_BATCH_SIZE );
63  return $status;
64  }
66  $batchId = $journal->getTimestampedUUID();
67  $ignoreErrors = !empty( $opts['force'] );
68  $journaled = empty( $opts['nonJournaled'] );
69  $maxConcurrency = $opts['concurrency'] ?? 1;
71  $entries = []; // file journal entry list
72  $predicates = FileOp::newPredicates(); // account for previous ops in prechecks
73  $curBatch = []; // concurrent FileOp sub-batch accumulation
74  $curBatchDeps = FileOp::newDependencies(); // paths used in FileOp sub-batch
75  $pPerformOps = []; // ordered list of concurrent FileOp sub-batches
76  $lastBackend = null; // last op backend name
77  // Do pre-checks for each operation; abort on failure...
78  foreach ( $performOps as $index => $fileOp ) {
79  $backendName = $fileOp->getBackend()->getName();
80  $fileOp->setBatchId( $batchId ); // transaction ID
81  // Decide if this op can be done concurrently within this sub-batch
82  // or if a new concurrent sub-batch must be started after this one...
83  if ( $fileOp->dependsOn( $curBatchDeps )
84  || count( $curBatch ) >= $maxConcurrency
85  || ( $backendName !== $lastBackend && count( $curBatch ) )
86  ) {
87  $pPerformOps[] = $curBatch; // push this batch
88  $curBatch = []; // start a new sub-batch
89  $curBatchDeps = FileOp::newDependencies();
90  }
91  $lastBackend = $backendName;
92  $curBatch[$index] = $fileOp; // keep index
93  // Update list of affected paths in this batch
94  $curBatchDeps = $fileOp->applyDependencies( $curBatchDeps );
95  // Simulate performing the operation...
96  $oldPredicates = $predicates;
97  $subStatus = $fileOp->precheck( $predicates ); // updates $predicates
98  $status->merge( $subStatus );
99  if ( $subStatus->isOK() ) {
100  if ( $journaled ) { // journal log entries
101  $entries = array_merge( $entries,
102  $fileOp->getJournalEntries( $oldPredicates, $predicates ) );
103  }
104  } else { // operation failed?
105  $status->success[$index] = false;
106  ++$status->failCount;
107  if ( !$ignoreErrors ) {
108  return $status; // abort
109  }
110  }
111  }
112  // Push the last sub-batch
113  if ( count( $curBatch ) ) {
114  $pPerformOps[] = $curBatch;
115  }
117  // Log the operations in the file journal...
118  if ( count( $entries ) ) {
119  $subStatus = $journal->logChangeBatch( $entries, $batchId );
120  if ( !$subStatus->isOK() ) {
121  $status->merge( $subStatus );
123  return $status; // abort
124  }
125  }
127  if ( $ignoreErrors ) { // treat precheck() fatals as mere warnings
128  $status->setResult( true, $status->value );
129  }
131  // Attempt each operation (in parallel if allowed and possible)...
132  self::runParallelBatches( $pPerformOps, $status );
134  return $status;
135  }
148  protected static function runParallelBatches( array $pPerformOps, StatusValue $status ) {
149  $aborted = false; // set to true on unexpected errors
150  foreach ( $pPerformOps as $performOpsBatch ) {
152  if ( $aborted ) { // check batch op abort flag...
153  // We can't continue (even with $ignoreErrors) as $predicates is wrong.
154  // Log the remaining ops as failed for recovery...
155  foreach ( $performOpsBatch as $i => $fileOp ) {
156  $status->success[$i] = false;
157  ++$status->failCount;
158  $performOpsBatch[$i]->logFailure( 'attempt_aborted' );
159  }
160  continue;
161  }
163  $statuses = [];
164  $opHandles = [];
165  // Get the backend; all sub-batch ops belong to a single backend
167  $backend = reset( $performOpsBatch )->getBackend();
168  // Get the operation handles or actually do it if there is just one.
169  // If attemptAsync() returns a StatusValue, it was either due to an error
170  // or the backend does not support async ops and did it synchronously.
171  foreach ( $performOpsBatch as $i => $fileOp ) {
172  if ( !isset( $status->success[$i] ) ) { // didn't already fail in precheck()
173  // Parallel ops may be disabled in config due to missing dependencies,
174  // (e.g. needing popen()). When they are, $performOpsBatch has size 1.
175  $subStatus = ( count( $performOpsBatch ) > 1 )
176  ? $fileOp->attemptAsync()
177  : $fileOp->attempt();
178  if ( $subStatus->value instanceof FileBackendStoreOpHandle ) {
179  $opHandles[$i] = $subStatus->value; // deferred
180  } else {
181  $statuses[$i] = $subStatus; // done already
182  }
183  }
184  }
185  // Try to do all the operations concurrently...
186  $statuses = $statuses + $backend->executeOpHandlesInternal( $opHandles );
187  // Marshall and merge all the responses (blocking)...
188  foreach ( $performOpsBatch as $i => $fileOp ) {
189  if ( !isset( $status->success[$i] ) ) { // didn't already fail in precheck()
190  $subStatus = $statuses[$i];
191  $status->merge( $subStatus );
192  if ( $subStatus->isOK() ) {
193  $status->success[$i] = true;
194  ++$status->successCount;
195  } else {
196  $status->success[$i] = false;
197  ++$status->failCount;
198  $aborted = true; // set abort flag; we can't continue
199  }
200  }
201  }
202  }
203  }
204 }
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. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header '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:1266
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: StatusValue.php:42
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:35
Class for handling file operation journaling.
Definition: FileJournal.php:37
logChangeBatch(array $entries, $batchId)
Log changes made by a batch file operation.
Definition: FileJournal.php:99
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("", 2))
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
static attempt(array $performOps, array $opts, FileJournal $journal)
Attempt to perform a series of file operations.
Definition: FileOpBatch.php:56
Helper class for representing batch file operations.
Definition: FileOpBatch.php:33
FileBackendStore helper class for performing asynchronous file operations.
Definition: FileBackendStore.php:1878
static runParallelBatches(array $pPerformOps, StatusValue $status)
Attempt a list of file operations sub-batches in series.
Definition: FileOpBatch.php:148
Definition: FileOpBatch.php:35
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:9
Get a statistically unique ID string.
Definition: FileJournal.php:78
static newDependencies()
Get a new empty dependency tracking array for paths read/written to.
Definition: FileOp.php:166
static newPredicates()
Get a new empty predicates array for precheck()
Definition: FileOp.php:157