68c433bd23
Migrate all callers of Hooks::run() to use the new HookContainer/HookRunner system. General principles: * Use DI if it is already used. We're not changing the way state is managed in this patch. * HookContainer is always injected, not HookRunner. HookContainer is a service, it's a more generic interface, it is the only thing that provides isRegistered() which is needed in some cases, and a HookRunner can be efficiently constructed from it (confirmed by benchmark). Because HookContainer is needed for object construction, it is also needed by all factories. * "Ask your friendly local base class". Big hierarchies like SpecialPage and ApiBase have getHookContainer() and getHookRunner() methods in the base class, and classes that extend that base class are not expected to know or care where the base class gets its HookContainer from. * ProtectedHookAccessorTrait provides protected getHookContainer() and getHookRunner() methods, getting them from the global service container. The point of this is to ease migration to DI by ensuring that call sites ask their local friendly base class rather than getting a HookRunner from the service container directly. * Private $this->hookRunner. In some smaller classes where accessor methods did not seem warranted, there is a private HookRunner property which is accessed directly. Very rarely (two cases), there is a protected property, for consistency with code that conventionally assumes protected=private, but in cases where the class might actually be overridden, a protected accessor is preferred over a protected property. * The last resort: Hooks::runner(). Mostly for static, file-scope and global code. In a few cases it was used for objects with broken construction schemes, out of horror or laziness. Constructors with new required arguments: * AuthManager * BadFileLookup * BlockManager * ClassicInterwikiLookup * ContentHandlerFactory * ContentSecurityPolicy * DefaultOptionsManager * DerivedPageDataUpdater * FullSearchResultWidget * HtmlCacheUpdater * LanguageFactory * LanguageNameUtils * LinkRenderer * LinkRendererFactory * LocalisationCache * MagicWordFactory * MessageCache * NamespaceInfo * PageEditStash * PageHandlerFactory * PageUpdater * ParserFactory * PermissionManager * RevisionStore * RevisionStoreFactory * SearchEngineConfig * SearchEngineFactory * SearchFormWidget * SearchNearMatcher * SessionBackend * SpecialPageFactory * UserNameUtils * UserOptionsManager * WatchedItemQueryService * WatchedItemStore Constructors with new optional arguments: * DefaultPreferencesFactory * Language * LinkHolderArray * MovePage * Parser * ParserCache * PasswordReset * Router setHookContainer() now required after construction: * AuthenticationProvider * ResourceLoaderModule * SearchEngine Change-Id: Id442b0dbe43aba84bd5cf801d86dedc768b082c7
105 lines
3.6 KiB
PHP
105 lines
3.6 KiB
PHP
<?php
|
|
/**
|
|
* Authentication provider interface
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Auth
|
|
*/
|
|
|
|
namespace MediaWiki\Auth;
|
|
|
|
use Config;
|
|
use MediaWiki\HookContainer\HookContainer;
|
|
use Psr\Log\LoggerAwareInterface;
|
|
|
|
/**
|
|
* An AuthenticationProvider is used by AuthManager when authenticating users.
|
|
*
|
|
* This interface should not be implemented directly; use one of its children.
|
|
*
|
|
* Authentication providers can be registered via $wgAuthManagerAutoConfig.
|
|
*
|
|
* @ingroup Auth
|
|
* @since 1.27
|
|
*/
|
|
interface AuthenticationProvider extends LoggerAwareInterface {
|
|
|
|
/**
|
|
* Set AuthManager
|
|
* @param AuthManager $manager
|
|
*/
|
|
public function setManager( AuthManager $manager );
|
|
|
|
/**
|
|
* Set configuration
|
|
* @param Config $config
|
|
*/
|
|
public function setConfig( Config $config );
|
|
|
|
/**
|
|
* Set the HookContainer
|
|
* @param HookContainer $hookContainer
|
|
*/
|
|
public function setHookContainer( HookContainer $hookContainer );
|
|
|
|
/**
|
|
* Return a unique identifier for this instance
|
|
*
|
|
* This must be the same across requests. If multiple instances return the
|
|
* same ID, exceptions will be thrown from AuthManager.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getUniqueId();
|
|
|
|
/**
|
|
* Return the applicable list of AuthenticationRequests
|
|
*
|
|
* Possible values for $action depend on whether the implementing class is
|
|
* also a PreAuthenticationProvider, PrimaryAuthenticationProvider, or
|
|
* SecondaryAuthenticationProvider.
|
|
* - ACTION_LOGIN: Valid for passing to beginAuthentication. Called on all
|
|
* providers.
|
|
* - ACTION_CREATE: Valid for passing to beginAccountCreation. Called on
|
|
* all providers.
|
|
* - ACTION_LINK: Valid for passing to beginAccountLink. Called on linking
|
|
* primary providers only.
|
|
* - ACTION_CHANGE: Valid for passing to AuthManager::changeAuthenticationData
|
|
* to change credentials. Called on primary and secondary providers.
|
|
* - ACTION_REMOVE: Valid for passing to AuthManager::changeAuthenticationData
|
|
* to remove credentials. Must work without additional user input (i.e.
|
|
* without calling loadFromSubmission). Called on primary and secondary
|
|
* providers.
|
|
*
|
|
* @see AuthManager::getAuthenticationRequests()
|
|
* @param string $action
|
|
* @param array $options Options are:
|
|
* - username: User name related to the action, or null/unset if anon.
|
|
* - ACTION_LOGIN: The currently logged-in user, if any.
|
|
* - ACTION_CREATE: The account creator, if non-anonymous.
|
|
* - ACTION_LINK: The local user being linked to.
|
|
* - ACTION_CHANGE: The user having data changed.
|
|
* - ACTION_REMOVE: The user having data removed.
|
|
* If you leave the username property of the returned requests empty, this
|
|
* will automatically be copied there (except for ACTION_CREATE where it
|
|
* wouldn't really make sense).
|
|
* @return AuthenticationRequest[]
|
|
*/
|
|
public function getAuthenticationRequests( $action, array $options );
|
|
|
|
}
|