77 if ( self::$executeContext && self::$executeContext[
'stage'] >= $stage ) {
78 self::$executeContext[
'subqueue'][] = $update;
82 if ( $stage === self::PRESEND ) {
83 self::push( self::$preSendUpdates, $update );
85 self::push( self::$postSendUpdates, $update );
91 self::tryOpportunisticExecute(
'run' );
106 $callable, $stage = self::POSTSEND,
IDatabase $dbw =
null
117 public static function doUpdates( $mode =
'run', $stage = self::ALL ) {
118 $stageEffective = ( $stage === self::ALL ) ? self::POSTSEND : $stage;
120 if ( $stage === self::ALL || $stage === self::PRESEND ) {
121 self::execute( self::$preSendUpdates, $mode, $stageEffective );
124 if ( $stage === self::ALL || $stage == self::POSTSEND ) {
125 self::execute( self::$postSendUpdates, $mode, $stageEffective );
144 $class = get_class( $update );
145 if ( isset(
$queue[$class] ) ) {
147 $existingUpdate =
$queue[$class];
148 $existingUpdate->merge( $update );
167 $services = MediaWikiServices::getInstance();
168 $stats =
$services->getStatsdDataFactory();
172 $ticket =
$lbFactory->getEmptyTransactionTicket( __METHOD__ );
175 $reportableError =
null;
183 if ( $mode ===
'enqueue' ) {
186 $updates = self::enqueueUpdates( $updates );
187 }
catch ( Exception
$e ) {
189 MWExceptionHandler::rollbackMasterChangesAndLog(
$e );
194 $updatesByType = [
'data' => [],
'generic' => [] ];
195 foreach ( $updates
as $du ) {
197 $du->setTransactionTicket( $ticket );
198 $updatesByType[
'data'][] = $du;
200 $updatesByType[
'generic'][] = $du;
204 ? get_class( $du ) .
'-' . $du->getOrigin()
206 $stats->increment(
'deferred_updates.' . $method .
'.' .
$name );
210 foreach ( $updatesByType
as $updatesForType ) {
211 foreach ( $updatesForType
as $update ) {
212 self::$executeContext = [
218 $guiError = self::runUpdate( $update,
$lbFactory, $stage );
219 $reportableError = $reportableError ?: $guiError;
221 while ( self::$executeContext[
'subqueue'] ) {
222 $subUpdate = reset( self::$executeContext[
'subqueue'] );
223 $firstKey =
key( self::$executeContext[
'subqueue'] );
224 unset( self::$executeContext[
'subqueue'][$firstKey] );
227 $subUpdate->setTransactionTicket( $ticket );
230 $guiError = self::runUpdate( $subUpdate,
$lbFactory, $stage );
231 $reportableError = $reportableError ?: $guiError;
233 self::$executeContext =
null;
240 if ( $reportableError ) {
241 throw $reportableError;
254 $fnameTrxOwner = get_class( $update ) .
'::doUpdate';
255 $lbFactory->beginMasterChanges( $fnameTrxOwner );
257 $lbFactory->commitMasterChanges( $fnameTrxOwner );
258 }
catch ( Exception
$e ) {
263 MWExceptionHandler::rollbackMasterChangesAndLog(
$e );
281 if ( self::$executeContext ) {
286 if ( !self::areDatabaseTransactionsActive() ) {
287 self::doUpdates( $mode );
291 if ( self::pendingUpdatesCount() >= self::BIG_QUEUE_SIZE ) {
294 self::$preSendUpdates = self::enqueueUpdates( self::$preSendUpdates );
295 self::$postSendUpdates = self::enqueueUpdates( self::$postSendUpdates );
298 return !self::pendingUpdatesCount();
310 foreach ( $updates
as $update ) {
312 $spec = $update->getAsJobSpecification();
315 $remaining[] = $update;
327 return count( self::$preSendUpdates ) + count( self::$postSendUpdates );
335 self::$preSendUpdates = [];
336 self::$postSendUpdates = [];
343 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfGetCaller( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
global $wgCommandLineMode
Abstract base class for update jobs that do something with some secondary data extracted from article...
Class for managing the deferred updates.
static enqueueUpdates(array $updates)
Enqueue a job for each EnqueueableDataUpdate item and return the other items.
static doUpdates( $mode='run', $stage=self::ALL)
Do any deferred updates and clear the list.
static areDatabaseTransactionsActive()
static addUpdate(DeferrableUpdate $update, $stage=self::POSTSEND)
Add an update to the deferred list to be run later by execute()
static addCallableUpdate( $callable, $stage=self::POSTSEND, IDatabase $dbw=null)
Add a callable update.
static pendingUpdatesCount()
static tryOpportunisticExecute( $mode='run')
Run all deferred updates immediately if there are no DB writes active.
static push(array &$queue, DeferrableUpdate $update)
static runUpdate(DeferrableUpdate $update, LBFactory $lbFactory, $stage)
static clearPendingUpdates()
Clear all pending updates without performing them.
static setImmediateMode( $value)
static array null $executeContext
Information about the current execute() call or null if not running.
static DeferrableUpdate[] $preSendUpdates
Updates to be deferred until before request end.
static execute(array &$queue, $mode, $stage)
Immediately run/queue a list of updates.
static DeferrableUpdate[] $postSendUpdates
Updates to be deferred until after request end.
An error page which can definitely be safely rendered using the OutputPage.
static singleton( $wiki=false)
An interface for generating database load balancers.
Database connection, tracking, load balancing, and transaction manager for a cluster.
forEachOpenMasterConnection( $callback, array $params=[])
Call a function with each open connection object to a master.
Deferrable Update for closure/callback.
static getMain()
Static methods.
when a variable name is used in a it is silently declared as a new local masking the global
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database key
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
the array() calling protocol came about after MediaWiki 1.4rc1.
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Allows to change the fields on the form that will be generated $name
returning false will NOT prevent logging $e
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
Callback wrapper that has an originating method.
Interface that deferrable updates should implement.
doUpdate()
Perform the actual work.
Interface that marks a DataUpdate as enqueuable via the JobQueue.
Basic database interface for live and lazy-loaded relation database handles.
writesOrCallbacksPending()
Returns true if there is a transaction open with possible write queries or transaction pre-commit/idl...
Interface that deferrable updates can implement.