/**
* Constructs an instance of ApiMain that utilizes the module and format specified by $request.
*
* @param IContextSource|WebRequest $context If this is an instance of
* FauxRequest, errors are thrown and no printing occurs
* @param bool $enableWrite Should be set to true if the api may modify data
*/
public function __construct($context = null, $enableWrite = false)
{
if ($context === null) {
$context = RequestContext::getMain();
} elseif ($context instanceof WebRequest) {
// BC for pre-1.19
$request = $context;
$context = RequestContext::getMain();
}
// We set a derivative context so we can change stuff later
$this->setContext(new DerivativeContext($context));
if (isset($request)) {
$this->getContext()->setRequest($request);
}
$this->mInternalMode = $this->getRequest() instanceof FauxRequest;
// Special handling for the main module: $parent === $this
parent::__construct($this, $this->mInternalMode ? 'main_int' : 'main');
if (!$this->mInternalMode) {
// Impose module restrictions.
// If the current user cannot read,
// Remove all modules other than login
global $wgUser;
if ($this->lacksSameOriginSecurity()) {
// If we're in a mode that breaks the same-origin policy, strip
// user credentials for security.
wfDebug("API: stripping user credentials when the same-origin policy is not applied\n");
$wgUser = new User();
$this->getContext()->setUser($wgUser);
}
}
$uselang = $this->getParameter('uselang');
if ($uselang === 'user') {
// Assume the parent context is going to return the user language
// for uselang=user (see T85635).
} else {
if ($uselang === 'content') {
global $wgContLang;
$uselang = $wgContLang->getCode();
}
$code = RequestContext::sanitizeLangCode($uselang);
$this->getContext()->setLanguage($code);
if (!$this->mInternalMode) {
global $wgLang;
$wgLang = $this->getContext()->getLanguage();
RequestContext::getMain()->setLanguage($wgLang);
}
}
$config = $this->getConfig();
$this->mModuleMgr = new ApiModuleManager($this);
$this->mModuleMgr->addModules(self::$Modules, 'action');
$this->mModuleMgr->addModules($config->get('APIModules'), 'action');
$this->mModuleMgr->addModules(self::$Formats, 'format');
$this->mModuleMgr->addModules($config->get('APIFormatModules'), 'format');
Hooks::run('ApiMain::moduleManager', array($this->mModuleMgr));
$this->mResult = new ApiResult($this->getConfig()->get('APIMaxResultSize'));
$this->mErrorFormatter = new ApiErrorFormatter_BackCompat($this->mResult);
$this->mResult->setErrorFormatter($this->mErrorFormatter);
$this->mResult->setMainForContinuation($this);
$this->mContinuationManager = null;
$this->mEnableWrite = $enableWrite;
$this->mSquidMaxage = -1;
// flag for executeActionWithErrorHandling()
$this->mCommit = false;
}
/**
* Set the Language object
*
* @param Language|string $l Language instance or language code
* @throws MWException
* @since 1.19
*/
public function setLanguage($l)
{
if ($l instanceof Language) {
$this->lang = $l;
} elseif (is_string($l)) {
$l = RequestContext::sanitizeLangCode($l);
$obj = Language::factory($l);
$this->lang = $obj;
} else {
throw new MWException(__METHOD__ . " was passed an invalid type of data.");
}
}
/**
* Constructs an instance of ApiMain that utilizes the module and format specified by $request.
*
* @param IContextSource|WebRequest $context If this is an instance of
* FauxRequest, errors are thrown and no printing occurs
* @param bool $enableWrite Should be set to true if the api may modify data
*/
public function __construct($context = null, $enableWrite = false)
{
if ($context === null) {
$context = RequestContext::getMain();
} elseif ($context instanceof WebRequest) {
// BC for pre-1.19
$request = $context;
$context = RequestContext::getMain();
}
// We set a derivative context so we can change stuff later
$this->setContext(new DerivativeContext($context));
if (isset($request)) {
$this->getContext()->setRequest($request);
} else {
$request = $this->getRequest();
}
$this->mInternalMode = $request instanceof FauxRequest;
// Special handling for the main module: $parent === $this
parent::__construct($this, $this->mInternalMode ? 'main_int' : 'main');
$config = $this->getConfig();
if (!$this->mInternalMode) {
// Log if a request with a non-whitelisted Origin header is seen
// with session cookies.
$originHeader = $request->getHeader('Origin');
if ($originHeader === false) {
$origins = [];
} else {
$originHeader = trim($originHeader);
$origins = preg_split('/\\s+/', $originHeader);
}
$sessionCookies = array_intersect(array_keys($_COOKIE), MediaWiki\Session\SessionManager::singleton()->getVaryCookies());
if ($origins && $sessionCookies && (count($origins) !== 1 || !self::matchOrigin($origins[0], $config->get('CrossSiteAJAXdomains'), $config->get('CrossSiteAJAXdomainExceptions')))) {
LoggerFactory::getInstance('cors')->warning('Non-whitelisted CORS request with session cookies', ['origin' => $originHeader, 'cookies' => $sessionCookies, 'ip' => $request->getIP(), 'userAgent' => $this->getUserAgent(), 'wiki' => wfWikiID()]);
}
// If we're in a mode that breaks the same-origin policy, strip
// user credentials for security.
if ($this->lacksSameOriginSecurity()) {
global $wgUser;
wfDebug("API: stripping user credentials when the same-origin policy is not applied\n");
$wgUser = new User();
$this->getContext()->setUser($wgUser);
}
}
$uselang = $this->getParameter('uselang');
if ($uselang === 'user') {
// Assume the parent context is going to return the user language
// for uselang=user (see T85635).
} else {
if ($uselang === 'content') {
global $wgContLang;
$uselang = $wgContLang->getCode();
}
$code = RequestContext::sanitizeLangCode($uselang);
$this->getContext()->setLanguage($code);
if (!$this->mInternalMode) {
global $wgLang;
$wgLang = $this->getContext()->getLanguage();
RequestContext::getMain()->setLanguage($wgLang);
}
}
$this->mModuleMgr = new ApiModuleManager($this);
$this->mModuleMgr->addModules(self::$Modules, 'action');
$this->mModuleMgr->addModules($config->get('APIModules'), 'action');
$this->mModuleMgr->addModules(self::$Formats, 'format');
$this->mModuleMgr->addModules($config->get('APIFormatModules'), 'format');
Hooks::run('ApiMain::moduleManager', [$this->mModuleMgr]);
$this->mResult = new ApiResult($this->getConfig()->get('APIMaxResultSize'));
$this->mErrorFormatter = new ApiErrorFormatter_BackCompat($this->mResult);
$this->mResult->setErrorFormatter($this->mErrorFormatter);
$this->mContinuationManager = null;
$this->mEnableWrite = $enableWrite;
$this->mSquidMaxage = -1;
// flag for executeActionWithErrorHandling()
$this->mCommit = false;
}
/**
* @return string
*/
public function getLanguage()
{
if ($this->language === null) {
// Must be a valid language code after this point (bug 62849)
$this->language = RequestContext::sanitizeLangCode($this->request->getVal('lang'));
}
return $this->language;
}
function execute($par)
{
global $wgMemc, $wgCentralAuthLoginWiki;
$request = $this->getRequest();
$this->loginWiki = $wgCentralAuthLoginWiki;
if (!$this->loginWiki) {
// Ugh, no central wiki. If we're coming from an edge login, make
// the logged-into wiki the de-facto central wiki for this request
// so auto-login still works.
$fromwiki = $request->getVal('from', $request->getVal('notifywiki'));
if ($fromwiki !== null && WikiMap::getWiki($fromwiki)) {
$this->loginWiki = $fromwiki;
}
} elseif ($request->getVal('from') === wfWikiId() && $wgCentralAuthLoginWiki !== wfWikiId()) {
// Remote wiki must not have wgCentralAuthLoginWiki set, but we do. Redirect them.
$this->do302Redirect($wgCentralAuthLoginWiki, $par, $request->getValues());
return;
}
$params = $request->getValues('type', 'from', 'return', 'returnto', 'returntoquery', 'proto', 'mobile');
switch (strval($par)) {
case 'P3P':
// Explain the bogus P3P header
$this->setHeaders();
$this->getOutput()->addWikiMsg('centralauth-centralautologin-p3p-explanation');
return;
case 'toolslist':
// Do not cache this, we want updated Echo numbers and such.
$this->getOutput()->enableClientCache(false);
$user = $this->getUser();
if (!$user->isAnon()) {
if (!CentralAuthHooks::isUIReloadRecommended($user)) {
$html = $this->getSkin()->getPersonalToolsList();
$json = FormatJSON::encode(array('toolslist' => $html));
} else {
$gender = $this->getUser()->getOption('gender');
if (strval($gender) === '') {
$gender = 'unknown';
}
$json = FormatJSON::encode(array('notify' => array('username' => $user->getName(), 'gender' => $gender)));
}
$this->doFinalOutput(true, 'OK', $json, 'json');
} else {
$this->doFinalOutput(false, 'Not logged in', '', 'json');
}
return;
case 'refreshCookies':
// Refresh central cookies (e.g. in case 'remember me' was set)
// Do not cache this, we need to reset the cookies every time.
$this->getOutput()->enableClientCache(false);
if (!$wgCentralAuthLoginWiki || !$this->checkIsCentralWiki($wikiid)) {
return;
}
CentralAuthUser::setP3P();
$centralUser = CentralAuthUser::getInstance($this->getUser());
if ($centralUser && $centralUser->getId()) {
$centralSession = $this->getCentralSession($centralUser, $this->getUser());
// Refresh 'remember me' preference
$remember = (bool) $centralSession['remember'];
if ($remember != $this->getUser()->getBoolOption('rememberpassword')) {
$this->getUser()->setOption('rememberpassword', $remember ? 1 : 0);
$this->getUser()->saveSettings();
}
$secureCookie = $centralSession['secureCookies'];
$centralUser->setGlobalCookies($remember, false, $secureCookie, $centralSession);
$this->doFinalOutput(true, 'success');
} else {
$this->doFinalOutput(false, 'Not logged in');
}
return;
case 'deleteCookies':
// Delete central cookies
// Do not cache this, we need to reset the cookies every time.
$this->getOutput()->enableClientCache(false);
if ($this->getUser()->isLoggedIn()) {
$this->doFinalOutput(false, 'Cannot delete cookies while still logged in');
return;
}
CentralAuthUser::setP3P();
CentralAuthUser::deleteGlobalCookies();
$this->doFinalOutput(true, 'success');
return;
case 'start':
// Main entry point
// Note this is safe to cache, because the cache already varies on
// the session cookies.
$this->getOutput()->setSquidMaxage(1200);
if (!$this->checkIsLocalWiki()) {
return;
}
CentralAuthUser::setP3P();
$this->do302Redirect($this->loginWiki, 'checkLoggedIn', array('wikiid' => wfWikiID(), 'proto' => $request->detectProtocol()) + $params);
return;
case 'checkLoggedIn':
// Check if we're logged in centrally
// Note this is safe to cache, because the cache already varies on
// the session cookies.
$this->getOutput()->setSquidMaxage(1200);
if (!$this->checkIsCentralWiki($wikiid)) {
return;
}
CentralAuthUser::setP3P();
if ($this->getUser()->isLoggedIn()) {
$centralUser = CentralAuthUser::getInstance($this->getUser());
} else {
$this->doFinalOutput(false, 'Not centrally logged in', self::getInlineScript('anon-set.js'));
return;
}
// We're pretty sure this user is logged in, so pass back
// headers to prevent caching, just in case
$this->getOutput()->enableClientCache(false);
$memcData = array('gu_id' => $centralUser->getId());
$token = MWCryptRand::generateHex(32);
$key = CentralAuthUser::memcKey('centralautologin-token', $token);
$wgMemc->set($key, $memcData, 60);
$this->do302Redirect($wikiid, 'createSession', array('token' => $token) + $params);
return;
case 'createSession':
// Create the local session and shared memcache token
if (!$this->checkIsLocalWiki()) {
return;
}
CentralAuthUser::setP3P();
$token = $request->getVal('token', '');
$gid = $request->getVal('gu_id', '');
if ($token !== '') {
// Load memc data
$key = CentralAuthUser::memcKey('centralautologin-token', $token);
$memcData = $wgMemc->get($key);
$wgMemc->delete($key);
if (!$memcData || !isset($memcData['gu_id'])) {
$this->doFinalOutput(false, 'Invalid parameters');
return;
}
$gu_id = intval($memcData['gu_id']);
} elseif ($gid !== '') {
// Cached, or was logging in as we switched from gu_id to token
$gu_id = intval($gid);
} else {
$this->doFinalOutput(false, 'Invalid parameters');
return;
}
if ($gu_id <= 0) {
$this->doFinalOutput(false, 'Not centrally logged in', self::getInlineScript('anon-set.js'));
return;
}
// At this point we can't cache anymore because we need to set
// cookies and memc each time.
$this->getOutput()->enableClientCache(false);
// Ensure that a session exists
if (session_id() == '') {
wfSetupSession();
}
// Create memc token
$wikiid = wfWikiID();
$memcData = array('gu_id' => $gu_id, 'wikiid' => $wikiid);
$token = MWCryptRand::generateHex(32);
$key = CentralAuthUser::memcKey('centralautologin-token', $token, $wikiid);
$wgMemc->set($key, $memcData, 60);
// Save memc token for the 'setCookies' step
$request->setSessionData('centralautologin-token', $token);
$this->do302Redirect($this->loginWiki, 'validateSession', array('token' => $token, 'wikiid' => $wikiid) + $params);
return;
case 'validateSession':
// Validate the shared memcached token
// Do not cache this, we need to reset the cookies and memc every time.
$this->getOutput()->enableClientCache(false);
if (!$this->checkIsCentralWiki($wikiid)) {
return;
}
if (!$this->getUser()->isLoggedIn()) {
$this->doFinalOutput(false, 'Not logged in');
return;
}
CentralAuthUser::setP3P();
// Validate params
$token = $request->getVal('token', '');
if ($token === '') {
$this->doFinalOutput(false, 'Invalid parameters');
return;
}
// Load memc data
$key = CentralAuthUser::memcKey('centralautologin-token', $token, $wikiid);
$memcData = $wgMemc->get($key);
$wgMemc->delete($key);
// Check memc data
$centralUser = CentralAuthUser::getInstance($this->getUser());
if (!$memcData || $memcData['wikiid'] !== $wikiid || !$centralUser || !$centralUser->getId() || $memcData['gu_id'] != $centralUser->getId()) {
$this->doFinalOutput(false, 'Invalid parameters');
return;
}
// Write info for session creation into memc
$centralSession = $this->getCentralSession($centralUser, $this->getUser());
$memcData += array('userName' => $centralUser->getName(), 'token' => $centralUser->getAuthToken(), 'finalProto' => $centralSession['finalProto'], 'secureCookies' => $centralSession['secureCookies'], 'remember' => $centralSession['remember'], 'sessionId' => $centralSession['sessionId']);
$wgMemc->set($key, $memcData, 60);
$this->do302Redirect($wikiid, 'setCookies', $params);
return;
case 'setCookies':
// Check that memcached is validated, and set cookies
// Do not cache this, we need to reset the cookies and memc every time.
$this->getOutput()->enableClientCache(false);
if (!$this->checkIsLocalWiki()) {
return;
}
CentralAuthUser::setP3P();
// Check saved memc token
$token = $this->getRequest()->getSessionData('centralautologin-token');
if ($token === null) {
$this->doFinalOutput(false, 'Lost session');
return;
}
// Load memc data
$wikiid = wfWikiID();
$key = CentralAuthUser::memcKey('centralautologin-token', $token, $wikiid);
$memcData = $wgMemc->get($key);
$wgMemc->delete($key);
// Check memc data
if (!$memcData || $memcData['wikiid'] !== $wikiid || !isset($memcData['userName']) || !isset($memcData['token'])) {
$this->doFinalOutput(false, 'Lost session');
return;
}
// Load and check CentralAuthUser. But don't check if it's
// attached, because then if the user is missing en.site they
// won't be auto logged in to any of the non-en versions either.
$centralUser = new CentralAuthUser($memcData['userName']);
if (!$centralUser->getId() || $centralUser->getId() != $memcData['gu_id']) {
$msg = "Wrong user: expected {$memcData['gu_id']}, got {$centralUser->getId()}";
wfDebug(__METHOD__ . ": {$msg}\n");
$this->doFinalOutput(false, 'Lost session');
return;
}
$loginResult = $centralUser->authenticateWithToken($memcData['token']);
if ($loginResult != 'ok') {
$msg = "Bad token: {$loginResult}";
wfDebug(__METHOD__ . ": {$msg}\n");
$this->doFinalOutput(false, 'Lost session');
return;
}
// Set a new session cookie, Just In Case™
wfResetSessionID();
// Set central cookies too, with a refreshed sessionid. Also, check if we
// need to override the default cookie security policy
$secureCookie = $memcData['secureCookies'];
$centralUser->setGlobalCookies($memcData['remember'], $memcData['sessionId'], $secureCookie, array('finalProto' => $memcData['finalProto'], 'secureCookies' => $memcData['secureCookies'], 'remember' => $memcData['remember']));
// Now, figure out how to report this back to the user.
// First, set to redo the edge login on the next pageview
$request->setSessionData('CentralAuthDoEdgeLogin', true);
// If it's not a script callback, just go for it.
if ($request->getVal('type') !== 'script') {
$this->doFinalOutput(true, 'success');
return;
}
// If it is a script callback, then we do want to create the user
// if it doesn't already exist locally (and fail if that can't be
// done).
if (!User::idFromName($centralUser->getName())) {
$user = new User();
$user->setName($centralUser->getName());
if (CentralAuthHooks::attemptAddUser($user)) {
$centralUser->invalidateCache();
}
}
if (!$centralUser->isAttached()) {
$this->doFinalOutput(false, 'Local user is not attached', self::getInlineScript('anon-set.js'));
return;
}
$script = self::getInlineScript('anon-remove.js');
// If we're returning to returnto, do that
if ($request->getCheck('return')) {
global $wgRedirectOnLogin;
if ($wgRedirectOnLogin !== null) {
$returnTo = $wgRedirectOnLogin;
$returnToQuery = array();
} else {
$returnTo = $request->getVal('returnto', '');
$returnToQuery = wfCgiToArray($request->getVal('returntoquery', ''));
}
$returnToTitle = Title::newFromText($returnTo);
if (!$returnToTitle) {
$returnToTitle = Title::newMainPage();
$returnToQuery = array();
}
$redirectUrl = $returnToTitle->getFullURL($returnToQuery);
$script .= "\n" . 'location.href = ' . Xml::encodeJsVar($redirectUrl) . ';';
$this->doFinalOutput(true, 'success', $script);
return;
}
// Otherwise, we need to rewrite p-personal and maybe notify the user too
global $wgCentralAuthUseEventLogging;
if ($wgCentralAuthUseEventLogging) {
EventLogging::logEvent('CentralAuth', 5690875, array('version' => 1, 'userId' => $centralUser->getId(), 'action' => 'sul2-autologin-fallbacklogin'));
}
// Add a script to the page that will pull in the user's toolslist
// via ajax, and update the UI. Don't write out the tools here (bug 57081).
$code = $this->getUser()->getOption('language');
$code = RequestContext::sanitizeLangCode($code);
Hooks::run('UserGetLanguageObject', array($this->getUser(), &$code, $this->getContext()));
$script .= "\n" . Xml::encodeJsCall('mediaWiki.messages.set', array(array('centralauth-centralautologin-logged-in' => wfMessage('centralauth-centralautologin-logged-in')->inLanguage($code)->plain(), 'centralauth-centralautologin-logged-in-nouser' => wfMessage('centralauth-centralautologin-logged-in-nouser')->inLanguage($code)->plain(), 'centralautologin' => wfMessage('centralautologin')->inLanguage($code)->plain())));
$script .= "\n" . self::getInlineScript('autologin.js');
// And for good measure, add the edge login HTML images to the page.
$script .= "\n" . Xml::encodeJsCall("jQuery( 'body' ).append", array(CentralAuthHooks::getEdgeLoginHTML()));
$this->doFinalOutput(true, 'success', $script);
return;
default:
$this->setHeaders();
$this->getOutput()->addWikiMsg('centralauth-centralautologin-desc');
return;
}
}
