MediaWiki  1.33.0
MWExceptionHandler.php
Go to the documentation of this file.
1 <?php
23 use Psr\Log\LogLevel;
25 
31  const CAUGHT_BY_HANDLER = 'mwe_handler'; // error reported by this exception handler
32  const CAUGHT_BY_OTHER = 'other'; // error reported by direct logException() call
33 
37  protected static $reservedMemory;
38 
55  protected static $fatalErrorTypes = [
56  E_ERROR,
57  E_PARSE,
58  E_CORE_ERROR,
59  E_COMPILE_ERROR,
60  E_USER_ERROR,
61 
62  // E.g. "Catchable fatal error: Argument X must be Y, null given"
63  E_RECOVERABLE_ERROR,
64 
65  // HHVM's FATAL_ERROR constant
66  16777217,
67  ];
71  protected static $handledFatalCallback = false;
72 
76  public static function installHandler() {
77  set_exception_handler( 'MWExceptionHandler::handleUncaughtException' );
78  set_error_handler( 'MWExceptionHandler::handleError' );
79 
80  // Reserve 16k of memory so we can report OOM fatals
81  self::$reservedMemory = str_repeat( ' ', 16384 );
82  register_shutdown_function( 'MWExceptionHandler::handleFatalError' );
83  }
84 
89  protected static function report( $e ) {
90  try {
91  // Try and show the exception prettily, with the normal skin infrastructure
92  if ( $e instanceof MWException ) {
93  // Delegate to MWException until all subclasses are handled by
94  // MWExceptionRenderer and MWException::report() has been
95  // removed.
96  $e->report();
97  } else {
99  }
100  } catch ( Exception $e2 ) {
101  // Exception occurred from within exception handler
102  // Show a simpler message for the original exception,
103  // don't try to invoke report()
105  }
106  }
107 
116  public static function rollbackMasterChangesAndLog( $e ) {
117  $services = MediaWikiServices::getInstance();
118  if ( !$services->isServiceDisabled( 'DBLoadBalancerFactory' ) ) {
119  // Rollback DBs to avoid transaction notices. This might fail
120  // to rollback some databases due to connection issues or exceptions.
121  // However, any sane DB driver will rollback implicitly anyway.
122  try {
123  $services->getDBLoadBalancerFactory()->rollbackMasterChanges( __METHOD__ );
124  } catch ( DBError $e2 ) {
125  // If the DB is unreacheable, rollback() will throw an error
126  // and the error report() method might need messages from the DB,
127  // which would result in an exception loop. PHP may escalate such
128  // errors to "Exception thrown without a stack frame" fatals, but
129  // it's better to be explicit here.
130  self::logException( $e2, self::CAUGHT_BY_HANDLER );
131  }
132  }
133 
134  self::logException( $e, self::CAUGHT_BY_HANDLER );
135  }
136 
143  public static function handleUncaughtException( $e ) {
145 
146  // Make sure we don't claim success on exit for CLI scripts (T177414)
147  if ( wfIsCLI() ) {
148  register_shutdown_function(
149  function () {
150  exit( 255 );
151  }
152  );
153  }
154  }
155 
170  public static function handleException( $e ) {
172  self::report( $e );
173  }
174 
193  public static function handleError(
194  $level, $message, $file = null, $line = null
195  ) {
196  global $wgPropagateErrors;
197 
198  if ( in_array( $level, self::$fatalErrorTypes ) ) {
199  return self::handleFatalError( ...func_get_args() );
200  }
201 
202  // Map PHP error constant to a PSR-3 severity level.
203  // Avoid use of "DEBUG" or "INFO" levels, unless the
204  // error should evade error monitoring and alerts.
205  //
206  // To decide the log level, ask yourself: "Has the
207  // program's behaviour diverged from what the written
208  // code expected?"
209  //
210  // For example, use of a deprecated method or violating a strict standard
211  // has no impact on functional behaviour (Warning). On the other hand,
212  // accessing an undefined variable makes behaviour diverge from what the
213  // author intended/expected. PHP recovers from an undefined variables by
214  // yielding null and continuing execution, but it remains a change in
215  // behaviour given the null was not part of the code and is likely not
216  // accounted for.
217  switch ( $level ) {
218  case E_WARNING:
219  case E_CORE_WARNING:
220  case E_COMPILE_WARNING:
221  $levelName = 'Warning';
222  $severity = LogLevel::ERROR;
223  break;
224  case E_NOTICE:
225  $levelName = 'Notice';
226  $severity = LogLevel::ERROR;
227  break;
228  case E_USER_NOTICE:
229  // Used by wfWarn(), MWDebug::warning()
230  $levelName = 'Notice';
231  $severity = LogLevel::WARNING;
232  break;
233  case E_USER_WARNING:
234  // Used by wfWarn(), MWDebug::warning()
235  $levelName = 'Warning';
236  $severity = LogLevel::WARNING;
237  break;
238  case E_STRICT:
239  $levelName = 'Strict Standards';
240  $severity = LogLevel::WARNING;
241  break;
242  case E_DEPRECATED:
243  case E_USER_DEPRECATED:
244  $levelName = 'Deprecated';
245  $severity = LogLevel::WARNING;
246  break;
247  default:
248  $levelName = 'Unknown error';
249  $severity = LogLevel::ERROR;
250  break;
251  }
252 
253  $e = new ErrorException( "PHP $levelName: $message", 0, $level, $file, $line );
254  self::logError( $e, 'error', $severity );
255 
256  // If $wgPropagateErrors is true return false so PHP shows/logs the error normally.
257  // Ignore $wgPropagateErrors if track_errors is set
258  // (which means someone is counting on regular PHP error handling behavior).
259  return !( $wgPropagateErrors || ini_get( 'track_errors' ) );
260  }
261 
283  public static function handleFatalError(
284  $level = null, $message = null, $file = null, $line = null,
285  $context = null, $trace = null
286  ) {
287  // Free reserved memory so that we have space to process OOM
288  // errors
289  self::$reservedMemory = null;
290 
291  if ( $level === null ) {
292  // Called as a shutdown handler, get data from error_get_last()
293  if ( static::$handledFatalCallback ) {
294  // Already called once (probably as an error handler callback
295  // under HHVM) so don't log again.
296  return false;
297  }
298 
299  $lastError = error_get_last();
300  if ( $lastError !== null ) {
301  $level = $lastError['type'];
302  $message = $lastError['message'];
303  $file = $lastError['file'];
304  $line = $lastError['line'];
305  } else {
306  $level = 0;
307  $message = '';
308  }
309  }
310 
311  if ( !in_array( $level, self::$fatalErrorTypes ) ) {
312  // Only interested in fatal errors, others should have been
313  // handled by MWExceptionHandler::handleError
314  return false;
315  }
316 
318  $msgParts = [
319  '[{exception_id}] {exception_url} PHP Fatal Error',
320  ( $line || $file ) ? ' from' : '',
321  $line ? " line $line" : '',
322  ( $line && $file ) ? ' of' : '',
323  $file ? " $file" : '',
324  ": $message",
325  ];
326  $msg = implode( '', $msgParts );
327 
328  // Look at message to see if this is a class not found failure
329  // HHVM: Class undefined: foo
330  // PHP5: Class 'foo' not found
331  if ( preg_match( "/Class (undefined: \w+|'\w+' not found)/", $message ) ) {
332  // phpcs:disable Generic.Files.LineLength
333  $msg = <<<TXT
334 {$msg}
335 
336 MediaWiki or an installed extension requires this class but it is not embedded directly in MediaWiki's git repository and must be installed separately by the end user.
337 
338 Please see <a href="https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries">mediawiki.org</a> for help on installing the required components.
339 TXT;
340  // phpcs:enable
341  }
342 
343  // We can't just create an exception and log it as it is likely that
344  // the interpreter has unwound the stack already. If that is true the
345  // stacktrace we would get would be functionally empty. If however we
346  // have been called as an error handler callback *and* HHVM is in use
347  // we will have been provided with a useful stacktrace that we can
348  // log.
349  $trace = $trace ?: debug_backtrace();
350  $logger = LoggerFactory::getInstance( 'fatal' );
351  $logger->error( $msg, [
352  'fatal_exception' => [
353  'class' => ErrorException::class,
354  'message' => "PHP Fatal Error: {$message}",
355  'code' => $level,
356  'file' => $file,
357  'line' => $line,
358  'trace' => self::prettyPrintTrace( self::redactTrace( $trace ) ),
359  ],
360  'exception_id' => WebRequest::getRequestId(),
361  'exception_url' => $url,
362  'caught_by' => self::CAUGHT_BY_HANDLER
363  ] );
364 
365  // Remember call so we don't double process via HHVM's fatal
366  // notifications and the shutdown hook behavior
367  static::$handledFatalCallback = true;
368  return false;
369  }
370 
381  public static function getRedactedTraceAsString( $e ) {
382  return self::prettyPrintTrace( self::getRedactedTrace( $e ) );
383  }
384 
393  public static function prettyPrintTrace( array $trace, $pad = '' ) {
394  $text = '';
395 
396  $level = 0;
397  foreach ( $trace as $level => $frame ) {
398  if ( isset( $frame['file'] ) && isset( $frame['line'] ) ) {
399  $text .= "{$pad}#{$level} {$frame['file']}({$frame['line']}): ";
400  } else {
401  // 'file' and 'line' are unset for calls via call_user_func
402  // (T57634) This matches behaviour of
403  // Exception::getTraceAsString to instead display "[internal
404  // function]".
405  $text .= "{$pad}#{$level} [internal function]: ";
406  }
407 
408  if ( isset( $frame['class'] ) && isset( $frame['type'] ) && isset( $frame['function'] ) ) {
409  $text .= $frame['class'] . $frame['type'] . $frame['function'];
410  } elseif ( isset( $frame['function'] ) ) {
411  $text .= $frame['function'];
412  } else {
413  $text .= 'NO_FUNCTION_GIVEN';
414  }
415 
416  if ( isset( $frame['args'] ) ) {
417  $text .= '(' . implode( ', ', $frame['args'] ) . ")\n";
418  } else {
419  $text .= "()\n";
420  }
421  }
422 
423  $level = $level + 1;
424  $text .= "{$pad}#{$level} {main}";
425 
426  return $text;
427  }
428 
440  public static function getRedactedTrace( $e ) {
441  return static::redactTrace( $e->getTrace() );
442  }
443 
454  public static function redactTrace( array $trace ) {
455  return array_map( function ( $frame ) {
456  if ( isset( $frame['args'] ) ) {
457  $frame['args'] = array_map( function ( $arg ) {
458  return is_object( $arg ) ? get_class( $arg ) : gettype( $arg );
459  }, $frame['args'] );
460  }
461  return $frame;
462  }, $trace );
463  }
464 
472  public static function getURL() {
473  global $wgRequest;
474  if ( !isset( $wgRequest ) || $wgRequest instanceof FauxRequest ) {
475  return false;
476  }
477  return $wgRequest->getRequestURL();
478  }
479 
487  public static function getLogMessage( $e ) {
488  $id = WebRequest::getRequestId();
489  $type = get_class( $e );
490  $file = $e->getFile();
491  $line = $e->getLine();
492  $message = $e->getMessage();
493  $url = self::getURL() ?: '[no req]';
494 
495  return "[$id] $url $type from line $line of $file: $message";
496  }
497 
507  public static function getLogNormalMessage( $e ) {
508  $type = get_class( $e );
509  $file = $e->getFile();
510  $line = $e->getLine();
511  $message = $e->getMessage();
512 
513  return "[{exception_id}] {exception_url} $type from line $line of $file: $message";
514  }
515 
520  public static function getPublicLogMessage( $e ) {
521  $reqId = WebRequest::getRequestId();
522  $type = get_class( $e );
523  return '[' . $reqId . '] '
524  . gmdate( 'Y-m-d H:i:s' ) . ': '
525  . 'Fatal exception of type "' . $type . '"';
526  }
527 
539  public static function getLogContext( $e, $catcher = self::CAUGHT_BY_OTHER ) {
540  return [
541  'exception' => $e,
542  'exception_id' => WebRequest::getRequestId(),
543  'exception_url' => self::getURL() ?: '[no req]',
544  'caught_by' => $catcher
545  ];
546  }
547 
560  public static function getStructuredExceptionData( $e, $catcher = self::CAUGHT_BY_OTHER ) {
562 
563  $data = [
564  'id' => WebRequest::getRequestId(),
565  'type' => get_class( $e ),
566  'file' => $e->getFile(),
567  'line' => $e->getLine(),
568  'message' => $e->getMessage(),
569  'code' => $e->getCode(),
570  'url' => self::getURL() ?: null,
571  'caught_by' => $catcher
572  ];
573 
574  if ( $e instanceof ErrorException &&
575  ( error_reporting() & $e->getSeverity() ) === 0
576  ) {
577  // Flag surpressed errors
578  $data['suppressed'] = true;
579  }
580 
581  if ( $wgLogExceptionBacktrace ) {
582  $data['backtrace'] = self::getRedactedTrace( $e );
583  }
584 
585  $previous = $e->getPrevious();
586  if ( $previous !== null ) {
587  $data['previous'] = self::getStructuredExceptionData( $previous, $catcher );
588  }
589 
590  return $data;
591  }
592 
647  public static function jsonSerializeException(
648  $e, $pretty = false, $escaping = 0, $catcher = self::CAUGHT_BY_OTHER
649  ) {
650  return FormatJson::encode(
651  self::getStructuredExceptionData( $e, $catcher ),
652  $pretty,
653  $escaping
654  );
655  }
656 
667  public static function logException( $e, $catcher = self::CAUGHT_BY_OTHER ) {
668  if ( !( $e instanceof MWException ) || $e->isLoggable() ) {
669  $logger = LoggerFactory::getInstance( 'exception' );
670  $logger->error(
671  self::getLogNormalMessage( $e ),
672  self::getLogContext( $e, $catcher )
673  );
674 
675  $json = self::jsonSerializeException( $e, false, FormatJson::ALL_OK, $catcher );
676  if ( $json !== false ) {
677  $logger = LoggerFactory::getInstance( 'exception-json' );
678  $logger->error( $json, [ 'private' => true ] );
679  }
680 
681  Hooks::run( 'LogException', [ $e, false ] );
682  }
683  }
684 
693  protected static function logError(
694  ErrorException $e, $channel, $level = LogLevel::ERROR
695  ) {
696  $catcher = self::CAUGHT_BY_HANDLER;
697  // The set_error_handler callback is independent from error_reporting.
698  // Filter out unwanted errors manually (e.g. when
699  // Wikimedia\suppressWarnings is active).
700  $suppressed = ( error_reporting() & $e->getSeverity() ) === 0;
701  if ( !$suppressed ) {
702  $logger = LoggerFactory::getInstance( $channel );
703  $logger->log(
704  $level,
705  self::getLogNormalMessage( $e ),
706  self::getLogContext( $e, $catcher )
707  );
708  }
709 
710  // Include all errors in the json log (surpressed errors will be flagged)
711  $json = self::jsonSerializeException( $e, false, FormatJson::ALL_OK, $catcher );
712  if ( $json !== false ) {
713  $logger = LoggerFactory::getInstance( "{$channel}-json" );
714  $logger->log( $level, $json, [ 'private' => true ] );
715  }
716 
717  Hooks::run( 'LogException', [ $e, $suppressed ] );
718  }
719 }
MWExceptionHandler\logError
static logError(ErrorException $e, $channel, $level=LogLevel::ERROR)
Log an exception that wasn't thrown but made to wrap an error.
Definition: MWExceptionHandler.php:693
MWExceptionHandler\$handledFatalCallback
static $handledFatalCallback
Definition: MWExceptionHandler.php:71
MWExceptionHandler\getRedactedTrace
static getRedactedTrace( $e)
Return a copy of an exception's backtrace as an array.
Definition: MWExceptionHandler.php:440
FauxRequest
WebRequest clone which takes values from a provided array.
Definition: FauxRequest.php:33
$file
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
$context
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2636
MWExceptionHandler\getLogNormalMessage
static getLogNormalMessage( $e)
Get a normalised message for formatting with PSR-3 log event context.
Definition: MWExceptionHandler.php:507
captcha-old.help
help
Definition: captcha-old.py:211
MWExceptionHandler\getStructuredExceptionData
static getStructuredExceptionData( $e, $catcher=self::CAUGHT_BY_OTHER)
Get a structured representation of an Exception.
Definition: MWExceptionHandler.php:560
MWExceptionHandler
Handler class for MWExceptions.
Definition: MWExceptionHandler.php:30
MWExceptionHandler\CAUGHT_BY_HANDLER
const CAUGHT_BY_HANDLER
Definition: MWExceptionHandler.php:31
MWExceptionHandler\redactTrace
static redactTrace(array $trace)
Redact a stacktrace generated by Exception::getTrace(), debug_backtrace() or similar means.
Definition: MWExceptionHandler.php:454
it
=Architecture==Two class hierarchies are used to provide the functionality associated with the different content models:*Content interface(and AbstractContent base class) define functionality that acts on the concrete content of a page, and *ContentHandler base class provides functionality specific to a content model, but not acting on concrete content. The most important function of ContentHandler is to act as a factory for the appropriate implementation of Content. These Content objects are to be used by MediaWiki everywhere, instead of passing page content around as text. All manipulation and analysis of page content must be done via the appropriate methods of the Content object. For each content model, a subclass of ContentHandler has to be registered with $wgContentHandlers. The ContentHandler object for a given content model can be obtained using ContentHandler::getForModelID($id). Also Title, WikiPage and Revision now have getContentHandler() methods for convenience. ContentHandler objects are singletons that provide functionality specific to the content type, but not directly acting on the content of some page. ContentHandler::makeEmptyContent() and ContentHandler::unserializeContent() can be used to create a Content object of the appropriate type. However, it is recommended to instead use WikiPage::getContent() resp. Revision::getContent() to get a page 's content as a Content object. These two methods should be the ONLY way in which page content is accessed. Another important function of ContentHandler objects is to define custom action handlers for a content model, see ContentHandler::getActionOverrides(). This is similar to what WikiPage::getActionOverrides() was already doing.==Serialization==With the ContentHandler facility, page content no longer has to be text based. Objects implementing the Content interface are used to represent and handle the content internally. For storage and data exchange, each content model supports at least one serialization format via ContentHandler::serializeContent($content). The list of supported formats for a given content model can be accessed using ContentHandler::getSupportedFormats(). Content serialization formats are identified using MIME type like strings. The following formats are built in:*text/x-wiki - wikitext *text/javascript - for js pages *text/css - for css pages *text/plain - for future use, e.g. with plain text messages. *text/html - for future use, e.g. with plain html messages. *application/vnd.php.serialized - for future use with the api and for extensions *application/json - for future use with the api, and for use by extensions *application/xml - for future use with the api, and for use by extensions In PHP, use the corresponding CONTENT_FORMAT_XXX constant. Note that when using the API to access page content, especially action=edit, action=parse and action=query &prop=revisions, the model and format of the content should always be handled explicitly. Without that information, interpretation of the provided content is not reliable. The same applies to XML dumps generated via maintenance/dumpBackup.php or Special:Export. Also note that the API will provide encapsulated, serialized content - so if the API was called with format=json, and contentformat is also json(or rather, application/json), the page content is represented as a string containing an escaped json structure. Extensions that use JSON to serialize some types of page content may provide specialized API modules that allow access to that content in a more natural form.==Compatibility==The ContentHandler facility is introduced in a way that should allow all existing code to keep functioning at least for pages that contain wikitext or other text based content. However, a number of functions and hooks have been deprecated in favor of new versions that are aware of the page 's content model, and will now generate warnings when used. Most importantly, the following functions have been deprecated:*Revisions::getText() is deprecated in favor Revisions::getContent() *WikiPage::getText() is deprecated in favor WikiPage::getContent() Also, the old Article::getContent()(which returns text) is superceded by Article::getContentObject(). However, both methods should be avoided since they do not provide clean access to the page 's actual content. For instance, they may return a system message for non-existing pages. Use WikiPage::getContent() instead. Code that relies on a textual representation of the page content should eventually be rewritten. However, ContentHandler::getContentText() provides a stop-gap that can be used to get text for a page. Its behavior is controlled by $wgContentHandlerTextFallback it
Definition: contenthandler.txt:104
MWExceptionHandler\installHandler
static installHandler()
Install handlers with PHP.
Definition: MWExceptionHandler.php:76
a
</source > ! result< div class="mw-highlight mw-content-ltr" dir="ltr">< pre >< span ></span >< span class="kd"> var</span >< span class="nx"> a</span >< span class="p"></span ></pre ></div > ! end ! test Multiline< source/> in lists !input *< source > a b</source > *foo< source > a b</source > ! html< ul >< li >< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul >< ul >< li > foo< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul > ! html tidy< ul >< li >< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul >< ul >< li > foo< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul > ! end ! test Custom attributes !input< source lang="javascript" id="foo" class="bar" dir="rtl" style="font-size: larger;"> var a
Definition: parserTests.txt:85
MWExceptionHandler\handleUncaughtException
static handleUncaughtException( $e)
Callback to use with PHP's set_exception_handler.
Definition: MWExceptionHandler.php:143
is
This document provides an overview of the usage of PageUpdater and that is
Definition: pageupdater.txt:3
Wikimedia\Rdbms\DBError
Database error base class.
Definition: DBError.php:30
FormatJson\ALL_OK
const ALL_OK
Skip escaping as many characters as reasonably possible.
Definition: FormatJson.php:55
php
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
$wgPropagateErrors
$wgPropagateErrors
If true, the MediaWiki error handler passes errors/warnings to the default error handler after loggin...
Definition: DefaultSettings.php:6311
MWExceptionHandler\getPublicLogMessage
static getPublicLogMessage( $e)
Definition: MWExceptionHandler.php:520
$data
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Definition: generatePhpCharToUpperMappings.php:13
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
MWExceptionHandler\CAUGHT_BY_OTHER
const CAUGHT_BY_OTHER
Definition: MWExceptionHandler.php:32
MWExceptionHandler\handleFatalError
static handleFatalError( $level=null, $message=null, $file=null, $line=null, $context=null, $trace=null)
Dual purpose callback used as both a set_error_handler() callback and a registered shutdown function.
Definition: MWExceptionHandler.php:283
MWException
MediaWiki exception.
Definition: MWException.php:26
MWExceptionHandler\getLogContext
static getLogContext( $e, $catcher=self::CAUGHT_BY_OTHER)
Get a PSR-3 log event context from an Exception.
Definition: MWExceptionHandler.php:539
MWExceptionHandler\prettyPrintTrace
static prettyPrintTrace(array $trace, $pad='')
Generate a string representation of a stacktrace.
Definition: MWExceptionHandler.php:393
user
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 and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Definition: distributors.txt:9
MWExceptionHandler\getURL
static getURL()
If the exception occurred in the course of responding to a request, returns the requested URL.
Definition: MWExceptionHandler.php:472
MWExceptionHandler\handleException
static handleException( $e)
Exception handler which simulates the appropriate catch() handling:
Definition: MWExceptionHandler.php:170
MWExceptionHandler\getLogMessage
static getLogMessage( $e)
Get a message formatting the exception message and its origin.
Definition: MWExceptionHandler.php:487
in
null for the wiki Added in
Definition: hooks.txt:1588
MWExceptionHandler\$fatalErrorTypes
static $fatalErrorTypes
Error types that, if unhandled, are fatal to the request.
Definition: MWExceptionHandler.php:55
MWExceptionHandler\rollbackMasterChangesAndLog
static rollbackMasterChangesAndLog( $e)
Roll back any open database transactions and log the stack trace of the exception.
Definition: MWExceptionHandler.php:116
not
if not
Definition: COPYING.txt:307
MediaWiki
A helper class for throttling authentication attempts.
$wgLogExceptionBacktrace
$wgLogExceptionBacktrace
If true, send the exception backtrace to the error log.
Definition: DefaultSettings.php:6305
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
MWExceptionHandler\$reservedMemory
static $reservedMemory
Definition: MWExceptionHandler.php:37
MWExceptionRenderer\AS_PRETTY
const AS_PRETTY
Definition: MWExceptionRenderer.php:31
array
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("192.168.0.1:11211", 2))
by
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed by
Definition: APACHE-LICENSE-2.0.txt:49
or
or
Definition: COPYING.txt:140
$line
$line
Definition: cdb.php:59
see
Some information about database access in MediaWiki By Tim January Database layout For information about the MediaWiki database such as a description of the tables and their please see
Definition: database.txt:2
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2162
wfIsCLI
wfIsCLI()
Check if we are running from the commandline.
Definition: GlobalFunctions.php:1974
$suppressed
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException $suppressed
Definition: hooks.txt:2162
on
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going on
Definition: hooks.txt:77
MWExceptionRenderer\output
static output( $e, $mode, $eNew=null)
Definition: MWExceptionRenderer.php:38
and
and that you know you can do these things To protect your we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the or if you modify it For if you distribute copies of such a whether gratis or for a you must give the recipients all the rights that you have You must make sure that receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two and(2) offer you this license which gives you legal permission to copy
MWExceptionHandler\report
static report( $e)
Report an exception to the user.
Definition: MWExceptionHandler.php:89
WebRequest\getRequestId
static getRequestId()
Get the unique request ID.
Definition: WebRequest.php:275
as
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
LoggerFactory
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
WebRequest\getGlobalRequestURL
static getGlobalRequestURL()
Return the path and query string portion of the main request URI.
Definition: WebRequest.php:796
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
MWExceptionHandler\jsonSerializeException
static jsonSerializeException( $e, $pretty=false, $escaping=0, $catcher=self::CAUGHT_BY_OTHER)
Serialize an Exception object to JSON.
Definition: MWExceptionHandler.php:647
$services
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response 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
Definition: hooks.txt:2220
$wgRequest
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:728
MediaWikiServices
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 MediaWikiServices
Definition: injection.txt:23
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
MWExceptionHandler\handleError
static handleError( $level, $message, $file=null, $line=null)
Handler for set_error_handler() callback notifications.
Definition: MWExceptionHandler.php:193
href
shown</td >< td > a href
Definition: All_system_messages.txt:2667
MWExceptionHandler\getRedactedTraceAsString
static getRedactedTraceAsString( $e)
Generate a string representation of an exception's stack trace.
Definition: MWExceptionHandler.php:381
MWExceptionHandler\logException
static logException( $e, $catcher=self::CAUGHT_BY_OTHER)
Log an exception to the exception log (if enabled).
Definition: MWExceptionHandler.php:667
MWExceptionRenderer\AS_RAW
const AS_RAW
Definition: MWExceptionRenderer.php:30
$type
$type
Definition: testCompression.php:48