X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/specials/forms/PreferencesForm.php

diff --git a/includes/specials/forms/PreferencesForm.php b/includes/specials/forms/PreferencesForm.php
new file mode 100644
index 00000000..d4e5ef4f
--- /dev/null
+++ b/includes/specials/forms/PreferencesForm.php
@@ -0,0 +1,143 @@
+<?php
+/**
+ * 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
+ */
+
+use MediaWiki\MediaWikiServices;
+
+/**
+ * Form to edit user preferences.
+ */
+class PreferencesForm extends HTMLForm {
+	// Override default value from HTMLForm
+	protected $mSubSectionBeforeFields = false;
+
+	private $modifiedUser;
+
+	/**
+	 * @param User $user
+	 */
+	public function setModifiedUser( $user ) {
+		$this->modifiedUser = $user;
+	}
+
+	/**
+	 * @return User
+	 */
+	public function getModifiedUser() {
+		if ( $this->modifiedUser === null ) {
+			return $this->getUser();
+		} else {
+			return $this->modifiedUser;
+		}
+	}
+
+	/**
+	 * Get extra parameters for the query string when redirecting after
+	 * successful save.
+	 *
+	 * @return array
+	 */
+	public function getExtraSuccessRedirectParameters() {
+		return [];
+	}
+
+	/**
+	 * @param string $html
+	 * @return string
+	 */
+	function wrapForm( $html ) {
+		$html = Xml::tags( 'div', [ 'id' => 'preferences' ], $html );
+
+		return parent::wrapForm( $html );
+	}
+
+	/**
+	 * @return string
+	 */
+	function getButtons() {
+		$attrs = [ 'id' => 'mw-prefs-restoreprefs' ];
+
+		if ( !$this->getModifiedUser()->isAllowedAny( 'editmyprivateinfo', 'editmyoptions' ) ) {
+			return '';
+		}
+
+		$html = parent::getButtons();
+
+		if ( $this->getModifiedUser()->isAllowed( 'editmyoptions' ) ) {
+			$t = $this->getTitle()->getSubpage( 'reset' );
+
+			$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
+			$html .= "\n" . $linkRenderer->makeLink( $t, $this->msg( 'restoreprefs' )->text(),
+				Html::buttonAttributes( $attrs, [ 'mw-ui-quiet' ] ) );
+
+			$html = Xml::tags( 'div', [ 'class' => 'mw-prefs-buttons' ], $html );
+		}
+
+		return $html;
+	}
+
+	/**
+	 * Separate multi-option preferences into multiple preferences, since we
+	 * have to store them separately
+	 * @param array $data
+	 * @return array
+	 */
+	function filterDataForSubmit( $data ) {
+		foreach ( $this->mFlatFields as $fieldname => $field ) {
+			if ( $field instanceof HTMLNestedFilterable ) {
+				$info = $field->mParams;
+				$prefix = isset( $info['prefix'] ) ? $info['prefix'] : $fieldname;
+				foreach ( $field->filterDataForSubmit( $data[$fieldname] ) as $key => $value ) {
+					$data["$prefix$key"] = $value;
+				}
+				unset( $data[$fieldname] );
+			}
+		}
+
+		return $data;
+	}
+
+	/**
+	 * Get the whole body of the form.
+	 * @return string
+	 */
+	function getBody() {
+		return $this->displaySection( $this->mFieldTree, '', 'mw-prefsection-' );
+	}
+
+	/**
+	 * Get the "<legend>" for a given section key. Normally this is the
+	 * prefs-$key message but we'll allow extensions to override it.
+	 * @param string $key
+	 * @return string
+	 */
+	function getLegend( $key ) {
+		$legend = parent::getLegend( $key );
+		Hooks::run( 'PreferencesGetLegend', [ $this, $key, &$legend ] );
+		return $legend;
+	}
+
+	/**
+	 * Get the keys of each top level preference section.
+	 * @return array of section keys
+	 */
+	function getPreferenceSections() {
+		return array_keys( array_filter( $this->mFieldTree, 'is_array' ) );
+	}
+}