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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
<?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\Site\MediaWikiPageNameNormalizer;
/**
* Class representing a MediaWiki site.
*
* @since 1.21
* @ingroup Site
* @author John Erling Blad < jeblad@gmail.com >
* @author Daniel Kinzler
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
class MediaWikiSite extends Site {
/** The script path of a site, e.g. `/w/$1` related to $wgScriptPath */
public const PATH_FILE = 'file_path';
/** The article path of a site, e.g. `/wiki/$1` like $wgArticlePath */
public const PATH_PAGE = 'page_path';
/**
* @since 1.21
* @param string $type
*/
public function __construct( $type = self::TYPE_MEDIAWIKI ) {
parent::__construct( $type );
}
/**
* Get the database form of the given title.
*
* @since 1.21
* @param string $title The target page's title, in normalized form.
* @return string
*/
public function toDBKey( $title ) {
return str_replace( ' ', '_', $title );
}
/**
* Get the normalized form of the given page title.
*
* This uses to normalization rules of the given site. If $followRedirect is set to true
* and the given title is a redirect, the redirect will be resolved and
* the redirect target is returned.
* Only titles of existing pages will be returned.
*
* @note This actually makes an API request to the remote site, so beware
* that this function is slow and depends on an external service.
*
* @note If MW_PHPUNIT_TEST is defined, the call to the external site is
* skipped, and the title is normalized using the local normalization
* rules as implemented by the Title class.
*
* @see Site::normalizePageName
* @since 1.21
* @since 1.37 Added $followRedirect
* @param string $pageName
* @param int $followRedirect either MediaWikiPageNameNormalizer::FOLLOW_REDIRECT or
* MediaWikiPageNameNormalizer::NOFOLLOW_REDIRECT
* @return string|false The normalized form of the title,
* or false to indicate an invalid title, a missing page,
* or some other kind of error.
*/
public function normalizePageName( $pageName, $followRedirect = MediaWikiPageNameNormalizer::FOLLOW_REDIRECT ) {
if ( defined( 'MW_PHPUNIT_TEST' ) || defined( 'MW_DEV_ENV' ) ) {
// If the code is under test, don't call out to other sites, just
// normalize locally.
// Note: this may cause results to be inconsistent with the actual
// normalization used by the respective remote site!
$t = Title::newFromText( $pageName );
return $t->getPrefixedText();
} else {
static $mediaWikiPageNameNormalizer = null;
if ( $mediaWikiPageNameNormalizer === null ) {
$mediaWikiPageNameNormalizer = new MediaWikiPageNameNormalizer();
}
return $mediaWikiPageNameNormalizer->normalizePageName(
$pageName,
$this->getFileUrl( 'api.php' ),
$followRedirect
);
}
}
/**
* Get the constant for getting or setting the script path.
*
* This configures how Site::setLinkPath() and Site::getLinkPath()
* will work internally in terms of Site::setPath() and Site::getPath().
*
* @see Site::getLinkPathType
* @since 1.21
* @return string
*/
public function getLinkPathType() {
return self::PATH_PAGE;
}
/**
* Get the article path, as relative path only (without server).
*
* @since 1.21
* @return string
*/
public function getRelativePagePath() {
return parse_url( $this->getPath( self::PATH_PAGE ), PHP_URL_PATH );
}
/**
* Get the script script, as relative path only (without server).
*
* @since 1.21
* @return string
*/
public function getRelativeFilePath() {
return parse_url( $this->getPath( self::PATH_FILE ), PHP_URL_PATH );
}
/**
* Set the article path.
*
* @since 1.21
* @param string $path
*/
public function setPagePath( $path ) {
$this->setPath( self::PATH_PAGE, $path );
}
/**
* Set the script path.
*
* @since 1.21
* @param string $path
*/
public function setFilePath( $path ) {
$this->setPath( self::PATH_FILE, $path );
}
/**
* Get the full URL for the given page on the site.
*
* This implementation returns a URL constructed using the path returned by getLinkPath().
* In addition to the default behavior implemented by Site::getPageUrl(), this
* method converts the $pageName to DBKey-format by replacing spaces with underscores
* before using it in the URL.
*
* @see Site::getPageUrl
* @since 1.21
* @param string|false $pageName Page name or false (default: false)
* @return string|null
*/
public function getPageUrl( $pageName = false ) {
$url = $this->getLinkPath();
if ( $url === null ) {
return null;
}
if ( $pageName !== false ) {
$pageName = $this->toDBKey( trim( $pageName ) );
$url = str_replace( '$1', wfUrlencode( $pageName ), $url );
}
return $url;
}
/**
* Get the full URL to an entry point under a wiki's script path.
*
* This is the equivalent of wfScript() for other sites.
*
* The path should go at the `$1` marker. If the $path
* argument is provided, the marker will be replaced by it's value.
*
* @since 1.21
* @param string|false $path Not passing a string for this is deprecated since 1.40.
* @return string
*/
public function getFileUrl( $path = false ) {
$filePath = $this->getPath( self::PATH_FILE );
if ( $filePath === null ) {
throw new RuntimeException( "getFileUrl called for {$this->getGlobalId()} while PATH_FILE is unset" );
}
if ( $path !== false ) {
$filePath = str_replace( '$1', $path, $filePath );
} else {
wfDeprecatedMsg( __METHOD__ . ': omitting $path is deprecated', '1.40' );
}
return $filePath;
}
}
|
