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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
<?php
/**
* Class representing a MediaWiki site.
*
* 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
* @ingroup Site
* @license GNU GPL v2+
* @author John Erling Blad < jeblad@gmail.com >
* @author Daniel Kinzler
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
/**
* Class representing a MediaWiki site.
*
* @since 1.21
*
* @ingroup Site
*/
class MediaWikiSite extends Site {
const PATH_FILE = 'file_path';
const PATH_PAGE = 'page_path';
/**
* @since 1.21
* @deprecated since 1.21 Just use the constructor or the factory Site::newForType
*
* @param int $globalId
*
* @return MediaWikiSite
*/
public static function newFromGlobalId( $globalId ) {
$site = new static();
$site->setGlobalId( $globalId );
return $site;
}
/**
* Constructor.
*
* @since 1.21
*
* @param string $type
*/
public function __construct( $type = self::TYPE_MEDIAWIKI ) {
parent::__construct( $type );
}
/**
* Returns 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 );
}
/**
* Returns the normalized form of the given page title, using the
* normalization rules of the given site. If the given title is a redirect,
* the redirect weill be resolved and the redirect target is 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
*
* @param string $pageName
*
* @return string
* @throws MWException
*/
public function normalizePageName( $pageName ) {
// Check if we have strings as arguments.
if ( !is_string( $pageName ) ) {
throw new MWException( '$pageName must be a string' );
}
// Go on call the external site
if ( defined( 'MW_PHPUNIT_TEST' ) ) {
// 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 {
// Make sure the string is normalized into NFC (due to the bug 40017)
// but do nothing to the whitespaces, that should work appropriately.
// @see https://bugzilla.wikimedia.org/show_bug.cgi?id=40017
$pageName = UtfNormal::cleanUp( $pageName );
// Build the args for the specific call
$args = array(
'action' => 'query',
'prop' => 'info',
'redirects' => true,
'converttitles' => true,
'format' => 'json',
'titles' => $pageName,
// @todo options for maxlag and maxage
// Note that maxlag will lead to a long delay before a reply is made,
// but that maxage can avoid the extreme delay. On the other hand
// maxage could be nice to use anyhow as it stops unnecessary requests.
// Also consider smaxage if maxage is used.
);
$url = wfAppendQuery( $this->getFileUrl( 'api.php' ), $args );
// Go on call the external site
// @todo we need a good way to specify a timeout here.
$ret = Http::get( $url );
}
if ( $ret === false ) {
wfDebugLog( "MediaWikiSite", "call to external site failed: $url" );
return false;
}
$data = FormatJson::decode( $ret, true );
if ( !is_array( $data ) ) {
wfDebugLog( "MediaWikiSite", "call to <$url> returned bad json: " . $ret );
return false;
}
$page = static::extractPageRecord( $data, $pageName );
if ( isset( $page['missing'] ) ) {
wfDebugLog( "MediaWikiSite", "call to <$url> returned a marker for a missing page title! "
. $ret );
return false;
}
if ( isset( $page['invalid'] ) ) {
wfDebugLog( "MediaWikiSite", "call to <$url> returned a marker for an invalid page title! "
. $ret );
return false;
}
if ( !isset( $page['title'] ) ) {
wfDebugLog( "MediaWikiSite", "call to <$url> did not return a page title! " . $ret );
return false;
}
return $page['title'];
}
/**
* Get normalization record for a given page title from an API response.
*
* @since 1.21
*
* @param array $externalData A reply from the API on a external server.
* @param string $pageTitle Identifies the page at the external site, needing normalization.
*
* @return array|bool A 'page' structure representing the page identified by $pageTitle.
*/
private static function extractPageRecord( $externalData, $pageTitle ) {
// If there is a special case with only one returned page
// we can cheat, and only return
// the single page in the "pages" substructure.
if ( isset( $externalData['query']['pages'] ) ) {
$pages = array_values( $externalData['query']['pages'] );
if ( count( $pages ) === 1 ) {
return $pages[0];
}
}
// This is only used during internal testing, as it is assumed
// a more optimal (and lossfree) storage.
// Make initial checks and return if prerequisites are not meet.
if ( !is_array( $externalData ) || !isset( $externalData['query'] ) ) {
return false;
}
// Loop over the tree different named structures, that otherwise are similar
$structs = array(
'normalized' => 'from',
'converted' => 'from',
'redirects' => 'from',
'pages' => 'title'
);
foreach ( $structs as $listId => $fieldId ) {
// Check if the substructure exist at all.
if ( !isset( $externalData['query'][$listId] ) ) {
continue;
}
// Filter the substructure down to what we actually are using.
$collectedHits = array_filter(
array_values( $externalData['query'][$listId] ),
function ( $a ) use ( $fieldId, $pageTitle ) {
return $a[$fieldId] === $pageTitle;
}
);
// If still looping over normalization, conversion or redirects,
// then we need to keep the new page title for later rounds.
if ( $fieldId === 'from' && is_array( $collectedHits ) ) {
switch ( count( $collectedHits ) ) {
case 0:
break;
case 1:
$pageTitle = $collectedHits[0]['to'];
break;
default:
return false;
}
}
// If on the pages structure we should prepare for returning.
elseif ( $fieldId === 'title' && is_array( $collectedHits ) ) {
switch ( count( $collectedHits ) ) {
case 0:
return false;
case 1:
return array_shift( $collectedHits );
default:
return false;
}
}
}
// should never be here
return false;
}
/**
* @see Site::getLinkPathType
* Returns Site::PATH_PAGE
*
* @since 1.21
*
* @return string
*/
public function getLinkPathType() {
return self::PATH_PAGE;
}
/**
* Returns the relative page path.
*
* @since 1.21
*
* @return string
*/
public function getRelativePagePath() {
return parse_url( $this->getPath( self::PATH_PAGE ), PHP_URL_PATH );
}
/**
* Returns the relative file path.
*
* @since 1.21
*
* @return string
*/
public function getRelativeFilePath() {
return parse_url( $this->getPath( self::PATH_FILE ), PHP_URL_PATH );
}
/**
* Sets the relative page path.
*
* @since 1.21
*
* @param string $path
*/
public function setPagePath( $path ) {
$this->setPath( self::PATH_PAGE, $path );
}
/**
* Sets the relative file path.
*
* @since 1.21
*
* @param string $path
*/
public function setFilePath( $path ) {
$this->setPath( self::PATH_FILE, $path );
}
/**
* @see Site::getPageUrl
*
* 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.
*
* @since 1.21
*
* @param string|bool $pageName Page name or false (default: false)
*
* @return string
*/
public function getPageUrl( $pageName = false ) {
$url = $this->getLinkPath();
if ( $url === false ) {
return false;
}
if ( $pageName !== false ) {
$pageName = $this->toDBKey( trim( $pageName ) );
$url = str_replace( '$1', wfUrlencode( $pageName ), $url );
}
return $url;
}
/**
* Returns the full file path (ie site url + relative file path).
* 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|bool $path
*
* @return string
*/
public function getFileUrl( $path = false ) {
$filePath = $this->getPath( self::PATH_FILE );
if ( $filePath !== false ) {
$filePath = str_replace( '$1', $path, $filePath );
}
return $filePath;
}
}
|