3 class LinkHolderArray
{
4 var $internals = array(), $interwikis = array();
8 function __construct( $parent ) {
9 $this->parent
= $parent;
13 * Reduce memory usage to reduce the impact of circular references
15 function __destruct() {
16 foreach ( $this as $name => $value ) {
17 unset( $this->$name );
22 * Merge another LinkHolderArray into this one
24 function merge( $other ) {
25 foreach ( $other->internals
as $ns => $entries ) {
26 $this->size +
= count( $entries );
27 if ( !isset( $this->internals
[$ns] ) ) {
28 $this->internals
[$ns] = $entries;
30 $this->internals
[$ns] +
= $entries;
33 $this->interwikis +
= $other->interwikis
;
37 * Returns true if the memory requirements of this object are getting large
40 global $wgLinkHolderBatchSize;
41 return $this->size
> $wgLinkHolderBatchSize;
45 * Clear all stored link holders.
46 * Make sure you don't have any text left using these link holders, before you call this
49 $this->internals
= array();
50 $this->interwikis
= array();
55 * Make a link placeholder. The text returned can be later resolved to a real link with
56 * replaceLinkHolders(). This is done for two reasons: firstly to avoid further
57 * parsing of interwiki links, and secondly to allow all existence checks and
58 * article length checks (for stub links) to be bundled into a single query.
61 function makeHolder( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
62 wfProfileIn( __METHOD__
);
63 if ( ! is_object($nt) ) {
65 $retVal = "<!-- ERROR -->{$prefix}{$text}{$trail}";
67 # Separate the link trail from the rest of the link
68 list( $inside, $trail ) = Linker
::splitTrail( $trail );
72 'text' => $prefix.$text.$inside,
73 'pdbk' => $nt->getPrefixedDBkey(),
75 if ( $query !== '' ) {
76 $entry['query'] = $query;
79 if ( $nt->isExternal() ) {
80 // Use a globally unique ID to keep the objects mergable
81 $key = $this->parent
->nextLinkID();
82 $this->interwikis
[$key] = $entry;
83 $retVal = "<!--IWLINK $key-->{$trail}";
85 $key = $this->parent
->nextLinkID();
86 $ns = $nt->getNamespace();
87 $this->internals
[$ns][$key] = $entry;
88 $retVal = "<!--LINK $ns:$key-->{$trail}";
92 wfProfileOut( __METHOD__
);
97 * Get the stub threshold
99 function getStubThreshold() {
101 if ( !isset( $this->stubThreshold
) ) {
102 $this->stubThreshold
= $wgUser->getOption('stubthreshold');
104 return $this->stubThreshold
;
108 * FIXME: update documentation. makeLinkObj() is deprecated.
109 * Replace <!--LINK--> link placeholders with actual links, in the buffer
110 * Placeholders created in Skin::makeLinkObj()
111 * Returns an array of link CSS classes, indexed by PDBK.
113 function replace( &$text ) {
114 wfProfileIn( __METHOD__
);
116 $colours = $this->replaceInternal( $text );
117 $this->replaceInterwiki( $text );
119 wfProfileOut( __METHOD__
);
124 * Replace internal links
126 protected function replaceInternal( &$text ) {
127 if ( !$this->internals
) {
131 wfProfileIn( __METHOD__
);
135 $sk = $this->parent
->getOptions()->getSkin();
136 $linkCache = LinkCache
::singleton();
137 $output = $this->parent
->getOutput();
139 wfProfileIn( __METHOD__
.'-check' );
140 $dbr = wfGetDB( DB_SLAVE
);
141 $page = $dbr->tableName( 'page' );
142 $threshold = $this->getStubThreshold();
145 ksort( $this->internals
);
150 foreach ( $this->internals
as $ns => $entries ) {
151 foreach ( $entries as $index => $entry ) {
153 $title = $entry['title'];
154 $pdbk = $entry['pdbk'];
156 # Skip invalid entries.
157 # Result will be ugly, but prevents crash.
158 if ( is_null( $title ) ) {
162 # Check if it's a static known link, e.g. interwiki
163 if ( $title->isAlwaysKnown() ) {
164 $colours[$pdbk] = '';
165 } elseif ( ( $id = $linkCache->getGoodLinkID( $pdbk ) ) != 0 ) {
166 $colours[$pdbk] = $sk->getLinkColour( $title, $threshold );
167 $output->addLink( $title, $id );
168 } elseif ( $linkCache->isBadLink( $pdbk ) ) {
169 $colours[$pdbk] = 'new';
171 # Not in the link cache, add it to the query
172 if ( !isset( $current ) ) {
174 $query = "SELECT page_id, page_namespace, page_title, page_is_redirect, page_len";
175 $query .= " FROM $page WHERE (page_namespace=$ns AND page_title IN(";
176 } elseif ( $current != $ns ) {
178 $query .= ")) OR (page_namespace=$ns AND page_title IN(";
183 $query .= $dbr->addQuotes( $title->getDBkey() );
190 $res = $dbr->query( $query, __METHOD__
);
192 # Fetch data and form into an associative array
193 # non-existent = broken
194 $linkcolour_ids = array();
195 while ( $s = $dbr->fetchObject($res) ) {
196 $title = Title
::makeTitle( $s->page_namespace
, $s->page_title
);
197 $pdbk = $title->getPrefixedDBkey();
198 $linkCache->addGoodLinkObj( $s->page_id
, $title, $s->page_len
, $s->page_is_redirect
);
199 $output->addLink( $title, $s->page_id
);
200 # FIXME: convoluted data flow
201 # The redirect status and length is passed to getLinkColour via the LinkCache
202 # Use formal parameters instead
203 $colours[$pdbk] = $sk->getLinkColour( $title, $threshold );
204 //add id to the extension todolist
205 $linkcolour_ids[$s->page_id
] = $pdbk;
208 //pass an array of page_ids to an extension
209 wfRunHooks( 'GetLinkColours', array( $linkcolour_ids, &$colours ) );
211 wfProfileOut( __METHOD__
.'-check' );
213 # Do a second query for different language variants of links and categories
214 if($wgContLang->hasVariants()) {
215 $this->doVariants( $colours );
218 # Construct search and replace arrays
219 wfProfileIn( __METHOD__
.'-construct' );
220 $replacePairs = array();
221 foreach ( $this->internals
as $ns => $entries ) {
222 foreach ( $entries as $index => $entry ) {
223 $pdbk = $entry['pdbk'];
224 $title = $entry['title'];
225 $query = isset( $entry['query'] ) ?
$entry['query'] : '';
227 $searchkey = "<!--LINK $key-->";
228 if ( !isset( $colours[$pdbk] ) ||
$colours[$pdbk] == 'new' ) {
229 $linkCache->addBadLinkObj( $title );
230 $colours[$pdbk] = 'new';
231 $output->addLink( $title, 0 );
232 // FIXME: replace deprecated makeBrokenLinkObj() by link()
233 $replacePairs[$searchkey] = $sk->makeBrokenLinkObj( $title,
237 // FIXME: replace deprecated makeColouredLinkObj() by link()
238 $replacePairs[$searchkey] = $sk->makeColouredLinkObj( $title, $colours[$pdbk],
244 $replacer = new HashtableReplacer( $replacePairs, 1 );
245 wfProfileOut( __METHOD__
.'-construct' );
248 wfProfileIn( __METHOD__
.'-replace' );
249 $text = preg_replace_callback(
250 '/(<!--LINK .*?-->)/',
254 wfProfileOut( __METHOD__
.'-replace' );
255 wfProfileOut( __METHOD__
);
259 * Replace interwiki links
261 protected function replaceInterwiki( &$text ) {
262 if ( empty( $this->interwikis
) ) {
266 wfProfileIn( __METHOD__
);
267 # Make interwiki link HTML
268 $sk = $this->parent
->getOptions()->getSkin();
269 $output = $this->parent
->getOutput();
270 $replacePairs = array();
271 foreach( $this->interwikis
as $key => $link ) {
272 $replacePairs[$key] = $sk->link( $link['title'], $link['text'] );
273 $output->addInterwikiLink( $link['title'] );
275 $replacer = new HashtableReplacer( $replacePairs, 1 );
277 $text = preg_replace_callback(
278 '/<!--IWLINK (.*?)-->/',
281 wfProfileOut( __METHOD__
);
285 * Modify $this->internals and $colours according to language variant linking rules
287 protected function doVariants( &$colours ) {
289 $linkBatch = new LinkBatch();
290 $variantMap = array(); // maps $pdbkey_Variant => $keys (of link holders)
291 $output = $this->parent
->getOutput();
292 $linkCache = LinkCache
::singleton();
293 $sk = $this->parent
->getOptions()->getSkin();
294 $threshold = $this->getStubThreshold();
296 // Add variants of links to link batch
297 foreach ( $this->internals
as $ns => $entries ) {
298 foreach ( $entries as $index => $entry ) {
300 $pdbk = $entry['pdbk'];
301 $title = $entry['title'];
302 $titleText = $title->getText();
304 // generate all variants of the link title text
305 $allTextVariants = $wgContLang->convertLinkToAllVariants($titleText);
307 // if link was not found (in first query), add all variants to query
308 if ( !isset($colours[$pdbk]) ){
309 foreach($allTextVariants as $textVariant){
310 if($textVariant != $titleText){
311 $variantTitle = Title
::makeTitle( $ns, $textVariant );
312 if(is_null($variantTitle)) continue;
313 $linkBatch->addObj( $variantTitle );
314 $variantMap[$variantTitle->getPrefixedDBkey()][] = $key;
321 // process categories, check if a category exists in some variant
322 $categoryMap = array(); // maps $category_variant => $category (dbkeys)
323 $varCategories = array(); // category replacements oldDBkey => newDBkey
324 foreach( $output->getCategoryLinks() as $category ){
325 $variants = $wgContLang->convertLinkToAllVariants($category);
326 foreach($variants as $variant){
327 if($variant != $category){
328 $variantTitle = Title
::newFromDBkey( Title
::makeName(NS_CATEGORY
,$variant) );
329 if(is_null($variantTitle)) continue;
330 $linkBatch->addObj( $variantTitle );
331 $categoryMap[$variant] = $category;
337 if(!$linkBatch->isEmpty()){
339 $dbr = wfGetDB( DB_SLAVE
);
340 $page = $dbr->tableName( 'page' );
341 $titleClause = $linkBatch->constructSet('page', $dbr);
342 $variantQuery = "SELECT page_id, page_namespace, page_title, page_is_redirect, page_len";
343 $variantQuery .= " FROM $page WHERE $titleClause";
344 $varRes = $dbr->query( $variantQuery, __METHOD__
);
345 $linkcolour_ids = array();
347 // for each found variants, figure out link holders and replace
348 while ( $s = $dbr->fetchObject($varRes) ) {
350 $variantTitle = Title
::makeTitle( $s->page_namespace
, $s->page_title
);
351 $varPdbk = $variantTitle->getPrefixedDBkey();
352 $vardbk = $variantTitle->getDBkey();
354 $holderKeys = array();
355 if(isset($variantMap[$varPdbk])){
356 $holderKeys = $variantMap[$varPdbk];
357 $linkCache->addGoodLinkObj( $s->page_id
, $variantTitle, $s->page_len
, $s->page_is_redirect
);
358 $output->addLink( $variantTitle, $s->page_id
);
361 // loop over link holders
362 foreach($holderKeys as $key){
363 list( $ns, $index ) = explode( ':', $key, 2 );
364 $entry =& $this->internals
[$ns][$index];
365 $pdbk = $entry['pdbk'];
367 if(!isset($colours[$pdbk])){
368 // found link in some of the variants, replace the link holder data
369 $entry['title'] = $variantTitle;
370 $entry['pdbk'] = $varPdbk;
372 // set pdbk and colour
373 # FIXME: convoluted data flow
374 # The redirect status and length is passed to getLinkColour via the LinkCache
375 # Use formal parameters instead
376 $colours[$varPdbk] = $sk->getLinkColour( $variantTitle, $threshold );
377 $linkcolour_ids[$s->page_id
] = $pdbk;
381 // check if the object is a variant of a category
382 if(isset($categoryMap[$vardbk])){
383 $oldkey = $categoryMap[$vardbk];
384 if($oldkey != $vardbk)
385 $varCategories[$oldkey]=$vardbk;
388 wfRunHooks( 'GetLinkColours', array( $linkcolour_ids, &$colours ) );
390 // rebuild the categories in original order (if there are replacements)
391 if(count($varCategories)>0){
393 $originalCats = $output->getCategories();
394 foreach($originalCats as $cat => $sortkey){
395 // make the replacement
396 if( array_key_exists($cat,$varCategories) )
397 $newCats[$varCategories[$cat]] = $sortkey;
398 else $newCats[$cat] = $sortkey;
400 $output->setCategoryLinks($newCats);
406 * Replace <!--LINK--> link placeholders with plain text of links
407 * (not HTML-formatted).
408 * @param string $text
411 function replaceText( $text ) {
412 wfProfileIn( __METHOD__
);
414 $text = preg_replace_callback(
415 '/<!--(LINK|IWLINK) (.*?)-->/',
416 array( &$this, 'replaceTextCallback' ),
419 wfProfileOut( __METHOD__
);
424 * @param array $matches
428 function replaceTextCallback( $matches ) {
431 if( $type == 'LINK' ) {
432 list( $ns, $index ) = explode( ':', $key, 2 );
433 if( isset( $this->internals
[$ns][$index]['text'] ) ) {
434 return $this->internals
[$ns][$index]['text'];
436 } elseif( $type == 'IWLINK' ) {
437 if( isset( $this->interwikis
[$key]['text'] ) ) {
438 return $this->interwikis
[$key]['text'];