MediaWiki:Common.js: Difference between revisions

Revision as of 01:45, 15 February 2018

/** extract a URL parameter from the current URL **********
 * From [[en:User:Lupin/autoedit.js]]
 *
 * paramName  : the name of the parameter to extract
 */
function getURLParamValue(paramName, url) 
{
    if (typeof (url) == 'undefined' || url === null)
        url = document.location.href;
    var cmdRe = RegExp('[&?]' + paramName + '=([^&#]*)'); // Stop at hash
    var m = cmdRe.exec(url);
    if (m && m.length > 1)
        return decodeURIComponent(m[1]);
    return null;
}
 
/** &withJS= URL parameter *******
 * Allow to try custom scripts from MediaWiki space 
 * without editing [[Special:Mypage/monobook.js]]
 */
var extraJS = getURLParamValue("withJS");
if (extraJS && extraJS.match("^MediaWiki:[^&<>=%]*\.js$"))
{
    mw.loader.load('/w/index.php?title=' + extraJS + '&action=raw&ctype=text/javascript');
}


/* Import more specific scripts if necessary */
if (mw.config.get('wgAction') === 'edit' || mw.config.get('wgAction') === 'submit' || mw.config.get('wgPageName') === 'Special:Upload') // load script specific to editing and upload pages
{
    mw.loader.load('/w/index.php?title=MediaWiki:Common.js/edit.js&action=raw&ctype=text/javascript');
}
else if (mw.config.get('wgPageName') === 'Special:Search') // load script for augmenting search page
{
    mw.loader.load('/w/index.php?title=MediaWiki:Common.js/search.js&action=raw&ctype=text/javascript');
}


/* Scripts specific to Internet Explorer */
if (navigator.appName == 'Microsoft Internet Explorer')
{
    /** Internet Explorer bug fix **************************************************
     *
     *  Description: Fixes IE horizontal scrollbar bug
     *  Maintainers: [[User:Tom-]]?
     */
    
    var oldWidth;
    var docEl = document.documentElement;
    
    var fixIEScroll = function()
    {
        if (!oldWidth || docEl.clientWidth > oldWidth)
        {
            doFixIEScroll();
        }
        else
        {
            setTimeout(doFixIEScroll, 1);
        }
        
        oldWidth = docEl.clientWidth;
    };
    
    var doFixIEScroll = function()
    {
        docEl.style.overflowX = (docEl.scrollWidth - docEl.clientWidth < 4) ? "hidden" : "";
    };
    
    document.attachEvent("onreadystatechange", fixIEScroll);
    document.attachEvent("onresize", fixIEScroll);
    
    // In print IE (7?) does not like line-height
    appendCSS('@media print {sup, sub, p, .documentDescription {line-height: normal;}}');

    // IE overflow bug
    appendCSS('div.overflowbugx {overflow-x: scroll !important; overflow-y: hidden !important;} div.overflowbugy {overflow-y: scroll !important; overflow-x: hidden !important;}');

    // IE zoomfix
    // Use to fix right floating div/table inside tables
    appendCSS('.iezoomfix div, .iezoomfix table {zoom: 1;}');
}


/* Test if an element has a certain class
 * Maintainers: [[User:Mike Dillon]], [[User:R. Koot]], [[User:SG]]
 *
 * @deprecated:  Use $(element).hasClass() instead.
 */

var hasClass = (function ()
{
    var reCache = {};
    return function (element, className)
    {
        return (reCache[className] ? reCache[className] : (reCache[className] = new RegExp("(?:\\s|^)" + className + "(?:\\s|$)"))).test(element.className);
    };
})();


/** Hover tables *********************************************************
 *
 *  Description: Allows tables to use mouse-over to provide explanation of
 *               the pointed-to content.
 *  Maintainers: [[User:Iritscen]]
 */
function showDescrip(typeID, show_or_not)
{
    var DescripPanel = document.getElementsByClassName("hovertable_descrip")[0]; /* only get 1st one on page to keep things simple */
    var Descrips = DescripPanel.getElementsByTagName("span");

    if (!DescripPanel || !Descrips)
        return false;

    for (var i = 0; i < Descrips.length; i++)
    {
        if (Descrips[i].id == typeID)
        {
            if (show_or_not)
                Descrips[i].style.display = "block";
            else
                Descrips[i].style.display = "none";
        }
    }
}

function initHoverTables()
{
    var Tables = document.getElementsByClassName("hovertable");
    if (!Tables)
        return false;

    for (var i = 0; i < Tables.length; i++)
    {
        var Cells = Tables[i].getElementsByTagName("td");
        if (!Cells) continue;

        for (var j = 0; j < Cells.length; j++)
        {
            if (hasClass(Cells[j], "hovercell"))
            {
                $(Cells[j]).mouseover(showDescrip(this.id, true));
                $(Cells[j]).mouseout(showDescrip(this.id, false));
            }
        }
    }
}

$(initHoverTables);

/** Hover GIFs *********************************************************
 *
 *  Description: Allows GIFs to only animate upon mouse-over.
 *  
 *  Maintainers: [[User:Iritscen]]
 */
function swapImage(gifID, show_gif)
{
    var gif_span = document.getElementById(gifID);
    var gif_image = gif_span.getElementsByClassName("image")[0];
    var gif_img = gif_image.getElementsByTagName("img")[0];
    var gif_src = gif_img.src;

    if (!gif_img)
        return false;

    if (show_gif)
        gif_img.src = gif_src.replace('.jpg', '.gif');
    else
        gif_img.src = gif_src.replace('.gif', '.jpg');
}

function initHoverGIFs()
{
    var gifs = document.getElementsByClassName("hovergif");

    if (!gifs)
        return false;

    for (var i = 0; i < gifs.length; i++)
    {
        $(gifs[i]).mouseover(swapImage(this.id, true));
        $(gifs[i]).mouseout(swapImage(this.id, false));
    }
}

$(initHoverGIFs);


/** Collapsible tables *********************************************************
 *
 *  Description: Allows tables to be collapsed, showing only the header. See
 *               [[Wikipedia:NavFrame]].
 *  Maintainers: [[User:R. Koot]]
 */

var autoCollapse = 2;
var collapseCaption = "hide";
var expandCaption = "show";

function collapseTable(tableIndex)
{
    var Button = document.getElementById("collapseButton" + tableIndex);
    var Table = document.getElementById("collapsibleTable" + tableIndex);

    if (!Table || !Button)
    {
        return false;
    }

    var Rows = Table.rows;

    if (Button.firstChild.data == collapseCaption)
    {
        for (var i = 1; i < Rows.length; i++)
        {
            Rows[i].style.display = "none";
        }
        Button.firstChild.data = expandCaption;
    }
    else
    {
        for (var i = 1; i < Rows.length; i++)
        {
            Rows[i].style.display = Rows[0].style.display;
        }
        Button.firstChild.data = collapseCaption;
    }
}

function createCollapseButtons()
{
    var tableIndex = 0;
    var NavigationBoxes = new Object();
    var Tables = document.getElementsByTagName("table");

    for (var i = 0; i < Tables.length; i++)
    {
        if (hasClass(Tables[i], "collapsible"))
        {
            /* only add button and increment count if there is a header row to work with */
            var HeaderRow = Tables[i].getElementsByTagName("tr")[0];
            if (!HeaderRow) continue;
            var Header = HeaderRow.getElementsByTagName("th")[0];
            if (!Header) continue;

            NavigationBoxes[tableIndex] = Tables[i];
            Tables[i].setAttribute("id", "collapsibleTable" + tableIndex);

            var Button     = document.createElement("span");
            var ButtonLink = document.createElement("a");
            var ButtonText = document.createTextNode(collapseCaption);

            Button.className = "collapseButton"; // styles are declared in Common.css

            ButtonLink.style.color = Header.style.color;
            ButtonLink.setAttribute("id", "collapseButton" + tableIndex);
            ButtonLink.setAttribute("href", "#");
            $(ButtonLink).click(new Function("evt", "collapseTable(" + tableIndex + " ); return killEvt(evt);"));
            ButtonLink.appendChild(ButtonText);

            Button.appendChild(document.createTextNode("["));
            Button.appendChild(ButtonLink);
            Button.appendChild(document.createTextNode("]"));

            Header.insertBefore(Button, Header.childNodes[0]);
            tableIndex++;
        }
    }

    for (var i = 0; i < tableIndex; i++)
    {
        if (hasClass(NavigationBoxes[i], "collapsed") || (tableIndex >= autoCollapse && hasClass(NavigationBoxes[i], "autocollapse")))
        {
            collapseTable(i);
        } 
        else if (hasClass(NavigationBoxes[i], "innercollapse"))
        {
            var element = NavigationBoxes[i];
            while (element = element.parentNode)
            {
                if (hasClass(element, "outercollapse"))
                {
                    collapseTable(i);
                    break;
                }
            }
        }
    }
}

$(createCollapseButtons);


/** Dynamic Navigation Bars (experimental) *************************************
 *
 *  Description: See [[Wikipedia:NavFrame]].
 *  Maintainers: UNMAINTAINED
 */

// set up the words in your language
var NavigationBarHide = '[' + collapseCaption + ']';
var NavigationBarShow = '[' + expandCaption + ']';

// shows and hides content and picture (if available) of navigation bars
// Parameters:
//     indexNavigationBar: the index of navigation bar to be toggled
function toggleNavigationBar(indexNavigationBar)
{
    var NavToggle = document.getElementById("NavToggle" + indexNavigationBar);
    var NavFrame = document.getElementById("NavFrame" + indexNavigationBar);

    if (!NavFrame || !NavToggle)
        return false;

    // if shown now
    if (NavToggle.firstChild.data == NavigationBarHide)
    {
        for (var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling)
        {
            if (hasClass(NavChild, 'NavContent') || hasClass(NavChild, 'NavPic'))
            {
                NavChild.style.display = 'none';
            }
        }
    NavToggle.firstChild.data = NavigationBarShow;

    // if hidden now
    }
    else if (NavToggle.firstChild.data == NavigationBarShow)
    {
        for (var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling)
        {
            if (hasClass(NavChild, 'NavContent') || hasClass(NavChild, 'NavPic'))
            {
                NavChild.style.display = 'block';
            }
        }
        NavToggle.firstChild.data = NavigationBarHide;
    }
}

// adds show/hide-button to navigation bars
function createNavigationBarToggleButton()
{
    var indexNavigationBar = 0;
    // iterate over all < div >-elements 
    var divs = document.getElementsByTagName("div");
    for (var i = 0; NavFrame = divs[i]; i++)
    {
        // if found a navigation bar
        if (hasClass(NavFrame, "NavFrame"))
        {
            indexNavigationBar++;
            var NavToggle = document.createElement("a");
            NavToggle.className = 'NavToggle';
            NavToggle.setAttribute('id', 'NavToggle' + indexNavigationBar);
            NavToggle.setAttribute('href', 'javascript:toggleNavigationBar(' + indexNavigationBar + ');');

            var isCollapsed = hasClass(NavFrame, "collapsed");
            /*
             * Check if any children are already hidden.  This loop is here for backwards compatibility:
             * the old way of making NavFrames start out collapsed was to manually add style="display:none"
             * to all the NavPic/NavContent elements.  Since this was bad for accessibility (no way to make
             * the content visible without JavaScript support), the new recommended way is to add the class
             * "collapsed" to the NavFrame itself, just like with collapsible tables.
             */
            for (var NavChild = NavFrame.firstChild; NavChild != null && !isCollapsed; NavChild = NavChild.nextSibling)
            {
                if (hasClass(NavChild, 'NavPic') || hasClass(NavChild, 'NavContent'))
                {
                    if (NavChild.style.display == 'none')
                    {
                        isCollapsed = true;
                    }
                }
            }
            if (isCollapsed)
            {
                for (var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling)
                {
                    if (hasClass(NavChild, 'NavPic') || hasClass(NavChild, 'NavContent'))
                    {
                        NavChild.style.display = 'none';
                    }
                }
            }
            var NavToggleText = document.createTextNode(isCollapsed ? NavigationBarShow : NavigationBarHide);
            NavToggle.appendChild(NavToggleText);

            // Find the NavHead and attach the toggle link (Must be this complicated because Moz's firstChild handling is borked)
            for (var j = 0; j < NavFrame.childNodes.length; j++)
            {
                if (hasClass(NavFrame.childNodes[j], "NavHead"))
                {
                    NavToggle.style.color = NavFrame.childNodes[j].style.color;
                    NavFrame.childNodes[j].appendChild(NavToggle);
                }
            }
            NavFrame.setAttribute('id', 'NavFrame' + indexNavigationBar);
        }
    }
}

$(createNavigationBarToggleButton);


// Allows sidebar's "navigation", "toolbox" and "languages" sections to be customized
function ModifySidebar(action, section, name, link)
{
    try
    {
        switch (section)
        {
          case "languages":
            var target = "p-lang";
            break;
          case "toolbox":
            var target = "p-tb";
            break;
          case "navigation":
            var target = "p-navigation";
            break;
          default:
            var target = "p-" + section;
            break;
        }
 
        if (action == "add")
        {
            var node = document.getElementById(target)
                               .getElementsByTagName('div')[0]
                               .getElementsByTagName('ul')[0];
 
            var aNode = document.createElement('a');
            var liNode = document.createElement('li');
 
            aNode.appendChild(document.createTextNode(name));
            aNode.setAttribute('href', link);
            liNode.appendChild(aNode);
            liNode.className='plainlinks';
            node.appendChild(liNode);
        }

        if (action == "sep")
        {
            var node = document.getElementById(target)
                               .getElementsByTagName('div')[0]
                               .getElementsByTagName('ul')[0];
 
            var liNode = document.createElement('li');
            liNode.style.listStyleImage="url('http://wiki.oni2.net/w/images/1/10/Separator.png')";
            liNode.style.listStylePosition='inside';
            node.appendChild(liNode);
        }
 
        if (action == "remove")
        {
            var list = document.getElementById(target)
                               .getElementsByTagName('div')[0]
                               .getElementsByTagName('ul')[0];
 
            var listelements = list.getElementsByTagName('li');
 
            for (var i = 0; i < listelements.length; i++)
            {
                if (listelements[i].getElementsByTagName('a')[0].innerHTML == name ||
                    listelements[i].getElementsByTagName('a')[0].href == link)
                {
 
                    list.removeChild(listelements[i]);
                }
            }
        }
 
    }
    catch(e)
    {
      // let's just ignore what's happened
      return;
    }
}


/** Table sorting fixes ************************************************
  *
  *  Description: Disables code in table sorting routine to set classes on even/odd rows
  *  Maintainers: [[User:Random832]]
  */
ts_alternate_row_colors = false;


/***** uploadwizard_newusers ********
 * Switches in a message for non-autoconfirmed users at [[Wikipedia:Upload]]
 *
 *  Maintainers: [[User:Krimpet]]
 */
function uploadwizard_newusers()
{
    if (mw.config.get('wgNamespaceNumber') == 4 && mw.config.get('wgTitle') == 'Upload' && mw.config.get('wgAction') === 'view')
    {
        var oldDiv = document.getElementById("autoconfirmedusers"),
            newDiv = document.getElementById("newusers");
        if (oldDiv && newDiv)
        {
            if (typeof wgUserGroups == "object" && wgUserGroups)
            {
                for (i = 0; i < wgUserGroups.length; i++)
                {
                    if (wgUserGroups[i] == "autoconfirmed")
                    {
                        oldDiv.style.display = "block";
                        newDiv.style.display = "none";
                        return;
                    }
                }
            }
            oldDiv.style.display = "none";
            newDiv.style.display = "block";
            return;
        }
    }
}

$(uploadwizard_newusers);


/***** autosort_sortable ********
 * Auto-sorts sortable tables by a given column (why is this not built-in?!)
 * You must opt into this feature by placing "autosort" in the list of
 * the table's classes along with "sortable"
 *
 *  Maintainers: [[User:Iritscen]]
 */

function sortSortableTables()
{
    // Iterate over all <div> elements
    var divs = document.getElementsByTagName("div");
    if (!divs) return;
    for (var i = 0; i < divs.length; i++)
    {
        var theDiv = divs[i];
        var tables = theDiv.getElementsByTagName("table");
        if (!tables) continue;
        for (var j = 0; j < tables.length; j++)
        {
            var theTable = tables[j];
            // If we found a sortable table that is asking for autosort...
            if (hasClass(theTable, "sortable") && hasClass(theTable, "autosort"))
            {
                var sortColumnNum = 1, curColumnNum = 0;

                // Take advantage of fact that hasClass() uses regex; if there is any by-column-x class at all,
                // then take the time to figure out the value of x
                if (hasClass(theTable, "by-column.."))
                {
                    for (var col = 1; col < 10; col++)
                    {
                        var colOption = "by-column-" + col;
                        if (hasClass(theTable, colOption))
                        {
                            sortColumnNum = col;
                            break;
                        }
                    }
                }

                // ...Look for sort button and click it
                var allTHs = theTable.getElementsByTagName("th");
                if (!allTHs) continue;
                for (var k = 0; k < allTHs.length; k++)
                {
                    if (hasClass(allTHs[k], "headerSort"))
                    {
                        curColumnNum++;
                        if (curColumnNum == sortColumnNum)
                        {
                            $(allTHs[k]).trigger("click"); // use jQuery's trigger() to send click event to this arrow
                            return;
                        }
                    }
                }
            }
        }
    }
}

$(sortSortableTables);