MediaWiki:Gadget-PatrollingEnhancements.js: Difference between revisions

var GPE = {};

/* </pre>

==Configuration options==

// override this in your common.js (or vector.js or whatnot).

GPE.initialDeleteReason = '';

 

// The value to use as a deletion reason if you leave the text-field blank; you

// can override it in your common.js (or vector.js or whatnot). If you *don't*

GPE.deleteReasonIfBlank = '';

 

 

==Automated patrolling (whitelisting)==

 

// set GPE.currMonth and GPE.lastMonth (in the form of, e.g., '2013/February')

  {

 

 

    var currYear = now.getFullYear();

    var currMonthNum = now.getMonth();

 

 

    var lastYear = (currMonthNum == 0 ? currYear - 1 : currYear);

    var lastMonthNum = (currMonthNum == 0 ? 11 : currMonthNum - 1);

 

    GPE.lastMonth = lastYear + '/' + monthNames[lastMonthNum];

)();

 

{

  "Wiktionary:Requested entries (English)": true,

  "Wiktionary:Tutorial (Editing)/sandbox": true,

  "Wiktionary:Word of the day/Nominations": true

 

  GPE.individualWhiteListedPages["Wiktionary:Beer parlour/" + GPE.lastMonth] =

// per-user white-listed sub-pages (for example, edits by user Foo

// to User:Foo/vector.js should be autopatrolled):

{

  "/nostalgia.js": true,

  "/nostalgia.css": true,

 

 

 

GPE.shouldAutoPatrol = function(link)

  var pagename = link.title;

  if(pagename in GPE.individualWhiteListedPages)

 

  if(mediaWiki.config.get('wgCanonicalSpecialPageName') === 'Contributions')

  {

      document.getElementById('t-contributions')

              .getElementsByTagName('a')[0].href.replace(/.*\//, '');

  }

  else

    if(li.tagName.toUpperCase() == 'SPAN')

      li = li.parentNode;

    var links = li.getElementsByTagName('a');

    for(var i = 0; i < links.length; ++i)

      if(links[i].title.indexOf('Special:Contributions/') == 0)

        contributor = links[i].title.substr('Special:Contributions/'.length);

 

 

/* </pre>

 

<pre> */

 

GPE.newButton = function(text, color, hoverText)

{

  var button = newNode('button', text);

  return button;

GPE.disableButton = function(button, text, hoverText)

{

  button.onclick = null;

  button.title = (hoverText || '');

  button.innerHTML = text;

  // disabled-button styles:

  button.style.background = '';

  button.disabled = 'disabled';

  // explicitly style like a disabled button:

  var computedStyle = window.getComputedStyle(button);

  button.style.background = computedStyle.backgroundColor;

  // re-enable, so the title will show up as hover-text in Firefox

  // (see https://bugzilla.mozilla.org/show_bug.cgi?id=274626):

  button.disabled = '';

  // technically the button is "enabled" now, but it *looks* disabled, and it

  // doesn't have an onclick event, so it's disabled for all normal purposes

};

 

GPE.anErrorOccurred = function(shortMsg, debugInfo)

  var msg, link;

  if(debugInfo)

  {

    link = newNode('a', {href:'#'}, 'here');

        'p',

        'An error occurred in MediaWiki:Gadget-PatrollingEnhancements.js: ',

        newNode('tt', shortMsg),

        ' \u2014 click ',

        link,

        ' for debugging information.'

    msg =

      (

        'An error occurred in MediaWiki:Gadget-PatrollingEnhancements.js: ',

        newNode('tt', shortMsg)

      );

  var bodyContent = $('div#bodyContent');

  bodyContent.insertBefore(msg, bodyContent.firstChild);

  if(link)

    link.onclick = function () { alert(debugInfo); };

  if(mediaWiki.config.get('wgUserName') == 'Ruakh')

    alert(shortMsg + '\n' + debugInfo);

};

 

==Individual patrol-buttons==

 

GPE.addPatrolButton = function(link, rcid)

  if(link.className.search(/(?:^|\s)gpe-hasPatrolButton(?:\s|$)/) > -1)

 

  var button = GPE.newButton('M', '#009', 'click to mark as patrolled');

  link.parentNode.insertBefore(button, link.nextSibling);

  link.parentNode.insertBefore(document.createTextNode(' · '), button);

      (

        '/w/api.php?format=json&action=patrol',

        { token: token, rcid: rcid },

          if(data.patrol)

            GPE.disableButton(button, 'm', 'marked as patrolled');

          else if(data.error)

            var msg = data.error.code + ': ' + data.error.info;

            if(data.error.code == 'badtoken')

              msg += ': "' + token + '"';

            alert(msg);

        },

      );

  if(GPE.shouldAutoPatrol(link))

 

  // remove the exclamation point:

  while(tmp && tmp.nodeName.toUpperCase() !== 'LI')

    tmp = tmp.parentNode;

    tmp = tmp.getElementsByClassName('unpatrolled')[0];

    tmp.parentNode.removeChild(tmp);

 

/* </pre>

<pre> */

 

GPE.addDeleteButton = function(link, title)

  if(link.className.search(/(?:^|\s)gpe-hasDeleteButton(?:\s|$)/) > -1)

    return;

  link.className = (link.className + ' gpe-hasDeleteButton').trim();

 

  var button = GPE.newButton('D', '#900', 'click to delete');

  link.parentNode.insertBefore(button, link.nextSibling);

  link.parentNode.insertBefore(document.createTextNode(' · '), button);

  button.onclick =

    function ()

    {

      var dropdownReason =

        document.getElementById('deleteReasonsDropdown')

          ? document.getElementById('deleteReasonsDropdown').value

      if(dropdownReason == 'other')

      var textInputReason =

        document.getElementById('deleteReasonTextInput').value;

      var reason;

      if(dropdownReason.length && textInputReason.length)

        reason = dropdownReason + ': ' + textInputReason;

      else if(dropdownReason.length || textInputReason.length)

        reason = dropdownReason + textInputReason;

        reason = GPE.deleteReasonIfBlank;

      var token = mediaWiki.user.tokens.get('deleteToken');

      $.post

      (

        '/w/api.php?format=json&action=delete',

        function (data)

          if(data['delete'])

            GPE.disableButton(button, 'd', 'deleted');

            var msg = data.error.code + ': ' + data.error.info;

            if(data.error.code == 'badtoken')

              msg += ': "' + token + '"';

        },

        'json'

      );

    };

};

 

==Delete-reasons==

 

GPE.addDeleteReasonInput = function ()

{ var deleteReasonDiv =

      ( 'div',

        { style:

            'background:#900; color:#FFF; ' +

            'position:fixed; bottom:0; right:0; margin-bottom:0'

        },

        '\u00A0Deletion reason:\u00A0'

    );

  deleteReasonDiv.title =

    'the deletion reason (message/summary) to use when you click "D"';

  var deleteReasonTextInput =

    ( 'input',

      { type: 'text',

        value: GPE.initialDeleteReason,

    )

  deleteReasonDiv.appendChild(deleteReasonTextInput);

  document.getElementById('bodyContent').appendChild(deleteReasonDiv);

 

  if(GPE.hideDeleteReasonDropdownOnWatchlist)

    if(mediaWiki.config.get('wgPageName') == 'Special:Watchlist')

      return;

 

  $.getJSON

  ( '/w/api.php?format=json&action=query&meta=allmessages&ammessages=Deletereason-dropdown',

    function (data)

    { var rawDeleteReasons = data.query.allmessages[0]['*'];

        newNode('select',

          { id: 'deleteReasonsDropdown', style: 'vertical-align: bottom' });

      deleteReasonsDropdown.appendChild

        (newNode('option', { value: 'other' }, 'Other reason'));

      ( /^(\*\*?) *(.+)$/gm,

        { if(asterisks == '*')

            deleteReasonsDropdown.appendChild

              (optGroup = newNode('optgroup', { label: text }));

          else // '**'

            optGroup.appendChild(newNode('option', { value: text }, text));

        }

      );

      deleteReasonDiv.insertBefore(deleteReasonsDropdown, deleteReasonTextInput);

      deleteReasonDiv.insertBefore(newNode('br'), deleteReasonTextInput);

      deleteReasonDiv.insertBefore(document.createTextNode('\u00A0'), deleteReasonTextInput);

};

 

==Namespaces==

 

GPE.computeNamespaces = function

  (selected, includeAssociated, invertSelection)

  var associated = Number(selected) + (selected % 2 === 0 ? 1 : -1);

    var selector = document.getElementById('namespace');

    if(! selector)

    for(var option = selector.firstChild; option; option = option.nextSibling)

      if(option.nodeName.toUpperCase() === 'OPTION' && option.value)

        if(option.value != selected)

          if(! includeAssociated || option.value != associated)

            ret.push(option.value);

    return ret;

    if(includeAssociated)

};

 

GPE.generateRcnamespace = function ()

  var currUrl = document.location.href;

  if(! /[?&]namespace=\d+(?:&|$)/.test(currUrl))

  var selected = /[?&]namespace=(\d+)(?:&|$)/.exec(currUrl)[1];

    mediaWiki.config.get('wgPageName') !== 'Special:NewPages'

    && /[?&]associated=(?!0?&|0?$)/.test(currUrl);

  var invertSelection = /[?&]invert=(?!0?&|0?$)/.test(currUrl);

  var namespaces =

    GPE.computeNamespaces(selected, includeAssociated, invertSelection);

  if(namespaces.length > 0)

    return namespaces.join('|');

 

/* </pre>

==Find and handle links==

 

GPE.handleUnpatrolledEdits = function (rcidsByRevid)

{

    document.getElementById('bodyContent').getElementsByTagName('a');

  for(var i = links.length - 1; i >= 0; --i)

    var mapKey = /&diff=(prev&oldid=)?(\d+)(&|$)/.exec(links[i].href);

      GPE.addPatrolButton(links[i], rcidsByRevid[mapKey[2]]);

};

 

GPE.findLinksToUnpatrolledNewPages = function (rcidsByTitle)

{

  if(mediaWiki.config.get('wgPageName') === 'Special:NewPages')

    var ret = [];

    $('li.not-patrolled a.mw-newpages-pagename').each(function () { ret.push(this) });

    var ret = [];

      document.getElementById('bodyContent').getElementsByTagName('abbr');

      if(abbrs[i].className != 'newpage')

        continue;

      var link = abbrs[i];

      while(link && link.nodeName.toUpperCase() != 'A')

        if(link.nodeName.toUpperCase() === 'SPAN' && link.className === 'mw-title')

          link = link.firstChild;

          link = link.nextSibling;

      if(link && link.title && rcidsByTitle.hasOwnProperty(link.title))

        ret.push(link);

 

    mediaWiki.config.get('wgUserGroups').indexOf('sysop') > -1;

  var links = GPE.findLinksToUnpatrolledNewPages(rcidsByTitle);

  for(var i = links.length - 1; i >= 0; --i)

    if(userIsSysop)

      GPE.addDeleteButton(link, link.title);

    GPE.addPatrolButton(link, rcidsByTitle[link.title]);

  if(userIsSysop && links.length > 0)

    GPE.getAndStoreDeleteToken();

    GPE.addDeleteReasonInput();

};

 

GPE.getAndStoreDeleteToken = function ()

  $.getJSON

  (

    '/w/api.php?format=json&action=tokens&type=delete',

    function (data)

      if(! token || token.search(/^[0-9a-f]{32}\+\\$/) != 0)

 

GPE.main = function (params)

{

  var url =

    '/w/api.php?format=json&action=query&list=recentchanges' +

    '&rcprop=ids|title' +

    '&rcshow=!patrolled' + (params.hasOwnProperty('rcshow') ? '|' + params.rcshow : '') +

    '&rclimit=' + (params.hasOwnProperty('rclimit') ? params.rclimit : 500) +

    '&rctype=' + (params.hasOwnProperty('rctype') ? params.rctype : 'edit|new') +

    (params.hasOwnProperty('rcnamespace') ? '&rcnamespace=' + params.rcnamespace : '');

  if(params.hasOwnProperty('rcuser'))

    url = url + '&rcuser=' + params.rcuser;

    function (data)

    {

      data = data.query.recentchanges;

      var rcidsByRevid = {}; // for unpatrolled edits

      var rcidsByTitle = {}; // for unpatrolled new pages

      for(var i = 0; i < data.length; ++i)

        if(data[i].type == 'edit')

          rcidsByRevid[data[i].revid] = data[i].rcid;

          rcidsByTitle[data[i].title] = data[i].rcid;

 

      GPE.handleUnpatrolledEdits(rcidsByRevid);

      GPE.handleUnpatrolledNewPages(rcidsByTitle);

  );

};

 

/* </pre>

==Onload-hooks==

<pre> */

 

$( document ).ready

( function ()

  {

    if(mediaWiki.config.get('wgPageName') === 'Special:RecentChanges') {

      var currUrl = document.location.href;

      var params = {};

      var rcshow = [];

      if(currUrl.search(/[?&]hideliu=(?!0?$|0?&)/) > -1)

        rcshow.push('anon');

      else if(currUrl.search(/[?&]hideanons=(?!0?$|0?&)/) > -1)

        rcshow.push('!anon');

      if(document.getElementsByClassName('minoredit').length === 0)

        rcshow.push('!minor');

      if(rcshow.length > 0)

        params.rcshow = rcshow.join('|');

      var rcnamespace = GPE.generateRcnamespace();

      if(rcnamespace)

        params.rcnamespace = rcnamespace;

      GPE.main(params);

    } else if(mediaWiki.config.get('wgPageName') === 'Special:NewPages') {

      var currUrl = document.location.href;

      var params = { rctype: 'new' };

      var rcshow = [];

      if(currUrl.search(/[?&]hideliu=(?!0?$|0?&)/) > -1)

      if(currUrl.search(/[?&]hideredirs=0?(?:$|&)/) === -1)

        rcshow.push('!redirect');

        params.rcshow = rcshow.join('|');

      var rcnamespace = GPE.generateRcnamespace();

      var params = {};

      var rcnamespace = GPE.generateRcnamespace();

      if(rcnamespace)

        params.rcnamespace = rcnamespace;

      // TODO is this the best way to find what we need for the watchlist?

      GPE.main(params);

    } else if(mediaWiki.config.get('wgPageName').search(/^Special:Contributions(\/|$)/) === 0)

      GPE.main({ rcuser: document.getElementById('t-contributions').firstChild.href.replace(/^.*?\/Special:Contributions\//, '') });

    else if(mediaWiki.config.get('wgAction') === 'markpatrolled'

        || mediaWiki.config.get('wgAction') === 'delete'

        || mediaWiki.config.get('wgAction') === 'rollback')

      GPE.main({ rclimit: 15 });

  }

);