AuthManager: Break AuthPlugin::addUser more explicitly
[mediawiki.git] / includes / site / MediaWikiSite.php
blob6734d5f70c997ea78b7c8a24f148516b227156fe
1 <?php
3 use MediaWiki\Site\MediaWikiPageNameNormalizer;
5 /**
6 * Class representing a MediaWiki site.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
23 * @file
24 * @ingroup Site
25 * @license GNU GPL v2+
26 * @author John Erling Blad < jeblad@gmail.com >
27 * @author Daniel Kinzler
28 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
31 /**
32 * Class representing a MediaWiki site.
34 * @since 1.21
36 * @ingroup Site
38 class MediaWikiSite extends Site {
39 const PATH_FILE = 'file_path';
40 const PATH_PAGE = 'page_path';
42 /**
43 * Constructor.
45 * @since 1.21
47 * @param string $type
49 public function __construct( $type = self::TYPE_MEDIAWIKI ) {
50 parent::__construct( $type );
53 /**
54 * Returns the database form of the given title.
56 * @since 1.21
58 * @param string $title The target page's title, in normalized form.
60 * @return string
62 public function toDBKey( $title ) {
63 return str_replace( ' ', '_', $title );
66 /**
67 * Returns the normalized form of the given page title, using the
68 * normalization rules of the given site. If the given title is a redirect,
69 * the redirect weill be resolved and the redirect target is returned.
71 * @note This actually makes an API request to the remote site, so beware
72 * that this function is slow and depends on an external service.
74 * @note If MW_PHPUNIT_TEST is defined, the call to the external site is
75 * skipped, and the title is normalized using the local normalization
76 * rules as implemented by the Title class.
78 * @see Site::normalizePageName
80 * @since 1.21
82 * @param string $pageName
84 * @return string
85 * @throws MWException
87 public function normalizePageName( $pageName ) {
88 if ( defined( 'MW_PHPUNIT_TEST' ) ) {
89 // If the code is under test, don't call out to other sites, just
90 // normalize locally.
91 // Note: this may cause results to be inconsistent with the actual
92 // normalization used by the respective remote site!
94 $t = Title::newFromText( $pageName );
95 return $t->getPrefixedText();
96 } else {
97 static $mediaWikiPageNameNormalizer = null;
99 if ( $mediaWikiPageNameNormalizer === null ) {
100 $mediaWikiPageNameNormalizer = new MediaWikiPageNameNormalizer();
103 return $mediaWikiPageNameNormalizer->normalizePageName(
104 $pageName,
105 $this->getFileUrl( 'api.php' )
111 * @see Site::getLinkPathType
112 * Returns Site::PATH_PAGE
114 * @since 1.21
116 * @return string
118 public function getLinkPathType() {
119 return self::PATH_PAGE;
123 * Returns the relative page path.
125 * @since 1.21
127 * @return string
129 public function getRelativePagePath() {
130 return parse_url( $this->getPath( self::PATH_PAGE ), PHP_URL_PATH );
134 * Returns the relative file path.
136 * @since 1.21
138 * @return string
140 public function getRelativeFilePath() {
141 return parse_url( $this->getPath( self::PATH_FILE ), PHP_URL_PATH );
145 * Sets the relative page path.
147 * @since 1.21
149 * @param string $path
151 public function setPagePath( $path ) {
152 $this->setPath( self::PATH_PAGE, $path );
156 * Sets the relative file path.
158 * @since 1.21
160 * @param string $path
162 public function setFilePath( $path ) {
163 $this->setPath( self::PATH_FILE, $path );
167 * @see Site::getPageUrl
169 * This implementation returns a URL constructed using the path returned by getLinkPath().
170 * In addition to the default behavior implemented by Site::getPageUrl(), this
171 * method converts the $pageName to DBKey-format by replacing spaces with underscores
172 * before using it in the URL.
174 * @since 1.21
176 * @param string|bool $pageName Page name or false (default: false)
178 * @return string
180 public function getPageUrl( $pageName = false ) {
181 $url = $this->getLinkPath();
183 if ( $url === false ) {
184 return false;
187 if ( $pageName !== false ) {
188 $pageName = $this->toDBKey( trim( $pageName ) );
189 $url = str_replace( '$1', wfUrlencode( $pageName ), $url );
192 return $url;
196 * Returns the full file path (ie site url + relative file path).
197 * The path should go at the $1 marker. If the $path
198 * argument is provided, the marker will be replaced by it's value.
200 * @since 1.21
202 * @param string|bool $path
204 * @return string
206 public function getFileUrl( $path = false ) {
207 $filePath = $this->getPath( self::PATH_FILE );
209 if ( $filePath !== false ) {
210 $filePath = str_replace( '$1', $path, $filePath );
213 return $filePath;