Merging latest changes from ContactPage

.eslintrc.json

@@ -1,8 +1,6 @@
 {
 	"root": true,
 	"extends": [
-		"wikimedia/client",
-		"wikimedia/jquery",
-		"wikimedia/mediawiki"
+		"wikimedia/server"
 	]
 }

.phpcs.xml

@@ -1,8 +1,6 @@
 <?xml version="1.0"?>
 <ruleset>
-	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
-		<exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
-	</rule>
+	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki" />
 	<file>.</file>
 	<arg name="extensions" value="php" />
 	<arg name="encoding" value="UTF-8" />

ContactPage.alias.php

@@ -328,6 +328,11 @@
 	'Contact' => [ 'Контакт' ],
 ];
 
+/** Serbian (Latin script) (srpski (latinica)‎) */
+$specialPageAliases['sr-el'] = [
+	'Contact' => [ 'Kontakt' ],
+];
+
 /** Swedish (svenska) */
 $specialPageAliases['sv'] = [
 	'Contact' => [ 'Kontakt' ],
@@ -395,15 +400,15 @@
 
 /** Chinese (中文) */
 $specialPageAliases['zh'] = [
-	'Contact' => [ '联系', '联络', '聯繫', '聯係', '聯絡' ],
+	'Contact' => [ 'Contact' ],
 ];
 
-/** Simplified Chinese (中文（简体）‎) */
+/** Simplified Chinese (中文（简体）) */
 $specialPageAliases['zh-hans'] = [
-	'Contact' => [ '联系' ],
+	'Contact' => [ '联系', '联络' ],
 ];
 
-/** Traditional Chinese (中文（繁體）‎) */
+/** Traditional Chinese (中文（繁體）) */
 $specialPageAliases['zh-hant'] = [
-	'Contact' => [ '聯絡' ],
+	'Contact' => [ '聯絡', '聯繫', '聯係' ],
 ];

Gruntfile.js

@@ -3,22 +3,21 @@
  *
  * @package ContactPage
  */
+'use strict';
 
-/* eslint-env node */
 module.exports = function ( grunt ) {
-	var conf = grunt.file.readJSON( 'extension.json' );
+	const conf = grunt.file.readJSON( 'extension.json' );
 	grunt.loadNpmTasks( 'grunt-banana-checker' );
 	grunt.loadNpmTasks( 'grunt-eslint' );
 
 	grunt.initConfig( {
 		banana: conf.MessagesDirs,
 		eslint: {
 			options: {
-				extensions: [ '.js', '.json' ],
 				cache: true
 			},
 			all: [
-				'**/*.js{,on}',
+				'**/*.{js,json}',
 				'!node_modules/**',
 				'!vendor/**'
 			]

README

@@ -5,7 +5,7 @@ Licenses: GNU General Public Licence (GPL)
           GNU Free Documentation License (GFDL)
 --------------------------------------------------------------------------
 
-The ContactPage extension implements a contact form for visitors. It 
+The ContactPage extension implements a contact form for visitors. It
 creates a special page Special:Contact, which is similar to
 Special:Emailuser, but it has a fixed recipient, and can be used
 anonymously.
@@ -21,7 +21,7 @@ they are mentioned in each file individually.
 
 == Installing ==
 
-Copy the ContactPage directory into the extensions folder of your 
+Copy the ContactPage directory into the extensions folder of your
 MediaWiki installation. Then add the following lines to your
 LocalSettings.php file (near the end):
 
@@ -38,29 +38,56 @@ $wgContactConfig.
        'SenderName' => 'User Email',
        'RequireDetails' => true,
        'IncludeIP' => true,
+       'MustBeLoggedIn' => true,
+       'NameReadonly' => true,
+       'EmailReadonly' => true,
+       'SubjectReadonly' => true,
+       'MustHaveEmail' => true,
        'AdditionalFields' => [],
+       'FieldsMergeStrategy' => null,
        'RLModules' => [],
        'RLStyleModules' => [],
   ];
 
 All contact form keys (in this case 'formname') should be in
 lowercase.
 
-RecipentUser must be the username of a registered wiki user, who has
+The following situations will cause the contact form to be inaccessible:
+* Setting EmailReadonly to true if MustBeLoggedIn is false and RequireDetails
+  is false.
+* Setting MustHaveEmail to true if MustBeLoggedIn is false.
+* RecipentUser and RecipientEmail being undefined.
+
+One of RecipientUser or RecipientEmail should be defined. If using RecipientUser,
+it must be the username of a registered wiki user, who has
 supplied an email address, has user-to-user email enabled, and has
-confirmed his/her email address if that is required on this wiki
-(see $wgEmailAuthentication).
+confirmed their email address if that is required on this wiki
+(see $wgEmailAuthentication). If using RecipientEmail, it should be a valid email address.
 
 SenderEmail is used when to send the email when an address isn't
 entered on the contact form. It defaults to $wgPasswordSender.
 
 SenderName is the display name used with SenderEmail.
 
-RequireDetails Whether users will be required to supply a name and an
-email address on Special:Contact.
+RequireDetails is whether the users will be required to supply a name
+and an email address on Special:Contact.
+
+IncludeIP is used to decide whether the form will include a checkbox
+offering to put the IP address of the submitter in the subject line.
+
+MustBeLoggedIn is whether the contact form is only accessible when
+users are logged in.
+
+NameReadonly is used to make the name field readonly.
+
+EmailReadonly is used to make the email field readonly.
+
+SubjectReadonly is used to make the subject field readonly.
 
-IncludeIP Whether the form will include a checkbox offering to put the IP
-address of the submitter in the subject line.
+MustHaveEmail is used to require that the user loading the form has
+a confirmed email address attached to their account. If the user does
+not have a confirmed email address, an error will be displayed and the
+form will not be shown.
 
 AdditionalFields is used to add any additional fields to the contact form.
 These are done using https://www.mediawiki.org/wiki/HTMLForm notation.
@@ -79,6 +106,90 @@ It should be noted that type 'selectandother' is not currently supported.
       ],
   ],
 
+FieldsMergeStrategy defines how fields defined in `AdditionalFields` are
+merged with extension-defined fields. It currently accepts only two values
+with the following semantic:
+
+  1. null (default). In default mode, some fields such as FromName,
+     and FromAddress are unconditionally defined by the extension and
+     placed in a fixed location. Configured forms cannot remove them nor
+     influence their placement locations.
+  2. The string 'replace'. With this option, the configured form can
+     redefine some fields already defined by the extension for the
+     purpose of controlling their placement position in the form or
+     hiding them completely. Example:
+
+    Let's say we want to have a very important field as the first field
+    of the form.
+
+    'AdditionalFields' => [
+       'ImportantField' => [
+            'label' => 'This field must be the first field of the form!',
+            'type' => 'textarea',
+        ],
+    ],
+
+    In default mode, this field will appear as the fourth field of the form
+    (instead of the location we wanted), because the extensions defines 3
+    other fields unconditionally and placed ours below them.
+
+    With `FieldsMergeStrategy` option, it's possibly to make our
+    'very important' field as the first field in the form.
+
+    'AdditionalFields' => [
+      'ImportantField' => [
+            'label' => 'This field must be the first field of the form!',
+            'type' => 'textarea',
+      ],
+      'FromName' => [
+          'label-message' => 'contactpage-fromname',
+          'type' => 'text',
+          'required' => true,
+          'default' => null,
+          'disabled' => false,
+      ],
+    ],
+
+    All the these fields will now appear in the order we defined them.
+    Any non-redefined field will retain their extension-defined order.
+
+    Setting any of these fields to null will remove them completely.
+
+    Note 1: Field attributes defined in 'AdditionalFields' take precedence
+    over the following 4 global attributes in form configuration:
+
+    $wgContactConfig['formname'] = [
+       'RequireDetails' => true, // This sets `FromName` and `FromAddress`
+                                // as required fields.
+       'NameReadonly' => true, // This sets `FromName` as readonly.
+       'EmailReadonly' => true, // This sets `FromAddress` as readonly.
+       'SubjectReadonly' => true, // This sets `Subject` as readonly.
+    ];
+
+    If FieldsMergeStrategy is 'replace', these will not automatically apply
+    for any field that's redefined. But you can set any of them explicitly
+    on the field.
+
+    Example:
+
+    'FieldsMergeStrategy' => 'replace',
+    'AdditionalFields' => [
+      'ImportantField' => [
+            'label' => 'This field must be the first field of the form!',
+            'type' => 'textarea',
+        ],
+      'FromName' => [ // FromName is redefined.
+          'label-message' => 'contactpage-fromname',
+          'type' => 'text',
+          'required' => true, // This takes precedence over 'RequireDetails'
+          'default' => null, // null means extension should populate it
+          'disabled' => false // This takes precedence over 'NameReadOnly'
+      ],
+    ],
+
+    Note 2: Some special control fields (where applicable) such as the Captcha
+    form, Email copy and IPAddress checkboxes cannot be redefined or moved.
+
 RLModules can be used to add ResourceLoader modules (custom CSS and
 JavaScript) to the page.
 
@@ -88,7 +199,7 @@ RLStyleModules can be used to add ResourceLoader CSS modules to the page.
 
 [[Special:Contact]] calls the 'default' form.
 Pagetext: [[MediaWiki:contactpage-pagetext]]
-Subject: prefilled with text from [[MediaWiki:Contactpage-defsubject]] 
+Subject: prefilled with text from [[MediaWiki:Contactpage-defsubject]]
 E-mail body: empty.
 
 [[Special:Contact/typename]] calls the contact page with a customized pagetext and

composer.json

@@ -1,10 +1,10 @@
 {
 	"require-dev": {
-		"mediawiki/mediawiki-codesniffer": "34.0.0",
-		"mediawiki/mediawiki-phan-config": "0.10.6",
-		"mediawiki/minus-x": "1.1.0",
-		"php-parallel-lint/php-console-highlighter": "0.5.0",
-		"php-parallel-lint/php-parallel-lint": "1.2.0"
+		"mediawiki/mediawiki-codesniffer": "48.0.0",
+		"mediawiki/mediawiki-phan-config": "0.17.0",
+		"mediawiki/minus-x": "1.1.3",
+		"php-parallel-lint/php-console-highlighter": "1.0.0",
+		"php-parallel-lint/php-parallel-lint": "1.4.0"
 	},
 	"scripts": {
 		"fix": [
@@ -13,8 +13,15 @@
 		],
 		"test": [
 			"parallel-lint . --exclude vendor --exclude node_modules",
-			"phpcs -p -s",
+			"@phpcs",
 			"minus-x check ."
-		]
+		],
+		"phan": "phan -d . --long-progress-bar",
+		"phpcs": "phpcs -sp --cache"
+	},
+	"config": {
+		"allow-plugins": {
+			"dealerdirect/phpcodesniffer-composer-installer": true
+		}
 	}
 }

extension.json

@@ -9,6 +9,9 @@
 	"descriptionmsg": "contactpage-desc",
 	"license-name": "GPL-2.0-or-later",
 	"type": "specialpage",
+	"requires": {
+		"MediaWiki": ">= 1.46"
+	},
 	"ExtensionMessagesFiles": {
 		"ContactPageAliases": "ContactPage.alias.php"
 	},
@@ -22,11 +25,19 @@
 			"value": {
 				"default": {
 					"RecipientUser": null,
+					"RecipientEmail": null,
+					"RecipientName": null,
 					"SenderEmail": null,
 					"SenderName": null,
 					"RequireDetails": false,
 					"IncludeIP": false,
 					"MustBeLoggedIn": false,
+					"MustHaveEmail": false,
+					"NameReadonly": false,
+					"EmailReadonly": false,
+					"SubjectReadonly": false,
+					"UseCustomBlockMessage": false,
+					"Redirect": null,
 					"RLModules": [],
 					"RLStyleModules": [],
 					"AdditionalFields": {
@@ -35,19 +46,24 @@
 							"type": "textarea",
 							"required": true
 						}
-					}
+					},
+					"FieldsMergeStrategy": null
 				}
-			}
+			},
+			"merge_strategy": "array_plus_2d"
 		}
 	},
 	"SpecialPages": {
-		"Contact": "SpecialContact"
+		"Contact": {
+			"class": "MediaWiki\\Extension\\ContactPage\\SpecialContact",
+			"services": [
+				"UserOptionsLookup",
+				"UserFactory"
+			]
+		}
 	},
-	"AutoloadClasses": {
-		"SpecialContact": "includes/SpecialContact.php"
+	"AutoloadNamespaces": {
+		"MediaWiki\\Extension\\ContactPage\\": "includes/"
 	},
-	"manifest_version": 2,
-	"requires": {
-		"MediaWiki": ">= 1.34.0"
-	}
+	"manifest_version": 2
 }

i18n/aae.json

@@ -0,0 +1,8 @@
+{
+	"@metadata": {
+		"authors": [
+			"Martindimaggio"
+		]
+	},
+	"contactpage": "Kontate"
+}

i18n/ab.json

@@ -0,0 +1,8 @@
+{
+	"@metadata": {
+		"authors": [
+			"Fraxinus.cs"
+		]
+	},
+	"contactpage": "Еимадоу адаҟьа"
+}

i18n/abr.json

@@ -0,0 +1,8 @@
+{
+	"@metadata": {
+		"authors": [
+			"Alicia Agyeiwaa"
+		]
+	},
+	"contactpage": "Simpie a bɛbɛtumi ne bi adi nkitaho"
+}

i18n/acf.json

@@ -0,0 +1,8 @@
+{
+	"@metadata": {
+		"authors": [
+			"Suitcaseshoes"
+		]
+	},
+	"contactpage": "Paj kontakt"
+}