MediaWiki  1.28.3
MediaWikiTitleCodec.php
Go to the documentation of this file.
1 <?php
25 
41  protected $language;
42 
46  protected $genderCache;
47 
51  protected $localInterwikis;
52 
59  $localInterwikis = []
60  ) {
61  $this->language = $language;
62  $this->genderCache = $genderCache;
63  $this->localInterwikis = (array)$localInterwikis;
64  }
65 
75  public function getNamespaceName( $namespace, $text ) {
76  if ( $this->language->needsGenderDistinction() &&
78  ) {
79 
80  // NOTE: we are assuming here that the title text is a user name!
81  $gender = $this->genderCache->getGenderOf( $text, __METHOD__ );
82  $name = $this->language->getGenderNsText( $namespace, $gender );
83  } else {
84  $name = $this->language->getNsText( $namespace );
85  }
86 
87  if ( $name === false ) {
88  throw new InvalidArgumentException( 'Unknown namespace ID: ' . $namespace );
89  }
90 
91  return $name;
92  }
93 
106  public function formatTitle( $namespace, $text, $fragment = '', $interwiki = '' ) {
107  if ( $namespace !== false ) {
108  // Try to get a namespace name, but fallback
109  // to empty string if it doesn't exist
110  try {
111  $nsName = $this->getNamespaceName( $namespace, $text );
112  } catch ( InvalidArgumentException $e ) {
113  $nsName = '';
114  }
115 
116  if ( $namespace !== 0 ) {
117  $text = $nsName . ':' . $text;
118  }
119  }
120 
121  if ( $fragment !== '' ) {
122  $text = $text . '#' . $fragment;
123  }
124 
125  if ( $interwiki !== '' ) {
126  $text = $interwiki . ':' . $text;
127  }
128 
129  $text = str_replace( '_', ' ', $text );
130 
131  return $text;
132  }
133 
144  public function parseTitle( $text, $defaultNamespace ) {
145  // NOTE: this is an ugly cludge that allows this class to share the
146  // code for parsing with the old Title class. The parser code should
147  // be refactored to avoid this.
148  $parts = $this->splitTitleString( $text, $defaultNamespace );
149 
150  // Relative fragment links are not supported by TitleValue
151  if ( $parts['dbkey'] === '' ) {
152  throw new MalformedTitleException( 'title-invalid-empty', $text );
153  }
154 
155  return new TitleValue(
156  $parts['namespace'],
157  $parts['dbkey'],
158  $parts['fragment'],
159  $parts['interwiki']
160  );
161  }
162 
170  public function getText( LinkTarget $title ) {
171  return $this->formatTitle( false, $title->getText(), '' );
172  }
173 
181  public function getPrefixedText( LinkTarget $title ) {
182  return $this->formatTitle(
183  $title->getNamespace(),
184  $title->getText(),
185  '',
186  $title->getInterwiki()
187  );
188  }
189 
196  public function getPrefixedDBkey( LinkTarget $target ) {
197  $key = '';
198  if ( $target->isExternal() ) {
199  $key .= $target->getInterwiki() . ':';
200  }
201  // Try to get a namespace name, but fallback
202  // to empty string if it doesn't exist
203  try {
204  $nsName = $this->getNamespaceName(
205  $target->getNamespace(),
206  $target->getText()
207  );
208  } catch ( InvalidArgumentException $e ) {
209  $nsName = '';
210  }
211 
212  if ( $target->getNamespace() !== 0 ) {
213  $key .= $nsName . ':';
214  }
215 
216  $key .= $target->getText();
217 
218  return strtr( $key, ' ', '_' );
219  }
220 
228  public function getFullText( LinkTarget $title ) {
229  return $this->formatTitle(
230  $title->getNamespace(),
231  $title->getText(),
232  $title->getFragment(),
233  $title->getInterwiki()
234  );
235  }
236 
257  public function splitTitleString( $text, $defaultNamespace = NS_MAIN ) {
258  $dbkey = str_replace( ' ', '_', $text );
259 
260  # Initialisation
261  $parts = [
262  'interwiki' => '',
263  'local_interwiki' => false,
264  'fragment' => '',
265  'namespace' => $defaultNamespace,
266  'dbkey' => $dbkey,
267  'user_case_dbkey' => $dbkey,
268  ];
269 
270  # Strip Unicode bidi override characters.
271  # Sometimes they slip into cut-n-pasted page titles, where the
272  # override chars get included in list displays.
273  $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
274 
275  # Clean up whitespace
276  # Note: use of the /u option on preg_replace here will cause
277  # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
278  # conveniently disabling them.
279  $dbkey = preg_replace(
280  '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u',
281  '_',
282  $dbkey
283  );
284  $dbkey = trim( $dbkey, '_' );
285 
286  if ( strpos( $dbkey, UtfNormal\Constants::UTF8_REPLACEMENT ) !== false ) {
287  # Contained illegal UTF-8 sequences or forbidden Unicode chars.
288  throw new MalformedTitleException( 'title-invalid-utf8', $text );
289  }
290 
291  $parts['dbkey'] = $dbkey;
292 
293  # Initial colon indicates main namespace rather than specified default
294  # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
295  if ( $dbkey !== '' && ':' == $dbkey[0] ) {
296  $parts['namespace'] = NS_MAIN;
297  $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
298  $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
299  }
300 
301  if ( $dbkey == '' ) {
302  throw new MalformedTitleException( 'title-invalid-empty', $text );
303  }
304 
305  # Namespace or interwiki prefix
306  $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
307  do {
308  $m = [];
309  if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
310  $p = $m[1];
311  $ns = $this->language->getNsIndex( $p );
312  if ( $ns !== false ) {
313  # Ordinary namespace
314  $dbkey = $m[2];
315  $parts['namespace'] = $ns;
316  # For Talk:X pages, check if X has a "namespace" prefix
317  if ( $ns == NS_TALK && preg_match( $prefixRegexp, $dbkey, $x ) ) {
318  if ( $this->language->getNsIndex( $x[1] ) ) {
319  # Disallow Talk:File:x type titles...
320  throw new MalformedTitleException( 'title-invalid-talk-namespace', $text );
321  } elseif ( Interwiki::isValidInterwiki( $x[1] ) ) {
322  // TODO: get rid of global state!
323  # Disallow Talk:Interwiki:x type titles...
324  throw new MalformedTitleException( 'title-invalid-talk-namespace', $text );
325  }
326  }
327  } elseif ( Interwiki::isValidInterwiki( $p ) ) {
328  # Interwiki link
329  $dbkey = $m[2];
330  $parts['interwiki'] = $this->language->lc( $p );
331 
332  # Redundant interwiki prefix to the local wiki
333  foreach ( $this->localInterwikis as $localIW ) {
334  if ( 0 == strcasecmp( $parts['interwiki'], $localIW ) ) {
335  if ( $dbkey == '' ) {
336  # Empty self-links should point to the Main Page, to ensure
337  # compatibility with cross-wiki transclusions and the like.
338  $mainPage = Title::newMainPage();
339  return [
340  'interwiki' => $mainPage->getInterwiki(),
341  'local_interwiki' => true,
342  'fragment' => $mainPage->getFragment(),
343  'namespace' => $mainPage->getNamespace(),
344  'dbkey' => $mainPage->getDBkey(),
345  'user_case_dbkey' => $mainPage->getUserCaseDBKey()
346  ];
347  }
348  $parts['interwiki'] = '';
349  # local interwikis should behave like initial-colon links
350  $parts['local_interwiki'] = true;
351 
352  # Do another namespace split...
353  continue 2;
354  }
355  }
356 
357  # If there's an initial colon after the interwiki, that also
358  # resets the default namespace
359  if ( $dbkey !== '' && $dbkey[0] == ':' ) {
360  $parts['namespace'] = NS_MAIN;
361  $dbkey = substr( $dbkey, 1 );
362  }
363  }
364  # If there's no recognized interwiki or namespace,
365  # then let the colon expression be part of the title.
366  }
367  break;
368  } while ( true );
369 
370  $fragment = strstr( $dbkey, '#' );
371  if ( false !== $fragment ) {
372  $parts['fragment'] = str_replace( '_', ' ', substr( $fragment, 1 ) );
373  $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
374  # remove whitespace again: prevents "Foo_bar_#"
375  # becoming "Foo_bar_"
376  $dbkey = preg_replace( '/_*$/', '', $dbkey );
377  }
378 
379  # Reject illegal characters.
380  $rxTc = self::getTitleInvalidRegex();
381  $matches = [];
382  if ( preg_match( $rxTc, $dbkey, $matches ) ) {
383  throw new MalformedTitleException( 'title-invalid-characters', $text, [ $matches[0] ] );
384  }
385 
386  # Pages with "/./" or "/../" appearing in the URLs will often be un-
387  # reachable due to the way web browsers deal with 'relative' URLs.
388  # Also, they conflict with subpage syntax. Forbid them explicitly.
389  if (
390  strpos( $dbkey, '.' ) !== false &&
391  (
392  $dbkey === '.' || $dbkey === '..' ||
393  strpos( $dbkey, './' ) === 0 ||
394  strpos( $dbkey, '../' ) === 0 ||
395  strpos( $dbkey, '/./' ) !== false ||
396  strpos( $dbkey, '/../' ) !== false ||
397  substr( $dbkey, -2 ) == '/.' ||
398  substr( $dbkey, -3 ) == '/..'
399  )
400  ) {
401  throw new MalformedTitleException( 'title-invalid-relative', $text );
402  }
403 
404  # Magic tilde sequences? Nu-uh!
405  if ( strpos( $dbkey, '~~~' ) !== false ) {
406  throw new MalformedTitleException( 'title-invalid-magic-tilde', $text );
407  }
408 
409  # Limit the size of titles to 255 bytes. This is typically the size of the
410  # underlying database field. We make an exception for special pages, which
411  # don't need to be stored in the database, and may edge over 255 bytes due
412  # to subpage syntax for long titles, e.g. [[Special:Block/Long name]]
413  $maxLength = ( $parts['namespace'] != NS_SPECIAL ) ? 255 : 512;
414  if ( strlen( $dbkey ) > $maxLength ) {
415  throw new MalformedTitleException( 'title-invalid-too-long', $text,
416  [ Message::numParam( $maxLength ) ] );
417  }
418 
419  # Normally, all wiki links are forced to have an initial capital letter so [[foo]]
420  # and [[Foo]] point to the same place. Don't force it for interwikis, since the
421  # other site might be case-sensitive.
422  $parts['user_case_dbkey'] = $dbkey;
423  if ( $parts['interwiki'] === '' ) {
424  $dbkey = Title::capitalize( $dbkey, $parts['namespace'] );
425  }
426 
427  # Can't make a link to a namespace alone... "empty" local links can only be
428  # self-links with a fragment identifier.
429  if ( $dbkey == '' && $parts['interwiki'] === '' ) {
430  if ( $parts['namespace'] != NS_MAIN ) {
431  throw new MalformedTitleException( 'title-invalid-empty', $text );
432  }
433  }
434 
435  // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
436  // IP names are not allowed for accounts, and can only be referring to
437  // edits from the IP. Given '::' abbreviations and caps/lowercaps,
438  // there are numerous ways to present the same IP. Having sp:contribs scan
439  // them all is silly and having some show the edits and others not is
440  // inconsistent. Same for talk/userpages. Keep them normalized instead.
441  if ( $parts['namespace'] == NS_USER || $parts['namespace'] == NS_USER_TALK ) {
442  $dbkey = IP::sanitizeIP( $dbkey );
443  }
444 
445  // Any remaining initial :s are illegal.
446  if ( $dbkey !== '' && ':' == $dbkey[0] ) {
447  throw new MalformedTitleException( 'title-invalid-leading-colon', $text );
448  }
449 
450  # Fill fields
451  $parts['dbkey'] = $dbkey;
452 
453  return $parts;
454  }
455 
465  public static function getTitleInvalidRegex() {
466  static $rxTc = false;
467  if ( !$rxTc ) {
468  # Matching titles will be held as illegal.
469  $rxTc = '/' .
470  # Any character not allowed is forbidden...
471  '[^' . Title::legalChars() . ']' .
472  # URL percent encoding sequences interfere with the ability
473  # to round-trip titles -- you can't link to them consistently.
474  '|%[0-9A-Fa-f]{2}' .
475  # XML/HTML character references produce similar issues.
476  '|&[A-Za-z0-9\x80-\xff]+;' .
477  '|&#[0-9]+;' .
478  '|&#x[0-9A-Fa-f]+;' .
479  '/S';
480  }
481 
482  return $rxTc;
483  }
484 }
#define the
table suitable for use with IDatabase::select()
A codec for MediaWiki page titles.
static hasGenderDistinction($index)
Does the namespace (potentially) have different aliases for different genders.
the array() calling protocol came about after MediaWiki 1.4rc1.
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
static getTitleInvalidRegex()
Returns a simple regex that will match on characters and sequences invalid in titles.
static sanitizeIP($ip)
Convert an IP into a verbose, uppercase, normalized form.
Definition: IP.php:140
const NS_MAIN
Definition: Defines.php:56
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:556
getText(LinkTarget $title)
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
splitTitleString($text, $defaultNamespace=NS_MAIN)
Normalizes and splits a title string.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2106
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for except in special pages derived from QueryPage It s a common pitfall for new developers to submit code containing SQL queries which examine huge numbers of rows Remember that COUNT * is(N), counting rows in atable is like counting beans in a bucket.------------------------------------------------------------------------Replication------------------------------------------------------------------------The largest installation of MediaWiki, Wikimedia, uses a large set ofslave MySQL servers replicating writes made to a master MySQL server.Itis important to understand the issues associated with this setup if youwant to write code destined for Wikipedia.It's often the case that the best algorithm to use for a given taskdepends on whether or not replication is in use.Due to our unabashedWikipedia-centrism, we often just use the replication-friendly version, but if you like, you can use wfGetLB() ->getServerCount() > 1 tocheck to see if replication is in use.===Lag===Lag primarily occurs when large write queries are sent to the master.Writes on the master are executed in parallel, but they are executed inserial when they are replicated to the slaves.The master writes thequery to the binlog when the transaction is committed.The slaves pollthe binlog and start executing the query as soon as it appears.They canservice reads while they are performing a write query, but will not readanything more from the binlog and thus will perform no more writes.Thismeans that if the write query runs for a long time, the slaves will lagbehind the master for the time it takes for the write query to complete.Lag can be exacerbated by high read load.MediaWiki's load balancer willstop sending reads to a slave when it is lagged by more than 30 seconds.If the load ratios are set incorrectly, or if there is too much loadgenerally, this may lead to a slave permanently hovering around 30seconds lag.If all slaves are lagged by more than 30 seconds, MediaWiki will stopwriting to the database.All edits and other write operations will berefused, with an error returned to the user.This gives the slaves achance to catch up.Before we had this mechanism, the slaves wouldregularly lag by several minutes, making review of recent editsdifficult.In addition to this, MediaWiki attempts to ensure that the user seesevents occurring on the wiki in chronological order.A few seconds of lagcan be tolerated, as long as the user sees a consistent picture fromsubsequent requests.This is done by saving the master binlog positionin the session, and then at the start of each request, waiting for theslave to catch up to that position before doing any reads from it.Ifthis wait times out, reads are allowed anyway, but the request isconsidered to be in"lagged slave mode".Lagged slave mode can bechecked by calling wfGetLB() ->getLaggedSlaveMode().The onlypractical consequence at present is a warning displayed in the pagefooter.===Lag avoidance===To avoid excessive lag, queries which write large numbers of rows shouldbe split up, generally to write one row at a time.Multi-row INSERT...SELECT queries are the worst offenders should be avoided altogether.Instead do the select first and then the insert.===Working with lag===Despite our best efforts, it's not practical to guarantee a low-lagenvironment.Lag will usually be less than one second, but mayoccasionally be up to 30 seconds.For scalability, it's very importantto keep load on the master low, so simply sending all your queries tothe master is not the answer.So when you have a genuine need forup-to-date data, the following approach is advised:1) Do a quick query to the master for a sequence number or timestamp 2) Run the full query on the slave and check if it matches the data you gotfrom the master 3) If it doesn't, run the full query on the masterTo avoid swamping the master every time the slaves lag, use of thisapproach should be kept to a minimum.In most cases you should just readfrom the slave and let the user deal with the delay.------------------------------------------------------------------------Lock contention------------------------------------------------------------------------Due to the high write rate on Wikipedia(and some other wikis), MediaWiki developers need to be very careful to structure their writesto avoid long-lasting locks.By default, MediaWiki opens a transactionat the first query, and commits it before the output is sent.Locks willbe held from the time when the query is done until the commit.So youcan reduce lock time by doing as much processing as possible before youdo your write queries.Often this approach is not good enough, and it becomes necessary toenclose small groups of queries in their own transaction.Use thefollowing syntax:$dbw=wfGetDB(DB_MASTER
Represents a page (or page fragment) title within MediaWiki.
Definition: TitleValue.php:36
const NS_SPECIAL
Definition: Defines.php:45
const UTF8_REPLACEMENT
formatTitle($namespace, $text, $fragment= '', $interwiki= '')
getNamespace()
Get the namespace index.
getFragment()
Get the link fragment (i.e.
isExternal()
Whether this LinkTarget has an interwiki component.
Unicode normalization routines for working with UTF-8 strings.
Definition: UtfNormal.php:48
__construct(Language $language, GenderCache $genderCache, $localInterwikis=[])
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after processing
Definition: hooks.txt:1940
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:957
getPrefixedText(LinkTarget $title)
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor'$rcid is used in generating this variable which contains information about the new such as the revision s whether the revision was marked as a minor edit or not
Definition: hooks.txt:1160
parseTitle($text, $defaultNamespace)
Parses the given text and constructs a TitleValue.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
getNamespaceName($namespace, $text)
getFullText(LinkTarget $title)
static numParam($num)
Definition: Message.php:996
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain URL
Definition: design.txt:25
getInterwiki()
The interwiki component of this LinkTarget.
getText()
Returns the link in text form, without namespace prefix or fragment.
static legalChars()
Get a regex character class describing the legal characters in a link.
Definition: Title.php:593
const NS_TALK
Definition: Defines.php:57
const NS_USER_TALK
Definition: Defines.php:59
static capitalize($text, $ns=NS_MAIN)
Capitalize a text string for a title if it belongs to a namespace that capitalizes.
Definition: Title.php:3367
static isValidInterwiki($prefix)
Check whether an interwiki prefix exists.
Definition: Interwiki.php:68
getPrefixedDBkey(LinkTarget $target)
$matches
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304