MediaWiki  1.29.2
Http.php
Go to the documentation of this file.
1 <?php
22 
27 class Http {
28  static public $httpEngine = false;
29 
61  public static function request( $method, $url, $options = [], $caller = __METHOD__ ) {
62  wfDebug( "HTTP: $method: $url\n" );
63 
64  $options['method'] = strtoupper( $method );
65 
66  if ( !isset( $options['timeout'] ) ) {
67  $options['timeout'] = 'default';
68  }
69  if ( !isset( $options['connectTimeout'] ) ) {
70  $options['connectTimeout'] = 'default';
71  }
72 
73  $req = MWHttpRequest::factory( $url, $options, $caller );
74  $status = $req->execute();
75 
76  if ( $status->isOK() ) {
77  return $req->getContent();
78  } else {
79  $errors = $status->getErrorsByType( 'error' );
80  $logger = LoggerFactory::getInstance( 'http' );
81  $logger->warning( Status::wrap( $status )->getWikiText( false, false, 'en' ),
82  [ 'error' => $errors, 'caller' => $caller, 'content' => $req->getContent() ] );
83  return false;
84  }
85  }
86 
98  public static function get( $url, $options = [], $caller = __METHOD__ ) {
99  $args = func_get_args();
100  if ( isset( $args[1] ) && ( is_string( $args[1] ) || is_numeric( $args[1] ) ) ) {
101  // Second was used to be the timeout
102  // And third parameter used to be $options
103  wfWarn( "Second parameter should not be a timeout.", 2 );
104  $options = isset( $args[2] ) && is_array( $args[2] ) ?
105  $args[2] : [];
106  $options['timeout'] = $args[1];
107  $caller = __METHOD__;
108  }
109  return Http::request( 'GET', $url, $options, $caller );
110  }
111 
121  public static function post( $url, $options = [], $caller = __METHOD__ ) {
122  return Http::request( 'POST', $url, $options, $caller );
123  }
124 
129  public static function userAgent() {
131  return "MediaWiki/$wgVersion";
132  }
133 
146  public static function isValidURI( $uri ) {
147  return (bool)preg_match(
148  '/^https?:\/\/[^\/\s]\S*$/D',
149  $uri
150  );
151  }
152 
158  public static function getProxy() {
159  global $wgHTTPProxy;
160 
161  if ( $wgHTTPProxy ) {
162  return $wgHTTPProxy;
163  }
164 
165  return "";
166  }
167 }
MWHttpRequest\factory
static factory( $url, $options=null, $caller=__METHOD__)
Generate a new request object.
Definition: MWHttpRequest.php:180
Http\$httpEngine
static $httpEngine
Definition: Http.php:28
Http\request
static request( $method, $url, $options=[], $caller=__METHOD__)
Perform an HTTP request.
Definition: Http.php:61
$wgVersion
$wgVersion
MediaWiki version number.
Definition: DefaultSettings.php:78
Http\userAgent
static userAgent()
A standard user-agent we can use for external requests.
Definition: Http.php:129
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1049
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
$req
this hook is for auditing only $req
Definition: hooks.txt:990
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
Status\wrap
static wrap( $sv)
Succinct helper method to wrap a StatusValue.
Definition: Status.php:55
Http\getProxy
static getProxy()
Gets the relevant proxy from $wgHTTPProxy.
Definition: Http.php:158
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:999
Http\post
static post( $url, $options=[], $caller=__METHOD__)
Simple wrapper for Http::request( 'POST' )
Definition: Http.php:121
$args
if( $line===false) $args
Definition: cdb.php:63
Http\isValidURI
static isValidURI( $uri)
Checks that the given URI is a valid one.
Definition: Http.php:146
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
wfWarn
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
Definition: GlobalFunctions.php:1142
$options
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1049
Http
Various HTTP related functions.
Definition: Http.php:27