3 * Implements Special:PageLanguage
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
22 * @author Kunal Grover
27 * Special page for changing the content language of a page
29 * @ingroup SpecialPage
31 class SpecialPageLanguage
extends FormSpecialPage
{
33 * @var string URL to go to if language change successful
37 public function __construct() {
38 parent
::__construct( 'PageLanguage', 'pagelang' );
41 public function doesWrites() {
45 protected function preText() {
46 $this->getOutput()->addModules( 'mediawiki.special.pageLanguage' );
49 protected function getFormFields() {
50 // Get default from the subpage of Special page
51 $defaultName = $this->par
;
56 'label-message' => 'pagelang-name',
57 'default' => $defaultName,
58 'autofocus' => $defaultName === null,
62 // Options for whether to use the default language or select language
64 (string)$this->msg( 'pagelang-use-default' )->escaped() => 1,
65 (string)$this->msg( 'pagelang-select-lang' )->escaped() => 2,
67 $page['selectoptions'] = [
68 'id' => 'mw-pl-options',
70 'options' => $selectoptions,
74 // Building a language selector
75 $userLang = $this->getLanguage()->getCode();
76 $languages = Language
::fetchLanguageNames( $userLang, 'mwfile' );
79 foreach ( $languages as $code => $name ) {
80 $options["$code - $name"] = $code;
84 'id' => 'mw-pl-languageselector',
85 'cssclass' => 'mw-languageselector',
87 'options' => $options,
88 'label-message' => 'pagelang-language',
89 'default' => $this->getConfig()->get( 'LanguageCode' ),
95 protected function postText() {
97 return $this->showLogFragment( $this->par
);
102 protected function getDisplayFormat() {
106 public function alterForm( HTMLForm
$form ) {
107 Hooks
::run( 'LanguageSelector', [ $this->getOutput(), 'mw-languageselector' ] );
108 $form->setSubmitTextMsg( 'pagelang-submit' );
116 public function onSubmit( array $data ) {
117 $pageName = $data['pagename'];
119 // Check if user wants to use default language
120 if ( $data['selectoptions'] == 1 ) {
121 $newLanguage = 'default';
123 $newLanguage = $data['language'];
127 $title = Title
::newFromTextThrow( $pageName );
128 } catch ( MalformedTitleException
$ex ) {
129 return Status
::newFatal( $ex->getMessageObject() );
132 // Url to redirect to after the operation
133 $this->goToUrl
= $title->getFullURL();
135 return self
::changePageLanguage( $this->getContext(), $title, $newLanguage );
139 * @param IContextSource $context
140 * @param Title $title
141 * @param string $newLanguage Language code
142 * @param array $tags Change tags to apply to the log entry
145 public static function changePageLanguage( IContextSource
$context, Title
$title,
146 $newLanguage, array $tags = [] ) {
147 // Get the default language for the wiki
148 $defLang = $context->getConfig()->get( 'LanguageCode' );
150 $pageId = $title->getArticleID();
152 // Check if article exists
154 return Status
::newFatal(
155 'pagelang-nonexistent-page',
156 wfEscapeWikiText( $title->getPrefixedText() )
160 // Load the page language from DB
161 $dbw = wfGetDB( DB_MASTER
);
162 $oldLanguage = $dbw->selectField(
165 [ 'page_id' => $pageId ],
169 // Check if user wants to use the default language
170 if ( $newLanguage === 'default' ) {
174 // No change in language
175 if ( $newLanguage === $oldLanguage ) {
176 // Check if old language does not exist
177 if ( !$oldLanguage ) {
178 return Status
::newFatal( ApiMessage
::create(
180 'pagelang-unchanged-language-default',
181 wfEscapeWikiText( $title->getPrefixedText() )
183 'pagelang-unchanged-language'
186 return Status
::newFatal(
187 'pagelang-unchanged-language',
188 wfEscapeWikiText( $title->getPrefixedText() ),
193 // Hardcoded [def] if the language is set to null
194 $logOld = $oldLanguage ?
$oldLanguage : $defLang . '[def]';
195 $logNew = $newLanguage ?
$newLanguage : $defLang . '[def]';
197 // Writing new page language to database
200 [ 'page_lang' => $newLanguage ],
202 'page_id' => $pageId,
203 'page_lang' => $oldLanguage
208 if ( !$dbw->affectedRows() ) {
209 return Status
::newFatal( 'pagelang-db-failed' );
212 // Logging change of language
214 '4::oldlanguage' => $logOld,
215 '5::newlanguage' => $logNew
217 $entry = new ManualLogEntry( 'pagelang', 'pagelang' );
218 $entry->setPerformer( $context->getUser() );
219 $entry->setTarget( $title );
220 $entry->setParameters( $logParams );
221 $entry->setTags( $tags );
223 $logid = $entry->insert();
224 $entry->publish( $logid );
226 // Force re-render so that language-based content (parser functions etc.) gets updated
227 $title->invalidateCache();
229 return Status
::newGood( (object)[
230 'oldLanguage' => $logOld,
231 'newLanguage' => $logNew,
236 public function onSuccess() {
237 // Success causes a redirect
238 $this->getOutput()->redirect( $this->goToUrl
);
241 function showLogFragment( $title ) {
242 $moveLogPage = new LogPage( 'pagelang' );
243 $out1 = Xml
::element( 'h2', null, $moveLogPage->getName()->text() );
245 LogEventsList
::showLogExtract( $out2, 'pagelang', $title );
246 return $out1 . $out2;
250 * Return an array of subpages beginning with $search that this special page will accept.
252 * @param string $search Prefix to search for
253 * @param int $limit Maximum number of results to return (usually 10)
254 * @param int $offset Number of results to skip (usually 0)
255 * @return string[] Matching subpages
257 public function prefixSearchSubpages( $search, $limit, $offset ) {
258 return $this->prefixSearchString( $search, $limit, $offset );
261 protected function getGroupName() {