1 // MediaWiki JavaScript support functions
3 window
.clientPC
= navigator
.userAgent
.toLowerCase(); // Get client info
4 window
.is_gecko
= /gecko/.test( clientPC
) &&
5 !/khtml|spoofer|netscape\/7\.0/.test(clientPC
);
7 window
.is_safari
= window
.is_safari_win
= window
.webkit_version
=
8 window
.is_chrome
= window
.is_chrome_mac
= false;
9 window
.webkit_match
= clientPC
.match(/applewebkit\/(\d+)/);
11 window
.is_safari
= clientPC
.indexOf('applewebkit') != -1 &&
12 clientPC
.indexOf('spoofer') == -1;
13 window
.is_safari_win
= is_safari
&& clientPC
.indexOf('windows') != -1;
14 window
.webkit_version
= parseInt(webkit_match
[1]);
15 // Tests for chrome here, to avoid breaking old scripts safari left alone
16 // This is here for accesskeys
17 window
.is_chrome
= clientPC
.indexOf('chrome') !== -1 &&
18 clientPC
.indexOf('spoofer') === -1;
19 window
.is_chrome_mac
= is_chrome
&& clientPC
.indexOf('mac') !== -1
22 // For accesskeys; note that FF3+ is included here!
23 window
.is_ff2
= /firefox\/[2-9]|minefield\/3/.test( clientPC
);
24 window
.ff2_bugs
= /firefox\/2/.test( clientPC
);
25 // These aren't used here, but some custom scripts rely on them
26 window
.is_ff2_win
= is_ff2
&& clientPC
.indexOf('windows') != -1;
27 window
.is_ff2_x11
= is_ff2
&& clientPC
.indexOf('x11') != -1;
29 window
.is_opera
= window
.is_opera_preseven
= window
.is_opera_95
=
30 window
.opera6_bugs
= window
.opera7_bugs
= window
.opera95_bugs
= false;
31 if (clientPC
.indexOf('opera') != -1) {
32 window
.is_opera
= true;
33 window
.is_opera_preseven
= window
.opera
&& !document
.childNodes
;
34 window
.is_opera_seven
= window
.opera
&& document
.childNodes
;
35 window
.is_opera_95
= /opera\/(9\.[5-9]|[1-9][0-9])/.test( clientPC
);
36 window
.opera6_bugs
= is_opera_preseven
;
37 window
.opera7_bugs
= is_opera_seven
&& !is_opera_95
;
38 window
.opera95_bugs
= /opera\/(9\.5)/.test( clientPC
);
40 // As recommended by <http://msdn.microsoft.com/en-us/library/ms537509.aspx>,
41 // avoiding false positives from moronic extensions that append to the IE UA
43 window
.ie6_bugs
= false;
44 if ( /msie ([0-9]{1,}[\.0-9]{0,})/.exec( clientPC
) != null
45 && parseFloat( RegExp
.$1 ) <= 6.0 ) {
49 // Global external objects used by this script.
50 /*extern ta, stylepath, skin */
52 // add any onload functions in this hook (please don't hard-code any events in the xhtml source)
53 window
.doneOnloadHook
= undefined;
55 if (!window
.onloadFuncts
) {
56 window
.onloadFuncts
= [];
59 window
.addOnloadHook = function( hookFunct
) {
60 // Allows add-on scripts to add onload functions
61 if( !doneOnloadHook
) {
62 onloadFuncts
[onloadFuncts
.length
] = hookFunct
;
64 hookFunct(); // bug in MSIE script loading
68 window
.importScript = function( page
) {
69 // TODO: might want to introduce a utility function to match wfUrlencode() in PHP
70 var uri
= wgScript
+ '?title=' +
71 encodeURIComponent(page
.replace(/ /g,'_')).replace(/%2F
/ig,'/').replace(/%3A/ig,':') +
72 '&action
=raw
&ctype
=text
/javascript
';
73 return importScriptURI( uri );
76 window.loadedScripts = {}; // included-scripts tracker
77 window.importScriptURI = function( url ) {
78 if ( loadedScripts[url] ) {
81 loadedScripts[url] = true;
82 var s = document.createElement( 'script
' );
83 s.setAttribute( 'src
', url );
84 s.setAttribute( 'type
', 'text
/javascript
' );
85 document.getElementsByTagName('head
')[0].appendChild( s );
89 window.importStylesheet = function( page ) {
90 return importStylesheetURI( wgScript + '?action
=raw
&ctype
=text
/css&title=' + encodeURIComponent( page.replace(/ /g
,'_') ) );
93 window
.importStylesheetURI = function( url
, media
) {
94 var l
= document
.createElement( 'link' );
101 document
.getElementsByTagName('head')[0].appendChild( l
);
105 window
.appendCSS = function( text
) {
106 var s
= document
.createElement( 'style' );
108 s
.rel
= 'stylesheet';
109 if ( s
.styleSheet
) {
110 s
.styleSheet
.cssText
= text
; // IE
112 s
.appendChild( document
.createTextNode( text
+ '' ) ); // Safari sometimes borks on null
114 document
.getElementsByTagName('head')[0].appendChild( s
);
118 // Special stylesheet links for Monobook only (see bug 14717)
119 if ( typeof stylepath
!= 'undefined' && skin
== 'monobook' ) {
121 importStylesheetURI( stylepath
+ '/' + skin
+ '/Opera6Fixes.css' );
122 } else if ( opera7_bugs
) {
123 importStylesheetURI( stylepath
+ '/' + skin
+ '/Opera7Fixes.css' );
124 } else if ( opera95_bugs
) {
125 importStylesheetURI( stylepath
+ '/' + skin
+ '/Opera9Fixes.css' );
126 } else if ( ff2_bugs
) {
127 importStylesheetURI( stylepath
+ '/' + skin
+ '/FF2Fixes.css' );
132 if ( 'wgBreakFrames' in window
&& window
.wgBreakFrames
) {
133 // Un-trap us from framesets
134 if ( window
.top
!= window
) {
135 window
.top
.location
= window
.location
;
139 window
.changeText = function( el
, newText
) {
140 // Safari work around
141 if ( el
.innerText
) {
142 el
.innerText
= newText
;
143 } else if ( el
.firstChild
&& el
.firstChild
.nodeValue
) {
144 el
.firstChild
.nodeValue
= newText
;
148 window
.killEvt = function( evt
) {
149 evt
= evt
|| window
.event
|| window
.Event
; // W3C, IE, Netscape
150 if ( typeof ( evt
.preventDefault
) != 'undefined' ) {
151 evt
.preventDefault(); // Don't follow the link
152 evt
.stopPropagation();
154 evt
.cancelBubble
= true; // IE
156 return false; // Don't follow the link (IE)
159 window
.mwEditButtons
= [];
160 window
.mwCustomEditButtons
= []; // eg to add in MediaWiki:Common.js
162 window
.escapeQuotes = function( text
) {
163 var re
= new RegExp( "'", "g" );
164 text
= text
.replace( re
, "\\'" );
165 re
= new RegExp( "\\n", "g" );
166 text
= text
.replace( re
, "\\n" );
167 return escapeQuotesHTML( text
);
170 window
.escapeQuotesHTML = function( text
) {
171 var re
= new RegExp( '&', "g" );
172 text
= text
.replace( re
, "&" );
173 re
= new RegExp( '"', "g" );
174 text
= text
.replace( re
, """ );
175 re
= new RegExp( '<', "g" );
176 text
= text
.replace( re
, "<" );
177 re
= new RegExp( '>', "g" );
178 text
= text
.replace( re
, ">" );
183 * Set the accesskey prefix based on browser detection.
185 window
.tooltipAccessKeyPrefix
= 'alt-';
187 tooltipAccessKeyPrefix
= 'shift-esc-';
188 } else if ( is_chrome
) {
189 tooltipAccessKeyPrefix
= is_chrome_mac
? 'ctrl-option-' : 'alt-';
190 } else if ( !is_safari_win
&& is_safari
&& webkit_version
> 526 ) {
191 tooltipAccessKeyPrefix
= 'ctrl-alt-';
192 } else if ( !is_safari_win
&& ( is_safari
193 || clientPC
.indexOf('mac') != -1
194 || clientPC
.indexOf('konqueror') != -1 ) ) {
195 tooltipAccessKeyPrefix
= 'ctrl-';
196 } else if ( is_ff2
) {
197 tooltipAccessKeyPrefix
= 'alt-shift-';
199 window
.tooltipAccessKeyRegexp
= /\[(ctrl-)?(alt-)?(shift-)?(esc-)?(.)\]$/;
202 * Add the appropriate prefix to the accesskey shown in the tooltip.
203 * If the nodeList parameter is given, only those nodes are updated;
204 * otherwise, all the nodes that will probably have accesskeys by
205 * default are updated.
207 * @param nodeList Array list of elements to update
209 window
.updateTooltipAccessKeys = function( nodeList
) {
211 // Rather than scan all links on the whole page, we can just scan these
212 // containers which contain the relevant links. This is really just an
213 // optimization technique.
214 var linkContainers
= [
215 'column-one', // Monobook and Modern
216 'mw-head', 'mw-panel', 'p-logo' // Vector
218 for ( var i
in linkContainers
) {
219 var linkContainer
= document
.getElementById( linkContainers
[i
] );
220 if ( linkContainer
) {
221 updateTooltipAccessKeys( linkContainer
.getElementsByTagName( 'a' ) );
224 // these are rare enough that no such optimization is needed
225 updateTooltipAccessKeys( document
.getElementsByTagName( 'input' ) );
226 updateTooltipAccessKeys( document
.getElementsByTagName( 'label' ) );
230 for ( var i
= 0; i
< nodeList
.length
; i
++ ) {
231 var element
= nodeList
[i
];
232 var tip
= element
.getAttribute( 'title' );
233 if ( tip
&& tooltipAccessKeyRegexp
.exec( tip
) ) {
234 tip
= tip
.replace(tooltipAccessKeyRegexp
,
235 '[' + tooltipAccessKeyPrefix
+ "$5]");
236 element
.setAttribute( 'title', tip
);
242 * Add a link to one of the portlet menus on the page, including:
244 * p-cactions: Content actions (shown as tabs above the main content in Monobook)
245 * p-personal: Personal tools (shown at the top right of the page in Monobook)
246 * p-navigation: Navigation
249 * This function exists for the convenience of custom JS authors. All
250 * but the first three parameters are optional, though providing at
251 * least an id and a tooltip is recommended.
253 * By default the new link will be added to the end of the list. To
254 * add the link before a given existing item, pass the DOM node of
255 * that item (easily obtained with document.getElementById()) as the
256 * nextnode parameter; to add the link _after_ an existing item, pass
257 * the node's nextSibling instead.
259 * @param portlet String id of the target portlet ("p-cactions", "p-personal", "p-navigation" or "p-tb")
260 * @param href String link URL
261 * @param text String link text (will be automatically lowercased by CSS for p-cactions in Monobook)
262 * @param id String id of the new item, should be unique and preferably have the appropriate prefix ("ca-", "pt-", "n-" or "t-")
263 * @param tooltip String text to show when hovering over the link, without accesskey suffix
264 * @param accesskey String accesskey to activate this link (one character, try to avoid conflicts)
265 * @param nextnode Node the DOM node before which the new item should be added, should be another item in the same list
267 * @return Node -- the DOM node of the new item (an LI element) or null
269 window
.addPortletLink = function( portlet
, href
, text
, id
, tooltip
, accesskey
, nextnode
) {
270 var root
= document
.getElementById( portlet
);
274 var uls
= root
.getElementsByTagName( 'ul' );
276 if ( uls
.length
> 0 ) {
279 node
= document
.createElement( 'ul' );
280 var lastElementChild
= null;
281 for ( var i
= 0; i
< root
.childNodes
.length
; ++i
) { /* get root.lastElementChild */
282 if ( root
.childNodes
[i
].nodeType
== 1 ) {
283 lastElementChild
= root
.childNodes
[i
];
286 if ( lastElementChild
&& lastElementChild
.nodeName
.match( /div/i ) ) {
287 /* Insert into the menu divs */
288 lastElementChild
.appendChild( node
);
290 root
.appendChild( node
);
297 // unhide portlet if it was hidden before
298 root
.className
= root
.className
.replace( /(^| )emptyPortlet( |$)/, "$2" );
300 var link
= document
.createElement( 'a' );
301 link
.appendChild( document
.createTextNode( text
) );
304 // Wrap in a span - make it work with vector tabs and has no effect on any other portlets
305 var span
= document
.createElement( 'span' );
306 span
.appendChild( link
);
308 var item
= document
.createElement( 'li' );
309 item
.appendChild( span
);
315 link
.setAttribute( 'accesskey', accesskey
);
316 tooltip
+= ' [' + accesskey
+ ']';
319 link
.setAttribute( 'title', tooltip
);
321 if ( accesskey
&& tooltip
) {
322 updateTooltipAccessKeys( new Array( link
) );
325 if ( nextnode
&& nextnode
.parentNode
== node
) {
326 node
.insertBefore( item
, nextnode
);
328 node
.appendChild( item
); // IE compatibility (?)
334 window
.getInnerText = function( el
) {
335 if ( typeof el
== 'string' ) {
338 if ( typeof el
== 'undefined' ) {
341 // Custom sort value through 'data-sort-value' attribute
342 // (no need to prepend hidden text to change sort value)
343 if ( el
.nodeType
&& el
.getAttribute( 'data-sort-value' ) !== null ) {
344 // Make sure it's a valid DOM element (.nodeType) and that the attribute is set (!null)
345 return el
.getAttribute( 'data-sort-value' );
347 if ( el
.textContent
) {
348 return el
.textContent
; // not needed but it is faster
350 if ( el
.innerText
) {
351 return el
.innerText
; // IE doesn't have textContent
355 var cs
= el
.childNodes
;
357 for ( var i
= 0; i
< l
; i
++ ) {
358 switch ( cs
[i
].nodeType
) {
359 case 1: // ELEMENT_NODE
360 str
+= getInnerText( cs
[i
] );
363 str
+= cs
[i
].nodeValue
;
370 /* Dummy for deprecated function */
372 window
.akeytt = function( doId
) {
375 window
.checkboxes
= undefined;
376 window
.lastCheckbox
= undefined;
378 window
.setupCheckboxShiftClick = function() {
381 var inputs
= document
.getElementsByTagName( 'input' );
382 addCheckboxClickHandlers( inputs
);
385 window
.addCheckboxClickHandlers = function( inputs
, start
) {
390 var finish
= start
+ 250;
391 if ( finish
> inputs
.length
) {
392 finish
= inputs
.length
;
395 for ( var i
= start
; i
< finish
; i
++ ) {
397 if ( !cb
.type
|| cb
.type
.toLowerCase() != 'checkbox' || ( ' ' + cb
.className
+ ' ' ).indexOf( ' noshiftselect ' ) != -1 ) {
400 var end
= checkboxes
.length
;
401 checkboxes
[end
] = cb
;
403 addClickHandler( cb
, checkboxClickHandler
);
406 if ( finish
< inputs
.length
) {
407 setTimeout( function() {
408 addCheckboxClickHandlers( inputs
, finish
);
413 window
.checkboxClickHandler = function( e
) {
414 if ( typeof e
== 'undefined' ) {
417 if ( !e
.shiftKey
|| lastCheckbox
=== null ) {
418 lastCheckbox
= this.index
;
421 var endState
= this.checked
;
423 if ( this.index
< lastCheckbox
) {
424 start
= this.index
+ 1;
425 finish
= lastCheckbox
;
427 start
= lastCheckbox
;
428 finish
= this.index
- 1;
430 for ( var i
= start
; i
<= finish
; ++i
) {
431 checkboxes
[i
].checked
= endState
;
432 if( i
> start
&& typeof checkboxes
[i
].onchange
== 'function' ) {
433 checkboxes
[i
].onchange(); // fire triggers
436 lastCheckbox
= this.index
;
442 Written by Jonathan Snook, http://www.snook.ca/jonathan
443 Add-ons by Robert Nyman, http://www.robertnyman.com
444 Author says "The credit comment is all it takes, no license. Go crazy with it!:-)"
445 From http://www.robertnyman.com/2005/11/07/the-ultimate-getelementsbyclassname/
447 window
.getElementsByClassName = function( oElm
, strTagName
, oClassNames
) {
448 var arrReturnElements
= new Array();
449 if ( typeof( oElm
.getElementsByClassName
) == 'function' ) {
450 /* Use a native implementation where possible FF3, Saf3.2, Opera 9.5 */
451 var arrNativeReturn
= oElm
.getElementsByClassName( oClassNames
);
452 if ( strTagName
== '*' ) {
453 return arrNativeReturn
;
455 for ( var h
= 0; h
< arrNativeReturn
.length
; h
++ ) {
456 if( arrNativeReturn
[h
].tagName
.toLowerCase() == strTagName
.toLowerCase() ) {
457 arrReturnElements
[arrReturnElements
.length
] = arrNativeReturn
[h
];
460 return arrReturnElements
;
462 var arrElements
= ( strTagName
== '*' && oElm
.all
) ? oElm
.all
: oElm
.getElementsByTagName( strTagName
);
463 var arrRegExpClassNames
= new Array();
464 if( typeof oClassNames
== 'object' ) {
465 for( var i
= 0; i
< oClassNames
.length
; i
++ ) {
466 arrRegExpClassNames
[arrRegExpClassNames
.length
] =
467 new RegExp("(^|\\s)" + oClassNames
[i
].replace(/\-/g, "\\-") + "(\\s|$)");
470 arrRegExpClassNames
[arrRegExpClassNames
.length
] =
471 new RegExp("(^|\\s)" + oClassNames
.replace(/\-/g, "\\-") + "(\\s|$)");
475 for( var j
= 0; j
< arrElements
.length
; j
++ ) {
476 oElement
= arrElements
[j
];
478 for( var k
= 0; k
< arrRegExpClassNames
.length
; k
++ ) {
479 if( !arrRegExpClassNames
[k
].test( oElement
.className
) ) {
485 arrReturnElements
[arrReturnElements
.length
] = oElement
;
488 return ( arrReturnElements
);
491 window
.redirectToFragment = function( fragment
) {
492 var match
= navigator
.userAgent
.match(/AppleWebKit\/(\d+)/);
494 var webKitVersion
= parseInt( match
[1] );
495 if ( webKitVersion
< 420 ) {
496 // Released Safari w/ WebKit 418.9.1 messes up horribly
497 // Nightlies of 420+ are ok
501 if ( window
.location
.hash
== '' ) {
502 window
.location
.hash
= fragment
;
504 // Mozilla needs to wait until after load, otherwise the window doesn't
505 // scroll. See <https://bugzilla.mozilla.org/show_bug.cgi?id=516293>.
506 // There's no obvious way to detect this programmatically, so we use
507 // version-testing. If Firefox fixes the bug, they'll jump twice, but
508 // better twice than not at all, so make the fix hit future versions as
511 addOnloadHook(function() {
512 if ( window
.location
.hash
== fragment
) {
513 window
.location
.hash
= fragment
;
521 * Add a cute little box at the top of the screen to inform the user of
522 * something, replacing any preexisting message.
524 * @param message String -or- Dom Object HTML to be put inside the right div
525 * @param className String Used in adding a class; should be different for each
526 * call to allow CSS/JS to hide different boxes. null = no class used.
527 * @return Boolean True on success, false on failure
529 window
.jsMsg = function( message
, className
) {
530 if ( !document
.getElementById
) {
533 // We special-case skin structures provided by the software. Skins that
534 // choose to abandon or significantly modify our formatting can just define
535 // an mw-js-message div to start with.
536 var messageDiv
= document
.getElementById( 'mw-js-message' );
538 messageDiv
= document
.createElement( 'div' );
539 if ( document
.getElementById( 'column-content' )
540 && document
.getElementById( 'content' ) ) {
541 // MonoBook, presumably
542 document
.getElementById( 'content' ).insertBefore(
544 document
.getElementById( 'content' ).firstChild
546 } else if ( document
.getElementById( 'content' )
547 && document
.getElementById( 'article' ) ) {
548 // Non-Monobook but still recognizable (old-style)
549 document
.getElementById( 'article').insertBefore(
551 document
.getElementById( 'article' ).firstChild
558 messageDiv
.setAttribute( 'id', 'mw-js-message' );
559 messageDiv
.style
.display
= 'block';
561 messageDiv
.setAttribute( 'class', 'mw-js-message-' + className
);
564 if ( typeof message
=== 'object' ) {
565 while ( messageDiv
.hasChildNodes() ) { // Remove old content
566 messageDiv
.removeChild( messageDiv
.firstChild
);
568 messageDiv
.appendChild( message
); // Append new content
570 messageDiv
.innerHTML
= message
;
576 * Inject a cute little progress spinner after the specified element
578 * @param element Element to inject after
579 * @param id Identifier string (for use with removeSpinner(), below)
581 window
.injectSpinner = function( element
, id
) {
582 var spinner
= document
.createElement( 'img' );
583 spinner
.id
= 'mw-spinner-' + id
;
584 spinner
.src
= stylepath
+ '/common/images/spinner.gif';
585 spinner
.alt
= spinner
.title
= '...';
586 if( element
.nextSibling
) {
587 element
.parentNode
.insertBefore( spinner
, element
.nextSibling
);
589 element
.parentNode
.appendChild( spinner
);
594 * Remove a progress spinner added with injectSpinner()
596 * @param id Identifier string
598 window
.removeSpinner = function( id
) {
599 var spinner
= document
.getElementById( 'mw-spinner-' + id
);
601 spinner
.parentNode
.removeChild( spinner
);
605 window
.runOnloadHook = function() {
606 // don't run anything below this for non-dom browsers
607 if ( doneOnloadHook
|| !( document
.getElementById
&& document
.getElementsByTagName
) ) {
611 // set this before running any hooks, since any errors below
612 // might cause the function to terminate prematurely
613 doneOnloadHook
= true;
615 // Run any added-on functions
616 for ( var i
= 0; i
< onloadFuncts
.length
; i
++ ) {
622 * Add an event handler to an element
624 * @param element Element to add handler to
625 * @param attach String Event to attach to
626 * @param handler callable Event handler callback
628 window
.addHandler = function( element
, attach
, handler
) {
629 if( element
.addEventListener
) {
630 element
.addEventListener( attach
, handler
, false );
631 } else if( element
.attachEvent
) {
632 element
.attachEvent( 'on' + attach
, handler
);
636 window
.hookEvent = function( hookName
, hookFunct
) {
637 addHandler( window
, hookName
, hookFunct
);
641 * Add a click event handler to an element
643 * @param element Element to add handler to
644 * @param handler callable Event handler callback
646 window
.addClickHandler = function( element
, handler
) {
647 addHandler( element
, 'click', handler
);
651 * Removes an event handler from an element
653 * @param element Element to remove handler from
654 * @param remove String Event to remove
655 * @param handler callable Event handler callback to remove
657 window
.removeHandler = function( element
, remove
, handler
) {
658 if( window
.removeEventListener
) {
659 element
.removeEventListener( remove
, handler
, false );
660 } else if( window
.detachEvent
) {
661 element
.detachEvent( 'on' + remove
, handler
);
664 // note: all skins should call runOnloadHook() at the end of html output,
665 // so the below should be redundant. It's there just in case.
666 hookEvent( 'load', runOnloadHook
);
669 importScriptURI( stylepath
+ '/common/IEFixes.js' );