MediaWiki  master
api.php
Go to the documentation of this file.
1 <?php
31 
32 // So extensions (and other code) can check whether they're running in API mode
33 define( 'MW_API', true );
34 define( 'MW_ENTRY_POINT', 'api' );
35 
36 require __DIR__ . '/includes/WebStart.php';
37 
38 $starttime = microtime( true );
39 
40 // PATH_INFO can be used for stupid things. We don't support it for api.php at
41 // all, so error out if it's present. (T128209)
42 if ( isset( $_SERVER['PATH_INFO'] ) && $_SERVER['PATH_INFO'] != '' ) {
43  $correctUrl = wfAppendQuery( wfScript( 'api' ), $wgRequest->getQueryValuesOnly() );
44  $correctUrl = wfExpandUrl( $correctUrl, PROTO_CANONICAL );
45  header( "Location: $correctUrl", true, 301 );
46  echo 'This endpoint does not support "path info", i.e. extra text between "api.php"'
47  . 'and the "?". Remove any such text and try again.';
48  die( 1 );
49 }
50 
51 // Set a dummy $wgTitle, because $wgTitle == null breaks various things
52 // In a perfect world this wouldn't be necessary
53 $wgTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/dummy title for API calls set in api.php' );
54 
55 // RequestContext will read from $wgTitle, but it will also whine about it.
56 // In a perfect world this wouldn't be necessary either.
57 RequestContext::getMain()->setTitle( $wgTitle );
58 
59 try {
60  // Construct an ApiMain with the arguments passed via the URL. What we get back
61  // is some form of an ApiMain, possibly even one that produces an error message,
62  // but we don't care here, as that is handled by the constructor.
63  $processor = new ApiMain( RequestContext::getMain(), true );
64 
65  // Last chance hook before executing the API
66  Hooks::run( 'ApiBeforeMain', [ &$processor ] );
67  if ( !$processor instanceof ApiMain ) {
68  throw new MWException( 'ApiBeforeMain hook set $processor to a non-ApiMain class' );
69  }
70 } catch ( Throwable $e ) {
71  // Crap. Try to report the exception in API format to be friendly to clients.
73  $processor = false;
74 }
75 
76 // Process data & print results
77 if ( $processor ) {
78  $processor->execute();
79 }
80 
81 // Log what the user did, for book-keeping purposes.
82 $endtime = microtime( true );
83 
84 // Log the request
85 if ( $wgAPIRequestLog ) {
86  $items = [
87  wfTimestamp( TS_MW ),
89  $wgRequest->getIP(),
90  $wgRequest->getHeader( 'User-agent' )
91  ];
92  $items[] = $wgRequest->wasPosted() ? 'POST' : 'GET';
93  if ( $processor ) {
94  try {
95  $manager = $processor->getModuleManager();
96  $module = $manager->getModule( $wgRequest->getVal( 'action' ), 'action' );
97  } catch ( Throwable $ex ) {
98  $module = null;
99  }
100  if ( !$module || $module->mustBePosted() ) {
101  $items[] = "action=" . $wgRequest->getVal( 'action' );
102  } else {
103  $items[] = wfArrayToCgi( $wgRequest->getValues() );
104  }
105  } else {
106  $items[] = "failed in ApiBeforeMain";
107  }
108  LegacyLogger::emit( implode( ',', $items ) . "\n", $wgAPIRequestLog );
109  wfDebug( "Logged API request to $wgAPIRequestLog\n" );
110 }
111 
113 $mediawiki->doPostOutputShutdown();
ApiMain
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:42
PROTO_CANONICAL
const PROTO_CANONICAL
Definition: Defines.php:203
$mediawiki
if( $wgAPIRequestLog) $mediawiki
Definition: api.php:112
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1871
$wgTitle
if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') $wgTitle
Definition: api.php:53
wfAppendQuery
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
Definition: GlobalFunctions.php:439
$wgAPIRequestLog
$wgAPIRequestLog
Log file or URL (TCP or UDP) to log API requests to, or false to disable API request logging.
Definition: DefaultSettings.php:8179
NS_SPECIAL
const NS_SPECIAL
Definition: Defines.php:49
MWException
MediaWiki exception.
Definition: MWException.php:26
$starttime
$starttime
Definition: api.php:38
wfScript
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:2629
$endtime
if(! $processor instanceof ApiMain) catch(Throwable $e) if( $processor) $endtime
Definition: api.php:82
MediaWiki
A helper class for throttling authentication attempts.
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:584
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:913
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:447
MediaWiki\Logger\LegacyLogger
PSR-3 logger that mimics the historic implementation of MediaWiki's former wfErrorLog logging impleme...
Definition: LegacyLogger.php:51
ApiMain\handleApiBeforeMainException
static handleApiBeforeMainException( $e)
Handle an exception from the ApiBeforeMain hook.
Definition: ApiMain.php:655
$wgRequest
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:713
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
wfExpandUrl
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Definition: GlobalFunctions.php:491
wfArrayToCgi
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
Definition: GlobalFunctions.php:347