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
|
<?php
/**
* Tools for dealing with other locally-hosted wikis.
*
* 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
*/
/**
* Helper tools for dealing with other locally-hosted wikis
*/
class WikiMap {
/**
* Get a WikiReference object for $wikiID
*
* @param $wikiID String: wiki'd id (generally database name)
* @return WikiReference object or null if the wiki was not found
*/
public static function getWiki( $wikiID ) {
global $wgConf;
$wgConf->loadFullData();
list( $major, $minor ) = $wgConf->siteFromDB( $wikiID );
if( $major === null ) {
return null;
}
$canonicalServer = $wgConf->get( 'wgCanonicalServer', $wikiID, $major,
array( 'lang' => $minor, 'site' => $major ) );
$server = $wgConf->get( 'wgServer', $wikiID, $major,
array( 'lang' => $minor, 'site' => $major ) );
$path = $wgConf->get( 'wgArticlePath', $wikiID, $major,
array( 'lang' => $minor, 'site' => $major ) );
return new WikiReference( $major, $minor, $canonicalServer, $path, $server );
}
/**
* Convenience to get the wiki's display name
*
* @todo We can give more info than just the wiki id!
* @param $wikiID String: wiki'd id (generally database name)
* @return string|int Wiki's name or $wiki_id if the wiki was not found
*/
public static function getWikiName( $wikiID ) {
$wiki = WikiMap::getWiki( $wikiID );
if ( $wiki ) {
return $wiki->getDisplayName();
}
return $wikiID;
}
/**
* Convenience to get a link to a user page on a foreign wiki
*
* @param $wikiID String: wiki'd id (generally database name)
* @param $user String: user name (must be normalised before calling this function!)
* @param $text String: link's text; optional, default to "User:$user"
* @return String: HTML link or false if the wiki was not found
*/
public static function foreignUserLink( $wikiID, $user, $text=null ) {
return self::makeForeignLink( $wikiID, "User:$user", $text );
}
/**
* Convenience to get a link to a page on a foreign wiki
*
* @param $wikiID String: wiki'd id (generally database name)
* @param $page String: page name (must be normalised before calling this function!)
* @param $text String: link's text; optional, default to $page
* @return String: HTML link or false if the wiki was not found
*/
public static function makeForeignLink( $wikiID, $page, $text=null ) {
if ( !$text ) {
$text = $page;
}
$url = self::getForeignURL( $wikiID, $page );
if ( $url === false ) {
return false;
}
return Linker::makeExternalLink( $url, $text );
}
/**
* Convenience to get a url to a page on a foreign wiki
*
* @param $wikiID String: wiki'd id (generally database name)
* @param $page String: page name (must be normalised before calling this function!)
* @return String: URL or false if the wiki was not found
*/
public static function getForeignURL( $wikiID, $page ) {
$wiki = WikiMap::getWiki( $wikiID );
if ( $wiki ) {
return $wiki->getFullUrl( $page );
}
return false;
}
}
/**
* Reference to a locally-hosted wiki
*/
class WikiReference {
private $mMinor; ///< 'en', 'meta', 'mediawiki', etc
private $mMajor; ///< 'wiki', 'wiktionary', etc
private $mCanonicalServer; ///< canonical server URL, e.g. 'http://www.mediawiki.org'
private $mServer; ///< server URL, may be protocol-relative, e.g. '//www.mediawiki.org'
private $mPath; ///< path, '/wiki/$1'
/**
* @param $major string
* @param $minor string
* @param $canonicalServer string
* @param $path string
* @param $server null|string
*/
public function __construct( $major, $minor, $canonicalServer, $path, $server = null ) {
$this->mMajor = $major;
$this->mMinor = $minor;
$this->mCanonicalServer = $canonicalServer;
$this->mPath = $path;
$this->mServer = $server === null ? $canonicalServer : $server;
}
/**
* @return string
* @throws MWException
*/
public function getHostname() {
$prefixes = array( 'http://', 'https://' );
foreach ( $prefixes as $prefix ) {
if ( substr( $this->mCanonicalServer, 0, strlen( $prefix ) ) ) {
return substr( $this->mCanonicalServer, strlen( $prefix ) );
}
}
throw new MWException( "Invalid hostname for wiki {$this->mMinor}.{$this->mMajor}" );
}
/**
* Get the the URL in a way to de displayed to the user
* More or less Wikimedia specific
*
* @return String
*/
public function getDisplayName() {
$url = $this->getUrl( '' );
$parsed = wfParseUrl( $url );
if ( $parsed ) {
return $parsed['host'];
} else {
// Invalid URL. There's no sane thing to do here, so just return it
return $url;
}
}
/**
* Helper function for getUrl()
*
* @todo FIXME: This may be generalized...
* @param $page String: page name (must be normalised before calling this function!)
* @return String: Url fragment
*/
private function getLocalUrl( $page ) {
return str_replace( '$1', wfUrlEncode( str_replace( ' ', '_', $page ) ), $this->mPath );
}
/**
* Get a canonical (i.e. based on $wgCanonicalServer) URL to a page on this foreign wiki
*
* @param $page String: page name (must be normalised before calling this function!)
* @return String: Url
*/
public function getCanonicalUrl( $page ) {
return $this->mCanonicalServer . $this->getLocalUrl( $page );
}
/**
* Get a canonical server URL
* @return string
*/
public function getCanonicalServer() {
return $this->mCanonicalServer;
}
/**
* Alias for getCanonicalUrl(), for backwards compatibility.
* @param $page string
* @return String
*/
public function getUrl( $page ) {
return $this->getCanonicalUrl( $page );
}
/**
* Get a URL based on $wgServer, like Title::getFullUrl() would produce
* when called locally on the wiki.
*
* @param $page String: page name (must be normalized before calling this function!)
* @return String: URL
*/
public function getFullUrl( $page ) {
return
$this->mServer .
$this->getLocalUrl( $page );
}
}
|
