MediaWiki  REL1_31
TextContent.php
Go to the documentation of this file.
1 <?php
36 
40  protected $mText;
41 
47  public function __construct( $text, $model_id = CONTENT_MODEL_TEXT ) {
48  parent::__construct( $model_id );
49 
50  if ( $text === null || $text === false ) {
51  wfWarn( "TextContent constructed with \$text = " . var_export( $text, true ) . "! "
52  . "This may indicate an error in the caller's scope.", 2 );
53 
54  $text = '';
55  }
56 
57  if ( !is_string( $text ) ) {
58  throw new MWException( "TextContent expects a string in the constructor." );
59  }
60 
61  $this->mText = $text;
62  }
63 
69  public function copy() {
70  return $this; # NOTE: this is ok since TextContent are immutable.
71  }
72 
73  public function getTextForSummary( $maxlength = 250 ) {
75 
76  $text = $this->getNativeData();
77 
78  $truncatedtext = $wgContLang->truncate(
79  preg_replace( "/[\n\r]/", ' ', $text ),
80  max( 0, $maxlength ) );
81 
82  return $truncatedtext;
83  }
84 
90  public function getSize() {
91  $text = $this->getNativeData();
92 
93  return strlen( $text );
94  }
95 
105  public function isCountable( $hasLinks = null ) {
107 
108  if ( $this->isRedirect() ) {
109  return false;
110  }
111 
112  if ( $wgArticleCountMethod === 'any' ) {
113  return true;
114  }
115 
116  return false;
117  }
118 
124  public function getNativeData() {
125  return $this->mText;
126  }
127 
133  public function getTextForSearchIndex() {
134  return $this->getNativeData();
135  }
136 
145  public function getWikitextForTransclusion() {
146  $wikitext = $this->convert( CONTENT_MODEL_WIKITEXT, 'lossy' );
147 
148  if ( $wikitext ) {
149  return $wikitext->getNativeData();
150  } else {
151  return false;
152  }
153  }
154 
168  public static function normalizeLineEndings( $text ) {
169  return str_replace( [ "\r\n", "\r" ], "\n", rtrim( $text ) );
170  }
171 
184  public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
185  $text = $this->getNativeData();
186  $pst = self::normalizeLineEndings( $text );
187 
188  return ( $text === $pst ) ? $this : new static( $pst, $this->getModel() );
189  }
190 
203  public function diff( Content $that, Language $lang = null ) {
205 
206  $this->checkModelID( $that->getModel() );
207 
208  // @todo could implement this in DifferenceEngine and just delegate here?
209 
210  if ( !$lang ) {
211  $lang = $wgContLang;
212  }
213 
214  $otext = $this->getNativeData();
215  $ntext = $that->getNativeData();
216 
217  # Note: Use native PHP diff, external engines don't give us abstract output
218  $ota = explode( "\n", $lang->segmentForDiff( $otext ) );
219  $nta = explode( "\n", $lang->segmentForDiff( $ntext ) );
220 
221  $diff = new Diff( $ota, $nta );
222 
223  return $diff;
224  }
225 
243  protected function fillParserOutput( Title $title, $revId,
244  ParserOptions $options, $generateHtml, ParserOutput &$output
245  ) {
247 
248  if ( in_array( $this->getModel(), $wgTextModelsToParse ) ) {
249  // parse just to get links etc into the database, HTML is replaced below.
250  $output = $wgParser->parse( $this->getNativeData(), $title, $options, true, true, $revId );
251  }
252 
253  if ( $generateHtml ) {
254  $html = $this->getHtml();
255  } else {
256  $html = '';
257  }
258 
259  $output->setText( $html );
260  }
261 
275  protected function getHtml() {
276  return $this->getHighlightHtml();
277  }
278 
295  protected function getHighlightHtml() {
296  return htmlspecialchars( $this->getNativeData() );
297  }
298 
312  public function convert( $toModel, $lossy = '' ) {
313  $converted = parent::convert( $toModel, $lossy );
314 
315  if ( $converted !== false ) {
316  return $converted;
317  }
318 
319  $toHandler = ContentHandler::getForModelID( $toModel );
320 
321  if ( $toHandler instanceof TextContentHandler ) {
322  // NOTE: ignore content serialization format - it's just text anyway.
323  $text = $this->getNativeData();
324  $converted = $toHandler->unserializeContent( $text );
325  }
326 
327  return $converted;
328  }
329 
330 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
TextContent\__construct
__construct( $text, $model_id=CONTENT_MODEL_TEXT)
Definition: TextContent.php:47
ParserOptions
Set options of the Parser.
Definition: ParserOptions.php:40
TextContent\getTextForSearchIndex
getTextForSearchIndex()
Returns the text represented by this Content object, as a string.
Definition: TextContent.php:133
ContentHandler\getForModelID
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
Definition: ContentHandler.php:293
ParserOutput
Definition: ParserOutput.php:25
AbstractContent\isRedirect
isRedirect()
Definition: AbstractContent.php:318
TextContent\getWikitextForTransclusion
getWikitextForTransclusion()
Returns attempts to convert this content object to wikitext, and then returns the text string.
Definition: TextContent.php:145
$wgParser
$wgParser
Definition: Setup.php:917
$html
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 & $html
Definition: hooks.txt:2013
$output
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2255
is
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
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
TextContent\getHtml
getHtml()
Generates an HTML version of the content, for display.
Definition: TextContent.php:275
TextContent\$mText
string $mText
Definition: TextContent.php:40
CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:245
php
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:37
TextContent\getTextForSummary
getTextForSummary( $maxlength=250)
Returns a textual representation of the content suitable for use in edit summaries and log messages.
Definition: TextContent.php:73
MWException
MediaWiki exception.
Definition: MWException.php:26
AbstractContent\checkModelID
checkModelID( $modelId)
Definition: AbstractContent.php:72
TextContent\getHighlightHtml
getHighlightHtml()
Generates an HTML version of the content, for display.
Definition: TextContent.php:295
TextContent\copy
copy()
Definition: TextContent.php:69
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
ParserOutput\setText
setText( $text)
Definition: ParserOutput.php:519
TextContent\preSaveTransform
preSaveTransform(Title $title, User $user, ParserOptions $popts)
Returns a Content object with pre-save transformations applied.
Definition: TextContent.php:184
$options
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 & $options
Definition: hooks.txt:2001
TextContent\getSize
getSize()
Returns the text's size in bytes.
Definition: TextContent.php:90
AbstractContent
Base implementation for content objects.
Definition: AbstractContent.php:34
TextContent\isCountable
isCountable( $hasLinks=null)
Returns true if this content is not a redirect, and $wgArticleCountMethod is "any".
Definition: TextContent.php:105
TextContentHandler
Base content handler implementation for flat text contents.
Definition: TextContentHandler.php:31
Content\getNativeData
getNativeData()
Returns native representation of the data.
TextContent
Content object implementation for representing flat text.
Definition: TextContent.php:35
Content
Base interface for content objects.
Definition: Content.php:34
AbstractContent\getModel
getModel()
Definition: AbstractContent.php:60
AbstractContent\$model_id
$model_id
Name of the content model this Content object represents.
Definition: AbstractContent.php:43
Title
Represents a title within MediaWiki.
Definition: Title.php:39
are
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types are
Definition: contenthandler.txt:9
Content\getModel
getModel()
Returns the ID of the content model used by this Content object.
TextContent\normalizeLineEndings
static normalizeLineEndings( $text)
Do a "\\r\\n" -> "\\n" and "\\r" -> "\\n" transformation as well as trim trailing whitespace.
Definition: TextContent.php:168
$wgTextModelsToParse
$wgTextModelsToParse
Determines which types of text are parsed as wikitext.
Definition: DefaultSettings.php:8593
wfWarn
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
Definition: GlobalFunctions.php:1137
$wgArticleCountMethod
$wgArticleCountMethod
Method used to determine if a page in a content namespace should be counted as a valid article.
Definition: DefaultSettings.php:4452
TextContent\diff
diff(Content $that, Language $lang=null)
Diff this content object with another content object.
Definition: TextContent.php:203
CONTENT_MODEL_TEXT
const CONTENT_MODEL_TEXT
Definition: Defines.php:248
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
Language
Internationalisation code.
Definition: Language.php:35
TextContent\fillParserOutput
fillParserOutput(Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
Fills the provided ParserOutput object with information derived from the content.
Definition: TextContent.php:243
TextContent\convert
convert( $toModel, $lossy='')
This implementation provides lossless conversion between content models based on TextContent.
Definition: TextContent.php:312
TextContent\getNativeData
getNativeData()
Returns the text represented by this Content object, as a string.
Definition: TextContent.php:124
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57
Diff
Class representing a 'diff' between two sequences of strings.
Definition: DairikiDiff.php:200