aboutsummaryrefslogtreecommitdiffstats
path: root/includes/editpage/Constraint/DoubleRedirectConstraint.php
blob: fd5ee1ab04cc540f834d1c82f2990b4d6a4be83e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<?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
 */

namespace MediaWiki\EditPage\Constraint;

use MediaWiki\Content\Content;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\Page\RedirectLookup;
use MediaWiki\Title\Title;
use StatusValue;

/**
 * Verify the page does not redirect to another redirect unless
 *  - the user is okay with a double redirect, or
 *  - the page already redirected to another redirect before the edit
 *
 * @since 1.44
 * @internal
 */
class DoubleRedirectConstraint implements IEditConstraint {

	private bool $allowDoubleRedirects;
	private Content $newContent;
	private Content $originalContent;
	private LinkTarget $title;
	private string $result;
	private RedirectLookup $redirectLookup;

	/**
	 * @param bool $allowDoubleRedirects
	 * @param Content $newContent
	 * @param Content $originalContent
	 * @param LinkTarget $title
	 */
	public function __construct(
		bool $allowDoubleRedirects,
		Content $newContent,
		Content $originalContent,
		LinkTarget $title,
		RedirectLookup $redirectLookup
	) {
		$this->allowDoubleRedirects = $allowDoubleRedirects;
		$this->newContent = $newContent;
		$this->originalContent = $originalContent;
		$this->title = $title;
		$this->redirectLookup = $redirectLookup;
	}

	public function checkConstraint(): string {
		if ( !$this->allowDoubleRedirects ) {
			$newRedirectTarget = $this->newContent->getRedirectTarget();

			if ( $newRedirectTarget !== null && $newRedirectTarget->isRedirect() &&
				!$newRedirectTarget->equals( $this->title ) ) {

				$currentTarget = $this->originalContent->getRedirectTarget();

				// fail if there was no previous content or the previous content already contained a double redirect
				if ( !$currentTarget || !$currentTarget->isRedirect() ) {
					$this->result = self::CONSTRAINT_FAILED;

					return self::CONSTRAINT_FAILED;
				}
			}
		}
		$this->result = self::CONSTRAINT_PASSED;

		return self::CONSTRAINT_PASSED;
	}

	public function getLegacyStatus(): StatusValue {
		$statusValue = StatusValue::newGood();
		if ( $this->result === self::CONSTRAINT_FAILED ) {
			$realRedirectTarget = $this->redirectLookup->getRedirectTarget( $this->newContent->getRedirectTarget() );
			$realTargetTitle = Title::castFromLinkTarget( $realRedirectTarget );

			$statusValue->fatal(
				'edit-constraint-doubleredirect',
				wfEscapeWikiText( $realTargetTitle->getPrefixedText() )
			);
			$statusValue->value = self::AS_DOUBLE_REDIRECT;
		}

		return $statusValue;
	}

}