Erweiterung:Email Authorization
Email Authorization Freigabestatus: stabil |
|
---|---|
Einbindung | Benutzerrechte |
Beschreibung | Impementiert den PluggableAuth-Hook, um die Autorisierung mithilfe einer Liste autorisierter E-Mail-Adressen zu ermöglichen. |
Autor(en) | Cindy Cicalese |
Letzte Version | 3.0 (2022-03-27) |
Kompatibilitätspolitik | Snapshots werden zusammen mit MediaWiki veröffentlicht. Der Master ist nicht abwärtskompatibel. |
MediaWiki | 1.35+ |
PHP | 7.4+ |
Datenbankänderungen | Ja |
Tabellen | emailauth emailrequest |
Lizenz | MIT-Lizenz |
Herunterladen | |
|
|
emailauthorizationconfig |
|
Übersetze die Email Authorization-Erweiterung, wenn sie auf translatewiki.net verfügbar ist | |
Probleme | Offene Aufgaben · Einen Fehler melden |
The Email Authorization extension implements the PluggableAuth PluggableAuthUserAuthorization
hook to provide authorization using a list of authorized email addresses.
It provides a special page, Special:EmailAuthorizationConfig
, for an administrator to use to add and remove email addresses and email domains from the authorization list.
Installation
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
EmailAuthorization
im Ordnerextensions/
ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/EmailAuthorization - Folgenden Code am Ende deiner LocalSettings.php -Datei einfügen:
wfLoadExtension( 'EmailAuthorization' );
- Führe das Aktualisierungsskript aus, welches automatisch die notwendigen Datenbanktabellen erstellt, die diese Erweiterung braucht.
- run
git submodule update --init
- Konfiguriere nach Bedarf
- Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
Konfiguration
Flag | Standard | Beschreibung |
---|---|---|
$wgEmailAuthorization_AuthorizedGroups
|
[]
|
An array of MediaWiki groups whose members are authorized regardless of whether their email addresses are authorized. This is especially useful to bootstrap the extension when it is installed by authorizing, for example, all members of the sysop group.
|
$wgEmailAuthorization_EnableRequests
|
false
|
Indicates whether a special page (Special:EmailAuthorizationRequest ) will be available for accounts to be requested. If enabled, that page will contain a form used to request an account. By default, that form will contain a single field: email address. Additional fields can be specified by $wgEmailAuthorization_RequestFields . In addition, if true, a special page (Special:EmailAuthorizationApprove ) will be available for users in the bureaucrat group to approve accounts.
|
$wgEmailAuthorization_RequestFields
|
[]
|
An array of additional fields for the request form. The definition of each field is itself an array with the following possible fields:
The last three parameters (values, rows, and columns) are used to decide how to display the field. If values is present, a drop-down list will be displayed, and any values for rows and columns will be ignored. If values is not present but rows is present, a text area of the specified size will be displayed, with columns defaulting to 50 if it is not present. If only columns is present, a text field of the specified width will be displayed. If none are present, a text field of 50 columns will be displayed. Regardless of the contents of this array, an email address field will be present as the first field. Zum Beispiel, $wgEmailAuthorization_RequestFields = [
[
'label' => 'Organization',
'mandatory' => true
],
[
'label' => 'Extra Information',
'rows' => 4,
'columns' => 60
],
[
'label' => 'Animals',
'values' => [ 'dog', 'cat' ]
]
];
would display a mandatory text field (Organization) with 50 columns, a text area with 4 rows and 60 columns (Extra Information), and a drop-down list to choose between dog and cat (Animals). |
Users who should be able to add and revoke email addresses and email domains on the Special:EmailAuthorizationConfig
page must be given the emailauthorizationconfig right.
Zum Beispiel:
$wgGroupPermissions['bureaucrat']['emailauthorizationconfig'] = true;
$wgPluggableAuth_EnableLocalProperties = false;
Hooks
This extension supplies the following hooks to other extensions:
EmailAuthorizationAdd
andEmailAuthorizationRevoke
take a single parameter: an email address or email domain (i.e. @ followed by the domain).EmailAuthorizationRequest
takes the following parameters: an email address and a JSON-encoded array of form fields.EmailAuthorizationApprove
andEmailAuthorizationReject
take the following parameters: an email address, a JSON-encoded array of form fields, and the User object of the bureaucrat approving/rejecting the account request.
Versionsgeschichte
- Version 3.0
- Updated to work with PluggableAuth 6.0
- Version 2.0
- Added
$wgEmailAuthorization_AuthorizedGroups
- Added support for postgres and sqlite in addition to existing mysql/mariadb support
- Use datatables jQuery plug-in on email authorization dashboard
- Convert UI to use OOUI
- Modernize code (type hints, dependency injection, global config, new hook system, linting, tests)
- Fix IDatabase::upsert() calls with bad unique key parameters
- Version 1.5
- Trim and lowercase emails before adding them
- Version 1.4
- Added PHPCS and autofix some found sniffs with PHPCBF
- Version 1.3
- Added optional account request capability controlled by
$wgEmailAuthorization_EnableRequests
Special:EmailAuthorizationRequest
Special:EmailAuthorizationApprove
- Version 1.2
- Change message prefix to prevent collisions with other extensions
- Table formatting
- Renamed
Special:ConfigEmailAuthorization
toSpecial:EmailAuthorizationConfig
- Version 1.1
- Bug fix: adding email address that already existed threw exception
- Email addresses and domains entered in
Special:ConfigEmailAuthorization
now are validated - Added missing rights messages
- Version 1.0
- Initial version
Bekannte Probleme
Versions before 2.0 did not work with PostgreSQL. Siehe T293933.
Diese Erweiterung ist in den folgenden Softwarepaketen enthalten und/oder wird von den folgenden Wiki-Farmen, bzw. Wiki-Hostern verwendet: Dies ist keine maßgebliche Liste. Softwarepakete und/oder Wiki-Farmen, bzw. Wiki-Hoster nutzen diese Erweiterung ggf., obwohl sie nicht in dieser Liste enthalten sind. Prüfe daher stets die Nutzung im verwendeten Softwarepaket und/oder bei der Wiki-Farm, bzw. dem Wiki-Hoster. |