* A new tab in the preferencesc called 'File' for any current and future
[lhc/web/wiklou.git] / includes / Linker.php
1 <?php
2 /**
3 * Split off some of the internal bits from Skin.php.
4 * These functions are used for primarily page content:
5 * links, embedded images, table of contents. Links are
6 * also used in the skin.
7 * @package MediaWiki
8 */
9
10 /**
11 * For the moment, Skin is a descendent class of Linker.
12 * In the future, it should probably be further split
13 * so that ever other bit of the wiki doesn't have to
14 * go loading up Skin to get at it.
15 *
16 * @package MediaWiki
17 */
18 class Linker {
19 var $linktrail ; # linktrail regexp
20 var $postParseLinkColour = false;
21
22 /** @todo document */
23 function Linker() {
24 global $wgContLang;
25 $this->linktrail = $wgContLang->linkTrail();
26 }
27
28 /**
29 * Get/set accessor for delayed link colouring
30 */
31 function postParseLinkColour( $setting = NULL ) {
32 return wfSetVar( $this->postParseLinkColour, $setting );
33 }
34
35 /** @todo document */
36 function getExternalLinkAttributes( $link, $text, $class='' ) {
37 global $wgContLang;
38
39 $same = ($link == $text);
40 $link = urldecode( $link );
41 $link = $wgContLang->checkTitleEncoding( $link );
42 $link = preg_replace( '/[\\x00-\\x1f_]/', ' ', $link );
43 $link = htmlspecialchars( $link );
44
45 $r = ($class != '') ? " class='$class'" : " class='external'";
46
47 $r .= " title=\"{$link}\"";
48 return $r;
49 }
50
51 /** @todo document */
52 function getInternalLinkAttributes( $link, $text, $broken = false ) {
53 $link = urldecode( $link );
54 $link = str_replace( '_', ' ', $link );
55 $link = htmlspecialchars( $link );
56
57 if( $broken == 'stub' ) {
58 $r = ' class="stub"';
59 } else if ( $broken == 'yes' ) {
60 $r = ' class="new"';
61 } else {
62 $r = '';
63 }
64
65 $r .= " title=\"{$link}\"";
66 return $r;
67 }
68
69 /**
70 * @param bool $broken
71 */
72 function getInternalLinkAttributesObj( &$nt, $text, $broken = false ) {
73 if( $broken == 'stub' ) {
74 $r = ' class="stub"';
75 } else if ( $broken == 'yes' ) {
76 $r = ' class="new"';
77 } else {
78 $r = '';
79 }
80
81 $r .= ' title="' . $nt->getEscapedText() . '"';
82 return $r;
83 }
84
85 /**
86 * Note: This function MUST call getArticleID() on the link,
87 * otherwise the cache won't get updated properly. See LINKCACHE.DOC.
88 */
89 function makeLink( $title, $text = '', $query = '', $trail = '' ) {
90 wfProfileIn( 'Skin::makeLink' );
91 $nt = Title::newFromText( $title );
92 if ($nt) {
93 $result = $this->makeLinkObj( Title::newFromText( $title ), $text, $query, $trail );
94 } else {
95 wfDebug( 'Invalid title passed to Skin::makeLink(): "'.$title."\"\n" );
96 $result = $text == "" ? $title : $text;
97 }
98
99 wfProfileOut( 'Skin::makeLink' );
100 return $result;
101 }
102
103 /** @todo document */
104 function makeKnownLink( $title, $text = '', $query = '', $trail = '', $prefix = '',$aprops = '') {
105 $nt = Title::newFromText( $title );
106 if ($nt) {
107 return $this->makeKnownLinkObj( Title::newFromText( $title ), $text, $query, $trail, $prefix , $aprops );
108 } else {
109 wfDebug( 'Invalid title passed to Skin::makeKnownLink(): "'.$title."\"\n" );
110 return $text == '' ? $title : $text;
111 }
112 }
113
114 /** @todo document */
115 function makeBrokenLink( $title, $text = '', $query = '', $trail = '' ) {
116 $nt = Title::newFromText( $title );
117 if ($nt) {
118 return $this->makeBrokenLinkObj( Title::newFromText( $title ), $text, $query, $trail );
119 } else {
120 wfDebug( 'Invalid title passed to Skin::makeBrokenLink(): "'.$title."\"\n" );
121 return $text == '' ? $title : $text;
122 }
123 }
124
125 /** @todo document */
126 function makeStubLink( $title, $text = '', $query = '', $trail = '' ) {
127 $nt = Title::newFromText( $title );
128 if ($nt) {
129 return $this->makeStubLinkObj( Title::newFromText( $title ), $text, $query, $trail );
130 } else {
131 wfDebug( 'Invalid title passed to Skin::makeStubLink(): "'.$title."\"\n" );
132 return $text == '' ? $title : $text;
133 }
134 }
135
136 /**
137 * Pass a title object, not a title string
138 */
139 function makeLinkObj( &$nt, $text= '', $query = '', $trail = '', $prefix = '' ) {
140 global $wgOut, $wgUser, $wgLinkHolders, $wgInputEncoding;
141 $fname = 'Skin::makeLinkObj';
142 wfProfileIn( $fname );
143
144 # Fail gracefully
145 if ( ! isset($nt) ) {
146 # wfDebugDieBacktrace();
147 wfProfileOut( $fname );
148 return "<!-- ERROR -->{$prefix}{$text}{$trail}";
149 }
150
151 $ns = $nt->getNamespace();
152 $dbkey = $nt->getDBkey();
153 if ( $nt->isExternal() ) {
154 $u = $nt->getFullURL();
155 $link = $nt->getPrefixedURL();
156 if ( '' == $text ) { $text = $nt->getPrefixedText(); }
157 $style = $this->getExternalLinkAttributes( $link, $text, 'extiw' );
158
159 $inside = '';
160 if ( '' != $trail ) {
161 if ( preg_match( '/^([a-z]+)(.*)$$/sD', $trail, $m ) ) {
162 $inside = $m[1];
163 $trail = $m[2];
164 }
165 }
166
167 # Check for anchors, normalize the anchor
168
169 $parts = explode( '#', $u, 2 );
170 if ( count( $parts ) == 2 ) {
171 $anchor = urlencode( do_html_entity_decode( str_replace(' ', '_', $parts[1] ),
172 ENT_COMPAT,
173 $wgInputEncoding ) );
174 $replacearray = array(
175 '%3A' => ':',
176 '%' => '.'
177 );
178 $u = $parts[0] . '#' .
179 str_replace( array_keys( $replacearray ),
180 array_values( $replacearray ),
181 $anchor );
182 }
183
184 $t = "<a href=\"{$u}\"{$style}>{$text}{$inside}</a>";
185
186 if( $this->postParseLinkColour ) {
187 # There's no existence check, but this will prevent
188 # interwiki links from being parsed as external links.
189 global $wgInterwikiLinkHolders;
190 $nr = array_push($wgInterwikiLinkHolders, $t);
191 $retVal = '<!--IWLINK '. ($nr-1) ."-->{$trail}";
192 } else {
193 return $t;
194 }
195 } elseif ( 0 == $ns && "" == $dbkey ) {
196 # A self-link with a fragment; skip existence check.
197 $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
198 } elseif ( ( NS_SPECIAL == $ns ) || ( NS_IMAGE == $ns ) ) {
199 # These are always shown as existing, currently.
200 # Special pages don't exist in the database; images may
201 # occasionally be present when there is no description
202 # page per se, so we always shown them.
203 $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
204 } elseif ( $this->postParseLinkColour ) {
205 wfProfileIn( $fname.'-postparse' );
206 # Insert a placeholder, and we'll work out the existence checks
207 # in a big lump later.
208 $inside = '';
209 if ( '' != $trail ) {
210 if ( preg_match( $this->linktrail, $trail, $m ) ) {
211 $inside = $m[1];
212 $trail = $m[2];
213 }
214 }
215
216 # These get picked up by Parser::replaceLinkHolders()
217 $nr = array_push( $wgLinkHolders['namespaces'], $nt->getNamespace() );
218 $wgLinkHolders['dbkeys'][] = $dbkey;
219 $wgLinkHolders['queries'][] = $query;
220 $wgLinkHolders['texts'][] = $prefix.$text.$inside;
221 $wgLinkHolders['titles'][] =& $nt;
222
223 $retVal = '<!--LINK '. ($nr-1) ."-->{$trail}";
224 wfProfileOut( $fname.'-postparse' );
225 } else {
226 wfProfileIn( $fname.'-immediate' );
227 # Work out link colour immediately
228 $aid = $nt->getArticleID() ;
229 if ( 0 == $aid ) {
230 $retVal = $this->makeBrokenLinkObj( $nt, $text, $query, $trail, $prefix );
231 } else {
232 $threshold = $wgUser->getOption('stubthreshold') ;
233 if ( $threshold > 0 ) {
234 $dbr =& wfGetDB( DB_SLAVE );
235 $s = $dbr->selectRow(
236 array( 'page' ),
237 array( 'page_len',
238 'page_namespace',
239 'page_is_redirect' ),
240 array( 'page_id' => $aid ), $fname ) ;
241 if ( $s !== false ) {
242 $size = $s->page_len;
243 if ( $s->page_is_redirect OR $s->page_namespace != NS_MAIN ) {
244 $size = $threshold*2 ; # Really big
245 }
246 } else {
247 $size = $threshold*2 ; # Really big
248 }
249 } else {
250 $size = 1 ;
251 }
252 if ( $size < $threshold ) {
253 $retVal = $this->makeStubLinkObj( $nt, $text, $query, $trail, $prefix );
254 } else {
255 $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
256 }
257 }
258 wfProfileOut( $fname.'-immediate' );
259 }
260 wfProfileOut( $fname );
261 return $retVal;
262 }
263
264 /**
265 * Pass a title object, not a title string
266 */
267 function makeKnownLinkObj( &$nt, $text = '', $query = '', $trail = '', $prefix = '' , $aprops = '' ) {
268 global $wgOut, $wgTitle, $wgInputEncoding;
269
270 $fname = 'Skin::makeKnownLinkObj';
271 wfProfileIn( $fname );
272
273 if ( !is_object( $nt ) ) {
274 wfProfileIn( $fname );
275 return $text;
276 }
277
278 $u = $nt->escapeLocalURL( $query );
279 if ( '' != $nt->getFragment() ) {
280 if( $nt->getPrefixedDbkey() == '' ) {
281 $u = '';
282 if ( '' == $text ) {
283 $text = htmlspecialchars( $nt->getFragment() );
284 }
285 }
286 $anchor = urlencode( do_html_entity_decode( str_replace(' ', '_', $nt->getFragment()), ENT_COMPAT, $wgInputEncoding ) );
287 $replacearray = array(
288 '%3A' => ':',
289 '%' => '.'
290 );
291 $u .= '#' . str_replace(array_keys($replacearray),array_values($replacearray),$anchor);
292 }
293 if ( '' == $text ) {
294 $text = htmlspecialchars( $nt->getPrefixedText() );
295 }
296 $style = $this->getInternalLinkAttributesObj( $nt, $text );
297
298 $inside = '';
299 if ( '' != $trail ) {
300 if ( preg_match( $this->linktrail, $trail, $m ) ) {
301 $inside = $m[1];
302 $trail = $m[2];
303 }
304 }
305 $r = "<a href=\"{$u}\"{$style}{$aprops}>{$prefix}{$text}{$inside}</a>{$trail}";
306 wfProfileOut( $fname );
307 return $r;
308 }
309
310 /**
311 * Pass a title object, not a title string
312 */
313 function makeBrokenLinkObj( &$nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
314 # Fail gracefully
315 if ( ! isset($nt) ) {
316 # wfDebugDieBacktrace();
317 return "<!-- ERROR -->{$prefix}{$text}{$trail}";
318 }
319
320 $fname = 'Skin::makeBrokenLinkObj';
321 wfProfileIn( $fname );
322
323 if ( '' == $query ) {
324 $q = 'action=edit';
325 } else {
326 $q = 'action=edit&'.$query;
327 }
328 $u = $nt->escapeLocalURL( $q );
329
330 if ( '' == $text ) {
331 $text = htmlspecialchars( $nt->getPrefixedText() );
332 }
333 $style = $this->getInternalLinkAttributesObj( $nt, $text, "yes" );
334
335 $inside = '';
336 if ( '' != $trail ) {
337 if ( preg_match( $this->linktrail, $trail, $m ) ) {
338 $inside = $m[1];
339 $trail = $m[2];
340 }
341 }
342 $s = "<a href=\"{$u}\"{$style}>{$prefix}{$text}{$inside}</a>{$trail}";
343
344 wfProfileOut( $fname );
345 return $s;
346 }
347
348 /**
349 * Pass a title object, not a title string
350 */
351 function makeStubLinkObj( &$nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
352 $link = $nt->getPrefixedURL();
353
354 $u = $nt->escapeLocalURL( $query );
355
356 if ( '' == $text ) {
357 $text = htmlspecialchars( $nt->getPrefixedText() );
358 }
359 $style = $this->getInternalLinkAttributesObj( $nt, $text, 'stub' );
360
361 $inside = '';
362 if ( '' != $trail ) {
363 if ( preg_match( $this->linktrail, $trail, $m ) ) {
364 $inside = $m[1];
365 $trail = $m[2];
366 }
367 }
368 $s = "<a href=\"{$u}\"{$style}>{$prefix}{$text}{$inside}</a>{$trail}";
369 return $s;
370 }
371
372 /** @todo document */
373 function makeSelfLinkObj( &$nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
374 $u = $nt->escapeLocalURL( $query );
375 if ( '' == $text ) {
376 $text = htmlspecialchars( $nt->getPrefixedText() );
377 }
378 $inside = '';
379 if ( '' != $trail ) {
380 if ( preg_match( $this->linktrail, $trail, $m ) ) {
381 $inside = $m[1];
382 $trail = $m[2];
383 }
384 }
385 return "<strong>{$prefix}{$text}{$inside}</strong>{$trail}";
386 }
387
388 /** @todo document */
389 function fnamePart( $url ) {
390 $basename = strrchr( $url, '/' );
391 if ( false === $basename ) {
392 $basename = $url;
393 } else {
394 $basename = substr( $basename, 1 );
395 }
396 return htmlspecialchars( $basename );
397 }
398
399 /** @todo document */
400 function makeImage( $url, $alt = '' ) {
401 global $wgOut;
402 if ( '' == $alt ) {
403 $alt = $this->fnamePart( $url );
404 }
405 $s = '<img src="'.$url.'" alt="'.$alt.'" />';
406 return $s;
407 }
408
409 /** @todo document */
410 function makeImageLink( $name, $url, $alt = '' ) {
411 $nt = Title::makeTitleSafe( NS_IMAGE, $name );
412 return $this->makeImageLinkObj( $nt, $alt );
413 }
414
415 /** @todo document */
416 function makeImageLinkObj( $nt, $alt = '' ) {
417 global $wgContLang, $wgUseImageResize;
418 global $wgUser, $wgThumbLimits;
419
420 $img = new Image( $nt );
421 $url = $img->getViewURL();
422
423 $align = '';
424 $prefix = $postfix = '';
425
426 # Check if the alt text is of the form "options|alt text"
427 # Options are:
428 # * thumbnail make a thumbnail with enlarge-icon and caption, alignment depends on lang
429 # * left no resizing, just left align. label is used for alt= only
430 # * right same, but right aligned
431 # * none same, but not aligned
432 # * ___px scale to ___ pixels width, no aligning. e.g. use in taxobox
433 # * center center the image
434 # * framed Keep original image size, no magnify-button.
435
436 $part = explode( '|', $alt);
437
438 $mwThumb =& MagicWord::get( MAG_IMG_THUMBNAIL );
439 $mwLeft =& MagicWord::get( MAG_IMG_LEFT );
440 $mwRight =& MagicWord::get( MAG_IMG_RIGHT );
441 $mwNone =& MagicWord::get( MAG_IMG_NONE );
442 $mwWidth =& MagicWord::get( MAG_IMG_WIDTH );
443 $mwCenter =& MagicWord::get( MAG_IMG_CENTER );
444 $mwFramed =& MagicWord::get( MAG_IMG_FRAMED );
445 $alt = '';
446
447 $height = $framed = $thumb = false;
448 $manual_thumb = "" ;
449
450 foreach( $part as $key => $val ) {
451 $val_parts = explode ( "=" , $val , 2 ) ;
452 $left_part = array_shift ( $val_parts ) ;
453 if ( $wgUseImageResize && ! is_null( $mwThumb->matchVariableStartToEnd($val) ) ) {
454 $thumb=true;
455 } elseif ( $wgUseImageResize && count ( $val_parts ) == 1 && ! is_null( $mwThumb->matchVariableStartToEnd($left_part) ) ) {
456 # use manually specified thumbnail
457 $thumb=true;
458 $manual_thumb = array_shift ( $val_parts ) ;
459 } elseif ( ! is_null( $mwRight->matchVariableStartToEnd($val) ) ) {
460 # remember to set an alignment, don't render immediately
461 $align = 'right';
462 } elseif ( ! is_null( $mwLeft->matchVariableStartToEnd($val) ) ) {
463 # remember to set an alignment, don't render immediately
464 $align = 'left';
465 } elseif ( ! is_null( $mwCenter->matchVariableStartToEnd($val) ) ) {
466 # remember to set an alignment, don't render immediately
467 $align = 'center';
468 } elseif ( ! is_null( $mwNone->matchVariableStartToEnd($val) ) ) {
469 # remember to set an alignment, don't render immediately
470 $align = 'none';
471 } elseif ( $wgUseImageResize && ! is_null( $match = $mwWidth->matchVariableStartToEnd($val) ) ) {
472 # $match is the image width in pixels
473 if ( preg_match( '/^([0-9]*)x([0-9]*)$/', $match, $m ) ) {
474 $width = intval( $m[1] );
475 $height = intval( $m[2] );
476 } else {
477 $width = intval($match);
478 }
479 } elseif ( ! is_null( $mwFramed->matchVariableStartToEnd($val) ) ) {
480 $framed=true;
481 } else {
482 $alt = $val;
483 }
484 }
485 if ( 'center' == $align )
486 {
487 $prefix = '<div class="center">';
488 $postfix = '</div>';
489 $align = 'none';
490 }
491
492 if ( $thumb || $framed ) {
493
494 # Create a thumbnail. Alignment depends on language
495 # writing direction, # right aligned for left-to-right-
496 # languages ("Western languages"), left-aligned
497 # for right-to-left-languages ("Semitic languages")
498 #
499 # If thumbnail width has not been provided, it is set
500 # to the default user option as specified in Language*.php
501 if ( $align == '' ) {
502 $align = $wgContLang->isRTL() ? 'left' : 'right';
503 }
504
505
506 if ( ! isset($width) ) {
507 $wopt = $wgUser->getOption( 'thumbsize' );
508
509 if( !isset( $wgThumbLimits[$wopt] ) ) {
510 $wopt = User::getDefaultOption( 'thumbsize' );
511 }
512
513 $width = $wgThumbLimits[$wopt];
514 }
515
516 return $prefix.$this->makeThumbLinkObj( $img, $alt, $align, $width, $height, $framed, $manual_thumb ).$postfix;
517
518 } elseif ( isset($width) ) {
519
520 # Create a resized image, without the additional thumbnail
521 # features
522
523 if ( ( ! $height === false )
524 && ( $img->getHeight() * $width / $img->getWidth() > $height ) ) {
525 $width = $img->getWidth() * $height / $img->getHeight();
526 }
527 if ( '' == $manual_thumb ) $url = $img->createThumb( $width );
528 }
529
530 # FIXME: This is a gross hack using a global.
531 # Replace link color holders in the caption text so the
532 # text portion can be placed int the alt/title attributes.
533 global $wgParser;
534 $wgParser->replaceLinkHolders( $alt );
535
536 $alt = Sanitizer::stripAllTags( $alt );
537
538 $u = $nt->escapeLocalURL();
539 if ( $url == '' ) {
540 $s = wfMsg( 'missingimage', $img->getName() );
541 $s .= "<br />{$alt}<br />{$url}<br />\n";
542 } else {
543 $s = '<a href="'.$u.'" class="image" title="'.$alt.'">' .
544 '<img src="'.$url.'" alt="'.$alt.'" longdesc="'.$u.'" /></a>';
545 }
546 if ( '' != $align ) {
547 $s = "<div class=\"float{$align}\"><span>{$s}</span></div>";
548 }
549 return str_replace("\n", ' ',$prefix.$s.$postfix);
550 }
551
552 /**
553 * Make HTML for a thumbnail including image, border and caption
554 * $img is an Image object
555 */
556 function makeThumbLinkObj( $img, $label = '', $align = 'right', $boxwidth = 180, $boxheight=false, $framed=false , $manual_thumb = "" ) {
557 global $wgStylePath, $wgContLang;
558 # $image = Title::makeTitleSafe( NS_IMAGE, $name );
559 $url = $img->getViewURL();
560
561 #$label = htmlspecialchars( $label );
562 $alt = Sanitizer::stripAllTags( $label );
563
564 $width = $height = 0;
565 if ( $img->exists() )
566 {
567 $width = $img->getWidth();
568 $height = $img->getHeight();
569 }
570 if ( 0 == $width || 0 == $height )
571 {
572 $width = $height = 200;
573 }
574 if ( $boxwidth == 0 )
575 {
576 $boxwidth = 200;
577 }
578 if ( $framed )
579 {
580 // Use image dimensions, don't scale
581 $boxwidth = $width;
582 $oboxwidth = $boxwidth + 2;
583 $boxheight = $height;
584 $thumbUrl = $url;
585 } else {
586 $h = intval( $height/($width/$boxwidth) );
587 $oboxwidth = $boxwidth + 2;
588 if ( ( ! $boxheight === false ) && ( $h > $boxheight ) )
589 {
590 $boxwidth *= $boxheight/$h;
591 } else {
592 $boxheight = $h;
593 }
594 if ( '' == $manual_thumb ) $thumbUrl = $img->createThumb( $boxwidth );
595 }
596
597 if ( $manual_thumb != '' ) # Use manually specified thumbnail
598 {
599 $manual_title = Title::makeTitleSafe( NS_IMAGE, $manual_thumb ); #new Title ( $manual_thumb ) ;
600 $manual_img = new Image( $manual_title );
601 $thumbUrl = $manual_img->getViewURL();
602 if ( $manual_img->exists() )
603 {
604 $width = $manual_img->getWidth();
605 $height = $manual_img->getHeight();
606 $boxwidth = $width ;
607 $boxheight = $height ;
608 $oboxwidth = $boxwidth + 2 ;
609 }
610 }
611
612 $u = $img->getEscapeLocalURL();
613
614 $more = htmlspecialchars( wfMsg( 'thumbnail-more' ) );
615 $magnifyalign = $wgContLang->isRTL() ? 'left' : 'right';
616 $textalign = $wgContLang->isRTL() ? ' style="text-align:right"' : '';
617
618 $s = "<div class=\"thumb t{$align}\"><div style=\"width:{$oboxwidth}px;\">";
619 if ( $thumbUrl == '' ) {
620 $s .= wfMsg( 'missingimage', $img->getName() );
621 $zoomicon = '';
622 } else {
623 $s .= '<a href="'.$u.'" class="internal" title="'.$alt.'">'.
624 '<img src="'.$thumbUrl.'" alt="'.$alt.'" ' .
625 'width="'.$boxwidth.'" height="'.$boxheight.'" ' .
626 'longdesc="'.$u.'" /></a>';
627 if ( $framed ) {
628 $zoomicon="";
629 } else {
630 $zoomicon = '<div class="magnify" style="float:'.$magnifyalign.'">'.
631 '<a href="'.$u.'" class="internal" title="'.$more.'">'.
632 '<img src="'.$wgStylePath.'/common/images/magnify-clip.png" ' .
633 'width="15" height="11" alt="'.$more.'" /></a></div>';
634 }
635 }
636 $s .= ' <div class="thumbcaption" '.$textalign.'>'.$zoomicon.$label."</div></div></div>";
637 return str_replace("\n", ' ', $s);
638 }
639
640 /** @todo document */
641 function makeMediaLink( $name, $url, $alt = '' ) {
642 $nt = Title::makeTitleSafe( NS_IMAGE, $name );
643 return $this->makeMediaLinkObj( $nt, $alt );
644 }
645
646 /**
647 * Create a direct link to a given uploaded file.
648 *
649 * @param Title $title
650 * @param string $text pre-sanitized HTML
651 * @param bool $nourl Mask absolute URLs, so the parser doesn't
652 * linkify them (it is currently not context-aware)
653 * @return string HTML
654 *
655 * @access public
656 * @todo Handle invalid or missing images better.
657 */
658 function makeMediaLinkObj( $title, $text = '', $nourl=false ) {
659 if( is_null( $title ) ) {
660 ### HOTFIX. Instead of breaking, return empty string.
661 return $text;
662 } else {
663 $name = $title->getDBKey();
664 $img = new Image( $title );
665 $url = $img->getURL();
666 if( $nourl ) {
667 $url = str_replace( "http://", "http-noparse://", $url );
668 }
669 $alt = htmlspecialchars( $title->getText() );
670 if( $text == '' ) {
671 $text = $alt;
672 }
673 $u = htmlspecialchars( $url );
674 return "<a href=\"{$u}\" class='internal' title=\"{$alt}\">{$text}</a>";
675 }
676 }
677
678 /** @todo document */
679 function specialLink( $name, $key = '' ) {
680 global $wgContLang;
681
682 if ( '' == $key ) { $key = strtolower( $name ); }
683 $pn = $wgContLang->ucfirst( $name );
684 return $this->makeKnownLink( $wgContLang->specialPage( $pn ),
685 wfMsg( $key ) );
686 }
687
688 /** @todo document */
689 function makeExternalLink( $url, $text, $escape = true, $linktype = '' ) {
690 $style = $this->getExternalLinkAttributes( $url, $text, 'external ' . $linktype );
691 global $wgNoFollowLinks;
692 if( $wgNoFollowLinks ) {
693 $style .= ' rel="nofollow"';
694 }
695 $url = htmlspecialchars( $url );
696 if( $escape ) {
697 $text = htmlspecialchars( $text );
698 }
699 return '<a href="'.$url.'"'.$style.'>'.$text.'</a>';
700 }
701
702 /**
703 * This function is called by all recent changes variants, by the page history,
704 * and by the user contributions list. It is responsible for formatting edit
705 * comments. It escapes any HTML in the comment, but adds some CSS to format
706 * auto-generated comments (from section editing) and formats [[wikilinks]].
707 *
708 * The &$title parameter must be a title OBJECT. It is used to generate a
709 * direct link to the section in the autocomment.
710 * @author Erik Moeller <moeller@scireview.de>
711 *
712 * Note: there's not always a title to pass to this function.
713 * Since you can't set a default parameter for a reference, I've turned it
714 * temporarily to a value pass. Should be adjusted further. --brion
715 */
716 function formatComment($comment, $title = NULL) {
717 $fname = 'Skin::formatComment';
718 wfProfileIn( $fname );
719
720 global $wgContLang;
721 $comment = str_replace( "\n", " ", $comment );
722 $comment = htmlspecialchars( $comment );
723
724 # The pattern for autogen comments is / * foo * /, which makes for
725 # some nasty regex.
726 # We look for all comments, match any text before and after the comment,
727 # add a separator where needed and format the comment itself with CSS
728 while (preg_match('/(.*)\/\*\s*(.*?)\s*\*\/(.*)/', $comment,$match)) {
729 $pre=$match[1];
730 $auto=$match[2];
731 $post=$match[3];
732 $link='';
733 if($title) {
734 $section=$auto;
735
736 # This is hackish but should work in most cases.
737 $section=str_replace('[[','',$section);
738 $section=str_replace(']]','',$section);
739 $title->mFragment=$section;
740 $link=$this->makeKnownLinkObj($title,wfMsg('sectionlink'));
741 }
742 $sep='-';
743 $auto=$link.$auto;
744 if($pre) { $auto = $sep.' '.$auto; }
745 if($post) { $auto .= ' '.$sep; }
746 $auto='<span class="autocomment">'.$auto.'</span>';
747 $comment=$pre.$auto.$post;
748 }
749
750 # format regular and media links - all other wiki formatting
751 # is ignored
752 $medians = $wgContLang->getNsText( NS_MEDIA ) . ':';
753 while(preg_match('/\[\[(.*?)(\|(.*?))*\]\](.*)$/',$comment,$match)) {
754 # Handle link renaming [[foo|text]] will show link as "text"
755 if( "" != $match[3] ) {
756 $text = $match[3];
757 } else {
758 $text = $match[1];
759 }
760 if( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
761 # Media link; trail not supported.
762 $linkRegexp = '/\[\[(.*?)\]\]/';
763 $thelink = $this->makeMediaLink( $submatch[1], "", $text );
764 } else {
765 # Other kind of link
766 if( preg_match( wfMsgForContent( "linktrail" ), $match[4], $submatch ) ) {
767 $trail = $submatch[1];
768 } else {
769 $trail = "";
770 }
771 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
772 if ($match[1][0] == ':')
773 $match[1] = substr($match[1], 1);
774 $thelink = $this->makeLink( $match[1], $text, "", $trail );
775 }
776 $comment = preg_replace( $linkRegexp, $thelink, $comment, 1 );
777 }
778 wfProfileOut( $fname );
779 return $comment;
780 }
781
782 /**
783 * Wrap a comment in standard punctuation and formatting if
784 * it's non-empty, otherwise return empty string.
785 *
786 * @param string $comment
787 * @param Title $title
788 * @return string
789 * @access public
790 */
791 function commentBlock( $comment, $title = NULL ) {
792 if( $comment == '' || $comment == '*' ) {
793 return '';
794 } else {
795 $formatted = $this->formatComment( $comment, $title );
796 return " <span class='comment'>($formatted)</span>";
797 }
798 }
799
800 /** @todo document */
801 function tocIndent() {
802 return "\n<ul>";
803 }
804
805 /** @todo document */
806 function tocUnindent($level) {
807 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level>0 ? $level : 0 );
808 }
809
810 /**
811 * parameter level defines if we are on an indentation level
812 */
813 function tocLine( $anchor, $tocline, $tocnumber, $level ) {
814 return "\n<li class='toclevel-$level'><a href=\"#" .
815 $anchor . '"><span class="tocnumber">' .
816 $tocnumber . '</span> <span class="toctext">' .
817 $tocline . '</span></a>';
818 }
819
820 /** @todo document */
821 function tocLineEnd() {
822 return "</li>\n";
823 }
824
825 /** @todo document */
826 function tocList($toc) {
827 return "<div id='toc'>\n"
828 . "<div id='toctitle'><h2>" . wfMsg('toc') . "</h2></div>\n"
829 . $toc
830 . "</ul>\n</div>\n"
831 . '<script type="text/javascript">'
832 . ' if (window.showTocToggle) {'
833 . ' var tocShowText = "' . addslashes( wfMsg('showtoc') ) . '";'
834 . ' var tocHideText = "' . addslashes( wfMsg('hidetoc') ) . '"; '
835 . ' showTocToggle();'
836 . ' } '
837 . '</script>'
838 . "<div class='visualClear'></div>\n";
839 }
840
841 /** @todo document */
842 function editSectionLinkForOther( $title, $section ) {
843 global $wgRequest;
844 global $wgContLang;
845
846 $title = Title::newFromText($title);
847 $editurl = '&section='.$section;
848 $url = $this->makeKnownLink($title->getPrefixedText(),wfMsg('editsection'),'action=edit'.$editurl);
849
850 if( $wgContLang->isRTL() ) {
851 $farside = 'left';
852 $nearside = 'right';
853 } else {
854 $farside = 'right';
855 $nearside = 'left';
856 }
857 return "<div class=\"editsection\" style=\"float:$farside;margin-$nearside:5px;\">[".$url."]</div>";
858
859 }
860
861 /** @todo document */
862 function editSectionLink( $nt, $section ) {
863 global $wgRequest;
864 global $wgContLang;
865
866 if( $wgRequest->getInt( 'oldid' ) && ( $wgRequest->getVal( 'diff' ) != '0' ) ) {
867 # Section edit links would be out of sync on an old page.
868 # But, if we're diffing to the current page, they'll be
869 # correct.
870 return '';
871 }
872
873 $editurl = '&section='.$section;
874 $url = $this->makeKnownLink($nt->getPrefixedText(),wfMsg('editsection'),'action=edit'.$editurl);
875
876 if( $wgContLang->isRTL() ) {
877 $farside = 'left';
878 $nearside = 'right';
879 } else {
880 $farside = 'right';
881 $nearside = 'left';
882 }
883 return "<div class=\"editsection\" style=\"float:$farside;margin-$nearside:5px;\">[".$url."]</div>";
884 }
885 }
886 ?>