Jump to content

User:BDavis (WMF)/userinfo.js

From Wikipedia, the free encyclopedia
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Note: After saving, you have to bypass your browser's cache to see the changes. Google Chrome, Firefox, Microsoft Edge and Safari: Hold down the ⇧ Shift key and click the Reload toolbar button. For details and instructions about other browsers, see Wikipedia:Bypass your cache.
// Forked from https://en.wikipedia.org/enwiki/w/index.php?title=User:Enterprisey/userinfo.js&oldid=1107033661
// Forked from https://en.wikipedia.org/enwiki/w/index.php?title=User:PleaseStand/userinfo.js&oldid=803890891
// based on http://en.wikipedia.org/wiki/User:Fran Rogers/dimorphism.js
// and on http://en.wikipedia.org/wiki/User:Splarka/sysopdectector.js
// Modified by Enterprisey
// Modified by BDavis (WMF)

function UserinfoJsFormatQty(qty, singular, plural) {
    return String(qty).replace(/\d{1,3}(?=(\d{3})+(?!\d))/g, "$&,") + "\u00a0" + (qty == 1 ? singular : plural);
}

function UserinfoJsFormatDateRel(old) {
// The code below requires the computer's clock to be set correctly.
            var age = new Date().getTime() - old.getTime();
            var ageNumber, ageRemainder, ageWords;
            if(age < 60000) {
                // less than one minute old
                ageNumber = Math.floor(age / 1000);
                ageWords = UserinfoJsFormatQty(ageNumber, "second", "seconds");
            } else if(age < 3600000) {
                // less than one hour old
                ageNumber = Math.floor(age / 60000);
                ageWords = UserinfoJsFormatQty(ageNumber, "minute", "minutes");
            } else if(age < 86400000) {
                // less than one day old
                ageNumber = Math.floor(age / 3600000);
                ageWords = UserinfoJsFormatQty(ageNumber, "hour", "hours");
                ageRemainder = Math.floor((age - ageNumber * 3600000) / 60000);
            } else if(age < 604800000) {
                // less than one week old
                ageNumber = Math.floor(age / 86400000);
                ageWords = UserinfoJsFormatQty(ageNumber, "day", "days");
            } else if(age < 2592000000) {
                // less than one month old
                ageNumber = Math.floor(age / 604800000);
                ageWords = UserinfoJsFormatQty(ageNumber, "week", "weeks");
            } else if(age < 31536000000) {
                // less than one year old
                ageNumber = Math.floor(age / 2592000000);
                ageWords = UserinfoJsFormatQty(ageNumber, "month", "months");
            } else {
                // one year or older
                ageNumber = Math.floor(age / 31536000000);
                ageWords = UserinfoJsFormatQty(ageNumber, "year", "years");
                ageRemainder =
                    Math.floor((age - ageNumber * 31536000000) / 2592000000);
                if(ageRemainder) {
                    ageWords += " " +
                        UserinfoJsFormatQty(ageRemainder, "month", "months");
                }
           }
           return ageWords;
}

// If on a user or user talk page, and not a subpage...
if((mw.config.get("wgNamespaceNumber") == 2 || mw.config.get("wgNamespaceNumber") == 3) && !(/\//.test(mw.config.get("wgTitle")))) {   
    // add a hook to...
    $.when( $.ready, mw.loader.using( ['mediawiki.util'] ) ).then( function() {
        function buildStatusHtml( userInfo ) {
            var statusText = "";
            var ipUser = false;
            var ipv4User = false;
            var ipv6User = false;

            // User status
            if(userInfo.blocked) {
                statusText += "<a href=\"" + mw.config.get("wgScriptPath") +
                    "/index.php?title=Special:Log&amp;page=" + 
                    encodeURIComponent(mw.config.get("wgFormattedNamespaces")[2] + ":" + user.name) +
                    "&amp;type=block\">" + (userInfo.partialblocked ? "partially " : "")+ "blocked</a> ";
                if(userInfo.locked) {
            	statusText += "and <a href=\"//meta.wikimedia.org/wiki/Special:CentralAuth/" + user.name +
                    "\">locked</a> ";
            	}
            }
            else if(userInfo.locked) {
            	statusText += "<a href=\"//meta.wikimedia.org/wiki/Special:CentralAuth/" + user.name +
                    "\">locked</a> ";
            }
            if (userInfo.missing) {
                statusText += "username not registered";
            } else if (userInfo.invalid) {
                ipv4User = mw.util.isIPv4Address(userInfo.name);
                ipv6User = mw.util.isIPv6Address(userInfo.name);
                ipUser = ipv4User || ipv6User;
                if (ipv4User) {
                    statusText += "anonymous IPv4 user";
                } else if (ipv6User) {
                    statusText += "anonymous IPv6 user";
                } else {
                    statusText += "invalid username";
                }
            } else {
                // User is registered and may be in a privileged group. Below we have a list of user groups.
                // Only need the ones different from the software's name (or ones to exclude), though.
                var friendlyGroupNames = {
                    // Exclude implicit user group information provided by MW 1.17 --PS 2010-02-17
                    '*': false,
                    'user': false,
                    'autoconfirmed': false,
                    extendedconfirmed: false,
                    sysop: "admin",
                    accountcreator: "acct creator",
                    'import': "importer",
                    transwiki: "transwiki importer",
                    'ipblock-exempt': "IPBE",
                    oversight: "OS",
                    confirmed: "confirmed",
                    abusefilter: "EFM",
                    'abusefilter-helper': "EFH",
                    autoreviewer: "AutoPatr user",
                    filemover: "file mover",
                    'massmessage-sender': "MMS",
                    templateeditor: "TE",
                    extendedmover: "PM",
                    'flow-bot': "Flow bot",
                    reviewer: "PCR",
                    suppress: "suppressor",
                    patroller: "NPR",
                    bureaucrat: "crat",
                    checkuser: "CU",
                    rollbacker: "RB",
                    'no-ipinfo': 'no IP Info'
                };
                
                var friendlyGroups = userInfo.groups.map( function ( s ) {
                    return friendlyGroupNames.hasOwnProperty(s) ? friendlyGroupNames[s] : s;
                } ).filter( Boolean );

                // add in global groups
                var globalFriendlyGroupNames = {
                    'abusefilter-helper': 'GEFH',
                    'abusefilter-maintainer': 'GEFM',
                    'global-interface-editor': 'GIE',
                    'global-ipblock-exempt': 'GIPBE',
                    'global-rollbacker': 'GRB',
                    'global-sysop': 'global sysop',
                    'ombuds': 'ombud',
                    'staff': 'WMF staff',
                    'vrt-permissions': 'VRT permissions agent',
                    'wmf-researcher': 'WMF researcher'
                };
                if (userInfo.globalGroups) {
                    [].push.apply( friendlyGroups, userInfo.globalGroups.map( function ( group ) {
                        return '<i>' + ( globalFriendlyGroupNames.hasOwnProperty(group) ? globalFriendlyGroupNames[group] : group ) + '</i>';
                    } ) );
                }

                switch(friendlyGroups.length) {
                    case 0:
                        // User not in a privileged group
                        // Changed to "registered user" by request of [[User:Svanslyck]]
                        // --PS 2010-05-16
                        
                        // statusText += "user";
                        if(userInfo.blocked || userInfo.locked) {
                            statusText += "user";
                        } else {
                            statusText += "registered user";
                        }
                        break;
                    case 1:
                        statusText += friendlyGroups[0];
                        break;
                    case 2:
                        statusText += friendlyGroups[0] + " and " + friendlyGroups[1];
                        break;
                    default:
                        statusText += friendlyGroups.slice(0, -1).join(", ") +
                            ", and " + friendlyGroups[friendlyGroups.length - 1];
                        break;
                }
            }
                
            // Registration date
            if(userInfo.registration) {
            	var firstLoggedUser = new Date("22:16, 7 September 2005"); // When the [[Special:Log/newusers]] was first activated
            	if(userInfo.registration >= firstLoggedUser) {
            		statusText += ", <a href='" + mw.config.get("wgScriptPath") +
                    "/index.php?title=Special:Log&amp;type=newusers&amp;dir=prev&amp;limit=1&amp;user=" +
                    et + "'>" + UserinfoJsFormatDateRel(userInfo.registration) + "</a> old";
            	} else {
            		statusText += ", <a href='" + mw.config.get("wgScriptPath") +
                    "/index.php?title=Special:ListUsers&amp;limit=1&amp;username=" +
                    et + "'>" + UserinfoJsFormatDateRel(userInfo.registration) + "</a> old";
            	}
            }
            
            // Edit count
            if(userInfo.editcount !== null) {
                statusText += ", with " +
                    "<a href=\"https://xtools.wmcloud.org/ec/" +
                    encodeURIComponent(mw.config.get("wgServerName")) + "/" +
                    encodeURIComponent(userInfo.name) + "\">" +
                    UserinfoJsFormatQty(userInfo.editcount, "edit", "edits") + "</a>";
            }
            
            // Prefix status text with correct article
            // Why "N"? "En".
            if("AEIOMNRaeio".indexOf(statusText.charAt(0)) >= 0) {
                statusText = "An " + statusText;
            } else {
                statusText = "A " + statusText;
            }

            // Add full stop to status text
            statusText += ".";

            // Last edited --PS 2010-06-27
            // Added link to contributions page --PS 2010-07-03
            if(userInfo.lastEdited) {
                statusText += " Last edited <a href=\"" +
                	mw.config.get("wgArticlePath").replace(
                		"$1", "Special:Contributions/" + encodeURIComponent(userInfo.name)
                	) + "\">" +
                	UserinfoJsFormatDateRel(userInfo.lastEdited) +
                	" ago</a>.";
            }
            return statusText;
        }
        // Request the user's information from the API.
        // Note that this is allowed to be up to 5 minutes old.
        var et = encodeURIComponent(mw.config.get("wgTitle"));

        $.getJSON(mw.config.get("wgScriptPath") + "/api.php?maxage=300&smaxage=300&format=json&formatversion=2&action=query&list=users|usercontribs&usprop=blockinfo|editcount|gender|registration|groups&uclimit=1&ucprop=timestamp&ususers=" + et + "&ucuser=" + et + "&guiuser=" +et + "&meta=allmessages|globaluserinfo&amprefix=grouppage-&amincludelocal=1&guiprop=groups")
        .done(function(query) {
            // When response arrives extract the information we need.
            if(!query.query) { return; } // Suggested by Gary King to avoid JS errors --PS 2010-08-25
            query = query.query;
            var userInfo = {};
            try {
                user = query.users[0];
                userInfo = {
                    name: user.name,
                    invalid: typeof user.invalid != "undefined",
                    missing: typeof user.missing != "undefined",
                    groups: (typeof user.groups == "object") ? user.groups : [],
                    editcount: (typeof user.editcount == "number") ? user.editcount : null,
                    registration: (typeof user.registration == "string") ?
                        new Date(user.registration) : null,
                    blocked: typeof user.blockedby != "undefined",
                    partialblocked: typeof user.blockpartial != "undefined" && user.blockpartial,
                    locked: typeof query.globaluserinfo != "undefined" && typeof query.globaluserinfo.locked != "undefined",
                    gender: (typeof user.gender == "string") ? user.gender : null,
                    lastEdited: (typeof query.usercontribs[0] == "object") &&
                        (typeof query.usercontribs[0].timestamp == "string") ?
                        new Date(query.usercontribs[0].timestamp) : null,
                    globalGroups: (typeof query.globaluserinfo != "undefined" && typeof query.globaluserinfo.groups == 'object') ? query.globaluserinfo.groups : []
                };
                if (userInfo.invalid) {
                    userInfo.ipv4User = mw.util.isIPv4Address(userInfo.name);
                    userInfo.ipv6User = mw.util.isIPv6Address(userInfo.name);
                    userInfo.ipUser = ipv4User || ipv6User;
                } else {
                    userInfo.ipv4User = false;
                    userInfo.ipv6User = false;
                    userInfo.ipUser = false;
                }
                userInfo.groupPages = {};
                for (var am=0; am<query.allmessages.length; am++) {
                	userInfo.groupPages[query.allmessages[am]["name"].replace("grouppage-","")] = query.allmessages[am]["content"].replace("{{ns:project}}:","Project:");
                }
            } catch(e) {
                console.error(e);
                return; // Not much to do if the server is returning an error (e.g. if the username is malformed).
            }

            // Show the correct gender symbol
            var fh = document.getElementById("firstHeading") ||
                document.getElementById("section-0");
            // Add classes for blocked, registered, and anonymous users
            var newClasses = [];
            if(userInfo.blocked) {
                newClasses.push("ps-blocked");
            }
            if(userInfo.ipUser) {
                newClasses.push("ps-anonymous");
            } else if(userInfo.invalid) {
                newClasses.push("ps-invalid");
            } else {
                newClasses.push("ps-registered");
            }
            fh.className += (fh.className.length ? " " : "") + userInfo.groups.map(function(s) {
                return "ps-group-" + s;
            }).concat(newClasses).join(" ");
            var genderSpan = document.createElement("span");
            genderSpan.id = "ps-gender-" + (userInfo.gender || "unknown");
            genderSpan.style.paddingLeft = "0.25em";
            genderSpan.style.fontFamily = '"Lucida Grande", "Lucida Sans Unicode", "sans-serif"';
            genderSpan.style.fontSize = "75%";
            var genderSymbol;
            switch(userInfo.gender) {
                case "male": genderSymbol = "\u2642"; break;
                case "female": genderSymbol = "\u2640"; break;
                default: genderSymbol = ""; break;
            }
            genderSpan.appendChild(document.createTextNode(genderSymbol));
            fh.appendChild(genderSpan);

            // Now show the other information. Non-standard? Yes, but it gets the job done.
            // Add a period after the tagline when doing so. --PS 2010-07-03

            var ss = document.getElementById("siteSub");
            if(!ss) {
                ss = document.createElement("div");
                ss.id = "siteSub";
                ss.innerHTML = "From Wikipedia, the free encyclopedia";
                var bc = document.getElementById("bodyContent");
                bc.insertBefore(ss, bc.firstChild);
            }
            ss.innerHTML = '<span id="ps-userinfo">' + buildStatusHtml(userInfo) + '</span> ' + ss.innerHTML + '.';
            ss.style.display = "block";
            });
    });
}