MediaWiki:Gadget-contribsrange.js

//  _________________________________________________________________________________________
// |                                                                                         |
// |                    === WARNING: GLOBAL GADGET FILE ===                                  |
// |                  Changes to this page affect many users.                                |
// | Please discuss changes on the talk page or on [[Wikipedia_talk:Gadget]] before editing. |
// |_________________________________________________________________________________________|
//
// Imported from version 312947638 as of September 10, 2009 from [[User:Splarka/contribsrange.js]]
// See notes below

/* Đặc biệt:Đóng góp Wildcard/CIDR lookup, version [0.2.7]
Originally from: https://en.wikipedia.org/wiki/User:Splarka/contribsrange.js

Notes:
* Uses the API which is faster than most CIDR contrib tools.
** Needs 1.14 r42198+ for advanced continue.
* Currently uses a GET json via <script src=""> to avoid ajax problems.
* Only currently works if submitted (or called by URL parameter, eg Đặc biệt:Đóng góp/User).
** Checks namespace and date options in form.
** Also utilizes &ucstart and &ucend date parameters if supplied manually (not supported in the UI atm).
*** These parameters override the form date options.
* Uses: Submit any IP CIDR range /16 or from /24 to /32. Submit any string (at least 3 characters) with a suffixed asterisk.
** eg: [123.123.123.0/24 ] or [123.123.123.* ] or [Willy* ].
* Now keeps searching until it finds crMax (or forever with crshowall=true URI parameter).
** Puts them in a nice collapsed div stack, like enhanced recent changes.
* /25 and /26 ranges now disabled, since they are inaccurate (50 parameter limit), please use /24 (ucuserprefix) or /27 (32 parameters)

To do:
* use ajax (let sysops/bots = 5000)?
*/
/*jshint scripturl:true*/
/*global jQuery, mediaWiki, prefixContribs, prefixContribsToggleDiv, prefixContribsToggleAll */
( function ( mw, $ ) {

function prefixContribsInit() {
  var options;
  var show = document.getElementById('contentSub') || document.getElementById('topbar');
  if(show) show.appendChild(document.createTextNode(' \u2022 Đã bật tra cứu đóng góp nâng cao bằng Javascript 0.2. Bạn có thể nhập dải CIDR hoặc thêm dấu hoa thị để thực hiện tìm kiếm tiền tố.'));
  var ucfrm = document.getElementsByTagName('form')[0];
  if(!ucfrm.target) return;

  //general optionlets independent of type of search.
  var opt_ns = "";
  if( typeof ucfrm.namespace != "undefined" ) {
    opt_ns = (parseInt(ucfrm.namespace[ucfrm.namespace.selectedIndex].value) > -1) ? '&ucnamespace=' + ucfrm.namespace[ucfrm.namespace.selectedIndex].value : '';
  }
  var opts_ts = '';
  var dateStart = ucfrm.start.value;
  var dateEnd = ucfrm.end.value;
  if(dateStart) opts_ts += '&ucstart=' + dateStart + 'T23:59:59Z';
  if(dateEnd) opts_ts += '&ucend=' + dateEnd + 'T23:59:59Z';
  var opts_se = '';
  if(queryString('ucstart')) opts_se += '&ucstart=' + encodeURIComponent(queryString('ucstart'));
  if(queryString('ucend')) opts_se += '&ucend=' + encodeURIComponent(queryString('ucend'));
  if(opts_se === '') {
    options = opt_ns + opts_ts + '&ucdir=newer';
  } else {
    options = opt_ns + opts_se + '&ucdir=newer';
  }

  var patternCIDR = /(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\/(2[7-9]|3[0-2]|24|16)/i ;
  var patternWild = /^.{3,}\*$/i ;
  var url = mw.config.get('wgServer') + mw.config.get('wgScriptPath') + '/api.php?action=query&format=json&callback=prefixContribs&rawcontinue=&list=usercontribs' + options + '&uclimit=' + parseInt(crLimit);
  if(ucfrm.target.value.search(patternCIDR) === 0) {
    prefixContribsStartbox(ucfrm.parentNode);
    var cidr = ucfrm.target.value.match(patternCIDR)[0];
    var range = cidr.match(/[^\/]\d{1,2}$/i)[0];
    if(range == 24 || range == 16) {
      //prefixable CIDR, lets do-er
      if(range == 24) {
        cidr = cidr.match(/\d{1,3}\.\d{1,3}\.\d{1,3}\./)[0];
      } else {
        cidr = cidr.match(/\d{1,3}\.\d{1,3}\./)[0];
      }
      url += '&ucuserprefix=' + cidr;
    } else {
      //complex CIDR, lets figure it out
      var oct3 = cidr.match(/\.\d{1,3}\//i)[0].replace(/(\.|\/)/g,'');
      cidr = cidr.match(/\d{1,3}\.\d{1,3}\.\d{1,3}\./)[0];
      var num = Math.pow(2,32 - range);
      var start = oct3 - oct3 % num;
      url += '&ucuser=';
      for(var i=start;i<=start + num;i++) {
        url += '' + cidr + i;
        if(i != start + num) url += '|';
      }
    }
  } else if(ucfrm.target.value.search(patternWild) === 0) {
    //very simple wildcard, lets do-er
    prefixContribsStartbox(ucfrm.parentNode);
    var prefix = ucfrm.target.value.replace(/\*$/,'');
    prefix = prefix.substr(0,1).toUpperCase() + prefix.substr(1);
    url += '&ucuserprefix=' + prefix;
  }
  mw.loader.load(url);
  crContURI = url;
}

/**
 * Attach the range contributions box as the given node’s child node.
 * @param {Node} parent Node to attach the box to.
 */
function prefixContribsStartbox(parent) {
  var res = document.createElement('div');
  res.setAttribute('id','results-from-CIDR');
  $('.mw-userpage-userdoesnotexist').hide();
  addlinkchild(res,'javascript:prefixContribsToggleAll();','toggle all','prefixcontribs-tog');
  var spin = document.createElement('span');
   spin.setAttribute('id','prefixcontribs-prog');
   spin.appendChild(document.createTextNode('Searching.'));
  res.appendChild(spin);
  mw.loader.using('jquery.spinner', function () {
    if (!loadingReady) {
      $(spin).injectSpinner('prefixcontribs-spin');
    }
  });
  parent.appendChild(res);
}

/**
 * Process the API call’s result (JSONP callback function). API documentation:
 * https://en.wikipedia.org/w/api.php?action=help&modules=query+usercontribs
 * @param {object} obj The API response object.
 */
window.prefixContribs = function (obj) {
  if(!obj.query || !obj.query.usercontribs) return;
  var cidr = obj.query.usercontribs;
  var res = document.getElementById('results-from-CIDR');
  if(!cidr.length) {
    res.appendChild(document.createTextNode(' Không tìm thấy sửa đổi nào của ký tự đại diện/dải CIDR này.'));
    removeSpinner();
    return;
  }
  for(var i=0;i<cidr.length;i++) {
    var id = 'cr-' + escapeID(cidr[i].user);
    // group each result set based on the user name, create new div for new names
    if(!document.getElementById(id)) {
      var hdiv = document.createElement('div');
      hdiv.setAttribute('id','d-' + id);
      addlinkchild(hdiv,'javascript:prefixContribsToggleDiv("' + id +'")',cidr[i].user,'m-' + id,'cr-toggle-hidden');
      res.appendChild(hdiv);
      res.appendChild(document.createTextNode('\n'));
      var rul = document.createElement('ul');
       rul.setAttribute('id',id);
       rul.setAttribute('class','cr-list');
       rul.style.display = 'none';
      res.appendChild(rul);
      res.appendChild(document.createTextNode('\n'));
    }
    var ul = document.getElementById(id);
    ul.appendChild(document.createTextNode('\n'));
    var li = document.createElement('li');
     li.appendChild(document.createTextNode(cidr[i].timestamp.replace(/T[\d:]*Z/,' ')));
     addlinkchild(li, mw.util.getUrl( 'Đặc_biệt:Đóng_góp/' + cidr[i].user ), cidr[i].user);
     li.appendChild(document.createTextNode(' ('));
     addlinkchild(li, mw.util.getUrl( 'Thảo_luận_thành_viên:' + cidr[i].user ), 'thảo luận','','mw-mightexist');
     li.appendChild(document.createTextNode(') đã sửa ('));
     addlinkchild(li, mw.util.getUrl( cidr[i].title, { curid: cidr[i].pageid, diff: 'prev', oldid: cidr[i].revid } ), 'khác biệt');
     li.appendChild(document.createTextNode(') '));
     addlinkchild(li, mw.util.getUrl( cidr[i].title, { curid: cidr[i].pageid } ), cidr[i].title);
     if(cidr[i].comment) li.appendChild(document.createTextNode(' (' + cidr[i].comment + ')'));
    ul.appendChild(li);
  }
  mw.hook( 'wikipage.content' ).fire($('.cr-list'));
  //continue?
  crMax = crMax - cidr.length;
  var prog = document.getElementById('prefixcontribs-prog');
  if(!obj['query-continue'] || !obj['query-continue'].usercontribs || !obj['query-continue'].usercontribs.uccontinue) {
    removeSpinner();
    prog.parentNode.removeChild(prog);
    prefixContribsNumerate();
    return;
  }
  var url = crContURI + '&uccontinue='+ obj['query-continue'].usercontribs.uccontinue;
  if(crMax <= 0 && queryString('crshowall') != 'true') {
    prog.appendChild(document.createTextNode(' Chà! Tìm được nhiều quá. Nhấp chuột để xem tất cả. '));
    var ga = document.createElement('a');
     var gaurl = document.location.href;
     if(gaurl.indexOf('#') != -1) gaurl = gaurl.substr(0,gaurl.indexOf('#'));
     if(gaurl.indexOf('?') == -1) gaurl += '?';
     gaurl += '&crshowall=true';
     ga.setAttribute('href',gaurl);
     ga.appendChild(document.createTextNode('here'));
    prog.appendChild(ga);
    prog.appendChild(document.createTextNode('. (Cảnh báo: Có thể làm trì trệ trình duyệt!)'));
    removeSpinner();
    prefixContribsNumerate();
  } else {
    prog.appendChild(document.createTextNode('.'));
    mw.loader.load(url);
  }
};

/**
 * Remove the jQuery spinner if the spinner ResourceLoader module is
 * ready. If it’s not ready yet, the spinner hasn’t been added in the
 * first place; set `loadingReady` to true to prevent its addition in
 * the future.
 */
function removeSpinner() {
  loadingReady = true;
  if (mw.loader.getState('jquery.spinner') === 'ready') {
    $.removeSpinner('prefixcontribs-spin');
  }
}

/**
 * Add the number of edits next to each user found. This only opens the
 * contributions for the found user if there’s only one.
 */
function prefixContribsNumerate() {
  var lsts = $( 'ul.cr-list' );
  for(var i=0;i<lsts.length;i++) {
    var dv = document.getElementById('d-' + lsts[i].getAttribute('id'));
    dv.appendChild(document.createTextNode(' ' + lsts[i].getElementsByTagName('li').length + ' found'));
  }
  if(lsts.length == 1) prefixContribsToggleDiv(lsts[0].id);
}

/**
 * Toggle the contributions listing for all users. The direction depends
 * on the first user listing’s state: if it’s collapsed, all users are
 * uncollapsed; if it’s uncollapsed, all users are collapsed.
 */
window.prefixContribsToggleAll = function () {
  var lsts = $( 'ul.cr-list' );
  if(!lsts.length) return;
  var togglefrom = lsts[0].style.display;
  for(var i=0;i<lsts.length;i++) {
    if(lsts[i].style.display == togglefrom) prefixContribsToggleDiv(lsts[i].id);
  }
};

/**
 * Toggle the contributions listing of a given user.
 * @param {string} id ID of the user to toggle.
 */
window.prefixContribsToggleDiv = function (id) {
  var i = document.getElementById(id);
  var m = document.getElementById('m-' + id);
  if(!i || !m) return;
  if(i.style.display == 'none') {
    i.style.display = 'block';
    m.className = 'cr-toggle-shown';
  } else {
    i.style.display = 'none';
    m.className = 'cr-toggle-hidden';
  }
};

/**
 * Create a link and append to the given element.
 * @param {Node} obj Node to add the link child to.
 * @param {string} href The link target.
 * @param {string} text The link text.
 * @param {string} [id] The link anchor ID.
 * @param {string} [classes] Classes to apply to the link as a space-separated list.
 * @returns {HTMLAnchorElement} The newly created link element.
 */
function addlinkchild(obj,href,text,id,classes) {
  if(!obj || !href || !text) return false;
  var a = document.createElement('a');
  a.setAttribute('href',href);
  a.appendChild(document.createTextNode(text));
  if(id) a.setAttribute('id',id);
  if(classes) a.setAttribute('class',classes);
  obj.appendChild(a);
  return a;
}

/**
 * Escape a text to make it suitable to be used in an HTML ID.
 * @param {string} txt The text to escape.
 * @returns {string} The escaped text.
 */
function escapeID(txt) {
  var id = txt;
  id = id.replace(/ /g,'_');
  id = encodeURIComponent(id);
  id = id.replace(/\%3A/g,':');
  id = id.replace(/\%/g,'.');
  return id;
}

/**
 * Get a query string parameter from the document’s URL.
 * @param {string} p The parameter’s name.
 * @returns {string|null} The parameter’s value, or `null` if the
 *  parameter is not found.
 */
function queryString(p) {
  var re = RegExp('[&?#]' + p + '=([^&#]*)');
  var matches = re.exec(document.location);
  if (matches) {
    try { 
      return decodeURI(matches[1]);
    } catch (e) {
    }
  }
  return null;
}

if(mw.config.get('wgCanonicalSpecialPageName') == 'Contributions') { 
  var crContURI = ''; //query URI for continuing later
  var crLimit = 500; //limit for each query
  var crMax = 10000; //bypass with &crshowall=true URI parameter
  var loadingReady = false; // whether the loading has been finished and the spinner should not be added anymore
  var crImgHid = '//upload.wikimedia.org/wikipedia/commons/a/ad/Arr_r.png';
  var crImgSho = '//upload.wikimedia.org/wikipedia/commons/f/f0/Arr_d.png';
  mw.util.addCSS('.cr-list {padding-left:5px;}\n.cr-toggle-hidden {padding-left:16px;background: transparent no-repeat center left url("' + crImgHid + '")}' +
    '\n.cr-toggle-shown {padding-left:16px;background: transparent no-repeat center left url("' + crImgSho + '")}\n.mw-mightexist {font-style:italic;}' +
    '\n#results-from-CIDR {border:1px solid black;padding:.5em}\n#prefixcontribs-tog {float:right;border:1px solid black;text-decoration:none;color:black;padding:0 5px;}');
  $(prefixContribsInit);
}

}( mediaWiki, jQuery ) );